sfa/plc/network.py

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