Synnefo » snf-ganeti

#!/usr/bin/python

#

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

"""Block device abstraction"""

import re

import time

import errno

from ganeti import utils

from ganeti import logger

from ganeti import errors

class BlockDev(object):

  """Block device abstract class.

  A block device can be in the following states:

    - not existing on the system, and by `Create()` it goes into:

    - existing but not setup/not active, and by `Assemble()` goes into:

    - active read-write and by `Open()` it goes into

    - online (=used, or ready for use)

  A device can also be online but read-only, however we are not using

  the readonly state (MD and LV have it, if needed in the future)

  and we are usually looking at this like at a stack, so it's easier

  to conceptualise the transition from not-existing to online and back

  like a linear one.

  The many different states of the device are due to the fact that we

  need to cover many device types:

    - logical volumes are created, lvchange -a y $lv, and used

    - md arrays are created or assembled and used

    - drbd devices are attached to a local disk/remote peer and made primary

  The status of the device can be examined by `GetStatus()`, which

  returns a numerical value, depending on the position in the

  transition stack of the device.

  A block device is identified by three items:

    - the /dev path of the device (dynamic)

    - a unique ID of the device (static)

    - it's major/minor pair (dynamic)

  Not all devices implement both the first two as distinct items. LVM

  logical volumes have their unique ID (the pair volume group, logical

  volume name) in a 1-to-1 relation to the dev path. For MD devices,

  the /dev path is dynamic and the unique ID is the UUID generated at

  array creation plus the slave list. For DRBD devices, the /dev path

  is again dynamic and the unique id is the pair (host1, dev1),

  (host2, dev2).

  You can get to a device in two ways:

    - creating the (real) device, which returns you

      an attached instance (lvcreate, mdadm --create)

    - attaching of a python instance to an existing (real) device

  The second point, the attachement to a device, is different

  depending on whether the device is assembled or not. At init() time,

  we search for a device with the same unique_id as us. If found,

  good. It also means that the device is already assembled. If not,

  after assembly we'll have our correct major/minor.

  """

  STATUS_UNKNOWN = 0

  STATUS_EXISTING = 1

  STATUS_STANDBY = 2

  STATUS_ONLINE = 3

  STATUS_MAP = {

    STATUS_UNKNOWN: "unknown",

    STATUS_EXISTING: "existing",

    STATUS_STANDBY: "ready for use",

    STATUS_ONLINE: "online",

    }

  def __init__(self, unique_id, children):

    self._children = children

    self.dev_path = None

    self.unique_id = unique_id

    self.major = None

    self.minor = None

  def Assemble(self):

    """Assemble the device from its components.

    If this is a plain block device (e.g. LVM) than assemble does

    nothing, as the LVM has no children and we don't put logical

    volumes offline.

    One guarantee is that after the device has been assembled, it

    knows its major/minor numbers. This allows other devices (usually

    parents) to probe correctly for their children.

    """

    status = True

    for child in self._children:

      if not isinstance(child, BlockDev):

        raise TypeError("Invalid child passed of type '%s'" % type(child))

      if not status:

        break

      status = status and child.Assemble()

      if not status:

        break

      status = status and child.Open()

    if not status:

      for child in self._children:

        child.Shutdown()

    return status

  def Attach(self):

    """Find a device which matches our config and attach to it.

    """

    raise NotImplementedError

  def Close(self):

    """Notifies that the device will no longer be used for I/O.

    """

    raise NotImplementedError

  @classmethod

  def Create(cls, unique_id, children, size):

    """Create the device.

    If the device cannot be created, it will return None

    instead. Error messages go to the logging system.

    Note that for some devices, the unique_id is used, and for other,

    the children. The idea is that these two, taken together, are

    enough for both creation and assembly (later).

    """

    raise NotImplementedError

  def Remove(self):

    """Remove this device.

    This makes sense only for some of the device types: LV and to a

    lesser degree, md devices. Also note that if the device can't

    attach, the removal can't be completed.

    """

    raise NotImplementedError

  def GetStatus(self):

    """Return the status of the device.

    """

    raise NotImplementedError

  def Open(self, force=False):

    """Make the device ready for use.

    This makes the device ready for I/O. For now, just the DRBD

    devices need this.

    The force parameter signifies that if the device has any kind of

    --force thing, it should be used, we know what we are doing.

    """

    raise NotImplementedError

  def Shutdown(self):

    """Shut down the device, freeing its children.

    This undoes the `Assemble()` work, except for the child

    assembling; as such, the children on the device are still

    assembled after this call.

    """

    raise NotImplementedError

  def SetSyncSpeed(self, speed):

    """Adjust the sync speed of the mirror.

    In case this is not a mirroring device, this is no-op.

    """

    result = True

    if self._children:

      for child in self._children:

        result = result and child.SetSyncSpeed(speed)

    return result

  def GetSyncStatus(self):

    """Returns the sync status of the device.

    If this device is a mirroring device, this function returns the

    status of the mirror.

    Returns:

     (sync_percent, estimated_time, is_degraded)

    If sync_percent is None, it means all is ok

    If estimated_time is None, it means we can't estimate

    the time needed, otherwise it's the time left in seconds

    If is_degraded is True, it means the device is missing

    redundancy. This is usually a sign that something went wrong in

    the device setup, if sync_percent is None.

    """

    return None, None, False

  def CombinedSyncStatus(self):

    """Calculate the mirror status recursively for our children.

    The return value is the same as for `GetSyncStatus()` except the

    minimum percent and maximum time are calculated across our

    children.

    """

    min_percent, max_time, is_degraded = self.GetSyncStatus()

    if self._children:

      for child in self._children:

        c_percent, c_time, c_degraded = child.GetSyncStatus()

        if min_percent is None:

          min_percent = c_percent

        elif c_percent is not None:

          min_percent = min(min_percent, c_percent)

        if max_time is None:

          max_time = c_time

        elif c_time is not None:

          max_time = max(max_time, c_time)

        is_degraded = is_degraded or c_degraded

    return min_percent, max_time, is_degraded

  def __repr__(self):

    return ("<%s: unique_id: %s, children: %s, %s:%s, %s>" %

            (self.__class__, self.unique_id, self._children,

             self.major, self.minor, self.dev_path))

class LogicalVolume(BlockDev):

  """Logical Volume block device.

  """

  def __init__(self, unique_id, children):

    """Attaches to a LV device.

    The unique_id is a tuple (vg_name, lv_name)

    """

    super(LogicalVolume, self).__init__(unique_id, children)

    if not isinstance(unique_id, (tuple, list)) or len(unique_id) != 2:

      raise ValueError("Invalid configuration data %s" % str(unique_id))

    self._vg_name, self._lv_name = unique_id

    self.dev_path = "/dev/%s/%s" % (self._vg_name, self._lv_name)

    self.Attach()

  @classmethod

  def Create(cls, unique_id, children, size):

    """Create a new logical volume.

    """

    if not isinstance(unique_id, (tuple, list)) or len(unique_id) != 2:

      raise ValueError("Invalid configuration data %s" % str(unique_id))

    vg_name, lv_name = unique_id

    pvs_info = cls.GetPVInfo(vg_name)

    if not pvs_info:

      raise errors.BlockDeviceError, ("Can't compute PV info for vg %s" %

                                      vg_name)

    pvs_info.sort()

    pvs_info.reverse()

    free_size, pv_name = pvs_info[0]

    if free_size < size:

      raise errors.BlockDeviceError, ("Not enough free space: required %s,"

                                      " available %s" % (size, free_size))

    result = utils.RunCmd(["lvcreate", "-L%dm" % size, "-n%s" % lv_name,

                           vg_name, pv_name])

    if result.failed:

      raise errors.BlockDeviceError(result.fail_reason)

    return LogicalVolume(unique_id, children)

  @staticmethod

  def GetPVInfo(vg_name):

    """Get the free space info for PVs in a volume group.

    Args:

      vg_name: the volume group name

    Returns:

      list of (free_space, name) with free_space in mebibytes

    """

    command = ["pvs", "--noheadings", "--nosuffix", "--units=m",

               "-opv_name,vg_name,pv_free,pv_attr", "--unbuffered",

               "--separator=:"]

    result = utils.RunCmd(command)

    if result.failed:

      logger.Error("Can't get the PV information: %s" % result.fail_reason)

      return None

    data = []

    for line in result.stdout.splitlines():

      fields = line.strip().split(':')

      if len(fields) != 4:

        logger.Error("Can't parse pvs output: line '%s'" % line)

        return None

      # skip over pvs from another vg or ones which are not allocatable

      if fields[1] != vg_name or fields[3][0] != 'a':

        continue

      data.append((float(fields[2]), fields[0]))

    return data

  def Remove(self):

    """Remove this logical volume.

    """

    if not self.minor and not self.Attach():

      # the LV does not exist

      return True

    result = utils.RunCmd(["lvremove", "-f", "%s/%s" %

                           (self._vg_name, self._lv_name)])

    if result.failed:

      logger.Error("Can't lvremove: %s" % result.fail_reason)

    return not result.failed

  def Attach(self):

    """Attach to an existing LV.

    This method will try to see if an existing and active LV exists

    which matches the our name. If so, its major/minor will be

    recorded.

    """

    result = utils.RunCmd(["lvdisplay", self.dev_path])

    if result.failed:

      logger.Error("Can't find LV %s: %s" %

                   (self.dev_path, result.fail_reason))

      return False

    match = re.compile("^ *Block device *([0-9]+):([0-9]+).*$")

    for line in result.stdout.splitlines():

      match_result = match.match(line)

      if match_result:

        self.major = int(match_result.group(1))

        self.minor = int(match_result.group(2))

        return True

    return False

  def Assemble(self):

    """Assemble the device.

    This is a no-op for the LV device type. Eventually, we could

    lvchange -ay here if we see that the LV is not active.

    """

    return True

  def Shutdown(self):

    """Shutdown the device.

    This is a no-op for the LV device type, as we don't deactivate the

    volumes on shutdown.

    """

    return True

  def GetStatus(self):

    """Return the status of the device.

    Logical volumes will can be in all four states, although we don't

    deactivate (lvchange -an) them when shutdown, so STATUS_EXISTING

    should not be seen for our devices.

    """

    result = utils.RunCmd(["lvs", "--noheadings", "-olv_attr", self.dev_path])

    if result.failed:

      logger.Error("Can't display lv: %s" % result.fail_reason)

      return self.STATUS_UNKNOWN

    out = result.stdout.strip()

    # format: type/permissions/alloc/fixed_minor/state/open

    if len(out) != 6:

      return self.STATUS_UNKNOWN

    #writable = (out[1] == "w")

    active = (out[4] == "a")

    online = (out[5] == "o")

    if online:

      retval = self.STATUS_ONLINE

    elif active:

      retval = self.STATUS_STANDBY

    else:

      retval = self.STATUS_EXISTING

    return retval

  def Open(self, force=False):

    """Make the device ready for I/O.

    This is a no-op for the LV device type.

    """

    return True

  def Close(self):

    """Notifies that the device will no longer be used for I/O.

    This is a no-op for the LV device type.

    """

    return True

  def Snapshot(self, size):

    """Create a snapshot copy of an lvm block device.

    """

    snap_name = self._lv_name + ".snap"

    # remove existing snapshot if found

    snap = LogicalVolume((self._vg_name, snap_name), None)

    snap.Remove()

    pvs_info = self.GetPVInfo(self._vg_name)

    if not pvs_info:

      raise errors.BlockDeviceError, ("Can't compute PV info for vg %s" %

                                      self._vg_name)

    pvs_info.sort()

    pvs_info.reverse()

    free_size, pv_name = pvs_info[0]

    if free_size < size:

      raise errors.BlockDeviceError, ("Not enough free space: required %s,"

                                      " available %s" % (size, free_size))

    result = utils.RunCmd(["lvcreate", "-L%dm" % size, "-s",

                           "-n%s" % snap_name, self.dev_path])

    if result.failed:

      raise errors.BlockDeviceError, ("command: %s error: %s" %

                                      (result.cmd, result.fail_reason))

    return snap_name

class MDRaid1(BlockDev):

  """raid1 device implemented via md.

  """

  def __init__(self, unique_id, children):

    super(MDRaid1, self).__init__(unique_id, children)

    self.major = 9

    self.Attach()

  def Attach(self):

    """Find an array which matches our config and attach to it.

    This tries to find a MD array which has the same UUID as our own.

    """

    minor = self._FindMDByUUID(self.unique_id)

    if minor is not None:

      self._SetFromMinor(minor)

    else:

      self.minor = None

      self.dev_path = None

    return (minor is not None)

  @staticmethod

  def _GetUsedDevs():

    """Compute the list of in-use MD devices.

    It doesn't matter if the used device have other raid level, just

    that they are in use.

    """

    mdstat = open("/proc/mdstat", "r")

    data = mdstat.readlines()

    mdstat.close()

    used_md = {}

    valid_line = re.compile("^md([0-9]+) : .*$")

    for line in data:

      match = valid_line.match(line)

      if match:

        md_no = int(match.group(1))

        used_md[md_no] = line

    return used_md

  @staticmethod

  def _GetDevInfo(minor):

    """Get info about a MD device.

    Currently only uuid is returned.

    """

    result = utils.RunCmd(["mdadm", "-D", "/dev/md%d" % minor])

    if result.failed:

      logger.Error("Can't display md: %s" % result.fail_reason)

      return None

    retval = {}

    for line in result.stdout.splitlines():

      line = line.strip()

      kv = line.split(" : ", 1)

      if kv:

        if kv[0] == "UUID":

          retval["uuid"] = kv[1]

        elif kv[0] == "State":

          retval["state"] = kv[1].split(", ")

    return retval

  @staticmethod

  def _FindUnusedMinor():

    """Compute an unused MD minor.

    This code assumes that there are 256 minors only.

    """

    used_md = MDRaid1._GetUsedDevs()

    i = 0

    while i < 256:

      if i not in used_md:

        break

      i += 1

    if i == 256:

      logger.Error("Critical: Out of md minor numbers.")

      return None

    return i

  @classmethod

  def _FindMDByUUID(cls, uuid):

    """Find the minor of an MD array with a given UUID.

    """

    md_list = cls._GetUsedDevs()

    for minor in md_list:

      info = cls._GetDevInfo(minor)

      if info and info["uuid"] == uuid:

        return minor

    return None

  @classmethod

  def Create(cls, unique_id, children, size):

    """Create a new MD raid1 array.

    """

    if not isinstance(children, (tuple, list)):

      raise ValueError("Invalid setup data for MDRaid1 dev: %s" %

                       str(children))

    for i in children:

      if not isinstance(i, BlockDev):

        raise ValueError("Invalid member in MDRaid1 dev: %s" % type(i))

    for i in children:

      result = utils.RunCmd(["mdadm", "--zero-superblock", "--force",

                             i.dev_path])

      if result.failed:

        logger.Error("Can't zero superblock: %s" % result.fail_reason)

        return None

    minor = cls._FindUnusedMinor()

    result = utils.RunCmd(["mdadm", "--create", "/dev/md%d" % minor,

                           "--auto=yes", "--force", "-l1",

                           "-n%d" % len(children)] +

                          [dev.dev_path for dev in children])

    if result.failed:

      logger.Error("Can't create md: %s" % result.fail_reason)

      return None

    info = cls._GetDevInfo(minor)

    if not info or not "uuid" in info:

      logger.Error("Wrong information returned from mdadm -D: %s" % str(info))

      return None

    return MDRaid1(info["uuid"], children)

  def Remove(self):

    """Stub remove function for MD RAID 1 arrays.

    We don't remove the superblock right now. Mark a to do.

    """

    #TODO: maybe zero superblock on child devices?

    return self.Shutdown()

  def AddChild(self, device):

    """Add a new member to the md raid1.

    """

    if self.minor is None and not self.Attach():

      raise errors.BlockDeviceError, "Can't attach to device"

    if device.dev_path is None:

      raise errors.BlockDeviceError, "New child is not initialised"

    result = utils.RunCmd(["mdadm", "-a", self.dev_path, device.dev_path])

    if result.failed:

      raise errors.BlockDeviceError, ("Failed to add new device to array: %s" %

                                      result.output)

    new_len = len(self._children) + 1

    result = utils.RunCmd(["mdadm", "--grow", self.dev_path, "-n", new_len])

    if result.failed:

      raise errors.BlockDeviceError, ("Can't grow md array: %s" %

                                      result.output)

    self._children.append(device)

  def RemoveChild(self, dev_path):

    """Remove member from the md raid1.

    """

    if self.minor is None and not self.Attach():

      raise errors.BlockDeviceError, "Can't attach to device"

    if len(self._children) == 1:

      raise errors.BlockDeviceError, ("Can't reduce member when only one"

                                      " child left")

    for device in self._children:

      if device.dev_path == dev_path:

        break

    else:

      raise errors.BlockDeviceError, "Can't find child with this path"

    new_len = len(self._children) - 1

    result = utils.RunCmd(["mdadm", "-f", self.dev_path, dev_path])

    if result.failed:

      raise errors.BlockDeviceError, ("Failed to mark device as failed: %s" %

                                      result.output)

    # it seems here we need a short delay for MD to update its

    # superblocks

    time.sleep(0.5)

    result = utils.RunCmd(["mdadm", "-r", self.dev_path, dev_path])

    if result.failed:

      raise errors.BlockDeviceError, ("Failed to remove device from array:"

                                      " %s" % result.output)

    result = utils.RunCmd(["mdadm", "--grow", "--force", self.dev_path,

                           "-n", new_len])

    if result.failed:

      raise errors.BlockDeviceError, ("Can't shrink md array: %s" %

                                      result.output)

    self._children.remove(device)

  def GetStatus(self):

    """Return the status of the device.

    """

    self.Attach()

    if self.minor is None:

      retval = self.STATUS_UNKNOWN

    else:

      retval = self.STATUS_ONLINE

    return retval

  def _SetFromMinor(self, minor):

    """Set our parameters based on the given minor.

    This sets our minor variable and our dev_path.

    """

    self.minor = minor

    self.dev_path = "/dev/md%d" % minor

  def Assemble(self):

    """Assemble the MD device.

    At this point we should have:

      - list of children devices

      - uuid

    """

    result = super(MDRaid1, self).Assemble()

    if not result:

      return result

    md_list = self._GetUsedDevs()

    for minor in md_list:

      info = self._GetDevInfo(minor)

      if info and info["uuid"] == self.unique_id:

        self._SetFromMinor(minor)

        logger.Info("MD array %s already started" % str(self))

        return True

    free_minor = self._FindUnusedMinor()

    result = utils.RunCmd(["mdadm", "-A", "--auto=yes", "--uuid",

                           self.unique_id, "/dev/md%d" % free_minor] +