5 from copy import deepcopy
7 from StringIO import StringIO
8 from optparse import OptionParser
10 from sfa.util.faults import *
11 from sfa.util.sfalogging import sfa_logger
13 def merge_rspecs(rspecs):
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.
18 if not rspecs or not isinstance(rspecs, list):
21 # ugly hack to avoid sending the same info twice, when the call graph has dags
23 def register_network (network):
25 known_networks[network.get('name')]=True
27 sfa_logger().error("merge_rspecs: cannot register network with no name in rspec")
29 def is_registered_network (network):
31 return network.get('name') in known_networks
33 sfa_logger().error("merge_rspecs: cannot retrieve network with no name in rspec")
38 for input_rspec in rspecs:
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)
48 if not root.get("type") in ["SFA"]:
49 sfa_logger().error("merge_rspecs: unexpected type for rspec root, %s"%root.get('type'))
52 # we scan the first input, register all networks
53 # in addition we remove duplicates - needed until everyone runs 1.0-10
55 for network in root.iterfind("./network"):
56 if not is_registered_network(network):
57 register_network(network)
59 # duplicate in the first input - trash it
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)
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()
76 # If there is only one network in the rspec, make it the default
78 networks = self.get_network_list()
79 if len(networks) == 1:
80 self.network = networks[0]
82 def get_node_element(self, hostname, network=None):
84 network = self.network
85 names = self.rspec.iterfind("./network[@name='%s']/site/node/hostname" % network)
87 if name.text == hostname:
88 return name.getparent()
91 # Thierry : I need this to return all nodes in all networks
92 def get_node_list(self, network=None):
93 if network == None and self.network:
94 network = self.network
96 return self.rspec.xpath("./network[@name='%s']/site/node/hostname/text()" % network)
98 return self.rspec.xpath("./network/site/node/hostname/text()")
100 def get_network_list(self):
101 return self.rspec.xpath("./network[@name]/@name")
103 def get_sliver_list(self, network=None):
105 network = self.network
106 result = self.rspec.xpath("./network[@name='%s']/site/node[sliver]/hostname/text()" % network)
109 def get_available_node_list(self, network=None):
111 network = self.network
112 result = self.rspec.xpath("./network[@name='%s']/site/node[not(sliver)]/hostname/text()" % network)
115 def add_sliver(self, hostname, network=None):
117 network = self.network
118 node = self.get_node_element(hostname, network)
119 etree.SubElement(node, "sliver")
121 def remove_sliver(self, hostname, network=None):
123 network = self.network
124 node = self.get_node_element(hostname, network)
125 node.remove(node.find("sliver"))
127 def attributes_list(self, elem):
131 opts.append((e.tag, e.text))
134 def get_default_sliver_attributes(self, network=None):
136 network = self.network
137 defaults = self.rspec.find("./network[@name='%s']/sliver_defaults" % network)
138 return self.attributes_list(defaults)
140 def get_sliver_attributes(self, hostname, network=None):
142 network = self.network
143 node = self.get_node_element(hostname, network)
144 sliver = node.find("sliver")
145 return self.attributes_list(sliver)
147 def add_attribute(self, elem, name, value):
148 opt = etree.SubElement(elem, name)
151 def add_default_sliver_attribute(self, name, value, network=None):
153 network = self.network
154 defaults = self.rspec.find("./network[@name='%s']/sliver_defaults" % network)
156 defaults = etree.Element("sliver_defaults")
157 network = self.rspec.find("./network[@name='%s']" % network)
158 network.insert(0, defaults)
159 self.add_attribute(defaults, name, value)
161 def add_sliver_attribute(self, hostname, name, value, network=None):
163 network = self.network
164 node = self.get_node_element(hostname, network)
165 sliver = node.find("sliver")
166 self.add_attribute(sliver, name, value)
168 def remove_attribute(self, elem, name, value):
170 opts = elem.iterfind(name)
173 if opt.text == value:
176 def remove_default_sliver_attribute(self, name, value, network=None):
178 network = self.network
179 defaults = self.rspec.find("./network[@name='%s']/sliver_defaults" % network)
180 self.remove_attribute(defaults, name, value)
182 def remove_sliver_attribute(self, hostname, name, value, network=None):
184 network = self.network
185 node = self.get_node_element(hostname, network)
186 sliver = node.find("sliver")
187 self.remove_attribute(sliver, name, value)
189 def get_site_nodes(self, siteid, network=None):
191 network = self.network
192 query = './network[@name="%s"]/site[@id="%s"]/node/hostname/text()' % (network, siteid)
193 result = self.rspec.xpath(query)
196 def get_link_list(self, network=None):
198 network = self.network
200 links = self.rspec.iterfind("./network[@name='%s']/link" % network)
202 (end1, end2) = link.get("endpoints").split()
203 name = link.find("description")
204 linklist.append((name.text,
205 self.get_site_nodes(end1, network),
206 self.get_site_nodes(end2, network)))
209 def get_vlink_list(self, network=None):
211 network = self.network
213 vlinks = self.rspec.iterfind("./network[@name='%s']//vlink" % network)
215 endpoints = vlink.get("endpoints")
216 (end1, end2) = endpoints.split()
217 query = './network[@name="%s"]//node[@id="%s"]/hostname/text()' % network
218 node1 = self.rspec.xpath(query % end1)[0]
219 node2 = self.rspec.xpath(query % end2)[0]
220 desc = "%s <--> %s" % (node1, node2)
221 kbps = vlink.find("kbps")
222 vlinklist.append((endpoints, desc, kbps.text))
225 def query_links(self, fromnode, tonode, network=None):
227 network = self.network
228 fromsite = fromnode.getparent()
229 tosite = tonode.getparent()
230 fromid = fromsite.get("id")
231 toid = tosite.get("id")
233 query = "./network[@name='%s']/link[@endpoints = '%s %s']" % (network, fromid, toid)
234 results = self.rspec.xpath(query)
236 query = "./network[@name='%s']/link[@endpoints = '%s %s']" % (network, toid, fromid)
237 results = self.rspec.xpath(query)
240 def query_vlinks(self, endpoints, network=None):
242 network = self.network
243 query = "./network[@name='%s']//vlink[@endpoints = '%s']" % (network, endpoints)
244 results = self.rspec.xpath(query)
248 def add_vlink(self, fromhost, tohost, kbps, network=None):
250 network = self.network
251 fromnode = self.get_node_element(fromhost, network)
252 tonode = self.get_node_element(tohost, network)
253 links = self.query_links(fromnode, tonode, network)
256 vlink = etree.SubElement(link, "vlink")
257 fromid = fromnode.get("id")
258 toid = tonode.get("id")
259 vlink.set("endpoints", "%s %s" % (fromid, toid))
260 self.add_attribute(vlink, "kbps", kbps)
263 def remove_vlink(self, endpoints, network=None):
265 network = self.network
266 vlinks = self.query_vlinks(endpoints, network)
268 vlink.getparent().remove(vlink)
271 return etree.tostring(self.rspec, pretty_print=True,
272 xml_declaration=True)
277 def save(self, filename):
278 f = open(filename, "w")
279 f.write(self.toxml())
284 def __init__(self, usage, description, epilog=None):
285 self.parser = OptionParser(usage=usage, description=description,
287 self.parser.add_option("-i", "", dest="infile", metavar="FILE",
288 help="read RSpec from FILE (default is stdin)")
289 self.parser.add_option("-o", "", dest="outfile", metavar="FILE",
290 help="write output to FILE (default is stdout)")
291 self.nodefile = False
294 def add_nodefile_option(self):
296 self.parser.add_option("-n", "", dest="nodefile",
298 help="read node list from FILE"),
300 def add_show_attributes_option(self):
301 self.parser.add_option("-s", "--show-attributes", action="store_true",
302 dest="showatt", default=False,
303 help="show sliver attributes")
305 def add_attribute_options(self):
306 self.parser.add_option("", "--capabilities", action="append",
307 metavar="<cap1,cap2,...>",
308 help="Vserver bcapabilities")
309 self.parser.add_option("", "--codemux", action="append",
310 metavar="<host,local-port>",
311 help="Demux HTTP between slices using " +
313 self.parser.add_option("", "--cpu-pct", action="append",
315 help="Reserved CPU percent (e.g., 25)")
316 self.parser.add_option("", "--cpu-share", action="append",
318 help="Number of CPU shares (e.g., 5)")
319 self.parser.add_option("", "--delegations",
320 metavar="<slice1,slice2,...>", action="append",
321 help="List of slices with delegation authority")
322 self.parser.add_option("", "--disk-max",
323 metavar="<num>", action="append",
324 help="Disk quota (1k disk blocks)")
325 self.parser.add_option("", "--initscript",
326 metavar="<name>", action="append",
327 help="Slice initialization script (e.g., stork)")
328 self.parser.add_option("", "--ip-addresses", action="append",
330 help="Add an IP address to a sliver")
331 self.parser.add_option("", "--net-i2-max-kbyte",
332 metavar="<KBytes>", action="append",
333 help="Maximum daily network Tx limit " +
335 self.parser.add_option("", "--net-i2-max-rate",
336 metavar="<Kbps>", action="append",
337 help="Maximum bandwidth over I2 routes")
338 self.parser.add_option("", "--net-i2-min-rate",
339 metavar="<Kbps>", action="append",
340 help="Minimum bandwidth over I2 routes")
341 self.parser.add_option("", "--net-i2-share",
342 metavar="<num>", action="append",
343 help="Number of bandwidth shares over I2 routes")
344 self.parser.add_option("", "--net-i2-thresh-kbyte",
345 metavar="<KBytes>", action="append",
346 help="Limit sent to I2 hosts before warning, " +
348 self.parser.add_option("", "--net-max-kbyte",
349 metavar="<KBytes>", action="append",
350 help="Maximum daily network Tx limit " +
352 self.parser.add_option("", "--net-max-rate",
353 metavar="<Kbps>", action="append",
354 help="Maximum bandwidth over non-I2 routes")
355 self.parser.add_option("", "--net-min-rate",
356 metavar="<Kbps>", action="append",
357 help="Minimum bandwidth over non-I2 routes")
358 self.parser.add_option("", "--net-share",
359 metavar="<num>", action="append",
360 help="Number of bandwidth shares over non-I2 " +
362 self.parser.add_option("", "--net-thresh-kbyte",
363 metavar="<KBytes>", action="append",
364 help="Limit sent to non-I2 hosts before " +
365 "warning, throttling")
366 self.parser.add_option("", "--vsys",
367 metavar="<name>", action="append",
368 help="Vsys script (e.g., fd_fusemount)")
369 self.parser.add_option("", "--vsys-vnet",
370 metavar="<IP network>", action="append",
371 help="Allocate a virtual private network")
373 def get_attribute_dict(self):
374 attrlist = ['capabilities','codemux','cpu_pct','cpu_share',
375 'delegations','disk_max','initscript','ip_addresses',
376 'net_i2_max_kbyte','net_i2_max_rate','net_i2_min_rate',
377 'net_i2_share','net_i2_thresh_kbyte',
378 'net_max_kbyte','net_max_rate','net_min_rate',
379 'net_share','net_thresh_kbyte',
382 for attr in attrlist:
383 value = getattr(self.opts, attr, None)
384 if value is not None:
385 attrdict[attr] = value
389 (self.opts, self.args) = self.parser.parse_args()
392 sys.stdin = open(self.opts.infile, "r")
393 xml = sys.stdin.read()
394 self.rspec = RSpec(xml)
397 if self.opts.nodefile:
398 f = open(self.opts.nodefile, "r")
399 self.nodes = f.read().split()
402 self.nodes = self.args
404 if self.opts.outfile:
405 sys.stdout = open(self.opts.outfile, "w")