bdev.py 55.6 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
Iustin Pop's avatar
Iustin Pop committed
34 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
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
68 69 70 71 72 73 74 75 76 77
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
78 79 80
  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
81 82 83 84 85 86 87 88 89 90 91 92 93 94
  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
95 96 97
  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
98 99 100

  You can get to a device in two ways:
    - creating the (real) device, which returns you
101
      an attached instance (lvcreate)
Iustin Pop's avatar
Iustin Pop committed
102 103 104 105 106 107 108 109 110
    - 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
111
  def __init__(self, unique_id, children, size):
Iustin Pop's avatar
Iustin Pop committed
112 113 114 115 116
    self._children = children
    self.dev_path = None
    self.unique_id = unique_id
    self.major = None
    self.minor = None
117
    self.attached = False
Iustin Pop's avatar
Iustin Pop committed
118
    self.size = size
Iustin Pop's avatar
Iustin Pop committed
119 120 121 122

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

123 124 125 126 127 128 129
    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
130 131

    """
132
    pass
Iustin Pop's avatar
Iustin Pop committed
133 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

  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.

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

    """
    raise NotImplementedError

Iustin Pop's avatar
Iustin Pop committed
170 171 172 173 174 175 176 177
  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
178 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
  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.

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

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

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

227 228 229 230
    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).

Iustin Pop's avatar
Iustin Pop committed
231 232 233
    @rtype: tuple
    @return: (sync_percent, estimated_time, is_degraded, ldisk)

Iustin Pop's avatar
Iustin Pop committed
234
    """
235
    return None, None, False, False
Iustin Pop's avatar
Iustin Pop committed
236 237 238 239 240 241 242 243 244 245


  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.

    """
246
    min_percent, max_time, is_degraded, ldisk = self.GetSyncStatus()
Iustin Pop's avatar
Iustin Pop committed
247 248
    if self._children:
      for child in self._children:
249
        c_percent, c_time, c_degraded, c_ldisk = child.GetSyncStatus()
Iustin Pop's avatar
Iustin Pop committed
250 251 252 253 254 255 256 257 258
        if min_percent is None:
          min_percent = c_percent
        elif c_percent is not None:
          min_percent = min(min_percent, c_percent)
        if max_time is None:
          max_time = c_time
        elif c_time is not None:
          max_time = max(max_time, c_time)
        is_degraded = is_degraded or c_degraded
259 260
        ldisk = ldisk or c_ldisk
    return min_percent, max_time, is_degraded, ldisk
Iustin Pop's avatar
Iustin Pop committed
261 262


263 264 265 266 267 268 269 270 271
  def SetInfo(self, text):
    """Update metadata with info text.

    Only supported for some device types.

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

272 273 274
  def Grow(self, amount):
    """Grow the block device.

Iustin Pop's avatar
Iustin Pop committed
275
    @param amount: the amount (in mebibytes) to grow with
276 277 278

    """
    raise NotImplementedError
279

Iustin Pop's avatar
Iustin Pop committed
280 281 282 283 284 285 286 287 288 289
  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
290
  def __init__(self, unique_id, children, size):
Iustin Pop's avatar
Iustin Pop committed
291 292 293 294 295
    """Attaches to a LV device.

    The unique_id is a tuple (vg_name, lv_name)

    """
Iustin Pop's avatar
Iustin Pop committed
296
    super(LogicalVolume, self).__init__(unique_id, children, size)
Iustin Pop's avatar
Iustin Pop committed
297 298 299 300
    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
301 302
    self._degraded = True
    self.major = self.minor = None
Iustin Pop's avatar
Iustin Pop committed
303 304 305 306 307 308 309 310
    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
311 312
      raise errors.ProgrammerError("Invalid configuration data %s" %
                                   str(unique_id))
Iustin Pop's avatar
Iustin Pop committed
313 314 315
    vg_name, lv_name = unique_id
    pvs_info = cls.GetPVInfo(vg_name)
    if not pvs_info:
316
      _ThrowError("Can't compute PV info for vg %s", vg_name)
Iustin Pop's avatar
Iustin Pop committed
317 318
    pvs_info.sort()
    pvs_info.reverse()
319 320 321

    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
322 323
    current_pvs = len(pvlist)
    stripes = min(current_pvs, constants.LVM_STRIPECOUNT)
324 325 326

    # The size constraint should have been checked from the master before
    # calling the create function.
Iustin Pop's avatar
Iustin Pop committed
327
    if free_size < size:
328 329
      _ThrowError("Not enough free space: required %s,"
                  " available %s", size, free_size)
Iustin Pop's avatar
Iustin Pop committed
330 331 332 333 334 335 336 337 338
    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
339
    if result.failed:
340 341
      _ThrowError("LV create failed (%s): %s",
                  result.fail_reason, result.output)
Iustin Pop's avatar
Iustin Pop committed
342
    return LogicalVolume(unique_id, children, size)
Iustin Pop's avatar
Iustin Pop committed
343 344 345 346 347

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

Iustin Pop's avatar
Iustin Pop committed
348
    @param vg_name: the volume group name
Iustin Pop's avatar
Iustin Pop committed
349

Iustin Pop's avatar
Iustin Pop committed
350 351
    @rtype: list
    @return: list of tuples (free_space, name) with free_space in mebibytes
352

Iustin Pop's avatar
Iustin Pop committed
353 354 355 356 357 358
    """
    command = ["pvs", "--noheadings", "--nosuffix", "--units=m",
               "-opv_name,vg_name,pv_free,pv_attr", "--unbuffered",
               "--separator=:"]
    result = utils.RunCmd(command)
    if result.failed:
359 360
      logging.error("Can't get the PV information: %s - %s",
                    result.fail_reason, result.output)
Iustin Pop's avatar
Iustin Pop committed
361 362 363 364 365
      return None
    data = []
    for line in result.stdout.splitlines():
      fields = line.strip().split(':')
      if len(fields) != 4:
366
        logging.error("Can't parse pvs output: line '%s'", line)
Iustin Pop's avatar
Iustin Pop committed
367 368 369 370 371 372 373 374 375 376 377 378 379 380
        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
381
      return
Iustin Pop's avatar
Iustin Pop committed
382 383 384
    result = utils.RunCmd(["lvremove", "-f", "%s/%s" %
                           (self._vg_name, self._lv_name)])
    if result.failed:
385
      _ThrowError("Can't lvremove: %s - %s", result.fail_reason, result.output)
Iustin Pop's avatar
Iustin Pop committed
386

Iustin Pop's avatar
Iustin Pop committed
387 388 389 390 391 392 393 394 395 396 397 398 399
  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:
400
      _ThrowError("Failed to rename the logical volume: %s", result.output)
401 402 403
    self._lv_name = new_name
    self.dev_path = "/dev/%s/%s" % (self._vg_name, self._lv_name)

Iustin Pop's avatar
Iustin Pop committed
404 405 406 407
  def Attach(self):
    """Attach to an existing LV.

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

    """
412
    self.attached = False
Iustin Pop's avatar
Iustin Pop committed
413 414 415
    result = utils.RunCmd(["lvs", "--noheadings", "--separator=,",
                           "-olv_attr,lv_kernel_major,lv_kernel_minor",
                           self.dev_path])
Iustin Pop's avatar
Iustin Pop committed
416
    if result.failed:
417 418
      logging.error("Can't find LV %s: %s, %s",
                    self.dev_path, result.fail_reason, result.output)
Iustin Pop's avatar
Iustin Pop committed
419
      return False
Iustin Pop's avatar
Iustin Pop committed
420 421 422
    out = result.stdout.strip().rstrip(',')
    out = out.split(",")
    if len(out) != 3:
423
      logging.error("Can't parse LVS output, len(%s) != 3", str(out))
Iustin Pop's avatar
Iustin Pop committed
424 425 426 427
      return False

    status, major, minor = out[:3]
    if len(status) != 6:
428
      logging.error("lvs lv_attr is not 6 characters (%s)", status)
Iustin Pop's avatar
Iustin Pop committed
429 430 431 432 433 434
      return False

    try:
      major = int(major)
      minor = int(minor)
    except ValueError, err:
435
      logging.error("lvs major/minor cannot be parsed: %s", str(err))
Iustin Pop's avatar
Iustin Pop committed
436 437 438 439 440

    self.major = major
    self.minor = minor
    self._degraded = status[0] == 'v' # virtual volume, i.e. doesn't backing
                                      # storage
441
    self.attached = True
Iustin Pop's avatar
Iustin Pop committed
442
    return True
Iustin Pop's avatar
Iustin Pop committed
443 444 445 446

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

447 448 449
    We alway run `lvchange -ay` on the LV to ensure it's active before
    use, as there were cases when xenvg was not active after boot
    (also possibly after disk issues).
Iustin Pop's avatar
Iustin Pop committed
450 451

    """
452 453
    result = utils.RunCmd(["lvchange", "-ay", self.dev_path])
    if result.failed:
454
      _ThrowError("Can't activate lv %s: %s", self.dev_path, result.output)
Iustin Pop's avatar
Iustin Pop committed
455 456 457 458 459 460 461 462

  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.

    """
463
    pass
Iustin Pop's avatar
Iustin Pop committed
464

465 466 467 468 469 470 471 472
  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
473 474
    case). The is_degraded parameter is the inverse of the ldisk
    parameter.
475

476 477 478 479 480
    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.
481

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

Iustin Pop's avatar
Iustin Pop committed
484 485 486
    @rtype: tuple
    @return: (sync_percent, estimated_time, is_degraded, ldisk)

487
    """
Iustin Pop's avatar
Iustin Pop committed
488
    return None, None, self._degraded, self._degraded
489

Iustin Pop's avatar
Iustin Pop committed
490 491 492 493 494 495
  def Open(self, force=False):
    """Make the device ready for I/O.

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

    """
496
    pass
Iustin Pop's avatar
Iustin Pop committed
497 498 499 500 501 502 503

  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.

    """
504
    pass
Iustin Pop's avatar
Iustin Pop committed
505 506 507 508 509 510 511 512

  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
513
    snap = LogicalVolume((self._vg_name, snap_name), None, size)
514
    _IgnoreError(snap.Remove)
Iustin Pop's avatar
Iustin Pop committed
515 516 517

    pvs_info = self.GetPVInfo(self._vg_name)
    if not pvs_info:
518
      _ThrowError("Can't compute PV info for vg %s", self._vg_name)
Iustin Pop's avatar
Iustin Pop committed
519 520 521 522
    pvs_info.sort()
    pvs_info.reverse()
    free_size, pv_name = pvs_info[0]
    if free_size < size:
523 524
      _ThrowError("Not enough free space: required %s,"
                  " available %s", size, free_size)
Iustin Pop's avatar
Iustin Pop committed
525 526 527 528

    result = utils.RunCmd(["lvcreate", "-L%dm" % size, "-s",
                           "-n%s" % snap_name, self.dev_path])
    if result.failed:
529 530
      _ThrowError("command: %s error: %s - %s",
                  result.cmd, result.fail_reason, result.output)
Iustin Pop's avatar
Iustin Pop committed
531 532 533

    return snap_name

534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549
  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:
550 551 552
      _ThrowError("Command: %s error: %s - %s", result.cmd, result.fail_reason,
                  result.output)

553 554 555 556 557 558 559 560 561 562 563 564 565
  def Grow(self, amount):
    """Grow the logical volume.

    """
    # 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
566
    _ThrowError("Can't grow LV %s: %s", self.dev_path, result.output)
567 568


569 570 571 572 573 574
class DRBD8Status(object):
  """A DRBD status representation class.

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

  """
575
  UNCONF_RE = re.compile(r"\s*[0-9]+:\s*cs:Unconfigured$")
Iustin Pop's avatar
Iustin Pop committed
576
  LINE_RE = re.compile(r"\s*[0-9]+:\s*cs:(\S+)\s+(?:st|ro):([^/]+)/(\S+)"
577 578 579 580
                       "\s+ds:([^/]+)/(\S+)\s+.*$")
  SYNC_RE = re.compile(r"^.*\ssync'ed:\s*([0-9.]+)%.*"
                       "\sfinish: ([0-9]+):([0-9]+):([0-9]+)\s.*$")

581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621
  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"

622
  def __init__(self, procline):
623 624
    u = self.UNCONF_RE.match(procline)
    if u:
625
      self.cstatus = self.CS_UNCONFIGURED
626 627 628 629 630 631 632 633 634 635 636 637
      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
638

639 640 641 642 643 644 645
    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
646 647 648
    self.both_primary = self.is_primary and self.peer_primary
    self.both_secondary = self.is_secondary and self.peer_secondary

649 650
    self.is_diskless = self.ldisk == self.DS_DISKLESS
    self.is_disk_uptodate = self.ldisk == self.DS_UPTODATE
651

652 653
    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
654

655 656 657 658 659 660 661 662
    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:
663 664 665 666 667 668 669 670
      # 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
671 672 673
      self.est_time = None


674 675
class BaseDRBD(BlockDev):
  """Base DRBD class.
Iustin Pop's avatar
Iustin Pop committed
676

677 678 679
  This class contains a few bits of common functionality between the
  0.7 and 8.x versions of DRBD.

680 681 682
  """
  _VERSION_RE = re.compile(r"^version: (\d+)\.(\d+)\.(\d+)"
                           r" \(api:(\d+)/proto:(\d+)(?:-(\d+))?\)")
Iustin Pop's avatar
Iustin Pop committed
683

684 685 686 687
  _DRBD_MAJOR = 147
  _ST_UNCONFIGURED = "Unconfigured"
  _ST_WFCONNECTION = "WFConnection"
  _ST_CONNECTED = "Connected"
Iustin Pop's avatar
Iustin Pop committed
688

689 690
  _STATUS_FILE = "/proc/drbd"

691
  @staticmethod
692
  def _GetProcData(filename=_STATUS_FILE):
693
    """Return data from /proc/drbd.
Iustin Pop's avatar
Iustin Pop committed
694 695

    """
696
    try:
697 698 699 700 701 702 703 704 705 706 707
      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))
708
    if not data:
709
      _ThrowError("Can't read any data from %s", filename)
710
    return data
Iustin Pop's avatar
Iustin Pop committed
711

712 713 714
  @staticmethod
  def _MassageProcData(data):
    """Transform the output of _GetProdData into a nicer form.
Iustin Pop's avatar
Iustin Pop committed
715

Iustin Pop's avatar
Iustin Pop committed
716 717
    @return: a dictionary of minor: joined lines from /proc/drbd
        for that minor
Iustin Pop's avatar
Iustin Pop committed
718 719

    """
720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736
    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
737

738 739 740
  @classmethod
  def _GetVersion(cls):
    """Return the DRBD version.
Iustin Pop's avatar
Iustin Pop committed
741

742
    This will return a dict with keys:
Iustin Pop's avatar
Iustin Pop committed
743 744 745 746 747 748
      - k_major
      - k_minor
      - k_point
      - api
      - proto
      - proto2 (only on drbd > 8.2.X)
Iustin Pop's avatar
Iustin Pop committed
749 750

    """
751 752 753 754 755 756
    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
757

758 759 760 761 762 763 764 765 766
    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
767

768 769 770 771 772
    return retval

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

    """
775
    return "/dev/drbd%d" % minor
Iustin Pop's avatar
Iustin Pop committed
776

777
  @classmethod
778
  def GetUsedDevs(cls):
779
    """Compute the list of used DRBD devices.
Iustin Pop's avatar
Iustin Pop committed
780 781

    """
782
    data = cls._GetProcData()
Iustin Pop's avatar
Iustin Pop committed
783

784 785 786 787 788 789 790 791 792 793 794
    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
795

796
    return used_devs
Iustin Pop's avatar
Iustin Pop committed
797

798 799
  def _SetFromMinor(self, minor):
    """Set our parameters based on the given minor.
800

801
    This sets our minor variable and our dev_path.
Iustin Pop's avatar
Iustin Pop committed
802 803

    """
804 805
    if minor is None:
      self.minor = self.dev_path = None
806
      self.attached = False
Iustin Pop's avatar
Iustin Pop committed
807
    else:
808 809
      self.minor = minor
      self.dev_path = self._DevPath(minor)
810
      self.attached = True
Iustin Pop's avatar
Iustin Pop committed
811 812

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

816 817
    This currently only check the size, which must be around
    128MiB.
Iustin Pop's avatar
Iustin Pop committed
818 819

    """
820 821
    result = utils.RunCmd(["blockdev", "--getsize", meta_device])
    if result.failed:
Iustin Pop's avatar
Iustin Pop committed
822 823
      _ThrowError("Failed to get device size: %s - %s",
                  result.fail_reason, result.output)
Iustin Pop's avatar
Iustin Pop committed
824
    try:
825 826
      sectors = int(result.stdout)
    except ValueError:
Iustin Pop's avatar
Iustin Pop committed
827
      _ThrowError("Invalid output from blockdev: '%s'", result.stdout)
828 829
    bytes = sectors * 512
    if bytes < 128 * 1024 * 1024: # less than 128MiB
Iustin Pop's avatar
Iustin Pop committed
830
      _ThrowError("Meta device too small (%.2fMib)", (bytes / 1024 / 1024))
831 832 833 834 835 836 837
    # 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
838
      _ThrowError("Meta device too big (%.2fMiB)", (bytes / 1024 / 1024))
Iustin Pop's avatar
Iustin Pop committed
839

840 841
  def Rename(self, new_id):
    """Rename a device.
Iustin Pop's avatar
Iustin Pop committed
842

843
    This is not supported for drbd devices.
Iustin Pop's avatar
Iustin Pop committed
844 845

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

Iustin Pop's avatar
Iustin Pop committed
848

849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864
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

865 866 867
  # timeout constants
  _NET_RECONFIG_TIMEOUT = 60

Iustin Pop's avatar
Iustin Pop committed
868
  def __init__(self, unique_id, children, size):
869 870
    if children and children.count(None) > 0:
      children = []
Iustin Pop's avatar
Iustin Pop committed
871
    super(DRBD8, self).__init__(unique_id, children, size)
872
    self.major = self._DRBD_MAJOR
873 874
    version = self._GetVersion()
    if version['k_major'] != 8 :
875 876 877
      _ThrowError("Mismatch in DRBD kernel version and requested ganeti"
                  " usage: kernel is %s.%s, ganeti wants 8.x",
                  version['k_major'], version['k_minor'])
878

879
    if len(children) not in (0, 2):
880
      raise ValueError("Invalid configuration data %s" % str(children))
881
    if not isinstance(unique_id, (tuple, list)) or len(unique_id) != 6:
882
      raise ValueError("Invalid configuration data %s" % str(unique_id))
883 884
    (self._lhost, self._lport,
     self._rhost, self._rport,
885
     self._aminor, self._secret) = unique_id
886 887 888 889
    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,))
890 891 892 893 894 895 896 897 898 899 900 901
    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:
902
      _ThrowError("Can't initialize meta device: %s", result.output)
903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927

  @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:
928
      logging.error("Error: no free drbd minors!")
929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947
      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
948
    number = pyp.Word(pyp.nums).setParseAction(lambda s, l, t: int(t[0]))
949 950 951 952 953 954 955 956 957 958

    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
959 960 961 962
    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)
963 964 965
    # meta device, extended syntax
    meta_value = ((value ^ quoted) + pyp.Literal('[').suppress() +
                  number + pyp.Word(']').suppress())
Iustin Pop's avatar
Iustin Pop committed
966 967
    # device name, extended syntax
    device_value = pyp.Literal("minor").suppress() + number
968 969 970

    # a statement
    stmt = (~rbrace + keyword + ~lbrace +
Iustin Pop's avatar
Iustin Pop committed
971 972
            pyp.Optional(addr_port ^ value ^ quoted ^ meta_value ^
                         device_value) +
973 974 975 976 977 978 979 980 981 982 983 984 985 986 987
            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
988 989
  def _GetShowData(cls, minor):
    """Return the `drbdsetup show` data for a minor.
990 991 992 993

    """
    result = utils.RunCmd(["drbdsetup", cls._DevPath(minor), "show"])
    if result.failed:
994 995
      logging.error("Can't display the drbd config: %s - %s",
                    result.fail_reason, result.output)
996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009
      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 = {}
1010 1011 1012 1013 1014 1015 1016 1017 1018
    if not out:
      return data

    bnf = cls._GetShowParser()
    # run pyparse

    try:
      results = bnf.parseString(out)
    except pyp.ParseException, err:
1019
      _ThrowError("Can't parse drbdsetup show output: %s", str(err))
1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047

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

    """
1048 1049 1050 1051 1052
    if self._children:
      backend, meta = self._children
    else:
      backend = meta = None

1053
    if backend is not None:
1054
      retval = ("local_dev" in info and info["local_dev"] == backend.dev_path)
1055 1056
    else:
      retval = ("local_dev" not in info)
1057

1058
    if meta is not None:
1059 1060 1061 1062
      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)
1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093
    else:
      retval = retval and ("meta_dev" not in info and
                           "meta_index" not in info)
    return retval

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

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

    """
    if (((self._lhost is None and not ("local_addr" in info)) and
         (self._rhost is None and not ("remote_addr" in info)))):
      return True

    if self._lhost is None:
      return False

    if not ("local_addr" in info and
            "remote_addr" in info):
      return False

    retval = (info["local_addr"] == (self._lhost, self._lport))
    retval = (retval and
              info["remote_addr"] == (self._rhost, self._rport))
    return retval

  @classmethod
1094
  def _AssembleLocal(cls, minor, backend, meta, size):
1095 1096 1097
    """Configure the local part of a DRBD device.

    """
1098
    args = ["drbdsetup", cls._DevPath(minor), "disk",
1099 1100 1101 1102
            backend, meta, "0",
            "-d", "%sm" % size,
            "-e", "detach",
            "--create-device"]
1103
    result = utils.RunCmd(args)
1104
    if result.failed:
1105
      _ThrowError("drbd%d: can't attach local disk: %s", minor, result.output)
1106 1107 1108 1109 1110 1111 1112 1113

  @classmethod
  def _AssembleNet(cls, minor, net_info, protocol,
                   dual_pri=False, hmac=None, secret=None):
    """Configure the network part of the device.

    """
    lhost, lport, rhost, rport = net_info
1114 1115 1116
    if None in net_info:
      # we don't want network connection and actually want to make
      # sure its shutdown
1117 1118
      cls._ShutdownNet(minor)
      return
1119

1120 1121 1122 1123 1124 1125 1126 1127
    # Workaround for a race condition. When DRBD is doing its dance to
    # establish a connection with its peer, it also sends the
    # synchronization speed over the wire. In some cases setting the
    # 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)

1128
    args = ["drbdsetup", cls._DevPath(minor), "net",
1129 1130 1131
            "%s:%s" % (lhost, lport), "%s:%s" % (rhost, rport), protocol,
            "-A", "discard-zero-changes",
            "-B", "consensus",
1132
            "--create-device",
1133
            ]
1134 1135 1136 1137 1138 1139
    if dual_pri:
      args.append("-m")
    if hmac and secret:
      args.extend(["-a", hmac, "-x", secret])
    result = utils.RunCmd(args)
    if result.failed:
1140 1141
      _ThrowError("drbd%d: can't setup network: %s - %s",
                  minor, result.fail_reason, result.output)
1142 1143 1144 1145

    timeout = time.time() + 10
    ok = False
    while time.time() < timeout:
1146
      info = cls._GetDevInfo(cls._GetShowData(minor))
1147 1148 1149 1150 1151 1152 1153 1154 1155 1156
      if not "local_addr" in info or not "remote_addr" in info:
        time.sleep(1)
        continue
      if (info["local_addr"] != (lhost, lport) or
          info["remote_addr"] != (rhost, rport)):
        time.sleep(1)
        continue
      ok = True
      break
    if not ok:
1157
      _ThrowError("drbd%d: timeout while configuring network", minor)
1158

1159 1160 1161 1162 1163
  def AddChildren(self, devices):
    """Add a disk to the DRBD device.

    """
    if self.minor is None:
1164 1165
      _ThrowError("drbd%d: can't attach to dbrd8 during AddChildren",
                  self._aminor)
1166
    if len(devices) != 2:
1167
      _ThrowError("drbd%d: need two devices for AddChildren", self.minor)