1MPI_Comm_free(3) LAM/MPI MPI_Comm_free(3)
2
6 MPI_Comm_free - Marks the communicator object for deallocation
7
9 #include <mpi.h>
10 int
11 MPI_Comm_free(MPI_Comm *comm)
12
14 comm - communicator to be destroyed (handle)
15
18 comm will be set to MPI_COMM_NULL upon successful return.
19
22 The MPI 1.1 specification, in the section on opaque objects, explicitly
23 disallows freeing a null communicator. The text from the
24
26 "A null handle argument is an erroneous IN argument in MPI calls,
27 unless an exception is explicitly stated in the text that defines the
28 function. Such exception is allowed for handles to request objects in
29 Wait and Test calls (sections Communication Completion and Multiple
30 Completions ). Otherwise, a null handle can only be passed to a
31 function that allocates a new object and returns a reference to it in
32 the handle."
33
37 All MPI routines in Fortran (except for MPI_WTIME and MPI_WTICK ) have
38 an additional argument ierr at the end of the argument list. ierr is
39 an integer and has the same meaning as the return value of the routine
40 in C. In Fortran, MPI routines are subroutines, and are invoked with
41 the call statement.
42 All MPI objects (e.g., MPI_Datatype , MPI_Comm ) are of type INTEGER in
44 Fortran.
45
48 If an error occurs in an MPI function, the current MPI error handler is
49 called to handle it. By default, this error handler aborts the MPI
50 job. The error handler may be changed with MPI_Errhandler_set ; the
51 predefined error handler MPI_ERRORS_RETURN may be used to cause error
52 values to be returned (in C and Fortran; this error handler is less
53 useful in with the C++ MPI bindings. The predefined error handler
54 MPI::ERRORS_THROW_EXCEPTIONS should be used in C++ if the error value
55 needs to be recovered). Note that MPI does not guarantee that an MPI
56 program can continue past an error.
57 All MPI routines (except MPI_Wtime and MPI_Wtick ) return an error
59 value; C routines as the value of the function and Fortran routines in
60 the last argument. The C++ bindings for MPI do not return error val‐
61 ues; instead, error values are communicated by throwing exceptions of
62 type MPI::Exception (but not by default). Exceptions are only thrown
63 if the error value is not MPI::SUCCESS .
64 Note that if the MPI::ERRORS_RETURN handler is set in C++, while MPI
67 functions will return upon an error, there will be no way to recover
68 what the actual error value was.
69 MPI_SUCCESS
70 - No error; MPI routine completed successfully.
71 MPI_ERR_COMM
72 - Invalid communicator. A common error is to use a null commu‐
73 nicator in a call (not even allowed in MPI_Comm_rank ).
74
77 For more information, please see the official MPI Forum web site, which
78 contains the text of both the MPI-1 and MPI-2 standards. These docu‐
79 ments contain detailed information about each MPI function (most of
80 which is not duplicated in these man pages).
81 http://www.mpi-forum.org/
83
87 The LAM Team would like the thank the MPICH Team for the handy program
88 to generate man pages ("doctext" from ftp://ftp.mcs.anl.gov/pub/sow‐
89 ing/sowing.tar.gz ), the initial formatting, and some initial text for
90 most of the MPI-1 man pages.
91
93 cfree.c
94LAM/MPI 7.1.2 2/23/2006 MPI_Comm_free(3)