forked from openshmem-org/specification
-
Notifications
You must be signed in to change notification settings - Fork 0
/
main_spec.tex
executable file
·260 lines (245 loc) · 8.08 KB
/
main_spec.tex
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
\documentclass[10pt]{book}
\usepackage[letterpaper,top=2.5cm,bottom=2.5cm,left=2.5cm,right=2.5cm]{geometry}
\usepackage{makeidx}
\usepackage{graphicx}
\usepackage{multicol}
\usepackage{float}
\usepackage{listings}
\usepackage[usenames,dvipsnames]{color}
\usepackage{amsmath}
\usepackage{ifthen}
\usepackage[table]{xcolor}
\usepackage{textcomp}
\usepackage{alltt}
\usepackage{ifpdf}
\usepackage[UKenglish]{isodate}
\ifpdf
\usepackage[pdftex,
pagebackref=true,
colorlinks=true,
linkcolor=blue,
unicode
]{hyperref}
\else
\usepackage[ps2pdf,
pagebackref=true,chapter
colorlinks=true,
linkcolor=blue,
unicode
]{hyperref}
\usepackage{pspicture}
\fi
\usepackage[utf8]{inputenc}
\usepackage{mathptmx}
\usepackage{sectsty}
\usepackage{mathptmx}
\usepackage[scaled=.90]{helvet}
\usepackage{courier}
\usepackage{sectsty}
\usepackage[titles]{tocloft}
\usepackage{prettyref}
\usepackage{mdwlist}
\usepackage{enumitem}
\usepackage{framed, color} %SP
\usepackage{pbox} %SP
\definecolor{shadecolor}{rgb}{0.92,0.92,0.92}
\usepackage{draftcopy}
\usepackage{fancyhdr}
\usepackage{wrapfig}
\usepackage[nolist]{acronym}
\usepackage{caption}
\usepackage{subcaption}
%\usepackage[latin]{babel} %causing page headings "CONTENTS" to show as "INDEX".
%%%%%%%%%%%%%%%Borrowed from MPI Spec%%%%%%%%
\usepackage[usenames,dvipsnames]{color}
\definecolor{ListingBG}{rgb}{0.91,0.91,0.91}
\include{osh}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\setcounter{secnumdepth}{3}
\makeindex
% Make content "clickable"
\begin{document}
\hypersetup{pageanchor=true,citecolor=blue}
% Set Header
\pagestyle{fancy}
\fancyhead{}
\fancyhead[LE,LO]{\insertDocVersion}
%\fancyhead[CO,CE]{--- DRAFT ---}
\fancyfoot[CE,CO]{\thepage}
\include{coverpage}
\setcounter{tocdepth}{3}
\tableofcontents
\mainmatter % included for use of documenttype 'book'
%\pagestyle{headings} \withlinenumbers
\pagestyle{fancy} \withlinenumbers%replacing {headings} with {fancy} for customization
\fancyhf{}
\fancyhead[RE, LO]{\rightmark}
\fancyhead[RO, LE]{\thepage}
\renewcommand{\headrulewidth}{0pt}
\renewcommand{\thesection}{\arabic{section}}
{ %using setlength to force standardized spacing, if needed
%\setlength{\baselineskip}{3pt plus 3pt minus 3pt}
\setlength{\parskip}{3pt} %plus 3pt minus 9pt}
\startchap
\section*{Introduction}
\label{sec:intro}
%\input{INTRODUCTION/introduction}
%\input{INTRODUCTION/overview}
%\input{INTRODUCTION/introduction_pgas}
\input{INTRODUCTION/osh_project}
\label{subsec:osh_project}
\input{INTRODUCTION/programming_model}
\label{subsec:programming_model}
\input{INTRODUCTION/memory_model}
\label{subsec:memory_model}
\input{INTRODUCTION/new_execution_model}
%\input{INTRODUCTION/original_language_bindings}
\input{INTRODUCTION/language_bindings} %SP: Reverting to original text for now as per discussion on 02/04/2014
\input{INTRODUCTION/library_constants.tex}
\label{subsec:library_constants}
\input{INTRODUCTION/environment_variables.tex}
\label{subsec:environment_variables}
\label{subsec:language_bindings}
%\input{INTRODUCTION/synchronization_model} %SP:Moving to remote memory operations section as per discussion on 1/21/14
\clearpage
\startchap
\section{OpenSHMEM Library API}
\label{sec:openshmem_library_api}
\subsection{Library Setup and Query Operations}%SP: Merging two operations
\input{INTRODUCTION/setup_query_intro}
\label{subsec:start_pes}
\input{TEX_FILES/start_pes.tex} %Swaroop
\input{TEX_FILES/NEW_shmem_my_pe.tex} %Tommy
\input{TEX_FILES/NEW_shmem_num_pe.tex}%Tommy
\label{subsec:shmem_pe_accessible}
\input{TEX_FILES/shmem_pe_accessible} %Oscar
\label{subsec:shmem_addr_accessible}
\input{TEX_FILES/shmem_addr_accessible}%Tommy
\input{TEX_FILES/shmem_ptr.tex} %Oscar
%\startchap
\subsection{Memory Management Operations}
\input{INTRODUCTION/memory_management_intro}
\label{subsec:shfree}
\input{TEX_FILES/shfree.tex}%Tommy
\input{TEX_FILES/shpalloc.tex} %Swaroop
\input{TEX_FILES/shpclmove.tex} %Swaroop
\input{TEX_FILES/shpdeallc.tex} %Swaroop
%\startchap
\input{INTRODUCTION/rma_intro.tex}
\label{subsec:shmem_put}
\input{TEX_FILES/shmem_put.tex} %Oscar
\label{subsec:shmem_p}
\input{TEX_FILES/shmem_p.tex} %Oscar
\input{TEX_FILES/shmem_iput.tex} %Oscar
\label{subsec:shmem_get}
\input{TEX_FILES/shmem_get.tex} %Manju
\label{subsec:shmem_g}
\input{TEX_FILES/shmem_g.tex} %Manju
\input{TEX_FILES/shmem_iget.tex} %Manju
%\startchap
\subsection{Atomic Memory Operations}
\input{INTRODUCTION/atomics_intro}
\label{subsec:shmem_add}
\input{TEX_FILES/shmem_add.tex}%Tommy
\label{subsec:shmem_cswap}
\input{TEX_FILES/shmem_cswap.tex} %Pasha
\label{subsec:shmem_swap}
\input{TEX_FILES/shmem_swap.tex} %Swaroop
\label{subsec:shmem_finc}
\input{TEX_FILES/shmem_finc.tex} %Manju
\label{subsec:shmem_inc}
\input{TEX_FILES/shmem_inc.tex} %Manju
\label{subsec:shmem_fadd}
\input{TEX_FILES/shmem_fadd.tex}%Pasha
%\startchap
\subsection{Collective Operations}
\label{subsec:coll}
\input{INTRODUCTION/collective_intro.tex}
\label{subsec:shmem_barrier_all}
\input{TEX_FILES/shmem_barrier_all.tex} %Pasha
\label{subsec:shmem_barrier}
\input{TEX_FILES/shmem_barrier.tex} %Tommy
\label{subsec:shmem_broadcast}
\input{TEX_FILES/shmem_broadcast.tex} %Pasha
\label{subsec:shmem_collect} %label in shmem_collect.tex, label from this location references page 1
\input{TEX_FILES/shmem_collect.tex} %Pasha
\label{subsec:shmem_reductions}
\input{TEX_FILES/shmem_reductions.tex} %Swaroop
%\startchap
\subsection{Point-To-Point Synchronization Functions}%SP: Adding a chapter to include wait and wait until
\input{INTRODUCTION/synchronization_intro} %Swaroop
\label{subsec:shmem_wait}
\input{TEX_FILES/shmem_wait.tex} %Swaroop
%\startchap
\subsection{Memory Ordering Operations} %SP: Adding a chapter to include fence and quiet
\label{subsec:memory_order}
\input{INTRODUCTION/ordering_intro} %Swaroop
\label{subsec:shmem_fence}
\input{TEX_FILES/shmem_fence.tex} %Manju
\label{subsec:shmem_quiet}
\input{TEX_FILES/shmem_quiet.tex} %Swaroop
\input{INTRODUCTION/synchronization_model.tex}
%\startchap
\subsection{Distributed Locking Operations}
\input{INTRODUCTION/locks_intro} %Swaroop
\input{TEX_FILES/shmem_lock.tex} %Oscar
%\startchap
\subsection{Deprecated API}
\input{INTRODUCTION/deprication.tex} %Pasha
\input{TEX_FILES/shmem_cache.tex} %Pasha
\clearpage
%\startchap
% -> Compilation
% -> Writing OpenSHMEM Programs
% -> Application written in Fortran
\appendix
%defining pagestyle for annex
%\pagestyle{plain} \withlinenumbers
\pagestyle{fancy} \withlinenumbers
\fancyhf{}
\fancyhead[RE, LO]{\leftmark}
\fancyhead[RO, LE]{\thepage}
\fancyfoot[CE,CO]{\thepage}
\renewcommand{\headrulewidth}{0pt}
%\fancyfoot[C]{\thepage}%no numbering appearing on non-title pages
\chapter{Writing \openshmem Programs}
\input{INTRODUCTION/writing_programs.tex}
\chapter{Compiling and Running Applications}
\input{INTRODUCTION/compile_exec_applications.tex}
\chapter{Undefined Behavior in \openshmem}
\label{sec:undefined}
\input{INTRODUCTION/undefined_behavior}
\chapter{Interoperability with other Programming Models}
\label{sec:mpi}
\input{INTRODUCTION/mpi_interoperability}
\clearpage
\chapter{History of \openshmem{}}
\input{INTRODUCTION/openshmem_history.tex}
\label{sec:openshmem_history}
\chapter{Changes to this Document}
\input{INTRODUCTION/changelog}
%\clearpage
%\startchap
%\section{\openshmem{} program examples}
%\input{INTRODUCTION/examples}
} %end of setlength command
% Manju: Don't move the definitions to the front, it requires to be after content
% Add acronyms here
\begin{acronym}
\acro{RMA}{\emph{Remote Memory Access}}
\acro{RMO}{\emph{Remote Memory Operations}}
\acro{AMO}{\emph{Atomic Memory Operation}}
\acro{PE}{\emph{Processing Element}}
\acrodefplural{PE}[PEs]{\emph{Processing Elements}}
\acro{PGAS}{\emph{Partitioned Global Address Space}}
\acro{API}{\emph{Application Programming Interface}}
\acro{MPI}{\emph{Message Passing Interface}}
\acro{SPMD}{\emph{Single Program Multiple Data}}
\acro{UH}{University of Houston}
\acro{ORNL}{Oak Ridge National Laboratory}
\acro{LANL}{Los Alamos National Laboratory}
\acro{ESSC}{Extreme Scale Systems Center}
\acro{OSSS}{Open Software System Solutions}
\acro{DoD}{U.S. Department of Defense}
\end{acronym}
\end{document}