src/nepi/resources/linux/ccn/fibentry.py

   1 #
   2 #    NEPI, a framework to manage network experiments
   3 #    Copyright (C) 2013 INRIA
   4 #
   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.
   9 #
  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.
  14 #
  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/>.
  17 #
  18 # Author: Alina Quereilhac <alina.quereilhac@inria.fr>
  19
  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
  27
  28 import os
  29
  30
  31 # TODO: Add rest of options for ccndc!!!
  32 #       Implement ENTRY DELETE!!
  33
  34 @clsinit_copy
  35 class LinuxFIBEntry(LinuxApplication):
  36     _rtype = "LinuxFIBEntry"
  37
  38     @classmethod
  39     def _register_attributes(cls):
  40         uri = Attribute("uri",
  41                 "URI prefix to match and route for this FIB entry",
  42                 default = "ccnx:/",
  43                 flags = Flags.ExecReadOnly)
  44
  45         protocol = Attribute("protocol",
  46                 "Transport protocol used in network connection to peer "
  47                 "for this FIB entry. One of 'udp' or 'tcp'.",
  48                 type = Types.Enumerate,
  49                 default = "udp",
  50                 allowed = ["udp", "tcp"],
  51                 flags = Flags.ExecReadOnly)
  52
  53         host = Attribute("host",
  54                 "Peer host used in network connection for this FIB entry. ",
  55                 flags = Flags.ExecReadOnly)
  56
  57         port = Attribute("port",
  58                 "Peer port address used in network connection to peer "
  59                 "for this FIB entry.",
  60                 flags = Flags.ExecReadOnly)
  61
  62         cls._register_attribute(uri)
  63         cls._register_attribute(protocol)
  64         cls._register_attribute(host)
  65         cls._register_attribute(port)
  66
  67     @classmethod
  68     def _register_traces(cls):
  69         ping = Trace("ping", "Ping to the peer end")
  70         mtr = Trace("mtr", "Mtr to the peer end")
  71         traceroute = Trace("traceroute", "Tracerout to the peer end")
  72
  73         cls._register_trace(ping)
  74         cls._register_trace(mtr)
  75         cls._register_trace(traceroute)
  76
  77     def __init__(self, ec, guid):
  78         super(LinuxFIBEntry, self).__init__(ec, guid)
  79         self._home = "fib-%s" % self.guid
  80         self._ping = None
  81         self._mtr = None
  82         self._traceroute = None
  83
  84     @property
  85     def ccnd(self):
  86         ccnd = self.get_connected(LinuxCCND.rtype())
  87         if ccnd: return ccnd[0]
  88         return None
  89
  90     @property
  91     def node(self):
  92         if self.ccnd: return self.ccnd.node
  93         return None
  94
  95     def trace(self, name, attr = TraceAttr.ALL, block = 512, offset = 0):
  96         if name == "ping":
  97             return self.ec.trace(self._ping, "stdout", attr, block, offset)
  98         if name == "mtr":
  99             return self.ec.trace(self._mtr, "stdout", attr, block, offset)
 100         if name == "traceroute":
 101             return self.ec.trace(self._traceroute, "stdout", attr, block, offset)
 102
 103         return super(LinuxFIBEntry, self).trace(name, attr, block, offset)
 104
 105     def deploy(self):
 106         # Wait until associated ccnd is provisioned
 107         if not self.ccnd or self.ccnd.state < ResourceState.READY:
 108             # ccnr needs to wait until ccnd is deployed and running
 109             self.ec.schedule(reschedule_delay, self.deploy)
 110         else:
 111             try:
 112                 if not self.get("command"):
 113                     self.set("command", self._start_command)
 114
 115                 if not self.get("env"):
 116                     self.set("env", self._environment)
 117
 118                 command = self.get("command")
 119
 120                 self.info("Deploying command '%s' " % command)
 121
 122                 self.discover()
 123                 self.provision()
 124                 self.configure()
 125             except:
 126                 self.fail()
 127                 raise
 128
 129             self.debug("----- READY ---- ")
 130             self._ready_time = tnow()
 131             self._state = ResourceState.READY
 132
 133     def upload_start_command(self):
 134         command = self.get("command")
 135         env = self.get("env")
 136
 137         if command:
 138             # We want to make sure the FIB entries are created
 139             # before the experiment starts.
 140             # Run the command as a bash script in the background,
 141             # in the host ( but wait until the command has
 142             # finished to continue )
 143             env = env and self.replace_paths(env)
 144             command = self.replace_paths(command)
 145
 146             (out, err), proc = self.execute_command(command, env)
 147
 148             if proc.poll():
 149                 self._state = ResourceState.FAILED
 150                 msg = "Failed to execute command"
 151                 self.error(msg, out, err)
 152                 raise RuntimeError, msg
 153
 154     def configure(self):
 155         if self.trace_enabled("ping"):
 156             self.info("Configuring PING trace")
 157             self._ping = self.ec.register_resource("LinuxPing")
 158             self.ec.set(self._ping, "printTimestamp", True)
 159             self.ec.set(self._ping, "target", self.get("host"))
 160             self.ec.register_connection(self._ping, self.node.guid)
 161             # force waiting until ping is READY before we starting the FIB
 162             self.ec.register_condition(self.guid, ResourceAction.START,
 163                     self._ping, ResourceState.READY)
 164             # schedule ping deploy
 165             self.ec.deploy(group=[self._ping])
 166
 167         if self.trace_enabled("mtr"):
 168             self.info("Configuring MTR trace")
 169             self._mtr = self.ec.register_resource("LinuxMtr")
 170             self.ec.set(self._mtr, "noDns", True)
 171             self.ec.set(self._mtr, "printTimestamp", True)
 172             self.ec.set(self._mtr, "continuous", True)
 173             self.ec.set(self._mtr, "target", self.get("host"))
 174             self.ec.register_connection(self._mtr, self.node.guid)
 175             # force waiting until mtr is READY before we starting the FIB
 176             self.ec.register_condition(self.guid, ResourceAction.START,
 177                     self._mtr, ResourceState.READY)
 178             # schedule mtr deploy
 179             self.ec.deploy(group=[self._mtr])
 180
 181         if self.trace_enabled("traceroute"):
 182             self.info("Configuring TRACEROUTE trace")
 183             self._traceroute = self.ec.register_resource("LinuxTraceroute")
 184             self.ec.set(self._traceroute, "printTimestamp", True)
 185             self.ec.set(self._traceroute, "continuous", True)
 186             self.ec.set(self._traceroute, "target", self.get("host"))
 187             self.ec.register_connection(self._traceroute, self.node.guid)
 188             # force waiting until mtr is READY before we starting the FIB
 189             self.ec.register_condition(self.guid, ResourceAction.START,
 190                     self._traceroute, ResourceState.READY)
 191             # schedule mtr deploy
 192             self.ec.deploy(group=[self._traceroute])
 193
 194     def start(self):
 195         if self._state in [ResourceState.READY, ResourceState.STARTED]:
 196             command = self.get("command")
 197             self.info("Starting command '%s'" % command)
 198
 199             self._start_time = tnow()
 200             self._state = ResourceState.STARTED
 201         else:
 202             msg = " Failed to execute command '%s'" % command
 203             self.error(msg, out, err)
 204             self._state = ResourceState.FAILED
 205             raise RuntimeError, msg
 206
 207     def stop(self):
 208         command = self.get('command')
 209         env = self.get('env')
 210
 211         if self.state == ResourceState.STARTED:
 212             self.info("Stopping command '%s'" % command)
 213
 214             command = self._stop_command
 215             (out, err), proc = self.execute_command(command, env)
 216
 217             if proc.poll():
 218                 pass
 219
 220             self._stop_time = tnow()
 221             self._state = ResourceState.STOPPED
 222
 223     @property
 224     def state(self):
 225         return self._state
 226
 227     @property
 228     def _start_command(self):
 229         uri = self.get("uri") or ""
 230         protocol = self.get("protocol") or ""
 231         host = self.get("host") or ""
 232         port = self.get("port") or ""
 233
 234         # add ccnx:/example.com/ udp 224.0.0.204 52428
 235         return "ccndc add %(uri)s %(protocol)s %(host)s %(port)s" % ({
 236             "uri" : uri,
 237             "protocol": protocol,
 238             "host": host,
 239             "port": port
 240             })
 241
 242     @property
 243     def _stop_command(self):
 244         uri = self.get("uri") or ""
 245         protocol = self.get("protocol") or ""
 246         host = self.get("host") or ""
 247         port = self.get("port") or ""
 248
 249         # add ccnx:/example.com/ udp 224.0.0.204 52428
 250         return "ccndc del %(uri)s %(protocol)s %(host)s %(port)s" % ({
 251             "uri" : uri,
 252             "protocol": protocol,
 253             "host": host,
 254             "port": port
 255             })
 256
 257     @property
 258     def _environment(self):
 259         return self.ccnd.path
 260
 261     def valid_connection(self, guid):
 262         # TODO: Validate!
 263         return True
 264