<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<meta name="robots" content="index,nofollow">



<title>Stabilizers - MLton Standard ML Compiler (SML Compiler)</title>
<link rel="stylesheet" type="text/css" charset="iso-8859-1" media="all" href="common.css">
<link rel="stylesheet" type="text/css" charset="iso-8859-1" media="screen" href="screen.css">
<link rel="stylesheet" type="text/css" charset="iso-8859-1" media="print" href="print.css">


<link rel="Start" href="Home">


<link rel="Appendix" title="stabilizers_alpha_2006-09-29.tar.gz" href="http://mlton.org/pages/Stabilizers/attachments/stabilizers_alpha_2006-09-29.tar.gz">
<link rel="Appendix" title="stabilizers_alpha_2006-10-09.tar.gz" href="http://mlton.org/pages/Stabilizers/attachments/stabilizers_alpha_2006-10-09.tar.gz">
</head>

<body lang="en" dir="ltr">

<script src="http://www.google-analytics.com/urchin.js" type="text/javascript">
</script>
<script type="text/javascript">
_uacct = "UA-833377-1";
urchinTracker();
</script>
<table bgcolor = lightblue cellspacing = 0 style = "border: 0px;" width = 100%>
  <tr>
    <td style = "
		border: 0px;
		color: darkblue; 
		font-size: 150%;
		text-align: left;">
      <a class = mltona href="Home">MLton 20061025</a>
    <td style = "
		border: 0px;
		font-size: 150%;
		text-align: center;
		width: 50%;">
      Stabilizers
    <td style = "
		border: 0px;
		text-align: right;">
      <table cellspacing = 0 style = "border: 0px">
        <tr style = "vertical-align: middle;">
      </table>
  <tr style = "background-color: white;">
    <td colspan = 3
	style = "
		border: 0px;
		font-size:70%;
		text-align: right;">
      <a href = "Home">Home</a>
      &nbsp;<a href = "Index">Index</a>
      &nbsp;
</table>
<div id="content" lang="en" dir="ltr">
<h2 id="head-c81b79df3c6448eae7c4f80428b54cd5692a17d7">Installation</h2>

    <ul>

    <li>
<p>
 Stabilizers currently require the MLton sources, this should be fixed by the next release 
</p>
</li>

    </ul>


<h3 id="head-3229609e15436ec51bcf00818a69a84dbc58a0c2">License</h3>

    <ul>

    <li>
<p>
 Stabilizers are released under the MLton License 
</p>
</li>

    </ul>


<h3 id="head-ed58f29743f8e14b9c8e13d41e070a1cc1d1c9f5">Instructions</h3>

    <ul>

    <li>
<p>
 Download and build a source copy of MLton 
</p>
</li>
    <li>
<p>
 Extract the tar.gz file attached to this wiki page 
</p>
</li>
    <li>
<p>
 Some examples are provided in the "examples/" sub directory, more examples will be added to this page in the following week 
</p>
</li>

    </ul>


<h2 id="head-a1ce09c8340ea8a92a6ab955588a7dfba7597534">Bug reports / Suggestions</h2>

    <ul>

    <li>
<p>
 Please send any errors you encounter to schatzp and lziarek at cs.purdue.edu 
</p>
</li>
    <li>
<p>
 We are looking to expand the usability of stabilizers 
</p>
</li>
    <li>
<p>
 Please send any suggestions and desired functionality to the above email addresses 
</p>
</li>

    </ul>


<h2 id="head-2c924e3088204ee77ba681f72be3444357932fca">Note</h2>

    <ul>

    <li>
<p>
 This is an alpha release. We expect to have another release shortly with added functionality soon 
</p>
</li>
    <li>
<p>
 More documentation, such as signatures and descriptions of functionality, will be forthcoming  
</p>
</li>

    </ul>


<h2 id="head-9e9cf3221a30246219863f1d2366e36cb580debc">Documentation</h2>

<pre class=code>
<B><FONT COLOR="#5F9EA0">signature</FONT></B> STABLE <B><FONT COLOR="#5F9EA0">=</FONT></B>
  <B><FONT COLOR="#5F9EA0">sig</FONT></B>
     <B><FONT COLOR="#A020F0">type</FONT></B> checkpoint

     <B><FONT COLOR="#A020F0">val</FONT></B> stable: ('a <B><FONT COLOR="#5F9EA0">-</FONT></B><B><FONT COLOR="#5F9EA0">&gt;</FONT></B> 'b) <B><FONT COLOR="#5F9EA0">-</FONT></B><B><FONT COLOR="#5F9EA0">&gt;</FONT></B> ('a <B><FONT COLOR="#5F9EA0">-</FONT></B><B><FONT COLOR="#5F9EA0">&gt;</FONT></B> 'b)
     <B><FONT COLOR="#A020F0">val</FONT></B> stabilize: <B><FONT COLOR="#228B22">unit</FONT></B> <B><FONT COLOR="#5F9EA0">-</FONT></B><B><FONT COLOR="#5F9EA0">&gt;</FONT></B> 'a

     <B><FONT COLOR="#A020F0">val</FONT></B> stableCP: (('a <B><FONT COLOR="#5F9EA0">-</FONT></B><B><FONT COLOR="#5F9EA0">&gt;</FONT></B> 'b) <B><FONT COLOR="#5F9EA0">*</FONT></B> (<B><FONT COLOR="#228B22">unit</FONT></B> <B><FONT COLOR="#5F9EA0">-</FONT></B><B><FONT COLOR="#5F9EA0">&gt;</FONT></B> <B><FONT COLOR="#228B22">unit</FONT></B>)) <B><FONT COLOR="#5F9EA0">-</FONT></B><B><FONT COLOR="#5F9EA0">&gt;</FONT></B> 
                    (('a <B><FONT COLOR="#5F9EA0">-</FONT></B><B><FONT COLOR="#5F9EA0">&gt;</FONT></B> 'b) <B><FONT COLOR="#5F9EA0">*</FONT></B>  checkpoint)
     <B><FONT COLOR="#A020F0">val</FONT></B> stabilizeCP: checkpoint <B><FONT COLOR="#5F9EA0">-</FONT></B><B><FONT COLOR="#5F9EA0">&gt;</FONT></B> <B><FONT COLOR="#228B22">unit</FONT></B>

     <B><FONT COLOR="#A020F0">val</FONT></B> unmonitoredAssign: ('a <B><FONT COLOR="#A020F0">ref</FONT></B> <B><FONT COLOR="#5F9EA0">*</FONT></B> 'a) <B><FONT COLOR="#5F9EA0">-</FONT></B><B><FONT COLOR="#5F9EA0">&gt;</FONT></B> <B><FONT COLOR="#228B22">unit</FONT></B>
     <B><FONT COLOR="#A020F0">val</FONT></B> monitoredAssign: ('a <B><FONT COLOR="#A020F0">ref</FONT></B> <B><FONT COLOR="#5F9EA0">*</FONT></B> 'a) <B><FONT COLOR="#5F9EA0">-</FONT></B><B><FONT COLOR="#5F9EA0">&gt;</FONT></B> <B><FONT COLOR="#228B22">unit</FONT></B>
  <B><FONT COLOR="#A020F0">end</FONT></B>
</PRE>
<p>
 
</p>
<p>
<tt>Stable</tt> provides functions to manage stable sections. 
</p>

    <ul>

    <li>
<p>
 <tt>type&nbsp;checkpoint</tt> 
</p>
</li>

        <ul>

  handle used to stabilize contexts other than the current one. 
        </ul>


    <li class="gap">
<p>
 <tt>stable&nbsp;f</tt> 
</p>
</li>

        <ul>

  returns a function identical to <tt>f</tt> that will execute within a stable section. 
        </ul>


    <li class="gap">
<p>
 <tt>stabilize&nbsp;()</tt> 
</p>
</li>

        <ul>

  unrolls the effects made up to the current context    to at least the nearest enclosing {{stable}}} section.   These effects may have propagated to other threads,    so all affected threads are returned to a globally consistent previous state.   The return is undefined because control cannot resume after stabilize is called. 
        </ul>


    <li class="gap">
<p>
 <tt>stableCP&nbsp;(f,&nbsp;comp)</tt> 
</p>
</li>

        <ul>

  returns a function <tt>f'</tt> and checkpoint tag <tt>cp</tt>.   Function <tt>f'</tt> is identical to <tt>f</tt> but when applied will execute within a stable section.   <tt>comp</tt> will be executed if <tt>f'</tt> is later stabilized.   <tt>cp</tt> is used by <tt>stabilizeCP</tt> to stabilize a given checkpoint. 
        </ul>


    <li class="gap">
<p>
 <tt>stabilizeCP&nbsp;cp</tt> 
</p>
</li>

        <ul>

  same as stabilize except that the (possibly current) checkpoint to stabilize is provided. 
        </ul>


    <li class="gap">
<p>
 <tt>unmonitoredAssign&nbsp;(r,&nbsp;v)</tt> 
</p>
</li>

        <ul>

  standard assignment (<tt>:=</tt>).    The version of CML distributed rebinds <tt>:=</tt>   to a monitored version so interesting effects can be recorded. 
        </ul>


    <li class="gap">
<p>
 <tt>monitoredAssign&nbsp;(r,&nbsp;v)</tt> 
</p>
</li>

        <ul>

  the assignment operator that should be used in programs that use stabilizers. <tt>:=</tt> is rebound to this by including CML. 
        </ul>



    </ul>


<p>
<a href="http://mlton.org/pages/Stabilizers/attachments/stabilizers_alpha_2006-10-09.tar.gz"><img src="moin-www.png" alt="[WWW]" height="11" width="11">stabilizers_alpha_2006-10-09.tar.gz</a> 
</p>
</div>



<p>
<hr>
Last edited on 2006-10-09 20:34:58 by <span title="ursula.cs.purdue.edu">PhilipSchatz</span>.
</body></html>
