sfa/util/rspecHelper.py

   1 #! /usr/bin/env python
   2
   3 import sys
   4
   5 from copy import deepcopy
   6 from lxml import etree
   7 from StringIO import StringIO
   8 from optparse import OptionParser
   9
  10 from sfa.util.faults import *
  11 from sfa.util.sfalogging import sfa_logger
  12
  13 def merge_rspecs(rspecs):
  14     """
  15     Merge merge a list of RSpecs into 1 RSpec, and return the result.
  16     rspecs must be a valid RSpec string or list of RSpec strings.
  17     """
  18     if not rspecs or not isinstance(rspecs, list):
  19         return rspecs
  20
  21     # ugly hack to avoid sending the same info twice, when the call graph has dags
  22     known_networks={}
  23     def register_network (network):
  24         try:
  25             known_networks[network.get('name')]=True
  26         except:
  27             sfa_logger().error("merge_rspecs: cannot register network with no name in rspec")
  28             pass
  29     def is_registered_network (network):
  30         try:
  31             return network.get('name') in known_networks
  32         except:
  33             sfa_logger().error("merge_rspecs: cannot retrieve network with no name in rspec")
  34             return False
  35
  36     # the resulting tree
  37     rspec = None
  38     for input_rspec in rspecs:
  39         try:
  40             tree = etree.parse(StringIO(input_rspec))
  41         except etree.XMLSyntaxError:
  42             # consider failing silently here
  43             sfa_logger().log_exc("merge_rspecs, parse error")
  44             message = str(sys.exc_info()[1]) + ' with ' + input_rspec
  45             raise InvalidRSpec(message)
  46
  47         root = tree.getroot()
  48         if not root.get("type") in ["SFA"]:
  49             sfa_logger().error("merge_rspecs: unexpected type for rspec root, %s"%root.get('type'))
  50             continue
  51         if rspec == None:
  52             # we scan the first input, register all networks
  53             # in addition we remove duplicates - needed until everyone runs 1.0-10
  54             rspec = root
  55             for network in root.iterfind("./network"):
  56                 if not is_registered_network(network):
  57                     register_network(network)
  58                 else:
  59                     # duplicate in the first input - trash it
  60                     root.remove(network)
  61         else:
  62             for network in root.iterfind("./network"):
  63                 if not is_registered_network(network):
  64                     rspec.append(deepcopy(network))
  65                     register_network(network)
  66             for request in root.iterfind("./request"):
  67                 rspec.append(deepcopy(request))
  68     return etree.tostring(rspec, xml_declaration=True, pretty_print=True)
  69
  70 class RSpec:
  71     def __init__(self, xml):
  72         parser = etree.XMLParser(remove_blank_text=True)
  73         tree = etree.parse(StringIO(xml), parser)
  74         self.rspec = tree.getroot()
  75
  76         # If there is only one network in the rspec, make it the default
  77         self.network = None
  78         networks = self.get_network_list()
  79         if len(networks) == 1:
  80             self.network = networks[0]
  81
  82     def get_node_element(self, hostname, network=None):
  83         if network == None:
  84             network = self.network
  85         names = self.rspec.iterfind("./network[@name='%s']/site/node/hostname" % network)
  86         for name in names:
  87             if name.text == hostname:
  88                 return name.getparent()
  89         return None
  90
  91     def get_node_list(self, network=None):
  92         if network == None:
  93             network = self.network
  94         result = self.rspec.xpath("./network[@name='%s']/site/node/hostname/text()" % network)
  95         return result
  96
  97     def get_network_list(self):
  98         return self.rspec.xpath("./network[@name]/@name")
  99
 100     def get_sliver_list(self, network=None):
 101         if network == None:
 102             network = self.network
 103         result = self.rspec.xpath("./network[@name='%s']/site/node[sliver]/hostname/text()" % network)
 104         return result
 105
 106     def get_available_node_list(self, network=None):
 107         if network == None:
 108             network = self.network
 109         result = self.rspec.xpath("./network[@name='%s']/site/node[not(sliver)]/hostname/text()" % network)
 110         return result
 111
 112     def add_sliver(self, hostname, network=None):
 113         if network == None:
 114             network = self.network
 115         node = self.get_node_element(hostname, network)
 116         etree.SubElement(node, "sliver")
 117
 118     def remove_sliver(self, hostname, network=None):
 119         if network == None:
 120             network = self.network
 121         node = self.get_node_element(hostname, network)
 122         node.remove(node.find("sliver"))
 123
 124     def attributes_list(self, elem):
 125         opts = []
 126         if elem is not None:
 127             for e in elem:
 128                 opts.append((e.tag, e.text))
 129         return opts
 130
 131     def get_default_sliver_attributes(self, network=None):
 132         if network == None:
 133             network = self.network
 134         defaults = self.rspec.find("./network[@name='%s']/sliver_defaults" % network)
 135         return self.attributes_list(defaults)
 136
 137     def get_sliver_attributes(self, hostname, network=None):
 138         if network == None:
 139             network = self.network
 140         node = self.get_node_element(hostname, network)
 141         sliver = node.find("sliver")
 142         return self.attributes_list(sliver)
 143
 144     def add_attribute(self, elem, name, value):
 145         opt = etree.SubElement(elem, name)
 146         opt.text = value
 147
 148     def add_default_sliver_attribute(self, name, value, network=None):
 149         if network == None:
 150             network = self.network
 151         defaults = self.rspec.find("./network[@name='%s']/sliver_defaults" % network)
 152         if defaults is None:
 153             defaults = etree.Element("sliver_defaults")
 154             network = self.rspec.find("./network[@name='%s']" % network)
 155             network.insert(0, defaults)
 156         self.add_attribute(defaults, name, value)
 157
 158     def add_sliver_attribute(self, hostname, name, value, network=None):
 159         if network == None:
 160             network = self.network
 161         node = self.get_node_element(hostname, network)
 162         sliver = node.find("sliver")
 163         self.add_attribute(sliver, name, value)
 164
 165     def remove_attribute(self, elem, name, value):
 166         if elem is not None:
 167             opts = elem.iterfind(name)
 168             if opts is not None:
 169                 for opt in opts:
 170                     if opt.text == value:
 171                         elem.remove(opt)
 172
 173     def remove_default_sliver_attribute(self, name, value, network=None):
 174         if network == None:
 175             network = self.network
 176         defaults = self.rspec.find("./network[@name='%s']/sliver_defaults" % network)
 177         self.remove_attribute(defaults, name, value)
 178
 179     def remove_sliver_attribute(self, hostname, name, value, network=None):
 180         if network == None:
 181             network = self.network
 182         node = self.get_node_element(hostname, network)
 183         sliver = node.find("sliver")
 184         self.remove_attribute(sliver, name, value)
 185
 186     def get_site_nodes(self, siteid, network=None):
 187         if network == None:
 188             network = self.network
 189         query = './network[@name="%s"]/site[@id="%s"]/node/hostname/text()' % (network, siteid)
 190         result = self.rspec.xpath(query)
 191         return result
 192
 193     def get_link_list(self, network=None):
 194         if network == None:
 195             network = self.network
 196         linklist = []
 197         links = self.rspec.iterfind("./network[@name='%s']/link" % network)
 198         for link in links:
 199             (end1, end2) = link.get("endpoints").split()
 200             name = link.find("description")
 201             linklist.append((name.text,
 202                              self.get_site_nodes(end1, network),
 203                              self.get_site_nodes(end2, network)))
 204         return linklist
 205
 206     def get_vlink_list(self, network=None):
 207         if network == None:
 208             network = self.network
 209         vlinklist = []
 210         vlinks = self.rspec.iterfind("./network[@name='%s']//vlink" % network)
 211         for vlink in vlinks:
 212             endpoints = vlink.get("endpoints")
 213             (end1, end2) = endpoints.split()
 214             query = './network[@name="%s"]//node[@id="%s"]/hostname/text()' % network
 215             node1 = self.rspec.xpath(query % end1)[0]
 216             node2 = self.rspec.xpath(query % end2)[0]
 217             desc = "%s <--> %s" % (node1, node2)
 218             kbps = vlink.find("kbps")
 219             vlinklist.append((endpoints, desc, kbps.text))
 220         return vlinklist
 221
 222     def query_links(self, fromnode, tonode, network=None):
 223         if network == None:
 224             network = self.network
 225         fromsite = fromnode.getparent()
 226         tosite = tonode.getparent()
 227         fromid = fromsite.get("id")
 228         toid = tosite.get("id")
 229
 230         query = "./network[@name='%s']/link[@endpoints = '%s %s']" % (network, fromid, toid)
 231         results = self.rspec.xpath(query)
 232         if results == None:
 233             query = "./network[@name='%s']/link[@endpoints = '%s %s']" % (network, toid, fromid)
 234             results = self.rspec.xpath(query)
 235         return results
 236
 237     def query_vlinks(self, endpoints, network=None):
 238         if network == None:
 239             network = self.network
 240         query = "./network[@name='%s']//vlink[@endpoints = '%s']" % (network, endpoints)
 241         results = self.rspec.xpath(query)
 242         return results
 243
 244
 245     def add_vlink(self, fromhost, tohost, kbps, network=None):
 246         if network == None:
 247             network = self.network
 248         fromnode = self.get_node_element(fromhost, network)
 249         tonode = self.get_node_element(tohost, network)
 250         links = self.query_links(fromnode, tonode, network)
 251
 252         for link in links:
 253             vlink = etree.SubElement(link, "vlink")
 254             fromid = fromnode.get("id")
 255             toid = tonode.get("id")
 256             vlink.set("endpoints", "%s %s" % (fromid, toid))
 257             self.add_attribute(vlink, "kbps", kbps)
 258
 259
 260     def remove_vlink(self, endpoints, network=None):
 261         if network == None:
 262             network = self.network
 263         vlinks = self.query_vlinks(endpoints, network)
 264         for vlink in vlinks:
 265             vlink.getparent().remove(vlink)
 266
 267     def toxml(self):
 268         return etree.tostring(self.rspec, pretty_print=True,
 269                               xml_declaration=True)
 270
 271     def __str__(self):
 272         return self.toxml()
 273
 274     def save(self, filename):
 275         f = open(filename, "w")
 276         f.write(self.toxml())
 277         f.close()
 278
 279
 280 class Commands:
 281     def __init__(self, usage, description, epilog=None):
 282         self.parser = OptionParser(usage=usage, description=description,
 283                                    epilog=epilog)
 284         self.parser.add_option("-i", "", dest="infile", metavar="FILE",
 285                                help="read RSpec from FILE (default is stdin)")
 286         self.parser.add_option("-o", "", dest="outfile", metavar="FILE",
 287                                help="write output to FILE (default is stdout)")
 288         self.nodefile = False
 289         self.attributes = {}
 290
 291     def add_nodefile_option(self):
 292         self.nodefile = True
 293         self.parser.add_option("-n", "", dest="nodefile",
 294                                metavar="FILE",
 295                                help="read node list from FILE"),
 296
 297     def add_show_attributes_option(self):
 298         self.parser.add_option("-s", "--show-attributes", action="store_true",
 299                                dest="showatt", default=False,
 300                                help="show sliver attributes")
 301
 302     def add_attribute_options(self):
 303         self.parser.add_option("", "--capabilities", action="append",
 304                                metavar="<cap1,cap2,...>",
 305                                help="Vserver bcapabilities")
 306         self.parser.add_option("", "--codemux", action="append",
 307                                metavar="<host,local-port>",
 308                                help="Demux HTTP between slices using " +
 309                                "localhost ports")
 310         self.parser.add_option("", "--cpu-pct", action="append",
 311                                metavar="<num>",
 312                                help="Reserved CPU percent (e.g., 25)")
 313         self.parser.add_option("", "--cpu-share", action="append",
 314                                metavar="<num>",
 315                                help="Number of CPU shares (e.g., 5)")
 316         self.parser.add_option("", "--delegations",
 317                                metavar="<slice1,slice2,...>", action="append",
 318                                help="List of slices with delegation authority")
 319         self.parser.add_option("", "--disk-max",
 320                                metavar="<num>", action="append",
 321                                help="Disk quota (1k disk blocks)")
 322         self.parser.add_option("", "--initscript",
 323                                metavar="<name>", action="append",
 324                                help="Slice initialization script (e.g., stork)")
 325         self.parser.add_option("", "--ip-addresses", action="append",
 326                                metavar="<IP addr>",
 327                                help="Add an IP address to a sliver")
 328         self.parser.add_option("", "--net-i2-max-kbyte",
 329                                metavar="<KBytes>", action="append",
 330                                help="Maximum daily network Tx limit " +
 331                                "to I2 hosts.")
 332         self.parser.add_option("", "--net-i2-max-rate",
 333                                metavar="<Kbps>", action="append",
 334                                help="Maximum bandwidth over I2 routes")
 335         self.parser.add_option("", "--net-i2-min-rate",
 336                                metavar="<Kbps>", action="append",
 337                                help="Minimum bandwidth over I2 routes")
 338         self.parser.add_option("", "--net-i2-share",
 339                                metavar="<num>", action="append",
 340                                help="Number of bandwidth shares over I2 routes")
 341         self.parser.add_option("", "--net-i2-thresh-kbyte",
 342                                metavar="<KBytes>", action="append",
 343                                help="Limit sent to I2 hosts before warning, " +
 344                                "throttling")
 345         self.parser.add_option("", "--net-max-kbyte",
 346                                metavar="<KBytes>", action="append",
 347                                help="Maximum daily network Tx limit " +
 348                                "to non-I2 hosts.")
 349         self.parser.add_option("", "--net-max-rate",
 350                                metavar="<Kbps>", action="append",
 351                                help="Maximum bandwidth over non-I2 routes")
 352         self.parser.add_option("", "--net-min-rate",
 353                                metavar="<Kbps>", action="append",
 354                                help="Minimum bandwidth over non-I2 routes")
 355         self.parser.add_option("", "--net-share",
 356                                metavar="<num>", action="append",
 357                                help="Number of bandwidth shares over non-I2 " +
 358                                "routes")
 359         self.parser.add_option("", "--net-thresh-kbyte",
 360                                metavar="<KBytes>", action="append",
 361                                help="Limit sent to non-I2 hosts before " +
 362                                "warning, throttling")
 363         self.parser.add_option("", "--vsys",
 364                                metavar="<name>", action="append",
 365                                help="Vsys script (e.g., fd_fusemount)")
 366         self.parser.add_option("", "--vsys-vnet",
 367                                metavar="<IP network>", action="append",
 368                                help="Allocate a virtual private network")
 369
 370     def get_attribute_dict(self):
 371         attrlist = ['capabilities','codemux','cpu_pct','cpu_share',
 372                     'delegations','disk_max','initscript','ip_addresses',
 373                     'net_i2_max_kbyte','net_i2_max_rate','net_i2_min_rate',
 374                     'net_i2_share','net_i2_thresh_kbyte',
 375                     'net_max_kbyte','net_max_rate','net_min_rate',
 376                     'net_share','net_thresh_kbyte',
 377                     'vsys','vsys_vnet']
 378         attrdict = {}
 379         for attr in attrlist:
 380             value = getattr(self.opts, attr, None)
 381             if value is not None:
 382                 attrdict[attr] = value
 383         return attrdict
 384
 385     def prep(self):
 386         (self.opts, self.args) = self.parser.parse_args()
 387
 388         if self.opts.infile:
 389             sys.stdin = open(self.opts.infile, "r")
 390         xml = sys.stdin.read()
 391         self.rspec = RSpec(xml)
 392
 393         if self.nodefile:
 394             if self.opts.nodefile:
 395                 f = open(self.opts.nodefile, "r")
 396                 self.nodes = f.read().split()
 397                 f.close()
 398             else:
 399                 self.nodes = self.args
 400
 401         if self.opts.outfile:
 402             sys.stdout = open(self.opts.outfile, "w")
 403
 404
 405
 406
 407
 408
 409