#!/usr/bin/env python
# -*- coding: utf-8 -*-
+import time
+
from constants import TESTBED_ID
from nepi.core import metadata
from nepi.core.attributes import Attribute
from nepi.util.constants import STATUS_NOT_STARTED, STATUS_RUNNING, \
STATUS_FINISHED
+import functools
+import os
+import os.path
+
NODE = "Node"
NODEIFACE = "NodeInterface"
TUNIFACE = "TunInterface"
APPLICATION = "Application"
+DEPENDENCY = "Dependency"
+NEPIDEPENDENCY = "NepiDependency"
INTERNET = "Internet"
+NETPIPE = "NetPipe"
PL_TESTBED_ID = "planetlab"
+
+### Custom validation functions ###
+def is_addrlist(attribute, value):
+ if not validation.is_string(attribute, value):
+ return False
+
+ if not value:
+ # No empty strings
+ return False
+
+ components = value.split(',')
+
+ for component in components:
+ if '/' in component:
+ addr, mask = component.split('/',1)
+ else:
+ addr, mask = component, 32
+
+ if mask is not None and not (mask and mask.isdigit()):
+ # No empty or nonnumeric masks
+ return False
+
+ if not validation.is_ip4_address(attribute, value):
+ # Address part must be ipv4
+ return False
+
+ return True
+
+def is_portlist(attribute, value):
+ if not validation.is_string(attribute, value):
+ return False
+
+ if not value:
+ # No empty strings
+ return False
+
+ components = value.split(',')
+
+ for component in components:
+ if '-' in component:
+ pfrom, pto = component.split('-',1)
+ else:
+ pfrom = pto = component
+
+ if not pfrom or not pto or not pfrom.isdigit() or not pto.isdigit():
+ # No empty or nonnumeric ports
+ return False
+
+ return True
+
+
### Connection functions ####
-def connect_node_iface_node(testbed_instance, node, iface):
+def connect_node_iface_node(testbed_instance, node_guid, iface_guid):
+ node = testbed_instance._elements[node_guid]
+ iface = testbed_instance._elements[iface_guid]
iface.node = node
-def connect_node_iface_inet(testbed_instance, iface, inet):
+def connect_node_iface_inet(testbed_instance, iface_guid, inet_guid):
+ iface = testbed_instance._elements[iface_guid]
iface.has_internet = True
-def connect_tun_iface_node(testbed_instance, node, iface):
+def connect_tun_iface_node(testbed_instance, node_guid, iface_guid):
+ node = testbed_instance._elements[node_guid]
+ iface = testbed_instance._elements[iface_guid]
+ if not node.emulation:
+ raise RuntimeError, "Use of TUN interfaces requires emulation"
iface.node = node
-
-def connect_app(testbed_instance, node, app):
+ node.required_vsys.update(('fd_tuntap', 'vif_up'))
+
+def connect_tun_iface_peer(proto, testbed_instance, iface_guid, peer_iface_guid):
+ iface = testbed_instance._elements[iface_guid]
+ peer_iface = testbed_instance._elements[peer_iface_guid]
+ iface.peer_iface = peer_iface
+ iface.peer_proto = \
+ iface.tun_proto = proto
+
+def connect_dep(testbed_instance, node_guid, app_guid):
+ node = testbed_instance._elements[node_guid]
+ app = testbed_instance._elements[app_guid]
app.node = node
+
+ if app.depends:
+ node.required_packages.update(set(
+ app.depends.split() ))
+
+ if app.add_to_path:
+ if app.home_path and app.home_path not in node.pythonpath:
+ node.pythonpath.append(app.home_path)
+
+def connect_node_netpipe(testbed_instance, node_guid, netpipe_guid):
+ node = testbed_instance._elements[node_guid]
+ netpipe = testbed_instance._elements[netpipe_guid]
+ if not node.emulation:
+ raise RuntimeError, "Use of NetPipes requires emulation"
+ netpipe.node = node
+
### Creation functions ###
# by counting connected devices
dev_guids = testbed_instance.get_connected(guid, "node", "devs")
num_open_ifaces = sum( # count True values
- TUNEIFACE == testbed_instance._get_factory_id(guid)
+ NODEIFACE == testbed_instance._get_factory_id(guid)
for guid in dev_guids )
element.min_num_external_ifaces = num_open_ifaces
def create_nodeiface(testbed_instance, guid):
parameters = testbed_instance._get_parameters(guid)
- element = testbed_instance.create_node_iface(parameters)
+ element = testbed_instance._make_node_iface(parameters)
testbed_instance.elements[guid] = element
def create_tuniface(testbed_instance, guid):
def create_application(testbed_instance, guid):
parameters = testbed_instance._get_parameters(guid)
element = testbed_instance._make_application(parameters)
+
+ # Just inject configuration stuff
+ element.home_path = "nepi-app-%s" % (guid,)
+
+ testbed_instance.elements[guid] = element
+
+def create_dependency(testbed_instance, guid):
+ parameters = testbed_instance._get_parameters(guid)
+ element = testbed_instance._make_dependency(parameters)
+
+ # Just inject configuration stuff
+ element.home_path = "nepi-dep-%s" % (guid,)
+
+ testbed_instance.elements[guid] = element
+
+def create_nepi_dependency(testbed_instance, guid):
+ parameters = testbed_instance._get_parameters(guid)
+ element = testbed_instance._make_nepi_dependency(parameters)
+
+ # Just inject configuration stuff
+ element.home_path = "nepi-nepi-%s" % (guid,)
+
testbed_instance.elements[guid] = element
def create_internet(testbed_instance, guid):
element = testbed_instance._make_internet(parameters)
testbed_instance.elements[guid] = element
+def create_netpipe(testbed_instance, guid):
+ parameters = testbed_instance._get_parameters(guid)
+ element = testbed_instance._make_netpipe(parameters)
+ testbed_instance.elements[guid] = element
+
### Start/Stop functions ###
def start_application(testbed_instance, guid):
parameters = testbed_instance._get_parameters(guid)
traces = testbed_instance._get_traces(guid)
app = testbed_instance.elements[guid]
- sudo = parameters["sudo"]
- command = parameters["command"]
- app.stdout = testbed_instance.trace_filename(guid, "stdout")
- app.stderr = testbed_instance.trace_filename(guid, "stderr")
+ app.stdout = "stdout" in traces
+ app.stderr = "stderr" in traces
+ app.buildlog = "buildlog" in traces
- # TODO
- pass
+ app.start()
+
+def stop_application(testbed_instance, guid):
+ app = testbed_instance.elements[guid]
+ app.kill()
### Status functions ###
def status_application(testbed_instance, guid):
if guid not in testbed_instance.elements.keys():
return STATUS_NOT_STARTED
+
app = testbed_instance.elements[guid]
- # TODO
- return STATUS_NOT_STARTED
+ return app.status()
### Configure functions ###
def configure_nodeiface(testbed_instance, guid):
element = testbed_instance._elements[guid]
- if not guid in testbed_instance._add_address:
- return
# Cannot explicitly configure addresses
- del testbed_instance._add_address[guid]
+ if guid in testbed_instance._add_address:
+ raise ValueError, "Cannot explicitly set address of public PlanetLab interface"
# Get siblings
node_guid = testbed_instance.get_connected(guid, "node", "devs")[0]
# Do some validations
element.validate()
-def configure_tuniface(testbed_instance, guid):
+def preconfigure_tuniface(testbed_instance, guid):
element = testbed_instance._elements[guid]
- if not guid in testbed_instance._add_address:
- return
- addresses = testbed_instance._add_address[guid]
- for address in addresses:
- (address, netprefix, broadcast) = address
- # TODO
+
+ # Set custom addresses if any
+ if guid in testbed_instance._add_address:
+ addresses = testbed_instance._add_address[guid]
+ for address in addresses:
+ (address, netprefix, broadcast) = address
+ element.add_address(address, netprefix, broadcast)
+
+ # Link to external interface, if any
+ for iface in testbed_instance._elements.itervalues():
+ if isinstance(iface, testbed_instance._interfaces.NodeIface) and iface.node is element.node and iface.has_internet:
+ element.external_iface = iface
+ break
+
+ # Set standard TUN attributes
+ element.tun_addr = element.external_iface.address
+ element.tun_port = 15000 + int(guid)
+
+ # Set enabled traces
+ traces = testbed_instance._get_traces(guid)
+ element.capture = 'packets' in traces
# Do some validations
element.validate()
+
+ # First-phase setup
+ element.prepare(
+ 'tun-%s' % (guid,),
+ id(element) < id(element.peer_iface) )
-def configure_node(testbed_instance, guid):
+def postconfigure_tuniface(testbed_instance, guid):
element = testbed_instance._elements[guid]
+ # Second-phase setup
+ element.setup()
+
+
+def configure_node(testbed_instance, guid):
+ node = testbed_instance._elements[guid]
+
+ # Just inject configuration stuff
+ node.home_path = "nepi-node-%s" % (guid,)
+ node.ident_path = testbed_instance.sliceSSHKey
+ node.slicename = testbed_instance.slicename
+
# Do some validations
- element.validate()
+ node.validate()
+
+ # recently provisioned nodes may not be up yet
+ sleeptime = 1.0
+ while not node.is_alive():
+ time.sleep(sleeptime)
+ sleeptime = min(30.0, sleeptime*1.5)
+
+ # this will be done in parallel in all nodes
+ # this call only spawns the process
+ node.install_dependencies()
+
+def configure_application(testbed_instance, guid):
+ app = testbed_instance._elements[guid]
+
+ # Do some validations
+ app.validate()
+
+ # Wait for dependencies
+ app.node.wait_dependencies()
+
+ # Install stuff
+ app.setup()
+
+def configure_dependency(testbed_instance, guid):
+ dep = testbed_instance._elements[guid]
+
+ # Do some validations
+ dep.validate()
+
+ # Wait for dependencies
+ dep.node.wait_dependencies()
+
+ # Install stuff
+ dep.setup()
+
+def configure_netpipe(testbed_instance, guid):
+ netpipe = testbed_instance._elements[guid]
+
+ # Do some validations
+ netpipe.validate()
+
+ # Wait for dependencies
+ netpipe.node.wait_dependencies()
+
+ # Install rules
+ netpipe.configure()
### Factory information ###
"max": -1,
"min": 0
}),
+ "deps": dict({
+ "help": "Connector from node to application dependencies "
+ "(packages and applications that need to be installed)",
+ "name": "deps",
+ "max": -1,
+ "min": 0
+ }),
"inet": dict({
"help": "Connector from network interfaces to the internet",
"name": "inet",
"max": 1,
"min": 1
}),
+ "pipes": dict({
+ "help": "Connector to a NetPipe",
+ "name": "pipes",
+ "max": 2,
+ "min": 0
+ }),
+
+ "tcp": dict({
+ "help": "ip-ip tunneling over TCP link",
+ "name": "tcp",
+ "max": 1,
+ "min": 0
+ }),
+ "udp": dict({
+ "help": "ip-ip tunneling over UDP datagrams",
+ "name": "udp",
+ "max": 1,
+ "min": 0
+ }),
})
connections = [
dict({
"from": (TESTBED_ID, NODE, "devs"),
"to": (TESTBED_ID, NODEIFACE, "node"),
- "code": connect_node_iface_node,
+ "init_code": connect_node_iface_node,
"can_cross": False
}),
dict({
"from": (TESTBED_ID, NODE, "devs"),
"to": (TESTBED_ID, TUNIFACE, "node"),
- "code": connect_tun_iface_node,
+ "init_code": connect_tun_iface_node,
"can_cross": False
}),
dict({
"from": (TESTBED_ID, NODEIFACE, "inet"),
"to": (TESTBED_ID, INTERNET, "devs"),
- "code": connect_node_iface_inet,
+ "init_code": connect_node_iface_inet,
"can_cross": False
}),
dict({
"from": (TESTBED_ID, NODE, "apps"),
"to": (TESTBED_ID, APPLICATION, "node"),
- "code": connect_app,
+ "init_code": connect_dep,
"can_cross": False
- })
+ }),
+ dict({
+ "from": (TESTBED_ID, NODE, "deps"),
+ "to": (TESTBED_ID, DEPENDENCY, "node"),
+ "init_code": connect_dep,
+ "can_cross": False
+ }),
+ dict({
+ "from": (TESTBED_ID, NODE, "deps"),
+ "to": (TESTBED_ID, NEPIDEPENDENCY, "node"),
+ "init_code": connect_dep,
+ "can_cross": False
+ }),
+ dict({
+ "from": (TESTBED_ID, NODE, "pipes"),
+ "to": (TESTBED_ID, NETPIPE, "node"),
+ "init_code": connect_node_netpipe,
+ "can_cross": False
+ }),
+ dict({
+ "from": (TESTBED_ID, TUNIFACE, "tcp"),
+ "to": (TESTBED_ID, TUNIFACE, "tcp"),
+ "init_code": functools.partial(connect_tun_iface_peer,"tcp"),
+ "can_cross": False
+ }),
+ dict({
+ "from": (TESTBED_ID, TUNIFACE, "udp"),
+ "to": (TESTBED_ID, TUNIFACE, "udp"),
+ "init_code": functools.partial(connect_tun_iface_peer,"udp"),
+ "can_cross": False
+ }),
]
attributes = dict({
"value": False,
"validation_function": validation.is_bool
}),
+ "txqueuelen": dict({
+ "name": "mask",
+ "help": "Transmission queue length (in packets)",
+ "type": Attribute.INTEGER,
+ "flags": Attribute.DesignOnly,
+ "range" : (1,10000),
+ "validation_function": validation.is_integer
+ }),
"command": dict({
"name": "command",
"validation_function": validation.is_string
}),
"sudo": dict({
- "name": "user",
- "help": "System user",
+ "name": "sudo",
+ "help": "Run with root privileges",
"type": Attribute.BOOL,
"flags": Attribute.DesignOnly,
"value": False,
"flags": Attribute.DesignOnly,
"validation_function": validation.is_string
}),
+
+ "depends": dict({
+ "name": "depends",
+ "help": "Space-separated list of packages required to run the application",
+ "type": Attribute.STRING,
+ "flags": Attribute.DesignOnly,
+ "validation_function": validation.is_string
+ }),
+ "build-depends": dict({
+ "name": "buildDepends",
+ "help": "Space-separated list of packages required to build the application",
+ "type": Attribute.STRING,
+ "flags": Attribute.DesignOnly,
+ "validation_function": validation.is_string
+ }),
+ "sources": dict({
+ "name": "sources",
+ "help": "Space-separated list of regular files to be deployed in the working path prior to building. "
+ "Archives won't be expanded automatically.",
+ "type": Attribute.STRING,
+ "flags": Attribute.DesignOnly,
+ "validation_function": validation.is_string
+ }),
+ "build": dict({
+ "name": "build",
+ "help": "Build commands to execute after deploying the sources. "
+ "Sources will be in the ${SOURCES} folder. "
+ "Example: tar xzf ${SOURCES}/my-app.tgz && cd my-app && ./configure && make && make clean.\n"
+ "Try to make the commands return with a nonzero exit code on error.\n"
+ "Also, do not install any programs here, use the 'install' attribute. This will "
+ "help keep the built files constrained to the build folder (which may "
+ "not be the home folder), and will result in faster deployment. Also, "
+ "make sure to clean up temporary files, to reduce bandwidth usage between "
+ "nodes when transferring built packages.",
+ "type": Attribute.STRING,
+ "flags": Attribute.DesignOnly,
+ "validation_function": validation.is_string
+ }),
+ "install": dict({
+ "name": "install",
+ "help": "Commands to transfer built files to their final destinations. "
+ "Sources will be in the initial working folder, and a special "
+ "tag ${SOURCES} can be used to reference the experiment's "
+ "home folder (where the application commands will run).\n"
+ "ALL sources and targets needed for execution must be copied there, "
+ "if building has been enabled.\n"
+ "That is, 'slave' nodes will not automatically get any source files. "
+ "'slave' nodes don't get build dependencies either, so if you need "
+ "make and other tools to install, be sure to provide them as "
+ "actual dependencies instead.",
+ "type": Attribute.STRING,
+ "flags": Attribute.DesignOnly,
+ "validation_function": validation.is_string
+ }),
+
+ "netpipe_mode": dict({
+ "name": "mode",
+ "help": "Link mode:\n"
+ " * SERVER: applies to incoming connections\n"
+ " * CLIENT: applies to outgoing connections\n"
+ " * SERVICE: applies to both",
+ "type": Attribute.ENUM,
+ "flags": Attribute.DesignOnly,
+ "allowed": ["SERVER",
+ "CLIENT",
+ "SERVICE"],
+ "validation_function": validation.is_enum,
+ }),
+ "port_list": dict({
+ "name": "portList",
+ "help": "Port list or range. Eg: '22', '22,23,27', '20-2000'",
+ "type": Attribute.STRING,
+ "validation_function": is_portlist,
+ }),
+ "addr_list": dict({
+ "name": "addrList",
+ "help": "Address list or range. Eg: '127.0.0.1', '127.0.0.1,127.0.1.1', '127.0.0.1/8'",
+ "type": Attribute.STRING,
+ "validation_function": is_addrlist,
+ }),
+ "bw_in": dict({
+ "name": "bwIn",
+ "help": "Inbound bandwidth limit (in Mbit/s)",
+ "type": Attribute.DOUBLE,
+ "validation_function": validation.is_double,
+ }),
+ "bw_out": dict({
+ "name": "bwOut",
+ "help": "Outbound bandwidth limit (in Mbit/s)",
+ "type": Attribute.DOUBLE,
+ "validation_function": validation.is_double,
+ }),
+ "plr_in": dict({
+ "name": "plrIn",
+ "help": "Inbound packet loss rate (0 = no loss, 1 = 100% loss)",
+ "type": Attribute.DOUBLE,
+ "validation_function": validation.is_double,
+ }),
+ "plr_out": dict({
+ "name": "plrOut",
+ "help": "Outbound packet loss rate (0 = no loss, 1 = 100% loss)",
+ "type": Attribute.DOUBLE,
+ "validation_function": validation.is_double,
+ }),
+ "delay_in": dict({
+ "name": "delayIn",
+ "help": "Inbound packet delay (in milliseconds)",
+ "type": Attribute.INTEGER,
+ "range": (0,60000),
+ "validation_function": validation.is_integer,
+ }),
+ "delay_out": dict({
+ "name": "delayOut",
+ "help": "Outbound packet delay (in milliseconds)",
+ "type": Attribute.INTEGER,
+ "range": (0,60000),
+ "validation_function": validation.is_integer,
+ }),
})
traces = dict({
"stderr": dict({
"name": "stderr",
"help": "Application standard error",
- })
+ }),
+ "buildlog": dict({
+ "name": "buildlog",
+ "help": "Output of the build process",
+ }),
+
+ "netpipe_stats": dict({
+ "name": "netpipeStats",
+ "help": "Information about rule match counters, packets dropped, etc.",
+ }),
+
+ "packets": dict({
+ "name": "packets",
+ "help": "Detailled log of all packets going through the interface",
+ }),
})
-create_order = [ NODE, NODEIFACE, TUNIFACE, APPLICATION ]
+create_order = [ INTERNET, NODE, NODEIFACE, TUNIFACE, NETPIPE, NEPIDEPENDENCY, DEPENDENCY, APPLICATION ]
-configure_order = [ NODE, NODEIFACE, TUNIFACE, APPLICATION ]
+configure_order = [ INTERNET, NODE, NODEIFACE, TUNIFACE, NETPIPE, NEPIDEPENDENCY, DEPENDENCY, APPLICATION ]
factories_info = dict({
NODE: dict({
"help": "Virtualized Node (V-Server style)",
"category": "topology",
"create_function": create_node,
- "configure_function": configure_node,
+ "preconfigure_function": configure_node,
"box_attributes": [
"forward_X11",
"hostname",
"min_bandwidth",
"max_bandwidth",
],
- "connector_types": ["devs", "apps"]
+ "connector_types": ["devs", "apps", "pipes", "deps"]
}),
NODEIFACE: dict({
- "allow_addresses": True,
+ "has_addresses": True,
"help": "External network interface - they cannot be brought up or down, and they MUST be connected to the internet.",
"category": "devices",
"create_function": create_nodeiface,
- "configure_function": configure_nodeiface,
+ "preconfigure_function": configure_nodeiface,
"box_attributes": [ ],
"connector_types": ["node", "inet"]
}),
"help": "Virtual TUN network interface",
"category": "devices",
"create_function": create_tuniface,
- "configure_function": configure_tuniface,
+ "preconfigure_function": preconfigure_tuniface,
+ "configure_function": postconfigure_tuniface,
"box_attributes": [
"up", "device_name", "mtu", "snat",
+ "txqueuelen"
],
- "connector_types": ["node"]
+ "traces": ["packets"],
+ "connector_types": ["node","udp","tcp"]
}),
APPLICATION: dict({
"help": "Generic executable command line application",
"create_function": create_application,
"start_function": start_application,
"status_function": status_application,
- "box_attributes": ["command", "sudo"],
+ "stop_function": stop_application,
+ "configure_function": configure_application,
+ "box_attributes": ["command", "sudo", "stdin",
+ "depends", "build-depends", "build", "install",
+ "sources" ],
+ "connector_types": ["node"],
+ "traces": ["stdout", "stderr", "buildlog"]
+ }),
+ DEPENDENCY: dict({
+ "help": "Requirement for package or application to be installed on some node",
+ "category": "applications",
+ "create_function": create_dependency,
+ "configure_function": configure_dependency,
+ "box_attributes": ["depends", "build-depends", "build", "install",
+ "sources" ],
+ "connector_types": ["node"],
+ "traces": ["buildlog"]
+ }),
+ NEPIDEPENDENCY: dict({
+ "help": "Requirement for NEPI inside NEPI - required to run testbed instances inside a node",
+ "category": "applications",
+ "create_function": create_nepi_dependency,
+ "configure_function": configure_dependency,
+ "box_attributes": [ ],
"connector_types": ["node"],
- "traces": ["stdout", "stderr"]
+ "traces": ["buildlog"]
}),
INTERNET: dict({
"help": "Internet routing",
"create_function": create_internet,
"connector_types": ["devs"],
}),
+ NETPIPE: dict({
+ "help": "Link emulation",
+ "category": "topology",
+ "create_function": create_netpipe,
+ "configure_function": configure_netpipe,
+ "box_attributes": ["netpipe_mode",
+ "addr_list", "port_list",
+ "bw_in","plr_in","delay_in",
+ "bw_out","plr_out","delay_out"],
+ "connector_types": ["node"],
+ "traces": ["netpipe_stats"]
+ }),
})
testbed_attributes = dict({
"flags": Attribute.DesignOnly | Attribute.HasNoDefaultValue,
"validation_function": validation.is_string
}),
+ "auth_user": dict({
+ "name": "authUser",
+ "help": "The name of the PlanetLab user to use for API calls - it must have at least a User role.",
+ "type": Attribute.STRING,
+ "flags": Attribute.DesignOnly | Attribute.HasNoDefaultValue,
+ "validation_function": validation.is_string
+ }),
+ "auth_pass": dict({
+ "name": "authPass",
+ "help": "The PlanetLab user's password.",
+ "type": Attribute.STRING,
+ "flags": Attribute.DesignOnly | Attribute.HasNoDefaultValue,
+ "validation_function": validation.is_string
+ }),
+ "slice_ssh_key": dict({
+ "name": "sliceSSHKey",
+ "help": "The controller-local path to the slice user's ssh private key. "
+ "It is the user's responsability to deploy this file where the controller "
+ "will run, it won't be done automatically because it's sensitive information. "
+ "It is recommended that a NEPI-specific user be created for this purpose and "
+ "this purpose alone.",
+ "type": Attribute.STRING,
+ "flags": Attribute.DesignOnly | Attribute.HasNoDefaultValue,
+ "validation_function": validation.is_string
+ }),
})
class VersionedMetadataInfo(metadata.VersionedMetadataInfo):
git://git.onelab.eu / nepi.git / blobdiff