--- /dev/null
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>nepi.execution.scheduler — NEPI 3.2 documentation</title>
+
+ <link rel="stylesheet" href="../../../_static/sphinxdoc.css" type="text/css" />
+ <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../../../',
+ VERSION: '3.2',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../../_static/doctools.js"></script>
+ <link rel="top" title="NEPI 3.2 documentation" href="../../../index.html" />
+ <link rel="up" title="Module code" href="../../index.html" />
+ </head>
+ <body>
+ <div class="related">
+ <h3>Navigation</h3>
+ <ul>
+ <li class="right" style="margin-right: 10px">
+ <a href="../../../genindex.html" title="General Index"
+ accesskey="I">index</a></li>
+ <li class="right" >
+ <a href="../../../py-modindex.html" title="Python Module Index"
+ >modules</a> |</li>
+ <li><a href="../../../index.html">NEPI 3.2 documentation</a> »</li>
+ <li><a href="../../index.html" accesskey="U">Module code</a> »</li>
+ </ul>
+ </div>
+ <div class="sphinxsidebar">
+ <div class="sphinxsidebarwrapper">
+<div id="searchbox" style="display: none">
+ <h3>Quick search</h3>
+ <form class="search" action="../../../search.html" method="get">
+ <input type="text" name="q" />
+ <input type="submit" value="Go" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ <p class="searchtip" style="font-size: 90%">
+ Enter search terms or a module, class or function name.
+ </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+ </div>
+ </div>
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body">
+
+ <h1>Source code for nepi.execution.scheduler</h1><div class="highlight"><pre>
+<span class="c">#</span>
+<span class="c"># NEPI, a framework to manage network experiments</span>
+<span class="c"># Copyright (C) 2013 INRIA</span>
+<span class="c">#</span>
+<span class="c"># This program is free software: you can redistribute it and/or modify</span>
+<span class="c"># it under the terms of the GNU General Public License version 2 as</span>
+<span class="c"># published by the Free Software Foundation;</span>
+<span class="c">#</span>
+<span class="c"># This program is distributed in the hope that it will be useful,</span>
+<span class="c"># but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
+<span class="c"># MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
+<span class="c"># GNU General Public License for more details.</span>
+<span class="c">#</span>
+<span class="c"># You should have received a copy of the GNU General Public License</span>
+<span class="c"># along with this program. If not, see <http://www.gnu.org/licenses/>.</span>
+<span class="c">#</span>
+<span class="c"># Author: Alina Quereilhac <alina.quereilhac@inria.fr></span>
+
+<span class="kn">import</span> <span class="nn">itertools</span>
+<span class="kn">import</span> <span class="nn">heapq</span>
+
+<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>
+ <span class="sd">""" Execution state of the Task</span>
+<span class="sd"> """</span>
+ <span class="n">NEW</span> <span class="o">=</span> <span class="mi">0</span>
+ <span class="n">DONE</span> <span class="o">=</span> <span class="mi">1</span>
+ <span class="n">ERROR</span> <span class="o">=</span> <span class="mi">2</span>
+</div>
+<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>
+ <span class="sd">""" A Task represents an operation to be executed by the </span>
+<span class="sd"> ExperimentController scheduler</span>
+<span class="sd"> """</span>
+
+ <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>
+ <span class="sd">"""</span>
+<span class="sd"> :param timestamp: Future execution date of the operation</span>
+<span class="sd"> :type timestamp: str</span>
+
+<span class="sd"> :param callback: A function to invoke in order to execute the operation</span>
+<span class="sd"> :type callback: function</span>
+
+<span class="sd"> """</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">id</span> <span class="o">=</span> <span class="bp">None</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">timestamp</span> <span class="o">=</span> <span class="n">timestamp</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">callback</span> <span class="o">=</span> <span class="n">callback</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">result</span> <span class="o">=</span> <span class="bp">None</span>
+ <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>
+</div>
+<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>
+ <span class="sd">""" Create a Heap Scheduler</span>
+
+<span class="sd"> .. note::</span>
+
+<span class="sd"> This class is thread safe.</span>
+<span class="sd"> All calls to C Extensions are made atomic by the GIL in the CPython implementation.</span>
+<span class="sd"> heapq.heappush, heapq.heappop, and list access are therefore thread-safe.</span>
+
+<span class="sd"> """</span>
+
+ <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="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>
+ <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>
+ <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>
+ <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>
+
+ <span class="nd">@property</span>
+<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>
+ <span class="sd">""" Returns the list of pending task ids """</span>
+ <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_valid</span>
+</div>
+<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>
+ <span class="sd">""" Add a task to the queue ordered by task.timestamp and arrival order</span>
+
+<span class="sd"> :param task: task to schedule</span>
+<span class="sd"> :type task: task</span>
+<span class="sd"> """</span>
+ <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>
+ <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>
+
+ <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>
+ <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>
+ <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>
+ <span class="k">return</span> <span class="n">task</span>
+</div>
+<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>
+ <span class="sd">""" Remove a task form the queue</span>
+
+<span class="sd"> :param tid: Id of the task to be removed</span>
+<span class="sd"> :type tid: int</span>
+
+<span class="sd"> """</span>
+ <span class="k">try</span><span class="p">:</span>
+ <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>
+ <span class="k">except</span><span class="p">:</span>
+ <span class="k">pass</span>
+</div>
+<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>
+ <span class="sd">""" Get the next task in the queue by timestamp and arrival order</span>
+<span class="sd"> """</span>
+ <span class="k">while</span> <span class="bp">self</span><span class="o">.</span><span class="n">_queue</span><span class="p">:</span>
+ <span class="k">try</span><span class="p">:</span>
+ <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>
+ <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>
+ <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>
+ <span class="k">return</span> <span class="n">task</span>
+ <span class="k">except</span> <span class="ne">IndexError</span><span class="p">:</span>
+ <span class="c"># heap empty</span>
+ <span class="k">pass</span>
+ <span class="k">return</span> <span class="bp">None</span>
+</pre></div></div></div>
+
+ </div>
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="related">
+ <h3>Navigation</h3>
+ <ul>
+ <li class="right" style="margin-right: 10px">
+ <a href="../../../genindex.html" title="General Index"
+ >index</a></li>
+ <li class="right" >
+ <a href="../../../py-modindex.html" title="Python Module Index"
+ >modules</a> |</li>
+ <li><a href="../../../index.html">NEPI 3.2 documentation</a> »</li>
+ <li><a href="../../index.html" >Module code</a> »</li>
+ </ul>
+ </div>
+ <div class="footer">
+ © Copyright 2014, Alina Quereilhac, Lucia Guevgeozian Odizzio, Julien Tribino.
+ Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
+ </div>
+ </body>
+</html>
\ No newline at end of file
git://git.onelab.eu / nepi.git / blobdiff