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