pmix_abort(3)

1pmix_abort(3)                      @VERSION@                     pmix_abort(3)
2
3
4

NAME

6       PMIx_Abort - Abort the specified processes
7

SYNOPSIS

9              #include <pmix.h>
10
11              pmix\_status\_t PMIx\_Abort(int status, const char msg[],
12                                       pmix\_proc\_t procs[], size_t nprocs);
13

ARGUMENTS

15       status  : Status value to be returned.  A value of zero is permitted by
16       PMIx, but may not be returned by some resource managers.
17
18       msg : A string message to be displayed
19
20       procs : An array of pmix_proc_t structures defining the processes to be
21       aborted.  A NULL for the proc array indicates that all processes in the
22       caller's nspace are to be aborted.  A wildcard value for  the  rank  in
23       any  structure  indicates  that  all processes in that nspace are to be
24       aborted.
25
26       nprocs : Number of pmix_proc_t structures in the procs array
27

DESCRIPTION

29       Request that the provided array of procs be aborted, returning the pro‐
30       vided  status  and  printing the provided message.  A NULL for the proc
31       array indicates that all processes in the caller's  nspace  are  to  be
32       aborted.
33
34       The  response  to  this  request  is somewhat dependent on the specific
35       resource manager and its configuration (e.g.,  some  resource  managers
36       will  not  abort  the application if the provided status is zero unless
37       specifically configured to do so), and thus lies outside the control of
38       PMIx  itself.   However,  the  client will inform the RM of the request
39       that the application be aborted, regardless of the value  of  the  pro‐
40       vided status.
41
42       Passing  a  NULL  msg  parameter is allowed.  Note that race conditions
43       caused by multiple processes calling PMIx_Abort are left to the  server
44       implementation  to  resolve with regard to which status is returned and
45       what messages (if any) are printed.
46

RETURN VALUE

48       Returns PMIX_SUCCESS on success.  On error,  a  negative  value  corre‐
49       sponding to a PMIx errno is returned.
50

ERRORS

52       PMIx errno values are defined in pmix_common.h.
53

NOTES

AUTHORS

57       PMIx.
58
59
60
61PMIx Programmer's Manual          2016-03-01                     pmix_abort(3)