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", "Continuous ping to the peer end")
  70
  71         cls._register_trace(ping)
  72
  73     def __init__(self, ec, guid):
  74         super(LinuxFIBEntry, self).__init__(ec, guid)
  75         self._home = "fib-%s" % self.guid
  76
  77     @property
  78     def ccnd(self):
  79         ccnd = self.get_connected(LinuxCCND.rtype())
  80         if ccnd: return ccnd[0]
  81         return None
  82
  83     @property
  84     def node(self):
  85         if self.ccnd: return self.ccnd.node
  86         return None
  87
  88     def deploy(self):
  89         # Wait until associated ccnd is provisioned
  90         if not self.ccnd or self.ccnd.state < ResourceState.READY:
  91             # ccnr needs to wait until ccnd is deployed and running
  92             self.ec.schedule(reschedule_delay, self.deploy)
  93         else:
  94             try:
  95                 if not self.get("command"):
  96                     self.set("command", self._start_command)
  97
  98                 if not self.get("env"):
  99                     self.set("env", self._environment)
 100
 101                 command = self.get("command")
 102
 103                 self.info("Deploying command '%s' " % command)
 104
 105                 self.discover()
 106                 self.provision()
 107                 self.configure()
 108             except:
 109                 self.fail()
 110                 raise
 111
 112             self.debug("----- READY ---- ")
 113             self._ready_time = tnow()
 114             self._state = ResourceState.READY
 115
 116     def upload_start_command(self):
 117         command = self.get("command")
 118         env = self.get("env")
 119
 120         if command:
 121             # We want to make sure the FIB entries are created
 122             # before the experiment starts.
 123             # Run the command as a bash script in the background,
 124             # in the host ( but wait until the command has
 125             # finished to continue )
 126             env = env and self.replace_paths(env)
 127             command = self.replace_paths(command)
 128
 129             (out, err), proc = self.execute_command(command, env)
 130
 131             if proc.poll():
 132                 self._state = ResourceState.FAILED
 133                 msg = "Failed to execute command"
 134                 self.error(msg, out, err)
 135                 raise RuntimeError, msg
 136
 137     def configure(self):
 138         if not self.trace_enabled("ping"):
 139             return
 140
 141         command = """ping %s""" % self.get("host")
 142         (out, err), proc = self.node.run(command, self.run_home,
 143             stdout = "ping",
 144             stderr = "ping_stderr",
 145             pidfile = "ping_pidfile")
 146
 147         # Wait for pid file to be generated
 148         pid, ppid = self.node.wait_pid(self.run_home, "ping_pidfile")
 149
 150         # If the process is not running, check for error information
 151         # on the remote machine
 152         if not pid or not ppid:
 153             (out, err), proc = self.node.check_errors(self.run_home,
 154                     stderr = "ping_pidfile")
 155
 156             # Out is what was written in the stderr file
 157             if err:
 158                 self.fail()
 159                 msg = " Failed to deploy ping trace command '%s' " % command
 160                 self.error(msg, out, err)
 161                 raise RuntimeError, msg
 162
 163     def start(self):
 164         if self._state in [ResourceState.READY, ResourceState.STARTED]:
 165             command = self.get("command")
 166             self.info("Starting command '%s'" % command)
 167
 168             self._start_time = tnow()
 169             self._state = ResourceState.STARTED
 170         else:
 171             msg = " Failed to execute command '%s'" % command
 172             self.error(msg, out, err)
 173             self._state = ResourceState.FAILED
 174             raise RuntimeError, msg
 175
 176     def stop(self):
 177         command = self.get('command')
 178         env = self.get('env')
 179
 180         if self.state == ResourceState.STARTED:
 181             self.info("Stopping command '%s'" % command)
 182
 183             command = self._stop_command
 184             (out, err), proc = self.execute_command(command, env)
 185
 186             if proc.poll():
 187                 pass
 188
 189             # now stop the ping trace
 190             if self.trace_enabled("ping"):
 191                pid, ppid = self.node.wait_pid(self.run_home, "ping_pidfile")
 192                (out, err), proc = self.node.kill(pid, ppid)
 193
 194             self._stop_time = tnow()
 195             self._state = ResourceState.STOPPED
 196
 197     @property
 198     def state(self):
 199         return self._state
 200
 201     @property
 202     def _start_command(self):
 203         uri = self.get("uri") or ""
 204         protocol = self.get("protocol") or ""
 205         host = self.get("host") or ""
 206         port = self.get("port") or ""
 207
 208         # add ccnx:/example.com/ udp 224.0.0.204 52428
 209         return "ccndc add %(uri)s %(protocol)s %(host)s %(port)s" % ({
 210             "uri" : uri,
 211             "protocol": protocol,
 212             "host": host,
 213             "port": port
 214             })
 215
 216     @property
 217     def _stop_command(self):
 218         uri = self.get("uri") or ""
 219         protocol = self.get("protocol") or ""
 220         host = self.get("host") or ""
 221         port = self.get("port") or ""
 222
 223         # add ccnx:/example.com/ udp 224.0.0.204 52428
 224         return "ccndc del %(uri)s %(protocol)s %(host)s %(port)s" % ({
 225             "uri" : uri,
 226             "protocol": protocol,
 227             "host": host,
 228             "port": port
 229             })
 230
 231     @property
 232     def _environment(self):
 233         return self.ccnd.path
 234
 235     def valid_connection(self, guid):
 236         # TODO: Validate!
 237         return True
 238