Add an intermezzo about substitution.
[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=,strip=auto]
11       \typebuffer[#1]
12       \setuptyping[option=none,style=\tttf,strip=auto]
13     }
14   }
15
16   \define[4]\transexample{
17     \placeexample[here][ex:trans:#1]{#2}
18     \startcombination[2*1]
19       {\example{#3}}{Original program}
20       {\example{#4}}{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 \VHDL, and describe how the
32   \VHDL we want to generate should look like.}
33
34   \section{Normal form}
35     \todo{Refresh or refer to distinct hardware per application principle}
36     The transformations described here have a well-defined goal: To bring the
37     program in a well-defined form that is directly translatable to hardware,
38     while fully preserving the semantics of the program. We refer to this form as
39     the \emph{normal form} of the program. The formal definition of this normal
40     form is quite simple:
41
42     \placedefinition{}{A program is in \emph{normal form} if none of the
43     transformations from this chapter apply.}
44
45     Of course, this is an \quote{easy} definition of the normal form, since our
46     program will end up in normal form automatically. The more interesting part is
47     to see if this normal form actually has the properties we would like it to
48     have.
49
50     But, before getting into more definitions and details about this normal form,
51     let's try to get a feeling for it first. The easiest way to do this is by
52     describing the things we want to not have in a normal form.
53
54     \startitemize
55       \item Any \emph{polymorphism} must be removed. When laying down hardware, we
56       can't generate any signals that can have multiple types. All types must be
57       completely known to generate hardware.
58       
59       \item Any \emph{higher order} constructions must be removed. We can't
60       generate a hardware signal that contains a function, so all values,
61       arguments and returns values used must be first order.
62
63       \item Any complex \emph{nested scopes} must be removed. In the \small{VHDL}
64       description, every signal is in a single scope. Also, full expressions are
65       not supported everywhere (in particular port maps can only map signal
66       names and constants, not complete expressions). To make the \small{VHDL}
67       generation easy, a separate binder must be bound to ever application or
68       other expression.
69     \stopitemize
70
71     \todo{Intermezzo: functions vs plain values}
72
73     A very simple example of a program in normal form is given in
74     \in{example}[ex:MulSum]. As you can see, all arguments to the function (which
75     will become input ports in the final hardware) are at the outer level.
76     This means that the body of the inner lambda abstraction is never a
77     function, but always a plain value.
78
79     As the body of the inner lambda abstraction, we see a single (recursive)
80     let expression, that binds two variables (\lam{mul} and \lam{sum}). These
81     variables will be signals in the final hardware, bound to the output port
82     of the \lam{*} and \lam{+} components.
83
84     The final line (the \quote{return value} of the function) selects the
85     \lam{sum} signal to be the output port of the function. This \quote{return
86     value} can always only be a variable reference, never a more complex
87     expression.
88
89     \todo{Add generated VHDL}
90
91     \startbuffer[MulSum]
92     alu :: Bit -> Word -> Word -> Word
93     alu = λa.λb.λc.
94         let
95           mul = (*) a b
96           sum = (+) mul c
97         in
98           sum
99     \stopbuffer
100
101     \startuseMPgraphic{MulSum}
102       save a, b, c, mul, add, sum;
103
104       % I/O ports
105       newCircle.a(btex $a$ etex) "framed(false)";
106       newCircle.b(btex $b$ etex) "framed(false)";
107       newCircle.c(btex $c$ etex) "framed(false)";
108       newCircle.sum(btex $res$ etex) "framed(false)";
109
110       % Components
111       newCircle.mul(btex * etex);
112       newCircle.add(btex + etex);
113
114       a.c      - b.c   = (0cm, 2cm);
115       b.c      - c.c   = (0cm, 2cm);
116       add.c            = c.c + (2cm, 0cm);
117       mul.c            = midpoint(a.c, b.c) + (2cm, 0cm);
118       sum.c            = add.c + (2cm, 0cm);
119       c.c              = origin;
120
121       % Draw objects and lines
122       drawObj(a, b, c, mul, add, sum);
123
124       ncarc(a)(mul) "arcangle(15)";
125       ncarc(b)(mul) "arcangle(-15)";
126       ncline(c)(add);
127       ncline(mul)(add);
128       ncline(add)(sum);
129     \stopuseMPgraphic
130
131     \placeexample[here][ex:MulSum]{Simple architecture consisting of a
132     multiplier and a subtractor.}
133       \startcombination[2*1]
134         {\typebufferlam{MulSum}}{Core description in normal form.}
135         {\boxedgraphic{MulSum}}{The architecture described by the normal form.}
136       \stopcombination
137
138     The previous example described composing an architecture by calling other
139     functions (operators), resulting in a simple architecture with components and
140     connections. There is of course also some mechanism for choice in the normal
141     form. In a normal Core program, the \emph{case} expression can be used in a
142     few different ways to describe choice. In normal form, this is limited to a
143     very specific form.
144
145     \in{Example}[ex:AddSubAlu] shows an example describing a
146     simple \small{ALU}, which chooses between two operations based on an opcode
147     bit. The main structure is similar to \in{example}[ex:MulSum], but this
148     time the \lam{res} variable is bound to a case expression. This case
149     expression scrutinizes the variable \lam{opcode} (and scrutinizing more
150     complex expressions is not supported). The case expression can select a
151     different variable based on the constructor of \lam{opcode}.
152
153     \startbuffer[AddSubAlu]
154     alu :: Bit -> Word -> Word -> Word
155     alu = λopcode.λa.λb.
156         let
157           res1 = (+) a b
158           res2 = (-) a b
159           res = case opcode of
160             Low -> res1
161             High -> res2
162         in
163           res
164     \stopbuffer
165
166     \startuseMPgraphic{AddSubAlu}
167       save opcode, a, b, add, sub, mux, res;
168
169       % I/O ports
170       newCircle.opcode(btex $opcode$ etex) "framed(false)";
171       newCircle.a(btex $a$ etex) "framed(false)";
172       newCircle.b(btex $b$ etex) "framed(false)";
173       newCircle.res(btex $res$ etex) "framed(false)";
174       % Components
175       newCircle.add(btex + etex);
176       newCircle.sub(btex - etex);
177       newMux.mux;
178
179       opcode.c - a.c   = (0cm, 2cm);
180       add.c    - a.c   = (4cm, 0cm);
181       sub.c    - b.c   = (4cm, 0cm);
182       a.c      - b.c   = (0cm, 3cm);
183       mux.c            = midpoint(add.c, sub.c) + (1.5cm, 0cm);
184       res.c    - mux.c = (1.5cm, 0cm);
185       b.c              = origin;
186
187       % Draw objects and lines
188       drawObj(opcode, a, b, res, add, sub, mux);
189
190       ncline(a)(add) "posA(e)";
191       ncline(b)(sub) "posA(e)";
192       nccurve(a)(sub) "posA(e)", "angleA(0)";
193       nccurve(b)(add) "posA(e)", "angleA(0)";
194       nccurve(add)(mux) "posB(inpa)", "angleB(0)";
195       nccurve(sub)(mux) "posB(inpb)", "angleB(0)";
196       nccurve(opcode)(mux) "posB(n)", "angleA(0)", "angleB(-90)";
197       ncline(mux)(res) "posA(out)";
198     \stopuseMPgraphic
199
200     \placeexample[here][ex:AddSubAlu]{Simple \small{ALU} supporting two operations.}
201       \startcombination[2*1]
202         {\typebufferlam{AddSubAlu}}{Core description in normal form.}
203         {\boxedgraphic{AddSubAlu}}{The architecture described by the normal form.}
204       \stopcombination
205
206     As a more complete example, consider \in{example}[ex:NormalComplete]. This
207     example contains everything that is supported in normal form, with the
208     exception of builtin higher order functions. The graphical version of the
209     architecture contains a slightly simplified version, since the state tuple
210     packing and unpacking have been left out. Instead, two seperate registers are
211     drawn. Also note that most synthesis tools will further optimize this
212     architecture by removing the multiplexers at the register input and
213     instead put some gates in front of the register's clock input, but we want
214     to show the architecture as close to the description as possible.
215
216     As you can see from the previous examples, the generation of the final
217     architecture from the normal form is straightforward. In each of the
218     examples, there is a direct match between the normal form structure,
219     the generated VHDL and the architecture shown in the images.
220
221     \startbuffer[NormalComplete]
222       regbank :: Bit 
223                  -> Word 
224                  -> State (Word, Word) 
225                  -> (State (Word, Word), Word)
226
227       -- All arguments are an inital lambda (address, data, packed state)
228       regbank = λa.λd.λsp.
229       -- There are nested let expressions at top level
230       let
231         -- Unpack the state by coercion (\eg, cast from
232         -- State (Word, Word) to (Word, Word))
233         s = sp ▶ (Word, Word)
234         -- Extract both registers from the state
235         r1 = case s of (a, b) -> a
236         r2 = case s of (a, b) -> b
237         -- Calling some other user-defined function.
238         d' = foo d
239         -- Conditional connections
240         out = case a of
241           High -> r1
242           Low -> r2
243         r1' = case a of
244           High -> d'
245           Low -> r1
246         r2' = case a of
247           High -> r2
248           Low -> d'
249         -- Packing a tuple
250         s' = (,) r1' r2'
251         -- pack the state by coercion (\eg, cast from
252         -- (Word, Word) to State (Word, Word))
253         sp' = s' ▶ State (Word, Word)
254         -- Pack our return value
255         res = (,) sp' out
256       in
257         -- The actual result
258         res
259     \stopbuffer
260
261     \startuseMPgraphic{NormalComplete}
262       save a, d, r, foo, muxr, muxout, out;
263
264       % I/O ports
265       newCircle.a(btex \lam{a} etex) "framed(false)";
266       newCircle.d(btex \lam{d} etex) "framed(false)";
267       newCircle.out(btex \lam{out} etex) "framed(false)";
268       % Components
269       %newCircle.add(btex + etex);
270       newBox.foo(btex \lam{foo} etex);
271       newReg.r1(btex $\lam{r1}$ etex) "dx(4mm)", "dy(6mm)";
272       newReg.r2(btex $\lam{r2}$ etex) "dx(4mm)", "dy(6mm)", "reflect(true)";
273       newMux.muxr1;
274       % Reflect over the vertical axis
275       reflectObj(muxr1)((0,0), (0,1));
276       newMux.muxr2;
277       newMux.muxout;
278       rotateObj(muxout)(-90);
279
280       d.c               = foo.c + (0cm, 1.5cm); 
281       a.c               = (xpart r2.c + 2cm, ypart d.c - 0.5cm);
282       foo.c             = midpoint(muxr1.c, muxr2.c) + (0cm, 2cm);
283       muxr1.c           = r1.c + (0cm, 2cm);
284       muxr2.c           = r2.c + (0cm, 2cm);
285       r2.c              = r1.c + (4cm, 0cm);
286       r1.c              = origin;
287       muxout.c          = midpoint(r1.c, r2.c) - (0cm, 2cm);
288       out.c             = muxout.c - (0cm, 1.5cm);
289
290     %  % Draw objects and lines
291       drawObj(a, d, foo, r1, r2, muxr1, muxr2, muxout, out);
292       
293       ncline(d)(foo);
294       nccurve(foo)(muxr1) "angleA(-90)", "posB(inpa)", "angleB(180)";
295       nccurve(foo)(muxr2) "angleA(-90)", "posB(inpb)", "angleB(0)";
296       nccurve(muxr1)(r1) "posA(out)", "angleA(180)", "posB(d)", "angleB(0)";
297       nccurve(r1)(muxr1) "posA(out)", "angleA(0)", "posB(inpb)", "angleB(180)";
298       nccurve(muxr2)(r2) "posA(out)", "angleA(0)", "posB(d)", "angleB(180)";
299       nccurve(r2)(muxr2) "posA(out)", "angleA(180)", "posB(inpa)", "angleB(0)";
300       nccurve(r1)(muxout) "posA(out)", "angleA(0)", "posB(inpb)", "angleB(-90)";
301       nccurve(r2)(muxout) "posA(out)", "angleA(180)", "posB(inpa)", "angleB(-90)";
302       % Connect port a
303       nccurve(a)(muxout) "angleA(-90)", "angleB(180)", "posB(sel)";
304       nccurve(a)(muxr1) "angleA(180)", "angleB(-90)", "posB(sel)";
305       nccurve(a)(muxr2) "angleA(180)", "angleB(-90)", "posB(sel)";
306       ncline(muxout)(out) "posA(out)";
307     \stopuseMPgraphic
308
309     \todo{Don't split registers in this image?}
310     \placeexample[here][ex:NormalComplete]{Simple architecture consisting of an adder and a
311     subtractor.}
312       \startcombination[2*1]
313         {\typebufferlam{NormalComplete}}{Core description in normal form.}
314         {\boxedgraphic{NormalComplete}}{The architecture described by the normal form.}
315       \stopcombination
316     
317
318
319     \subsection[sec:normalization:intendednormalform]{Intended normal form definition}
320       Now we have some intuition for the normal form, we can describe how we want
321       the normal form to look like in a slightly more formal manner. The following
322       EBNF-like description completely captures the intended structure (and
323       generates a subset of GHC's core format).
324
325       Some clauses have an expression listed in parentheses. These are conditions
326       that need to apply to the clause.
327
328       \defref{intended normal form definition}
329       \todo{Fix indentation}
330       \startlambda
331       \italic{normal} := \italic{lambda}
332       \italic{lambda} := λvar.\italic{lambda} (representable(var))
333                       | \italic{toplet} 
334       \italic{toplet} := letrec [\italic{binding}...] in var (representable(var))
335       \italic{binding} := var = \italic{rhs} (representable(rhs))
336                        -- State packing and unpacking by coercion
337                        | var0 = var1 ▶ State ty (lvar(var1))
338                        | var0 = var1 ▶ ty (var1 :: State ty ∧ lvar(var1))
339       \italic{rhs} := userapp
340                    | builtinapp
341                    -- Extractor case
342                    | case var of C a0 ... an -> ai (lvar(var))
343                    -- Selector case
344                    | case var of (lvar(var))
345                       [ DEFAULT -> var ]  (lvar(var))
346                       C0 w0,0 ... w0,n -> var0
347                       \vdots
348                       Cm wm,0 ... wm,n -> varm       (\forall{}i \forall{}j, wi,j \neq vari, lvar(vari))
349       \italic{userapp} := \italic{userfunc}
350                        | \italic{userapp} {userarg}
351       \italic{userfunc} := var (gvar(var))
352       \italic{userarg} := var (lvar(var))
353       \italic{builtinapp} := \italic{builtinfunc}
354                           | \italic{builtinapp} \italic{builtinarg}
355       \italic{builtinfunc} := var (bvar(var))
356       \italic{builtinarg} := var (representable(var) ∧ lvar(var))
357                           | \italic{partapp} (partapp :: a -> b)
358                           | \italic{coreexpr} (¬representable(coreexpr) ∧ ¬(coreexpr :: a -> b))
359       \italic{partapp} := \italic{userapp} | \italic{builtinapp}
360       \stoplambda
361
362       \todo{There can still be other casts around (which the code can handle,
363       e.g., ignore), which still need to be documented here}
364
365       When looking at such a program from a hardware perspective, the top level
366       lambda's define the input ports. The variable reference in the body of
367       the recursive let expression is the output port. Most function
368       applications bound by the let expression define a component
369       instantiation, where the input and output ports are mapped to local
370       signals or arguments. Some of the others use a builtin construction (\eg
371       the \lam{case} expression) or call a builtin function (\eg \lam{+} or
372       \lam{map}). For these, a hardcoded \small{VHDL} translation is
373       available.
374
375   \section[sec:normalization:transformation]{Transformation notation}
376     To be able to concisely present transformations, we use a specific format
377     for them. It is a simple format, similar to one used in logic reasoning.
378
379     Such a transformation description looks like the following.
380
381     \starttrans
382     <context conditions>
383     ~
384     <original expression>
385     --------------------------          <expression conditions>
386     <transformed expresssion>
387     ~
388     <context additions>
389     \stoptrans
390
391     This format desribes a transformation that applies to \lam{<original
392     expresssion>} and transforms it into \lam{<transformed expression>}, assuming
393     that all conditions apply. In this format, there are a number of placeholders
394     in pointy brackets, most of which should be rather obvious in their meaning.
395     Nevertheless, we will more precisely specify their meaning below:
396
397       \startdesc{<original expression>} The expression pattern that will be matched
398       against (subexpressions of) the expression to be transformed. We call this a
399       pattern, because it can contain \emph{placeholders} (variables), which match
400       any expression or binder. Any such placeholder is said to be \emph{bound} to
401       the expression it matches. It is convention to use an uppercase letter (\eg
402       \lam{M} or \lam{E}) to refer to any expression (including a simple variable
403       reference) and lowercase letters (\eg \lam{v} or \lam{b}) to refer to
404       (references to) binders.
405
406       For example, the pattern \lam{a + B} will match the expression 
407       \lam{v + (2 * w)} (binding \lam{a} to \lam{v} and \lam{B} to 
408       \lam{(2 * w)}), but not \lam{(2 * w) + v}.
409       \stopdesc
410
411       \startdesc{<expression conditions>}
412       These are extra conditions on the expression that is matched. These
413       conditions can be used to further limit the cases in which the
414       transformation applies, commonly to prevent a transformation from
415       causing a loop with itself or another transformation.
416
417       Only if these conditions are \emph{all} true, the transformation
418       applies.
419       \stopdesc
420
421       \startdesc{<context conditions>}
422       These are a number of extra conditions on the context of the function. In
423       particular, these conditions can require some (other) top level function to be
424       present, whose value matches the pattern given here. The format of each of
425       these conditions is: \lam{binder = <pattern>}.
426
427       Typically, the binder is some placeholder bound in the \lam{<original
428       expression>}, while the pattern contains some placeholders that are used in
429       the \lam{transformed expression}.
430       
431       Only if a top level binder exists that matches each binder and pattern,
432       the transformation applies.
433       \stopdesc
434
435       \startdesc{<transformed expression>}
436       This is the expression template that is the result of the transformation. If, looking
437       at the above three items, the transformation applies, the \lam{<original
438       expression>} is completely replaced with the \lam{<transformed expression>}.
439       We call this a template, because it can contain placeholders, referring to
440       any placeholder bound by the \lam{<original expression>} or the
441       \lam{<context conditions>}. The resulting expression will have those
442       placeholders replaced by the values bound to them.
443
444       Any binder (lowercase) placeholder that has no value bound to it yet will be
445       bound to (and replaced with) a fresh binder.
446       \stopdesc
447
448       \startdesc{<context additions>}
449       These are templates for new functions to add to the context. This is a way
450       to have a transformation create new top level functions.
451
452       Each addition has the form \lam{binder = template}. As above, any
453       placeholder in the addition is replaced with the value bound to it, and any
454       binder placeholder that has no value bound to it yet will be bound to (and
455       replaced with) a fresh binder.
456       \stopdesc
457
458     As an example, we'll look at η-abstraction:
459
460     \starttrans
461     E                 \lam{E :: a -> b}
462     --------------    \lam{E} does not occur on a function position in an application
463     λx.E x            \lam{E} is not a lambda abstraction.
464     \stoptrans
465
466     η-abstraction is a well known transformation from lambda calculus. What
467     this transformation does, is take any expression that has a function type
468     and turn it into a lambda expression (giving an explicit name to the
469     argument). There are some extra conditions that ensure that this
470     transformation does not apply infinitely (which are not necessarily part
471     of the conventional definition of η-abstraction).
472
473     Consider the following function, which is a fairly obvious way to specify a
474     simple ALU (Note that \in{example}[ex:AddSubAlu] shows the normal form of this
475     function). The parentheses around the \lam{+} and \lam{-} operators are
476     commonly used in Haskell to show that the operators are used as normal
477     functions, instead of \emph{infix} operators (\eg, the operators appear
478     before their arguments, instead of in between).
479
480     \startlambda 
481     alu :: Bit -> Word -> Word -> Word
482     alu = λopcode. case opcode of
483       Low -> (+)
484       High -> (-)
485     \stoplambda
486
487     There are a few subexpressions in this function to which we could possibly
488     apply the transformation. Since the pattern of the transformation is only
489     the placeholder \lam{E}, any expression will match that. Whether the
490     transformation applies to an expression is thus solely decided by the
491     conditions to the right of the transformation.
492
493     We will look at each expression in the function in a top down manner. The
494     first expression is the entire expression the function is bound to.
495
496     \startlambda
497     λopcode. case opcode of
498       Low -> (+)
499       High -> (-)
500     \stoplambda
501
502     As said, the expression pattern matches this. The type of this expression is
503     \lam{Bit -> Word -> Word -> Word}, which matches \lam{a -> b} (Note that in
504     this case \lam{a = Bit} and \lam{b = Word -> Word -> Word}).
505
506     Since this expression is at top level, it does not occur at a function
507     position of an application. However, The expression is a lambda abstraction,
508     so this transformation does not apply.
509
510     The next expression we could apply this transformation to, is the body of
511     the lambda abstraction:
512
513     \startlambda
514     case opcode of
515       Low -> (+)
516       High -> (-)
517     \stoplambda
518
519     The type of this expression is \lam{Word -> Word -> Word}, which again
520     matches \lam{a -> b}. The expression is the body of a lambda expression, so
521     it does not occur at a function position of an application. Finally, the
522     expression is not a lambda abstraction but a case expression, so all the
523     conditions match. There are no context conditions to match, so the
524     transformation applies.
525
526     By now, the placeholder \lam{E} is bound to the entire expression. The
527     placeholder \lam{x}, which occurs in the replacement template, is not bound
528     yet, so we need to generate a fresh binder for that. Let's use the binder
529     \lam{a}. This results in the following replacement expression:
530
531     \startlambda
532     λa.(case opcode of
533       Low -> (+)
534       High -> (-)) a
535     \stoplambda
536
537     Continuing with this expression, we see that the transformation does not
538     apply again (it is a lambda expression). Next we look at the body of this
539     lambda abstraction:
540
541     \startlambda
542     (case opcode of
543       Low -> (+)
544       High -> (-)) a
545     \stoplambda
546     
547     Here, the transformation does apply, binding \lam{E} to the entire
548     expression and \lam{x} to the fresh binder \lam{b}, resulting in the
549     replacement:
550
551     \startlambda
552     λb.(case opcode of
553       Low -> (+)
554       High -> (-)) a b
555     \stoplambda
556
557     Again, the transformation does not apply to this lambda abstraction, so we
558     look at its body. For brevity, we'll put the case statement on one line from
559     now on.
560
561     \startlambda
562     (case opcode of Low -> (+); High -> (-)) a b
563     \stoplambda
564
565     The type of this expression is \lam{Word}, so it does not match \lam{a -> b}
566     and the transformation does not apply. Next, we have two options for the
567     next expression to look at: The function position and argument position of
568     the application. The expression in the argument position is \lam{b}, which
569     has type \lam{Word}, so the transformation does not apply. The expression in
570     the function position is:
571
572     \startlambda
573     (case opcode of Low -> (+); High -> (-)) a
574     \stoplambda
575
576     Obviously, the transformation does not apply here, since it occurs in
577     function position (which makes the second condition false). In the same
578     way the transformation does not apply to both components of this
579     expression (\lam{case opcode of Low -> (+); High -> (-)} and \lam{a}), so
580     we'll skip to the components of the case expression: The scrutinee and
581     both alternatives. Since the opcode is not a function, it does not apply
582     here.
583
584     The first alternative is \lam{(+)}. This expression has a function type
585     (the operator still needs two arguments). It does not occur in function
586     position of an application and it is not a lambda expression, so the
587     transformation applies.
588
589     We look at the \lam{<original expression>} pattern, which is \lam{E}.
590     This means we bind \lam{E} to \lam{(+)}. We then replace the expression
591     with the \lam{<transformed expression>}, replacing all occurences of
592     \lam{E} with \lam{(+)}. In the \lam{<transformed expression>}, the This gives us the replacement expression:
593     \lam{λx.(+) x} (A lambda expression binding \lam{x}, with a body that
594     applies the addition operator to \lam{x}).
595
596     The complete function then becomes:
597     \startlambda
598     (case opcode of Low -> λa1.(+) a1; High -> (-)) a
599     \stoplambda
600
601     Now the transformation no longer applies to the complete first alternative
602     (since it is a lambda expression). It does not apply to the addition
603     operator again, since it is now in function position in an application. It
604     does, however, apply to the application of the addition operator, since
605     that is neither a lambda expression nor does it occur in function
606     position. This means after one more application of the transformation, the
607     function becomes:
608
609     \startlambda
610     (case opcode of Low -> λa1.λb1.(+) a1 b1; High -> (-)) a
611     \stoplambda
612
613     The other alternative is left as an exercise to the reader. The final
614     function, after applying η-abstraction until it does no longer apply is:
615
616     \startlambda 
617     alu :: Bit -> Word -> Word -> Word
618     alu = λopcode.λa.b. (case opcode of
619       Low -> λa1.λb1 (+) a1 b1
620       High -> λa2.λb2 (-) a2 b2) a b
621     \stoplambda
622
623     \subsection{Transformation application}
624       In this chapter we define a number of transformations, but how will we apply
625       these? As stated before, our normal form is reached as soon as no
626       transformation applies anymore. This means our application strategy is to
627       simply apply any transformation that applies, and continuing to do that with
628       the result of each transformation.
629
630       In particular, we define no particular order of transformations. Since
631       transformation order should not influence the resulting normal form,
632       \todo{This is not really true, but would like it to be...} this leaves
633       the implementation free to choose any application order that results in
634       an efficient implementation.
635
636       When applying a single transformation, we try to apply it to every (sub)expression
637       in a function, not just the top level function body. This allows us to
638       keep the transformation descriptions concise and powerful.
639
640     \subsection{Definitions}
641       In the following sections, we will be using a number of functions and
642       notations, which we will define here.
643
644       \subsubsection{Concepts}
645         A \emph{global variable} is any variable (binder) that is bound at the
646         top level of a program, or an external module. A \emph{local variable} is any
647         other variable (\eg, variables local to a function, which can be bound by
648         lambda abstractions, let expressions and pattern matches of case
649         alternatives).  Note that this is a slightly different notion of global versus
650         local than what \small{GHC} uses internally.
651         \defref{global variable} \defref{local variable}
652
653         A \emph{hardware representable} (or just \emph{representable}) type or value
654         is (a value of) a type that we can generate a signal for in hardware. For
655         example, a bit, a vector of bits, a 32 bit unsigned word, etc. Values that are
656         not runtime representable notably include (but are not limited to): Types,
657         dictionaries, functions.
658         \defref{representable}
659
660         A \emph{builtin function} is a function supplied by the Cλash framework, whose
661         implementation is not valid Cλash. The implementation is of course valid
662         Haskell, for simulation, but it is not expressable in Cλash.
663         \defref{builtin function} \defref{user-defined function}
664
665       For these functions, Cλash has a \emph{builtin hardware translation}, so calls
666       to these functions can still be translated. These are functions like
667       \lam{map}, \lam{hwor} and \lam{length}.
668
669       A \emph{user-defined} function is a function for which we do have a Cλash
670       implementation available.
671
672       \subsubsection{Predicates}
673         Here, we define a number of predicates that can be used below to concisely
674         specify conditions.\refdef{global variable}
675
676         \emph{gvar(expr)} is true when \emph{expr} is a variable that references a
677         global variable. It is false when it references a local variable.
678
679         \refdef{local variable}\emph{lvar(expr)} is the complement of \emph{gvar}; it is true when \emph{expr}
680         references a local variable, false when it references a global variable.
681
682         \refdef{representable}\emph{representable(expr)} or \emph{representable(var)} is true when
683         \emph{expr} or \emph{var} is \emph{representable}.
684
685     \subsection[sec:normalization:uniq]{Binder uniqueness}
686       A common problem in transformation systems, is binder uniqueness. When not
687       considering this problem, it is easy to create transformations that mix up
688       bindings and cause name collisions. Take for example, the following core
689       expression:
690
691       \startlambda
692       (λa.λb.λc. a * b * c) x c
693       \stoplambda
694
695       By applying β-reduction (see \in{section}[sec:normalization:beta]) once,
696       we can simplify this expression to:
697
698       \startlambda
699       (λb.λc. x * b * c) c
700       \stoplambda
701
702       Now, we have replaced the \lam{a} binder with a reference to the \lam{x}
703       binder. No harm done here. But note that we see multiple occurences of the
704       \lam{c} binder. The first is a binding occurence, to which the second refers.
705       The last, however refers to \emph{another} instance of \lam{c}, which is
706       bound somewhere outside of this expression. Now, if we would apply beta
707       reduction without taking heed of binder uniqueness, we would get:
708
709       \startlambda
710       λc. x * c * c
711       \stoplambda
712
713       This is obviously not what was supposed to happen! The root of this problem is
714       the reuse of binders: Identical binders can be bound in different scopes, such
715       that only the inner one is \quote{visible} in the inner expression. In the example
716       above, the \lam{c} binder was bound outside of the expression and in the inner
717       lambda expression. Inside that lambda expression, only the inner \lam{c} is
718       visible.
719
720       There are a number of ways to solve this. \small{GHC} has isolated this
721       problem to their binder substitution code, which performs \emph{deshadowing}
722       during its expression traversal. This means that any binding that shadows
723       another binding on a higher level is replaced by a new binder that does not
724       shadow any other binding. This non-shadowing invariant is enough to prevent
725       binder uniqueness problems in \small{GHC}.
726
727       In our transformation system, maintaining this non-shadowing invariant is
728       a bit harder to do (mostly due to implementation issues, the prototype doesn't
729       use \small{GHC}'s subsitution code). Also, the following points can be
730       observed.
731
732       \startitemize
733       \item Deshadowing does not guarantee overall uniqueness. For example, the
734       following (slightly contrived) expression shows the identifier \lam{x} bound in
735       two seperate places (and to different values), even though no shadowing
736       occurs.
737
738       \startlambda
739       (let x = 1 in x) + (let x = 2 in x)
740       \stoplambda
741
742       \item In our normal form (and the resulting \small{VHDL}), all binders
743       (signals) within the same function (entity) will end up in the same
744       scope. To allow this, all binders within the same function should be
745       unique.
746
747       \item When we know that all binders in an expression are unique, moving around
748       or removing a subexpression will never cause any binder conflicts. If we have
749       some way to generate fresh binders, introducing new subexpressions will not
750       cause any problems either. The only way to cause conflicts is thus to
751       duplicate an existing subexpression.
752       \stopitemize
753
754       Given the above, our prototype maintains a unique binder invariant. This
755       means that in any given moment during normalization, all binders \emph{within
756       a single function} must be unique. To achieve this, we apply the following
757       technique.
758
759       \todo{Define fresh binders and unique supplies}
760
761       \startitemize
762       \item Before starting normalization, all binders in the function are made
763       unique. This is done by generating a fresh binder for every binder used. This
764       also replaces binders that did not cause any conflict, but it does ensure that
765       all binders within the function are generated by the same unique supply.
766       \refdef{fresh binder}
767       \item Whenever a new binder must be generated, we generate a fresh binder that
768       is guaranteed to be different from \emph{all binders generated so far}. This
769       can thus never introduce duplication and will maintain the invariant.
770       \item Whenever (a part of) an expression is duplicated (for example when
771       inlining), all binders in the expression are replaced with fresh binders
772       (using the same method as at the start of normalization). These fresh binders
773       can never introduce duplication, so this will maintain the invariant.
774       \item Whenever we move part of an expression around within the function, there
775       is no need to do anything special. There is obviously no way to introduce
776       duplication by moving expressions around. Since we know that each of the
777       binders is already unique, there is no way to introduce (incorrect) shadowing
778       either.
779       \stopitemize
780
781   \section{Transform passes}
782     In this section we describe the actual transforms.
783
784     Each transformation will be described informally first, explaining
785     the need for and goal of the transformation. Then, we will formally define
786     the transformation using the syntax introduced in
787     \in{section}[sec:normalization:transformation].
788
789     \subsection{General cleanup}
790       These transformations are general cleanup transformations, that aim to
791       make expressions simpler. These transformations usually clean up the
792        mess left behind by other transformations or clean up expressions to
793        expose new transformation opportunities for other transformations.
794
795        Most of these transformations are standard optimizations in other
796        compilers as well. However, in our compiler, most of these are not just
797        optimizations, but they are required to get our program into intended
798        normal form.
799
800         \placeintermezzo{}{
801           \startframedtext[width=8cm,background=box,frame=no]
802           \startalignment[center]
803             {\tfa Substitution notation}
804           \stopalignment
805           \blank[medium]
806
807           In some of the transformations in this chapter, we need to perform
808           substitution on an expression. Substitution means replacing every
809           occurence of some expression (usually a variable reference) with
810           another expression.
811
812           There have been a lot of different notations used in literature for
813           specifying substitution. The notation that will be used in this report
814           is the following:
815
816           \startlambda
817             E[A=>B]
818           \stoplambda
819
820           This means expression \lam{E} with all occurences of \lam{A} replaced
821           with \lam{B}.
822           \stopframedtext
823         }
824
825       \defref{beta-reduction}
826       \subsubsection[sec:normalization:beta]{β-reduction}
827         β-reduction is a well known transformation from lambda calculus, where it is
828         the main reduction step. It reduces applications of lambda abstractions,
829         removing both the lambda abstraction and the application.
830
831         In our transformation system, this step helps to remove unwanted lambda
832         abstractions (basically all but the ones at the top level). Other
833         transformations (application propagation, non-representable inlining) make
834         sure that most lambda abstractions will eventually be reducable by
835         β-reduction.
836
837         Note that β-reduction also works on type lambda abstractions and type
838         applications as well. This means the substitution below also works on
839         type variables, in the case that the binder is a type variable and teh
840         expression applied to is a type.
841
842         \starttrans
843         (λx.E) M
844         -----------------
845         E[x=>M]
846         \stoptrans
847
848         % And an example
849         \startbuffer[from]
850         (λa. 2 * a) (2 * b)
851         \stopbuffer
852
853         \startbuffer[to]
854         2 * (2 * b)
855         \stopbuffer
856
857         \transexample{beta}{β-reduction}{from}{to}
858
859         \startbuffer[from]
860         (λt.λa::t. a) @Int
861         \stopbuffer
862
863         \startbuffer[to]
864         (λa::Int. a)
865         \stopbuffer
866
867         \transexample{beta-type}{β-reduction for type abstractions}{from}{to}
868        
869       \subsubsection{Empty let removal}
870         This transformation is simple: It removes recursive lets that have no bindings
871         (which usually occurs when unused let binding removal removes the last
872         binding from it).
873
874         Note that there is no need to define this transformation for
875         non-recursive lets, since they always contain exactly one binding.
876
877         \starttrans
878         letrec in M
879         --------------
880         M
881         \stoptrans
882
883         \todo{Example}
884
885       \subsubsection[sec:normalization:simplelet]{Simple let binding removal}
886         This transformation inlines simple let bindings, that bind some
887         binder to some other binder instead of a more complex expression (\ie
888         a = b).
889
890         This transformation is not needed to get an expression into intended
891         normal form (since these bindings are part of the intended normal
892         form), but makes the resulting \small{VHDL} a lot shorter.
893         
894         \starttrans
895         letrec
896           a0 = E0
897           \vdots
898           ai = b
899           \vdots
900           an = En
901         in
902           M
903         -----------------------------  \lam{b} is a variable reference
904         letrec                         \lam{ai} ≠ \lam{b}
905           a0 = E0 [ai=>b]
906           \vdots
907           ai-1 = Ei-1 [ai=>b]
908           ai+1 = Ei+1 [ai=>b]
909           \vdots
910           an = En [ai=>b]
911         in
912           M[ai=>b]
913         \stoptrans
914
915         \todo{example}
916
917       \subsubsection{Unused let binding removal}
918         This transformation removes let bindings that are never used.
919         Occasionally, \GHC's desugarer introduces some unused let bindings.
920
921         This normalization pass should really be unneeded to get into intended normal form
922         (since unused bindings are not forbidden by the normal form), but in practice
923         the desugarer or simplifier emits some unused bindings that cannot be
924         normalized (e.g., calls to a \type{PatError}\todo{Check this name}). Also,
925         this transformation makes the resulting \small{VHDL} a lot shorter.
926
927         \todo{Don't use old-style numerals in transformations}
928         \starttrans
929         letrec
930           a0 = E0
931           \vdots
932           ai = Ei
933           \vdots
934           an = En
935         in
936           M                             \lam{ai} does not occur free in \lam{M}
937         ----------------------------    \forall j, 0 ≤ j ≤ n, j ≠ i (\lam{ai} does not occur free in \lam{Ej})
938         letrec
939           a0 = E0
940           \vdots
941           ai-1 = Ei-1
942           ai+1 = Ei+1
943           \vdots
944           an = En
945         in
946           M
947         \stoptrans
948
949         \todo{Example}
950
951       \subsubsection{Cast propagation / simplification}
952         This transform pushes casts down into the expression as far as possible.
953         Since its exact role and need is not clear yet, this transformation is
954         not yet specified.
955
956         \todo{Cast propagation}
957
958       \subsubsection{Top level binding inlining}
959         This transform takes simple top level bindings generated by the
960         \small{GHC} compiler. \small{GHC} sometimes generates very simple
961         \quote{wrapper} bindings, which are bound to just a variable
962         reference, or a partial application to constants or other variable
963         references.
964
965         Note that this transformation is completely optional. It is not
966         required to get any function into intended normal form, but it does help making
967         the resulting VHDL output easier to read (since it removes a bunch of
968         components that are really boring).
969
970         This transform takes any top level binding generated by the compiler,
971         whose normalized form contains only a single let binding.
972
973         \starttrans
974         x = λa0 ... λan.let y = E in y
975         ~
976         x
977         --------------------------------------         \lam{x} is generated by the compiler
978         λa0 ... λan.let y = E in y
979         \stoptrans
980
981         \startbuffer[from]
982         (+) :: Word -> Word -> Word
983         (+) = GHC.Num.(+) @Word \$dNum
984         ~
985         (+) a b
986         \stopbuffer
987         \startbuffer[to]
988         GHC.Num.(+) @ Alu.Word \$dNum a b
989         \stopbuffer
990
991         \transexample{toplevelinline}{Top level binding inlining}{from}{to}
992        
993         \in{Example}[ex:trans:toplevelinline] shows a typical application of
994         the addition operator generated by \GHC. The type and dictionary
995         arguments used here are described in
996         \in{Section}[section:prototype:polymorphism].
997
998         Without this transformation, there would be a \lam{(+)} entity
999         in the \VHDL which would just add its inputs. This generates a
1000         lot of overhead in the \VHDL, which is particularly annoying
1001         when browsing the generated RTL schematic (especially since most
1002         non-alphanumerics, like all characters in \lam{(+)}, are not
1003         allowed in \VHDL architecture names\footnote{Technically, it is
1004         allowed to use non-alphanumerics when using extended
1005         identifiers, but it seems that none of the tooling likes
1006         extended identifiers in filenames, so it effectively doesn't
1007         work.}, so the entity would be called \quote{w7aA7f} or
1008         something similarly unreadable and autogenerated).
1009
1010     \subsection{Program structure}
1011       These transformations are aimed at normalizing the overall structure
1012       into the intended form. This means ensuring there is a lambda abstraction
1013       at the top for every argument (input port or current state), putting all
1014       of the other value definitions in let bindings and making the final
1015       return value a simple variable reference.
1016
1017       \subsubsection[sec:normalization:eta]{η-abstraction}
1018         This transformation makes sure that all arguments of a function-typed
1019         expression are named, by introducing lambda expressions. When combined with
1020         β-reduction and non-representable binding inlining, all function-typed
1021         expressions should be lambda abstractions or global identifiers.
1022
1023         \starttrans
1024         E                 \lam{E :: a -> b}
1025         --------------    \lam{E} is not the first argument of an application.
1026         λx.E x            \lam{E} is not a lambda abstraction.
1027                           \lam{x} is a variable that does not occur free in \lam{E}.
1028         \stoptrans
1029
1030         \startbuffer[from]
1031         foo = λa.case a of 
1032           True -> λb.mul b b
1033           False -> id
1034         \stopbuffer
1035
1036         \startbuffer[to]
1037         foo = λa.λx.(case a of 
1038             True -> λb.mul b b
1039             False -> λy.id y) x
1040         \stopbuffer
1041
1042         \transexample{eta}{η-abstraction}{from}{to}
1043
1044       \subsubsection[sec:normalization:appprop]{Application propagation}
1045         This transformation is meant to propagate application expressions downwards
1046         into expressions as far as possible. This allows partial applications inside
1047         expressions to become fully applied and exposes new transformation
1048         opportunities for other transformations (like β-reduction and
1049         specialization).
1050
1051         Since all binders in our expression are unique (see
1052         \in{section}[sec:normalization:uniq]), there is no risk that we will
1053         introduce unintended shadowing by moving an expression into a lower
1054         scope. Also, since only move expression into smaller scopes (down into
1055         our expression), there is no risk of moving a variable reference out
1056         of the scope in which it is defined.
1057
1058         \starttrans
1059         (letrec binds in E) M
1060         ------------------------
1061         letrec binds in E M
1062         \stoptrans
1063
1064         % And an example
1065         \startbuffer[from]
1066         ( letrec
1067             val = 1
1068           in 
1069             add val
1070         ) 3
1071         \stopbuffer
1072
1073         \startbuffer[to]
1074         letrec
1075           val = 1
1076         in 
1077           add val 3
1078         \stopbuffer
1079
1080         \transexample{appproplet}{Application propagation for a let expression}{from}{to}
1081
1082         \starttrans
1083         (case x of
1084           p1 -> E1
1085           \vdots
1086           pn -> En) M
1087         -----------------
1088         case x of
1089           p1 -> E1 M
1090           \vdots
1091           pn -> En M
1092         \stoptrans
1093
1094         % And an example
1095         \startbuffer[from]
1096         ( case x of 
1097             True -> id
1098             False -> neg
1099         ) 1
1100         \stopbuffer
1101
1102         \startbuffer[to]
1103         case x of 
1104           True -> id 1
1105           False -> neg 1
1106         \stopbuffer
1107
1108         \transexample{apppropcase}{Application propagation for a case expression}{from}{to}
1109
1110       \subsubsection[sec:normalization:letrecurse]{Let recursification}
1111         This transformation makes all non-recursive lets recursive. In the
1112         end, we want a single recursive let in our normalized program, so all
1113         non-recursive lets can be converted. This also makes other
1114         transformations simpler: They can simply assume all lets are
1115         recursive.
1116
1117         \starttrans
1118         let
1119           a = E
1120         in
1121           M
1122         ------------------------------------------
1123         letrec
1124           a = E
1125         in
1126           M
1127         \stoptrans
1128
1129       \subsubsection{Let flattening}
1130         This transformation puts nested lets in the same scope, by lifting the
1131         binding(s) of the inner let into the outer let. Eventually, this will
1132         cause all let bindings to appear in the same scope.
1133
1134         This transformation only applies to recursive lets, since all
1135         non-recursive lets will be made recursive (see
1136         \in{section}[sec:normalization:letrecurse]).
1137
1138         Since we are joining two scopes together, there is no risk of moving a
1139         variable reference out of the scope where it is defined.
1140
1141         \starttrans
1142         letrec 
1143           a0 = E0
1144           \vdots
1145           ai = (letrec bindings in M)
1146           \vdots
1147           an = En
1148         in
1149           N
1150         ------------------------------------------
1151         letrec
1152           a0 = E0
1153           \vdots
1154           ai = M
1155           \vdots
1156           an = En
1157           bindings
1158         in
1159           N
1160         \stoptrans
1161
1162         \startbuffer[from]
1163         letrec
1164           a = 1
1165           b = letrec
1166             x = a
1167             y = c
1168           in
1169             x + y
1170           c = 2
1171         in
1172           b
1173         \stopbuffer
1174         \startbuffer[to]
1175         letrec
1176           a = 1
1177           b = x + y
1178           c = 2
1179           x = a
1180           y = c
1181         in
1182           b
1183         \stopbuffer
1184
1185         \transexample{letflat}{Let flattening}{from}{to}
1186
1187       \subsubsection{Return value simplification}
1188         This transformation ensures that the return value of a function is always a
1189         simple local variable reference.
1190
1191         Currently implemented using lambda simplification, let simplification, and
1192         top simplification. Should change into something like the following, which
1193         works only on the result of a function instead of any subexpression. This is
1194         achieved by the contexts, like \lam{x = E}, though this is strictly not
1195         correct (you could read this as "if there is any function \lam{x} that binds
1196         \lam{E}, any \lam{E} can be transformed, while we only mean the \lam{E} that
1197         is bound by \lam{x}. This might need some extra notes or something).
1198
1199         Note that the return value is not simplified if its not representable.
1200         Otherwise, this would cause a direct loop with the inlining of
1201         unrepresentable bindings. If the return value is not
1202         representable because it has a function type, η-abstraction should
1203         make sure that this transformation will eventually apply. If the value
1204         is not representable for other reasons, the function result itself is
1205         not representable, meaning this function is not translatable anyway.
1206
1207         \starttrans
1208         x = E                            \lam{E} is representable
1209         ~                                \lam{E} is not a lambda abstraction
1210         E                                \lam{E} is not a let expression
1211         ---------------------------      \lam{E} is not a local variable reference
1212         letrec x = E in x
1213         \stoptrans
1214
1215         \starttrans
1216         x = λv0 ... λvn.E
1217         ~                                \lam{E} is representable
1218         E                                \lam{E} is not a let expression
1219         ---------------------------      \lam{E} is not a local variable reference
1220         letrec x = E in x
1221         \stoptrans
1222
1223         \starttrans
1224         x = λv0 ... λvn.let ... in E
1225         ~                                \lam{E} is representable
1226         E                                \lam{E} is not a local variable reference
1227         -----------------------------
1228         letrec x = E in x
1229         \stoptrans
1230
1231         \startbuffer[from]
1232         x = add 1 2
1233         \stopbuffer
1234
1235         \startbuffer[to]
1236         x = letrec x = add 1 2 in x
1237         \stopbuffer
1238
1239         \transexample{retvalsimpl}{Return value simplification}{from}{to}
1240         
1241         \todo{More examples}
1242
1243     \subsection[sec:normalization:argsimpl]{Representable arguments simplification}
1244       This section contains just a single transformation that deals with
1245       representable arguments in applications. Non-representable arguments are
1246       handled by the transformations in
1247       \in{section}[sec:normalization:nonrep]. 
1248       
1249       This transformation ensures that all representable arguments will become
1250       references to local variables. This ensures they will become references
1251       to local signals in the resulting \small{VHDL}, which is required due to
1252       limitations in the component instantiation code in \VHDL (one can only
1253       assign a signal or constant to an input port). By ensuring that all
1254       arguments are always simple variable references, we always have a signal
1255       available to map to the input ports.
1256
1257       To reduce a complex expression to a simple variable reference, we create
1258       a new let expression around the application, which binds the complex
1259       expression to a new variable. The original function is then applied to
1260       this variable.
1261
1262       \refdef{global variable}
1263       Note that references to \emph{global variables} (like a top level
1264       function without arguments, but also an argumentless dataconstructors
1265       like \lam{True}) are also simplified. Only local variables generate
1266       signals in the resulting architecture. Even though argumentless
1267       dataconstructors generate constants in generated \VHDL code and could be
1268       mapped to an input port directly, they are still simplified to make the
1269       normal form more regular.
1270
1271       \refdef{representable}
1272       \starttrans
1273       M N
1274       --------------------    \lam{N} is representable
1275       letrec x = N in M x     \lam{N} is not a local variable reference
1276       \stoptrans
1277       \refdef{local variable}
1278
1279       \startbuffer[from]
1280       add (add a 1) 1
1281       \stopbuffer
1282
1283       \startbuffer[to]
1284       letrec x = add a 1 in add x 1
1285       \stopbuffer
1286
1287       \transexample{argsimpl}{Argument simplification}{from}{to}
1288
1289     \subsection[sec:normalization:builtins]{Builtin functions}
1290       This section deals with (arguments to) builtin functions.  In the
1291       intended normal form definition\refdef{intended normal form definition}
1292       we can see that there are three sorts of arguments a builtin function
1293       can receive.
1294       
1295       \startitemize[KR]
1296         \item A representable local variable reference. This is the most
1297         common argument to any function. The argument simplification
1298         transformation described in \in{section}[sec:normalization:argsimpl]
1299         makes sure that \emph{any} representable argument to \emph{any}
1300         function (including builtin functions) is turned into a local variable
1301         reference.
1302         \item (A partial application of) a top level function (either builtin on
1303         user-defined). The function extraction transformation described in
1304         this section takes care of turning every functiontyped argument into
1305         (a partial application of) a top level function.
1306         \item Any expression that is not representable and does not have a
1307         function type. Since these can be any expression, there is no
1308         transformation needed. Note that this category is exactly all
1309         expressions that are not transformed by the transformations for the
1310         previous two categories. This means that \emph{any} core expression
1311         that is used as an argument to a builtin function will be either
1312         transformed into one of the above categories, or end up in this
1313         categorie. In any case, the result is in normal form.
1314       \stopitemize
1315
1316       As noted, the argument simplification will handle any representable
1317       arguments to a builtin function. The following transformation is needed
1318       to handle non-representable arguments with a function type, all other
1319       non-representable arguments don't need any special handling.
1320
1321       \subsubsection[sec:normalization:funextract]{Function extraction}
1322         This transform deals with function-typed arguments to builtin
1323         functions. 
1324         Since builtin functions cannot be specialized (see
1325         \in{section}[sec:normalization:specialize]) to remove the arguments,
1326         these arguments are extracted into a new global function instead. In
1327         other words, we create a new top level function that has exactly the
1328         extracted argument as its body. This greatly simplifies the
1329         translation rules needed for builtin functions, since they only need
1330         to handle (partial applications of) top level functions.
1331
1332         Any free variables occuring in the extracted arguments will become
1333         parameters to the new global function. The original argument is replaced
1334         with a reference to the new function, applied to any free variables from
1335         the original argument.
1336
1337         This transformation is useful when applying higher order builtin functions
1338         like \hs{map} to a lambda abstraction, for example. In this case, the code
1339         that generates \small{VHDL} for \hs{map} only needs to handle top level functions and
1340         partial applications, not any other expression (such as lambda abstractions or
1341         even more complicated expressions).
1342
1343         \starttrans
1344         M N                     \lam{M} is (a partial aplication of) a builtin function.
1345         ---------------------   \lam{f0 ... fn} are all free local variables of \lam{N}
1346         M (x f0 ... fn)         \lam{N :: a -> b}
1347         ~                       \lam{N} is not a (partial application of) a top level function
1348         x = λf0 ... λfn.N
1349         \stoptrans
1350
1351         \startbuffer[from]
1352         addList = λb.λxs.map (λa . add a b) xs
1353         \stopbuffer
1354
1355         \startbuffer[to]
1356         addList = λb.λxs.map (f b) xs
1357         ~
1358         f = λb.λa.add a b
1359         \stopbuffer
1360
1361         \transexample{funextract}{Function extraction}{from}{to}
1362
1363         Note that the function \lam{f} will still need normalization after
1364         this.
1365
1366     \subsection{Case normalisation}
1367       \subsubsection{Scrutinee simplification}
1368         This transform ensures that the scrutinee of a case expression is always
1369         a simple variable reference.
1370
1371         \starttrans
1372         case E of
1373           alts
1374         -----------------        \lam{E} is not a local variable reference
1375         letrec x = E in 
1376           case E of
1377             alts
1378         \stoptrans
1379
1380         \startbuffer[from]
1381         case (foo a) of
1382           True -> a
1383           False -> b
1384         \stopbuffer
1385
1386         \startbuffer[to]
1387         letrec x = foo a in
1388           case x of
1389             True -> a
1390             False -> b
1391         \stopbuffer
1392
1393         \transexample{letflat}{Case normalisation}{from}{to}
1394
1395
1396       \subsubsection{Case simplification}
1397         This transformation ensures that all case expressions become normal form. This
1398         means they will become one of:
1399         \startitemize
1400         \item An extractor case with a single alternative that picks a single field
1401         from a datatype, \eg \lam{case x of (a, b) -> a}.
1402         \item A selector case with multiple alternatives and only wild binders, that
1403         makes a choice between expressions based on the constructor of another
1404         expression, \eg \lam{case x of Low -> a; High -> b}.
1405         \stopitemize
1406         
1407         \defref{wild binder}
1408         \starttrans
1409         case E of
1410           C0 v0,0 ... v0,m -> E0
1411           \vdots
1412           Cn vn,0 ... vn,m -> En
1413         --------------------------------------------------- \forall i \forall j, 0 ≤ i ≤ n, 0 ≤ i < m (\lam{wi,j} is a wild (unused) binder)
1414         letrec
1415           v0,0 = case E of C0 v0,0 .. v0,m -> v0,0
1416           \vdots
1417           v0,m = case E of C0 v0,0 .. v0,m -> v0,m
1418           \vdots
1419           vn,m = case E of Cn vn,0 .. vn,m -> vn,m
1420           x0 = E0
1421           \vdots
1422           xn = En
1423         in
1424           case E of
1425             C0 w0,0 ... w0,m -> x0
1426             \vdots
1427             Cn wn,0 ... wn,m -> xn
1428         \stoptrans
1429         \todo{Check the subscripts of this transformation}
1430
1431         Note that this transformation applies to case statements with any
1432         scrutinee. If the scrutinee is a complex expression, this might result
1433         in duplicate hardware. An extra condition to only apply this
1434         transformation when the scrutinee is already simple (effectively
1435         causing this transformation to be only applied after the scrutinee
1436         simplification transformation) might be in order. 
1437
1438         \fxnote{This transformation specified like this is complicated and misses
1439         conditions to prevent looping with itself. Perhaps it should be split here for
1440         discussion?}
1441
1442         \startbuffer[from]
1443         case a of
1444           True -> add b 1
1445           False -> add b 2
1446         \stopbuffer
1447
1448         \startbuffer[to]
1449         letnonrec
1450           x0 = add b 1
1451           x1 = add b 2
1452         in
1453           case a of
1454             True -> x0
1455             False -> x1
1456         \stopbuffer
1457
1458         \transexample{selcasesimpl}{Selector case simplification}{from}{to}
1459
1460         \startbuffer[from]
1461         case a of
1462           (,) b c -> add b c
1463         \stopbuffer
1464         \startbuffer[to]
1465         letrec
1466           b = case a of (,) b c -> b
1467           c = case a of (,) b c -> c
1468           x0 = add b c
1469         in
1470           case a of
1471             (,) w0 w1 -> x0
1472         \stopbuffer
1473
1474         \transexample{excasesimpl}{Extractor case simplification}{from}{to}
1475
1476         \refdef{selector case}
1477         In \in{example}[ex:trans:excasesimpl] the case expression is expanded
1478         into multiple case expressions, including a pretty useless expression
1479         (that is neither a selector or extractor case). This case can be
1480         removed by the Case removal transformation in
1481         \in{section}[sec:transformation:caseremoval].
1482
1483       \subsubsection[sec:transformation:caseremoval]{Case removal}
1484         This transform removes any case statements with a single alternative and
1485         only wild binders.
1486
1487         These "useless" case statements are usually leftovers from case simplification
1488         on extractor case (see the previous example).
1489
1490         \starttrans
1491         case x of
1492           C v0 ... vm -> E
1493         ----------------------     \lam{\forall i, 0 ≤ i ≤ m} (\lam{vi} does not occur free in E)
1494         E
1495         \stoptrans
1496
1497         \startbuffer[from]
1498         case a of
1499           (,) w0 w1 -> x0
1500         \stopbuffer
1501
1502         \startbuffer[to]
1503         x0
1504         \stopbuffer
1505
1506         \transexample{caserem}{Case removal}{from}{to}
1507
1508     \subsection[sec:normalization:nonrep]{Removing unrepresentable values}
1509       The transformations in this section are aimed at making all the
1510       values used in our expression representable. There are two main
1511       transformations that are applied to \emph{all} unrepresentable let
1512       bindings and function arguments. These are meant to address three
1513       different kinds of unrepresentable values: Polymorphic values, higher
1514       order values and literals. The transformation are described generically:
1515       They apply to all non-representable values. However, non-representable
1516       values that don't fall into one of these three categories will be moved
1517       around by these transformations but are unlikely to completely
1518       disappear. They usually mean the program was not valid in the first
1519       place, because unsupported types were used (for example, a program using
1520       strings).
1521      
1522       Each of these three categories will be detailed below, followed by the
1523       actual transformations.
1524
1525       \subsubsection{Removing Polymorphism}
1526         As noted in \in{section}[sec:prototype:polymporphism],
1527         polymorphism is made explicit in Core through type and
1528         dictionary arguments. To remove the polymorphism from a
1529         function, we can simply specialize the polymorphic function for
1530         the particular type applied to it. The same goes for dictionary
1531         arguments. To remove polymorphism from let bound values, we
1532         simply inline the let bindings that have a polymorphic type,
1533         which should (eventually) make sure that the polymorphic
1534         expression is applied to a type and/or dictionary, which can
1535         then be removed by β-reduction (\in{section}[sec:normalization:beta]).
1536
1537         Since both type and dictionary arguments are not representable,
1538         \refdef{representable}
1539         the non-representable argument specialization and
1540         non-representable let binding inlining transformations below
1541         take care of exactly this.
1542
1543         There is one case where polymorphism cannot be completely
1544         removed: Builtin functions are still allowed to be polymorphic
1545         (Since we have no function body that we could properly
1546         specialize). However, the code that generates \VHDL for builtin
1547         functions knows how to handle this, so this is not a problem.
1548
1549       \subsubsection{Defunctionalization}
1550         These transformations remove higher order expressions from our
1551         program, making all values first-order.
1552       
1553         Higher order values are always introduced by lambda abstractions, none
1554         of the other Core expression elements can introduce a function type.
1555         However, other expressions can \emph{have} a function type, when they
1556         have a lambda expression in their body. 
1557         
1558         For example, the following expression is a higher order expression
1559         that is not a lambda expression itself:
1560         
1561         \refdef{id function}
1562         \startlambda
1563           case x of
1564             High -> id
1565             Low -> λx.x
1566         \stoplambda
1567
1568         The reference to the \lam{id} function shows that we can introduce a
1569         higher order expression in our program without using a lambda
1570         expression directly. However, inside the definition of the \lam{id}
1571         function, we can be sure that a lambda expression is present.
1572         
1573         Looking closely at the definition of our normal form in
1574         \in{section}[sec:normalization:intendednormalform], we can see that
1575         there are three possibilities for higher order values to appear in our
1576         intended normal form:
1577
1578         \startitemize[KR]
1579           \item[item:toplambda] Lambda abstractions can appear at the highest level of a
1580           top level function. These lambda abstractions introduce the
1581           arguments (input ports / current state) of the function.
1582           \item[item:builtinarg] (Partial applications of) top level functions can appear as an
1583           argument to a builtin function.
1584           \item[item:completeapp] (Partial applications of) top level functions can appear in
1585           function position of an application. Since a partial application
1586           cannot appear anywhere else (except as builtin function arguments),
1587           all partial applications are applied, meaning that all applications
1588           will become complete applications. However, since application of
1589           arguments happens one by one, in the expression:
1590           \startlambda
1591             f 1 2
1592           \stoplambda
1593           the subexpression \lam{f 1} has a function type. But this is
1594           allowed, since it is inside a complete application.
1595         \stopitemize
1596
1597         We will take a typical function with some higher order values as an
1598         example. The following function takes two arguments: a \lam{Bit} and a
1599         list of numbers. Depending on the first argument, each number in the
1600         list is doubled, or the list is returned unmodified. For the sake of
1601         the example, no polymorphism is shown. In reality, at least map would
1602         be polymorphic.
1603
1604         \startlambda
1605         λy.let double = λx. x + x in
1606              case y of
1607                 Low -> map double
1608                 High -> λz. z
1609         \stoplambda
1610
1611         This example shows a number of higher order values that we cannot
1612         translate to \VHDL directly. The \lam{double} binder bound in the let
1613         expression has a function type, as well as both of the alternatives of
1614         the case expression. The first alternative is a partial application of
1615         the \lam{map} builtin function, whereas the second alternative is a
1616         lambda abstraction.
1617
1618         To reduce all higher order values to one of the above items, a number
1619         of transformations we've already seen are used. The η-abstraction
1620         transformation from \in{section}[sec:normalization:eta] ensures all
1621         function arguments are introduced by lambda abstraction on the highest
1622         level of a function. These lambda arguments are allowed because of
1623         \in{item}[item:toplambda] above. After η-abstraction, our example
1624         becomes a bit bigger:
1625
1626         \startlambda
1627         λy.λq.(let double = λx. x + x in
1628                  case y of
1629                    Low -> map double
1630                    High -> λz. z
1631               ) q
1632         \stoplambda
1633
1634         η-abstraction also introduces extra applications (the application of
1635         the let expression to \lam{q} in the above example). These
1636         applications can then propagated down by the application propagation
1637         transformation (\in{section}[sec:normalization:appprop]). In our
1638         example, the \lam{q} and \lam{r} variable will be propagated into the
1639         let expression and then into the case expression:
1640
1641         \startlambda
1642         λy.λq.let double = λx. x + x in
1643                 case y of
1644                   Low -> map double q
1645                   High -> (λz. z) q
1646         \stoplambda
1647         
1648         This propagation makes higher order values become applied (in
1649         particular both of the alternatives of the case now have a
1650         representable type. Completely applied top level functions (like the
1651         first alternative) are now no longer invalid (they fall under
1652         \in{item}[item:completeapp] above). (Completely) applied lambda
1653         abstractions can be removed by β-abstraction. For our example,
1654         applying β-abstraction results in the following:
1655
1656         \startlambda
1657         λy.λq.let double = λx. x + x in
1658                 case y of
1659                   Low -> map double q
1660                   High -> q
1661         \stoplambda
1662
1663         As you can see in our example, all of this moves applications towards
1664         the higher order values, but misses higher order functions bound by
1665         let expressions. The applications cannot be moved towards these values
1666         (since they can be used in multiple places), so the values will have
1667         to be moved towards the applications. This is achieved by inlining all
1668         higher order values bound by let applications, by the
1669         non-representable binding inlining transformation below. When applying
1670         it to our example, we get the following:
1671         
1672         \startlambda
1673         λy.λq.case y of
1674                 Low -> map (λx. x + x) q
1675                 High -> q
1676         \stoplambda
1677
1678         We've nearly eliminated all unsupported higher order values from this
1679         expressions. The one that's remaining is the first argument to the
1680         \lam{map} function. Having higher order arguments to a builtin
1681         function like \lam{map} is allowed in the intended normal form, but
1682         only if the argument is a (partial application) of a top level
1683         function. This is easily done by introducing a new top level function
1684         and put the lambda abstraction inside. This is done by the function
1685         extraction transformation from
1686         \in{section}[sec:normalization:funextract].
1687
1688         \startlambda
1689         λy.λq.case y of
1690                 Low -> map func q
1691                 High -> q
1692         \stoplambda
1693
1694         This also introduces a new function, that we have called \lam{func}:
1695
1696         \startlambda
1697         func = λx. x + x
1698         \stoplambda
1699
1700         Note that this does not actually remove the lambda, but now it is a
1701         lambda at the highest level of a function, which is allowed in the
1702         intended normal form.
1703
1704         There is one case that has not been discussed yet. What if the
1705         \lam{map} function in the example above was not a builtin function
1706         but a user-defined function? Then extracting the lambda expression
1707         into a new function would not be enough, since user-defined functions
1708         can never have higher order arguments. For example, the following
1709         expression shows an example:
1710
1711         \startlambda
1712         twice :: (Word -> Word) -> Word -> Word
1713         twice = λf.λa.f (f a)
1714
1715         main = λa.app (λx. x + x) a
1716         \stoplambda
1717
1718         This example shows a function \lam{twice} that takes a function as a
1719         first argument and applies that function twice to the second argument.
1720         Again, we've made the function monomorphic for clarity, even though
1721         this function would be a lot more useful if it was polymorphic. The
1722         function \lam{main} uses \lam{twice} to apply a lambda epression twice.
1723
1724         When faced with a user defined function, a body is available for that
1725         function. This means we could create a specialized version of the
1726         function that only works for this particular higher order argument
1727         (\ie, we can just remove the argument and call the specialized
1728         function without the argument). This transformation is detailed below.
1729         Applying this transformation to the example gives:
1730
1731         \startlambda
1732         twice' :: Word -> Word
1733         twice' = λb.(λf.λa.f (f a)) (λx. x + x) b
1734
1735         main = λa.app' a
1736         \stoplambda
1737
1738         The \lam{main} function is now in normal form, since the only higher
1739         order value there is the top level lambda expression. The new
1740         \lam{twice'} function is a bit complex, but the entire original body of
1741         the original \lam{twice} function is wrapped in a lambda abstraction
1742         and applied to the argument we've specialized for (\lam{λx. x + x})
1743         and the other arguments. This complex expression can fortunately be
1744         effectively reduced by repeatedly applying β-reduction: 
1745
1746         \startlambda
1747         twice' :: Word -> Word
1748         twice' = λb.(b + b) + (b + b)
1749         \stoplambda
1750
1751         This example also shows that the resulting normal form might not be as
1752         efficient as we might hope it to be (it is calculating \lam{(b + b)}
1753         twice). This is discussed in more detail in
1754         \in{section}[sec:normalization:duplicatework].
1755
1756       \subsubsection{Literals}
1757         There are a limited number of literals available in Haskell and Core.
1758         \refdef{enumerated types} When using (enumerating) algebraic
1759         datatypes, a literal is just a reference to the corresponding data
1760         constructor, which has a representable type (the algebraic datatype)
1761         and can be translated directly. This also holds for literals of the
1762         \hs{Bool} Haskell type, which is just an enumerated type.
1763
1764         There is, however, a second type of literal that does not have a
1765         representable type: Integer literals. Cλash supports using integer
1766         literals for all three integer types supported (\hs{SizedWord},
1767         \hs{SizedInt} and \hs{RangedWord}). This is implemented using
1768         Haskell's \hs{Num} typeclass, which offers a \hs{fromInteger} method
1769         that converts any \hs{Integer} to the Cλash datatypes.
1770
1771         When \GHC sees integer literals, it will automatically insert calls to
1772         the \hs{fromInteger} method in the resulting Core expression. For
1773         example, the following expression in Haskell creates a 32 bit unsigned
1774         word with the value 1. The explicit type signature is needed, since
1775         there is no context for \GHC to determine the type from otherwise.
1776
1777         \starthaskell
1778         1 :: SizedWord D32
1779         \stophaskell
1780
1781         This Haskell code results in the following Core expression:
1782
1783         \startlambda
1784         fromInteger @(SizedWord D32) \$dNum (smallInteger 10)
1785         \stoplambda
1786
1787         The literal 10 will have the type \lam{GHC.Prim.Int\#}, which is
1788         converted into an \lam{Integer} by \lam{smallInteger}. Finally, the
1789         \lam{fromInteger} function will finally convert this into a
1790         \lam{SizedWord D32}.
1791
1792         Both the \lam{GHC.Prim.Int\#} and \lam{Integer} types are not
1793         representable, and cannot be translated directly. Fortunately, there
1794         is no need to translate them, since \lam{fromInteger} is a builtin
1795         function that knows how to handle these values. However, this does
1796         require that the \lam{fromInteger} function is directly applied to
1797         these non-representable literal values, otherwise errors will occur.
1798         For example, the following expression is not in the intended normal
1799         form, since one of the let bindings has an unrepresentable type
1800         (\lam{Integer}):
1801
1802         \startlambda
1803         let l = smallInteger 10 in fromInteger @(SizedWord D32) \$dNum l
1804         \stoplambda
1805
1806         By inlining these let-bindings, we can ensure that unrepresentable
1807         literals bound by a let binding end up in an application of the
1808         appropriate builtin function, where they are allowed. Since it is
1809         possible that the application of that function is in a different
1810         function than the definition of the literal value, we will always need
1811         to specialize away any unrepresentable literals that are used as
1812         function arguments. The following two transformations do exactly this.
1813
1814       \subsubsection{Non-representable binding inlining}
1815         This transform inlines let bindings that are bound to a
1816         non-representable value. Since we can never generate a signal
1817         assignment for these bindings (we cannot declare a signal assignment
1818         with a non-representable type, for obvious reasons), we have no choice
1819         but to inline the binding to remove it.
1820
1821         As we have seen in the previous sections, inlining these bindings
1822         solves (part of) the polymorphism, higher order values and
1823         unrepresentable literals in an expression.
1824
1825         \starttrans
1826         letrec 
1827           a0 = E0
1828           \vdots
1829           ai = Ei
1830           \vdots
1831           an = En
1832         in
1833           M
1834         --------------------------    \lam{Ei} has a non-representable type.
1835         letrec
1836           a0 = E0 [ai=>Ei] \vdots
1837           ai-1 = Ei-1 [ai=>Ei]
1838           ai+1 = Ei+1 [ai=>Ei]
1839           \vdots
1840           an = En [ai=>Ei]
1841         in
1842           M[ai=>Ei]
1843         \stoptrans
1844
1845         \startbuffer[from]
1846         letrec
1847           a = smallInteger 10
1848           inc = λb -> add b 1
1849           inc' = add 1
1850           x = fromInteger a 
1851         in
1852           inc (inc' x)
1853         \stopbuffer
1854
1855         \startbuffer[to]
1856         letrec
1857           x = fromInteger (smallInteger 10)
1858         in
1859           (λb -> add b 1) (add 1 x)
1860         \stopbuffer
1861
1862         \transexample{nonrepinline}{Nonrepresentable binding inlining}{from}{to}
1863
1864       \subsubsection[sec:normalization:specialize]{Function specialization}
1865         This transform removes arguments to user-defined functions that are
1866         not representable at runtime. This is done by creating a
1867         \emph{specialized} version of the function that only works for one
1868         particular value of that argument (in other words, the argument can be
1869         removed).
1870
1871         Specialization means to create a specialized version of the called
1872         function, with one argument already filled in. As a simple example, in
1873         the following program (this is not actual Core, since it directly uses
1874         a literal with the unrepresentable type \lam{GHC.Prim.Int\#}).
1875
1876         \startlambda
1877         f = λa.λb.a + b
1878         inc = λa.f a 1
1879         \stoplambda
1880
1881         We could specialize the function \lam{f} against the literal argument
1882         1, with the following result:
1883
1884         \startlambda
1885         f' = λa.a + 1
1886         inc = λa.f' a
1887         \stoplambda
1888
1889         In some way, this transformation is similar to β-reduction, but it
1890         operates across function boundaries. It is also similar to
1891         non-representable let binding inlining above, since it sort of
1892         \quote{inlines} an expression into a called function.
1893
1894         Special care must be taken when the argument has any free variables.
1895         If this is the case, the original argument should not be removed
1896         completely, but replaced by all the free variables of the expression.
1897         In this way, the original expression can still be evaluated inside the
1898         new function.
1899
1900         To prevent us from propagating the same argument over and over, a
1901         simple local variable reference is not propagated (since is has
1902         exactly one free variable, itself, we would only replace that argument
1903         with itself).
1904
1905         This shows that any free local variables that are not runtime
1906         representable cannot be brought into normal form by this transform. We
1907         rely on an inlining or β-reduction transformation to replace such a
1908         variable with an expression we can propagate again.
1909
1910         \starttrans
1911         x = E
1912         ~
1913         x Y0 ... Yi ... Yn                               \lam{Yi} is not representable
1914         ---------------------------------------------    \lam{Yi} is not a local variable reference
1915         x' y0 ... yi-1 f0 ...  fm Yi+1 ... Yn            \lam{f0 ... fm} are all free local vars of \lam{Yi}
1916         ~                                                \lam{T0 ... Tn} are the types of \lam{Y0 ... Yn}
1917         x' = λ(y0 :: T0) ... λ(yi-1 :: Ty-1). λf0 ... λfm. λ(yi+1 :: Ty+1) ...  λ(yn :: Tn).       
1918               E y0 ... yi-1 Yi yi+1 ... yn   
1919         \stoptrans
1920
1921         This is a bit of a complex transformation. It transforms an
1922         application of the function \lam{x}, where one of the arguments
1923         (\lam{Y_i}) is not representable. A new
1924         function \lam{x'} is created that wraps the body of the old function.
1925         The body of the new function becomes a number of nested lambda
1926         abstractions, one for each of the original arguments that are left
1927         unchanged.
1928         
1929         The ith argument is replaced with the free variables of
1930         \lam{Y_i}. Note that we reuse the same binders as those used in
1931         \lam{Y_i}, since we can then just use \lam{Y_i} inside the new
1932         function body and have all of the variables it uses be in scope.
1933
1934         The argument that we are specializing for, \lam{Y_i}, is put inside
1935         the new function body. The old function body is applied to it. Since
1936         we use this new function only in place of an application with that
1937         particular argument \lam{Y_i}, behaviour should not change.
1938         
1939         Note that the types of the arguments of our new function are taken
1940         from the types of the \emph{actual} arguments (\lam{T0 ... Tn}). This
1941         means that any polymorphism in the arguments is removed, even when the
1942         corresponding explicit type lambda is not removed
1943         yet.\refdef{type lambda}
1944
1945         \todo{Examples. Perhaps reference the previous sections}
1946
1947
1948   \section{Unsolved problems}
1949     The above system of transformations has been implemented in the prototype
1950     and seems to work well to compile simple and more complex examples of
1951     hardware descriptions. \todo{Ref christiaan?} However, this normalization
1952     system has not seen enough review and work to be complete and work for
1953     every Core expression that is supplied to it. A number of problems
1954     have already been identified and are discussed in this section.
1955
1956     \subsection[sec:normalization:duplicatework]{Work duplication}
1957         A possible problem of β-reduction is that it could duplicate work.
1958         When the expression applied is not a simple variable reference, but
1959         requires calculation and the binder the lambda abstraction binds to
1960         is used more than once, more hardware might be generated than strictly
1961         needed. 
1962
1963         As an example, consider the expression:
1964
1965         \startlambda
1966         (λx. x + x) (a * b)
1967         \stoplambda
1968
1969         When applying β-reduction to this expression, we get:
1970
1971         \startlambda
1972         (a * b) + (a * b)
1973         \stoplambda
1974
1975         which of course calculates \lam{(a * b)} twice.
1976         
1977         A possible solution to this would be to use the following alternative
1978         transformation, which is of course no longer normal β-reduction. The
1979         followin transformation has not been tested in the prototype, but is
1980         given here for future reference:
1981
1982         \starttrans
1983         (λx.E) M
1984         -----------------
1985         letrec x = M in E
1986         \stoptrans
1987         
1988         This doesn't seem like much of an improvement, but it does get rid of
1989         the lambda expression (and the associated higher order value), while
1990         at the same time introducing a new let binding. Since the result of
1991         every application or case expression must be bound by a let expression
1992         in the intended normal form anyway, this is probably not a problem. If
1993         the argument happens to be a variable reference, then simple let
1994         binding removal (\in{section}[sec:normalization:simplelet]) will
1995         remove it, making the result identical to that of the original
1996         β-reduction transformation.
1997
1998         When also applying argument simplification to the above example, we
1999         get the following expression:
2000
2001         \startlambda
2002         let y = (a * b)
2003             z = (a * b)
2004         in y + z
2005         \stoplambda
2006
2007         Looking at this, we could imagine an alternative approach: Create a
2008         transformation that removes let bindings that bind identical values.
2009         In the above expression, the \lam{y} and \lam{z} variables could be
2010         merged together, resulting in the more efficient expression:
2011
2012         \startlambda
2013         let y = (a * b) in y + y
2014         \stoplambda
2015
2016       \subsection{Non-determinism}
2017         As an example, again consider the following expression:
2018
2019         \startlambda
2020         (λx. x + x) (a * b)
2021         \stoplambda
2022
2023         We can apply both β-reduction (\in{section}[sec:normalization:beta])
2024         as well as argument simplification
2025         (\in{section}[sec:normalization:argsimpl]) to this expression.
2026
2027         When applying argument simplification first and then β-reduction, we
2028         get the following expression:
2029
2030         \startlambda
2031         let y = (a * b) in y + y
2032         \stoplambda
2033
2034         When applying β-reduction first and then argument simplification, we
2035         get the following expression:
2036
2037         \startlambda
2038         let y = (a * b)
2039             z = (a * b)
2040         in y + z
2041         \stoplambda
2042
2043         As you can see, this is a different expression. This means that the
2044         order of expressions, does in fact change the resulting normal form,
2045         which is something that we would like to avoid. In this particular
2046         case one of the alternatives is even clearly more efficient, so we
2047         would of course like the more efficient form to be the normal form.
2048
2049         For this particular problem, the solutions for duplication of work
2050         seem from the previous section seem to fix the determinism of our
2051         transformation system as well. However, it is likely that there are
2052         other occurences of this problem.
2053
2054       \subsection{Casts}
2055         We do not fully understand the use of cast expressions in Core, so
2056         there are probably expressions involving cast expressions that cannot
2057         be brought into intended normal form by this transformation system.
2058
2059         The uses of casts in the core system should be investigated more and
2060         transformations will probably need updating to handle them in all
2061         cases.
2062
2063   \section[sec:normalization:properties]{Provable properties}
2064     When looking at the system of transformations outlined above, there are a
2065     number of questions that we can ask ourselves. The main question is of course:
2066     \quote{Does our system work as intended?}. We can split this question into a
2067     number of subquestions:
2068
2069     \startitemize[KR]
2070     \item[q:termination] Does our system \emph{terminate}? Since our system will
2071     keep running as long as transformations apply, there is an obvious risk that
2072     it will keep running indefinitely. This typically happens when one
2073     transformation produces a result that is transformed back to the original
2074     by another transformation, or when one or more transformations keep
2075     expanding some expression.
2076     \item[q:soundness] Is our system \emph{sound}? Since our transformations
2077     continuously modify the expression, there is an obvious risk that the final
2078     normal form will not be equivalent to the original program: Its meaning could
2079     have changed.
2080     \item[q:completeness] Is our system \emph{complete}? Since we have a complex
2081     system of transformations, there is an obvious risk that some expressions will
2082     not end up in our intended normal form, because we forgot some transformation.
2083     In other words: Does our transformation system result in our intended normal
2084     form for all possible inputs?
2085     \item[q:determinism] Is our system \emph{deterministic}? Since we have defined
2086     no particular order in which the transformation should be applied, there is an
2087     obvious risk that different transformation orderings will result in
2088     \emph{different} normal forms. They might still both be intended normal forms
2089     (if our system is \emph{complete}) and describe correct hardware (if our
2090     system is \emph{sound}), so this property is less important than the previous
2091     three: The translator would still function properly without it.
2092     \stopitemize
2093
2094     Unfortunately, the final transformation system has only been
2095     developed in the final part of the research, leaving no more time
2096     for verifying these properties. In fact, it is likely that the
2097     current transformation system still violates some of these
2098     properties in some cases and should be improved (or extra conditions
2099     on the input hardware descriptions should be formulated).
2100
2101     This is most likely the case with the completeness and determinism
2102     properties, perhaps als the termination property. The soundness
2103     property probably holds, since it is easier to manually verify (each
2104     transformation can be reviewed separately).
2105
2106     Even though no complete proofs have been made, some ideas for
2107     possible proof strategies are shown below.
2108
2109     \subsection{Graph representation}
2110       Before looking into how to prove these properties, we'll look at our
2111       transformation system from a graph perspective. The nodes of the graph are
2112       all possible Core expressions. The (directed) edges of the graph are
2113       transformations. When a transformation α applies to an expression \lam{A} to
2114       produce an expression \lam{B}, we add an edge from the node for \lam{A} to the
2115       node for \lam{B}, labeled α.
2116
2117       \startuseMPgraphic{TransformGraph}
2118         save a, b, c, d;
2119
2120         % Nodes
2121         newCircle.a(btex \lam{(λx.λy. (+) x y) 1} etex);
2122         newCircle.b(btex \lam{λy. (+) 1 y} etex);
2123         newCircle.c(btex \lam{(λx.(+) x) 1} etex);
2124         newCircle.d(btex \lam{(+) 1} etex);
2125
2126         b.c = origin;
2127         c.c = b.c + (4cm, 0cm);
2128         a.c = midpoint(b.c, c.c) + (0cm, 4cm);
2129         d.c = midpoint(b.c, c.c) - (0cm, 3cm);
2130
2131         % β-conversion between a and b
2132         ncarc.a(a)(b) "name(bred)";
2133         ObjLabel.a(btex $\xrightarrow[normal]{}{β}$ etex) "labpathname(bred)", "labdir(rt)";
2134         ncarc.b(b)(a) "name(bexp)", "linestyle(dashed withdots)";
2135         ObjLabel.b(btex $\xleftarrow[normal]{}{β}$ etex) "labpathname(bexp)", "labdir(lft)";
2136
2137         % η-conversion between a and c
2138         ncarc.a(a)(c) "name(ered)";
2139         ObjLabel.a(btex $\xrightarrow[normal]{}{η}$ etex) "labpathname(ered)", "labdir(rt)";
2140         ncarc.c(c)(a) "name(eexp)", "linestyle(dashed withdots)";
2141         ObjLabel.c(btex $\xleftarrow[normal]{}{η}$ etex) "labpathname(eexp)", "labdir(lft)";
2142
2143         % η-conversion between b and d
2144         ncarc.b(b)(d) "name(ered)";
2145         ObjLabel.b(btex $\xrightarrow[normal]{}{η}$ etex) "labpathname(ered)", "labdir(rt)";
2146         ncarc.d(d)(b) "name(eexp)", "linestyle(dashed withdots)";
2147         ObjLabel.d(btex $\xleftarrow[normal]{}{η}$ etex) "labpathname(eexp)", "labdir(lft)";
2148
2149         % β-conversion between c and d
2150         ncarc.c(c)(d) "name(bred)";
2151         ObjLabel.c(btex $\xrightarrow[normal]{}{β}$ etex) "labpathname(bred)", "labdir(rt)";
2152         ncarc.d(d)(c) "name(bexp)", "linestyle(dashed withdots)";
2153         ObjLabel.d(btex $\xleftarrow[normal]{}{β}$ etex) "labpathname(bexp)", "labdir(lft)";
2154
2155         % Draw objects and lines
2156         drawObj(a, b, c, d);
2157       \stopuseMPgraphic
2158
2159       \placeexample[right][ex:TransformGraph]{Partial graph of a lambda calculus
2160       system with β and η reduction (solid lines) and expansion (dotted lines).}
2161           \boxedgraphic{TransformGraph}
2162
2163       Of course our graph is unbounded, since we can construct an infinite amount of
2164       Core expressions. Also, there might potentially be multiple edges between two
2165       given nodes (with different labels), though seems unlikely to actually happen
2166       in our system.
2167
2168       See \in{example}[ex:TransformGraph] for the graph representation of a very
2169       simple lambda calculus that contains just the expressions \lam{(λx.λy. (+) x
2170       y) 1}, \lam{λy. (+) 1 y}, \lam{(λx.(+) x) 1} and \lam{(+) 1}. The
2171       transformation system consists of β-reduction and η-reduction (solid edges) or
2172       β-expansion and η-expansion (dotted edges).
2173
2174       \todo{Define β-reduction and η-reduction?}
2175
2176       Note that the normal form of such a system consists of the set of nodes
2177       (expressions) without outgoing edges, since those are the expression to which
2178       no transformation applies anymore. We call this set of nodes the \emph{normal
2179       set}. The set of nodes containing expressions in intended normal
2180       form \refdef{intended normal form} is called the \emph{intended
2181       normal set}.
2182
2183       From such a graph, we can derive some properties easily:
2184       \startitemize[KR]
2185         \item A system will \emph{terminate} if there is no path of infinite length
2186         in the graph (this includes cycles, but can also happen without cycles).
2187         \item Soundness is not easily represented in the graph.
2188         \item A system is \emph{complete} if all of the nodes in the normal set have
2189         the intended normal form. The inverse (that all of the nodes outside of
2190         the normal set are \emph{not} in the intended normal form) is not
2191         strictly required. In other words, our normal set must be a
2192         subset of the intended normal form, but they do not need to be
2193         the same set.
2194         form.
2195         \item A system is deterministic if all paths starting at a particular
2196         node, which end in a node in the normal set, end at the same node.
2197       \stopitemize
2198
2199       When looking at the \in{example}[ex:TransformGraph], we see that the system
2200       terminates for both the reduction and expansion systems (but note that, for
2201       expansion, this is only true because we've limited the possible
2202       expressions.  In comlete lambda calculus, there would be a path from
2203       \lam{(λx.λy. (+) x y) 1} to \lam{(λx.λy.(λz.(+) z) x y) 1} to
2204       \lam{(λx.λy.(λz.(λq.(+) q) z) x y) 1} etc.)
2205
2206       If we would consider the system with both expansion and reduction, there
2207       would no longer be termination either, since there would be cycles all
2208       over the place.
2209
2210       The reduction and expansion systems have a normal set of containing just
2211       \lam{(+) 1} or \lam{(λx.λy. (+) x y) 1} respectively. Since all paths in
2212       either system end up in these normal forms, both systems are \emph{complete}.
2213       Also, since there is only one node in the normal set, it must obviously be
2214       \emph{deterministic} as well.
2215
2216     \todo{Add content to these sections}
2217     \subsection{Termination}
2218       In general, proving termination of an arbitrary program is a very
2219       hard problem. \todo{Ref about arbitrary termination} Fortunately,
2220       we only have to prove termination for our specific transformation
2221       system.
2222
2223       A common approach for these kinds of proofs is to associate a
2224       measure with each possible expression in our system. If we can
2225       show that each transformation strictly decreases this measure
2226       (\ie, the expression transformed to has a lower measure than the
2227       expression transformed from).  \todo{ref about measure-based
2228       termination proofs / analysis}
2229       
2230       A good measure for a system consisting of just β-reduction would
2231       be the number of lambda expressions in the expression. Since every
2232       application of β-reduction removes a lambda abstraction (and there
2233       is always a bounded number of lambda abstractions in every
2234       expression) we can easily see that a transformation system with
2235       just β-reduction will always terminate.
2236
2237       For our complete system, this measure would be fairly complex
2238       (probably the sum of a lot of things). Since the (conditions on)
2239       our transformations are pretty complex, we would need to include
2240       both simple things like the number of let expressions as well as
2241       more complex things like the number of case expressions that are
2242       not yet in normal form.
2243
2244       No real attempt has been made at finding a suitable measure for
2245       our system yet.
2246
2247     \subsection{Soundness}
2248       Soundness is a property that can be proven for each transformation
2249       separately. Since our system only runs separate transformations
2250       sequentially, if each of our transformations leaves the
2251       \emph{meaning} of the expression unchanged, then the entire system
2252       will of course leave the meaning unchanged and is thus
2253       \emph{sound}.
2254
2255       The current prototype has only been verified in an ad-hoc fashion
2256       by inspecting (the code for) each transformation. A more formal
2257       verification would be more appropriate.
2258
2259       To be able to formally show that each transformation properly
2260       preserves the meaning of every expression, we require an exact
2261       definition of the \emph{meaning} of every expression, so we can
2262       compare them. Currently there seems to be no formal definition of
2263       the meaning or semantics of \GHC's core language, only informal
2264       descriptions are available.
2265
2266       It should be possible to have a single formal definition of
2267       meaning for Core for both normal Core compilation by \GHC and for
2268       our compilation to \VHDL. The main difference seems to be that in
2269       hardware every expression is always evaluated, while in software
2270       it is only evaluated if needed, but it should be possible to
2271       assign a meaning to core expressions that assumes neither.
2272       
2273       Since each of the transformations can be applied to any
2274       subexpression as well, there is a constraint on our meaning
2275       definition: The meaning of an expression should depend only on the
2276       meaning of subexpressions, not on the expressions themselves. For
2277       example, the meaning of the application in \lam{f (let x = 4 in
2278       x)} should be the same as the meaning of the application in \lam{f
2279       4}, since the argument subexpression has the same meaning (though
2280       the actual expression is different).
2281       
2282     \subsection{Completeness}
2283       Proving completeness is probably not hard, but it could be a lot
2284       of work. We have seen above that to prove completeness, we must
2285       show that the normal set of our graph representation is a subset
2286       of the intended normal set.
2287
2288       However, it is hard to systematically generate or reason about the
2289       normal set, since it is defined as any nodes to which no
2290       transformation applies. To determine this set, each transformation
2291       must be considered and when a transformation is added, the entire
2292       set should be re-evaluated. This means it is hard to show that
2293       each node in the normal set is also in the intended normal set.
2294       Reasoning about our intended normal set is easier, since we know
2295       how to generate it from its definition. \refdef{intended normal
2296       form definition}.
2297
2298       Fortunately, we can also prove the complement (which is
2299       equivalent, since $A \subseteq B \Leftrightarrow \overline{B}
2300       \subseteq \overline{A}$): Show that the set of nodes not in
2301       intended normal form is a subset of the set of nodes not in normal
2302       form. In other words, show that for every expression that is not
2303       in intended normal form, that there is at least one transformation
2304       that applies to it (since that means it is not in normal form
2305       either and since $A \subseteq C \Leftrightarrow \forall x (x \in A
2306       \rightarrow x \in C)$).
2307
2308       By systematically reviewing the entire Core language definition
2309       along with the intended normal form definition (both of which have
2310       a similar structure), it should be possible to identify all
2311       possible (sets of) core expressions that are not in intended
2312       normal form and identify a transformation that applies to it.
2313       
2314       This approach is especially useful for proving completeness of our
2315       system, since if expressions exist to which none of the
2316       transformations apply (\ie if the system is not yet complete), it
2317       is immediately clear which expressions these are and adding
2318       (or modifying) transformations to fix this should be relatively
2319       easy.
2320
2321       As observed above, applying this approach is a lot of work, since
2322       we need to check every (set of) transformation(s) separately.
2323
2324       \todo{Perhaps do a few steps of the proofs as proof-of-concept}
2325
2326 % vim: set sw=2 sts=2 expandtab: