from __future__ import with_statement
import re
import socket
+from sfa.util.namespace import *
from sfa.util.faults import *
from xmlbuilder import XMLBuilder
-#from lxml import etree
+from lxml import etree
import sys
from StringIO import StringIO
-# Taken from bwlimit.py
-#
-# See tc_util.c and http://physics.nist.gov/cuu/Units/binary.html. Be
-# warned that older versions of tc interpret "kbps", "mbps", "mbit",
-# and "kbit" to mean (in this system) "kibps", "mibps", "mibit", and
-# "kibit" and that if an older version is installed, all rates will
-# be off by a small fraction.
-suffixes = {
- "": 1,
- "bit": 1,
- "kibit": 1024,
- "kbit": 1000,
- "mibit": 1024*1024,
- "mbit": 1000000,
- "gibit": 1024*1024*1024,
- "gbit": 1000000000,
- "tibit": 1024*1024*1024*1024,
- "tbit": 1000000000000,
- "bps": 8,
- "kibps": 8*1024,
- "kbps": 8000,
- "mibps": 8*1024*1024,
- "mbps": 8000000,
- "gibps": 8*1024*1024*1024,
- "gbps": 8000000000,
- "tibps": 8*1024*1024*1024*1024,
- "tbps": 8000000000000
-}
-
-
-def get_tc_rate(s):
- """
- Parses an integer or a tc rate string (e.g., 1.5mbit) into bits/second
- """
-
- if type(s) == int:
- return s
- m = re.match(r"([0-9.]+)(\D*)", s)
- if m is None:
- return -1
- suffix = m.group(2).lower()
- if suffixes.has_key(suffix):
- return int(float(m.group(1)) * suffixes[suffix])
- else:
- return -1
-
-def format_tc_rate(rate):
- """
- Formats a bits/second rate into a tc rate string
- """
-
- if rate >= 1000000000 and (rate % 1000000000) == 0:
- return "%.0fgbit" % (rate / 1000000000.)
- elif rate >= 1000000 and (rate % 1000000) == 0:
- return "%.0fmbit" % (rate / 1000000.)
- elif rate >= 1000:
- return "%.0fkbit" % (rate / 1000.)
- else:
- return "%.0fbit" % rate
+class Sliver:
+ def __init__(self, node):
+ self.node = node
+ self.network = node.network
+ self.slice = node.network.slice
+
+ def toxml(self, xml):
+ with xml.sliver:
+ self.slice.tags_to_xml(xml, self.node)
+
class Iface:
def __init__(self, network, iface):
self.network = network
self.bwlimit = iface['bwlimit']
self.hostname = iface['hostname']
+ """
+ Just print out bwlimit right now
+ """
def toxml(self, xml):
- with xml.interface(id = self.idtag):
- if self.hostname:
- with xml.hostname:
- xml << self.hostname
- with xml.ipv4:
- xml << self.ipv4
- if self.bwlimit:
- with xml.bwlimit:
- xml << format_tc_rate(self.bwlimit)
+ if self.bwlimit:
+ with xml.bw_limit(units="kbps"):
+ xml << str(self.bwlimit / 1000)
+
class Node:
def __init__(self, network, node, bps = 1000 * 1000000):
self.id = node['node_id']
self.idtag = "n%s" % self.id
self.hostname = node['hostname']
- self.name = self.shortname = self.hostname.replace('.vini-veritas.net', '')
self.site_id = node['site_id']
- #self.ipaddr = socket.gethostbyname(self.hostname)
- self.bps = bps
- self.links = set()
self.iface_ids = node['interface_ids']
- self.iface_ids.sort()
- self.sliver = False
+ self.sliver = None
+ self.whitelist = node['slice_ids_whitelist']
- def get_link_id(self, remote):
- if self.id < remote.id:
- link = (self.id<<7) + remote.id
- else:
- link = (remote.id<<7) + self.id
- return link
-
- def get_iface_id(self, remote):
- if self.id < remote.id:
- iface = 1
- else:
- iface = 2
- return iface
-
def get_ifaces(self):
i = []
for id in self.iface_ids:
i.append(self.network.lookupIface(id))
+ # Only return the first interface
+ break
return i
- def get_virt_ip(self, remote):
- link = self.get_link_id(remote)
- iface = self.get_iface_id(remote)
- first = link >> 6
- second = ((link & 0x3f)<<2) + iface
- return "192.168.%d.%d" % (first, second)
-
- def get_virt_net(self, remote):
- link = self.get_link_id(remote)
- first = link >> 6
- second = (link & 0x3f)<<2
- return "192.168.%d.%d/30" % (first, second)
-
def get_site(self):
return self.network.lookupSite(self.site_id)
- def get_topo_rspec(self, link):
- if link.end1 == self:
- remote = link.end2
- elif link.end2 == self:
- remote = link.end1
- else:
- raise Error("Link does not connect to Node")
-
- my_ip = self.get_virt_ip(remote)
- remote_ip = remote.get_virt_ip(self)
- net = self.get_virt_net(remote)
- bw = format_tc_rate(link.bps)
- return (remote.id, remote.ipaddr, bw, my_ip, remote_ip, net)
-
- def add_link(self, link):
- self.links.add(link)
-
- # Assumes there is at most one Link between two sites
- def get_sitelink(self, node, sites):
- site1 = sites[self.site_id]
- site2 = sites[node.site_id]
- sl = site1.links.intersection(site2.links)
- if len(sl):
- return sl.pop()
- return None
-
def add_sliver(self):
- self.sliver = True
+ self.sliver = Sliver(self)
+
+ def toxml(self, xml):
+ slice = self.network.slice
+ if self.whitelist and not self.sliver:
+ if not slice or slice.id not in self.whitelist:
+ return
- def toxml(self, xml, hrn):
with xml.node(id = self.idtag):
with xml.hostname:
xml << self.hostname
for iface in self.get_ifaces():
iface.toxml(xml)
if self.sliver:
- with xml.sliver:
- pass
+ self.sliver.toxml(xml)
-class Link:
- def __init__(self, end1, end2, bps = 1000000000, parent = None):
- self.end1 = end1
- self.end2 = end2
- self.bps = bps
- self.parent = parent
- self.children = []
-
- end1.add_link(self)
- end2.add_link(self)
-
- if self.parent:
- self.parent.children.append(self)
-
- def toxml(self, xml):
- end_ids = "%s %s" % (self.end1.idtag, self.end2.idtag)
-
- if self.parent:
- element = xml.vlink(endpoints=end_ids)
- else:
- element = xml.link(endpoints=end_ids)
-
- with element:
- with xml.description:
- xml << "%s -- %s" % (self.end1.name, self.end2.name)
- with xml.kbps:
- xml << str(int(self.bps/1000))
- for child in self.children:
- child.toxml(xml)
-
-
class Site:
def __init__(self, network, site):
self.network = network
self.public = site['is_public']
self.enabled = site['enabled']
self.links = set()
+ self.whitelist = False
def get_sitenodes(self):
n = []
n.append(self.network.lookupNode(i))
return n
- def add_link(self, link):
- self.links.add(link)
-
- def toxml(self, xml, hrn, nodes):
+ def toxml(self, xml):
if not (self.public and self.enabled and self.node_ids):
return
with xml.site(id = self.idtag):
with xml.name:
xml << self.name
-
for node in self.get_sitenodes():
- node.toxml(xml, hrn)
+ node.toxml(xml)
class Slice:
- def __init__(self, network, slice):
+ def __init__(self, network, hrn, slice):
+ self.hrn = hrn
self.network = network
self.id = slice['slice_id']
self.name = slice['name']
self.node_ids = set(slice['node_ids'])
self.slice_tag_ids = slice['slice_tag_ids']
+ """
+ Use with tags that can have more than one instance
+ """
+ def get_multi_tag(self, tagname, node = None):
+ tags = []
+ for i in self.slice_tag_ids:
+ tag = self.network.lookupSliceTag(i)
+ if tag.tagname == tagname:
+ if not (node and node.id != tag.node_id):
+ tags.append(tag)
+ return tags
+
+ """
+ Use with tags that have only one instance
+ """
def get_tag(self, tagname, node = None):
for i in self.slice_tag_ids:
tag = self.network.lookupSliceTag(i)
if tag.tagname == tagname:
if (not node) or (node.id == tag.node_id):
return tag
- else:
- return None
+ return None
- def get_nodes(self, nodes):
+ def get_nodes(self):
n = []
for id in self.node_ids:
- n.append(nodes[id])
+ n.append(self.network.nodes[id])
return n
# Add a new slice tag
else:
record['node_id'] = None
tag = Slicetag(record)
- self.network.slicetags[tag.id] = tag
+ self.network.tags[tag.id] = tag
self.slice_tag_ids.append(tag.id)
tag.changed = True
tag.updated = True
tag = self.add_tag(tagname, value, node)
tag.updated = True
- """
- Find a free EGRE key
- """
- def new_egre_key():
- slicetags = self.network.slicetags
- used = set()
- for i in slicetags:
- tag = slicetags[i]
- if tag.tagname == 'egre_key':
- used.add(int(tag.value))
-
- for i in range(1, 256):
- if i not in used:
- key = i
+ def update_multi_tag(self, tagname, value, node = None):
+ tags = self.get_multi_tag(tagname, node)
+ for tag in tags:
+ if tag and tag.value == value:
+ value = "no change"
break
else:
- raise KeyError("No more EGRE keys available")
-
- return "%s" % key
-
-
- def assign_egre_key(self):
- if not self.get_tag('egre_key'):
- try:
- key = self.new_egre_key()
- self.update_tag('egre_key', key)
- except:
- # Should handle this case...
- pass
- return
+ tag = self.add_tag(tagname, value, node)
+ tag.updated = True
- def turn_on_netns(self):
- tag = self.get_tag('netns')
- if (not tag) or (tag.value != '1'):
- self.update_tag('netns', '1')
- return
-
- def turn_off_netns(self):
- tag = self.get_tag('netns')
- if tag and (tag.value != '0'):
- tag.delete()
- return
-
- def add_cap_net_admin(self):
- tag = self.get_tag('capabilities')
- if tag:
- caps = tag.value.split(',')
- for cap in caps:
- if cap == "CAP_NET_ADMIN":
- return
- else:
- newcaps = "CAP_NET_ADMIN," + tag.value
- self.update_tag('capabilities', newcaps)
- else:
- self.add_tag('capabilities', 'CAP_NET_ADMIN')
- return
-
- def remove_cap_net_admin(self):
- tag = self.get_tag('capabilities')
- if tag:
- caps = tag.value.split(',')
- newcaps = []
- for cap in caps:
- if cap != "CAP_NET_ADMIN":
- newcaps.append(cap)
- if newcaps:
- value = ','.join(newcaps)
- self.update_tag('capabilities', value)
+ def tags_to_xml(self, xml, node = None):
+ tagtypes = self.network.getTagTypes()
+ for tt in tagtypes:
+ if tt.multi:
+ tags = self.get_multi_tag(tt.tagname, node)
+ for tag in tags:
+ if not tag.deleted: ### Debugging
+ xml << (tag.tagname, tag.value)
else:
- tag.delete()
- return
+ tag = self.get_tag(tt.tagname, node)
+ if tag:
+ if not tag.deleted: ### Debugging
+ xml << (tag.tagname, tag.value)
- # Update the vsys/setup-link and vsys/setup-nat slice tags.
- def add_vsys_tags(self):
- link = nat = False
- for i in self.slice_tag_ids:
- tag = self.network.lookupSliceTag(i)
- if tag.tagname == 'vsys':
- if tag.value == 'setup-link':
- link = True
- elif tag.value == 'setup-nat':
- nat = True
- if not link:
- self.add_tag('vsys', 'setup-link')
- if not nat:
- self.add_tag('vsys', 'setup-nat')
- return
+ def toxml(self, xml):
+ with xml.sliver_defaults:
+ self.tags_to_xml(xml)
class Slicetag:
api.plshell.DeleteSliceTag(api.plauth, self.id)
+class TagType:
+ def __init__(self, tagtype):
+ self.id = tagtype['tag_type_id']
+ self.tagname = tagtype['tagname']
+ if self.tagname in ['codemux', 'ip_addresses', 'vsys']:
+ self.multi = True
+ else:
+ self.multi = False
+
+
"""
A Network is a compound object consisting of:
* a dictionary mapping site IDs to Site objects
* a dictionary mapping node IDs to Node objects
* a dictionary mapping interface IDs to Iface objects
-* the Site objects are connected via Link objects representing
- the physical topology and available bandwidth
-* the Node objects are connected via Link objects representing
- the requested or assigned virtual topology of a slice
"""
class Network:
- def __init__(self, api, type = "PlanetLab", physical_links = [],
- schema = None):
+ def __init__(self, api, type = "PlanetLab"):
self.api = api
self.type = type
self.sites = self.get_sites(api)
self.nodes = self.get_nodes(api)
self.ifaces = self.get_ifaces(api)
self.tags = self.get_slice_tags(api)
+ self.tagtypes = self.get_tag_types(api)
self.slice = None
- self.sitelinks = []
- self.nodelinks = []
- self.schema = schema
-
- for (s1, s2) in physical_links:
- self.sitelinks.append(Link(self.sites[s1], self.sites[s2]))
-
- for t in self.tags:
- tag = self.tags[t]
- if tag.tagname == 'topo_rspec':
- node1 = self.nodes[tag.node_id]
- l = eval(tag.value)
- for (id, realip, bw, lvip, rvip, vnet) in l:
- allocbps = get_tc_rate(bw)
- node1.bps -= allocbps
- try:
- node2 = self.nodes[id]
- if node1.id < node2.id:
- sl = node1.get_sitelink(node2, self.sites)
- sl.bps -= allocbps
- except:
- pass
-
""" Lookup site based on id or idtag value """
def lookupSite(self, id):
try:
val = self.sites[id]
except:
- raise KeyError("site ID %s not found" % id)
+ raise InvalidRSpec("site ID %s not found" % id)
return val
def getSites(self):
try:
val = self.nodes[id]
except:
- raise KeyError("node ID %s not found" % id)
+ raise InvalidRSpec("node ID %s not found" % id)
return val
def getNodes(self):
try:
val = self.ifaces[id]
except:
- raise KeyError("interface ID %s not found" % id)
+ raise InvalidRSpec("interface ID %s not found" % id)
return val
def getIfaces(self):
ifaces.append(self.ifaces[i])
return ifaces
- def nodesInNetwork(self):
+ def nodesWithSlivers(self):
nodes = []
for n in self.nodes:
node = self.nodes[n]
try:
val = self.tags[id]
except:
- raise KeyError("slicetag ID %s not found" % id)
+ raise InvalidRSpec("slicetag ID %s not found" % id)
return val
def getSliceTags(self):
tags.append(self.tags[t])
return tags
- def lookupSiteLink(self, node1, node2):
- site1 = self.sites[node1.site_id]
- site2 = self.sites[node2.site_id]
- for link in self.sitelinks:
- if site1 == link.end1 and site2 == link.end2:
- return link
- if site2 == link.end1 and site1 == link.end2:
- return link
- return None
+ def lookupTagType(self, name):
+ val = None
+ try:
+ val = self.tagstypes[name]
+ except:
+ raise InvalidRSpec("tag %s not found" % name)
+ return val
+ def getTagTypes(self):
+ tags = []
+ for t in self.tagtypes:
+ tags.append(self.tagtypes[t])
+ return tags
+
+ def __process_attributes(self, element, node=None):
+ # Do we need to check caller's role before update???
+ tagtypes = self.getTagTypes()
+ for tt in tagtypes:
+ if tt.multi:
+ for e in element.iterfind("./" + tt.tagname):
+ self.slice.update_multi_tag(tt.tagname, e.text, node)
+ else:
+ e = element.find("./" + tt.tagname)
+ if e is not None:
+ self.slice.update_tag(tt.tagname, e.text, node)
- def __add_vlink(self, vlink, slicenodes, parent = None):
- n1 = n2 = None
- endpoints = vlink.get("endpoints")
- if endpoints:
- (end1, end2) = endpoints.split()
- n1 = self.lookupNode(end1)
- n2 = self.lookupNode(end2)
- elif parent:
- """ Try to infer the endpoints for the virtual link """
- site_endpoints = parent.get("endpoints")
- (n1, n2) = self.__infer_endpoints(site_endpoints, slicenodes)
- else:
- raise Error("no endpoints given")
-
- #print "Added virtual link: %s -- %s" % (n1.tag, n2.tag)
- bps = int(vlink.findtext("kbps")) * 1000
- sitelink = self.lookupSiteLink(n1, n2)
- if not sitelink:
- raise PermissionError("nodes %s and %s not adjacent" %
- (n1.idtag, n2.idtag))
- self.nodelinks.append(Link(n1, n2, bps, sitelink))
- return
-
- """
- Infer the endpoints of the virtual link. If the slice exists on
- only a single node at each end of the physical link, we'll assume that
- the user wants the virtual link to terminate at these nodes.
"""
- def __infer_endpoints(self, endpoints, slicenodes):
- n = []
- ends = endpoints.split()
- for end in ends:
- found = 0
- site = self.lookupSite(end)
- for id in site.node_ids:
- if id in slicenodes:
- n.append(slicenodes[id])
- found += 1
- if found != 1:
- raise Error("could not infer endpoint for site %s" % site.id)
- #print "Inferred endpoints: %s %s" % (n[0].idtag, n[1].idtag)
- return n
-
- def annotateFromRSpec(self, xml):
- if self.nodelinks:
- raise Error("virtual topology already present")
-
+ Annotate the objects in the Network with information from the RSpec
+ """
+ def addRSpec(self, xml, schema=None):
nodedict = {}
for node in self.getNodes():
nodedict[node.idtag] = node
- slicenodes = {}
-
- tree = etree.parse(StringIO(xml))
+ try:
+ tree = etree.parse(StringIO(xml))
+ except etree.XMLSyntaxError:
+ message = str(sys.exc_info()[1])
+ raise InvalidRSpec(message)
- if self.schema:
+ if schema:
# Validate the incoming request against the RelaxNG schema
- relaxng_doc = etree.parse(self.schema)
+ relaxng_doc = etree.parse(schema)
relaxng = etree.RelaxNG(relaxng_doc)
if not relaxng(tree):
rspec = tree.getroot()
- """
- Handle requests where the user has annotated a description of the
- physical resources (nodes and links) with virtual ones (slivers
- and vlinks).
- """
+ defaults = rspec.find("./network/sliver_defaults")
+ self.__process_attributes(defaults)
+
# Find slivers under node elements
for sliver in rspec.iterfind("./network/site/node/sliver"):
elem = sliver.getparent()
node = nodedict[elem.get("id")]
- slicenodes[node.id] = node
node.add_sliver()
+ self.__process_attributes(sliver, node)
- # Find vlinks under link elements
- for vlink in rspec.iterfind("./network/link/vlink"):
- link = vlink.getparent()
- self.__add_vlink(vlink, slicenodes, link)
-
- """
- Handle requests where the user has listed the virtual resources only
- """
# Find slivers that specify nodeid
for sliver in rspec.iterfind("./request/sliver[@nodeid]"):
node = nodedict[sliver.get("nodeid")]
- slicenodes[node.id] = node
node.add_sliver()
-
- # Find vlinks that specify endpoints
- for vlink in rspec.iterfind("./request/vlink[@endpoints]"):
- self.__add_vlink(vlink, slicenodes)
+ self.__process_attributes(sliver, node)
return
- def annotateFromSliceTags(self, slice):
- if self.nodelinks:
- raise Error("virtual topology already present")
-
- for node in slice.get_nodes(self.nodes):
- node.sliver = True
- linktag = slice.get_tag('topo_rspec', self.tags, node)
- if linktag:
- l = eval(linktag.value)
- for (id, realip, bw, lvip, rvip, vnet) in l:
- if node.id < id:
- bps = get_tc_rate(bw)
- remote = self.lookupNode(id)
- sitelink = self.lookupSiteLink(node, remote)
- self.nodelinks.append(Link(node,remote,bps,sitelink))
-
- def updateSliceTags(self, slice):
- if not self.nodelinks:
- return
-
- slice.update_tag('vini_topo', 'manual', self.tags)
- slice.assign_egre_key(self.tags)
- slice.turn_on_netns(self.tags)
- slice.add_cap_net_admin(self.tags)
-
- for node in slice.get_nodes(self.nodes):
- linkdesc = []
- for link in node.links:
- linkdesc.append(node.get_topo_rspec(link))
- if linkdesc:
- topo_str = "%s" % linkdesc
- slice.update_tag('topo_rspec', topo_str, self.tags, node)
+ """
+ Annotate the objects in the Network with information from the slice
+ """
+ def addSlice(self):
+ slice = self.slice
+ if not slice:
+ raise InvalidRSpec("no slice associated with network")
+ for node in slice.get_nodes():
+ node.add_sliver()
+
+ """
+ Write any slice tags that have been added or modified back to the DB
+ """
+ def updateSliceTags(self):
# Update slice tags in database
for tag in self.getSliceTags():
- if tag.slice_id == slice.id:
- if tag.tagname == 'topo_rspec' and not tag.updated:
+ if tag.slice_id == self.slice.id:
+ if not tag.updated:
tag.delete()
- tag.write(self.api)
-
- """
- Check the requested topology against the available topology and capacity
- """
- def verifyNodeNetwork(self, hrn, topo):
- for link in self.nodelinks:
- if link.bps <= 0:
- raise GeniInvalidArgument(bw, "BW")
-
- n1 = link.end1
- n2 = link.end2
- sitelink = self.lookupSiteLink(n1, n2)
- if not sitelink:
- raise PermissionError("%s: nodes %s and %s not adjacent" % (hrn, n1.tag, n2.tag))
- if sitelink.bps < link.bps:
- raise PermissionError("%s: insufficient capacity between %s and %s" % (hrn, n1.tag, n2.tag))
-
+ #tag.write(self.api) ### Debugging
+
"""
Produce XML directly from the topology specification.
"""
- def toxml(self, hrn = None):
+ def toxml(self):
xml = XMLBuilder(format = True, tab_step = " ")
- with xml.RSpec(type="VINI"):
- if hrn:
- element = xml.network(name="Public_VINI", slice=hrn)
+ with xml.RSpec(type=self.type):
+ name = "Public_" + self.type
+ if self.slice:
+ element = xml.network(name=name, slice=self.slice.hrn)
else:
- element = xml.network(name="Public_VINI")
+ element = xml.network(name=name)
with element:
+ if self.slice:
+ self.slice.toxml(xml)
for site in self.getSites():
- site.toxml(xml, hrn, self.nodes)
- for link in self.sitelinks:
- link.toxml(xml)
+ site.toxml(xml)
header = '<?xml version="1.0"?>\n'
return header + str(xml)
"""
def get_sites(self, api):
tmp = []
- for site in api.plshell.GetSites(api.plauth):
+ for site in api.plshell.GetSites(api.plauth, {'peer_id': None}):
t = site['site_id'], Site(self, site)
tmp.append(t)
return dict(tmp)
"""
def get_nodes(self, api):
tmp = []
- for node in api.plshell.GetNodes(api.plauth):
+ for node in api.plshell.GetNodes(api.plauth, {'peer_id': None}):
t = node['node_id'], Node(self, node)
tmp.append(t)
return dict(tmp)
tmp.append(t)
return dict(tmp)
+ """
+ Create a list of tagtype obects keyed by tag name
+ """
+ def get_tag_types(self, api):
+ tmp = []
+ for tag in api.plshell.GetTagTypes(api.plauth):
+ if tag['category'] == 'slice/rspec':
+ t = tag['tagname'], TagType(tag)
+ tmp.append(t)
+ return dict(tmp)
+
"""
Return a Slice object for a single slice
"""
- def get_slice(self, api, slicename):
+ def get_slice(self, api, hrn):
+ slicename = hrn_to_pl_slicename(hrn)
slice = api.plshell.GetSlices(api.plauth, [slicename])
if slice:
- return Slice(self, slice[0])
+ self.slice = Slice(self, slicename, slice[0])
+ return self.slice
else:
return None