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
29 UNIX_ADDR = '/tmp/sliver_mgr.api'
31 deliver_ticket = None # set in sm.py:start()
36 def export_to_api(nargs):
38 nargs_dict[method.__name__] = nargs
39 api_method_dict[method.__name__] = method
46 """Help(): get help"""
47 return ''.join([method.__doc__ + '\n' for method in api_method_dict.itervalues()])
51 """Ticket(tkt): deliver a ticket"""
54 data = ticket.verify(tkt)
58 if not succeeded: raise xmlrpclib.Fault(102, 'Invalid argument: the sole argument must be a valid ticket as returned from GetTicket().')
62 """Create(sliver_name): create a non-PLC-instantiated sliver"""
63 if rec['instantiation'] == 'delegated': accounts.get(rec['name']).ensure_created(rec)
67 """Destroy(sliver_name): destroy a non-PLC-instantiated sliver"""
68 if rec['instantiation'] == 'delegated': accounts.get(rec['name']).ensure_destroyed()
72 """Start(sliver_name): run start scripts belonging to the specified sliver"""
73 accounts.get(rec['name']).start()
77 """Stop(sliver_name): kill all processes belonging to the specified sliver"""
78 accounts.get(rec['name']).stop()
81 def GetEffectiveRSpec(rec):
82 """GetEffectiveRSpec(sliver_name): return the RSpec allocated to the specified sliver, including loans"""
83 return rec.get('_rspec', {}).copy()
87 """GetRSpec(sliver_name): return the RSpec allocated to the specified sliver, excluding loans"""
88 return rec.get('rspec', {}).copy()
92 """GetLoans(sliver_name): return the list of loans made by the specified sliver"""
93 return rec.get('_loans', [])[:]
95 def validate_loans(obj):
96 """Check that <obj> is a valid loan specification."""
97 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
98 return type(obj)==list and False not in map(validate_loan, obj)
101 def SetLoans(rec, loans):
102 """SetLoans(sliver_name, loans): overwrite the list of loans made by the specified sliver"""
103 if not validate_loans(loans): raise xmlrpclib.Fault(102, 'Invalid argument: the second argument must be a well-formed loan specification')
104 rec['_loans'] = loans
108 class APIRequestHandler(SimpleXMLRPCServer.SimpleXMLRPCRequestHandler):
109 # overriding _dispatch to achieve this effect is officially deprecated,
110 # but I can't figure out how to get access to .request without
111 # duplicating SimpleXMLRPCServer code here, which is more likely to
112 # change than the deprecated behavior is to be broken
114 @database.synchronized
115 def _dispatch(self, method_name_unicode, args):
116 method_name = str(method_name_unicode)
117 try: method = api_method_dict[method_name]
119 api_method_list = api_method_dict.keys()
120 api_method_list.sort()
121 raise xmlrpclib.Fault(100, 'Invalid API method %s. Valid choices are %s' % (method_name, ', '.join(api_method_list)))
122 expected_nargs = nargs_dict[method_name]
123 if len(args) != expected_nargs: raise xmlrpclib.Fault(101, 'Invalid argument count: got %d, expecting %d.' % (len(args), expected_nargs))
125 # Figure out who's calling.
126 # XXX - these ought to be imported directly from some .h file
128 sizeof_struct_ucred = 12
129 ucred = self.request.getsockopt(socket.SOL_SOCKET, SO_PEERCRED, sizeof_struct_ucred)
130 xid = struct.unpack('3i', ucred)[2]
131 caller_name = pwd.getpwuid(xid)[0]
132 if method_name not in ('Help', 'Ticket'):
133 target_name = args[0]
134 target_rec = database.db.get(target_name)
135 if not (target_rec and target_rec['type'].startswith('sliver.')): raise xmlrpclib.Fault(102, 'Invalid argument: the first argument must be a sliver name.')
136 if not (caller_name in (args[0], 'root') or (caller_name, method_name) in target_rec['delegations']): raise xmlrpclib.Fault(108, 'Permission denied.')
137 result = method(target_rec, *args[1:])
138 else: result = method(*args)
139 if result == None: result = 1
142 class APIServer_INET(SocketServer.ThreadingMixIn, SimpleXMLRPCServer.SimpleXMLRPCServer): allow_reuse_address = True
144 class APIServer_UNIX(APIServer_INET): address_family = socket.AF_UNIX
147 """Start two XMLRPC interfaces: one bound to localhost, the other bound to a Unix domain socket."""
148 serv1 = APIServer_INET(('127.0.0.1', API_SERVER_PORT), requestHandler=APIRequestHandler, logRequests=0)
149 tools.as_daemon_thread(serv1.serve_forever)
150 try: os.unlink(UNIX_ADDR)
152 if e.errno != errno.ENOENT: raise
153 serv2 = APIServer_UNIX(UNIX_ADDR, requestHandler=APIRequestHandler, logRequests=0)
154 tools.as_daemon_thread(serv2.serve_forever)
155 os.chmod(UNIX_ADDR, 0666)