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