Skip to content

Commit

Permalink
Assign values to remaining constants
Browse files Browse the repository at this point in the history
Finish assigning values to constants as defined in OpenPMIx. This is
basically a revert of
a256e08
and
296edb4
from #359.

Refs #358.

Signed-off-by: Ken Raffenetti <[email protected]>
  • Loading branch information
raffenet committed Feb 15, 2022
1 parent dd1cc36 commit 8dd83b8
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 13 deletions.
4 changes: 2 additions & 2 deletions Chap_API_Event.tex
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ \subsection{System events}

\begin{constantdesc}
%
\declareconstitemNEW{PMIX_EVENT_SYS_BASE}
\declareconstitemvalueNEW{PMIX_EVENT_SYS_BASE}{-230}
Mark the beginning of a dedicated range of constants for system event reporting.
%
\declareconstitemNEW{PMIX_EVENT_NODE_DOWN}
Expand All @@ -180,7 +180,7 @@ \subsection{System events}
\declareconstitemNEW{PMIX_EVENT_NODE_OFFLINE}
A node has been marked as \emph{offline} - the identifier of the affected node will be included in the notification.
%
\declareconstitemNEW{PMIX_EVENT_SYS_OTHER}
\declareconstitemvalueNEW{PMIX_EVENT_SYS_OTHER}{-330}
Mark the end of a dedicated range of constants for system event reporting.
%
\end{constantdesc}
Expand Down
2 changes: 1 addition & 1 deletion Chap_API_Job_Mgmt.tex
Original file line number Diff line number Diff line change
Expand Up @@ -287,7 +287,7 @@ \subsection{Job Allocation Directives}
\declareconstitem{PMIX_ALLOC_REAQUIRE}
Reacquire resources that were previously ``lent'' back to the scheduler.
%
\declareconstitem{PMIX_ALLOC_EXTERNAL}
\declareconstitemvalue{PMIX_ALLOC_EXTERNAL}{128}
A value boundary above which implementers are free to define their own directive values.
%
\end{constantdesc}
Expand Down
20 changes: 10 additions & 10 deletions Chap_API_Struct.tex
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ \section{Constants}

\begin{constantdesc}
%
\declareconstitem{PMIX_MAX_NSLEN}
\declareconstitemvalue{PMIX_MAX_NSLEN}{255}
Maximum namespace string length as an integer.
\end{constantdesc}

Expand All @@ -78,7 +78,7 @@ \section{Constants}

\begin{constantdesc}
%
\declareconstitem{PMIX_MAX_KEYLEN}
\declareconstitemvalue{PMIX_MAX_KEYLEN}{511}
Maximum key string length as an integer.
\end{constantdesc}

Expand Down Expand Up @@ -237,7 +237,7 @@ \subsubsection{User-Defined Error and Event Constants}

\begin{constantdesc}
%
\declareconstitem{PMIX_EXTERNAL_ERR_BASE}
\declareconstitemvalue{PMIX_EXTERNAL_ERR_BASE}{-3000}
A starting point for user-level defined error and event constants.
Negative values that are more negative than the defined constant are guaranteed not to conflict with \ac{PMIx} values.
Definitions should always be based on the \refconst{PMIX_EXTERNAL_ERR_BASE} constant and not a specific value as the value of the constant may change.
Expand Down Expand Up @@ -721,14 +721,14 @@ \subsection{Process State Structure}
\declareconstitem{PMIX_PROC_STATE_CONNECTED}
Process has connected to PMIx server.
%
\declareconstitem{PMIX_PROC_STATE_UNTERMINATED}
\declareconstitemvalue{PMIX_PROC_STATE_UNTERMINATED}{15}
Define a ``boundary'' between the terminated states and \refconst{PMIX_PROC_STATE_CONNECTED} so users can easily and quickly determine if a process is still running or not.
Any value less than this constant means that the process has not terminated.
%
\declareconstitem{PMIX_PROC_STATE_TERMINATED}
\declareconstitemvalue{PMIX_PROC_STATE_TERMINATED}{20}
Process has terminated and is no longer running.
%
\declareconstitem{PMIX_PROC_STATE_ERROR}
\declareconstitemvalue{PMIX_PROC_STATE_ERROR}{50}
Define a boundary so users can easily and quickly determine if a process abnormally terminated.
Any value above this constant means that the process has terminated abnormally.
%
Expand Down Expand Up @@ -908,14 +908,14 @@ \subsection{Job State Structure}
\declareconstitemNEW{PMIX_JOB_STATE_CONNECTED}
All processes in the job have connected to their \ac{PMIx} server.
%
\declareconstitemNEW{PMIX_JOB_STATE_UNTERMINATED}
\declareconstitemvalue{PMIX_JOB_STATE_UNTERMINATED}{15}
Define a ``boundary'' between the terminated states and \refconst{PMIX_JOB_STATE_TERMINATED} so users can easily and quickly determine if a job is still running or not.
Any value less than this constant means that the job has not terminated.
%
\declareconstitemNEW{PMIX_JOB_STATE_TERMINATED}
\declareconstitemvalue{PMIX_JOB_STATE_TERMINATED}{20}
All processes in the job have terminated and are no longer running - typically will be accompanied by the job exit status in response to a query.
%
\declareconstitemNEW{PMIX_JOB_STATE_TERMINATED_WITH_ERROR}
\declareconstitemvalue{PMIX_JOB_STATE_TERMINATED_WITH_ERROR}{50}
Define a boundary so users can easily and quickly determine if a job abnormally terminated - typically will be accompanied by a job-related error code in response to a query
Any value above this constant means that the job terminated abnormally.
%
Expand Down Expand Up @@ -2211,7 +2211,7 @@ \section{Generalized Data Types Used for Packing/Unpacking}
\declareconstitemNEW{PMIX_LOCTYPE}
Bitmask describing the relative location of another process. (\refstruct{pmix_locality_t}).
%
\declareconstitemNEW{PMIX_DATA_TYPE_MAX}
\declareconstitemvalue{PMIX_DATA_TYPE_MAX}{500}
A starting point for implementer-specific data types.
Values above this are guaranteed not to conflict with \ac{PMIx} values.
Definitions should always be based on the \refconst{PMIX_DATA_TYPE_MAX} constant and not a specific value as the value of the constant may change.
Expand Down

0 comments on commit 8dd83b8

Please sign in to comment.