# -*- coding: utf-8 -*-
from nepi.core.attributes import Attribute, AttributesMap
+from nepi.core.connector import ConnectorTypeBase
from nepi.util import proxy, validation
-from nepi.util.constants import STATUS_FINISHED
+from nepi.util.constants import STATUS_FINISHED, TIME_NOW
from nepi.util.parser._xml import XmlExperimentParser
import sys
import re
+import threading
+import ConfigParser
+import os
ATTRIBUTE_PATTERN_BASE = re.compile(r"\{#\[(?P<label>[-a-zA-Z0-9._]*)\](?P<expr>(?P<component>\.addr\[[0-9]+\]|\.route\[[0-9]+\]|\.trace\[[0-9]+\]|).\[(?P<attribute>[-a-zA-Z0-9._]*)\])#}")
ATTRIBUTE_PATTERN_GUID_SUB = r"{#[%(guid)s]%(expr)s#}"
+COMPONENT_PATTERN = re.compile(r"(?P<kind>[a-z]*)\[(?P<index>.*)\]")
-class ConnectorType(object):
+class ConnectorType(ConnectorTypeBase):
def __init__(self, testbed_id, factory_id, name, max = -1, min = 0):
- super(ConnectorType, self).__init__()
- if max == -1:
- max = sys.maxint
- elif max <= 0:
- raise RuntimeError(
- "The maximum number of connections allowed need to be more than 0")
- if min < 0:
- raise RuntimeError(
- "The minimum number of connections allowed needs to be at least 0")
- # connector_type_id -- univoquely identifies a connector type
- # across testbeds
- self._connector_type_id = (testbed_id.lower(), factory_id.lower(),
- name.lower())
- # name -- display name for the connector type
- self._name = name
- # max -- maximum amount of connections that this type support,
- # -1 for no limit
- self._max = max
- # min -- minimum amount of connections required by this type of connector
- self._min = min
+ super(ConnectorType, self).__init__(testbed_id, factory_id, name, max, min)
# from_connections -- connections where the other connector is the "From"
# to_connections -- connections where the other connector is the "To"
# keys in the dictionary correspond to the
self._from_connections = dict()
self._to_connections = dict()
- @property
- def connector_type_id(self):
- return self._connector_type_id
-
- @property
- def name(self):
- return self._name
-
- @property
- def max(self):
- return self._max
-
- @property
- def min(self):
- return self._min
+ def add_from_connection(self, testbed_id, factory_id, name, can_cross,
+ init_code, compl_code):
+ type_id = self.make_connector_type_id(testbed_id, factory_id, name)
+ self._from_connections[type_id] = (can_cross, init_code, compl_code)
- def add_from_connection(self, testbed_id, factory_id, name, can_cross, code):
- self._from_connections[(testbed_id.lower(), factory_id.lower(),
- name.lower())] = (can_cross, code)
-
- def add_to_connection(self, testbed_id, factory_id, name, can_cross, code):
- self._to_connections[(testbed_id.lower(), factory_id.lower(),
- name.lower())] = (can_cross, code)
+ def add_to_connection(self, testbed_id, factory_id, name, can_cross,
+ init_code, compl_code):
+ type_id = self.make_connector_type_id(testbed_id, factory_id, name)
+ self._to_connections[type_id] = (can_cross, init_code, compl_code)
def can_connect(self, testbed_id, factory_id, name, count,
must_cross = False):
- connector_type_id = (testbed_id.lower(), factory_id.lower(),
- name.lower())
- if connector_type_id in self._from_connections:
- (can_cross, code) = self._from_connections[connector_type_id]
- elif connector_type_id in self._to_connections:
- (can_cross, code) = self._to_connections[connector_type_id]
+ connector_type_id = self.make_connector_type_id(testbed_id, factory_id, name)
+ for lookup_type_id in self._type_resolution_order(connector_type_id):
+ if lookup_type_id in self._from_connections:
+ (can_cross, init_code, compl_code) = self._from_connections[lookup_type_id]
+ elif lookup_type_id in self._to_connections:
+ (can_cross, init_code, compl_code) = self._to_connections[lookup_type_id]
+ else:
+ # keey trying
+ continue
+ return not must_cross or can_cross
else:
return False
- return not must_cross or can_cross
- def code_to_connect(self, testbed_id, factory_id, name):
- connector_type_id = (testbed_id.lower(), factory_id.lower(),
- name.lower())
- if not connector_type_id in self._to_connections.keys():
- return False
- (can_cross, code) = self._to_connections[connector_type_id]
- return code
+ def _connect_to_code(self, testbed_id, factory_id, name):
+ connector_type_id = self.make_connector_type_id(testbed_id, factory_id, name)
+ for lookup_type_id in self._type_resolution_order(connector_type_id):
+ if lookup_type_id in self._to_connections:
+ (can_cross, init_code, compl_code) = self._to_connections[lookup_type_id]
+ return (init_code, compl_code)
+ else:
+ return (False, False)
+
+ def connect_to_init_code(self, testbed_id, factory_id, name):
+ return self._connect_to_code(testbed_id, factory_id, name)[0]
+
+ def connect_to_compl_code(self, testbed_id, factory_id, name):
+ return self._connect_to_code(testbed_id, factory_id, name)[1]
-# TODO: create_function, start_function, stop_function, status_function
-# need a definition!
class Factory(AttributesMap):
def __init__(self, factory_id, create_function, start_function,
- stop_function, status_function, configure_function,
- allow_addresses = False, allow_routes = False):
+ stop_function, status_function,
+ configure_function, preconfigure_function,
+ allow_addresses = False, has_addresses = False,
+ allow_routes = False, has_routes = False):
super(Factory, self).__init__()
self._factory_id = factory_id
- self._allow_addresses = (allow_addresses == True)
- self._allow_routes = (allow_routes == True)
+ self._allow_addresses = bool(allow_addresses)
+ self._allow_routes = bool(allow_routes)
+ self._has_addresses = bool(has_addresses) or self._allow_addresses
+ self._has_routes = bool(has_routes) or self._allow_routes
self._create_function = create_function
self._start_function = start_function
self._stop_function = stop_function
self._status_function = status_function
self._configure_function = configure_function
+ self._preconfigure_function = preconfigure_function
self._connector_types = dict()
self._traces = list()
self._box_attributes = AttributesMap()
def allow_routes(self):
return self._allow_routes
+ @property
+ def has_addresses(self):
+ return self._has_addresses
+
+ @property
+ def has_routes(self):
+ return self._has_routes
+
@property
def box_attributes(self):
return self._box_attributes
def configure_function(self):
return self._configure_function
+ @property
+ def preconfigure_function(self):
+ return self._preconfigure_function
+
@property
def traces(self):
return self._traces
self._box_attributes.add_attribute(name, help, type, value, range,
allowed, flags, validation_function)
-class TestbedInstance(object):
+class TestbedController(object):
def __init__(self, testbed_id, testbed_version):
self._testbed_id = testbed_id
self._testbed_version = testbed_version
+ @property
+ def testbed_id(self):
+ return self._testbed_id
+
+ @property
+ def testbed_version(self):
+ return self._testbed_version
+
@property
def guids(self):
raise NotImplementedError
"""
raise NotImplementedError
- def do_connect(self):
+ def do_connect_init(self):
+ """
+ After do_connect_init all internal connections between testbed elements
+ are initiated
+ """
+ raise NotImplementedError
+
+ def do_connect_compl(self):
"""
After do_connect all internal connections between testbed elements
- are done
+ are completed
"""
raise NotImplementedError
"""After do_configure elements are configured"""
raise NotImplementedError
- def do_cross_connect(self):
+ def do_cross_connect_init(self, cross_data):
+ """
+ After do_cross_connect_init initiation of all external connections
+ between different testbed elements is performed
+ """
+ raise NotImplementedError
+
+ def do_cross_connect_compl(self, cross_data):
"""
- After do_cross_connect all external connections between different testbed
- elements are done
+ After do_cross_connect_compl completion of all external connections
+ between different testbed elements is performed
"""
raise NotImplementedError
def stop(self):
raise NotImplementedError
- def set(self, time, guid, name, value):
+ def set(self, guid, name, value, time = TIME_NOW):
+ raise NotImplementedError
+
+ def get(self, guid, name, time = TIME_NOW):
+ raise NotImplementedError
+
+ def get_route(self, guid, index, attribute):
+ """
+ Params:
+
+ guid: guid of box to query
+ index: number of routing entry to fetch
+ attribute: one of Destination, NextHop, NetPrefix
+ """
+ raise NotImplementedError
+
+ def get_address(self, guid, index, attribute='Address'):
+ """
+ Params:
+
+ guid: guid of box to query
+ index: number of inteface to select
+ attribute: one of Address, NetPrefix, Broadcast
+ """
raise NotImplementedError
- def get(self, time, guid, name):
+ def get_attribute_list(self, guid):
raise NotImplementedError
def action(self, time, guid, action):
def status(self, guid):
raise NotImplementedError
- def trace(self, guid, trace_id):
+ def trace(self, guid, trace_id, attribute='value'):
raise NotImplementedError
def shutdown(self):
raise NotImplementedError
class ExperimentController(object):
- def __init__(self, experiment_xml):
+ def __init__(self, experiment_xml, root_dir):
self._experiment_xml = experiment_xml
self._testbeds = dict()
self._access_config = dict()
- self._label_guids = dict()
+ self._netrefs = dict()
+ self._cross_data = dict()
+ self._root_dir = root_dir
+
+ self.persist_experiment_xml()
@property
def experiment_xml(self):
return self._experiment_xml
+ def persist_experiment_xml(self):
+ xml_path = os.path.join(self._root_dir, "experiment.xml")
+ f = open(xml_path, "w")
+ f.write(self._experiment_xml)
+ f.close()
+
def set_access_configuration(self, testbed_guid, access_config):
self._access_config[testbed_guid] = access_config
- def trace(self, testbed_guid, guid, trace_id):
- return self._testbeds[testbed_guid].trace(guid, trace_id)
+ def trace(self, testbed_guid, guid, trace_id, attribute='value'):
+ return self._testbeds[testbed_guid].trace(guid, trace_id, attribute)
+
+ @staticmethod
+ def _parallel(callables):
+ threads = [ threading.Thread(target=callable) for callable in callables ]
+ for thread in threads:
+ thread.start()
+ for thread in threads:
+ thread.join()
def start(self):
- self._create_testbed_instances()
- for testbed in self._testbeds.values():
- testbed.do_setup()
- for testbed in self._testbeds.values():
- testbed.do_create()
- testbed.do_connect()
- testbed.do_configure()
- for testbed in self._testbeds.values():
- testbed.do_cross_connect()
- for testbed in self._testbeds.values():
- testbed.start()
+ self._init_testbed_controllers()
+
+ # persist testbed connection data, for potential recovery
+ self._persist_testbed_proxies()
+
+ # perform setup in parallel for all test beds,
+ # wait for all threads to finish
+ self._parallel([testbed.do_setup
+ for testbed in self._testbeds.itervalues()])
+
+ # perform create-connect in parallel, wait
+ # (internal connections only)
+ self._parallel([testbed.do_create
+ for testbed in self._testbeds.itervalues()])
+
+ self._parallel([testbed.do_connect_init
+ for testbed in self._testbeds.itervalues()])
+
+ self._parallel([testbed.do_connect_compl
+ for testbed in self._testbeds.itervalues()])
+
+ self._parallel([testbed.do_preconfigure
+ for testbed in self._testbeds.itervalues()])
+
+ # resolve netrefs
+ self.do_netrefs(fail_if_undefined=True)
+
+ # perform do_configure in parallel for al testbeds
+ # (it's internal configuration for each)
+ self._parallel([testbed.do_configure
+ for testbed in self._testbeds.itervalues()])
+
+ # cross-connect (cannot be done in parallel)
+ for guid, testbed in self._testbeds.iteritems():
+ cross_data = self._get_cross_data(guid)
+ testbed.do_cross_connect_init(cross_data)
+ for guid, testbed in self._testbeds.iteritems():
+ cross_data = self._get_cross_data(guid)
+ testbed.do_cross_connect_compl(cross_data)
+
+ # start experiment (parallel start on all testbeds)
+ self._parallel([testbed.start
+ for testbed in self._testbeds.itervalues()])
+
+ def _persist_testbed_proxies(self):
+ TRANSIENT = ('Recover',)
+
+ # persist access configuration for all testbeds, so that
+ # recovery mode can reconnect to them if it becomes necessary
+ conf = ConfigParser.RawConfigParser()
+ for testbed_guid, testbed_config in self._access_config.iteritems():
+ testbed_guid = str(testbed_guid)
+ conf.add_section(testbed_guid)
+ for attr in testbed_config.attributes_list:
+ if attr not in TRANSIENT:
+ conf.set(testbed_guid, attr,
+ testbed_config.get_attribute_value(attr))
+
+ f = open(os.path.join(self._root_dir, 'access_config.ini'), 'w')
+ conf.write(f)
+ f.close()
+
+ def _load_testbed_proxies(self):
+ TYPEMAP = {
+ STRING : 'get',
+ INTEGER : 'getint',
+ FLOAT : 'getfloat',
+ BOOLEAN : 'getboolean',
+ }
+
+ conf = ConfigParser.RawConfigParser()
+ conf.read(os.path.join(self._root_dir, 'access_config.ini'))
+ for testbed_guid in conf.sections():
+ testbed_config = proxy.AccessConfiguration()
+ for attr in conf.options(testbed_guid):
+ testbed_config.set_attribute_value(attr,
+ conf.get(testbed_guid, attr) )
+
+ testbed_guid = str(testbed_guid)
+ conf.add_section(testbed_guid)
+ for attr in testbed_config.attributes_list:
+ if attr not in TRANSIENT:
+ getter = getattr(conf, TYPEMAP.get(
+ testbed_config.get_attribute_type(attr),
+ 'get') )
+ testbed_config.set_attribute_value(
+ testbed_guid, attr, getter(attr))
+
+ def _unpersist_testbed_proxies(self):
+ try:
+ os.remove(os.path.join(self._root_dir, 'access_config.ini'))
+ except:
+ # Just print exceptions, this is just cleanup
+ import traceback
+ traceback.print_exc(file=sys.stderr)
def stop(self):
for testbed in self._testbeds.values():
testbed.stop()
+ self._unpersist_testbed_proxies()
+
+ def recover(self):
+ # reload perviously persisted testbed access configurations
+ self._load_testbed_proxies()
+
+ # recreate testbed proxies by reconnecting only
+ self._init_testbed_controllers(recover = True)
def is_finished(self, guid):
for testbed in self._testbeds.values():
return testbed.status(guid) == STATUS_FINISHED
raise RuntimeError("No element exists with guid %d" % guid)
+ def set(self, testbed_guid, guid, name, value, time = TIME_NOW):
+ testbed = self._testbeds[testbed_guid]
+ testbed.set(guid, name, value, time)
+
+ def get(self, testbed_guid, guid, name, time = TIME_NOW):
+ testbed = self._testbeds[testbed_guid]
+ return testbed.get(guid, name, time)
+
def shutdown(self):
for testbed in self._testbeds.values():
testbed.shutdown()
- def _create_testbed_instances(self):
+ @staticmethod
+ def _netref_component_split(component):
+ match = COMPONENT_PATTERN.match(component)
+ if match:
+ return match.group("kind"), match.group("index")
+ else:
+ return component, None
+
+ def do_netrefs(self, fail_if_undefined = False):
+ COMPONENT_GETTERS = {
+ 'addr':
+ lambda testbed, guid, index, name:
+ testbed.get_address(guid, index, name),
+ 'route' :
+ lambda testbed, guid, index, name:
+ testbed.get_route(guid, index, name),
+ 'trace' :
+ lambda testbed, guid, index, name:
+ testbed.trace(guid, index, name),
+ '' :
+ lambda testbed, guid, index, name:
+ testbed.get(guid, name),
+ }
+
+ for (testbed_guid, guid), attrs in self._netrefs.iteritems():
+ testbed = self._testbeds[testbed_guid]
+ for name in attrs:
+ value = testbed.get(guid, name)
+ if isinstance(value, basestring):
+ match = ATTRIBUTE_PATTERN_BASE.search(value)
+ if match:
+ label = match.group("label")
+ if label.startswith('GUID-'):
+ ref_guid = int(label[5:])
+ if ref_guid:
+ expr = match.group("expr")
+ component = match.group("component")[1:] # skip the dot
+ attribute = match.group("attribute")
+
+ # split compound components into component kind and index
+ # eg: 'addr[0]' -> ('addr', '0')
+ component, component_index = self._netref_component_split(component)
+
+ # find object and resolve expression
+ for ref_testbed in self._testbeds.itervalues():
+ if component not in COMPONENT_GETTERS:
+ raise ValueError, "Malformed netref: %r - unknown component" % (expr,)
+ else:
+ ref_value = COMPONENT_GETTERS[component](
+ ref_testbed, ref_guid, component_index, attribute)
+ if ref_value:
+ testbed.set(guid, name,
+ value.replace(match.group(), ref_value))
+ break
+ else:
+ # couldn't find value
+ if fail_if_undefined:
+ raise ValueError, "Unresolvable GUID: %r, in netref: %r" % (ref_guid, expr)
+
+ def _init_testbed_controllers(self, recover = False):
parser = XmlExperimentParser()
data = parser.from_xml_to_data(self._experiment_xml)
element_guids = list()
label_guids = dict()
data_guids = data.guids
+
+ # create testbed controllers
for guid in data_guids:
if data.is_testbed_data(guid):
- (testbed_id, testbed_version) = data.get_testbed_data(guid)
- access_config = None if guid not in self._access_config else\
- self._access_config[guid]
- testbed = proxy.create_testbed_instance(testbed_id,
- testbed_version, access_config)
- for (name, value) in data.get_attribute_data(guid):
- testbed.defer_configure(name, value)
- self._testbeds[guid] = testbed
+ self._create_testbed_controller(guid, data, element_guids,
+ recover)
else:
element_guids.append(guid)
label = data.get_attribute_data(guid, "label")
if label in label_guids:
raise RuntimeError, "Label %r is not unique" % (label,)
label_guids[label] = guid
+
+ # replace references to elements labels for its guid
+ self._resolve_labels(data, data_guids, label_guids)
+
+ # program testbed controllers
+ if not recover:
+ self._program_testbed_controllers(element_guids, data)
+
+ def _resolve_labels(self, data, data_guids, label_guids):
+ netrefs = self._netrefs
for guid in data_guids:
if not data.is_testbed_data(guid):
for name, value in data.get_attribute_data(guid):
match = ATTRIBUTE_PATTERN_BASE.search(value)
if match:
label = match.group("label")
- ref_guid = label_guids.get(label)
- if ref_guid is not None:
- print "@", guid, ",", ref_guid, "=", label, ": ", value, "->",
- value = ATTRIBUTE_PATTERN_BASE.sub(
- ATTRIBUTE_PATTERN_GUID_SUB % dict(
- guid=ref_guid,
- expr=match.group("expr"),
- label=label),
- value)
- print value
- data.set_attribute_data(guid, name, value)
- self._label_guids = label_guids
- self._program_testbed_instances(element_guids, data)
-
- def _program_testbed_instances(self, element_guids, data):
+ if not label.startswith('GUID-'):
+ ref_guid = label_guids.get(label)
+ if ref_guid is not None:
+ value = ATTRIBUTE_PATTERN_BASE.sub(
+ ATTRIBUTE_PATTERN_GUID_SUB % dict(
+ guid = 'GUID-%d' % (ref_guid,),
+ expr = match.group("expr"),
+ label = label),
+ value)
+ data.set_attribute_data(guid, name, value)
+
+ # memorize which guid-attribute pairs require
+ # postprocessing, to avoid excessive controller-testbed
+ # communication at configuration time
+ # (which could require high-latency network I/O)
+ (testbed_guid, factory_id) = data.get_box_data(guid)
+ netrefs.setdefault((testbed_guid, guid), set()).add(name)
+
+ def _create_testbed_controller(self, guid, data, element_guids, recover):
+ (testbed_id, testbed_version) = data.get_testbed_data(guid)
+ access_config = None if guid not in self._access_config else\
+ self._access_config[guid]
+
+ if recover and access_config is None:
+ # need to create one
+ access_config = self._access_config[guid] = proxy.AccessConfiguration()
+ if access_config is not None:
+ # force recovery mode
+ access_config.set_attribute_value("recover",recover)
+
+ testbed = proxy.create_testbed_controller(testbed_id,
+ testbed_version, access_config)
+ for (name, value) in data.get_attribute_data(guid):
+ testbed.defer_configure(name, value)
+ self._testbeds[guid] = testbed
+
+ def _program_testbed_controllers(self, element_guids, data):
for guid in element_guids:
(testbed_guid, factory_id) = data.get_box_data(guid)
testbed = self._testbeds[testbed_guid]
for guid in element_guids:
(testbed_guid, factory_id) = data.get_box_data(guid)
testbed = self._testbeds[testbed_guid]
- for (connector_type_name, other_guid, other_connector_type_name) \
+ for (connector_type_name, cross_guid, cross_connector_type_name) \
in data.get_connection_data(guid):
(testbed_guid, factory_id) = data.get_box_data(guid)
- (other_testbed_guid, other_factory_id) = data.get_box_data(
- other_guid)
- if testbed_guid == other_testbed_guid:
- testbed.defer_connect(guid, connector_type_name, other_guid,
- other_connector_type_name)
- else:
- testbed.defer_cross_connect(guid, connector_type_name, other_guid,
- other_testbed_id, other_factory_id, other_connector_type_name)
+ (cross_testbed_guid, cross_factory_id) = data.get_box_data(
+ cross_guid)
+ if testbed_guid == cross_testbed_guid:
+ testbed.defer_connect(guid, connector_type_name,
+ cross_guid, cross_connector_type_name)
+ else:
+ cross_testbed = self._testbeds[cross_testbed_guid]
+ cross_testbed_id = cross_testbed.testbed_id
+ testbed.defer_cross_connect(guid, connector_type_name, cross_guid,
+ cross_testbed_guid, cross_testbed_id, cross_factory_id,
+ cross_connector_type_name)
+ # save cross data for later
+ self._add_crossdata(testbed_guid, guid, cross_testbed_guid,
+ cross_guid)
for trace_id in data.get_trace_data(guid):
testbed.defer_add_trace(guid, trace_id)
for (autoconf, address, netprefix, broadcast) in \
data.get_address_data(guid):
if address != None:
- testbed.defer_add_address(guid, address, netprefix, broadcast)
+ testbed.defer_add_address(guid, address, netprefix,
+ broadcast)
for (destination, netprefix, nexthop) in data.get_route_data(guid):
testbed.defer_add_route(guid, destination, netprefix, nexthop)
-
+
+ def _add_crossdata(self, testbed_guid, guid, cross_testbed_guid, cross_guid):
+ if testbed_guid not in self._cross_data:
+ self._cross_data[testbed_guid] = dict()
+ if cross_testbed_guid not in self._cross_data[testbed_guid]:
+ self._cross_data[testbed_guid][cross_testbed_guid] = set()
+ self._cross_data[testbed_guid][cross_testbed_guid].add(cross_guid)
+
+ def _get_cross_data(self, testbed_guid):
+ cross_data = dict()
+ if not testbed_guid in self._cross_data:
+ return cross_data
+ for cross_testbed_guid, guid_list in \
+ self._cross_data[testbed_guid].iteritems():
+ cross_data[cross_testbed_guid] = dict()
+ cross_testbed = self._testbeds[cross_testbed_guid]
+ for cross_guid in guid_list:
+ elem_cross_data = dict()
+ cross_data[cross_testbed_guid][cross_guid] = elem_cross_data
+ attributes_list = cross_testbed.get_attribute_list(cross_guid)
+ for attr_name in attributes_list:
+ attr_value = cross_testbed.get(cross_guid, attr_name)
+ elem_cross_data[attr_name] = attr_value
+ return cross_data
+