X-Git-Url: https://code.grnet.gr/git/ganeti-local/blobdiff_plain/96c7a5b0d68f638f8e8a7bb932512a3ce04c73ea..b76d4aaf4b54b049658cbf3dbd762431ecfcc51d:/lib/bdev.py diff --git a/lib/bdev.py b/lib/bdev.py index d2d62c8..b221235 100644 --- a/lib/bdev.py +++ b/lib/bdev.py @@ -1,7 +1,7 @@ # # -# Copyright (C) 2006, 2007 Google Inc. +# Copyright (C) 2006, 2007, 2010, 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 @@ -24,14 +24,24 @@ import re import time import errno +import shlex +import stat import pyparsing as pyp import os import logging +import math from ganeti import utils from ganeti import errors from ganeti import constants from ganeti import objects +from ganeti import compat +from ganeti import netutils +from ganeti import pathutils + + +# Size of reads in _CanReadDevice +_DEVICE_READ_SIZE = 128 * 1024 def _IgnoreError(fn, *args, **kwargs): @@ -48,7 +58,7 @@ def _IgnoreError(fn, *args, **kwargs): fn(*args, **kwargs) return True except errors.BlockDeviceError, err: - logging.warning("Caught BlockDeviceError but ignoring: %s" % str(err)) + logging.warning("Caught BlockDeviceError but ignoring: %s", str(err)) return False @@ -66,6 +76,141 @@ def _ThrowError(msg, *args): raise errors.BlockDeviceError(msg) +def _CheckResult(result): + """Throws an error if the given result is a failed one. + + @param result: result from RunCmd + + """ + if result.failed: + _ThrowError("Command: %s error: %s - %s", result.cmd, result.fail_reason, + result.output) + + +def _CanReadDevice(path): + """Check if we can read from the given device. + + This tries to read the first 128k of the device. + + """ + try: + utils.ReadFile(path, size=_DEVICE_READ_SIZE) + return True + except EnvironmentError: + logging.warning("Can't read from device %s", path, exc_info=True) + return False + + +def _GetForbiddenFileStoragePaths(): + """Builds a list of path prefixes which shouldn't be used for file storage. + + @rtype: frozenset + + """ + paths = set([ + "/boot", + "/dev", + "/etc", + "/home", + "/proc", + "/root", + "/sys", + ]) + + for prefix in ["", "/usr", "/usr/local"]: + paths.update(map(lambda s: "%s/%s" % (prefix, s), + ["bin", "lib", "lib32", "lib64", "sbin"])) + + return compat.UniqueFrozenset(map(os.path.normpath, paths)) + + +def _ComputeWrongFileStoragePaths(paths, + _forbidden=_GetForbiddenFileStoragePaths()): + """Cross-checks a list of paths for prefixes considered bad. + + Some paths, e.g. "/bin", should not be used for file storage. + + @type paths: list + @param paths: List of paths to be checked + @rtype: list + @return: Sorted list of paths for which the user should be warned + + """ + def _Check(path): + return (not os.path.isabs(path) or + path in _forbidden or + filter(lambda p: utils.IsBelowDir(p, path), _forbidden)) + + return utils.NiceSort(filter(_Check, map(os.path.normpath, paths))) + + +def ComputeWrongFileStoragePaths(_filename=pathutils.FILE_STORAGE_PATHS_FILE): + """Returns a list of file storage paths whose prefix is considered bad. + + See L{_ComputeWrongFileStoragePaths}. + + """ + return _ComputeWrongFileStoragePaths(_LoadAllowedFileStoragePaths(_filename)) + + +def _CheckFileStoragePath(path, allowed): + """Checks if a path is in a list of allowed paths for file storage. + + @type path: string + @param path: Path to check + @type allowed: list + @param allowed: List of allowed paths + @raise errors.FileStoragePathError: If the path is not allowed + + """ + if not os.path.isabs(path): + raise errors.FileStoragePathError("File storage path must be absolute," + " got '%s'" % path) + + for i in allowed: + if not os.path.isabs(i): + logging.info("Ignoring relative path '%s' for file storage", i) + continue + + if utils.IsBelowDir(i, path): + break + else: + raise errors.FileStoragePathError("Path '%s' is not acceptable for file" + " storage" % path) + + +def _LoadAllowedFileStoragePaths(filename): + """Loads file containing allowed file storage paths. + + @rtype: list + @return: List of allowed paths (can be an empty list) + + """ + try: + contents = utils.ReadFile(filename) + except EnvironmentError: + return [] + else: + return utils.FilterEmptyLinesAndComments(contents) + + +def CheckFileStoragePath(path, _filename=pathutils.FILE_STORAGE_PATHS_FILE): + """Checks if a path is allowed for file storage. + + @type path: string + @param path: Path to check + @raise errors.FileStoragePathError: If the path is not allowed + + """ + allowed = _LoadAllowedFileStoragePaths(_filename) + + if _ComputeWrongFileStoragePaths([path]): + raise errors.FileStoragePathError("Path '%s' uses a forbidden prefix" % + path) + + _CheckFileStoragePath(path, allowed) + + class BlockDev(object): """Block device abstract class. @@ -109,7 +254,7 @@ class BlockDev(object): after assembly we'll have our correct major/minor. """ - def __init__(self, unique_id, children, size): + def __init__(self, unique_id, children, size, params): self._children = children self.dev_path = None self.unique_id = unique_id @@ -117,6 +262,7 @@ class BlockDev(object): self.minor = None self.attached = False self.size = size + self.params = params def Assemble(self): """Assemble the device from its components. @@ -145,7 +291,7 @@ class BlockDev(object): raise NotImplementedError @classmethod - def Create(cls, unique_id, children, size): + def Create(cls, unique_id, children, size, params, excl_stor): """Create the device. If the device cannot be created, it will return None @@ -198,16 +344,36 @@ class BlockDev(object): """ raise NotImplementedError - def SetSyncSpeed(self, speed): - """Adjust the sync speed of the mirror. + def SetSyncParams(self, params): + """Adjust the synchronization parameters of the mirror. + + In case this is not a mirroring device, this is no-op. + + @param params: dictionary of LD level disk parameters related to the + synchronization. + @rtype: list + @return: a list of error messages, emitted both by the current node and by + children. An empty list means no errors. + + """ + result = [] + if self._children: + for child in self._children: + result.extend(child.SetSyncParams(params)) + return result + + def PauseResumeSync(self, pause): + """Pause/Resume the sync of the mirror. In case this is not a mirroring device, this is no-op. + @param pause: Whether to pause or resume + """ result = True if self._children: for child in self._children: - result = result and child.SetSyncSpeed(speed) + result = result and child.PauseResumeSync(pause) return result def GetSyncStatus(self): @@ -286,7 +452,6 @@ class BlockDev(object): is_degraded=is_degraded, ldisk_status=ldisk_status) - def SetInfo(self, text): """Update metadata with info text. @@ -296,10 +461,17 @@ class BlockDev(object): for child in self._children: child.SetInfo(text) - def Grow(self, amount): + def Grow(self, amount, dryrun, backingstore): """Grow the block device. + @type amount: integer @param amount: the amount (in mebibytes) to grow with + @type dryrun: boolean + @param dryrun: whether to execute the operation in simulation mode + only, without actually increasing the size + @param backingstore: whether to execute the operation on backing storage + only, or on "logical" storage only; e.g. DRBD is logical storage, + whereas LVM, file, RBD are backing storage """ raise NotImplementedError @@ -331,23 +503,66 @@ class LogicalVolume(BlockDev): """Logical Volume block device. """ - def __init__(self, unique_id, children, size): + _VALID_NAME_RE = re.compile("^[a-zA-Z0-9+_.-]*$") + _INVALID_NAMES = compat.UniqueFrozenset([".", "..", "snapshot", "pvmove"]) + _INVALID_SUBSTRINGS = compat.UniqueFrozenset(["_mlog", "_mimage"]) + + def __init__(self, unique_id, children, size, params): """Attaches to a LV device. The unique_id is a tuple (vg_name, lv_name) """ - super(LogicalVolume, self).__init__(unique_id, children, size) + super(LogicalVolume, self).__init__(unique_id, children, size, params) 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._ValidateName(self._vg_name) + self._ValidateName(self._lv_name) + self.dev_path = utils.PathJoin("/dev", self._vg_name, self._lv_name) self._degraded = True self.major = self.minor = self.pe_size = self.stripe_count = None self.Attach() + @staticmethod + def _GetStdPvSize(pvs_info): + """Return the the standard PV size (used with exclusive storage). + + @param pvs_info: list of objects.LvmPvInfo, cannot be empty + @rtype: float + @return: size in MiB + + """ + assert len(pvs_info) > 0 + smallest = min([pv.size for pv in pvs_info]) + return smallest / (1 + constants.PART_MARGIN + constants.PART_RESERVED) + + @staticmethod + def _ComputeNumPvs(size, pvs_info): + """Compute the number of PVs needed for an LV (with exclusive storage). + + @type size: float + @param size: LV size in MiB + @param pvs_info: list of objects.LvmPvInfo, cannot be empty + @rtype: integer + @return: number of PVs needed + """ + assert len(pvs_info) > 0 + pv_size = float(LogicalVolume._GetStdPvSize(pvs_info)) + return int(math.ceil(float(size) / pv_size)) + + @staticmethod + def _GetEmptyPvNames(pvs_info, max_pvs=None): + """Return a list of empty PVs, by name. + + """ + empty_pvs = filter(objects.LvmPvInfo.IsEmpty, pvs_info) + if max_pvs is not None: + empty_pvs = empty_pvs[:max_pvs] + return map((lambda pv: pv.name), empty_pvs) + @classmethod - def Create(cls, unique_id, children, size): + def Create(cls, unique_id, children, size, params, excl_stor): """Create a new logical volume. """ @@ -355,30 +570,59 @@ class LogicalVolume(BlockDev): raise errors.ProgrammerError("Invalid configuration data %s" % str(unique_id)) vg_name, lv_name = unique_id - pvs_info = cls.GetPVInfo(vg_name) + cls._ValidateName(vg_name) + cls._ValidateName(lv_name) + pvs_info = cls.GetPVInfo([vg_name]) if not pvs_info: - _ThrowError("Can't compute PV info for vg %s", vg_name) - pvs_info.sort() - pvs_info.reverse() - - pvlist = [ pv[1] for pv in pvs_info ] - if utils.any(pvlist, lambda v: ":" in v): - _ThrowError("Some of your PVs have invalid character ':'" - " in their name") - free_size = sum([ pv[0] for pv in pvs_info ]) + if excl_stor: + msg = "No (empty) PVs found" + else: + msg = "Can't compute PV info for vg %s" % vg_name + _ThrowError(msg) + pvs_info.sort(key=(lambda pv: pv.free), reverse=True) + + pvlist = [pv.name for pv in pvs_info] + if compat.any(":" in v for v in pvlist): + _ThrowError("Some of your PVs have the invalid character ':' in their" + " name, this is not supported - please filter them out" + " in lvm.conf using either 'filter' or 'preferred_names'") + current_pvs = len(pvlist) - stripes = min(current_pvs, constants.LVM_STRIPECOUNT) + desired_stripes = params[constants.LDP_STRIPES] + stripes = min(current_pvs, desired_stripes) + + if excl_stor: + (err_msgs, _) = utils.LvmExclusiveCheckNodePvs(pvs_info) + if err_msgs: + for m in err_msgs: + logging.warning(m) + req_pvs = cls._ComputeNumPvs(size, pvs_info) + pvlist = cls._GetEmptyPvNames(pvs_info, req_pvs) + current_pvs = len(pvlist) + if current_pvs < req_pvs: + _ThrowError("Not enough empty PVs to create a disk of %d MB:" + " %d available, %d needed", size, current_pvs, req_pvs) + assert current_pvs == len(pvlist) + if stripes > current_pvs: + # No warning issued for this, as it's no surprise + stripes = current_pvs + + else: + if stripes < desired_stripes: + logging.warning("Could not use %d stripes for VG %s, as only %d PVs are" + " available.", desired_stripes, vg_name, current_pvs) + free_size = sum([pv.free for pv in pvs_info]) + # The size constraint should have been checked from the master before + # calling the create function. + if free_size < size: + _ThrowError("Not enough free space: required %s," + " available %s", size, free_size) - # The size constraint should have been checked from the master before - # calling the create function. - if free_size < size: - _ThrowError("Not enough free space: required %s," - " available %s", size, free_size) - cmd = ["lvcreate", "-L%dm" % size, "-n%s" % lv_name] # If the free space is not well distributed, we won't be able to # create an optimally-striped volume; in that case, we want to try # with N, N-1, ..., 2, and finally 1 (non-stripped) number of # stripes + cmd = ["lvcreate", "-L%dm" % size, "-n%s" % lv_name] for stripes_arg in range(stripes, 0, -1): result = utils.RunCmd(cmd + ["-i%d" % stripes_arg] + [vg_name] + pvlist) if not result.failed: @@ -386,40 +630,165 @@ class LogicalVolume(BlockDev): if result.failed: _ThrowError("LV create failed (%s): %s", result.fail_reason, result.output) - return LogicalVolume(unique_id, children, size) + return LogicalVolume(unique_id, children, size, params) @staticmethod - def GetPVInfo(vg_name): + def _GetVolumeInfo(lvm_cmd, fields): + """Returns LVM Volumen infos using lvm_cmd + + @param lvm_cmd: Should be one of "pvs", "vgs" or "lvs" + @param fields: Fields to return + @return: A list of dicts each with the parsed fields + + """ + if not fields: + raise errors.ProgrammerError("No fields specified") + + sep = "|" + cmd = [lvm_cmd, "--noheadings", "--nosuffix", "--units=m", "--unbuffered", + "--separator=%s" % sep, "-o%s" % ",".join(fields)] + + result = utils.RunCmd(cmd) + if result.failed: + raise errors.CommandError("Can't get the volume information: %s - %s" % + (result.fail_reason, result.output)) + + data = [] + for line in result.stdout.splitlines(): + splitted_fields = line.strip().split(sep) + + if len(fields) != len(splitted_fields): + raise errors.CommandError("Can't parse %s output: line '%s'" % + (lvm_cmd, line)) + + data.append(splitted_fields) + + return data + + @classmethod + def GetPVInfo(cls, vg_names, filter_allocatable=True, include_lvs=False): """Get the free space info for PVs in a volume group. - @param vg_name: the volume group name + @param vg_names: list of volume group names, if empty all will be returned + @param filter_allocatable: whether to skip over unallocatable PVs + @param include_lvs: whether to include a list of LVs hosted on each PV @rtype: list - @return: list of tuples (free_space, name) with free_space in mebibytes + @return: list of objects.LvmPvInfo objects """ - sep = "|" - command = ["pvs", "--noheadings", "--nosuffix", "--units=m", - "-opv_name,vg_name,pv_free,pv_attr", "--unbuffered", - "--separator=%s" % sep ] - result = utils.RunCmd(command) - if result.failed: - logging.error("Can't get the PV information: %s - %s", - result.fail_reason, result.output) + # We request "lv_name" field only if we care about LVs, so we don't get + # a long list of entries with many duplicates unless we really have to. + # The duplicate "pv_name" field will be ignored. + if include_lvs: + lvfield = "lv_name" + else: + lvfield = "pv_name" + try: + info = cls._GetVolumeInfo("pvs", ["pv_name", "vg_name", "pv_free", + "pv_attr", "pv_size", lvfield]) + except errors.GenericError, err: + logging.error("Can't get PV information: %s", err) return None + + # When asked for LVs, "pvs" may return multiple entries for the same PV-LV + # pair. We sort entries by PV name and then LV name, so it's easy to weed + # out duplicates. + if include_lvs: + info.sort(key=(lambda i: (i[0], i[5]))) data = [] - for line in result.stdout.splitlines(): - fields = line.strip().split(sep) - if len(fields) != 4: - logging.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': + lastpvi = None + for (pv_name, vg_name, pv_free, pv_attr, pv_size, lv_name) in info: + # (possibly) skip over pvs which are not allocatable + if filter_allocatable and pv_attr[0] != "a": + continue + # (possibly) skip over pvs which are not in the right volume group(s) + if vg_names and vg_name not in vg_names: + continue + # Beware of duplicates (check before inserting) + if lastpvi and lastpvi.name == pv_name: + if include_lvs and lv_name: + if not lastpvi.lv_list or lastpvi.lv_list[-1] != lv_name: + lastpvi.lv_list.append(lv_name) + else: + if include_lvs and lv_name: + lvl = [lv_name] + else: + lvl = [] + lastpvi = objects.LvmPvInfo(name=pv_name, vg_name=vg_name, + size=float(pv_size), free=float(pv_free), + attributes=pv_attr, lv_list=lvl) + data.append(lastpvi) + + return data + + @classmethod + def _GetExclusiveStorageVgFree(cls, vg_name): + """Return the free disk space in the given VG, in exclusive storage mode. + + @type vg_name: string + @param vg_name: VG name + @rtype: float + @return: free space in MiB + """ + pvs_info = cls.GetPVInfo([vg_name]) + if not pvs_info: + return 0.0 + pv_size = cls._GetStdPvSize(pvs_info) + num_pvs = len(cls._GetEmptyPvNames(pvs_info)) + return pv_size * num_pvs + + @classmethod + def GetVGInfo(cls, vg_names, excl_stor, filter_readonly=True): + """Get the free space info for specific VGs. + + @param vg_names: list of volume group names, if empty all will be returned + @param excl_stor: whether exclusive_storage is enabled + @param filter_readonly: whether to skip over readonly VGs + + @rtype: list + @return: list of tuples (free_space, total_size, name) with free_space in + MiB + + """ + try: + info = cls._GetVolumeInfo("vgs", ["vg_name", "vg_free", "vg_attr", + "vg_size"]) + except errors.GenericError, err: + logging.error("Can't get VG information: %s", err) + return None + + data = [] + for vg_name, vg_free, vg_attr, vg_size in info: + # (possibly) skip over vgs which are not writable + if filter_readonly and vg_attr[0] == "r": + continue + # (possibly) skip over vgs which are not in the right volume group(s) + if vg_names and vg_name not in vg_names: continue - data.append((float(fields[2]), fields[0])) + # Exclusive storage needs a different concept of free space + if excl_stor: + es_free = cls._GetExclusiveStorageVgFree(vg_name) + assert es_free <= vg_free + vg_free = es_free + data.append((float(vg_free), float(vg_size), vg_name)) return data + @classmethod + def _ValidateName(cls, name): + """Validates that a given name is valid as VG or LV name. + + The list of valid characters and restricted names is taken out of + the lvm(8) manpage, with the simplification that we enforce both + VG and LV restrictions on the names. + + """ + if (not cls._VALID_NAME_RE.match(name) or + name in cls._INVALID_NAMES or + compat.any(substring in name for substring in cls._INVALID_SUBSTRINGS)): + _ThrowError("Invalid LVM name '%s'", name) + def Remove(self): """Remove this logical volume. @@ -447,7 +816,7 @@ class LogicalVolume(BlockDev): if result.failed: _ThrowError("Failed to rename the logical volume: %s", result.output) self._lv_name = new_name - self.dev_path = "/dev/%s/%s" % (self._vg_name, self._lv_name) + self.dev_path = utils.PathJoin("/dev", self._vg_name, self._lv_name) def Attach(self): """Attach to an existing LV. @@ -476,21 +845,21 @@ class LogicalVolume(BlockDev): # one line for any non-empty string logging.error("Can't parse LVS output, no lines? Got '%s'", str(out)) return False - out = out[-1].strip().rstrip(',') + out = out[-1].strip().rstrip(",") out = out.split(",") if len(out) != 5: logging.error("Can't parse LVS output, len(%s) != 5", str(out)) return False status, major, minor, pe_size, stripes = out - if len(status) != 6: - logging.error("lvs lv_attr is not 6 characters (%s)", status) + if len(status) < 6: + logging.error("lvs lv_attr is not at least 6 characters (%s)", status) return False try: major = int(major) minor = int(minor) - except ValueError, err: + except (TypeError, ValueError), err: logging.error("lvs major/minor cannot be parsed: %s", str(err)) try: @@ -509,7 +878,7 @@ class LogicalVolume(BlockDev): self.minor = minor self.pe_size = pe_size self.stripe_count = stripes - self._degraded = status[0] == 'v' # virtual volume, i.e. doesn't backing + self._degraded = status[0] == "v" # virtual volume, i.e. doesn't backing # storage self.attached = True return True @@ -589,30 +958,41 @@ class LogicalVolume(BlockDev): def Snapshot(self, size): """Create a snapshot copy of an lvm block device. + @returns: tuple (vg, lv) + """ snap_name = self._lv_name + ".snap" # remove existing snapshot if found - snap = LogicalVolume((self._vg_name, snap_name), None, size) + snap = LogicalVolume((self._vg_name, snap_name), None, size, self.params) _IgnoreError(snap.Remove) - pvs_info = self.GetPVInfo(self._vg_name) - if not pvs_info: - _ThrowError("Can't compute PV info for vg %s", self._vg_name) - pvs_info.sort() - pvs_info.reverse() - free_size, pv_name = pvs_info[0] + vg_info = self.GetVGInfo([self._vg_name], False) + if not vg_info: + _ThrowError("Can't compute VG info for vg %s", self._vg_name) + free_size, _, _ = vg_info[0] if free_size < size: _ThrowError("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: - _ThrowError("command: %s error: %s - %s", - result.cmd, result.fail_reason, result.output) + _CheckResult(utils.RunCmd(["lvcreate", "-L%dm" % size, "-s", + "-n%s" % snap_name, self.dev_path])) + + return (self._vg_name, snap_name) + + def _RemoveOldInfo(self): + """Try to remove old tags from the lv. + + """ + result = utils.RunCmd(["lvs", "-o", "tags", "--noheadings", "--nosuffix", + self.dev_path]) + _CheckResult(result) - return snap_name + raw_tags = result.stdout.strip() + if raw_tags: + for tag in raw_tags.split(","): + _CheckResult(utils.RunCmd(["lvchange", "--deltag", + tag.strip(), self.dev_path])) def SetInfo(self, text): """Update metadata with info text. @@ -620,23 +1000,23 @@ class LogicalVolume(BlockDev): """ BlockDev.SetInfo(self, text) + self._RemoveOldInfo() + # Replace invalid characters - text = re.sub('^[^A-Za-z0-9_+.]', '_', text) - text = re.sub('[^-A-Za-z0-9_+.]', '_', text) + text = re.sub("^[^A-Za-z0-9_+.]", "_", text) + text = re.sub("[^-A-Za-z0-9_+.]", "_", text) # Only up to 128 characters are allowed text = text[:128] - result = utils.RunCmd(["lvchange", "--addtag", text, - self.dev_path]) - if result.failed: - _ThrowError("Command: %s error: %s - %s", result.cmd, result.fail_reason, - result.output) + _CheckResult(utils.RunCmd(["lvchange", "--addtag", text, self.dev_path])) - def Grow(self, amount): + def Grow(self, amount, dryrun, backingstore): """Grow the logical volume. """ + if not backingstore: + return if self.pe_size is None or self.stripe_count is None: if not self.Attach(): _ThrowError("Can't attach to LV during Grow()") @@ -644,13 +1024,15 @@ class LogicalVolume(BlockDev): rest = amount % full_stripe_size if rest != 0: amount += full_stripe_size - rest + cmd = ["lvextend", "-L", "+%dm" % amount] + if dryrun: + cmd.append("--test") # we try multiple algorithms since the 'best' ones might not have # space available in the right place, but later ones might (since # they have less constraints); also note that only recent LVM # supports 'cling' for alloc_policy in "contiguous", "cling", "normal": - result = utils.RunCmd(["lvextend", "--alloc", alloc_policy, - "-L", "+%dm" % amount, self.dev_path]) + result = utils.RunCmd(cmd + ["--alloc", alloc_policy, self.dev_path]) if not result.failed: return _ThrowError("Can't grow LV %s: %s", self.dev_path, result.output) @@ -666,7 +1048,10 @@ class DRBD8Status(object): LINE_RE = re.compile(r"\s*[0-9]+:\s*cs:(\S+)\s+(?:st|ro):([^/]+)/(\S+)" "\s+ds:([^/]+)/(\S+)\s+.*$") SYNC_RE = re.compile(r"^.*\ssync'ed:\s*([0-9.]+)%.*" - "\sfinish: ([0-9]+):([0-9]+):([0-9]+)\s.*$") + # Due to a bug in drbd in the kernel, introduced in + # commit 4b0715f096 (still unfixed as of 2011-08-22) + "(?:\s|M)" + "finish: ([0-9]+):([0-9]+):([0-9]+)\s.*$") CS_UNCONFIGURED = "Unconfigured" CS_STANDALONE = "StandAlone" @@ -682,7 +1067,7 @@ class DRBD8Status(object): CS_SYNCTARGET = "SyncTarget" CS_PAUSEDSYNCS = "PausedSyncS" CS_PAUSEDSYNCT = "PausedSyncT" - CSET_SYNC = frozenset([ + CSET_SYNC = compat.UniqueFrozenset([ CS_WFREPORTPARAMS, CS_STARTINGSYNCS, CS_STARTINGSYNCT, @@ -761,22 +1146,25 @@ class DRBD8Status(object): self.est_time = None -class BaseDRBD(BlockDev): +class BaseDRBD(BlockDev): # pylint: disable=W0223 """Base DRBD class. This class contains a few bits of common functionality between the 0.7 and 8.x versions of DRBD. """ - _VERSION_RE = re.compile(r"^version: (\d+)\.(\d+)\.(\d+)" + _VERSION_RE = re.compile(r"^version: (\d+)\.(\d+)\.(\d+)(?:\.\d+)?" r" \(api:(\d+)/proto:(\d+)(?:-(\d+))?\)") + _VALID_LINE_RE = re.compile("^ *([0-9]+): cs:([^ ]+).*$") + _UNUSED_LINE_RE = re.compile("^ *([0-9]+): cs:Unconfigured$") _DRBD_MAJOR = 147 _ST_UNCONFIGURED = "Unconfigured" _ST_WFCONNECTION = "WFConnection" _ST_CONNECTED = "Connected" - _STATUS_FILE = "/proc/drbd" + _STATUS_FILE = constants.DRBD_STATUS_FILE + _USERMODE_HELPER_FILE = "/sys/module/drbd/parameters/usermode_helper" @staticmethod def _GetProcData(filename=_STATUS_FILE): @@ -795,21 +1183,20 @@ class BaseDRBD(BlockDev): _ThrowError("Can't read any data from %s", filename) return data - @staticmethod - def _MassageProcData(data): + @classmethod + def _MassageProcData(cls, data): """Transform the output of _GetProdData into a nicer form. @return: a dictionary of minor: joined lines from /proc/drbd for that minor """ - lmatch = re.compile("^ *([0-9]+):.*$") results = {} old_minor = old_line = None for line in data: if not line: # completely empty lines, as can be returned by drbd8.0+ continue - lresult = lmatch.match(line) + lresult = cls._VALID_LINE_RE.match(line) if lresult is not None: if old_minor is not None: results[old_minor] = old_line @@ -824,7 +1211,7 @@ class BaseDRBD(BlockDev): return results @classmethod - def _GetVersion(cls): + def _GetVersion(cls, proc_data): """Return the DRBD version. This will return a dict with keys: @@ -836,7 +1223,6 @@ class BaseDRBD(BlockDev): - proto2 (only on drbd > 8.2.X) """ - proc_data = cls._GetProcData() first_line = proc_data[0].strip() version = cls._VERSION_RE.match(first_line) if not version: @@ -844,18 +1230,36 @@ class BaseDRBD(BlockDev): first_line) values = version.groups() - retval = {'k_major': int(values[0]), - 'k_minor': int(values[1]), - 'k_point': int(values[2]), - 'api': int(values[3]), - 'proto': int(values[4]), - } + retval = { + "k_major": int(values[0]), + "k_minor": int(values[1]), + "k_point": int(values[2]), + "api": int(values[3]), + "proto": int(values[4]), + } if values[5] is not None: - retval['proto2'] = values[5] + retval["proto2"] = values[5] return retval @staticmethod + def GetUsermodeHelper(filename=_USERMODE_HELPER_FILE): + """Returns DRBD usermode_helper currently set. + + """ + try: + helper = utils.ReadFile(filename).splitlines()[0] + except EnvironmentError, err: + if err.errno == errno.ENOENT: + _ThrowError("The file %s cannot be opened, check if the module" + " is loaded (%s)", filename, str(err)) + else: + _ThrowError("Can't read DRBD helper file %s: %s", filename, str(err)) + if not helper: + _ThrowError("Can't read any data from %s", filename) + return helper + + @staticmethod def _DevPath(minor): """Return the path to a drbd device for a given minor. @@ -870,9 +1274,8 @@ class BaseDRBD(BlockDev): data = cls._GetProcData() used_devs = {} - valid_line = re.compile("^ *([0-9]+): cs:([^ ]+).*$") for line in data: - match = valid_line.match(line) + match = cls._VALID_LINE_RE.match(line) if not match: continue minor = int(match.group(1)) @@ -901,7 +1304,7 @@ class BaseDRBD(BlockDev): def _CheckMetaSize(meta_device): """Check if the given meta device looks like a valid one. - This currently only check the size, which must be around + This currently only checks the size, which must be around 128MiB. """ @@ -911,19 +1314,19 @@ class BaseDRBD(BlockDev): result.fail_reason, result.output) try: sectors = int(result.stdout) - except ValueError: + except (TypeError, ValueError): _ThrowError("Invalid output from blockdev: '%s'", result.stdout) - bytes = sectors * 512 - if bytes < 128 * 1024 * 1024: # less than 128MiB - _ThrowError("Meta device too small (%.2fMib)", (bytes / 1024 / 1024)) + num_bytes = sectors * 512 + if num_bytes < 128 * 1024 * 1024: # less than 128MiB + _ThrowError("Meta device too small (%.2fMib)", (num_bytes / 1024 / 1024)) # the maximum *valid* size of the meta device when living on top # of LVM is hard to compute: it depends on the number of stripes # and the PE size; e.g. a 2-stripe, 64MB PE will result in a 128MB # (normal size), but an eight-stripe 128MB PE will result in a 1GB # size meta device; as such, we restrict it to 1GB (a little bit # too generous, but making assumptions about PE size is hard) - if bytes > 1024 * 1024 * 1024: - _ThrowError("Meta device too big (%.2fMiB)", (bytes / 1024 / 1024)) + if num_bytes > 1024 * 1024 * 1024: + _ThrowError("Meta device too big (%.2fMiB)", (num_bytes / 1024 / 1024)) def Rename(self, new_id): """Rename a device. @@ -941,10 +1344,10 @@ class DRBD8(BaseDRBD): doesn't do anything to the supposed peer. If you need a fully connected DRBD pair, you need to use this class on both hosts. - The unique_id for the drbd device is the (local_ip, local_port, - remote_ip, remote_port) tuple, and it must have two children: the - data device and the meta_device. The meta device is checked for - valid size and is zeroed on create. + The unique_id for the drbd device is a (local_ip, local_port, + remote_ip, remote_port, local_minor, secret) tuple, and it must have + two children: the data device and the meta_device. The meta device + is checked for valid size and is zeroed on create. """ _MAX_MINORS = 255 @@ -953,17 +1356,15 @@ class DRBD8(BaseDRBD): # timeout constants _NET_RECONFIG_TIMEOUT = 60 - def __init__(self, unique_id, children, size): + # command line options for barriers + _DISABLE_DISK_OPTION = "--no-disk-barrier" # -a + _DISABLE_DRAIN_OPTION = "--no-disk-drain" # -D + _DISABLE_FLUSH_OPTION = "--no-disk-flushes" # -i + _DISABLE_META_FLUSH_OPTION = "--no-md-flushes" # -m + + def __init__(self, unique_id, children, size, params): if children and children.count(None) > 0: children = [] - super(DRBD8, self).__init__(unique_id, children, size) - self.major = self._DRBD_MAJOR - version = self._GetVersion() - if version['k_major'] != 8 : - _ThrowError("Mismatch in DRBD kernel version and requested ganeti" - " usage: kernel is %s.%s, ganeti wants 8.x", - version['k_major'], version['k_minor']) - if len(children) not in (0, 2): raise ValueError("Invalid configuration data %s" % str(children)) if not isinstance(unique_id, (tuple, list)) or len(unique_id) != 6: @@ -971,6 +1372,18 @@ class DRBD8(BaseDRBD): (self._lhost, self._lport, self._rhost, self._rport, self._aminor, self._secret) = unique_id + if children: + if not _CanReadDevice(children[1].dev_path): + logging.info("drbd%s: Ignoring unreadable meta device", self._aminor) + children = [] + super(DRBD8, self).__init__(unique_id, children, size, params) + self.major = self._DRBD_MAJOR + version = self._GetVersion(self._GetProcData()) + if version["k_major"] != 8: + _ThrowError("Mismatch in DRBD kernel version and requested ganeti" + " usage: kernel is %s.%s, ganeti wants 8.x", + version["k_major"], version["k_minor"]) + if (self._lhost is not None and self._lhost == self._rhost and self._lport == self._rport): raise ValueError("Invalid configuration data, same local/remote %s" % @@ -984,6 +1397,17 @@ class DRBD8(BaseDRBD): This will not work if the given minor is in use. """ + # Zero the metadata first, in order to make sure drbdmeta doesn't + # try to auto-detect existing filesystems or similar (see + # http://code.google.com/p/ganeti/issues/detail?id=182); we only + # care about the first 128MB of data in the device, even though it + # can be bigger + result = utils.RunCmd([constants.DD_CMD, + "if=/dev/zero", "of=%s" % dev_path, + "bs=1048576", "count=128", "oflag=direct"]) + if result.failed: + _ThrowError("Can't wipe the meta device: %s", result.output) + result = utils.RunCmd(["drbdmeta", "--force", cls._DevPath(minor), "v08", dev_path, "0", "create-md"]) if result.failed: @@ -999,14 +1423,12 @@ class DRBD8(BaseDRBD): """ data = cls._GetProcData() - unused_line = re.compile("^ *([0-9]+): cs:Unconfigured$") - used_line = re.compile("^ *([0-9]+): cs:") highest = None for line in data: - match = unused_line.match(line) + match = cls._UNUSED_LINE_RE.match(line) if match: return int(match.group(1)) - match = used_line.match(line) + match = cls._VALID_LINE_RE.match(line) if match: minor = int(match.group(1)) highest = max(highest, minor) @@ -1021,7 +1443,7 @@ class DRBD8(BaseDRBD): def _GetShowParser(cls): """Return a parser for `drbd show` output. - This will either create or return an already-create parser for the + This will either create or return an already-created parser for the output of the command `drbd show`. """ @@ -1031,38 +1453,41 @@ class DRBD8(BaseDRBD): # pyparsing setup lbrace = pyp.Literal("{").suppress() rbrace = pyp.Literal("}").suppress() + lbracket = pyp.Literal("[").suppress() + rbracket = pyp.Literal("]").suppress() semi = pyp.Literal(";").suppress() + colon = pyp.Literal(":").suppress() # this also converts the value to an int number = pyp.Word(pyp.nums).setParseAction(lambda s, l, t: int(t[0])) - comment = pyp.Literal ("#") + pyp.Optional(pyp.restOfLine) + comment = pyp.Literal("#") + pyp.Optional(pyp.restOfLine) defa = pyp.Literal("_is_default").suppress() dbl_quote = pyp.Literal('"').suppress() - keyword = pyp.Word(pyp.alphanums + '-') + keyword = pyp.Word(pyp.alphanums + "-") # value types - value = pyp.Word(pyp.alphanums + '_-/.:') + value = pyp.Word(pyp.alphanums + "_-/.:") quoted = dbl_quote + pyp.CharsNotIn('"') + dbl_quote - addr_type = (pyp.Optional(pyp.Literal("ipv4")).suppress() + - pyp.Optional(pyp.Literal("ipv6")).suppress()) - addr_port = (addr_type + pyp.Word(pyp.nums + '.') + - pyp.Literal(':').suppress() + number) + ipv4_addr = (pyp.Optional(pyp.Literal("ipv4")).suppress() + + pyp.Word(pyp.nums + ".") + colon + number) + ipv6_addr = (pyp.Optional(pyp.Literal("ipv6")).suppress() + + pyp.Optional(lbracket) + pyp.Word(pyp.hexnums + ":") + + pyp.Optional(rbracket) + colon + number) # meta device, extended syntax - meta_value = ((value ^ quoted) + pyp.Literal('[').suppress() + - number + pyp.Word(']').suppress()) + meta_value = ((value ^ quoted) + lbracket + number + rbracket) # device name, extended syntax device_value = pyp.Literal("minor").suppress() + number # a statement stmt = (~rbrace + keyword + ~lbrace + - pyp.Optional(addr_port ^ value ^ quoted ^ meta_value ^ + pyp.Optional(ipv4_addr ^ ipv6_addr ^ value ^ quoted ^ meta_value ^ device_value) + pyp.Optional(defa) + semi + pyp.Optional(pyp.restOfLine).suppress()) # an entire section - section_name = pyp.Word(pyp.alphas + '_') + section_name = pyp.Word(pyp.alphas + "_") section = section_name + lbrace + pyp.ZeroOrMore(pyp.Group(stmt)) + rbrace bnf = pyp.ZeroOrMore(pyp.Group(section ^ stmt)) @@ -1178,23 +1603,110 @@ class DRBD8(BaseDRBD): info["remote_addr"] == (self._rhost, self._rport)) return retval - @classmethod - def _AssembleLocal(cls, minor, backend, meta, size): + def _AssembleLocal(self, minor, backend, meta, size): """Configure the local part of a DRBD device. """ - args = ["drbdsetup", cls._DevPath(minor), "disk", + args = ["drbdsetup", self._DevPath(minor), "disk", backend, meta, "0", "-e", "detach", "--create-device"] if size: args.extend(["-d", "%sm" % size]) + + version = self._GetVersion(self._GetProcData()) + vmaj = version["k_major"] + vmin = version["k_minor"] + vrel = version["k_point"] + + barrier_args = \ + self._ComputeDiskBarrierArgs(vmaj, vmin, vrel, + self.params[constants.LDP_BARRIERS], + self.params[constants.LDP_NO_META_FLUSH]) + args.extend(barrier_args) + + if self.params[constants.LDP_DISK_CUSTOM]: + args.extend(shlex.split(self.params[constants.LDP_DISK_CUSTOM])) + result = utils.RunCmd(args) if result.failed: _ThrowError("drbd%d: can't attach local disk: %s", minor, result.output) @classmethod - def _AssembleNet(cls, minor, net_info, protocol, + def _ComputeDiskBarrierArgs(cls, vmaj, vmin, vrel, disabled_barriers, + disable_meta_flush): + """Compute the DRBD command line parameters for disk barriers + + Returns a list of the disk barrier parameters as requested via the + disabled_barriers and disable_meta_flush arguments, and according to the + supported ones in the DRBD version vmaj.vmin.vrel + + If the desired option is unsupported, raises errors.BlockDeviceError. + + """ + disabled_barriers_set = frozenset(disabled_barriers) + if not disabled_barriers_set in constants.DRBD_VALID_BARRIER_OPT: + raise errors.BlockDeviceError("%s is not a valid option set for DRBD" + " barriers" % disabled_barriers) + + args = [] + + # The following code assumes DRBD 8.x, with x < 4 and x != 1 (DRBD 8.1.x + # does not exist) + if not vmaj == 8 and vmin in (0, 2, 3): + raise errors.BlockDeviceError("Unsupported DRBD version: %d.%d.%d" % + (vmaj, vmin, vrel)) + + def _AppendOrRaise(option, min_version): + """Helper for DRBD options""" + if min_version is not None and vrel >= min_version: + args.append(option) + else: + raise errors.BlockDeviceError("Could not use the option %s as the" + " DRBD version %d.%d.%d does not support" + " it." % (option, vmaj, vmin, vrel)) + + # the minimum version for each feature is encoded via pairs of (minor + # version -> x) where x is version in which support for the option was + # introduced. + meta_flush_supported = disk_flush_supported = { + 0: 12, + 2: 7, + 3: 0, + } + + disk_drain_supported = { + 2: 7, + 3: 0, + } + + disk_barriers_supported = { + 3: 0, + } + + # meta flushes + if disable_meta_flush: + _AppendOrRaise(cls._DISABLE_META_FLUSH_OPTION, + meta_flush_supported.get(vmin, None)) + + # disk flushes + if constants.DRBD_B_DISK_FLUSH in disabled_barriers_set: + _AppendOrRaise(cls._DISABLE_FLUSH_OPTION, + disk_flush_supported.get(vmin, None)) + + # disk drain + if constants.DRBD_B_DISK_DRAIN in disabled_barriers_set: + _AppendOrRaise(cls._DISABLE_DRAIN_OPTION, + disk_drain_supported.get(vmin, None)) + + # disk barriers + if constants.DRBD_B_DISK_BARRIERS in disabled_barriers_set: + _AppendOrRaise(cls._DISABLE_DISK_OPTION, + disk_barriers_supported.get(vmin, None)) + + return args + + def _AssembleNet(self, minor, net_info, protocol, dual_pri=False, hmac=None, secret=None): """Configure the network part of the device. @@ -1203,7 +1715,7 @@ class DRBD8(BaseDRBD): if None in net_info: # we don't want network connection and actually want to make # sure its shutdown - cls._ShutdownNet(minor) + self._ShutdownNet(minor) return # Workaround for a race condition. When DRBD is doing its dance to @@ -1212,10 +1724,27 @@ class DRBD8(BaseDRBD): # sync speed only after setting up both sides can race with DRBD # connecting, hence we set it here before telling DRBD anything # about its peer. - cls._SetMinorSyncSpeed(minor, constants.SYNC_SPEED) + sync_errors = self._SetMinorSyncParams(minor, self.params) + if sync_errors: + _ThrowError("drbd%d: can't set the synchronization parameters: %s" % + (minor, utils.CommaJoin(sync_errors))) + + if netutils.IP6Address.IsValid(lhost): + if not netutils.IP6Address.IsValid(rhost): + _ThrowError("drbd%d: can't connect ip %s to ip %s" % + (minor, lhost, rhost)) + family = "ipv6" + elif netutils.IP4Address.IsValid(lhost): + if not netutils.IP4Address.IsValid(rhost): + _ThrowError("drbd%d: can't connect ip %s to ip %s" % + (minor, lhost, rhost)) + family = "ipv4" + else: + _ThrowError("drbd%d: Invalid ip %s" % (minor, lhost)) - args = ["drbdsetup", cls._DevPath(minor), "net", - "%s:%s" % (lhost, lport), "%s:%s" % (rhost, rport), protocol, + args = ["drbdsetup", self._DevPath(minor), "net", + "%s:%s:%s" % (family, lhost, lport), + "%s:%s:%s" % (family, rhost, rport), protocol, "-A", "discard-zero-changes", "-B", "consensus", "--create-device", @@ -1224,13 +1753,17 @@ class DRBD8(BaseDRBD): args.append("-m") if hmac and secret: args.extend(["-a", hmac, "-x", secret]) + + if self.params[constants.LDP_NET_CUSTOM]: + args.extend(shlex.split(self.params[constants.LDP_NET_CUSTOM])) + result = utils.RunCmd(args) if result.failed: _ThrowError("drbd%d: can't setup network: %s - %s", minor, result.fail_reason, result.output) def _CheckNetworkConfig(): - info = cls._GetDevInfo(cls._GetShowData(minor)) + info = self._GetDevInfo(self._GetShowData(minor)) if not "local_addr" in info or not "remote_addr" in info: raise utils.RetryAgain() @@ -1294,40 +1827,104 @@ class DRBD8(BaseDRBD): self._children = [] @classmethod - def _SetMinorSyncSpeed(cls, minor, kbytes): - """Set the speed of the DRBD syncer. + def _SetMinorSyncParams(cls, minor, params): + """Set the parameters of the DRBD syncer. This is the low-level implementation. @type minor: int @param minor: the drbd minor whose settings we change - @type kbytes: int - @param kbytes: the speed in kbytes/second - @rtype: boolean - @return: the success of the operation + @type params: dict + @param params: LD level disk parameters related to the synchronization + @rtype: list + @return: a list of error messages + + """ + + args = ["drbdsetup", cls._DevPath(minor), "syncer"] + if params[constants.LDP_DYNAMIC_RESYNC]: + version = cls._GetVersion(cls._GetProcData()) + vmin = version["k_minor"] + vrel = version["k_point"] + + # By definition we are using 8.x, so just check the rest of the version + # number + if vmin != 3 or vrel < 9: + msg = ("The current DRBD version (8.%d.%d) does not support the " + "dynamic resync speed controller" % (vmin, vrel)) + logging.error(msg) + return [msg] + + if params[constants.LDP_PLAN_AHEAD] == 0: + msg = ("A value of 0 for c-plan-ahead disables the dynamic sync speed" + " controller at DRBD level. If you want to disable it, please" + " set the dynamic-resync disk parameter to False.") + logging.error(msg) + return [msg] + + # add the c-* parameters to args + args.extend(["--c-plan-ahead", params[constants.LDP_PLAN_AHEAD], + "--c-fill-target", params[constants.LDP_FILL_TARGET], + "--c-delay-target", params[constants.LDP_DELAY_TARGET], + "--c-max-rate", params[constants.LDP_MAX_RATE], + "--c-min-rate", params[constants.LDP_MIN_RATE], + ]) - """ - result = utils.RunCmd(["drbdsetup", cls._DevPath(minor), "syncer", - "-r", "%d" % kbytes, "--create-device"]) + else: + args.extend(["-r", "%d" % params[constants.LDP_RESYNC_RATE]]) + + args.append("--create-device") + result = utils.RunCmd(args) if result.failed: - logging.error("Can't change syncer rate: %s - %s", - result.fail_reason, result.output) - return not result.failed + msg = ("Can't change syncer rate: %s - %s" % + (result.fail_reason, result.output)) + logging.error(msg) + return [msg] - def SetSyncSpeed(self, kbytes): - """Set the speed of the DRBD syncer. + return [] - @type kbytes: int - @param kbytes: the speed in kbytes/second - @rtype: boolean + def SetSyncParams(self, params): + """Set the synchronization parameters of the DRBD syncer. + + @type params: dict + @param params: LD level disk parameters related to the synchronization + @rtype: list + @return: a list of error messages, emitted both by the current node and by + children. An empty list means no errors + + """ + if self.minor is None: + err = "Not attached during SetSyncParams" + logging.info(err) + return [err] + + children_result = super(DRBD8, self).SetSyncParams(params) + children_result.extend(self._SetMinorSyncParams(self.minor, params)) + return children_result + + def PauseResumeSync(self, pause): + """Pauses or resumes the sync of a DRBD device. + + @param pause: Wether to pause or resume @return: the success of the operation """ if self.minor is None: - logging.info("Not attached during SetSyncSpeed") + logging.info("Not attached during PauseSync") return False - children_result = super(DRBD8, self).SetSyncSpeed(kbytes) - return self._SetMinorSyncSpeed(self.minor, kbytes) and children_result + + children_result = super(DRBD8, self).PauseResumeSync(pause) + + if pause: + cmd = "pause-sync" + else: + cmd = "resume-sync" + + result = utils.RunCmd(["drbdsetup", self.dev_path, cmd]) + if result.failed: + logging.error("Can't %s: %s - %s", cmd, + result.fail_reason, result.output) + return not result.failed and children_result def GetProcStatus(self): """Return device data from /proc. @@ -1526,6 +2123,7 @@ class DRBD8(BaseDRBD): - if we have a configured device, we try to ensure that it matches our config - if not, we create it from zero + - anyway, set the device parameters """ super(DRBD8, self).Assemble() @@ -1539,6 +2137,11 @@ class DRBD8(BaseDRBD): # the device self._SlowAssemble() + sync_errors = self.SetSyncParams(self.params) + if sync_errors: + _ThrowError("drbd%d: can't set the synchronization parameters: %s" % + (self.minor, utils.CommaJoin(sync_errors))) + def _SlowAssemble(self): """Assembles the DRBD device from a (partially) configured device. @@ -1547,6 +2150,8 @@ class DRBD8(BaseDRBD): the attach if can return success. """ + # TODO: Rewrite to not use a for loop just because there is 'break' + # pylint: disable=W0631 net_data = (self._lhost, self._lport, self._rhost, self._rport) for minor in (self._aminor,): info = self._GetDevInfo(self._GetShowData(minor)) @@ -1683,7 +2288,7 @@ class DRBD8(BaseDRBD): self.Shutdown() @classmethod - def Create(cls, unique_id, children, size): + def Create(cls, unique_id, children, size, params, excl_stor): """Create a new DRBD8 device. Since DRBD devices are not created per se, just assembled, this @@ -1692,6 +2297,9 @@ class DRBD8(BaseDRBD): """ if len(children) != 2: raise errors.ProgrammerError("Invalid setup for the drbd device") + if excl_stor: + raise errors.ProgrammerError("DRBD device requested with" + " exclusive_storage") # check that the minor is unused aminor = unique_id[4] proc_info = cls._MassageProcData(cls._GetProcData()) @@ -1709,9 +2317,9 @@ class DRBD8(BaseDRBD): aminor, meta) cls._CheckMetaSize(meta.dev_path) cls._InitMeta(aminor, meta.dev_path) - return cls(unique_id, children, size) + return cls(unique_id, children, size, params) - def Grow(self, amount): + def Grow(self, amount, dryrun, backingstore): """Resize the DRBD device and its backing storage. """ @@ -1719,7 +2327,11 @@ class DRBD8(BaseDRBD): _ThrowError("drbd%d: Grow called while not attached", self._aminor) if len(self._children) != 2 or None in self._children: _ThrowError("drbd%d: cannot grow diskless device", self.minor) - self._children[0].Grow(amount) + self._children[0].Grow(amount, dryrun, backingstore) + if dryrun or backingstore: + # DRBD does not support dry-run mode and is not backing storage, + # so we'll return here + return result = utils.RunCmd(["drbdsetup", self.dev_path, "resize", "-s", "%dm" % (self.size + amount)]) if result.failed: @@ -1734,17 +2346,20 @@ class FileStorage(BlockDev): The unique_id for the file device is a (file_driver, file_path) tuple. """ - def __init__(self, unique_id, children, size): + def __init__(self, unique_id, children, size, params): """Initalizes a file device backend. """ if children: raise errors.BlockDeviceError("Invalid setup for file device") - super(FileStorage, self).__init__(unique_id, children, size) + super(FileStorage, self).__init__(unique_id, children, size, params) if not isinstance(unique_id, (tuple, list)) or len(unique_id) != 2: raise ValueError("Invalid configuration data %s" % str(unique_id)) self.driver = unique_id[0] self.dev_path = unique_id[1] + + CheckFileStoragePath(self.dev_path) + self.Attach() def Assemble(self): @@ -1794,6 +2409,36 @@ class FileStorage(BlockDev): if err.errno != errno.ENOENT: _ThrowError("Can't remove file '%s': %s", self.dev_path, err) + def Rename(self, new_id): + """Renames the file. + + """ + # TODO: implement rename for file-based storage + _ThrowError("Rename is not supported for file-based storage") + + def Grow(self, amount, dryrun, backingstore): + """Grow the file + + @param amount: the amount (in mebibytes) to grow with + + """ + if not backingstore: + return + # Check that the file exists + self.Assemble() + current_size = self.GetActualSize() + new_size = current_size + amount * 1024 * 1024 + assert new_size > current_size, "Cannot Grow with a negative amount" + # We can't really simulate the growth + if dryrun: + return + try: + f = open(self.dev_path, "a+") + f.truncate(new_size) + f.close() + except EnvironmentError, err: + _ThrowError("Error in file growth: %", str(err)) + def Attach(self): """Attach to an existing file. @@ -1820,7 +2465,7 @@ class FileStorage(BlockDev): _ThrowError("Can't stat %s: %s", self.dev_path, err) @classmethod - def Create(cls, unique_id, children, size): + def Create(cls, unique_id, children, size, params, excl_stor): """Create a new file. @param size: the size of file in MiB @@ -1829,62 +2474,903 @@ class FileStorage(BlockDev): @return: an instance of FileStorage """ + if excl_stor: + raise errors.ProgrammerError("FileStorage device requested with" + " exclusive_storage") if not isinstance(unique_id, (tuple, list)) or len(unique_id) != 2: raise ValueError("Invalid configuration data %s" % str(unique_id)) + dev_path = unique_id[1] - if os.path.exists(dev_path): - _ThrowError("File already existing: %s", dev_path) + + CheckFileStoragePath(dev_path) + try: - f = open(dev_path, 'w') + fd = os.open(dev_path, os.O_RDWR | os.O_CREAT | os.O_EXCL) + f = os.fdopen(fd, "w") f.truncate(size * 1024 * 1024) f.close() - except IOError, err: + except EnvironmentError, err: + if err.errno == errno.EEXIST: + _ThrowError("File already existing: %s", dev_path) _ThrowError("Error in file creation: %", str(err)) - return FileStorage(unique_id, children, size) + return FileStorage(unique_id, children, size, params) -DEV_MAP = { - constants.LD_LV: LogicalVolume, - constants.LD_DRBD8: DRBD8, - constants.LD_FILE: FileStorage, - } - +class PersistentBlockDevice(BlockDev): + """A block device with persistent node -def FindDevice(dev_type, unique_id, children, size): - """Search for an existing, assembled device. + May be either directly attached, or exposed through DM (e.g. dm-multipath). + udev helpers are probably required to give persistent, human-friendly + names. - This will succeed only if the device exists and is assembled, but it - does not do any actions in order to activate the device. + For the time being, pathnames are required to lie under /dev. """ - if dev_type not in DEV_MAP: - raise errors.ProgrammerError("Invalid block device type '%s'" % dev_type) - device = DEV_MAP[dev_type](unique_id, children, size) - if not device.attached: - return None + def __init__(self, unique_id, children, size, params): + """Attaches to a static block device. + + The unique_id is a path under /dev. + + """ + super(PersistentBlockDevice, self).__init__(unique_id, children, size, + params) + if not isinstance(unique_id, (tuple, list)) or len(unique_id) != 2: + raise ValueError("Invalid configuration data %s" % str(unique_id)) + self.dev_path = unique_id[1] + if not os.path.realpath(self.dev_path).startswith("/dev/"): + raise ValueError("Full path '%s' lies outside /dev" % + os.path.realpath(self.dev_path)) + # TODO: this is just a safety guard checking that we only deal with devices + # we know how to handle. In the future this will be integrated with + # external storage backends and possible values will probably be collected + # from the cluster configuration. + if unique_id[0] != constants.BLOCKDEV_DRIVER_MANUAL: + raise ValueError("Got persistent block device of invalid type: %s" % + unique_id[0]) + + self.major = self.minor = None + self.Attach() + + @classmethod + def Create(cls, unique_id, children, size, params, excl_stor): + """Create a new device + + This is a noop, we only return a PersistentBlockDevice instance + + """ + if excl_stor: + raise errors.ProgrammerError("Persistent block device requested with" + " exclusive_storage") + return PersistentBlockDevice(unique_id, children, 0, params) + + def Remove(self): + """Remove a device + + This is a noop + + """ + pass + + def Rename(self, new_id): + """Rename this device. + + """ + _ThrowError("Rename is not supported for PersistentBlockDev storage") + + def Attach(self): + """Attach to an existing block device. + + + """ + self.attached = False + try: + st = os.stat(self.dev_path) + except OSError, err: + logging.error("Error stat()'ing %s: %s", self.dev_path, str(err)) + return False + + if not stat.S_ISBLK(st.st_mode): + logging.error("%s is not a block device", self.dev_path) + return False + + self.major = os.major(st.st_rdev) + self.minor = os.minor(st.st_rdev) + self.attached = True + + return True + + def Assemble(self): + """Assemble the device. + + """ + pass + + def Shutdown(self): + """Shutdown the device. + + """ + pass + + def Open(self, force=False): + """Make the device ready for I/O. + + """ + pass + + def Close(self): + """Notifies that the device will no longer be used for I/O. + + """ + pass + + def Grow(self, amount, dryrun, backingstore): + """Grow the logical volume. + + """ + _ThrowError("Grow is not supported for PersistentBlockDev storage") + + +class RADOSBlockDevice(BlockDev): + """A RADOS Block Device (rbd). + + This class implements the RADOS Block Device for the backend. You need + the rbd kernel driver, the RADOS Tools and a working RADOS cluster for + this to be functional. + + """ + def __init__(self, unique_id, children, size, params): + """Attaches to an rbd device. + + """ + super(RADOSBlockDevice, self).__init__(unique_id, children, size, params) + if not isinstance(unique_id, (tuple, list)) or len(unique_id) != 2: + raise ValueError("Invalid configuration data %s" % str(unique_id)) + + self.driver, self.rbd_name = unique_id + + self.major = self.minor = None + self.Attach() + + @classmethod + def Create(cls, unique_id, children, size, params, excl_stor): + """Create a new rbd device. + + Provision a new rbd volume inside a RADOS pool. + + """ + if not isinstance(unique_id, (tuple, list)) or len(unique_id) != 2: + raise errors.ProgrammerError("Invalid configuration data %s" % + str(unique_id)) + if excl_stor: + raise errors.ProgrammerError("RBD device requested with" + " exclusive_storage") + rbd_pool = params[constants.LDP_POOL] + rbd_name = unique_id[1] + + # Provision a new rbd volume (Image) inside the RADOS cluster. + cmd = [constants.RBD_CMD, "create", "-p", rbd_pool, + rbd_name, "--size", "%s" % size] + result = utils.RunCmd(cmd) + if result.failed: + _ThrowError("rbd creation failed (%s): %s", + result.fail_reason, result.output) + + return RADOSBlockDevice(unique_id, children, size, params) + + def Remove(self): + """Remove the rbd device. + + """ + rbd_pool = self.params[constants.LDP_POOL] + rbd_name = self.unique_id[1] + + if not self.minor and not self.Attach(): + # The rbd device doesn't exist. + return + + # First shutdown the device (remove mappings). + self.Shutdown() + + # Remove the actual Volume (Image) from the RADOS cluster. + cmd = [constants.RBD_CMD, "rm", "-p", rbd_pool, rbd_name] + result = utils.RunCmd(cmd) + if result.failed: + _ThrowError("Can't remove Volume from cluster with rbd rm: %s - %s", + result.fail_reason, result.output) + + def Rename(self, new_id): + """Rename this device. + + """ + pass + + def Attach(self): + """Attach to an existing rbd device. + + This method maps the rbd volume that matches our name with + an rbd device and then attaches to this device. + + """ + self.attached = False + + # Map the rbd volume to a block device under /dev + self.dev_path = self._MapVolumeToBlockdev(self.unique_id) + + try: + st = os.stat(self.dev_path) + except OSError, err: + logging.error("Error stat()'ing %s: %s", self.dev_path, str(err)) + return False + + if not stat.S_ISBLK(st.st_mode): + logging.error("%s is not a block device", self.dev_path) + return False + + self.major = os.major(st.st_rdev) + self.minor = os.minor(st.st_rdev) + self.attached = True + + return True + + def _MapVolumeToBlockdev(self, unique_id): + """Maps existing rbd volumes to block devices. + + This method should be idempotent if the mapping already exists. + + @rtype: string + @return: the block device path that corresponds to the volume + + """ + pool = self.params[constants.LDP_POOL] + name = unique_id[1] + + # Check if the mapping already exists. + showmap_cmd = [constants.RBD_CMD, "showmapped", "-p", pool] + result = utils.RunCmd(showmap_cmd) + if result.failed: + _ThrowError("rbd showmapped failed (%s): %s", + result.fail_reason, result.output) + + rbd_dev = self._ParseRbdShowmappedOutput(result.output, name) + + if rbd_dev: + # The mapping exists. Return it. + return rbd_dev + + # The mapping doesn't exist. Create it. + map_cmd = [constants.RBD_CMD, "map", "-p", pool, name] + result = utils.RunCmd(map_cmd) + if result.failed: + _ThrowError("rbd map failed (%s): %s", + result.fail_reason, result.output) + + # Find the corresponding rbd device. + showmap_cmd = [constants.RBD_CMD, "showmapped", "-p", pool] + result = utils.RunCmd(showmap_cmd) + if result.failed: + _ThrowError("rbd map succeeded, but showmapped failed (%s): %s", + result.fail_reason, result.output) + + rbd_dev = self._ParseRbdShowmappedOutput(result.output, name) + + if not rbd_dev: + _ThrowError("rbd map succeeded, but could not find the rbd block" + " device in output of showmapped, for volume: %s", name) + + # The device was successfully mapped. Return it. + return rbd_dev + + @staticmethod + def _ParseRbdShowmappedOutput(output, volume_name): + """Parse the output of `rbd showmapped'. + + This method parses the output of `rbd showmapped' and returns + the rbd block device path (e.g. /dev/rbd0) that matches the + given rbd volume. + + @type output: string + @param output: the whole output of `rbd showmapped' + @type volume_name: string + @param volume_name: the name of the volume whose device we search for + @rtype: string or None + @return: block device path if the volume is mapped, else None + + """ + allfields = 5 + volumefield = 2 + devicefield = 4 + + field_sep = "\t" + + lines = output.splitlines() + splitted_lines = map(lambda l: l.split(field_sep), lines) + + # Check empty output. + if not splitted_lines: + _ThrowError("rbd showmapped returned empty output") + + # Check showmapped header line, to determine number of fields. + field_cnt = len(splitted_lines[0]) + if field_cnt != allfields: + _ThrowError("Cannot parse rbd showmapped output because its format" + " seems to have changed; expected %s fields, found %s", + allfields, field_cnt) + + matched_lines = \ + filter(lambda l: len(l) == allfields and l[volumefield] == volume_name, + splitted_lines) + + if len(matched_lines) > 1: + _ThrowError("The rbd volume %s is mapped more than once." + " This shouldn't happen, try to unmap the extra" + " devices manually.", volume_name) + + if matched_lines: + # rbd block device found. Return it. + rbd_dev = matched_lines[0][devicefield] + return rbd_dev + + # The given volume is not mapped. + return None + + def Assemble(self): + """Assemble the device. + + """ + pass + + def Shutdown(self): + """Shutdown the device. + + """ + if not self.minor and not self.Attach(): + # The rbd device doesn't exist. + return + + # Unmap the block device from the Volume. + self._UnmapVolumeFromBlockdev(self.unique_id) + + self.minor = None + self.dev_path = None + + def _UnmapVolumeFromBlockdev(self, unique_id): + """Unmaps the rbd device from the Volume it is mapped. + + Unmaps the rbd device from the Volume it was previously mapped to. + This method should be idempotent if the Volume isn't mapped. + + """ + pool = self.params[constants.LDP_POOL] + name = unique_id[1] + + # Check if the mapping already exists. + showmap_cmd = [constants.RBD_CMD, "showmapped", "-p", pool] + result = utils.RunCmd(showmap_cmd) + if result.failed: + _ThrowError("rbd showmapped failed [during unmap](%s): %s", + result.fail_reason, result.output) + + rbd_dev = self._ParseRbdShowmappedOutput(result.output, name) + + if rbd_dev: + # The mapping exists. Unmap the rbd device. + unmap_cmd = [constants.RBD_CMD, "unmap", "%s" % rbd_dev] + result = utils.RunCmd(unmap_cmd) + if result.failed: + _ThrowError("rbd unmap failed (%s): %s", + result.fail_reason, result.output) + + def Open(self, force=False): + """Make the device ready for I/O. + + """ + pass + + def Close(self): + """Notifies that the device will no longer be used for I/O. + + """ + pass + + def Grow(self, amount, dryrun, backingstore): + """Grow the Volume. + + @type amount: integer + @param amount: the amount (in mebibytes) to grow with + @type dryrun: boolean + @param dryrun: whether to execute the operation in simulation mode + only, without actually increasing the size + + """ + if not backingstore: + return + if not self.Attach(): + _ThrowError("Can't attach to rbd device during Grow()") + + if dryrun: + # the rbd tool does not support dry runs of resize operations. + # Since rbd volumes are thinly provisioned, we assume + # there is always enough free space for the operation. + return + + rbd_pool = self.params[constants.LDP_POOL] + rbd_name = self.unique_id[1] + new_size = self.size + amount + + # Resize the rbd volume (Image) inside the RADOS cluster. + cmd = [constants.RBD_CMD, "resize", "-p", rbd_pool, + rbd_name, "--size", "%s" % new_size] + result = utils.RunCmd(cmd) + if result.failed: + _ThrowError("rbd resize failed (%s): %s", + result.fail_reason, result.output) + + +class ExtStorageDevice(BlockDev): + """A block device provided by an ExtStorage Provider. + + This class implements the External Storage Interface, which means + handling of the externally provided block devices. + + """ + def __init__(self, unique_id, children, size, params): + """Attaches to an extstorage block device. + + """ + super(ExtStorageDevice, self).__init__(unique_id, children, size, params) + if not isinstance(unique_id, (tuple, list)) or len(unique_id) != 2: + raise ValueError("Invalid configuration data %s" % str(unique_id)) + + self.driver, self.vol_name = unique_id + self.ext_params = params + + self.major = self.minor = None + self.Attach() + + @classmethod + def Create(cls, unique_id, children, size, params, excl_stor): + """Create a new extstorage device. + + Provision a new volume using an extstorage provider, which will + then be mapped to a block device. + + """ + if not isinstance(unique_id, (tuple, list)) or len(unique_id) != 2: + raise errors.ProgrammerError("Invalid configuration data %s" % + str(unique_id)) + if excl_stor: + raise errors.ProgrammerError("extstorage device requested with" + " exclusive_storage") + + # Call the External Storage's create script, + # to provision a new Volume inside the External Storage + _ExtStorageAction(constants.ES_ACTION_CREATE, unique_id, + params, str(size)) + + return ExtStorageDevice(unique_id, children, size, params) + + def Remove(self): + """Remove the extstorage device. + + """ + if not self.minor and not self.Attach(): + # The extstorage device doesn't exist. + return + + # First shutdown the device (remove mappings). + self.Shutdown() + + # Call the External Storage's remove script, + # to remove the Volume from the External Storage + _ExtStorageAction(constants.ES_ACTION_REMOVE, self.unique_id, + self.ext_params) + + def Rename(self, new_id): + """Rename this device. + + """ + pass + + def Attach(self): + """Attach to an existing extstorage device. + + This method maps the extstorage volume that matches our name with + a corresponding block device and then attaches to this device. + + """ + self.attached = False + + # Call the External Storage's attach script, + # to attach an existing Volume to a block device under /dev + self.dev_path = _ExtStorageAction(constants.ES_ACTION_ATTACH, + self.unique_id, self.ext_params) + + try: + st = os.stat(self.dev_path) + except OSError, err: + logging.error("Error stat()'ing %s: %s", self.dev_path, str(err)) + return False + + if not stat.S_ISBLK(st.st_mode): + logging.error("%s is not a block device", self.dev_path) + return False + + self.major = os.major(st.st_rdev) + self.minor = os.minor(st.st_rdev) + self.attached = True + + return True + + def Assemble(self): + """Assemble the device. + + """ + pass + + def Shutdown(self): + """Shutdown the device. + + """ + if not self.minor and not self.Attach(): + # The extstorage device doesn't exist. + return + + # Call the External Storage's detach script, + # to detach an existing Volume from it's block device under /dev + _ExtStorageAction(constants.ES_ACTION_DETACH, self.unique_id, + self.ext_params) + + self.minor = None + self.dev_path = None + + def Open(self, force=False): + """Make the device ready for I/O. + + """ + pass + + def Close(self): + """Notifies that the device will no longer be used for I/O. + + """ + pass + + def Grow(self, amount, dryrun, backingstore): + """Grow the Volume. + + @type amount: integer + @param amount: the amount (in mebibytes) to grow with + @type dryrun: boolean + @param dryrun: whether to execute the operation in simulation mode + only, without actually increasing the size + + """ + if not backingstore: + return + if not self.Attach(): + _ThrowError("Can't attach to extstorage device during Grow()") + + if dryrun: + # we do not support dry runs of resize operations for now. + return + + new_size = self.size + amount + + # Call the External Storage's grow script, + # to grow an existing Volume inside the External Storage + _ExtStorageAction(constants.ES_ACTION_GROW, self.unique_id, + self.ext_params, str(self.size), grow=str(new_size)) + + def SetInfo(self, text): + """Update metadata with info text. + + """ + # Replace invalid characters + text = re.sub("^[^A-Za-z0-9_+.]", "_", text) + text = re.sub("[^-A-Za-z0-9_+.]", "_", text) + + # Only up to 128 characters are allowed + text = text[:128] + + # Call the External Storage's setinfo script, + # to set metadata for an existing Volume inside the External Storage + _ExtStorageAction(constants.ES_ACTION_SETINFO, self.unique_id, + self.ext_params, metadata=text) + + +def _ExtStorageAction(action, unique_id, ext_params, + size=None, grow=None, metadata=None): + """Take an External Storage action. + + Take an External Storage action concerning or affecting + a specific Volume inside the External Storage. + + @type action: string + @param action: which action to perform. One of: + create / remove / grow / attach / detach + @type unique_id: tuple (driver, vol_name) + @param unique_id: a tuple containing the type of ExtStorage (driver) + and the Volume name + @type ext_params: dict + @param ext_params: ExtStorage parameters + @type size: integer + @param size: the size of the Volume in mebibytes + @type grow: integer + @param grow: the new size in mebibytes (after grow) + @type metadata: string + @param metadata: metadata info of the Volume, for use by the provider + @rtype: None or a block device path (during attach) + + """ + driver, vol_name = unique_id + + # Create an External Storage instance of type `driver' + status, inst_es = ExtStorageFromDisk(driver) + if not status: + _ThrowError("%s" % inst_es) + + # Create the basic environment for the driver's scripts + create_env = _ExtStorageEnvironment(unique_id, ext_params, size, + grow, metadata) + + # Do not use log file for action `attach' as we need + # to get the output from RunResult + # TODO: find a way to have a log file for attach too + logfile = None + if action is not constants.ES_ACTION_ATTACH: + logfile = _VolumeLogName(action, driver, vol_name) + + # Make sure the given action results in a valid script + if action not in constants.ES_SCRIPTS: + _ThrowError("Action '%s' doesn't result in a valid ExtStorage script" % + action) + + # Find out which external script to run according the given action + script_name = action + "_script" + script = getattr(inst_es, script_name) + + # Run the external script + result = utils.RunCmd([script], env=create_env, + cwd=inst_es.path, output=logfile,) + if result.failed: + logging.error("External storage's %s command '%s' returned" + " error: %s, logfile: %s, output: %s", + action, result.cmd, result.fail_reason, + logfile, result.output) + + # If logfile is 'None' (during attach), it breaks TailFile + # TODO: have a log file for attach too + if action is not constants.ES_ACTION_ATTACH: + lines = [utils.SafeEncode(val) + for val in utils.TailFile(logfile, lines=20)] + else: + lines = result.output[-20:] + + _ThrowError("External storage's %s script failed (%s), last" + " lines of output:\n%s", + action, result.fail_reason, "\n".join(lines)) + + if action == constants.ES_ACTION_ATTACH: + return result.stdout + + +def ExtStorageFromDisk(name, base_dir=None): + """Create an ExtStorage instance from disk. + + This function will return an ExtStorage instance + if the given name is a valid ExtStorage name. + + @type base_dir: string + @keyword base_dir: Base directory containing ExtStorage installations. + Defaults to a search in all the ES_SEARCH_PATH dirs. + @rtype: tuple + @return: True and the ExtStorage instance if we find a valid one, or + False and the diagnose message on error + + """ + if base_dir is None: + es_base_dir = pathutils.ES_SEARCH_PATH + else: + es_base_dir = [base_dir] + + es_dir = utils.FindFile(name, es_base_dir, os.path.isdir) + + if es_dir is None: + return False, ("Directory for External Storage Provider %s not" + " found in search path" % name) + + # ES Files dictionary, we will populate it with the absolute path + # names; if the value is True, then it is a required file, otherwise + # an optional one + es_files = dict.fromkeys(constants.ES_SCRIPTS, True) + + es_files[constants.ES_PARAMETERS_FILE] = True + + for (filename, _) in es_files.items(): + es_files[filename] = utils.PathJoin(es_dir, filename) + + try: + st = os.stat(es_files[filename]) + except EnvironmentError, err: + return False, ("File '%s' under path '%s' is missing (%s)" % + (filename, es_dir, utils.ErrnoOrStr(err))) + + if not stat.S_ISREG(stat.S_IFMT(st.st_mode)): + return False, ("File '%s' under path '%s' is not a regular file" % + (filename, es_dir)) + + if filename in constants.ES_SCRIPTS: + if stat.S_IMODE(st.st_mode) & stat.S_IXUSR != stat.S_IXUSR: + return False, ("File '%s' under path '%s' is not executable" % + (filename, es_dir)) + + parameters = [] + if constants.ES_PARAMETERS_FILE in es_files: + parameters_file = es_files[constants.ES_PARAMETERS_FILE] + try: + parameters = utils.ReadFile(parameters_file).splitlines() + except EnvironmentError, err: + return False, ("Error while reading the EXT parameters file at %s: %s" % + (parameters_file, utils.ErrnoOrStr(err))) + parameters = [v.split(None, 1) for v in parameters] + + es_obj = \ + objects.ExtStorage(name=name, path=es_dir, + create_script=es_files[constants.ES_SCRIPT_CREATE], + remove_script=es_files[constants.ES_SCRIPT_REMOVE], + grow_script=es_files[constants.ES_SCRIPT_GROW], + attach_script=es_files[constants.ES_SCRIPT_ATTACH], + detach_script=es_files[constants.ES_SCRIPT_DETACH], + setinfo_script=es_files[constants.ES_SCRIPT_SETINFO], + verify_script=es_files[constants.ES_SCRIPT_VERIFY], + supported_parameters=parameters) + return True, es_obj + + +def _ExtStorageEnvironment(unique_id, ext_params, + size=None, grow=None, metadata=None): + """Calculate the environment for an External Storage script. + + @type unique_id: tuple (driver, vol_name) + @param unique_id: ExtStorage pool and name of the Volume + @type ext_params: dict + @param ext_params: the EXT parameters + @type size: string + @param size: size of the Volume (in mebibytes) + @type grow: string + @param grow: new size of Volume after grow (in mebibytes) + @type metadata: string + @param metadata: metadata info of the Volume + @rtype: dict + @return: dict of environment variables + + """ + vol_name = unique_id[1] + + result = {} + result["VOL_NAME"] = vol_name + + # EXT params + for pname, pvalue in ext_params.items(): + result["EXTP_%s" % pname.upper()] = str(pvalue) + + if size is not None: + result["VOL_SIZE"] = size + + if grow is not None: + result["VOL_NEW_SIZE"] = grow + + if metadata is not None: + result["VOL_METADATA"] = metadata + + return result + + +def _VolumeLogName(kind, es_name, volume): + """Compute the ExtStorage log filename for a given Volume and operation. + + @type kind: string + @param kind: the operation type (e.g. create, remove etc.) + @type es_name: string + @param es_name: the ExtStorage name + @type volume: string + @param volume: the name of the Volume inside the External Storage + + """ + # Check if the extstorage log dir is a valid dir + if not os.path.isdir(pathutils.LOG_ES_DIR): + _ThrowError("Cannot find log directory: %s", pathutils.LOG_ES_DIR) + + # TODO: Use tempfile.mkstemp to create unique filename + base = ("%s-%s-%s-%s.log" % + (kind, es_name, volume, utils.TimestampForFilename())) + return utils.PathJoin(pathutils.LOG_ES_DIR, base) + + +DEV_MAP = { + constants.LD_LV: LogicalVolume, + constants.LD_DRBD8: DRBD8, + constants.LD_BLOCKDEV: PersistentBlockDevice, + constants.LD_RBD: RADOSBlockDevice, + constants.LD_EXT: ExtStorageDevice, + } + +if constants.ENABLE_FILE_STORAGE or constants.ENABLE_SHARED_FILE_STORAGE: + DEV_MAP[constants.LD_FILE] = FileStorage + + +def _VerifyDiskType(dev_type): + if dev_type not in DEV_MAP: + raise errors.ProgrammerError("Invalid block device type '%s'" % dev_type) + + +def _VerifyDiskParams(disk): + """Verifies if all disk parameters are set. + + """ + missing = set(constants.DISK_LD_DEFAULTS[disk.dev_type]) - set(disk.params) + if missing: + raise errors.ProgrammerError("Block device is missing disk parameters: %s" % + missing) + + +def FindDevice(disk, children): + """Search for an existing, assembled device. + + This will succeed only if the device exists and is assembled, but it + does not do any actions in order to activate the device. + + @type disk: L{objects.Disk} + @param disk: the disk object to find + @type children: list of L{bdev.BlockDev} + @param children: the list of block devices that are children of the device + represented by the disk parameter + + """ + _VerifyDiskType(disk.dev_type) + device = DEV_MAP[disk.dev_type](disk.physical_id, children, disk.size, + disk.params) + if not device.attached: + return None return device -def Assemble(dev_type, unique_id, children, size): +def Assemble(disk, children): """Try to attach or assemble an existing device. This will attach to assemble the device, as needed, to bring it fully up. It must be safe to run on already-assembled devices. + @type disk: L{objects.Disk} + @param disk: the disk object to assemble + @type children: list of L{bdev.BlockDev} + @param children: the list of block devices that are children of the device + represented by the disk parameter + """ - if dev_type not in DEV_MAP: - raise errors.ProgrammerError("Invalid block device type '%s'" % dev_type) - device = DEV_MAP[dev_type](unique_id, children, size) + _VerifyDiskType(disk.dev_type) + _VerifyDiskParams(disk) + device = DEV_MAP[disk.dev_type](disk.physical_id, children, disk.size, + disk.params) device.Assemble() return device -def Create(dev_type, unique_id, children, size): +def Create(disk, children, excl_stor): """Create a device. + @type disk: L{objects.Disk} + @param disk: the disk object to create + @type children: list of L{bdev.BlockDev} + @param children: the list of block devices that are children of the device + represented by the disk parameter + @type excl_stor: boolean + @param excl_stor: Whether exclusive_storage is active + """ - if dev_type not in DEV_MAP: - raise errors.ProgrammerError("Invalid block device type '%s'" % dev_type) - device = DEV_MAP[dev_type].Create(unique_id, children, size) + _VerifyDiskType(disk.dev_type) + _VerifyDiskParams(disk) + device = DEV_MAP[disk.dev_type].Create(disk.physical_id, children, disk.size, + disk.params, excl_stor) return device