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