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 clsinit_copy, ResourceState, \
23 ResourceAction, reschedule_delay
24 from nepi.resources.linux.ccn.ccnapplication import LinuxCCNApplication
25 from nepi.resources.linux.ccn.ccnd import LinuxCCND
26 from nepi.util.timefuncs import tnow
31 class LinuxCCNR(LinuxCCNApplication):
35 def _register_attributes(cls):
36 max_fanout = Attribute("maxFanout",
37 "Sets the CCNR_BTREE_MAX_FANOUT environmental variable. ",
38 flags = Flags.ExecReadOnly)
40 max_leaf_entries = Attribute("maxLeafEntries",
41 "Sets the CCNR_BTREE_MAX_LEAF_ENTRIES environmental variable. ",
42 flags = Flags.ExecReadOnly)
44 max_node_bytes = Attribute("maxNodeBytes",
45 "Sets the CCNR_BTREE_MAX_NODE_BYTES environmental variable. ",
46 flags = Flags.ExecReadOnly)
48 max_node_pool = Attribute("maxNodePool",
49 "Sets the CCNR_BTREE_MAX_NODE_POOL environmental variable. ",
50 flags = Flags.ExecReadOnly)
52 content_cache = Attribute("contentCache",
53 "Sets the CCNR_CONTENT_CACHE environmental variable. ",
54 flags = Flags.ExecReadOnly)
56 debug = Attribute("debug",
57 "Sets the CCNR_DEBUG environmental variable. "
58 "Logging level for ccnr. Defaults to WARNING.",
59 type = Types.Enumerate,
66 "FINE, FINER, FINEST"],
67 flags = Flags.ExecReadOnly)
69 directory = Attribute("directory",
70 "Sets the CCNR_DIRECTORY environmental variable. ",
71 flags = Flags.ExecReadOnly)
73 global_prefix = Attribute("globalPrefix",
74 "Sets the CCNR_GLOBAL_PREFIX environmental variable. ",
75 flags = Flags.ExecReadOnly)
77 listen_on = Attribute("listenOn",
78 "Sets the CCNR_LISTEN_ON environmental variable. ",
79 flags = Flags.ExecReadOnly)
81 min_send_bufsize = Attribute("minSendBufsize",
82 "Sets the CCNR_MIN_SEND_BUFSIZE environmental variable. ",
83 flags = Flags.ExecReadOnly)
85 proto = Attribute("proto",
86 "Sets the CCNR_PROTO environmental variable. ",
87 flags = Flags.ExecReadOnly)
89 status_port = Attribute("statusPort",
90 "Sets the CCNR_STATUS_PORT environmental variable. ",
91 flags = Flags.ExecReadOnly)
93 start_write_scope_limit = Attribute("startWriteScopeLimit",
94 "Sets the CCNR_START_WRITE_SCOPE_LIMIT environmental variable. ",
95 flags = Flags.ExecReadOnly)
97 ccns_debug = Attribute("ccnsDebug",
98 "Sets the CCNS_DEBUG environmental variable. ",
99 flags = Flags.ExecReadOnly)
101 ccns_enable = Attribute("ccnsEnable",
102 "Sets the CCNS_ENABLE environmental variable. ",
103 flags = Flags.ExecReadOnly)
105 ccns_faux_error = Attribute("ccnsFauxError",
106 "Sets the CCNS_FAUX_ERROR environmental variable. ",
107 flags = Flags.ExecReadOnly)
109 ccns_heartbeat_micros = Attribute("ccnsHeartBeatMicros",
110 "Sets the CCNS_HEART_BEAT_MICROS environmental variable. ",
111 flags = Flags.ExecReadOnly)
113 ccns_max_compares_busy = Attribute("ccnsMaxComparesBusy",
114 "Sets the CCNS_MAX_COMPARES_BUSY environmental variable. ",
115 flags = Flags.ExecReadOnly)
117 ccns_max_fetch_busy = Attribute("ccnsMaxFetchBusy",
118 "Sets the CCNS_MAX_FETCH_BUSY environmental variable. ",
119 flags = Flags.ExecReadOnly)
121 ccns_node_fetch_lifetime = Attribute("ccnsNodeFetchLifetime",
122 "Sets the CCNS_NODE_FETCH_LIFETIME environmental variable. ",
123 flags = Flags.ExecReadOnly)
125 ccns_note_err = Attribute("ccnsNoteErr",
126 "Sets the CCNS_NOTE_ERR environmental variable. ",
127 flags = Flags.ExecReadOnly)
129 ccns_repo_store = Attribute("ccnsRepoStore",
130 "Sets the CCNS_REPO_STORE environmental variable. ",
131 flags = Flags.ExecReadOnly)
133 ccns_root_advise_fresh = Attribute("ccnsRootAdviseFresh",
134 "Sets the CCNS_ROOT_ADVISE_FRESH environmental variable. ",
135 flags = Flags.ExecReadOnly)
137 ccns_root_advise_lifetime = Attribute("ccnsRootAdviseLifetime",
138 "Sets the CCNS_ROOT_ADVISE_LIFETIME environmental variable. ",
139 flags = Flags.ExecReadOnly)
141 ccns_stable_enabled = Attribute("ccnsStableEnabled",
142 "Sets the CCNS_STABLE_ENABLED environmental variable. ",
143 flags = Flags.ExecReadOnly)
145 ccns_sync_scope = Attribute("ccnsSyncScope",
146 "Sets the CCNS_SYNC_SCOPE environmental variable. ",
147 flags = Flags.ExecReadOnly)
149 cls._register_attribute(max_fanout)
150 cls._register_attribute(max_leaf_entries)
151 cls._register_attribute(max_node_bytes)
152 cls._register_attribute(max_node_pool)
153 cls._register_attribute(content_cache)
154 cls._register_attribute(debug)
155 cls._register_attribute(directory)
156 cls._register_attribute(global_prefix)
157 cls._register_attribute(listen_on)
158 cls._register_attribute(min_send_bufsize)
159 cls._register_attribute(proto)
160 cls._register_attribute(status_port)
161 cls._register_attribute(start_write_scope_limit)
162 cls._register_attribute(ccns_debug)
163 cls._register_attribute(ccns_enable)
164 cls._register_attribute(ccns_faux_error)
165 cls._register_attribute(ccns_heartbeat_micros)
166 cls._register_attribute(ccns_max_compares_busy)
167 cls._register_attribute(ccns_max_fetch_busy)
168 cls._register_attribute(ccns_node_fetch_lifetime)
169 cls._register_attribute(ccns_note_err)
170 cls._register_attribute(ccns_repo_store)
171 cls._register_attribute(ccns_root_advise_fresh)
172 cls._register_attribute(ccns_root_advise_lifetime)
173 cls._register_attribute(ccns_stable_enabled)
174 cls._register_attribute(ccns_sync_scope)
177 def _register_traces(cls):
178 log = Trace("log", "CCND log output")
180 cls._register_trace(log)
182 def __init__(self, ec, guid):
183 super(LinuxCCNR, self).__init__(ec, guid)
184 self._home = "ccnr-%s" % self.guid
187 if not self.ccnd or self.ccnd.state < ResourceState.READY:
188 self.debug("---- RESCHEDULING DEPLOY ---- CCND state %s " % self.ccnd.state )
190 # ccnr needs to wait until ccnd is deployed and running
191 self.ec.schedule(reschedule_delay, self.deploy)
193 command = self._start_command
194 env = self._environment
196 self.set("command", command)
199 self.info("Deploying command '%s' " % command)
201 self.node.mkdir(self.app_home)
204 self.upload_sources()
206 # We want to make sure the repository is running
207 # before the experiment starts.
208 # Run the command as a bash script in background,
209 # in the host ( but wait until the command has
210 # finished to continue )
211 env = self.replace_paths(env)
212 command = self.replace_paths(command)
214 self.node.run_and_wait(command, self.app_home,
217 raise_on_error = True)
219 self.debug("----- READY ---- ")
220 self._ready_time = tnow()
221 self._state = ResourceState.READY
224 if self._state == ResourceState.READY:
225 command = self.get("command")
226 self.info("Starting command '%s'" % command)
228 self._start_time = tnow()
229 self._state = ResourceState.STARTED
231 msg = " Failed to execute command '%s'" % command
232 self.error(msg, out, err)
233 self._state = ResourceState.FAILED
234 raise RuntimeError, msg
237 def _start_command(self):
241 def _environment(self):
243 "maxFanout": "CCNR_BTREE_MAX_FANOUT",
244 "maxLeafEntries": "CCNR_BTREE_MAX_LEAF_ENTRIES",
245 "maxNodeBytes": "CCNR_BTREE_MAX_NODE_BYTES",
246 "maxNodePool": "CCNR_BTREE_MAX_NODE_POOL",
247 "contentCache": "CCNR_CONTENT_CACHE",
248 "debug": "CCNR_DEBUG",
249 "directory": "CCNR_DIRECTORY",
250 "globalPrefix": "CCNR_GLOBAL_PREFIX",
251 "listenOn": "CCNR_LISTEN_ON",
252 "minSendBufsize": "CCNR_MIN_SEND_BUFSIZE",
253 "proto": "CCNR_PROTO",
254 "statusPort": "CCNR_STATUS_PORT",
255 "startWriteScopeLimit": "CCNR_START_WRITE_SCOPE_LIMIT",
256 "ccnsDebug": "CCNS_DEBUG",
257 "ccnsEnable": "CCNS_ENABLE",
258 "ccnsFauxError": "CCNS_FAUX_ERROR",
259 "ccnsHeartBeatMicros": "CCNS_HEART_BEAT_MICROS",
260 "ccnsMaxComparesBusy": "CCNS_MAX_COMPARES_BUSY",
261 "ccnsMaxFetchBusy": "CCNS_MAX_FETCH_BUSY",
262 "ccnsNodeFetchLifetime": "CCNS_NODE_FETCH_LIFETIME",
263 "ccnsNoteErr": "CCNS_NOTE_ERR",
264 "ccnsRepoStore": "CCNS_REPO_STORE",
265 "ccnsRootAdviseFresh": "CCNS_ROOT_ADVISE_FRESH",
266 "ccnsRootAdviseLifetime": "CCNS_ROOT_ADVISE_LIFETIME",
267 "ccnsStableEnabled": "CCNS_STABLE_ENABLED",
268 "ccnsSyncScope": "CCNS_SYNC_SCOPE",
271 env = "PATH=$PATH:${STORE}/ccnx/bin "
272 env += " ".join(map(lambda k: "%s=%s" % (envs.get(k), self.get(k)) \
273 if self.get(k) else "", envs.keys()))
277 def valid_connection(self, guid):