df598fd641878366ab832f099ac7f084b3b6865c
[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                 requested_users = sfa_to_pg_users_arg(users)
206             args = [xrn, credential, rspec, requested_users]
207             if _call_id_supported(api, server):
208                 args.append(call_id)
209             rspec = server.CreateSliver(*args)
210             return {"aggregate": aggregate, "rspec": rspec, "elapsed": time.time()-tStart, "status": "success"}
211         except: 
212             logger.log_exc('Something wrong in _CreateSliver with URL %s'%server.url)
213             return {"aggregate": aggregate, "elapsed": time.time()-tStart, "status": "exception"}
214
215     if Callids().already_handled(call_id): return ""
216     # Validate the RSpec against PlanetLab's schema --disabled for now
217     # The schema used here needs to aggregate the PL and VINI schemas
218     # schema = "/var/www/html/schemas/pl.rng"
219     rspec = RSpec(rspec_str)
220     schema = None
221     if schema:
222         rspec.validate(schema)
223
224     # if there is a <statistics> section, the aggregates don't care about it,
225     # so delete it.
226     drop_slicemgr_stats(rspec)
227
228     # attempt to use delegated credential first
229     credential = api.getDelegatedCredential(creds)
230     if not credential:
231         credential = api.getCredential()
232
233     # get the callers hrn
234     hrn, type = urn_to_hrn(xrn)
235     valid_cred = api.auth.checkCredentials(creds, 'createsliver', hrn)[0]
236     caller_hrn = Credential(string=valid_cred).get_gid_caller().get_hrn()
237     threads = ThreadManager()
238     for aggregate in api.aggregates:
239         # prevent infinite loop. Dont send request back to caller
240         # unless the caller is the aggregate's SM 
241         if caller_hrn == aggregate and aggregate != api.hrn:
242             continue
243         server = api.aggregates[aggregate]
244         # Just send entire RSpec to each aggregate
245         threads.run(_CreateSliver, aggregate, server, xrn, credential, rspec.toxml(), users, call_id)
246             
247     results = threads.get_results()
248     manifest_version = version_manager._get_version(rspec.version.type, rspec.version.version, 'manifest')
249     result_rspec = RSpec(version=manifest_version)
250     for result in results:
251         add_slicemgr_stat(result_rspec, "CreateSliver", result["aggregate"], result["elapsed"], result["status"])
252         if result["status"]=="success":
253             try:
254                 result_rspec.version.merge(result["rspec"])
255             except:
256                 api.logger.log_exc("SM.CreateSliver: Failed to merge aggregate rspec")
257     return result_rspec.toxml()
258
259 def RenewSliver(api, xrn, creds, expiration_time, call_id):
260     def _RenewSliver(server, xrn, creds, expiration_time, call_id):
261         server_version = api.get_cached_server_version(server)
262         args =  [xrn, creds, expiration_time, call_id]
263         if _call_id_supported(api, server):
264             args.append(call_id)
265         return server.RenewSliver(*args)
266
267     if Callids().already_handled(call_id): return True
268
269     (hrn, type) = urn_to_hrn(xrn)
270     # get the callers hrn
271     valid_cred = api.auth.checkCredentials(creds, 'renewsliver', hrn)[0]
272     caller_hrn = Credential(string=valid_cred).get_gid_caller().get_hrn()
273
274     # attempt to use delegated credential first
275     credential = api.getDelegatedCredential(creds)
276     if not credential:
277         credential = api.getCredential()
278     threads = ThreadManager()
279     for aggregate in api.aggregates:
280         # prevent infinite loop. Dont send request back to caller
281         # unless the caller is the aggregate's SM
282         if caller_hrn == aggregate and aggregate != api.hrn:
283             continue
284         server = api.aggregates[aggregate]
285         threads.run(_RenewSliver, server, xrn, [credential], expiration_time, call_id)
286     # 'and' the results
287     return reduce (lambda x,y: x and y, threads.get_results() , True)
288
289 def DeleteSliver(api, xrn, creds, call_id):
290     def _DeleteSliver(server, xrn, creds, call_id):
291         server_version = api.get_cached_server_version(server)
292         args =  [xrn, creds]
293         if _call_id_supported(api, server):
294             args.append(call_id)
295         return server.DeleteSliver(*args)
296
297     if Callids().already_handled(call_id): return ""
298     (hrn, type) = urn_to_hrn(xrn)
299     # get the callers hrn
300     valid_cred = api.auth.checkCredentials(creds, 'deletesliver', hrn)[0]
301     caller_hrn = Credential(string=valid_cred).get_gid_caller().get_hrn()
302
303     # attempt to use delegated credential first
304     credential = api.getDelegatedCredential(creds)
305     if not credential:
306         credential = api.getCredential()
307     threads = ThreadManager()
308     for aggregate in api.aggregates:
309         # prevent infinite loop. Dont send request back to caller
310         # unless the caller is the aggregate's SM
311         if caller_hrn == aggregate and aggregate != api.hrn:
312             continue
313         server = api.aggregates[aggregate]
314         threads.run(_DeleteSliver, server, xrn, credential, call_id)
315     threads.get_results()
316     return 1
317
318
319 # first draft at a merging SliverStatus
320 def SliverStatus(api, slice_xrn, creds, call_id):
321     def _SliverStatus(server, xrn, creds, call_id):
322         server_version = api.get_cached_server_version(server)
323         args =  [xrn, creds]
324         if _call_id_supported(api, server):
325             args.append(call_id)
326         return server.SliverStatus(*args)
327     
328     if Callids().already_handled(call_id): return {}
329     # attempt to use delegated credential first
330     credential = api.getDelegatedCredential(creds)
331     if not credential:
332         credential = api.getCredential()
333     threads = ThreadManager()
334     for aggregate in api.aggregates:
335         server = api.aggregates[aggregate]
336         threads.run (_SliverStatus, server, slice_xrn, credential, call_id)
337     results = threads.get_results()
338
339     # get rid of any void result - e.g. when call_id was hit where by convention we return {}
340     results = [ result for result in results if result and result['geni_resources']]
341
342     # do not try to combine if there's no result
343     if not results : return {}
344
345     # otherwise let's merge stuff
346     overall = {}
347
348     # mmh, it is expected that all results carry the same urn
349     overall['geni_urn'] = results[0]['geni_urn']
350     overall['pl_login'] = results[0]['pl_login']
351     # append all geni_resources
352     overall['geni_resources'] = \
353         reduce (lambda x,y: x+y, [ result['geni_resources'] for result in results] , [])
354     overall['status'] = 'unknown'
355     if overall['geni_resources']:
356         overall['status'] = 'ready'
357
358     return overall
359
360 caching=True
361 #caching=False
362 def ListSlices(api, creds, call_id):
363     def _ListSlices(server, creds, call_id):
364         server_version = api.get_cached_server_version(server)
365         args =  [creds]
366         if _call_id_supported(api, server):
367             args.append(call_id)
368         return server.ListSlices(*args)
369
370     if Callids().already_handled(call_id): return []
371
372     # look in cache first
373     if caching and api.cache:
374         slices = api.cache.get('slices')
375         if slices:
376             return slices
377
378     # get the callers hrn
379     valid_cred = api.auth.checkCredentials(creds, 'listslices', None)[0]
380     caller_hrn = Credential(string=valid_cred).get_gid_caller().get_hrn()
381
382     # attempt to use delegated credential first
383     credential = api.getDelegatedCredential(creds)
384     if not credential:
385         credential = api.getCredential()
386     threads = ThreadManager()
387     # fetch from aggregates
388     for aggregate in api.aggregates:
389         # prevent infinite loop. Dont send request back to caller
390         # unless the caller is the aggregate's SM
391         if caller_hrn == aggregate and aggregate != api.hrn:
392             continue
393         server = api.aggregates[aggregate]
394         threads.run(_ListSlices, server, credential, call_id)
395
396     # combime results
397     results = threads.get_results()
398     slices = []
399     for result in results:
400         slices.extend(result)
401
402     # cache the result
403     if caching and api.cache:
404         api.cache.add('slices', slices)
405
406     return slices
407
408
409 def get_ticket(api, xrn, creds, rspec, users):
410     slice_hrn, type = urn_to_hrn(xrn)
411     # get the netspecs contained within the clients rspec
412     aggregate_rspecs = {}
413     tree= etree.parse(StringIO(rspec))
414     elements = tree.findall('./network')
415     for element in elements:
416         aggregate_hrn = element.values()[0]
417         aggregate_rspecs[aggregate_hrn] = rspec 
418
419     # get the callers hrn
420     valid_cred = api.auth.checkCredentials(creds, 'getticket', slice_hrn)[0]
421     caller_hrn = Credential(string=valid_cred).get_gid_caller().get_hrn()
422
423     # attempt to use delegated credential first
424     credential = api.getDelegatedCredential(creds)
425     if not credential:
426         credential = api.getCredential() 
427     threads = ThreadManager()
428     for (aggregate, aggregate_rspec) in aggregate_rspecs.iteritems():
429         # prevent infinite loop. Dont send request back to caller
430         # unless the caller is the aggregate's SM
431         if caller_hrn == aggregate and aggregate != api.hrn:
432             continue
433         server = None
434         if aggregate in api.aggregates:
435             server = api.aggregates[aggregate]
436         else:
437             net_urn = hrn_to_urn(aggregate, 'authority')     
438             # we may have a peer that knows about this aggregate
439             for agg in api.aggregates:
440                 target_aggs = api.aggregates[agg].get_aggregates(credential, net_urn)
441                 if not target_aggs or not 'hrn' in target_aggs[0]:
442                     continue
443                 # send the request to this address 
444                 url = target_aggs[0]['url']
445                 server = xmlrpcprotocol.get_server(url, api.key_file, api.cert_file, timeout=30)
446                 # aggregate found, no need to keep looping
447                 break   
448         if server is None:
449             continue 
450         threads.run(server.GetTicket, xrn, credential, aggregate_rspec, users)
451
452     results = threads.get_results()
453     
454     # gather information from each ticket 
455     rspecs = []
456     initscripts = []
457     slivers = [] 
458     object_gid = None  
459     for result in results:
460         agg_ticket = SfaTicket(string=result)
461         attrs = agg_ticket.get_attributes()
462         if not object_gid:
463             object_gid = agg_ticket.get_gid_object()
464         rspecs.append(agg_ticket.get_rspec())
465         initscripts.extend(attrs.get('initscripts', [])) 
466         slivers.extend(attrs.get('slivers', [])) 
467     
468     # merge info
469     attributes = {'initscripts': initscripts,
470                  'slivers': slivers}
471     merged_rspec = merge_rspecs(rspecs) 
472
473     # create a new ticket
474     ticket = SfaTicket(subject = slice_hrn)
475     ticket.set_gid_caller(api.auth.client_gid)
476     ticket.set_issuer(key=api.key, subject=api.hrn)
477     ticket.set_gid_object(object_gid)
478     ticket.set_pubkey(object_gid.get_pubkey())
479     #new_ticket.set_parent(api.auth.hierarchy.get_auth_ticket(auth_hrn))
480     ticket.set_attributes(attributes)
481     ticket.set_rspec(merged_rspec)
482     ticket.encode()
483     ticket.sign()          
484     return ticket.save_to_string(save_parents=True)
485
486 def start_slice(api, xrn, creds):
487     hrn, type = urn_to_hrn(xrn)
488
489     # get the callers hrn
490     valid_cred = api.auth.checkCredentials(creds, 'startslice', hrn)[0]
491     caller_hrn = Credential(string=valid_cred).get_gid_caller().get_hrn()
492
493     # attempt to use delegated credential first
494     credential = api.getDelegatedCredential(creds)
495     if not credential:
496         credential = api.getCredential()
497     threads = ThreadManager()
498     for aggregate in api.aggregates:
499         # prevent infinite loop. Dont send request back to caller
500         # unless the caller is the aggregate's SM
501         if caller_hrn == aggregate and aggregate != api.hrn:
502             continue
503         server = api.aggregates[aggregate]
504         threads.run(server.Start, xrn, credential)
505     threads.get_results()    
506     return 1
507  
508 def stop_slice(api, xrn, creds):
509     hrn, type = urn_to_hrn(xrn)
510
511     # get the callers hrn
512     valid_cred = api.auth.checkCredentials(creds, 'stopslice', hrn)[0]
513     caller_hrn = Credential(string=valid_cred).get_gid_caller().get_hrn()
514
515     # attempt to use delegated credential first
516     credential = api.getDelegatedCredential(creds)
517     if not credential:
518         credential = api.getCredential()
519     threads = ThreadManager()
520     for aggregate in api.aggregates:
521         # prevent infinite loop. Dont send request back to caller
522         # unless the caller is the aggregate's SM
523         if caller_hrn == aggregate and aggregate != api.hrn:
524             continue
525         server = api.aggregates[aggregate]
526         threads.run(server.Stop, xrn, credential)
527     threads.get_results()    
528     return 1
529
530 def reset_slice(api, xrn):
531     """
532     Not implemented
533     """
534     return 1
535
536 def shutdown(api, xrn, creds):
537     """
538     Not implemented   
539     """
540     return 1
541
542 def status(api, xrn, creds):
543     """
544     Not implemented 
545     """
546     return 1
547
548 def main():
549     r = RSpec()
550     r.parseFile(sys.argv[1])
551     rspec = r.toDict()
552     CreateSliver(None,'plc.princeton.tmacktestslice',rspec,'create-slice-tmacktestslice')
553
554 if __name__ == "__main__":
555     main()
556