bdev.py 59.8 KB
Newer Older
Iustin Pop's avatar
Iustin Pop committed
1
#
Iustin Pop's avatar
Iustin Pop committed
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26
#

# 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
27
import pyparsing as pyp
Manuel Franceschini's avatar
Manuel Franceschini committed
28
import os
29
import logging
Iustin Pop's avatar
Iustin Pop committed
30 31 32

from ganeti import utils
from ganeti import errors
33
from ganeti import constants
34
from ganeti import objects
Iustin Pop's avatar
Iustin Pop committed
35 36


37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68
def _IgnoreError(fn, *args, **kwargs):
  """Executes the given function, ignoring BlockDeviceErrors.

  This is used in order to simplify the execution of cleanup or
  rollback functions.

  @rtype: boolean
  @return: True when fn didn't raise an exception, False otherwise

  """
  try:
    fn(*args, **kwargs)
    return True
  except errors.BlockDeviceError, err:
    logging.warning("Caught BlockDeviceError but ignoring: %s" % str(err))
    return False


def _ThrowError(msg, *args):
  """Log an error to the node daemon and the raise an exception.

  @type msg: string
  @param msg: the text of the exception
  @raise errors.BlockDeviceError

  """
  if args:
    msg = msg % args
  logging.error(msg)
  raise errors.BlockDeviceError(msg)


Iustin Pop's avatar
Iustin Pop committed
69 70 71 72 73 74 75 76 77 78
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
79 80 81
  the readonly state (LV has 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
Iustin Pop's avatar
Iustin Pop committed
82 83 84 85 86 87 88 89 90 91 92 93 94 95
  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
    - drbd devices are attached to a local disk/remote peer and made primary

  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
96 97 98
  volume name) in a 1-to-1 relation to the dev path. For DRBD devices,
  the /dev path is again dynamic and the unique id is the pair (host1,
  dev1), (host2, dev2).
Iustin Pop's avatar
Iustin Pop committed
99 100 101

  You can get to a device in two ways:
    - creating the (real) device, which returns you
102
      an attached instance (lvcreate)
Iustin Pop's avatar
Iustin Pop committed
103 104 105 106 107 108 109 110 111
    - 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.

  """
Iustin Pop's avatar
Iustin Pop committed
112
  def __init__(self, unique_id, children, size):
Iustin Pop's avatar
Iustin Pop committed
113 114 115 116 117
    self._children = children
    self.dev_path = None
    self.unique_id = unique_id
    self.major = None
    self.minor = None
118
    self.attached = False
Iustin Pop's avatar
Iustin Pop committed
119
    self.size = size
Iustin Pop's avatar
Iustin Pop committed
120 121 122 123

  def Assemble(self):
    """Assemble the device from its components.

124 125 126 127 128 129 130
    Implementations of this method by child classes must ensure 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
      - calling this method on an existing, in-use device is safe
      - if the device is already configured (and in an OK state),
        this method is idempotent
Iustin Pop's avatar
Iustin Pop committed
131 132

    """
133
    pass
Iustin Pop's avatar
Iustin Pop committed
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163

  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.

164
    This makes sense only for some of the device types: LV and file
Michael Hanselmann's avatar
Michael Hanselmann committed
165
    storage. Also note that if the device can't attach, the removal
166
    can't be completed.
Iustin Pop's avatar
Iustin Pop committed
167 168 169 170

    """
    raise NotImplementedError

Iustin Pop's avatar
Iustin Pop committed
171 172 173 174 175 176 177 178
  def Rename(self, new_id):
    """Rename this device.

    This may or may not make sense for a given device type.

    """
    raise NotImplementedError

Iustin Pop's avatar
Iustin Pop committed
179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218
  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.

219
    If sync_percent is None, it means the device is not syncing.
Iustin Pop's avatar
Iustin Pop committed
220 221

    If estimated_time is None, it means we can't estimate
222 223
    the time needed, otherwise it's the time left in seconds.

Iustin Pop's avatar
Iustin Pop committed
224 225 226 227
    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.

228 229 230 231
    The ldisk parameter represents the degradation of the local
    data. This is only valid for some devices, the rest will always
    return False (not degraded).

232
    @rtype: objects.BlockDevStatus
Iustin Pop's avatar
Iustin Pop committed
233

Iustin Pop's avatar
Iustin Pop committed
234
    """
235 236 237 238 239 240
    return objects.BlockDevStatus(dev_path=self.dev_path,
                                  major=self.major,
                                  minor=self.minor,
                                  sync_percent=None,
                                  estimated_time=None,
                                  is_degraded=False,
241
                                  ldisk_status=constants.LDS_OKAY)
Iustin Pop's avatar
Iustin Pop committed
242 243 244 245 246 247 248 249

  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.

250 251
    @rtype: objects.BlockDevStatus

Iustin Pop's avatar
Iustin Pop committed
252
    """
253 254 255 256 257
    status = self.GetSyncStatus()

    min_percent = status.sync_percent
    max_time = status.estimated_time
    is_degraded = status.is_degraded
258
    ldisk_status = status.ldisk_status
259

Iustin Pop's avatar
Iustin Pop committed
260 261
    if self._children:
      for child in self._children:
262 263
        child_status = child.GetSyncStatus()

Iustin Pop's avatar
Iustin Pop committed
264
        if min_percent is None:
265 266 267 268
          min_percent = child_status.sync_percent
        elif child_status.sync_percent is not None:
          min_percent = min(min_percent, child_status.sync_percent)

Iustin Pop's avatar
Iustin Pop committed
269
        if max_time is None:
270 271 272 273 274
          max_time = child_status.estimated_time
        elif child_status.estimated_time is not None:
          max_time = max(max_time, child_status.estimated_time)

        is_degraded = is_degraded or child_status.is_degraded
275 276 277 278 279

        if ldisk_status is None:
          ldisk_status = child_status.ldisk_status
        elif child_status.ldisk_status is not None:
          ldisk_status = max(ldisk_status, child_status.ldisk_status)
280 281 282 283 284 285 286

    return objects.BlockDevStatus(dev_path=self.dev_path,
                                  major=self.major,
                                  minor=self.minor,
                                  sync_percent=min_percent,
                                  estimated_time=max_time,
                                  is_degraded=is_degraded,
287
                                  ldisk_status=ldisk_status)
Iustin Pop's avatar
Iustin Pop committed
288 289


290 291 292 293 294 295 296 297 298
  def SetInfo(self, text):
    """Update metadata with info text.

    Only supported for some device types.

    """
    for child in self._children:
      child.SetInfo(text)

299 300 301
  def Grow(self, amount):
    """Grow the block device.

Iustin Pop's avatar
Iustin Pop committed
302
    @param amount: the amount (in mebibytes) to grow with
303 304 305

    """
    raise NotImplementedError
306

307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323
  def GetActualSize(self):
    """Return the actual disk size.

    @note: the device needs to be active when this is called

    """
    assert self.attached, "BlockDevice not attached in GetActualSize()"
    result = utils.RunCmd(["blockdev", "--getsize64", self.dev_path])
    if result.failed:
      _ThrowError("blockdev failed (%s): %s",
                  result.fail_reason, result.output)
    try:
      sz = int(result.output.strip())
    except (ValueError, TypeError), err:
      _ThrowError("Failed to parse blockdev output: %s", str(err))
    return sz

Iustin Pop's avatar
Iustin Pop committed
324 325 326 327 328 329 330 331 332 333
  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.

  """
Iustin Pop's avatar
Iustin Pop committed
334
  def __init__(self, unique_id, children, size):
Iustin Pop's avatar
Iustin Pop committed
335 336 337 338 339
    """Attaches to a LV device.

    The unique_id is a tuple (vg_name, lv_name)

    """
Iustin Pop's avatar
Iustin Pop committed
340
    super(LogicalVolume, self).__init__(unique_id, children, size)
Iustin Pop's avatar
Iustin Pop committed
341 342 343 344
    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)
Iustin Pop's avatar
Iustin Pop committed
345
    self._degraded = True
346
    self.major = self.minor = self.pe_size = self.stripe_count = None
Iustin Pop's avatar
Iustin Pop committed
347 348 349 350 351 352 353 354
    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:
Iustin Pop's avatar
Iustin Pop committed
355 356
      raise errors.ProgrammerError("Invalid configuration data %s" %
                                   str(unique_id))
Iustin Pop's avatar
Iustin Pop committed
357 358 359
    vg_name, lv_name = unique_id
    pvs_info = cls.GetPVInfo(vg_name)
    if not pvs_info:
360
      _ThrowError("Can't compute PV info for vg %s", vg_name)
Iustin Pop's avatar
Iustin Pop committed
361 362
    pvs_info.sort()
    pvs_info.reverse()
363 364 365

    pvlist = [ pv[1] for pv in pvs_info ]
    free_size = sum([ pv[0] for pv in pvs_info ])
Iustin Pop's avatar
Iustin Pop committed
366 367
    current_pvs = len(pvlist)
    stripes = min(current_pvs, constants.LVM_STRIPECOUNT)
368 369 370

    # The size constraint should have been checked from the master before
    # calling the create function.
Iustin Pop's avatar
Iustin Pop committed
371
    if free_size < size:
372 373
      _ThrowError("Not enough free space: required %s,"
                  " available %s", size, free_size)
Iustin Pop's avatar
Iustin Pop committed
374 375 376 377 378 379 380 381 382
    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
    for stripes_arg in range(stripes, 0, -1):
      result = utils.RunCmd(cmd + ["-i%d" % stripes_arg] + [vg_name] + pvlist)
      if not result.failed:
        break
Iustin Pop's avatar
Iustin Pop committed
383
    if result.failed:
384 385
      _ThrowError("LV create failed (%s): %s",
                  result.fail_reason, result.output)
Iustin Pop's avatar
Iustin Pop committed
386
    return LogicalVolume(unique_id, children, size)
Iustin Pop's avatar
Iustin Pop committed
387 388 389 390 391

  @staticmethod
  def GetPVInfo(vg_name):
    """Get the free space info for PVs in a volume group.

Iustin Pop's avatar
Iustin Pop committed
392
    @param vg_name: the volume group name
Iustin Pop's avatar
Iustin Pop committed
393

Iustin Pop's avatar
Iustin Pop committed
394 395
    @rtype: list
    @return: list of tuples (free_space, name) with free_space in mebibytes
396

Iustin Pop's avatar
Iustin Pop committed
397 398 399 400 401 402
    """
    command = ["pvs", "--noheadings", "--nosuffix", "--units=m",
               "-opv_name,vg_name,pv_free,pv_attr", "--unbuffered",
               "--separator=:"]
    result = utils.RunCmd(command)
    if result.failed:
403 404
      logging.error("Can't get the PV information: %s - %s",
                    result.fail_reason, result.output)
Iustin Pop's avatar
Iustin Pop committed
405 406 407 408 409
      return None
    data = []
    for line in result.stdout.splitlines():
      fields = line.strip().split(':')
      if len(fields) != 4:
410
        logging.error("Can't parse pvs output: line '%s'", line)
Iustin Pop's avatar
Iustin Pop committed
411 412 413 414 415 416 417 418 419 420 421 422 423 424
        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
425
      return
Iustin Pop's avatar
Iustin Pop committed
426 427 428
    result = utils.RunCmd(["lvremove", "-f", "%s/%s" %
                           (self._vg_name, self._lv_name)])
    if result.failed:
429
      _ThrowError("Can't lvremove: %s - %s", result.fail_reason, result.output)
Iustin Pop's avatar
Iustin Pop committed
430

Iustin Pop's avatar
Iustin Pop committed
431 432 433 434 435 436 437 438 439 440 441 442 443
  def Rename(self, new_id):
    """Rename this logical volume.

    """
    if not isinstance(new_id, (tuple, list)) or len(new_id) != 2:
      raise errors.ProgrammerError("Invalid new logical id '%s'" % new_id)
    new_vg, new_name = new_id
    if new_vg != self._vg_name:
      raise errors.ProgrammerError("Can't move a logical volume across"
                                   " volume groups (from %s to to %s)" %
                                   (self._vg_name, new_vg))
    result = utils.RunCmd(["lvrename", new_vg, self._lv_name, new_name])
    if result.failed:
444
      _ThrowError("Failed to rename the logical volume: %s", result.output)
445 446 447
    self._lv_name = new_name
    self.dev_path = "/dev/%s/%s" % (self._vg_name, self._lv_name)

Iustin Pop's avatar
Iustin Pop committed
448 449 450 451
  def Attach(self):
    """Attach to an existing LV.

    This method will try to see if an existing and active LV exists
452
    which matches our name. If so, its major/minor will be
Iustin Pop's avatar
Iustin Pop committed
453 454 455
    recorded.

    """
456
    self.attached = False
Iustin Pop's avatar
Iustin Pop committed
457
    result = utils.RunCmd(["lvs", "--noheadings", "--separator=,",
458 459 460
                           "--units=m", "--nosuffix",
                           "-olv_attr,lv_kernel_major,lv_kernel_minor,"
                           "vg_extent_size,stripes", self.dev_path])
Iustin Pop's avatar
Iustin Pop committed
461
    if result.failed:
462 463
      logging.error("Can't find LV %s: %s, %s",
                    self.dev_path, result.fail_reason, result.output)
Iustin Pop's avatar
Iustin Pop committed
464
      return False
465 466 467 468 469 470 471 472 473 474 475
    # the output can (and will) have multiple lines for multi-segment
    # LVs, as the 'stripes' parameter is a segment one, so we take
    # only the last entry, which is the one we're interested in; note
    # that with LVM2 anyway the 'stripes' value must be constant
    # across segments, so this is a no-op actually
    out = result.stdout.splitlines()
    if not out: # totally empty result? splitlines() returns at least
                # 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(',')
Iustin Pop's avatar
Iustin Pop committed
476
    out = out.split(",")
477 478
    if len(out) != 5:
      logging.error("Can't parse LVS output, len(%s) != 5", str(out))
Iustin Pop's avatar
Iustin Pop committed
479 480
      return False

481
    status, major, minor, pe_size, stripes = out
Iustin Pop's avatar
Iustin Pop committed
482
    if len(status) != 6:
483
      logging.error("lvs lv_attr is not 6 characters (%s)", status)
Iustin Pop's avatar
Iustin Pop committed
484 485 486 487 488 489
      return False

    try:
      major = int(major)
      minor = int(minor)
    except ValueError, err:
490
      logging.error("lvs major/minor cannot be parsed: %s", str(err))
Iustin Pop's avatar
Iustin Pop committed
491

492 493 494 495 496 497 498 499 500 501 502 503
    try:
      pe_size = int(float(pe_size))
    except (TypeError, ValueError), err:
      logging.error("Can't parse vg extent size: %s", err)
      return False

    try:
      stripes = int(stripes)
    except (TypeError, ValueError), err:
      logging.error("Can't parse the number of stripes: %s", err)
      return False

Iustin Pop's avatar
Iustin Pop committed
504 505
    self.major = major
    self.minor = minor
506 507
    self.pe_size = pe_size
    self.stripe_count = stripes
Iustin Pop's avatar
Iustin Pop committed
508 509
    self._degraded = status[0] == 'v' # virtual volume, i.e. doesn't backing
                                      # storage
510
    self.attached = True
Iustin Pop's avatar
Iustin Pop committed
511
    return True
Iustin Pop's avatar
Iustin Pop committed
512 513 514 515

  def Assemble(self):
    """Assemble the device.

Michael Hanselmann's avatar
Michael Hanselmann committed
516
    We always run `lvchange -ay` on the LV to ensure it's active before
517 518
    use, as there were cases when xenvg was not active after boot
    (also possibly after disk issues).
Iustin Pop's avatar
Iustin Pop committed
519 520

    """
521 522
    result = utils.RunCmd(["lvchange", "-ay", self.dev_path])
    if result.failed:
523
      _ThrowError("Can't activate lv %s: %s", self.dev_path, result.output)
Iustin Pop's avatar
Iustin Pop committed
524 525 526 527 528 529 530 531

  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.

    """
532
    pass
Iustin Pop's avatar
Iustin Pop committed
533

534 535 536 537 538 539 540 541
  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.

    For logical volumes, sync_percent and estimated_time are always
    None (no recovery in progress, as we don't handle the mirrored LV
542 543
    case). The is_degraded parameter is the inverse of the ldisk
    parameter.
544

545 546 547 548 549
    For the ldisk parameter, we check if the logical volume has the
    'virtual' type, which means it's not backed by existing storage
    anymore (read from it return I/O error). This happens after a
    physical disk failure and subsequent 'vgreduce --removemissing' on
    the volume group.
550

Iustin Pop's avatar
Iustin Pop committed
551 552
    The status was already read in Attach, so we just return it.

553
    @rtype: objects.BlockDevStatus
Iustin Pop's avatar
Iustin Pop committed
554

555
    """
556 557 558 559 560
    if self._degraded:
      ldisk_status = constants.LDS_FAULTY
    else:
      ldisk_status = constants.LDS_OKAY

561 562 563 564 565 566
    return objects.BlockDevStatus(dev_path=self.dev_path,
                                  major=self.major,
                                  minor=self.minor,
                                  sync_percent=None,
                                  estimated_time=None,
                                  is_degraded=self._degraded,
567
                                  ldisk_status=ldisk_status)
568

Iustin Pop's avatar
Iustin Pop committed
569 570 571 572 573 574
  def Open(self, force=False):
    """Make the device ready for I/O.

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

    """
575
    pass
Iustin Pop's avatar
Iustin Pop committed
576 577 578 579 580 581 582

  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.

    """
583
    pass
Iustin Pop's avatar
Iustin Pop committed
584 585 586 587 588 589 590 591

  def Snapshot(self, size):
    """Create a snapshot copy of an lvm block device.

    """
    snap_name = self._lv_name + ".snap"

    # remove existing snapshot if found
Iustin Pop's avatar
Iustin Pop committed
592
    snap = LogicalVolume((self._vg_name, snap_name), None, size)
593
    _IgnoreError(snap.Remove)
Iustin Pop's avatar
Iustin Pop committed
594 595 596

    pvs_info = self.GetPVInfo(self._vg_name)
    if not pvs_info:
597
      _ThrowError("Can't compute PV info for vg %s", self._vg_name)
Iustin Pop's avatar
Iustin Pop committed
598 599 600 601
    pvs_info.sort()
    pvs_info.reverse()
    free_size, pv_name = pvs_info[0]
    if free_size < size:
602 603
      _ThrowError("Not enough free space: required %s,"
                  " available %s", size, free_size)
Iustin Pop's avatar
Iustin Pop committed
604 605 606 607

    result = utils.RunCmd(["lvcreate", "-L%dm" % size, "-s",
                           "-n%s" % snap_name, self.dev_path])
    if result.failed:
608 609
      _ThrowError("command: %s error: %s - %s",
                  result.cmd, result.fail_reason, result.output)
Iustin Pop's avatar
Iustin Pop committed
610 611 612

    return snap_name

613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628
  def SetInfo(self, text):
    """Update metadata with info text.

    """
    BlockDev.SetInfo(self, 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]

    result = utils.RunCmd(["lvchange", "--addtag", text,
                           self.dev_path])
    if result.failed:
629 630 631
      _ThrowError("Command: %s error: %s - %s", result.cmd, result.fail_reason,
                  result.output)

632 633 634 635
  def Grow(self, amount):
    """Grow the logical volume.

    """
636 637 638 639 640 641 642
    if self.pe_size is None or self.stripe_count is None:
      if not self.Attach():
        _ThrowError("Can't attach to LV during Grow()")
    full_stripe_size = self.pe_size * self.stripe_count
    rest = amount % full_stripe_size
    if rest != 0:
      amount += full_stripe_size - rest
643 644 645 646 647 648 649 650 651
    # 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])
      if not result.failed:
        return
652
    _ThrowError("Can't grow LV %s: %s", self.dev_path, result.output)
653 654


655 656 657 658 659 660
class DRBD8Status(object):
  """A DRBD status representation class.

  Note that this doesn't support unconfigured devices (cs:Unconfigured).

  """
661
  UNCONF_RE = re.compile(r"\s*[0-9]+:\s*cs:Unconfigured$")
Iustin Pop's avatar
Iustin Pop committed
662
  LINE_RE = re.compile(r"\s*[0-9]+:\s*cs:(\S+)\s+(?:st|ro):([^/]+)/(\S+)"
663 664 665 666
                       "\s+ds:([^/]+)/(\S+)\s+.*$")
  SYNC_RE = re.compile(r"^.*\ssync'ed:\s*([0-9.]+)%.*"
                       "\sfinish: ([0-9]+):([0-9]+):([0-9]+)\s.*$")

667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707
  CS_UNCONFIGURED = "Unconfigured"
  CS_STANDALONE = "StandAlone"
  CS_WFCONNECTION = "WFConnection"
  CS_WFREPORTPARAMS = "WFReportParams"
  CS_CONNECTED = "Connected"
  CS_STARTINGSYNCS = "StartingSyncS"
  CS_STARTINGSYNCT = "StartingSyncT"
  CS_WFBITMAPS = "WFBitMapS"
  CS_WFBITMAPT = "WFBitMapT"
  CS_WFSYNCUUID = "WFSyncUUID"
  CS_SYNCSOURCE = "SyncSource"
  CS_SYNCTARGET = "SyncTarget"
  CS_PAUSEDSYNCS = "PausedSyncS"
  CS_PAUSEDSYNCT = "PausedSyncT"
  CSET_SYNC = frozenset([
    CS_WFREPORTPARAMS,
    CS_STARTINGSYNCS,
    CS_STARTINGSYNCT,
    CS_WFBITMAPS,
    CS_WFBITMAPT,
    CS_WFSYNCUUID,
    CS_SYNCSOURCE,
    CS_SYNCTARGET,
    CS_PAUSEDSYNCS,
    CS_PAUSEDSYNCT,
    ])

  DS_DISKLESS = "Diskless"
  DS_ATTACHING = "Attaching" # transient state
  DS_FAILED = "Failed" # transient state, next: diskless
  DS_NEGOTIATING = "Negotiating" # transient state
  DS_INCONSISTENT = "Inconsistent" # while syncing or after creation
  DS_OUTDATED = "Outdated"
  DS_DUNKNOWN = "DUnknown" # shown for peer disk when not connected
  DS_CONSISTENT = "Consistent"
  DS_UPTODATE = "UpToDate" # normal state

  RO_PRIMARY = "Primary"
  RO_SECONDARY = "Secondary"
  RO_UNKNOWN = "Unknown"

708
  def __init__(self, procline):
709 710
    u = self.UNCONF_RE.match(procline)
    if u:
711
      self.cstatus = self.CS_UNCONFIGURED
712 713 714 715 716 717 718 719 720 721 722 723
      self.lrole = self.rrole = self.ldisk = self.rdisk = None
    else:
      m = self.LINE_RE.match(procline)
      if not m:
        raise errors.BlockDeviceError("Can't parse input data '%s'" % procline)
      self.cstatus = m.group(1)
      self.lrole = m.group(2)
      self.rrole = m.group(3)
      self.ldisk = m.group(4)
      self.rdisk = m.group(5)

    # end reading of data from the LINE_RE or UNCONF_RE
724

725 726 727 728 729 730 731
    self.is_standalone = self.cstatus == self.CS_STANDALONE
    self.is_wfconn = self.cstatus == self.CS_WFCONNECTION
    self.is_connected = self.cstatus == self.CS_CONNECTED
    self.is_primary = self.lrole == self.RO_PRIMARY
    self.is_secondary = self.lrole == self.RO_SECONDARY
    self.peer_primary = self.rrole == self.RO_PRIMARY
    self.peer_secondary = self.rrole == self.RO_SECONDARY
732 733 734
    self.both_primary = self.is_primary and self.peer_primary
    self.both_secondary = self.is_secondary and self.peer_secondary

735 736
    self.is_diskless = self.ldisk == self.DS_DISKLESS
    self.is_disk_uptodate = self.ldisk == self.DS_UPTODATE
737

738 739
    self.is_in_resync = self.cstatus in self.CSET_SYNC
    self.is_in_use = self.cstatus != self.CS_UNCONFIGURED
Iustin Pop's avatar
Iustin Pop committed
740

741 742 743 744 745 746 747 748
    m = self.SYNC_RE.match(procline)
    if m:
      self.sync_percent = float(m.group(1))
      hours = int(m.group(2))
      minutes = int(m.group(3))
      seconds = int(m.group(4))
      self.est_time = hours * 3600 + minutes * 60 + seconds
    else:
749 750 751 752 753 754 755 756
      # we have (in this if branch) no percent information, but if
      # we're resyncing we need to 'fake' a sync percent information,
      # as this is how cmdlib determines if it makes sense to wait for
      # resyncing or not
      if self.is_in_resync:
        self.sync_percent = 0
      else:
        self.sync_percent = None
757 758 759
      self.est_time = None


760 761
class BaseDRBD(BlockDev):
  """Base DRBD class.
Iustin Pop's avatar
Iustin Pop committed
762

763 764 765
  This class contains a few bits of common functionality between the
  0.7 and 8.x versions of DRBD.

766 767 768
  """
  _VERSION_RE = re.compile(r"^version: (\d+)\.(\d+)\.(\d+)"
                           r" \(api:(\d+)/proto:(\d+)(?:-(\d+))?\)")
Iustin Pop's avatar
Iustin Pop committed
769

770 771 772 773
  _DRBD_MAJOR = 147
  _ST_UNCONFIGURED = "Unconfigured"
  _ST_WFCONNECTION = "WFConnection"
  _ST_CONNECTED = "Connected"
Iustin Pop's avatar
Iustin Pop committed
774

775 776
  _STATUS_FILE = "/proc/drbd"

777
  @staticmethod
778
  def _GetProcData(filename=_STATUS_FILE):
779
    """Return data from /proc/drbd.
Iustin Pop's avatar
Iustin Pop committed
780 781

    """
782
    try:
783 784 785 786 787 788 789 790 791 792 793
      stat = open(filename, "r")
      try:
        data = stat.read().splitlines()
      finally:
        stat.close()
    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 the DRBD proc file %s: %s", filename, str(err))
794
    if not data:
795
      _ThrowError("Can't read any data from %s", filename)
796
    return data
Iustin Pop's avatar
Iustin Pop committed
797

798 799 800
  @staticmethod
  def _MassageProcData(data):
    """Transform the output of _GetProdData into a nicer form.
Iustin Pop's avatar
Iustin Pop committed
801

Iustin Pop's avatar
Iustin Pop committed
802 803
    @return: a dictionary of minor: joined lines from /proc/drbd
        for that minor
Iustin Pop's avatar
Iustin Pop committed
804 805

    """
806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822
    lmatch = re.compile("^ *([0-9]+):.*$")
    results = {}
    old_minor = old_line = None
    for line in data:
      lresult = lmatch.match(line)
      if lresult is not None:
        if old_minor is not None:
          results[old_minor] = old_line
        old_minor = int(lresult.group(1))
        old_line = line
      else:
        if old_minor is not None:
          old_line += " " + line.strip()
    # add last line
    if old_minor is not None:
      results[old_minor] = old_line
    return results
Iustin Pop's avatar
Iustin Pop committed
823

824 825 826
  @classmethod
  def _GetVersion(cls):
    """Return the DRBD version.
Iustin Pop's avatar
Iustin Pop committed
827

828
    This will return a dict with keys:
Iustin Pop's avatar
Iustin Pop committed
829 830 831 832 833 834
      - k_major
      - k_minor
      - k_point
      - api
      - proto
      - proto2 (only on drbd > 8.2.X)
Iustin Pop's avatar
Iustin Pop committed
835 836

    """
837 838 839 840 841 842
    proc_data = cls._GetProcData()
    first_line = proc_data[0].strip()
    version = cls._VERSION_RE.match(first_line)
    if not version:
      raise errors.BlockDeviceError("Can't parse DRBD version from '%s'" %
                                    first_line)
Iustin Pop's avatar
Iustin Pop committed
843

844 845 846 847 848 849 850 851 852
    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]),
             }
    if values[5] is not None:
      retval['proto2'] = values[5]
Iustin Pop's avatar
Iustin Pop committed
853

854 855 856 857 858
    return retval

  @staticmethod
  def _DevPath(minor):
    """Return the path to a drbd device for a given minor.
Iustin Pop's avatar
Iustin Pop committed
859 860

    """
861
    return "/dev/drbd%d" % minor
Iustin Pop's avatar
Iustin Pop committed
862

863
  @classmethod
864
  def GetUsedDevs(cls):
865
    """Compute the list of used DRBD devices.
Iustin Pop's avatar
Iustin Pop committed
866 867

    """
868
    data = cls._GetProcData()
Iustin Pop's avatar
Iustin Pop committed
869

870 871 872 873 874 875 876 877 878 879 880
    used_devs = {}
    valid_line = re.compile("^ *([0-9]+): cs:([^ ]+).*$")
    for line in data:
      match = valid_line.match(line)
      if not match:
        continue
      minor = int(match.group(1))
      state = match.group(2)
      if state == cls._ST_UNCONFIGURED:
        continue
      used_devs[minor] = state, line
Iustin Pop's avatar
Iustin Pop committed
881

882
    return used_devs
Iustin Pop's avatar
Iustin Pop committed
883

884 885
  def _SetFromMinor(self, minor):
    """Set our parameters based on the given minor.
886

887
    This sets our minor variable and our dev_path.
Iustin Pop's avatar
Iustin Pop committed
888 889

    """
890 891
    if minor is None:
      self.minor = self.dev_path = None
892
      self.attached = False
Iustin Pop's avatar
Iustin Pop committed
893
    else:
894 895
      self.minor = minor
      self.dev_path = self._DevPath(minor)
896
      self.attached = True
Iustin Pop's avatar
Iustin Pop committed
897 898

  @staticmethod
899 900
  def _CheckMetaSize(meta_device):
    """Check if the given meta device looks like a valid one.
Iustin Pop's avatar
Iustin Pop committed
901

902 903
    This currently only check the size, which must be around
    128MiB.
Iustin Pop's avatar
Iustin Pop committed
904 905

    """
906 907
    result = utils.RunCmd(["blockdev", "--getsize", meta_device])
    if result.failed:
Iustin Pop's avatar
Iustin Pop committed
908 909
      _ThrowError("Failed to get device size: %s - %s",
                  result.fail_reason, result.output)
Iustin Pop's avatar
Iustin Pop committed
910
    try:
911 912
      sectors = int(result.stdout)
    except ValueError:
Iustin Pop's avatar
Iustin Pop committed
913
      _ThrowError("Invalid output from blockdev: '%s'", result.stdout)
914 915
    bytes = sectors * 512
    if bytes < 128 * 1024 * 1024: # less than 128MiB
Iustin Pop's avatar
Iustin Pop committed
916
      _ThrowError("Meta device too small (%.2fMib)", (bytes / 1024 / 1024))
917 918 919 920 921 922 923
    # 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:
Iustin Pop's avatar
Iustin Pop committed
924
      _ThrowError("Meta device too big (%.2fMiB)", (bytes / 1024 / 1024))
Iustin Pop's avatar
Iustin Pop committed
925

926 927
  def Rename(self, new_id):
    """Rename a device.
Iustin Pop's avatar
Iustin Pop committed
928

929
    This is not supported for drbd devices.
Iustin Pop's avatar
Iustin Pop committed
930 931

    """
932
    raise errors.ProgrammerError("Can't rename a drbd device")
Iustin Pop's avatar
Iustin Pop committed
933

Iustin Pop's avatar
Iustin Pop committed
934

935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950
class DRBD8(BaseDRBD):
  """DRBD v8.x block device.

  This implements the local host part of the DRBD device, i.e. it
  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.

  """
  _MAX_MINORS = 255
  _PARSE_SHOW = None

951 952 953
  # timeout constants
  _NET_RECONFIG_TIMEOUT = 60

Iustin Pop's avatar
Iustin Pop committed
954
  def __init__(self, unique_id, children, size):
955 956
    if children and children.count(None) > 0:
      children = []
Iustin Pop's avatar
Iustin Pop committed
957
    super(DRBD8, self).__init__(unique_id, children, size)
958
    self.major = self._DRBD_MAJOR
959 960
    version = self._GetVersion()
    if version['k_major'] != 8 :
961 962 963
      _ThrowError("Mismatch in DRBD kernel version and requested ganeti"
                  " usage: kernel is %s.%s, ganeti wants 8.x",
                  version['k_major'], version['k_minor'])
964

965
    if len(children) not in (0, 2):
966
      raise ValueError("Invalid configuration data %s" % str(children))
967
    if not isinstance(unique_id, (tuple, list)) or len(unique_id) != 6:
968
      raise ValueError("Invalid configuration data %s" % str(unique_id))
969 970
    (self._lhost, self._lport,
     self._rhost, self._rport,
971
     self._aminor, self._secret) = unique_id
972 973 974 975
    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" %
                       (unique_id,))
976 977 978 979 980 981 982 983 984 985 986 987
    self.Attach()

  @classmethod
  def _InitMeta(cls, minor, dev_path):
    """Initialize a meta device.

    This will not work if the given minor is in use.

    """
    result = utils.RunCmd(["drbdmeta", "--force", cls._DevPath(minor),
                           "v08", dev_path, "0", "create-md"])
    if result.failed:
988
      _ThrowError("Can't initialize meta device: %s", result.output)
989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013

  @classmethod
  def _FindUnusedMinor(cls):
    """Find an unused DRBD device.

    This is specific to 8.x as the minors are allocated dynamically,
    so non-existing numbers up to a max minor count are actually free.

    """
    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)
      if match:
        return int(match.group(1))
      match = used_line.match(line)
      if match:
        minor = int(match.group(1))
        highest = max(highest, minor)
    if highest is None: # there are no minors in use at all
      return 0
    if highest >= cls._MAX_MINORS:
1014
      logging.error("Error: no free drbd minors!")
1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033
      raise errors.BlockDeviceError("Can't find a free DRBD minor")
    return highest + 1

  @classmethod
  def _GetShowParser(cls):
    """Return a parser for `drbd show` output.

    This will either create or return an already-create parser for the
    output of the command `drbd show`.

    """
    if cls._PARSE_SHOW is not None:
      return cls._PARSE_SHOW

    # pyparsing setup
    lbrace = pyp.Literal("{").suppress()
    rbrace = pyp.Literal("}").suppress()
    semi = pyp.Literal(";").suppress()
    # this also converts the value to an int
1034
    number = pyp.Word(pyp.nums).setParseAction(lambda s, l, t: int(t[0]))
1035 1036 1037 1038 1039 1040 1041 1042 1043 1044

    comment = pyp.Literal ("#") + pyp.Optional(pyp.restOfLine)
    defa = pyp.Literal("_is_default").suppress()
    dbl_quote = pyp.Literal('"').suppress()

    keyword = pyp.Word(pyp.alphanums + '-')

    # value types
    value = pyp.Word(pyp.alphanums + '_-/.:')
    quoted = dbl_quote + pyp.CharsNotIn('"') + dbl_quote
Karsten Keil's avatar
Karsten Keil committed
1045 1046 1047 1048
    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)
1049 1050 1051
    # meta device, extended syntax
    meta_value = ((value ^ quoted) + pyp.Literal('[').suppress() +
                  number + pyp.Word(']').suppress())
Iustin Pop's avatar
Iustin Pop committed
1052 1053
    # device name, extended syntax
    device_value = pyp.Literal("minor").suppress() + number
1054 1055 1056

    # a statement
    stmt = (~rbrace + keyword + ~lbrace +
Iustin Pop's avatar
Iustin Pop committed
1057 1058
            pyp.Optional(addr_port ^ value ^ quoted ^ meta_value ^
                         device_value) +
1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073
            pyp.Optional(defa) + semi +
            pyp.Optional(pyp.restOfLine).suppress())

    # an entire section
    section_name = pyp.Word(pyp.alphas + '_')
    section = section_name + lbrace + pyp.ZeroOrMore(pyp.Group(stmt)) + rbrace

    bnf = pyp.ZeroOrMore(pyp.Group(section ^ stmt))
    bnf.ignore(comment)

    cls._PARSE_SHOW = bnf

    return bnf

  @classmethod
1074 1075
  def _GetShowData(cls, minor):
    """Return the `drbdsetup show` data for a minor.
1076 1077 1078 1079

    """
    result = utils.RunCmd(["drbdsetup", cls._DevPath(minor), "show"])
    if result.failed:
1080 1081
      logging.error("Can't display the drbd config: %s - %s",
                    result.fail_reason, result.output)
1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095
      return None
    return result.stdout

  @classmethod
  def _GetDevInfo(cls, out):
    """Parse details about a given DRBD minor.

    This return, if available, the local backing device (as a path)
    and the local and remote (ip, port) information from a string
    containing the output of the `drbdsetup show` command as returned
    by _GetShowData.

    """
    data = {}
1096 1097 1098 1099 1100 1101 1102 1103 1104
    if not out:
      return data

    bnf = cls._GetShowParser()
    # run pyparse

    try:
      results = bnf.parseString(out)
    except pyp.ParseException, err:
1105
      _ThrowError("Can't parse drbdsetup show output: %s", str(err))
1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133

    # and massage the results into our desired format
    for section in results:
      sname = section[0]
      if sname == "_this_host":
        for lst in section[1:]:
          if lst[0] == "disk":
            data["local_dev"] = lst[1]
          elif lst[0] == "meta-disk":
            data["meta_dev"] = lst[1]
            data["meta_index"] = lst[2]
          elif lst[0] == "address":
            data["local_addr"] = tuple(lst[1:])
      elif sname == "_remote_host":
        for lst in section[1:]:
          if lst[0] == "address":
            data["remote_addr"] = tuple(lst[1:])
    return data

  def _MatchesLocal(self, info):
    """Test if our local config matches with an existing device.

    The parameter should be as returned from `_GetDevInfo()`. This
    method tests if our local backing device is the same as the one in
    the info parameter, in effect testing if we look like the given
    device.

    """
1134 1135 1136 1137 1138
    if self._children:
      backend, meta = self._children
    else:
      backend = meta = None

1139
    if backend is not None:
1140
      retval = ("local_dev" in info and info["local_dev"] == backend.dev_path)
1141 1142
    else:
      retval = ("local_dev" not in info)
1143

1144
    if meta is not None:
1145 1146 1147 1148
      retval = retval and ("meta_dev" in info and
                           info["meta_dev"] == meta.dev_path)
      retval = retval and ("meta_index" in info and
                           info["meta_index"] == 0)
1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164