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