root / lib / luxi.py @ 204f2086
History | View | Annotate | Download (8.6 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 time |
35 | 03a8dbdc | Iustin Pop | import errno |
36 | c2a03789 | Iustin Pop | |
37 | fad50141 | Michael Hanselmann | from ganeti import serializer |
38 | ceab32dd | Iustin Pop | from ganeti import constants |
39 | c2a03789 | Iustin Pop | |
40 | c2a03789 | Iustin Pop | |
41 | 3d8548c4 | Michael Hanselmann | KEY_METHOD = 'method'
|
42 | 3d8548c4 | Michael Hanselmann | KEY_ARGS = 'args'
|
43 | 3d8548c4 | Michael Hanselmann | KEY_SUCCESS = "success"
|
44 | 3d8548c4 | Michael Hanselmann | KEY_RESULT = "result"
|
45 | 3d8548c4 | Michael Hanselmann | |
46 | 0bbe448c | Michael Hanselmann | REQ_SUBMIT_JOB = "SubmitJob"
|
47 | dfe57c22 | Michael Hanselmann | REQ_WAIT_FOR_JOB_CHANGE = "WaitForJobChange"
|
48 | 0bbe448c | Michael Hanselmann | REQ_CANCEL_JOB = "CancelJob"
|
49 | 0bbe448c | Michael Hanselmann | REQ_ARCHIVE_JOB = "ArchiveJob"
|
50 | 0bbe448c | Michael Hanselmann | REQ_QUERY_JOBS = "QueryJobs"
|
51 | ee6c7b94 | Michael Hanselmann | REQ_QUERY_INSTANCES = "QueryInstances"
|
52 | 02f7fe54 | Michael Hanselmann | REQ_QUERY_NODES = "QueryNodes"
|
53 | 32f93223 | Michael Hanselmann | REQ_QUERY_EXPORTS = "QueryExports"
|
54 | c2a03789 | Iustin Pop | |
55 | c2a03789 | Iustin Pop | DEF_CTMO = 10
|
56 | c2a03789 | Iustin Pop | DEF_RWTO = 60
|
57 | c2a03789 | Iustin Pop | |
58 | c2a03789 | Iustin Pop | |
59 | c2a03789 | Iustin Pop | class ProtocolError(Exception): |
60 | c2a03789 | Iustin Pop | """Denotes an error in the server communication"""
|
61 | c2a03789 | Iustin Pop | |
62 | c2a03789 | Iustin Pop | |
63 | c2a03789 | Iustin Pop | class ConnectionClosedError(ProtocolError): |
64 | c2a03789 | Iustin Pop | """Connection closed error"""
|
65 | c2a03789 | Iustin Pop | |
66 | c2a03789 | Iustin Pop | |
67 | c2a03789 | Iustin Pop | class TimeoutError(ProtocolError): |
68 | c2a03789 | Iustin Pop | """Operation timeout error"""
|
69 | c2a03789 | Iustin Pop | |
70 | c2a03789 | Iustin Pop | |
71 | c2a03789 | Iustin Pop | class EncodingError(ProtocolError): |
72 | c2a03789 | Iustin Pop | """Encoding failure on the sending side"""
|
73 | c2a03789 | Iustin Pop | |
74 | c2a03789 | Iustin Pop | |
75 | c2a03789 | Iustin Pop | class DecodingError(ProtocolError): |
76 | c2a03789 | Iustin Pop | """Decoding failure on the receiving side"""
|
77 | c2a03789 | Iustin Pop | |
78 | c2a03789 | Iustin Pop | |
79 | b77acb3e | Iustin Pop | class RequestError(ProtocolError): |
80 | b77acb3e | Iustin Pop | """Error on request
|
81 | b77acb3e | Iustin Pop |
|
82 | b77acb3e | Iustin Pop | This signifies an error in the request format or request handling,
|
83 | b77acb3e | Iustin Pop | but not (e.g.) an error in starting up an instance.
|
84 | b77acb3e | Iustin Pop |
|
85 | b77acb3e | Iustin Pop | Some common conditions that can trigger this exception:
|
86 | b77acb3e | Iustin Pop | - job submission failed because the job data was wrong
|
87 | b77acb3e | Iustin Pop | - query failed because required fields were missing
|
88 | b77acb3e | Iustin Pop |
|
89 | b77acb3e | Iustin Pop | """
|
90 | b77acb3e | Iustin Pop | |
91 | 3d8548c4 | Michael Hanselmann | |
92 | 03a8dbdc | Iustin Pop | class NoMasterError(ProtocolError): |
93 | 03a8dbdc | Iustin Pop | """The master cannot be reached
|
94 | 03a8dbdc | Iustin Pop |
|
95 | 03a8dbdc | Iustin Pop | This means that the master daemon is not running or the socket has
|
96 | 03a8dbdc | Iustin Pop | been removed.
|
97 | 03a8dbdc | Iustin Pop |
|
98 | 03a8dbdc | Iustin Pop | """
|
99 | 03a8dbdc | Iustin Pop | |
100 | b77acb3e | Iustin Pop | |
101 | c2a03789 | Iustin Pop | class Transport: |
102 | c2a03789 | Iustin Pop | """Low-level transport class.
|
103 | c2a03789 | Iustin Pop |
|
104 | c2a03789 | Iustin Pop | This is used on the client side.
|
105 | c2a03789 | Iustin Pop |
|
106 | c2a03789 | Iustin Pop | This could be replace by any other class that provides the same
|
107 | c2a03789 | Iustin Pop | semantics to the Client. This means:
|
108 | c2a03789 | Iustin Pop | - can send messages and receive messages
|
109 | c2a03789 | Iustin Pop | - safe for multithreading
|
110 | c2a03789 | Iustin Pop |
|
111 | c2a03789 | Iustin Pop | """
|
112 | c2a03789 | Iustin Pop | |
113 | c2a03789 | Iustin Pop | def __init__(self, address, timeouts=None, eom=None): |
114 | c2a03789 | Iustin Pop | """Constructor for the Client class.
|
115 | c2a03789 | Iustin Pop |
|
116 | c2a03789 | Iustin Pop | Arguments:
|
117 | c2a03789 | Iustin Pop | - address: a valid address the the used transport class
|
118 | c2a03789 | Iustin Pop | - timeout: a list of timeouts, to be used on connect and read/write
|
119 | c2a03789 | Iustin Pop | - eom: an identifier to be used as end-of-message which the
|
120 | c2a03789 | Iustin Pop | upper-layer will guarantee that this identifier will not appear
|
121 | c2a03789 | Iustin Pop | in any message
|
122 | c2a03789 | Iustin Pop |
|
123 | c2a03789 | Iustin Pop | There are two timeouts used since we might want to wait for a long
|
124 | c2a03789 | Iustin Pop | time for a response, but the connect timeout should be lower.
|
125 | c2a03789 | Iustin Pop |
|
126 | c2a03789 | Iustin Pop | If not passed, we use a default of 10 and respectively 60 seconds.
|
127 | c2a03789 | Iustin Pop |
|
128 | c2a03789 | Iustin Pop | Note that on reading data, since the timeout applies to an
|
129 | c2a03789 | Iustin Pop | invidual receive, it might be that the total duration is longer
|
130 | c2a03789 | Iustin Pop | than timeout value passed (we make a hard limit at twice the read
|
131 | c2a03789 | Iustin Pop | timeout).
|
132 | c2a03789 | Iustin Pop |
|
133 | c2a03789 | Iustin Pop | """
|
134 | c2a03789 | Iustin Pop | self.address = address
|
135 | c2a03789 | Iustin Pop | if timeouts is None: |
136 | c2a03789 | Iustin Pop | self._ctimeout, self._rwtimeout = DEF_CTMO, DEF_RWTO |
137 | c2a03789 | Iustin Pop | else:
|
138 | c2a03789 | Iustin Pop | self._ctimeout, self._rwtimeout = timeouts |
139 | c2a03789 | Iustin Pop | |
140 | c2a03789 | Iustin Pop | self.socket = None |
141 | c2a03789 | Iustin Pop | self._buffer = "" |
142 | c2a03789 | Iustin Pop | self._msgs = collections.deque()
|
143 | c2a03789 | Iustin Pop | |
144 | c2a03789 | Iustin Pop | if eom is None: |
145 | c2a03789 | Iustin Pop | self.eom = '\3' |
146 | c2a03789 | Iustin Pop | else:
|
147 | c2a03789 | Iustin Pop | self.eom = eom
|
148 | c2a03789 | Iustin Pop | |
149 | c2a03789 | Iustin Pop | try:
|
150 | c2a03789 | Iustin Pop | self.socket = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
|
151 | c2a03789 | Iustin Pop | self.socket.settimeout(self._ctimeout) |
152 | c2a03789 | Iustin Pop | try:
|
153 | c2a03789 | Iustin Pop | self.socket.connect(address)
|
154 | c2a03789 | Iustin Pop | except socket.timeout, err:
|
155 | 03a8dbdc | Iustin Pop | raise TimeoutError("Connect timed out: %s" % str(err)) |
156 | 03a8dbdc | Iustin Pop | except socket.error, err:
|
157 | 082c5adb | Michael Hanselmann | if err.args[0] in (errno.ENOENT, errno.ECONNREFUSED): |
158 | 03a8dbdc | Iustin Pop | raise NoMasterError((address,))
|
159 | 03a8dbdc | Iustin Pop | raise
|
160 | c2a03789 | Iustin Pop | self.socket.settimeout(self._rwtimeout) |
161 | 03a8dbdc | Iustin Pop | except (socket.error, NoMasterError):
|
162 | c2a03789 | Iustin Pop | if self.socket is not None: |
163 | c2a03789 | Iustin Pop | self.socket.close()
|
164 | c2a03789 | Iustin Pop | self.socket = None |
165 | c2a03789 | Iustin Pop | raise
|
166 | c2a03789 | Iustin Pop | |
167 | c2a03789 | Iustin Pop | def _CheckSocket(self): |
168 | c2a03789 | Iustin Pop | """Make sure we are connected.
|
169 | c2a03789 | Iustin Pop |
|
170 | c2a03789 | Iustin Pop | """
|
171 | c2a03789 | Iustin Pop | if self.socket is None: |
172 | c2a03789 | Iustin Pop | raise ProtocolError("Connection is closed") |
173 | c2a03789 | Iustin Pop | |
174 | c2a03789 | Iustin Pop | def Send(self, msg): |
175 | c2a03789 | Iustin Pop | """Send a message.
|
176 | c2a03789 | Iustin Pop |
|
177 | c2a03789 | Iustin Pop | This just sends a message and doesn't wait for the response.
|
178 | c2a03789 | Iustin Pop |
|
179 | c2a03789 | Iustin Pop | """
|
180 | c2a03789 | Iustin Pop | if self.eom in msg: |
181 | c2a03789 | Iustin Pop | raise EncodingError("Message terminator found in payload") |
182 | c2a03789 | Iustin Pop | self._CheckSocket()
|
183 | c2a03789 | Iustin Pop | try:
|
184 | c2a03789 | Iustin Pop | self.socket.sendall(msg + self.eom) |
185 | c2a03789 | Iustin Pop | except socket.timeout, err:
|
186 | c2a03789 | Iustin Pop | raise TimeoutError("Sending timeout: %s" % str(err)) |
187 | c2a03789 | Iustin Pop | |
188 | c2a03789 | Iustin Pop | def Recv(self): |
189 | c2a03789 | Iustin Pop | """Try to receive a messae from the socket.
|
190 | c2a03789 | Iustin Pop |
|
191 | c2a03789 | Iustin Pop | In case we already have messages queued, we just return from the
|
192 | c2a03789 | Iustin Pop | queue. Otherwise, we try to read data with a _rwtimeout network
|
193 | c2a03789 | Iustin Pop | timeout, and making sure we don't go over 2x_rwtimeout as a global
|
194 | c2a03789 | Iustin Pop | limit.
|
195 | c2a03789 | Iustin Pop |
|
196 | c2a03789 | Iustin Pop | """
|
197 | c2a03789 | Iustin Pop | self._CheckSocket()
|
198 | c2a03789 | Iustin Pop | etime = time.time() + self._rwtimeout
|
199 | c2a03789 | Iustin Pop | while not self._msgs: |
200 | c2a03789 | Iustin Pop | if time.time() > etime:
|
201 | c2a03789 | Iustin Pop | raise TimeoutError("Extended receive timeout") |
202 | c2a03789 | Iustin Pop | try:
|
203 | c2a03789 | Iustin Pop | data = self.socket.recv(4096) |
204 | c2a03789 | Iustin Pop | except socket.timeout, err:
|
205 | c2a03789 | Iustin Pop | raise TimeoutError("Receive timeout: %s" % str(err)) |
206 | c2a03789 | Iustin Pop | if not data: |
207 | c2a03789 | Iustin Pop | raise ConnectionClosedError("Connection closed while reading") |
208 | c2a03789 | Iustin Pop | new_msgs = (self._buffer + data).split(self.eom) |
209 | c2a03789 | Iustin Pop | self._buffer = new_msgs.pop()
|
210 | c2a03789 | Iustin Pop | self._msgs.extend(new_msgs)
|
211 | c2a03789 | Iustin Pop | return self._msgs.popleft() |
212 | c2a03789 | Iustin Pop | |
213 | c2a03789 | Iustin Pop | def Call(self, msg): |
214 | c2a03789 | Iustin Pop | """Send a message and wait for the response.
|
215 | c2a03789 | Iustin Pop |
|
216 | c2a03789 | Iustin Pop | This is just a wrapper over Send and Recv.
|
217 | c2a03789 | Iustin Pop |
|
218 | c2a03789 | Iustin Pop | """
|
219 | c2a03789 | Iustin Pop | self.Send(msg)
|
220 | c2a03789 | Iustin Pop | return self.Recv() |
221 | c2a03789 | Iustin Pop | |
222 | c2a03789 | Iustin Pop | def Close(self): |
223 | c2a03789 | Iustin Pop | """Close the socket"""
|
224 | c2a03789 | Iustin Pop | if self.socket is not None: |
225 | c2a03789 | Iustin Pop | self.socket.close()
|
226 | c2a03789 | Iustin Pop | self.socket = None |
227 | c2a03789 | Iustin Pop | |
228 | c2a03789 | Iustin Pop | |
229 | c2a03789 | Iustin Pop | class Client(object): |
230 | c2a03789 | Iustin Pop | """High-level client implementation.
|
231 | c2a03789 | Iustin Pop |
|
232 | c2a03789 | Iustin Pop | This uses a backing Transport-like class on top of which it
|
233 | c2a03789 | Iustin Pop | implements data serialization/deserialization.
|
234 | c2a03789 | Iustin Pop |
|
235 | c2a03789 | Iustin Pop | """
|
236 | ceab32dd | Iustin Pop | def __init__(self, address=None, timeouts=None, transport=Transport): |
237 | c2a03789 | Iustin Pop | """Constructor for the Client class.
|
238 | c2a03789 | Iustin Pop |
|
239 | c2a03789 | Iustin Pop | Arguments:
|
240 | c2a03789 | Iustin Pop | - address: a valid address the the used transport class
|
241 | c2a03789 | Iustin Pop | - timeout: a list of timeouts, to be used on connect and read/write
|
242 | c2a03789 | Iustin Pop | - transport: a Transport-like class
|
243 | c2a03789 | Iustin Pop |
|
244 | c2a03789 | Iustin Pop |
|
245 | c2a03789 | Iustin Pop | If timeout is not passed, the default timeouts of the transport
|
246 | c2a03789 | Iustin Pop | class are used.
|
247 | c2a03789 | Iustin Pop |
|
248 | c2a03789 | Iustin Pop | """
|
249 | ceab32dd | Iustin Pop | if address is None: |
250 | ceab32dd | Iustin Pop | address = constants.MASTER_SOCKET |
251 | c2a03789 | Iustin Pop | self.transport = transport(address, timeouts=timeouts)
|
252 | c2a03789 | Iustin Pop | |
253 | 3d8548c4 | Michael Hanselmann | def CallMethod(self, method, args): |
254 | c2a03789 | Iustin Pop | """Send a generic request and return the response.
|
255 | c2a03789 | Iustin Pop |
|
256 | c2a03789 | Iustin Pop | """
|
257 | 3d8548c4 | Michael Hanselmann | # Build request
|
258 | 3d8548c4 | Michael Hanselmann | request = { |
259 | 3d8548c4 | Michael Hanselmann | KEY_METHOD: method, |
260 | 3d8548c4 | Michael Hanselmann | KEY_ARGS: args, |
261 | 3d8548c4 | Michael Hanselmann | } |
262 | 3d8548c4 | Michael Hanselmann | |
263 | 3d8548c4 | Michael Hanselmann | # Send request and wait for response
|
264 | 3d8548c4 | Michael Hanselmann | result = self.transport.Call(serializer.DumpJson(request, indent=False)) |
265 | c2a03789 | Iustin Pop | try:
|
266 | fad50141 | Michael Hanselmann | data = serializer.LoadJson(result) |
267 | c2a03789 | Iustin Pop | except Exception, err: |
268 | c2a03789 | Iustin Pop | raise ProtocolError("Error while deserializing response: %s" % str(err)) |
269 | 3d8548c4 | Michael Hanselmann | |
270 | 3d8548c4 | Michael Hanselmann | # Validate response
|
271 | a14a17fc | Iustin Pop | if (not isinstance(data, dict) or |
272 | 3d8548c4 | Michael Hanselmann | KEY_SUCCESS not in data or |
273 | 3d8548c4 | Michael Hanselmann | KEY_RESULT not in data): |
274 | a14a17fc | Iustin Pop | raise DecodingError("Invalid response from server: %s" % str(data)) |
275 | 3d8548c4 | Michael Hanselmann | |
276 | 3d8548c4 | Michael Hanselmann | if not data[KEY_SUCCESS]: |
277 | 3d8548c4 | Michael Hanselmann | # TODO: decide on a standard exception
|
278 | 3d8548c4 | Michael Hanselmann | raise RequestError(data[KEY_RESULT])
|
279 | 3d8548c4 | Michael Hanselmann | |
280 | 3d8548c4 | Michael Hanselmann | return data[KEY_RESULT]
|
281 | c2a03789 | Iustin Pop | |
282 | 0bbe448c | Michael Hanselmann | def SubmitJob(self, ops): |
283 | 0bbe448c | Michael Hanselmann | ops_state = map(lambda op: op.__getstate__(), ops) |
284 | 0bbe448c | Michael Hanselmann | return self.CallMethod(REQ_SUBMIT_JOB, ops_state) |
285 | 0bbe448c | Michael Hanselmann | |
286 | 0bbe448c | Michael Hanselmann | def CancelJob(self, job_id): |
287 | 0bbe448c | Michael Hanselmann | return self.CallMethod(REQ_CANCEL_JOB, job_id) |
288 | 0bbe448c | Michael Hanselmann | |
289 | 0bbe448c | Michael Hanselmann | def ArchiveJob(self, job_id): |
290 | 0bbe448c | Michael Hanselmann | return self.CallMethod(REQ_ARCHIVE_JOB, job_id) |
291 | 0bbe448c | Michael Hanselmann | |
292 | 6c5a7090 | Michael Hanselmann | def WaitForJobChange(self, job_id, fields, prev_job_info, prev_log_serial): |
293 | 5c735209 | Iustin Pop | timeout = (DEF_RWTO - 1) / 2 |
294 | 5c735209 | Iustin Pop | while True: |
295 | 5c735209 | Iustin Pop | result = self.CallMethod(REQ_WAIT_FOR_JOB_CHANGE,
|
296 | 5c735209 | Iustin Pop | (job_id, fields, prev_job_info, |
297 | 5c735209 | Iustin Pop | prev_log_serial, timeout)) |
298 | 5c735209 | Iustin Pop | if result != constants.JOB_NOTCHANGED:
|
299 | 5c735209 | Iustin Pop | break
|
300 | 5c735209 | Iustin Pop | return result
|
301 | dfe57c22 | Michael Hanselmann | |
302 | 0bbe448c | Michael Hanselmann | def QueryJobs(self, job_ids, fields): |
303 | 0bbe448c | Michael Hanselmann | return self.CallMethod(REQ_QUERY_JOBS, (job_ids, fields)) |
304 | 3d8548c4 | Michael Hanselmann | |
305 | ee6c7b94 | Michael Hanselmann | def QueryInstances(self, names, fields): |
306 | ee6c7b94 | Michael Hanselmann | return self.CallMethod(REQ_QUERY_INSTANCES, (names, fields)) |
307 | ee6c7b94 | Michael Hanselmann | |
308 | 02f7fe54 | Michael Hanselmann | def QueryNodes(self, names, fields): |
309 | 02f7fe54 | Michael Hanselmann | return self.CallMethod(REQ_QUERY_NODES, (names, fields)) |
310 | 02f7fe54 | Michael Hanselmann | |
311 | 32f93223 | Michael Hanselmann | def QueryExports(self, nodes): |
312 | 32f93223 | Michael Hanselmann | return self.CallMethod(REQ_QUERY_EXPORTS, nodes) |
313 | 32f93223 | Michael Hanselmann | |
314 | 3d8548c4 | Michael Hanselmann | # TODO: class Server(object) |