about summary refs log blame commit diff stats
path: root/html/apps/ex10.subx.html
blob: ddfd8a6e57151a3cb70b1aca7437fbf2426e8b54 (plain) (tree)
ac07e589 ^
pre { line-height: 125%; } td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } .highlight .hll { background-color: #ffffcc } .highlight .c { color: #888888 } /* Comment */ .highlight .err { color: #a61717; background-color: #e3d2d2 } /* Error */ .highlight .k { color: #008800; font-weight: bold } /* Keyword */ .highlight .ch { color: #888888 } /* Comment.Hashbang */ .highlight .cm { color: #888888 } /* Comment.Multiline */ .highlight .cp { color: #cc0000; font-weight: bold } /* Comment.Preproc */ .highlight .cpf { color: #888888 } /* Comment.PreprocFile */ .highlight .c1 { color: #888888 } /* Comment.Single */ .highlight .cs { color: #cc0000; font-weight: bold; background-color: #fff0f0 } /* Comment.Special */ .highlight .gd { color: #000000; background-color: #ffdddd } /* Generic.Deleted */ .highlight .ge { font-style: italic } /* Generic.Emph */ .highlight .ges { font-weight: bold; font-style: italic } /* Generic.EmphStrong */ .highlight .gr { color: #aa0000 } /* Generic.Error */ .highlight .gh { color: #333333 } /* Generic.Heading */ .highlight .gi { color: #000000; background-color: #ddffdd } /* Generic.Inserted */ .highlight .go { color: #888888 } /* Generic.Output */ .highlight .gp { color: #555555 } /* Generic.Prompt */ .highlight .gs { font-weight: bold } /* Generic.Strong */ .highlight .gu { color: #666666 } /* Generic.Subheading */ .highlight .gt { color: #aa0000 } /* Generic.Traceback */ .highlight .kc { color: #008800; font-weight: bold } /* Keyword.Constant */ .highlight .kd { color: #008800; font-weight: bold } /* Keyword.Declaration */ .highlight .kn { color: #008800; font-weight: bold } /* Keyword.Namespace */ .highlight .kp { color: #008800 } /* Keyword.Pseudo */ .highlight .kr { color: #008800; font-weight: bold } /* Keyword.Reserved */ .highlight .kt { color: #888888; font-weight: bold } /* Keyword.Type */ .highlight .m { color: #0000DD; font-weight: bold } /* Literal.Number */ .highlight .s { color: #dd2200; background-color: #fff0f0 } /* Literal.String */ .highlight .na { color: #336699 } /* Name.Attribute */ .highlight .nb { color: #003388 } /* Name.Builtin */ .highlight .nc { color: #bb0066; font-weight: bold } /* Name.Class */ .highlight .no { color: #003366; font-weight: bold } /* Name.Constant */ .highlight .nd { color: #555555 } /* Name.Decorator */ .highlight .ne { color: #bb0066; font-weight: bold } /* Name.Exception */ .highlight .nf { color: #0066bb; font-weight: bold } /* Name.Function */ .highlight .nl { color: #336699; font-style: italic } /* Name.Label */ .highlight .nn { color: #bb0066; font-weight: bold } /* Name.Namespace */ .highlight .py { color: #336699; font-weight: bold } /* Name.Property */ .highlight .nt { color: #bb0066; font-weight: bold } /* Name.Tag */ .highlight .nv { color: #336699 } /* Name.Variable */ .highlight .ow { color: #008800 } /* Operator.Word */ .highlight .w { color: #bbbbbb } /* Text.Whitespace */ .highlight .mb { color: #0000DD; font-weight: bold } /* Literal.Number.Bin */ .highlight .mf { color: #0000DD; font-weight: bold } /* Literal.Number.Float */ .highlight .mh { color: #0000DD; font-weight: bold } /* Literal.Number.Hex */ .highlight .mi { color: #0000DD; font-weight: bold } /* Literal.Number.Integer */ .highlight .mo { color: #0000DD; font-weight: bold } /* Literal.Number.Oct */ .highlight .sa { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Affix */ .highlight .sb { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Backtick */ .highlight .sc { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Char */ .highlight .dl { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Delimiter */ .highlight .sd { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Doc */ .highlight .s2 { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Double */ .highlight .se { color: #0044dd; background-color: #fff0f0 } /* Literal.String.Escape */ .highlight .sh { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Heredoc */ .highlight .si { color: #3333bb; background-color: #fff0f0 } /* Literal.String.Interpol */ .highlight .sx { color: #22bb22; background-color: #f0fff0 } /* Literal.String.Other */ .highlight .sr { color: #008800; background-color: #fff0ff } /* Literal.String.Regex */ .highlight .s1 { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Single */ .highlight .ss { color: #aa6600; background-color: #fff0f0 } /* Literal.String.Symbol */ .highlight .bp { color: #003388 } /* Name.Builtin.Pseudo */ .highlight .fm { color: #0066bb; font-weight: bold } /* Name.Function.Magic */ .highlight .vc { color: #336699 } /* Name.Variable.Class */ .highlight .vg { color: #dd7700 } /* Name.Variable.Global */ .highlight .vi { color: #3333bb } /* Name.Variable.Instance */ .highlight .vm { color: #336699 } /* Name.Variable.Magic */ .highlight .il { color: #0000DD; font-weight: bold } /* Literal.Number.Integer.Long */
== Goal

A memory-safe language with a simple translator to x86 that can be feasibly written in x86.

== Definitions of terms

Memory-safe: it should be impossible to:
  a) create a pointer out of arbitrary data, or
  b) to access heap memory after it's been freed.

Simple: do all the work in a 2-pass translator:
  Pass 1: check each instruction's types in isolation.
  Pass 2: emit code for each instruction in isolation.

== Implications

=> Each instruction matches a pattern and yields a template to emit.
=> There's a 1-to-1 mapping between instructions in the source language and x86 machine code.
  Zero runtime.
=> Programmers have to decide how to use registers.
=> Translator can't insert any instructions that write to registers. (We don't know if a register is in use.)

== Lessons from Mu

1. For easy bounds checking, never advance pointers to arrays or heap allocations. No pointer arithmetic.
2. Store the array length with the array.
3. Store an allocation id with heap allocations. Allocation id goes monotonically up, never gets reused. When it wraps around to zero the program panics.
4. Heap pointers also carry around allocation id.
5. When dereferencing a heap pointer, first ensure its alloc id matches the alloc id of the payload. This ensures some other copy of the pointer didn't get freed (and potentially reused)

== Problem 1

How to index into an array?

  The array has a length that needs to be checked.
  Its elements have a type T.
  The base will be in memory, either on the stack or the heap.
  The index may be in the register, stack or heap.

That's too much work to do in a single instruction.

So arrays have to take multiple steps. And we have to guard against the steps
being misused in unsafe ways.

To index into an array with elements of type T, starting with the size of the
array in bytes:

  step 1: get the offset the index is at
    <reg offset> : (index T) <- index <reg/mem idx> : int, <literal> : (size T)
  step 2: convert the array to address-of-element
    <reg x> : (address T) <- advance <reg/mem A> : (array T), <reg offset> : (index T)
    implicitly compares the offset with the size, panic if greater
    =>
      compare <reg offset> : (index T), <reg/mem> : (array T)
      jge panic
  step 3: use the address to the element
    ...

(index T) is a special type. You can do only two things with it:
  - pass it to the advance instruction
  - convert it to a number (but no converting back)

(address T) is a short-term pointer. You can't store addresses in structs, you
can't define global variables of that type, and you can't pass the type to the
memory allocator to save to the heap. Only place you can store an (address T)
is on the stack or a register.

[But you can still be holding an address in a long-lived stack frame after
it's been freed?!]

== Problem 2

How to dereference a heap allocation?
3b'>14a38052 ^
c56d803c ^
60338448 ^
ee0e67b9 ^

c56d803c ^


1a4de9dd ^
a0d3cac4 ^
14a38052 ^


1a4de9dd ^
e99038ea ^
c56d803c ^
33352536 ^


c56d803c ^
b1635a5c ^
33352536 ^
14a38052 ^

33352536 ^
14a38052 ^
33352536 ^
14a38052 ^
a0d3cac4 ^

33352536 ^
a0d3cac4 ^



2104d1a7 ^
a0d3cac4 ^









c52ae116 ^
6070c23e ^
a0d3cac4 ^

6070c23e ^
a0d3cac4 ^



4a4a392d ^
a0d3cac4 ^

c52ae116 ^
6070c23e ^
a0d3cac4 ^








1a4de9dd ^



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



                                                                                          
                                  

                                                
                                   
                                                                                                      
                                                 

                       

                                                                                           
                    
                                     
                                

                                                             
           
                                  
                                
                                                                           
                             















                                                                                 
                                                  















                                                                              
                                                                                                                                 
                         
                                                                                                                                                              
                                                                         
                                                                                 

                                                                                                                                          


                                                                                          
                                       
                                               


                                                                                                                                                                                                                            
                                        
                                                                                                                                                       
                                                                                                                


                                                                                                    
                                                                                      
                                                                                           
                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                           
                                                                                                                                                                                                                                                                                                                                                                                           
                                                                                                 
                                                                                                                                                                                                                                                                                                                                                                                          
                                                                                         

                                                                                                      
                                                                                                                                                                                                                                                                                                                                                                                            



                                                                                                                                                                                    
                                                                                                                                                                                    









                                                                                                                                                                                                                                                                                                                                                                                                    
                                                                            
                                                                                                               

                                                                                                                                                                                                                                                                                                                                                                                                
                                                                                  



                                                                                         
                                                                                                         

                                                                                                       
                                                                                                                                                                                                                                                                                                                                                                                        
                                                                                  








                                                                                                             



                                     
<!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 - apps/ex10.subx</title>
<meta name="Generator" content="Vim/8.1">
<meta name="plugin-version" content="vim8.1_v1">
<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-light">
<style type="text/css">
<!--
pre { font-family: monospace; color: #000000; background-color: #c6c6c6; }
body { font-size:12pt; font-family: monospace; color: #000000; background-color: #c6c6c6; }
a { color:inherit; }
* { font-size:12pt; font-size: 1em; }
.subxComment { color: #005faf; }
.subxS2Comment { color: #8a8a8a; }
.subxFunction { color: #af5f00; text-decoration: underline; }
.LineNr { }
.subxS1Comment { color: #0000af; }
.SpecialChar { color: #d70000; }
.Normal { color: #000000; background-color: #c6c6c6; padding-bottom: 1px; }
.Constant { color: #008787; }
-->
</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;
  }
  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/master/apps/ex10.subx'>https://github.com/akkartik/mu/blob/master/apps/ex10.subx</a>
<pre id='vimCodeElement'>
<span id="L1" class="LineNr"> 1 </span><span class="subxComment"># String comparison: return 1 iff the two args passed in at the commandline are equal.</span>
<span id="L2" class="LineNr"> 2 </span><span class="subxComment">#</span>
<span id="L3" class="LineNr"> 3 </span><span class="subxComment"># To run:</span>
<span id="L4" class="LineNr"> 4 </span><span class="subxComment">#   $ ./bootstrap translate init.linux apps/ex10.subx -o apps/ex10</span>
<span id="L5" class="LineNr"> 5 </span><span class="subxComment">#   $ ./bootstrap run apps/ex10 abc abd</span>
<span id="L6" class="LineNr"> 6 </span><span class="subxComment"># Expected result:</span>
<span id="L7" class="LineNr"> 7 </span><span class="subxComment">#   $ echo $?</span>
<span id="L8" class="LineNr"> 8 </span><span class="subxComment">#   0  # false</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="subxComment">#   instruction                     effective address                                                   register    displacement    immediate</span>
<span id="L12" class="LineNr">12 </span><span class="subxS1Comment"># . op          subop               mod             rm32          base        index         scale       r32</span>
<span id="L13" class="LineNr">13 </span><span class="subxS1Comment"># . 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="SpecialChar">Entry</span>:  <span class="subxComment"># return argv-equal(argv[1], argv[2])</span>
<span id="L16" class="LineNr">16 </span><span class="subxComment">#       At the start of a SubX program:</span>
<span id="L17" class="LineNr">17 </span><span class="subxComment">#         argc: *esp</span>
<span id="L18" class="LineNr">18 </span><span class="subxComment">#         argv[0]: *(esp+4)</span>
<span id="L19" class="LineNr">19 </span><span class="subxComment">#         argv[1]: *(esp+8)</span>
<span id="L20" class="LineNr">20 </span><span class="subxComment">#         ...</span>
<span id="L21" class="LineNr">21 </span>    <span class="subxS1Comment"># . prologue</span>
<span id="L22" class="LineNr">22 </span>    89/copy                         3/mod/direct    5/rm32/ebp   <span class="Normal"> . </span>         <span class="Normal"> . </span>           <span class="Normal"> . </span>          4/r32/esp  <span class="Normal"> . </span>             <span class="Normal"> . </span>                <span class="subxComment"># copy esp to ebp</span>
<span id="L23" class="LineNr">23 </span>    <span class="subxComment"># argv-equal(argv[1], argv[2])</span>
<span id="L24" class="LineNr">24 </span>    <span class="subxS2Comment"># . . push argv[2]</span>
<span id="L25" class="LineNr">25 </span>    ff          6/subop/push        1/mod/*+disp8   5/rm32/ebp   <span class="Normal"> . </span>         <span class="Normal"> . </span>           <span class="Normal"> . </span>         <span class="Normal"> . </span>          0xc/disp8      <span class="Normal"> . </span>                <span class="subxComment"># push *(ebp+12)</span>
<span id="L26" class="LineNr">26 </span>    <span class="subxS2Comment"># . . push argv[1]</span>
<span id="L27" class="LineNr">27 </span>    ff          6/subop/push        1/mod/*+disp8   5/rm32/ebp   <span class="Normal"> . </span>         <span class="Normal"> . </span>           <span class="Normal"> . </span>         <span class="Normal"> . </span>          8/disp8        <span class="Normal"> . </span>                <span class="subxComment"># push *(ebp+8)</span>
<span id="L28" class="LineNr">28 </span>    <span class="subxS2Comment"># . . call</span>
<span id="L29" class="LineNr">29 </span>    e8/call <a href='ex10.subx.html#L36'>argv-equal</a>/disp32
<span id="L30" class="LineNr">30 </span>    <span class="subxComment"># exit(eax)</span>
<span id="L31" class="LineNr">31 </span>    89/copy                         3/mod/direct    3/rm32/ebx   <span class="Normal"> . </span>         <span class="Normal"> . </span>           <span class="Normal"> . </span>          0/r32/eax  <span class="Normal"> . </span>             <span class="Normal"> . </span>                <span class="subxComment"># copy eax to ebx</span>
<span id="L32" class="LineNr">32 </span>    e8/call  syscall_exit/disp32
<span id="L33" class="LineNr">33 </span>
<span id="L34" class="LineNr">34 </span><span class="subxComment"># compare two null-terminated ascii strings</span>
<span id="L35" class="LineNr">35 </span><span class="subxComment"># reason for the name: the only place we should have null-terminated ascii strings is from commandline args</span>
<span id="L36" class="LineNr">36 </span><span class="subxFunction">argv-equal</span>:  <span class="subxComment"># (s1, s2): null-terminated ascii strings -&gt; eax: boolean</span>
<span id="L37" class="LineNr">37 </span>    <span class="subxComment"># initialize s1 (ecx) and s2 (edx)</span>
<span id="L38" class="LineNr">38 </span>    8b/copy                         1/mod/*+disp8   4/rm32/sib    4/base/esp  4/index/none <span class="Normal"> . </span>          1/r32/ecx   4/disp8        <span class="Normal"> . </span>                <span class="subxComment"># copy *(esp+4) to ecx</span>
<span id="L39" class="LineNr">39 </span>    8b/copy                         1/mod/*+disp8   4/rm32/sib    4/base/esp  4/index/none <span class="Normal"> . </span>          2/r32/edx   8/disp8        <span class="Normal"> . </span>                <span class="subxComment"># copy *(esp+8) to edx</span>
<span id="L40" class="LineNr">40 </span><span class="Constant">$argv-equal:loop</span>:
<span id="L41" class="LineNr">41 </span>    <span class="subxComment"># c1/eax, c2/ebx = *s1, *s2</span>
<span id="L42" class="LineNr">42 </span>    b8/copy-to-eax  0/imm32
<span id="L43" class="LineNr">43 </span>    8a/copy-byte                    0/mod/indirect  1/rm32/ecx   <span class="Normal"> . </span>         <span class="Normal"> . </span>           <span class="Normal"> . </span>          0/r32/AL   <span class="Normal"> . </span>             <span class="Normal"> . </span>                <span class="subxComment"># copy byte at *ecx to AL</span>
<span id="L44" class="LineNr">44 </span>    bb/copy-to-ebx  0/imm32
<span id="L45" class="LineNr">45 </span>    8a/copy-byte                    0/mod/indirect  2/rm32/edx   <span class="Normal"> . </span>         <span class="Normal"> . </span>           <span class="Normal"> . </span>          3/r32/BL   <span class="Normal"> . </span>             <span class="Normal"> . </span>                <span class="subxComment"># copy byte at *edx to BL</span>
<span id="L46" class="LineNr">46 </span>    <span class="subxComment"># if (c1 == 0) break</span>
<span id="L47" class="LineNr">47 </span>    3d/compare-eax-and  0/imm32/null
<span id="L48" class="LineNr">48 </span>    74/jump-if-=  $argv-equal:<span class="Constant">break</span>/disp8
<span id="L49" class="LineNr">49 </span>    <span class="subxComment"># if (c1 != c2) return false</span>
<span id="L50" class="LineNr">50 </span>    39/compare                      3/mod/direct    0/rm32/eax   <span class="Normal"> . </span>         <span class="Normal"> . </span>           <span class="Normal"> . </span>          3/r32/ebx  <span class="Normal"> . </span>             <span class="Normal"> . </span>                <span class="subxComment"># compare eax and ebx</span>
<span id="L51" class="LineNr">51 </span>    75/jump-if-!=  $argv-equal:false/disp8
<span id="L52" class="LineNr">52 </span>    <span class="subxComment"># ++s1, ++s2</span>
<span id="L53" class="LineNr">53 </span>    41/increment-ecx
<span id="L54" class="LineNr">54 </span>    42/increment-edx
<span id="L55" class="LineNr">55 </span>    <span class="subxComment"># end while</span>
<span id="L56" class="LineNr">56 </span>    eb/jump  $argv-equal:<span class="Constant">loop</span>/disp8
<span id="L57" class="LineNr">57 </span><span class="Constant">$argv-equal:break</span>:
<span id="L58" class="LineNr">58 </span>    <span class="subxComment"># if (c2 == 0) return true</span>
<span id="L59" class="LineNr">59 </span>    81          7/subop/compare     3/mod/direct    3/rm32/ebx   <span class="Normal"> . </span>         <span class="Normal"> . </span>           <span class="Normal"> . </span>         <span class="Normal"> . </span>         <span class="Normal"> . </span>              0/imm32/null      <span class="subxComment"># compare ebx</span>
<span id="L60" class="LineNr">60 </span>    75/jump-if-!=  $argv-equal:false/disp8
<span id="L61" class="LineNr">61 </span><span class="Constant">$argv-equal:success</span>:
<span id="L62" class="LineNr">62 </span>    b8/copy-to-eax  1/imm32
<span id="L63" class="LineNr">63 </span>    c3/return
<span id="L64" class="LineNr">64 </span>    <span class="subxComment"># return false</span>
<span id="L65" class="LineNr">65 </span><span class="Constant">$argv-equal:false</span>:
<span id="L66" class="LineNr">66 </span>    b8/copy-to-eax  0/imm32
<span id="L67" class="LineNr">67 </span>    c3/return
<span id="L68" class="LineNr">68 </span>
<span id="L69" class="LineNr">69 </span><span class="subxS2Comment"># . . vim&#0058;nowrap:textwidth=0</span>
</pre>
</body>
</html>
<!-- vim: set foldmethod=manual : -->