luxi.py 10.5 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
#
#

# Copyright (C) 2006, 2007 Google Inc.
#
# 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 2 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, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
# 02110-1301, USA.


"""Module for the unix socket protocol

24
This module implements the local unix socket protocol. You only need
25
26
27
this module and the opcodes module in the client program in order to
communicate with the master.

Guido Trotter's avatar
Guido Trotter committed
28
The module is also used by the master daemon.
29
30
31
32
33
34

"""

import socket
import collections
import time
35
import errno
36

37
from ganeti import serializer
Iustin Pop's avatar
Iustin Pop committed
38
from ganeti import constants
39
from ganeti import errors
40
41


42
43
44
45
46
KEY_METHOD = 'method'
KEY_ARGS = 'args'
KEY_SUCCESS = "success"
KEY_RESULT = "result"

47
REQ_SUBMIT_JOB = "SubmitJob"
48
REQ_SUBMIT_MANY_JOBS = "SubmitManyJobs"
49
REQ_WAIT_FOR_JOB_CHANGE = "WaitForJobChange"
50
51
REQ_CANCEL_JOB = "CancelJob"
REQ_ARCHIVE_JOB = "ArchiveJob"
Iustin Pop's avatar
Iustin Pop committed
52
REQ_AUTOARCHIVE_JOBS = "AutoArchiveJobs"
53
REQ_QUERY_JOBS = "QueryJobs"
54
REQ_QUERY_INSTANCES = "QueryInstances"
Michael Hanselmann's avatar
Michael Hanselmann committed
55
REQ_QUERY_NODES = "QueryNodes"
56
REQ_QUERY_EXPORTS = "QueryExports"
57
REQ_QUERY_CONFIG_VALUES = "QueryConfigValues"
58
REQ_QUERY_CLUSTER_INFO = "QueryClusterInfo"
59
REQ_QUEUE_SET_DRAIN_FLAG = "SetDrainFlag"
60
REQ_SET_WATCHER_PAUSE = "SetWatcherPause"
61
62
63
64
65

DEF_CTMO = 10
DEF_RWTO = 60


Michael Hanselmann's avatar
Michael Hanselmann committed
66
67
class ProtocolError(errors.GenericError):
  """Denotes an error in the LUXI protocol"""
68
69
70
71
72
73
74
75
76
77


class ConnectionClosedError(ProtocolError):
  """Connection closed error"""


class TimeoutError(ProtocolError):
  """Operation timeout error"""


78
79
80
81
82
83
84
85
86
87
88
89
class RequestError(ProtocolError):
  """Error on request

  This signifies an error in the request format or request handling,
  but not (e.g.) an error in starting up an instance.

  Some common conditions that can trigger this exception:
    - job submission failed because the job data was wrong
    - query failed because required fields were missing

  """

90

91
92
93
94
95
96
97
98
class NoMasterError(ProtocolError):
  """The master cannot be reached

  This means that the master daemon is not running or the socket has
  been removed.

  """

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
class Transport:
  """Low-level transport class.

  This is used on the client side.

  This could be replace by any other class that provides the same
  semantics to the Client. This means:
    - can send messages and receive messages
    - safe for multithreading

  """

  def __init__(self, address, timeouts=None, eom=None):
    """Constructor for the Client class.

    Arguments:
      - address: a valid address the the used transport class
      - timeout: a list of timeouts, to be used on connect and read/write
      - eom: an identifier to be used as end-of-message which the
        upper-layer will guarantee that this identifier will not appear
        in any message

    There are two timeouts used since we might want to wait for a long
    time for a response, but the connect timeout should be lower.

    If not passed, we use a default of 10 and respectively 60 seconds.

    Note that on reading data, since the timeout applies to an
    invidual receive, it might be that the total duration is longer
    than timeout value passed (we make a hard limit at twice the read
    timeout).

    """
    self.address = address
    if timeouts is None:
      self._ctimeout, self._rwtimeout = DEF_CTMO, DEF_RWTO
    else:
      self._ctimeout, self._rwtimeout = timeouts

    self.socket = None
    self._buffer = ""
    self._msgs = collections.deque()

    if eom is None:
      self.eom = '\3'
    else:
      self.eom = eom

    try:
      self.socket = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
      self.socket.settimeout(self._ctimeout)
      try:
        self.socket.connect(address)
      except socket.timeout, err:
154
155
        raise TimeoutError("Connect timed out: %s" % str(err))
      except socket.error, err:
156
        if err.args[0] in (errno.ENOENT, errno.ECONNREFUSED):
157
          raise NoMasterError(address)
158
        raise
159
      self.socket.settimeout(self._rwtimeout)
160
    except (socket.error, NoMasterError):
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
      if self.socket is not None:
        self.socket.close()
      self.socket = None
      raise

  def _CheckSocket(self):
    """Make sure we are connected.

    """
    if self.socket is None:
      raise ProtocolError("Connection is closed")

  def Send(self, msg):
    """Send a message.

    This just sends a message and doesn't wait for the response.

    """
    if self.eom in msg:
Michael Hanselmann's avatar
Michael Hanselmann committed
180
181
      raise ProtocolError("Message terminator found in payload")

182
183
    self._CheckSocket()
    try:
184
      # TODO: sendall is not guaranteed to send everything
185
186
187
188
189
      self.socket.sendall(msg + self.eom)
    except socket.timeout, err:
      raise TimeoutError("Sending timeout: %s" % str(err))

  def Recv(self):
Michael Hanselmann's avatar
Michael Hanselmann committed
190
    """Try to receive a message from the socket.
191
192
193
194
195
196
197
198
199
200
201
202

    In case we already have messages queued, we just return from the
    queue. Otherwise, we try to read data with a _rwtimeout network
    timeout, and making sure we don't go over 2x_rwtimeout as a global
    limit.

    """
    self._CheckSocket()
    etime = time.time() + self._rwtimeout
    while not self._msgs:
      if time.time() > etime:
        raise TimeoutError("Extended receive timeout")
203
204
205
206
207
208
209
210
211
212
      while True:
        try:
          data = self.socket.recv(4096)
        except socket.error, err:
          if err.args and err.args[0] == errno.EAGAIN:
            continue
          raise
        except socket.timeout, err:
          raise TimeoutError("Receive timeout: %s" % str(err))
        break
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
      if not data:
        raise ConnectionClosedError("Connection closed while reading")
      new_msgs = (self._buffer + data).split(self.eom)
      self._buffer = new_msgs.pop()
      self._msgs.extend(new_msgs)
    return self._msgs.popleft()

  def Call(self, msg):
    """Send a message and wait for the response.

    This is just a wrapper over Send and Recv.

    """
    self.Send(msg)
    return self.Recv()

  def Close(self):
    """Close the socket"""
    if self.socket is not None:
      self.socket.close()
      self.socket = None


class Client(object):
  """High-level client implementation.

  This uses a backing Transport-like class on top of which it
  implements data serialization/deserialization.

  """
Iustin Pop's avatar
Iustin Pop committed
243
  def __init__(self, address=None, timeouts=None, transport=Transport):
244
245
246
247
248
249
250
251
252
253
254
255
    """Constructor for the Client class.

    Arguments:
      - address: a valid address the the used transport class
      - timeout: a list of timeouts, to be used on connect and read/write
      - transport: a Transport-like class


    If timeout is not passed, the default timeouts of the transport
    class are used.

    """
Iustin Pop's avatar
Iustin Pop committed
256
257
    if address is None:
      address = constants.MASTER_SOCKET
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
    self.address = address
    self.timeouts = timeouts
    self.transport_class = transport
    self.transport = None
    self._InitTransport()

  def _InitTransport(self):
    """(Re)initialize the transport if needed.

    """
    if self.transport is None:
      self.transport = self.transport_class(self.address,
                                            timeouts=self.timeouts)

  def _CloseTransport(self):
    """Close the transport, ignoring errors.

    """
    if self.transport is None:
      return
    try:
      old_transp = self.transport
      self.transport = None
      old_transp.Close()
Iustin Pop's avatar
Iustin Pop committed
282
    except Exception: # pylint: disable-msg=W0703
283
      pass
284

285
  def CallMethod(self, method, args):
286
287
288
    """Send a generic request and return the response.

    """
289
290
291
292
293
294
    # Build request
    request = {
      KEY_METHOD: method,
      KEY_ARGS: args,
      }

295
296
297
    # Serialize the request
    send_data = serializer.DumpJson(request, indent=False)

298
    # Send request and wait for response
299
300
301
302
303
304
305
306
    try:
      self._InitTransport()
      result = self.transport.Call(send_data)
    except Exception:
      self._CloseTransport()
      raise

    # Parse the result
307
    try:
308
      data = serializer.LoadJson(result)
309
310
    except Exception, err:
      raise ProtocolError("Error while deserializing response: %s" % str(err))
311
312

    # Validate response
313
    if (not isinstance(data, dict) or
314
315
        KEY_SUCCESS not in data or
        KEY_RESULT not in data):
Michael Hanselmann's avatar
Michael Hanselmann committed
316
      raise ProtocolError("Invalid response from server: %s" % str(data))
317

318
319
    result = data[KEY_RESULT]

320
    if not data[KEY_SUCCESS]:
321
      errors.MaybeRaise(result)
322
      raise RequestError(result)
323

324
    return result
325

326
327
328
  def SetQueueDrainFlag(self, drain_flag):
    return self.CallMethod(REQ_QUEUE_SET_DRAIN_FLAG, drain_flag)

329
330
331
  def SetWatcherPause(self, until):
    return self.CallMethod(REQ_SET_WATCHER_PAUSE, [until])

332
333
334
335
  def SubmitJob(self, ops):
    ops_state = map(lambda op: op.__getstate__(), ops)
    return self.CallMethod(REQ_SUBMIT_JOB, ops_state)

336
337
338
339
340
341
  def SubmitManyJobs(self, jobs):
    jobs_state = []
    for ops in jobs:
      jobs_state.append([op.__getstate__() for op in ops])
    return self.CallMethod(REQ_SUBMIT_MANY_JOBS, jobs_state)

342
343
344
345
346
347
  def CancelJob(self, job_id):
    return self.CallMethod(REQ_CANCEL_JOB, job_id)

  def ArchiveJob(self, job_id):
    return self.CallMethod(REQ_ARCHIVE_JOB, job_id)

Iustin Pop's avatar
Iustin Pop committed
348
  def AutoArchiveJobs(self, age):
349
350
    timeout = (DEF_RWTO - 1) / 2
    return self.CallMethod(REQ_AUTOARCHIVE_JOBS, (age, timeout))
Iustin Pop's avatar
Iustin Pop committed
351

352
  def WaitForJobChange(self, job_id, fields, prev_job_info, prev_log_serial):
353
354
355
356
357
358
359
360
    timeout = (DEF_RWTO - 1) / 2
    while True:
      result = self.CallMethod(REQ_WAIT_FOR_JOB_CHANGE,
                               (job_id, fields, prev_job_info,
                                prev_log_serial, timeout))
      if result != constants.JOB_NOTCHANGED:
        break
    return result
361

362
363
  def QueryJobs(self, job_ids, fields):
    return self.CallMethod(REQ_QUERY_JOBS, (job_ids, fields))
364

365
366
  def QueryInstances(self, names, fields, use_locking):
    return self.CallMethod(REQ_QUERY_INSTANCES, (names, fields, use_locking))
367

368
369
  def QueryNodes(self, names, fields, use_locking):
    return self.CallMethod(REQ_QUERY_NODES, (names, fields, use_locking))
Michael Hanselmann's avatar
Michael Hanselmann committed
370

371
372
  def QueryExports(self, nodes, use_locking):
    return self.CallMethod(REQ_QUERY_EXPORTS, (nodes, use_locking))
373

374
375
376
  def QueryClusterInfo(self):
    return self.CallMethod(REQ_QUERY_CLUSTER_INFO, ())

377
378
379
  def QueryConfigValues(self, fields):
    return self.CallMethod(REQ_QUERY_CONFIG_VALUES, fields)

380

381
# TODO: class Server(object)