further refinements to plslices
[sfa.git] / sfa / planetlab / plslices.py
1 import time
2 from types import StringTypes
3 from collections import defaultdict
4
5 from sfa.util.sfatime import utcparse, datetime_to_epoch
6 from sfa.util.sfalogging import logger
7 from sfa.util.xrn import Xrn, get_leaf, get_authority, urn_to_hrn
8 from sfa.rspecs.rspec import RSpec
9 from sfa.planetlab.vlink import VLink
10 from sfa.planetlab.topology import Topology
11 from sfa.planetlab.plxrn import PlXrn, hrn_to_pl_slicename, xrn_to_hostname, top_auth, hash_loginbase
12 from sfa.storage.model import SliverAllocation
13
14 MAXINT =  2L**31-1
15
16 class PlSlices:
17
18     rspec_to_slice_tag = {'max_rate':'net_max_rate'}
19
20     def __init__(self, driver):
21         self.driver = driver
22
23     def get_slivers(self, xrn, node=None):
24         hrn, type = urn_to_hrn(xrn)
25          
26         slice_name = hrn_to_pl_slicename(hrn)
27         # XX Should we just call PLCAPI.GetSliceTicket(slice_name) instead
28         # of doing all of this?
29         #return self.driver.shell.GetSliceTicket(self.auth, slice_name) 
30         
31         # from PLCAPI.GetSlivers.get_slivers()
32         slice_fields = ['slice_id', 'name', 'instantiation', 'expires', 'person_ids', 'slice_tag_ids']
33         slices = self.driver.shell.GetSlices(slice_name, slice_fields)
34         # Build up list of users and slice attributes
35         person_ids = set()
36         all_slice_tag_ids = set()
37         for slice in slices:
38             person_ids.update(slice['person_ids'])
39             all_slice_tag_ids.update(slice['slice_tag_ids'])
40         person_ids = list(person_ids)
41         all_slice_tag_ids = list(all_slice_tag_ids)
42         # Get user information
43         all_persons_list = self.driver.shell.GetPersons({'person_id':person_ids,'enabled':True}, 
44                                                         ['person_id', 'enabled', 'key_ids'])
45         all_persons = {}
46         for person in all_persons_list:
47             all_persons[person['person_id']] = person        
48
49         # Build up list of keys
50         key_ids = set()
51         for person in all_persons.values():
52             key_ids.update(person['key_ids'])
53         key_ids = list(key_ids)
54         # Get user account keys
55         all_keys_list = self.driver.shell.GetKeys(key_ids, ['key_id', 'key', 'key_type'])
56         all_keys = {}
57         for key in all_keys_list:
58             all_keys[key['key_id']] = key
59         # Get slice attributes
60         all_slice_tags_list = self.driver.shell.GetSliceTags(all_slice_tag_ids)
61         all_slice_tags = {}
62         for slice_tag in all_slice_tags_list:
63             all_slice_tags[slice_tag['slice_tag_id']] = slice_tag
64            
65         slivers = []
66         for slice in slices:
67             keys = []
68             for person_id in slice['person_ids']:
69                 if person_id in all_persons:
70                     person = all_persons[person_id]
71                     if not person['enabled']:
72                         continue
73                     for key_id in person['key_ids']:
74                         if key_id in all_keys:
75                             key = all_keys[key_id]
76                             keys += [{'key_type': key['key_type'],
77                                     'key': key['key']}]
78             attributes = []
79             # All (per-node and global) attributes for this slice
80             slice_tags = []
81             for slice_tag_id in slice['slice_tag_ids']:
82                 if slice_tag_id in all_slice_tags:
83                     slice_tags.append(all_slice_tags[slice_tag_id]) 
84             # Per-node sliver attributes take precedence over global
85             # slice attributes, so set them first.
86             # Then comes nodegroup slice attributes
87             # Followed by global slice attributes
88             sliver_attributes = []
89
90             if node is not None:
91                 for sliver_attribute in filter(lambda a: a['node_id'] == node['node_id'], slice_tags):
92                     sliver_attributes.append(sliver_attribute['tagname'])
93                     attributes.append({'tagname': sliver_attribute['tagname'],
94                                     'value': sliver_attribute['value']})
95
96             # set nodegroup slice attributes
97             for slice_tag in filter(lambda a: a['nodegroup_id'] in node['nodegroup_ids'], slice_tags):
98                 # Do not set any nodegroup slice attributes for
99                 # which there is at least one sliver attribute
100                 # already set.
101                 if slice_tag not in slice_tags:
102                     attributes.append({'tagname': slice_tag['tagname'],
103                         'value': slice_tag['value']})
104
105             for slice_tag in filter(lambda a: a['node_id'] is None, slice_tags):
106                 # Do not set any global slice attributes for
107                 # which there is at least one sliver attribute
108                 # already set.
109                 if slice_tag['tagname'] not in sliver_attributes:
110                     attributes.append({'tagname': slice_tag['tagname'],
111                                    'value': slice_tag['value']})
112
113             # XXX Sanity check; though technically this should be a system invariant
114             # checked with an assertion
115             if slice['expires'] > MAXINT:  slice['expires']= MAXINT
116             
117             slivers.append({
118                 'hrn': hrn,
119                 'name': slice['name'],
120                 'slice_id': slice['slice_id'],
121                 'instantiation': slice['instantiation'],
122                 'expires': slice['expires'],
123                 'keys': keys,
124                 'attributes': attributes
125             })
126
127         return slivers
128  
129
130     def get_sfa_peer(self, xrn):
131         hrn, type = urn_to_hrn(xrn)
132
133         # return the authority for this hrn or None if we are the authority
134         sfa_peer = None
135         slice_authority = get_authority(hrn)
136         site_authority = get_authority(slice_authority)
137
138         if site_authority != self.driver.hrn:
139             sfa_peer = site_authority
140
141         return sfa_peer
142
143     def verify_slice_leases(self, slice, rspec_requested_leases):
144
145         leases = self.driver.shell.GetLeases({'name':slice['name'], 'clip':int(time.time())}, 
146                                              ['lease_id','name', 'hostname', 't_from', 't_until'])
147         grain = self.driver.shell.GetLeaseGranularity()
148
149         requested_leases = []
150         for lease in rspec_requested_leases:
151              requested_lease = {}
152              slice_hrn, _ = urn_to_hrn(lease['slice_id'])
153
154              top_auth_hrn = top_auth(slice_hrn)
155              site_hrn = '.'.join(slice_hrn.split('.')[:-1])
156              slice_part = slice_hrn.split('.')[-1]
157              if top_auth_hrn == self.driver.hrn:
158                  login_base = slice_hrn.split('.')[-2][:12]
159              else:
160                  login_base = hash_loginbase(site_hrn)
161
162              slice_name = '_'.join([login_base, slice_part])
163
164              if slice_name != slice['name']:
165                  continue
166              elif Xrn(lease['component_id']).get_authority_urn().split(':')[0] != self.driver.hrn:
167                  continue
168
169              hostname = xrn_to_hostname(lease['component_id'])
170              # fill the requested node with nitos ids
171              requested_lease['name'] = slice['name']
172              requested_lease['hostname'] = hostname
173              requested_lease['t_from'] = int(lease['start_time'])
174              requested_lease['t_until'] = int(lease['duration']) * grain + int(lease['start_time'])
175              requested_leases.append(requested_lease)
176
177
178
179         # prepare actual slice leases by lease_id  
180         leases_by_id = {}
181         for lease in leases:
182              leases_by_id[lease['lease_id']] = {'name': lease['name'], 'hostname': lease['hostname'], \
183                                                 't_from': lease['t_from'], 't_until': lease['t_until']}
184         
185         added_leases = []
186         kept_leases_id = []
187         deleted_leases_id = []
188         for lease_id in leases_by_id:
189              if leases_by_id[lease_id] not in requested_leases:
190                  deleted_leases_id.append(lease_id)
191              else:
192                  kept_leases_id.append(lease_id)
193                  requested_leases.remove(leases_by_id[lease_id])
194         added_leases = requested_leases
195    
196
197         try:
198             self.driver.shell.DeleteLeases(deleted_leases_id)
199             for lease in added_leases:
200                 self.driver.shell.AddLeases(lease['hostname'], slice['name'], lease['t_from'], lease['t_until'])
201
202         except: 
203             logger.log_exc('Failed to add/remove slice leases')
204
205         return leases
206
207
208     def verify_slice_nodes(self, slice_urn, slice, rspec_nodes):
209         
210         slivers = {}
211         for node in rspec_nodes:
212             hostname = node.get('component_name')
213             client_id = node.get('client_id')
214             component_id = node.get('component_id').strip()    
215             if hostname:
216                 hostname = hostname.strip()
217             elif component_id:
218                 hostname = xrn_to_hostname(component_id)
219             if hostname:
220                 slivers[hostname] = {'client_id': client_id, 'component_id': component_id}
221         
222         nodes = self.driver.shell.GetNodes(slice['node_ids'], ['node_id', 'hostname', 'interface_ids'])
223         current_slivers = [node['hostname'] for node in nodes]
224
225         # remove nodes not in rspec
226         deleted_nodes = list(set(current_slivers).difference(slivers.keys()))
227
228         # add nodes from rspec
229         added_nodes = list(set(slivers.keys()).difference(current_slivers))        
230
231         try:
232             self.driver.shell.AddSliceToNodes(slice['name'], added_nodes)
233             self.driver.shell.DeleteSliceFromNodes(slice['name'], deleted_nodes)
234             
235         except: 
236             logger.log_exc('Failed to add/remove slice from nodes')
237
238         slices = self.driver.shell.GetSlices(slice['name'], ['node_ids']) 
239         resulting_nodes = self.driver.shell.GetNodes(slices[0]['node_ids'])
240
241         # update sliver allocations
242         for node in resulting_nodes:
243             client_id = slivers[node['hostname']]['client_id']
244             component_id = slivers[node['hostname']]['component_id']
245             sliver_hrn = '%s.%s-%s' % (self.driver.hrn, slice['slice_id'], node['node_id'])
246             sliver_id = Xrn(sliver_hrn, type='sliver').urn
247             record = SliverAllocation(sliver_id=sliver_id, client_id=client_id, 
248                                       component_id=component_id,
249                                       slice_urn = slice_urn, 
250                                       allocation_state='geni_allocated')      
251             record.sync(self.driver.api.dbsession())
252         return resulting_nodes
253
254     def free_egre_key(self):
255         used = set()
256         for tag in self.driver.shell.GetSliceTags({'tagname': 'egre_key'}):
257                 used.add(int(tag['value']))
258
259         for i in range(1, 256):
260             if i not in used:
261                 key = i
262                 break
263         else:
264             raise KeyError("No more EGRE keys available")
265
266         return str(key)
267
268     def verify_slice_links(self, slice, requested_links, nodes):
269          
270         if not requested_links:
271             return
272
273         # exit if links are not supported here
274         topology = Topology()
275         if not topology:
276             return 
277
278         # build dict of nodes 
279         nodes_dict = {}
280         interface_ids = []
281         for node in nodes:
282             nodes_dict[node['node_id']] = node
283             interface_ids.extend(node['interface_ids'])
284         # build dict of interfaces
285         interfaces = self.driver.shell.GetInterfaces(interface_ids)
286         interfaces_dict = {}
287         for interface in interfaces:
288             interfaces_dict[interface['interface_id']] = interface 
289
290         slice_tags = []
291         
292         # set egre key
293         slice_tags.append({'name': 'egre_key', 'value': self.free_egre_key()})
294     
295         # set netns
296         slice_tags.append({'name': 'netns', 'value': '1'})
297
298         # set cap_net_admin 
299         # need to update the attribute string?
300         slice_tags.append({'name': 'capabilities', 'value': 'CAP_NET_ADMIN'}) 
301         
302         for link in requested_links:
303             # get the ip address of the first node in the link
304             ifname1 = Xrn(link['interface1']['component_id']).get_leaf()
305
306             if ifname1:
307                 ifname_parts = ifname1.split(':')
308                 node_raw = ifname_parts[0]
309                 device = None
310                 if len(ifname_parts) > 1:
311                     device = ifname_parts[1] 
312                 node_id = int(node_raw.replace('node', ''))
313                 node = nodes_dict[node_id]
314                 if1 = interfaces_dict[node['interface_ids'][0]]
315                 ipaddr = if1['ip']
316                 topo_rspec = VLink.get_topo_rspec(link, ipaddr)
317                 # set topo_rspec tag
318                 slice_tags.append({'name': 'topo_rspec', 'value': str([topo_rspec]), 'node_id': node_id})
319                 # set vini_topo tag
320                 slice_tags.append({'name': 'vini_topo', 'value': 'manual', 'node_id': node_id})
321                 #self.driver.shell.AddSliceTag(slice['name'], 'topo_rspec', str([topo_rspec]), node_id) 
322
323         self.verify_slice_attributes(slice, slice_tags, {'append': True}, admin=True)
324                         
325         
326
327     def verify_site(self, slice_xrn, slice_record=None, sfa_peer=None, options=None):
328         if slice_record is None: slice_record={}
329         if options is None: options={}
330         (slice_hrn, type) = urn_to_hrn(slice_xrn)
331         top_auth_hrn = top_auth(slice_hrn)
332         site_hrn = '.'.join(slice_hrn.split('.')[:-1])
333         if top_auth_hrn == self.driver.hrn:
334             login_base = slice_hrn.split('.')[-2][:12]
335         else:
336             login_base = hash_loginbase(site_hrn)
337
338         # filter sites by hrn
339         sites = self.driver.shell.GetSites({'peer_id': None, 'hrn':site_hrn},
340                                            ['site_id','name','abbreviated_name','login_base','hrn'])
341
342         # alredy exists
343         if sites:
344             site = sites[0]
345         else:
346             # create new site record
347             site = {'name': 'sfa:%s' % site_hrn,
348                     'abbreviated_name': site_hrn,
349                     'login_base': login_base,
350                     'max_slices': 100,
351                     'max_slivers': 1000,
352                     'enabled': True,
353                     'peer_site_id': None,
354                     'hrn':site_hrn,
355                     'sfa_created': 'True',
356             }
357             site_id = self.driver.shell.AddSite(site)
358             site['site_id'] = site_id
359             # exempt federated sites from monitor policies
360             self.driver.shell.AddSiteTag(site_id, 'exempt_site_until', "20200101")
361
362         return site
363
364
365     def verify_slice(self, slice_hrn, slice_record, sfa_peer, expiration, options=None):
366         if options is None: options={}
367         top_auth_hrn = top_auth(slice_hrn)
368         site_hrn = '.'.join(slice_hrn.split('.')[:-1])
369         slice_part = slice_hrn.split('.')[-1]
370         if top_auth_hrn == self.driver.hrn:
371             login_base = slice_hrn.split('.')[-2][:12]
372         else:
373             login_base = hash_loginbase(site_hrn)
374         slice_name = '_'.join([login_base, slice_part])
375
376         expires = int(datetime_to_epoch(utcparse(expiration)))
377         # Filter slices by HRN
378         slices = self.driver.shell.GetSlices({'peer_id': None, 'hrn':slice_hrn},
379                                              ['slice_id','name','hrn','expires'])
380         
381         if slices:
382             slice = slices[0]
383             slice_id = slice['slice_id']
384             #Update expiration if necessary
385             if slice.get('expires', None) != expires:
386                 self.driver.shell.UpdateSlice( slice_id, {'expires' : expires})
387         else:
388             if slice_record:
389                 url = slice_record.get('url', slice_hrn)
390                 description = slice_record.get('description', slice_hrn)
391             else:
392                 url = slice_hrn
393                 description = slice_hrn
394             slice = {'name': slice_name,
395                      'url': url,
396                      'description': description,
397                      'hrn': slice_hrn,
398                      'sfa_created': 'True',
399                      'expires': expires,
400             }
401             # add the slice
402             slice_id = self.driver.shell.AddSlice(slice)
403
404         return self.driver.shell.GetSlices(slice_id)[0]
405
406
407     # in the following code, we use
408     # 'person' to denote a PLCAPI-like record with typically 'person_id' and 'email'
409     # 'user' to denote an incoming record with typically 'urn' and 'email' - we add 'hrn' in there
410     #        'slice_record': it seems like the first of these 'users' also contains a 'slice_record' 
411     #           key that holds stuff like 'hrn', 'slice_id', 'authority',...
412     # 
413     def create_person (self, user, site_id):
414         user_hrn = user['hrn']
415         # the value to use if 'user' has no 'email' attached - xxx should be configurable
416         default_email = "%s@geni.net"%user_hrn.split('.')[-1]
417         # PLCAPI requires at least these to be set
418
419         person_record = { 
420             'first_name': user.get('first_name',user_hrn),
421             'last_name': user.get('last_name',user_hrn),
422             'email': user.get('email', default_email),
423             'enabled': True,
424             'sfa_created': 'True',
425             'hrn': user_hrn,
426         }
427
428         person_id = int (self.driver.shell.AddPerson(person_record))
429         self.driver.shell.AddRoleToPerson('user', person_id)
430         self.driver.shell.AddPersonToSite(person_id, site['site_id'])
431
432         return person_id
433
434     def verify_persons(self, slice_hrn, slice_record, users, sfa_peer, options=None):
435         if options is None: options={}
436
437         # first we annotate the incoming users arg with a 'hrn' key
438         for user in users:
439            user['hrn'], _ = urn_to_hrn(user['urn'])
440         # this is for retrieving users from a hrn
441         users_by_hrn = { user['hrn'] : user for user in users }
442
443         # compute the hrn's for the authority and site
444         top_auth_hrn = top_auth(slice_hrn)
445         site_hrn = '.'.join(slice_hrn.split('.')[:-1])
446         slice_part = slice_hrn.split('.')[-1]
447         # deduce login_base and slice_name
448         if top_auth_hrn == self.driver.hrn:
449             login_base = slice_hrn.split('.')[-2][:12]
450         else:
451             login_base = hash_loginbase(site_hrn)
452         slice_name = '_'.join([login_base, slice_part])
453
454         # locate the site object
455         # due to a limitation in PLCAPI, we have to specify 'hrn' as part of the return fields
456         site = self.driver.shell.GetSites ({'peer_id':None, 'hrn':site_hrn}, ['site_id','hrn'])[0]
457         site_id = site['site_id']
458
459         # locate the slice object
460         slice = self.driver.shell.GetSlices ({'peer_id':None, 'hrn':slice_hrn}, ['slice_id','hrn','person_ids'])[0]
461         slice_id = slice['slice_id']
462         slice_person_ids = slice['person_ids']
463
464         # the common set of attributes for our calls to GetPersons
465         person_fields = ['person_id','email','hrn']
466
467         # for the intended set of hrns, locate existing persons
468         target_hrns = [ user['hrn'] for user in users ]
469         target_existing_persons = self.driver.shell.GetPersons ({'peer_id':None, 'hrn': target_hrns}, person_fields)
470         target_existing_person_ids = [ person ['person_id'] for person in target_existing_persons ]
471         # find out the hrns that *do not* have a corresponding person
472         existing_hrns = [ person['hrn'] for person in target_existing_persons ]
473         tocreate_hrns = set (target_hrns) - set (existing_hrns)
474         # create these
475         target_created_person_ids = [ self.create_person (users_by_hrn[hrn], site_id) for hrn in tocreate_hrns ]
476
477         # we can partition the persons of interest into one of these 3 classes
478         add_person_ids  = set(target_created_person_ids) | set(target_existing_person_ids) - set(slice_person_ids)
479         keep_person_ids = set(target_existing_person_ids) & set(slice_person_ids)
480         del_person_ids  = set(slice_person_ids) - set(target_existing_person_ids)
481
482         # delete 
483         for person_id in del_person_ids:
484             self.driver.shell.DeletePersonFromSlice (person_id, slice_id)
485
486         # about the last 2 sets, for managing keys, we need to trace back person_id -> user
487         # and for this we need all the Person objects; we already have the target_existing ones
488         # also we avoid issuing a call if possible
489         target_created_persons = [] if not target_created_person_ids \
490                                  else driver.shell.GetPersons ({'peer_id':None, 'person_id':target_created_person_ids},
491                                                                person_fields)
492         persons_by_person_id = { person['person_id'] : person \
493                                  for person in target_existing_persons + target_created_persons }
494
495         def user_by_person_id (person_id):
496             person = persons_by_person_id [person_id]
497             hrn = person ['hrn']
498             return users_by_hrn [hrn]
499         
500         persons_to_verify_keys = {}
501         # add 
502         for person_id in add_person_ids:
503             self.driver.shell.AddPersonToSlice(person_id, slice_id)
504             persons_to_verify_keys[person_id] = user_by_person_id(person_id)
505         # Update kept persons
506         for person_id in keep_person_ids:
507             persons_to_verify_keys[person_id] = user_by_person_id(person_id)
508         self.verify_keys(persons_to_verify_keys, options)
509
510         # return hrns of the newly added persons
511
512         return [ persons_by_person_id[person_id]['hrn'] for person_id in add_person_ids ]
513
514     def verify_keys(self, persons_to_verify_keys, options=None):
515         if options is None: options={}
516         # we only add keys that comes from sfa to persons in PL
517         for person_id in persons_to_verify_keys:
518              person_sfa_keys = persons_to_verify_keys[person_id].get('keys', [])
519              person_pl_keys = self.driver.shell.GetKeys({'person_id': int(person_id)})
520              person_pl_keys_list = [key['key'] for key in person_pl_keys]
521
522              keys_to_add = set(person_sfa_keys).difference(person_pl_keys_list)
523
524              for key_string in keys_to_add:
525                   key = {'key': key_string, 'key_type': 'ssh'}
526                   self.driver.shell.AddPersonKey(int(person_id), key)
527
528
529     def verify_slice_attributes(self, slice, requested_slice_attributes, options=None, admin=False):
530         if options is None: options={}
531         append = options.get('append', True)
532         # get list of attributes users ar able to manage
533         filter = {'category': '*slice*'}
534         if not admin:
535             filter['|roles'] = ['user']
536         slice_attributes = self.driver.shell.GetTagTypes(filter)
537         valid_slice_attribute_names = [attribute['tagname'] for attribute in slice_attributes]
538
539         # get sliver attributes
540         added_slice_attributes = []
541         removed_slice_attributes = []
542         # we need to keep the slice hrn anyway
543         ignored_slice_attribute_names = ['hrn']
544         existing_slice_attributes = self.driver.shell.GetSliceTags({'slice_id': slice['slice_id']})
545
546         # get attributes that should be removed
547         for slice_tag in existing_slice_attributes:
548             if slice_tag['tagname'] in ignored_slice_attribute_names:
549                 # If a slice already has a admin only role it was probably given to them by an
550                 # admin, so we should ignore it.
551                 ignored_slice_attribute_names.append(slice_tag['tagname'])
552                 attribute_found=True
553             else:
554                 # If an existing slice attribute was not found in the request it should
555                 # be removed
556                 attribute_found=False
557                 for requested_attribute in requested_slice_attributes:
558                     if requested_attribute['name'] == slice_tag['tagname'] and \
559                        requested_attribute['value'] == slice_tag['value']:
560                         attribute_found=True
561                         break
562
563             if not attribute_found and not append:
564                 removed_slice_attributes.append(slice_tag)
565
566         # get attributes that should be added:
567         for requested_attribute in requested_slice_attributes:
568             # if the requested attribute wasn't found  we should add it
569             if requested_attribute['name'] in valid_slice_attribute_names:
570                 attribute_found = False
571                 for existing_attribute in existing_slice_attributes:
572                     if requested_attribute['name'] == existing_attribute['tagname'] and \
573                        requested_attribute['value'] == existing_attribute['value']:
574                         attribute_found=True
575                         break
576                 if not attribute_found:
577                     added_slice_attributes.append(requested_attribute)
578
579
580         # remove stale attributes
581         for attribute in removed_slice_attributes:
582             try:
583                 self.driver.shell.DeleteSliceTag(attribute['slice_tag_id'])
584             except Exception, e:
585                 logger.warn('Failed to remove sliver attribute. name: %s, value: %s, node_id: %s\nCause:%s'\
586                                 % (slice['name'], attribute['value'],  attribute.get('node_id'), str(e)))
587
588         # add requested_attributes
589         for attribute in added_slice_attributes:
590             try:
591                 self.driver.shell.AddSliceTag(slice['name'], attribute['name'], 
592                                               attribute['value'], attribute.get('node_id', None))
593             except Exception, e:
594                 logger.warn('Failed to add sliver attribute. name: %s, value: %s, node_id: %s\nCause:%s'\
595                                 % (slice['name'], attribute['value'],  attribute.get('node_id'), str(e)))
596