doc/sphinx/_build/html/_modules/nepi/resources/linux/ns3/ns3dceapplication.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.resources.linux.ns3.ns3dceapplication &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.resources.linux.ns3.ns3dceapplication</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) 2014 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">from</span> <span class="nn">nepi.execution.attribute</span> <span class="kn">import</span> <span class="n">Attribute</span><span class="p">,</span> <span class="n">Flags</span><span class="p">,</span> <span class="n">Types</span>
  86 <span class="kn">from</span> <span class="nn">nepi.execution.resource</span> <span class="kn">import</span> <span class="n">clsinit_copy</span><span class="p">,</span> <span class="n">ResourceState</span>
  87 <span class="kn">from</span> <span class="nn">nepi.resources.ns3.ns3dceapplication</span> <span class="kn">import</span> <span class="n">NS3BaseDceApplication</span>
  88
  89 <span class="nd">@clsinit_copy</span>
  90 <div class="viewcode-block" id="LinuxNS3DceApplication"><a class="viewcode-back" href="../../../../../_layout/nepi.resources.linux.ns3.html#nepi.resources.linux.ns3.ns3dceapplication.LinuxNS3DceApplication">[docs]</a><span class="k">class</span> <span class="nc">LinuxNS3DceApplication</span><span class="p">(</span><span class="n">NS3BaseDceApplication</span><span class="p">):</span>
  91     <span class="n">_rtype</span> <span class="o">=</span> <span class="s">&quot;linux::ns3::dce::Application&quot;</span>
  92
  93     <span class="nd">@classmethod</span>
  94     <span class="k">def</span> <span class="nf">_register_attributes</span><span class="p">(</span><span class="n">cls</span><span class="p">):</span>
  95         <span class="n">sources</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;sources&quot;</span><span class="p">,</span>
  96                 <span class="s">&quot;Path to tar.gz file with sources for the application execute in DCE. &quot;</span>
  97                 <span class="s">&quot;Sources will be uploaded to ${SRC} and it is the responsibility of &quot;</span>
  98                 <span class="s">&quot;the build instructions (in the build attribute) to copy the compiled &quot;</span>
  99                 <span class="s">&quot;binaries to the ${BIN_DCE} directory&quot;</span><span class="p">,</span>
 100                 <span class="n">flags</span> <span class="o">=</span> <span class="n">Flags</span><span class="o">.</span><span class="n">Design</span><span class="p">)</span>
 101
 102         <span class="n">build</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;build&quot;</span><span class="p">,</span>
 103                 <span class="s">&quot;Instructions to compile sources DCE-compatible way. &quot;</span>
 104                 <span class="s">&quot;Note that sources will be uploaded to ${SRC} and the &quot;</span>
 105                 <span class="s">&quot;build instructions are responsible for copying the &quot;</span>
 106                 <span class="s">&quot;binaries to the ${BIN_DCE} directory. &quot;</span><span class="p">,</span>
 107                 <span class="n">flags</span> <span class="o">=</span> <span class="n">Flags</span><span class="o">.</span><span class="n">Design</span><span class="p">)</span>
 108
 109         <span class="n">depends</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;depends&quot;</span><span class="p">,</span>
 110                 <span class="s">&quot;Space-separated list of packages required to run the application&quot;</span><span class="p">,</span>
 111                 <span class="n">flags</span> <span class="o">=</span> <span class="n">Flags</span><span class="o">.</span><span class="n">Design</span><span class="p">)</span>
 112
 113         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">sources</span><span class="p">)</span>
 114         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">build</span><span class="p">)</span>
 115         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">depends</span><span class="p">)</span>
 116
 117     <span class="k">def</span> <span class="nf">_instantiate_object</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 118         <span class="n">command</span> <span class="o">=</span> <span class="p">[]</span>
 119
 120         <span class="c"># Install package dependencies required to run the binary </span>
 121         <span class="n">depends</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;depends&quot;</span><span class="p">)</span>
 122         <span class="k">if</span> <span class="n">depends</span><span class="p">:</span>
 123             <span class="n">dcmd</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">simulation</span><span class="o">.</span><span class="n">install_dependencies</span><span class="p">(</span><span class="n">depends</span> <span class="o">=</span> <span class="n">depends</span><span class="p">)</span>
 124             <span class="k">if</span> <span class="n">dcmd</span><span class="p">:</span>
 125                 <span class="n">command</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">dcmd</span><span class="p">)</span>
 126
 127         <span class="c"># Upload sources to generate the binary</span>
 128         <span class="n">sources</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;sources&quot;</span><span class="p">)</span>
 129         <span class="k">if</span> <span class="n">sources</span><span class="p">:</span>
 130             <span class="n">scmd</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">simulation</span><span class="o">.</span><span class="n">upload_extra_sources</span><span class="p">(</span><span class="n">sources</span> <span class="o">=</span> <span class="n">sources</span><span class="p">)</span>
 131             <span class="k">if</span> <span class="n">scmd</span><span class="p">:</span>
 132                 <span class="n">command</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">scmd</span><span class="p">)</span>
 133
 134         <span class="c"># Upload instructions to build the binary</span>
 135         <span class="n">build</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;build&quot;</span><span class="p">)</span>
 136         <span class="k">if</span> <span class="n">build</span><span class="p">:</span>
 137             <span class="n">bcmd</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">simulation</span><span class="o">.</span><span class="n">build</span><span class="p">(</span><span class="n">build</span> <span class="o">=</span> <span class="n">build</span><span class="p">)</span>
 138             <span class="k">if</span> <span class="n">bcmd</span><span class="p">:</span>
 139                 <span class="n">command</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">bcmd</span><span class="p">)</span>
 140
 141         <span class="k">if</span> <span class="n">command</span><span class="p">:</span>
 142             <span class="n">deploy_command</span> <span class="o">=</span> <span class="s">&quot;;&quot;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">command</span><span class="p">)</span>
 143             <span class="n">prefix</span> <span class="o">=</span> <span class="s">&quot;</span><span class="si">%d</span><span class="s">_deploy&quot;</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">guid</span>
 144             <span class="bp">self</span><span class="o">.</span><span class="n">simulation</span><span class="o">.</span><span class="n">execute_deploy_command</span><span class="p">(</span><span class="n">deploy_command</span><span class="p">,</span> <span class="n">prefix</span><span class="o">=</span><span class="n">prefix</span><span class="p">)</span>
 145 </pre></div></div>
 146
 147           </div>
 148         </div>
 149       </div>
 150       <div class="clearer"></div>
 151     </div>
 152     <div class="related">
 153       <h3>Navigation</h3>
 154       <ul>
 155         <li class="right" style="margin-right: 10px">
 156           <a href="../../../../../genindex.html" title="General Index"
 157              >index</a></li>
 158         <li class="right" >
 159           <a href="../../../../../py-modindex.html" title="Python Module Index"
 160              >modules</a> |</li>
 161         <li><a href="../../../../../index.html">NEPI 3.0 documentation</a> &raquo;</li>
 162           <li><a href="../../../../index.html" >Module code</a> &raquo;</li>
 163       </ul>
 164     </div>
 165     <div class="footer">
 166         &copy; Copyright 2014, Alina Quereilhac, Lucia Guevgeozian Odizzio, Julien Tribino.
 167       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
 168     </div>
 169   </body>
 170 </html>