Explicitely use "letrec" for recursive lets.
[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       These transformations are general cleanup transformations, that aim to
748       make expressions simpler. These transformations usually clean up the
749        mess left behind by other transformations or clean up expressions to
750        expose new transformation opportunities for other transformations.
751
752        Most of these transformations are standard optimizations in other
753        compilers as well. However, in our compiler, most of these are not just
754        optimizations, but they are required to get our program into normal
755        form.
756
757       \subsubsection{β-reduction}
758         β-reduction is a well known transformation from lambda calculus, where it is
759         the main reduction step. It reduces applications of labmda abstractions,
760         removing both the lambda abstraction and the application.
761
762         In our transformation system, this step helps to remove unwanted lambda
763         abstractions (basically all but the ones at the top level). Other
764         transformations (application propagation, non-representable inlining) make
765         sure that most lambda abstractions will eventually be reducable by
766         β-reduction.
767
768         \starttrans
769         (λx.E) M
770         -----------------
771         E[M/x]
772         \stoptrans
773
774         % And an example
775         \startbuffer[from]
776         (λa. 2 * a) (2 * b)
777         \stopbuffer
778
779         \startbuffer[to]
780         2 * (2 * b)
781         \stopbuffer
782
783         \transexample{β-reduction}{from}{to}
784
785       \subsubsection{Empty let removal}
786         This transformation is simple: It removes recursive lets that have no bindings
787         (which usually occurs when let derecursification removes the last binding from
788         it).
789
790         \starttrans
791         letrec in M
792         --------------
793         M
794         \stoptrans
795
796       \subsubsection{Simple let binding removal}
797         This transformation inlines simple let bindings (\eg a = b).
798
799         This transformation is not needed to get into normal form, but makes the
800         resulting \small{VHDL} a lot shorter.
801
802         \starttrans
803         letnonrec
804           a = b
805         in
806           M
807         -----------------
808         M[b/a]
809         \stoptrans
810
811         \starttrans
812         letrec
813           \vdots
814           a = b
815           \vdots
816         in
817           M
818         -----------------
819         let
820           \vdots [b/a]
821           \vdots [b/a]
822         in
823           M[b/a]
824         \stoptrans
825
826       \subsubsection{Unused let binding removal}
827         This transformation removes let bindings that are never used. Usually,
828         the desugarer introduces some unused let bindings.
829
830         This normalization pass should really be unneeded to get into normal form
831         (since ununsed bindings are not forbidden by the normal form), but in practice
832         the desugarer or simplifier emits some unused bindings that cannot be
833         normalized (e.g., calls to a \type{PatError} (TODO: Check this name)). Also,
834         this transformation makes the resulting \small{VHDL} a lot shorter.
835
836         \starttrans
837         let a = E in M
838         ----------------------------    \lam{a} does not occur free in \lam{M}
839         M
840         \stoptrans
841
842         \starttrans
843         letrec
844           \vdots
845           a = E
846           \vdots
847         in
848           M
849         ----------------------------    \lam{a} does not occur free in \lam{M}
850         letrec
851           \vdots
852           \vdots
853         in
854           M
855         \stoptrans
856
857       \subsubsection{Cast propagation / simplification}
858         This transform pushes casts down into the expression as far as possible.
859         Since its exact role and need is not clear yet, this transformation is
860         not yet specified.
861
862       \subsubsection{Compiler generated top level binding inlining}
863         TODO
864
865     \section{Program structure}
866       These transformations are aimed at normalizing the overall structure
867       into the intended form. This means ensuring there is a lambda abstraction
868       at the top for every argument (input port), putting all of the other
869       value definitions in let bindings and making the final return value a
870       simple variable reference.
871
872       \subsubsection{η-abstraction}
873         This transformation makes sure that all arguments of a function-typed
874         expression are named, by introducing lambda expressions. When combined with
875         β-reduction and non-representable binding inlining, all function-typed
876         expressions should be lambda abstractions or global identifiers.
877
878         \starttrans
879         E                 \lam{E :: a -> b}
880         --------------    \lam{E} is not the first argument of an application.
881         λx.E x            \lam{E} is not a lambda abstraction.
882                           \lam{x} is a variable that does not occur free in \lam{E}.
883         \stoptrans
884
885         \startbuffer[from]
886         foo = λa.case a of 
887           True -> λb.mul b b
888           False -> id
889         \stopbuffer
890
891         \startbuffer[to]
892         foo = λa.λx.(case a of 
893             True -> λb.mul b b
894             False -> λy.id y) x
895         \stopbuffer
896
897         \transexample{η-abstraction}{from}{to}
898
899       \subsubsection{Application propagation}
900         This transformation is meant to propagate application expressions downwards
901         into expressions as far as possible. This allows partial applications inside
902         expressions to become fully applied and exposes new transformation
903         opportunities for other transformations (like β-reduction and
904         specialization).
905
906         \starttrans
907         (let binds in E) M
908         -----------------
909         let binds in E M
910         \stoptrans
911
912         % And an example
913         \startbuffer[from]
914         ( let 
915             val = 1
916           in 
917             add val
918         ) 3
919         \stopbuffer
920
921         \startbuffer[to]
922         let 
923           val = 1
924         in 
925           add val 3
926         \stopbuffer
927
928         \transexample{Application propagation for a let expression}{from}{to}
929
930         \starttrans
931         (case x of
932           p1 -> E1
933           \vdots
934           pn -> En) M
935         -----------------
936         case x of
937           p1 -> E1 M
938           \vdots
939           pn -> En M
940         \stoptrans
941
942         % And an example
943         \startbuffer[from]
944         ( case x of 
945             True -> id
946             False -> neg
947         ) 1
948         \stopbuffer
949
950         \startbuffer[to]
951         case x of 
952           True -> id 1
953           False -> neg 1
954         \stopbuffer
955
956         \transexample{Application propagation for a case expression}{from}{to}
957
958       \subsubsection{Let derecursification}
959         This transformation is meant to make lets non-recursive whenever possible.
960         This might allow other optimizations to do their work better. TODO: Why is
961         this needed exactly?
962
963       \subsubsection{Let flattening}
964         This transformation puts nested lets in the same scope, by lifting the
965         binding(s) of the inner let into a new let around the outer let. Eventually,
966         this will cause all let bindings to appear in the same scope (they will all be
967         in scope for the function return value).
968
969         Note that this transformation does not try to be smart when faced with
970         recursive lets, it will just leave the lets recursive (possibly joining a
971         recursive and non-recursive let into a single recursive let). The let
972         dederecursification transformation will do this instead.
973
974         \starttrans
975         letnonrec x = (let bindings in M) in N
976         ------------------------------------------
977         let bindings in (letnonrec x = M) in N
978         \stoptrans
979
980         \starttrans
981         letrec 
982           \vdots
983           x = (let bindings in M)
984           \vdots
985         in
986           N
987         ------------------------------------------
988         letrec
989           \vdots
990           bindings
991           x = M
992           \vdots
993         in
994           N
995         \stoptrans
996
997         \startbuffer[from]
998         let
999           a = letrec
1000             x = 1
1001             y = 2
1002           in
1003             x + y
1004         in
1005           letrec
1006             b = let c = 3 in a + c
1007             d = 4
1008           in
1009             d + b
1010         \stopbuffer
1011         \startbuffer[to]
1012         letrec
1013           x = 1
1014           y = 2
1015         in
1016           let
1017             a = x + y
1018           in
1019             letrec
1020               c = 3
1021               b = a + c
1022               d = 4
1023             in
1024               d + b
1025         \stopbuffer
1026
1027         \transexample{Let flattening}{from}{to}
1028
1029       \subsubsection{Return value simplification}
1030         This transformation ensures that the return value of a function is always a
1031         simple local variable reference.
1032
1033         Currently implemented using lambda simplification, let simplification, and
1034         top simplification. Should change into something like the following, which
1035         works only on the result of a function instead of any subexpression. This is
1036         achieved by the contexts, like \lam{x = E}, though this is strictly not
1037         correct (you could read this as "if there is any function \lam{x} that binds
1038         \lam{E}, any \lam{E} can be transformed, while we only mean the \lam{E} that
1039         is bound by \lam{x}. This might need some extra notes or something).
1040
1041         Note that the return value is not simplified if its not representable.
1042         Otherwise, this would cause a direct loop with the inlining of
1043         unrepresentable bindings, of course. If the return value is not
1044         representable because it has a function type, η-abstraction should
1045         make sure that this transformation will eventually apply. If the value
1046         is not representable for other reasons, the function result itself is
1047         not representable, meaning this function is not representable anyway!
1048
1049         \starttrans
1050         x = E                            \lam{E} is representable
1051         ~                                \lam{E} is not a lambda abstraction
1052         E                                \lam{E} is not a let expression
1053         ---------------------------      \lam{E} is not a local variable reference
1054         let x = E in x
1055         \stoptrans
1056
1057         \starttrans
1058         x = λv0 ... λvn.E
1059         ~                                \lam{E} is representable
1060         E                                \lam{E} is not a let expression
1061         ---------------------------      \lam{E} is not a local variable reference
1062         let x = E in x
1063         \stoptrans
1064
1065         \starttrans
1066         x = λv0 ... λvn.let ... in E
1067         ~                                \lam{E} is representable
1068         E                                \lam{E} is not a local variable reference
1069         ---------------------------
1070         let x = E in x
1071         \stoptrans
1072
1073         \startbuffer[from]
1074         x = add 1 2
1075         \stopbuffer
1076
1077         \startbuffer[to]
1078         x = let x = add 1 2 in x
1079         \stopbuffer
1080
1081         \transexample{Return value simplification}{from}{to}
1082
1083     \subsection{Argument simplification}
1084       The transforms in this section deal with simplifying application
1085       arguments into normal form. The goal here is to:
1086
1087       \startitemize
1088        \item Make all arguments of user-defined functions (\eg, of which
1089        we have a function body) simple variable references of a runtime
1090        representable type. This is needed, since these applications will be turned
1091        into component instantiations.
1092        \item Make all arguments of builtin functions one of:
1093          \startitemize
1094           \item A type argument.
1095           \item A dictionary argument.
1096           \item A type level expression.
1097           \item A variable reference of a runtime representable type.
1098           \item A variable reference or partial application of a function type.
1099          \stopitemize
1100       \stopitemize
1101
1102       When looking at the arguments of a user-defined function, we can
1103       divide them into two categories:
1104       \startitemize
1105         \item Arguments of a runtime representable type (\eg bits or vectors).
1106
1107               These arguments can be preserved in the program, since they can
1108               be translated to input ports later on.  However, since we can
1109               only connect signals to input ports, these arguments must be
1110               reduced to simple variables (for which signals will be
1111               produced). This is taken care of by the argument extraction
1112               transform.
1113         \item Non-runtime representable typed arguments.
1114               
1115               These arguments cannot be preserved in the program, since we
1116               cannot represent them as input or output ports in the resulting
1117               \small{VHDL}. To remove them, we create a specialized version of the
1118               called function with these arguments filled in. This is done by
1119               the argument propagation transform.
1120
1121               Typically, these arguments are type and dictionary arguments that are
1122               used to make functions polymorphic. By propagating these arguments, we
1123               are essentially doing the same which GHC does when it specializes
1124               functions: Creating multiple variants of the same function, one for
1125               each type for which it is used. Other common non-representable
1126               arguments are functions, e.g. when calling a higher order function
1127               with another function or a lambda abstraction as an argument.
1128
1129               The reason for doing this is similar to the reasoning provided for
1130               the inlining of non-representable let bindings above. In fact, this
1131               argument propagation could be viewed as a form of cross-function
1132               inlining.
1133       \stopitemize
1134
1135       TODO: Check the following itemization.
1136
1137       When looking at the arguments of a builtin function, we can divide them
1138       into categories: 
1139
1140       \startitemize
1141         \item Arguments of a runtime representable type.
1142               
1143               As we have seen with user-defined functions, these arguments can
1144               always be reduced to a simple variable reference, by the
1145               argument extraction transform. Performing this transform for
1146               builtin functions as well, means that the translation of builtin
1147               functions can be limited to signal references, instead of
1148               needing to support all possible expressions.
1149
1150         \item Arguments of a function type.
1151               
1152               These arguments are functions passed to higher order builtins,
1153               like \lam{map} and \lam{foldl}. Since implementing these
1154               functions for arbitrary function-typed expressions (\eg, lambda
1155               expressions) is rather comlex, we reduce these arguments to
1156               (partial applications of) global functions.
1157               
1158               We can still support arbitrary expressions from the user code,
1159               by creating a new global function containing that expression.
1160               This way, we can simply replace the argument with a reference to
1161               that new function. However, since the expression can contain any
1162               number of free variables we also have to include partial
1163               applications in our normal form.
1164
1165               This category of arguments is handled by the function extraction
1166               transform.
1167         \item Other unrepresentable arguments.
1168               
1169               These arguments can take a few different forms:
1170               \startdesc{Type arguments}
1171                 In the core language, type arguments can only take a single
1172                 form: A type wrapped in the Type constructor. Also, there is
1173                 nothing that can be done with type expressions, except for
1174                 applying functions to them, so we can simply leave type
1175                 arguments as they are.
1176               \stopdesc
1177               \startdesc{Dictionary arguments}
1178                 In the core language, dictionary arguments are used to find
1179                 operations operating on one of the type arguments (mostly for
1180                 finding class methods). Since we will not actually evaluatie
1181                 the function body for builtin functions and can generate
1182                 code for builtin functions by just looking at the type
1183                 arguments, these arguments can be ignored and left as they
1184                 are.
1185               \stopdesc
1186               \startdesc{Type level arguments}
1187                 Sometimes, we want to pass a value to a builtin function, but
1188                 we need to know the value at compile time. Additionally, the
1189                 value has an impact on the type of the function. This is
1190                 encoded using type-level values, where the actual value of the
1191                 argument is not important, but the type encodes some integer,
1192                 for example. Since the value is not important, the actual form
1193                 of the expression does not matter either and we can leave
1194                 these arguments as they are.
1195               \stopdesc
1196               \startdesc{Other arguments}
1197                 Technically, there is still a wide array of arguments that can
1198                 be passed, but does not fall into any of the above categories.
1199                 However, none of the supported builtin functions requires such
1200                 an argument. This leaves use with passing unsupported types to
1201                 a function, such as calling \lam{head} on a list of functions.
1202
1203                 In these cases, it would be impossible to generate hardware
1204                 for such a function call anyway, so we can ignore these
1205                 arguments.
1206
1207                 The only way to generate hardware for builtin functions with
1208                 arguments like these, is to expand the function call into an
1209                 equivalent core expression (\eg, expand map into a series of
1210                 function applications). But for now, we choose to simply not
1211                 support expressions like these.
1212               \stopdesc
1213
1214               From the above, we can conclude that we can simply ignore these
1215               other unrepresentable arguments and focus on the first two
1216               categories instead.
1217       \stopitemize
1218
1219       \subsubsection{Argument simplification}
1220         This transform deals with arguments to functions that
1221         are of a runtime representable type. It ensures that they will all become
1222         references to global variables, or local signals in the resulting \small{VHDL}. 
1223
1224         TODO: It seems we can map an expression to a port, not only a signal.
1225         Perhaps this makes this transformation not needed?
1226         TODO: Say something about dataconstructors (without arguments, like True
1227         or False), which are variable references of a runtime representable
1228         type, but do not result in a signal.
1229
1230         To reduce a complex expression to a simple variable reference, we create
1231         a new let expression around the application, which binds the complex
1232         expression to a new variable. The original function is then applied to
1233         this variable.
1234
1235         \starttrans
1236         M N
1237         --------------------    \lam{N} is of a representable type
1238         let x = N in M x        \lam{N} is not a local variable reference
1239         \stoptrans
1240
1241         \startbuffer[from]
1242         add (add a 1) 1
1243         \stopbuffer
1244
1245         \startbuffer[to]
1246         let x = add a 1 in add x 1
1247         \stopbuffer
1248
1249         \transexample{Argument extraction}{from}{to}
1250
1251       \subsubsection{Function extraction}
1252         This transform deals with function-typed arguments to builtin functions.
1253         Since these arguments cannot be propagated, we choose to extract them
1254         into a new global function instead.
1255
1256         Any free variables occuring in the extracted arguments will become
1257         parameters to the new global function. The original argument is replaced
1258         with a reference to the new function, applied to any free variables from
1259         the original argument.
1260
1261         This transformation is useful when applying higher order builtin functions
1262         like \hs{map} to a lambda abstraction, for example. In this case, the code
1263         that generates \small{VHDL} for \hs{map} only needs to handle top level functions and
1264         partial applications, not any other expression (such as lambda abstractions or
1265         even more complicated expressions).
1266
1267         \starttrans
1268         M N                     \lam{M} is a (partial aplication of a) builtin function.
1269         ---------------------   \lam{f0 ... fn} = free local variables of \lam{N}
1270         M x f0 ... fn           \lam{N :: a -> b}
1271         ~                       \lam{N} is not a (partial application of) a top level function
1272         x = λf0 ... λfn.N
1273         \stoptrans
1274
1275         \startbuffer[from]
1276         map (λa . add a b) xs
1277
1278         map (add b) ys
1279         \stopbuffer
1280
1281         \startbuffer[to]
1282         x0 = λb.λa.add a b
1283         ~
1284         map x0 xs
1285
1286         x1 = λb.add b
1287         map x1 ys
1288         \stopbuffer
1289
1290         \transexample{Function extraction}{from}{to}
1291
1292       \subsubsection{Argument propagation}
1293         This transform deals with arguments to user-defined functions that are
1294         not representable at runtime. This means these arguments cannot be
1295         preserved in the final form and most be {\em propagated}.
1296
1297         Propagation means to create a specialized version of the called
1298         function, with the propagated argument already filled in. As a simple
1299         example, in the following program:
1300
1301         \startlambda
1302         f = λa.λb.a + b
1303         inc = λa.f a 1
1304         \stoplambda
1305
1306         we could {\em propagate} the constant argument 1, with the following
1307         result:
1308
1309         \startlambda
1310         f' = λa.a + 1
1311         inc = λa.f' a
1312         \stoplambda
1313
1314         Special care must be taken when the to-be-propagated expression has any
1315         free variables. If this is the case, the original argument should not be
1316         removed alltogether, but replaced by all the free variables of the
1317         expression. In this way, the original expression can still be evaluated
1318         inside the new function. Also, this brings us closer to our goal: All
1319         these free variables will be simple variable references.
1320
1321         To prevent us from propagating the same argument over and over, a simple
1322         local variable reference is not propagated (since is has exactly one
1323         free variable, itself, we would only replace that argument with itself).
1324
1325         This shows that any free local variables that are not runtime representable
1326         cannot be brought into normal form by this transform. We rely on an
1327         inlining transformation to replace such a variable with an expression we
1328         can propagate again.
1329
1330         \starttrans
1331         x = E
1332         ~
1333         x Y0 ... Yi ... Yn                               \lam{Yi} is not of a runtime representable type
1334         ---------------------------------------------    \lam{Yi} is not a local variable reference
1335         x' y0 ... yi-1 f0 ...  fm Yi+1 ... Yn            \lam{f0 ... fm} = free local vars of \lam{Yi}
1336         ~
1337         x' = λy0 ... yi-1 f0 ... fm yi+1 ... yn .       
1338               E y0 ... yi-1 Yi yi+1 ... yn   
1339
1340         \stoptrans
1341
1342         TODO: Example
1343
1344     \subsection{Case simplification}
1345       \subsubsection{Scrutinee simplification}
1346         This transform ensures that the scrutinee of a case expression is always
1347         a simple variable reference.
1348
1349         \starttrans
1350         case E of
1351           alts
1352         -----------------        \lam{E} is not a local variable reference
1353         let x = E in 
1354           case E of
1355             alts
1356         \stoptrans
1357
1358         \startbuffer[from]
1359         case (foo a) of
1360           True -> a
1361           False -> b
1362         \stopbuffer
1363
1364         \startbuffer[to]
1365         let x = foo a in
1366           case x of
1367             True -> a
1368             False -> b
1369         \stopbuffer
1370
1371         \transexample{Let flattening}{from}{to}
1372
1373
1374       \subsubsection{Case simplification}
1375         This transformation ensures that all case expressions become normal form. This
1376         means they will become one of:
1377         \startitemize
1378         \item An extractor case with a single alternative that picks a single field
1379         from a datatype, \eg \lam{case x of (a, b) -> a}.
1380         \item A selector case with multiple alternatives and only wild binders, that
1381         makes a choice between expressions based on the constructor of another
1382         expression, \eg \lam{case x of Low -> a; High -> b}.
1383         \stopitemize
1384
1385         \starttrans
1386         case E of
1387           C0 v0,0 ... v0,m -> E0
1388           \vdots
1389           Cn vn,0 ... vn,m -> En
1390         --------------------------------------------------- \forall i \forall j, 0 <= i <= n, 0 <= i < m (\lam{wi,j} is a wild (unused) binder)
1391         letnonrec
1392           v0,0 = case x of C0 v0,0 .. v0,m -> v0,0
1393           \vdots
1394           v0,m = case x of C0 v0,0 .. v0,m -> v0,m
1395           x0 = E0
1396           \dots
1397           vn,m = case x of Cn vn,0 .. vn,m -> vn,m
1398           xn = En
1399         in
1400           case E of
1401             C0 w0,0 ... w0,m -> x0
1402             \vdots
1403             Cn wn,0 ... wn,m -> xn
1404         \stoptrans
1405
1406         TODO: This transformation specified like this is complicated and misses
1407         conditions to prevent looping with itself. Perhaps we should split it here for
1408         discussion?
1409
1410         \startbuffer[from]
1411         case a of
1412           True -> add b 1
1413           False -> add b 2
1414         \stopbuffer
1415
1416         \startbuffer[to]
1417         letnonrec
1418           x0 = add b 1
1419           x1 = add b 2
1420         in
1421           case a of
1422             True -> x0
1423             False -> x1
1424         \stopbuffer
1425
1426         \transexample{Selector case simplification}{from}{to}
1427
1428         \startbuffer[from]
1429         case a of
1430           (,) b c -> add b c
1431         \stopbuffer
1432         \startbuffer[to]
1433         letnonrec
1434           b = case a of (,) b c -> b
1435           c = case a of (,) b c -> c
1436           x0 = add b c
1437         in
1438           case a of
1439             (,) w0 w1 -> x0
1440         \stopbuffer
1441
1442         \transexample{Extractor case simplification}{from}{to}
1443
1444       \subsubsection{Case removal}
1445         This transform removes any case statements with a single alternative and
1446         only wild binders.
1447
1448         These "useless" case statements are usually leftovers from case simplification
1449         on extractor case (see the previous example).
1450
1451         \starttrans
1452         case x of
1453           C v0 ... vm -> E
1454         ----------------------     \lam{\forall i, 0 <= i <= m} (\lam{vi} does not occur free in E)
1455         E
1456         \stoptrans
1457
1458         \startbuffer[from]
1459         case a of
1460           (,) w0 w1 -> x0
1461         \stopbuffer
1462
1463         \startbuffer[to]
1464         x0
1465         \stopbuffer
1466
1467         \transexample{Case removal}{from}{to}
1468
1469   \subsection{Removing polymorphism}
1470     Reference type-specialization (== argument propagation)
1471
1472     Reference polymporphic binding inlining (== non-representable binding
1473     inlining).
1474
1475   \subsection{Defunctionalization}
1476     These transformations remove most higher order expressions from our
1477     program, making it completely first-order (the only exception here is for
1478     arguments to builtin functions, since we can't specialize builtin
1479     function. TODO: Talk more about this somewhere).
1480
1481     Reference higher-order-specialization (== argument propagation)
1482
1483       \subsubsection{Non-representable binding inlining}
1484         This transform inlines let bindings that have a non-representable type. Since
1485         we can never generate a signal assignment for these bindings (we cannot
1486         declare a signal assignment with a non-representable type, for obvious
1487         reasons), we have no choice but to inline the binding to remove it.
1488
1489         If the binding is non-representable because it is a lambda abstraction, it is
1490         likely that it will inlined into an application and β-reduction will remove
1491         the lambda abstraction and turn it into a representable expression at the
1492         inline site. The same holds for partial applications, which can be turned into
1493         full applications by inlining.
1494
1495         Other cases of non-representable bindings we see in practice are primitive
1496         Haskell types. In most cases, these will not result in a valid normalized
1497         output, but then the input would have been invalid to start with. There is one
1498         exception to this: When a builtin function is applied to a non-representable
1499         expression, things might work out in some cases. For example, when you write a
1500         literal \hs{SizedInt} in Haskell, like \hs{1 :: SizedInt D8}, this results in
1501         the following core: \lam{fromInteger (smallInteger 10)}, where for example
1502         \lam{10 :: GHC.Prim.Int\#} and \lam{smallInteger 10 :: Integer} have
1503         non-representable types. TODO: This/these paragraph(s) should probably become a
1504         separate discussion somewhere else.
1505
1506         \starttrans
1507         letnonrec a = E in M
1508         --------------------------    \lam{E} has a non-representable type.
1509         M[E/a]
1510         \stoptrans
1511
1512         \starttrans
1513         letrec 
1514           \vdots
1515           a = E
1516           \vdots
1517         in
1518           M
1519         --------------------------    \lam{E} has a non-representable type.
1520         letrec
1521           \vdots [E/a]
1522           \vdots [E/a]
1523         in
1524           M[E/a]
1525         \stoptrans
1526
1527         \startbuffer[from]
1528         letrec
1529           a = smallInteger 10
1530           inc = λa -> add a 1
1531           inc' = add 1
1532           x = fromInteger a 
1533         in
1534           inc (inc' x)
1535         \stopbuffer
1536
1537         \startbuffer[to]
1538         letrec
1539           x = fromInteger (smallInteger 10)
1540         in
1541           (λa -> add a 1) (add 1 x)
1542         \stopbuffer
1543
1544         \transexample{Let flattening}{from}{to}
1545
1546
1547   \section{Provable properties}
1548     When looking at the system of transformations outlined above, there are a
1549     number of questions that we can ask ourselves. The main question is of course:
1550     \quote{Does our system work as intended?}. We can split this question into a
1551     number of subquestions:
1552
1553     \startitemize[KR]
1554     \item[q:termination] Does our system \emph{terminate}? Since our system will
1555     keep running as long as transformations apply, there is an obvious risk that
1556     it will keep running indefinitely. One transformation produces a result that
1557     is transformed back to the original by another transformation, for example.
1558     \item[q:soundness] Is our system \emph{sound}? Since our transformations
1559     continuously modify the expression, there is an obvious risk that the final
1560     normal form will not be equivalent to the original program: Its meaning could
1561     have changed.
1562     \item[q:completeness] Is our system \emph{complete}? Since we have a complex
1563     system of transformations, there is an obvious risk that some expressions will
1564     not end up in our intended normal form, because we forgot some transformation.
1565     In other words: Does our transformation system result in our intended normal
1566     form for all possible inputs?
1567     \item[q:determinism] Is our system \emph{deterministic}? Since we have defined
1568     no particular order in which the transformation should be applied, there is an
1569     obvious risk that different transformation orderings will result in
1570     \emph{different} normal forms. They might still both be intended normal forms
1571     (if our system is \emph{complete}) and describe correct hardware (if our
1572     system is \emph{sound}), so this property is less important than the previous
1573     three: The translator would still function properly without it.
1574     \stopitemize
1575
1576     \subsection{Graph representation}
1577       Before looking into how to prove these properties, we'll look at our
1578       transformation system from a graph perspective. The nodes of the graph are
1579       all possible Core expressions. The (directed) edges of the graph are
1580       transformations. When a transformation α applies to an expression \lam{A} to
1581       produce an expression \lam{B}, we add an edge from the node for \lam{A} to the
1582       node for \lam{B}, labeled α.
1583
1584       \startuseMPgraphic{TransformGraph}
1585         save a, b, c, d;
1586
1587         % Nodes
1588         newCircle.a(btex \lam{(λx.λy. (+) x y) 1} etex);
1589         newCircle.b(btex \lam{λy. (+) 1 y} etex);
1590         newCircle.c(btex \lam{(λx.(+) x) 1} etex);
1591         newCircle.d(btex \lam{(+) 1} etex);
1592
1593         b.c = origin;
1594         c.c = b.c + (4cm, 0cm);
1595         a.c = midpoint(b.c, c.c) + (0cm, 4cm);
1596         d.c = midpoint(b.c, c.c) - (0cm, 3cm);
1597
1598         % β-conversion between a and b
1599         ncarc.a(a)(b) "name(bred)";
1600         ObjLabel.a(btex $\xrightarrow[normal]{}{β}$ etex) "labpathname(bred)", "labdir(rt)";
1601         ncarc.b(b)(a) "name(bexp)", "linestyle(dashed withdots)";
1602         ObjLabel.b(btex $\xleftarrow[normal]{}{β}$ etex) "labpathname(bexp)", "labdir(lft)";
1603
1604         % η-conversion between a and c
1605         ncarc.a(a)(c) "name(ered)";
1606         ObjLabel.a(btex $\xrightarrow[normal]{}{η}$ etex) "labpathname(ered)", "labdir(rt)";
1607         ncarc.c(c)(a) "name(eexp)", "linestyle(dashed withdots)";
1608         ObjLabel.c(btex $\xleftarrow[normal]{}{η}$ etex) "labpathname(eexp)", "labdir(lft)";
1609
1610         % η-conversion between b and d
1611         ncarc.b(b)(d) "name(ered)";
1612         ObjLabel.b(btex $\xrightarrow[normal]{}{η}$ etex) "labpathname(ered)", "labdir(rt)";
1613         ncarc.d(d)(b) "name(eexp)", "linestyle(dashed withdots)";
1614         ObjLabel.d(btex $\xleftarrow[normal]{}{η}$ etex) "labpathname(eexp)", "labdir(lft)";
1615
1616         % β-conversion between c and d
1617         ncarc.c(c)(d) "name(bred)";
1618         ObjLabel.c(btex $\xrightarrow[normal]{}{β}$ etex) "labpathname(bred)", "labdir(rt)";
1619         ncarc.d(d)(c) "name(bexp)", "linestyle(dashed withdots)";
1620         ObjLabel.d(btex $\xleftarrow[normal]{}{β}$ etex) "labpathname(bexp)", "labdir(lft)";
1621
1622         % Draw objects and lines
1623         drawObj(a, b, c, d);
1624       \stopuseMPgraphic
1625
1626       \placeexample[right][ex:TransformGraph]{Partial graph of a labmda calculus
1627       system with β and η reduction (solid lines) and expansion (dotted lines).}
1628           \boxedgraphic{TransformGraph}
1629
1630       Of course our graph is unbounded, since we can construct an infinite amount of
1631       Core expressions. Also, there might potentially be multiple edges between two
1632       given nodes (with different labels), though seems unlikely to actually happen
1633       in our system.
1634
1635       See \in{example}[ex:TransformGraph] for the graph representation of a very
1636       simple lambda calculus that contains just the expressions \lam{(λx.λy. (+) x
1637       y) 1}, \lam{λy. (+) 1 y}, \lam{(λx.(+) x) 1} and \lam{(+) 1}. The
1638       transformation system consists of β-reduction and η-reduction (solid edges) or
1639       β-reduction and η-reduction (dotted edges).
1640
1641       TODO: Define β-reduction and η-reduction?
1642
1643       Note that the normal form of such a system consists of the set of nodes
1644       (expressions) without outgoing edges, since those are the expression to which
1645       no transformation applies anymore. We call this set of nodes the \emph{normal
1646       set}.
1647
1648       From such a graph, we can derive some properties easily:
1649       \startitemize[KR]
1650         \item A system will \emph{terminate} if there is no path of infinite length
1651         in the graph (this includes cycles).
1652         \item Soundness is not easily represented in the graph.
1653         \item A system is \emph{complete} if all of the nodes in the normal set have
1654         the intended normal form. The inverse (that all of the nodes outside of
1655         the normal set are \emph{not} in the intended normal form) is not
1656         strictly required.
1657         \item A system is deterministic if all paths from a node, which end in a node
1658         in the normal set, end at the same node.
1659       \stopitemize
1660
1661       When looking at the \in{example}[ex:TransformGraph], we see that the system
1662       terminates for both the reduction and expansion systems (but note that, for
1663       expansion, this is only true because we've limited the possible expressions!
1664       In comlete lambda calculus, there would be a path from \lam{(λx.λy. (+) x y)
1665       1} to \lam{(λx.λy.(λz.(+) z) x y) 1} to \lam{(λx.λy.(λz.(λq.(+) q) z) x y) 1}
1666       etc.)
1667
1668       If we would consider the system with both expansion and reduction, there would
1669       no longer be termination, since there would be cycles all over the place.
1670
1671       The reduction and expansion systems have a normal set of containing just
1672       \lam{(+) 1} or \lam{(λx.λy. (+) x y) 1} respectively. Since all paths in
1673       either system end up in these normal forms, both systems are \emph{complete}.
1674       Also, since there is only one normal form, it must obviously be
1675       \emph{deterministic} as well.
1676
1677     \subsection{Termination}
1678       Approach: Counting.
1679
1680       Church-Rosser?
1681
1682     \subsection{Soundness}
1683       Needs formal definition of semantics.
1684       Prove for each transformation seperately, implies soundness of the system.
1685      
1686     \subsection{Completeness}
1687       Show that any transformation applies to every Core expression that is not
1688       in normal form. To prove: no transformation applies => in intended form.
1689       Show the reverse: Not in intended form => transformation applies.
1690
1691     \subsection{Determinism}
1692       How to prove this?