1XMPI_Coloroff(3) LAM/MPI XMPI_Coloroff(3)
2
6 XMPI_Coloroff - LAM/MPI-specific function to disable a color in the
7 XMPI trace stream.
8
10 #include <mpi.h>
11 int
12 XMPI_Coloroff()
13
15 The LAM implementation of MPI is integrated with the XMPI run/debug
16 viewer. It can generate tracefiles and on-the-fly trace streams suit‐
17 able for display in XMPI.
18 A new functionality in XMPI is the ability to enable and disable select
20 colors in the trace stream. LAM/MPI allows this functionality with the
21 XMPI_Coloron and XMPI_Coloroff functions.
22 XMPI_Coloron is called with red , green , and blue parameters. Each
24 value may be from 0 to 255. The resulting RGB composite will become
25 activated for that rank at that point in time. Enabling and disabling
26 colors is a local action; the calls will return immediately. The color
27 will be activated or deactivated on the timeline corresponding to the
28 rank that invoked XMPI_Coloron / XMPI_Colorff in the XMPI trace window.
29 Only one color is active at a time. However, XMPI_Coloron may be
31 invoked multiple times to build a stack of colors. XMPI_Coloroff will
32 pop the last color off the stack and make the previous color active.
33 If this function is invoked and tracing is not active, the color deac‐
35 tivation is ignored.
36 There is no profiling version of this function.
38 This is a LAM/MPI-specific function and is intended mainly for use with
40 XMPI. If this function is used, it should be used in conjunction with
41 the LAM_MPI C preprocessor macro
42 #if LAM_MPI
44 XMPI_Coloroff();
45 #endif
46
50 All MPI routines in Fortran (except for MPI_WTIME and MPI_WTICK ) have
51 an additional argument ierr at the end of the argument list. ierr is
52 an integer and has the same meaning as the return value of the routine
53 in C. In Fortran, MPI routines are subroutines, and are invoked with
54 the call statement.
55 All MPI objects (e.g., MPI_Datatype , MPI_Comm ) are of type INTEGER in
57 Fortran.
58
61 If an error occurs in an MPI function, the current MPI error handler is
62 called to handle it. By default, this error handler aborts the MPI
63 job. The error handler may be changed with MPI_Errhandler_set ; the
64 predefined error handler MPI_ERRORS_RETURN may be used to cause error
65 values to be returned (in C and Fortran; this error handler is less
66 useful in with the C++ MPI bindings. The predefined error handler
67 MPI::ERRORS_THROW_EXCEPTIONS should be used in C++ if the error value
68 needs to be recovered). Note that MPI does not guarantee that an MPI
69 program can continue past an error.
70 All MPI routines (except MPI_Wtime and MPI_Wtick ) return an error
72 value; C routines as the value of the function and Fortran routines in
73 the last argument. The C++ bindings for MPI do not return error val‐
74 ues; instead, error values are communicated by throwing exceptions of
75 type MPI::Exception (but not by default). Exceptions are only thrown
76 if the error value is not MPI::SUCCESS .
77 Note that if the MPI::ERRORS_RETURN handler is set in C++, while MPI
80 functions will return upon an error, there will be no way to recover
81 what the actual error value was.
82 MPI_SUCCESS
83 - No error; MPI routine completed successfully.
84 MPI_ERR_INTERN
85 - An internal error has been detected. This is fatal. Please
86 send a bug report to the LAM mailing list (see http://www.lam-
87 mpi.org/contact.php ).
88
91 XMPI_Buoy, XMPI_Coloron
92
94 xcoloroff.c
95LAM/MPI 7.1.2 2/23/2006 XMPI_Coloroff(3)