Skip to content

Commit

Permalink
Adding text for Quiet per PE interface
Browse files Browse the repository at this point in the history
  • Loading branch information
manjugv committed Nov 15, 2019
1 parent 30a662c commit c125155
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 1 deletion.
41 changes: 41 additions & 0 deletions content/shmem_pe_quiet.tex
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
\apisummary{
Waits for completion of all outstanding memory store, blocking
\PUT{}, \ac{AMO}, and \emph{put-with-signal}, as well as
nonblocking \PUT{}, \emph{put-with-signal}, and \GET{} routines
to symmetric data objects issued by the calling \ac{PE} at the target \ac{PE}.
}

\begin{apidefinition}

\begin{Csynopsis}
void @\FuncDecl{shmem\_pe\_quiet}@(int target_pe);
void @\FuncDecl{shmem\_ctx\_pe\_quiet}@(shmem_ctx_t ctx, int target_pe);
\end{Csynopsis}

\begin{apiarguments}
\apiargument{IN}{ctx}{A context handle specifying the context on which to perform the operation.
When this argument is not provided, the operation is performed on
the default context.}
\apiargument{IN}{target\_pe}{The target \ac{PE} where the operations needs
to be completed}
\end{apiarguments}

\apidescription{
The \FUNC{shmem\_pe\_quiet} ensures completion of memory store, blocking
\PUT{}, \ac{AMO}, and \emph{put-with-signal}, as well as
nonblocking \PUT{}, \emph{put-with-signal}, and \GET{} routines
on the symmetric data objects issued by the
calling \ac{PE} to the target \ac{PE} and on the given context.

The completion and visibility semantics of these routines are same as the
\FUNC{shmem\_quiet} routine, however, it applies only to the target \ac{PE}
.i.e., the routines to target \ac{PE} are guaranteed to be completed and
visible to all \ac{PE} when \FUNC{shmem\_pe\_quiet} returns.
}
\apireturnvalues{
None.
}

\apinotes{
}
\end{apidefinition}
4 changes: 3 additions & 1 deletion main_spec.tex
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,6 @@ \subsection{Memory Management Routines}
\subsubsection{\textbf{SHMEM\_MALLOC, SHMEM\_FREE, SHMEM\_REALLOC, SHMEM\_ALIGN}}\label{subsec:shfree}
\input{content/shmem_malloc.tex}

\newpage
\subsubsection{\textbf{SHMEM\_MALLOC\_WITH\_HINTS}}\label{subsec:shmmallochint}
\input{content/shmem_malloc_hints.tex}

Expand Down Expand Up @@ -481,6 +480,9 @@ \subsubsection{\textbf{SHMEM\_FENCE}}\label{subsec:shmem_fence}
\subsubsection{\textbf{SHMEM\_QUIET}}\label{subsec:shmem_quiet}
\input{content/shmem_quiet.tex}

\subsubsection{\textbf{SHMEM\_PE\_QUIET}}\label{subsec:shmem_quiet}
\input{content/shmem_pe_quiet.tex}

\subsubsection{Synchronization and Communication Ordering in OpenSHMEM}
\input{content/synchronization_model.tex}

Expand Down

0 comments on commit c125155

Please sign in to comment.