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     def get_node_element(self, hostname):
  77         names = self.rspec.iterfind("./network/site/node/hostname")
  78         for name in names:
  79             if name.text == hostname:
  80                 return name.getparent()
  81         return None
  82
  83     def get_node_list(self):
  84         result = self.rspec.xpath("./network/site/node/hostname/text()")
  85         return result
  86
  87     def get_network_list(self):
  88         return self.rspec.xpath("./network[@name]/@name")
  89
  90     def get_nodes_from_network(self, network):
  91         return self.rspec.xpath("./network[@name='%s']/site/node/hostname/text()" % network)
  92
  93     def get_sliver_list(self):
  94         result = self.rspec.xpath("./network/site/node[sliver]/hostname/text()")
  95         return result
  96
  97     def add_sliver(self, hostname):
  98         node = self.get_node_element(hostname)
  99         etree.SubElement(node, "sliver")
 100
 101     def remove_sliver(self, hostname):
 102         node = self.get_node_element(hostname)
 103         node.remove(node.find("sliver"))
 104
 105     def attributes_list(self, elem):
 106         opts = []
 107         if elem is not None:
 108             for e in elem:
 109                 opts.append((e.tag, e.text))
 110         return opts
 111
 112     def get_default_sliver_attributes(self):
 113         defaults = self.rspec.find(".//sliver_defaults")
 114         return self.attributes_list(defaults)
 115
 116     def get_sliver_attributes(self, hostname):
 117         node = self.get_node_element(hostname)
 118         sliver = node.find("sliver")
 119         return self.attributes_list(sliver)
 120
 121     def add_attribute(self, elem, name, value):
 122         opt = etree.SubElement(elem, name)
 123         opt.text = value
 124
 125     def add_default_sliver_attribute(self, name, value):
 126         defaults = self.rspec.find(".//sliver_defaults")
 127         if defaults is None:
 128             defaults = etree.Element("sliver_defaults")
 129             network = self.rspec.find(".//network")
 130             network.insert(0, defaults)
 131         self.add_attribute(defaults, name, value)
 132
 133     def add_sliver_attribute(self, hostname, name, value):
 134         node = self.get_node_element(hostname)
 135         sliver = node.find("sliver")
 136         self.add_attribute(sliver, name, value)
 137
 138     def remove_attribute(self, elem, name, value):
 139         if elem is not None:
 140             opts = elem.iterfind(name)
 141             if opts is not None:
 142                 for opt in opts:
 143                     if opt.text == value:
 144                         elem.remove(opt)
 145
 146     def remove_default_sliver_attribute(self, name, value):
 147         defaults = self.rspec.find(".//sliver_defaults")
 148         self.remove_attribute(defaults, name, value)
 149
 150     def remove_sliver_attribute(self, hostname, name, value):
 151         node = self.get_node_element(hostname)
 152         sliver = node.find("sliver")
 153         self.remove_attribute(sliver, name, value)
 154
 155     def get_site_nodes(self, siteid):
 156         query = './/site[@id="%s"]/node/hostname/text()' % siteid
 157         result = self.rspec.xpath(query)
 158         return result
 159
 160     def get_link_list(self):
 161         linklist = []
 162         links = self.rspec.iterfind(".//link")
 163         for link in links:
 164             (end1, end2) = link.get("endpoints").split()
 165             name = link.find("description")
 166             linklist.append((name.text,
 167                              self.get_site_nodes(end1),
 168                              self.get_site_nodes(end2)))
 169         return linklist
 170
 171     def get_vlink_list(self):
 172         vlinklist = []
 173         vlinks = self.rspec.iterfind(".//vlink")
 174         for vlink in vlinks:
 175             endpoints = vlink.get("endpoints")
 176             (end1, end2) = endpoints.split()
 177             query = './/node[@id="%s"]/hostname/text()'
 178             node1 = self.rspec.xpath(query % end1)[0]
 179             node2 = self.rspec.xpath(query % end2)[0]
 180             desc = "%s <--> %s" % (node1, node2)
 181             kbps = vlink.find("kbps")
 182             vlinklist.append((endpoints, desc, kbps.text))
 183         return vlinklist
 184
 185     def query_links(self, fromnode, tonode):
 186         fromsite = fromnode.getparent()
 187         tosite = tonode.getparent()
 188         fromid = fromsite.get("id")
 189         toid = tosite.get("id")
 190
 191         query = ".//link[@endpoints = '%s %s']" % (fromid, toid)
 192         results = self.rspec.xpath(query)
 193         if results == None:
 194             query = ".//link[@endpoints = '%s %s']" % (toid, fromid)
 195             results = self.rspec.xpath(query)
 196         return results
 197
 198     def query_vlinks(self, endpoints):
 199         query = ".//vlink[@endpoints = '%s']" % endpoints
 200         results = self.rspec.xpath(query)
 201         return results
 202
 203
 204     def add_vlink(self, fromhost, tohost, kbps):
 205         fromnode = self.get_node_element(fromhost)
 206         tonode = self.get_node_element(tohost)
 207         links = self.query_links(fromnode, tonode)
 208
 209         for link in links:
 210             vlink = etree.SubElement(link, "vlink")
 211             fromid = fromnode.get("id")
 212             toid = tonode.get("id")
 213             vlink.set("endpoints", "%s %s" % (fromid, toid))
 214             self.add_attribute(vlink, "kbps", kbps)
 215
 216
 217     def remove_vlink(self, endpoints):
 218         vlinks = self.query_vlinks(endpoints)
 219         for vlink in vlinks:
 220             vlink.getparent().remove(vlink)
 221
 222     def toxml(self):
 223         return etree.tostring(self.rspec, pretty_print=True,
 224                               xml_declaration=True)
 225
 226     def __str__(self):
 227         return self.toxml()
 228
 229     def save(self, filename):
 230         f = open(filename, "w")
 231         f.write(self.toxml())
 232         f.close()
 233
 234
 235 class Commands:
 236     def __init__(self, usage, description, epilog=None):
 237         self.parser = OptionParser(usage=usage, description=description,
 238                                    epilog=epilog)
 239         self.parser.add_option("-i", "", dest="infile", metavar="FILE",
 240                                help="read RSpec from FILE (default is stdin)")
 241         self.parser.add_option("-o", "", dest="outfile", metavar="FILE",
 242                                help="write output to FILE (default is stdout)")
 243         self.nodefile = False
 244         self.attributes = {}
 245
 246     def add_nodefile_option(self):
 247         self.nodefile = True
 248         self.parser.add_option("-n", "", dest="nodefile",
 249                                metavar="FILE",
 250                                help="read node list from FILE"),
 251
 252     def add_show_attributes_option(self):
 253         self.parser.add_option("-s", "--show-attributes", action="store_true",
 254                                dest="showatt", default=False,
 255                                help="show sliver attributes")
 256
 257     def add_attribute_options(self):
 258         self.parser.add_option("", "--capabilities", action="append",
 259                                metavar="<cap1,cap2,...>",
 260                                help="Vserver bcapabilities")
 261         self.parser.add_option("", "--codemux", action="append",
 262                                metavar="<host,local-port>",
 263                                help="Demux HTTP between slices using " +
 264                                "localhost ports")
 265         self.parser.add_option("", "--cpu-pct", action="append",
 266                                metavar="<num>",
 267                                help="Reserved CPU percent (e.g., 25)")
 268         self.parser.add_option("", "--cpu-share", action="append",
 269                                metavar="<num>",
 270                                help="Number of CPU shares (e.g., 5)")
 271         self.parser.add_option("", "--delegations",
 272                                metavar="<slice1,slice2,...>", action="append",
 273                                help="List of slices with delegation authority")
 274         self.parser.add_option("", "--disk-max",
 275                                metavar="<num>", action="append",
 276                                help="Disk quota (1k disk blocks)")
 277         self.parser.add_option("", "--initscript",
 278                                metavar="<name>", action="append",
 279                                help="Slice initialization script (e.g., stork)")
 280         self.parser.add_option("", "--ip-addresses", action="append",
 281                                metavar="<IP addr>",
 282                                help="Add an IP address to a sliver")
 283         self.parser.add_option("", "--net-i2-max-kbyte",
 284                                metavar="<KBytes>", action="append",
 285                                help="Maximum daily network Tx limit " +
 286                                "to I2 hosts.")
 287         self.parser.add_option("", "--net-i2-max-rate",
 288                                metavar="<Kbps>", action="append",
 289                                help="Maximum bandwidth over I2 routes")
 290         self.parser.add_option("", "--net-i2-min-rate",
 291                                metavar="<Kbps>", action="append",
 292                                help="Minimum bandwidth over I2 routes")
 293         self.parser.add_option("", "--net-i2-share",
 294                                metavar="<num>", action="append",
 295                                help="Number of bandwidth shares over I2 routes")
 296         self.parser.add_option("", "--net-i2-thresh-kbyte",
 297                                metavar="<KBytes>", action="append",
 298                                help="Limit sent to I2 hosts before warning, " +
 299                                "throttling")
 300         self.parser.add_option("", "--net-max-kbyte",
 301                                metavar="<KBytes>", action="append",
 302                                help="Maximum daily network Tx limit " +
 303                                "to non-I2 hosts.")
 304         self.parser.add_option("", "--net-max-rate",
 305                                metavar="<Kbps>", action="append",
 306                                help="Maximum bandwidth over non-I2 routes")
 307         self.parser.add_option("", "--net-min-rate",
 308                                metavar="<Kbps>", action="append",
 309                                help="Minimum bandwidth over non-I2 routes")
 310         self.parser.add_option("", "--net-share",
 311                                metavar="<num>", action="append",
 312                                help="Number of bandwidth shares over non-I2 " +
 313                                "routes")
 314         self.parser.add_option("", "--net-thresh-kbyte",
 315                                metavar="<KBytes>", action="append",
 316                                help="Limit sent to non-I2 hosts before " +
 317                                "warning, throttling")
 318         self.parser.add_option("", "--vsys",
 319                                metavar="<name>", action="append",
 320                                help="Vsys script (e.g., fd_fusemount)")
 321         self.parser.add_option("", "--vsys-vnet",
 322                                metavar="<IP network>", action="append",
 323                                help="Allocate a virtual private network")
 324
 325     def get_attribute_dict(self):
 326         attrlist = ['capabilities','codemux','cpu_pct','cpu_share',
 327                     'delegations','disk_max','initscript','ip_addresses',
 328                     'net_i2_max_kbyte','net_i2_max_rate','net_i2_min_rate',
 329                     'net_i2_share','net_i2_thresh_kbyte',
 330                     'net_max_kbyte','net_max_rate','net_min_rate',
 331                     'net_share','net_thresh_kbyte',
 332                     'vsys','vsys_vnet']
 333         attrdict = {}
 334         for attr in attrlist:
 335             value = getattr(self.opts, attr, None)
 336             if value is not None:
 337                 attrdict[attr] = value
 338         return attrdict
 339
 340     def prep(self):
 341         (self.opts, self.args) = self.parser.parse_args()
 342
 343         if self.opts.infile:
 344             sys.stdin = open(self.opts.infile, "r")
 345         xml = sys.stdin.read()
 346         self.rspec = RSpec(xml)
 347
 348         if self.nodefile:
 349             if self.opts.nodefile:
 350                 f = open(self.opts.nodefile, "r")
 351                 self.nodes = f.read().split()
 352                 f.close()
 353             else:
 354                 self.nodes = self.args
 355
 356         if self.opts.outfile:
 357             sys.stdout = open(self.opts.outfile, "w")
 358
 359
 360
 361
 362
 363
 364