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