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 ResourceManager, clsinit_copy, \
23 ResourceState, reschedule_delay, failtrap
24 from nepi.resources.linux.application import LinuxApplication
25 from nepi.resources.linux.node import OSType
26 from nepi.util.timefuncs import tnow, tdiffsec
30 # TODO: use ccndlogging to dynamically change the logging level
34 class LinuxCCND(LinuxApplication):
38 def _register_attributes(cls):
39 debug = Attribute("debug", "Sets the CCND_DEBUG environmental variable. "
40 " Allowed values are : \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",
53 flags = Flags.ExecReadOnly)
55 port = Attribute("port", "Sets the CCN_LOCAL_PORT environmental variable. "
57 flags = Flags.ExecReadOnly)
59 sockname = Attribute("sockname",
60 "Sets the CCN_LOCAL_SCOKNAME environmental variable. "
61 "Defaults to /tmp/.ccnd.sock",
62 flags = Flags.ExecReadOnly)
64 capacity = Attribute("capacity",
65 "Sets the CCND_CAP environmental variable. "
66 "Capacity limit in terms of ContentObjects",
67 flags = Flags.ExecReadOnly)
69 mtu = Attribute("mtu", "Sets the CCND_MTU environmental variable. ",
70 flags = Flags.ExecReadOnly)
72 data_pause = Attribute("dataPauseMicrosec",
73 "Sets the CCND_DATA_PAUSE_MICROSEC environmental variable. ",
74 flags = Flags.ExecReadOnly)
76 default_stale = Attribute("defaultTimeToStale",
77 "Sets the CCND_DEFAULT_TIME_TO_STALE environmental variable. ",
78 flags = Flags.ExecReadOnly)
80 max_stale = Attribute("maxTimeToStale",
81 "Sets the CCND_MAX_TIME_TO_STALE environmental variable. ",
82 flags = Flags.ExecReadOnly)
84 max_rte = Attribute("maxRteMicrosec",
85 "Sets the CCND_MAX_RTE_MICROSEC environmental variable. ",
86 flags = Flags.ExecReadOnly)
88 keystore = Attribute("keyStoreDirectory",
89 "Sets the CCND_KEYSTORE_DIRECTORY environmental variable. ",
90 flags = Flags.ExecReadOnly)
92 listen_on = Attribute("listenOn",
93 "Sets the CCND_LISTEN_ON environmental variable. ",
94 flags = Flags.ExecReadOnly)
96 autoreg = Attribute("autoreg",
97 "Sets the CCND_AUTOREG environmental variable. ",
98 flags = Flags.ExecReadOnly)
100 prefix = Attribute("prefix",
101 "Sets the CCND_PREFIX environmental variable. ",
102 flags = Flags.ExecReadOnly)
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)
119 def _register_traces(cls):
120 log = Trace("log", "CCND log output")
121 status = Trace("status", "ccndstatus output")
123 cls._register_trace(log)
124 cls._register_trace(status)
126 def __init__(self, ec, guid):
127 super(LinuxCCND, self).__init__(ec, guid)
128 self._home = "ccnd-%s" % self.guid
129 self._version = "ccnx"
137 return "PATH=$PATH:${BIN}/%s/" % self.version
141 if not self.node or self.node.state < ResourceState.READY:
142 self.debug("---- RESCHEDULING DEPLOY ---- node state %s " % self.node.state )
144 # ccnd needs to wait until node is deployed and running
145 self.ec.schedule(reschedule_delay, self.deploy)
147 if not self.get("command"):
148 self.set("command", self._start_command)
150 if not self.get("depends"):
151 self.set("depends", self._dependencies)
153 if not self.get("sources"):
154 self.set("sources", self._sources)
156 sources = self.get("sources")
157 source = sources.split(" ")[0]
158 basename = os.path.basename(source)
159 self._version = ( basename.strip().replace(".tar.gz", "")
162 .replace(".zip","") )
164 if not self.get("build"):
165 self.set("build", self._build)
167 if not self.get("install"):
168 self.set("install", self._install)
170 if not self.get("env"):
171 self.set("env", self._environment)
173 command = self.get("command")
175 self.info("Deploying command '%s' " % command)
180 self.debug("----- READY ---- ")
183 def upload_start_command(self):
184 command = self.get("command")
185 env = self.get("env")
187 # We want to make sure the ccnd is running
188 # before the experiment starts.
189 # Run the command as a bash script in background,
190 # in the host ( but wait until the command has
191 # finished to continue )
192 env = self.replace_paths(env)
193 command = self.replace_paths(command)
195 shfile = os.path.join(self.app_home, "start.sh")
196 self.node.run_and_wait(command, self.run_home,
200 raise_on_error = True)
204 if self.state == ResourceState.READY:
205 command = self.get("command")
206 self.info("Starting command '%s'" % command)
210 msg = " Failed to execute command '%s'" % command
211 self.error(msg, out, err)
212 raise RuntimeError, msg
216 command = self.get('command') or ''
218 if self.state == ResourceState.STARTED:
219 self.info("Stopping command '%s'" % command)
222 env = self.get("env")
224 # replace application specific paths in the command
225 command = self.replace_paths(command)
226 env = env and self.replace_paths(env)
228 # Upload the command to a file, and execute asynchronously
229 shfile = os.path.join(self.app_home, "stop.sh")
230 self.node.run_and_wait(command, self.run_home,
234 pidfile = "ccndstop_pidfile",
235 ecodefile = "ccndstop_exitcode",
236 stdout = "ccndstop_stdout",
237 stderr = "ccndstop_stderr")
243 # First check if the ccnd has failed
244 state_check_delay = 0.5
245 if self._state == ResourceState.STARTED and \
246 tdiffsec(tnow(), self._last_state_check) > state_check_delay:
247 (out, err), proc = self._ccndstatus()
249 retcode = proc.poll()
251 if retcode == 1 and err.find("No such file or directory") > -1:
252 # ccnd is not running (socket not found)
256 msg = " Failed to execute command '%s'" % self.get("command")
257 self.error(msg, out, err)
260 self._last_state_check = tnow()
264 def _ccndstatus(self):
265 env = self.get('env') or ""
266 environ = self.node.format_environment(env, inline = True)
267 command = environ + " ccndstatus"
268 command = self.replace_paths(command)
270 return self.node.execute(command)
273 def _start_command(self):
277 def _dependencies(self):
278 if self.node.use_rpm:
279 return ( " autoconf openssl-devel expat-devel libpcap-devel "
280 " ecryptfs-utils-devel libxml2-devel automake gawk "
281 " gcc gcc-c++ git pcre-devel make ")
282 elif self.node.use_deb:
283 return ( " autoconf libssl-dev libexpat-dev libpcap-dev "
284 " libecryptfs0 libxml2-utils automake gawk gcc g++ "
285 " git-core pkg-config libpcre3-dev make ")
290 return "http://www.ccnx.org/releases/ccnx-0.7.2.tar.gz"
294 sources = self.get("sources").split(" ")[0]
295 sources = os.path.basename(sources)
298 # Evaluate if ccnx binaries are already installed
300 " test -f ${BIN}/%(version)s/ccnd && "
301 " echo 'binaries found, nothing to do' "
303 # If not, untar and build
305 " mkdir -p ${SRC}/%(version)s && "
306 " tar xf ${SRC}/%(sources)s --strip-components=1 -C ${SRC}/%(version)s "
308 "cd ${SRC}/%(version)s && "
309 # Just execute and silence warnings...
310 " ( ./configure && make ) "
311 " )") % ({ 'sources': sources,
312 'version': self.version
318 # Evaluate if ccnx binaries are already installed
320 " test -f ${BIN}/%(version)s/ccnd && "
321 " echo 'binaries found, nothing to do' "
324 " mkdir -p ${BIN}/%(version)s && "
325 " mv ${SRC}/%(version)s/bin/* ${BIN}/%(version)s/ "
327 ) % ({ 'version': self.version
331 def _environment(self):
333 "debug": "CCND_DEBUG",
334 "port": "CCN_LOCAL_PORT",
335 "sockname" : "CCN_LOCAL_SOCKNAME",
336 "capacity" : "CCND_CAP",
338 "dataPauseMicrosec" : "CCND_DATA_PAUSE_MICROSEC",
339 "defaultTimeToStale" : "CCND_DEFAULT_TIME_TO_STALE",
340 "maxTimeToStale" : "CCND_MAX_TIME_TO_STALE",
341 "maxRteMicrosec" : "CCND_MAX_RTE_MICROSEC",
342 "keyStoreDirectory" : "CCND_KEYSTORE_DIRECTORY",
343 "listenOn" : "CCND_LISTEN_ON",
344 "autoreg" : "CCND_AUTOREG",
345 "prefix" : "CCND_PREFIX",
349 env += " ".join(map(lambda k: "%s=%s" % (envs.get(k), str(self.get(k))) \
350 if self.get(k) else "", envs.keys()))
354 def valid_connection(self, guid):