Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove unnecessary whitespace #539

Merged
merged 1 commit into from
Sep 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion content/atomics_intro.tex
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@

\openshmem \ac{AMO} 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
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
Expand Down
2 changes: 1 addition & 1 deletion content/backmatter.tex
Original file line number Diff line number Diff line change
Expand Up @@ -993,7 +993,7 @@ \section{Version 1.4}
%
\item Expanded the type support for \ac{RMA}, \ac{AMO}, and point-to-point
synchronization operations.
%% cleveref will compress a list of references by default. It is better to not
%% cleveref will compress a list of references by default. It is better to not
%% compress this list of *table* references because the clickable hyperref
%% links are useful. You can tell cleveref to not compress the LHS and RHS by
%% inserting an empty item between them; i.e., `,,`.
Expand Down
2 changes: 1 addition & 1 deletion content/execution_model.tex
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
communicate and synchronize among executing \acp{PE}. The \openshmem phase in
a program begins with the first call to the initialization routine \FUNC{shmem\_init}
or \FUNC{shmem\_init\_thread}, which must be performed before using any of the
other \openshmem library routines.
other \openshmem library routines.
An \openshmem program concludes its use of the \openshmem library when all \acp{PE}
make their final call to
\FUNC{shmem\_finalize} or any \ac{PE} calls \FUNC{shmem\_global\_exit}.
Expand Down
6 changes: 3 additions & 3 deletions content/frontmatter.tex
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
\SetWatermarkText{DRAFT}
\SetWatermarkScale{1}
\SetWatermarkLightness{.91}
\fancyfoot[C]{\thepage} %affects page numbering for the first pages,
\fancyfoot[C]{\thepage} %affects page numbering for the first pages,
%except the first ToC page

\pagenumbering{roman} %sets coverpage and toc page numbers to roman numerals
Expand All @@ -19,10 +19,10 @@
\setcounter{secnumdepth}{4}
\tableofcontents

\mainmatter % included for use of documenttype 'book'
\mainmatter % included for use of documenttype 'book'

% Set header/footer for main content
\pagestyle{fancy} %replacing {headings} with {fancy} for customization
\pagestyle{fancy} %replacing {headings} with {fancy} for customization
\fancyhf{}
\fancyhead[L]{\leftmark}
\fancyhead[R]{\thepage}
Expand Down
2 changes: 1 addition & 1 deletion content/memmgmt_intro.tex
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

The total size of the symmetric heap is determined at job startup. One can
specify the size of the heap using the \ENVVAR{SHMEM\_SYMMETRIC\_SIZE} environment
variable (where available).
variable (where available).

\begin{DeprecateBlock}
As of \openshmem[1.2] the use of \FUNC{shmalloc}, \FUNC{shmemalign},
Expand Down
6 changes: 3 additions & 3 deletions content/rma_intro.tex
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,10 @@
is not explicitly passed and thus, the operations are performed on the
default context.

Where appropriate compiler support is available, \openshmem provides type-generic
Where appropriate compiler support is available, \openshmem provides type-generic
one-sided communication interfaces via \Cstd[11] generic selection
(\Cstd[11]~\S6.5.1.1\footnote{Formally, the \Cstd[11] specification is ISO/IEC 9899:2011(E).})
for block, scalar, and block-strided put and get communication.
for block, scalar, and block-strided put and get communication.
Such type-generic routines are supported for the ``standard \ac{RMA} types''
listed in Table \ref{stdrmatypes}.

Expand Down Expand Up @@ -78,5 +78,5 @@
\end{tabular}
\TableCaptionRef{Standard \ac{RMA} Types and Names}
\label{stdrmatypes}
\end{center}
\end{center}
\end{table}
2 changes: 1 addition & 1 deletion content/shmem_addr_accessible.tex
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
\FUNC{shmem\_addr\_accessible} is a query routine that indicates whether
the address \VAR{addr} can be used to access the given data object on the
specified \ac{PE} via \openshmem routines.

This routine verifies that the data object is symmetric and accessible with
respect to a remote \ac{PE} via \openshmem data transfer routines. The
specified address \VAR{addr} is the local address of the data object on the
Expand Down
9 changes: 4 additions & 5 deletions content/shmem_alltoalls.tex
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@

\apiargument{IN}{team}{A valid \openshmem team handle.}%

\apiargument{OUT}{dest}{Symmetric address of a data object large enough to receive
\apiargument{OUT}{dest}{Symmetric address of a data object large enough to receive
the combined total of \VAR{nelems} elements from each \ac{PE} in the
active set.
The type of \dest{} should match that implied in the SYNOPSIS section.}
Expand All @@ -53,7 +53,7 @@
for \FUNC{shmem\_alltoalls\{32,64\}}, elements are 4 or 8 bytes,
respectively.
}

\begin{DeprecateBlock}
\apiargument{IN}{PE\_start}{The lowest \ac{PE} number of the active set of
\acp{PE}.}
Expand Down Expand Up @@ -82,7 +82,7 @@
The same \dest{} and \source{} arrays and same values for values of
arguments \VAR{dst}, \VAR{sst}, \VAR{nelems} must be passed by all \acp{PE}
that participate in the collective.

Given a \ac{PE} \VAR{i} that is the \kth \ac{PE}
participating in the operation and a \ac{PE}
\VAR{j} that is the \lth \ac{PE}
Expand All @@ -99,8 +99,7 @@
\item The pre- and post-conditions for symmetric objects.
\item Typing constraints for \dest{} and \source{} data objects.
\end{itemize}

}
}


\apireturnvalues{
Expand Down
2 changes: 1 addition & 1 deletion content/shmem_barrier_all.tex
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@

\end{apiarguments}

\apidescription{
\apidescription{
The \FUNC{shmem\_barrier\_all} routine
is a mechanism for synchronizing all \acp{PE} in the world team at
once. This routine blocks the calling \ac{PE} until all \acp{PE} have called
Expand Down
4 changes: 2 additions & 2 deletions content/shmem_broadcast.tex
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@

\end{apiarguments}

\apidescription{
\apidescription{
\openshmem broadcast routines are collective routines over an active set or
valid \openshmem team.
They copy the \source{} data object on the \ac{PE} specified by
Expand All @@ -82,7 +82,7 @@
between \CONST{0} and \VAR{N$-$1}, where \VAR{N} is the size of
the team.
\end{itemize}

For active-set-based broadcasts:
\begin{itemize}
\item The \dest{} object is updated on all \acp{PE} other than the
Expand Down
12 changes: 6 additions & 6 deletions content/shmem_collect.tex
Original file line number Diff line number Diff line change
Expand Up @@ -69,18 +69,18 @@
\dest{} array, over an \openshmem team or active set
in processor number order. The resultant \dest{} array contains the contribution from
\acp{PE} as follows:

\begin{itemize}
\item For an active set, the data from \ac{PE} \VAR{PE\_start} is first, then the
contribution from \ac{PE} \VAR{PE\_start} + \VAR{PE\_stride} second, and so on.
\item For a team, the data from \ac{PE} number \CONST{0} in the team is first, then the
contribution from \ac{PE} \CONST{1} in the team, and so on.
\end{itemize}

The collected result is written to the \dest{} array for all \acp{PE}
that participate in the operation. The same \dest{} and \source{}
arrays must be passed by all \acp{PE} that participate in the operation.

The \FUNC{fcollect} routines require that \VAR{nelems} be the same value in all
participating \acp{PE}, while the \FUNC{collect} routines allow \VAR{nelems} to
vary from \ac{PE} to \ac{PE}.
Expand All @@ -96,15 +96,15 @@
each of these routines assumes that
only \acp{PE} in the active set call the routine. If a \ac{PE} not in the
active set and calls this collective routine, the behavior is undefined.

The values of arguments \VAR{PE\_start}, \VAR{logPE\_stride}, and \VAR{PE\_size}
must be the same value on all \acp{PE} in the active set. The same
\VAR{pSync} work array must be passed by all \acp{PE} in the active set.

Upon return from a collective routine, the following are true for the local
\ac{PE}:
\begin{itemize}
\item The \dest{} array is updated and the \source{} array may be safely reused.
\item The \dest{} array is updated and the \source{} array may be safely reused.
\item For active-set-based collective routines, the values in the \VAR{pSync} array are
restored to the original values.
\end{itemize}
Expand Down
2 changes: 1 addition & 1 deletion content/shmem_finalize.tex
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
An \openshmem program may perform a series of matching
initialization and finalization calls.
The last call to \FUNC{shmem\_finalize} in this series
releases all resources used by the \openshmem library.
releases all resources used by the \openshmem library.
This call destroys all teams created by the \openshmem program.
As a result, all shareable contexts are destroyed.
The user is
Expand Down
2 changes: 1 addition & 1 deletion content/shmem_g.tex
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@

\apidescription{
These routines provide a very low latency get capability for single elements
of most basic types.
of most basic types.
}

\apireturnvalues{
Expand Down
22 changes: 11 additions & 11 deletions content/shmem_init_thread.tex
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,12 @@
\end{apiarguments}

\apidescription{
\FUNC{shmem\_init\_thread} initializes the \openshmem library in the same way as
\FUNC{shmem\_init}. In addition, \FUNC{shmem\_init\_thread} also performs
the initialization required for supporting the provided thread level.
The argument \VAR{requested} is used to specify the desired level of
thread support. The argument \VAR{provided} returns the support level
provided by the library. The allowed values for \VAR{provided} and
\FUNC{shmem\_init\_thread} initializes the \openshmem library in the same way as
\FUNC{shmem\_init}. In addition, \FUNC{shmem\_init\_thread} also performs
the initialization required for supporting the provided thread level.
The argument \VAR{requested} is used to specify the desired level of
thread support. The argument \VAR{provided} returns the support level
provided by the library. The allowed values for \VAR{provided} and
\VAR{requested} are \CONST{SHMEM\_THREAD\_SINGLE}, \CONST{SHMEM\_THREAD\_FUNNELED},
\CONST{SHMEM\_THREAD\_SERIALIZED}, and \CONST{SHMEM\_THREAD\_MULTIPLE}.

Expand All @@ -32,8 +32,8 @@
re-initialized with a subsequent call to an initialization routine.

If the call to \FUNC{shmem\_init\_thread}
is unsuccessful in allocating and initializing resources for the
\openshmem library, then the behavior of any subsequent call
is unsuccessful in allocating and initializing resources for the
\openshmem library, then the behavior of any subsequent call
to the \openshmem library is undefined.


Expand All @@ -45,9 +45,9 @@
}

\apinotes{
The \openshmem library can be initialized either by \FUNC{shmem\_init}
or \FUNC{shmem\_init\_thread}. If the \openshmem library is initialized
by \FUNC{shmem\_init}, the library implementation can choose to
The \openshmem library can be initialized either by \FUNC{shmem\_init}
or \FUNC{shmem\_init\_thread}. If the \openshmem library is initialized
by \FUNC{shmem\_init}, the library implementation can choose to
support any one of the defined thread levels.

The \openshmem library may not be able to change the level of threading support
Expand Down
18 changes: 9 additions & 9 deletions content/shmem_malloc_hints.tex
Original file line number Diff line number Diff line change
Expand Up @@ -22,19 +22,19 @@
is a collective operation on the world team that returns a pointer to a block of at least
\VAR{size} bytes, which shall be suitably aligned so that it may be
assigned to a pointer to any type of object. This space is allocated from
the symmetric heap (similar to \FUNC{shmem\_malloc}). When the \VAR{size} is zero,
the \FUNC{shmem\_malloc\_with\_hints} routine performs no action and returns a null pointer.
In addition to the \VAR{size} argument, the \VAR{hints} argument is provided by the user.
the symmetric heap (similar to \FUNC{shmem\_malloc}). When the \VAR{size} is zero,
the \FUNC{shmem\_malloc\_with\_hints} routine performs no action and returns a null pointer.

In addition to the \VAR{size} argument, the \VAR{hints} argument is provided by the user.
The \VAR{hints} describes the expected manner in which the \openshmem program may use the allocated memory.
The valid usage hints are described in Table~\ref{usagehints}. Multiple hints may be requested by combining them with a bitwise \CONST{OR} operation.
A zero option can be given if no options are requested.
The information provided by the \VAR{hints} is used to optimize for performance by the implementation.

The information provided by the \VAR{hints} is used to optimize for performance by the implementation.
If the implementation cannot optimize, the behavior is same as \FUNC{shmem\_malloc}.
If more than one hint is provided, the implementation will make the best effort to use one or more hints
to optimize performance.
If more than one hint is provided, the implementation will make the best effort to use one or more hints
to optimize performance.

The \FUNC{shmem\_malloc\_with\_hints} routine is provided so that multiple \acp{PE} in a program can allocate symmetric,
remotely accessible memory blocks. When no action is performed, these
routines return without performing a barrier. Otherwise, the routine will call a procedure that is semantically equivalent to \FUNC{shmem\_barrier\_all} on exit.
Expand Down
2 changes: 1 addition & 1 deletion content/shmem_p.tex
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
\apidescription{
These routines provide a very low latency put capability for single elements of
most basic types.

As with \FUNC{shmem\_put}, these routines start the remote transfer and may
return before the data is delivered to the remote \ac{PE}. Use
\FUNC{shmem\_quiet} to force completion of all remote \PUT{} transfers.
Expand Down
18 changes: 9 additions & 9 deletions content/shmem_pe_quiet.tex
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
\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
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
\acp{PE}.
}
Expand All @@ -17,22 +17,22 @@
\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\_pes}{Address of target \ac{PE} array where the
\apiargument{IN}{target\_pes}{Address of target \ac{PE} array where the
operations need to be completed}
\apiargument{IN}{npes}{The number of \acp{PE} in the target \ac{PE} array}
\apiargument{IN}{npes}{The number of \acp{PE} in the target \ac{PE} array}

\end{apiarguments}

\apidescription{
The \FUNC{shmem\_pe\_quiet} ensures completion of memory store, blocking
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 \acp{PE} and on the
given context. If \VAR{npes} is set to 0, the \VAR{target\_pes} is ignored
and the routine returns immediately.
The completion and visibility semantics of these operations are the same as the
\FUNC{shmem\_quiet} routine. However, it applies only to the target

The completion and visibility semantics of these operations are the same as the
\FUNC{shmem\_quiet} routine. However, it applies only to the target
\acp{PE}, i.e., the operations to the target \acp{PE} are guaranteed to be
complete and visible to all \acp{PE} when \FUNC{shmem\_pe\_quiet} returns.
}
Expand Down
2 changes: 1 addition & 1 deletion content/shmem_ptr.tex
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
to a remotely accessible data object. Providing this address to an argument
of an \openshmem routine that requires a symmetric address results in
undefined behavior.

The \FUNC{shmem\_ptr} routine can provide an efficient means to accomplish
communication, for example when a sequence of reads and writes to a data
object on a remote \ac{PE} does not match the access pattern provided in an
Expand Down
2 changes: 1 addition & 1 deletion content/shmem_reductions.tex
Original file line number Diff line number Diff line change
Expand Up @@ -319,7 +319,7 @@ \subsubsubsection{PROD}
\openshmem routine.
\end{itemize}
Otherwise, the behavior is undefined.

Upon return from a reduction routine, the following are true for the local
\ac{PE}:
\begin{itemize}
Expand Down
4 changes: 2 additions & 2 deletions content/shmem_scan.tex
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@

The \FUNC{shmem\_sum\_inscan} routine performs an inclusive scan
operation, while the \FUNC{shmem\_sum\_exscan} routine performs an
exclusive scan operation.
exclusive scan operation.

For \FUNC{shmem\_sum\_inscan}, the value of the $j$-th element in
the \VAR{dest} array on \ac{PE}~$i$ is defined as:
Expand Down Expand Up @@ -89,7 +89,7 @@
Before any \ac{PE} calls a scan routine, the \dest{} array on all
\acp{PE} participating in the operation must be ready to accept the
results of the operation. Otherwise, the behavior is undefined.

Upon return from a scan routine, the following are true for the
local \ac{PE}: the \dest{} array is updated, and the \source{} array
may be safely reused.
Expand Down
2 changes: 1 addition & 1 deletion content/shmem_team_ptr.tex
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
a remotely accessible data object. Providing this address to an argument of
an \openshmem routine that requires a symmetric address results in
undefined behavior.

The \FUNC{shmem\_team\_ptr} routine can provide an efficient means to accomplish
communication, for example when a sequence of reads and writes to a data
object on a remote \ac{PE} does not match the access pattern provided in an
Expand Down
2 changes: 1 addition & 1 deletion content/shmem_wait_until_all.tex
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@

\end{apiarguments}

\apidescription{
\apidescription{
The \FUNC{shmem\_wait\_until\_all} routine waits until all entries in the
wait set specified by \VAR{ivars} and \VAR{status} have satisfied the wait condition at the
calling \ac{PE}. The \VAR{ivars} objects at the calling \ac{PE} may be
Expand Down
2 changes: 1 addition & 1 deletion content/shmem_wait_until_all_vector.tex
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@

\end{apiarguments}

\apidescription{
\apidescription{
The \FUNC{shmem\_wait\_until\_all\_vector} routine waits until all entries
in the wait set specified by \VAR{ivars} and \VAR{status} have satisfied
the wait conditions at the calling \ac{PE}. The \VAR{ivars}
Expand Down
Loading