2 # -*- coding: utf-8 -*-
4 from constants import TESTBED_ID
5 from nepi.core import metadata
6 from nepi.core.attributes import Attribute
7 from nepi.util import validation
8 from nepi.util.constants import STATUS_NOT_STARTED, STATUS_RUNNING, \
12 P2PIFACE = "P2PNodeInterface"
13 TAPIFACE = "TapNodeInterface"
14 NODEIFACE = "NodeInterface"
16 APPLICATION = "Application"
18 NS3_TESTBED_ID = "ns3"
19 FDNETDEV = "ns3::FileDescriptorNetDevice"
21 ### Connection functions ####
23 def connect_switch(testbed_instance, switch_guid, interface_guid):
24 switch = testbed_instance._elements[switch_guid]
25 interface = testbed_instance._elements[interface_guid]
26 switch.connect(interface)
28 def connect_fd(testbed_instance, tap_guid, cross_data):
31 tap = testbed_instance._elements[tap_guid]
32 address = cross_data["LinuxSocketAddress"]
33 sock = socket.socket(socket.AF_UNIX, socket.SOCK_DGRAM)
35 passfd.sendfd(sock, tap.fd, '0')
36 # TODO: after succesful transfer, the tap device should close the fd
38 ### Creation functions ###
40 def create_node(testbed_instance, guid):
41 parameters = testbed_instance._get_parameters(guid)
43 if "forward_X11" in parameters:
44 forward_X11 = parameters["forward_X11"]
45 del parameters["forward_X11"]
46 element = testbed_instance.netns.Node(forward_X11 = forward_X11)
47 testbed_instance.elements[guid] = element
49 def create_p2piface(testbed_instance, guid):
50 if guid in testbed_instance.elements:
51 # The interface pair was already instantiated
53 # search for the node asociated with the p2piface
54 node1_guid = testbed_instance.get_connected(guid, "node", "devs")
55 if len(node1_guid) == 0:
56 raise RuntimeError("Can't instantiate interface %d outside netns \
58 node1 = testbed_instance.elements[node1_guid[0]]
59 # search for the pair p2piface
60 p2p_guid = testbed_instance.get_connected(guid, "p2p","p2p")
61 if len(p2p_guid) == 0:
62 raise RuntimeError("Can't instantiate p2p interface %d. \
63 Missing interface pair" % guid)
65 node2_guid = testbed_instance.get_connected(guid2, "node", "devs")
66 if len(node2_guid) == 0:
67 raise RuntimeError("Can't instantiate interface %d outside netns \
69 node2 = testbed_instance.elements[node2_guid[0]]
70 element1, element2 = testbed_instance.netns.P2PInterface.create_pair(
72 testbed_instance.elements[guid] = element1
73 testbed_instance.elements[guid2] = element2
75 def create_tapiface(testbed_instance, guid):
76 node_guid = testbed_instance.get_connected(guid, "node", "devs")
77 if len(node_guid) == 0:
78 raise RuntimeError("Can't instantiate interface %d outside netns \
80 node = testbed_instance.elements[node_guid[0]]
81 element = node.add_tap()
82 testbed_instance.elements[guid] = element
84 def create_nodeiface(testbed_instance, guid):
85 node_guid = testbed_instance.get_connected(guid, "node", "devs")
86 if len(node_guid) == 0:
87 raise RuntimeError("Can't instantiate interface %d outside netns \
89 node = testbed_instance.elements[node_guid[0]]
90 element = node.add_if()
91 testbed_instance.elements[guid] = element
93 def create_switch(testbed_instance, guid):
94 element = testbed_instance.netns.Switch()
95 testbed_instance.elements[guid] = element
97 def create_application(testbed_instance, guid):
98 testbed_instance.elements[guid] = None # Delayed construction
100 ### Start/Stop functions ###
102 def start_application(testbed_instance, guid):
103 parameters = testbed_instance._get_parameters(guid)
104 traces = testbed_instance._get_traces(guid)
105 user = parameters["user"]
106 command = parameters["command"]
107 stdout = stderr = None
108 if "stdout" in traces:
109 filename = testbed_instance.trace_filename(guid, "stdout")
110 stdout = open(filename, "wb")
111 testbed_instance.follow_trace("stdout", stdout)
112 if "stderr" in traces:
113 filename = testbed_instance.trace_filename(guid, "stderr")
114 stderr = open(filename, "wb")
115 testbed_instance.follow_trace("stderr", stderr)
117 node_guid = testbed_instance.get_connected(guid, "node", "apps")
118 if len(node_guid) == 0:
119 raise RuntimeError("Can't instantiate interface %d outside netns \
121 node = testbed_instance.elements[node_guid[0]]
122 element = node.Popen(command, shell = True, stdout = stdout,
123 stderr = stderr, user = user)
124 testbed_instance.elements[guid] = element
126 ### Status functions ###
128 def status_application(testbed_instance, guid):
129 if guid not in testbed_instance.elements.keys():
130 return STATUS_NOT_STARTED
131 app = testbed_instance.elements[guid]
132 if app.poll() == None:
133 return STATUS_RUNNING
134 return STATUS_FINISHED
136 ### Configure functions ###
138 def configure_device(testbed_instance, guid):
139 element = testbed_instance._elements[guid]
140 if not guid in testbed_instance._add_address:
142 addresses = testbed_instance._add_address[guid]
143 for address in addresses:
144 (address, netprefix, broadcast) = address
145 # TODO: Decide if we should add a ipv4 or ipv6 address
146 element.add_v4_address(address, netprefix)
148 def configure_node(testbed_instance, guid):
149 element = testbed_instance._elements[guid]
150 if not guid in testbed_instance._add_route:
152 routes = testbed_instance._add_route[guid]
154 (destination, netprefix, nexthop) = route
155 element.add_route(prefix = destination, prefix_len = netprefix,
158 ### Factory information ###
160 connector_types = dict({
162 "help": "Connector from node to applications",
168 "help": "Connector from node to network interfaces",
174 "help": "Connector to a Node",
180 "help": "Connector to a P2PInterface",
186 "help": "Connector to a network interface that can receive a file descriptor",
192 "help": "Connector to a switch",
201 "from": (TESTBED_ID, NODE, "devs"),
202 "to": (TESTBED_ID, P2PIFACE, "node"),
206 "from": (TESTBED_ID, NODE, "devs"),
207 "to": (TESTBED_ID, TAPIFACE, "node"),
211 "from": (TESTBED_ID, NODE, "devs"),
212 "to": (TESTBED_ID, NODEIFACE, "node"),
216 "from": (TESTBED_ID, P2PIFACE, "p2p"),
217 "to": (TESTBED_ID, P2PIFACE, "p2p"),
221 "from": (TESTBED_ID, TAPIFACE, "fd"),
222 "to": (NS3_TESTBED_ID, FDNETDEV, "fd"),
223 "compl_code": connect_fd,
227 "from": (TESTBED_ID, SWITCH, "devs"),
228 "to": (TESTBED_ID, NODEIFACE, "switch"),
229 "init_code": connect_switch,
233 "from": (TESTBED_ID, NODE, "apps"),
234 "to": (TESTBED_ID, APPLICATION, "node"),
240 "forward_X11": dict({
241 "name": "forward_X11",
242 "help": "Forward x11 from main namespace to the node",
243 "type": Attribute.BOOL,
245 "flags": Attribute.DesignOnly,
246 "validation_function": validation.is_bool
250 "help": "Mac address",
251 "type": Attribute.STRING,
252 "flags": Attribute.DesignOnly,
253 "validation_function": validation.is_mac_address
258 "type": Attribute.BOOL,
260 "validation_function": validation.is_bool
262 "device_name": dict({
264 "help": "Device name",
265 "type": Attribute.STRING,
266 "flags": Attribute.DesignOnly,
267 "validation_function": validation.is_string
271 "help": "Maximum transmition unit for device",
272 "type": Attribute.INTEGER,
273 "validation_function": validation.is_integer
277 "help": "Broadcast address",
278 "type": Attribute.STRING,
279 "validation_function": validation.is_string # TODO: should be is address!
283 "help": "Multicast enabled",
284 "type": Attribute.BOOL,
286 "validation_function": validation.is_bool
290 "help": "ARP enabled",
291 "type": Attribute.BOOL,
293 "validation_function": validation.is_bool
297 "help": "Command line string",
298 "type": Attribute.STRING,
299 "flags": Attribute.DesignOnly,
300 "validation_function": validation.is_string
304 "help": "System user",
305 "type": Attribute.STRING,
306 "flags": Attribute.DesignOnly,
307 "validation_function": validation.is_string
311 "help": "Standard input",
312 "type": Attribute.STRING,
313 "flags": Attribute.DesignOnly,
314 "validation_function": validation.is_string
321 "help": "Standard output stream"
325 "help": "Application standard error",
329 create_order = [ NODE, P2PIFACE, NODEIFACE, TAPIFACE, SWITCH,
332 configure_order = [ P2PIFACE, NODEIFACE, TAPIFACE, SWITCH, NODE,
335 factories_info = dict({
337 "allow_routes": True,
338 "help": "Emulated Node with virtualized network stack",
339 "category": "topology",
340 "create_function": create_node,
341 "configure_function": configure_node,
342 "box_attributes": ["forward_X11"],
343 "connector_types": ["devs", "apps"]
346 "allow_addresses": True,
347 "help": "Point to point network interface",
348 "category": "devices",
349 "create_function": create_p2piface,
350 "configure_function": configure_device,
351 "box_attributes": ["lladdr", "up", "device_name", "mtu",
352 "multicast", "broadcast", "arp"],
353 "connector_types": ["node", "p2p"]
356 "allow_addresses": True,
357 "help": "Tap device network interface",
358 "category": "devices",
359 "create_function": create_tapiface,
360 "configure_function": configure_device,
361 "box_attributes": ["lladdr", "up", "device_name", "mtu",
362 "multicast", "broadcast", "arp"],
363 "connector_types": ["node", "fd"]
366 "allow_addresses": True,
367 "help": "Node network interface",
368 "category": "devices",
369 "create_function": create_nodeiface,
370 "configure_function": configure_device,
371 "box_attributes": ["lladdr", "up", "device_name", "mtu",
372 "multicast", "broadcast", "arp"],
373 "connector_types": ["node", "switch"]
376 "display_name": "Switch",
377 "help": "Switch interface",
378 "category": "devices",
379 "create_function": create_switch,
380 "box_attributes": ["up", "device_name", "mtu", "multicast"],
381 #TODO: Add attribute ("Stp", help, type, value, range, allowed, readonly, validation_function),
382 #TODO: Add attribute ("ForwarddDelay", help, type, value, range, allowed, readonly, validation_function),
383 #TODO: Add attribute ("HelloTime", help, type, value, range, allowed, readonly, validation_function),
384 #TODO: Add attribute ("AgeingTime", help, type, value, range, allowed, readonly, validation_function),
385 #TODO: Add attribute ("MaxAge", help, type, value, range, allowed, readonly, validation_function)
386 "connector_types": ["devs"]
389 "help": "Generic executable command line application",
390 "category": "applications",
391 "create_function": create_application,
392 "start_function": start_application,
393 "status_function": status_application,
394 "box_attributes": ["command", "user"],
395 "connector_types": ["node"],
396 "traces": ["stdout", "stderr"]
400 testbed_attributes = dict({
401 "enable_debug": dict({
402 "name": "enableDebug",
403 "help": "Enable netns debug output",
404 "type": Attribute.BOOL,
406 "validation_function": validation.is_bool
410 class VersionedMetadataInfo(metadata.VersionedMetadataInfo):
412 def connector_types(self):
413 return connector_types
416 def connections(self):
420 def attributes(self):
428 def create_order(self):
432 def configure_order(self):
433 return configure_order
436 def factories_info(self):
437 return factories_info
440 def testbed_attributes(self):
441 return testbed_attributes