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