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