main_spec.tex

\documentclass[10pt]{book}

\input{utils/packages}

\input{utils/defs}

\makeindex

\begin{document}

\input{content/frontmatter}



\section{The \openshmem Effort}\label{subsec:openshmem_effort}
\input{content/the_openshmem_effort}

\section{Programming Model Overview}\label{subsec:programming_model}
\input{content/programming_model_overview}

\section{Memory Model}\label{subsec:memory_model}
\input{content/memory_model}

\section{Execution Model}\label{subsec:execution_model}
\input{content/execution_model}

\section{Language Bindings and Conformance}\label{subsec:bindings}
\input{content/language_bindings_and_conformance}

\section{Library Constants}\label{subsec:library_constants}
\input{content/library_constants}

\section{Environment Variables }\label{subsec:environment_variables}
\input{content/environment_variables}




\clearpage



\section{OpenSHMEM Library API}\label{sec:openshmem_library_api}

\subsection{Library Setup, Exit, and Query Routines}
The library setup and query interfaces that initialize and monitor the parallel
environment of the \ac{PE}s.

\subsubsection{\textbf{SHMEM\_INIT}}\label{subsec:shmem_init}
\input{content/shmem_init}

\subsubsection{\textbf{SHMEM\_MY\_PE}}\label{subsec:shmem_my_pe}
\input{content/shmem_my_pe}

\subsubsection{\textbf{SHMEM\_N\_PES}}\label{subsec:shmem_n_pes}
\input{content/shmem_n_pes}

\subsubsection{\textbf{SHMEM\_FINALIZE}}\label{subsec:shmem_finalize}
\input{content/shmem_finalize}

\subsubsection{\textbf{SHMEM\_GLOBAL\_EXIT}}\label{subsec:shmem_global_exit}
\input{content/shmem_global_exit}

\subsubsection{\textbf{SHMEM\_PE\_ACCESSIBLE}}\label{subsec:shmem_pe_accessible}
\input{content/shmem_pe_accessible}

\subsubsection{\textbf{SHMEM\_ADDR\_ACCESSIBLE}}\label{subsec:shmem_addr_accessible}
\input{content/shmem_addr_accessible}

\subsubsection{\textbf{SHMEM\_PTR}}\label{subsec:shmem_ptr}
\input{content/shmem_ptr}

\subsubsection{\textbf{SHMEM\_INFO\_GET\_VERSION}}\label{subsec:shmem_info_get_version}
\input{content/shmem_info_get_version}

\subsubsection{\textbf{SHMEM\_INFO\_GET\_NAME}}\label{subsec:shmem_info_get_name}
\input{content/shmem_info_get_name}

\subsubsection{\textbf{START\_PES}}\label{subsec:start_pes}
\input{content/start_pes}





\subsection{Memory Management Routines}
\openshmem provides a set of \ac{API}s for managing the symmetric heap. The
\ac{API}s allow one to dynamically allocate, deallocate, reallocate and align
symmetric data objects in the symmetric heap, in \Clang{} and \Fortran.

\subsubsection{\textbf{SHMEM\_MALLOC, SHMEM\_FREE, SHMEM\_REALLOC, SHMEM\_ALIGN}}\label{subsec:shfree}
\input{content/shmem_malloc.tex}

\subsubsection{\textbf{SHPALLOC}}\label{subsec:shpalloc}
\input{content/shpalloc.tex}

\subsubsection{\textbf{SHPCLMOVE}}\label{subsec:shpclmove}
\input{content/shpclmove.tex}

\subsubsection{\textbf{SHPDEALLOC}}\label{subsec:shpdealloc}
\input{content/shpdealloc.tex}






\subsection{Remote Memory Access Routines}\label{sec:rma}
\input{content/rma_intro.tex}

\subsubsection{\textbf{SHMEM\_PUT}}\label{subsec:shmem_put}
\input{content/shmem_put.tex}

\subsubsection{\textbf{SHMEM\_P}}\label{subsec:shmem_p}
\input{content/shmem_p.tex}

\subsubsection{\textbf{SHMEM\_IPUT}}\label{subsec:shmem_iput}
\input{content/shmem_iput.tex}

\subsubsection{\textbf{SHMEM\_GET}}\label{subsec:shmem_get}
\input{content/shmem_get.tex}

\subsubsection{\textbf{SHMEM\_G}}\label{subsec:shmem_g}
\input{content/shmem_g.tex}

\subsubsection{\textbf{SHMEM\_IGET}}\label{subsec:shmem_iget}
\input{content/shmem_iget.tex}


\subsection{Non-blocking Remote Memory Access Routines}\label{sec:rma_nbi}

\subsubsection{\textbf{SHMEM\_PUT\_NBI}}\label{subsec:shmem_put_nbi}
\input{content/shmem_put_nbi.tex}

\subsubsection{\textbf{SHMEM\_GET\_NBI}}\label{subsec:shmem_get_nbi}
\input{content/shmem_get_nbi.tex}


\subsection{Atomic Memory Operations}\label{sec:amo}
\input{content/atomics_intro}

\subsubsection{\textbf{SHMEM\_ADD}}\label{subsec:shmem_add}
\input{content/shmem_add.tex}

\subsubsection{\textbf{SHMEM\_CSWAP}}\label{subsec:shmem_cswap}
\input{content/shmem_cswap.tex} 

\subsubsection{\textbf{SHMEM\_SWAP}}\label{subsec:shmem_swap}
\input{content/shmem_swap.tex}

\subsubsection{\textbf{SHMEM\_FINC}}\label{subsec:shmem_finc}
\input{content/shmem_finc.tex}

\subsubsection{\textbf{SHMEM\_INC}}\label{subsec:shmem_inc}
\input{content/shmem_inc.tex}

\subsubsection{\textbf{SHMEM\_FADD}}\label{subsec:shmem_fadd}
\input{content/shmem_fadd.tex}

\subsubsection{\textbf{SHMEM\_FETCH}}\label{subsec:shmem_fetch}
\input{content/shmem_fetch.tex}

\subsubsection{\textbf{SHMEM\_SET}}\label{subsec:shmem_set}
\input{content/shmem_set.tex}





\subsection{Collective Routines}\label{subsec:coll}
\input{content/collective_intro.tex}

\subsubsection{\textbf{SHMEM\_BARRIER\_ALL}}\label{subsec:shmem_barrier_all}
\input{content/shmem_barrier_all.tex}

\subsubsection{\textbf{SHMEM\_BARRIER}}\label{subsec:shmem_barrier}
\input{content/shmem_barrier.tex}

\subsubsection{\textbf{SHMEM\_BROADCAST}}\label{subsec:shmem_broadcast}
\input{content/shmem_broadcast.tex}

\subsubsection{\textbf{SHMEM\_COLLECT, SHMEM\_FCOLLECT}}\label{subsec:shmem_collect}
\input{content/shmem_collect.tex}

\subsubsection{\textbf{SHMEM\_REDUCTIONS}}\label{subsec:shmem_reductions}
\input{content/shmem_reductions.tex}

\subsubsection{\textbf{SHMEM\_ALLTOALL}}\label{subsec:shmem_alltoall}
\input{content/shmem_alltoall.tex}

\subsubsection{\textbf{SHMEM\_ALLTOALLS}}\label{subsec:shmem_alltoalls}
\input{content/shmem_alltoalls.tex}





\subsection{Point-To-Point Synchronization Routines}
The following section discusses \openshmem \ac{API}s that provides a mechanism
for synchronization between two \ac{PE}s based on the value of a symmetric data
object. 

\subsubsection{\textbf{SHMEM\_WAIT}}\label{subsec:shmem_wait}
\input{content/shmem_wait.tex}





\subsection{Memory Ordering Routines}\label{subsec:memory_order}
The following section discusses \openshmem \ac{API}s that provide mechanisms to
ensure ordering and/or delivery of \OPR{Put}, \ac{AMO}, and memory store
routines to symmetric data objects. 

\subsubsection{\textbf{SHMEM\_FENCE}}\label{subsec:shmem_fence}
\input{content/shmem_fence.tex}

\subsubsection{\textbf{SHMEM\_QUIET}}\label{subsec:shmem_quiet}
\input{content/shmem_quiet.tex}

\subsubsection{Synchronization and Communication Ordering in \openshmem}
\input{content/synchronization_model.tex}






\subsection{Distributed Locking Routines}
The following section discusses \openshmem locks as a mechanism to provide
mutual exclusion. Three routines are available for distributed locking,
\textit{set, test} and \textit{clear}.

\subsubsection{\textbf{SHMEM\_LOCK}}\label{subsec:shmem_lock}
\input{content/shmem_lock.tex}





\subsection{Cache Management}
All of these routines are deprecated and are provided for backwards
compatibility.  Implementations must include all items in this section, and the
routines should function properly and may notify the user about deprecation of
their use.

\subsubsection{\textbf{SHMEM\_CACHE}}\label{subsec:shmem_cache}
\input{content/shmem_cache.tex}





\clearpage



\input{content/backmatter}


\end{document}