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