2 # NEPI, a framework to manage network experiments
3 # Copyright (C) 2013 INRIA
5 # This program is free software: you can redistribute it and/or modify
6 # it under the terms of the GNU General Public License as published by
7 # the Free Software Foundation, either version 3 of the License, or
8 # (at your option) any later version.
10 # This program is distributed in the hope that it will be useful,
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 # GNU General Public License for more details.
15 # You should have received a copy of the GNU General Public License
16 # along with this program. If not, see <http://www.gnu.org/licenses/>.
18 # Author: Alina Quereilhac <alina.quereilhac@inria.fr>
20 from nepi.execution.attribute import Attribute, Flags, Types
21 from nepi.execution.trace import Trace, TraceAttr
22 from nepi.execution.resource import clsinit_copy, ResourceState, \
23 ResourceAction, reschedule_delay
24 from nepi.resources.linux.application import LinuxApplication
25 from nepi.resources.linux.ccn.ccnd import LinuxCCND
26 from nepi.util.timefuncs import tnow
33 # TODO: Add rest of options for ccndc!!!
34 # Implement ENTRY DELETE!!
37 class LinuxFIBEntry(LinuxApplication):
38 _rtype = "LinuxFIBEntry"
41 def _register_attributes(cls):
42 uri = Attribute("uri",
43 "URI prefix to match and route for this FIB entry",
45 flags = Flags.ExecReadOnly)
47 protocol = Attribute("protocol",
48 "Transport protocol used in network connection to peer "
49 "for this FIB entry. One of 'udp' or 'tcp'.",
50 type = Types.Enumerate,
52 allowed = ["udp", "tcp"],
53 flags = Flags.ExecReadOnly)
55 host = Attribute("host",
56 "Peer hostname used in network connection for this FIB entry. ",
57 flags = Flags.ExecReadOnly)
59 port = Attribute("port",
60 "Peer port address used in network connection to peer "
61 "for this FIB entry.",
62 flags = Flags.ExecReadOnly)
65 "Peer host public IP used in network connection for this FIB entry. ",
66 flags = Flags.ReadOnly)
68 cls._register_attribute(uri)
69 cls._register_attribute(protocol)
70 cls._register_attribute(host)
71 cls._register_attribute(port)
72 cls._register_attribute(ip)
75 def _register_traces(cls):
76 ping = Trace("ping", "Ping to the peer end")
77 mtr = Trace("mtr", "Mtr to the peer end")
78 traceroute = Trace("traceroute", "Tracerout to the peer end")
80 cls._register_trace(ping)
81 cls._register_trace(mtr)
82 cls._register_trace(traceroute)
84 def __init__(self, ec, guid):
85 super(LinuxFIBEntry, self).__init__(ec, guid)
86 self._home = "fib-%s" % self.guid
89 self._traceroute = None
93 ccnd = self.get_connected(LinuxCCND.get_rtype())
94 if ccnd: return ccnd[0]
99 if self.ccnd: return self.ccnd.node
102 def trace(self, name, attr = TraceAttr.ALL, block = 512, offset = 0):
104 return self.ec.trace(self._ping, "stdout", attr, block, offset)
106 return self.ec.trace(self._mtr, "stdout", attr, block, offset)
107 if name == "traceroute":
108 return self.ec.trace(self._traceroute, "stdout", attr, block, offset)
110 return super(LinuxFIBEntry, self).trace(name, attr, block, offset)
113 # Wait until associated ccnd is provisioned
114 if not self.ccnd or self.ccnd.state < ResourceState.READY:
115 # ccnr needs to wait until ccnd is deployed and running
116 self.ec.schedule(reschedule_delay, self.deploy)
118 if not self.get("ip"):
119 host = self.get("host")
120 ip = socket.gethostbyname(host)
123 if not self.get("command"):
124 self.set("command", self._start_command)
126 if not self.get("env"):
127 self.set("env", self._environment)
129 command = self.get("command")
131 self.info("Deploying command '%s' " % command)
137 self.debug("----- READY ---- ")
140 def upload_start_command(self):
141 command = self.get("command")
142 env = self.get("env")
144 # We want to make sure the FIB entries are created
145 # before the experiment starts.
146 # Run the command as a bash script in the background,
147 # in the host ( but wait until the command has
148 # finished to continue )
149 env = env and self.replace_paths(env)
150 command = self.replace_paths(command)
152 # ccndc seems to return exitcode OK even if a (dns) error
153 # occurred, so we need to account for this case here.
154 (out, err), proc = self.execute_command(command,
155 env, blocking = True)
158 msg = "Failed to execute command"
159 self.error(msg, out, err)
160 raise RuntimeError, msg
163 if self.trace_enabled("ping"):
164 self.info("Configuring PING trace")
165 self._ping = self.ec.register_resource("LinuxPing")
166 self.ec.set(self._ping, "printTimestamp", True)
167 self.ec.set(self._ping, "target", self.get("host"))
168 self.ec.register_connection(self._ping, self.node.guid)
169 # schedule ping deploy
170 self.ec.deploy(guids=[self._ping], group = self.deployment_group)
172 if self.trace_enabled("mtr"):
173 self.info("Configuring MTR trace")
174 self._mtr = self.ec.register_resource("LinuxMtr")
175 self.ec.set(self._mtr, "noDns", True)
176 self.ec.set(self._mtr, "printTimestamp", True)
177 self.ec.set(self._mtr, "continuous", True)
178 self.ec.set(self._mtr, "target", self.get("host"))
179 self.ec.register_connection(self._mtr, self.node.guid)
180 # schedule mtr deploy
181 self.ec.deploy(guids=[self._mtr], group = self.deployment_group)
183 if self.trace_enabled("traceroute"):
184 self.info("Configuring TRACEROUTE trace")
185 self._traceroute = self.ec.register_resource("LinuxTraceroute")
186 self.ec.set(self._traceroute, "printTimestamp", True)
187 self.ec.set(self._traceroute, "continuous", True)
188 self.ec.set(self._traceroute, "target", self.get("host"))
189 self.ec.register_connection(self._traceroute, self.node.guid)
190 # schedule mtr deploy
191 self.ec.deploy(guids=[self._traceroute], group = self.deployment_group)
194 if self.state == ResourceState.READY:
195 command = self.get("command")
196 self.info("Starting command '%s'" % command)
200 msg = " Failed to execute command '%s'" % command
201 self.error(msg, out, err)
202 raise RuntimeError, msg
205 command = self.get('command')
206 env = self.get('env')
208 if self.state == ResourceState.STARTED:
209 self.info("Stopping command '%s'" % command)
211 command = self._stop_command
212 (out, err), proc = self.execute_command(command, env,
218 msg = " Failed to execute command '%s'" % command
219 self.error(msg, out, err)
220 raise RuntimeError, msg
223 def _start_command(self):
224 uri = self.get("uri") or ""
225 protocol = self.get("protocol") or ""
226 ip = self.get("ip") or ""
227 port = self.get("port") or ""
229 # add ccnx:/example.com/ udp 224.0.0.204 52428
230 return "ccndc add %(uri)s %(protocol)s %(host)s %(port)s" % ({
232 "protocol": protocol,
238 def _stop_command(self):
239 uri = self.get("uri") or ""
240 protocol = self.get("protocol") or ""
241 ip = self.get("ip") or ""
242 port = self.get("port") or ""
244 # add ccnx:/example.com/ udp 224.0.0.204 52428
245 return "ccndc del %(uri)s %(protocol)s %(host)s %(port)s" % ({
247 "protocol": protocol,
253 def _environment(self):
254 return self.ccnd.path
256 def valid_connection(self, guid):