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     def __init__(self, ec, guid):
  68         super(LinuxFIBEntry, self).__init__(ec, guid)
  69         self._home = "fib-%s" % self.guid
  70
  71     @property
  72     def ccnd(self):
  73         ccnd = self.get_connected(LinuxCCND.rtype())
  74         if ccnd: return ccnd[0]
  75         return None
  76
  77     @property
  78     def node(self):
  79         if self.ccnd: return self.ccnd.node
  80         return None
  81
  82     def deploy(self):
  83         # Wait until associated ccnd is provisioned
  84         if not self.ccnd or self.ccnd.state < ResourceState.READY:
  85             # ccnr needs to wait until ccnd is deployed and running
  86             self.ec.schedule(reschedule_delay, self.deploy)
  87         else:
  88             command = self._start_command
  89             env = self._environment
  90
  91             self.set("command", command)
  92             self.set("env", env)
  93
  94             self.info("Deploying command '%s' " % command)
  95
  96             # create run dir for application
  97             self.node.mkdir(self.run_home)
  98
  99             (out, err), proc = self.execute_command(command, env)
 100
 101             if proc.poll():
 102                 self._state = ResourceState.FAILED
 103                 msg = "Failed to execute command"
 104                 self.error(msg, out, err)
 105                 raise RuntimeError, msg
 106
 107             self.debug("----- READY ---- ")
 108             self._ready_time = tnow()
 109             self._state = ResourceState.READY
 110
 111     def start(self):
 112         if self._state in [ResourceState.READY, ResourceState.STARTED]:
 113             command = self.get("command")
 114             self.info("Starting command '%s'" % command)
 115
 116             self._start_time = tnow()
 117             self._state = ResourceState.STARTED
 118         else:
 119             msg = " Failed to execute command '%s'" % command
 120             self.error(msg, out, err)
 121             self._state = ResourceState.FAILED
 122             raise RuntimeError, msg
 123
 124     def stop(self):
 125         command = self.get('command')
 126         env = self.get('env')
 127
 128         if self.state == ResourceState.STARTED:
 129             self.info("Stopping command '%s'" % command)
 130
 131             command = self._stop_command
 132             (out, err), proc = self.execute_command(command, env)
 133
 134             if proc.poll():
 135                 pass
 136
 137             self._stop_time = tnow()
 138             self._state = ResourceState.STOPPED
 139
 140     @property
 141     def state(self):
 142         return self._state
 143
 144     @property
 145     def _start_command(self):
 146         uri = self.get("uri") or ""
 147         protocol = self.get("protocol") or ""
 148         host = self.get("host") or ""
 149         port = self.get("port") or ""
 150
 151         # add ccnx:/example.com/ udp 224.0.0.204 52428
 152         return "ccndc add %(uri)s %(protocol)s %(host)s %(port)s" % ({
 153             "uri" : uri,
 154             "protocol": protocol,
 155             "host": host,
 156             "port": port
 157             })
 158
 159     @property
 160     def _stop_command(self):
 161         uri = self.get("uri") or ""
 162         protocol = self.get("protocol") or ""
 163         host = self.get("host") or ""
 164         port = self.get("port") or ""
 165
 166         # add ccnx:/example.com/ udp 224.0.0.204 52428
 167         return "ccndc del %(uri)s %(protocol)s %(host)s %(port)s" % ({
 168             "uri" : uri,
 169             "protocol": protocol,
 170             "host": host,
 171             "port": port
 172             })
 173
 174     @property
 175     def _environment(self):
 176         return self.ccnd.path
 177
 178     def execute_command(self, command, env):
 179         environ = self.node.format_environment(env, inline = True)
 180         command = environ + command
 181         command = self.replace_paths(command)
 182
 183         return self.node.execute(command)
 184
 185     def valid_connection(self, guid):
 186         # TODO: Validate!
 187         return True
 188