Merge pull request #3 from davidozog/sec/ordering-short_p2p_sync_issue

Deprecate short-typed wait/test & update tables to std AMO
jdinan · Mar 11, 2020 · 493fa7f · 493fa7f
2 parents 1b45eec + 238d700
commit 493fa7f
Show file tree

Hide file tree

Showing 16 changed files with 87 additions and 61 deletions.
diff --git a/content/backmatter.tex b/content/backmatter.tex
@@ -345,6 +345,20 @@ \section{Overview}\label{subsec:dep_overview}
     \hyperref[subsec:shmem_alltoall]{\FUNC{shmem\_alltoall}} \\ \hline
     \CorCpp: \FuncRef{shmem\_alltoalls[32,64]} & 1.5 & Current &
     \hyperref[subsec:shmem_alltoalls]{\FUNC{shmem\_alltoalls}} \\ \hline
+    \minitab{\Cstd[11]: \FuncRef{shmem\_wait\_until(\CTYPE{short} ...)}
+        \\ \CorCpp: \FuncRef{shmem\_short\_wait\_until}}
+        & 1.5 & Current & (none) \\ \hline
+    \minitab{\Cstd[11]: \FuncRef{shmem\_wait\_until(\CTYPE{unsigned short} ...)}
+        \\ \CorCpp: \FuncRef{shmem\_ushort\_wait\_until}}
+        & 1.5 & Current & (none) \\ \hline
+    \minitab{\Cstd[11]: \FuncRef{shmem\_test(\CTYPE{short} ...)}
+        \\ \CorCpp: \FuncRef{shmem\_short\_test}}
+        & 1.5 & Current & (none) \\ \hline
+    \minitab{\Cstd[11]: \FuncRef{shmem\_test(\CTYPE{unsigned short} ...)}
+        \\ \CorCpp: \FuncRef{shmem\_ushort\_test}}
+        & 1.5 & Current & (none) \\ \hline
+    \minitab{Table~\ref{p2psynctypes}: point-to-point synchronization types}
+        & 1.5 & Current & Table~\ref{stdamotypes}: standard AMO types \\ \hline
     \end{longtable}
 \end{center}
 
@@ -512,6 +526,18 @@ \subsection{\CorCpp: \FUNC{shmem\_barrier}}
 followed by a call to \FUNC{shmem\_sync} in order to explicitly
 indicate which context to quiesce.
 
+\subsection{\textit{C11} and \CorCpp: \FUNC{shmem\_wait\_until} and \FUNC{shmem\_test} --- \CTYPE{short} and \CTYPE{unsigned short} variants}
+The \CTYPE{short} and \CTYPE{unsigned short} type \CorCpp and \textit{C11}
+routines for \FUNC{shmem\_wait\_until} and \FUNC{shmem\_test} were deprecated
+because point-to-point synchronization routines are only compatible with
+\acp{AMO} (as of \openshmem 1.5), and there is no corresponding AMO for
+\CTYPE{short} and \CTYPE{unsigned short}.
+
+\subsection{Table~\ref{p2psynctypes}: point-to-point synchronization types}
+As of \openshmem 1.5, the point-to-point synchronization routines are only
+compatible with \acp{AMO}, so their interfaces are defined via the
+standard \ac{AMO} types in Table~\ref{stdamotypes}.
+
 \chapter{Changes to this Document}\label{sec:changelog}
 
 \section{Version 1.5}

diff --git a/content/p2p_sync_intro.tex b/content/p2p_sync_intro.tex
@@ -9,10 +9,10 @@
 Where appropriate compiler support is available, \openshmem provides
 type-generic point-to-point synchronization interfaces via \Cstd[11] generic
 selection. Such type-generic routines are supported for the
-``point-to-point synchronization types'' identified in
-Table~\ref{p2psynctypes}.
+``standard \ac{AMO} types'' identified in
+Table~\ref{stdamotypes}.
 
-The point-to-point synchronization types include some of the exact-width
+The standard \ac{AMO} types include some of the exact-width
 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
@@ -22,6 +22,7 @@
 \Cstd[99]~\S7.18.3 and \Cstd[11]~\S7.20.3.
 
 \begin{table}[h]
+\begin{DeprecateBlock}
   \begin{center}
     \begin{tabular}{|l|l|}
       \hline
@@ -44,6 +45,7 @@
     \TableCaptionRef{Point-to-Point Synchronization Types and Names}
     \label{p2psynctypes}
   \end{center}
+\end{DeprecateBlock}
 \end{table}
 
 The point-to-point synchronization interface provides named constants whose

diff --git a/content/shmem_test.tex b/content/shmem_test.tex
@@ -7,14 +7,14 @@
 \begin{C11synopsis}
 int @\FuncDecl{shmem\_test}@(TYPE *ivar, int cmp, TYPE cmp_value);
 \end{C11synopsis}
-where \TYPE{} is one of the point-to-point synchronization types specified by
-Table \ref{p2psynctypes}.
+where \TYPE{} is one of the standard \ac{AMO} types specified by
+Table \ref{stdamotypes}.
 
 \begin{Csynopsis}
 int @\FuncDecl{shmem\_\FuncParam{TYPENAME}\_test}@(TYPE *ivar, int cmp, TYPE cmp_value);
 \end{Csynopsis}
-where \TYPE{} is one of the point-to-point synchronization types and has a
-corresponding \TYPENAME{} specified by Table \ref{p2psynctypes}.
+where \TYPE{} is one of the standard \ac{AMO} types and has a
+corresponding \TYPENAME{} specified by Table \ref{stdamotypes}.
 
 \begin{apiarguments}
 

diff --git a/content/shmem_test_all.tex b/content/shmem_test_all.tex
@@ -7,15 +7,15 @@
 \begin{C11synopsis}
 int @\FuncDecl{shmem\_test\_all}@(TYPE *ivars, size_t nelems, const int *status, int cmp, TYPE cmp_value);
 \end{C11synopsis}
-where \TYPE{} is one of the point-to-point synchronization types specified by
-Table \ref{p2psynctypes}.
+where \TYPE{} is one of the standard \ac{AMO} types specified by
+Table \ref{stdamotypes}.
 
 \begin{Csynopsis}
 int @\FuncDecl{shmem\_\FuncParam{TYPENAME}\_test\_all}@(TYPE *ivars, size_t nelems, const int *status, int cmp,
     TYPE cmp_value);
 \end{Csynopsis}
-where \TYPE{} is one of the point-to-point synchronization types and has a
-corresponding \TYPENAME{} specified by Table \ref{p2psynctypes}.
+where \TYPE{} is one of the standard \ac{AMO} types and has a
+corresponding \TYPENAME{} specified by Table \ref{stdamotypes}.
 
 \begin{apiarguments}
 

diff --git a/content/shmem_test_all_vector.tex b/content/shmem_test_all_vector.tex
@@ -9,15 +9,15 @@
 int @\FuncDecl{shmem\_test\_all\_vector}@(TYPE *ivars, size_t nelems, const int *status, int cmp,
     TYPE *cmp_values);
 \end{C11synopsis}
-where \TYPE{} is one of the point-to-point synchronization types specified by
-Table \ref{p2psynctypes}.
+where \TYPE{} is one of the standard \ac{AMO} types specified by
+Table \ref{stdamotypes}.
 
 \begin{Csynopsis}
 int @\FuncDecl{shmem\_\FuncParam{TYPENAME}\_test\_all\_vector}@(TYPE *ivars, size_t nelems, const int *status, int cmp,
     TYPE *cmp_values);
 \end{Csynopsis}
-where \TYPE{} is one of the point-to-point synchronization types and has a
-corresponding \TYPENAME{} specified by Table \ref{p2psynctypes}.
+where \TYPE{} is one of the standard \ac{AMO} types and has a
+corresponding \TYPENAME{} specified by Table \ref{stdamotypes}.
 
 \begin{apiarguments}
 

diff --git a/content/shmem_test_any.tex b/content/shmem_test_any.tex
@@ -8,15 +8,15 @@
 size_t @\FuncDecl{shmem\_test\_any}@(TYPE *ivars, size_t nelems, const int *status, int cmp,
     TYPE cmp_value);
 \end{C11synopsis}
-where \TYPE{} is one of the point-to-point synchronization types specified by
-Table \ref{p2psynctypes}.
+where \TYPE{} is one of the standard \ac{AMO} types specified by
+Table \ref{stdamotypes}.
 
 \begin{Csynopsis}
 size_t @\FuncDecl{shmem\_\FuncParam{TYPENAME}\_test\_any}@(TYPE *ivars, size_t nelems, const int *status, int cmp,
     TYPE cmp_value);
 \end{Csynopsis}
-where \TYPE{} is one of the point-to-point synchronization types and has a
-corresponding \TYPENAME{} specified by Table \ref{p2psynctypes}.
+where \TYPE{} is one of the standard \ac{AMO} types and has a
+corresponding \TYPENAME{} specified by Table \ref{stdamotypes}.
 
 \begin{apiarguments}
 

diff --git a/content/shmem_test_any_vector.tex b/content/shmem_test_any_vector.tex
@@ -9,15 +9,15 @@
 size_t @\FuncDecl{shmem\_test\_any\_vector}@(TYPE *ivars, size_t nelems, const int *status, int cmp,
     TYPE *cmp_values);
 \end{C11synopsis}
-where \TYPE{} is one of the point-to-point synchronization types specified by
-Table \ref{p2psynctypes}.
+where \TYPE{} is one of the standard \ac{AMO} types specified by
+Table \ref{stdamotypes}.
 
 \begin{Csynopsis}
 size_t @\FuncDecl{shmem\_\FuncParam{TYPENAME}\_test\_any\_vector}@(TYPE *ivars, size_t nelems, const int *status,
     int cmp, TYPE *cmp_values);
 \end{Csynopsis}
-where \TYPE{} is one of the point-to-point synchronization types and has a
-corresponding \TYPENAME{} specified by Table \ref{p2psynctypes}.
+where \TYPE{} is one of the standard \ac{AMO} types and has a
+corresponding \TYPENAME{} specified by Table \ref{stdamotypes}.
 
 \begin{apiarguments}
 

diff --git a/content/shmem_test_some.tex b/content/shmem_test_some.tex
@@ -8,15 +8,15 @@
 size_t @\FuncDecl{shmem\_test\_some}@(TYPE *ivars, size_t nelems, size_t *indices, const int *status,
     int cmp, TYPE cmp_value);
 \end{C11synopsis}
-where \TYPE{} is one of the point-to-point synchronization types specified by
-Table \ref{p2psynctypes}.
+where \TYPE{} is one of the standard \ac{AMO} types specified by
+Table \ref{stdamotypes}.
 
 \begin{Csynopsis}
 size_t @\FuncDecl{shmem\_\FuncParam{TYPENAME}\_test\_some}@(TYPE *ivars, size_t nelems, size_t *indices,
     const int *status, int cmp, TYPE cmp_value);
 \end{Csynopsis}
-where \TYPE{} is one of the point-to-point synchronization types and has a
-corresponding \TYPENAME{} specified by Table \ref{p2psynctypes}.
+where \TYPE{} is one of the standard \ac{AMO} types and has a
+corresponding \TYPENAME{} specified by Table \ref{stdamotypes}.
 
 \begin{apiarguments}
 

diff --git a/content/shmem_test_some_vector.tex b/content/shmem_test_some_vector.tex
@@ -9,15 +9,15 @@
 size_t @\FuncDecl{shmem\_test\_some\_vector}@(TYPE *ivars, size_t nelems, size_t *indices, const int *status,
     int cmp, TYPE *cmp_values);
 \end{C11synopsis}
-where \TYPE{} is one of the point-to-point synchronization types specified by
-Table \ref{p2psynctypes}.
+where \TYPE{} is one of the standard \ac{AMO} types specified by
+Table \ref{stdamotypes}.
 
 \begin{Csynopsis}
 size_t @\FuncDecl{shmem\_\FuncParam{TYPENAME}\_test\_some\_vector}@(TYPE *ivars, size_t nelems, size_t *indices,
     const int *status, int cmp, TYPE *cmp_values);
 \end{Csynopsis}
-where \TYPE{} is one of the point-to-point synchronization types and has a
-corresponding \TYPENAME{} specified by Table \ref{p2psynctypes}.
+where \TYPE{} is one of the standard \ac{AMO} types and has a
+corresponding \TYPENAME{} specified by Table \ref{stdamotypes}.
 
 \begin{apiarguments}
 

diff --git a/content/shmem_wait_until.tex b/content/shmem_wait_until.tex
@@ -7,14 +7,14 @@
 \begin{C11synopsis}
 void @\FuncDecl{shmem\_wait\_until}@(TYPE *ivar, int cmp, TYPE cmp_value);
 \end{C11synopsis}
-where \TYPE{} is one of the point-to-point synchronization types specified by
-Table \ref{p2psynctypes}.
+where \TYPE{} is one of the standard \ac{AMO} types specified by
+Table \ref{stdamotypes}.
 
 \begin{Csynopsis}
 void @\FuncDecl{shmem\_\FuncParam{TYPENAME}\_wait\_until}@(TYPE *ivar, int cmp, TYPE cmp_value);
 \end{Csynopsis}
-where \TYPE{} is one of the point-to-point synchronization types and has a
-corresponding \TYPENAME{} specified by Table~\ref{p2psynctypes}.
+where \TYPE{} is one of the standard \ac{AMO} types and has a
+corresponding \TYPENAME{} specified by Table~\ref{stdamotypes}.
 
 \begin{DeprecateBlock}
 \begin{CsynopsisCol}

diff --git a/content/shmem_wait_until_all.tex b/content/shmem_wait_until_all.tex
@@ -8,14 +8,14 @@
 void @\FuncDecl{shmem\_wait\_until\_all}@(TYPE *ivars, size_t nelems, const int *status, int cmp,
     TYPE cmp_value);
 \end{C11synopsis}
-where \TYPE{} is one of the point-to-point synchronization types specified by
-Table \ref{p2psynctypes}.
+where \TYPE{} is one of the standard \ac{AMO} types specified by
+Table \ref{stdamotypes}.
 
 \begin{Csynopsis}
 void @\FuncDecl{shmem\_\FuncParam{TYPENAME}\_wait\_until\_all}@(TYPE *ivars, size_t nelems, const int *status, int cmp, TYPE cmp_value);
 \end{Csynopsis}
-where \TYPE{} is one of the point-to-point synchronization types and has a
-corresponding \TYPENAME{} specified by Table~\ref{p2psynctypes}.
+where \TYPE{} is one of the standard \ac{AMO} types and has a
+corresponding \TYPENAME{} specified by Table~\ref{stdamotypes}.
 
 \begin{apiarguments}
 

diff --git a/content/shmem_wait_until_all_vector.tex b/content/shmem_wait_until_all_vector.tex
@@ -9,14 +9,14 @@
 void @\FuncDecl{shmem\_wait\_until\_all\_vector}@(TYPE *ivars, size_t nelems, const int *status, int cmp,
     TYPE *cmp_values);
 \end{C11synopsis}
-where \TYPE{} is one of the point-to-point synchronization types specified by
-Table \ref{p2psynctypes}.
+where \TYPE{} is one of the standard \ac{AMO} types specified by
+Table \ref{stdamotypes}.
 
 \begin{Csynopsis}
 void @\FuncDecl{shmem\_\FuncParam{TYPENAME}\_wait\_until\_all\_vector}@(TYPE *ivars, size_t nelems, const int *status, int cmp, TYPE *cmp_values);
 \end{Csynopsis}
-where \TYPE{} is one of the point-to-point synchronization types and has a
-corresponding \TYPENAME{} specified by Table~\ref{p2psynctypes}.
+where \TYPE{} is one of the standard \ac{AMO} types and has a
+corresponding \TYPENAME{} specified by Table~\ref{stdamotypes}.
 
 \begin{apiarguments}
 

diff --git a/content/shmem_wait_until_any.tex b/content/shmem_wait_until_any.tex
@@ -8,15 +8,15 @@
 size_t @\FuncDecl{shmem\_wait\_until\_any}@(TYPE *ivars, size_t nelems, const int *status, int cmp,
     TYPE cmp_value);
 \end{C11synopsis}
-where \TYPE{} is one of the point-to-point synchronization types specified by
-Table \ref{p2psynctypes}.
+where \TYPE{} is one of the standard \ac{AMO} specified by
+Table \ref{stdamotypes}.
 
 \begin{Csynopsis}
 size_t @\FuncDecl{shmem\_\FuncParam{TYPENAME}\_wait\_until\_any}@(TYPE *ivars, size_t nelems, const int *status,
     int cmp, TYPE cmp_value);
 \end{Csynopsis}
-where \TYPE{} is one of the point-to-point synchronization types and has a
-corresponding \TYPENAME{} specified by Table~\ref{p2psynctypes}.
+where \TYPE{} is one of the standard \ac{AMO} types and has a
+corresponding \TYPENAME{} specified by Table~\ref{stdamotypes}.
 
 \begin{apiarguments}
 
@@ -81,4 +81,3 @@
 \end{apiexamples}
 
 \end{apidefinition}
-
diff --git a/content/shmem_wait_until_any_vector.tex b/content/shmem_wait_until_any_vector.tex
@@ -9,15 +9,15 @@
 size_t @\FuncDecl{shmem\_wait\_until\_any\_vector}@(TYPE *ivars, size_t nelems, const int *status, int cmp,
     TYPE *cmp_values);
 \end{C11synopsis}
-where \TYPE{} is one of the point-to-point synchronization types specified by
-Table \ref{p2psynctypes}.
+where \TYPE{} is one of the standard \ac{AMO} types specified by
+Table \ref{stdamotypes}.
 
 \begin{Csynopsis}
 size_t @\FuncDecl{shmem\_\FuncParam{TYPENAME}\_wait\_until\_any\_vector}@(TYPE *ivars, size_t nelems, const int *status,
     int cmp, TYPE *cmp_values);
 \end{Csynopsis}
-where \TYPE{} is one of the point-to-point synchronization types and has a
-corresponding \TYPENAME{} specified by Table~\ref{p2psynctypes}.
+where \TYPE{} is one of the standard \ac{AMO} types and has a
+corresponding \TYPENAME{} specified by Table~\ref{stdamotypes}.
 
 \begin{apiarguments}
 
@@ -80,4 +80,3 @@
 \end{apiexamples}
 
 \end{apidefinition}
-
diff --git a/content/shmem_wait_until_some.tex b/content/shmem_wait_until_some.tex
@@ -8,15 +8,15 @@
 size_t @\FuncDecl{shmem\_wait\_until\_some}@(TYPE *ivars, size_t nelems, size_t *indices, const int *status,
     int cmp, TYPE cmp_value);
 \end{C11synopsis}
-where \TYPE{} is one of the point-to-point synchronization types specified by
-Table \ref{p2psynctypes}.
+where \TYPE{} is one of the standard \ac{AMO} types specified by
+Table \ref{stdamotypes}.
 
 \begin{Csynopsis}
 size_t @\FuncDecl{shmem\_\FuncParam{TYPENAME}\_wait\_until\_some}@(TYPE *ivars, size_t nelems, size_t *indices,
     const int *status, int cmp, TYPE cmp_value);
 \end{Csynopsis}
-where \TYPE{} is one of the point-to-point synchronization types and has a
-corresponding \TYPENAME{} specified by Table~\ref{p2psynctypes}.
+where \TYPE{} is one of the standard \ac{AMO} types and has a
+corresponding \TYPENAME{} specified by Table~\ref{stdamotypes}.
 
 \begin{apiarguments}
 

diff --git a/content/shmem_wait_until_some_vector.tex b/content/shmem_wait_until_some_vector.tex
@@ -9,15 +9,15 @@
 size_t @\FuncDecl{shmem\_wait\_until\_some\_vector}@(TYPE *ivars, size_t nelems, size_t *indices,
     const int *status, int cmp, TYPE *cmp_values);
 \end{C11synopsis}
-where \TYPE{} is one of the point-to-point synchronization types specified by
-Table \ref{p2psynctypes}.
+where \TYPE{} is one of the standard \ac{AMO} types specified by
+Table \ref{stdamotypes}.
 
 \begin{Csynopsis}
 size_t @\FuncDecl{shmem\_\FuncParam{TYPENAME}\_wait\_until\_some\_vector}@(TYPE *ivars, size_t nelems, size_t *indices,
     const int *status, int cmp, TYPE *cmp_values);
 \end{Csynopsis}
-where \TYPE{} is one of the point-to-point synchronization types and has a
-corresponding \TYPENAME{} specified by Table~\ref{p2psynctypes}.
+where \TYPE{} is one of the standard \ac{AMO} types and has a
+corresponding \TYPENAME{} specified by Table~\ref{stdamotypes}.
 
 \begin{apiarguments}