doc/sphinx/_build/html/_modules/nepi/resources/linux/ns3/ns3client.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.ns3client &mdash; NEPI 3.2 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.2',
  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.2 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.2 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.ns3client</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">import</span> <span class="nn">base64</span>
  86 <span class="kn">import</span> <span class="nn">cPickle</span>
  87 <span class="kn">import</span> <span class="nn">errno</span>
  88 <span class="kn">import</span> <span class="nn">os</span>
  89 <span class="kn">import</span> <span class="nn">socket</span>
  90 <span class="kn">import</span> <span class="nn">time</span>
  91 <span class="kn">import</span> <span class="nn">weakref</span>
  92 <span class="kn">import</span> <span class="nn">threading</span>
  93
  94 <span class="kn">from</span> <span class="nn">optparse</span> <span class="kn">import</span> <span class="n">OptionParser</span><span class="p">,</span> <span class="n">SUPPRESS_HELP</span>
  95
  96 <span class="kn">from</span> <span class="nn">nepi.resources.ns3.ns3client</span> <span class="kn">import</span> <span class="n">NS3Client</span>
  97 <span class="kn">from</span> <span class="nn">nepi.resources.ns3.ns3server</span> <span class="kn">import</span> <span class="n">NS3WrapperMessage</span>
  98
  99 <div class="viewcode-block" id="LinuxNS3Client"><a class="viewcode-back" href="../../../../../_layout/nepi.resources.linux.ns3.html#nepi.resources.linux.ns3.ns3client.LinuxNS3Client">[docs]</a><span class="k">class</span> <span class="nc">LinuxNS3Client</span><span class="p">(</span><span class="n">NS3Client</span><span class="p">):</span>
 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">simulation</span><span class="p">):</span>
 101         <span class="nb">super</span><span class="p">(</span><span class="n">LinuxNS3Client</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>
 102         <span class="bp">self</span><span class="o">.</span><span class="n">_simulation</span> <span class="o">=</span> <span class="n">weakref</span><span class="o">.</span><span class="n">ref</span><span class="p">(</span><span class="n">simulation</span><span class="p">)</span>
 103         <span class="bp">self</span><span class="o">.</span><span class="n">_socket_lock</span> <span class="o">=</span> <span class="n">threading</span><span class="o">.</span><span class="n">Lock</span><span class="p">()</span>
 104
 105     <span class="nd">@property</span>
 106 <div class="viewcode-block" id="LinuxNS3Client.simulation"><a class="viewcode-back" href="../../../../../_layout/nepi.resources.linux.ns3.html#nepi.resources.linux.ns3.ns3client.LinuxNS3Client.simulation">[docs]</a>    <span class="k">def</span> <span class="nf">simulation</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 107         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_simulation</span><span class="p">()</span>
 108 </div>
 109 <div class="viewcode-block" id="LinuxNS3Client.send_msg"><a class="viewcode-back" href="../../../../../_layout/nepi.resources.linux.ns3.html#nepi.resources.linux.ns3.ns3client.LinuxNS3Client.send_msg">[docs]</a>    <span class="k">def</span> <span class="nf">send_msg</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">msg_type</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
 110         <span class="n">msg</span> <span class="o">=</span> <span class="p">[</span><span class="n">msg_type</span><span class="p">,</span> <span class="n">args</span><span class="p">,</span> <span class="n">kwargs</span><span class="p">]</span>
 111
 112         <span class="k">def</span> <span class="nf">encode</span><span class="p">(</span><span class="n">item</span><span class="p">):</span>
 113             <span class="n">item</span> <span class="o">=</span> <span class="n">cPickle</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="n">item</span><span class="p">)</span>
 114             <span class="k">return</span> <span class="n">base64</span><span class="o">.</span><span class="n">b64encode</span><span class="p">(</span><span class="n">item</span><span class="p">)</span>
 115
 116         <span class="n">encoded</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="nb">map</span><span class="p">(</span><span class="n">encode</span><span class="p">,</span> <span class="n">msg</span><span class="p">))</span>
 117
 118         <span class="k">with</span> <span class="bp">self</span><span class="o">.</span><span class="n">_socket_lock</span><span class="p">:</span>
 119             <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">simulation</span><span class="o">.</span><span class="n">node</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;hostname&quot;</span><span class="p">)</span> <span class="ow">in</span> <span class="p">[</span><span class="s">&#39;localhost&#39;</span><span class="p">,</span> <span class="s">&#39;127.0.0.1&#39;</span><span class="p">]:</span>
 120                 <span class="n">sock</span> <span class="o">=</span> <span class="n">socket</span><span class="o">.</span><span class="n">socket</span><span class="p">(</span><span class="n">socket</span><span class="o">.</span><span class="n">AF_UNIX</span><span class="p">,</span> <span class="n">socket</span><span class="o">.</span><span class="n">SOCK_STREAM</span><span class="p">)</span>
 121                 <span class="n">sock</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">simulation</span><span class="o">.</span><span class="n">remote_socket</span><span class="p">)</span>
 122                 <span class="n">sock</span><span class="o">.</span><span class="n">send</span><span class="p">(</span><span class="s">&quot;</span><span class="si">%s</span><span class="se">\n</span><span class="s">&quot;</span> <span class="o">%</span> <span class="n">encoded</span><span class="p">)</span>
 123                 <span class="n">reply</span> <span class="o">=</span> <span class="n">sock</span><span class="o">.</span><span class="n">recv</span><span class="p">(</span><span class="mi">1024</span><span class="p">)</span>
 124                 <span class="n">sock</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
 125             <span class="k">else</span><span class="p">:</span>
 126                 <span class="n">command</span> <span class="o">=</span> <span class="p">(</span> <span class="s">&quot;python -c &#39;import socket;&quot;</span>
 127                     <span class="s">&quot;sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM);&quot;</span>
 128                     <span class="s">&quot;sock.connect(</span><span class="se">\&quot;</span><span class="si">%(socket_addr)s</span><span class="se">\&quot;</span><span class="s">);&quot;</span>
 129                     <span class="s">&quot;msg = </span><span class="se">\&quot;</span><span class="si">%(encoded_message)s</span><span class="se">\\</span><span class="s">n</span><span class="se">\&quot;</span><span class="s">;&quot;</span>
 130                     <span class="s">&quot;sock.send(msg);&quot;</span>
 131                     <span class="s">&quot;reply = sock.recv(1024);&quot;</span>
 132                     <span class="s">&quot;sock.close();&quot;</span>
 133                     <span class="s">&quot;print reply&#39;&quot;</span><span class="p">)</span> <span class="o">%</span> <span class="p">{</span>
 134                         <span class="s">&quot;encoded_message&quot;</span><span class="p">:</span> <span class="n">encoded</span><span class="p">,</span>
 135                         <span class="s">&quot;socket_addr&quot;</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">simulation</span><span class="o">.</span><span class="n">remote_socket</span><span class="p">,</span>
 136                         <span class="p">}</span>
 137
 138                 <span class="p">(</span><span class="n">reply</span><span class="p">,</span> <span class="n">err</span><span class="p">),</span> <span class="n">proc</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">node</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">command</span><span class="p">,</span>
 139                         <span class="n">with_lock</span> <span class="o">=</span> <span class="bp">True</span><span class="p">)</span>
 140
 141                 <span class="k">if</span> <span class="p">(</span><span class="n">err</span> <span class="ow">and</span> <span class="n">proc</span><span class="o">.</span><span class="n">poll</span><span class="p">())</span> <span class="ow">or</span> <span class="n">reply</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span> <span class="o">==</span> <span class="s">&quot;&quot;</span><span class="p">:</span>
 142                     <span class="n">msg</span> <span class="o">=</span> <span class="p">(</span><span class="s">&quot; Couldn&#39;t connect to remote socket </span><span class="si">%s</span><span class="s"> - REPLY: </span><span class="si">%s</span><span class="s"> &quot;</span>
 143                           <span class="s">&quot;- ERROR: </span><span class="si">%s</span><span class="s"> &quot;</span><span class="p">)</span> <span class="o">%</span> <span class="p">(</span>
 144                             <span class="bp">self</span><span class="o">.</span><span class="n">simulation</span><span class="o">.</span><span class="n">remote_socket</span><span class="p">,</span> <span class="n">reply</span><span class="p">,</span> <span class="n">err</span><span class="p">)</span>
 145                     <span class="bp">self</span><span class="o">.</span><span class="n">simulation</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="n">msg</span><span class="p">,</span> <span class="n">reply</span><span class="p">,</span> <span class="n">err</span><span class="p">)</span>
 146                     <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
 147
 148         <span class="n">reply</span> <span class="o">=</span> <span class="n">cPickle</span><span class="o">.</span><span class="n">loads</span><span class="p">(</span><span class="n">base64</span><span class="o">.</span><span class="n">b64decode</span><span class="p">(</span><span class="n">reply</span><span class="p">))</span>
 149
 150         <span class="k">return</span> <span class="n">reply</span>
 151 </div>
 152 <div class="viewcode-block" id="LinuxNS3Client.create"><a class="viewcode-back" href="../../../../../_layout/nepi.resources.linux.ns3.html#nepi.resources.linux.ns3.ns3client.LinuxNS3Client.create">[docs]</a>    <span class="k">def</span> <span class="nf">create</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
 153         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">send_msg</span><span class="p">(</span><span class="n">NS3WrapperMessage</span><span class="o">.</span><span class="n">CREATE</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
 154 </div>
 155 <div class="viewcode-block" id="LinuxNS3Client.factory"><a class="viewcode-back" href="../../../../../_layout/nepi.resources.linux.ns3.html#nepi.resources.linux.ns3.ns3client.LinuxNS3Client.factory">[docs]</a>    <span class="k">def</span> <span class="nf">factory</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
 156         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">send_msg</span><span class="p">(</span><span class="n">NS3WrapperMessage</span><span class="o">.</span><span class="n">FACTORY</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
 157 </div>
 158 <div class="viewcode-block" id="LinuxNS3Client.invoke"><a class="viewcode-back" href="../../../../../_layout/nepi.resources.linux.ns3.html#nepi.resources.linux.ns3.ns3client.LinuxNS3Client.invoke">[docs]</a>    <span class="k">def</span> <span class="nf">invoke</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
 159         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">send_msg</span><span class="p">(</span><span class="n">NS3WrapperMessage</span><span class="o">.</span><span class="n">INVOKE</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
 160 </div>
 161 <div class="viewcode-block" id="LinuxNS3Client.set"><a class="viewcode-back" href="../../../../../_layout/nepi.resources.linux.ns3.html#nepi.resources.linux.ns3.ns3client.LinuxNS3Client.set">[docs]</a>    <span class="k">def</span> <span class="nf">set</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
 162         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">send_msg</span><span class="p">(</span><span class="n">NS3WrapperMessage</span><span class="o">.</span><span class="n">SET</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
 163 </div>
 164 <div class="viewcode-block" id="LinuxNS3Client.get"><a class="viewcode-back" href="../../../../../_layout/nepi.resources.linux.ns3.html#nepi.resources.linux.ns3.ns3client.LinuxNS3Client.get">[docs]</a>    <span class="k">def</span> <span class="nf">get</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
 165         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">send_msg</span><span class="p">(</span><span class="n">NS3WrapperMessage</span><span class="o">.</span><span class="n">GET</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
 166 </div>
 167 <div class="viewcode-block" id="LinuxNS3Client.flush"><a class="viewcode-back" href="../../../../../_layout/nepi.resources.linux.ns3.html#nepi.resources.linux.ns3.ns3client.LinuxNS3Client.flush">[docs]</a>    <span class="k">def</span> <span class="nf">flush</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
 168         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">send_msg</span><span class="p">(</span><span class="n">NS3WrapperMessage</span><span class="o">.</span><span class="n">FLUSH</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
 169 </div>
 170 <div class="viewcode-block" id="LinuxNS3Client.start"><a class="viewcode-back" href="../../../../../_layout/nepi.resources.linux.ns3.html#nepi.resources.linux.ns3.ns3client.LinuxNS3Client.start">[docs]</a>    <span class="k">def</span> <span class="nf">start</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
 171         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">send_msg</span><span class="p">(</span><span class="n">NS3WrapperMessage</span><span class="o">.</span><span class="n">START</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
 172 </div>
 173 <div class="viewcode-block" id="LinuxNS3Client.stop"><a class="viewcode-back" href="../../../../../_layout/nepi.resources.linux.ns3.html#nepi.resources.linux.ns3.ns3client.LinuxNS3Client.stop">[docs]</a>    <span class="k">def</span> <span class="nf">stop</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
 174         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">send_msg</span><span class="p">(</span><span class="n">NS3WrapperMessage</span><span class="o">.</span><span class="n">STOP</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
 175 </div>
 176 <div class="viewcode-block" id="LinuxNS3Client.shutdown"><a class="viewcode-back" href="../../../../../_layout/nepi.resources.linux.ns3.html#nepi.resources.linux.ns3.ns3client.LinuxNS3Client.shutdown">[docs]</a>    <span class="k">def</span> <span class="nf">shutdown</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
 177         <span class="k">try</span><span class="p">:</span>
 178             <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">send_msg</span><span class="p">(</span><span class="n">NS3WrapperMessage</span><span class="o">.</span><span class="n">SHUTDOWN</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
 179         <span class="k">except</span><span class="p">:</span>
 180             <span class="k">pass</span>
 181
 182         <span class="k">return</span> <span class="bp">None</span>
 183 </pre></div></div></div>
 184
 185           </div>
 186         </div>
 187       </div>
 188       <div class="clearer"></div>
 189     </div>
 190     <div class="related">
 191       <h3>Navigation</h3>
 192       <ul>
 193         <li class="right" style="margin-right: 10px">
 194           <a href="../../../../../genindex.html" title="General Index"
 195              >index</a></li>
 196         <li class="right" >
 197           <a href="../../../../../py-modindex.html" title="Python Module Index"
 198              >modules</a> |</li>
 199         <li><a href="../../../../../index.html">NEPI 3.2 documentation</a> &raquo;</li>
 200           <li><a href="../../../../index.html" >Module code</a> &raquo;</li>
 201       </ul>
 202     </div>
 203     <div class="footer">
 204         &copy; Copyright 2014, Alina Quereilhac, Lucia Guevgeozian Odizzio, Julien Tribino.
 205       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
 206     </div>
 207   </body>
 208 </html>