Changeset c65b930 for doc/theses/andrew_beach_MMath

Timestamp:

May 25, 2021, 4:15:06 PM (5 years ago)

Author:

caparsons <caparson@…>

Branches:

ADT, arm-eh, ast-experimental, enum, forall-pointer-decay, jacob/cs343-translation, master, new-ast-unique-expr, pthread-emulation, qualifiedEnum

Children:

375fb46, 82f4063

Parents:

b984d54 (diff), 887fc79 (diff)
Note: this is a merge changeset, the changes displayed below correspond to the merge itself.
Use the (diff) links above to see all the changes relative to each parent.

Message:

Merge branch 'master' of plg.uwaterloo.ca:software/cfa/cfa-cc

Location:

doc/theses/andrew_beach_MMath

Files:

• cfalab.sty (modified) (1 diff)
• exception-layout.fig (added)
• existing.tex (modified) (3 diffs)
• features.tex (modified) (5 diffs)
• implement.tex (modified) (14 diffs)
• resumption-marking.fig (added)
• uw-ethesis.tex (modified) (1 diff)
• vtable-layout.fig (added)

doc/theses/andrew_beach_MMath/cfalab.sty

@@ -126 +126 @@
 }
 
+% \snake{<identifier>}
+% Improves writing of snake case (or any convention that uses _) by allowing
+% line breaks after _. Disables commands inside the block and formats the
+% identifier to look like code.
+\newcommand*\snake[1]{\snakefont{\expandafter\snake@next\detokenize{#1}\@nil}}
+
+% \snakefont{<text>}
+% Command used by \snake, you may renew the command to change its formating.
+\newcommand*\snakefont[1]{\texttt{#1}}
+
+% Thanks Manuel of TeX Stack exchange. (I got the base pattern from one of
+% their answers.) Note: \@nil should never be defined.
+\newcommand*\snake@next[1]{\ifx\@nil#1\else
+  \expandafter\ifx\string_#1\string_\allowbreak\else#1\fi
+  \expandafter\snake@next\fi
+}
+
 % common.tex Compatablity ===================================================
 % Below this line is for compatability with the old common.tex file.

doc/theses/andrew_beach_MMath/existing.tex

@@ -199 +199 @@
 forall(dtype T)
 struct node {
-        node(T) * next;  // generic linked node
+        node(T) * next;
         T * data;
 }
@@ -238 +238 @@
 \begin{cfa}
 coroutine CountUp {
-        unsigned int next; // communication variable
+        unsigned int next;
 }
 CountUp countup;
@@ -308 +308 @@
 {
         StringWorker stringworker; // fork thread running in "main"
-} // implicitly join with thread $\(\Rightarrow\)$ wait for completion
+} // <- implicitly join with thread / wait for completion
 \end{cfa}
 The thread main is where a new thread starts execution after a fork operation

doc/theses/andrew_beach_MMath/features.tex

@@ -115 +115 @@
 
 \paragraph{Communication}
-For effective exception handling, additional information is usually passed
+For effective exception handling, additional information is often passed
 from the raise to the handler.
 So far only communication of the exceptions' identity has been covered.
@@ -327 +327 @@
 \end{cfa}
 When viewed on its own, a try statement will simply execute the statements
-in @GUARDED_BLOCK@ and when those are finished the try statement finishes.
+in \snake{GUARDED_BLOCK} and when those are finished the try statement finishes.
 
 However, while the guarded statements are being executed, including any
@@ -343 +343 @@
 
 If no termination handler is found during the search then the default handler
-(@defaultTerminationHandler@) is run.
+(\defaultTerminationHandler) is run.
 Through \CFA's trait system the best match at the throw sight will be used.
 This function is run and is passed the copied exception. After the default
@@ -421 +421 @@
 execution continues after the raise statement.
 
-There is a global @defaultResumptionHandler@ is polymorphic over all
+There is a global \defaultResumptionHandler{} is polymorphic over all
 termination exceptions and preforms a termination throw on the exception.
-The @defaultTerminationHandler@ for that raise is matched at the original
-raise statement (the resumption @throwResume@) and it can be customized by
-introducing a new or better match as well.
+The \defaultTerminationHandler{} for that raise is matched at the
+original raise statement (the resumption @throw@\-@Resume@) and it can be
+customized by introducing a new or better match as well.
 
 \subsubsection{Resumption Marking}
@@ -681 +681 @@
 @CoroutineCancelled@ exception, which contains a references to the cancelled
 coroutine and the exception used to cancel it.
-The resume function also takes the @defaultResumptionHandler@ from the
+The resume function also takes the \defaultResumptionHandler{} from the
 caller's context and passes it to the internal report.
 

doc/theses/andrew_beach_MMath/implement.tex

@@ -16 +16 @@
 Virtual types only have one change to their structure: the addition of a
 pointer to the virtual table, which is called the \emph{virtual-table pointer}.
-Internally, the field is called @virtual_table@.
+Internally, the field is called \snake{virtual_table}.
 The field is fixed after construction. It is always the first field in the
 structure so that its location is always known.
@@ -124 +124 @@
 
 \begin{figure}
-\begin{cfa}
-type_id
-parent_field0
-...
-parent_fieldN
-child_field0
-...
-child_fieldN
-\end{cfa}
+\input{vtable-layout}
 \caption{Virtual Table Layout}
 \label{f:VirtualTableLayout}
@@ -171 +163 @@
 coroutine Example {
         // fields
-}
+};
 \end{cfa}
 
@@ -329 +321 @@
 To get full unwinding support all of this has to be done directly with
 assembly and assembler directives. Partiularly the cfi directives
-\texttt{.cfi\_lsda} and \texttt{.cfi\_personality}.
+\snake{.cfi_lsda} and \snake{.cfi_personality}.
 
 \subsection{Personality Functions}
@@ -337 +329 @@
 A personality function can preform different actions depending on how it is
 called.
-\begin{lstlisting}[language=C,{moredelim=**[is][\color{red}]{@}{@}}]
-typedef _Unwind_Reason_Code (*@_Unwind_Personality_Fn@) (
-        _Unwind_Action @action@,
-        _Unwind_Exception_Class @exception_class@,
-        _Unwind_Exception * @exception@,
-        struct _Unwind_Context * @context@
-);
+\begin{lstlisting}
+typedef _Unwind_Reason_Code (*_Unwind_Personality_Fn) (
+        _Unwind_Action action,
+        _Unwind_Exception_Class exception_class,
+        _Unwind_Exception * exception,
+        struct _Unwind_Context * context);
 \end{lstlisting}
 The @action@ argument is a bitmask of possible actions:
@@ -427 +418 @@
 function and the stop parameter. The stop function has a similar interface as a
 personality function, except it is also passed the stop parameter.
-\begin{lstlisting}[language=C,{moredelim=**[is][\color{red}]{@}{@}}]
-typedef _Unwind_Reason_Code (*@_Unwind_Stop_Fn@)(
-        _Unwind_Action @action@,
-        _Unwind_Exception_Class @exception_class@,
-        _Unwind_Exception * @exception@,
-        struct _Unwind_Context * @context@,
-        void * @stop_parameter@);
+\begin{lstlisting}
+typedef _Unwind_Reason_Code (*_Unwind_Stop_Fn)(
+        _Unwind_Action action,
+        _Unwind_Exception_Class exception_class,
+        _Unwind_Exception * exception,
+        struct _Unwind_Context * context,
+        void * stop_parameter);
 \end{lstlisting}
 
@@ -446 +437 @@
 \begin{sloppypar}
 Its arguments are the same as the paired personality function. The actions
-@_UA_CLEANUP_PHASE@ and @_UA_FORCE_UNWIND@ are always set when it is
+\snake{_UA_CLEANUP_PHASE} and \snake{_UA_FORCE_UNWIND} are always set when it is
 called. Beyond the libunwind standard, both GCC and Clang add an extra action
-on the last call at the end of the stack: @_UA_END_OF_STACK@.
+on the last call at the end of the stack: \snake{_UA_END_OF_STACK}.
 \end{sloppypar}
 
@@ -465 +456 @@
 
 The exception context should be retrieved by calling the function
-@this_exception_context@. For sequential execution, this function is defined as
+\snake{this_exception_context}.
+For sequential execution, this function is defined as
 a weak symbol in the \CFA system-library, @libcfa@. When a \CFA program is
 concurrent, it links with @libcfathread@, where this function is defined with a
@@ -493 +485 @@
 
 \begin{figure}
-\begin{verbatim}
-Fixed Header  | _Unwind_Exception   <- pointer target
-              |
-              | Cforall storage
-              |
-Variable Body | the exception       <- fixed offset
-              V ...
-\end{verbatim}
+\input{exception-layout}
 \caption{Exception Layout}
 \label{f:ExceptionLayout}
@@ -525 +510 @@
 \begin{figure}
 \centering
-% Andrew: Figure out what these do and give them better names.
-\newsavebox{\myboxA}
-\newsavebox{\myboxB}
-\begin{lrbox}{\myboxA}
+\newsavebox{\codeBox}
+\newsavebox{\stackBox}
+\begin{lrbox}{\codeBox}
 \begin{lstlisting}[language=CFA,{moredelim=**[is][\color{red}]{@}{@}}]
 unsigned num_exceptions = 0;
@@ -551 +535 @@
 \end{lrbox}
 
-\begin{lrbox}{\myboxB}
+\begin{lrbox}{\stackBox}
 \begin{lstlisting}
+| try-finally
+| try-catch (Example)
+throws()
+| try-finally
+| try-catch (Example)
+throws()
+| try-finally
+| try-catch (Example)
+throws()
+main()
 \end{lstlisting}
 \end{lrbox}
 
-{\usebox\myboxA}
+{\usebox\codeBox}
 \hspace{25pt}
-{\usebox\myboxB}
+{\usebox\stackBox}
 
 \caption{Multiple Exceptions}
@@ -647 +641 @@
         {
                 Exception1 * name1;
-                if (name1 = (virtual Exception1 *)__exception_inst && check(name1)) {
+                if (name1 = (virtual Exception1 *)__exception_inst
+                                && check(name1)) {
                         return 1;
                 }
@@ -732 +727 @@
         {
                 Exception1 * name1;
-                if (name1 = (virtual Exception1 *)__exception_inst && check(name1)) {
+                if (name1 = (virtual Exception1 *)__exception_inst
+                                && check(name1)) {
                         // CATCH BLOCK 1
                         return 1;
@@ -775 +771 @@
 
 \begin{figure}
-\begin{minipage}[l][][b]{0,2\textwidth}
-\begin{verbatim}
-
-
-  X <-
-  |
-  V
-  X
-  |
-  V
-  X
-\end{verbatim}
-Initial State
-\end{minipage}
-\begin{minipage}[l][][b]{0,2\textwidth}
-\begin{verbatim}
-
-
-  X
-  |
-  V
-  X <-
-  |
-  V
-  X
-\end{verbatim}
-Handler Found
-\end{minipage}
-\begin{minipage}[l][][b]{0,2\textwidth}
-\begin{verbatim}
-  X <-
- /
-/ X
-| |
-\ V
-  X
-  |
-  V
-  X
-\end{verbatim}
-Try Block Added
-\end{minipage}
-\begin{minipage}[l][][b]{0,2\textwidth}
-\begin{verbatim}
-
-
-  X <-
-  |
-  V
-  X
-  |
-  V
-  X
-\end{verbatim}
-Handler Done
-\end{minipage}
+\input{resumption-marking}
 \caption{Resumption Marking}
 \label{f:ResumptionMarking}

doc/theses/andrew_beach_MMath/uw-ethesis.tex

@@ -202 +202 @@
 \makeglossaries
 
+% New commands/options for this document alone:
+% Code snipits with formating and line-breaks.
+\newcommand\defaultResumptionHandler{\texttt{default\-Resumption\-Handler}}
+\newcommand\defaultTerminationHandler{\texttt{default\-Termination\-Handler}}
+
 % listings package configuation:
 \lstMakeShortInline@