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