luxi.py 15.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
import logging
37

38
from ganeti import serializer
Iustin Pop's avatar
Iustin Pop committed
39
from ganeti import constants
40
from ganeti import errors
41
from ganeti import utils
42
from ganeti import objects
43
44


45
46
KEY_METHOD = "method"
KEY_ARGS = "args"
47
48
KEY_SUCCESS = "success"
KEY_RESULT = "result"
49
KEY_VERSION = "version"
50

51
REQ_SUBMIT_JOB = "SubmitJob"
52
REQ_SUBMIT_MANY_JOBS = "SubmitManyJobs"
53
REQ_WAIT_FOR_JOB_CHANGE = "WaitForJobChange"
54
55
REQ_CANCEL_JOB = "CancelJob"
REQ_ARCHIVE_JOB = "ArchiveJob"
Iustin Pop's avatar
Iustin Pop committed
56
REQ_AUTOARCHIVE_JOBS = "AutoArchiveJobs"
57
58
REQ_QUERY = "Query"
REQ_QUERY_FIELDS = "QueryFields"
59
REQ_QUERY_JOBS = "QueryJobs"
60
REQ_QUERY_INSTANCES = "QueryInstances"
Michael Hanselmann's avatar
Michael Hanselmann committed
61
REQ_QUERY_NODES = "QueryNodes"
62
REQ_QUERY_GROUPS = "QueryGroups"
63
REQ_QUERY_EXPORTS = "QueryExports"
64
REQ_QUERY_CONFIG_VALUES = "QueryConfigValues"
65
REQ_QUERY_CLUSTER_INFO = "QueryClusterInfo"
Iustin Pop's avatar
Iustin Pop committed
66
REQ_QUERY_TAGS = "QueryTags"
Michael Hanselmann's avatar
Michael Hanselmann committed
67
REQ_QUERY_LOCKS = "QueryLocks"
68
REQ_QUEUE_SET_DRAIN_FLAG = "SetDrainFlag"
69
REQ_SET_WATCHER_PAUSE = "SetWatcherPause"
70
71
72
73

DEF_CTMO = 10
DEF_RWTO = 60

74
75
76
# WaitForJobChange timeout
WFJC_TIMEOUT = (DEF_RWTO - 1) / 2

77

78
class ProtocolError(errors.LuxiError):
79
  """Denotes an error in the LUXI protocol."""
80
81
82


class ConnectionClosedError(ProtocolError):
83
  """Connection closed error."""
84
85
86


class TimeoutError(ProtocolError):
87
  """Operation timeout error."""
88
89


90
class RequestError(ProtocolError):
91
  """Error on request.
92
93
94
95
96
97
98
99
100
101

  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

  """

102

103
class NoMasterError(ProtocolError):
104
  """The master cannot be reached.
105
106
107
108
109
110

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

  """

111

112
113
114
115
116
117
118
119
class PermissionError(ProtocolError):
  """Permission denied while connecting to the master socket.

  This means the user doesn't have the proper rights.

  """


120
121
122
123
124
125
126
127
128
129
130
131
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

  """

132
  def __init__(self, address, timeouts=None):
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
    """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

    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()

    try:
      self.socket = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
162
163

      # Try to connect
164
      try:
165
166
167
168
169
        utils.Retry(self._Connect, 1.0, self._ctimeout,
                    args=(self.socket, address, self._ctimeout))
      except utils.RetryTimeout:
        raise TimeoutError("Connect timed out")

170
      self.socket.settimeout(self._rwtimeout)
171
    except (socket.error, NoMasterError):
172
173
174
175
176
      if self.socket is not None:
        self.socket.close()
      self.socket = None
      raise

177
178
179
180
181
182
183
184
  @staticmethod
  def _Connect(sock, address, timeout):
    sock.settimeout(timeout)
    try:
      sock.connect(address)
    except socket.timeout, err:
      raise TimeoutError("Connect timed out: %s" % str(err))
    except socket.error, err:
185
186
      error_code = err.args[0]
      if error_code in (errno.ENOENT, errno.ECONNREFUSED):
187
        raise NoMasterError(address)
188
189
190
      elif error_code in (errno.EPERM, errno.EACCES):
        raise PermissionError(address)
      elif error_code == errno.EAGAIN:
191
192
193
194
        # Server's socket backlog is full at the moment
        raise utils.RetryAgain()
      raise

195
196
197
198
199
200
201
202
203
204
205
206
207
  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.

    """
208
    if constants.LUXI_EOM in msg:
Michael Hanselmann's avatar
Michael Hanselmann committed
209
210
      raise ProtocolError("Message terminator found in payload")

211
212
    self._CheckSocket()
    try:
213
      # TODO: sendall is not guaranteed to send everything
214
      self.socket.sendall(msg + constants.LUXI_EOM)
215
216
217
218
    except socket.timeout, err:
      raise TimeoutError("Sending timeout: %s" % str(err))

  def Recv(self):
Michael Hanselmann's avatar
Michael Hanselmann committed
219
    """Try to receive a message from the socket.
220
221
222
223
224
225
226
227
228
229
230
231

    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")
232
233
234
      while True:
        try:
          data = self.socket.recv(4096)
235
236
        except socket.timeout, err:
          raise TimeoutError("Receive timeout: %s" % str(err))
237
238
239
240
241
        except socket.error, err:
          if err.args and err.args[0] == errno.EAGAIN:
            continue
          raise
        break
242
243
      if not data:
        raise ConnectionClosedError("Connection closed while reading")
244
      new_msgs = (self._buffer + data).split(constants.LUXI_EOM)
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
      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


265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
def ParseRequest(msg):
  """Parses a LUXI request message.

  """
  try:
    request = serializer.LoadJson(msg)
  except ValueError, err:
    raise ProtocolError("Invalid LUXI request (parsing error): %s" % err)

  logging.debug("LUXI request: %s", request)

  if not isinstance(request, dict):
    logging.error("LUXI request not a dict: %r", msg)
    raise ProtocolError("Invalid LUXI request (not a dict)")

Guido Trotter's avatar
Guido Trotter committed
280
281
  method = request.get(KEY_METHOD, None) # pylint: disable-msg=E1103
  args = request.get(KEY_ARGS, None) # pylint: disable-msg=E1103
Guido Trotter's avatar
Guido Trotter committed
282
  version = request.get(KEY_VERSION, None) # pylint: disable-msg=E1103
Guido Trotter's avatar
Guido Trotter committed
283

284
285
286
287
288
  if method is None or args is None:
    logging.error("LUXI request missing method or arguments: %r", msg)
    raise ProtocolError(("Invalid LUXI request (no method or arguments"
                         " in request): %r") % msg)

289
  return (method, args, version)
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307


def ParseResponse(msg):
  """Parses a LUXI response message.

  """
  # Parse the result
  try:
    data = serializer.LoadJson(msg)
  except Exception, err:
    raise ProtocolError("Error while deserializing response: %s" % str(err))

  # Validate response
  if not (isinstance(data, dict) and
          KEY_SUCCESS in data and
          KEY_RESULT in data):
    raise ProtocolError("Invalid response from server: %r" % data)

Guido Trotter's avatar
Guido Trotter committed
308
309
  return (data[KEY_SUCCESS], data[KEY_RESULT],
          data.get(KEY_VERSION, None)) # pylint: disable-msg=E1103
310
311


312
def FormatResponse(success, result, version=None):
313
314
315
316
317
318
319
320
  """Formats a LUXI response message.

  """
  response = {
    KEY_SUCCESS: success,
    KEY_RESULT: result,
    }

321
322
323
  if version is not None:
    response[KEY_VERSION] = version

324
325
326
327
328
  logging.debug("LUXI response: %s", response)

  return serializer.DumpJson(response)


329
def FormatRequest(method, args, version=None):
330
331
332
333
334
335
336
337
338
  """Formats a LUXI request message.

  """
  # Build request
  request = {
    KEY_METHOD: method,
    KEY_ARGS: args,
    }

339
340
341
  if version is not None:
    request[KEY_VERSION] = version

342
343
344
345
  # Serialize the request
  return serializer.DumpJson(request, indent=False)


346
def CallLuxiMethod(transport_cb, method, args, version=None):
347
348
349
350
351
  """Send a LUXI request via a transport and return the response.

  """
  assert callable(transport_cb)

352
  request_msg = FormatRequest(method, args, version=version)
353
354
355
356

  # Send request and wait for response
  response_msg = transport_cb(request_msg)

357
358
359
360
361
362
  (success, result, resp_version) = ParseResponse(response_msg)

  # Verify version if there was one in the response
  if resp_version is not None and resp_version != version:
    raise errors.LuxiError("LUXI version mismatch, client %s, response %s" %
                           (version, resp_version))
363
364
365
366
367
368
369
370

  if success:
    return result

  errors.MaybeRaise(result)
  raise RequestError(result)


371
372
373
374
375
376
377
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
378
  def __init__(self, address=None, timeouts=None, transport=Transport):
379
380
381
382
383
384
385
386
387
388
389
390
    """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
391
392
    if address is None:
      address = constants.MASTER_SOCKET
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
    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
417
    except Exception: # pylint: disable-msg=W0703
418
      pass
419

420
  def _SendMethodCall(self, data):
421
    # Send request and wait for response
422
423
    try:
      self._InitTransport()
424
      return self.transport.Call(data)
425
426
427
428
    except Exception:
      self._CloseTransport()
      raise

429
430
  def CallMethod(self, method, args):
    """Send a generic request and return the response.
431

432
    """
433
434
    return CallLuxiMethod(self._SendMethodCall, method, args,
                          version=constants.LUXI_VERSION)
435

436
437
438
  def SetQueueDrainFlag(self, drain_flag):
    return self.CallMethod(REQ_QUEUE_SET_DRAIN_FLAG, drain_flag)

439
440
441
  def SetWatcherPause(self, until):
    return self.CallMethod(REQ_SET_WATCHER_PAUSE, [until])

442
443
444
445
  def SubmitJob(self, ops):
    ops_state = map(lambda op: op.__getstate__(), ops)
    return self.CallMethod(REQ_SUBMIT_JOB, ops_state)

446
447
448
449
450
451
  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)

452
453
454
455
456
457
  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
458
  def AutoArchiveJobs(self, age):
459
460
    timeout = (DEF_RWTO - 1) / 2
    return self.CallMethod(REQ_AUTOARCHIVE_JOBS, (age, timeout))
Iustin Pop's avatar
Iustin Pop committed
461

462
  def WaitForJobChangeOnce(self, job_id, fields,
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
                           prev_job_info, prev_log_serial,
                           timeout=WFJC_TIMEOUT):
    """Waits for changes on a job.

    @param job_id: Job ID
    @type fields: list
    @param fields: List of field names to be observed
    @type prev_job_info: None or list
    @param prev_job_info: Previously received job information
    @type prev_log_serial: None or int/long
    @param prev_log_serial: Highest log serial number previously received
    @type timeout: int/float
    @param timeout: Timeout in seconds (values larger than L{WFJC_TIMEOUT} will
                    be capped to that value)

    """
    assert timeout >= 0, "Timeout can not be negative"
480
481
    return self.CallMethod(REQ_WAIT_FOR_JOB_CHANGE,
                           (job_id, fields, prev_job_info,
482
483
                            prev_log_serial,
                            min(WFJC_TIMEOUT, timeout)))
484
485

  def WaitForJobChange(self, job_id, fields, prev_job_info, prev_log_serial):
486
    while True:
487
488
      result = self.WaitForJobChangeOnce(job_id, fields,
                                         prev_job_info, prev_log_serial)
489
490
491
      if result != constants.JOB_NOTCHANGED:
        break
    return result
492

493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
  def Query(self, what, fields, filter_):
    """Query for resources/items.

    @param what: One of L{constants.QR_OP_LUXI}
    @type fields: List of strings
    @param fields: List of requested fields
    @type filter_: None or list
    @param filter_: Query filter
    @rtype: L{objects.QueryResponse}

    """
    req = objects.QueryRequest(what=what, fields=fields, filter=filter_)
    result = self.CallMethod(REQ_QUERY, req.ToDict())
    return objects.QueryResponse.FromDict(result)

  def QueryFields(self, what, fields):
    """Query for available fields.

    @param what: One of L{constants.QR_OP_LUXI}
    @type fields: None or list of strings
    @param fields: List of requested fields
    @rtype: L{objects.QueryFieldsResponse}

    """
    req = objects.QueryFieldsRequest(what=what, fields=fields)
    result = self.CallMethod(REQ_QUERY_FIELDS, req.ToDict())
    return objects.QueryFieldsResponse.FromDict(result)

521
522
  def QueryJobs(self, job_ids, fields):
    return self.CallMethod(REQ_QUERY_JOBS, (job_ids, fields))
523

524
525
  def QueryInstances(self, names, fields, use_locking):
    return self.CallMethod(REQ_QUERY_INSTANCES, (names, fields, use_locking))
526

527
528
  def QueryNodes(self, names, fields, use_locking):
    return self.CallMethod(REQ_QUERY_NODES, (names, fields, use_locking))
Michael Hanselmann's avatar
Michael Hanselmann committed
529

530
531
532
  def QueryGroups(self, names, fields, use_locking):
    return self.CallMethod(REQ_QUERY_GROUPS, (names, fields, use_locking))

533
534
  def QueryExports(self, nodes, use_locking):
    return self.CallMethod(REQ_QUERY_EXPORTS, (nodes, use_locking))
535

536
537
538
  def QueryClusterInfo(self):
    return self.CallMethod(REQ_QUERY_CLUSTER_INFO, ())

539
540
541
  def QueryConfigValues(self, fields):
    return self.CallMethod(REQ_QUERY_CONFIG_VALUES, fields)

Iustin Pop's avatar
Iustin Pop committed
542
543
  def QueryTags(self, kind, name):
    return self.CallMethod(REQ_QUERY_TAGS, (kind, name))
Michael Hanselmann's avatar
Michael Hanselmann committed
544
545
546

  def QueryLocks(self, fields, sync):
    return self.CallMethod(REQ_QUERY_LOCKS, (fields, sync))