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.

Sign up for GitHub

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

Update instructions for CMake build #3

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update instructions for CMake build #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 2 additions & 5 deletions coherence.tex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,7 @@ \section{Atomic}
\label{sec:atomic}

\begin{figure}
{\small
\lstinputlisting[linerange={16-58}]{Examples/Coherence/atomic/atomic.cc}
}
\lstinputlisting[language=C++,linerange={16-58}]{Examples/Coherence/atomic/atomic.cc}
\caption{\legionbook{Coherence/atomic/atomic.cc}}
\label{fig:atomic}
\end{figure}
Expand Down Expand Up @@ -148,8 +146,7 @@ \section{Simultaneous}
\end{itemize}

\begin{figure}
\centering
\lstinputlisting[linerange={16-77}]{Examples/Coherence/simultaneous/sim.cc}
\lstinputlisting[language=C++,linerange={16-77}]{Examples/Coherence/simultaneous/sim.cc}
\caption{\legionbook{Coherene/simultaneous/sim.cc}}
\label{fig:sim}
\end{figure}
Expand Down
4 changes: 1 addition & 3 deletions control_replication.tex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,7 @@ \chapter{Control Replication}


\begin{figure}
{\small
\lstinputlisting[linerange={15-44,59-74}]{Examples/ControlReplication/sum/cp.cc}
}
\lstinputlisting[language=C++,linerange={15-44,59-74}]{Examples/ControlReplication/sum/cp.cc}
\caption{\legionbook{ControlReplication/sum/cp.cc}}
\label{fig:ctrlrep}
\end{figure}
Expand Down
2 changes: 1 addition & 1 deletion docker/Dockerfile.latex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ ENV DEBIAN_FRONTEND noninteractive
COPY . /build

RUN apt-get update -qq && \
apt-get install -qq git make texlive && \
apt-get install -qq git make texlive texlive-fonts-extra && \
apt-get clean

RUN cd /build && make
44 changes: 34 additions & 10 deletions installation.tex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,42 @@ \chapter{Installation}

The Legion homepage is \url{https://legion.stanford.edu}. Here you will find
links to everything associated with the project, including a set of
tutorials that are distinct from this manual. The Legion distribution is at
tutorials that are distinct from this manual. The Legion software distribution is at
\url{https://github.com/StanfordLegion/legion}. The distribution has been
tested on Linux and macOS. To install, in a shell type
\begin{lstlisting}
> cd DIR
> git clone https://github.com/StanfordLegion/legion
tested on Linux and macOS.

To install Legion, open a shell and type:

\begin{lstlisting}[language=bash,style=inline]
git clone https://github.com/StanfordLegion/legion.git
cd legion
mkdir build install
cd build
cmake .. -DCMAKE_INSTALL_PREFIX=$PWD/../install
make install -j4
cd ../..
\end{lstlisting}
where {\tt DIR} is a directory of your choice. This command creates
the directory {\tt DIR/legion}. To complete the installation,
set the environment variable {\tt LG\_RT\_DIR} to {\tt DIR/legion/runtime}.
For {\tt bash} users, an example {\tt .bashrc} is included in
\legionbook{Installation}.

This installs Legion into the directory
\lstinline{legion/install}. Note that by default, a debug build is
created. To build a release copy of Legion, add
\lstinline{-DCMAKE_BUILD_Type=Release} the the \lstinline{cmake}
command. (A debug build is strongly recommended when initially
developing with Legion, as it enables a number of checks for correct
usage of Legion APIs, in addition to enabling debug symbols.)

The examples in this manual can then be downloaded and built with:

\begin{lstlisting}[language=bash,style=inline]
git clone https://github.com/StanfordLegion/legion-manual.git
cd legion-manual
mkdir build
cmake ../Examples -DCMAKE_PREFIX_PATH=$PWD/../../legion/install
make -j4
\end{lstlisting}

All of the examples in this manual are included in the build, and will
be located under the \lstinline{legion-manual/build} directory.

\section{Regent}

Expand Down
72 changes: 72 additions & 0 deletions legion.tex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,84 @@
\usepackage{url}
\usepackage{graphicx}
\usepackage{microtype}
\usepackage{xcolor}
\usepackage{geometry} % widen the page margins a bit

\usepackage{inconsolata} % the default monospace font is ugly

\lstset{upquote=true}

\newcommand{\legionbook}[1]{{\tt Examples/#1}}
\newcommand{\Cpp}{C++}

% use Eisvogen style for code highlighting
% https://github.com/Wandmalfarbe/pandoc-latex-template/blob/04e329698d01c3a25aa72ad81d98483284669316/eisvogel.tex

%
% general listing colors
%
\definecolor{listing-background}{HTML}{F7F7F7}
\definecolor{listing-rule}{HTML}{B3B2B3}
\definecolor{listing-numbers}{HTML}{B3B2B3}
\definecolor{listing-text-color}{HTML}{000000}
\definecolor{listing-keyword}{HTML}{435489}
\definecolor{listing-keyword-2}{HTML}{1284CA} % additional keywords
\definecolor{listing-keyword-3}{HTML}{9137CB} % additional keywords
\definecolor{listing-identifier}{HTML}{435489}
\definecolor{listing-string}{HTML}{00999A}
\definecolor{listing-comment}{HTML}{8E8E8E}

\lstdefinestyle{eisvogel_listing_style}{
numbers = left,
xleftmargin = 2.7em,
framexleftmargin = 2.5em,
backgroundcolor = \color{listing-background},
basicstyle = \color{listing-text-color}\linespread{1.0}%
\lst@ifdisplaystyle%
\scriptsize%
\fi\ttfamily{},
breaklines = true,
frame = single,
framesep = 0.19em,
rulecolor = \color{listing-rule},
frameround = ffff,
tabsize = 4,
numberstyle = \color{listing-numbers},
aboveskip = 1.0em,
belowskip = 0.1em,
abovecaptionskip = 0em,
belowcaptionskip = 1.0em,
keywordstyle = {\color{listing-keyword}\bfseries},
keywordstyle = {[2]\color{listing-keyword-2}\bfseries},
keywordstyle = {[3]\color{listing-keyword-3}\bfseries\itshape},
sensitive = true,
identifierstyle = \color{listing-identifier},
commentstyle = \color{listing-comment},
stringstyle = \color{listing-string},
showstringspaces = false,
escapeinside = {/*@}{@*/}, % Allow LaTeX inside these special comments
literate =
{á}{{\'a}}1 {é}{{\'e}}1 {í}{{\'i}}1 {ó}{{\'o}}1 {ú}{{\'u}}1
{Á}{{\'A}}1 {É}{{\'E}}1 {Í}{{\'I}}1 {Ó}{{\'O}}1 {Ú}{{\'U}}1
{à}{{\`a}}1 {è}{{\'e}}1 {ì}{{\`i}}1 {ò}{{\`o}}1 {ù}{{\`u}}1
{À}{{\`A}}1 {È}{{\'E}}1 {Ì}{{\`I}}1 {Ò}{{\`O}}1 {Ù}{{\`U}}1
{ä}{{\"a}}1 {ë}{{\"e}}1 {ï}{{\"i}}1 {ö}{{\"o}}1 {ü}{{\"u}}1
{Ä}{{\"A}}1 {Ë}{{\"E}}1 {Ï}{{\"I}}1 {Ö}{{\"O}}1 {Ü}{{\"U}}1
{â}{{\^a}}1 {ê}{{\^e}}1 {î}{{\^i}}1 {ô}{{\^o}}1 {û}{{\^u}}1
{Â}{{\^A}}1 {Ê}{{\^E}}1 {Î}{{\^I}}1 {Ô}{{\^O}}1 {Û}{{\^U}}1
{œ}{{\oe}}1 {Œ}{{\OE}}1 {æ}{{\ae}}1 {Æ}{{\AE}}1 {ß}{{\ss}}1
{ç}{{\c c}}1 {Ç}{{\c C}}1 {ø}{{\o}}1 {å}{{\r a}}1 {Å}{{\r A}}1
{€}{{\EUR}}1 {£}{{\pounds}}1 {«}{{\guillemotleft}}1
{»}{{\guillemotright}}1 {ñ}{{\~n}}1 {Ñ}{{\~N}}1 {¿}{{?`}}1
{…}{{\ldots}}1 {≥}{{>=}}1 {≤}{{<=}}1 {„}{{\glqq}}1 {“}{{\grqq}}1
{”}{{''}}1
}
\lstset{style=eisvogel_listing_style}

\lstdefinestyle{inline}{
numbers=none,
}

\begin{document}

\title{Programming with Legion}
Expand Down
7 changes: 2 additions & 5 deletions mapping.tex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,9 +86,7 @@ \subsection{Mapper Registration}
example registering a custom mapper.

\begin{figure}
{ \small
\lstinputlisting[linerange={14,78}]{Examples/Mapping/registration/registration.cc}
}
\lstinputlisting[language=C++,linerange={14,78}]{Examples/Mapping/registration/registration.cc}
\caption{\legionbook{Mapping/registration/registration.cc}}
\label{fig:mapper_registration}
\end{figure}
Expand Down Expand Up @@ -227,8 +225,7 @@ \subsection{Machine Interface}
commonly invoked queries to avoid duplicated work.

\begin{figure}
{\small
\lstinputlisting[linerange={22,80}]{Examples/Mapping/machine/machine.cc}}
\lstinputlisting[language=C++,linerange={22,80}]{Examples/Mapping/machine/machine.cc}
\caption{\legionbook{Mapping/machine/machine.cc}}
\label{fig:mapper_machine}
\end{figure}
Expand Down
24 changes: 6 additions & 18 deletions partitioning.tex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,9 +100,7 @@ \section{Equal Partitions}


\begin{figure}
{\small
\lstinputlisting[linerange={15-49}]{Examples/Partitions/equal/equal.cc}
}
\lstinputlisting[language=C++,linerange={15-49}]{Examples/Partitions/equal/equal.cc}
\caption{\legionbook{Partitions/equal/equal.cc}}
\label{fig:equalpart}
\end{figure}
Expand Down Expand Up @@ -130,9 +128,7 @@ \section{Partition by Field}
The logic for launching the {\tt sum\_task} over the paritition on lines 31-35 is the same as in Figure~\ref{fig:equalpart}.

\begin{figure}
{\small
\lstinputlisting[linerange={17-74}]{"Examples/Partitions/partition_by_field/pbf.cc"}
}
\lstinputlisting[language=C++,linerange={17-74}]{"Examples/Partitions/partition_by_field/pbf.cc"}
\caption{\legionbook{Partitions/partition\_by\_field/pbf.cc}}
\label{fig:pbf}
\end{figure}
Expand Down Expand Up @@ -168,9 +164,7 @@ \section{Partition by Restriction}
of the subregion---for a region with an index space 0..99, it is necessary that the color space be $0..3$ and not some other set of four points.

\begin{figure}
{\small
\lstinputlisting[linerange={15-49}]{"Examples/Partitions/partition_by_restriction/pbr.cc"}
}
\lstinputlisting[language=C++,linerange={15-49}]{"Examples/Partitions/partition_by_restriction/pbr.cc"}
\caption{\legionbook{Partitions/partition\_by\_restriction/pbr.cc}}
\label{fig:pbr}
\end{figure}
Expand Down Expand Up @@ -199,9 +193,7 @@ \section{Set-Based Partitions}


\begin{figure}
{\small
\lstinputlisting[linerange={21-58}]{Examples/Partitions/sets/sets.cc}
}
\lstinputlisting[language=C++,linerange={21-58}]{Examples/Partitions/sets/sets.cc}
\caption{\legionbook{Partitions/sets/sets.cc}}
\label{fig:sets}
\end{figure}
Expand Down Expand Up @@ -235,9 +227,7 @@ \section{Image Partitions}
The rest of the program (lines 41-45) sums the value field of the destination partition's subregions (which as in other examples has the same value 1 for every element). Since the 1-1 pointer relationship copies the coloring exactly from source to destination and the source was an equal partition, the sums printed for each subregion are the same.

\begin{figure}
{\small
\lstinputlisting[linerange={17-76}]{Examples/Partitions/image/image.cc}
}
\lstinputlisting[language=C++,linerange={17-76}]{Examples/Partitions/image/image.cc}
\caption{\legionbook{Partitions/image/image.cc}}
\label{fig:image}
\end{figure}
Expand Down Expand Up @@ -268,9 +258,7 @@ \section{Pre-Image Partitions}


\begin{figure}
{\small
\lstinputlisting[linerange={17-74}]{"Examples/Partitions/pre_image/preimage.cc"}
}
\lstinputlisting[language=C++,linerange={17-74}]{"Examples/Partitions/pre_image/preimage.cc"}
\caption{\legionbook{Partitions/pre\_image/preimage.cc}}
\label{fig:preimage}
\end{figure}
Expand Down
16 changes: 6 additions & 10 deletions regions.tex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,7 @@ \chapter{Regions}
region.

\begin{figure}
{\small
\lstinputlisting[linerange={19-38}]{Examples/Regions/logicalregions/logicalregions.cc}}
\lstinputlisting[language=C++,linerange={19-38}]{Examples/Regions/logicalregions/logicalregions.cc}
\caption{\legionbook{Regions/logicalregions/logicalregions.cc}}
\label{fig:lr1}
\end{figure}
Expand All @@ -77,8 +76,7 @@ \section{Physical Instances, Region Requirements, Privileges and Accessors}
Chapter~\ref{chap:coherence}.

\begin{figure}
{\small
\lstinputlisting[linerange={31-39}]{Examples/Regions/physicalregions/physicalregions.cc}}
\lstinputlisting[language=C++,linerange={31-39}]{Examples/Regions/physicalregions/physicalregions.cc}
\caption{Task launches from \legionbook{Regions/physicalregions/physicalregions.cc.}}
\label{fig:privileges}
\end{figure}
Expand Down Expand Up @@ -142,8 +140,7 @@ \section{Physical Instances, Region Requirements, Privileges and Accessors}
accessed by the subtask.

\begin{figure}
{\small
\lstinputlisting[linerange={63-75}]{Examples/Regions/physicalregions/physicalregions.cc}}
\lstinputlisting[language=C++,linerange={63-75}]{Examples/Regions/physicalregions/physicalregions.cc}
\caption{Region accessors from \legionbook{Regions/physicalregions/physicalregions.cc}.}
\label{fig:accessors}
\end{figure}
Expand Down Expand Up @@ -203,8 +200,7 @@ \section{Fill Fields}
the runtime that fills every occurrence of {\tt FIELD\_A} with a default value.

\begin{figure}
{\small
\lstinputlisting[linerange={28-31}]{Examples/Regions/fillfields/fillfields.cc}}
\lstinputlisting[language=C++,linerange={28-31}]{Examples/Regions/fillfields/fillfields.cc}
\caption{\legionbook{Regions/fillfields/fillfields.cc}}
\label{fig:fill}
\end{figure}
Expand Down Expand Up @@ -256,9 +252,9 @@ \section{Inline Launchers}

\begin{figure}
{\small
\lstinputlisting[linerange={26-29}]{Examples/Regions/inlinemapping/inlinemapping.cc}
\lstinputlisting[language=C++,linerange={26-29}]{Examples/Regions/inlinemapping/inlinemapping.cc}
... lines omitted ...\\
\lstinputlisting[linerange={43-44}]{Examples/Regions/inlinemapping/inlinemapping.cc}}
\lstinputlisting[language=C++,linerange={43-44}]{Examples/Regions/inlinemapping/inlinemapping.cc}}
\caption{\legionbook{Regions/inlinemapping/inlinemapping.cc}}
\label{fig:inlinelaunch}
\end{figure}
Expand Down
Loading