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         if node:
 225             self.node_id = node.id
 226         else:
 227             self.node_id = None
 228         self.category = tt.category
 229         self.min_role_id = tt.min_role_id
 230         self.status = "new"
 231
 232     def permit_update(self, role_id, value = None):
 233         if value and self.value == value:
 234             return True
 235         if role_id > self.min_role_id:
 236             return False
 237         return True
 238
 239     def change(self, value):
 240         if self.value != value:
 241             self.value = value
 242             self.status = "change"
 243         else:
 244             self.status = "updated"
 245
 246     # Mark a tag as deleted
 247     def delete(self):
 248         self.status = "delete"
 249
 250     def was_added(self):
 251         return (self.id < 0)
 252
 253     def was_changed(self):
 254         return (self.status == "change")
 255
 256     def was_deleted(self):
 257         return (self.status == "delete")
 258
 259     def was_updated(self):
 260         return (self.status != None)
 261
 262     def write(self, api):
 263         if self.was_added():
 264             api.plshell.AddSliceTag(api.plauth, self.slice_id,
 265                                     self.tagname, self.value, self.node_id)
 266         elif self.was_changed():
 267             api.plshell.UpdateSliceTag(api.plauth, self.id, self.value)
 268         elif self.was_deleted():
 269             api.plshell.DeleteSliceTag(api.plauth, self.id)
 270
 271
 272 class TagType:
 273     def __init__(self, tagtype):
 274         self.id = tagtype['tag_type_id']
 275         self.category = tagtype['category']
 276         self.tagname = tagtype['tagname']
 277         self.min_role_id = tagtype['min_role_id']
 278         self.multi = False
 279         self.in_rspec = False
 280         if self.category == 'slice/rspec':
 281             self.in_rspec = True
 282         if self.tagname in ['codemux', 'ip_addresses', 'vsys']:
 283             self.multi = True
 284
 285     def permit_update(self, role_id):
 286         if role_id > self.min_role_id:
 287             return False
 288         return True
 289
 290
 291 """
 292 A Network is a compound object consisting of:
 293 * a dictionary mapping site IDs to Site objects
 294 * a dictionary mapping node IDs to Node objects
 295 * a dictionary mapping interface IDs to Iface objects
 296 """
 297 class Network:
 298     def __init__(self, api, type = "SFA"):
 299         self.api = api
 300         self.type = type
 301         self.sites = self.get_sites(api)
 302         self.nodes = self.get_nodes(api)
 303         self.ifaces = self.get_ifaces(api)
 304         self.tags = self.get_slice_tags(api)
 305         self.tagtypes = self.get_tag_types(api)
 306         self.slice = None
 307
 308     """ Lookup site based on id or idtag value """
 309     def lookupSite(self, id):
 310         val = None
 311         if isinstance(id, basestring):
 312             id = int(id.lstrip('s'))
 313         try:
 314             val = self.sites[id]
 315         except:
 316             raise InvalidRSpec("site ID %s not found" % id)
 317         return val
 318
 319     def getSites(self):
 320         sites = []
 321         for s in self.sites:
 322             sites.append(self.sites[s])
 323         return sites
 324
 325     """ Lookup node based on id or idtag value """
 326     def lookupNode(self, id):
 327         val = None
 328         if isinstance(id, basestring):
 329             id = int(id.lstrip('n'))
 330         try:
 331             val = self.nodes[id]
 332         except:
 333             raise InvalidRSpec("node ID %s not found" % id)
 334         return val
 335
 336     def getNodes(self):
 337         nodes = []
 338         for n in self.nodes:
 339             nodes.append(self.nodes[n])
 340         return nodes
 341
 342     """ Lookup iface based on id or idtag value """
 343     def lookupIface(self, id):
 344         val = None
 345         if isinstance(id, basestring):
 346             id = int(id.lstrip('i'))
 347         try:
 348             val = self.ifaces[id]
 349         except:
 350             raise InvalidRSpec("interface ID %s not found" % id)
 351         return val
 352
 353     def getIfaces(self):
 354         ifaces = []
 355         for i in self.ifaces:
 356             ifaces.append(self.ifaces[i])
 357         return ifaces
 358
 359     def nodesWithSlivers(self):
 360         nodes = []
 361         for n in self.nodes:
 362             node = self.nodes[n]
 363             if node.sliver:
 364                 nodes.append(node)
 365         return nodes
 366
 367     def lookupSliceTag(self, id):
 368         val = None
 369         try:
 370             val = self.tags[id]
 371         except:
 372             raise InvalidRSpec("slicetag ID %s not found" % id)
 373         return val
 374
 375     def getSliceTags(self):
 376         tags = []
 377         for t in self.tags:
 378             tags.append(self.tags[t])
 379         return tags
 380
 381     def lookupTagType(self, name):
 382         val = None
 383         try:
 384             val = self.tagtypes[name]
 385         except:
 386             raise InvalidRSpec("tag %s not found" % name)
 387         return val
 388
 389     def getTagTypes(self):
 390         tags = []
 391         for t in self.tagtypes:
 392             tags.append(self.tagtypes[t])
 393         return tags
 394
 395     """
 396     Process the elements under <sliver_defaults> or <sliver>
 397     """
 398     def __process_attributes(self, element, node=None):
 399         if element is None:
 400             return
 401
 402         tagtypes = self.getTagTypes()
 403         for tt in tagtypes:
 404             if tt.in_rspec:
 405                 if tt.multi:
 406                     for e in element.iterfind("./" + tt.tagname):
 407                         self.slice.update_multi_tag(tt.tagname, e.text, node)
 408                 else:
 409                     e = element.find("./" + tt.tagname)
 410                     if e is not None:
 411                         self.slice.update_tag(tt.tagname, e.text, node)
 412
 413     """
 414     Annotate the objects in the Network with information from the RSpec
 415     """
 416     def addRSpec(self, xml, schema=None):
 417         try:
 418             tree = etree.parse(StringIO(xml))
 419         except etree.XMLSyntaxError:
 420             message = str(sys.exc_info()[1])
 421             raise InvalidRSpec(message)
 422
 423         # Filter out stuff that's not for us
 424         rspec = tree.getroot()
 425         for network in rspec.iterfind("./network"):
 426             if network.get("name") != self.api.hrn:
 427                 rspec.remove(network)
 428         for request in rspec.iterfind("./request"):
 429             if request.get("name") != self.api.hrn:
 430                 rspec.remove(request)
 431
 432         if schema:
 433             # Validate the incoming request against the RelaxNG schema
 434             relaxng_doc = etree.parse(schema)
 435             relaxng = etree.RelaxNG(relaxng_doc)
 436
 437             if not relaxng(tree):
 438                 error = relaxng.error_log.last_error
 439                 message = "%s (line %s)" % (error.message, error.line)
 440                 raise InvalidRSpec(message)
 441
 442         self.rspec = rspec
 443
 444         defaults = rspec.find(".//sliver_defaults")
 445         self.__process_attributes(defaults)
 446
 447         # Find slivers under node elements
 448         for sliver in rspec.iterfind("./network/site/node/sliver"):
 449             elem = sliver.getparent()
 450             try:
 451                 node = self.lookupNode(elem.get("id"))
 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         # Find slivers that specify nodeid
 460         for sliver in rspec.iterfind("./request/sliver[@nodeid]"):
 461             try:
 462                 node = self.lookupNode(sliver.get("nodeid"))
 463             except:
 464                 # Don't worry about nodes from other aggregates
 465                 pass
 466             else:
 467                 node.add_sliver()
 468                 self.__process_attributes(sliver, node)
 469
 470         return
 471
 472     """
 473     Annotate the objects in the Network with information from the slice
 474     """
 475     def addSlice(self):
 476         slice = self.slice
 477         if not slice:
 478             raise InvalidRSpec("no slice associated with network")
 479
 480         for node in slice.get_nodes():
 481             node.add_sliver()
 482
 483     """
 484     Write any slice tags that have been added or modified back to the DB
 485     """
 486     def updateSliceTags(self):
 487         for tag in self.getSliceTags():
 488             if tag.category == 'slice/rspec' and not tag.was_updated() and tag.permit_update(None, 40):
 489                 # The user wants to delete this tag
 490                 tag.delete()
 491
 492         # Update slice tags in database
 493         for tag in self.getSliceTags():
 494             if tag.slice_id == self.slice.id:
 495                 tag.write(self.api)
 496
 497     """
 498     Produce XML directly from the topology specification.
 499     """
 500     def toxml(self):
 501         xml = XMLBuilder(format = True, tab_step = "  ")
 502         with xml.RSpec(type=self.type):
 503             if self.slice:
 504                 element = xml.network(name=self.api.hrn, slice=self.slice.hrn)
 505             else:
 506                 element = xml.network(name=self.api.hrn)
 507
 508             with element:
 509                 if self.slice:
 510                     self.slice.toxml(xml)
 511                 for site in self.getSites():
 512                     site.toxml(xml)
 513
 514         header = '<?xml version="1.0"?>\n'
 515         return header + str(xml)
 516
 517     """
 518     Create a dictionary of site objects keyed by site ID
 519     """
 520     def get_sites(self, api):
 521         tmp = []
 522         for site in api.plshell.GetSites(api.plauth, {'peer_id': None}):
 523             t = site['site_id'], Site(self, site)
 524             tmp.append(t)
 525         return dict(tmp)
 526
 527
 528     """
 529     Create a dictionary of node objects keyed by node ID
 530     """
 531     def get_nodes(self, api):
 532         tmp = []
 533         for node in api.plshell.GetNodes(api.plauth, {'peer_id': None}):
 534             t = node['node_id'], Node(self, node)
 535             tmp.append(t)
 536         return dict(tmp)
 537
 538     """
 539     Create a dictionary of node objects keyed by node ID
 540     """
 541     def get_ifaces(self, api):
 542         tmp = []
 543         for iface in api.plshell.GetInterfaces(api.plauth):
 544             t = iface['interface_id'], Iface(self, iface)
 545             tmp.append(t)
 546         return dict(tmp)
 547
 548     """
 549     Create a dictionary of slicetag objects keyed by slice tag ID
 550     """
 551     def get_slice_tags(self, api):
 552         tmp = []
 553         for tag in api.plshell.GetSliceTags(api.plauth):
 554             t = tag['slice_tag_id'], Slicetag(tag)
 555             tmp.append(t)
 556         return dict(tmp)
 557
 558     """
 559     Create a list of tagtype obects keyed by tag name
 560     """
 561     def get_tag_types(self, api):
 562         tmp = []
 563         for tag in api.plshell.GetTagTypes(api.plauth):
 564             t = tag['tagname'], TagType(tag)
 565             tmp.append(t)
 566         return dict(tmp)
 567
 568     """
 569     Return a Slice object for a single slice
 570     """
 571     def get_slice(self, api, hrn):
 572         slicename = hrn_to_pl_slicename(hrn)
 573         slice = api.plshell.GetSlices(api.plauth, [slicename])
 574         if len(slice):
 575             self.slice = Slice(self, slicename, slice[0])
 576             return self.slice
 577         else:
 578             return None
 579
 580