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