3 This module exposes an XMLRPC interface that allows PlanetLab users to
4 create/destroy slivers with delegated instantiation, start and stop
5 slivers, make resource loans, and examine resource allocations. The
6 XMLRPC is provided on a localhost-only TCP port as well as via a Unix
7 domain socket that is accessible by ssh-ing into a delegate account
8 with the forward_api_calls shell.
11 import SimpleXMLRPCServer
30 UNIX_ADDR = '/tmp/sliver_mgr.api'
32 deliver_ticket = None # set in sm.py:start()
37 def export_to_api(nargs):
39 nargs_dict[method.__name__] = nargs
40 api_method_dict[method.__name__] = method
47 """Help(): get help"""
48 return ''.join([method.__doc__ + '\n' for method in api_method_dict.itervalues()])
52 """Ticket(tkt): deliver a ticket"""
54 data = ticket.verify(tkt)
55 name = data['slivers'][0]['name']
58 logger.log('Ticket delivered for %s' % name)
59 Create(database.db.get(name))
60 except Exception, err:
61 raise xmlrpclib.Fault(102, 'Ticket error: ' + str(err))
65 """GetXIDs(): return an dictionary mapping slice names to XIDs"""
66 return dict([(pwent[0], pwent[2]) for pwent in pwd.getpwall() if pwent[6] == sliver_vs.Sliver_VS.SHELL])
70 """GetSSHKeys(): return an dictionary mapping slice names to SSH keys"""
72 for rec in database.db.itervalues():
74 keydict[rec['name']] = rec['keys']
79 """Create(sliver_name): create a non-PLC-instantiated sliver"""
80 if rec['instantiation'] == 'delegated': accounts.get(rec['name']).ensure_created(rec)
84 """Destroy(sliver_name): destroy a non-PLC-instantiated sliver"""
85 if rec['instantiation'] == 'delegated': accounts.get(rec['name']).ensure_destroyed()
89 """Start(sliver_name): run start scripts belonging to the specified sliver"""
90 accounts.get(rec['name']).start()
94 """Stop(sliver_name): kill all processes belonging to the specified sliver"""
95 accounts.get(rec['name']).stop()
98 def GetEffectiveRSpec(rec):
99 """GetEffectiveRSpec(sliver_name): return the RSpec allocated to the specified sliver, including loans"""
100 return rec.get('_rspec', {}).copy()
104 """GetRSpec(sliver_name): return the RSpec allocated to the specified sliver, excluding loans"""
105 return rec.get('rspec', {}).copy()
109 """GetLoans(sliver_name): return the list of loans made by the specified sliver"""
110 return rec.get('_loans', [])[:]
112 def validate_loans(obj):
113 """Check that <obj> is a valid loan specification."""
114 def validate_loan(obj): return (type(obj)==list or type(obj)==tuple) and len(obj)==3 and type(obj[0])==str and type(obj[1])==str and obj[1] in database.LOANABLE_RESOURCES and type(obj[2])==int and obj[2]>=0
115 return type(obj)==list and False not in map(validate_loan, obj)
118 def SetLoans(rec, loans):
119 """SetLoans(sliver_name, loans): overwrite the list of loans made by the specified sliver"""
120 if not validate_loans(loans): raise xmlrpclib.Fault(102, 'Invalid argument: the second argument must be a well-formed loan specification')
121 rec['_loans'] = loans
125 class APIRequestHandler(SimpleXMLRPCServer.SimpleXMLRPCRequestHandler):
126 # overriding _dispatch to achieve this effect is officially deprecated,
127 # but I can't figure out how to get access to .request without
128 # duplicating SimpleXMLRPCServer code here, which is more likely to
129 # change than the deprecated behavior is to be broken
131 @database.synchronized
132 def _dispatch(self, method_name_unicode, args):
133 method_name = str(method_name_unicode)
134 try: method = api_method_dict[method_name]
136 api_method_list = api_method_dict.keys()
137 api_method_list.sort()
138 raise xmlrpclib.Fault(100, 'Invalid API method %s. Valid choices are %s' % \
139 (method_name, ', '.join(api_method_list)))
140 expected_nargs = nargs_dict[method_name]
141 if len(args) != expected_nargs:
142 raise xmlrpclib.Fault(101, 'Invalid argument count: got %d, expecting %d.' % \
143 (len(args), expected_nargs))
145 # Figure out who's calling.
146 # XXX - these ought to be imported directly from some .h file
148 sizeof_struct_ucred = 12
149 ucred = self.request.getsockopt(socket.SOL_SOCKET, SO_PEERCRED, sizeof_struct_ucred)
150 xid = struct.unpack('3i', ucred)[2]
151 caller_name = pwd.getpwuid(xid)[0]
152 if method_name not in ('ReCreate', 'Help', 'Ticket', 'GetXIDs', 'GetSSHKeys'):
153 target_name = args[0]
154 target_rec = database.db.get(target_name)
155 if not (target_rec and target_rec['type'].startswith('sliver.')):
156 raise xmlrpclib.Fault(102, \
157 'Invalid argument: the first argument must be a sliver name.')
158 if not caller_name in (target_name, target_rec['delegations']):
159 raise xmlrpclib.Fault(108, 'Permission denied.')
160 result = method(target_rec, *args[1:])
161 else: result = method(*args)
162 if result == None: result = 1
165 class APIServer_INET(SocketServer.ThreadingMixIn, SimpleXMLRPCServer.SimpleXMLRPCServer): allow_reuse_address = True
167 class APIServer_UNIX(APIServer_INET): address_family = socket.AF_UNIX
170 """Start two XMLRPC interfaces: one bound to localhost, the other bound to a Unix domain socket."""
171 serv1 = APIServer_INET(('127.0.0.1', API_SERVER_PORT), requestHandler=APIRequestHandler, logRequests=0)
172 tools.as_daemon_thread(serv1.serve_forever)
173 try: os.unlink(UNIX_ADDR)
175 if e.errno != errno.ENOENT: raise
176 serv2 = APIServer_UNIX(UNIX_ADDR, requestHandler=APIRequestHandler, logRequests=0)
177 tools.as_daemon_thread(serv2.serve_forever)
178 os.chmod(UNIX_ADDR, 0666)