doc/sphinx/_build/html/_modules/nepi/resources/ns3/ns3route.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.ns3.ns3route &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.ns3.ns3route</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>
  86 <span class="kn">from</span> <span class="nn">nepi.execution.resource</span> <span class="kn">import</span> <span class="n">clsinit_copy</span>
  87 <span class="kn">from</span> <span class="nn">nepi.execution.trace</span> <span class="kn">import</span> <span class="n">Trace</span>
  88 <span class="kn">from</span> <span class="nn">nepi.resources.ns3.ns3base</span> <span class="kn">import</span> <span class="n">NS3Base</span>
  89
  90 <span class="kn">import</span> <span class="nn">ipaddr</span>
  91
  92 <span class="nd">@clsinit_copy</span>
  93 <div class="viewcode-block" id="NS3Route"><a class="viewcode-back" href="../../../../_layout/nepi.resources.ns3.html#nepi.resources.ns3.ns3route.NS3Route">[docs]</a><span class="k">class</span> <span class="nc">NS3Route</span><span class="p">(</span><span class="n">NS3Base</span><span class="p">):</span>
  94     <span class="n">_rtype</span> <span class="o">=</span> <span class="s">&quot;ns3::Route&quot;</span>
  95
  96     <span class="nd">@classmethod</span>
  97     <span class="k">def</span> <span class="nf">_register_attributes</span><span class="p">(</span><span class="n">cls</span><span class="p">):</span>
  98         <span class="n">network</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;network&quot;</span><span class="p">,</span> <span class="s">&quot;Destination network address&quot;</span><span class="p">,</span>
  99                 <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>
 100
 101         <span class="n">prefix</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;prefix&quot;</span><span class="p">,</span> <span class="s">&quot;Network prefix for the network&quot;</span><span class="p">,</span>
 102                 <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>
 103
 104         <span class="n">nexthop</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;nexthop&quot;</span><span class="p">,</span> <span class="s">&quot;Address of next hop in the route&quot;</span><span class="p">,</span>
 105                 <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>
 106
 107         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">network</span><span class="p">)</span>
 108         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">prefix</span><span class="p">)</span>
 109         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">nexthop</span><span class="p">)</span>
 110
 111     <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">ec</span><span class="p">,</span> <span class="n">guid</span><span class="p">):</span>
 112         <span class="nb">super</span><span class="p">(</span><span class="n">NS3Route</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="n">ec</span><span class="p">,</span> <span class="n">guid</span><span class="p">)</span>
 113
 114     <span class="nd">@property</span>
 115 <div class="viewcode-block" id="NS3Route.node"><a class="viewcode-back" href="../../../../_layout/nepi.resources.ns3.html#nepi.resources.ns3.ns3route.NS3Route.node">[docs]</a>    <span class="k">def</span> <span class="nf">node</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 116         <span class="kn">from</span> <span class="nn">nepi.resources.ns3.ns3node</span> <span class="kn">import</span> <span class="n">NS3BaseNode</span>
 117         <span class="n">nodes</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_connected</span><span class="p">(</span><span class="n">NS3BaseNode</span><span class="o">.</span><span class="n">get_rtype</span><span class="p">())</span>
 118
 119         <span class="k">if</span> <span class="ow">not</span> <span class="n">nodes</span><span class="p">:</span>
 120             <span class="n">msg</span> <span class="o">=</span> <span class="s">&quot;Device not connected to node&quot;</span>
 121             <span class="bp">self</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
 122             <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="n">msg</span>
 123
 124         <span class="k">return</span> <span class="n">nodes</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
 125 </div>
 126     <span class="nd">@property</span>
 127     <span class="k">def</span> <span class="nf">_rms_to_wait</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 128         <span class="c"># Wait for all network devices connected to the node to be ready</span>
 129         <span class="c"># before configuring the routes, else the route might refer to a</span>
 130         <span class="c"># non yet existing interface</span>
 131
 132         <span class="n">rms</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
 133         <span class="n">rms</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">node</span><span class="o">.</span><span class="n">devices</span><span class="p">)</span>
 134         <span class="k">return</span> <span class="n">rms</span>
 135
 136     <span class="k">def</span> <span class="nf">_instantiate_object</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 137         <span class="k">pass</span>
 138
 139     <span class="k">def</span> <span class="nf">_configure_object</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 140         <span class="n">network</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;network&quot;</span><span class="p">)</span>
 141         <span class="n">prefix</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;prefix&quot;</span><span class="p">)</span>
 142         <span class="n">nexthop</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;nexthop&quot;</span><span class="p">)</span>
 143         <span class="n">ipv4_uuid</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">node</span><span class="o">.</span><span class="n">ipv4</span><span class="o">.</span><span class="n">uuid</span>
 144
 145         <span class="n">ret</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">invoke</span><span class="p">(</span><span class="n">ipv4_uuid</span><span class="p">,</span> <span class="s">&quot;addStaticRoute&quot;</span><span class="p">,</span> <span class="n">network</span><span class="p">,</span>
 146             <span class="n">prefix</span><span class="p">,</span> <span class="n">nexthop</span><span class="p">)</span>
 147
 148         <span class="k">if</span> <span class="ow">not</span> <span class="n">ret</span><span class="p">:</span>
 149             <span class="n">msg</span> <span class="o">=</span> <span class="s">&quot;Could not configure route </span><span class="si">%s</span><span class="s">/</span><span class="si">%s</span><span class="s"> hop: </span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">network</span><span class="p">,</span> <span class="n">prefix</span><span class="p">,</span>
 150                     <span class="n">nexthop</span><span class="p">)</span>
 151             <span class="bp">self</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
 152             <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="n">msg</span>
 153
 154     <span class="k">def</span> <span class="nf">_connect_object</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 155         <span class="n">node</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">node</span>
 156         <span class="k">if</span> <span class="n">node</span> <span class="ow">and</span> <span class="n">node</span><span class="o">.</span><span class="n">uuid</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">connected</span><span class="p">:</span>
 157             <span class="bp">self</span><span class="o">.</span><span class="n">_connected</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">node</span><span class="o">.</span><span class="n">uuid</span><span class="p">)</span>
 158 </pre></div></div>
 159
 160           </div>
 161         </div>
 162       </div>
 163       <div class="clearer"></div>
 164     </div>
 165     <div class="related">
 166       <h3>Navigation</h3>
 167       <ul>
 168         <li class="right" style="margin-right: 10px">
 169           <a href="../../../../genindex.html" title="General Index"
 170              >index</a></li>
 171         <li class="right" >
 172           <a href="../../../../py-modindex.html" title="Python Module Index"
 173              >modules</a> |</li>
 174         <li><a href="../../../../index.html">NEPI 3.0 documentation</a> &raquo;</li>
 175           <li><a href="../../../index.html" >Module code</a> &raquo;</li>
 176       </ul>
 177     </div>
 178     <div class="footer">
 179         &copy; Copyright 2014, Alina Quereilhac, Lucia Guevgeozian Odizzio, Julien Tribino.
 180       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
 181     </div>
 182   </body>
 183 </html>