Merge remote-tracking branch 'naveen-rn/rma-amo-changes' into tmp

content/atomics_intro.tex

@@ -29,6 +29,13 @@
   The non-fetching routines include:
   \FUNC{shmem\_atomic\_\{set, inc, add, and, or, xor\}[\_nbi]}.
 
+\begin{DeprecateBlock}
+
+Starting in \openshmem[1.4], all \ac{AMO} functions added "\_atomic\_" to the function 
+name and deprecated the equivalent functions without "\_atomic\_" in the name.
+
+\end{DeprecateBlock}
+
 \end{itemize}
 
 \openshmem \ac{AMO} routines specified in this section have two variants. In
@@ -56,7 +63,7 @@
 integer types defined in \HEADER{stdint.h} by \Cstd[99]~\S7.18.1.1 and
 \Cstd[11]~\S7.20.1.1. When the \Cstd translation environment
 does not provide exact-width integer types with \HEADER{stdint.h}, an
-\openshmem implemementation is not required to provide support for these types.
+\openshmem implementation is not required to provide support for these types.
 
 \begin{table}[h]
   \begin{center}
@@ -123,3 +130,10 @@
     \label{bitamotypes}
   \end{center}
 \end{table}
+]
+
+
+
+
+
+

content/rma_intro.tex

@@ -18,7 +18,7 @@
 
 The destination \ac{PE} is specified as an integer representing the \ac{PE} number.
 This \ac{PE} number is relative to the team associated with the
-communication context being using for the operation. If no context argument is passed to the routine,
+communication context being used for the operation. If no context argument is passed to the routine,
 then the routine operates on the default context, which implies that
 the \ac{PE} number is relative to the world team.
 If the \ac{PE} number passed to the routine is invalid, being negative
@@ -44,7 +44,7 @@
 \footnote{Formally, the \Cstd[99] specification is ISO/IEC~9899:1999(E).}%
 ~\S7.18.1.1 and \Cstd[11]~\S7.20.1.1. When the \Cstd translation environment
 does not provide exact-width integer types with \HEADER{stdint.h}, an
-\openshmem implemementation is not required to provide support for these types.
+\openshmem implementation is not required to provide support for these types.
 
 \begin{table}[h]
   \begin{center}

content/shmem_atomic_add.tex

@@ -39,8 +39,8 @@
         The type of \dest{} should match that implied in the SYNOPSIS section.}
     \apiargument{IN}{value}{The operand to the atomic add operation.
         The type of \VAR{value} should match that implied in the SYNOPSIS section.}
-    \apiargument{IN}{pe}{An integer that indicates the \ac{PE} number upon which
-        \dest{} is to be updated.}
+    \apiargument{IN}{pe}{\ac{PE} number of the remote \ac{PE} relative to the team associated
+      with the given \VAR{ctx} when provided, or the default context otherwise.}
 \end{apiarguments}
 
 \apidescription{

content/shmem_atomic_and.tex

@@ -28,9 +28,8 @@
     The type of \dest{} should match that implied in the SYNOPSIS section.}
   \apiargument{IN}{value}{The operand to the bitwise AND operation.
     The type of \VAR{value} should match that implied in the SYNOPSIS section.}
-  \apiargument{IN}{pe}{An integer value for the \ac{PE} on which \VAR{dest}
-    is to be updated.}
-
+  \apiargument{IN}{pe}{\ac{PE} number of the remote \ac{PE} relative to the team associated
+    with the given \VAR{ctx} when provided, or the default context otherwise.}
 \end{apiarguments}
 
 \apidescription{

content/shmem_atomic_compare_swap.tex

@@ -45,8 +45,8 @@
         type as \VAR{dest}.}
     \apiargument{IN}{value}{The value to be atomically written to the remote \ac{PE}.
         The type of \VAR{value} should match that implied in the SYNOPSIS section.}
-    \apiargument{IN}{pe}{An integer that indicates the \ac{PE} number upon which
-        \VAR{dest} is to be updated.}
+    \apiargument{IN}{pe}{\ac{PE} number of the remote \ac{PE} relative to the team associated
+      with the given \VAR{ctx} when provided, or the default context otherwise.}
 \end{apiarguments}
 
 \apidescription{

content/shmem_atomic_compare_swap_nbi.tex

@@ -35,8 +35,8 @@
   \apiargument{IN}{value}{The value to be atomically written to the remote
       \ac{PE}.
       The type of \VAR{value} should match that implied in the SYNOPSIS section.}
-  \apiargument{IN}{pe}{An integer that indicates the \ac{PE} number upon which
-      \VAR{dest} is to be updated.}
+  \apiargument{IN}{pe}{\ac{PE} number of the remote \ac{PE} relative to the team associated
+    with the given \VAR{ctx} when provided, or the default context otherwise.}
 \end{apiarguments}
 
 \apidescription{

content/shmem_atomic_fetch.tex

@@ -40,9 +40,9 @@
     the default context.}
   \apiargument{IN}{source}{Symmetric address of the source data object.
     The type of \source{} should match that implied in the SYNOPSIS section.}
-  \apiargument{IN}{pe}{An integer that indicates the \ac{PE} number from which
-    \VAR{source} is to be fetched.}
-
+  \apiargument{IN}{pe}{\ac{PE} number of the remote \ac{PE} on which \VAR{source} resides 
+    relative to the team associated with the given \VAR{ctx} when provided, or the 
+    default context otherwise.}
 \end{apiarguments}
 
 \apidescription{

content/shmem_atomic_fetch_add.tex

@@ -41,9 +41,8 @@
     SYNOPSIS section.}
 \apiargument{IN}{value}{The operand to the atomic fetch-and-add operation.  The
     type of \VAR{value} should match that implied in the SYNOPSIS section.}
-\apiargument{IN}{pe}{An integer that indicates the \ac{PE} number on which
-    \VAR{dest} is to be updated.}
-
+\apiargument{IN}{pe}{\ac{PE} number of the remote \ac{PE} relative to the team associated
+     with the given \VAR{ctx} when provided, or the default context otherwise.}
 \end{apiarguments}
 
 \apidescription{

content/shmem_atomic_fetch_add_nbi.tex

@@ -30,9 +30,8 @@
     The type of \dest{} should match that implied in the SYNOPSIS section.}
   \apiargument{IN}{value}{The operand to the atomic fetch-and-add operation.
       The type of \VAR{value} should match that implied in the SYNOPSIS section.}
-  \apiargument{IN}{pe}{An integer that indicates the \ac{PE} number on which
-      \VAR{dest} is to be updated.}
-
+  \apiargument{IN}{pe}{\ac{PE} number of the remote \ac{PE} relative to the team associated
+      with the given \VAR{ctx} when provided, or the default context otherwise.}
 \end{apiarguments}
 
 \apidescription{

content/shmem_atomic_fetch_and.tex

@@ -27,9 +27,8 @@
     The type of \dest{} should match that implied in the SYNOPSIS section.}
   \apiargument{IN}{value}{The operand to the bitwise AND operation.
     The type of \VAR{value} should match that implied in the SYNOPSIS section.}
-  \apiargument{IN}{pe}{An integer value for the \ac{PE} on which \VAR{dest}
-    is to be updated.}
-
+  \apiargument{IN}{pe}{\ac{PE} number of the remote \ac{PE} relative to the team associated
+    with the given \VAR{ctx} when provided, or the default context otherwise.}
 \end{apiarguments}
 
 \apidescription{

content/shmem_atomic_fetch_and_nbi.tex

@@ -30,9 +30,8 @@
       The type of \dest{} should match that implied in the SYNOPSIS section.}
   \apiargument{IN}{value}{The operand to the bitwise AND operation.
       The type of \VAR{value} should match that implied in the SYNOPSIS section.}
-  \apiargument{IN}{pe}{An integer value for the \ac{PE} on which \VAR{dest}
-    is to be updated.}
-
+  \apiargument{IN}{pe}{\ac{PE} number of the remote \ac{PE} relative to the team associated
+      with the given \VAR{ctx} when provided, or the default context otherwise.}
 \end{apiarguments}
 
 \apidescription{

content/shmem_atomic_fetch_inc.tex

@@ -38,9 +38,8 @@
     the default context.}
 \apiargument{OUT}{dest}{Symmetric address of the destination data object.
     The type of \dest{} should match that implied in the SYNOPSIS section.}
-\apiargument{IN}{pe}{An integer that indicates the \ac{PE} number on which
-    \dest{} is to be updated.}
-
+\apiargument{IN}{pe}{\ac{PE} number of the remote \ac{PE} relative to the team associated
+    with the given \VAR{ctx} when provided, or the default context otherwise.}
 \end{apiarguments}
 
 

content/shmem_atomic_fetch_inc_nbi.tex

@@ -28,9 +28,8 @@
     The type of \VAR{fetch} should match that implied in the SYNOPSIS section.}
 \apiargument{OUT}{dest}{Symmetric address of the destination data object.
     The type of \dest{} should match that implied in the SYNOPSIS section.}
-\apiargument{IN}{pe}{An integer that indicates the \ac{PE} number on which
-    \dest{} is to be updated.}
-
+\apiargument{IN}{pe}{\ac{PE} number of the remote \ac{PE} relative to the team associated
+    with the given \VAR{ctx} when provided, or the default context otherwise.}
 \end{apiarguments}
 
 

content/shmem_atomic_fetch_nbi.tex

@@ -28,9 +28,8 @@
     The type of \VAR{fetch} should match that implied in the SYNOPSIS section.}
   \apiargument{OUT}{source}{Symmetric address of the source data object.
     The type of \source{} should match that implied in the SYNOPSIS section.}
-  \apiargument{IN}{pe}{An integer that indicates the \ac{PE} number from which
-    \VAR{source} is to be fetched.}
-
+  \apiargument{IN}{pe}{\ac{PE} number of the remote \ac{PE} relative to the team associated
+    with the given \VAR{ctx} when provided, or the default context otherwise.}
 \end{apiarguments}
 
 \apidescription{

content/shmem_atomic_fetch_or.tex

@@ -27,9 +27,8 @@
     The type of \dest{} should match that implied in the SYNOPSIS section.}
   \apiargument{IN}{value}{The operand to the bitwise OR operation.
     The type of \VAR{value} should match that implied in the SYNOPSIS section.}
-  \apiargument{IN}{pe}{An integer value for the \ac{PE} on which \VAR{dest}
-    is to be updated.}
-
+  \apiargument{IN}{pe}{\ac{PE} number of the remote \ac{PE} relative to the team associated
+    with the given \VAR{ctx} when provided, or the default context otherwise.}
 \end{apiarguments}
 
 \apidescription{

content/shmem_atomic_fetch_or_nbi.tex

@@ -30,9 +30,8 @@
       The type of \dest{} should match that implied in the SYNOPSIS section.}
   \apiargument{IN}{value}{The operand to the bitwise OR operation.
       The type of \VAR{value} should match that implied in the SYNOPSIS section.}
-  \apiargument{IN}{pe}{An integer value for the \ac{PE} on which \VAR{dest}
-    is to be updated.}
-
+  \apiargument{IN}{pe}{\ac{PE} number of the remote \ac{PE} relative to the team associated
+    with the given \VAR{ctx} when provided, or the default context otherwise.}
 \end{apiarguments}
 
 \apidescription{

content/shmem_atomic_fetch_xor.tex

@@ -28,9 +28,8 @@
     The type of \dest{} should match that implied in the SYNOPSIS section.}
   \apiargument{IN}{value}{The operand to the bitwise XOR operation.
     The type of \VAR{value} should match that implied in the SYNOPSIS section.}
-  \apiargument{IN}{pe}{An integer value for the \ac{PE} on which \VAR{dest}
-    is to be updated.}
-
+  \apiargument{IN}{pe}{\ac{PE} number of the remote \ac{PE} relative to the team associated
+    with the given \VAR{ctx} when provided, or the default context otherwise.}
 \end{apiarguments}
 
 \apidescription{

content/shmem_atomic_fetch_xor_nbi.tex

@@ -30,9 +30,8 @@
       The type of \dest{} should match that implied in the SYNOPSIS section.}
   \apiargument{IN}{value}{The operand to the bitwise XOR operation.
       The type of \VAR{value} should match that implied in the SYNOPSIS section.}
-  \apiargument{IN}{pe}{An integer value for the \ac{PE} on which \VAR{dest}
-    is to be updated.}
-
+  \apiargument{IN}{pe}{\ac{PE} number of the remote \ac{PE} relative to the team associated
+      with the given \VAR{ctx} when provided, or the default context otherwise.}
 \end{apiarguments}
 
 \apidescription{

content/shmem_atomic_inc.tex

@@ -38,9 +38,8 @@
     the default context.}
 \apiargument{OUT}{dest}{Symmetric address of the destination data object.
     The type of \dest{} should match that implied in the SYNOPSIS section.}
-\apiargument{IN}{pe}{An integer that indicates the \ac{PE} number on which
-    \dest{} is to be  updated.}
-
+\apiargument{IN}{pe}{\ac{PE} number of the remote \ac{PE} relative to the team associated
+    with the given \VAR{ctx} when provided, or the default context otherwise.}
 \end{apiarguments}
 
 \apidescription{

content/shmem_atomic_or.tex

@@ -28,9 +28,8 @@
     The type of \dest{} should match that implied in the SYNOPSIS section.}
   \apiargument{IN}{value}{The operand to the bitwise OR operation.
     The type of \VAR{value} should match that implied in the SYNOPSIS section.}
-  \apiargument{IN}{pe}{An integer value for the \ac{PE} on which \VAR{dest}
-    is to be updated.}
-
+  \apiargument{IN}{pe}{\ac{PE} number of the remote \ac{PE} relative to the team associated
+    with the given \VAR{ctx} when provided, or the default context otherwise.}
 \end{apiarguments}
 
 \apidescription{

content/shmem_atomic_set.tex

@@ -42,9 +42,8 @@
     The type of \dest{} should match that implied in the SYNOPSIS section.}
 \apiargument{IN}{value}{The operand to the atomic set operation.
     The type of \VAR{value} should match that implied in the SYNOPSIS section.}
-\apiargument{IN}{pe}{An integer that indicates the \ac{PE} number on which
-    \VAR{dest} is to be updated.}
-
+\apiargument{IN}{pe}{\ac{PE} number of the remote \ac{PE} relative to the team associated
+    with the given \VAR{ctx} when provided, or the default context otherwise.}
 \end{apiarguments}
 
 \apidescription{

content/shmem_atomic_swap.tex

@@ -39,8 +39,8 @@
     The type of \dest{} should match that implied in the SYNOPSIS section.}
   \apiargument{IN}{value}{The value to be atomically written to the remote \ac{PE}.
     The type of \VAR{value} should match that implied in the SYNOPSIS section.}
-  \apiargument{IN}{pe}{ An integer that indicates the \ac{PE} number on which
-    \dest{} is to be updated.}
+  \apiargument{IN}{pe}{\ac{PE} number of the remote \ac{PE} relative to the team associated
+    with the given \VAR{ctx} when provided, or the default context otherwise.}
 \end{apiarguments}
 
 \apidescription{

content/shmem_atomic_swap_nbi.tex

@@ -30,8 +30,8 @@
   \apiargument{IN}{value}{The value to be atomically written to the remote
       \ac{PE}.
       The type of \VAR{value} should match that implied in the SYNOPSIS section.}
-  \apiargument{IN}{pe}{An integer that indicates the \ac{PE} number on which
-    \dest{} is to be updated.}
+  \apiargument{IN}{pe}{\ac{PE} number of the remote \ac{PE} relative to the team associated
+      with the given \VAR{ctx} when provided, or the default context otherwise.}
 \end{apiarguments}
 
 \apidescription{

content/shmem_atomic_xor.tex

@@ -28,9 +28,8 @@
     The type of \dest{} should match that implied in the SYNOPSIS section.}
   \apiargument{IN}{value}{The operand to the bitwise XOR operation.
     The type of \VAR{value} should match that implied in the SYNOPSIS section.}
-  \apiargument{IN}{pe}{An integer value for the \ac{PE} on which \VAR{dest}
-    is to be updated.}
-
+  \apiargument{IN}{pe}{\ac{PE} number of the remote \ac{PE} relative to the team associated
+    with the given \VAR{ctx} when provided, or the default context otherwise.}
 \end{apiarguments}
 
 \apidescription{

content/shmem_g.tex

@@ -23,6 +23,9 @@
   \apiargument{IN}{source}{Symmetric address of the source data object.
     The type of \source{} should match that implied in the SYNOPSIS section.}
   \apiargument{IN}{pe}{The number of the remote \ac{PE} on which \VAR{source} resides.}
+  \apiargument{IN}{pe}{\ac{PE} number of the remote \ac{PE} on which \VAR{source} resides 
+    relative to the team associated with the given \VAR{ctx} when provided, or the 
+    default context otherwise.}
 \end{apiarguments}
 
 \apidescription{

content/shmem_get.tex

@@ -37,12 +37,13 @@
       The type of \source{} should match that implied in the SYNOPSIS section.}
     \apiargument{IN}{nelems}{Number of elements in the \dest{} and \source{} arrays.
       For \FUNC{shmem\_getmem} and \FUNC{shmem\_ctx\_getmem}, elements are bytes.}
-    \apiargument{IN}{pe}{\ac{PE} number of the remote \ac{PE}.}
+    \apiargument{IN}{pe}{\ac{PE} number of the remote \ac{PE} relative to the team associated
+      with the given \VAR{ctx} when provided, or the default context otherwise.}
 \end{apiarguments}
 
 \apidescription{
    The get routines provide a method for copying a contiguous symmetric data
-   object from a different \ac{PE} to a contiguous data object on the local
+   object from a remote \ac{PE} to a contiguous data object on the local
    \ac{PE}.  The routines return after the data has been delivered to the
    \dest{} array on the local \ac{PE}.
 }

content/shmem_get_nbi.tex

@@ -39,12 +39,13 @@
     \apiargument{IN}{nelems}{Number of elements in the \dest{} and \source{}
         arrays. For \FUNC{shmem\_getmem\_nbi} and
         \FUNC{shmem\_ctx\_getmem\_nbi}, elements are bytes.}
-    \apiargument{IN}{pe}{\ac{PE}  number of the remote \ac{PE}.}
+    \apiargument{IN}{pe}{\ac{PE} number of the remote \ac{PE} relative to the team associated
+      with the given \VAR{ctx} when provided, or the default context otherwise.}
 \end{apiarguments}
 
 \apidescription{
     The get routines provide a method for copying a contiguous symmetric data
-   object from a different \ac{PE} to a contiguous data object on the local
+   object from a remote \ac{PE} to a contiguous data object on the local
    \ac{PE}.   The routines return after initiating the operation.  The operation is considered
     complete after a subsequent call to \FUNC{shmem\_quiet}.
     At the completion of \FUNC{shmem\_quiet}, the

content/shmem_ibget.tex

@@ -42,7 +42,8 @@
         arrays.}
     \apiargument{IN}{nblocks}{Number of blocks to be copied from the \source{} array
         to the \dest{} array.}
-    \apiargument{IN}{pe}{\ac{PE} number of the remote \ac{PE}.}
+    \apiargument{IN}{pe}{\ac{PE} number of the remote \ac{PE} relative to the team associated
+      with the given \VAR{ctx} when provided, or the default context otherwise.}
 \end{apiarguments}
 
 \apidescription{

content/shmem_ibput.tex

@@ -42,13 +42,14 @@
         arrays.}
     \apiargument{IN}{nblocks}{Number of blocks to be copied from the \source{} array
         to the \dest{} array.}
-    \apiargument{IN}{pe}{\ac{PE} number of the remote \ac{PE}.}
+    \apiargument{IN}{pe}{\ac{PE} number of the remote \ac{PE} relative to the team associated
+      with the given \VAR{ctx} when provided, or the default context otherwise.}
 \end{apiarguments}
 
 
 \apidescription{
     The \FUNC{shmem\_ibput} routines provide a method  for  copying strided data
-    blocks (specified by \VAR{sst}) of an array from a \source{} array on the
+    blocks (of size \VAR{bsize}) with stride  (specified by \VAR{sst}) of an array from a \source{} array on the
     local \ac{PE} to locations specified by stride \VAR{dst} on a \dest{} array
     on specified remote \ac{PE}. The routines return when the data has
     been copied out of the \VAR{source} array on the local \ac{PE} but not

content/shmem_iget.tex

@@ -40,7 +40,8 @@
         indicates contiguous data.}
     \apiargument{IN}{nelems}{Number of elements in the \dest{} and \source{}
         arrays.}
-    \apiargument{IN}{pe}{\ac{PE} number of the remote \ac{PE}.}
+    \apiargument{IN}{pe}{\ac{PE} number of the remote \ac{PE} relative to the team associated
+      with the given \VAR{ctx} when provided, or the default context otherwise.}
 \end{apiarguments}
 
 \apidescription{