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, ResourceState
23 from nepi.resources.linux.application import LinuxApplication
24 from nepi.resources.linux.node import OSType
26 from nepi.util.sshfuncs import ProcStatus
27 from nepi.util.timefuncs import strfnow, strfdiff
31 class LinuxCCND(LinuxApplication):
35 def _register_attributes(cls):
36 debug = Attribute("debug", "Sets the CCND_DEBUG environmental variable. "
37 " Allowed values are : \n"
39 " 1 - basic messages (any non-zero value gets these) \n"
40 " 2 - interest messages \n"
41 " 4 - content messages \n"
42 " 8 - matching details \n"
43 " 16 - interest details \n"
44 " 32 - gory interest details \n"
45 " 64 - log occasional human-readable timestamps \n"
46 " 128 - face registration debugging \n"
47 " -1 - max logging \n"
48 " Or apply bitwise OR to these values to get combinations of them",
49 flags = Flags.ExecReadOnly)
51 port = Attribute("port", "Sets the CCN_LOCAL_PORT environmental variable. "
53 flags = Flags.ExecReadOnly)
55 sockname = Attribute("sockname",
56 "Sets the CCN_LOCAL_SCOKNAME environmental variable. "
57 "Defaults to /tmp/.ccnd.sock",
58 flags = Flags.ExecReadOnly)
60 capacity = Attribute("capacity",
61 "Sets the CCND_CAP environmental variable. "
62 "Capacity limit in terms of ContentObjects",
63 flags = Flags.ExecReadOnly)
65 mtu = Attribute("mtu", "Sets the CCND_MTU environmental variable. ",
66 flags = Flags.ExecReadOnly)
68 data_pause = Attribute("dataPauseMicrosec",
69 "Sets the CCND_DATA_PAUSE_MICROSEC environmental variable. ",
70 flags = Flags.ExecReadOnly)
72 default_stale = Attribute("defaultTimeToStale",
73 "Sets the CCND_DEFAULT_TIME_TO_STALE environmental variable. ",
74 flags = Flags.ExecReadOnly)
76 max_stale = Attribute("maxTimeToStale",
77 "Sets the CCND_MAX_TIME_TO_STALE environmental variable. ",
78 flags = Flags.ExecReadOnly)
80 max_rte = Attribute("maxRteMicrosec",
81 "Sets the CCND_MAX_RTE_MICROSEC environmental variable. ",
82 flags = Flags.ExecReadOnly)
84 keystore = Attribute("keyStoreDirectory",
85 "Sets the CCND_KEYSTORE_DIRECTORY environmental variable. ",
86 flags = Flags.ExecReadOnly)
88 listen_on = Attribute("listenOn",
89 "Sets the CCND_LISTEN_ON environmental variable. ",
90 flags = Flags.ExecReadOnly)
92 autoreg = Attribute("autoreg",
93 "Sets the CCND_AUTOREG environmental variable. ",
94 flags = Flags.ExecReadOnly)
96 prefix = Attribute("prefix",
97 "Sets the CCND_PREFIX environmental variable. ",
98 flags = Flags.ExecReadOnly)
100 cls._register_attribute(debug)
101 cls._register_attribute(port)
102 cls._register_attribute(sockname)
103 cls._register_attribute(capacity)
104 cls._register_attribute(mtu)
105 cls._register_attribute(data_pause)
106 cls._register_attribute(default_stale)
107 cls._register_attribute(max_stale)
108 cls._register_attribute(max_rte)
109 cls._register_attribute(keystore)
110 cls._register_attribute(listen_on)
111 cls._register_attribute(autoreg)
112 cls._register_attribute(prefix)
115 def _register_traces(cls):
116 log = Trace("log", "CCND log output")
117 status = Trace("status", "ccndstatus output")
119 cls._register_trace(log)
120 cls._register_trace(status)
122 def __init__(self, ec, guid):
123 super(LinuxCCND, self).__init__(ec, guid)
124 # Marks whether daemon is running
125 self._running = False
128 if not self.get("command"):
129 self.set("command", self._default_command)
131 if not self.get("depends"):
132 self.set("depends", self._default_dependencies)
134 if not self.get("sources"):
135 self.set("sources", self._default_sources)
137 if not self.get("build"):
138 self.set("build", self._default_build)
140 if not self.get("install"):
141 self.set("install", self._default_install)
143 if not self.get("env"):
144 self.set("env", self._default_environment)
146 super(LinuxCCND, self).deploy()
148 # As soon as the ccnd sources are deployed, we launch the
149 # daemon ( we don't want to lose time launching the ccn
151 if self._state == ResourceState.READY:
152 self._start_in_background()
156 # CCND should already be started by now.
157 # Nothing to do but to set the state to STARTED
159 self._start_time = strfnow()
160 self._state = ResourceState.STARTED
162 msg = " Failed to execute command '%s'" % command
163 self.error(msg, out, err)
164 self._state = ResourceState.FAILED
165 raise RuntimeError, msg
168 command = self.get('command') or ''
171 if state == ResourceState.STARTED:
172 self.info("Stopping command '%s'" % command)
175 env = self.get("env")
177 # replace application specific paths in the command
178 command = self.replace_paths(command)
179 env = env and self.replace_paths(env)
181 # Upload the command to a file, and execute asynchronously
182 self.node.run_and_wait(command, self.app_home,
183 shfile = "ccndstop.sh",
185 pidfile = "ccndstop_pidfile",
186 ecodefile = "ccndstop_exitcode",
187 stdout = "ccndstop_stdout",
188 stderr = "ccndstop_stderr")
191 super(LinuxCCND, self).stop()
195 # First check if the ccnd has failed
196 if self._running and strfdiff(strfnow(), self._last_state_check) > state_check_delay:
197 state_check_delay = 0.5
198 (out, err), proc = self._cndstatus()
200 retcode = proc.poll()
202 if retcode == 1 and err.find("No such file or directory") > -1:
203 # ccnd is not running (socket not found)
204 self._running = False
205 self._state = ResourceState.FINISHED
208 self._running = False
209 msg = " Failed to execute command '%s'" % command
210 self.error(msg, out, err)
211 self._state = ResourceState.FAILED
213 self._last_state_check = strfnow()
215 if self._state == ResourceState.READY:
216 # CCND is really deployed only when ccn daemon is running
217 if not self._running:
218 return ResourceState.PROVISIONED
223 def _ccndstatus(self):
224 env = self.get('env') or ""
225 environ = self.node.format_environment(env, inline = True)
226 command = environ + "; ccndstatus"
227 command = self.replace_paths(command)
229 return self.node.execute(command)
232 def _default_command(self):
236 def _default_dependencies(self):
237 if self.node.os in [ OSType.FEDORA_12 , OSType.FEDORA_14 ]:
238 return ( " autoconf openssl-devel expat-devel libpcap-devel "
239 " ecryptfs-utils-devel libxml2-devel automake gawk "
240 " gcc gcc-c++ git pcre-devel make ")
241 elif self.node.os in [ OSType.UBUNTU , OSType.DEBIAN]:
242 return ( " autoconf libssl-dev libexpat-dev libpcap-dev "
243 " libecryptfs0 libxml2-utils automake gawk gcc g++ "
244 " git-core pkg-config libpcre3-dev make ")
248 def _default_sources(self):
249 return "http://www.ccnx.org/releases/ccnx-0.7.1.tar.gz"
252 def _default_build(self):
253 sources = self.get("sources").split(" ")[0]
254 sources = os.path.basename(sources)
257 # Evaluate if ccnx binaries are already installed
259 " test -f ${EXP_HOME}/ccnx/bin/ccnd && "
260 " echo 'sources found, nothing to do' "
262 # If not, untar and build
264 " mkdir -p ${SOURCES}/ccnx && "
265 " tar xf ${SOURCES}/%(sources)s --strip-components=1 -C ${SOURCES}/ccnx "
267 "cd ${SOURCES}/ccnx && "
268 # Just execute and silence warnings...
269 " ( ./configure && make ) "
270 " )") % ({ 'sources': sources })
273 def _default_install(self):
275 # Evaluate if ccnx binaries are already installed
277 " test -f ${EXP_HOME}/ccnx/bin/ccnd && "
278 " echo 'sources found, nothing to do' "
281 " mkdir -p ${EXP_HOME}/ccnx/bin && "
282 " cp -r ${SOURCES}/ccnx ${EXP_HOME}"
287 def _default_environment(self):
289 "debug": "CCND_DEBUG",
290 "port": "CCN_LOCAL_PORT",
291 "sockname" : "CCN_LOCAL_SOCKNAME",
292 "capacity" : "CCND_CAP",
294 "dataPauseMicrosec" : "CCND_DATA_PAUSE_MICROSEC",
295 "defaultTimeToStale" : "CCND_DEFAULT_TIME_TO_STALE",
296 "maxTimeToStale" : "CCND_MAX_TIME_TO_STALE",
297 "maxRteMicrosec" : "CCND_MAX_RTE_MICROSEC",
298 "keyStoreDirectory" : "CCND_KEYSTORE_DIRECTORY",
299 "listenOn" : "CCND_LISTEN_ON",
300 "autoreg" : "CCND_AUTOREG",
301 "prefix" : "CCND_PREFIX",
304 env = "PATH=$PATH:${EXP_HOME}/ccnx/bin "
305 env += " ".join(map(lambda k: "%s=%s" % (envs.get(k), self.get(k)) \
306 if self.get(k) else "", envs.keys()))
310 def valid_connection(self, guid):