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
  16 from sfa.server.threadmanager import ThreadManager
  17
  18 from sfa.rspecs.rspec_converter import RSpecConverter
  19 from sfa.rspecs.version_manager import VersionManager
  20 from sfa.rspecs.rspec import RSpec
  21 from sfa.client.client_helper import sfa_to_pg_users_arg
  22
  23 class SliceManager:
  24     def __init__ (self):
  25     #    self.caching=False
  26         self.caching=True
  27
  28
  29     def _options_supported(self, api, server):
  30         """
  31         Returns true if server support the optional call_id arg, false otherwise.
  32         """
  33         server_version = api.get_cached_server_version(server)
  34
  35         if 'sfa' in server_version:
  36             code_tag = server_version['code_tag']
  37             code_tag_parts = code_tag.split("-")
  38
  39             version_parts = code_tag_parts[0].split(".")
  40             major, minor = version_parts[0:2]
  41             rev = code_tag_parts[1]
  42             if int(major) >= 1:
  43                 if int(minor) >= 2:
  44                     return True
  45         return False
  46
  47     # we have specialized xmlrpclib.ServerProxy to remember the input url
  48     # OTOH it's not clear if we're only dealing with XMLRPCServerProxy instances
  49     def get_serverproxy_url (self, server):
  50         try:
  51             return server.get_url()
  52         except:
  53             logger.warning("GetVersion, falling back to xmlrpclib.ServerProxy internals")
  54             return server._ServerProxy__host + server._ServerProxy__handler
  55
  56     def GetVersion(self, api, options={}):
  57         # peers explicitly in aggregates.xml
  58         peers =dict ([ (peername,self.get_serverproxy_url(v)) for (peername,v) in api.aggregates.iteritems()
  59                        if peername != api.hrn])
  60         version_manager = VersionManager()
  61         ad_rspec_versions = []
  62         request_rspec_versions = []
  63         for rspec_version in version_manager.versions:
  64             if rspec_version.content_type in ['*', 'ad']:
  65                 ad_rspec_versions.append(rspec_version.to_dict())
  66             if rspec_version.content_type in ['*', 'request']:
  67                 request_rspec_versions.append(rspec_version.to_dict())
  68         default_rspec_version = version_manager.get_version("sfa 1").to_dict()
  69         xrn=Xrn(api.hrn, 'authority+sa')
  70         version_more = {'interface':'slicemgr',
  71                         'hrn' : xrn.get_hrn(),
  72                         'urn' : xrn.get_urn(),
  73                         'peers': peers,
  74                         'request_rspec_versions': request_rspec_versions,
  75                         'ad_rspec_versions': ad_rspec_versions,
  76                         'default_ad_rspec': default_rspec_version
  77                     }
  78         sm_version=version_core(version_more)
  79         # local aggregate if present needs to have localhost resolved
  80         if api.hrn in api.aggregates:
  81             local_am_url=self.get_serverproxy_url(api.aggregates[api.hrn])
  82             sm_version['peers'][api.hrn]=local_am_url.replace('localhost',sm_version['hostname'])
  83         return sm_version
  84
  85     def drop_slicemgr_stats(self, rspec):
  86         try:
  87             stats_elements = rspec.xml.xpath('//statistics')
  88             for node in stats_elements:
  89                 node.getparent().remove(node)
  90         except Exception, e:
  91             logger.warn("drop_slicemgr_stats failed: %s " % (str(e)))
  92
  93     def add_slicemgr_stat(self, rspec, callname, aggname, elapsed, status, exc_info=None):
  94         try:
  95             stats_tags = rspec.xml.xpath('//statistics[@call="%s"]' % callname)
  96             if stats_tags:
  97                 stats_tag = stats_tags[0]
  98             else:
  99                 stats_tag = rspec.xml.root.add_element("statistics", call=callname)
 100
 101             stat_tag = stats_tag.add_element("aggregate", name=str(aggname), elapsed=str(elapsed), status=str(status))
 102
 103             if exc_info:
 104                 exc_tag = stat_tag.add_element("exc_info", name=str(exc_info[1]))
 105
 106                 # formats the traceback as one big text blob
 107                 #exc_tag.text = "\n".join(traceback.format_exception(exc_info[0], exc_info[1], exc_info[2]))
 108
 109                 # formats the traceback as a set of xml elements
 110                 tb = traceback.extract_tb(exc_info[2])
 111                 for item in tb:
 112                     exc_frame = exc_tag.add_element("tb_frame", filename=str(item[0]), line=str(item[1]), func=str(item[2]), code=str(item[3]))
 113
 114         except Exception, e:
 115             logger.warn("add_slicemgr_stat failed on  %s: %s" %(aggname, str(e)))
 116
 117     def ListResources(self, api, creds, options={}):
 118         version_manager = VersionManager()
 119         def _ListResources(aggregate, server, credential, opts={}):
 120
 121             my_opts = copy(opts)
 122             args = [credential, my_opts]
 123             tStart = time.time()
 124             try:
 125                 version = api.get_cached_server_version(server)
 126                 # force ProtoGENI aggregates to give us a v2 RSpec
 127                 if 'sfa' not in version.keys():
 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('rspec_version'))
 145         version_string = "rspec_%s" % (rspec_version.to_string())
 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('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(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(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         return reduce (lambda x,y: x and y, threads.get_results() , True)
 300
 301     def DeleteSliver(self, api, xrn, creds, options={}):
 302         def _DeleteSliver(server, xrn, creds, options={}):
 303             server_version = api.get_cached_server_version(server)
 304             args =  [xrn, creds]
 305             if self._options_supported(api, server):
 306                 args.append(options)
 307             return server.DeleteSliver(*args)
 308
 309         call_id = options.get('call_id')
 310         if Callids().already_handled(call_id): return ""
 311         (hrn, type) = urn_to_hrn(xrn)
 312         # get the callers hrn
 313         valid_cred = api.auth.checkCredentials(creds, 'deletesliver', hrn)[0]
 314         caller_hrn = Credential(string=valid_cred).get_gid_caller().get_hrn()
 315
 316         # attempt to use delegated credential first
 317         cred = api.getDelegatedCredential(creds)
 318         if not cred:
 319             cred = api.getCredential()
 320         threads = ThreadManager()
 321         for aggregate in api.aggregates:
 322             # prevent infinite loop. Dont send request back to caller
 323             # unless the caller is the aggregate's SM
 324             if caller_hrn == aggregate and aggregate != api.hrn:
 325                 continue
 326             interface = api.aggregates[aggregate]
 327             server = api.server_proxy(interface, cred)
 328             threads.run(_DeleteSliver, server, xrn, [cred], call_id)
 329         threads.get_results()
 330         return 1
 331
 332
 333     # first draft at a merging SliverStatus
 334     def SliverStatus(self, api, slice_xrn, creds, options={}):
 335         def _SliverStatus(server, xrn, creds, options={}):
 336             server_version = api.get_cached_server_version(server)
 337             args =  [xrn, creds]
 338             if self._options_supported(api, server):
 339                 args.append(options)
 340             return server.SliverStatus(*args)
 341
 342         call_id = options.get('call_id')
 343         if Callids().already_handled(call_id): return {}
 344         # attempt to use delegated credential first
 345         cred = api.getDelegatedCredential(creds)
 346         if not cred:
 347             cred = api.getCredential()
 348         threads = ThreadManager()
 349         for aggregate in api.aggregates:
 350             interface = api.aggregates[aggregate]
 351             server = api.server_proxy(interface, cred)
 352             threads.run (_SliverStatus, server, slice_xrn, [cred], call_id)
 353         results = threads.get_results()
 354
 355         # get rid of any void result - e.g. when call_id was hit where by convention we return {}
 356         results = [ result for result in results if result and result['geni_resources']]
 357
 358         # do not try to combine if there's no result
 359         if not results : return {}
 360
 361         # otherwise let's merge stuff
 362         overall = {}
 363
 364         # mmh, it is expected that all results carry the same urn
 365         overall['geni_urn'] = results[0]['geni_urn']
 366         overall['pl_login'] = results[0]['pl_login']
 367         # append all geni_resources
 368         overall['geni_resources'] = \
 369             reduce (lambda x,y: x+y, [ result['geni_resources'] for result in results] , [])
 370         overall['status'] = 'unknown'
 371         if overall['geni_resources']:
 372             overall['status'] = 'ready'
 373
 374         return overall
 375
 376     def ListSlices(self, api, creds, options={}):
 377         def _ListSlices(server, creds, options={}):
 378             server_version = api.get_cached_server_version(server)
 379             args =  [creds]
 380             if self._options_supported(api, server):
 381                 args.append(options)
 382             return server.ListSlices(*args)
 383
 384         call_id = options.get('call_id')
 385         if Callids().already_handled(call_id): return []
 386
 387         # look in cache first
 388         if self.caching and api.cache:
 389             slices = api.cache.get('slices')
 390             if slices:
 391                 return slices
 392
 393         # get the callers hrn
 394         valid_cred = api.auth.checkCredentials(creds, 'listslices', None)[0]
 395         caller_hrn = Credential(string=valid_cred).get_gid_caller().get_hrn()
 396
 397         # attempt to use delegated credential first
 398         cred= api.getDelegatedCredential(creds)
 399         if not cred:
 400             cred = api.getCredential()
 401         threads = ThreadManager()
 402         # fetch from aggregates
 403         for aggregate in api.aggregates:
 404             # prevent infinite loop. Dont send request back to caller
 405             # unless the caller is the aggregate's SM
 406             if caller_hrn == aggregate and aggregate != api.hrn:
 407                 continue
 408             interface = api.aggregates[aggregate]
 409             server = api.server_proxy(interface, cred)
 410             threads.run(_ListSlices, server, [cred], options)
 411
 412         # combime results
 413         results = threads.get_results()
 414         slices = []
 415         for result in results:
 416             slices.extend(result)
 417
 418         # cache the result
 419         if self.caching and api.cache:
 420             api.cache.add('slices', slices)
 421
 422         return slices
 423
 424
 425     def GetTicket(self, api, xrn, creds, rspec, users, options={}):
 426         slice_hrn, type = urn_to_hrn(xrn)
 427         # get the netspecs contained within the clients rspec
 428         aggregate_rspecs = {}
 429         tree= etree.parse(StringIO(rspec))
 430         elements = tree.findall('./network')
 431         for element in elements:
 432             aggregate_hrn = element.values()[0]
 433             aggregate_rspecs[aggregate_hrn] = rspec
 434
 435         # get the callers hrn
 436         valid_cred = api.auth.checkCredentials(creds, 'getticket', slice_hrn)[0]
 437         caller_hrn = Credential(string=valid_cred).get_gid_caller().get_hrn()
 438
 439         # attempt to use delegated credential first
 440         cred = api.getDelegatedCredential(creds)
 441         if not cred:
 442             cred = api.getCredential()
 443         threads = ThreadManager()
 444         for (aggregate, aggregate_rspec) in aggregate_rspecs.iteritems():
 445             # prevent infinite loop. Dont send request back to caller
 446             # unless the caller is the aggregate's SM
 447             if caller_hrn == aggregate and aggregate != api.hrn:
 448                 continue
 449
 450             interface = api.aggregates[aggregate]
 451             server = api.server_proxy(interface, cred)
 452             threads.run(server.GetTicket, xrn, [cred], aggregate_rspec, users, options)
 453
 454         results = threads.get_results()
 455
 456         # gather information from each ticket
 457         rspec = None
 458         initscripts = []
 459         slivers = []
 460         object_gid = None
 461         for result in results:
 462             agg_ticket = SfaTicket(string=result)
 463             attrs = agg_ticket.get_attributes()
 464             if not object_gid:
 465                 object_gid = agg_ticket.get_gid_object()
 466             if not rspec:
 467                 rspec = RSpec(agg_ticket.get_rspec())
 468             else:
 469                 rspec.version.merge(agg_ticket.get_rspec())
 470             initscripts.extend(attrs.get('initscripts', []))
 471             slivers.extend(attrs.get('slivers', []))
 472
 473         # merge info
 474         attributes = {'initscripts': initscripts,
 475                      'slivers': slivers}
 476
 477         # create a new ticket
 478         ticket = SfaTicket(subject = slice_hrn)
 479         ticket.set_gid_caller(api.auth.client_gid)
 480         ticket.set_issuer(key=api.key, subject=api.hrn)
 481         ticket.set_gid_object(object_gid)
 482         ticket.set_pubkey(object_gid.get_pubkey())
 483         #new_ticket.set_parent(api.auth.hierarchy.get_auth_ticket(auth_hrn))
 484         ticket.set_attributes(attributes)
 485         ticket.set_rspec(rspec.toxml())
 486         ticket.encode()
 487         ticket.sign()
 488         return ticket.save_to_string(save_parents=True)
 489
 490     def start_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, 'startslice', 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.Start, xrn, cred)
 510         threads.get_results()
 511         return 1
 512
 513     def stop_slice(self, api, xrn, creds):
 514         hrn, type = urn_to_hrn(xrn)
 515
 516         # get the callers hrn
 517         valid_cred = api.auth.checkCredentials(creds, 'stopslice', hrn)[0]
 518         caller_hrn = Credential(string=valid_cred).get_gid_caller().get_hrn()
 519
 520         # attempt to use delegated credential first
 521         cred = api.getDelegatedCredential(creds)
 522         if not cred:
 523             cred = api.getCredential()
 524         threads = ThreadManager()
 525         for aggregate in api.aggregates:
 526             # prevent infinite loop. Dont send request back to caller
 527             # unless the caller is the aggregate's SM
 528             if caller_hrn == aggregate and aggregate != api.hrn:
 529                 continue
 530             interface = api.aggregates[aggregate]
 531             server = api.server_proxy(interface, cred)
 532             threads.run(server.Stop, xrn, cred)
 533         threads.get_results()
 534         return 1
 535
 536     def reset_slice(self, api, xrn):
 537         """
 538         Not implemented
 539         """
 540         return 1
 541
 542     def shutdown(self, api, xrn, creds):
 543         """
 544         Not implemented
 545         """
 546         return 1
 547
 548     def status(self, api, xrn, creds):
 549         """
 550         Not implemented
 551         """
 552         return 1
 553