d93717a1337e968253320a41d5a25cf32971ae7f
[matthijs/master-project/report.git] / Chapters / Normalization.tex
1 \chapter[chap:normalization]{Normalization}
2   % A helper to print a single example in the half the page width. The example
3   % text should be in a buffer whose name is given in an argument.
4   %
5   % The align=right option really does left-alignment, but without the program
6   % will end up on a single line. The strut=no option prevents a bunch of empty
7   % space at the start of the frame.
8   \define[1]\example{
9     \framed[offset=1mm,align=right,strut=no,background=box,frame=off]{
10       \setuptyping[option=LAM,style=sans,before=,after=]
11       \typebuffer[#1]
12       \setuptyping[option=none,style=\tttf]
13     }
14   }
15
16   \define[3]\transexample{
17     \placeexample[here]{#1}
18     \startcombination[2*1]
19       {\example{#2}}{Original program}
20       {\example{#3}}{Transformed program}
21     \stopcombination
22   }
23
24   The first step in the core to \small{VHDL} translation process, is normalization. We
25   aim to bring the core description into a simpler form, which we can
26   subsequently translate into \small{VHDL} easily. This normal form is needed because
27   the full core language is more expressive than \small{VHDL} in some areas and because
28   core can describe expressions that do not have a direct hardware
29   interpretation.
30
31   TODO: Describe core properties not supported in \small{VHDL}, and describe how the
32   \small{VHDL} we want to generate should look like.
33
34   \section{Normal form}
35     The transformations described here have a well-defined goal: To bring the
36     program in a well-defined form that is directly translatable to hardware,
37     while fully preserving the semantics of the program. We refer to this form as
38     the \emph{normal form} of the program. The formal definition of this normal
39     form is quite simple:
40
41     \placedefinition{}{A program is in \emph{normal form} if none of the
42     transformations from this chapter apply.}
43
44     Of course, this is an \quote{easy} definition of the normal form, since our
45     program will end up in normal form automatically. The more interesting part is
46     to see if this normal form actually has the properties we would like it to
47     have.
48
49     But, before getting into more definitions and details about this normal form,
50     let's try to get a feeling for it first. The easiest way to do this is by
51     describing the things we want to not have in a normal form.
52
53     \startitemize
54       \item Any \emph{polymorphism} must be removed. When laying down hardware, we
55       can't generate any signals that can have multiple types. All types must be
56       completely known to generate hardware.
57       
58       \item Any \emph{higher order} constructions must be removed. We can't
59       generate a hardware signal that contains a function, so all values,
60       arguments and returns values used must be first order.
61
62       \item Any complex \emph{nested scopes} must be removed. In the \small{VHDL}
63       description, every signal is in a single scope. Also, full expressions are
64       not supported everywhere (in particular port maps can only map signal names,
65       not expressions). To make the \small{VHDL} generation easy, all values must be bound
66       on the \quote{top level}.
67     \stopitemize
68
69     TODO: Intermezzo: functions vs plain values
70
71     A very simple example of a program in normal form is given in
72     \in{example}[ex:MulSum]. As you can see, all arguments to the function (which
73     will become input ports in the final hardware) are at the top. This means that
74     the body of the final lambda abstraction is never a function, but always a
75     plain value.
76
77     After the lambda abstractions, we see a single let expression, that binds two
78     variables (\lam{mul} and \lam{sum}). These variables will be signals in the
79     final hardware, bound to the output port of the \lam{*} and \lam{+}
80     components.
81
82     The final line (the \quote{return value} of the function) selects the
83     \lam{sum} signal to be the output port of the function. This \quote{return
84     value} can always only be a variable reference, never a more complex
85     expression.
86
87     \startbuffer[MulSum]
88     alu :: Bit -> Word -> Word -> Word
89     alu = λa.λb.λc.
90         let
91           mul = (*) a b
92           sum = (+) mul c
93         in
94           sum
95     \stopbuffer
96
97     \startuseMPgraphic{MulSum}
98       save a, b, c, mul, add, sum;
99
100       % I/O ports
101       newCircle.a(btex $a$ etex) "framed(false)";
102       newCircle.b(btex $b$ etex) "framed(false)";
103       newCircle.c(btex $c$ etex) "framed(false)";
104       newCircle.sum(btex $res$ etex) "framed(false)";
105
106       % Components
107       newCircle.mul(btex - etex);
108       newCircle.add(btex + etex);
109
110       a.c      - b.c   = (0cm, 2cm);
111       b.c      - c.c   = (0cm, 2cm);
112       add.c            = c.c + (2cm, 0cm);
113       mul.c            = midpoint(a.c, b.c) + (2cm, 0cm);
114       sum.c            = add.c + (2cm, 0cm);
115       c.c              = origin;
116
117       % Draw objects and lines
118       drawObj(a, b, c, mul, add, sum);
119
120       ncarc(a)(mul) "arcangle(15)";
121       ncarc(b)(mul) "arcangle(-15)";
122       ncline(c)(add);
123       ncline(mul)(add);
124       ncline(add)(sum);
125     \stopuseMPgraphic
126
127     \placeexample[here][ex:MulSum]{Simple architecture consisting of an adder and a
128     subtractor.}
129       \startcombination[2*1]
130         {\typebufferlam{MulSum}}{Core description in normal form.}
131         {\boxedgraphic{MulSum}}{The architecture described by the normal form.}
132       \stopcombination
133
134     The previous example described composing an architecture by calling other
135     functions (operators), resulting in a simple architecture with component and
136     connection. There is of course also some mechanism for choice in the normal
137     form. In a normal Core program, the \emph{case} expression can be used in a
138     few different ways to describe choice. In normal form, this is limited to a
139     very specific form.
140
141     \in{Example}[ex:AddSubAlu] shows an example describing a
142     simple \small{ALU}, which chooses between two operations based on an opcode
143     bit. The main structure is the same as in \in{example}[ex:MulSum], but this
144     time the \lam{res} variable is bound to a case expression. This case
145     expression scrutinizes the variable \lam{opcode} (and scrutinizing more
146     complex expressions is not supported). The case expression can select a
147     different variable based on the constructor of \lam{opcode}.
148
149     \startbuffer[AddSubAlu]
150     alu :: Bit -> Word -> Word -> Word
151     alu = λopcode.λa.λb.
152         let
153           res1 = (+) a b
154           res2 = (-) a b
155           res = case opcode of
156             Low -> res1
157             High -> res2
158         in
159           res
160     \stopbuffer
161
162     \startuseMPgraphic{AddSubAlu}
163       save opcode, a, b, add, sub, mux, res;
164
165       % I/O ports
166       newCircle.opcode(btex $opcode$ etex) "framed(false)";
167       newCircle.a(btex $a$ etex) "framed(false)";
168       newCircle.b(btex $b$ etex) "framed(false)";
169       newCircle.res(btex $res$ etex) "framed(false)";
170       % Components
171       newCircle.add(btex + etex);
172       newCircle.sub(btex - etex);
173       newMux.mux;
174
175       opcode.c - a.c   = (0cm, 2cm);
176       add.c    - a.c   = (4cm, 0cm);
177       sub.c    - b.c   = (4cm, 0cm);
178       a.c      - b.c   = (0cm, 3cm);
179       mux.c            = midpoint(add.c, sub.c) + (1.5cm, 0cm);
180       res.c    - mux.c = (1.5cm, 0cm);
181       b.c              = origin;
182
183       % Draw objects and lines
184       drawObj(opcode, a, b, res, add, sub, mux);
185
186       ncline(a)(add) "posA(e)";
187       ncline(b)(sub) "posA(e)";
188       nccurve(a)(sub) "posA(e)", "angleA(0)";
189       nccurve(b)(add) "posA(e)", "angleA(0)";
190       nccurve(add)(mux) "posB(inpa)", "angleB(0)";
191       nccurve(sub)(mux) "posB(inpb)", "angleB(0)";
192       nccurve(opcode)(mux) "posB(n)", "angleA(0)", "angleB(-90)";
193       ncline(mux)(res) "posA(out)";
194     \stopuseMPgraphic
195
196     \placeexample[here][ex:AddSubAlu]{Simple \small{ALU} supporting two operations.}
197       \startcombination[2*1]
198         {\typebufferlam{AddSubAlu}}{Core description in normal form.}
199         {\boxedgraphic{AddSubAlu}}{The architecture described by the normal form.}
200       \stopcombination
201
202     As a more complete example, consider \in{example}[ex:NormalComplete]. This
203     example contains everything that is supported in normal form, with the
204     exception of builtin higher order functions. The graphical version of the
205     architecture contains a slightly simplified version, since the state tuple
206     packing and unpacking have been left out. Instead, two seperate registers are
207     drawn. Also note that most synthesis tools will further optimize this
208     architecture by removing the multiplexers at the register input and replace
209     them with some logic in the clock inputs, but we want to show the architecture
210     as close to the description as possible.
211
212     \startbuffer[NormalComplete]
213       regbank :: Bit 
214                  -> Word 
215                  -> State (Word, Word) 
216                  -> (State (Word, Word), Word)
217
218       -- All arguments are an inital lambda
219       regbank = λa.λd.λsp.
220       -- There are nested let expressions at top level
221       let
222         -- Unpack the state by coercion (\eg, cast from
223         -- State (Word, Word) to (Word, Word))
224         s = sp :: (Word, Word)
225         -- Extract both registers from the state
226         r1 = case s of (fst, snd) -> fst
227         r2 = case s of (fst, snd) -> snd
228         -- Calling some other user-defined function.
229         d' = foo d
230         -- Conditional connections
231         out = case a of
232           High -> r1
233           Low -> r2
234         r1' = case a of
235           High -> d'
236           Low -> r1
237         r2' = case a of
238           High -> r2
239           Low -> d'
240         -- Packing a tuple
241         s' = (,) r1' r2'
242         -- pack the state by coercion (\eg, cast from
243         -- (Word, Word) to State (Word, Word))
244         sp' = s' :: State (Word, Word)
245         -- Pack our return value
246         res = (,) sp' out
247       in
248         -- The actual result
249         res
250     \stopbuffer
251
252     \startuseMPgraphic{NormalComplete}
253       save a, d, r, foo, muxr, muxout, out;
254
255       % I/O ports
256       newCircle.a(btex \lam{a} etex) "framed(false)";
257       newCircle.d(btex \lam{d} etex) "framed(false)";
258       newCircle.out(btex \lam{out} etex) "framed(false)";
259       % Components
260       %newCircle.add(btex + etex);
261       newBox.foo(btex \lam{foo} etex);
262       newReg.r1(btex $\lam{r1}$ etex) "dx(4mm)", "dy(6mm)";
263       newReg.r2(btex $\lam{r2}$ etex) "dx(4mm)", "dy(6mm)", "reflect(true)";
264       newMux.muxr1;
265       % Reflect over the vertical axis
266       reflectObj(muxr1)((0,0), (0,1));
267       newMux.muxr2;
268       newMux.muxout;
269       rotateObj(muxout)(-90);
270
271       d.c               = foo.c + (0cm, 1.5cm); 
272       a.c               = (xpart r2.c + 2cm, ypart d.c - 0.5cm);
273       foo.c             = midpoint(muxr1.c, muxr2.c) + (0cm, 2cm);
274       muxr1.c           = r1.c + (0cm, 2cm);
275       muxr2.c           = r2.c + (0cm, 2cm);
276       r2.c              = r1.c + (4cm, 0cm);
277       r1.c              = origin;
278       muxout.c          = midpoint(r1.c, r2.c) - (0cm, 2cm);
279       out.c             = muxout.c - (0cm, 1.5cm);
280
281     %  % Draw objects and lines
282       drawObj(a, d, foo, r1, r2, muxr1, muxr2, muxout, out);
283       
284       ncline(d)(foo);
285       nccurve(foo)(muxr1) "angleA(-90)", "posB(inpa)", "angleB(180)";
286       nccurve(foo)(muxr2) "angleA(-90)", "posB(inpb)", "angleB(0)";
287       nccurve(muxr1)(r1) "posA(out)", "angleA(180)", "posB(d)", "angleB(0)";
288       nccurve(r1)(muxr1) "posA(out)", "angleA(0)", "posB(inpb)", "angleB(180)";
289       nccurve(muxr2)(r2) "posA(out)", "angleA(0)", "posB(d)", "angleB(180)";
290       nccurve(r2)(muxr2) "posA(out)", "angleA(180)", "posB(inpa)", "angleB(0)";
291       nccurve(r1)(muxout) "posA(out)", "angleA(0)", "posB(inpb)", "angleB(-90)";
292       nccurve(r2)(muxout) "posA(out)", "angleA(180)", "posB(inpa)", "angleB(-90)";
293       % Connect port a
294       nccurve(a)(muxout) "angleA(-90)", "angleB(180)", "posB(sel)";
295       nccurve(a)(muxr1) "angleA(180)", "angleB(-90)", "posB(sel)";
296       nccurve(a)(muxr2) "angleA(180)", "angleB(-90)", "posB(sel)";
297       ncline(muxout)(out) "posA(out)";
298     \stopuseMPgraphic
299
300     \placeexample[here][ex:NormalComplete]{Simple architecture consisting of an adder and a
301     subtractor.}
302       \startcombination[2*1]
303         {\typebufferlam{NormalComplete}}{Core description in normal form.}
304         {\boxedgraphic{NormalComplete}}{The architecture described by the normal form.}
305       \stopcombination
306
307     \subsection{Intended normal form definition}
308       Now we have some intuition for the normal form, we can describe how we want
309       the normal form to look like in a slightly more formal manner. The following
310       EBNF-like description completely captures the intended structure (and
311       generates a subset of GHC's core format).
312
313       Some clauses have an expression listed in parentheses. These are conditions
314       that need to apply to the clause.
315
316       \startlambda
317       \italic{normal} = \italic{lambda}
318       \italic{lambda} = λvar.\italic{lambda} (representable(var))
319                       | \italic{toplet} 
320       \italic{toplet} = let \italic{binding} in \italic{toplet} 
321                       | letrec [\italic{binding}] in \italic{toplet}
322                       | var (representable(varvar))
323       \italic{binding} = var = \italic{rhs} (representable(rhs))
324                        -- State packing and unpacking by coercion
325                        | var0 = var1 :: State ty (lvar(var1))
326                        | var0 = var1 :: ty (var0 :: State ty) (lvar(var1))
327       \italic{rhs} = userapp
328                    | builtinapp
329                    -- Extractor case
330                    | case var of C a0 ... an -> ai (lvar(var))
331                    -- Selector case
332                    | case var of (lvar(var))
333                       DEFAULT -> var0 (lvar(var0))
334                       C w0 ... wn -> resvar (\forall{}i, wi \neq resvar, lvar(resvar))
335       \italic{userapp} = \italic{userfunc}
336                        | \italic{userapp} {userarg}
337       \italic{userfunc} = var (gvar(var))
338       \italic{userarg} = var (lvar(var))
339       \italic{builtinapp} = \italic{builtinfunc}
340                           | \italic{builtinapp} \italic{builtinarg}
341       \italic{builtinfunc} = var (bvar(var))
342       \italic{builtinarg} = \italic{coreexpr}
343       \stoplambda
344
345       -- TODO: Limit builtinarg further
346
347       -- TODO: There can still be other casts around (which the code can handle,
348       e.g., ignore), which still need to be documented here.
349
350       -- TODO: Note about the selector case. It just supports Bit and Bool
351       currently, perhaps it should be generalized in the normal form?
352
353       When looking at such a program from a hardware perspective, the top level
354       lambda's define the input ports. The value produced by the let expression is
355       the output port. Most function applications bound by the let expression
356       define a component instantiation, where the input and output ports are mapped
357       to local signals or arguments. Some of the others use a builtin
358       construction (\eg the \lam{case} statement) or call a builtin function
359       (\eg \lam{add} or \lam{sub}). For these, a hardcoded \small{VHDL} translation is
360       available.
361
362   \section{Transformation notation}
363     To be able to concisely present transformations, we use a specific format to
364     them. It is a simple format, similar to one used in logic reasoning.
365
366     Such a transformation description looks like the following.
367
368     \starttrans
369     <context conditions>
370     ~
371     <original expression>
372     --------------------------          <expression conditions>
373     <transformed expresssion>
374     ~
375     <context additions>
376     \stoptrans
377
378     This format desribes a transformation that applies to \lam{original
379     expresssion} and transforms it into \lam{transformed expression}, assuming
380     that all conditions apply. In this format, there are a number of placeholders
381     in pointy brackets, most of which should be rather obvious in their meaning.
382     Nevertheless, we will more precisely specify their meaning below:
383
384       \startdesc{<original expression>} The expression pattern that will be matched
385       against (subexpressions of) the expression to be transformed. We call this a
386       pattern, because it can contain \emph{placeholders} (variables), which match
387       any expression or binder. Any such placeholder is said to be \emph{bound} to
388       the expression it matches. It is convention to use an uppercase latter (\eg
389       \lam{M} or \lam{E} to refer to any expression (including a simple variable
390       reference) and lowercase letters (\eg \lam{v} or \lam{b}) to refer to
391       (references to) binders.
392
393       For example, the pattern \lam{a + B} will match the expression 
394       \lam{v + (2 * w)} (and bind \lam{a} to \lam{v} and \lam{B} to 
395       \lam{(2 * 2)}), but not \lam{v + (2 * w)}.
396       \stopdesc
397
398       \startdesc{<expression conditions>}
399       These are extra conditions on the expression that is matched. These
400       conditions can be used to further limit the cases in which the
401       transformation applies, in particular to prevent a transformation from
402       causing a loop with itself or another transformation.
403
404       Only if these if these conditions are \emph{all} true, this transformation
405       applies.
406       \stopdesc
407
408       \startdesc{<context conditions>}
409       These are a number of extra conditions on the context of the function. In
410       particular, these conditions can require some other top level function to be
411       present, whose value matches the pattern given here. The format of each of
412       these conditions is: \lam{binder = <pattern>}.
413
414       Typically, the binder is some placeholder bound in the \lam{<original
415       expression>}, while the pattern contains some placeholders that are used in
416       the \lam{transformed expression}.
417       
418       Only if a top level binder exists that matches each binder and pattern, this
419       transformation applies.
420       \stopdesc
421
422       \startdesc{<transformed expression>}
423       This is the expression template that is the result of the transformation. If, looking
424       at the above three items, the transformation applies, the \lam{original
425       expression} is completely replaced with the \lam{<transformed expression>}.
426       We call this a template, because it can contain placeholders, referring to
427       any placeholder bound by the \lam{<original expression>} or the
428       \lam{<context conditions>}. The resulting expression will have those
429       placeholders replaced by the values bound to them.
430
431       Any binder (lowercase) placeholder that has no value bound to it yet will be
432       bound to (and replaced with) a fresh binder.
433       \stopdesc
434
435       \startdesc{<context additions>}
436       These are templates for new functions to add to the context. This is a way
437       to have a transformation create new top level functiosn.
438
439       Each addition has the form \lam{binder = template}. As above, any
440       placeholder in the addition is replaced with the value bound to it, and any
441       binder placeholder that has no value bound to it yet will be bound to (and
442       replaced with) a fresh binder.
443       \stopdesc
444
445     As an example, we'll look at η-abstraction:
446
447     \starttrans
448     E                 \lam{E :: a -> b}
449     --------------    \lam{E} does not occur on a function position in an application
450     λx.E x            \lam{E} is not a lambda abstraction.
451     \stoptrans
452
453     Consider the following function, which is a fairly obvious way to specify a
454     simple ALU (Note \at{example}[ex:AddSubAlu] is the normal form of this
455     function):
456
457     \startlambda 
458     alu :: Bit -> Word -> Word -> Word
459     alu = λopcode. case opcode of
460       Low -> (+)
461       High -> (-)
462     \stoplambda
463
464     There are a few subexpressions in this function to which we could possibly
465     apply the transformation. Since the pattern of the transformation is only
466     the placeholder \lam{E}, any expression will match that. Whether the
467     transformation applies to an expression is thus solely decided by the
468     conditions to the right of the transformation.
469
470     We will look at each expression in the function in a top down manner. The
471     first expression is the entire expression the function is bound to.
472
473     \startlambda
474     λopcode. case opcode of
475       Low -> (+)
476       High -> (-)
477     \stoplambda
478
479     As said, the expression pattern matches this. The type of this expression is
480     \lam{Bit -> Word -> Word -> Word}, which matches \lam{a -> b} (Note that in
481     this case \lam{a = Bit} and \lam{b = Word -> Word -> Word}).
482
483     Since this expression is at top level, it does not occur at a function
484     position of an application. However, The expression is a lambda abstraction,
485     so this transformation does not apply.
486
487     The next expression we could apply this transformation to, is the body of
488     the lambda abstraction:
489
490     \startlambda
491     case opcode of
492       Low -> (+)
493       High -> (-)
494     \stoplambda
495
496     The type of this expression is \lam{Word -> Word -> Word}, which again
497     matches \lam{a -> b}. The expression is the body of a lambda expression, so
498     it does not occur at a function position of an application. Finally, the
499     expression is not a lambda abstraction but a case expression, so all the
500     conditions match. There are no context conditions to match, so the
501     transformation applies.
502
503     By now, the placeholder \lam{E} is bound to the entire expression. The
504     placeholder \lam{x}, which occurs in the replacement template, is not bound
505     yet, so we need to generate a fresh binder for that. Let's use the binder
506     \lam{a}. This results in the following replacement expression:
507
508     \startlambda
509     λa.(case opcode of
510       Low -> (+)
511       High -> (-)) a
512     \stoplambda
513
514     Continuing with this expression, we see that the transformation does not
515     apply again (it is a lambda expression). Next we look at the body of this
516     labmda abstraction:
517
518     \startlambda
519     (case opcode of
520       Low -> (+)
521       High -> (-)) a
522     \stoplambda
523     
524     Here, the transformation does apply, binding \lam{E} to the entire
525     expression and \lam{x} to the fresh binder \lam{b}, resulting in the
526     replacement:
527
528     \startlambda
529     λb.(case opcode of
530       Low -> (+)
531       High -> (-)) a b
532     \stoplambda
533
534     Again, the transformation does not apply to this lambda abstraction, so we
535     look at its body. For brevity, we'll put the case statement on one line from
536     now on.
537
538     \startlambda
539     (case opcode of Low -> (+); High -> (-)) a b
540     \stoplambda
541
542     The type of this expression is \lam{Word}, so it does not match \lam{a -> b}
543     and the transformation does not apply. Next, we have two options for the
544     next expression to look at: The function position and argument position of
545     the application. The expression in the argument position is \lam{b}, which
546     has type \lam{Word}, so the transformation does not apply. The expression in
547     the function position is:
548
549     \startlambda
550     (case opcode of Low -> (+); High -> (-)) a
551     \stoplambda
552
553     Obviously, the transformation does not apply here, since it occurs in
554     function position. In the same way the transformation does not apply to both
555     components of this expression (\lam{case opcode of Low -> (+); High -> (-)}
556     and \lam{a}), so we'll skip to the components of the case expression: The
557     scrutinee and both alternatives. Since the opcode is not a function, it does
558     not apply here, and we'll leave both alternatives as an exercise to the
559     reader. The final function, after all these transformations becomes:
560
561     \startlambda 
562     alu :: Bit -> Word -> Word -> Word
563     alu = λopcode.λa.b. (case opcode of
564       Low -> λa1.λb1 (+) a1 b1
565       High -> λa2.λb2 (-) a2 b2) a b
566     \stoplambda
567
568     In this case, the transformation does not apply anymore, though this might
569     not always be the case (e.g., the application of a transformation on a
570     subexpression might open up possibilities to apply the transformation
571     further up in the expression).
572
573     \subsection{Transformation application}
574       In this chapter we define a number of transformations, but how will we apply
575       these? As stated before, our normal form is reached as soon as no
576       transformation applies anymore. This means our application strategy is to
577       simply apply any transformation that applies, and continuing to do that with
578       the result of each transformation.
579
580       In particular, we define no particular order of transformations. Since
581       transformation order should not influence the resulting normal form (see TODO
582       ref), this leaves the implementation free to choose any application order that
583       results in an efficient implementation.
584
585       When applying a single transformation, we try to apply it to every (sub)expression
586       in a function, not just the top level function. This allows us to keep the
587       transformation descriptions concise and powerful.
588
589     \subsection{Definitions}
590       In the following sections, we will be using a number of functions and
591       notations, which we will define here.
592
593       \subsubsection{Other concepts}
594         A \emph{global variable} is any variable that is bound at the
595         top level of a program, or an external module. A \emph{local variable} is any
596         other variable (\eg, variables local to a function, which can be bound by
597         lambda abstractions, let expressions and pattern matches of case
598         alternatives).  Note that this is a slightly different notion of global versus
599         local than what \small{GHC} uses internally.
600         \defref{global variable} \defref{local variable}
601
602         A \emph{hardware representable} (or just \emph{representable}) type or value
603         is (a value of) a type that we can generate a signal for in hardware. For
604         example, a bit, a vector of bits, a 32 bit unsigned word, etc. Types that are
605         not runtime representable notably include (but are not limited to): Types,
606         dictionaries, functions.
607         \defref{representable}
608
609         A \emph{builtin function} is a function supplied by the Cλash framework, whose
610         implementation is not valid Cλash. The implementation is of course valid
611         Haskell, for simulation, but it is not expressable in Cλash.
612         \defref{builtin function} \defref{user-defined function}
613
614       For these functions, Cλash has a \emph{builtin hardware translation}, so calls
615       to these functions can still be translated. These are functions like
616       \lam{map}, \lam{hwor} and \lam{length}.
617
618       A \emph{user-defined} function is a function for which we do have a Cλash
619       implementation available.
620
621       \subsubsection{Functions}
622         Here, we define a number of functions that can be used below to concisely
623         specify conditions.
624
625         \refdef{global variable}\emph{gvar(expr)} is true when \emph{expr} is a variable that references a
626         global variable. It is false when it references a local variable.
627
628         \refdef{local variable}\emph{lvar(expr)} is the complement of \emph{gvar}; it is true when \emph{expr}
629         references a local variable, false when it references a global variable.
630
631         \refdef{representable}\emph{representable(expr)} or \emph{representable(var)} is true when
632         \emph{expr} or \emph{var} is \emph{representable}.
633
634     \subsection{Binder uniqueness}
635       A common problem in transformation systems, is binder uniqueness. When not
636       considering this problem, it is easy to create transformations that mix up
637       bindings and cause name collisions. Take for example, the following core
638       expression:
639
640       \startlambda
641       (λa.λb.λc. a * b * c) x c
642       \stoplambda
643
644       By applying β-reduction (see below) once, we can simplify this expression to:
645
646       \startlambda
647       (λb.λc. x * b * c) c
648       \stoplambda
649
650       Now, we have replaced the \lam{a} binder with a reference to the \lam{x}
651       binder. No harm done here. But note that we see multiple occurences of the
652       \lam{c} binder. The first is a binding occurence, to which the second refers.
653       The last, however refers to \emph{another} instance of \lam{c}, which is
654       bound somewhere outside of this expression. Now, if we would apply beta
655       reduction without taking heed of binder uniqueness, we would get:
656
657       \startlambda
658       λc. x * c * c
659       \stoplambda
660
661       This is obviously not what was supposed to happen! The root of this problem is
662       the reuse of binders: Identical binders can be bound in different scopes, such
663       that only the inner one is \quote{visible} in the inner expression. In the example
664       above, the \lam{c} binder was bound outside of the expression and in the inner
665       lambda expression. Inside that lambda expression, only the inner \lam{c} is
666       visible.
667
668       There are a number of ways to solve this. \small{GHC} has isolated this
669       problem to their binder substitution code, which performs \emph{deshadowing}
670       during its expression traversal. This means that any binding that shadows
671       another binding on a higher level is replaced by a new binder that does not
672       shadow any other binding. This non-shadowing invariant is enough to prevent
673       binder uniqueness problems in \small{GHC}.
674
675       In our transformation system, maintaining this non-shadowing invariant is
676       a bit harder to do (mostly due to implementation issues, the prototype doesn't
677       use \small{GHC}'s subsitution code). Also, we can observe the following
678       points.
679
680       \startitemize
681       \item Deshadowing does not guarantee overall uniqueness. For example, the
682       following (slightly contrived) expression shows the identifier \lam{x} bound in
683       two seperate places (and to different values), even though no shadowing
684       occurs.
685
686       \startlambda
687       (let x = 1 in x) + (let x = 2 in x)
688       \stoplambda
689
690       \item In our normal form (and the resulting \small{VHDL}), all binders
691       (signals) will end up in the same scope. To allow this, all binders within the
692       same function should be unique.
693
694       \item When we know that all binders in an expression are unique, moving around
695       or removing a subexpression will never cause any binder conflicts. If we have
696       some way to generate fresh binders, introducing new subexpressions will not
697       cause any problems either. The only way to cause conflicts is thus to
698       duplicate an existing subexpression.
699       \stopitemize
700
701       Given the above, our prototype maintains a unique binder invariant. This
702       meanst that in any given moment during normalization, all binders \emph{within
703       a single function} must be unique. To achieve this, we apply the following
704       technique.
705
706       TODO: Define fresh binders and unique supplies
707
708       \startitemize
709       \item Before starting normalization, all binders in the function are made
710       unique. This is done by generating a fresh binder for every binder used. This
711       also replaces binders that did not pose any conflict, but it does ensure that
712       all binders within the function are generated by the same unique supply. See
713       (TODO: ref fresh binder).
714       \item Whenever a new binder must be generated, we generate a fresh binder that
715       is guaranteed to be different from \emph{all binders generated so far}. This
716       can thus never introduce duplication and will maintain the invariant.
717       \item Whenever (part of) an expression is duplicated (for example when
718       inlining), all binders in the expression are replaced with fresh binders
719       (using the same method as at the start of normalization). These fresh binders
720       can never introduce duplication, so this will maintain the invariant.
721       \item Whenever we move part of an expression around within the function, there
722       is no need to do anything special. There is obviously no way to introduce
723       duplication by moving expressions around. Since we know that each of the
724       binders is already unique, there is no way to introduce (incorrect) shadowing
725       either.
726       \stopitemize
727
728   \section{Transform passes}
729     In this section we describe the actual transforms. Here we're using
730     the core language in a notation that resembles lambda calculus.
731
732     Each of these transforms is meant to be applied to every (sub)expression
733     in a program, for as long as it applies. Only when none of the
734     transformations can be applied anymore, the program is in normal form (by
735     definition). We hope to be able to prove that this form will obey all of the
736     constraints defined above, but this has yet to happen (though it seems likely
737     that it will).
738
739     Each of the transforms will be described informally first, explaining
740     the need for and goal of the transform. Then, a formal definition is
741     given, using a familiar syntax from the world of logic. Each transform
742     is specified as a number of conditions (above the horizontal line) and a
743     number of conclusions (below the horizontal line). The details of using
744     this notation are still a bit fuzzy, so comments are welcom.
745
746     \subsection{General cleanup}
747
748       \subsubsection{β-reduction}
749         β-reduction is a well known transformation from lambda calculus, where it is
750         the main reduction step. It reduces applications of labmda abstractions,
751         removing both the lambda abstraction and the application.
752
753         In our transformation system, this step helps to remove unwanted lambda
754         abstractions (basically all but the ones at the top level). Other
755         transformations (application propagation, non-representable inlining) make
756         sure that most lambda abstractions will eventually be reducable by
757         β-reduction.
758
759         TODO: Define substitution syntax
760
761         \starttrans
762         (λx.E) M
763         -----------------
764         E[M/x]
765         \stoptrans
766
767         % And an example
768         \startbuffer[from]
769         (λa. 2 * a) (2 * b)
770         \stopbuffer
771
772         \startbuffer[to]
773         2 * (2 * b)
774         \stopbuffer
775
776         \transexample{β-reduction}{from}{to}
777
778       \subsubsection{Application propagation}
779         This transformation is meant to propagate application expressions downwards
780         into expressions as far as possible. This allows partial applications inside
781         expressions to become fully applied and exposes new transformation
782         possibilities for other transformations (like β-reduction).
783
784         \starttrans
785         let binds in E) M
786         -----------------
787         let binds in E M
788         \stoptrans
789
790         % And an example
791         \startbuffer[from]
792         ( let 
793             val = 1
794           in 
795             add val
796         ) 3
797         \stopbuffer
798
799         \startbuffer[to]
800         let 
801           val = 1
802         in 
803           add val 3
804         \stopbuffer
805
806         \transexample{Application propagation for a let expression}{from}{to}
807
808         \starttrans
809         (case x of
810           p1 -> E1
811           \vdots
812           pn -> En) M
813         -----------------
814         case x of
815           p1 -> E1 M
816           \vdots
817           pn -> En M
818         \stoptrans
819
820         % And an example
821         \startbuffer[from]
822         ( case x of 
823             True -> id
824             False -> neg
825         ) 1
826         \stopbuffer
827
828         \startbuffer[to]
829         case x of 
830           True -> id 1
831           False -> neg 1
832         \stopbuffer
833
834         \transexample{Application propagation for a case expression}{from}{to}
835
836       \subsubsection{Empty let removal}
837         This transformation is simple: It removes recursive lets that have no bindings
838         (which usually occurs when let derecursification removes the last binding from
839         it).
840
841         \starttrans
842         letrec in M
843         --------------
844         M
845         \stoptrans
846
847         \subsubsection{Simple let binding removal}
848         This transformation inlines simple let bindings (\eg a = b).
849
850         This transformation is not needed to get into normal form, but makes the
851         resulting \small{VHDL} a lot shorter.
852
853         \starttrans
854         letnonrec
855           a = b
856         in
857           M
858         -----------------
859         M[b/a]
860         \stoptrans
861
862         \starttrans
863         letrec
864           \vdots
865           a = b
866           \vdots
867         in
868           M
869         -----------------
870         let
871           \vdots [b/a]
872           \vdots [b/a]
873         in
874           M[b/a]
875         \stoptrans
876
877       \subsubsection{Unused let binding removal}
878         This transformation removes let bindings that are never used. Usually,
879         the desugarer introduces some unused let bindings.
880
881         This normalization pass should really be unneeded to get into normal form
882         (since ununsed bindings are not forbidden by the normal form), but in practice
883         the desugarer or simplifier emits some unused bindings that cannot be
884         normalized (e.g., calls to a \type{PatError} (TODO: Check this name)). Also,
885         this transformation makes the resulting \small{VHDL} a lot shorter.
886
887         \starttrans
888         let a = E in M
889         ----------------------------    \lam{a} does not occur free in \lam{M}
890         M
891         \stoptrans
892
893         \starttrans
894         letrec
895           \vdots
896           a = E
897           \vdots
898         in
899           M
900         ----------------------------    \lam{a} does not occur free in \lam{M}
901         letrec
902           \vdots
903           \vdots
904         in
905           M
906         \stoptrans
907
908       \subsubsection{Cast propagation / simplification}
909         This transform pushes casts down into the expression as far as possible.
910         Since its exact role and need is not clear yet, this transformation is
911         not yet specified.
912
913       \subsubsection{Compiler generated top level binding inlining}
914         TODO
915
916     \section{Program structure}
917
918       \subsubsection{η-abstraction}
919         This transformation makes sure that all arguments of a function-typed
920         expression are named, by introducing lambda expressions. When combined with
921         β-reduction and function inlining below, all function-typed expressions should
922         be lambda abstractions or global identifiers.
923
924         \starttrans
925         E                 \lam{E :: a -> b}
926         --------------    \lam{E} is not the first argument of an application.
927         λx.E x            \lam{E} is not a lambda abstraction.
928                           \lam{x} is a variable that does not occur free in \lam{E}.
929         \stoptrans
930
931         \startbuffer[from]
932         foo = λa.case a of 
933           True -> λb.mul b b
934           False -> id
935         \stopbuffer
936
937         \startbuffer[to]
938         foo = λa.λx.(case a of 
939             True -> λb.mul b b
940             False -> λy.id y) x
941         \stopbuffer
942
943         \transexample{η-abstraction}{from}{to}
944
945       \subsubsection{Let derecursification}
946         This transformation is meant to make lets non-recursive whenever possible.
947         This might allow other optimizations to do their work better. TODO: Why is
948         this needed exactly?
949
950       \subsubsection{Let flattening}
951         This transformation puts nested lets in the same scope, by lifting the
952         binding(s) of the inner let into a new let around the outer let. Eventually,
953         this will cause all let bindings to appear in the same scope (they will all be
954         in scope for the function return value).
955
956         Note that this transformation does not try to be smart when faced with
957         recursive lets, it will just leave the lets recursive (possibly joining a
958         recursive and non-recursive let into a single recursive let). The let
959         rederecursification transformation will do this instead.
960
961         \starttrans
962         letnonrec x = (let bindings in M) in N
963         ------------------------------------------
964         let bindings in (letnonrec x = M) in N
965         \stoptrans
966
967         \starttrans
968         letrec 
969           \vdots
970           x = (let bindings in M)
971           \vdots
972         in
973           N
974         ------------------------------------------
975         letrec
976           \vdots
977           bindings
978           x = M
979           \vdots
980         in
981           N
982         \stoptrans
983
984         \startbuffer[from]
985         let
986           a = letrec
987             x = 1
988             y = 2
989           in
990             x + y
991         in
992           letrec
993             b = let c = 3 in a + c
994             d = 4
995           in
996             d + b
997         \stopbuffer
998         \startbuffer[to]
999         letrec
1000           x = 1
1001           y = 2
1002         in
1003           let
1004             a = x + y
1005           in
1006             letrec
1007               c = 3
1008               b = a + c
1009               d = 4
1010             in
1011               d + b
1012         \stopbuffer
1013
1014         \transexample{Let flattening}{from}{to}
1015
1016       \subsubsection{Return value simplification}
1017         This transformation ensures that the return value of a function is always a
1018         simple local variable reference.
1019
1020         Currently implemented using lambda simplification, let simplification, and
1021         top simplification. Should change into something like the following, which
1022         works only on the result of a function instead of any subexpression. This is
1023         achieved by the contexts, like \lam{x = E}, though this is strictly not
1024         correct (you could read this as "if there is any function \lam{x} that binds
1025         \lam{E}, any \lam{E} can be transformed, while we only mean the \lam{E} that
1026         is bound by \lam{x}. This might need some extra notes or something).
1027
1028         \starttrans
1029         x = E                            \lam{E} is representable
1030         ~                                \lam{E} is not a lambda abstraction
1031         E                                \lam{E} is not a let expression
1032         ---------------------------      \lam{E} is not a local variable reference
1033         let x = E in x
1034         \stoptrans
1035
1036         \starttrans
1037         x = λv0 ... λvn.E
1038         ~                                \lam{E} is representable
1039         E                                \lam{E} is not a let expression
1040         ---------------------------      \lam{E} is not a local variable reference
1041         let x = E in x
1042         \stoptrans
1043
1044         \starttrans
1045         x = λv0 ... λvn.let ... in E
1046         ~                                \lam{E} is representable
1047         E                                \lam{E} is not a local variable reference
1048         ---------------------------
1049         let x = E in x
1050         \stoptrans
1051
1052         \startbuffer[from]
1053         x = add 1 2
1054         \stopbuffer
1055
1056         \startbuffer[to]
1057         x = let x = add 1 2 in x
1058         \stopbuffer
1059
1060         \transexample{Return value simplification}{from}{to}
1061
1062     \subsection{Argument simplification}
1063       The transforms in this section deal with simplifying application
1064       arguments into normal form. The goal here is to:
1065
1066       \startitemize
1067        \item Make all arguments of user-defined functions (\eg, of which
1068        we have a function body) simple variable references of a runtime
1069        representable type. This is needed, since these applications will be turned
1070        into component instantiations.
1071        \item Make all arguments of builtin functions one of:
1072          \startitemize
1073           \item A type argument.
1074           \item A dictionary argument.
1075           \item A type level expression.
1076           \item A variable reference of a runtime representable type.
1077           \item A variable reference or partial application of a function type.
1078          \stopitemize
1079       \stopitemize
1080
1081       When looking at the arguments of a user-defined function, we can
1082       divide them into two categories:
1083       \startitemize
1084         \item Arguments of a runtime representable type (\eg bits or vectors).
1085
1086               These arguments can be preserved in the program, since they can
1087               be translated to input ports later on.  However, since we can
1088               only connect signals to input ports, these arguments must be
1089               reduced to simple variables (for which signals will be
1090               produced). This is taken care of by the argument extraction
1091               transform.
1092         \item Non-runtime representable typed arguments.
1093               
1094               These arguments cannot be preserved in the program, since we
1095               cannot represent them as input or output ports in the resulting
1096               \small{VHDL}. To remove them, we create a specialized version of the
1097               called function with these arguments filled in. This is done by
1098               the argument propagation transform.
1099
1100               Typically, these arguments are type and dictionary arguments that are
1101               used to make functions polymorphic. By propagating these arguments, we
1102               are essentially doing the same which GHC does when it specializes
1103               functions: Creating multiple variants of the same function, one for
1104               each type for which it is used. Other common non-representable
1105               arguments are functions, e.g. when calling a higher order function
1106               with another function or a lambda abstraction as an argument.
1107
1108               The reason for doing this is similar to the reasoning provided for
1109               the inlining of non-representable let bindings above. In fact, this
1110               argument propagation could be viewed as a form of cross-function
1111               inlining.
1112       \stopitemize
1113
1114       TODO: Check the following itemization.
1115
1116       When looking at the arguments of a builtin function, we can divide them
1117       into categories: 
1118
1119       \startitemize
1120         \item Arguments of a runtime representable type.
1121               
1122               As we have seen with user-defined functions, these arguments can
1123               always be reduced to a simple variable reference, by the
1124               argument extraction transform. Performing this transform for
1125               builtin functions as well, means that the translation of builtin
1126               functions can be limited to signal references, instead of
1127               needing to support all possible expressions.
1128
1129         \item Arguments of a function type.
1130               
1131               These arguments are functions passed to higher order builtins,
1132               like \lam{map} and \lam{foldl}. Since implementing these
1133               functions for arbitrary function-typed expressions (\eg, lambda
1134               expressions) is rather comlex, we reduce these arguments to
1135               (partial applications of) global functions.
1136               
1137               We can still support arbitrary expressions from the user code,
1138               by creating a new global function containing that expression.
1139               This way, we can simply replace the argument with a reference to
1140               that new function. However, since the expression can contain any
1141               number of free variables we also have to include partial
1142               applications in our normal form.
1143
1144               This category of arguments is handled by the function extraction
1145               transform.
1146         \item Other unrepresentable arguments.
1147               
1148               These arguments can take a few different forms:
1149               \startdesc{Type arguments}
1150                 In the core language, type arguments can only take a single
1151                 form: A type wrapped in the Type constructor. Also, there is
1152                 nothing that can be done with type expressions, except for
1153                 applying functions to them, so we can simply leave type
1154                 arguments as they are.
1155               \stopdesc
1156               \startdesc{Dictionary arguments}
1157                 In the core language, dictionary arguments are used to find
1158                 operations operating on one of the type arguments (mostly for
1159                 finding class methods). Since we will not actually evaluatie
1160                 the function body for builtin functions and can generate
1161                 code for builtin functions by just looking at the type
1162                 arguments, these arguments can be ignored and left as they
1163                 are.
1164               \stopdesc
1165               \startdesc{Type level arguments}
1166                 Sometimes, we want to pass a value to a builtin function, but
1167                 we need to know the value at compile time. Additionally, the
1168                 value has an impact on the type of the function. This is
1169                 encoded using type-level values, where the actual value of the
1170                 argument is not important, but the type encodes some integer,
1171                 for example. Since the value is not important, the actual form
1172                 of the expression does not matter either and we can leave
1173                 these arguments as they are.
1174               \stopdesc
1175               \startdesc{Other arguments}
1176                 Technically, there is still a wide array of arguments that can
1177                 be passed, but does not fall into any of the above categories.
1178                 However, none of the supported builtin functions requires such
1179                 an argument. This leaves use with passing unsupported types to
1180                 a function, such as calling \lam{head} on a list of functions.
1181
1182                 In these cases, it would be impossible to generate hardware
1183                 for such a function call anyway, so we can ignore these
1184                 arguments.
1185
1186                 The only way to generate hardware for builtin functions with
1187                 arguments like these, is to expand the function call into an
1188                 equivalent core expression (\eg, expand map into a series of
1189                 function applications). But for now, we choose to simply not
1190                 support expressions like these.
1191               \stopdesc
1192
1193               From the above, we can conclude that we can simply ignore these
1194               other unrepresentable arguments and focus on the first two
1195               categories instead.
1196       \stopitemize
1197
1198       \subsubsection{Argument simplification}
1199         This transform deals with arguments to functions that
1200         are of a runtime representable type. It ensures that they will all become
1201         references to global variables, or local signals in the resulting \small{VHDL}. 
1202
1203         TODO: It seems we can map an expression to a port, not only a signal.
1204         Perhaps this makes this transformation not needed?
1205         TODO: Say something about dataconstructors (without arguments, like True
1206         or False), which are variable references of a runtime representable
1207         type, but do not result in a signal.
1208
1209         To reduce a complex expression to a simple variable reference, we create
1210         a new let expression around the application, which binds the complex
1211         expression to a new variable. The original function is then applied to
1212         this variable.
1213
1214         \starttrans
1215         M N
1216         --------------------    \lam{N} is of a representable type
1217         let x = N in M x        \lam{N} is not a local variable reference
1218         \stoptrans
1219
1220         \startbuffer[from]
1221         add (add a 1) 1
1222         \stopbuffer
1223
1224         \startbuffer[to]
1225         let x = add a 1 in add x 1
1226         \stopbuffer
1227
1228         \transexample{Argument extraction}{from}{to}
1229
1230       \subsubsection{Function extraction}
1231         This transform deals with function-typed arguments to builtin functions.
1232         Since these arguments cannot be propagated, we choose to extract them
1233         into a new global function instead.
1234
1235         Any free variables occuring in the extracted arguments will become
1236         parameters to the new global function. The original argument is replaced
1237         with a reference to the new function, applied to any free variables from
1238         the original argument.
1239
1240         This transformation is useful when applying higher order builtin functions
1241         like \hs{map} to a lambda abstraction, for example. In this case, the code
1242         that generates \small{VHDL} for \hs{map} only needs to handle top level functions and
1243         partial applications, not any other expression (such as lambda abstractions or
1244         even more complicated expressions).
1245
1246         \starttrans
1247         M N                     \lam{M} is a (partial aplication of a) builtin function.
1248         ---------------------   \lam{f0 ... fn} = free local variables of \lam{N}
1249         M x f0 ... fn           \lam{N :: a -> b}
1250         ~                       \lam{N} is not a (partial application of) a top level function
1251         x = λf0 ... λfn.N
1252         \stoptrans
1253
1254         \startbuffer[from]
1255         map (λa . add a b) xs
1256
1257         map (add b) ys
1258         \stopbuffer
1259
1260         \startbuffer[to]
1261         x0 = λb.λa.add a b
1262         ~
1263         map x0 xs
1264
1265         x1 = λb.add b
1266         map x1 ys
1267         \stopbuffer
1268
1269         \transexample{Function extraction}{from}{to}
1270
1271       \subsubsection{Argument propagation}
1272         This transform deals with arguments to user-defined functions that are
1273         not representable at runtime. This means these arguments cannot be
1274         preserved in the final form and most be {\em propagated}.
1275
1276         Propagation means to create a specialized version of the called
1277         function, with the propagated argument already filled in. As a simple
1278         example, in the following program:
1279
1280         \startlambda
1281         f = λa.λb.a + b
1282         inc = λa.f a 1
1283         \stoplambda
1284
1285         we could {\em propagate} the constant argument 1, with the following
1286         result:
1287
1288         \startlambda
1289         f' = λa.a + 1
1290         inc = λa.f' a
1291         \stoplambda
1292
1293         Special care must be taken when the to-be-propagated expression has any
1294         free variables. If this is the case, the original argument should not be
1295         removed alltogether, but replaced by all the free variables of the
1296         expression. In this way, the original expression can still be evaluated
1297         inside the new function. Also, this brings us closer to our goal: All
1298         these free variables will be simple variable references.
1299
1300         To prevent us from propagating the same argument over and over, a simple
1301         local variable reference is not propagated (since is has exactly one
1302         free variable, itself, we would only replace that argument with itself).
1303
1304         This shows that any free local variables that are not runtime representable
1305         cannot be brought into normal form by this transform. We rely on an
1306         inlining transformation to replace such a variable with an expression we
1307         can propagate again.
1308
1309         \starttrans
1310         x = E
1311         ~
1312         x Y0 ... Yi ... Yn                               \lam{Yi} is not of a runtime representable type
1313         ---------------------------------------------    \lam{Yi} is not a local variable reference
1314         x' y0 ... yi-1 f0 ...  fm Yi+1 ... Yn            \lam{f0 ... fm} = free local vars of \lam{Yi}
1315         ~
1316         x' = λy0 ... yi-1 f0 ... fm yi+1 ... yn .       
1317               E y0 ... yi-1 Yi yi+1 ... yn   
1318
1319         \stoptrans
1320
1321         TODO: Example
1322
1323     \subsection{Case simplification}
1324       \subsubsection{Scrutinee simplification}
1325         This transform ensures that the scrutinee of a case expression is always
1326         a simple variable reference.
1327
1328         \starttrans
1329         case E of
1330           alts
1331         -----------------        \lam{E} is not a local variable reference
1332         let x = E in 
1333           case E of
1334             alts
1335         \stoptrans
1336
1337         \startbuffer[from]
1338         case (foo a) of
1339           True -> a
1340           False -> b
1341         \stopbuffer
1342
1343         \startbuffer[to]
1344         let x = foo a in
1345           case x of
1346             True -> a
1347             False -> b
1348         \stopbuffer
1349
1350         \transexample{Let flattening}{from}{to}
1351
1352
1353       \subsubsection{Case simplification}
1354         This transformation ensures that all case expressions become normal form. This
1355         means they will become one of:
1356         \startitemize
1357         \item An extractor case with a single alternative that picks a single field
1358         from a datatype, \eg \lam{case x of (a, b) -> a}.
1359         \item A selector case with multiple alternatives and only wild binders, that
1360         makes a choice between expressions based on the constructor of another
1361         expression, \eg \lam{case x of Low -> a; High -> b}.
1362         \stopitemize
1363
1364         \starttrans
1365         case E of
1366           C0 v0,0 ... v0,m -> E0
1367           \vdots
1368           Cn vn,0 ... vn,m -> En
1369         --------------------------------------------------- \forall i \forall j, 0 <= i <= n, 0 <= i < m (\lam{wi,j} is a wild (unused) binder)
1370         letnonrec
1371           v0,0 = case x of C0 v0,0 .. v0,m -> v0,0
1372           \vdots
1373           v0,m = case x of C0 v0,0 .. v0,m -> v0,m
1374           x0 = E0
1375           \dots
1376           vn,m = case x of Cn vn,0 .. vn,m -> vn,m
1377           xn = En
1378         in
1379           case E of
1380             C0 w0,0 ... w0,m -> x0
1381             \vdots
1382             Cn wn,0 ... wn,m -> xn
1383         \stoptrans
1384
1385         TODO: This transformation specified like this is complicated and misses
1386         conditions to prevent looping with itself. Perhaps we should split it here for
1387         discussion?
1388
1389         \startbuffer[from]
1390         case a of
1391           True -> add b 1
1392           False -> add b 2
1393         \stopbuffer
1394
1395         \startbuffer[to]
1396         letnonrec
1397           x0 = add b 1
1398           x1 = add b 2
1399         in
1400           case a of
1401             True -> x0
1402             False -> x1
1403         \stopbuffer
1404
1405         \transexample{Selector case simplification}{from}{to}
1406
1407         \startbuffer[from]
1408         case a of
1409           (,) b c -> add b c
1410         \stopbuffer
1411         \startbuffer[to]
1412         letnonrec
1413           b = case a of (,) b c -> b
1414           c = case a of (,) b c -> c
1415           x0 = add b c
1416         in
1417           case a of
1418             (,) w0 w1 -> x0
1419         \stopbuffer
1420
1421         \transexample{Extractor case simplification}{from}{to}
1422
1423       \subsubsection{Case removal}
1424         This transform removes any case statements with a single alternative and
1425         only wild binders.
1426
1427         These "useless" case statements are usually leftovers from case simplification
1428         on extractor case (see the previous example).
1429
1430         \starttrans
1431         case x of
1432           C v0 ... vm -> E
1433         ----------------------     \lam{\forall i, 0 <= i <= m} (\lam{vi} does not occur free in E)
1434         E
1435         \stoptrans
1436
1437         \startbuffer[from]
1438         case a of
1439           (,) w0 w1 -> x0
1440         \stopbuffer
1441
1442         \startbuffer[to]
1443         x0
1444         \stopbuffer
1445
1446         \transexample{Case removal}{from}{to}
1447
1448   \subsection{Monomorphisation}
1449     TODO: Better name for this section
1450
1451     Reference type-specialization (== argument propagation)
1452
1453   \subsubsection{Defunctionalization}
1454     Reference higher-order-specialization (== argument propagation)
1455
1456       \subsubsection{Non-representable binding inlining}
1457         This transform inlines let bindings that have a non-representable type. Since
1458         we can never generate a signal assignment for these bindings (we cannot
1459         declare a signal assignment with a non-representable type, for obvious
1460         reasons), we have no choice but to inline the binding to remove it.
1461
1462         If the binding is non-representable because it is a lambda abstraction, it is
1463         likely that it will inlined into an application and β-reduction will remove
1464         the lambda abstraction and turn it into a representable expression at the
1465         inline site. The same holds for partial applications, which can be turned into
1466         full applications by inlining.
1467
1468         Other cases of non-representable bindings we see in practice are primitive
1469         Haskell types. In most cases, these will not result in a valid normalized
1470         output, but then the input would have been invalid to start with. There is one
1471         exception to this: When a builtin function is applied to a non-representable
1472         expression, things might work out in some cases. For example, when you write a
1473         literal \hs{SizedInt} in Haskell, like \hs{1 :: SizedInt D8}, this results in
1474         the following core: \lam{fromInteger (smallInteger 10)}, where for example
1475         \lam{10 :: GHC.Prim.Int\#} and \lam{smallInteger 10 :: Integer} have
1476         non-representable types. TODO: This/these paragraph(s) should probably become a
1477         separate discussion somewhere else.
1478
1479         \starttrans
1480         letnonrec a = E in M
1481         --------------------------    \lam{E} has a non-representable type.
1482         M[E/a]
1483         \stoptrans
1484
1485         \starttrans
1486         letrec 
1487           \vdots
1488           a = E
1489           \vdots
1490         in
1491           M
1492         --------------------------    \lam{E} has a non-representable type.
1493         letrec
1494           \vdots [E/a]
1495           \vdots [E/a]
1496         in
1497           M[E/a]
1498         \stoptrans
1499
1500         \startbuffer[from]
1501         letrec
1502           a = smallInteger 10
1503           inc = λa -> add a 1
1504           inc' = add 1
1505           x = fromInteger a 
1506         in
1507           inc (inc' x)
1508         \stopbuffer
1509
1510         \startbuffer[to]
1511         letrec
1512           x = fromInteger (smallInteger 10)
1513         in
1514           (λa -> add a 1) (add 1 x)
1515         \stopbuffer
1516
1517         \transexample{Let flattening}{from}{to}
1518
1519
1520   \section{Provable properties}
1521     When looking at the system of transformations outlined above, there are a
1522     number of questions that we can ask ourselves. The main question is of course:
1523     \quote{Does our system work as intended?}. We can split this question into a
1524     number of subquestions:
1525
1526     \startitemize[KR]
1527     \item[q:termination] Does our system \emph{terminate}? Since our system will
1528     keep running as long as transformations apply, there is an obvious risk that
1529     it will keep running indefinitely. One transformation produces a result that
1530     is transformed back to the original by another transformation, for example.
1531     \item[q:soundness] Is our system \emph{sound}? Since our transformations
1532     continuously modify the expression, there is an obvious risk that the final
1533     normal form will not be equivalent to the original program: Its meaning could
1534     have changed.
1535     \item[q:completeness] Is our system \emph{complete}? Since we have a complex
1536     system of transformations, there is an obvious risk that some expressions will
1537     not end up in our intended normal form, because we forgot some transformation.
1538     In other words: Does our transformation system result in our intended normal
1539     form for all possible inputs?
1540     \item[q:determinism] Is our system \emph{deterministic}? Since we have defined
1541     no particular order in which the transformation should be applied, there is an
1542     obvious risk that different transformation orderings will result in
1543     \emph{different} normal forms. They might still both be intended normal forms
1544     (if our system is \emph{complete}) and describe correct hardware (if our
1545     system is \emph{sound}), so this property is less important than the previous
1546     three: The translator would still function properly without it.
1547     \stopitemize
1548
1549     \subsection{Graph representation}
1550       Before looking into how to prove these properties, we'll look at our
1551       transformation system from a graph perspective. The nodes of the graph are
1552       all possible Core expressions. The (directed) edges of the graph are
1553       transformations. When a transformation α applies to an expression \lam{A} to
1554       produce an expression \lam{B}, we add an edge from the node for \lam{A} to the
1555       node for \lam{B}, labeled α.
1556
1557       \startuseMPgraphic{TransformGraph}
1558         save a, b, c, d;
1559
1560         % Nodes
1561         newCircle.a(btex \lam{(λx.λy. (+) x y) 1} etex);
1562         newCircle.b(btex \lam{λy. (+) 1 y} etex);
1563         newCircle.c(btex \lam{(λx.(+) x) 1} etex);
1564         newCircle.d(btex \lam{(+) 1} etex);
1565
1566         b.c = origin;
1567         c.c = b.c + (4cm, 0cm);
1568         a.c = midpoint(b.c, c.c) + (0cm, 4cm);
1569         d.c = midpoint(b.c, c.c) - (0cm, 3cm);
1570
1571         % β-conversion between a and b
1572         ncarc.a(a)(b) "name(bred)";
1573         ObjLabel.a(btex $\xrightarrow[normal]{}{β}$ etex) "labpathname(bred)", "labdir(rt)";
1574         ncarc.b(b)(a) "name(bexp)", "linestyle(dashed withdots)";
1575         ObjLabel.b(btex $\xleftarrow[normal]{}{β}$ etex) "labpathname(bexp)", "labdir(lft)";
1576
1577         % η-conversion between a and c
1578         ncarc.a(a)(c) "name(ered)";
1579         ObjLabel.a(btex $\xrightarrow[normal]{}{η}$ etex) "labpathname(ered)", "labdir(rt)";
1580         ncarc.c(c)(a) "name(eexp)", "linestyle(dashed withdots)";
1581         ObjLabel.c(btex $\xleftarrow[normal]{}{η}$ etex) "labpathname(eexp)", "labdir(lft)";
1582
1583         % η-conversion between b and d
1584         ncarc.b(b)(d) "name(ered)";
1585         ObjLabel.b(btex $\xrightarrow[normal]{}{η}$ etex) "labpathname(ered)", "labdir(rt)";
1586         ncarc.d(d)(b) "name(eexp)", "linestyle(dashed withdots)";
1587         ObjLabel.d(btex $\xleftarrow[normal]{}{η}$ etex) "labpathname(eexp)", "labdir(lft)";
1588
1589         % β-conversion between c and d
1590         ncarc.c(c)(d) "name(bred)";
1591         ObjLabel.c(btex $\xrightarrow[normal]{}{β}$ etex) "labpathname(bred)", "labdir(rt)";
1592         ncarc.d(d)(c) "name(bexp)", "linestyle(dashed withdots)";
1593         ObjLabel.d(btex $\xleftarrow[normal]{}{β}$ etex) "labpathname(bexp)", "labdir(lft)";
1594
1595         % Draw objects and lines
1596         drawObj(a, b, c, d);
1597       \stopuseMPgraphic
1598
1599       \placeexample[right][ex:TransformGraph]{Partial graph of a labmda calculus
1600       system with β and η reduction (solid lines) and expansion (dotted lines).}
1601           \boxedgraphic{TransformGraph}
1602
1603       Of course our graph is unbounded, since we can construct an infinite amount of
1604       Core expressions. Also, there might potentially be multiple edges between two
1605       given nodes (with different labels), though seems unlikely to actually happen
1606       in our system.
1607
1608       See \in{example}[ex:TransformGraph] for the graph representation of a very
1609       simple lambda calculus that contains just the expressions \lam{(λx.λy. (+) x
1610       y) 1}, \lam{λy. (+) 1 y}, \lam{(λx.(+) x) 1} and \lam{(+) 1}. The
1611       transformation system consists of β-reduction and η-reduction (solid edges) or
1612       β-reduction and η-reduction (dotted edges).
1613
1614       TODO: Define β-reduction and η-reduction?
1615
1616       Note that the normal form of such a system consists of the set of nodes
1617       (expressions) without outgoing edges, since those are the expression to which
1618       no transformation applies anymore. We call this set of nodes the \emph{normal
1619       set}.
1620
1621       From such a graph, we can derive some properties easily:
1622       \startitemize[KR]
1623         \item A system will \emph{terminate} if there is no path of infinite length
1624         in the graph (this includes cycles).
1625         \item Soundness is not easily represented in the graph.
1626         \item A system is \emph{complete} if all of the nodes in the normal set have
1627         the intended normal form. The inverse (that all of the nodes outside of
1628         the normal set are \emph{not} in the intended normal form) is not
1629         strictly required.
1630         \item A system is deterministic if all paths from a node, which end in a node
1631         in the normal set, end at the same node.
1632       \stopitemize
1633
1634       When looking at the \in{example}[ex:TransformGraph], we see that the system
1635       terminates for both the reduction and expansion systems (but note that, for
1636       expansion, this is only true because we've limited the possible expressions!
1637       In comlete lambda calculus, there would be a path from \lam{(λx.λy. (+) x y)
1638       1} to \lam{(λx.λy.(λz.(+) z) x y) 1} to \lam{(λx.λy.(λz.(λq.(+) q) z) x y) 1}
1639       etc.)
1640
1641       If we would consider the system with both expansion and reduction, there would
1642       no longer be termination, since there would be cycles all over the place.
1643
1644       The reduction and expansion systems have a normal set of containing just
1645       \lam{(+) 1} or \lam{(λx.λy. (+) x y) 1} respectively. Since all paths in
1646       either system end up in these normal forms, both systems are \emph{complete}.
1647       Also, since there is only one normal form, it must obviously be
1648       \emph{deterministic} as well.
1649
1650     \subsection{Termination}
1651       Approach: Counting.
1652
1653       Church-Rosser?
1654
1655     \subsection{Soundness}
1656       Needs formal definition of semantics.
1657       Prove for each transformation seperately, implies soundness of the system.
1658      
1659     \subsection{Completeness}
1660       Show that any transformation applies to every Core expression that is not
1661       in normal form. To prove: no transformation applies => in intended form.
1662       Show the reverse: Not in intended form => transformation applies.
1663
1664     \subsection{Determinism}
1665       How to prove this?