about summary refs log tree commit diff stats
path: root/html/linux/apps/factorial4.subx.html
blob: 223e3ee0ceaf0ed8c0d3e49cf6415c74b7c39c75 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>Mu - linux/apps/factorial4.subx</title>
<meta name="Generator" content="Vim/8.2">
<meta name="plugin-version" content="vim8.1_v2">
<meta name="syntax" content="none">
<meta name="settings" content="number_lines,use_css,pre_wrap,no_foldcolumn,expand_tabs,line_ids,prevent_copy=,use_input_for_pc=fallback">
<meta name="colorscheme" content="minimal-light">
<style>
<!--
pre { white-space: pre-wrap; font-family: monospace; color: #000000; background-color: #ffffd7; }
body { font-size:12pt; font-family: monospace; color: #000000; background-color: #ffffd7; }
a { color:inherit; }
* { font-size:12pt; font-size: 1em; }
.SpecialChar { color: #d70000; }
.subxComment { color: #005faf; }
.subxS1Comment { color: #0000af; }
.LineNr { }
.subxTest { color: #5f8700; }
.subxFunction { color: #af5f00; text-decoration: underline; }
.Constant { color: #008787; }
-->
</style>

<script>
<!--

/* function to open any folds containing a jumped-to line before jumping to it */
function JumpToLine()
{
  var lineNum;
  lineNum = window.location.hash;
  lineNum = lineNum.substr(1); /* strip off '#' */

  if (lineNum.indexOf('L') == -1) {
    lineNum = 'L'+lineNum;
  }
  var lineElem = document.getElementById(lineNum);
  /* Always jump to new location even if the line was hidden inside a fold, or
   * we corrected the raw number to a line ID.
   */
  if (lineElem) {
    lineElem.scrollIntoView(true);
  }
  return true;
}
if ('onhashchange' in window) {
  window.onhashchange = JumpToLine;
}

-->
</script>
</head>
<body onload='JumpToLine();'>
<a href='https://github.com/akkartik/mu/blob/main/linux/apps/factorial4.subx'>https://github.com/akkartik/mu/blob/main/linux/apps/factorial4.subx</a>
<pre id='vimCodeElement'>
<span id="L1" class="LineNr"> 1 </span><span class="subxComment">## compute the factorial of 5, and return the result in the exit code</span>
<span id="L2" class="LineNr"> 2 </span><span class="subxComment">#</span>
<span id="L3" class="LineNr"> 3 </span><span class="subxComment"># Uses syntax sugar for:</span>
<span id="L4" class="LineNr"> 4 </span><span class="subxComment">#   rm32 operands</span>
<span id="L5" class="LineNr"> 5 </span><span class="subxComment">#   function calls</span>
<span id="L6" class="LineNr"> 6 </span><span class="subxComment">#   control flow</span>
<span id="L7" class="LineNr"> 7 </span><span class="subxComment">#</span>
<span id="L8" class="LineNr"> 8 </span><span class="subxComment"># To run:</span>
<span id="L9" class="LineNr"> 9 </span><span class="subxComment">#   $ ./translate_subx init.linux [01]*.subx apps/factorial4.subx</span>
<span id="L10" class="LineNr">10 </span><span class="subxComment">#   $ ./a.elf</span>
<span id="L11" class="LineNr">11 </span><span class="subxComment"># Expected result:</span>
<span id="L12" class="LineNr">12 </span><span class="subxComment">#   $ echo $?</span>
<span id="L13" class="LineNr">13 </span><span class="subxComment">#   120</span>
<span id="L14" class="LineNr">14 </span><span class="subxComment">#</span>
<span id="L15" class="LineNr">15 </span><span class="subxComment"># You can also run the automated test suite:</span>
<span id="L16" class="LineNr">16 </span><span class="subxComment">#   $ ./a.elf test</span>
<span id="L17" class="LineNr">17 </span><span class="subxComment"># Expected output:</span>
<span id="L18" class="LineNr">18 </span><span class="subxComment">#   ........</span>
<span id="L19" class="LineNr">19 </span><span class="subxComment"># Every '.' indicates a passing test. Failing tests get a 'F'.</span>
<span id="L20" class="LineNr">20 </span><span class="subxComment">#</span>
<span id="L21" class="LineNr">21 </span><span class="subxComment"># Compare factorial3.subx</span>
<span id="L22" class="LineNr">22 </span>
<span id="L23" class="LineNr">23 </span>== code
<span id="L24" class="LineNr">24 </span>
<span id="L25" class="LineNr">25 </span><span class="subxFunction">factorial</span>:  <span class="subxComment"># n: int -&gt; _/eax: int</span>
<span id="L26" class="LineNr">26 </span>    <span class="subxS1Comment"># . prologue</span>
<span id="L27" class="LineNr">27 </span>    55/push-ebp
<span id="L28" class="LineNr">28 </span>    89/&lt;- %ebp 4/r32/esp
<span id="L29" class="LineNr">29 </span>    <span class="subxComment"># save registers</span>
<span id="L30" class="LineNr">30 </span>    51/push-ecx
<span id="L31" class="LineNr">31 </span>    <span class="subxComment"># if (n &lt;= 1) return 1</span>
<span id="L32" class="LineNr">32 </span>    81 7/subop/compare *(ebp+8) 1/imm32
<span id="L33" class="LineNr">33 </span>    {
<span id="L34" class="LineNr">34 </span>      7f/jump-if-&gt; <span class="Constant">break</span>/disp8
<span id="L35" class="LineNr">35 </span>      b8/copy-to-eax 1/imm32
<span id="L36" class="LineNr">36 </span>      eb/jump $factorial:end/disp8
<span id="L37" class="LineNr">37 </span>    }
<span id="L38" class="LineNr">38 </span>    <span class="subxComment"># n &gt; 1; return n * factorial(n-1)</span>
<span id="L39" class="LineNr">39 </span>    8b/-&gt; *(ebp+8) 1/r32/ecx
<span id="L40" class="LineNr">40 </span>    49/decrement-ecx
<span id="L41" class="LineNr">41 </span>    (<a href='factorial4.subx.html#L25'>factorial</a> %ecx)  <span class="subxComment"># =&gt; eax</span>
<span id="L42" class="LineNr">42 </span>    f7 4/subop/multiply-into-eax *(ebp+8)
<span id="L43" class="LineNr">43 </span>    <span class="subxComment"># TODO: check for overflow</span>
<span id="L44" class="LineNr">44 </span><span class="Constant">$factorial:end</span>:
<span id="L45" class="LineNr">45 </span>    <span class="subxComment"># restore registers</span>
<span id="L46" class="LineNr">46 </span>    59/pop-to-ecx
<span id="L47" class="LineNr">47 </span>    <span class="subxS1Comment"># . epilogue</span>
<span id="L48" class="LineNr">48 </span>    89/&lt;- %esp 5/r32/ebp
<span id="L49" class="LineNr">49 </span>    5d/pop-to-ebp
<span id="L50" class="LineNr">50 </span>    c3/return
<span id="L51" class="LineNr">51 </span>
<span id="L52" class="LineNr">52 </span><span class="subxTest">test-factorial</span>:
<span id="L53" class="LineNr">53 </span>    (<a href='factorial4.subx.html#L25'>factorial</a> 5)
<span id="L54" class="LineNr">54 </span>    (<a href='../102test.subx.html#L23'>check-ints-equal</a> %eax 0x78 <span class="Constant">&quot;F - test-factorial&quot;</span>)
<span id="L55" class="LineNr">55 </span>    c3/return
<span id="L56" class="LineNr">56 </span>
<span id="L57" class="LineNr">57 </span><span class="SpecialChar">Entry</span>:  <span class="subxComment"># run tests if necessary, compute `factorial(5)` if not</span>
<span id="L58" class="LineNr">58 </span>    <span class="subxS1Comment"># . prologue</span>
<span id="L59" class="LineNr">59 </span>    89/&lt;- %ebp 4/r32/esp
<span id="L60" class="LineNr">60 </span>
<span id="L61" class="LineNr">61 </span>    <span class="subxComment"># initialize heap (needed by tests elsewhere)</span>
<span id="L62" class="LineNr">62 </span>    (<a href='../104new-segment.subx.html#L40'>new-segment</a> *<span class="SpecialChar"><a href='../120allocate.subx.html#L34'>Heap-size</a></span> <span class="SpecialChar"><a href='../120allocate.subx.html#L27'>Heap</a></span>)
<span id="L63" class="LineNr">63 </span>
<span id="L64" class="LineNr">64 </span>    <span class="subxComment"># if (argc &lt;= 1) return factorial(5)</span>
<span id="L65" class="LineNr">65 </span>    {
<span id="L66" class="LineNr">66 </span>      <span class="subxComment"># if (argc &gt; 1) break</span>
<span id="L67" class="LineNr">67 </span>      81 7/subop/compare *ebp 1/imm32
<span id="L68" class="LineNr">68 </span>      7f/jump-if-&gt; <span class="Constant">break</span>/disp8
<span id="L69" class="LineNr">69 </span>      <span class="subxComment"># ebx = factorial(5)</span>
<span id="L70" class="LineNr">70 </span>      (<a href='factorial4.subx.html#L25'>factorial</a> 5)  <span class="subxComment"># =&gt; eax</span>
<span id="L71" class="LineNr">71 </span>      89/&lt;- %ebx 0/r32/eax
<span id="L72" class="LineNr">72 </span>      eb/jump $main:end/disp8
<span id="L73" class="LineNr">73 </span>    }
<span id="L74" class="LineNr">74 </span>    <span class="subxComment"># otherwise if first arg is &quot;test&quot;, then return run_tests()</span>
<span id="L75" class="LineNr">75 </span>    {
<span id="L76" class="LineNr">76 </span>      <span class="subxComment"># if (!kernel-string-equal?(argv[1], &quot;test&quot;)) break</span>
<span id="L77" class="LineNr">77 </span>      (<a href='../103kernel-string-equal.subx.html#L31'>kernel-string-equal?</a> *(ebp+8) <span class="Constant">&quot;test&quot;</span>)  <span class="subxComment"># =&gt; eax</span>
<span id="L78" class="LineNr">78 </span>      3d/compare-eax-and 0/imm32/false
<span id="L79" class="LineNr">79 </span>      74/jump-if-= <span class="Constant">break</span>/disp8
<span id="L80" class="LineNr">80 </span>      <span class="subxComment">#</span>
<span id="L81" class="LineNr">81 </span>      (run-tests)
<span id="L82" class="LineNr">82 </span>      <span class="subxComment"># exit(*Num-test-failures)</span>
<span id="L83" class="LineNr">83 </span>      8b/-&gt; *<span class="SpecialChar"><a href='../102test.subx.html#L89'>Num-test-failures</a></span> 3/r32/ebx
<span id="L84" class="LineNr">84 </span>      eb/jump $main:end/disp8
<span id="L85" class="LineNr">85 </span>    }
<span id="L86" class="LineNr">86 </span>    bb/copy-to-ebx 0/imm32
<span id="L87" class="LineNr">87 </span><span class="Constant">$main:end</span>:
<span id="L88" class="LineNr">88 </span>    e8/call  <a href='../000init.subx.html#L18'>syscall_exit</a>/disp32
</pre>
</body>
</html>
<!-- vim: set foldmethod=manual : -->