108 lines
3.0 KiB
Groff
108 lines
3.0 KiB
Groff
.\" Man page generated from reStructuredText.
|
||
.
|
||
.TH "PMIX_ABORT" "3" "Feb 14, 2025" "" "OpenPMIx"
|
||
.
|
||
.nr rst2man-indent-level 0
|
||
.
|
||
.de1 rstReportMargin
|
||
\\$1 \\n[an-margin]
|
||
level \\n[rst2man-indent-level]
|
||
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||
-
|
||
\\n[rst2man-indent0]
|
||
\\n[rst2man-indent1]
|
||
\\n[rst2man-indent2]
|
||
..
|
||
.de1 INDENT
|
||
.\" .rstReportMargin pre:
|
||
. RS \\$1
|
||
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
|
||
. nr rst2man-indent-level +1
|
||
.\" .rstReportMargin post:
|
||
..
|
||
.de UNINDENT
|
||
. RE
|
||
.\" indent \\n[an-margin]
|
||
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||
.nr rst2man-indent-level -1
|
||
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
||
..
|
||
.sp
|
||
PMIx_Abort \- Abort the specified processes
|
||
.SH SYNOPSIS
|
||
.INDENT 0.0
|
||
.INDENT 3.5
|
||
.sp
|
||
.nf
|
||
.ft C
|
||
#include <pmix.h>
|
||
|
||
pmix_status_t PMIx_Abort(int status, const char msg[],
|
||
pmix_proc_t procs[], size_t nprocs);
|
||
.ft P
|
||
.fi
|
||
.UNINDENT
|
||
.UNINDENT
|
||
.SH ARGUMENTS
|
||
.INDENT 0.0
|
||
.IP \(bu 2
|
||
\fBstatus\fP: Status value to be returned. A value of zero is
|
||
permitted by PMIx, but may not be returned by some resource
|
||
managers.
|
||
.IP \(bu 2
|
||
\fBmsg\fP: A string message to be displayed.
|
||
.IP \(bu 2
|
||
\fBprocs\fP: An array of \fBpmix_proc_t\fP structures defining the
|
||
processes to be aborted. A NULL for the proc array indicates that
|
||
all processes in the caller’s namespace are to be aborted. A
|
||
wildcard value for the rank in any structure indicates that all
|
||
processes in that namespace are to be aborted.
|
||
.IP \(bu 2
|
||
\fBnprocs\fP: Number of \fBpmix_proc_t\fP structures in the \fBprocs\fP
|
||
array.
|
||
.UNINDENT
|
||
.SH DESCRIPTION
|
||
.sp
|
||
Request that the provided array of procs be aborted, returning the
|
||
provided status and printing the provided message. A NULL for the
|
||
\fBprocs\fP array indicates that all processes in the caller’s namespace
|
||
are to be aborted.
|
||
.sp
|
||
The response to this request is somewhat dependent on the specific
|
||
resource manager and its configuration (e.g., some resource managers
|
||
will not abort the application if the provided status is zero unless
|
||
specifically configured to do so), and thus lies outside the control
|
||
of PMIx itself. However, the client will inform the RM of the request
|
||
that the application be aborted, regardless of the value of the
|
||
provided status.
|
||
.sp
|
||
Passing a NULL \fBmsg\fP parameter is allowed. Note that race conditions
|
||
caused by multiple processes calling \fBPMIx_Abort\fP are left to the server
|
||
implementation to resolve with regard to which status is returned and
|
||
what messages (if any) are printed.
|
||
.SH RETURN VALUE
|
||
.sp
|
||
Returns \fBPMIX_SUCCESS\fP on success. On error, a negative value
|
||
corresponding to a PMIx \fBerrno\fP is returned.
|
||
.SH ERRORS
|
||
.sp
|
||
PMIx errno values are defined in \fBpmix_common.h\fP\&.
|
||
.sp
|
||
\fBSEE ALSO:\fP
|
||
.INDENT 0.0
|
||
.INDENT 3.5
|
||
PMIx_Commit(3),
|
||
\fI\%PMIx_Finalize(3)\fP,
|
||
\fI\%PMIx_Init(3)\fP,
|
||
PMIx_Initialized(3),
|
||
PMIx_Put(3),
|
||
pmiAddInstance(3),
|
||
pmiAddMetric(3)
|
||
.UNINDENT
|
||
.UNINDENT
|
||
.SH COPYRIGHT
|
||
2014-2025, The OpenPMIx Community
|
||
.\" Generated by docutils manpage writer.
|
||
.
|