root / lib / luxi.py @ 04864530
History | View | Annotate | Download (8.1 kB)
1 | c2a03789 | Iustin Pop | #
|
---|---|---|---|
2 | c2a03789 | Iustin Pop | #
|
3 | c2a03789 | Iustin Pop | |
4 | c2a03789 | Iustin Pop | # Copyright (C) 2006, 2007 Google Inc.
|
5 | c2a03789 | Iustin Pop | #
|
6 | c2a03789 | Iustin Pop | # This program is free software; you can redistribute it and/or modify
|
7 | c2a03789 | Iustin Pop | # it under the terms of the GNU General Public License as published by
|
8 | c2a03789 | Iustin Pop | # the Free Software Foundation; either version 2 of the License, or
|
9 | c2a03789 | Iustin Pop | # (at your option) any later version.
|
10 | c2a03789 | Iustin Pop | #
|
11 | c2a03789 | Iustin Pop | # This program is distributed in the hope that it will be useful, but
|
12 | c2a03789 | Iustin Pop | # WITHOUT ANY WARRANTY; without even the implied warranty of
|
13 | c2a03789 | Iustin Pop | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
14 | c2a03789 | Iustin Pop | # General Public License for more details.
|
15 | c2a03789 | Iustin Pop | #
|
16 | c2a03789 | Iustin Pop | # You should have received a copy of the GNU General Public License
|
17 | c2a03789 | Iustin Pop | # along with this program; if not, write to the Free Software
|
18 | c2a03789 | Iustin Pop | # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
|
19 | c2a03789 | Iustin Pop | # 02110-1301, USA.
|
20 | c2a03789 | Iustin Pop | |
21 | c2a03789 | Iustin Pop | |
22 | c2a03789 | Iustin Pop | """Module for the unix socket protocol
|
23 | c2a03789 | Iustin Pop |
|
24 | c2a03789 | Iustin Pop | This module implements the local unix socket protocl. You only need
|
25 | c2a03789 | Iustin Pop | this module and the opcodes module in the client program in order to
|
26 | c2a03789 | Iustin Pop | communicate with the master.
|
27 | c2a03789 | Iustin Pop |
|
28 | c2a03789 | Iustin Pop | The module is also be used by the master daemon.
|
29 | c2a03789 | Iustin Pop |
|
30 | c2a03789 | Iustin Pop | """
|
31 | c2a03789 | Iustin Pop | |
32 | c2a03789 | Iustin Pop | import socket |
33 | c2a03789 | Iustin Pop | import collections |
34 | c2a03789 | Iustin Pop | import simplejson |
35 | c2a03789 | Iustin Pop | import time |
36 | 03a8dbdc | Iustin Pop | import errno |
37 | c2a03789 | Iustin Pop | |
38 | c2a03789 | Iustin Pop | from ganeti import opcodes |
39 | ceab32dd | Iustin Pop | from ganeti import constants |
40 | c2a03789 | Iustin Pop | |
41 | c2a03789 | Iustin Pop | |
42 | c2a03789 | Iustin Pop | KEY_REQUEST = 'request'
|
43 | c2a03789 | Iustin Pop | KEY_DATA = 'data'
|
44 | c2a03789 | Iustin Pop | REQ_SUBMIT = 'submit'
|
45 | c2a03789 | Iustin Pop | REQ_ABORT = 'abort'
|
46 | c2a03789 | Iustin Pop | REQ_QUERY = 'query'
|
47 | c2a03789 | Iustin Pop | |
48 | c2a03789 | Iustin Pop | DEF_CTMO = 10
|
49 | c2a03789 | Iustin Pop | DEF_RWTO = 60
|
50 | c2a03789 | Iustin Pop | |
51 | c2a03789 | Iustin Pop | |
52 | c2a03789 | Iustin Pop | class ProtocolError(Exception): |
53 | c2a03789 | Iustin Pop | """Denotes an error in the server communication"""
|
54 | c2a03789 | Iustin Pop | |
55 | c2a03789 | Iustin Pop | |
56 | c2a03789 | Iustin Pop | class ConnectionClosedError(ProtocolError): |
57 | c2a03789 | Iustin Pop | """Connection closed error"""
|
58 | c2a03789 | Iustin Pop | |
59 | c2a03789 | Iustin Pop | |
60 | c2a03789 | Iustin Pop | class TimeoutError(ProtocolError): |
61 | c2a03789 | Iustin Pop | """Operation timeout error"""
|
62 | c2a03789 | Iustin Pop | |
63 | c2a03789 | Iustin Pop | |
64 | c2a03789 | Iustin Pop | class EncodingError(ProtocolError): |
65 | c2a03789 | Iustin Pop | """Encoding failure on the sending side"""
|
66 | c2a03789 | Iustin Pop | |
67 | c2a03789 | Iustin Pop | |
68 | c2a03789 | Iustin Pop | class DecodingError(ProtocolError): |
69 | c2a03789 | Iustin Pop | """Decoding failure on the receiving side"""
|
70 | c2a03789 | Iustin Pop | |
71 | c2a03789 | Iustin Pop | |
72 | b77acb3e | Iustin Pop | class RequestError(ProtocolError): |
73 | b77acb3e | Iustin Pop | """Error on request
|
74 | b77acb3e | Iustin Pop |
|
75 | b77acb3e | Iustin Pop | This signifies an error in the request format or request handling,
|
76 | b77acb3e | Iustin Pop | but not (e.g.) an error in starting up an instance.
|
77 | b77acb3e | Iustin Pop |
|
78 | b77acb3e | Iustin Pop | Some common conditions that can trigger this exception:
|
79 | b77acb3e | Iustin Pop | - job submission failed because the job data was wrong
|
80 | b77acb3e | Iustin Pop | - query failed because required fields were missing
|
81 | b77acb3e | Iustin Pop |
|
82 | b77acb3e | Iustin Pop | """
|
83 | b77acb3e | Iustin Pop | |
84 | 03a8dbdc | Iustin Pop | class NoMasterError(ProtocolError): |
85 | 03a8dbdc | Iustin Pop | """The master cannot be reached
|
86 | 03a8dbdc | Iustin Pop |
|
87 | 03a8dbdc | Iustin Pop | This means that the master daemon is not running or the socket has
|
88 | 03a8dbdc | Iustin Pop | been removed.
|
89 | 03a8dbdc | Iustin Pop |
|
90 | 03a8dbdc | Iustin Pop | """
|
91 | 03a8dbdc | Iustin Pop | |
92 | b77acb3e | Iustin Pop | |
93 | c2a03789 | Iustin Pop | def SerializeJob(job): |
94 | c2a03789 | Iustin Pop | """Convert a job description to a string format.
|
95 | c2a03789 | Iustin Pop |
|
96 | c2a03789 | Iustin Pop | """
|
97 | c2a03789 | Iustin Pop | return simplejson.dumps(job.__getstate__())
|
98 | c2a03789 | Iustin Pop | |
99 | c2a03789 | Iustin Pop | |
100 | c2a03789 | Iustin Pop | def UnserializeJob(data): |
101 | c2a03789 | Iustin Pop | """Load a job from a string format"""
|
102 | c2a03789 | Iustin Pop | try:
|
103 | c2a03789 | Iustin Pop | new_data = simplejson.loads(data) |
104 | c2a03789 | Iustin Pop | except Exception, err: |
105 | c2a03789 | Iustin Pop | raise DecodingError("Error while unserializing: %s" % str(err)) |
106 | c2a03789 | Iustin Pop | job = opcodes.Job() |
107 | c2a03789 | Iustin Pop | job.__setstate__(new_data) |
108 | c2a03789 | Iustin Pop | return job
|
109 | c2a03789 | Iustin Pop | |
110 | c2a03789 | Iustin Pop | |
111 | c2a03789 | Iustin Pop | class Transport: |
112 | c2a03789 | Iustin Pop | """Low-level transport class.
|
113 | c2a03789 | Iustin Pop |
|
114 | c2a03789 | Iustin Pop | This is used on the client side.
|
115 | c2a03789 | Iustin Pop |
|
116 | c2a03789 | Iustin Pop | This could be replace by any other class that provides the same
|
117 | c2a03789 | Iustin Pop | semantics to the Client. This means:
|
118 | c2a03789 | Iustin Pop | - can send messages and receive messages
|
119 | c2a03789 | Iustin Pop | - safe for multithreading
|
120 | c2a03789 | Iustin Pop |
|
121 | c2a03789 | Iustin Pop | """
|
122 | c2a03789 | Iustin Pop | |
123 | c2a03789 | Iustin Pop | def __init__(self, address, timeouts=None, eom=None): |
124 | c2a03789 | Iustin Pop | """Constructor for the Client class.
|
125 | c2a03789 | Iustin Pop |
|
126 | c2a03789 | Iustin Pop | Arguments:
|
127 | c2a03789 | Iustin Pop | - address: a valid address the the used transport class
|
128 | c2a03789 | Iustin Pop | - timeout: a list of timeouts, to be used on connect and read/write
|
129 | c2a03789 | Iustin Pop | - eom: an identifier to be used as end-of-message which the
|
130 | c2a03789 | Iustin Pop | upper-layer will guarantee that this identifier will not appear
|
131 | c2a03789 | Iustin Pop | in any message
|
132 | c2a03789 | Iustin Pop |
|
133 | c2a03789 | Iustin Pop | There are two timeouts used since we might want to wait for a long
|
134 | c2a03789 | Iustin Pop | time for a response, but the connect timeout should be lower.
|
135 | c2a03789 | Iustin Pop |
|
136 | c2a03789 | Iustin Pop | If not passed, we use a default of 10 and respectively 60 seconds.
|
137 | c2a03789 | Iustin Pop |
|
138 | c2a03789 | Iustin Pop | Note that on reading data, since the timeout applies to an
|
139 | c2a03789 | Iustin Pop | invidual receive, it might be that the total duration is longer
|
140 | c2a03789 | Iustin Pop | than timeout value passed (we make a hard limit at twice the read
|
141 | c2a03789 | Iustin Pop | timeout).
|
142 | c2a03789 | Iustin Pop |
|
143 | c2a03789 | Iustin Pop | """
|
144 | c2a03789 | Iustin Pop | self.address = address
|
145 | c2a03789 | Iustin Pop | if timeouts is None: |
146 | c2a03789 | Iustin Pop | self._ctimeout, self._rwtimeout = DEF_CTMO, DEF_RWTO |
147 | c2a03789 | Iustin Pop | else:
|
148 | c2a03789 | Iustin Pop | self._ctimeout, self._rwtimeout = timeouts |
149 | c2a03789 | Iustin Pop | |
150 | c2a03789 | Iustin Pop | self.socket = None |
151 | c2a03789 | Iustin Pop | self._buffer = "" |
152 | c2a03789 | Iustin Pop | self._msgs = collections.deque()
|
153 | c2a03789 | Iustin Pop | |
154 | c2a03789 | Iustin Pop | if eom is None: |
155 | c2a03789 | Iustin Pop | self.eom = '\3' |
156 | c2a03789 | Iustin Pop | else:
|
157 | c2a03789 | Iustin Pop | self.eom = eom
|
158 | c2a03789 | Iustin Pop | |
159 | c2a03789 | Iustin Pop | try:
|
160 | c2a03789 | Iustin Pop | self.socket = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
|
161 | c2a03789 | Iustin Pop | self.socket.settimeout(self._ctimeout) |
162 | c2a03789 | Iustin Pop | try:
|
163 | c2a03789 | Iustin Pop | self.socket.connect(address)
|
164 | c2a03789 | Iustin Pop | except socket.timeout, err:
|
165 | 03a8dbdc | Iustin Pop | raise TimeoutError("Connect timed out: %s" % str(err)) |
166 | 03a8dbdc | Iustin Pop | except socket.error, err:
|
167 | 03a8dbdc | Iustin Pop | if err.args[0] == errno.ENOENT: |
168 | 03a8dbdc | Iustin Pop | raise NoMasterError((address,))
|
169 | 03a8dbdc | Iustin Pop | raise
|
170 | c2a03789 | Iustin Pop | self.socket.settimeout(self._rwtimeout) |
171 | 03a8dbdc | Iustin Pop | except (socket.error, NoMasterError):
|
172 | c2a03789 | Iustin Pop | if self.socket is not None: |
173 | c2a03789 | Iustin Pop | self.socket.close()
|
174 | c2a03789 | Iustin Pop | self.socket = None |
175 | c2a03789 | Iustin Pop | raise
|
176 | c2a03789 | Iustin Pop | |
177 | c2a03789 | Iustin Pop | def _CheckSocket(self): |
178 | c2a03789 | Iustin Pop | """Make sure we are connected.
|
179 | c2a03789 | Iustin Pop |
|
180 | c2a03789 | Iustin Pop | """
|
181 | c2a03789 | Iustin Pop | if self.socket is None: |
182 | c2a03789 | Iustin Pop | raise ProtocolError("Connection is closed") |
183 | c2a03789 | Iustin Pop | |
184 | c2a03789 | Iustin Pop | def Send(self, msg): |
185 | c2a03789 | Iustin Pop | """Send a message.
|
186 | c2a03789 | Iustin Pop |
|
187 | c2a03789 | Iustin Pop | This just sends a message and doesn't wait for the response.
|
188 | c2a03789 | Iustin Pop |
|
189 | c2a03789 | Iustin Pop | """
|
190 | c2a03789 | Iustin Pop | if self.eom in msg: |
191 | c2a03789 | Iustin Pop | raise EncodingError("Message terminator found in payload") |
192 | c2a03789 | Iustin Pop | self._CheckSocket()
|
193 | c2a03789 | Iustin Pop | try:
|
194 | c2a03789 | Iustin Pop | self.socket.sendall(msg + self.eom) |
195 | c2a03789 | Iustin Pop | except socket.timeout, err:
|
196 | c2a03789 | Iustin Pop | raise TimeoutError("Sending timeout: %s" % str(err)) |
197 | c2a03789 | Iustin Pop | |
198 | c2a03789 | Iustin Pop | def Recv(self): |
199 | c2a03789 | Iustin Pop | """Try to receive a messae from the socket.
|
200 | c2a03789 | Iustin Pop |
|
201 | c2a03789 | Iustin Pop | In case we already have messages queued, we just return from the
|
202 | c2a03789 | Iustin Pop | queue. Otherwise, we try to read data with a _rwtimeout network
|
203 | c2a03789 | Iustin Pop | timeout, and making sure we don't go over 2x_rwtimeout as a global
|
204 | c2a03789 | Iustin Pop | limit.
|
205 | c2a03789 | Iustin Pop |
|
206 | c2a03789 | Iustin Pop | """
|
207 | c2a03789 | Iustin Pop | self._CheckSocket()
|
208 | c2a03789 | Iustin Pop | etime = time.time() + self._rwtimeout
|
209 | c2a03789 | Iustin Pop | while not self._msgs: |
210 | c2a03789 | Iustin Pop | if time.time() > etime:
|
211 | c2a03789 | Iustin Pop | raise TimeoutError("Extended receive timeout") |
212 | c2a03789 | Iustin Pop | try:
|
213 | c2a03789 | Iustin Pop | data = self.socket.recv(4096) |
214 | c2a03789 | Iustin Pop | except socket.timeout, err:
|
215 | c2a03789 | Iustin Pop | raise TimeoutError("Receive timeout: %s" % str(err)) |
216 | c2a03789 | Iustin Pop | if not data: |
217 | c2a03789 | Iustin Pop | raise ConnectionClosedError("Connection closed while reading") |
218 | c2a03789 | Iustin Pop | new_msgs = (self._buffer + data).split(self.eom) |
219 | c2a03789 | Iustin Pop | self._buffer = new_msgs.pop()
|
220 | c2a03789 | Iustin Pop | self._msgs.extend(new_msgs)
|
221 | c2a03789 | Iustin Pop | return self._msgs.popleft() |
222 | c2a03789 | Iustin Pop | |
223 | c2a03789 | Iustin Pop | def Call(self, msg): |
224 | c2a03789 | Iustin Pop | """Send a message and wait for the response.
|
225 | c2a03789 | Iustin Pop |
|
226 | c2a03789 | Iustin Pop | This is just a wrapper over Send and Recv.
|
227 | c2a03789 | Iustin Pop |
|
228 | c2a03789 | Iustin Pop | """
|
229 | c2a03789 | Iustin Pop | self.Send(msg)
|
230 | c2a03789 | Iustin Pop | return self.Recv() |
231 | c2a03789 | Iustin Pop | |
232 | c2a03789 | Iustin Pop | def Close(self): |
233 | c2a03789 | Iustin Pop | """Close the socket"""
|
234 | c2a03789 | Iustin Pop | if self.socket is not None: |
235 | c2a03789 | Iustin Pop | self.socket.close()
|
236 | c2a03789 | Iustin Pop | self.socket = None |
237 | c2a03789 | Iustin Pop | |
238 | c2a03789 | Iustin Pop | |
239 | c2a03789 | Iustin Pop | class Client(object): |
240 | c2a03789 | Iustin Pop | """High-level client implementation.
|
241 | c2a03789 | Iustin Pop |
|
242 | c2a03789 | Iustin Pop | This uses a backing Transport-like class on top of which it
|
243 | c2a03789 | Iustin Pop | implements data serialization/deserialization.
|
244 | c2a03789 | Iustin Pop |
|
245 | c2a03789 | Iustin Pop | """
|
246 | ceab32dd | Iustin Pop | def __init__(self, address=None, timeouts=None, transport=Transport): |
247 | c2a03789 | Iustin Pop | """Constructor for the Client class.
|
248 | c2a03789 | Iustin Pop |
|
249 | c2a03789 | Iustin Pop | Arguments:
|
250 | c2a03789 | Iustin Pop | - address: a valid address the the used transport class
|
251 | c2a03789 | Iustin Pop | - timeout: a list of timeouts, to be used on connect and read/write
|
252 | c2a03789 | Iustin Pop | - transport: a Transport-like class
|
253 | c2a03789 | Iustin Pop |
|
254 | c2a03789 | Iustin Pop |
|
255 | c2a03789 | Iustin Pop | If timeout is not passed, the default timeouts of the transport
|
256 | c2a03789 | Iustin Pop | class are used.
|
257 | c2a03789 | Iustin Pop |
|
258 | c2a03789 | Iustin Pop | """
|
259 | ceab32dd | Iustin Pop | if address is None: |
260 | ceab32dd | Iustin Pop | address = constants.MASTER_SOCKET |
261 | c2a03789 | Iustin Pop | self.transport = transport(address, timeouts=timeouts)
|
262 | c2a03789 | Iustin Pop | |
263 | c2a03789 | Iustin Pop | def SendRequest(self, request, data): |
264 | c2a03789 | Iustin Pop | """Send a generic request and return the response.
|
265 | c2a03789 | Iustin Pop |
|
266 | c2a03789 | Iustin Pop | """
|
267 | c2a03789 | Iustin Pop | msg = {KEY_REQUEST: request, KEY_DATA: data} |
268 | c2a03789 | Iustin Pop | result = self.transport.Call(simplejson.dumps(msg))
|
269 | c2a03789 | Iustin Pop | try:
|
270 | c2a03789 | Iustin Pop | data = simplejson.loads(result) |
271 | c2a03789 | Iustin Pop | except Exception, err: |
272 | c2a03789 | Iustin Pop | raise ProtocolError("Error while deserializing response: %s" % str(err)) |
273 | a14a17fc | Iustin Pop | if (not isinstance(data, dict) or |
274 | a14a17fc | Iustin Pop | 'success' not in data or |
275 | a14a17fc | Iustin Pop | 'result' not in data): |
276 | a14a17fc | Iustin Pop | raise DecodingError("Invalid response from server: %s" % str(data)) |
277 | c2a03789 | Iustin Pop | return data
|
278 | c2a03789 | Iustin Pop | |
279 | c2a03789 | Iustin Pop | def SubmitJob(self, job): |
280 | c2a03789 | Iustin Pop | """Submit a job"""
|
281 | b77acb3e | Iustin Pop | result = self.SendRequest(REQ_SUBMIT, SerializeJob(job))
|
282 | b77acb3e | Iustin Pop | if not result['success']: |
283 | b77acb3e | Iustin Pop | raise RequestError(result['result']) |
284 | b77acb3e | Iustin Pop | return result['result'] |
285 | c2a03789 | Iustin Pop | |
286 | c2a03789 | Iustin Pop | def Query(self, data): |
287 | c2a03789 | Iustin Pop | """Make a query"""
|
288 | b77acb3e | Iustin Pop | result = self.SendRequest(REQ_QUERY, data)
|
289 | b77acb3e | Iustin Pop | if not result['success']: |
290 | b77acb3e | Iustin Pop | raise RequestError(result[result])
|
291 | b77acb3e | Iustin Pop | result = result['result']
|
292 | b77acb3e | Iustin Pop | if data["object"] == "jobs": |
293 | b77acb3e | Iustin Pop | # custom job processing of query values
|
294 | b77acb3e | Iustin Pop | for row in result: |
295 | b77acb3e | Iustin Pop | for idx, field in enumerate(data["fields"]): |
296 | b77acb3e | Iustin Pop | if field == "op_list": |
297 | b77acb3e | Iustin Pop | row[idx] = [opcodes.OpCode.LoadOpCode(i) for i in row[idx]] |
298 | b77acb3e | Iustin Pop | return result |