doc/sphinx/_build/html/_modules/nepi/execution/scheduler.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
   2   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3
   4
   5 <html xmlns="http://www.w3.org/1999/xhtml">
   6   <head>
   7     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   8
   9     <title>nepi.execution.scheduler &mdash; NEPI 3.0 documentation</title>
  10
  11     <link rel="stylesheet" href="../../../_static/sphinxdoc.css" type="text/css" />
  12     <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
  13
  14     <script type="text/javascript">
  15       var DOCUMENTATION_OPTIONS = {
  16         URL_ROOT:    '../../../',
  17         VERSION:     '3.0',
  18         COLLAPSE_INDEX: false,
  19         FILE_SUFFIX: '.html',
  20         HAS_SOURCE:  true
  21       };
  22     </script>
  23     <script type="text/javascript" src="../../../_static/jquery.js"></script>
  24     <script type="text/javascript" src="../../../_static/underscore.js"></script>
  25     <script type="text/javascript" src="../../../_static/doctools.js"></script>
  26     <link rel="top" title="NEPI 3.0 documentation" href="../../../index.html" />
  27     <link rel="up" title="Module code" href="../../index.html" />
  28   </head>
  29   <body>
  30     <div class="related">
  31       <h3>Navigation</h3>
  32       <ul>
  33         <li class="right" style="margin-right: 10px">
  34           <a href="../../../genindex.html" title="General Index"
  35              accesskey="I">index</a></li>
  36         <li class="right" >
  37           <a href="../../../py-modindex.html" title="Python Module Index"
  38              >modules</a> |</li>
  39         <li><a href="../../../index.html">NEPI 3.0 documentation</a> &raquo;</li>
  40           <li><a href="../../index.html" accesskey="U">Module code</a> &raquo;</li>
  41       </ul>
  42     </div>
  43       <div class="sphinxsidebar">
  44         <div class="sphinxsidebarwrapper">
  45 <div id="searchbox" style="display: none">
  46   <h3>Quick search</h3>
  47     <form class="search" action="../../../search.html" method="get">
  48       <input type="text" name="q" />
  49       <input type="submit" value="Go" />
  50       <input type="hidden" name="check_keywords" value="yes" />
  51       <input type="hidden" name="area" value="default" />
  52     </form>
  53     <p class="searchtip" style="font-size: 90%">
  54     Enter search terms or a module, class or function name.
  55     </p>
  56 </div>
  57 <script type="text/javascript">$('#searchbox').show(0);</script>
  58         </div>
  59       </div>
  60
  61     <div class="document">
  62       <div class="documentwrapper">
  63         <div class="bodywrapper">
  64           <div class="body">
  65
  66   <h1>Source code for nepi.execution.scheduler</h1><div class="highlight"><pre>
  67 <span class="c">#</span>
  68 <span class="c">#    NEPI, a framework to manage network experiments</span>
  69 <span class="c">#    Copyright (C) 2013 INRIA</span>
  70 <span class="c">#</span>
  71 <span class="c">#    This program is free software: you can redistribute it and/or modify</span>
  72 <span class="c">#    it under the terms of the GNU General Public License version 2 as</span>
  73 <span class="c">#    published by the Free Software Foundation;</span>
  74 <span class="c">#</span>
  75 <span class="c">#    This program is distributed in the hope that it will be useful,</span>
  76 <span class="c">#    but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
  77 <span class="c">#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the</span>
  78 <span class="c">#    GNU General Public License for more details.</span>
  79 <span class="c">#</span>
  80 <span class="c">#    You should have received a copy of the GNU General Public License</span>
  81 <span class="c">#    along with this program.  If not, see &lt;http://www.gnu.org/licenses/&gt;.</span>
  82 <span class="c">#</span>
  83 <span class="c"># Author: Alina Quereilhac &lt;alina.quereilhac@inria.fr&gt;</span>
  84
  85 <span class="kn">import</span> <span class="nn">itertools</span>
  86 <span class="kn">import</span> <span class="nn">heapq</span>
  87
  88 <div class="viewcode-block" id="TaskStatus"><a class="viewcode-back" href="../../../_layout/nepi.execution.html#nepi.execution.scheduler.TaskStatus">[docs]</a><span class="k">class</span> <span class="nc">TaskStatus</span><span class="p">:</span>
  89     <span class="sd">&quot;&quot;&quot; Execution state of the Task</span>
  90 <span class="sd">    &quot;&quot;&quot;</span>
  91     <span class="n">NEW</span> <span class="o">=</span> <span class="mi">0</span>
  92     <span class="n">DONE</span> <span class="o">=</span> <span class="mi">1</span>
  93     <span class="n">ERROR</span> <span class="o">=</span> <span class="mi">2</span>
  94 </div>
  95 <div class="viewcode-block" id="Task"><a class="viewcode-back" href="../../../_layout/nepi.execution.html#nepi.execution.scheduler.Task">[docs]</a><span class="k">class</span> <span class="nc">Task</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
  96     <span class="sd">&quot;&quot;&quot; A Task represents an operation to be executed by the </span>
  97 <span class="sd">    ExperimentController scheduler</span>
  98 <span class="sd">    &quot;&quot;&quot;</span>
  99
 100     <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">timestamp</span><span class="p">,</span> <span class="n">callback</span><span class="p">):</span>
 101         <span class="sd">&quot;&quot;&quot;</span>
 102 <span class="sd">        :param timestamp: Future execution date of the operation</span>
 103 <span class="sd">        :type timestamp: str</span>
 104
 105 <span class="sd">        :param callback: A function to invoke in order to execute the operation</span>
 106 <span class="sd">        :type callback: function</span>
 107
 108 <span class="sd">        &quot;&quot;&quot;</span>
 109         <span class="bp">self</span><span class="o">.</span><span class="n">id</span> <span class="o">=</span> <span class="bp">None</span>
 110         <span class="bp">self</span><span class="o">.</span><span class="n">timestamp</span> <span class="o">=</span> <span class="n">timestamp</span>
 111         <span class="bp">self</span><span class="o">.</span><span class="n">callback</span> <span class="o">=</span> <span class="n">callback</span>
 112         <span class="bp">self</span><span class="o">.</span><span class="n">result</span> <span class="o">=</span> <span class="bp">None</span>
 113         <span class="bp">self</span><span class="o">.</span><span class="n">status</span> <span class="o">=</span> <span class="n">TaskStatus</span><span class="o">.</span><span class="n">NEW</span>
 114 </div>
 115 <div class="viewcode-block" id="HeapScheduler"><a class="viewcode-back" href="../../../_layout/nepi.execution.html#nepi.execution.scheduler.HeapScheduler">[docs]</a><span class="k">class</span> <span class="nc">HeapScheduler</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
 116     <span class="sd">&quot;&quot;&quot; Create a Heap Scheduler</span>
 117
 118 <span class="sd">    .. note::</span>
 119
 120 <span class="sd">        This class is thread safe.</span>
 121 <span class="sd">        All calls to C Extensions are made atomic by the GIL in the CPython implementation.</span>
 122 <span class="sd">        heapq.heappush, heapq.heappop, and list access are therefore thread-safe.</span>
 123
 124 <span class="sd">    &quot;&quot;&quot;</span>
 125
 126     <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 127         <span class="nb">super</span><span class="p">(</span><span class="n">HeapScheduler</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">__init__</span><span class="p">()</span>
 128         <span class="bp">self</span><span class="o">.</span><span class="n">_queue</span> <span class="o">=</span> <span class="nb">list</span><span class="p">()</span>
 129         <span class="bp">self</span><span class="o">.</span><span class="n">_valid</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
 130         <span class="bp">self</span><span class="o">.</span><span class="n">_idgen</span> <span class="o">=</span> <span class="n">itertools</span><span class="o">.</span><span class="n">count</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>
 131
 132     <span class="nd">@property</span>
 133 <div class="viewcode-block" id="HeapScheduler.pending"><a class="viewcode-back" href="../../../_layout/nepi.execution.html#nepi.execution.scheduler.HeapScheduler.pending">[docs]</a>    <span class="k">def</span> <span class="nf">pending</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 134         <span class="sd">&quot;&quot;&quot; Returns the list of pending task ids &quot;&quot;&quot;</span>
 135         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_valid</span>
 136 </div>
 137 <div class="viewcode-block" id="HeapScheduler.schedule"><a class="viewcode-back" href="../../../_layout/nepi.execution.html#nepi.execution.scheduler.HeapScheduler.schedule">[docs]</a>    <span class="k">def</span> <span class="nf">schedule</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">task</span><span class="p">):</span>
 138         <span class="sd">&quot;&quot;&quot; Add a task to the queue ordered by task.timestamp and arrival order</span>
 139
 140 <span class="sd">        :param task: task to schedule</span>
 141 <span class="sd">        :type task: task</span>
 142 <span class="sd">        &quot;&quot;&quot;</span>
 143         <span class="k">if</span> <span class="n">task</span><span class="o">.</span><span class="n">id</span> <span class="o">==</span> <span class="bp">None</span><span class="p">:</span>
 144             <span class="n">task</span><span class="o">.</span><span class="n">id</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_idgen</span><span class="o">.</span><span class="n">next</span><span class="p">()</span>
 145
 146         <span class="n">entry</span> <span class="o">=</span> <span class="p">(</span><span class="n">task</span><span class="o">.</span><span class="n">timestamp</span><span class="p">,</span> <span class="n">task</span><span class="o">.</span><span class="n">id</span><span class="p">,</span> <span class="n">task</span><span class="p">)</span>
 147         <span class="bp">self</span><span class="o">.</span><span class="n">_valid</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">task</span><span class="o">.</span><span class="n">id</span><span class="p">)</span>
 148         <span class="n">heapq</span><span class="o">.</span><span class="n">heappush</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_queue</span><span class="p">,</span> <span class="n">entry</span><span class="p">)</span>
 149         <span class="k">return</span> <span class="n">task</span>
 150 </div>
 151 <div class="viewcode-block" id="HeapScheduler.remove"><a class="viewcode-back" href="../../../_layout/nepi.execution.html#nepi.execution.scheduler.HeapScheduler.remove">[docs]</a>    <span class="k">def</span> <span class="nf">remove</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">tid</span><span class="p">):</span>
 152         <span class="sd">&quot;&quot;&quot; Remove a task form the queue</span>
 153
 154 <span class="sd">        :param tid: Id of the task to be removed</span>
 155 <span class="sd">        :type tid: int</span>
 156
 157 <span class="sd">        &quot;&quot;&quot;</span>
 158         <span class="k">try</span><span class="p">:</span>
 159             <span class="bp">self</span><span class="o">.</span><span class="n">_valid</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="n">tid</span><span class="p">)</span>
 160         <span class="k">except</span><span class="p">:</span>
 161             <span class="k">pass</span>
 162 </div>
 163 <div class="viewcode-block" id="HeapScheduler.next"><a class="viewcode-back" href="../../../_layout/nepi.execution.html#nepi.execution.scheduler.HeapScheduler.next">[docs]</a>    <span class="k">def</span> <span class="nf">next</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 164         <span class="sd">&quot;&quot;&quot; Get the next task in the queue by timestamp and arrival order</span>
 165 <span class="sd">        &quot;&quot;&quot;</span>
 166         <span class="k">while</span> <span class="bp">self</span><span class="o">.</span><span class="n">_queue</span><span class="p">:</span>
 167             <span class="k">try</span><span class="p">:</span>
 168                 <span class="n">timestamp</span><span class="p">,</span> <span class="n">tid</span><span class="p">,</span> <span class="n">task</span> <span class="o">=</span> <span class="n">heapq</span><span class="o">.</span><span class="n">heappop</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_queue</span><span class="p">)</span>
 169                 <span class="k">if</span> <span class="n">tid</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_valid</span><span class="p">:</span>
 170                     <span class="bp">self</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="n">tid</span><span class="p">)</span>
 171                     <span class="k">return</span> <span class="n">task</span>
 172             <span class="k">except</span> <span class="ne">IndexError</span><span class="p">:</span>
 173                 <span class="c"># heap empty</span>
 174                 <span class="k">pass</span>
 175         <span class="k">return</span> <span class="bp">None</span>
 176 </pre></div></div></div>
 177
 178           </div>
 179         </div>
 180       </div>
 181       <div class="clearer"></div>
 182     </div>
 183     <div class="related">
 184       <h3>Navigation</h3>
 185       <ul>
 186         <li class="right" style="margin-right: 10px">
 187           <a href="../../../genindex.html" title="General Index"
 188              >index</a></li>
 189         <li class="right" >
 190           <a href="../../../py-modindex.html" title="Python Module Index"
 191              >modules</a> |</li>
 192         <li><a href="../../../index.html">NEPI 3.0 documentation</a> &raquo;</li>
 193           <li><a href="../../index.html" >Module code</a> &raquo;</li>
 194       </ul>
 195     </div>
 196     <div class="footer">
 197         &copy; Copyright 2014, Alina Quereilhac, Lucia Guevgeozian Odizzio, Julien Tribino.
 198       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
 199     </div>
 200   </body>
 201 </html>