Skip to content

Commit

Permalink
Merge branch 'master' into rfc/groups
Browse files Browse the repository at this point in the history
  • Loading branch information
rhc54 authored Jan 15, 2019
2 parents 9b36967 + 98e2de7 commit 34f9f30
Show file tree
Hide file tree
Showing 10 changed files with 444 additions and 44 deletions.
4 changes: 4 additions & 0 deletions Chap_API_Event.tex
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,8 @@ \subsection{\code{PMIx_Register_event_handler}}
\pastePRIAttributeItem{PMIX_RANGE}
\pastePRIAttributeItem{PMIX_EVENT_RETURN_OBJECT}

\divider

Host environments that implement support for \ac{PMIx} event notification are required to support the following attributes:

\pastePRRTEAttributeItem{PMIX_EVENT_AFFECTED_PROC}
Expand Down Expand Up @@ -244,6 +246,8 @@ \subsection{\code{PMIx_Notify_event}}
\pastePRIAttributeItem{PMIX_EVENT_NON_DEFAULT}
\pastePRIAttributeItem{PMIX_EVENT_CUSTOM_RANGE}

\divider

Host environments that implement support for \ac{PMIx} event notification are required to provide the following attributes for all events generated by the environment:

\pastePRRTEAttributeItem{PMIX_EVENT_AFFECTED_PROC}
Expand Down
16 changes: 13 additions & 3 deletions Chap_API_Job_Mgmt.tex
Original file line number Diff line number Diff line change
Expand Up @@ -160,10 +160,8 @@ \subsection{\code{PMIx_Query_info_nb}}

\ac{PMIx} libraries are not required to directly support any other attributes for this function. However, any provided attributes must be passed to the host \ac{SMS} daemon for processing, and the \ac{PMIx} library is \textit{required} to add the \refPRIAttributeItem{PMIX_USERID} and the \refPRIAttributeItem{PMIX_GRPID} attributes of the client process making the request.

\reqattrend

\divider

\reqattrstart
Host environments that support this operation are required to support the following attributes as qualifiers to the request:

\pastePRRTEAttributeItemBegin{PMIX_PROCID} Specifies the process ID whose information is being requested - e.g., a query asking for the \refattr{PMIX_LOCAL_RANK} of a specified process. Only required when the request is for information on a specific process.
Expand Down Expand Up @@ -298,6 +296,8 @@ \subsection{\code{PMIx_Allocation_request}}
\reqattrstart
\ac{PMIx} libraries are not required to directly support any attributes for this function. However, any provided attributes must be passed to the host \ac{SMS} daemon for processing, and the \ac{PMIx} library is \textit{required} to add the \refPRIAttributeItem{PMIX_USERID} and the \refPRIAttributeItem{PMIX_GRPID} attributes of the client process making the request.

\divider

Host environments that implement support for this operation are required to support the following attributes:

\pasteAttributeItem{PMIX_ALLOC_ID}
Expand Down Expand Up @@ -387,6 +387,8 @@ \subsection{\code{PMIx_Allocation_request_nb}}
\reqattrstart
\ac{PMIx} libraries are not required to directly support any attributes for this function. However, any provided attributes must be passed to the host \ac{SMS} daemon for processing, and the \ac{PMIx} library is \textit{required} to add the \refPRIAttributeItem{PMIX_USERID} and the \refPRIAttributeItem{PMIX_GRPID} attributes of the client process making the request.

\divider

Host environments that implement support for this operation are required to support the following attributes:

\pasteAttributeItem{PMIX_ALLOC_ID}
Expand Down Expand Up @@ -475,6 +477,8 @@ \subsection{\code{PMIx_Job_control}}
\reqattrstart
\ac{PMIx} libraries are not required to directly support any attributes for this function. However, any provided attributes must be passed to the host \ac{SMS} daemon for processing, and the \ac{PMIx} library is \textit{required} to add the \refPRIAttributeItem{PMIX_USERID} and the \refPRIAttributeItem{PMIX_GRPID} attributes of the client process making the request.

\divider

Host environments that implement support for this operation are required to support the following attributes:

\pastePRRTEAttributeItem{PMIX_JOB_CTRL_ID}
Expand Down Expand Up @@ -561,6 +565,8 @@ \subsection{\code{PMIx_Job_control_nb}}
\reqattrstart
\ac{PMIx} libraries are not required to directly support any attributes for this function. However, any provided attributes must be passed to the host \ac{SMS} daemon for processing, and the \ac{PMIx} library is \textit{required} to add the \refPRIAttributeItem{PMIX_USERID} and the \refPRIAttributeItem{PMIX_GRPID} attributes of the client process making the request.

\divider

Host environments that implement support for this operation are required to support the following attributes:

\pastePRRTEAttributeItem{PMIX_JOB_CTRL_ID}
Expand Down Expand Up @@ -828,6 +834,8 @@ \subsection{\code{PMIx_Log}}
\pastePRIAttributeItem{PMIX_USERID}
\pastePRIAttributeItem{PMIX_GRPID}

\divider

Host environments or \ac{PMIx} libraries that implement support for this operation are required to support the following attributes:

\pastePRIAttributeItem{PMIX_LOG_STDERR}
Expand Down Expand Up @@ -913,6 +921,8 @@ \subsection{\code{PMIx_Log_nb}}
\pastePRIAttributeItem{PMIX_USERID}
\pastePRIAttributeItem{PMIX_GRPID}

\divider

Host environments or \ac{PMIx} libraries that implement support for this operation are required to support the following attributes:

\pastePRIAttributeItem{PMIX_LOG_STDERR}
Expand Down
4 changes: 4 additions & 0 deletions Chap_API_Proc_Mgmt.tex
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,8 @@ \subsection{\code{PMIx_Spawn}}
\pastePRIAttributeItem{PMIX_REQUESTOR_IS_CLIENT}
\pastePRIAttributeItem{PMIX_REQUESTOR_IS_TOOL}

\divider

Host environments that implement support for \refapi{PMIx_Spawn} are required to pass the \refattr{PMIX_SPAWNED} and \refattr{PMIX_PARENT_ID} attributes to all \ac{PMIx} servers launching new child processes so those values can be returned to clients upon connection to the \ac{PMIx} server. In addition, they are required to support the following attributes when present in either the \refarg{job_info} or the \textit{info} array of an element of the \refarg{apps} array:

\pastePRRTEAttributeItem{PMIX_WDIR}
Expand Down Expand Up @@ -214,6 +216,8 @@ \subsection{\code{PMIx_Spawn_nb}}
\pastePRIAttributeItem{PMIX_REQUESTOR_IS_CLIENT}
\pastePRIAttributeItem{PMIX_REQUESTOR_IS_TOOL}

\divider

Host environments that implement support for \refapi{PMIx_Spawn} are required to pass the \refattr{PMIX_SPAWNED} and \refattr{PMIX_PARENT_ID} attributes to all \ac{PMIx} servers launching new child processes so those values can be returned to clients upon connection to the \ac{PMIx} server. In addition, they are required to support the following attributes when present in either the \refarg{job_info} or the \textit{info} array of an element of the \refarg{apps} array:

\pastePRRTEAttributeItem{PMIX_WDIR}
Expand Down
16 changes: 4 additions & 12 deletions Chap_API_Security.tex
Original file line number Diff line number Diff line change
Expand Up @@ -62,15 +62,11 @@ \subsection{\code{PMIx_Get_credential}}
\reqattrstart
\ac{PMIx} libraries that choose not to support this operation \textit{must} return \refconst{PMIX_ERR_NOT_SUPPORTED} when the function is called.

There are no required attributes for this \ac{API} mplementations that support the operation may choose to internally execute integration for some security environments (e.g., directly contacting a \textit{munge} server) - there are no identified required attributes for this \ac{API}.

For implementations that support the operation, there are no identified required
attributes for this \ac{API}. Note that implementations may choose to internally
There are no required attributes for this \ac{API}. Note that implementations may choose to internally
execute integration for some security environments (e.g., directly
contacting a \textit{munge} server).

Finally, for implementations that support the operation but the client's request
cannot be processed by the \ac{PMIx} library itself, then any attributes that are provided by the client must be passed to the host environment for processing. In addition, the following attributes are required to be included in the \refarg{info} array passed from the \ac{PMIx} library to the host environment:
Implementations that support the operation but cannot directly process the client's request must pass any attributes that are provided by the client to the host environment for processing. In addition, the following attributes are required to be included in the \refarg{info} array passed from the \ac{PMIx} library to the host environment:

\pastePRIAttributeItem{PMIX_USERID}
\pastePRIAttributeItem{PMIX_GRPID}
Expand Down Expand Up @@ -141,15 +137,11 @@ \subsection{\code{PMIx_Validate_credential}}
\reqattrstart
\ac{PMIx} libraries that choose not to support this operation \textit{must} return \refconst{PMIX_ERR_NOT_SUPPORTED} when the function is called.

There are no required attributes for this \ac{API} mplementations that support the operation may choose to internally execute integration for some security environments (e.g., directly contacting a \textit{munge} server) - there are no identified required attributes for this \ac{API}.

For implementations that support the operation, there are no identified required
attributes for this \ac{API}. Note that implementations may choose to internally
There are no required attributes for this \ac{API}. Note that implementations may choose to internally
execute integration for some security environments (e.g., directly
contacting a \textit{munge} server).

Finally, for implementations that support the operation but the client's request
cannot be processed by the \ac{PMIx} library itself, then any attributes that are provided by the client must be passed to the host environment for processing. In addition, the following attributes are required to be included in the \refarg{info} array passed from the \ac{PMIx} library to the host environment:
Implementations that support the operation but cannot directly process the client's request must pass any attributes that are provided by the client to the host environment for processing. In addition, the following attributes are required to be included in the \refarg{info} array passed from the \ac{PMIx} library to the host environment:

\pastePRIAttributeItem{PMIX_USERID}
\pastePRIAttributeItem{PMIX_GRPID}
Expand Down
27 changes: 27 additions & 0 deletions Chap_API_Server.tex
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,8 @@ \subsection{\code{PMIx_server_register_nspace}}

\pastePRIAttributeItem{PMIX_REGISTER_NODATA}

\divider

Host environments are \textit{required} to provide the following attributes:

\begin{itemize}
Expand Down Expand Up @@ -1261,6 +1263,8 @@ \subsection{\code{pmix_server_fencenb_fn_t}}
\reqattrstart
\ac{PMIx} libraries are required to pass any provided attributes to the host environment for processing.

\divider

The following attributes are required to be supported by all host environments:

\pastePRRTEAttributeItem{PMIX_COLLECT_DATA}
Expand Down Expand Up @@ -1410,6 +1414,8 @@ \subsection{\code{pmix_server_publish_fn_t}}
\pastePRIAttributeItem{PMIX_USERID}
\pastePRIAttributeItem{PMIX_GRPID}

\divider

Host environments that implement this entry point are required to support the following attributes:

\pastePRRTEAttributeItem{PMIX_RANGE}
Expand Down Expand Up @@ -1489,6 +1495,8 @@ \subsection{\code{pmix_server_lookup_fn_t}}
\pastePRIAttributeItem{PMIX_USERID}
\pastePRIAttributeItem{PMIX_GRPID}

\divider

Host environments that implement this entry point are required to support the following attributes:

\pastePRRTEAttributeItem{PMIX_RANGE}
Expand Down Expand Up @@ -1566,6 +1574,8 @@ \subsection{\code{pmix_server_unpublish_fn_t}}
\pastePRIAttributeItem{PMIX_USERID}
\pastePRIAttributeItem{PMIX_GRPID}

\divider

Host environments that implement this entry point are required to support the following attributes:

\pastePRRTEAttributeItem{PMIX_RANGE}
Expand Down Expand Up @@ -1641,6 +1651,8 @@ \subsection{\code{pmix_server_spawn_fn_t}}
\pastePRIAttributeItem{PMIX_USERID}
\pastePRIAttributeItem{PMIX_GRPID}

\divider

Host environments that provide this module entry point are required to pass the \refattr{PMIX_SPAWNED} and \refattr{PMIX_PARENT_ID} attributes to all \ac{PMIx} servers launching new child processes so those values can be returned to clients upon connection to the \ac{PMIx} server. In addition, they are required to support the following attributes when present in either the \refarg{job_info} or the \textit{info} array of an element of the \refarg{apps} array:

\pastePRRTEAttributeItem{PMIX_WDIR}
Expand Down Expand Up @@ -2009,6 +2021,8 @@ \subsection{\code{pmix_server_notify_event_fn_t}}
\reqattrstart
\ac{PMIx} libraries are required to pass any provided attributes to the host environment for processing.

\divider

Host environments that provide this module entry point are required to support the following attributes:

\pastePRRTEAttributeItem{PMIX_RANGE}
Expand Down Expand Up @@ -2244,6 +2258,8 @@ \subsection{\code{pmix_server_log_fn_t}}
\pastePRIAttributeItem{PMIX_USERID}
\pastePRIAttributeItem{PMIX_GRPID}

\divider

Host environments that provide this module entry point are required to support the following attributes:

\pastePRRTEAttributeItem{PMIX_LOG_STDERR}
Expand Down Expand Up @@ -2310,10 +2326,13 @@ \subsection{\code{pmix_server_alloc_fn_t}}
\end{itemize}

\reqattrstart
\ac{PMIx} libraries are required to pass any provided attributes to the host environment for processing. In addition, the following attributes are required to be included in the passed \refarg{info} array:

\pastePRIAttributeItem{PMIX_USERID}
\pastePRIAttributeItem{PMIX_GRPID}

\divider

Host environments that provide this module entry point are required to support the following attributes:

\pasteAttributeItem{PMIX_ALLOC_ID}
Expand Down Expand Up @@ -2404,6 +2423,8 @@ \subsection{\code{pmix_server_job_control_fn_t}}
\pastePRIAttributeItem{PMIX_USERID}
\pastePRIAttributeItem{PMIX_GRPID}

\divider

Host environments that provide this module entry point are required to support the following attributes:

\pastePRRTEAttributeItem{PMIX_JOB_CTRL_ID}
Expand Down Expand Up @@ -2491,6 +2512,8 @@ \subsection{\code{pmix_server_monitor_fn_t}}
\pastePRIAttributeItem{PMIX_USERID}
\pastePRIAttributeItem{PMIX_GRPID}

\divider

Host environments are not required to support any specific monitoring attributes.

\reqattrend
Expand Down Expand Up @@ -2636,6 +2659,8 @@ \subsection{\code{pmix_server_validate_cred_fn_t}}
\pastePRIAttributeItem{PMIX_USERID}
\pastePRIAttributeItem{PMIX_GRPID}

\divider

Host environments are not required to support any specific attributes.

\reqattrend
Expand Down Expand Up @@ -2705,6 +2730,8 @@ \subsection{\code{pmix_server_iof_fn_t}}
\pastePRIAttributeItem{PMIX_USERID}
\pastePRIAttributeItem{PMIX_GRPID}

\divider

Host environments that provide this module entry point are required to support the following attributes:

\pastePRRTEAttributeItem{PMIX_IOF_CACHE_SIZE}
Expand Down
Loading

0 comments on commit 34f9f30

Please sign in to comment.