process todos
[phd-thesis.git] / top / lang.tex
index cf245de..243733e 100644 (file)
@@ -29,13 +29,14 @@ Furthermore, this particular type of embedding has the property that it is exten
 Adding a language construct is as simple as adding a type class.
 Adding an interpretation is done by creating a new data type and providing implementations for the various type classes.
 
-In order to reduce the hardware requirements for devices running \gls{MTASK} programs, several measures have been taken.
+In order to reduce the hardware requirements for devices running \gls{MTASK} programs, several measures have been taken that are reflected in the language design.
 Programs in \gls{MTASK} are written in the \gls{MTASK} \gls{DSL}, separating them from the host \gls{ITASK} program.
 This allows the tasks to be constructed at compile time in order to tailor-make them for the specific work requirements.
 Furthermore, the \gls{MTASK} language is restricted: there are no recursive data structures, no higher-order functions, strict evaluation, and functions and objects can only be declared at the top level.
 
 \section{Class-based shallow embedding}
-Let us illustrate this technique by taking the very simple language of literal values.
+The \gls{MTASK} language is implemented as a class-based shallow, also known as tagless-final, embedded \gls{DSL} (see also \cref{sec:tagless-final}).
+In order to demonstrate the technique, it is first illustrated by showing the very simple language of literal values.
 This language interface can be described using a single type constructor class with a single function \cleaninline{lit}.
 This function is for lifting values, when it has a \cleaninline{toString} instance, from the host language to our new \gls{DSL}.
 The type variable \cleaninline{v} of the type class represents the view on the language, the interpretation.
@@ -92,7 +93,7 @@ Creating such a function, e.g.\ one that both prints and evaluates an expression
 
 \section{Types}
 The \gls{MTASK} language is a tagless-final \gls{EDSL} as well.
-As it is shallowly embedded, the types of the terms in the language can be constrained by type classes.
+As it is shallow embedded, the types of the terms in the language can be constrained by type classes.
 Types in the \gls{MTASK} language are expressed as types in the host language, to make the language type safe.
 However, not all types in the host language are suitable for microcontrollers that may only have \qty{2}{\kibi\byte} of \gls{RAM}, so class constraints are added to the \gls{DSL} functions.
 \Cref{tbl:mtask-c-datatypes} shows the mapping from \gls{CLEAN} types to \ccpp{} types.
@@ -140,7 +141,7 @@ Peripheral, \gls{SDS}, and function definitions are always defined at the top le
 This is enforced by the \cleaninline{Main} type.
 Most top level definitions are defined using \gls{HOAS}.
 To make their syntax friendlier, the \cleaninline{In} type---an infix tuple---is used to combine these top level definitions.
-To illustrate the structure of \gls{MTASK} programs, \cref{lst:mtask_types} shows a skeleton of a program.
+To illustrate the structure of \gls{MTASK} programs, \cref{lst:mtask_types} shows a skeleton of a program.
 
 % VimTeX: SynIgnore on
 \begin{lstClean}[caption={Auxiliary types and example task in the \gls{MTASK} language.},label={lst:mtask_types}]
@@ -152,10 +153,10 @@ someTask :: MTask v Int | mtask v & lowerSds v & sensor1 v & ...
 someTask =
        sensor1 config1 \sns1->
        sensor2 config2 \sns2->
-          sds      \s1  = initialValue
-       In lowerSds \s2  = someiTaskSDS
-       In fun      \fun1= ( \(a0, a1)->... )
-       In fun      \fun2= ( \a->... )
+          sds      \s1   = initialValue
+       In lowerSds \s2   = someiTaskSDS
+       In fun      \fun1 = ( \(a0, a1)->... )
+       In fun      \fun2 = ( \a->... )
        In { main = mainexpr }
 \end{lstClean}
 % VimTeX: SynIgnore off
@@ -164,7 +165,7 @@ Expressions in the \gls{MTASK} language are usually overloaded in their interpre
 In \gls{CLEAN}, all free variables in a type are implicitly universally quantified.
 In order to use the \gls{MTASK} expressions with multiple interpretations, rank-2 polymorphism is required \citep{odersky_putting_1996}.
 \Cref{lst:rank2_mtask} shows an example of a function that simulates an \gls{MTASK} expression while showing the pretty printed representation in parallel.
-Providing a type for the \cleaninline{simulateAndPrint} function is mandatory as the compiler cannot infer the type of rank-2 polymorphic functions\citep[\citesection{3.7.4}]{plasmeijer_clean_2021}.
+Providing a type for the \cleaninline{simulateAndPrint} function is mandatory as the compiler cannot infer the type of rank-2 polymorphic functions \citep[\citesection{3.7.4}]{plasmeijer_clean_2021}.
 
 \begin{lstClean}[label={lst:rank2_mtask},caption={Rank-2 polymorphism to allow multiple interpretations.}]
 simulateAndPrint :: (A.v: Main (MTask v a) | mtask v) -> Task a | type a
@@ -212,7 +213,7 @@ For convenience, there are many lower-cased macro definitions for often-used con
 \Cref{lst:example_exprs} shows some examples of expressions in the \gls{MTASK} language.
 Since they are only expressions, there is no need for a \cleaninline{Main}.
 \cleaninline{e0} defines the literal \num{42}, \cleaninline{e1} calculates the literal \num{42.0} using real numbers and uses a type conversion.
-\cleaninline{e2} compares \cleaninline{e0} and \cleaninline{e1} as integers and if they are equal it returns $\frac{\text{\cleaninline{e2}}}{2}$ and \cleaninline{e0} otherwise.
+\cleaninline{e2} compares \cleaninline{e0} and \cleaninline{e1} as integers and if they are equal it returns $\nicefrac{\text{\cleaninline{e2}}}{2}$ and \cleaninline{e0} otherwise.
 
 \begin{lstClean}[label={lst:example_exprs},caption={Example \gls{MTASK} expressions.}]
 e0 :: v Int | expr v
@@ -226,17 +227,18 @@ e2 = If (e0 ==. int e1)
        (int e1 /. lit 2) e0
 \end{lstClean}
 
-The \gls{MTASK} language is shallowly embedded in \gls{CLEAN} and the terms are constructed and hence compiled at run time.
+The \gls{MTASK} language is shallow embedded in \gls{CLEAN} and the terms are constructed and hence compiled at run time.
 This means that \gls{MTASK} programs can also be tailor-made at run time using \gls{CLEAN} functions, maximising the linguistic reuse \citep{krishnamurthi_linguistic_2001}.
 The \cleaninline{approxEqual} function in \cref{lst:example_macro} is an example of this.
 It performs a simple approximate equality---admittedly not taking into account all floating point peculiarities.
 When calling \cleaninline{approxEqual} in an \gls{MTASK} expression, the resulting code is inlined.
 
-\begin{lstClean}[label={lst:example_macro},caption={Approximate equality as an example of linguistic reuse in \gls{MTASK}.}]
+\begin{lstClean}[label={lst:example_macro},caption={Approximate equality in \gls{MTASK}.}]
 approxEqual :: (v Real) (v Real) (v Real) -> v Bool | expr v
-approxEqual x y eps = x ==. y |.  If (x >. y)
-       (x -. y <. eps)
-       (y -. x <. eps)
+approxEqual x y eps = x ==. y
+       |.  If (x >. y)
+               (x -. y <. eps)
+               (y -. x <. eps)
 \end{lstClean}
 
 \subsection{Data types}
@@ -261,16 +263,16 @@ class tupl v where
 \end{lstClean}
 
 \subsection{Functions}\label{sec:mtask_functions}
-Adding functions to the language is achieved by one type class to the \gls{DSL}.
-By using \gls{HOAS}, both the function definition and the calls to the function can be controlled by the \gls{DSL} \citep{pfenning_higher-order_1988,chlipala_parametric_2008}.
-The \gls{MTASK} language only allows first-order functions and no partial function application.
-To restrict this, a multi-parameter type class is used instead of a type class with one type variable.
+Adding functions to the language is achieved by one type class in the \gls{MTASK} \gls{DSL}.
+By using \gls{HOAS}, both the function definitions and the calls to the functions are controlled by the \gls{DSL} \citep{pfenning_higher-order_1988,chlipala_parametric_2008}.
+The \gls{MTASK} language enforces all functions to be first-order and forbids partial function application in order to reduce memory use and code size.
+These restrictions are enforced by using a multi-parameter type class with two parameters instead of a type class with one type variable.
 The first parameter represents the shape of the arguments, the second parameter the interpretation.
 An instance is provided for each function arity instead of providing an instance for all possible arities to enforce that all functions are first order.
-By using argument tuples to represent the arity of the function, partial function applications are eradicated.
-The definition of the type class and some instances for the pretty printer are as follows:
+By using argument tuples to represent the arity of the function, it is not possible to create partial function applications.
+The definition of the type class and some instances for the pretty printer are shown in \cref{lst:fun_mtask}.
 
-\begin{lstClean}[caption={Functions in \gls{MTASK}.}]
+\begin{lstClean}[float=,caption={Functions in \gls{MTASK}.},label={lst:fun_mtask}]
 class fun a v :: ((a -> v s) -> In (a -> v s) (Main (MTask v u)))
        -> Main (MTask v u)
 
@@ -282,42 +284,41 @@ instance fun (Show a, Show b, Show c) Show | type a, ... where ...
 \end{lstClean}
 
 Deriving how to define and use functions from the type is quite a challenge even though the resulting syntax is made easier using the infix type \cleaninline{In}.
+Splitting out the function definition for each single arity means that for every function arity and combination of arguments, a separate class constraint is required.
+Many of the often used functions signatures are in the \cleaninline{mtask} class constraint collection.
 \Cref{lst:function_examples} show some examples of functions to illustrate the syntax.
-Splitting out the function definition for each single arity means that for every function arity and combination of arguments, a separate class constraint must be created.
-Many of the often used functions are already bundled in the \cleaninline{mtask} class constraint collection.
-The \cleaninline{factorial} functions shows a recursive version of the factorial function.
-The \cleaninline{factorialtail} function is a tail-call optimised version of the factorial function.
+The \cleaninline{factorial} function shows a recursive version of the factorial function.
+The \cleaninline{factorialtail} function is a tail-call optimised version of the above.
 It also illustrates a manually added class constraint, as they are required when functions are used that have signatures not present in the \cleaninline{mtask} class collection.
-Zero-arity functions are always called with unit as an argument.
-An illustration of this is seen in the \cleaninline{zeroarity} expression.
-Finally, \cleaninline{swapTuple} shows an example of a tuple being swapped.
+Zero-arity functions are always called with unit as an argument, which is shown in the \cleaninline{zeroarity} function.
+Finally, the \cleaninline{swapTuple} function shows an example of a tuple being swapped using the \cleaninline{tupopen} macro (see \cref{lst:tuple_exprs}).
 
 % VimTeX: SynIgnore on
 \begin{lstClean}[label={lst:function_examples},caption={Examples of various functions in \gls{MTASK}.}]
 factorial :: Main (v Int) | mtask v
 factorial =
-       fun \fac=(\i->If (i <. lit 1)
+       fun \fac = (\i->If (i <. lit 1)
                (lit 1)
                (i *. fac (i -. lit 1)))
        In {main = fac (lit 5) }
 
 factorialtail :: Main (v Int) | mtask v & fun (v Int, v Int) v
 factorialtail =
-          fun \facacc=(\(acc, i)->If (i <. lit 1)
+          fun \facacc = (\(acc, i)->If (i <. lit 1)
                        acc
                        (fac (acc *. i, i -. lit 1)))
-       In fun \fac=(\i->facacc (lit 1, i))
+       In fun \fac = (\i->facacc (lit 1, i))
        In {main = fac (lit 5) }
 
 zeroarity :: Main (v Int) | mtask v
 zeroarity =
-          fun \fourtytwo=(\()->lit 42)
-       In fun \add=(\(x, y)->x +. y)
+          fun \fourtytwo = (\()->lit 42)
+       In fun \add = (\(x, y)->x +. y)
        In {main = add (fourtytwo (), lit 9)}
-
+       [+\pagebreak+]
 swapTuple :: Main (v (Int, Bool)) | mtask v
 swapTuple =
-          fun \swap=(tupopen \(x, y)->tupl y x)
+          fun \swap = (tupopen \(x, y)->tupl y x)
        In {main = swap (tupl true (lit 42)) }
 \end{lstClean}
 % VimTeX: SynIgnore off
@@ -344,7 +345,8 @@ The task language of \gls{MTASK} is divided into three categories:
        \item [Task combinators] provide a way of describing the workflow or collaboration.
                They combine one or more tasks into a compound task.
        \item [\Glspl{SDS}] are typed references to shared memory in \gls{MTASK}.
-               The data is available for tasks using many-to-many communication but only from within the task language to ensure atomicity.
+               The data is available for tasks using many-to-many communication.
+               Reading, writing and updating \glspl{SDS} is an atomic operation on the task level.
 \end{description}
 
 As \gls{MTASK} is integrated with \gls{ITASK}, a stability distinction is made for task values just as in \gls{ITASK}.
@@ -369,7 +371,7 @@ The most rudimentary non-interactive basic tasks in the task language of \gls{MT
 They lift the value from the \gls{MTASK} expression language to the task domain either as a stable or unstable value.
 There is also a special type of basic task for delaying execution.
 The \cleaninline{delay} task---parametrised by a number of milliseconds---yields an unstable value while the time has not passed.
-Once the specified time has passed, the time it overshot the planned time is yielded as a stable task value.
+Once the specified time has passed, the time the task overshot the target time is yielded as a stable task value.
 See \cref{sec:repeat} for an example task using \cleaninline{delay}.
 
 \begin{lstClean}[label={lst:basic_tasks},caption={Non-interactive basic tasks in \gls{MTASK}.}]
@@ -446,7 +448,7 @@ When provided a configuration and a configuration function, the \gls{DHT} object
 For the \gls{DHT} sensor there are two basic tasks, \cleaninline{temperature} and \cleaninline{humidity}, that produce a task that yields the observed temperature in \unit{\celcius} or the relative humidity as an unstable value.
 Other peripherals have similar interfaces, they are available in \cref{sec:aux_peripherals}.
 
-\begin{lstClean}[label={lst:dht},caption={The \gls{MTASK} interface for \glspl{DHT} sensors.}]
+\begin{lstClean}[float=,label={lst:dht},caption={The \gls{MTASK} interface for \glspl{DHT} sensors.}]
 :: DHT //abstract
 :: DHTInfo
        = DHT_DHT Pin DHTtype
@@ -468,7 +470,7 @@ There are three main types of task combinators, namely:
 \begin{itemize}
        \item sequential combinators that execute tasks one after the other, possibly using the result of the left-hand side;
        \item parallel combinators that execute tasks at the same time, combining the result;
-       \item miscellaneous combinators that change the semantics of a task---for example a combinator that repeats the child task.
+       \item and miscellaneous combinators that change the semantics of a task---for example a combinator that repeats the child task.
 \end{itemize}
 
 \subsubsection{Sequential}
@@ -478,8 +480,8 @@ This combinator has a single task on the left-hand side and a list of \emph{task
 Every rewrite step, the list of task continuations are tested on the task value.
 If one of the predicates matches, the task continues with the result of these continuations.
 Several shorthand combinators are derived from the step combinator.
-\cleaninline{>>=.} is a shorthand for the bind operation, if the left-hand side is stable, the right-hand side function is called to produce a new task.
-\cleaninline{>>\|.} is a shorthand for the sequence operation, if the left-hand side is stable, it continues with the right-hand side task.
+The \cleaninline{>>=.} combinator is a shorthand for the bind operation, if the left-hand side is stable, the right-hand side function is called to produce a new task.
+The \cleaninline{>>\|.} combinator is a shorthand for the sequence operation, if the left-hand side is stable, it continues with the right-hand side task.
 The \cleaninline{>>~.} and \cleaninline{>>..} combinators are variants of the ones above that ignore the stability and continue on an unstable value as well.
 
 \begin{lstClean}[label={lst:mtask_sequential},caption={Sequential task combinators in \gls{MTASK}.}]
@@ -497,7 +499,7 @@ class step v | expr v where
        | Always                                (MTask v u)
 \end{lstClean}
 
-The following listing shows an example of a step in action.
+\Cref{lst:mtask_readpinbin} shows an example task containing a step.
 The \cleaninline{readPinBin} function produces an \gls{MTASK} task that classifies the value of an analogue pin into four bins.
 It also shows that the nature of embedding allows the host language to be used as a macro language.
 
@@ -525,7 +527,7 @@ If both children are stable, the result is stable, otherwise the result is unsta
 The disjunction combinator (\cleaninline{.\|\|.}) combines the results by picking the leftmost, most stable task.
 The semantics of both parallel combinators are most easily described using the \gls{CLEAN} functions shown in \cref{lst:semantics_con,lst:semantics_dis}.
 
-\begin{figure}[ht]
+\begin{figure}
        \centering
        \begin{subfigure}[t]{.5\textwidth}
                \begin{lstClean}[caption={Semantics of the\\conjunction combinator.},label={lst:semantics_con}]
@@ -555,12 +557,12 @@ dis (Value l ls) (Value r rs)
 This task read two pins at the same time, returning when one of the pins becomes high.
 If the combinator was the \cleaninline{.&&.}, the type would be \cleaninline{MTask v (Bool, Bool)} and the task would only return when both pins are high but not necessarily at the same time.
 
-\begin{lstClean}[label={lst:mtask_parallel_example},caption={Parallel task combinator example in \gls{MTASK}.}]
+\begin{lstClean}[float=,label={lst:mtask_parallel_example},caption={Parallel task combinator example in \gls{MTASK}.}]
 task :: MTask v Bool
 task =
        declarePin D0 PMInput \d0->
        declarePin D1 PMInput \d1->
-       let monitor pin = readD pin >>*. [IfValue id rtrn]
+       fun \monitor = (\pin->readD pin >>*. [IfValue id rtrn])
        In {main = monitor d0 .||. monitor d1}
 \end{lstClean}
 
@@ -643,6 +645,7 @@ The only function exposed for this interpretation is the \cleaninline{showMain}
 It runs the pretty printer and returns a list of strings containing the pretty printed result.
 The pretty printing function does the best it can but obviously cannot reproduce layout, curried functions, and variable names.
 This shortcoming is illustrated by printing a blink task that contains a function and currying in \cref{lst:showexample}.
+The output of this action would be \cleaninline{fun f0 a1 = writeD(D13, a1) >>= \\a2.(delay 1000) >>\| (f0 (Not a1)) in (f0 True)}
 
 \begin{lstClean}[caption={The entry point for the pretty printing interpretation.},label={lst:showmain}]
 :: Show a // from the mTask pretty printing library
@@ -655,10 +658,6 @@ blinkTask =
        fun \blink=(\state->
                writeD d13 state >>|. delay (lit 500) >>=. blink o Not
        ) In {main = blink true}
-
-// output when printing:
-// fun f0 a1 = writeD(D13, a1) >>= \a2.(delay 1000)
-//     >>| (f0 (Not a1)) in (f0 True)
 \end{lstClean}
 
 \subsection{Simulator}
@@ -694,9 +693,8 @@ It uses expressions based a simply-typed $\lambda$-calculus with support for som
 \section{Conclusion}
 This chapter gave an overview of the complete \gls{MTASK} \gls{DSL}.
 The \gls{MTASK} language is a rich \gls{TOP} language tailored for \gls{IOT} edge devices.
-The language is implemented as a class-based shallowly \gls{EDSL} in the pure functional host language \gls{CLEAN}.
-The language is an enriched lambda calculus as a host language.
-It provides language constructs for arithmetic expressions, conditionals, functions, but also non-interactive basic tasks, task combinators, peripheral support, and integration with \gls{ITASK}.
+The language is implemented as a class-based shallow embedded \gls{DSL} in the pure functional host language \gls{CLEAN}.
+The language uses an enriched lambda calculus as a host language, providing additional language constructs for arithmetic expressions, conditionals, functions, but also non-interactive basic tasks, task combinators, peripheral support, and integration with \gls{ITASK}.
 Terms in the language are just interfaces and can be interpreted by one or more interpretations.
 When using the byte code compiler, terms in the \gls{MTASK} language are type checked at compile time but are constructed and compiled at run time.
 This facilitates tailor-making tasks for the current work requirements.