X-Git-Url: https://code.grnet.gr/git/ganeti-local/blobdiff_plain/5c73520908a113583d7ff61f751a9cc4737a68b7..b4e8599b115ebeb3833515530a6bc328144d0447:/lib/luxi.py diff --git a/lib/luxi.py b/lib/luxi.py index f04aee7..0de9185 100644 --- a/lib/luxi.py +++ b/lib/luxi.py @@ -1,7 +1,7 @@ # # -# Copyright (C) 2006, 2007 Google Inc. +# Copyright (C) 2006, 2007, 2011, 2012 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 @@ -21,11 +21,11 @@ """Module for the unix socket protocol -This module implements the local unix socket protocl. You only need +This module implements the local unix socket protocol. You only need this module and the opcodes module in the client program in order to communicate with the master. -The module is also be used by the master daemon. +The module is also used by the master daemon. """ @@ -33,51 +33,89 @@ import socket import collections import time import errno +import logging +from ganeti import compat from ganeti import serializer from ganeti import constants +from ganeti import errors +from ganeti import utils +from ganeti import objects +from ganeti import pathutils -KEY_METHOD = 'method' -KEY_ARGS = 'args' +KEY_METHOD = "method" +KEY_ARGS = "args" KEY_SUCCESS = "success" KEY_RESULT = "result" +KEY_VERSION = "version" REQ_SUBMIT_JOB = "SubmitJob" +REQ_SUBMIT_MANY_JOBS = "SubmitManyJobs" REQ_WAIT_FOR_JOB_CHANGE = "WaitForJobChange" REQ_CANCEL_JOB = "CancelJob" REQ_ARCHIVE_JOB = "ArchiveJob" +REQ_CHANGE_JOB_PRIORITY = "ChangeJobPriority" +REQ_AUTO_ARCHIVE_JOBS = "AutoArchiveJobs" +REQ_QUERY = "Query" +REQ_QUERY_FIELDS = "QueryFields" REQ_QUERY_JOBS = "QueryJobs" REQ_QUERY_INSTANCES = "QueryInstances" REQ_QUERY_NODES = "QueryNodes" +REQ_QUERY_GROUPS = "QueryGroups" +REQ_QUERY_NETWORKS = "QueryNetworks" REQ_QUERY_EXPORTS = "QueryExports" +REQ_QUERY_CONFIG_VALUES = "QueryConfigValues" +REQ_QUERY_CLUSTER_INFO = "QueryClusterInfo" +REQ_QUERY_TAGS = "QueryTags" +REQ_SET_DRAIN_FLAG = "SetDrainFlag" +REQ_SET_WATCHER_PAUSE = "SetWatcherPause" + +#: List of all LUXI requests +REQ_ALL = compat.UniqueFrozenset([ + REQ_ARCHIVE_JOB, + REQ_AUTO_ARCHIVE_JOBS, + REQ_CANCEL_JOB, + REQ_CHANGE_JOB_PRIORITY, + 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_NETWORKS, + REQ_QUERY_TAGS, + REQ_SET_DRAIN_FLAG, + REQ_SET_WATCHER_PAUSE, + REQ_SUBMIT_JOB, + REQ_SUBMIT_MANY_JOBS, + REQ_WAIT_FOR_JOB_CHANGE, + ]) DEF_CTMO = 10 DEF_RWTO = 60 +# WaitForJobChange timeout +WFJC_TIMEOUT = (DEF_RWTO - 1) / 2 -class ProtocolError(Exception): - """Denotes an error in the server communication""" + +class ProtocolError(errors.LuxiError): + """Denotes an error in the LUXI protocol.""" class ConnectionClosedError(ProtocolError): - """Connection closed error""" + """Connection closed error.""" class TimeoutError(ProtocolError): - """Operation timeout error""" - - -class EncodingError(ProtocolError): - """Encoding failure on the sending side""" - - -class DecodingError(ProtocolError): - """Decoding failure on the receiving side""" + """Operation timeout error.""" class RequestError(ProtocolError): - """Error on request + """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. @@ -90,7 +128,7 @@ class RequestError(ProtocolError): class NoMasterError(ProtocolError): - """The master cannot be reached + """The master cannot be reached. This means that the master daemon is not running or the socket has been removed. @@ -98,6 +136,14 @@ class NoMasterError(ProtocolError): """ +class PermissionError(ProtocolError): + """Permission denied while connecting to the master socket. + + This means the user doesn't have the proper rights. + + """ + + class Transport: """Low-level transport class. @@ -110,15 +156,12 @@ class Transport: """ - def __init__(self, address, timeouts=None, eom=None): + def __init__(self, address, timeouts=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. @@ -141,22 +184,16 @@ class Transport: 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 to connect try: - self.socket.connect(address) - except socket.timeout, err: - raise TimeoutError("Connect timed out: %s" % str(err)) - except socket.error, err: - if err.args[0] in (errno.ENOENT, errno.ECONNREFUSED): - raise NoMasterError((address,)) - raise + utils.Retry(self._Connect, 1.0, self._ctimeout, + args=(self.socket, address, self._ctimeout)) + except utils.RetryTimeout: + raise TimeoutError("Connect timed out") + self.socket.settimeout(self._rwtimeout) except (socket.error, NoMasterError): if self.socket is not None: @@ -164,6 +201,24 @@ class Transport: self.socket = None raise + @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: + error_code = err.args[0] + if error_code in (errno.ENOENT, errno.ECONNREFUSED): + raise NoMasterError(address) + elif error_code in (errno.EPERM, errno.EACCES): + raise PermissionError(address) + elif error_code == errno.EAGAIN: + # Server's socket backlog is full at the moment + raise utils.RetryAgain() + raise + def _CheckSocket(self): """Make sure we are connected. @@ -177,16 +232,18 @@ class Transport: This just sends a message and doesn't wait for the response. """ - if self.eom in msg: - raise EncodingError("Message terminator found in payload") + if constants.LUXI_EOM in msg: + raise ProtocolError("Message terminator found in payload") + self._CheckSocket() try: - self.socket.sendall(msg + self.eom) + # TODO: sendall is not guaranteed to send everything + self.socket.sendall(msg + constants.LUXI_EOM) except socket.timeout, err: raise TimeoutError("Sending timeout: %s" % str(err)) def Recv(self): - """Try to receive a messae from the socket. + """Try to receive a message from the socket. In case we already have messages queued, we just return from the queue. Otherwise, we try to read data with a _rwtimeout network @@ -199,13 +256,19 @@ class Transport: while not self._msgs: if time.time() > etime: raise TimeoutError("Extended receive timeout") - try: - data = self.socket.recv(4096) - except socket.timeout, err: - raise TimeoutError("Receive timeout: %s" % str(err)) + while True: + try: + data = self.socket.recv(4096) + except socket.timeout, err: + raise TimeoutError("Receive timeout: %s" % str(err)) + except socket.error, err: + if err.args and err.args[0] == errno.EAGAIN: + continue + raise + break if not data: raise ConnectionClosedError("Connection closed while reading") - new_msgs = (self._buffer + data).split(self.eom) + new_msgs = (self._buffer + data).split(constants.LUXI_EOM) self._buffer = new_msgs.pop() self._msgs.extend(new_msgs) return self._msgs.popleft() @@ -226,6 +289,114 @@ class Transport: self.socket = None +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)") + + 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 + + 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) + + return (method, args, version) + + +def ParseResponse(msg): + """Parses a LUXI response message. + + """ + # Parse the result + try: + data = serializer.LoadJson(msg) + except KeyboardInterrupt: + raise + 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) + + return (data[KEY_SUCCESS], data[KEY_RESULT], + data.get(KEY_VERSION, None)) # pylint: disable=E1103 + + +def FormatResponse(success, result, version=None): + """Formats a LUXI response message. + + """ + response = { + KEY_SUCCESS: success, + KEY_RESULT: result, + } + + if version is not None: + response[KEY_VERSION] = version + + logging.debug("LUXI response: %s", response) + + return serializer.DumpJson(response) + + +def FormatRequest(method, args, version=None): + """Formats a LUXI request message. + + """ + # Build request + request = { + KEY_METHOD: method, + KEY_ARGS: args, + } + + if version is not None: + request[KEY_VERSION] = version + + # Serialize the request + return serializer.DumpJson(request) + + +def CallLuxiMethod(transport_cb, method, args, version=None): + """Send a LUXI request via a transport and return the response. + + """ + assert callable(transport_cb) + + request_msg = FormatRequest(method, args, version=version) + + # Send request and wait for response + response_msg = transport_cb(request_msg) + + (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)) + + if success: + return result + + errors.MaybeRaise(result) + raise RequestError(result) + + class Client(object): """High-level client implementation. @@ -247,68 +418,168 @@ class Client(object): """ if address is None: - address = constants.MASTER_SOCKET - self.transport = transport(address, timeouts=timeouts) + address = pathutils.MASTER_SOCKET + self.address = address + self.timeouts = timeouts + self.transport_class = transport + self.transport = None + self._InitTransport() - def CallMethod(self, method, args): - """Send a generic request and return the response. + 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. """ - # Build request - request = { - KEY_METHOD: method, - KEY_ARGS: args, - } + if self.transport is None: + return + try: + old_transp = self.transport + self.transport = None + old_transp.Close() + except Exception: # pylint: disable=W0703 + pass + def _SendMethodCall(self, data): # Send request and wait for response - result = self.transport.Call(serializer.DumpJson(request, indent=False)) try: - data = serializer.LoadJson(result) - except Exception, err: - raise ProtocolError("Error while deserializing response: %s" % str(err)) + self._InitTransport() + return self.transport.Call(data) + except Exception: + self._CloseTransport() + raise - # Validate response - if (not isinstance(data, dict) or - KEY_SUCCESS not in data or - KEY_RESULT not in data): - raise DecodingError("Invalid response from server: %s" % str(data)) + def Close(self): + """Close the underlying connection. - if not data[KEY_SUCCESS]: - # TODO: decide on a standard exception - raise RequestError(data[KEY_RESULT]) + """ + self._CloseTransport() - return data[KEY_RESULT] + def CallMethod(self, method, args): + """Send a generic request and return the response. + + """ + if not isinstance(args, (list, tuple)): + raise errors.ProgrammerError("Invalid parameter passed to CallMethod:" + " expected list, got %s" % type(args)) + return CallLuxiMethod(self._SendMethodCall, method, args, + version=constants.LUXI_VERSION) + + def SetQueueDrainFlag(self, drain_flag): + return self.CallMethod(REQ_SET_DRAIN_FLAG, (drain_flag, )) + + def SetWatcherPause(self, until): + return self.CallMethod(REQ_SET_WATCHER_PAUSE, (until, )) def SubmitJob(self, ops): ops_state = map(lambda op: op.__getstate__(), ops) - return self.CallMethod(REQ_SUBMIT_JOB, ops_state) + return self.CallMethod(REQ_SUBMIT_JOB, (ops_state, )) + + 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, )) def CancelJob(self, job_id): - return self.CallMethod(REQ_CANCEL_JOB, job_id) + return self.CallMethod(REQ_CANCEL_JOB, (job_id, )) def ArchiveJob(self, job_id): - return self.CallMethod(REQ_ARCHIVE_JOB, job_id) + return self.CallMethod(REQ_ARCHIVE_JOB, (job_id, )) - def WaitForJobChange(self, job_id, fields, prev_job_info, prev_log_serial): + def ChangeJobPriority(self, job_id, priority): + return self.CallMethod(REQ_CHANGE_JOB_PRIORITY, (job_id, priority)) + + def AutoArchiveJobs(self, age): timeout = (DEF_RWTO - 1) / 2 + return self.CallMethod(REQ_AUTO_ARCHIVE_JOBS, (age, timeout)) + + def WaitForJobChangeOnce(self, job_id, fields, + 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" + return self.CallMethod(REQ_WAIT_FOR_JOB_CHANGE, + (job_id, fields, prev_job_info, + prev_log_serial, + min(WFJC_TIMEOUT, timeout))) + + def WaitForJobChange(self, job_id, fields, prev_job_info, prev_log_serial): while True: - result = self.CallMethod(REQ_WAIT_FOR_JOB_CHANGE, - (job_id, fields, prev_job_info, - prev_log_serial, timeout)) + result = self.WaitForJobChangeOnce(job_id, fields, + prev_job_info, prev_log_serial) if result != constants.JOB_NOTCHANGED: break return result + def Query(self, what, fields, qfilter): + """Query for resources/items. + + @param what: One of L{constants.QR_VIA_LUXI} + @type fields: List of strings + @param fields: List of requested fields + @type qfilter: None or list + @param qfilter: Query filter + @rtype: L{objects.QueryResponse} + + """ + result = self.CallMethod(REQ_QUERY, (what, fields, qfilter)) + return objects.QueryResponse.FromDict(result) + + def QueryFields(self, what, fields): + """Query for available fields. + + @param what: One of L{constants.QR_VIA_LUXI} + @type fields: None or list of strings + @param fields: List of requested fields + @rtype: L{objects.QueryFieldsResponse} + + """ + result = self.CallMethod(REQ_QUERY_FIELDS, (what, fields)) + return objects.QueryFieldsResponse.FromDict(result) + def QueryJobs(self, job_ids, fields): return self.CallMethod(REQ_QUERY_JOBS, (job_ids, fields)) - def QueryInstances(self, names, fields): - return self.CallMethod(REQ_QUERY_INSTANCES, (names, fields)) + def QueryInstances(self, names, fields, use_locking): + return self.CallMethod(REQ_QUERY_INSTANCES, (names, fields, use_locking)) + + def QueryNodes(self, names, fields, use_locking): + return self.CallMethod(REQ_QUERY_NODES, (names, fields, use_locking)) + + def QueryGroups(self, names, fields, use_locking): + return self.CallMethod(REQ_QUERY_GROUPS, (names, fields, use_locking)) + + def QueryNetworks(self, names, fields, use_locking): + return self.CallMethod(REQ_QUERY_NETWORKS, (names, fields, use_locking)) + + def QueryExports(self, nodes, use_locking): + return self.CallMethod(REQ_QUERY_EXPORTS, (nodes, use_locking)) - def QueryNodes(self, names, fields): - return self.CallMethod(REQ_QUERY_NODES, (names, fields)) + def QueryClusterInfo(self): + return self.CallMethod(REQ_QUERY_CLUSTER_INFO, ()) - def QueryExports(self, nodes): - return self.CallMethod(REQ_QUERY_EXPORTS, nodes) + def QueryConfigValues(self, fields): + return self.CallMethod(REQ_QUERY_CONFIG_VALUES, (fields, )) -# TODO: class Server(object) + def QueryTags(self, kind, name): + return self.CallMethod(REQ_QUERY_TAGS, (kind, name))