sfa/plc/network.py

   1 from __future__ import with_statement
   2 import re
   3 import socket
   4 from sfa.util.namespace import *
   5 from sfa.util.faults import *
   6 from xmlbuilder import XMLBuilder
   7 from lxml import etree
   8 import sys
   9 from StringIO import StringIO
  10
  11
  12 class Sliver:
  13     def __init__(self, node):
  14         self.node = node
  15         self.network = node.network
  16         self.slice = node.network.slice
  17
  18     def toxml(self, xml):
  19         with xml.sliver:
  20             self.slice.tags_to_xml(xml, self.node)
  21
  22
  23 class Iface:
  24     def __init__(self, network, iface):
  25         self.network = network
  26         self.id = iface['interface_id']
  27         self.idtag = "i%s" % self.id
  28         self.ipv4 = iface['ip']
  29         self.bwlimit = iface['bwlimit']
  30         self.hostname = iface['hostname']
  31         self.primary = iface['is_primary']
  32
  33     """
  34     Just print out bwlimit right now
  35     """
  36     def toxml(self, xml):
  37         if self.bwlimit:
  38             with xml.bw_limit(units="kbps"):
  39                 xml << str(self.bwlimit / 1000)
  40
  41
  42 class Node:
  43     def __init__(self, network, node):
  44         self.network = network
  45         self.id = node['node_id']
  46         self.idtag = "n%s" % self.id
  47         self.hostname = node['hostname']
  48         self.site_id = node['site_id']
  49         self.iface_ids = node['interface_ids']
  50         self.sliver = None
  51         self.whitelist = node['slice_ids_whitelist']
  52
  53     def get_primary_iface(self):
  54         for id in self.iface_ids:
  55             iface = self.network.lookupIface(id)
  56             if iface.primary:
  57                 return iface
  58         return None
  59
  60     def get_site(self):
  61         return self.network.lookupSite(self.site_id)
  62
  63     def add_sliver(self):
  64         self.sliver = Sliver(self)
  65
  66     def toxml(self, xml):
  67         slice = self.network.slice
  68         if self.whitelist and not self.sliver:
  69             if not slice or slice.id not in self.whitelist:
  70                 return
  71
  72         with xml.node(id = self.idtag):
  73             with xml.hostname:
  74                 xml << self.hostname
  75             iface = self.get_primary_iface()
  76             if iface:
  77                 iface.toxml(xml)
  78             if self.sliver:
  79                 self.sliver.toxml(xml)
  80
  81
  82 class Site:
  83     def __init__(self, network, site):
  84         self.network = network
  85         self.id = site['site_id']
  86         self.idtag = "s%s" % self.id
  87         self.node_ids = site['node_ids']
  88         self.node_ids.sort()
  89         self.name = site['abbreviated_name']
  90         self.tag = site['login_base']
  91         self.public = site['is_public']
  92         self.enabled = site['enabled']
  93         self.links = set()
  94         self.whitelist = False
  95
  96     def get_sitenodes(self):
  97         n = []
  98         for i in self.node_ids:
  99             n.append(self.network.lookupNode(i))
 100         return n
 101
 102     def toxml(self, xml):
 103         if not (self.public and self.enabled and self.node_ids):
 104             return
 105         with xml.site(id = self.idtag):
 106             with xml.name:
 107                 xml << self.name
 108             for node in self.get_sitenodes():
 109                 node.toxml(xml)
 110
 111
 112 class Slice:
 113     def __init__(self, network, hrn, slice):
 114         self.hrn = hrn
 115         self.network = network
 116         self.id = slice['slice_id']
 117         self.name = slice['name']
 118         self.node_ids = set(slice['node_ids'])
 119         self.slice_tag_ids = slice['slice_tag_ids']
 120
 121     """
 122     Use with tags that can have more than one instance
 123     """
 124     def get_multi_tag(self, tagname, node = None):
 125         tags = []
 126         for i in self.slice_tag_ids:
 127             tag = self.network.lookupSliceTag(i)
 128             if tag.tagname == tagname:
 129                 if not (node and node.id != tag.node_id):
 130                     tags.append(tag)
 131         return tags
 132
 133     """
 134     Use with tags that have only one instance
 135     """
 136     def get_tag(self, tagname, node = None):
 137         for i in self.slice_tag_ids:
 138             tag = self.network.lookupSliceTag(i)
 139             if tag.tagname == tagname:
 140                 if (not node) or (node.id == tag.node_id):
 141                     return tag
 142         return None
 143
 144     def get_nodes(self):
 145         n = []
 146         for id in self.node_ids:
 147             if id in self.network.nodes:
 148                 n.append(self.network.nodes[id])
 149         return n
 150
 151     # Add a new slice tag
 152     def add_tag(self, tagname, value, node = None, role_id = 40):
 153         tt = self.network.lookupTagType(tagname)
 154         if not tt.permit_update(role_id):
 155             raise InvalidRSpec("permission denied to modify '%s' tag" % tagname)
 156         tag = Slicetag()
 157         tag.initialize(tagname, value, node, self.network)
 158         self.network.tags[tag.id] = tag
 159         self.slice_tag_ids.append(tag.id)
 160         return tag
 161
 162     # Update a slice tag if it exists, else add it
 163     def update_tag(self, tagname, value, node = None, role_id = 40):
 164         tag = self.get_tag(tagname, node)
 165         if tag:
 166             if not tag.permit_update(role_id, value):
 167                 raise InvalidRSpec("permission denied to modify '%s' tag" % tagname)
 168             tag.change(value)
 169         else:
 170             tag = self.add_tag(tagname, value, node, role_id)
 171         return tag
 172
 173     def update_multi_tag(self, tagname, value, node = None, role_id = 40):
 174         tags = self.get_multi_tag(tagname, node)
 175         for tag in tags:
 176             if tag and tag.value == value:
 177                 break
 178         else:
 179             tag = self.add_tag(tagname, value, node, role_id)
 180         return tag
 181
 182     def tags_to_xml(self, xml, node = None):
 183         tagtypes = self.network.getTagTypes()
 184         for tt in tagtypes:
 185             if tt.in_rspec:
 186                 if tt.multi:
 187                     tags = self.get_multi_tag(tt.tagname, node)
 188                     for tag in tags:
 189                         if not tag.was_deleted():  ### Debugging
 190                             xml << (tag.tagname, tag.value)
 191                 else:
 192                     tag = self.get_tag(tt.tagname, node)
 193                     if tag:
 194                         if not tag.was_deleted():   ### Debugging
 195                             xml << (tag.tagname, tag.value)
 196
 197     def toxml(self, xml):
 198         with xml.sliver_defaults:
 199             self.tags_to_xml(xml)
 200
 201
 202 class Slicetag:
 203     newid = -1
 204     def __init__(self, tag = None):
 205         if not tag:
 206             return
 207         self.id = tag['slice_tag_id']
 208         self.slice_id = tag['slice_id']
 209         self.tagname = tag['tagname']
 210         self.value = tag['value']
 211         self.node_id = tag['node_id']
 212         self.category = tag['category']
 213         self.min_role_id = tag['min_role_id']
 214         self.status = None
 215
 216     # Create a new slicetag that will be written to the DB later
 217     def initialize(self, tagname, value, node, network):
 218         tt = network.lookupTagType(tagname)
 219         self.id = Slicetag.newid
 220         Slicetag.newid -=1
 221         self.slice_id = network.slice.id
 222         self.tagname = tagname
 223         self.value = value
 224         self.node_id = node.id
 225         self.category = tt.category
 226         self.min_role_id = tt.min_role_id
 227         self.status = "new"
 228
 229     def permit_update(self, role_id, value = None):
 230         if value and self.value == value:
 231             return True
 232         if role_id > self.min_role_id:
 233             return False
 234         return True
 235
 236     def change(self, value):
 237         if self.value != value:
 238             self.value = value
 239             self.status = "change"
 240         else:
 241             self.status = "updated"
 242
 243     # Mark a tag as deleted
 244     def delete(self):
 245         self.status = "delete"
 246
 247     def was_added(self):
 248         return (self.id < 0)
 249
 250     def was_changed(self):
 251         return (self.status == "change")
 252
 253     def was_deleted(self):
 254         return (self.status == "delete")
 255
 256     def was_updated(self):
 257         return (self.status != None)
 258
 259     def write(self, api):
 260         if self.was_added():
 261             api.plshell.AddSliceTag(api.plauth, self.slice_id,
 262                                     self.tagname, self.value, self.node_id)
 263         elif self.was_changed():
 264             api.plshell.UpdateSliceTag(api.plauth, self.id, self.value)
 265         elif self.was_deleted():
 266             api.plshell.DeleteSliceTag(api.plauth, self.id)
 267
 268
 269 class TagType:
 270     def __init__(self, tagtype):
 271         self.id = tagtype['tag_type_id']
 272         self.category = tagtype['category']
 273         self.tagname = tagtype['tagname']
 274         self.min_role_id = tagtype['min_role_id']
 275         self.multi = False
 276         self.in_rspec = False
 277         if self.category == 'slice/rspec':
 278             self.in_rspec = True
 279         if self.tagname in ['codemux', 'ip_addresses', 'vsys']:
 280             self.multi = True
 281
 282     def permit_update(self, role_id):
 283         if role_id > self.min_role_id:
 284             return False
 285         return True
 286
 287
 288 """
 289 A Network is a compound object consisting of:
 290 * a dictionary mapping site IDs to Site objects
 291 * a dictionary mapping node IDs to Node objects
 292 * a dictionary mapping interface IDs to Iface objects
 293 """
 294 class Network:
 295     def __init__(self, api, type = "PlanetLab"):
 296         self.api = api
 297         self.type = type
 298         self.sites = self.get_sites(api)
 299         self.nodes = self.get_nodes(api)
 300         self.ifaces = self.get_ifaces(api)
 301         self.tags = self.get_slice_tags(api)
 302         self.tagtypes = self.get_tag_types(api)
 303         self.slice = None
 304
 305     """ Lookup site based on id or idtag value """
 306     def lookupSite(self, id):
 307         val = None
 308         if isinstance(id, basestring):
 309             id = int(id.lstrip('s'))
 310         try:
 311             val = self.sites[id]
 312         except:
 313             raise InvalidRSpec("site ID %s not found" % id)
 314         return val
 315
 316     def getSites(self):
 317         sites = []
 318         for s in self.sites:
 319             sites.append(self.sites[s])
 320         return sites
 321
 322     """ Lookup node based on id or idtag value """
 323     def lookupNode(self, id):
 324         val = None
 325         if isinstance(id, basestring):
 326             id = int(id.lstrip('n'))
 327         try:
 328             val = self.nodes[id]
 329         except:
 330             raise InvalidRSpec("node ID %s not found" % id)
 331         return val
 332
 333     def getNodes(self):
 334         nodes = []
 335         for n in self.nodes:
 336             nodes.append(self.nodes[n])
 337         return nodes
 338
 339     """ Lookup iface based on id or idtag value """
 340     def lookupIface(self, id):
 341         val = None
 342         if isinstance(id, basestring):
 343             id = int(id.lstrip('i'))
 344         try:
 345             val = self.ifaces[id]
 346         except:
 347             raise InvalidRSpec("interface ID %s not found" % id)
 348         return val
 349
 350     def getIfaces(self):
 351         ifaces = []
 352         for i in self.ifaces:
 353             ifaces.append(self.ifaces[i])
 354         return ifaces
 355
 356     def nodesWithSlivers(self):
 357         nodes = []
 358         for n in self.nodes:
 359             node = self.nodes[n]
 360             if node.sliver:
 361                 nodes.append(node)
 362         return nodes
 363
 364     def lookupSliceTag(self, id):
 365         val = None
 366         try:
 367             val = self.tags[id]
 368         except:
 369             raise InvalidRSpec("slicetag ID %s not found" % id)
 370         return val
 371
 372     def getSliceTags(self):
 373         tags = []
 374         for t in self.tags:
 375             tags.append(self.tags[t])
 376         return tags
 377
 378     def lookupTagType(self, name):
 379         val = None
 380         try:
 381             val = self.tagtypes[name]
 382         except:
 383             raise InvalidRSpec("tag %s not found" % name)
 384         return val
 385
 386     def getTagTypes(self):
 387         tags = []
 388         for t in self.tagtypes:
 389             tags.append(self.tagtypes[t])
 390         return tags
 391
 392     """
 393     Process the elements under <sliver_defaults> or <sliver>
 394     """
 395     def __process_attributes(self, element, node=None):
 396         if element is None:
 397             return
 398
 399         tagtypes = self.getTagTypes()
 400         for tt in tagtypes:
 401             if tt.in_rspec:
 402                 if tt.multi:
 403                     for e in element.iterfind("./" + tt.tagname):
 404                         self.slice.update_multi_tag(tt.tagname, e.text, node)
 405                 else:
 406                     e = element.find("./" + tt.tagname)
 407                     if e is not None:
 408                         self.slice.update_tag(tt.tagname, e.text, node)
 409
 410     """
 411     Annotate the objects in the Network with information from the RSpec
 412     """
 413     def addRSpec(self, xml, schema=None):
 414         try:
 415             tree = etree.parse(StringIO(xml))
 416         except etree.XMLSyntaxError:
 417             message = str(sys.exc_info()[1])
 418             raise InvalidRSpec(message)
 419
 420         if schema:
 421             # Validate the incoming request against the RelaxNG schema
 422             relaxng_doc = etree.parse(schema)
 423             relaxng = etree.RelaxNG(relaxng_doc)
 424
 425             if not relaxng(tree):
 426                 error = relaxng.error_log.last_error
 427                 message = "%s (line %s)" % (error.message, error.line)
 428                 raise InvalidRSpec(message)
 429
 430         rspec = tree.getroot()
 431         self.rspec = rspec
 432
 433         defaults = rspec.find("./network/sliver_defaults")
 434         self.__process_attributes(defaults)
 435
 436         # Find slivers under node elements
 437         for sliver in rspec.iterfind("./network/site/node/sliver"):
 438             elem = sliver.getparent()
 439             try:
 440                 node = self.lookupNode(elem.get("id"))
 441             except:
 442                 # Don't worry about nodes from other aggregates
 443                 pass
 444             else:
 445                 node.add_sliver()
 446                 self.__process_attributes(sliver, node)
 447
 448         # Find slivers that specify nodeid
 449         for sliver in rspec.iterfind("./request/sliver[@nodeid]"):
 450             try:
 451                 node = self.lookupNode(sliver.get("nodeid"))
 452             except:
 453                 # Don't worry about nodes from other aggregates
 454                 pass
 455             else:
 456                 node.add_sliver()
 457                 self.__process_attributes(sliver, node)
 458
 459         return
 460
 461     """
 462     Annotate the objects in the Network with information from the slice
 463     """
 464     def addSlice(self):
 465         slice = self.slice
 466         if not slice:
 467             raise InvalidRSpec("no slice associated with network")
 468
 469         for node in slice.get_nodes():
 470             node.add_sliver()
 471
 472     """
 473     Write any slice tags that have been added or modified back to the DB
 474     """
 475     def updateSliceTags(self):
 476         for tag in self.getSliceTags():
 477             if tag.category == 'slice/rspec' and not tag.was_updated() and tag.permit_update(None, 40):
 478                 # The user wants to delete this tag
 479                 tag.delete()
 480
 481         # Update slice tags in database
 482         for tag in self.getSliceTags():
 483             if tag.slice_id == self.slice.id:
 484                 tag.write(self.api)
 485
 486     """
 487     Produce XML directly from the topology specification.
 488     """
 489     def toxml(self):
 490         xml = XMLBuilder(format = True, tab_step = "  ")
 491         with xml.RSpec(type=self.type):
 492             name = "Public_" + self.type
 493             if self.slice:
 494                 element = xml.network(name=name, slice=self.slice.hrn)
 495             else:
 496                 element = xml.network(name=name)
 497
 498             with element:
 499                 if self.slice:
 500                     self.slice.toxml(xml)
 501                 for site in self.getSites():
 502                     site.toxml(xml)
 503
 504         header = '<?xml version="1.0"?>\n'
 505         return header + str(xml)
 506
 507     """
 508     Create a dictionary of site objects keyed by site ID
 509     """
 510     def get_sites(self, api):
 511         tmp = []
 512         for site in api.plshell.GetSites(api.plauth, {'peer_id': None}):
 513             t = site['site_id'], Site(self, site)
 514             tmp.append(t)
 515         return dict(tmp)
 516
 517
 518     """
 519     Create a dictionary of node objects keyed by node ID
 520     """
 521     def get_nodes(self, api):
 522         tmp = []
 523         for node in api.plshell.GetNodes(api.plauth, {'peer_id': None}):
 524             t = node['node_id'], Node(self, node)
 525             tmp.append(t)
 526         return dict(tmp)
 527
 528     """
 529     Create a dictionary of node objects keyed by node ID
 530     """
 531     def get_ifaces(self, api):
 532         tmp = []
 533         for iface in api.plshell.GetInterfaces(api.plauth):
 534             t = iface['interface_id'], Iface(self, iface)
 535             tmp.append(t)
 536         return dict(tmp)
 537
 538     """
 539     Create a dictionary of slicetag objects keyed by slice tag ID
 540     """
 541     def get_slice_tags(self, api):
 542         tmp = []
 543         for tag in api.plshell.GetSliceTags(api.plauth):
 544             t = tag['slice_tag_id'], Slicetag(tag)
 545             tmp.append(t)
 546         return dict(tmp)
 547
 548     """
 549     Create a list of tagtype obects keyed by tag name
 550     """
 551     def get_tag_types(self, api):
 552         tmp = []
 553         for tag in api.plshell.GetTagTypes(api.plauth):
 554             t = tag['tagname'], TagType(tag)
 555             tmp.append(t)
 556         return dict(tmp)
 557
 558     """
 559     Return a Slice object for a single slice
 560     """
 561     def get_slice(self, api, hrn):
 562         slicename = hrn_to_pl_slicename(hrn)
 563         slice = api.plshell.GetSlices(api.plauth, [slicename])
 564         if slice:
 565             self.slice = Slice(self, slicename, slice[0])
 566             return self.slice
 567         else:
 568             return None
 569
 570