about summary refs log tree commit diff stats
path: root/html/apps/ex5.subx.html
blob: 8575bbfd8b5e0af10a09c3cd173b64ae4a4cb4e3 (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
<!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/ex5.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; }
.LineNr { }
.subxS1Comment { color: #0000af; }
.SpecialChar { color: #d70000; }
.Normal { color: #000000; background-color: #c6c6c6; padding-bottom: 1px; }
-->
</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/ex5.subx'>https://github.com/akkartik/mu/blob/master/apps/ex5.subx</a>
<pre id='vimCodeElement'>
<span id="L1" class="LineNr"> 1 </span><span class="subxComment"># Read a character from stdin, save it to a local on the stack, write it to stdout.</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/ex5.subx -o apps/ex5</span>
<span id="L5" class="LineNr"> 5 </span><span class="subxComment">#   $ ./bootstrap run apps/ex5</span>
<span id="L6" class="LineNr"> 6 </span>
<span id="L7" class="LineNr"> 7 </span>== code
<span id="L8" class="LineNr"> 8 </span><span class="subxComment">#   instruction                     effective address                                                   register    displacement    immediate</span>
<span id="L9" class="LineNr"> 9 </span><span class="subxS1Comment"># . op          subop               mod             rm32          base        index         scale       r32</span>
<span id="L10" class="LineNr">10 </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="L11" class="LineNr">11 </span>
<span id="L12" class="LineNr">12 </span><span class="SpecialChar">Entry</span>:
<span id="L13" class="LineNr">13 </span>
<span id="L14" class="LineNr">14 </span>    <span class="subxComment"># allocate x on the stack</span>
<span id="L15" class="LineNr">15 </span>    81          5/subop/subtract    3/mod/direct    4/rm32/esp   <span class="Normal"> . </span>         <span class="Normal"> . </span>           <span class="Normal"> . </span>         <span class="Normal"> . </span>         <span class="Normal"> . </span>              4/imm32           <span class="subxComment"># subtract from esp</span>
<span id="L16" class="LineNr">16 </span>
<span id="L17" class="LineNr">17 </span>    <span class="subxComment"># read(stdin, x, 1)</span>
<span id="L18" class="LineNr">18 </span>    <span class="subxS1Comment"># . fd = 0 (stdin)</span>
<span id="L19" class="LineNr">19 </span>    bb/copy-to-ebx  0/imm32
<span id="L20" class="LineNr">20 </span>    <span class="subxS1Comment"># . data = x (location to write result to)</span>
<span id="L21" class="LineNr">21 </span>    8d/copy-address                 1/mod/*+disp8   4/rm32/sib    4/base/esp  4/index/none              1/r32/ecx   4/disp8        <span class="Normal"> . </span>                <span class="subxComment"># copy esp+4 to ecx</span>
<span id="L22" class="LineNr">22 </span>    <span class="subxS1Comment"># . size = 1 character</span>
<span id="L23" class="LineNr">23 </span>    ba/copy-to-edx  1/imm32
<span id="L24" class="LineNr">24 </span>    <span class="subxS1Comment"># . syscall</span>
<span id="L25" class="LineNr">25 </span>    e8/call  syscall_read/disp32
<span id="L26" class="LineNr">26 </span>
<span id="L27" class="LineNr">27 </span>    <span class="subxComment"># syscall(write, stdout, x, 1)</span>
<span id="L28" class="LineNr">28 </span>    <span class="subxS1Comment"># . fd = 1 (stdout)</span>
<span id="L29" class="LineNr">29 </span>    bb/copy-to-ebx  1/imm32
<span id="L30" class="LineNr">30 </span>    <span class="subxS1Comment"># . data = x (location to read from)</span>
<span id="L31" class="LineNr">31 </span>    8d/copy-address                 1/mod/*+disp8   4/rm32/sib    4/base/esp  4/index/none              1/r32/ecx   4/disp8        <span class="Normal"> . </span>                <span class="subxComment"># copy esp+4 to ecx</span>
<span id="L32" class="LineNr">32 </span>    <span class="subxS1Comment"># . size = 1 character</span>
<span id="L33" class="LineNr">33 </span>    ba/copy-to-edx  1/imm32
<span id="L34" class="LineNr">34 </span>    <span class="subxS1Comment"># . syscall</span>
<span id="L35" class="LineNr">35 </span>    e8/call  syscall_write/disp32
<span id="L36" class="LineNr">36 </span>
<span id="L37" class="LineNr">37 </span>    <span class="subxComment"># exit(ebx)</span>
<span id="L38" class="LineNr">38 </span>    e8/call  syscall_exit/disp32
<span id="L39" class="LineNr">39 </span>
<span id="L40" class="LineNr">40 </span><span class="subxS2Comment"># . . vim&#0058;nowrap:textwidth=0</span>
</pre>
</body>
</html>
<!-- vim: set foldmethod=manual : -->
ss="p">.at(0) == t.elements.at(i).at(0)) { raise << "container " << t.name << " can't include itself as a member\n" << end(); return 0; } result += size_of(t.elements.at(i)); } return result; } :(scenario stash_container) recipe main [ 1:number <- copy 34 # first 2:number <- copy 35 3:number <- copy 36 stash [foo:], 1:point-number/raw ] +app: foo: 34 35 36 //:: To access elements of a container, use 'get' :(scenario get) recipe main [ 12:number <- copy 34 13:number <- copy 35 15:number <- get 12:point/raw, 1:offset # unsafe ] +mem: storing 35 in location 15 :(before "End Primitive Recipe Declarations") GET, :(before "End Primitive Recipe Numbers") Recipe_ordinal["get"] = GET; :(before "End Primitive Recipe Checks") case GET: { if (SIZE(inst.ingredients) != 2) { raise << maybe(Recipe[r].name) << "'get' expects exactly 2 ingredients in '" << inst.to_string() << "'\n" << end(); break; } reagent base = inst.ingredients.at(0); // Update GET base in Check if (base.types.empty() || Type[base.types.at(0)].kind != container) { raise << maybe(Recipe[r].name) << "first ingredient of 'get' should be a container, but got " << inst.ingredients.at(0).original_string << '\n' << end(); break; } type_ordinal base_type = base.types.at(0); reagent offset = inst.ingredients.at(1); if (!is_literal(offset) || !is_mu_scalar(offset)) { raise << maybe(Recipe[r].name) << "second ingredient of 'get' should have type 'offset', but got " << inst.ingredients.at(1).original_string << '\n' << end(); break; } long long int offset_value = 0; if (is_integer(offset.name)) { // later layers permit non-integer offsets offset_value = to_integer(offset.name); if (offset_value < 0 || offset_value >= SIZE(Type[base_type].elements)) { raise << maybe(Recipe[r].name) << "invalid offset " << offset_value << " for " << Type[base_type].name << '\n' << end(); break; } } else { offset_value = offset.value; } reagent product = inst.products.at(0); // Update GET product in Check reagent element; element.types = Type[base_type].elements.at(offset_value); if (!types_match(product, element)) { raise << maybe(Recipe[r].name) << "'get' " << offset.original_string << " (" << offset_value << ") on " << Type[base_type].name << " can't be saved in " << product.original_string << "; type should be " << dump_types(element) << '\n' << end(); } break; } :(before "End Primitive Recipe Implementations") case GET: { reagent base = current_instruction().ingredients.at(0); // Update GET base in Run long long int base_address = base.value; if (base_address == 0) { raise << maybe(current_recipe_name()) << "tried to access location 0 in '" << current_instruction().to_string() << "'\n" << end(); break; } type_ordinal base_type = base.types.at(0); long long int offset = ingredients.at(1).at(0); if (offset < 0 || offset >= SIZE(Type[base_type].elements)) break; // copied from Check above long long int src = base_address; for (long long int i = 0; i < offset; ++i) { src += size_of(Type[base_type].elements.at(i)); } trace(Primitive_recipe_depth, "run") << "address to copy is " << src << end(); type_ordinal src_type = Type[base_type].elements.at(offset).at(0); trace(Primitive_recipe_depth, "run") << "its type is " << Type[src_type].name << end(); reagent tmp; tmp.set_value(src); tmp.types.push_back(src_type); products.push_back(read_memory(tmp)); break; } :(code) string dump_types(const reagent& x) { ostringstream out; for (long long int i = 0; i < SIZE(x.types); ++i) { if (i > 0) out << ':'; out << Type[x.types.at(i)].name; } return out.str(); } :(scenario get_handles_nested_container_elements) recipe main [ 12:number <- copy 34 13:number <- copy 35 14:number <- copy 36 15:number <- get 12:point-number/raw, 1:offset # unsafe ] +mem: storing 36 in location 15 //:: To write to elements of containers, you need their address. :(scenario get_address) recipe main [ 12:number <- copy 34 13:number <- copy 35 15:address:number <- get-address 12:point/raw, 1:offset # unsafe ] +mem: storing 13 in location 15 :(scenario get_out_of_bounds) % Hide_warnings = true; recipe main [ 12:number <- copy 34 13:number <- copy 35 14:number <- copy 36 get 12:point-number/raw, 2:offset # point-number occupies 3 locations but has only 2 fields; out of bounds ] +warn: main: invalid offset 2 for point-number :(scenario get_out_of_bounds_2) % Hide_warnings = true; recipe main [ 12:number <- copy 34 13:number <- copy 35 14:number <- copy 36 get 12:point-number/raw, -1:offset ] +warn: main: invalid offset -1 for point-number :(scenario get_product_type_mismatch) % Hide_warnings = true; recipe main [ 12:number <- copy 34 13:number <- copy 35 14:number <- copy 36 15:address:number <- get 12:point-number/raw, 1:offset ] +warn: main: 'get' 1:offset (1) on point-number can't be saved in 15:address:number; type should be number :(before "End Primitive Recipe Declarations") GET_ADDRESS, :(before "End Primitive Recipe Numbers") Recipe_ordinal["get-address"] = GET_ADDRESS; :(before "End Primitive Recipe Checks") case GET_ADDRESS: { if (SIZE(inst.ingredients) != 2) { raise << maybe(Recipe[r].name) << "'get-address' expects exactly 2 ingredients in '" << inst.to_string() << "'\n" << end(); break; } reagent base = inst.ingredients.at(0); // Update GET_ADDRESS base in Check if (base.types.empty() || Type[base.types.at(0)].kind != container) { raise << maybe(Recipe[r].name) << "first ingredient of 'get-address' should be a container, but got " << inst.ingredients.at(0).original_string << '\n' << end(); break; } type_ordinal base_type = base.types.at(0); reagent offset = inst.ingredients.at(1); if (!is_literal(offset) || !is_mu_scalar(offset)) { raise << maybe(Recipe[r].name) << "second ingredient of 'get' should have type 'offset', but got " << inst.ingredients.at(1).original_string << '\n' << end(); break; } if (is_integer(offset.name)) { // later layers permit non-integer offsets long long int offset_value = to_integer(offset.name); if (offset_value < 0 || offset_value >= SIZE(Type[base_type].elements)) { raise << maybe(Recipe[r].name) << "invalid offset " << offset_value << " for " << Type[base_type].name << '\n' << end(); break; } } break; } :(before "End Primitive Recipe Implementations") case GET_ADDRESS: { reagent base = current_instruction().ingredients.at(0); // Update GET_ADDRESS base in Run long long int base_address = base.value; if (base_address == 0) { raise << maybe(current_recipe_name()) << "tried to access location 0 in '" << current_instruction().to_string() << "'\n" << end(); break; } type_ordinal base_type = base.types.at(0); long long int offset = ingredients.at(1).at(0); if (offset < 0 || offset >= SIZE(Type[base_type].elements)) break; // copied from Check above long long int result = base_address; for (long long int i = 0; i < offset; ++i) { result += size_of(Type[base_type].elements.at(i)); } trace(Primitive_recipe_depth, "run") << "address to copy is " << result << end(); products.resize(1); products.at(0).push_back(result); break; } :(scenario get_address_out_of_bounds) % Hide_warnings = true; recipe main [ 12:number <- copy 34 13:number <- copy 35 14:number <- copy 36 get-address 12:point-number/raw, 2:offset # point-number occupies 3 locations but has only 2 fields; out of bounds ] +warn: main: invalid offset 2 for point-number :(scenario get_address_out_of_bounds_2) % Hide_warnings = true; recipe main [ 12:number <- copy 34 13:number <- copy 35 14:number <- copy 36 get-address 12:point-number/raw, -1:offset ] +warn: main: invalid offset -1 for point-number //:: Allow containers to be defined in mu code. :(scenarios load) :(scenario container) container foo [ x:number y:number ] +parse: reading container foo +parse: element name: x +parse: type: 1 +parse: element name: y +parse: type: 1 :(scenario container_use_before_definition) container foo [ x:number y:bar ] container bar [ x:number y:number ] +parse: reading container foo +parse: type number: 1000 +parse: element name: x +parse: type: 1 +parse: element name: y +parse: type: 1001 +parse: reading container bar +parse: type number: 1001 :(before "End Command Handlers") else if (command == "container") { insert_container(command, container, in); } :(code) void insert_container(const string& command, kind_of_type kind, istream& in) { skip_whitespace(in); string name = next_word(in); trace("parse") << "reading " << command << ' ' << name << end(); if (Type_ordinal.find(name) == Type_ordinal.end() || Type_ordinal[name] == 0) { Type_ordinal[name] = Next_type_ordinal++; } trace("parse") << "type number: " << Type_ordinal[name] << end(); skip_bracket(in, "'container' must begin with '['"); type_info& t = Type[Type_ordinal[name]]; recently_added_types.push_back(Type_ordinal[name]); t.name = name; t.kind = kind; while (!in.eof()) { skip_whitespace_and_comments(in); string element = next_word(in); if (element == "]") break; istringstream inner(element); t.element_names.push_back(slurp_until(inner, ':')); trace("parse") << " element name: " << t.element_names.back() << end(); vector<type_ordinal> types; while (!inner.eof()) { string type_name = slurp_until(inner, ':'); if (Type_ordinal.find(type_name) == Type_ordinal.end() // types can contain integers, like for array sizes && !is_integer(type_name)) { Type_ordinal[type_name] = Next_type_ordinal++; } types.push_back(Type_ordinal[type_name]); trace("parse") << " type: " << types.back() << end(); } t.elements.push_back(types); } assert(SIZE(t.elements) == SIZE(t.element_names)); t.size = SIZE(t.elements); } :(scenarios run) :(scenario container_define_twice) container foo [ x:number ] container foo [ y:number ] recipe main [ 1:number <- copy 34 2:number <- copy 35 3:number <- get 1:foo, 0:offset 4:number <- get 1:foo, 1:offset ] +mem: storing 34 in location 3 +mem: storing 35 in location 4 //: ensure types created in one scenario don't leak outside it. :(before "End Globals") vector<type_ordinal> recently_added_types; :(before "End load_permanently") //: for non-tests recently_added_types.clear(); :(before "End Setup") //: for tests for (long long int i = 0; i < SIZE(recently_added_types); ++i) { Type_ordinal.erase(Type[recently_added_types.at(i)].name); Type.erase(recently_added_types.at(i)); } recently_added_types.clear(); // delete recent type references // can't rely on recently_added_types to cleanup Type_ordinal, because of deliberately misbehaving tests with references to undefined types map<string, type_ordinal>::iterator p = Type_ordinal.begin(); while(p != Type_ordinal.end()) { // save current item string name = p->first; type_ordinal t = p->second; // increment iterator ++p; // now delete current item if necessary if (t >= 1000) { Type_ordinal.erase(name); } } //: lastly, ensure scenarios are consistent by always starting them at the //: same type number. Next_type_ordinal = 1000; :(before "End Test Run Initialization") assert(Next_type_ordinal < 1000); :(before "End Setup") Next_type_ordinal = 1000; //:: Allow container definitions anywhere in the codebase, but warn if you //:: can't find a definition. :(scenario run_warns_on_unknown_types) % Hide_warnings = true; recipe main [ # integer is not a type 1:integer <- copy 0 ] +warn: unknown type: integer :(scenario run_allows_type_definition_after_use) % Hide_warnings = true; recipe main [ 1:bar <- copy 0/raw ] container bar [ x:number ] -warn: unknown type: bar $warn: 0 :(after "int main") Transform.push_back(check_invalid_types); :(code) void check_invalid_types(const recipe_ordinal r) { for (long long int index = 0; index < SIZE(Recipe[r].steps); ++index) { const instruction& inst = Recipe[r].steps.at(index); for (long long int i = 0; i < SIZE(inst.ingredients); ++i) { check_invalid_types(inst.ingredients.at(i)); } for (long long int i = 0; i < SIZE(inst.products); ++i) { check_invalid_types(inst.products.at(i)); } } } void check_invalid_types(const reagent& r) { for (long long int i = 0; i < SIZE(r.types); ++i) { if (r.types.at(i) == 0) continue; if (Type.find(r.types.at(i)) == Type.end()) raise << "unknown type: " << r.properties.at(0).second.at(i) << '\n' << end(); } } :(scenario container_unknown_field) % Hide_warnings = true; container foo [ x:number y:bar ] +warn: unknown type for field y in foo :(scenario read_container_with_bracket_in_comment) container foo [ x:number # ']' in comment y:number ] +parse: reading container foo +parse: element name: x +parse: type: 1 +parse: element name: y +parse: type: 1 :(before "End Transform") check_container_field_types(); :(code) void check_container_field_types() { for (map<type_ordinal, type_info>::iterator p = Type.begin(); p != Type.end(); ++p) { const type_info& info = p->second; for (long long int i = 0; i < SIZE(info.elements); ++i) { for (long long int j = 0; j < SIZE(info.elements.at(i)); ++j) { if (info.elements.at(i).at(j) == 0) continue; if (Type.find(info.elements.at(i).at(j)) == Type.end()) raise << "unknown type for field " << info.element_names.at(i) << " in " << info.name << '\n' << end(); } } } } //:: Construct types out of their constituent fields. Doesn't currently do //:: type-checking but *does* match sizes. :(before "End Primitive Recipe Declarations") MERGE, :(before "End Primitive Recipe Numbers") Recipe_ordinal["merge"] = MERGE; :(before "End Primitive Recipe Checks") case MERGE: { break; } :(before "End Primitive Recipe Implementations") case MERGE: { products.resize(1); for (long long int i = 0; i < SIZE(ingredients); ++i) for (long long int j = 0; j < SIZE(ingredients.at(i)); ++j) products.at(0).push_back(ingredients.at(i).at(j)); break; } :(scenario merge) container foo [ x:number y:number ] recipe main [ 1:foo <- merge 3, 4 ] +mem: storing 3 in location 1 +mem: storing 4 in location 2 //:: helpers :(code) void skip_bracket(istream& in, string message) { skip_whitespace_and_comments(in); if (in.get() != '[') raise << message << '\n' << end(); }