Skip to content

Commit

Permalink
Removal of const in signal set, add and minor changes
Browse files Browse the repository at this point in the history
  • Loading branch information
wrrobin committed Aug 28, 2024
1 parent 1d6f40e commit 1a7bf49
Show file tree
Hide file tree
Showing 5 changed files with 65 additions and 65 deletions.
6 changes: 3 additions & 3 deletions content/shmem_signal_add.tex
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@
\begin{apidefinition}

\begin{C11synopsis}
void @\FuncDecl{shmem\_signal\_add}@(shmem_ctx_t ctx, const uint64_t *sig_addr, uint64_t signal, int pe);
void @\FuncDecl{shmem\_signal\_add}@(shmem_ctx_t ctx, uint64_t *sig_addr, uint64_t signal, int pe);
\end{C11synopsis}

\begin{Csynopsis}
void @\FuncDecl{shmem\_signal\_add}@(const uint64_t *sig_addr, uint64_t signal, int pe);
void @\FuncDecl{shmem\_ctx\_signal\_add}@(shmem_ctx_t ctx, const uint64_t *sig_addr, uint64_t signal, int pe);
void @\FuncDecl{shmem\_signal\_add}@(uint64_t *sig_addr, uint64_t signal, int pe);
void @\FuncDecl{shmem\_ctx\_signal\_add}@(shmem_ctx_t ctx, uint64_t *sig_addr, uint64_t signal, int pe);
\end{Csynopsis}

\begin{apiarguments}
Expand Down
6 changes: 3 additions & 3 deletions content/shmem_signal_set.tex
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@
\begin{apidefinition}

\begin{C11synopsis}
void @\FuncDecl{shmem\_signal\_set}@(shmem_ctx_t ctx, const uint64_t *sig_addr, uint64_t signal, int pe);
void @\FuncDecl{shmem\_signal\_set}@(shmem_ctx_t ctx, uint64_t *sig_addr, uint64_t signal, int pe);
\end{C11synopsis}

\begin{Csynopsis}
void @\FuncDecl{shmem\_signal\_set}@(const uint64_t *sig_addr, uint64_t signal, int pe);
void @\FuncDecl{shmem\_ctx\_signal\_set}@(shmem_ctx_t ctx, const uint64_t *sig_addr, uint64_t signal, int pe);
void @\FuncDecl{shmem\_signal\_set}@(uint64_t *sig_addr, uint64_t signal, int pe);
void @\FuncDecl{shmem\_ctx\_signal\_set}@(shmem_ctx_t ctx, uint64_t *sig_addr, uint64_t signal, int pe);
\end{Csynopsis}

\begin{apiarguments}
Expand Down
2 changes: 1 addition & 1 deletion content/shmem_signal_wait_until.tex
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@

\begin{apiarguments}

\apiargument{IN}{sig\_addr}{Local address of the source signal variable.}
\apiargument{IN}{sig\_addr}{Local address of the remotely accessible source signal variable.}
\apiargument{IN}{cmp}{The comparison operator that compares \VAR{sig\_addr} with
\VAR{cmp\_value}.}
\apiargument{IN}{cmp\_value}{The value against which the object pointed to
Expand Down
57 changes: 57 additions & 0 deletions content/signaling.tex
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
This section specifies the OpenSHMEM support for \OPR{put-with-signal},
nonblocking \OPR{put-with-signal}, and \OPR{signal-\{add, fetch, set\}} routines. The
put-with-signal routines provide a method for copying data from a contiguous
local data object to a data object on a specified \ac{PE} and subsequently
updating a remote flag to signal completion.
The signal-add and signal-set routines provide methods for updating
the signal object without the associated data transfer of a
put-with-signal operation.
The signal-fetch routine provides support for reading a local signal value.

\openshmem \OPR{put-with-signal} and \OPR{signal-\{add, set\}}
routines specified in this section have two
variants. In one of the variants, the context handle, \VAR{ctx}, is explicitly
passed as an argument. In this variant, the operation is performed on the
specified context. If the context handle \VAR{ctx} does not correspond to a
valid context, the behavior is undefined. In the other variant, the context
handle is not explicitly passed and thus, the operations are performed on the
default context.

\subsubsection{Atomicity Guarantees for Signaling Operations}
\label{subsec:signal_atomicity}
All signaling operations put-with-signal, nonblocking put-with-signal, and
signal-\{add, fetch, set\} are performed on a signal data object, a remotely accessible
symmetric object of type \VAR{uint64\_t}. A signal operator in the
put-with-signal routine is an \openshmem library constant that determines the
type of update to be performed as a signal on the signal data object.

All signaling operations on the signal data object complete as if performed
atomically with respect to the following:
\begin{itemize}
\item other blocking or nonblocking variant of the put-with-signal routine
that updates the signal data object using the same signal update operator;
\item signal-add routine when the put-with-signal routine uses the
\LibConstRef{SHMEM\_SIGNAL\_ADD} signal operator;
\item signal-set routine when the put-with-signal routine uses the
\LibConstRef{SHMEM\_SIGNAL\_SET} signal operator;
\item signal-fetch routine that fetches the signal data object; and
\item any point-to-point synchronization routine that accesses the signal
data object.
\end{itemize}

\subsubsection{Available Signal Operators}
\label{subsec:signal_operator}

With the atomicity guarantees as described in
Section~\ref{subsec:signal_atomicity}, the following options can be used as a
signal operator.

\apitablerow{\LibConstRef{SHMEM\_SIGNAL\_SET}}{An update to signal data
object is an atomic set operation. It writes an unsigned 64-bit value as a
signal into the signal data object on a remote \VAR{PE} as an atomic
operation.}

\apitablerow{\LibConstRef{SHMEM\_SIGNAL\_ADD}}{An update to signal data
object is an atomic add operation. It adds an unsigned 64-bit value as a
signal into the signal data object on a remote \VAR{PE} as an atomic
operation.}
59 changes: 1 addition & 58 deletions main_spec.tex
Original file line number Diff line number Diff line change
Expand Up @@ -306,64 +306,7 @@ \subsubsubsection{\textbf{SHMEM\_ATOMIC\_FETCH\_XOR\_NBI}}


\subsection{Signaling Operations}\label{sec:shmem_signal}
This section specifies the OpenSHMEM support for \OPR{put-with-signal},
nonblocking \OPR{put-with-signal}, and \OPR{signal-\{add, fetch, set\}} routines. The
put-with-signal routines provide a method for copying data from a contiguous
local data object to a data object on a specified \ac{PE} and subsequently
updating a remote flag to signal completion.
The signal-add and signal-set routines provide methods for updating
the signal object without the associated data transfer of a
put-with-signal operation.
The signal-fetch routine provides support for reading a local signal value.

\openshmem \OPR{put-with-signal} and \OPR{signal-\{add, set\}}
routines specified in this section have two
variants. In one of the variants, the context handle, \VAR{ctx}, is explicitly
passed as an argument. In this variant, the operation is performed on the
specified context. If the context handle \VAR{ctx} does not correspond to a
valid context, the behavior is undefined. In the other variant, the context
handle is not explicitly passed and thus, the operations are performed on the
default context.

\subsubsection{Atomicity Guarantees for Signaling Operations}
\label{subsec:signal_atomicity}
All signaling operations put-with-signal, nonblocking put-with-signal, and
signal-\{add, fetch, set\} are performed on a signal data object, a remotely accessible
symmetric object of type \VAR{uint64\_t}. A signal operator in the
put-with-signal routine is an \openshmem library constant that determines the
type of update to be performed as a signal on the signal data object.

All signaling operations on the signal data object complete as if performed
atomically with respect to the following:
\begin{itemize}
\item other blocking or nonblocking variant of the put-with-signal routine
that updates the signal data object using the same signal update operator;
\item signal-add routine when the put-with-signal routine uses the
\LibConstRef{SHMEM\_SIGNAL\_ADD} signal operator;
\item signal-set routine when the put-with-signal routine uses the
\LibConstRef{SHMEM\_SIGNAL\_SET} signal operator;
\item signal-fetch routine that fetches the signal data object; and
\item any point-to-point synchronization routine that accesses the signal
data object.
\end{itemize}

\subsubsection{Available Signal Operators}
\label{subsec:signal_operator}

With the atomicity guarantees as described in
Section~\ref{subsec:signal_atomicity}, the following options can be used as a
signal operator.

\apitablerow{\LibConstRef{SHMEM\_SIGNAL\_SET}}{An update to signal data
object is an atomic set operation. It writes an unsigned 64-bit value as a
signal into the signal data object on a remote \VAR{PE} as an atomic
operation.}

\apitablerow{\LibConstRef{SHMEM\_SIGNAL\_ADD}}{An update to signal data
object is an atomic add operation. It adds an unsigned 64-bit value as a
signal into the signal data object on a remote \VAR{PE} as an atomic
operation.}

\input{content/signaling.tex}

\subsubsection{\textbf{SHMEM\_PUT\_SIGNAL}}\label{subsec:shmem_put_signal}
\input{content/shmem_put_signal.tex}
Expand Down

0 comments on commit 1a7bf49

Please sign in to comment.