about summary refs log tree commit diff stats
path: root/html/subx/apps/factorial.subx.html
blob: 1fa6a4e32dd75d3465b5b84825fa394c6a34b1f6 (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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Mu - subx/apps/factorial.subx</title>
<meta name="Generator" content="Vim/8.0">
<meta name="plugin-version" content="vim7.4_v2">
<meta name="syntax" content="none">
<meta name="settings" content="number_lines,use_css,no_foldcolumn,expand_tabs,line_ids,prevent_copy=">
<meta name="colorscheme" content="minimal">
<style type="text/css">
<!--
pre { font-family: monospace; color: #aaaaaa; background-color: #080808; }
body { font-size: 12pt; font-family: monospace; color: #aaaaaa; background-color: #080808; }
a { color:#eeeeee; text-decoration: none; }
a:hover { text-decoration: underline; }
* { font-size: 12pt; font-size: 1em; }
.LineNr { color: #444444; }
.Delimiter { color: #800080; }
.Comment { color: #9090ff; }
.Comment a { color:#0000ee; text-decoration:underline; }
.SalientComment { color: #00ffff; }
-->
</style>

<script type='text/javascript'>
<!--

/* 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;
  }
  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();'>
<pre id='vimCodeElement'>
<span id="L1" class="LineNr"> 1 </span><span class="SalientComment">## compute the factorial of 5, and return the result in the exit code</span>
<span id="L2" class="LineNr"> 2 </span><span class="Comment">#</span>
<span id="L3" class="LineNr"> 3 </span><span class="Comment"># To run:</span>
<span id="L4" class="LineNr"> 4 </span><span class="Comment">#   $ subx translate apps/factorial.subx apps/factorial</span>
<span id="L5" class="LineNr"> 5 </span><span class="Comment">#   $ subx run apps/factorial</span>
<span id="L6" class="LineNr"> 6 </span><span class="Comment"># Expected result:</span>
<span id="L7" class="LineNr"> 7 </span><span class="Comment">#   $ echo $?</span>
<span id="L8" class="LineNr"> 8 </span><span class="Comment">#   120</span>
<span id="L9" class="LineNr"> 9 </span>
<span id="L10" class="LineNr">10 </span>== code
<span id="L11" class="LineNr">11 </span><span class="Comment"># instruction                     effective address                                                   operand     displacement    immediate</span>
<span id="L12" class="LineNr">12 </span><span class="Comment"># op          subop               mod             rm32          base        index         scale       r32</span>
<span id="L13" class="LineNr">13 </span><span class="Comment"># 1-3 bytes   3 bits              2 bits          3 bits        3 bits      3 bits        2 bits      2 bits      0/1/2/4 bytes   0/1/2/4 bytes</span>
<span id="L14" class="LineNr">14 </span>
<span id="L15" class="LineNr">15 </span><span class="Comment"># main:</span>
<span id="L16" class="LineNr">16 </span>  <span class="Comment"># prepare to make a call</span>
<span id="L17" class="LineNr">17 </span>  55/push                        <span class="Delimiter"> . </span>             <span class="Delimiter"> . </span>           <span class="Delimiter"> . </span>         <span class="Delimiter"> . </span>           <span class="Delimiter"> . </span>         <span class="Delimiter"> . </span>         <span class="Delimiter"> . </span>             <span class="Delimiter"> . </span>                <span class="Comment"># push EBP</span>
<span id="L18" class="LineNr">18 </span>  89/copy                         3/mod/direct    5/rm32/EBP   <span class="Delimiter"> . </span>         <span class="Delimiter"> . </span>           <span class="Delimiter"> . </span>          4/r32/ESP  <span class="Delimiter"> . </span>             <span class="Delimiter"> . </span>                <span class="Comment"># copy ESP to EBP</span>
<span id="L19" class="LineNr">19 </span>  <span class="Comment"># factorial(5)</span>
<span id="L20" class="LineNr">20 </span>  68/push                        <span class="Delimiter"> . </span>             <span class="Delimiter"> . </span>           <span class="Delimiter"> . </span>         <span class="Delimiter"> . </span>           <span class="Delimiter"> . </span>         <span class="Delimiter"> . </span>         <span class="Delimiter"> . </span>              5/imm32           <span class="Comment"># push 5</span>
<span id="L21" class="LineNr">21 </span>  e8/call                        <span class="Delimiter"> . </span>             <span class="Delimiter"> . </span>           <span class="Delimiter"> . </span>         <span class="Delimiter"> . </span>           <span class="Delimiter"> . </span>         <span class="Delimiter"> . </span>          factorial/disp32
<span id="L22" class="LineNr">22 </span>  <span class="Comment"># discard arg</span>
<span id="L23" class="LineNr">23 </span>  5a/pop                         <span class="Delimiter"> . </span>             <span class="Delimiter"> . </span>           <span class="Delimiter"> . </span>         <span class="Delimiter"> . </span>           <span class="Delimiter"> . </span>         <span class="Delimiter"> . </span>         <span class="Delimiter"> . </span>             <span class="Delimiter"> . </span>                <span class="Comment"># pop into EDX</span>
<span id="L24" class="LineNr">24 </span>  <span class="Comment"># clean up after call</span>
<span id="L25" class="LineNr">25 </span>  89/copy                         3/mod/direct    4/rm32/ESP   <span class="Delimiter"> . </span>         <span class="Delimiter"> . </span>           <span class="Delimiter"> . </span>          5/r32/EBP  <span class="Delimiter"> . </span>             <span class="Delimiter"> . </span>                <span class="Comment"># copy EBP to ESP</span>
<span id="L26" class="LineNr">26 </span>  5d/pop                         <span class="Delimiter"> . </span>             <span class="Delimiter"> . </span>           <span class="Delimiter"> . </span>         <span class="Delimiter"> . </span>           <span class="Delimiter"> . </span>         <span class="Delimiter"> . </span>         <span class="Delimiter"> . </span>             <span class="Delimiter"> . </span>                <span class="Comment"># pop to EBP</span>
<span id="L27" class="LineNr">27 </span>
<span id="L28" class="LineNr">28 </span>  <span class="Comment"># exit(EAX)</span>
<span id="L29" class="LineNr">29 </span>  89/copy                         3/mod/direct    3/rm32/EBX   <span class="Delimiter"> . </span>         <span class="Delimiter"> . </span>           <span class="Delimiter"> . </span>          0/r32/EAX  <span class="Delimiter"> . </span>             <span class="Delimiter"> . </span>                <span class="Comment"># copy EAX to EBX</span>
<span id="L30" class="LineNr">30 </span>  b8/copy                        <span class="Delimiter"> . </span>             <span class="Delimiter"> . </span>           <span class="Delimiter"> . </span>         <span class="Delimiter"> . </span>           <span class="Delimiter"> . </span>         <span class="Delimiter"> . </span>         <span class="Delimiter"> . </span>              1/imm32           <span class="Comment"># copy 1 to EAX</span>
<span id="L31" class="LineNr">31 </span>  cd/syscall                     <span class="Delimiter"> . </span>             <span class="Delimiter"> . </span>           <span class="Delimiter"> . </span>         <span class="Delimiter"> . </span>           <span class="Delimiter"> . </span>         <span class="Delimiter"> . </span>         <span class="Delimiter"> . </span>              0x80/imm8         <span class="Comment"># int 80h</span>
<span id="L32" class="LineNr">32 </span>
<span id="L33" class="LineNr">33 </span><span class="Comment"># factorial(n)</span>
<span id="L34" class="LineNr">34 </span>factorial:
<span id="L35" class="LineNr">35 </span>  <span class="Comment"># initialize EAX to 1 (base case)</span>
<span id="L36" class="LineNr">36 </span>  b8/copy                        <span class="Delimiter"> . </span>             <span class="Delimiter"> . </span>           <span class="Delimiter"> . </span>         <span class="Delimiter"> . </span>           <span class="Delimiter"> . </span>         <span class="Delimiter"> . </span>         <span class="Delimiter"> . </span>              1/imm32           <span class="Comment"># copy 1 to EAX</span>
<span id="L37" class="LineNr">37 </span>  <span class="Comment"># if (n &lt;= 1) jump exit</span>
<span id="L38" class="LineNr">38 </span>  81          7/subop/compare     1/mod/*+disp8   4/rm32/sib    4/base/ESP  4/index/none <span class="Delimiter"> . </span>         <span class="Delimiter"> . </span>          4/disp8         1/imm32           <span class="Comment"># compare *(ESP+4) with 1</span>
<span id="L39" class="LineNr">39 </span>  7e/jump-if-&lt;=                  <span class="Delimiter"> . </span>             <span class="Delimiter"> . </span>           <span class="Delimiter"> . </span>         <span class="Delimiter"> . </span>           <span class="Delimiter"> . </span>         <span class="Delimiter"> . </span>          $factorial:exit/disp8             <span class="Comment"># jump if &lt;= to $factorial:exit</span>
<span id="L40" class="LineNr">40 </span>  <span class="Comment"># EBX: n-1</span>
<span id="L41" class="LineNr">41 </span>  8b/copy                         1/mod/*+disp8   4/rm32/sib    4/base/ESP  4/index/none              3/r32/EBX   4/disp8        <span class="Delimiter"> . </span>                <span class="Comment"># copy *(ESP+4) to EBX</span>
<span id="L42" class="LineNr">42 </span>  81          5/subop/subtract    3/mod/direct    3/rm32/EBX   <span class="Delimiter"> . </span>         <span class="Delimiter"> . </span>           <span class="Delimiter"> . </span>         <span class="Delimiter"> . </span>         <span class="Delimiter"> . </span>              1/imm32           <span class="Comment"># subtract 1 from EBX</span>
<span id="L43" class="LineNr">43 </span>  <span class="Comment"># prepare call</span>
<span id="L44" class="LineNr">44 </span>  55/push                        <span class="Delimiter"> . </span>             <span class="Delimiter"> . </span>           <span class="Delimiter"> . </span>         <span class="Delimiter"> . </span>           <span class="Delimiter"> . </span>         <span class="Delimiter"> . </span>         <span class="Delimiter"> . </span>             <span class="Delimiter"> . </span>                <span class="Comment"># push EBP</span>
<span id="L45" class="LineNr">45 </span>  89/copy                         3/mod/direct    5/rm32/EBP   <span class="Delimiter"> . </span>         <span class="Delimiter"> . </span>           <span class="Delimiter"> . </span>          4/r32/ESP  <span class="Delimiter"> . </span>             <span class="Delimiter"> . </span>                <span class="Comment"># copy ESP to EBP</span>
<span id="L46" class="LineNr">46 </span>  <span class="Comment"># EAX: factorial(n-1)</span>
<span id="L47" class="LineNr">47 </span>  53/push                        <span class="Delimiter"> . </span>             <span class="Delimiter"> . </span>           <span class="Delimiter"> . </span>         <span class="Delimiter"> . </span>           <span class="Delimiter"> . </span>         <span class="Delimiter"> . </span>         <span class="Delimiter"> . </span>             <span class="Delimiter"> . </span>                <span class="Comment"># push EBX</span>
<span id="L48" class="LineNr">48 </span>  e8/call                        <span class="Delimiter"> . </span>             <span class="Delimiter"> . </span>           <span class="Delimiter"> . </span>         <span class="Delimiter"> . </span>           <span class="Delimiter"> . </span>         <span class="Delimiter"> . </span>          factorial/disp32
<span id="L49" class="LineNr">49 </span>  <span class="Comment"># discard arg</span>
<span id="L50" class="LineNr">50 </span>  5e/pop                         <span class="Delimiter"> . </span>             <span class="Delimiter"> . </span>           <span class="Delimiter"> . </span>         <span class="Delimiter"> . </span>           <span class="Delimiter"> . </span>         <span class="Delimiter"> . </span>         <span class="Delimiter"> . </span>             <span class="Delimiter"> . </span>                <span class="Comment"># pop into ESI</span>
<span id="L51" class="LineNr">51 </span>  <span class="Comment"># clean up after call</span>
<span id="L52" class="LineNr">52 </span>  89/copy                         3/mod/direct    4/rm32/ESP   <span class="Delimiter"> . </span>         <span class="Delimiter"> . </span>           <span class="Delimiter"> . </span>          5/r32/EBP  <span class="Delimiter"> . </span>             <span class="Delimiter"> . </span>                <span class="Comment"># copy EBP to ESP</span>
<span id="L53" class="LineNr">53 </span>  5d/pop                         <span class="Delimiter"> . </span>             <span class="Delimiter"> . </span>           <span class="Delimiter"> . </span>         <span class="Delimiter"> . </span>           <span class="Delimiter"> . </span>         <span class="Delimiter"> . </span>         <span class="Delimiter"> . </span>             <span class="Delimiter"> . </span>                <span class="Comment"># pop to EBP</span>
<span id="L54" class="LineNr">54 </span>  <span class="Comment"># refresh n</span>
<span id="L55" class="LineNr">55 </span>  8b/copy                         1/mod/*+disp8   4/rm32/sib    4/base/ESP  4/index/none              2/r32/EDX   4/disp8        <span class="Delimiter"> . </span>                <span class="Comment"># copy *(ESP+4) to EDX</span>
<span id="L56" class="LineNr">56 </span>  <span class="Comment"># return n * factorial(n-1)</span>
<span id="L57" class="LineNr">57 </span>  f7          4/subop/multiply    1/mod/*+disp8   4/rm32/sib    4/base/ESP  4/index/none                          4/disp8        <span class="Delimiter"> . </span>                <span class="Comment"># multiply *(ESP+4) (n) into EAX (factorial(n-1))</span>
<span id="L58" class="LineNr">58 </span>  <span class="Comment"># TODO: check for overflow</span>
<span id="L59" class="LineNr">59 </span>$factorial:exit:
<span id="L60" class="LineNr">60 </span>  c3/return
<span id="L61" class="LineNr">61 </span>
<span id="L62" class="LineNr">62 </span><span class="Comment"># vim&#0058;ft=subx:nowrap:so=0</span>
</pre>
</body>
</html>
<!-- vim: set foldmethod=manual : -->