9df40c8b0fb5ea7793bddb5435637f09677cc0bd
[sfa.git] / sfa / plc / slices.py
1 import datetime
2 import time
3 import traceback
4 import sys
5
6 from types import StringTypes
7 from sfa.util.namespace import get_leaf, get_authority, hrn_to_urn, hrn_to_pl_slicename, urn_to_hrn
8 from sfa.util.rspec import *
9 from sfa.util.specdict import *
10 from sfa.util.faults import *
11 from sfa.util.record import SfaRecord
12 from sfa.util.policy import Policy
13 from sfa.util.prefixTree import prefixTree
14
15 MAXINT =  2L**31-1
16
17 class Slices:
18
19     rspec_to_slice_tag = {'max_rate':'net_max_rate'}
20
21     def __init__(self, api, ttl = .5, origin_hrn=None):
22         self.api = api
23         #filepath = path + os.sep + filename
24         self.policy = Policy(self.api)    
25         self.origin_hrn = origin_hrn
26
27     def get_slivers(self, xrn, node=None):
28         hrn, type = urn_to_hrn(xrn)
29          
30         slice_name = hrn_to_pl_slicename(hrn)
31         # XX Should we just call PLCAPI.GetSliceTicket(slice_name) instead
32         # of doing all of this?
33         #return self.api.GetSliceTicket(self.auth, slice_name) 
34         
35         # from PLCAPI.GetSlivers.get_slivers()
36         slice_fields = ['slice_id', 'name', 'instantiation', 'expires', 'person_ids', 'slice_tag_ids']
37         slices = self.api.plshell.GetSlices(self.api.plauth, slice_name, slice_fields)
38         # Build up list of users and slice attributes
39         person_ids = set()
40         all_slice_tag_ids = set()
41         for slice in slices:
42             person_ids.update(slice['person_ids'])
43             all_slice_tag_ids.update(slice['slice_tag_ids'])
44         person_ids = list(person_ids)
45         all_slice_tag_ids = list(all_slice_tag_ids)
46         # Get user information
47         all_persons_list = self.api.plshell.GetPersons(self.api.plauth, {'person_id':person_ids,'enabled':True}, ['person_id', 'enabled', 'key_ids'])
48         all_persons = {}
49         for person in all_persons_list:
50             all_persons[person['person_id']] = person        
51
52         # Build up list of keys
53         key_ids = set()
54         for person in all_persons.values():
55             key_ids.update(person['key_ids'])
56         key_ids = list(key_ids)
57         # Get user account keys
58         all_keys_list = self.api.plshell.GetKeys(self.api.plauth, key_ids, ['key_id', 'key', 'key_type'])
59         all_keys = {}
60         for key in all_keys_list:
61             all_keys[key['key_id']] = key
62         # Get slice attributes
63         all_slice_tags_list = self.api.plshell.GetSliceTags(self.api.plauth, all_slice_tag_ids)
64         all_slice_tags = {}
65         for slice_tag in all_slice_tags_list:
66             all_slice_tags[slice_tag['slice_tag_id']] = slice_tag
67            
68         slivers = []
69         for slice in slices:
70             keys = []
71             for person_id in slice['person_ids']:
72                 if person_id in all_persons:
73                     person = all_persons[person_id]
74                     if not person['enabled']:
75                         continue
76                     for key_id in person['key_ids']:
77                         if key_id in all_keys:
78                             key = all_keys[key_id]
79                             keys += [{'key_type': key['key_type'],
80                                     'key': key['key']}]
81             attributes = []
82             # All (per-node and global) attributes for this slice
83             slice_tags = []
84             for slice_tag_id in slice['slice_tag_ids']:
85                 if slice_tag_id in all_slice_tags:
86                     slice_tags.append(all_slice_tags[slice_tag_id]) 
87             # Per-node sliver attributes take precedence over global
88             # slice attributes, so set them first.
89             # Then comes nodegroup slice attributes
90             # Followed by global slice attributes
91             sliver_attributes = []
92
93             if node is not None:
94                 for sliver_attribute in filter(lambda a: a['node_id'] == node['node_id'], slice_tags):
95                     sliver_attributes.append(sliver_attribute['tagname'])
96                     attributes.append({'tagname': sliver_attribute['tagname'],
97                                     'value': sliver_attribute['value']})
98
99             # set nodegroup slice attributes
100             for slice_tag in filter(lambda a: a['nodegroup_id'] in node['nodegroup_ids'], slice_tags):
101                 # Do not set any nodegroup slice attributes for
102                 # which there is at least one sliver attribute
103                 # already set.
104                 if slice_tag not in slice_tags:
105                     attributes.append({'tagname': slice_tag['tagname'],
106                         'value': slice_tag['value']})
107
108             for slice_tag in filter(lambda a: a['node_id'] is None, slice_tags):
109                 # Do not set any global slice attributes for
110                 # which there is at least one sliver attribute
111                 # already set.
112                 if slice_tag['tagname'] not in sliver_attributes:
113                     attributes.append({'tagname': slice_tag['tagname'],
114                                    'value': slice_tag['value']})
115
116             # XXX Sanity check; though technically this should be a system invariant
117             # checked with an assertion
118             if slice['expires'] > MAXINT:  slice['expires']= MAXINT
119             
120             slivers.append({
121                 'hrn': hrn,
122                 'name': slice['name'],
123                 'slice_id': slice['slice_id'],
124                 'instantiation': slice['instantiation'],
125                 'expires': slice['expires'],
126                 'keys': keys,
127                 'attributes': attributes
128             })
129
130         return slivers
131  
132     def get_peer(self, xrn):
133         hrn, type = urn_to_hrn(xrn)
134         # Becaues of myplc federation,  we first need to determine if this
135         # slice belongs to out local plc or a myplc peer. We will assume it 
136         # is a local site, unless we find out otherwise  
137         peer = None
138
139         # get this slice's authority (site)
140         slice_authority = get_authority(hrn)
141
142         # get this site's authority (sfa root authority or sub authority)
143         site_authority = get_authority(slice_authority).lower()
144
145         # check if we are already peered with this site_authority, if so
146         peers = self.api.plshell.GetPeers(self.api.plauth, {}, ['peer_id', 'peername', 'shortname', 'hrn_root'])
147         for peer_record in peers:
148             names = [name.lower() for name in peer_record.values() if isinstance(name, StringTypes)]
149             if site_authority in names:
150                 peer = peer_record['shortname']
151
152         return peer
153
154     def get_sfa_peer(self, xrn):
155         hrn, type = urn_to_hrn(xrn)
156
157         # return the authority for this hrn or None if we are the authority
158         sfa_peer = None
159         slice_authority = get_authority(hrn)
160         site_authority = get_authority(slice_authority)
161
162         if site_authority != self.api.hrn:
163             sfa_peer = site_authority
164
165         return sfa_peer 
166
167     def verify_site(self, registry, credential, slice_hrn, peer, sfa_peer, reg_objects=None):
168         authority = get_authority(slice_hrn)
169         authority_urn = hrn_to_urn(authority, 'authority')
170         login_base = None
171         if reg_objects:
172             site = reg_objects['site']
173             login_base = site['login_base']
174         else:
175             site_records = registry.Resolve(authority_urn, [credential])
176             site = {}            
177             for site_record in site_records:            
178                 if site_record['type'] == 'authority':
179                     site = site_record
180             if not site:
181                 raise RecordNotFound(authority)
182             
183         remote_site_id = site.pop('site_id')    
184         
185         if login_base is None:
186             login_base = get_leaf(authority)
187         sites = self.api.plshell.GetSites(self.api.plauth, login_base)
188
189         if not sites:
190             site_id = self.api.plshell.AddSite(self.api.plauth, site)
191             if peer:
192                 try:
193                     self.api.plshell.BindObjectToPeer(self.api.plauth, 'site', site_id, peer, remote_site_id)   
194                 except Exception,e:
195                     self.api.plshell.DeleteSite(self.api.plauth, site_id)
196                     raise e
197             # mark this site as an sfa peer record
198             if sfa_peer and not reg_objects:
199                 peer_dict = {'type': 'authority', 'hrn': authority, 'peer_authority': sfa_peer, 'pointer': site_id}
200                 registry.register_peer_object(credential, peer_dict)
201         else:
202             site_id = sites[0]['site_id']
203             remote_site_id = sites[0]['peer_site_id']
204             
205             old_site = sites[0]
206             #the site is already on the remote agg. Let us update(e.g. max_slices field) it with the latest info.
207             self.sync_site(old_site, site, peer)
208
209
210         return (site_id, remote_site_id) 
211
212     def verify_slice(self, registry, credential, slice_hrn, site_id, remote_site_id, peer, sfa_peer, reg_objects=None):
213         slice = {}
214         slice_record = None
215         authority = get_authority(slice_hrn)
216
217         if reg_objects:
218             slice_record = reg_objects['slice_record']
219         else:
220             slice_records = registry.Resolve(slice_hrn, [credential])
221     
222             for record in slice_records:
223                 if record['type'] in ['slice']:
224                     slice_record = record
225             if not slice_record:
226                 raise RecordNotFound(hrn)
227             
228         
229         slicename = hrn_to_pl_slicename(slice_hrn)
230         parts = slicename.split("_")
231         login_base = parts[0]
232         slices = self.api.plshell.GetSlices(self.api.plauth, [slicename]) 
233         if not slices:
234             slice_fields = {}
235             slice_keys = ['name', 'url', 'description']
236             for key in slice_keys:
237                 if key in slice_record and slice_record[key]:
238                     slice_fields[key] = slice_record[key]
239             # add the slice                          
240             slice_id = self.api.plshell.AddSlice(self.api.plauth, slice_fields)
241             slice = slice_fields
242             slice['slice_id'] = slice_id
243
244             # mark this slice as an sfa peer record
245             if sfa_peer:
246                 peer_dict = {'type': 'slice', 'hrn': slice_hrn, 'peer_authority': sfa_peer, 'pointer': slice_id}
247                 registry.register_peer_object(credential, peer_dict)
248
249             #this belongs to a peer
250             if peer:
251                 try:
252                     self.api.plshell.BindObjectToPeer(self.api.plauth, 'slice', slice_id, peer, slice_record['pointer'])
253                 except Exception,e:
254                     self.api.plshell.DeleteSlice(self.api.plauth,slice_id)
255                     raise e
256             slice['node_ids'] = []
257         else:
258             slice = slices[0]
259             slice_id = slice['slice_id']
260             site_id = slice['site_id']
261             #the slice is alredy on the remote agg. Let us update(e.g. expires field) it with the latest info.
262             self.sync_slice(slice, slice_record, peer)
263
264         slice['peer_slice_id'] = slice_record['pointer']
265         self.verify_persons(registry, credential, slice_record, site_id, remote_site_id, peer, sfa_peer, reg_objects)
266     
267         return slice        
268
269     def verify_persons(self, registry, credential, slice_record, site_id, remote_site_id, peer, sfa_peer, reg_objects=None):
270         # get the list of valid slice users from the registry and make 
271         # sure they are added to the slice 
272         slicename = hrn_to_pl_slicename(slice_record['hrn'])
273         if reg_objects:
274             researchers = reg_objects['users'].keys()
275         else:
276             researchers = slice_record.get('researcher', [])
277         for researcher in researchers:
278             if reg_objects:
279                 person_dict = reg_objects['users'][researcher]
280             else:
281                 person_records = registry.Resolve(researcher, [credential])
282                 for record in person_records:
283                     if record['type'] in ['user'] and record['enabled']:
284                         person_record = record
285                 if not person_record:
286                     return 1
287                 person_dict = person_record
288
289             local_person=False
290             if peer:
291                 peer_id = self.api.plshell.GetPeers(self.api.plauth, {'shortname': peer}, ['peer_id'])[0]['peer_id']
292                 persons = self.api.plshell.GetPersons(self.api.plauth, {'email': [person_dict['email']], 'peer_id': peer_id}, ['person_id', 'key_ids'])
293                 if not persons:
294                     persons = self.api.plshell.GetPersons(self.api.plauth, [person_dict['email']], ['person_id', 'key_ids'])
295                     if persons:
296                         local_person=True
297                         
298             else:
299                 persons = self.api.plshell.GetPersons(self.api.plauth, [person_dict['email']], ['person_id', 'key_ids'])   
300         
301             if not persons:
302                 person_id=self.api.plshell.AddPerson(self.api.plauth, person_dict)
303                 self.api.plshell.UpdatePerson(self.api.plauth, person_id, {'enabled' : True})
304                 
305                 # mark this person as an sfa peer record
306                 if sfa_peer:
307                     peer_dict = {'type': 'user', 'hrn': researcher, 'peer_authority': sfa_peer, 'pointer': person_id}
308                     registry.register_peer_object(credential, peer_dict)
309
310                 if peer:
311                     try:
312                         self.api.plshell.BindObjectToPeer(self.api.plauth, 'person', person_id, peer, person_dict['pointer'])
313                     except Exception,e:
314                         self.api.plshell.DeletePerson(self.api.plauth,person_id)
315                         raise e
316                 key_ids = []
317             else:
318                 person_id = persons[0]['person_id']
319                 key_ids = persons[0]['key_ids']
320
321
322             # if this is a peer person, we must unbind them from the peer or PLCAPI will throw
323             # an error
324             try:
325                 if peer and not local_person:
326                     self.api.plshell.UnBindObjectFromPeer(self.api.plauth, 'person', person_id, peer)
327                 if peer:
328                     self.api.plshell.UnBindObjectFromPeer(self.api.plauth, 'site', site_id,  peer)
329
330                 self.api.plshell.AddPersonToSlice(self.api.plauth, person_dict['email'], slicename)
331                 self.api.plshell.AddPersonToSite(self.api.plauth, person_dict['email'], site_id)
332             finally:
333                 if peer:
334                     try: self.api.plshell.BindObjectToPeer(self.api.plauth, 'site', site_id, peer, remote_site_id)
335                     except: pass
336                 if peer and not local_person:
337                     try: self.api.plshell.BindObjectToPeer(self.api.plauth, 'person', person_id, peer, person_dict['pointer'])
338                     except: pass
339             
340             self.verify_keys(registry, credential, person_dict, key_ids, person_id, peer, local_person)
341
342     def verify_keys(self, registry, credential, person_dict, key_ids, person_id,  peer, local_person):
343         keylist = self.api.plshell.GetKeys(self.api.plauth, key_ids, ['key'])
344         keys = [key['key'] for key in keylist]
345         
346         #add keys that arent already there
347         key_ids = person_dict['key_ids']
348         for personkey in person_dict['keys']:
349             if personkey not in keys:
350                 key = {'key_type': 'ssh', 'key': personkey}
351                 try:
352                     if peer:
353                         self.api.plshell.UnBindObjectFromPeer(self.api.plauth, 'person', person_id, peer)
354                     key_id = self.api.plshell.AddPersonKey(self.api.plauth, person_dict['email'], key)
355                 finally:
356                     if peer and not local_person:
357                         self.api.plshell.BindObjectToPeer(self.api.plauth, 'person', person_id, peer, person_dict['pointer'])
358                     if peer:
359                         # xxx - thierry how are we getting the peer_key_id in here ?
360                         try: self.api.plshell.BindObjectToPeer(self.api.plauth, 'key', key_id, peer, key_ids.pop(0))
361                         except: pass   
362
363     def create_slice_aggregate(self, xrn, rspec):
364         hrn, type = urn_to_hrn(xrn)
365         # Determine if this is a peer slice
366         peer = self.get_peer(hrn)
367         sfa_peer = self.get_sfa_peer(hrn)
368
369         spec = RSpec(rspec)
370         # Get the slice record from sfa
371         slicename = hrn_to_pl_slicename(hrn) 
372         slice = {}
373         slice_record = None
374         registry = self.api.registries[self.api.hrn]
375         credential = self.api.getCredential()
376
377         site_id, remote_site_id = self.verify_site(registry, credential, hrn, peer, sfa_peer)
378         slice = self.verify_slice(registry, credential, hrn, site_id, remote_site_id, peer, sfa_peer)
379
380         # find out where this slice is currently running
381         nodelist = self.api.plshell.GetNodes(self.api.plauth, slice['node_ids'], ['hostname'])
382         hostnames = [node['hostname'] for node in nodelist]
383
384         # get netspec details
385         nodespecs = spec.getDictsByTagName('NodeSpec')
386
387         # dict in which to store slice attributes to set for the nodes
388         nodes = {}
389         for nodespec in nodespecs:
390             if isinstance(nodespec['name'], list):
391                 for nodename in nodespec['name']:
392                     nodes[nodename] = {}
393                     for k in nodespec.keys():
394                         rspec_attribute_value = nodespec[k]
395                         if (self.rspec_to_slice_tag.has_key(k)):
396                             slice_tag_name = self.rspec_to_slice_tag[k]
397                             nodes[nodename][slice_tag_name] = rspec_attribute_value
398             elif isinstance(nodespec['name'], StringTypes):
399                 nodename = nodespec['name']
400                 nodes[nodename] = {}
401                 for k in nodespec.keys():
402                     rspec_attribute_value = nodespec[k]
403                     if (self.rspec_to_slice_tag.has_key(k)):
404                         slice_tag_name = self.rspec_to_slice_tag[k]
405                         nodes[nodename][slice_tag_name] = rspec_attribute_value
406
407                 for k in nodespec.keys():
408                     rspec_attribute_value = nodespec[k]
409                     if (self.rspec_to_slice_tag.has_key(k)):
410                         slice_tag_name = self.rspec_to_slice_tag[k]
411                         nodes[nodename][slice_tag_name] = rspec_attribute_value
412
413         node_names = nodes.keys()
414         # remove nodes not in rspec
415         deleted_nodes = list(set(hostnames).difference(node_names))
416         # add nodes from rspec
417         added_nodes = list(set(node_names).difference(hostnames))
418
419         try:
420             if peer:
421                 self.api.plshell.UnBindObjectFromPeer(self.api.plauth, 'slice', slice['slice_id'], peer)
422
423             self.api.plshell.AddSliceToNodes(self.api.plauth, slicename, added_nodes) 
424
425             # Add recognized slice tags
426             for node_name in node_names:
427                 node = nodes[node_name]
428                 for slice_tag in node.keys():
429                     value = node[slice_tag]
430                     if (isinstance(value, list)):
431                         value = value[0]
432
433                     self.api.plshell.AddSliceTag(self.api.plauth, slicename, slice_tag, value, node_name)
434
435             self.api.plshell.DeleteSliceFromNodes(self.api.plauth, slicename, deleted_nodes)
436         finally:
437             if peer:
438                 self.api.plshell.BindObjectToPeer(self.api.plauth, 'slice', slice['slice_id'], peer, slice['peer_slice_id'])
439
440         return 1
441
442     def sync_site(self, old_record, new_record, peer):
443         if old_record['max_slices'] != new_record['max_slices'] or old_record['max_slivers'] != new_record['max_slivers']:
444             try:
445                 if peer:
446                     self.api.plshell.UnBindObjectFromPeer(self.api.plauth, 'site', old_record['site_id'], peer)
447                 if old_record['max_slices'] != new_record['max_slices']:
448                     self.api.plshell.UpdateSite(self.api.plauth, old_record['site_id'], {'max_slices' : new_record['max_slices']})
449                 if old_record['max_slivers'] != new_record['max_slivers']:
450                     self.api.plshell.UpdateSite(self.api.plauth, old_record['site_id'], {'max_slivers' : new_record['max_slivers']})
451             finally:
452                 if peer:
453                     self.api.plshell.BindObjectToPeer(self.api.plauth, 'site', old_record['site_id'], peer, old_record['peer_site_id'])
454         return 1
455
456     def sync_slice(self, old_record, new_record, peer):
457         if old_record['expires'] != new_record['expires']:
458             try:
459                 if peer:
460                     self.api.plshell.UnBindObjectFromPeer(self.api.plauth, 'slice', old_record['slice_id'], peer)
461                 self.api.plshell.UpdateSlice(self.api.plauth, old_record['slice_id'], {'expires' : new_record['expires']})
462             finally:
463                 if peer:
464                     self.api.plshell.BindObjectToPeer(self.api.plauth, 'slice', old_record['slice_id'], peer, old_record['peer_slice_id'])
465         return 1