about summary refs log blame commit diff stats
path: root/html/subx/057stop.subx.html
blob: c6fd5f802779fd68aeb76a8e467d46af7fb1b1e1 (plain) (tree)
1
2
3
4
5
6
7
8
9







                                                                                          
                                                                                                      
                                                 

                       

                                                                                           
                    
                                     




                                  
                                                             
                             
                                      

                                                                           
                                
































                                                                                 
                                                                                                                                       
                         
































                                                                                                                                                               

                                                


                                                                                                                                                                                                                             
                                         
                                                                                 
                                                                                                                                                                                                                   
                                                                                                                                 
                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                             
                                                                  
                                         


                                                                                                                                                     
                                                                                                                                                                                                                                          

                                                                                          
                                                                                                                                                                                                                                                                                                                                                                                             



                                                                                                  
                                                                                                                                                                                                                                                                                                                                                                       


















                                                                                                                                                                                      
                                                                                                     

                                                                                                                                                                                                                                                          
                                                                                                     

                                                                                                                                                                                                                                                                                                                                                                                                                    
                                                                                                         

                                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                       
                                                                                                                                                                                                                                                                                                                                                                  




                                                                                                     
                                                                                                                                                                                                                                                                                                                                                                                             


                                                          
                                                                                                                                                                                                    

                                                                                                                                                
                                                                                                                                                                                                                                                                                                               
                                                                                                                  
                                                                                                                                                                                                                                                                                                                                                                                           

                                                                                                     

                                                                                                                                                                                                                                                                                                               


                                                                                                       
                                                                                                                                                                                                                                                                                                               
                                                        
                                                                                                                                                                                                                                                                                                                                                                       
                                                                                                                
                                                                                                                                                                                                                                                                                                                                                                                               


                                                                                                                    
                                                                                                                                             






                                                                                                                                                           
                                                                                                                                                                                                                                                                                                                                                                                              



                                                                                                                                                           

                                                                                                                                                                                                                                                                                                                                                                                                





                                                                                                                                                             
                                                                                                                        
                                                                                                   
                                                                                                                                                                                                                                                                                                                                                                                         



                                                                                                     
                                                                                                               








                                                                                                                                                            
                                                                                                                                                                                                                                                                                                                                                                                            
                                                                                           
                                                                                                                  
                                                                                                   
                                                                                                                                                                                                                                                                                                                                                                                         
                                                                                           
                                                                                                                                    
                                                                                                                                                                                                                                                                                                                                                                                         
                                                           

                                                       
                                                                                                                                                                                                      

                                                                                           
                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                 
                                                                                                                                                                                                                                                                                                                                                                                            
                                                                                           
                                                                                                               


                                                                                                                 
                                                                                                                                                                                                                                                                                                                                                                                         





                                                                                                                                          
                                                                                                                  
                                                                                                   
                                                                                                                                                                                                                                                                                                                                                                                         
                                                                                           
                                                                                                                                                                                                                                                                                                                                                                                              


                                                           
                                                                                                                                                                                                      

                                                                                           
                                                                                                                                                                                                                                                                                                                                                                                              


                                                                                                
                                                                                                                                                                                                                                                                                                                                                                                            
                                                                                           
                                                                                                      


                                                                                                                 
                                                                                                                                                                                                                                                                                                                                                                                              



                                                                                                               



                                     
<!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/057stop.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-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; }
.Constant { color: #008787; }
.LineNr { }
.subxS1Comment { color: #0000af; }
.CommentedCode { color: #8a8a8a; }
.subxFunction { color: #af5f00; text-decoration: underline; }
.subxTest { color: #5f8700; }
.subxMinorFunction { color: #875f5f; }
.Normal { color: #000000; background-color: #c6c6c6; padding-bottom: 1px; }
.subxS2Comment { color: #8a8a8a; }
.SpecialChar { color: #d70000; }
-->
</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();'>
<a href='https://github.com/akkartik/mu/blob/master/subx/057stop.subx'>https://github.com/akkartik/mu/blob/master/subx/057stop.subx</a>
<pre id='vimCodeElement'>
<span id="L1" class="LineNr">  1 </span><span class="subxComment"># stop: dependency-injected wrapper around the exit() syscall</span>
<span id="L2" class="LineNr">  2 </span><span class="subxComment">#</span>
<span id="L3" class="LineNr">  3 </span><span class="subxComment"># We'd like to be able to write tests for functions that call exit(), and to</span>
<span id="L4" class="LineNr">  4 </span><span class="subxComment"># make assertions about whether they exit() or not in a given situation. To</span>
<span id="L5" class="LineNr">  5 </span><span class="subxComment"># achieve this we'll call exit() via a smarter wrapper called 'stop'.</span>
<span id="L6" class="LineNr">  6 </span><span class="subxComment">#</span>
<span id="L7" class="LineNr">  7 </span><span class="subxComment"># In the context of a test, calling a function X that calls 'stop' (directly</span>
<span id="L8" class="LineNr">  8 </span><span class="subxComment"># or through further intervening calls) will unwind the stack until X returns,</span>
<span id="L9" class="LineNr">  9 </span><span class="subxComment"># so that we can say check any further assertions after the execution of X. To</span>
<span id="L10" class="LineNr"> 10 </span><span class="subxComment"># achieve this end, we'll pass the return address of X as a 'target' argument</span>
<span id="L11" class="LineNr"> 11 </span><span class="subxComment"># into X, plumbing it through to 'stop'. When 'stop' gets a non-null target it</span>
<span id="L12" class="LineNr"> 12 </span><span class="subxComment"># unwinds the stack until the target. If it gets a null target it calls</span>
<span id="L13" class="LineNr"> 13 </span><span class="subxComment"># exit().</span>
<span id="L14" class="LineNr"> 14 </span><span class="subxComment">#</span>
<span id="L15" class="LineNr"> 15 </span><span class="subxComment"># We'd also like to get the exit status out of 'stop', so we'll combine the</span>
<span id="L16" class="LineNr"> 16 </span><span class="subxComment"># input target with an output status parameter into a type called 'exit-descriptor'.</span>
<span id="L17" class="LineNr"> 17 </span><span class="subxComment">#</span>
<span id="L18" class="LineNr"> 18 </span><span class="subxComment"># So the exit-descriptor looks like this:</span>
<span id="L19" class="LineNr"> 19 </span><span class="subxComment">#   target : address  # return address for 'stop' to unwind to</span>
<span id="L20" class="LineNr"> 20 </span><span class="subxComment">#   value : int  # exit status stop was called with</span>
<span id="L21" class="LineNr"> 21 </span><span class="subxComment">#</span>
<span id="L22" class="LineNr"> 22 </span><span class="subxComment"># 'stop' thus takes two parameters: an exit-descriptor and the exit status.</span>
<span id="L23" class="LineNr"> 23 </span><span class="subxComment">#</span>
<span id="L24" class="LineNr"> 24 </span><span class="subxComment"># 'stop' won't bother cleaning up any other processor state besides the stack,</span>
<span id="L25" class="LineNr"> 25 </span><span class="subxComment"># such as registers. Only ESP will have a well-defined value after 'stop'</span>
<span id="L26" class="LineNr"> 26 </span><span class="subxComment"># returns. (This is a poor man's setjmp/longjmp, if you know what that is.)</span>
<span id="L27" class="LineNr"> 27 </span><span class="subxComment">#</span>
<span id="L28" class="LineNr"> 28 </span><span class="subxComment"># Before you can call any function that may call 'stop', you need to pass in an</span>
<span id="L29" class="LineNr"> 29 </span><span class="subxComment"># exit-descriptor to it. To create an exit-descriptor use 'tailor-exit-descriptor'</span>
<span id="L30" class="LineNr"> 30 </span><span class="subxComment"># below. It's not the most pleasant abstraction in the world.</span>
<span id="L31" class="LineNr"> 31 </span><span class="subxComment">#</span>
<span id="L32" class="LineNr"> 32 </span><span class="subxComment"># An exit-descriptor's target is its input, computed during 'tailor-exit-descriptor'.</span>
<span id="L33" class="LineNr"> 33 </span><span class="subxComment"># Its value is its output, computed during stop and available to the test.</span>
<span id="L34" class="LineNr"> 34 </span>
<span id="L35" class="LineNr"> 35 </span>== code
<span id="L36" class="LineNr"> 36 </span><span class="subxComment">#   instruction                     effective address                                                   register    displacement    immediate</span>
<span id="L37" class="LineNr"> 37 </span><span class="subxS1Comment"># . op          subop               mod             rm32          base        index         scale       r32</span>
<span id="L38" class="LineNr"> 38 </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="L39" class="LineNr"> 39 </span>
<span id="L40" class="LineNr"> 40 </span><span class="subxComment"># main:</span>
<span id="L41" class="LineNr"> 41 </span>    e8/call  run-tests/disp32  <span class="subxComment"># 'run-tests' is a function created automatically by SubX. It calls all functions that start with 'test-'.</span>
<span id="L42" class="LineNr"> 42 </span><span class="CommentedCode">#?     e8/call test-stop-skips-returns-on-exit/disp32</span>
<span id="L43" class="LineNr"> 43 </span>    <span class="subxComment"># syscall(exit, Num-test-failures)</span>
<span id="L44" class="LineNr"> 44 </span>    8b/copy                         0/mod/indirect  5/rm32/.disp32           <span class="Normal"> . </span>           <span class="Normal"> . </span>          3/r32/EBX   <span class="SpecialChar"><a href='051test.subx.html#L87'>Num-test-failures</a></span>/disp32          <span class="subxComment"># copy *Num-test-failures to EBX</span>
<span id="L45" class="LineNr"> 45 </span>    b8/copy-to-EAX  1/imm32/exit
<span id="L46" class="LineNr"> 46 </span>    cd/syscall  0x80/imm8
<span id="L47" class="LineNr"> 47 </span>
<span id="L48" class="LineNr"> 48 </span><span class="subxComment"># Configure an exit-descriptor for a call pushing 'nbytes' bytes of args to</span>
<span id="L49" class="LineNr"> 49 </span><span class="subxComment"># the stack.</span>
<span id="L50" class="LineNr"> 50 </span><span class="subxComment"># Ugly that we need to know the size of args, but so it goes.</span>
<span id="L51" class="LineNr"> 51 </span><span class="subxFunction"><a href='057stop.subx.html#L51'>tailor-exit-descriptor</a></span>:  <span class="subxComment"># ed : (address exit-descriptor), nbytes : int -&gt; &lt;void&gt;</span>
<span id="L52" class="LineNr"> 52 </span>    <span class="subxS1Comment"># . prolog</span>
<span id="L53" class="LineNr"> 53 </span>    55/push-EBP
<span id="L54" class="LineNr"> 54 </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="L55" class="LineNr"> 55 </span>    <span class="subxS1Comment"># . save registers</span>
<span id="L56" class="LineNr"> 56 </span>    50/push-EAX
<span id="L57" class="LineNr"> 57 </span>    51/push-ECX
<span id="L58" class="LineNr"> 58 </span>    <span class="subxComment"># EAX = nbytes</span>
<span id="L59" class="LineNr"> 59 </span>    8b/copy                         1/mod/*+disp8   5/rm32/EBP   <span class="Normal"> . </span>         <span class="Normal"> . </span>           <span class="Normal"> . </span>          0/r32/EAX   0xc/disp8      <span class="Normal"> . </span>                <span class="subxComment"># copy *(EBP+12) to EAX</span>
<span id="L60" class="LineNr"> 60 </span>    <span class="subxComment"># Let X be the value of ESP in the caller, before the call to tailor-exit-descriptor.</span>
<span id="L61" class="LineNr"> 61 </span>    <span class="subxComment"># The return address for a call in the caller's body will be at:</span>
<span id="L62" class="LineNr"> 62 </span>    <span class="subxComment">#   X-8 if the caller takes 4 bytes of args for the exit-descriptor (add 4 bytes for the return address)</span>
<span id="L63" class="LineNr"> 63 </span>    <span class="subxComment">#   X-12 if the caller takes 8 bytes of args</span>
<span id="L64" class="LineNr"> 64 </span>    <span class="subxComment">#   ..and so on</span>
<span id="L65" class="LineNr"> 65 </span>    <span class="subxComment"># That's the value we need to return: X-nbytes-4</span>
<span id="L66" class="LineNr"> 66 </span>    <span class="subxComment">#</span>
<span id="L67" class="LineNr"> 67 </span>    <span class="subxComment"># However, we also need to account for the perturbance to ESP caused by the</span>
<span id="L68" class="LineNr"> 68 </span>    <span class="subxComment"># call to tailor-exit-descriptor. It pushes 8 bytes of args followed by 4</span>
<span id="L69" class="LineNr"> 69 </span>    <span class="subxComment"># bytes for the return address and 4 bytes to push EBP above.</span>
<span id="L70" class="LineNr"> 70 </span>    <span class="subxComment"># So EBP at this point is X-16.</span>
<span id="L71" class="LineNr"> 71 </span>    <span class="subxComment">#</span>
<span id="L72" class="LineNr"> 72 </span>    <span class="subxComment"># So the return address for the next call in the caller is:</span>
<span id="L73" class="LineNr"> 73 </span>    <span class="subxComment">#   EBP+8 if the caller takes 4 bytes of args</span>
<span id="L74" class="LineNr"> 74 </span>    <span class="subxComment">#   EBP+4 if the caller takes 8 bytes of args</span>
<span id="L75" class="LineNr"> 75 </span>    <span class="subxComment">#   EBP if the caller takes 12 bytes of args</span>
<span id="L76" class="LineNr"> 76 </span>    <span class="subxComment">#   EBP-4 if the caller takes 16 bytes of args</span>
<span id="L77" class="LineNr"> 77 </span>    <span class="subxComment">#   ..and so on</span>
<span id="L78" class="LineNr"> 78 </span>    <span class="subxComment"># That's EBP+12-nbytes.</span>
<span id="L79" class="LineNr"> 79 </span>    <span class="subxComment"># option 1: 6 + 3 bytes</span>
<span id="L80" class="LineNr"> 80 </span><span class="CommentedCode">#?     2d/subtract                     3/mod/direct    0/rm32/EAX    .           .             .           .           .               8/imm32           # subtract from EAX</span>
<span id="L81" class="LineNr"> 81 </span><span class="CommentedCode">#?     8d/copy-address                 0/mod/indirect  4/rm32/sib    5/base/EBP  0/index/EAX   .           0/r32/EAX   .               .                 # copy EBP+EAX to EAX</span>
<span id="L82" class="LineNr"> 82 </span>    <span class="subxComment"># option 2: 2 + 4 bytes</span>
<span id="L83" class="LineNr"> 83 </span>    f7          3/subop/negate      3/mod/direct    0/rm32/EAX   <span class="Normal"> . </span>         <span class="Normal"> . </span>           <span class="Normal"> . </span>         <span class="Normal"> . </span>         <span class="Normal"> . </span>             <span class="Normal"> . </span>                <span class="subxComment"># negate EAX</span>
<span id="L84" class="LineNr"> 84 </span>    8d/copy-address                 1/mod/*+disp8   4/rm32/sib    5/base/EBP  0/index/EAX  <span class="Normal"> . </span>          0/r32/EAX   0xc/disp8        <span class="Normal"> . </span>              <span class="subxComment"># copy EBP+EAX+12 to EAX</span>
<span id="L85" class="LineNr"> 85 </span>    <span class="subxComment"># copy EAX to ed-&gt;target</span>
<span id="L86" class="LineNr"> 86 </span>    8b/copy                         1/mod/*+disp8   5/rm32/EBP   <span class="Normal"> . </span>         <span class="Normal"> . </span>           <span class="Normal"> . </span>          1/r32/ECX   8/disp8        <span class="Normal"> . </span>                <span class="subxComment"># copy *(EBP+8) to ECX</span>
<span id="L87" class="LineNr"> 87 </span>    89/copy                         0/mod/indirect  1/rm32/ECX   <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 *ECX</span>
<span id="L88" class="LineNr"> 88 </span>    <span class="subxComment"># initialize ed-&gt;value</span>
<span id="L89" class="LineNr"> 89 </span>    c7          0/subop/copy        1/mod/*+disp8   1/rm32/ECX   <span class="Normal"> . </span>         <span class="Normal"> . </span>           <span class="Normal"> . </span>         <span class="Normal"> . </span>          4/disp8         0/imm32           <span class="subxComment"># copy to *(ECX+4)</span>
<span id="L90" class="LineNr"> 90 </span><span class="Constant">$tailor-exit-descriptor:end</span>:
<span id="L91" class="LineNr"> 91 </span>    <span class="subxS1Comment"># . restore registers</span>
<span id="L92" class="LineNr"> 92 </span>    59/pop-to-ECX
<span id="L93" class="LineNr"> 93 </span>    58/pop-to-EAX
<span id="L94" class="LineNr"> 94 </span>    <span class="subxS1Comment"># . epilog</span>
<span id="L95" class="LineNr"> 95 </span>    89/copy                         3/mod/direct    4/rm32/ESP   <span class="Normal"> . </span>         <span class="Normal"> . </span>           <span class="Normal"> . </span>          5/r32/EBP  <span class="Normal"> . </span>             <span class="Normal"> . </span>                <span class="subxComment"># copy EBP to ESP</span>
<span id="L96" class="LineNr"> 96 </span>    5d/pop-to-EBP
<span id="L97" class="LineNr"> 97 </span>    c3/return
<span id="L98" class="LineNr"> 98 </span>
<span id="L99" class="LineNr"> 99 </span><span class="subxFunction"><a href='057stop.subx.html#L99'>stop</a></span>:  <span class="subxComment"># ed : (address exit-descriptor), value : int</span>
<span id="L100" class="LineNr">100 </span>    <span class="subxComment"># no prolog; one way or another, we're going to clobber registers</span>
<span id="L101" class="LineNr">101 </span>    <span class="subxComment"># EAX = ed</span>
<span id="L102" class="LineNr">102 </span>    8b/copy                         1/mod/*+disp8   4/rm32/sib    4/base/ESP  4/index/none <span class="Normal"> . </span>          0/r32/EAX   4/disp8        <span class="Normal"> . </span>                <span class="subxComment"># copy *(ESP+4) to EAX</span>
<span id="L103" class="LineNr">103 </span>    <span class="subxComment"># exit(value) if ed-&gt;target == 0</span>
<span id="L104" class="LineNr">104 </span>    81          7/subop/compare     0/mod/indirect  0/rm32/EAX   <span class="Normal"> . </span>         <span class="Normal"> . </span>           <span class="Normal"> . </span>         <span class="Normal"> . </span>         <span class="Normal"> . </span>              0/imm32           <span class="subxComment"># compare *EAX</span>
<span id="L105" class="LineNr">105 </span>    75/jump-if-not-equal  $stop:fake/disp8
<span id="L106" class="LineNr">106 </span>    <span class="subxComment"># syscall(exit, value)</span>
<span id="L107" class="LineNr">107 </span>    8b/copy                         1/mod/*+disp8   4/rm32/sib    4/base/ESP  4/index/none <span class="Normal"> . </span>          3/r32/EBX   8/disp8        <span class="Normal"> . </span>                <span class="subxComment"># copy *(ESP+8) to EBX</span>
<span id="L108" class="LineNr">108 </span>    b8/copy-to-EAX  1/imm32/exit
<span id="L109" class="LineNr">109 </span>    cd/syscall  0x80/imm8
<span id="L110" class="LineNr">110 </span><span class="Constant">$stop:fake</span>:
<span id="L111" class="LineNr">111 </span>    <span class="subxComment"># ed-&gt;value = value+1</span>
<span id="L112" class="LineNr">112 </span>    8b/copy                         1/mod/*+disp8   4/rm32/sib    4/base/ESP  4/index/none <span class="Normal"> . </span>          1/r32/ECX   8/disp8        <span class="Normal"> . </span>                <span class="subxComment"># copy *(ESP+8) to ECX</span>
<span id="L113" class="LineNr">113 </span>    41/inc-ECX
<span id="L114" class="LineNr">114 </span>    89/copy                         1/mod/*+disp8   0/rm32/EAX   <span class="Normal"> . </span>         <span class="Normal"> . </span>           <span class="Normal"> . </span>          1/r32/ECX   4/disp8        <span class="Normal"> . </span>                <span class="subxComment"># copy ECX to *(EAX+4)</span>
<span id="L115" class="LineNr">115 </span>    <span class="subxComment"># non-local jump to ed-&gt;target</span>
<span id="L116" class="LineNr">116 </span>    8b/copy                         0/mod/indirect  0/rm32/EAX   <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 *EAX to ESP</span>
<span id="L117" class="LineNr">117 </span><span class="Constant">$stop:end</span>:
<span id="L118" class="LineNr">118 </span>    c3/return  <span class="subxComment"># doesn't return to caller</span>
<span id="L119" class="LineNr">119 </span>
<span id="L120" class="LineNr">120 </span><span class="subxTest"><a href='057stop.subx.html#L120'>test-stop-skips-returns-on-exit</a></span>:
<span id="L121" class="LineNr">121 </span>    <span class="subxComment"># This looks like the standard prolog, but is here for different reasons.</span>
<span id="L122" class="LineNr">122 </span>    <span class="subxComment"># A function calling 'stop' can't rely on EBP persisting past the call.</span>
<span id="L123" class="LineNr">123 </span>    <span class="subxComment">#</span>
<span id="L124" class="LineNr">124 </span>    <span class="subxComment"># Use EBP here as a stable base to refer to locals and arguments from in the</span>
<span id="L125" class="LineNr">125 </span>    <span class="subxComment"># presence of push/pop/call instructions.</span>
<span id="L126" class="LineNr">126 </span>    <span class="subxComment"># *Don't* use EBP as a way to restore ESP.</span>
<span id="L127" class="LineNr">127 </span>    55/push-EBP
<span id="L128" class="LineNr">128 </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="L129" class="LineNr">129 </span>    <span class="subxComment"># Make room for an exit descriptor on the stack. That's almost always the</span>
<span id="L130" class="LineNr">130 </span>    <span class="subxComment"># right place for it, available only as long as it's legal to use. Once this</span>
<span id="L131" class="LineNr">131 </span>    <span class="subxComment"># containing function returns we'll need a new exit descriptor.</span>
<span id="L132" class="LineNr">132 </span>    <span class="subxComment"># var ed/EAX : (address exit-descriptor)</span>
<span id="L133" class="LineNr">133 </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>              8/imm32           <span class="subxComment"># subtract from ESP</span>
<span id="L134" class="LineNr">134 </span>    89/copy                         3/mod/direct    0/rm32/EAX   <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 EAX</span>
<span id="L135" class="LineNr">135 </span>    <span class="subxComment"># Size the exit-descriptor precisely for the next call below, to _test-stop-1.</span>
<span id="L136" class="LineNr">136 </span>    <span class="subxComment"># tailor-exit-descriptor(ed, 4)</span>
<span id="L137" class="LineNr">137 </span>    <span class="subxS2Comment"># . . push args</span>
<span id="L138" class="LineNr">138 </span>    68/push  4/imm32/nbytes-of-args-for-_test-stop-1
<span id="L139" class="LineNr">139 </span>    50/push-EAX
<span id="L140" class="LineNr">140 </span>    <span class="subxS2Comment"># . . call</span>
<span id="L141" class="LineNr">141 </span>    e8/call  <a href='057stop.subx.html#L51'>tailor-exit-descriptor</a>/disp32
<span id="L142" class="LineNr">142 </span>    <span class="subxS2Comment"># . . discard args</span>
<span id="L143" class="LineNr">143 </span>    81          0/subop/add         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>              8/imm32           <span class="subxComment"># add to ESP</span>
<span id="L144" class="LineNr">144 </span>    <span class="subxS1Comment"># . _test-stop-1(ed)</span>
<span id="L145" class="LineNr">145 </span>    <span class="subxS2Comment"># . . push args</span>
<span id="L146" class="LineNr">146 </span>    50/push-EAX
<span id="L147" class="LineNr">147 </span>    <span class="subxS2Comment"># . . call</span>
<span id="L148" class="LineNr">148 </span>    e8/call  <a href='057stop.subx.html#L169'>_test-stop-1</a>/disp32
<span id="L149" class="LineNr">149 </span>    <span class="subxComment"># registers except ESP may be clobbered at this point</span>
<span id="L150" class="LineNr">150 </span>    <span class="subxComment"># restore args</span>
<span id="L151" class="LineNr">151 </span>    58/pop-to-EAX
<span id="L152" class="LineNr">152 </span>    <span class="subxComment"># check that _test-stop-1 tried to call exit(1)</span>
<span id="L153" class="LineNr">153 </span>    <span class="subxComment"># check-ints-equal(ed-&gt;value, 2, msg)  # i.e. stop was called with value 1</span>
<span id="L154" class="LineNr">154 </span>    <span class="subxS2Comment"># . . push args</span>
<span id="L155" class="LineNr">155 </span>    68/push  <span class="Constant">&quot;F - test-stop-skips-returns-on-exit&quot;</span>/imm32
<span id="L156" class="LineNr">156 </span>    68/push  2/imm32
<span id="L157" class="LineNr">157 </span>    <span class="subxS2Comment"># . . push ed-&gt;value</span>
<span id="L158" class="LineNr">158 </span>    ff          6/subop/push        1/mod/*+disp8   0/rm32/EAX   <span class="Normal"> . </span>         <span class="Normal"> . </span>           <span class="Normal"> . </span>         <span class="Normal"> . </span>          4/disp8        <span class="Normal"> . </span>                <span class="subxComment"># push *(EAX+4)</span>
<span id="L159" class="LineNr">159 </span>    <span class="subxS2Comment"># . . call</span>
<span id="L160" class="LineNr">160 </span>    e8/call  <a href='051test.subx.html#L24'>check-ints-equal</a>/disp32
<span id="L161" class="LineNr">161 </span>    <span class="subxS2Comment"># . . discard args</span>
<span id="L162" class="LineNr">162 </span>    81          0/subop/add         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>              0xc/imm32         <span class="subxComment"># add to ESP</span>
<span id="L163" class="LineNr">163 </span>    <span class="subxS1Comment"># . epilog</span>
<span id="L164" class="LineNr">164 </span>    <span class="subxComment"># don't restore ESP from EBP; manually reclaim locals</span>
<span id="L165" class="LineNr">165 </span>    81          0/subop/add         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>              8/imm32           <span class="subxComment"># add to ESP</span>
<span id="L166" class="LineNr">166 </span>    5d/pop-to-EBP
<span id="L167" class="LineNr">167 </span>    c3/return
<span id="L168" class="LineNr">168 </span>
<span id="L169" class="LineNr">169 </span><span class="subxMinorFunction"><a href='057stop.subx.html#L169'>_test-stop-1</a></span>:  <span class="subxComment"># ed : (address exit-descriptor)</span>
<span id="L170" class="LineNr">170 </span>    <span class="subxS1Comment"># . prolog</span>
<span id="L171" class="LineNr">171 </span>    55/push-EBP
<span id="L172" class="LineNr">172 </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="L173" class="LineNr">173 </span>    <span class="subxComment"># _test-stop-2(ed)</span>
<span id="L174" class="LineNr">174 </span>    <span class="subxS2Comment"># . . push args</span>
<span id="L175" class="LineNr">175 </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="L176" class="LineNr">176 </span>    <span class="subxS2Comment"># . . call</span>
<span id="L177" class="LineNr">177 </span>    e8/call  <a href='057stop.subx.html#L196'>_test-stop-2</a>/disp32
<span id="L178" class="LineNr">178 </span>    <span class="subxComment"># should never get past this point</span>
<span id="L179" class="LineNr">179 </span><span class="Constant">$_test-stop-1:dead-end</span>:
<span id="L180" class="LineNr">180 </span>    <span class="subxS2Comment"># . . discard args</span>
<span id="L181" class="LineNr">181 </span>    81          0/subop/add         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"># add to ESP</span>
<span id="L182" class="LineNr">182 </span>    <span class="subxComment"># signal test failed: check-ints-equal(1, 0, msg)</span>
<span id="L183" class="LineNr">183 </span>    <span class="subxS2Comment"># . . push args</span>
<span id="L184" class="LineNr">184 </span>    68/push  <span class="Constant">&quot;F - test-stop-skips-returns-on-exit&quot;</span>/imm32
<span id="L185" class="LineNr">185 </span>    68/push  0/imm32
<span id="L186" class="LineNr">186 </span>    68/push  1/imm32
<span id="L187" class="LineNr">187 </span>    <span class="subxS2Comment"># . . call</span>
<span id="L188" class="LineNr">188 </span>    e8/call  <a href='051test.subx.html#L24'>check-ints-equal</a>/disp32
<span id="L189" class="LineNr">189 </span>    <span class="subxS2Comment"># . . discard args</span>
<span id="L190" class="LineNr">190 </span>    81          0/subop/add         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>              0xc/imm32         <span class="subxComment"># add to ESP</span>
<span id="L191" class="LineNr">191 </span>    <span class="subxS1Comment"># . epilog</span>
<span id="L192" class="LineNr">192 </span>    89/copy                         3/mod/direct    4/rm32/ESP   <span class="Normal"> . </span>         <span class="Normal"> . </span>           <span class="Normal"> . </span>          5/r32/EBP  <span class="Normal"> . </span>             <span class="Normal"> . </span>                <span class="subxComment"># copy EBP to ESP</span>
<span id="L193" class="LineNr">193 </span>    5d/pop-to-EBP
<span id="L194" class="LineNr">194 </span>    c3/return
<span id="L195" class="LineNr">195 </span>
<span id="L196" class="LineNr">196 </span><span class="subxMinorFunction"><a href='057stop.subx.html#L196'>_test-stop-2</a></span>:  <span class="subxComment"># ed : (address exit-descriptor)</span>
<span id="L197" class="LineNr">197 </span>    <span class="subxS1Comment"># . prolog</span>
<span id="L198" class="LineNr">198 </span>    55/push-EBP
<span id="L199" class="LineNr">199 </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="L200" class="LineNr">200 </span>    <span class="subxS1Comment"># . stop(ed, 1)</span>
<span id="L201" class="LineNr">201 </span>    <span class="subxS2Comment"># . . push args</span>
<span id="L202" class="LineNr">202 </span>    68/push  1/imm32
<span id="L203" class="LineNr">203 </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="L204" class="LineNr">204 </span>    <span class="subxS2Comment"># . . call</span>
<span id="L205" class="LineNr">205 </span>    e8/call  <a href='057stop.subx.html#L99'>stop</a>/disp32
<span id="L206" class="LineNr">206 </span>    <span class="subxComment"># should never get past this point</span>
<span id="L207" class="LineNr">207 </span><span class="Constant">$_test-stop-2:dead-end</span>:
<span id="L208" class="LineNr">208 </span>    <span class="subxS1Comment"># . epilog</span>
<span id="L209" class="LineNr">209 </span>    89/copy                         3/mod/direct    4/rm32/ESP   <span class="Normal"> . </span>         <span class="Normal"> . </span>           <span class="Normal"> . </span>          5/r32/EBP  <span class="Normal"> . </span>             <span class="Normal"> . </span>                <span class="subxComment"># copy EBP to ESP</span>
<span id="L210" class="LineNr">210 </span>    5d/pop-to-EBP
<span id="L211" class="LineNr">211 </span>    c3/return
<span id="L212" class="LineNr">212 </span>
<span id="L213" class="LineNr">213 </span><span class="subxS2Comment"># . . vim&#0058;nowrap:textwidth=0</span>
</pre>
</body>
</html>
<!-- vim: set foldmethod=manual : -->