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