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 role_id > tt.min_role_id:
 155             raise InvalidRSpec("permission denied to add '%s' tag" % tagname)
 156
 157         tag = Slicetag()
 158         tag.initialize(tagname, value, node, self.network)
 159         self.network.tags[tag.id] = tag
 160         self.slice_tag_ids.append(tag.id)
 161         tag.changed = True
 162         tag.updated = True
 163         tag.writable = True
 164         return tag
 165
 166     # Update a slice tag if it exists, else add it
 167     def update_tag(self, tagname, value, node = None, role_id = 40):
 168         tag = self.get_tag(tagname, node)
 169         if tag and tag.value == value:
 170             value = "no change"
 171         elif tag:
 172             if role_id > tag.min_role_id:
 173                 raise InvalidRSpec("permission denied to update '%s' tag" % tagname)
 174             tag.value = value
 175             tag.changed = True
 176         else:
 177             tag = self.add_tag(tagname, value, node, role_id)
 178         tag.updated = True
 179         tag.writable = True
 180         return tag
 181
 182     def update_multi_tag(self, tagname, value, node = None, role_id = 40):
 183         tags = self.get_multi_tag(tagname, node)
 184         for tag in tags:
 185             if tag and tag.value == value:
 186                 value = "no change"
 187                 break
 188         else:
 189             tag = self.add_tag(tagname, value, node, role_id)
 190         tag.updated = True
 191         tag.writable = True
 192         return tag
 193
 194     def tags_to_xml(self, xml, node = None):
 195         tagtypes = self.network.getTagTypes()
 196         for tt in tagtypes:
 197             if tt.in_rspec:
 198                 if tt.multi:
 199                     tags = self.get_multi_tag(tt.tagname, node)
 200                     for tag in tags:
 201                         if not tag.deleted:  ### Debugging
 202                             xml << (tag.tagname, tag.value)
 203                 else:
 204                     tag = self.get_tag(tt.tagname, node)
 205                     if tag:
 206                         if not tag.deleted:   ### Debugging
 207                             xml << (tag.tagname, tag.value)
 208
 209     def toxml(self, xml):
 210         with xml.sliver_defaults:
 211             self.tags_to_xml(xml)
 212
 213
 214 class Slicetag:
 215     newid = -1
 216     def __init__(self, tag = None):
 217         if not tag:
 218             return
 219         self.id = tag['slice_tag_id']
 220         self.slice_id = tag['slice_id']
 221         self.tagname = tag['tagname']
 222         self.value = tag['value']
 223         self.node_id = tag['node_id']
 224         self.category = tag['category']
 225         self.min_role_id = tag['min_role_id']
 226         self.__init_flags()
 227
 228     # Create a new slicetag that will be written to the DB later
 229     def initialize(self, tagname, value, node, network):
 230         tt = network.lookupTagType(tagname)
 231         self.id = Slicetag.newid
 232         Slicetag.newid -=1
 233         self.slice_id = network.slice.id
 234         self.tagname = tagname
 235         self.value = value
 236         self.node_id = node.id
 237         self.category = tt.category
 238         self.min_role_id = tt.min_role_id
 239         self.__init_flags()
 240
 241     def __init_flags(self):
 242         self.updated = False
 243         self.changed = False
 244         self.deleted = False
 245         self.writable = False
 246         if self.category == 'slice/rspec':
 247             self.writable = True
 248
 249     # Mark a tag as deleted
 250     def delete(self):
 251         self.deleted = True
 252         self.updated = True
 253
 254     def write(self, api):
 255         if not self.writable:
 256             return
 257
 258         if self.changed:
 259             if int(self.id) > 0:
 260                 api.plshell.UpdateSliceTag(api.plauth, self.id, self.value)
 261             else:
 262                 api.plshell.AddSliceTag(api.plauth, self.slice_id,
 263                                         self.tagname, self.value, self.node_id)
 264         elif self.deleted and int(self.id) > 0:
 265             api.plshell.DeleteSliceTag(api.plauth, self.id)
 266
 267
 268 class TagType:
 269     def __init__(self, tagtype):
 270         self.id = tagtype['tag_type_id']
 271         self.category = tagtype['category']
 272         self.tagname = tagtype['tagname']
 273         self.min_role_id = tagtype['min_role_id']
 274         self.multi = False
 275         self.in_rspec = False
 276         if self.category == 'slice/rspec':
 277             self.in_rspec = True
 278         if self.tagname in ['codemux', 'ip_addresses', 'vsys']:
 279             self.multi = True
 280
 281
 282 """
 283 A Network is a compound object consisting of:
 284 * a dictionary mapping site IDs to Site objects
 285 * a dictionary mapping node IDs to Node objects
 286 * a dictionary mapping interface IDs to Iface objects
 287 """
 288 class Network:
 289     def __init__(self, api, type = "PlanetLab"):
 290         self.api = api
 291         self.type = type
 292         self.sites = self.get_sites(api)
 293         self.nodes = self.get_nodes(api)
 294         self.ifaces = self.get_ifaces(api)
 295         self.tags = self.get_slice_tags(api)
 296         self.tagtypes = self.get_tag_types(api)
 297         self.slice = None
 298
 299     """ Lookup site based on id or idtag value """
 300     def lookupSite(self, id):
 301         val = None
 302         if isinstance(id, basestring):
 303             id = int(id.lstrip('s'))
 304         try:
 305             val = self.sites[id]
 306         except:
 307             raise InvalidRSpec("site ID %s not found" % id)
 308         return val
 309
 310     def getSites(self):
 311         sites = []
 312         for s in self.sites:
 313             sites.append(self.sites[s])
 314         return sites
 315
 316     """ Lookup node based on id or idtag value """
 317     def lookupNode(self, id):
 318         val = None
 319         if isinstance(id, basestring):
 320             id = int(id.lstrip('n'))
 321         try:
 322             val = self.nodes[id]
 323         except:
 324             raise InvalidRSpec("node ID %s not found" % id)
 325         return val
 326
 327     def getNodes(self):
 328         nodes = []
 329         for n in self.nodes:
 330             nodes.append(self.nodes[n])
 331         return nodes
 332
 333     """ Lookup iface based on id or idtag value """
 334     def lookupIface(self, id):
 335         val = None
 336         if isinstance(id, basestring):
 337             id = int(id.lstrip('i'))
 338         try:
 339             val = self.ifaces[id]
 340         except:
 341             raise InvalidRSpec("interface ID %s not found" % id)
 342         return val
 343
 344     def getIfaces(self):
 345         ifaces = []
 346         for i in self.ifaces:
 347             ifaces.append(self.ifaces[i])
 348         return ifaces
 349
 350     def nodesWithSlivers(self):
 351         nodes = []
 352         for n in self.nodes:
 353             node = self.nodes[n]
 354             if node.sliver:
 355                 nodes.append(node)
 356         return nodes
 357
 358     def lookupSliceTag(self, id):
 359         val = None
 360         try:
 361             val = self.tags[id]
 362         except:
 363             raise InvalidRSpec("slicetag ID %s not found" % id)
 364         return val
 365
 366     def getSliceTags(self):
 367         tags = []
 368         for t in self.tags:
 369             tags.append(self.tags[t])
 370         return tags
 371
 372     def lookupTagType(self, name):
 373         val = None
 374         try:
 375             val = self.tagtypes[name]
 376         except:
 377             raise InvalidRSpec("tag %s not found" % name)
 378         return val
 379
 380     def getTagTypes(self):
 381         tags = []
 382         for t in self.tagtypes:
 383             tags.append(self.tagtypes[t])
 384         return tags
 385
 386     def __process_attributes(self, element, node=None):
 387         if element is None:
 388             return
 389
 390         # Do we need to check caller's role before update???
 391         tagtypes = self.getTagTypes()
 392         for tt in tagtypes:
 393             if tt.in_rspec:
 394                 if tt.multi:
 395                     for e in element.iterfind("./" + tt.tagname):
 396                         self.slice.update_multi_tag(tt.tagname, e.text, node)
 397                 else:
 398                     e = element.find("./" + tt.tagname)
 399                     if e is not None:
 400                         self.slice.update_tag(tt.tagname, e.text, node)
 401
 402     """
 403     Annotate the objects in the Network with information from the RSpec
 404     """
 405     def addRSpec(self, xml, schema=None):
 406         try:
 407             tree = etree.parse(StringIO(xml))
 408         except etree.XMLSyntaxError:
 409             message = str(sys.exc_info()[1])
 410             raise InvalidRSpec(message)
 411
 412         if schema:
 413             # Validate the incoming request against the RelaxNG schema
 414             relaxng_doc = etree.parse(schema)
 415             relaxng = etree.RelaxNG(relaxng_doc)
 416
 417             if not relaxng(tree):
 418                 error = relaxng.error_log.last_error
 419                 message = "%s (line %s)" % (error.message, error.line)
 420                 raise InvalidRSpec(message)
 421
 422         rspec = tree.getroot()
 423         self.rspec = rspec
 424
 425         defaults = rspec.find("./network/sliver_defaults")
 426         self.__process_attributes(defaults)
 427
 428         # Find slivers under node elements
 429         for sliver in rspec.iterfind("./network/site/node/sliver"):
 430             elem = sliver.getparent()
 431             try:
 432                 node = self.lookupNode(elem.get("id"))
 433             except:
 434                 # Don't worry about nodes from other aggregates
 435                 pass
 436             else:
 437                 node.add_sliver()
 438                 self.__process_attributes(sliver, node)
 439
 440         # Find slivers that specify nodeid
 441         for sliver in rspec.iterfind("./request/sliver[@nodeid]"):
 442             try:
 443                 node = self.lookupNode(sliver.get("nodeid"))
 444             except:
 445                 # Don't worry about nodes from other aggregates
 446                 pass
 447             else:
 448                 node.add_sliver()
 449                 self.__process_attributes(sliver, node)
 450
 451         return
 452
 453     """
 454     Annotate the objects in the Network with information from the slice
 455     """
 456     def addSlice(self):
 457         slice = self.slice
 458         if not slice:
 459             raise InvalidRSpec("no slice associated with network")
 460
 461         for node in slice.get_nodes():
 462             node.add_sliver()
 463
 464     """
 465     Write any slice tags that have been added or modified back to the DB
 466     """
 467     def updateSliceTags(self):
 468         # Update slice tags in database
 469         for tag in self.getSliceTags():
 470             if tag.slice_id == self.slice.id:
 471                 if not tag.updated:
 472                     tag.delete()
 473                 tag.write(self.api)
 474
 475     """
 476     Produce XML directly from the topology specification.
 477     """
 478     def toxml(self):
 479         xml = XMLBuilder(format = True, tab_step = "  ")
 480         with xml.RSpec(type=self.type):
 481             name = "Public_" + self.type
 482             if self.slice:
 483                 element = xml.network(name=name, slice=self.slice.hrn)
 484             else:
 485                 element = xml.network(name=name)
 486
 487             with element:
 488                 if self.slice:
 489                     self.slice.toxml(xml)
 490                 for site in self.getSites():
 491                     site.toxml(xml)
 492
 493         header = '<?xml version="1.0"?>\n'
 494         return header + str(xml)
 495
 496     """
 497     Create a dictionary of site objects keyed by site ID
 498     """
 499     def get_sites(self, api):
 500         tmp = []
 501         for site in api.plshell.GetSites(api.plauth, {'peer_id': None}):
 502             t = site['site_id'], Site(self, site)
 503             tmp.append(t)
 504         return dict(tmp)
 505
 506
 507     """
 508     Create a dictionary of node objects keyed by node ID
 509     """
 510     def get_nodes(self, api):
 511         tmp = []
 512         for node in api.plshell.GetNodes(api.plauth, {'peer_id': None}):
 513             t = node['node_id'], Node(self, node)
 514             tmp.append(t)
 515         return dict(tmp)
 516
 517     """
 518     Create a dictionary of node objects keyed by node ID
 519     """
 520     def get_ifaces(self, api):
 521         tmp = []
 522         for iface in api.plshell.GetInterfaces(api.plauth):
 523             t = iface['interface_id'], Iface(self, iface)
 524             tmp.append(t)
 525         return dict(tmp)
 526
 527     """
 528     Create a dictionary of slicetag objects keyed by slice tag ID
 529     """
 530     def get_slice_tags(self, api):
 531         tmp = []
 532         for tag in api.plshell.GetSliceTags(api.plauth):
 533             t = tag['slice_tag_id'], Slicetag(tag)
 534             tmp.append(t)
 535         return dict(tmp)
 536
 537     """
 538     Create a list of tagtype obects keyed by tag name
 539     """
 540     def get_tag_types(self, api):
 541         tmp = []
 542         for tag in api.plshell.GetTagTypes(api.plauth):
 543             t = tag['tagname'], TagType(tag)
 544             tmp.append(t)
 545         return dict(tmp)
 546
 547     """
 548     Return a Slice object for a single slice
 549     """
 550     def get_slice(self, api, hrn):
 551         slicename = hrn_to_pl_slicename(hrn)
 552         slice = api.plshell.GetSlices(api.plauth, [slicename])
 553         if slice:
 554             self.slice = Slice(self, slicename, slice[0])
 555             return self.slice
 556         else:
 557             return None
 558
 559