src/nepi/resources/linux/ccn/ccnd.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 ResourceManager, clsinit_copy, \
  23         ResourceState, reschedule_delay
  24 from nepi.resources.linux.application import LinuxApplication
  25 from nepi.resources.linux.node import OSType
  26 from nepi.util.timefuncs import tnow, tdiffsec
  27
  28 import os
  29
  30 # TODO: use ccndlogging to dynamically change the logging level
  31
  32
  33 @clsinit_copy
  34 class LinuxCCND(LinuxApplication):
  35     _rtype = "LinuxCCND"
  36
  37     @classmethod
  38     def _register_attributes(cls):
  39         debug = Attribute("debug", "Sets the CCND_DEBUG environmental variable. "
  40             " Allowed values are : \n"
  41             "  0 - no messages \n"
  42             "  1 - basic messages (any non-zero value gets these) \n"
  43             "  2 - interest messages \n"
  44             "  4 - content messages \n"
  45             "  8 - matching details \n"
  46             "  16 - interest details \n"
  47             "  32 - gory interest details \n"
  48             "  64 - log occasional human-readable timestamps \n"
  49             "  128 - face registration debugging \n"
  50             "  -1 - max logging \n"
  51             "  Or apply bitwise OR to these values to get combinations of them",
  52             type = Types.Integer,
  53             flags = Flags.ExecReadOnly)
  54
  55         port = Attribute("port", "Sets the CCN_LOCAL_PORT environmental variable. "
  56             "Defaults to 9695 ",
  57             flags = Flags.ExecReadOnly)
  58
  59         sockname = Attribute("sockname",
  60             "Sets the CCN_LOCAL_SCOKNAME environmental variable. "
  61             "Defaults to /tmp/.ccnd.sock",
  62             flags = Flags.ExecReadOnly)
  63
  64         capacity = Attribute("capacity",
  65             "Sets the CCND_CAP environmental variable. "
  66             "Capacity limit in terms of ContentObjects",
  67             flags = Flags.ExecReadOnly)
  68
  69         mtu = Attribute("mtu", "Sets the CCND_MTU environmental variable. ",
  70             flags = Flags.ExecReadOnly)
  71
  72         data_pause = Attribute("dataPauseMicrosec",
  73             "Sets the CCND_DATA_PAUSE_MICROSEC environmental variable. ",
  74             flags = Flags.ExecReadOnly)
  75
  76         default_stale = Attribute("defaultTimeToStale",
  77              "Sets the CCND_DEFAULT_TIME_TO_STALE environmental variable. ",
  78             flags = Flags.ExecReadOnly)
  79
  80         max_stale = Attribute("maxTimeToStale",
  81             "Sets the CCND_MAX_TIME_TO_STALE environmental variable. ",
  82             flags = Flags.ExecReadOnly)
  83
  84         max_rte = Attribute("maxRteMicrosec",
  85             "Sets the CCND_MAX_RTE_MICROSEC environmental variable. ",
  86             flags = Flags.ExecReadOnly)
  87
  88         keystore = Attribute("keyStoreDirectory",
  89             "Sets the CCND_KEYSTORE_DIRECTORY environmental variable. ",
  90             flags = Flags.ExecReadOnly)
  91
  92         listen_on = Attribute("listenOn",
  93             "Sets the CCND_LISTEN_ON environmental variable. ",
  94             flags = Flags.ExecReadOnly)
  95
  96         autoreg = Attribute("autoreg",
  97             "Sets the CCND_AUTOREG environmental variable. ",
  98             flags = Flags.ExecReadOnly)
  99
 100         prefix = Attribute("prefix",
 101             "Sets the CCND_PREFIX environmental variable. ",
 102             flags = Flags.ExecReadOnly)
 103
 104         cls._register_attribute(debug)
 105         cls._register_attribute(port)
 106         cls._register_attribute(sockname)
 107         cls._register_attribute(capacity)
 108         cls._register_attribute(mtu)
 109         cls._register_attribute(data_pause)
 110         cls._register_attribute(default_stale)
 111         cls._register_attribute(max_stale)
 112         cls._register_attribute(max_rte)
 113         cls._register_attribute(keystore)
 114         cls._register_attribute(listen_on)
 115         cls._register_attribute(autoreg)
 116         cls._register_attribute(prefix)
 117
 118     @classmethod
 119     def _register_traces(cls):
 120         log = Trace("log", "CCND log output")
 121         status = Trace("status", "ccndstatus output")
 122
 123         cls._register_trace(log)
 124         cls._register_trace(status)
 125
 126     def __init__(self, ec, guid):
 127         super(LinuxCCND, self).__init__(ec, guid)
 128         self._home = "ccnd-%s" % self.guid
 129         self._version = "ccnx"
 130
 131     @property
 132     def version(self):
 133         return self._version
 134
 135     @property
 136     def path(self):
 137         return "PATH=$PATH:${BIN}/%s/" % self.version
 138
 139     def deploy(self):
 140         if not self.node or self.node.state < ResourceState.READY:
 141             self.debug("---- RESCHEDULING DEPLOY ---- node state %s " % self.node.state )
 142
 143             # ccnd needs to wait until node is deployed and running
 144             self.ec.schedule(reschedule_delay, self.deploy)
 145         else:
 146             try:
 147                 if not self.get("command"):
 148                     self.set("command", self._start_command)
 149
 150                 if not self.get("depends"):
 151                     self.set("depends", self._dependencies)
 152
 153                 if not self.get("sources"):
 154                     self.set("sources", self._sources)
 155
 156                 sources = self.get("sources")
 157                 source = sources.split(" ")[0]
 158                 basename = os.path.basename(source)
 159                 self._version = ( basename.strip().replace(".tar.gz", "")
 160                         .replace(".tar","")
 161                         .replace(".gz","")
 162                         .replace(".zip","") )
 163
 164                 if not self.get("build"):
 165                     self.set("build", self._build)
 166
 167                 if not self.get("install"):
 168                     self.set("install", self._install)
 169
 170                 if not self.get("env"):
 171                     self.set("env", self._environment)
 172
 173                 command = self.get("command")
 174
 175                 self.info("Deploying command '%s' " % command)
 176
 177                 self.discover()
 178                 self.provision()
 179             except:
 180                 self.fail()
 181                 return
 182
 183             self.debug("----- READY ---- ")
 184             self.set_ready()
 185
 186     def upload_start_command(self):
 187         command = self.get("command")
 188         env = self.get("env")
 189
 190         # We want to make sure the ccnd is running
 191         # before the experiment starts.
 192         # Run the command as a bash script in background,
 193         # in the host ( but wait until the command has
 194         # finished to continue )
 195         env = self.replace_paths(env)
 196         command = self.replace_paths(command)
 197
 198         shfile = os.path.join(self.app_home, "start.sh")
 199         self.node.run_and_wait(command, self.run_home,
 200                 shfile = shfile,
 201                 overwrite = False,
 202                 env = env,
 203                 raise_on_error = True)
 204
 205     def start(self):
 206         if self.state == ResourceState.READY:
 207             command = self.get("command")
 208             self.info("Starting command '%s'" % command)
 209
 210             self.set_started()
 211         else:
 212             msg = " Failed to execute command '%s'" % command
 213             self.error(msg, out, err)
 214             self.fail()
 215
 216     def stop(self):
 217         command = self.get('command') or ''
 218
 219         if self.state == ResourceState.STARTED:
 220             self.info("Stopping command '%s'" % command)
 221
 222             command = "ccndstop"
 223             env = self.get("env")
 224
 225             # replace application specific paths in the command
 226             command = self.replace_paths(command)
 227             env = env and self.replace_paths(env)
 228
 229             # Upload the command to a file, and execute asynchronously
 230             shfile = os.path.join(self.app_home, "stop.sh")
 231             self.node.run_and_wait(command, self.run_home,
 232                         shfile = shfile,
 233                         overwrite = False,
 234                         env = env,
 235                         pidfile = "ccndstop_pidfile",
 236                         ecodefile = "ccndstop_exitcode",
 237                         stdout = "ccndstop_stdout",
 238                         stderr = "ccndstop_stderr")
 239
 240             self.set_stopped()
 241
 242     @property
 243     def state(self):
 244         # First check if the ccnd has failed
 245         state_check_delay = 0.5
 246         if self._state == ResourceState.STARTED and \
 247                 tdiffsec(tnow(), self._last_state_check) > state_check_delay:
 248             (out, err), proc = self._ccndstatus
 249
 250             retcode = proc.poll()
 251
 252             if retcode == 1 and err.find("No such file or directory") > -1:
 253                 # ccnd is not running (socket not found)
 254                 self.set_finished()
 255             elif retcode:
 256                 # other errors ...
 257                 msg = " Failed to execute command '%s'" % self.get("command")
 258                 self.error(msg, out, err)
 259                 self.fail()
 260
 261             self._last_state_check = tnow()
 262
 263         return self._state
 264
 265     @property
 266     def _ccndstatus(self):
 267         env = self.get('env') or ""
 268         environ = self.node.format_environment(env, inline = True)
 269         command = environ + " ccndstatus"
 270         command = self.replace_paths(command)
 271
 272         return self.node.execute(command)
 273
 274     @property
 275     def _start_command(self):
 276         return "ccndstart"
 277
 278     @property
 279     def _dependencies(self):
 280         if self.node.use_rpm:
 281             return ( " autoconf openssl-devel  expat-devel libpcap-devel "
 282                 " ecryptfs-utils-devel libxml2-devel automake gawk "
 283                 " gcc gcc-c++ git pcre-devel make ")
 284         elif self.node.use_deb:
 285             return ( " autoconf libssl-dev libexpat-dev libpcap-dev "
 286                 " libecryptfs0 libxml2-utils automake gawk gcc g++ "
 287                 " git-core pkg-config libpcre3-dev make ")
 288         return ""
 289
 290     @property
 291     def _sources(self):
 292         return "http://www.ccnx.org/releases/ccnx-0.7.2.tar.gz"
 293
 294     @property
 295     def _build(self):
 296         sources = self.get("sources").split(" ")[0]
 297         sources = os.path.basename(sources)
 298
 299         return (
 300             # Evaluate if ccnx binaries are already installed
 301             " ( "
 302                 " test -f ${BIN}/%(version)s/ccnd && "
 303                 " echo 'binaries found, nothing to do' "
 304             " ) || ( "
 305             # If not, untar and build
 306                 " ( "
 307                     " mkdir -p ${SRC}/%(version)s && "
 308                     " tar xf ${SRC}/%(sources)s --strip-components=1 -C ${SRC}/%(version)s "
 309                  " ) && "
 310                     "cd ${SRC}/%(version)s && "
 311                     # Just execute and silence warnings...
 312                     " ( ./configure && make ) "
 313              " )") % ({ 'sources': sources,
 314                         'version': self.version
 315                  })
 316
 317     @property
 318     def _install(self):
 319         return (
 320             # Evaluate if ccnx binaries are already installed
 321             " ( "
 322                 " test -f ${BIN}/%(version)s/ccnd && "
 323                 " echo 'binaries found, nothing to do' "
 324             " ) || ( "
 325             # If not, install
 326                 "  mkdir -p ${BIN}/%(version)s && "
 327                 "  mv ${SRC}/%(version)s/bin/* ${BIN}/%(version)s/ "
 328             " )"
 329             ) % ({ 'version': self.version
 330                  })
 331
 332     @property
 333     def _environment(self):
 334         envs = dict({
 335             "debug": "CCND_DEBUG",
 336             "port": "CCN_LOCAL_PORT",
 337             "sockname" : "CCN_LOCAL_SOCKNAME",
 338             "capacity" : "CCND_CAP",
 339             "mtu" : "CCND_MTU",
 340             "dataPauseMicrosec" : "CCND_DATA_PAUSE_MICROSEC",
 341             "defaultTimeToStale" : "CCND_DEFAULT_TIME_TO_STALE",
 342             "maxTimeToStale" : "CCND_MAX_TIME_TO_STALE",
 343             "maxRteMicrosec" : "CCND_MAX_RTE_MICROSEC",
 344             "keyStoreDirectory" : "CCND_KEYSTORE_DIRECTORY",
 345             "listenOn" : "CCND_LISTEN_ON",
 346             "autoreg" : "CCND_AUTOREG",
 347             "prefix" : "CCND_PREFIX",
 348             })
 349
 350         env = self.path
 351         env += " ".join(map(lambda k: "%s=%s" % (envs.get(k), str(self.get(k))) \
 352             if self.get(k) else "", envs.keys()))
 353
 354         return env
 355
 356     def valid_connection(self, guid):
 357         # TODO: Validate!
 358         return True
 359