Synnefo » snf-ganeti

#

#

# 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.

"""Inter-node RPC library.

"""

# pylint: disable-msg=C0103,R0201,R0904

# C0103: Invalid name, since call_ are not valid

# R0201: Method could be a function, we keep all rpcs instance methods

# as not to change them back and forth between static/instance methods

# if they need to start using instance attributes

# R0904: Too many public methods

import os

import logging

import zlib

import base64

from ganeti import utils

from ganeti import objects

from ganeti import http

from ganeti import serializer

from ganeti import constants

from ganeti import errors

# pylint has a bug here, doesn't see this import

import ganeti.http.client  # pylint: disable-msg=W0611

# Module level variable

_http_manager = None

def Init():

  """Initializes the module-global HTTP client manager.

  Must be called before using any RPC function.

  """

  global _http_manager # pylint: disable-msg=W0603

  assert not _http_manager, "RPC module initialized more than once"

  _http_manager = http.client.HttpClientManager()

def Shutdown():

  """Stops the module-global HTTP client manager.

  Must be called before quitting the program.

  """

  global _http_manager # pylint: disable-msg=W0603

  if _http_manager:

    _http_manager.Shutdown()

    _http_manager = None

class RpcResult(object):

  """RPC Result class.

  This class holds an RPC result. It is needed since in multi-node

  calls we can't raise an exception just because one one out of many

  failed, and therefore we use this class to encapsulate the result.

  @ivar data: the data payload, for successful results, or None

  @type failed: boolean

  @ivar failed: whether the operation failed at RPC level (not

      application level on the remote node)

  @ivar call: the name of the RPC call

  @ivar node: the name of the node to which we made the call

  @ivar offline: whether the operation failed because the node was

      offline, as opposed to actual failure; offline=True will always

      imply failed=True, in order to allow simpler checking if

      the user doesn't care about the exact failure mode

  """

  def __init__(self, data=None, failed=False, offline=False,

               call=None, node=None):

    self.failed = failed

    self.offline = offline

    self.call = call

    self.node = node

    if offline:

      self.failed = True

      self.error = "Node is marked offline"

      self.data = self.payload = None

    elif failed:

      self.error = data

      self.data = self.payload = None

    else:

      self.data = data

      self.error = None

      if isinstance(data, (tuple, list)) and len(data) == 2:

        self.payload = data[1]

      else:

        self.payload = None

  def Raise(self):

    """If the result has failed, raise an OpExecError.

    This is used so that LU code doesn't have to check for each

    result, but instead can call this function.

    """

    if self.failed:

      raise errors.OpExecError("Call '%s' to node '%s' has failed: %s" %

                               (self.call, self.node, self.error))

  def RemoteFailMsg(self):

    """Check if the remote procedure failed.

    This is valid only for RPC calls which return result of the form

    (status, data | error_msg).

    @return: empty string for succcess, otherwise an error message

    """

    def _EnsureErr(val):

      """Helper to ensure we return a 'True' value for error."""

      if val:

        return val

      else:

        return "No error information"

    if self.failed:

      return _EnsureErr(self.error)

    if not isinstance(self.data, (tuple, list)):

      return "Invalid result type (%s)" % type(self.data)

    if len(self.data) != 2:

      return "Invalid result length (%d), expected 2" % len(self.data)

    if not self.data[0]:

      return _EnsureErr(self.data[1])

    return ""

class Client:

  """RPC Client class.

  This class, given a (remote) method name, a list of parameters and a

  list of nodes, will contact (in parallel) all nodes, and return a

  dict of results (key: node name, value: result).

  One current bug is that generic failure is still signaled by

  'False' result, which is not good. This overloading of values can

  cause bugs.

  """

  def __init__(self, procedure, body, port):

    self.procedure = procedure

    self.body = body

    self.port = port

    self.nc = {}

    self._ssl_params = \

      http.HttpSslParams(ssl_key_path=constants.SSL_CERT_FILE,

                         ssl_cert_path=constants.SSL_CERT_FILE)

  def ConnectList(self, node_list, address_list=None):

    """Add a list of nodes to the target nodes.

    @type node_list: list

    @param node_list: the list of node names to connect

    @type address_list: list or None

    @keyword address_list: either None or a list with node addresses,

        which must have the same length as the node list

    """

    if address_list is None:

      address_list = [None for _ in node_list]

    else:

      assert len(node_list) == len(address_list), \

             "Name and address lists should have the same length"

    for node, address in zip(node_list, address_list):

      self.ConnectNode(node, address)

  def ConnectNode(self, name, address=None):

    """Add a node to the target list.

    @type name: str

    @param name: the node name

    @type address: str

    @keyword address: the node address, if known

    """

    if address is None:

      address = name

    self.nc[name] = \

      http.client.HttpClientRequest(address, self.port, http.HTTP_PUT,

                                    "/%s" % self.procedure,

                                    post_data=self.body,

                                    ssl_params=self._ssl_params,

                                    ssl_verify_peer=True)

  def GetResults(self):

    """Call nodes and return results.

    @rtype: list

    @return: List of RPC results

    """

    assert _http_manager, "RPC module not initialized"

    _http_manager.ExecRequests(self.nc.values())

    results = {}

    for name, req in self.nc.iteritems():

      if req.success and req.resp_status_code == http.HTTP_OK:

        results[name] = RpcResult(data=serializer.LoadJson(req.resp_body),

                                  node=name, call=self.procedure)

        continue

      # TODO: Better error reporting

      if req.error:

        msg = req.error

      else:

        msg = req.resp_body

      logging.error("RPC error in %s from node %s: %s",

                    self.procedure, name, msg)

      results[name] = RpcResult(data=msg, failed=True, node=name,

                                call=self.procedure)

    return results

class RpcRunner(object):

  """RPC runner class"""

  def __init__(self, cfg):

    """Initialized the rpc runner.

    @type cfg:  C{config.ConfigWriter}

    @param cfg: the configuration object that will be used to get data

                about the cluster

    """

    self._cfg = cfg

    self.port = utils.GetNodeDaemonPort()

  def _InstDict(self, instance, hvp=None, bep=None):

    """Convert the given instance to a dict.

    This is done via the instance's ToDict() method and additionally

    we fill the hvparams with the cluster defaults.

    @type instance: L{objects.Instance}

    @param instance: an Instance object

    @type hvp: dict or None

    @param hvp: a dictionary with overridden hypervisor parameters

    @type bep: dict or None

    @param bep: a dictionary with overridden backend parameters

    @rtype: dict

    @return: the instance dict, with the hvparams filled with the

        cluster defaults

    """

    idict = instance.ToDict()

    cluster = self._cfg.GetClusterInfo()

    idict["hvparams"] = cluster.FillHV(instance)

    if hvp is not None:

      idict["hvparams"].update(hvp)

    idict["beparams"] = cluster.FillBE(instance)

    if bep is not None:

      idict["beparams"].update(bep)

    return idict

  def _ConnectList(self, client, node_list, call):

    """Helper for computing node addresses.

    @type client: L{ganeti.rpc.Client}

    @param client: a C{Client} instance

    @type node_list: list

    @param node_list: the node list we should connect

    @type call: string

    @param call: the name of the remote procedure call, for filling in

        correctly any eventual offline nodes' results

    """

    all_nodes = self._cfg.GetAllNodesInfo()

    name_list = []

    addr_list = []

    skip_dict = {}

    for node in node_list:

      if node in all_nodes:

        if all_nodes[node].offline:

          skip_dict[node] = RpcResult(node=node, offline=True, call=call)

          continue

        val = all_nodes[node].primary_ip

      else:

        val = None

      addr_list.append(val)

      name_list.append(node)

    if name_list:

      client.ConnectList(name_list, address_list=addr_list)

    return skip_dict

  def _ConnectNode(self, client, node, call):

    """Helper for computing one node's address.

    @type client: L{ganeti.rpc.Client}

    @param client: a C{Client} instance

    @type node: str

    @param node: the node we should connect

    @type call: string

    @param call: the name of the remote procedure call, for filling in

        correctly any eventual offline nodes' results

    """

    node_info = self._cfg.GetNodeInfo(node)

    if node_info is not None:

      if node_info.offline:

        return RpcResult(node=node, offline=True, call=call)

      addr = node_info.primary_ip

    else:

      addr = None

    client.ConnectNode(node, address=addr)

  def _MultiNodeCall(self, node_list, procedure, args):

    """Helper for making a multi-node call

    """

    body = serializer.DumpJson(args, indent=False)

    c = Client(procedure, body, self.port)

    skip_dict = self._ConnectList(c, node_list, procedure)

    skip_dict.update(c.GetResults())

    return skip_dict

  @classmethod

  def _StaticMultiNodeCall(cls, node_list, procedure, args,

                           address_list=None):

    """Helper for making a multi-node static call

    """

    body = serializer.DumpJson(args, indent=False)

    c = Client(procedure, body, utils.GetNodeDaemonPort())

    c.ConnectList(node_list, address_list=address_list)

    return c.GetResults()

  def _SingleNodeCall(self, node, procedure, args):

    """Helper for making a single-node call

    """

    body = serializer.DumpJson(args, indent=False)

    c = Client(procedure, body, self.port)

    result = self._ConnectNode(c, node, procedure)

    if result is None:

      # we did connect, node is not offline

      result = c.GetResults()[node]

    return result

  @classmethod

  def _StaticSingleNodeCall(cls, node, procedure, args):

    """Helper for making a single-node static call

    """

    body = serializer.DumpJson(args, indent=False)

    c = Client(procedure, body, utils.GetNodeDaemonPort())

    c.ConnectNode(node)

    return c.GetResults()[node]

  @staticmethod

  def _Compress(data):

    """Compresses a string for transport over RPC.

    Small amounts of data are not compressed.

    @type data: str

    @param data: Data

    @rtype: tuple

    @return: Encoded data to send

    """

    # Small amounts of data are not compressed

    if len(data) < 512:

      return (constants.RPC_ENCODING_NONE, data)

    # Compress with zlib and encode in base64

    return (constants.RPC_ENCODING_ZLIB_BASE64,

            base64.b64encode(zlib.compress(data, 3)))

  #

  # Begin RPC calls

  #

  def call_volume_list(self, node_list, vg_name):

    """Gets the logical volumes present in a given volume group.

    This is a multi-node call.

    """

    return self._MultiNodeCall(node_list, "volume_list", [vg_name])

  def call_vg_list(self, node_list):

    """Gets the volume group list.

    This is a multi-node call.

    """

    return self._MultiNodeCall(node_list, "vg_list", [])

  def call_bridges_exist(self, node, bridges_list):

    """Checks if a node has all the bridges given.

    This method checks if all bridges given in the bridges_list are

    present on the remote node, so that an instance that uses interfaces

    on those bridges can be started.

    This is a single-node call.

    """

    return self._SingleNodeCall(node, "bridges_exist", [bridges_list])

  def call_instance_start(self, node, instance, hvp, bep):

    """Starts an instance.

    This is a single-node call.

    """

    idict = self._InstDict(instance, hvp=hvp, bep=bep)

    return self._SingleNodeCall(node, "instance_start", [idict])

  def call_instance_shutdown(self, node, instance):

    """Stops an instance.

    This is a single-node call.

    """

    return self._SingleNodeCall(node, "instance_shutdown",

                                [self._InstDict(instance)])

  def call_migration_info(self, node, instance):

    """Gather the information necessary to prepare an instance migration.

    This is a single-node call.

    @type node: string

    @param node: the node on which the instance is currently running

    @type instance: C{objects.Instance}

    @param instance: the instance definition

    """

    return self._SingleNodeCall(node, "migration_info",

                                [self._InstDict(instance)])

  def call_accept_instance(self, node, instance, info, target):

    """Prepare a node to accept an instance.

    This is a single-node call.

    @type node: string

    @param node: the target node for the migration

    @type instance: C{objects.Instance}

    @param instance: the instance definition

    @type info: opaque/hypervisor specific (string/data)

    @param info: result for the call_migration_info call

    @type target: string

    @param target: target hostname (usually ip address) (on the node itself)

    """

    return self._SingleNodeCall(node, "accept_instance",

                                [self._InstDict(instance), info, target])

  def call_finalize_migration(self, node, instance, info, success):

    """Finalize any target-node migration specific operation.

    This is called both in case of a successful migration and in case of error

    (in which case it should abort the migration).

    This is a single-node call.

    @type node: string

    @param node: the target node for the migration

    @type instance: C{objects.Instance}

    @param instance: the instance definition

    @type info: opaque/hypervisor specific (string/data)

    @param info: result for the call_migration_info call

    @type success: boolean

    @param success: whether the migration was a success or a failure

    """

    return self._SingleNodeCall(node, "finalize_migration",

                                [self._InstDict(instance), info, success])

  def call_instance_migrate(self, node, instance, target, live):

    """Migrate an instance.

    This is a single-node call.

    @type node: string

    @param node: the node on which the instance is currently running

    @type instance: C{objects.Instance}

    @param instance: the instance definition

    @type target: string

    @param target: the target node name

    @type live: boolean

    @param live: whether the migration should be done live or not (the

        interpretation of this parameter is left to the hypervisor)

    """

    return self._SingleNodeCall(node, "instance_migrate",

                                [self._InstDict(instance), target, live])

  def call_instance_reboot(self, node, instance, reboot_type):

    """Reboots an instance.

    This is a single-node call.

    """

    return self._SingleNodeCall(node, "instance_reboot",

                                [self._InstDict(instance), reboot_type])

  def call_instance_os_add(self, node, inst):

    """Installs an OS on the given instance.

    This is a single-node call.

    """

    return self._SingleNodeCall(node, "instance_os_add",

                                [self._InstDict(inst)])

  def call_instance_run_rename(self, node, inst, old_name):

    """Run the OS rename script for an instance.

    This is a single-node call.

    """

    return self._SingleNodeCall(node, "instance_run_rename",

                                [self._InstDict(inst), old_name])

  def call_instance_info(self, node, instance, hname):

    """Returns information about a single instance.

    This is a single-node call.

    @type node: list

    @param node: the list of nodes to query

    @type instance: string

    @param instance: the instance name

    @type hname: string

    @param hname: the hypervisor type of the instance

    """

    return self._SingleNodeCall(node, "instance_info", [instance, hname])

  def call_instance_migratable(self, node, instance):

    """Checks whether the given instance can be migrated.

    This is a single-node call.

    @param node: the node to query

    @type instance: L{objects.Instance}

    @param instance: the instance to check

    """

    return self._SingleNodeCall(node, "instance_migratable",

                                [self._InstDict(instance)])

  def call_all_instances_info(self, node_list, hypervisor_list):

    """Returns information about all instances on the given nodes.

    This is a multi-node call.

    @type node_list: list

    @param node_list: the list of nodes to query

    @type hypervisor_list: list

    @param hypervisor_list: the hypervisors to query for instances

    """

    return self._MultiNodeCall(node_list, "all_instances_info",

                               [hypervisor_list])

  def call_instance_list(self, node_list, hypervisor_list):

    """Returns the list of running instances on a given node.

    This is a multi-node call.

    @type node_list: list

    @param node_list: the list of nodes to query

    @type hypervisor_list: list

    @param hypervisor_list: the hypervisors to query for instances

    """

    return self._MultiNodeCall(node_list, "instance_list", [hypervisor_list])

  def call_node_tcp_ping(self, node, source, target, port, timeout,

                         live_port_needed):

    """Do a TcpPing on the remote node

    This is a single-node call.

    """

    return self._SingleNodeCall(node, "node_tcp_ping",

                                [source, target, port, timeout,

                                 live_port_needed])

  def call_node_has_ip_address(self, node, address):

    """Checks if a node has the given IP address.

    This is a single-node call.

    """

    return self._SingleNodeCall(node, "node_has_ip_address", [address])

  def call_node_info(self, node_list, vg_name, hypervisor_type):

    """Return node information.

    This will return memory information and volume group size and free

    space.

    This is a multi-node call.

    @type node_list: list

    @param node_list: the list of nodes to query

    @type vg_name: C{string}

    @param vg_name: the name of the volume group to ask for disk space

        information

    @type hypervisor_type: C{str}

    @param hypervisor_type: the name of the hypervisor to ask for

        memory information

    """

    retux = self._MultiNodeCall(node_list, "node_info",

                                [vg_name, hypervisor_type])

    for result in retux.itervalues():

      if result.failed or not isinstance(result.data, dict):

        result.data = {}

      if result.offline:

        log_name = None

      else:

        log_name = "call_node_info"

      utils.CheckDict(result.data, {

        'memory_total' : '-',

        'memory_dom0' : '-',

        'memory_free' : '-',

        'vg_size' : 'node_unreachable',

        'vg_free' : '-',

        }, log_name)

    return retux

  def call_node_add(self, node, dsa, dsapub, rsa, rsapub, ssh, sshpub):

    """Add a node to the cluster.

    This is a single-node call.

    """

    return self._SingleNodeCall(node, "node_add",

                                [dsa, dsapub, rsa, rsapub, ssh, sshpub])

  def call_node_verify(self, node_list, checkdict, cluster_name):

    """Request verification of given parameters.

    This is a multi-node call.

    """

    return self._MultiNodeCall(node_list, "node_verify",

                               [checkdict, cluster_name])

  @classmethod

  def call_node_start_master(cls, node, start_daemons, no_voting):

    """Tells a node to activate itself as a master.

    This is a single-node call.

    """

    return cls._StaticSingleNodeCall(node, "node_start_master",

                                     [start_daemons, no_voting])

  @classmethod

  def call_node_stop_master(cls, node, stop_daemons):

    """Tells a node to demote itself from master status.

    This is a single-node call.

    """

    return cls._StaticSingleNodeCall(node, "node_stop_master", [stop_daemons])

  @classmethod

  def call_master_info(cls, node_list):

    """Query master info.

    This is a multi-node call.

    """

    # TODO: should this method query down nodes?

    return cls._StaticMultiNodeCall(node_list, "master_info", [])

  def call_version(self, node_list):

    """Query node version.

    This is a multi-node call.

    """

    return self._MultiNodeCall(node_list, "version", [])