doc/sphinx/_build/html/_modules/nepi/resources/linux/gretunnel.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.gretunnel &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.gretunnel</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">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.linux.tunnel</span> <span class="kn">import</span> <span class="n">LinuxTunnel</span>
  88 <span class="kn">from</span> <span class="nn">nepi.util.sshfuncs</span> <span class="kn">import</span> <span class="n">ProcStatus</span>
  89 <span class="kn">from</span> <span class="nn">nepi.util.timefuncs</span> <span class="kn">import</span> <span class="n">tnow</span><span class="p">,</span> <span class="n">tdiffsec</span>
  90
  91 <span class="kn">import</span> <span class="nn">re</span>
  92 <span class="kn">import</span> <span class="nn">socket</span>
  93 <span class="kn">import</span> <span class="nn">time</span>
  94 <span class="kn">import</span> <span class="nn">os</span>
  95
  96 <span class="nd">@clsinit_copy</span>
  97 <div class="viewcode-block" id="LinuxGRETunnel"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.gretunnel.LinuxGRETunnel">[docs]</a><span class="k">class</span> <span class="nc">LinuxGRETunnel</span><span class="p">(</span><span class="n">LinuxTunnel</span><span class="p">):</span>
  98     <span class="n">_rtype</span> <span class="o">=</span> <span class="s">&quot;linux::GRETunnel&quot;</span>
  99     <span class="n">_help</span> <span class="o">=</span> <span class="s">&quot;Constructs a tunnel between two Linux endpoints using a UDP connection &quot;</span>
 100
 101 <div class="viewcode-block" id="LinuxGRETunnel.log_message"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.gretunnel.LinuxGRETunnel.log_message">[docs]</a>    <span class="k">def</span> <span class="nf">log_message</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">msg</span><span class="p">):</span>
 102         <span class="k">return</span> <span class="s">&quot; guid </span><span class="si">%d</span><span class="s"> - GRE tunnel </span><span class="si">%s</span><span class="s"> - </span><span class="si">%s</span><span class="s"> - </span><span class="si">%s</span><span class="s"> &quot;</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">guid</span><span class="p">,</span>
 103                 <span class="bp">self</span><span class="o">.</span><span class="n">endpoint1</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>
 104                 <span class="bp">self</span><span class="o">.</span><span class="n">endpoint2</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>
 105                 <span class="n">msg</span><span class="p">)</span>
 106 </div>
 107 <div class="viewcode-block" id="LinuxGRETunnel.get_endpoints"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.gretunnel.LinuxGRETunnel.get_endpoints">[docs]</a>    <span class="k">def</span> <span class="nf">get_endpoints</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 108         <span class="sd">&quot;&quot;&quot; Returns the list of RM that are endpoints to the tunnel </span>
 109 <span class="sd">        &quot;&quot;&quot;</span>
 110         <span class="n">connected</span> <span class="o">=</span> <span class="p">[]</span>
 111         <span class="k">for</span> <span class="n">guid</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">connections</span><span class="p">:</span>
 112             <span class="n">rm</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">ec</span><span class="o">.</span><span class="n">get_resource</span><span class="p">(</span><span class="n">guid</span><span class="p">)</span>
 113             <span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">rm</span><span class="p">,</span> <span class="s">&quot;gre_connect&quot;</span><span class="p">):</span>
 114                 <span class="n">connected</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">rm</span><span class="p">)</span>
 115         <span class="k">return</span> <span class="n">connected</span>
 116 </div>
 117 <div class="viewcode-block" id="LinuxGRETunnel.initiate_connection"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.gretunnel.LinuxGRETunnel.initiate_connection">[docs]</a>    <span class="k">def</span> <span class="nf">initiate_connection</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">endpoint</span><span class="p">,</span> <span class="n">remote_endpoint</span><span class="p">):</span>
 118         <span class="c"># Return the command to execute to initiate the connection to the</span>
 119         <span class="c"># other endpoint</span>
 120         <span class="n">connection_run_home</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">run_home</span><span class="p">(</span><span class="n">endpoint</span><span class="p">)</span>
 121         <span class="n">connection_app_home</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">app_home</span><span class="p">(</span><span class="n">endpoint</span><span class="p">)</span>
 122         <span class="n">data</span> <span class="o">=</span> <span class="n">endpoint</span><span class="o">.</span><span class="n">gre_connect</span><span class="p">(</span><span class="n">remote_endpoint</span><span class="p">,</span>
 123                 <span class="n">connection_app_home</span><span class="p">,</span>
 124                 <span class="n">connection_run_home</span><span class="p">)</span>
 125         <span class="k">return</span> <span class="n">data</span>
 126 </div>
 127 <div class="viewcode-block" id="LinuxGRETunnel.establish_connection"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.gretunnel.LinuxGRETunnel.establish_connection">[docs]</a>    <span class="k">def</span> <span class="nf">establish_connection</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">endpoint</span><span class="p">,</span> <span class="n">remote_endpoint</span><span class="p">,</span> <span class="n">data</span><span class="p">):</span>
 128         <span class="k">pass</span>
 129 </div>
 130 <div class="viewcode-block" id="LinuxGRETunnel.verify_connection"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.gretunnel.LinuxGRETunnel.verify_connection">[docs]</a>    <span class="k">def</span> <span class="nf">verify_connection</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">endpoint</span><span class="p">,</span> <span class="n">remote_endpoint</span><span class="p">):</span>
 131         <span class="n">remote_ip</span> <span class="o">=</span> <span class="n">socket</span><span class="o">.</span><span class="n">gethostbyname</span><span class="p">(</span><span class="n">remote_endpoint</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>
 132
 133         <span class="n">command</span> <span class="o">=</span> <span class="s">&quot;ping -c 4 </span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="n">remote_ip</span>
 134         <span class="p">(</span><span class="n">out</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="n">endpoint</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>
 135                 <span class="n">blocking</span> <span class="o">=</span> <span class="bp">True</span><span class="p">)</span>
 136
 137         <span class="n">m</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="s">&quot;(\d+)% packet loss&quot;</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="n">out</span><span class="p">))</span>
 138         <span class="k">if</span> <span class="ow">not</span> <span class="n">m</span> <span class="ow">or</span> <span class="nb">int</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">groups</span><span class="p">()[</span><span class="mi">0</span><span class="p">])</span> <span class="o">==</span> <span class="mi">100</span><span class="p">:</span>
 139              <span class="n">msg</span> <span class="o">=</span> <span class="s">&quot; Error establishing GRE Tunnel&quot;</span>
 140              <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> <span class="n">out</span><span class="p">,</span> <span class="n">err</span><span class="p">)</span>
 141              <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="n">msg</span>
 142 </div>
 143 <div class="viewcode-block" id="LinuxGRETunnel.terminate_connection"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.gretunnel.LinuxGRETunnel.terminate_connection">[docs]</a>    <span class="k">def</span> <span class="nf">terminate_connection</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">endpoint</span><span class="p">,</span> <span class="n">remote_endpoint</span><span class="p">):</span>
 144         <span class="k">pass</span>
 145 </div>
 146 <div class="viewcode-block" id="LinuxGRETunnel.check_state_connection"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.gretunnel.LinuxGRETunnel.check_state_connection">[docs]</a>    <span class="k">def</span> <span class="nf">check_state_connection</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 147         <span class="k">pass</span>
 148 </div>
 149 <div class="viewcode-block" id="LinuxGRETunnel.valid_connection"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.gretunnel.LinuxGRETunnel.valid_connection">[docs]</a>    <span class="k">def</span> <span class="nf">valid_connection</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">guid</span><span class="p">):</span>
 150         <span class="c"># TODO: Validate!</span>
 151         <span class="k">return</span> <span class="bp">True</span>
 152 </pre></div></div></div>
 153
 154           </div>
 155         </div>
 156       </div>
 157       <div class="clearer"></div>
 158     </div>
 159     <div class="related">
 160       <h3>Navigation</h3>
 161       <ul>
 162         <li class="right" style="margin-right: 10px">
 163           <a href="../../../../genindex.html" title="General Index"
 164              >index</a></li>
 165         <li class="right" >
 166           <a href="../../../../py-modindex.html" title="Python Module Index"
 167              >modules</a> |</li>
 168         <li><a href="../../../../index.html">NEPI 3.2 documentation</a> &raquo;</li>
 169           <li><a href="../../../index.html" >Module code</a> &raquo;</li>
 170       </ul>
 171     </div>
 172     <div class="footer">
 173         &copy; Copyright 2014, Alina Quereilhac, Lucia Guevgeozian Odizzio, Julien Tribino.
 174       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
 175     </div>
 176   </body>
 177 </html>