sfa/managers/slice_manager.py

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