1MPIL_Signal(3)                      LAM/MPI                     MPIL_Signal(3)
2
3
4

NAME

6       MPIL_Signal -  LAM/MPI-specific function to send a LAM signal to a rank
7       in an MPI communicator
8

SYNOPSIS

10       #include <mpi.h>
11       int MPIL_Signal(MPI_Comm comm, int rank, int signo)
12

INPUT PARAMETERS

14       comm   - MPI communicator (handle)
15       rank   - rank to send it to
16       signo  - signal number
17
18

NOTES

20       An asynchronous signal is delivered from one process  to  another  with
21       MPIL_Signal().   The target process is selected with a communicator and
22       a process rank  within  that  communicator.   The  remaining  argument,
23       signo,  identifies  the signal to be delivered.  These signals are com‐
24       pletely apart from the signals provided  by  the  underlying  operating
25       system.  LAM signals, defined in <lam_ksignal.h>, are listed below.
26
27       LAM_SIGTRACE   1    unload trace data
28       LAM_SIGC       2    user defined
29       LAM_SIGARECV   3    async receive pending
30       LAM_SIGUDIE    4    terminate
31       LAM_SIGARREST  5    suspend execution
32       LAM_SIGRELEASE 6    continue execution
33       LAM_SIGA       7    user defined
34       LAM_SIGB       8    user defined
35       LAM_SIGFUSE    9    node about to die
36       LAM_SIGSHRINK  10   another node has died
37
38       This  is  a  LAM/MPI-specific function.  Most users should not have use
39       for this function.  If this function is used, it should be used in con‐
40       junction with the LAM_MPI C preprocessor macro
41
42       #if LAM_MPI
43       MPIL_Signal(MPI_COMM_WORLD, 0, LAM_SIGUDIE);
44       #endif
45
46
47

NOTES FOR FORTRAN

49       All  MPI routines in Fortran (except for MPI_WTIME and MPI_WTICK ) have
50       an additional argument ierr at the end of the argument list.   ierr  is
51       an  integer and has the same meaning as the return value of the routine
52       in C.  In Fortran, MPI routines are subroutines, and are  invoked  with
53       the call statement.
54
55       All MPI objects (e.g., MPI_Datatype , MPI_Comm ) are of type INTEGER in
56       Fortran.
57
58

ERRORS

60       If an error occurs in an MPI function, the current MPI error handler is
61       called  to  handle  it.   By default, this error handler aborts the MPI
62       job.  The error handler may be changed with  MPI_Errhandler_set  ;  the
63       predefined  error  handler MPI_ERRORS_RETURN may be used to cause error
64       values to be returned (in C and Fortran; this  error  handler  is  less
65       useful  in  with  the  C++  MPI bindings.  The predefined error handler
66       MPI::ERRORS_THROW_EXCEPTIONS should be used in C++ if the  error  value
67       needs  to  be recovered).  Note that MPI does not guarantee that an MPI
68       program can continue past an error.
69
70       All MPI routines (except MPI_Wtime and  MPI_Wtick  )  return  an  error
71       value;  C routines as the value of the function and Fortran routines in
72       the last argument.  The C++ bindings for MPI do not return  error  val‐
73       ues;  instead,  error values are communicated by throwing exceptions of
74       type MPI::Exception (but not by default).  Exceptions are  only  thrown
75       if the error value is not MPI::SUCCESS .
76
77
78       Note  that  if  the MPI::ERRORS_RETURN handler is set in C++, while MPI
79       functions will return upon an error, there will be no  way  to  recover
80       what the actual error value was.
81       MPI_SUCCESS
82              - No error; MPI routine completed successfully.
83       MPI_ERR_COMM
84              -  Invalid communicator.  A common error is to use a null commu‐
85              nicator in a call (not even allowed in MPI_Comm_rank ).
86       MPI_ERR_RANK
87              - Invalid source or destination rank.   Ranks  must  be  between
88              zero  and  the  size  of  the communicator minus one; ranks in a
89              receive ( MPI_Recv , MPI_Irecv , MPI_Sendrecv , etc.)  may  also
90              be MPI_ANY_SOURCE .
91
92       MPI_ERR_OTHER
93              -  Other  error;  use  MPI_Error_string  to get more information
94              about this error code.
95
96

SEE ALSO

98       lam_ksignal
99

LOCATION

101       mpil_signal.c
102
103
104
105LAM/MPI 7.1.2                      2/23/2006                    MPIL_Signal(3)
Impressum