1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5 <html xmlns="http://www.w3.org/1999/xhtml">
7 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9 <title>nepi.resources.linux.ccn.ccncontent — NEPI 3.0 documentation</title>
11 <link rel="stylesheet" href="../../../../../_static/sphinxdoc.css" type="text/css" />
12 <link rel="stylesheet" href="../../../../../_static/pygments.css" type="text/css" />
14 <script type="text/javascript">
15 var DOCUMENTATION_OPTIONS = {
16 URL_ROOT: '../../../../../',
18 COLLAPSE_INDEX: false,
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" />
33 <li class="right" style="margin-right: 10px">
34 <a href="../../../../../genindex.html" title="General Index"
35 accesskey="I">index</a></li>
37 <a href="../../../../../py-modindex.html" title="Python Module Index"
39 <li><a href="../../../../../index.html">NEPI 3.0 documentation</a> »</li>
40 <li><a href="../../../../index.html" accesskey="U">Module code</a> »</li>
43 <div class="sphinxsidebar">
44 <div class="sphinxsidebarwrapper">
45 <div id="searchbox" style="display: none">
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" />
53 <p class="searchtip" style="font-size: 90%">
54 Enter search terms or a module, class or function name.
57 <script type="text/javascript">$('#searchbox').show(0);</script>
61 <div class="document">
62 <div class="documentwrapper">
63 <div class="bodywrapper">
66 <h1>Source code for nepi.resources.linux.ccn.ccncontent</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 <http://www.gnu.org/licenses/>.</span>
82 <span class="c">#</span>
83 <span class="c"># Author: Alina Quereilhac <alina.quereilhac@inria.fr></span>
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><span class="p">,</span> \
87 <span class="n">ResourceAction</span>
88 <span class="kn">from</span> <span class="nn">nepi.resources.linux.application</span> <span class="kn">import</span> <span class="n">LinuxApplication</span>
89 <span class="kn">from</span> <span class="nn">nepi.resources.linux.ccn.ccnr</span> <span class="kn">import</span> <span class="n">LinuxCCNR</span>
90 <span class="kn">from</span> <span class="nn">nepi.util.timefuncs</span> <span class="kn">import</span> <span class="n">tnow</span>
92 <span class="kn">import</span> <span class="nn">os</span>
94 <span class="nd">@clsinit_copy</span>
95 <div class="viewcode-block" id="LinuxCCNContent"><a class="viewcode-back" href="../../../../../_layout/nepi.resources.linux.ccn.html#nepi.resources.linux.ccn.ccncontent.LinuxCCNContent">[docs]</a><span class="k">class</span> <span class="nc">LinuxCCNContent</span><span class="p">(</span><span class="n">LinuxApplication</span><span class="p">):</span>
96 <span class="n">_rtype</span> <span class="o">=</span> <span class="s">"linux::CCNContent"</span>
98 <span class="nd">@classmethod</span>
99 <span class="k">def</span> <span class="nf">_register_attributes</span><span class="p">(</span><span class="n">cls</span><span class="p">):</span>
100 <span class="n">content_name</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">"contentName"</span><span class="p">,</span>
101 <span class="s">"The name of the content to publish (e.g. ccn:/VIDEO) "</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>
104 <span class="n">content</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">"content"</span><span class="p">,</span>
105 <span class="s">"The content to publish. It can be a path to a file or plain text "</span><span class="p">,</span>
106 <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 <span class="n">scope</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">"scope"</span><span class="p">,</span>
109 <span class="s">"Use the given scope on the start-write request (if -r specified). "</span>
110 <span class="s">"scope can be 1 (local), 2 (neighborhood), or 3 (unlimited). "</span>
111 <span class="s">"Note that a scope of 3 is encoded as the absence of any scope in the interest. "</span><span class="p">,</span>
112 <span class="nb">type</span> <span class="o">=</span> <span class="n">Types</span><span class="o">.</span><span class="n">Integer</span><span class="p">,</span>
113 <span class="n">default</span> <span class="o">=</span> <span class="mi">1</span><span class="p">,</span>
114 <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>
116 <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">content_name</span><span class="p">)</span>
117 <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">content</span><span class="p">)</span>
118 <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">scope</span><span class="p">)</span>
120 <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>
121 <span class="nb">super</span><span class="p">(</span><span class="n">LinuxCCNContent</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>
122 <span class="bp">self</span><span class="o">.</span><span class="n">_home</span> <span class="o">=</span> <span class="s">"content-</span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">guid</span>
124 <span class="nd">@property</span>
125 <div class="viewcode-block" id="LinuxCCNContent.ccnr"><a class="viewcode-back" href="../../../../../_layout/nepi.resources.linux.ccn.html#nepi.resources.linux.ccn.ccncontent.LinuxCCNContent.ccnr">[docs]</a> <span class="k">def</span> <span class="nf">ccnr</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
126 <span class="n">ccnr</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">LinuxCCNR</span><span class="o">.</span><span class="n">get_rtype</span><span class="p">())</span>
127 <span class="k">if</span> <span class="n">ccnr</span><span class="p">:</span> <span class="k">return</span> <span class="n">ccnr</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
128 <span class="k">return</span> <span class="bp">None</span>
130 <span class="nd">@property</span>
131 <div class="viewcode-block" id="LinuxCCNContent.ccnd"><a class="viewcode-back" href="../../../../../_layout/nepi.resources.linux.ccn.html#nepi.resources.linux.ccn.ccncontent.LinuxCCNContent.ccnd">[docs]</a> <span class="k">def</span> <span class="nf">ccnd</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
132 <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">ccnr</span><span class="p">:</span> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">ccnr</span><span class="o">.</span><span class="n">ccnd</span>
133 <span class="k">return</span> <span class="bp">None</span>
135 <span class="nd">@property</span>
136 <div class="viewcode-block" id="LinuxCCNContent.node"><a class="viewcode-back" href="../../../../../_layout/nepi.resources.linux.ccn.html#nepi.resources.linux.ccn.ccncontent.LinuxCCNContent.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>
137 <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">ccnr</span><span class="p">:</span> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">ccnr</span><span class="o">.</span><span class="n">node</span>
138 <span class="k">return</span> <span class="bp">None</span>
140 <div class="viewcode-block" id="LinuxCCNContent.do_deploy"><a class="viewcode-back" href="../../../../../_layout/nepi.resources.linux.ccn.html#nepi.resources.linux.ccn.ccncontent.LinuxCCNContent.do_deploy">[docs]</a> <span class="k">def</span> <span class="nf">do_deploy</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
141 <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">ccnr</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">ccnr</span><span class="o">.</span><span class="n">state</span> <span class="o"><</span> <span class="n">ResourceState</span><span class="o">.</span><span class="n">READY</span><span class="p">:</span>
142 <span class="bp">self</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"---- RESCHEDULING DEPLOY ---- node state </span><span class="si">%s</span><span class="s"> "</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">state</span> <span class="p">)</span>
144 <span class="c"># ccnr needs to wait until ccnd is deployed and running</span>
145 <span class="bp">self</span><span class="o">.</span><span class="n">ec</span><span class="o">.</span><span class="n">schedule</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">reschedule_delay</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">deploy</span><span class="p">)</span>
146 <span class="k">else</span><span class="p">:</span>
147 <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">"command"</span><span class="p">):</span>
148 <span class="bp">self</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s">"command"</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_start_command</span><span class="p">)</span>
150 <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">"env"</span><span class="p">):</span>
151 <span class="bp">self</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s">"env"</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_environment</span><span class="p">)</span>
153 <span class="c"># set content to stdin, so the content will be</span>
154 <span class="c"># uploaded during provision</span>
155 <span class="bp">self</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s">"stdin"</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">"content"</span><span class="p">))</span>
157 <span class="n">command</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">"command"</span><span class="p">)</span>
159 <span class="bp">self</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s">"Deploying command '</span><span class="si">%s</span><span class="s">' "</span> <span class="o">%</span> <span class="n">command</span><span class="p">)</span>
161 <span class="bp">self</span><span class="o">.</span><span class="n">do_discover</span><span class="p">()</span>
162 <span class="bp">self</span><span class="o">.</span><span class="n">do_provision</span><span class="p">()</span>
164 <span class="bp">self</span><span class="o">.</span><span class="n">set_ready</span><span class="p">()</span>
166 <div class="viewcode-block" id="LinuxCCNContent.upload_start_command"><a class="viewcode-back" href="../../../../../_layout/nepi.resources.linux.ccn.html#nepi.resources.linux.ccn.ccncontent.LinuxCCNContent.upload_start_command">[docs]</a> <span class="k">def</span> <span class="nf">upload_start_command</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
167 <span class="n">command</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">"command"</span><span class="p">)</span>
168 <span class="n">env</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">"env"</span><span class="p">)</span>
170 <span class="bp">self</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s">"Uploading command '</span><span class="si">%s</span><span class="s">'"</span> <span class="o">%</span> <span class="n">command</span><span class="p">)</span>
172 <span class="c"># We want to make sure the content is published</span>
173 <span class="c"># before the experiment starts.</span>
174 <span class="c"># Run the command as a bash script in the background, </span>
175 <span class="c"># in the host ( but wait until the command has</span>
176 <span class="c"># finished to continue )</span>
177 <span class="n">env</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">replace_paths</span><span class="p">(</span><span class="n">env</span><span class="p">)</span>
178 <span class="n">command</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">replace_paths</span><span class="p">(</span><span class="n">command</span><span class="p">)</span>
180 <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="bp">self</span><span class="o">.</span><span class="n">execute_command</span><span class="p">(</span><span class="n">command</span><span class="p">,</span>
181 <span class="n">env</span><span class="p">,</span> <span class="n">blocking</span> <span class="o">=</span> <span class="bp">True</span><span class="p">)</span>
183 <span class="k">if</span> <span class="n">proc</span><span class="o">.</span><span class="n">poll</span><span class="p">():</span>
184 <span class="n">msg</span> <span class="o">=</span> <span class="s">"Failed to execute command"</span>
185 <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>
186 <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="n">msg</span>
188 <div class="viewcode-block" id="LinuxCCNContent.do_start"><a class="viewcode-back" href="../../../../../_layout/nepi.resources.linux.ccn.html#nepi.resources.linux.ccn.ccncontent.LinuxCCNContent.do_start">[docs]</a> <span class="k">def</span> <span class="nf">do_start</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
189 <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">state</span> <span class="o">==</span> <span class="n">ResourceState</span><span class="o">.</span><span class="n">READY</span><span class="p">:</span>
190 <span class="n">command</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">"command"</span><span class="p">)</span>
191 <span class="bp">self</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s">"Starting command '</span><span class="si">%s</span><span class="s">'"</span> <span class="o">%</span> <span class="n">command</span><span class="p">)</span>
193 <span class="bp">self</span><span class="o">.</span><span class="n">set_started</span><span class="p">()</span>
194 <span class="k">else</span><span class="p">:</span>
195 <span class="n">msg</span> <span class="o">=</span> <span class="s">" Failed to execute command '</span><span class="si">%s</span><span class="s">'"</span> <span class="o">%</span> <span class="n">command</span>
196 <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>
197 <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="n">msg</span>
199 <span class="nd">@property</span>
200 <span class="k">def</span> <span class="nf">_start_command</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
201 <span class="n">command</span> <span class="o">=</span> <span class="p">[</span><span class="s">"ccnseqwriter"</span><span class="p">]</span>
202 <span class="n">command</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">"-r </span><span class="si">%s</span><span class="s">"</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">"contentName"</span><span class="p">))</span>
203 <span class="n">command</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">"-s </span><span class="si">%d</span><span class="s">"</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">"scope"</span><span class="p">))</span>
204 <span class="n">command</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">"< </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">app_home</span><span class="p">,</span> <span class="s">'stdin'</span><span class="p">))</span>
206 <span class="n">command</span> <span class="o">=</span> <span class="s">" "</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">command</span><span class="p">)</span>
207 <span class="k">return</span> <span class="n">command</span>
209 <span class="nd">@property</span>
210 <span class="k">def</span> <span class="nf">_environment</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
211 <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">ccnd</span><span class="o">.</span><span class="n">path</span>
213 <div class="viewcode-block" id="LinuxCCNContent.valid_connection"><a class="viewcode-back" href="../../../../../_layout/nepi.resources.linux.ccn.html#nepi.resources.linux.ccn.ccncontent.LinuxCCNContent.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>
214 <span class="c"># TODO: Validate!</span>
215 <span class="k">return</span> <span class="bp">True</span>
216 </pre></div></div></div>
221 <div class="clearer"></div>
223 <div class="related">
226 <li class="right" style="margin-right: 10px">
227 <a href="../../../../../genindex.html" title="General Index"
230 <a href="../../../../../py-modindex.html" title="Python Module Index"
232 <li><a href="../../../../../index.html">NEPI 3.0 documentation</a> »</li>
233 <li><a href="../../../../index.html" >Module code</a> »</li>
237 © Copyright 2014, Alina Quereilhac, Lucia Guevgeozian Odizzio, Julien Tribino.
238 Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.