merged
[sfa.git] / sfa / managers / slice_manager_pl.py
1 #
2 import sys
3 import time,datetime
4 from StringIO import StringIO
5 from types import StringTypes
6 from copy import deepcopy
7 from copy import copy
8 from lxml import etree
9
10 from sfa.util.sfalogging import logger
11 from sfa.util.rspecHelper import merge_rspecs
12 from sfa.util.xrn import Xrn, urn_to_hrn, hrn_to_urn
13 from sfa.util.plxrn import hrn_to_pl_slicename
14 from sfa.util.rspec import *
15 from sfa.util.specdict import *
16 from sfa.util.faults import *
17 from sfa.util.record import SfaRecord
18 from sfa.rspecs.rspec_converter import RSpecConverter
19 from sfa.rspecs.version_manager import VersionManager
20 from sfa.rspecs.rspec import RSpec 
21 from sfa.util.policy import Policy
22 from sfa.util.prefixTree import prefixTree
23 from sfa.util.sfaticket import *
24 from sfa.trust.credential import Credential
25 from sfa.util.threadmanager import ThreadManager
26 import sfa.util.xmlrpcprotocol as xmlrpcprotocol     
27 import sfa.plc.peers as peers
28 from sfa.util.version import version_core
29 from sfa.util.callids import Callids
30
31
32 def _call_id_supported(api, server):
33     """
34     Returns true if server support the optional call_id arg, false otherwise.
35     """
36     server_version = api.get_cached_server_version(server)
37
38     if 'sfa' in server_version:
39         code_tag = server_version['code_tag']
40         code_tag_parts = code_tag.split("-")
41
42         version_parts = code_tag_parts[0].split(".")
43         major, minor = version_parts[0:2]
44         rev = code_tag_parts[1]
45         if int(major) > 1:
46             if int(minor) > 0 or int(rev) > 20:
47                 return True
48     return False
49
50 # we have specialized xmlrpclib.ServerProxy to remember the input url
51 # OTOH it's not clear if we're only dealing with XMLRPCServerProxy instances
52 def get_serverproxy_url (server):
53     try:
54         return server.url
55     except:
56         logger.warning("GetVersion, falling back to xmlrpclib.ServerProxy internals")
57         return server._ServerProxy__host + server._ServerProxy__handler
58
59 def GetVersion(api):
60     # peers explicitly in aggregates.xml
61     peers =dict ([ (peername,get_serverproxy_url(v)) for (peername,v) in api.aggregates.iteritems()
62                    if peername != api.hrn])
63     version_manager = VersionManager()
64     ad_rspec_versions = []
65     request_rspec_versions = []
66     for rspec_version in version_manager.versions:
67         if rspec_version in ['*', 'ad']:
68             request_rspec_versions.append(rspec_version.to_dict())
69         if rspec_version in ['*', 'request']:
70             request_rspec_version.append(rspec_version.to_dict())
71     default_rspec_version = version_manager.get_version("sfa 1").to_dict()
72     xrn=Xrn(api.hrn)
73     version_more = {'interface':'slicemgr',
74                     'hrn' : xrn.get_hrn(),
75                     'urn' : xrn.get_urn(),
76                     'peers': peers,
77                     'request_rspec_versions': request_rspec_versions,
78                     'ad_rspec_versions': ad_rspec_versions,
79                     'default_ad_rspec': default_rspec_version
80                     }
81     sm_version=version_core(version_more)
82     # local aggregate if present needs to have localhost resolved
83     if api.hrn in api.aggregates:
84         local_am_url=get_serverproxy_url(api.aggregates[api.hrn])
85         sm_version['peers'][api.hrn]=local_am_url.replace('localhost',sm_version['hostname'])
86     return sm_version
87
88 def drop_slicemgr_stats(rspec):
89     try:
90         stats_elements = rspec.xml.xpath('//statistics')
91         for node in stats_elements:
92             node.getparent().remove(node)
93     except Exception, e:
94         api.logger.warn("drop_slicemgr_stats failed: %s " % (str(e)))
95
96 def add_slicemgr_stat(rspec, callname, aggname, elapsed, status):
97     try:
98         stats_tags = rspec.xml.xpath('//statistics[@call="%s"]' % callname)
99         if stats_tags:
100             stats_tag = stats_tags[0]
101         else:
102             stats_tag = etree.SubElement(rspec.xml.root, "statistics", call=callname)
103
104         etree.SubElement(stats_tag, "aggregate", name=str(aggname), elapsed=str(elapsed), status=str(status))
105     except Exception, e:
106         api.logger.warn("add_slicemgr_stat failed on  %s: %s" %(aggname, str(e)))
107
108 def ListResources(api, creds, options, call_id):
109     version_manager = VersionManager()
110     def _ListResources(aggregate, server, credential, opts, call_id):
111
112         my_opts = copy(opts)
113         args = [credential, my_opts]
114         tStart = time.time()
115         try:
116             if _call_id_supported(api, server):
117                 args.append(call_id)
118             version = api.get_cached_server_version(server)
119             # force ProtoGENI aggregates to give us a v2 RSpec
120             if 'sfa' not in version.keys():
121                 my_opts['rspec_version'] = version_manager.get_version('ProtoGENI 2').to_dict()
122             rspec = server.ListResources(*args)
123             return {"aggregate": aggregate, "rspec": rspec, "elapsed": time.time()-tStart, "status": "success"}
124         except Exception, e:
125             api.logger.log_exc("ListResources failed at %s: %s" %(server.url))
126             return {"aggregate": aggregate, "elapsed": time.time()-tStart, "status": "exception"}
127
128     if Callids().already_handled(call_id): return ""
129
130     # get slice's hrn from options
131     xrn = options.get('geni_slice_urn', '')
132     (hrn, type) = urn_to_hrn(xrn)
133     if 'geni_compressed' in options:
134         del(options['geni_compressed'])
135
136     # get the rspec's return format from options
137     rspec_version = version_manager.get_version(options.get('rspec_version'))
138     version_string = "rspec_%s" % (rspec_version.to_string())
139
140     # look in cache first
141     if caching and api.cache and not xrn:
142         rspec =  api.cache.get(version_string)
143         if rspec:
144             return rspec
145
146     # get the callers hrn
147     valid_cred = api.auth.checkCredentials(creds, 'listnodes', hrn)[0]
148     caller_hrn = Credential(string=valid_cred).get_gid_caller().get_hrn()
149
150     # attempt to use delegated credential first
151     credential = api.getDelegatedCredential(creds)
152     if not credential:
153         credential = api.getCredential()
154     credentials = [credential]
155     threads = ThreadManager()
156     for aggregate in api.aggregates:
157         # prevent infinite loop. Dont send request back to caller
158         # unless the caller is the aggregate's SM
159         if caller_hrn == aggregate and aggregate != api.hrn:
160             continue
161
162         # get the rspec from the aggregate
163         server = api.aggregates[aggregate]
164         threads.run(_ListResources, aggregate, server, credentials, options, call_id)
165
166     results = threads.get_results()
167     rspec_version = version_manager.get_version(options.get('rspec_version'))
168     if xrn:    
169         result_version = version_manager._get_version(rspec_version.type, rspec_version.version, 'manifest')
170     else: 
171         result_version = version_manager._get_version(rspec_version.type, rspec_version.version, 'ad')
172     rspec = RSpec(version=result_version)
173     for result in results:
174         add_slicemgr_stat(rspec, "ListResources", result["aggregate"], result["elapsed"], result["status"])
175         if result["status"]=="success":
176             try:
177                 rspec.version.merge(result["rspec"])
178             except:
179                 api.logger.log_exc("SM.ListResources: Failed to merge aggregate rspec")
180
181     # cache the result
182     if caching and api.cache and not xrn:
183         api.cache.add(version_string, rspec.toxml())
184
185     return rspec.toxml()
186
187
188 def CreateSliver(api, xrn, creds, rspec_str, users, call_id):
189
190     version_manager = VersionManager()
191     def _CreateSliver(aggregate, server, xrn, credential, rspec, users, call_id):
192         tStart = time.time()
193         try:
194             # Need to call GetVersion at an aggregate to determine the supported
195             # rspec type/format beofre calling CreateSliver at an Aggregate.
196             server_version = api.get_cached_server_version(server)
197             requested_users = users
198             if 'sfa' not in server_version and 'geni_api' in server_version:
199                 # sfa aggregtes support both sfa and pg rspecs, no need to convert
200                 # if aggregate supports sfa rspecs. otherwise convert to pg rspec
201                 rspec = RSpecConverter.to_pg_rspec(rspec, 'request')
202                 requested_users = sfa_to_pg_users(users)
203             args = [xrn, credential, rspec, requested_users]
204             if _call_id_supported(api, server):
205                 args.append(call_id)
206             rspec = server.CreateSliver(*args)
207             return {"aggregate": aggregate, "rspec": rspec, "elapsed": time.time()-tStart, "status": "success"}
208         except: 
209             logger.log_exc('Something wrong in _CreateSliver with URL %s'%server.url)
210             return {"aggregate": aggregate, "elapsed": time.time()-tStart, "status": "exception"}
211
212     if Callids().already_handled(call_id): return ""
213     # Validate the RSpec against PlanetLab's schema --disabled for now
214     # The schema used here needs to aggregate the PL and VINI schemas
215     # schema = "/var/www/html/schemas/pl.rng"
216     rspec = RSpec(rspec_str)
217     schema = None
218     if schema:
219         rspec.validate(schema)
220
221     # if there is a <statistics> section, the aggregates don't care about it,
222     # so delete it.
223     drop_slicemgr_stats(rspec)
224
225     # attempt to use delegated credential first
226     credential = api.getDelegatedCredential(creds)
227     if not credential:
228         credential = api.getCredential()
229
230     # get the callers hrn
231     hrn, type = urn_to_hrn(xrn)
232     valid_cred = api.auth.checkCredentials(creds, 'createsliver', hrn)[0]
233     caller_hrn = Credential(string=valid_cred).get_gid_caller().get_hrn()
234     threads = ThreadManager()
235     for aggregate in api.aggregates:
236         # prevent infinite loop. Dont send request back to caller
237         # unless the caller is the aggregate's SM 
238         if caller_hrn == aggregate and aggregate != api.hrn:
239             continue
240         server = api.aggregates[aggregate]
241         # Just send entire RSpec to each aggregate
242         threads.run(_CreateSliver, aggregate, server, xrn, credential, rspec.toxml(), users, call_id)
243             
244     results = threads.get_results()
245     manifest_version = version_manager._get_version(rspec.version.type, rspec.version.version, 'manifest')
246     result_rspec = RSpec(version=manifest_version)
247     for result in results:
248         add_slicemgr_stat(result_rspec, "CreateSliver", result["aggregate"], result["elapsed"], result["status"])
249         if result["status"]=="success":
250             try:
251                 result_rspec.version.merge(result["rspec"])
252             except:
253                 api.logger.log_exc("SM.CreateSliver: Failed to merge aggregate rspec")
254     return result_rspec.toxml()
255
256 def RenewSliver(api, xrn, creds, expiration_time, call_id):
257     def _RenewSliver(server, xrn, creds, expiration_time, call_id):
258         server_version = api.get_cached_server_version(server)
259         args =  [xrn, creds, expiration_time, call_id]
260         if _call_id_supported(api, server):
261             args.append(call_id)
262         return server.RenewSliver(*args)
263
264     if Callids().already_handled(call_id): return True
265
266     (hrn, type) = urn_to_hrn(xrn)
267     # get the callers hrn
268     valid_cred = api.auth.checkCredentials(creds, 'renewsliver', hrn)[0]
269     caller_hrn = Credential(string=valid_cred).get_gid_caller().get_hrn()
270
271     # attempt to use delegated credential first
272     credential = api.getDelegatedCredential(creds)
273     if not credential:
274         credential = api.getCredential()
275     threads = ThreadManager()
276     for aggregate in api.aggregates:
277         # prevent infinite loop. Dont send request back to caller
278         # unless the caller is the aggregate's SM
279         if caller_hrn == aggregate and aggregate != api.hrn:
280             continue
281         server = api.aggregates[aggregate]
282         threads.run(_RenewSliver, server, xrn, [credential], expiration_time, call_id)
283     # 'and' the results
284     return reduce (lambda x,y: x and y, threads.get_results() , True)
285
286 def DeleteSliver(api, xrn, creds, call_id):
287     def _DeleteSliver(server, xrn, creds, call_id):
288         server_version = api.get_cached_server_version(server)
289         args =  [xrn, creds]
290         if _call_id_supported(api, server):
291             args.append(call_id)
292         return server.DeleteSliver(*args)
293
294     if Callids().already_handled(call_id): return ""
295     (hrn, type) = urn_to_hrn(xrn)
296     # get the callers hrn
297     valid_cred = api.auth.checkCredentials(creds, 'deletesliver', hrn)[0]
298     caller_hrn = Credential(string=valid_cred).get_gid_caller().get_hrn()
299
300     # attempt to use delegated credential first
301     credential = api.getDelegatedCredential(creds)
302     if not credential:
303         credential = api.getCredential()
304     threads = ThreadManager()
305     for aggregate in api.aggregates:
306         # prevent infinite loop. Dont send request back to caller
307         # unless the caller is the aggregate's SM
308         if caller_hrn == aggregate and aggregate != api.hrn:
309             continue
310         server = api.aggregates[aggregate]
311         threads.run(_DeleteSliver, server, xrn, credential, call_id)
312     threads.get_results()
313     return 1
314
315
316 # first draft at a merging SliverStatus
317 def SliverStatus(api, slice_xrn, creds, call_id):
318     def _SliverStatus(server, xrn, creds, call_id):
319         server_version = api.get_cached_server_version(server)
320         args =  [xrn, creds]
321         if _call_id_supported(api, server):
322             args.append(call_id)
323         return server.SliverStatus(*args)
324     
325     if Callids().already_handled(call_id): return {}
326     # attempt to use delegated credential first
327     credential = api.getDelegatedCredential(creds)
328     if not credential:
329         credential = api.getCredential()
330     threads = ThreadManager()
331     for aggregate in api.aggregates:
332         server = api.aggregates[aggregate]
333         threads.run (_SliverStatus, server, slice_xrn, credential, call_id)
334     results = threads.get_results()
335
336     # get rid of any void result - e.g. when call_id was hit where by convention we return {}
337     results = [ result for result in results if result and result['geni_resources']]
338
339     # do not try to combine if there's no result
340     if not results : return {}
341
342     # otherwise let's merge stuff
343     overall = {}
344
345     # mmh, it is expected that all results carry the same urn
346     overall['geni_urn'] = results[0]['geni_urn']
347     overall['pl_login'] = results[0]['pl_login']
348     # append all geni_resources
349     overall['geni_resources'] = \
350         reduce (lambda x,y: x+y, [ result['geni_resources'] for result in results] , [])
351     overall['status'] = 'unknown'
352     if overall['geni_resources']:
353         overall['status'] = 'ready'
354
355     return overall
356
357 caching=True
358 #caching=False
359 def ListSlices(api, creds, call_id):
360     def _ListSlices(server, creds, call_id):
361         server_version = api.get_cached_server_version(server)
362         args =  [creds]
363         if _call_id_supported(api, server):
364             args.append(call_id)
365         return server.ListSlices(*args)
366
367     if Callids().already_handled(call_id): return []
368
369     # look in cache first
370     if caching and api.cache:
371         slices = api.cache.get('slices')
372         if slices:
373             return slices
374
375     # get the callers hrn
376     valid_cred = api.auth.checkCredentials(creds, 'listslices', None)[0]
377     caller_hrn = Credential(string=valid_cred).get_gid_caller().get_hrn()
378
379     # attempt to use delegated credential first
380     credential = api.getDelegatedCredential(creds)
381     if not credential:
382         credential = api.getCredential()
383     threads = ThreadManager()
384     # fetch from aggregates
385     for aggregate in api.aggregates:
386         # prevent infinite loop. Dont send request back to caller
387         # unless the caller is the aggregate's SM
388         if caller_hrn == aggregate and aggregate != api.hrn:
389             continue
390         server = api.aggregates[aggregate]
391         threads.run(_ListSlices, server, credential, call_id)
392
393     # combime results
394     results = threads.get_results()
395     slices = []
396     for result in results:
397         slices.extend(result)
398
399     # cache the result
400     if caching and api.cache:
401         api.cache.add('slices', slices)
402
403     return slices
404
405
406 def get_ticket(api, xrn, creds, rspec, users):
407     slice_hrn, type = urn_to_hrn(xrn)
408     # get the netspecs contained within the clients rspec
409     aggregate_rspecs = {}
410     tree= etree.parse(StringIO(rspec))
411     elements = tree.findall('./network')
412     for element in elements:
413         aggregate_hrn = element.values()[0]
414         aggregate_rspecs[aggregate_hrn] = rspec 
415
416     # get the callers hrn
417     valid_cred = api.auth.checkCredentials(creds, 'getticket', slice_hrn)[0]
418     caller_hrn = Credential(string=valid_cred).get_gid_caller().get_hrn()
419
420     # attempt to use delegated credential first
421     credential = api.getDelegatedCredential(creds)
422     if not credential:
423         credential = api.getCredential() 
424     threads = ThreadManager()
425     for (aggregate, aggregate_rspec) in aggregate_rspecs.iteritems():
426         # prevent infinite loop. Dont send request back to caller
427         # unless the caller is the aggregate's SM
428         if caller_hrn == aggregate and aggregate != api.hrn:
429             continue
430         server = None
431         if aggregate in api.aggregates:
432             server = api.aggregates[aggregate]
433         else:
434             net_urn = hrn_to_urn(aggregate, 'authority')     
435             # we may have a peer that knows about this aggregate
436             for agg in api.aggregates:
437                 target_aggs = api.aggregates[agg].get_aggregates(credential, net_urn)
438                 if not target_aggs or not 'hrn' in target_aggs[0]:
439                     continue
440                 # send the request to this address 
441                 url = target_aggs[0]['url']
442                 server = xmlrpcprotocol.get_server(url, api.key_file, api.cert_file, timeout=30)
443                 # aggregate found, no need to keep looping
444                 break   
445         if server is None:
446             continue 
447         threads.run(server.GetTicket, xrn, credential, aggregate_rspec, users)
448
449     results = threads.get_results()
450     
451     # gather information from each ticket 
452     rspecs = []
453     initscripts = []
454     slivers = [] 
455     object_gid = None  
456     for result in results:
457         agg_ticket = SfaTicket(string=result)
458         attrs = agg_ticket.get_attributes()
459         if not object_gid:
460             object_gid = agg_ticket.get_gid_object()
461         rspecs.append(agg_ticket.get_rspec())
462         initscripts.extend(attrs.get('initscripts', [])) 
463         slivers.extend(attrs.get('slivers', [])) 
464     
465     # merge info
466     attributes = {'initscripts': initscripts,
467                  'slivers': slivers}
468     merged_rspec = merge_rspecs(rspecs) 
469
470     # create a new ticket
471     ticket = SfaTicket(subject = slice_hrn)
472     ticket.set_gid_caller(api.auth.client_gid)
473     ticket.set_issuer(key=api.key, subject=api.hrn)
474     ticket.set_gid_object(object_gid)
475     ticket.set_pubkey(object_gid.get_pubkey())
476     #new_ticket.set_parent(api.auth.hierarchy.get_auth_ticket(auth_hrn))
477     ticket.set_attributes(attributes)
478     ticket.set_rspec(merged_rspec)
479     ticket.encode()
480     ticket.sign()          
481     return ticket.save_to_string(save_parents=True)
482
483 def start_slice(api, xrn, creds):
484     hrn, type = urn_to_hrn(xrn)
485
486     # get the callers hrn
487     valid_cred = api.auth.checkCredentials(creds, 'startslice', hrn)[0]
488     caller_hrn = Credential(string=valid_cred).get_gid_caller().get_hrn()
489
490     # attempt to use delegated credential first
491     credential = api.getDelegatedCredential(creds)
492     if not credential:
493         credential = api.getCredential()
494     threads = ThreadManager()
495     for aggregate in api.aggregates:
496         # prevent infinite loop. Dont send request back to caller
497         # unless the caller is the aggregate's SM
498         if caller_hrn == aggregate and aggregate != api.hrn:
499             continue
500         server = api.aggregates[aggregate]
501         threads.run(server.Start, xrn, credential)
502     threads.get_results()    
503     return 1
504  
505 def stop_slice(api, xrn, creds):
506     hrn, type = urn_to_hrn(xrn)
507
508     # get the callers hrn
509     valid_cred = api.auth.checkCredentials(creds, 'stopslice', hrn)[0]
510     caller_hrn = Credential(string=valid_cred).get_gid_caller().get_hrn()
511
512     # attempt to use delegated credential first
513     credential = api.getDelegatedCredential(creds)
514     if not credential:
515         credential = api.getCredential()
516     threads = ThreadManager()
517     for aggregate in api.aggregates:
518         # prevent infinite loop. Dont send request back to caller
519         # unless the caller is the aggregate's SM
520         if caller_hrn == aggregate and aggregate != api.hrn:
521             continue
522         server = api.aggregates[aggregate]
523         threads.run(server.Stop, xrn, credential)
524     threads.get_results()    
525     return 1
526
527 def reset_slice(api, xrn):
528     """
529     Not implemented
530     """
531     return 1
532
533 def shutdown(api, xrn, creds):
534     """
535     Not implemented   
536     """
537     return 1
538
539 def status(api, xrn, creds):
540     """
541     Not implemented 
542     """
543     return 1
544
545 def main():
546     r = RSpec()
547     r.parseFile(sys.argv[1])
548     rspec = r.toDict()
549     CreateSliver(None,'plc.princeton.tmacktestslice',rspec,'create-slice-tmacktestslice')
550
551 if __name__ == "__main__":
552     main()
553