1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
|
#
# Copyright 2017 Ettus Research (National Instruments)
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
"""
Implemented RPC Servers
"""
from __future__ import print_function
from gevent.server import StreamServer
from gevent.pool import Pool
from gevent import signal
from gevent import spawn_later
from gevent import Greenlet
from gevent import monkey
monkey.patch_all()
from mprpc import RPCServer
from random import choice
from string import ascii_letters, digits
from multiprocessing import Process
from .mpmlog import get_main_logger
class MPMServer(RPCServer):
"""
Main MPM RPC class which holds the periph_manager object and translates
RPC calls to appropiate calls in the periph_manager and dboard_managers.
Claiming and unclaiming is implemented in python only
"""
_db_methods = []
_mb_methods = []
def __init__(self, state, mgr, *args, **kwargs):
self.log = get_main_logger().getChild('RPCServer')
self._state = state
self._timer = Greenlet()
self.periph_manager = mgr
# add public mboard methods without namespace
self._update_component_commands(mgr, '', '_mb_methods')
# add public dboard methods in `db_<slot>_` namespace
for db_slot, dboard in enumerate(mgr.dboards):
self._update_component_commands(dboard, 'db_' + str(db_slot) + '_', '_db_methods')
super(MPMServer, self).__init__(*args, **kwargs)
def _update_component_commands(self, component, namespace, storage):
"""
Detect available methods for an object and add them to the RPC server
"""
for method in (m for m in dir(component)
if not m.startswith('_') and callable(getattr(component, m))):
if method.startswith('safe_'):
command_name = namespace + method.lstrip('safe_')
self._add_safe_command(getattr(component, method), command_name)
else:
command_name = namespace + method
self._add_command(getattr(component, method), command_name)
getattr(self, storage).append(command_name)
def _add_command(self, function, command):
"""
Adds a method with the name command to the RPC server
This command will require an acquired claim on the device
"""
self.log.trace("adding command %s pointing to %s", command, function)
def new_function(token, *args):
if token[:256] != self._state.claim_token.value:
return False
return function(*args)
new_function.__doc__ = function.__doc__
setattr(self, command, new_function)
def _add_safe_command(self, function, command):
"""
Add a safe method which does not require a claim on the
device
"""
self.log.trace("adding safe command %s pointing to %s", command, function)
setattr(self, command, function)
def list_methods(self):
"""
Returns a tuple of public methods and
corresponding docs of this RPC server
"""
return [(met, getattr(self, met).__doc__)
for met in dir(self)
if not met.startswith('_') and callable(getattr(self, met))]
def ping(self, data=None):
"""
Take in data as argument and send it back
This is a safe method which can be called without a claim on the device
"""
self.log.debug("I was pinged from: %s:%s", self.client_host, self.client_port)
return data
def claim(self, sender_id):
"""
claim `token` - tries to claim MPM device and provides a human readable sender_id
This is a safe method which can be called without a claim on the device
"""
self._state.lock.acquire()
if self._state.claim_status.value:
return ""
self.log.debug("claiming from: %s", self.client_host)
self.periph_manager.claimed = True
self._state.claim_token.value = ''.join(choice(ascii_letters + digits) for _ in range(256))
self._state.claim_status.value = True
self._state.lock.release()
self.sender_id = sender_id
self._reset_timer()
self.log.debug("giving token: %s to host: %s", self._state.claim_token.value, self.client_host)
return self._state.claim_token.value
def reclaim(self, token):
"""
reclaim a MPM device with a token. This operation will fail
if the device is claimed and the token doesn't match.
Or if the device is not claimed at all.
"""
self._state.lock.acquire()
if self._state.claim_status.value:
if self._state.claim_token.value == token[:256]:
self._state.lock.release()
self.log.debug("reclaimed from: %s", self.client_host)
self._reset_timer()
return True
self._state.lock.release()
self.log.debug("reclaim failed from: %s", self.client_host)
return False
self.log.debug("trying to reclaim unclaimed device from: %s", self.client_host)
return False
def _unclaim(self):
"""
unconditional unclaim - for internal use
"""
self.log.debug("releasing claim")
self._state.claim_status.value = False
self._state.claim_token.value = ""
self.sender_id = None
self.periph_manager.claimed = False
self._timer.kill()
def _reset_timer(self):
"""
reset unclaim timer
"""
self._timer.kill()
self._timer = spawn_later(2.0, self._unclaim)
def unclaim(self, token):
"""
unclaim `token` - unclaims the MPM device if it is claimed with this token
"""
if self._state.claim_status.value and self._state.claim_token.value == token:
self._unclaim()
return True
return False
def get_device_info(self):
"""
get device information
This is as safe method which can be called without a claim on the device
"""
info = self.periph_manager._get_device_info()
if self.client_host in ["127.0.0.1", "::1"]:
info["connection"] = "local"
else:
info["connection"] = "remote"
return info
def allocate_sid(self, token, *args):
"""
Forwards the call to periph_manager._allocate_sid with the client ip addresss
as argument. Should be used to setup interfaces
"""
return self.periph_manager._allocate_sid(self.client_host, *args)
def _rpc_server_process(shared_state, port, mgr):
"""
Start the RPC server
"""
connections = Pool(1000)
server = StreamServer(
('0.0.0.0', port),
handle=MPMServer(shared_state, mgr),
spawn=connections)
# catch signals and stop the stream server
signal(signal.SIGTERM, lambda *args: server.stop())
signal(signal.SIGINT, lambda *args: server.stop())
server.serve_forever()
def spawn_rpc_process(state, udp_port, mgr):
"""
Returns a process that contains the RPC server
"""
proc_args = [udp_port, state, mgr]
proc = Process(target=_rpc_server_process, args=proc_args)
proc.start()
return proc
|
