luxi.py 16 KB
Newer Older
1
2
3
#
#

4
# Copyright (C) 2006, 2007, 2011, 2012 Google Inc.
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
#
# 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
from ganeti import pathutils
44
45


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

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

71
72
73
#: List of all LUXI requests
REQ_ALL = frozenset([
  REQ_ARCHIVE_JOB,
74
  REQ_AUTO_ARCHIVE_JOBS,
75
76
77
78
79
80
81
82
83
84
85
  REQ_CANCEL_JOB,
  REQ_QUERY,
  REQ_QUERY_CLUSTER_INFO,
  REQ_QUERY_CONFIG_VALUES,
  REQ_QUERY_EXPORTS,
  REQ_QUERY_FIELDS,
  REQ_QUERY_GROUPS,
  REQ_QUERY_INSTANCES,
  REQ_QUERY_JOBS,
  REQ_QUERY_NODES,
  REQ_QUERY_TAGS,
86
  REQ_SET_DRAIN_FLAG,
87
88
89
90
91
92
  REQ_SET_WATCHER_PAUSE,
  REQ_SUBMIT_JOB,
  REQ_SUBMIT_MANY_JOBS,
  REQ_WAIT_FOR_JOB_CHANGE,
  ])

93
94
95
DEF_CTMO = 10
DEF_RWTO = 60

96
97
98
# WaitForJobChange timeout
WFJC_TIMEOUT = (DEF_RWTO - 1) / 2

99

100
class ProtocolError(errors.LuxiError):
101
  """Denotes an error in the LUXI protocol."""
102
103
104


class ConnectionClosedError(ProtocolError):
105
  """Connection closed error."""
106
107
108


class TimeoutError(ProtocolError):
109
  """Operation timeout error."""
110
111


112
class RequestError(ProtocolError):
113
  """Error on request.
114
115
116
117
118
119
120
121
122
123

  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

  """

124

125
class NoMasterError(ProtocolError):
126
  """The master cannot be reached.
127
128
129
130
131
132

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

  """

133

134
135
136
137
138
139
140
141
class PermissionError(ProtocolError):
  """Permission denied while connecting to the master socket.

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

  """


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

  """

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

      # Try to connect
186
      try:
187
188
189
190
191
        utils.Retry(self._Connect, 1.0, self._ctimeout,
                    args=(self.socket, address, self._ctimeout))
      except utils.RetryTimeout:
        raise TimeoutError("Connect timed out")

192
      self.socket.settimeout(self._rwtimeout)
193
    except (socket.error, NoMasterError):
194
195
196
197
198
      if self.socket is not None:
        self.socket.close()
      self.socket = None
      raise

199
200
201
202
203
204
205
206
  @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:
207
208
      error_code = err.args[0]
      if error_code in (errno.ENOENT, errno.ECONNREFUSED):
209
        raise NoMasterError(address)
210
211
212
      elif error_code in (errno.EPERM, errno.EACCES):
        raise PermissionError(address)
      elif error_code == errno.EAGAIN:
213
214
215
216
        # Server's socket backlog is full at the moment
        raise utils.RetryAgain()
      raise

217
218
219
220
221
222
223
224
225
226
227
228
229
  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.

    """
230
    if constants.LUXI_EOM in msg:
Michael Hanselmann's avatar
Michael Hanselmann committed
231
232
      raise ProtocolError("Message terminator found in payload")

233
234
    self._CheckSocket()
    try:
235
      # TODO: sendall is not guaranteed to send everything
236
      self.socket.sendall(msg + constants.LUXI_EOM)
237
238
239
240
    except socket.timeout, err:
      raise TimeoutError("Sending timeout: %s" % str(err))

  def Recv(self):
Michael Hanselmann's avatar
Michael Hanselmann committed
241
    """Try to receive a message from the socket.
242
243
244
245
246
247
248
249
250
251
252
253

    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")
254
255
256
      while True:
        try:
          data = self.socket.recv(4096)
257
258
        except socket.timeout, err:
          raise TimeoutError("Receive timeout: %s" % str(err))
259
260
261
262
263
        except socket.error, err:
          if err.args and err.args[0] == errno.EAGAIN:
            continue
          raise
        break
264
265
      if not data:
        raise ConnectionClosedError("Connection closed while reading")
266
      new_msgs = (self._buffer + data).split(constants.LUXI_EOM)
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
      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


287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
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)")

302
303
304
  method = request.get(KEY_METHOD, None) # pylint: disable=E1103
  args = request.get(KEY_ARGS, None) # pylint: disable=E1103
  version = request.get(KEY_VERSION, None) # pylint: disable=E1103
Guido Trotter's avatar
Guido Trotter committed
305

306
307
308
309
310
  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)

311
  return (method, args, version)
312
313
314
315
316
317
318
319
320


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

  """
  # Parse the result
  try:
    data = serializer.LoadJson(msg)
321
322
  except KeyboardInterrupt:
    raise
323
324
325
326
327
328
329
330
331
  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
332
  return (data[KEY_SUCCESS], data[KEY_RESULT],
333
          data.get(KEY_VERSION, None)) # pylint: disable=E1103
334
335


336
def FormatResponse(success, result, version=None):
337
338
339
340
341
342
343
344
  """Formats a LUXI response message.

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

345
346
347
  if version is not None:
    response[KEY_VERSION] = version

348
349
350
351
352
  logging.debug("LUXI response: %s", response)

  return serializer.DumpJson(response)


353
def FormatRequest(method, args, version=None):
354
355
356
357
358
359
360
361
362
  """Formats a LUXI request message.

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

363
364
365
  if version is not None:
    request[KEY_VERSION] = version

366
  # Serialize the request
367
  return serializer.DumpJson(request)
368
369


370
def CallLuxiMethod(transport_cb, method, args, version=None):
371
372
373
374
375
  """Send a LUXI request via a transport and return the response.

  """
  assert callable(transport_cb)

376
  request_msg = FormatRequest(method, args, version=version)
377
378
379
380

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

381
382
383
384
385
386
  (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))
387
388
389
390
391
392
393
394

  if success:
    return result

  errors.MaybeRaise(result)
  raise RequestError(result)


395
396
397
398
399
400
401
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
402
  def __init__(self, address=None, timeouts=None, transport=Transport):
403
404
405
406
407
408
409
410
411
412
413
414
    """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
415
    if address is None:
416
      address = pathutils.MASTER_SOCKET
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
    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()
441
    except Exception: # pylint: disable=W0703
442
      pass
443

444
  def _SendMethodCall(self, data):
445
    # Send request and wait for response
446
447
    try:
      self._InitTransport()
448
      return self.transport.Call(data)
449
450
451
452
    except Exception:
      self._CloseTransport()
      raise

453
454
455
456
457
458
  def Close(self):
    """Close the underlying connection.

    """
    self._CloseTransport()

459
460
  def CallMethod(self, method, args):
    """Send a generic request and return the response.
461

462
    """
463
464
465
    if not isinstance(args, (list, tuple)):
      raise errors.ProgrammerError("Invalid parameter passed to CallMethod:"
                                   " expected list, got %s" % type(args))
466
467
    return CallLuxiMethod(self._SendMethodCall, method, args,
                          version=constants.LUXI_VERSION)
468

469
  def SetQueueDrainFlag(self, drain_flag):
470
    return self.CallMethod(REQ_SET_DRAIN_FLAG, (drain_flag, ))
471

472
  def SetWatcherPause(self, until):
473
    return self.CallMethod(REQ_SET_WATCHER_PAUSE, (until, ))
474

475
476
  def SubmitJob(self, ops):
    ops_state = map(lambda op: op.__getstate__(), ops)
477
    return self.CallMethod(REQ_SUBMIT_JOB, (ops_state, ))
478

479
480
481
482
  def SubmitManyJobs(self, jobs):
    jobs_state = []
    for ops in jobs:
      jobs_state.append([op.__getstate__() for op in ops])
483
    return self.CallMethod(REQ_SUBMIT_MANY_JOBS, (jobs_state, ))
484

485
  def CancelJob(self, job_id):
486
    return self.CallMethod(REQ_CANCEL_JOB, (job_id, ))
487
488

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

Iustin Pop's avatar
Iustin Pop committed
491
  def AutoArchiveJobs(self, age):
492
    timeout = (DEF_RWTO - 1) / 2
493
    return self.CallMethod(REQ_AUTO_ARCHIVE_JOBS, (age, timeout))
Iustin Pop's avatar
Iustin Pop committed
494

495
  def WaitForJobChangeOnce(self, job_id, fields,
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
                           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"
513
514
    return self.CallMethod(REQ_WAIT_FOR_JOB_CHANGE,
                           (job_id, fields, prev_job_info,
515
516
                            prev_log_serial,
                            min(WFJC_TIMEOUT, timeout)))
517
518

  def WaitForJobChange(self, job_id, fields, prev_job_info, prev_log_serial):
519
    while True:
520
521
      result = self.WaitForJobChangeOnce(job_id, fields,
                                         prev_job_info, prev_log_serial)
522
523
524
      if result != constants.JOB_NOTCHANGED:
        break
    return result
525

526
  def Query(self, what, fields, qfilter):
527
528
    """Query for resources/items.

529
    @param what: One of L{constants.QR_VIA_LUXI}
530
531
    @type fields: List of strings
    @param fields: List of requested fields
532
533
    @type qfilter: None or list
    @param qfilter: Query filter
534
535
536
    @rtype: L{objects.QueryResponse}

    """
537
    result = self.CallMethod(REQ_QUERY, (what, fields, qfilter))
538
539
540
541
542
    return objects.QueryResponse.FromDict(result)

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

543
    @param what: One of L{constants.QR_VIA_LUXI}
544
545
546
547
548
    @type fields: None or list of strings
    @param fields: List of requested fields
    @rtype: L{objects.QueryFieldsResponse}

    """
549
    result = self.CallMethod(REQ_QUERY_FIELDS, (what, fields))
550
551
    return objects.QueryFieldsResponse.FromDict(result)

552
553
  def QueryJobs(self, job_ids, fields):
    return self.CallMethod(REQ_QUERY_JOBS, (job_ids, fields))
554

555
556
  def QueryInstances(self, names, fields, use_locking):
    return self.CallMethod(REQ_QUERY_INSTANCES, (names, fields, use_locking))
557

558
559
  def QueryNodes(self, names, fields, use_locking):
    return self.CallMethod(REQ_QUERY_NODES, (names, fields, use_locking))
Michael Hanselmann's avatar
Michael Hanselmann committed
560

561
562
563
  def QueryGroups(self, names, fields, use_locking):
    return self.CallMethod(REQ_QUERY_GROUPS, (names, fields, use_locking))

564
565
  def QueryExports(self, nodes, use_locking):
    return self.CallMethod(REQ_QUERY_EXPORTS, (nodes, use_locking))
566

567
568
569
  def QueryClusterInfo(self):
    return self.CallMethod(REQ_QUERY_CLUSTER_INFO, ())

570
  def QueryConfigValues(self, fields):
571
    return self.CallMethod(REQ_QUERY_CONFIG_VALUES, (fields, ))
572

Iustin Pop's avatar
Iustin Pop committed
573
574
  def QueryTags(self, kind, name):
    return self.CallMethod(REQ_QUERY_TAGS, (kind, name))