ListResources uses the 'rspec_version' field specified in the 'options' struct to...
[sfa.git] / sfa / managers / slice_manager_pl.py
1
2 import sys
3 import time,datetime
4 from StringIO import StringIO
5 from types import StringTypes
6 from copy import deepcopy
7 from copy import copy
8 from lxml import etree
9
10 from sfa.util.sfalogging import sfa_logger
11 from sfa.util.rspecHelper import merge_rspecs
12 from sfa.util.xrn import Xrn, urn_to_hrn, hrn_to_urn
13 from sfa.util.plxrn import hrn_to_pl_slicename
14 from sfa.util.rspec import *
15 from sfa.util.specdict import *
16 from sfa.util.faults import *
17 from sfa.util.record import SfaRecord
18 from sfa.rspecs.sfa_rspec import SfaRSpec
19 from sfa.util.policy import Policy
20 from sfa.util.prefixTree import prefixTree
21 from sfa.util.sfaticket import *
22 from sfa.trust.credential import Credential
23 from sfa.util.threadmanager import ThreadManager
24 import sfa.util.xmlrpcprotocol as xmlrpcprotocol     
25 import sfa.plc.peers as peers
26 from sfa.util.version import version_core
27 from sfa.rspecs.rspec_version import RSpecVersion
28 from sfa.util.callids import Callids
29
30 # we have specialized xmlrpclib.ServerProxy to remember the input url
31 # OTOH it's not clear if we're only dealing with XMLRPCServerProxy instances
32 def get_serverproxy_url (server):
33     try:
34         return server.url
35     except:
36         sfa_logger().warning("GetVersion, falling back to xmlrpclib.ServerProxy internals")
37         return server._ServerProxy__host + server._ServerProxy__handler 
38
39 def GetVersion(api):
40     # peers explicitly in aggregates.xml
41     peers =dict ([ (peername,get_serverproxy_url(v)) for (peername,v) in api.aggregates.iteritems() 
42                    if peername != api.hrn])
43     xrn=Xrn (api.hrn)
44     sm_version=version_core({'interface':'slicemgr',
45                              'hrn' : xrn.get_hrn(),
46                              'urn' : xrn.get_urn(),
47                              'peers': peers,
48                              })
49     # local aggregate if present needs to have localhost resolved
50     if api.hrn in api.aggregates:
51         local_am_url=get_serverproxy_url(api.aggregates[api.hrn])
52         sm_version['peers'][api.hrn]=local_am_url.replace('localhost',sm_version['hostname'])
53     return sm_version
54
55 def CreateSliver(api, xrn, creds, rspec, users, call_id):
56
57     if Callids().already_handled(call_id): return ""
58
59     hrn, type = urn_to_hrn(xrn)
60
61     # Validate the RSpec against PlanetLab's schema --disabled for now
62     # The schema used here needs to aggregate the PL and VINI schemas
63     # schema = "/var/www/html/schemas/pl.rng"
64     schema = None
65     if schema:
66         try:
67             tree = etree.parse(StringIO(rspec))
68         except etree.XMLSyntaxError:
69             message = str(sys.exc_info()[1])
70             raise InvalidRSpec(message)
71
72         relaxng_doc = etree.parse(schema)
73         relaxng = etree.RelaxNG(relaxng_doc)
74         
75         if not relaxng(tree):
76             error = relaxng.error_log.last_error
77             message = "%s (line %s)" % (error.message, error.line)
78             raise InvalidRSpec(message)
79
80     # get the callers hrn
81     valid_cred = api.auth.checkCredentials(creds, 'createsliver', hrn)[0]
82     caller_hrn = Credential(string=valid_cred).get_gid_caller().get_hrn()
83
84     # attempt to use delegated credential first
85     credential = api.getDelegatedCredential(creds)
86     if not credential:     
87         credential = api.getCredential()
88     threads = ThreadManager()
89     for aggregate in api.aggregates:
90         # prevent infinite loop. Dont send request back to caller
91         # unless the caller is the aggregate's SM 
92         if caller_hrn == aggregate and aggregate != api.hrn:
93             continue
94             
95         # Just send entire RSpec to each aggregate
96         server = api.aggregates[aggregate]
97         threads.run(server.CreateSliver, xrn, credential, rspec, users, call_id)
98             
99     results = threads.get_results()
100     rspec = SfaRSpec()
101     for result in results:
102         rspec.merge(result)     
103     return rspec
104
105 def RenewSliver(api, xrn, creds, expiration_time, call_id):
106     if Callids().already_handled(call_id): return True
107
108     (hrn, type) = urn_to_hrn(xrn)
109     # get the callers hrn
110     valid_cred = api.auth.checkCredentials(creds, 'renewsliver', hrn)[0]
111     caller_hrn = Credential(string=valid_cred).get_gid_caller().get_hrn()
112
113     # attempt to use delegated credential first
114     credential = api.getDelegatedCredential(creds)
115     if not credential:
116         credential = api.getCredential()
117     threads = ThreadManager()
118     for aggregate in api.aggregates:
119         # prevent infinite loop. Dont send request back to caller
120         # unless the caller is the aggregate's SM
121         if caller_hrn == aggregate and aggregate != api.hrn:
122             continue
123
124         server = api.aggregates[aggregate]
125         threads.run(server.RenewSliver, xrn, [credential], expiration_time, call_id)
126     # 'and' the results
127     return reduce (lambda x,y: x and y, threads.get_results() , True)
128
129 def get_ticket(api, xrn, creds, rspec, users):
130     slice_hrn, type = urn_to_hrn(xrn)
131     # get the netspecs contained within the clients rspec
132     aggregate_rspecs = {}
133     tree= etree.parse(StringIO(rspec))
134     elements = tree.findall('./network')
135     for element in elements:
136         aggregate_hrn = element.values()[0]
137         aggregate_rspecs[aggregate_hrn] = rspec 
138
139     # get the callers hrn
140     valid_cred = api.auth.checkCredentials(creds, 'getticket', slice_hrn)[0]
141     caller_hrn = Credential(string=valid_cred).get_gid_caller().get_hrn()
142
143     # attempt to use delegated credential first
144     credential = api.getDelegatedCredential(creds)
145     if not credential:
146         credential = api.getCredential() 
147     threads = ThreadManager()
148     for (aggregate, aggregate_rspec) in aggregate_rspecs.iteritems():
149         # prevent infinite loop. Dont send request back to caller
150         # unless the caller is the aggregate's SM
151         if caller_hrn == aggregate and aggregate != api.hrn:
152             continue
153         server = None
154         if aggregate in api.aggregates:
155             server = api.aggregates[aggregate]
156         else:
157             net_urn = hrn_to_urn(aggregate, 'authority')     
158             # we may have a peer that knows about this aggregate
159             for agg in api.aggregates:
160                 target_aggs = api.aggregates[agg].get_aggregates(credential, net_urn)
161                 if not target_aggs or not 'hrn' in target_aggs[0]:
162                     continue
163                 # send the request to this address 
164                 url = target_aggs[0]['url']
165                 server = xmlrpcprotocol.get_server(url, api.key_file, api.cert_file)
166                 # aggregate found, no need to keep looping
167                 break   
168         if server is None:
169             continue 
170         threads.run(server.GetTicket, xrn, credential, aggregate_rspec, users)
171
172     results = threads.get_results()
173     
174     # gather information from each ticket 
175     rspecs = []
176     initscripts = []
177     slivers = [] 
178     object_gid = None  
179     for result in results:
180         agg_ticket = SfaTicket(string=result)
181         attrs = agg_ticket.get_attributes()
182         if not object_gid:
183             object_gid = agg_ticket.get_gid_object()
184         rspecs.append(agg_ticket.get_rspec())
185         initscripts.extend(attrs.get('initscripts', [])) 
186         slivers.extend(attrs.get('slivers', [])) 
187     
188     # merge info
189     attributes = {'initscripts': initscripts,
190                  'slivers': slivers}
191     merged_rspec = merge_rspecs(rspecs) 
192
193     # create a new ticket
194     ticket = SfaTicket(subject = slice_hrn)
195     ticket.set_gid_caller(api.auth.client_gid)
196     ticket.set_issuer(key=api.key, subject=api.hrn)
197     ticket.set_gid_object(object_gid)
198     ticket.set_pubkey(object_gid.get_pubkey())
199     #new_ticket.set_parent(api.auth.hierarchy.get_auth_ticket(auth_hrn))
200     ticket.set_attributes(attributes)
201     ticket.set_rspec(merged_rspec)
202     ticket.encode()
203     ticket.sign()          
204     return ticket.save_to_string(save_parents=True)
205
206
207 def DeleteSliver(api, xrn, creds, call_id):
208     if Callids().already_handled(call_id): return ""
209     (hrn, type) = urn_to_hrn(xrn)
210     # get the callers hrn
211     valid_cred = api.auth.checkCredentials(creds, 'deletesliver', hrn)[0]
212     caller_hrn = Credential(string=valid_cred).get_gid_caller().get_hrn()
213
214     # attempt to use delegated credential first
215     credential = api.getDelegatedCredential(creds)
216     if not credential:
217         credential = api.getCredential()
218     threads = ThreadManager()
219     for aggregate in api.aggregates:
220         # prevent infinite loop. Dont send request back to caller
221         # unless the caller is the aggregate's SM
222         if caller_hrn == aggregate and aggregate != api.hrn:
223             continue
224         server = api.aggregates[aggregate]
225         threads.run(server.DeleteSliver, xrn, credential, call_id)
226     threads.get_results()
227     return 1
228
229 def start_slice(api, xrn, creds):
230     hrn, type = urn_to_hrn(xrn)
231
232     # get the callers hrn
233     valid_cred = api.auth.checkCredentials(creds, 'startslice', hrn)[0]
234     caller_hrn = Credential(string=valid_cred).get_gid_caller().get_hrn()
235
236     # attempt to use delegated credential first
237     credential = api.getDelegatedCredential(creds)
238     if not credential:
239         credential = api.getCredential()
240     threads = ThreadManager()
241     for aggregate in api.aggregates:
242         # prevent infinite loop. Dont send request back to caller
243         # unless the caller is the aggregate's SM
244         if caller_hrn == aggregate and aggregate != api.hrn:
245             continue
246         server = api.aggregates[aggregate]
247         threads.run(server.Start, xrn, credential)
248     threads.get_results()    
249     return 1
250  
251 def stop_slice(api, xrn, creds):
252     hrn, type = urn_to_hrn(xrn)
253
254     # get the callers hrn
255     valid_cred = api.auth.checkCredentials(creds, 'stopslice', hrn)[0]
256     caller_hrn = Credential(string=valid_cred).get_gid_caller().get_hrn()
257
258     # attempt to use delegated credential first
259     credential = api.getDelegatedCredential(creds)
260     if not credential:
261         credential = api.getCredential()
262     threads = ThreadManager()
263     for aggregate in api.aggregates:
264         # prevent infinite loop. Dont send request back to caller
265         # unless the caller is the aggregate's SM
266         if caller_hrn == aggregate and aggregate != api.hrn:
267             continue
268         server = api.aggregates[aggregate]
269         threads.run(server.Stop, xrn, credential)
270     threads.get_results()    
271     return 1
272
273 def reset_slice(api, xrn):
274     """
275     Not implemented
276     """
277     return 1
278
279 def shutdown(api, xrn, creds):
280     """
281     Not implemented   
282     """
283     return 1
284
285 def status(api, xrn, creds):
286     """
287     Not implemented 
288     """
289     return 1
290
291 # Thierry : caching at the slicemgr level makes sense to some extent
292 caching=True
293 #caching=False
294 def ListSlices(api, creds, call_id):
295
296     if Callids().already_handled(call_id): return []
297
298     # look in cache first
299     if caching and api.cache:
300         slices = api.cache.get('slices')
301         if slices:
302             return slices    
303
304     # get the callers hrn
305     valid_cred = api.auth.checkCredentials(creds, 'listslices', None)[0]
306     caller_hrn = Credential(string=valid_cred).get_gid_caller().get_hrn()
307
308     # attempt to use delegated credential first
309     credential = api.getDelegatedCredential(creds)
310     if not credential:
311         credential = api.getCredential()
312     threads = ThreadManager()
313     # fetch from aggregates
314     for aggregate in api.aggregates:
315         # prevent infinite loop. Dont send request back to caller
316         # unless the caller is the aggregate's SM
317         if caller_hrn == aggregate and aggregate != api.hrn:
318             continue
319         server = api.aggregates[aggregate]
320         threads.run(server.ListSlices, credential, call_id)
321
322     # combime results
323     results = threads.get_results()
324     slices = []
325     for result in results:
326         slices.extend(result)
327     
328     # cache the result
329     if caching and api.cache:
330         api.cache.add('slices', slices)
331
332     return slices
333
334
335 def ListResources(api, creds, options, call_id):
336
337     if Callids().already_handled(call_id): return ""
338
339     # get slice's hrn from options
340     xrn = options.get('geni_slice_urn', '')
341     (hrn, type) = urn_to_hrn(xrn)
342
343     # get the rspec's return format from options
344     rspec_version = RSpecVersion(options.get('rspec_version', 'SFA 1'))
345     version_string = "rspec_%s_%s" % (rspec_version.format, rspec_version.version)
346
347     # get hrn of the original caller
348     origin_hrn = options.get('origin_hrn', None)
349     if not origin_hrn:
350         if isinstance(creds, list):
351             origin_hrn = Credential(string=creds[0]).get_gid_caller().get_hrn()
352         else:
353             origin_hrn = Credential(string=creds).get_gid_caller().get_hrn()
354     
355     # look in cache first 
356     if caching and api.cache and not xrn:
357         rspec =  api.cache.get(version_string)
358         if rspec:
359             return rspec
360
361     # get the callers hrn
362     valid_cred = api.auth.checkCredentials(creds, 'listnodes', hrn)[0]
363     caller_hrn = Credential(string=valid_cred).get_gid_caller().get_hrn()
364
365     # attempt to use delegated credential first
366     credential = api.getDelegatedCredential(creds)
367     if not credential:
368         credential = api.getCredential()
369     threads = ThreadManager()
370     for aggregate in api.aggregates:
371         # prevent infinite loop. Dont send request back to caller
372         # unless the caller is the aggregate's SM
373         if caller_hrn == aggregate and aggregate != api.hrn:
374             continue
375         # get the rspec from the aggregate
376         server = api.aggregates[aggregate]
377         my_opts = copy(options)
378         my_opts['geni_compressed'] = False
379         threads.run(server.ListResources, credential, my_opts, call_id)
380         #threads.run(server.get_resources, cred, xrn, origin_hrn)
381                     
382     results = threads.get_results()
383     rspec = SfaRSpec()
384     for result in results:
385         rspec.merge(result)
386
387     # cache the result
388     if caching and api.cache and not xrn:
389         api.cache.add(version_string, rspec)
390  
391     return rspec.toxml()
392
393 # first draft at a merging SliverStatus
394 def SliverStatus(api, slice_xrn, creds, call_id):
395     if Callids().already_handled(call_id): return {}
396     # attempt to use delegated credential first
397     credential = api.getDelegatedCredential(creds)
398     if not credential:
399         credential = api.getCredential()
400     threads = ThreadManager()
401     for aggregate in api.aggregates:
402         server = api.aggregates[aggregate]
403         threads.run (server.SliverStatus, slice_xrn, credential, call_id)
404     results = threads.get_results()
405
406     # get rid of any void result - e.g. when call_id was hit where by convention we return {}
407     results = [ result for result in results if result and result['geni_resources']]
408
409     # do not try to combine if there's no result
410     if not results : return {}
411
412     # otherwise let's merge stuff
413     overall = {}
414
415     # mmh, it is expected that all results carry the same urn
416     overall['geni_urn'] = results[0]['geni_urn']
417
418     # consolidate geni_status - simple model using max on a total order
419     states = [ 'ready', 'configuring', 'failed', 'unknown' ]
420     # hash name to index
421     shash = dict ( zip ( states, range(len(states)) ) )
422     def combine_status (x,y):
423         return shash [ max (shash(x),shash(y)) ]
424     overall['geni_status'] = reduce (combine_status, [ result['geni_status'] for result in results], 'ready' )
425
426     # {'ready':0,'configuring':1,'failed':2,'unknown':3}
427     # append all geni_resources
428     overall['geni_resources'] = \
429         reduce (lambda x,y: x+y, [ result['geni_resources'] for result in results] , [])
430
431     return overall
432
433 def main():
434     r = RSpec()
435     r.parseFile(sys.argv[1])
436     rspec = r.toDict()
437     CreateSliver(None,'plc.princeton.tmacktestslice',rspec,'create-slice-tmacktestslice')
438
439 if __name__ == "__main__":
440     main()
441