1XMPI_Buoy(3) LAM/MPI XMPI_Buoy(3)
2
6 XMPI_Buoy - LAM/MPI-specific function to drop a buoy in the XMPI trace
7 stream.
8
10 #include <mpi.h>
11 int
12 XMPI_Buoy(const char* name)
13
15 name - buoy name (string)
16
19 The LAM implementation of MPI is integrated with the XMPI run/debug
20 viewer. It can generate tracefiles and on-the-fly trace streams suit‐
21 able for display in XMPI.
22 A new functionality in XMPI is the ability to view "buoys" in the trace
24 stream that can be helpful in marking particular sections of code.
25 LAM/MPI allows the dropping of buoys with the XMPI_Buoy function.
26 Calling XMPI_Buoy with a string will drop a bouy of that name (if trac‐
27 ing is enabled) in the trace stream. Dropping a buoy is a local
28 action; the call will return immediately. The buoy is dropped in the
29 trace stream of the local rank, and will appear on the corresponding
30 rank timeline in XMPI.
31 The name can be a maximum of 32 characters long; if it is longer, it
33 will be truncated.
34 If this function is invoked and tracing is not active, the buoy is
36 ignored.
37 There is no profiling version of this function.
39 This is a LAM/MPI-specific function and is intended mainly for use with
41 XMPI. If this function is used, it should be used in conjunction with
42 the LAM_MPI C preprocessor macro
43 #if LAM_MPI
45 XMPI_Buoy("my function begins");
46 // ... message passing code
47 XMPI_Buoy("my function ends");
48 #endif
49
53 All MPI routines in Fortran (except for MPI_WTIME and MPI_WTICK ) have
54 an additional argument ierr at the end of the argument list. ierr is
55 an integer and has the same meaning as the return value of the routine
56 in C. In Fortran, MPI routines are subroutines, and are invoked with
57 the call statement.
58 All MPI objects (e.g., MPI_Datatype , MPI_Comm ) are of type INTEGER in
60 Fortran.
61
64 If an error occurs in an MPI function, the current MPI error handler is
65 called to handle it. By default, this error handler aborts the MPI
66 job. The error handler may be changed with MPI_Errhandler_set ; the
67 predefined error handler MPI_ERRORS_RETURN may be used to cause error
68 values to be returned (in C and Fortran; this error handler is less
69 useful in with the C++ MPI bindings. The predefined error handler
70 MPI::ERRORS_THROW_EXCEPTIONS should be used in C++ if the error value
71 needs to be recovered). Note that MPI does not guarantee that an MPI
72 program can continue past an error.
73 All MPI routines (except MPI_Wtime and MPI_Wtick ) return an error
75 value; C routines as the value of the function and Fortran routines in
76 the last argument. The C++ bindings for MPI do not return error val‐
77 ues; instead, error values are communicated by throwing exceptions of
78 type MPI::Exception (but not by default). Exceptions are only thrown
79 if the error value is not MPI::SUCCESS .
80 Note that if the MPI::ERRORS_RETURN handler is set in C++, while MPI
83 functions will return upon an error, there will be no way to recover
84 what the actual error value was.
85 MPI_SUCCESS
86 - No error; MPI routine completed successfully.
87 MPI_ERR_ARG
88 - Invalid argument. Some argument is invalid and is not identi‐
89 fied by a specific error class. This is typically a NULL
90 pointer or other such error.
91 MPI_ERR_INTERN
92 - An internal error has been detected. This is fatal. Please
93 send a bug report to the LAM mailing list (see http://www.lam-
94 mpi.org/contact.php ).
95
98 XMPI_Coloron, XMPI_Coloroff
99
101 xbuoy.c
102LAM/MPI 7.1.2 2/23/2006 XMPI_Buoy(3)