-
Notifications
You must be signed in to change notification settings - Fork 41
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' into pr/ib-ops
- Loading branch information
Showing
6 changed files
with
128 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
\apisummary{ | ||
Adds to a signal value of a remote data object. | ||
} | ||
|
||
\begin{apidefinition} | ||
|
||
\begin{C11synopsis} | ||
void @\FuncDecl{shmem\_signal\_add}@(shmem_ctx_t ctx, const 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); | ||
\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{OUT}{sig\_addr}{ | ||
Symmetric address of the signal data object to be updated on the | ||
remote \ac{PE}. | ||
} | ||
\apiargument{IN}{signal}{ | ||
Unsigned 64-bit value that is used for updating the remote | ||
\VAR{sig\_addr} signal data object. | ||
} | ||
\apiargument{IN}{pe}{ | ||
\ac{PE} number of the remote \ac{PE}. | ||
} | ||
\end{apiarguments} | ||
|
||
\apidescription{ | ||
\FUNC{shmem\_signal\_add} adds \VAR{value} to the signal data | ||
object pointed to by \VAR{sig\_addr} on \ac{PE}~\VAR{pe}. | ||
The update to the \VAR{sig\_addr} signal object at the calling | ||
\ac{PE} is expected to satisfy the atomicity guarantees as described | ||
in Section~\ref{subsec:signal_atomicity}. | ||
} | ||
|
||
\apireturnvalues{ | ||
None. | ||
} | ||
|
||
\end{apidefinition} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
\apisummary{ | ||
Sets the signal value of a remote data object. | ||
} | ||
|
||
\begin{apidefinition} | ||
|
||
\begin{C11synopsis} | ||
void @\FuncDecl{shmem\_signal\_set}@(shmem_ctx_t ctx, const 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); | ||
\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{OUT}{sig\_addr}{ | ||
Symmetric address of the signal data object to be updated on the | ||
remote \ac{PE}. | ||
} | ||
\apiargument{IN}{signal}{ | ||
Unsigned 64-bit value that is used for updating the remote | ||
\VAR{sig\_addr} signal data object. | ||
} | ||
\apiargument{IN}{pe}{ | ||
\ac{PE} number of the remote \ac{PE}. | ||
} | ||
\end{apiarguments} | ||
|
||
\apidescription{ | ||
\FUNC{shmem\_signal\_set} writes \VAR{value} into the signal data | ||
object pointed to by \VAR{sig\_addr} on \ac{PE}~\VAR{pe}. | ||
The update to the \VAR{sig\_addr} signal object at the calling | ||
\ac{PE} is expected to satisfy the atomicity guarantees as described | ||
in Section~\ref{subsec:signal_atomicity}. | ||
} | ||
|
||
\apireturnvalues{ | ||
None. | ||
} | ||
|
||
\end{apidefinition} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters