3 ###############################################################################
5 # NEPI, a framework to manage network experiments
7 # This program is free software: you can redistribute it and/or modify
8 # it under the terms of the GNU General Public License as published by
9 # the Free Software Foundation, either version 3 of the License, or
10 # (at your option) any later version.
12 # This program is distributed in the hope that it will be useful,
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU General Public License for more details.
17 # You should have received a copy of the GNU General Public License
18 # along with this program. If not, see <http://www.gnu.org/licenses/>.
20 # Author: Alina Quereilhac <alina.quereilhac@inria.fr>
22 ###############################################################################
24 from nepi.execution.ec import ExperimentController
25 from nepi.execution.runner import ExperimentRunner
26 from nepi.util.netgraph import NetGraph, TopologyType
27 import nepi.data.processing.ccn.parser as ccn_parser
34 0: "iraplab1.iralab.uni-karlsruhe.de",
35 1: "planetvs2.informatik.uni-stuttgart.de",
36 2: "dfn-ple1.x-win.dfn.de",
37 3: "planetlab2.extern.kuleuven.be",
38 4: "mars.planetlab.haw-hamburg.de",
39 5: "planetlab-node3.it-sudparis.eu",
40 6: "node2pl.planet-lab.telecom-lille1.eu",
41 7: "planetlab1.informatik.uni-wuerzburg.de",
42 8: "planet1.l3s.uni-hannover.de",
43 9: "planetlab1.wiwi.hu-berlin.de",
44 10: "pl2.uni-rostock.de",
45 11: "planetlab1.u-strasbg.fr",
46 12: "peeramidion.irisa.fr",
47 13: "planetlab2.unineuchatel.ch",
50 pl_slice = os.environ.get("PL_SLICE")
51 pl_user = os.environ.get("PL_USER")
52 pl_password = os.environ.get("PL_PASS")
53 pl_ssh_key = os.environ.get("PL_SSHKEY")
55 content_name = "ccnx:/test/bunny.ts"
57 pipeline = 4 # Default value for ccncat
59 operating_system = "f14"
63 repofile = os.path.join(
64 os.path.dirname(os.path.realpath(__file__)), "repoFile1.0.8.2")
66 def add_collector(ec, trace_name, subdir, newname = None):
67 collector = ec.register_resource("Collector")
68 ec.set(collector, "traceName", trace_name)
69 ec.set(collector, "subDir", subdir)
71 ec.set(collector, "rename", newname)
75 def add_pl_host(ec, nid):
76 hostname = PL_NODES[nid]
78 # Add a planetlab host to the experiment description
79 host = ec.register_resource("planetlab::Node")
80 ec.set(host, "hostname", hostname)
81 ec.set(host, "username", pl_slice)
82 ec.set(host, "identity", pl_ssh_key)
83 #ec.set(host, "pluser", pl_user)
84 #ec.set(host, "plpassword", pl_password)
85 #ec.set(host, "country", country)
86 #ec.set(host, "operatingSystem", operating_system)
87 ec.set(host, "cleanExperiment", True)
88 ec.set(host, "cleanProcesses", True)
91 ec.netgraph.annotate_node(nid, "hostname", hostname)
92 ec.netgraph.annotate_node(nid, "host", host)
94 # Annotate the graph node with an ip address
95 ip = socket.gethostbyname(hostname)
96 ec.netgraph.annotate_node_ip(nid, ip)
98 def add_pl_ccnd(ec, nid):
99 # Retrieve annotation from netgraph
100 host = ec.netgraph.node_annotation(nid, "host")
102 # Add a CCN daemon to the planetlab node
103 ccnd = ec.register_resource("linux::CCND")
104 ec.set(ccnd, "debug", 7)
105 ec.register_connection(ccnd, host)
107 # Collector to retrieve ccnd log
108 collector = add_collector(ec, "stderr", nid, "log")
109 ec.register_connection(collector, ccnd)
112 ec.netgraph.annotate_node(nid, "ccnd", ccnd)
114 def add_pl_ccnr(ec, nid):
115 # Retrieve annotation from netgraph
116 ccnd = ec.netgraph.node_annotation(nid, "ccnd")
118 # Add a CCN content repository to the planetlab node
119 ccnr = ec.register_resource("linux::CCNR")
121 ec.set(ccnr, "repoFile1", repofile)
122 ec.register_connection(ccnr, ccnd)
124 def add_pl_ccncat(ec, nid):
125 # Retrieve annotation from netgraph
126 ccnd = ec.netgraph.node_annotation(nid, "ccnd")
128 # Add a CCN cat application to the planetlab node
129 ccncat = ec.register_resource("linux::CCNCat")
130 ec.set(ccncat, "pipeline", pipeline)
131 ec.set(ccncat, "contentName", content_name)
132 ec.register_connection(ccncat, ccnd)
134 def add_pl_fib_entry(ec, nid1, nid2):
135 # Retrieve annotations from netgraph
136 ccnd1 = ec.netgraph.node_annotation(nid1, "ccnd")
137 hostname2 = ec.netgraph.node_annotation(nid2, "hostname")
139 # Add a FIB entry between one planetlab node and its peer
140 entry = ec.register_resource("linux::FIBEntry")
141 ec.set(entry, "host", hostname2)
142 ec.register_connection(entry, ccnd1)
144 # Collector to retrieve peering ping output (to measure neighbors delay)
145 ec.enable_trace(entry, "ping")
146 collector = add_collector(ec, "ping", nid1)
147 ec.register_connection(collector, entry)
151 def avg_interests(ec, run):
153 logs_dir = ec.run_dir
157 interest_expiry_count,
158 interest_dupnonce_count,
160 content_count) = ccn_parser.process_content_history_logs(
162 ec.netgraph.topology,
163 parse_ping_logs = True)
165 shortest_path = networkx.shortest_path(graph,
166 source = ec.netgraph.sources()[0],
167 target = ec.netgraph.targets()[0])
169 ### Compute metric: Avg number of Interests seen per content name
170 ### normalized by the number of nodes in the shortest path
171 content_name_count = len(content_names.values())
172 nodes_in_shortest_path = len(shortest_path) - 1
173 metric = interest_count / (float(content_name_count) * float(nodes_in_shortest_path))
175 # TODO: DUMP RESULTS TO FILE
176 # TODO: DUMP GRAPH DELAYS!
177 f = open("/tmp/metric", "a+")
178 f.write("%.2f\n" % metric)
180 print " METRIC", metric
184 def add_pl_edge(ec, nid1, nid2):
185 #### Add connections between CCN nodes
186 add_pl_fib_entry(ec, nid1, nid2)
187 add_pl_fib_entry(ec, nid2, nid1)
189 def add_pl_node(ec, nid):
190 ### Add CCN nodes (ec.netgraph holds the topology graph)
194 if nid == ec.netgraph.targets()[0]:
197 if nid == ec.netgraph.sources()[0]:
198 add_pl_ccncat(ec, nid)
200 if __name__ == '__main__':
202 #### Create NEPI Experiment Description with LINEAR topology
203 ec = ExperimentController("pl_ccn",
204 topo_type = TopologyType.LINEAR,
208 add_node_callback = add_pl_node,
209 add_edge_callback = add_pl_edge)
211 print "Results stored at", ec.exp_dir
213 #### Retrieve the content producing resource to wait for ot to finish
214 ccncat = ec.filter_resources("linux::CCNCat")
216 #### Run experiment until metric convergences
217 rnr = ExperimentRunner()
218 runs = rnr.run(ec, min_runs = 10, max_runs = 300,
219 compute_metric_callback = avg_interests,