backend.py 69.7 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
27
28
29
30
31
32
#

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


"""Functions used by the node daemon"""


import os
import os.path
import shutil
import time
import stat
import errno
import re
import subprocess
33
import random
34
import logging
35
import tempfile
36
37
import zlib
import base64
Iustin Pop's avatar
Iustin Pop committed
38
39
40
41
42
43
44
45

from ganeti import errors
from ganeti import utils
from ganeti import ssh
from ganeti import hypervisor
from ganeti import constants
from ganeti import bdev
from ganeti import objects
46
from ganeti import ssconf
Iustin Pop's avatar
Iustin Pop committed
47
48


Michael Hanselmann's avatar
Michael Hanselmann committed
49
def _GetConfig():
Iustin Pop's avatar
Iustin Pop committed
50
  """Simple wrapper to return a SimpleStore.
Iustin Pop's avatar
Iustin Pop committed
51

Iustin Pop's avatar
Iustin Pop committed
52
53
  @rtype: L{ssconf.SimpleStore}
  @return: a SimpleStore instance
Iustin Pop's avatar
Iustin Pop committed
54
55

  """
Iustin Pop's avatar
Iustin Pop committed
56
  return ssconf.SimpleStore()
Michael Hanselmann's avatar
Michael Hanselmann committed
57
58


59
def _GetSshRunner(cluster_name):
Iustin Pop's avatar
Iustin Pop committed
60
61
62
63
64
65
66
67
68
  """Simple wrapper to return an SshRunner.

  @type cluster_name: str
  @param cluster_name: the cluster name, which is needed
      by the SshRunner constructor
  @rtype: L{ssh.SshRunner}
  @return: an SshRunner instance

  """
69
  return ssh.SshRunner(cluster_name)
70
71


72
73
74
75
76
77
78
79
80
def _Decompress(data):
  """Unpacks data compressed by the RPC client.

  @type data: list or tuple
  @param data: Data sent by RPC client
  @rtype: str
  @return: Decompressed data

  """
81
  assert isinstance(data, (list, tuple))
82
83
84
85
86
87
88
89
90
91
  assert len(data) == 2
  (encoding, content) = data
  if encoding == constants.RPC_ENCODING_NONE:
    return content
  elif encoding == constants.RPC_ENCODING_ZLIB_BASE64:
    return zlib.decompress(base64.b64decode(content))
  else:
    raise AssertionError("Unknown data encoding")


92
def _CleanDirectory(path, exclude=None):
93
94
  """Removes all regular files in a directory.

Iustin Pop's avatar
Iustin Pop committed
95
96
  @type path: str
  @param path: the directory to clean
97
  @type exclude: list
Iustin Pop's avatar
Iustin Pop committed
98
99
  @param exclude: list of files to be excluded, defaults
      to the empty list
100
101

  """
102
103
  if not os.path.isdir(path):
    return
104
105
106
107
108
  if exclude is None:
    exclude = []
  else:
    # Normalize excluded paths
    exclude = [os.path.normpath(i) for i in exclude]
109

110
  for rel_name in utils.ListVisibleFiles(path):
111
112
113
    full_name = os.path.normpath(os.path.join(path, rel_name))
    if full_name in exclude:
      continue
114
115
116
117
    if os.path.isfile(full_name) and not os.path.islink(full_name):
      utils.RemoveFile(full_name)


118
def JobQueuePurge():
Iustin Pop's avatar
Iustin Pop committed
119
120
121
  """Removes job queue files and archived jobs.

  @rtype: None
122
123

  """
124
  _CleanDirectory(constants.QUEUE_DIR, exclude=[constants.JOB_QUEUE_LOCK_FILE])
125
126
127
  _CleanDirectory(constants.JOB_QUEUE_ARCHIVE_DIR)


128
129
130
131
132
133
134
def GetMasterInfo():
  """Returns master information.

  This is an utility function to compute master information, either
  for consumption here or from the node daemon.

  @rtype: tuple
Iustin Pop's avatar
Iustin Pop committed
135
136
  @return: (master_netdev, master_ip, master_name) if we have a good
      configuration, otherwise (None, None, None)
137
138
139

  """
  try:
Michael Hanselmann's avatar
Michael Hanselmann committed
140
141
142
143
    cfg = _GetConfig()
    master_netdev = cfg.GetMasterNetdev()
    master_ip = cfg.GetMasterIP()
    master_node = cfg.GetMasterNode()
144
145
  except errors.ConfigurationError, err:
    logging.exception("Cluster configuration incomplete")
Iustin Pop's avatar
Iustin Pop committed
146
    return (None, None, None)
147
  return (master_netdev, master_ip, master_node)
148
149


150
def StartMaster(start_daemons):
Iustin Pop's avatar
Iustin Pop committed
151
152
  """Activate local node as master node.

153
  The function will always try activate the IP address of the master
Iustin Pop's avatar
Iustin Pop committed
154
155
156
157
158
159
160
  (unless someone else has it). It will also start the master daemons,
  based on the start_daemons parameter.

  @type start_daemons: boolean
  @param start_daemons: whther to also start the master
      daemons (ganeti-masterd and ganeti-rapi)
  @rtype: None
Iustin Pop's avatar
Iustin Pop committed
161
162

  """
163
  ok = True
164
  master_netdev, master_ip, _ = GetMasterInfo()
165
  if not master_netdev:
Iustin Pop's avatar
Iustin Pop committed
166
167
    return False

168
  if utils.TcpPing(master_ip, constants.DEFAULT_NODED_PORT):
169
    if utils.OwnIpAddress(master_ip):
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
      # we already have the ip:
      logging.debug("Already started")
    else:
      logging.error("Someone else has the master ip, not activating")
      ok = False
  else:
    result = utils.RunCmd(["ip", "address", "add", "%s/32" % master_ip,
                           "dev", master_netdev, "label",
                           "%s:0" % master_netdev])
    if result.failed:
      logging.error("Can't activate master IP: %s", result.output)
      ok = False

    result = utils.RunCmd(["arping", "-q", "-U", "-c 3", "-I", master_netdev,
                           "-s", master_ip, master_ip])
    # we'll ignore the exit code of arping

  # and now start the master and rapi daemons
  if start_daemons:
    for daemon in 'ganeti-masterd', 'ganeti-rapi':
      result = utils.RunCmd([daemon])
      if result.failed:
        logging.error("Can't start daemon %s: %s", daemon, result.output)
        ok = False
  return ok
Iustin Pop's avatar
Iustin Pop committed
195
196


197
def StopMaster(stop_daemons):
Iustin Pop's avatar
Iustin Pop committed
198
199
  """Deactivate this node as master.

200
  The function will always try to deactivate the IP address of the
Iustin Pop's avatar
Iustin Pop committed
201
202
203
204
205
206
207
  master. It will also stop the master daemons depending on the
  stop_daemons parameter.

  @type stop_daemons: boolean
  @param stop_daemons: whether to also stop the master daemons
      (ganeti-masterd and ganeti-rapi)
  @rtype: None
Iustin Pop's avatar
Iustin Pop committed
208
209

  """
210
  master_netdev, master_ip, _ = GetMasterInfo()
211
212
  if not master_netdev:
    return False
Iustin Pop's avatar
Iustin Pop committed
213

214
215
  result = utils.RunCmd(["ip", "address", "del", "%s/32" % master_ip,
                         "dev", master_netdev])
Iustin Pop's avatar
Iustin Pop committed
216
  if result.failed:
217
    logging.error("Can't remove the master IP, error: %s", result.output)
218
219
220
221
222
223
    # but otherwise ignore the failure

  if stop_daemons:
    # stop/kill the rapi and the master daemon
    for daemon in constants.RAPI_PID, constants.MASTERD_PID:
      utils.KillProcess(utils.ReadPidFile(utils.DaemonPidFileName(daemon)))
Iustin Pop's avatar
Iustin Pop committed
224
225
226
227

  return True


Iustin Pop's avatar
Iustin Pop committed
228
def AddNode(dsa, dsapub, rsa, rsapub, sshkey, sshpub):
229
  """Joins this node to the cluster.
Iustin Pop's avatar
Iustin Pop committed
230

231
232
233
234
  This does the following:
      - updates the hostkeys of the machine (rsa and dsa)
      - adds the ssh private key to the user
      - adds the ssh public key to the users' authorized_keys file
Iustin Pop's avatar
Iustin Pop committed
235

Iustin Pop's avatar
Iustin Pop committed
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
  @type dsa: str
  @param dsa: the DSA private key to write
  @type dsapub: str
  @param dsapub: the DSA public key to write
  @type rsa: str
  @param rsa: the RSA private key to write
  @type rsapub: str
  @param rsapub: the RSA public key to write
  @type sshkey: str
  @param sshkey: the SSH private key to write
  @type sshpub: str
  @param sshpub: the SSH public key to write
  @rtype: boolean
  @return: the success of the operation

251
  """
252
253
254
255
  sshd_keys =  [(constants.SSH_HOST_RSA_PRIV, rsa, 0600),
                (constants.SSH_HOST_RSA_PUB, rsapub, 0644),
                (constants.SSH_HOST_DSA_PRIV, dsa, 0600),
                (constants.SSH_HOST_DSA_PUB, dsapub, 0644)]
256
  for name, content, mode in sshd_keys:
257
    utils.WriteFile(name, data=content, mode=mode)
Iustin Pop's avatar
Iustin Pop committed
258

259
260
261
262
  try:
    priv_key, pub_key, auth_keys = ssh.GetUserFiles(constants.GANETI_RUNAS,
                                                    mkdir=True)
  except errors.OpExecError, err:
263
    logging.exception("Error while processing user ssh files")
264
    return False
Iustin Pop's avatar
Iustin Pop committed
265

266
267
  for name, content in [(priv_key, sshkey), (pub_key, sshpub)]:
    utils.WriteFile(name, data=content, mode=0600)
Iustin Pop's avatar
Iustin Pop committed
268

269
  utils.AddAuthorizedKey(auth_keys, sshpub)
Iustin Pop's avatar
Iustin Pop committed
270

271
  utils.RunCmd([constants.SSH_INITD_SCRIPT, "restart"])
Iustin Pop's avatar
Iustin Pop committed
272
273
274
275
276

  return True


def LeaveCluster():
Iustin Pop's avatar
Iustin Pop committed
277
278
279
280
281
282
  """Cleans up and remove the current node.

  This function cleans up and prepares the current node to be removed
  from the cluster.

  If processing is successful, then it raises an
Iustin Pop's avatar
Iustin Pop committed
283
  L{errors.QuitGanetiException} which is used as a special case to
Iustin Pop's avatar
Iustin Pop committed
284
  shutdown the node daemon.
Iustin Pop's avatar
Iustin Pop committed
285
286

  """
287
  _CleanDirectory(constants.DATA_DIR)
288
  JobQueuePurge()
289

290
291
  try:
    priv_key, pub_key, auth_keys = ssh.GetUserFiles(constants.GANETI_RUNAS)
292
293
  except errors.OpExecError:
    logging.exception("Error while processing ssh files")
294
295
    return

296
  f = open(pub_key, 'r')
Iustin Pop's avatar
Iustin Pop committed
297
  try:
298
    utils.RemoveAuthorizedKey(auth_keys, f.read(8192))
Iustin Pop's avatar
Iustin Pop committed
299
300
301
  finally:
    f.close()

302
303
  utils.RemoveFile(priv_key)
  utils.RemoveFile(pub_key)
Iustin Pop's avatar
Iustin Pop committed
304

305
306
307
  # Return a reassuring string to the caller, and quit
  raise errors.QuitGanetiException(False, 'Shutdown scheduled')

Iustin Pop's avatar
Iustin Pop committed
308

309
def GetNodeInfo(vgname, hypervisor_type):
Alexander Schreiber's avatar
Alexander Schreiber committed
310
  """Gives back a hash with different informations about the node.
Iustin Pop's avatar
Iustin Pop committed
311

312
313
314
315
316
317
318
319
320
321
322
323
  @type vgname: C{string}
  @param vgname: the name of the volume group to ask for disk space information
  @type hypervisor_type: C{str}
  @param hypervisor_type: the name of the hypervisor to ask for
      memory information
  @rtype: C{dict}
  @return: dictionary with the following keys:
      - vg_size is the size of the configured volume group in MiB
      - vg_free is the free size of the volume group in MiB
      - memory_dom0 is the memory allocated for domain0 in MiB
      - memory_free is the currently available (free) ram in MiB
      - memory_total is the total number of ram in MiB
Iustin Pop's avatar
Iustin Pop committed
324

325
  """
Iustin Pop's avatar
Iustin Pop committed
326
327
328
329
330
  outputarray = {}
  vginfo = _GetVGInfo(vgname)
  outputarray['vg_size'] = vginfo['vg_size']
  outputarray['vg_free'] = vginfo['vg_free']

331
  hyper = hypervisor.GetHypervisor(hypervisor_type)
Iustin Pop's avatar
Iustin Pop committed
332
333
334
335
  hyp_info = hyper.GetNodeInfo()
  if hyp_info is not None:
    outputarray.update(hyp_info)

336
337
338
339
340
341
  f = open("/proc/sys/kernel/random/boot_id", 'r')
  try:
    outputarray["bootid"] = f.read(128).rstrip("\n")
  finally:
    f.close()

Iustin Pop's avatar
Iustin Pop committed
342
343
344
  return outputarray


345
def VerifyNode(what, cluster_name):
Iustin Pop's avatar
Iustin Pop committed
346
347
  """Verify the status of the local node.

348
349
350
351
352
353
354
355
356
  Based on the input L{what} parameter, various checks are done on the
  local node.

  If the I{filelist} key is present, this list of
  files is checksummed and the file/checksum pairs are returned.

  If the I{nodelist} key is present, we check that we have
  connectivity via ssh with the target nodes (and check the hostname
  report).
Iustin Pop's avatar
Iustin Pop committed
357

358
359
360
361
362
363
364
365
366
367
368
  If the I{node-net-test} key is present, we check that we have
  connectivity to the given nodes via both primary IP and, if
  applicable, secondary IPs.

  @type what: C{dict}
  @param what: a dictionary of things to check:
      - filelist: list of files for which to compute checksums
      - nodelist: list of nodes we should check ssh communication with
      - node-net-test: list of nodes we should check node daemon port
        connectivity with
      - hypervisor: list with hypervisors to run the verify for
Iustin Pop's avatar
Iustin Pop committed
369
370
371
  @rtype: dict
  @return: a dictionary with the same keys as the input dict, and
      values representing the result of the checks
Iustin Pop's avatar
Iustin Pop committed
372
373
374
375

  """
  result = {}

376
377
378
379
380
381
382
383
384
385
386
387
388
  if constants.NV_HYPERVISOR in what:
    result[constants.NV_HYPERVISOR] = tmp = {}
    for hv_name in what[constants.NV_HYPERVISOR]:
      tmp[hv_name] = hypervisor.GetHypervisor(hv_name).Verify()

  if constants.NV_FILELIST in what:
    result[constants.NV_FILELIST] = utils.FingerprintFiles(
      what[constants.NV_FILELIST])

  if constants.NV_NODELIST in what:
    result[constants.NV_NODELIST] = tmp = {}
    random.shuffle(what[constants.NV_NODELIST])
    for node in what[constants.NV_NODELIST]:
389
      success, message = _GetSshRunner(cluster_name).VerifyNodeHostname(node)
Iustin Pop's avatar
Iustin Pop committed
390
      if not success:
391
392
393
394
        tmp[node] = message

  if constants.NV_NODENETTEST in what:
    result[constants.NV_NODENETTEST] = tmp = {}
395
396
    my_name = utils.HostInfo().name
    my_pip = my_sip = None
397
    for name, pip, sip in what[constants.NV_NODENETTEST]:
398
399
400
401
402
      if name == my_name:
        my_pip = pip
        my_sip = sip
        break
    if not my_pip:
403
404
      tmp[my_name] = ("Can't find my own primary/secondary IP"
                      " in the node list")
405
    else:
Michael Hanselmann's avatar
Michael Hanselmann committed
406
      port = utils.GetNodeDaemonPort()
407
      for name, pip, sip in what[constants.NV_NODENETTEST]:
408
409
410
411
412
413
414
        fail = []
        if not utils.TcpPing(pip, port, source=my_pip):
          fail.append("primary")
        if sip != pip:
          if not utils.TcpPing(sip, port, source=my_sip):
            fail.append("secondary")
        if fail:
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
          tmp[name] = ("failure using the %s interface(s)" %
                       " and ".join(fail))

  if constants.NV_LVLIST in what:
    result[constants.NV_LVLIST] = GetVolumeList(what[constants.NV_LVLIST])

  if constants.NV_INSTANCELIST in what:
    result[constants.NV_INSTANCELIST] = GetInstanceList(
      what[constants.NV_INSTANCELIST])

  if constants.NV_VGLIST in what:
    result[constants.NV_VGLIST] = ListVolumeGroups()

  if constants.NV_VERSION in what:
    result[constants.NV_VERSION] = constants.PROTOCOL_VERSION

  if constants.NV_HVINFO in what:
    hyper = hypervisor.GetHypervisor(what[constants.NV_HVINFO])
    result[constants.NV_HVINFO] = hyper.GetNodeInfo()
434

Iustin Pop's avatar
Iustin Pop committed
435
436
437
438
439
440
  return result


def GetVolumeList(vg_name):
  """Compute list of logical volumes and their size.

Iustin Pop's avatar
Iustin Pop committed
441
442
443
444
445
446
447
448
449
450
451
  @type vg_name: str
  @param vg_name: the volume group whose LVs we should list
  @rtype: dict
  @return:
      dictionary of all partions (key) with value being a tuple of
      their size (in MiB), inactive and online status::

        {'test1': ('20.06', True, True)}

      in case of errors, a string is returned with the error
      details.
Iustin Pop's avatar
Iustin Pop committed
452
453

  """
454
455
456
457
458
  lvs = {}
  sep = '|'
  result = utils.RunCmd(["lvs", "--noheadings", "--units=m", "--nosuffix",
                         "--separator=%s" % sep,
                         "-olv_name,lv_size,lv_attr", vg_name])
Iustin Pop's avatar
Iustin Pop committed
459
  if result.failed:
460
461
    logging.error("Failed to list logical volumes, lvs output: %s",
                  result.output)
462
    return result.output
463

464
  valid_line_re = re.compile("^ *([^|]+)\|([0-9.]+)\|([^|]{6})\|?$")
465
  for line in result.stdout.splitlines():
466
467
468
    line = line.strip()
    match = valid_line_re.match(line)
    if not match:
469
      logging.error("Invalid line returned from lvs output: '%s'", line)
470
471
      continue
    name, size, attr = match.groups()
472
473
474
475
476
    inactive = attr[4] == '-'
    online = attr[5] == 'o'
    lvs[name] = (size, inactive, online)

  return lvs
Iustin Pop's avatar
Iustin Pop committed
477
478
479


def ListVolumeGroups():
Alexander Schreiber's avatar
Alexander Schreiber committed
480
  """List the volume groups and their size.
Iustin Pop's avatar
Iustin Pop committed
481

Iustin Pop's avatar
Iustin Pop committed
482
483
484
  @rtype: dict
  @return: dictionary with keys volume name and values the
      size of the volume
Iustin Pop's avatar
Iustin Pop committed
485
486
487
488
489

  """
  return utils.ListVolumeGroups()


490
491
492
def NodeVolumes():
  """List all volumes on this node.

Iustin Pop's avatar
Iustin Pop committed
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
  @rtype: list
  @return:
    A list of dictionaries, each having four keys:
      - name: the logical volume name,
      - size: the size of the logical volume
      - dev: the physical device on which the LV lives
      - vg: the volume group to which it belongs

    In case of errors, we return an empty list and log the
    error.

    Note that since a logical volume can live on multiple physical
    volumes, the resulting list might include a logical volume
    multiple times.

508
509
510
511
512
  """
  result = utils.RunCmd(["lvs", "--noheadings", "--units=m", "--nosuffix",
                         "--separator=|",
                         "--options=lv_name,lv_size,devices,vg_name"])
  if result.failed:
513
514
    logging.error("Failed to list logical volumes, lvs output: %s",
                  result.output)
Iustin Pop's avatar
Iustin Pop committed
515
    return []
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530

  def parse_dev(dev):
    if '(' in dev:
      return dev.split('(')[0]
    else:
      return dev

  def map_line(line):
    return {
      'name': line[0].strip(),
      'size': line[1].strip(),
      'dev': parse_dev(line[2].strip()),
      'vg': line[3].strip(),
    }

531
532
  return [map_line(line.split('|')) for line in result.stdout.splitlines()
          if line.count('|') >= 3]
533
534


Iustin Pop's avatar
Iustin Pop committed
535
def BridgesExist(bridges_list):
Alexander Schreiber's avatar
Alexander Schreiber committed
536
  """Check if a list of bridges exist on the current node.
Iustin Pop's avatar
Iustin Pop committed
537

Iustin Pop's avatar
Iustin Pop committed
538
539
  @rtype: boolean
  @return: C{True} if all of them exist, C{False} otherwise
Iustin Pop's avatar
Iustin Pop committed
540
541
542
543
544
545
546
547
548

  """
  for bridge in bridges_list:
    if not utils.BridgeExists(bridge):
      return False

  return True


549
def GetInstanceList(hypervisor_list):
Alexander Schreiber's avatar
Alexander Schreiber committed
550
  """Provides a list of instances.
Iustin Pop's avatar
Iustin Pop committed
551

552
553
554
555
556
  @type hypervisor_list: list
  @param hypervisor_list: the list of hypervisors to query information

  @rtype: list
  @return: a list of all running instances on the current node
Iustin Pop's avatar
Iustin Pop committed
557
558
    - instance1.example.com
    - instance2.example.com
Iustin Pop's avatar
Iustin Pop committed
559

560
  """
561
562
563
564
565
566
567
568
569
  results = []
  for hname in hypervisor_list:
    try:
      names = hypervisor.GetHypervisor(hname).ListInstances()
      results.extend(names)
    except errors.HypervisorError, err:
      logging.exception("Error enumerating instances for hypevisor %s", hname)
      # FIXME: should we somehow not propagate this to the master?
      raise
Iustin Pop's avatar
Iustin Pop committed
570

571
  return results
Iustin Pop's avatar
Iustin Pop committed
572
573


574
def GetInstanceInfo(instance, hname):
Alexander Schreiber's avatar
Alexander Schreiber committed
575
  """Gives back the informations about an instance as a dictionary.
Iustin Pop's avatar
Iustin Pop committed
576

577
578
579
580
  @type instance: string
  @param instance: the instance name
  @type hname: string
  @param hname: the hypervisor type of the instance
Iustin Pop's avatar
Iustin Pop committed
581

582
583
584
585
586
  @rtype: dict
  @return: dictionary with the following keys:
      - memory: memory size of instance (int)
      - state: xen state of instance (string)
      - time: cpu time of instance (float)
Iustin Pop's avatar
Iustin Pop committed
587

588
  """
Iustin Pop's avatar
Iustin Pop committed
589
590
  output = {}

591
  iinfo = hypervisor.GetHypervisor(hname).GetInstanceInfo(instance)
Iustin Pop's avatar
Iustin Pop committed
592
593
594
595
596
597
598
599
  if iinfo is not None:
    output['memory'] = iinfo[2]
    output['state'] = iinfo[4]
    output['time'] = iinfo[5]

  return output


600
def GetAllInstancesInfo(hypervisor_list):
Iustin Pop's avatar
Iustin Pop committed
601
602
  """Gather data about all instances.

Iustin Pop's avatar
Iustin Pop committed
603
  This is the equivalent of L{GetInstanceInfo}, except that it
Iustin Pop's avatar
Iustin Pop committed
604
605
606
  computes data for all instances at once, thus being faster if one
  needs data about more than one instance.

607
608
609
  @type hypervisor_list: list
  @param hypervisor_list: list of hypervisors to query for instance data

610
  @rtype: dict
611
612
613
614
  @return: dictionary of instance: data, with data having the following keys:
      - memory: memory size of instance (int)
      - state: xen state of instance (string)
      - time: cpu time of instance (float)
Iustin Pop's avatar
Iustin Pop committed
615
      - vcpus: the number of vcpus
Iustin Pop's avatar
Iustin Pop committed
616

617
  """
Iustin Pop's avatar
Iustin Pop committed
618
619
  output = {}

620
621
622
623
  for hname in hypervisor_list:
    iinfo = hypervisor.GetHypervisor(hname).GetAllInstancesInfo()
    if iinfo:
      for name, inst_id, memory, vcpus, state, times in iinfo:
624
        value = {
625
626
627
628
629
          'memory': memory,
          'vcpus': vcpus,
          'state': state,
          'time': times,
          }
630
631
632
633
        if name in output and output[name] != value:
          raise errors.HypervisorError("Instance %s running duplicate"
                                       " with different parameters" % name)
        output[name] = value
Iustin Pop's avatar
Iustin Pop committed
634
635
636
637

  return output


638
def AddOSToInstance(instance):
Alexander Schreiber's avatar
Alexander Schreiber committed
639
  """Add an OS to an instance.
Iustin Pop's avatar
Iustin Pop committed
640

641
642
  @type instance: L{objects.Instance}
  @param instance: Instance whose OS is to be installed
Iustin Pop's avatar
Iustin Pop committed
643
644
  @rtype: boolean
  @return: the success of the operation
Iustin Pop's avatar
Iustin Pop committed
645
646
647
648

  """
  inst_os = OSFromDisk(instance.os)

649
  create_env = OSEnvironment(instance)
Iustin Pop's avatar
Iustin Pop committed
650
651
652

  logfile = "%s/add-%s-%s-%d.log" % (constants.LOG_OS_DIR, instance.os,
                                     instance.name, int(time.time()))
653

654
655
  result = utils.RunCmd([inst_os.create_script], env=create_env,
                        cwd=inst_os.path, output=logfile,)
656
  if result.failed:
657
    logging.error("os create command '%s' returned error: %s, logfile: %s,"
658
                  " output: %s", result.cmd, result.fail_reason, logfile,
659
                  result.output)
660
661
662
663
664
    return False

  return True


665
def RunRenameInstance(instance, old_name):
666
667
  """Run the OS rename script for an instance.

Iustin Pop's avatar
Iustin Pop committed
668
  @type instance: L{objects.Instance}
669
670
671
  @param instance: Instance whose OS is to be installed
  @type old_name: string
  @param old_name: previous instance name
Iustin Pop's avatar
Iustin Pop committed
672
673
  @rtype: boolean
  @return: the success of the operation
674
675
676
677

  """
  inst_os = OSFromDisk(instance.os)

678
679
  rename_env = OSEnvironment(instance)
  rename_env['OLD_INSTANCE_NAME'] = old_name
680
681
682
683

  logfile = "%s/rename-%s-%s-%s-%d.log" % (constants.LOG_OS_DIR, instance.os,
                                           old_name,
                                           instance.name, int(time.time()))
Iustin Pop's avatar
Iustin Pop committed
684

685
686
  result = utils.RunCmd([inst_os.rename_script], env=rename_env,
                        cwd=inst_os.path, output=logfile)
Iustin Pop's avatar
Iustin Pop committed
687
688

  if result.failed:
689
    logging.error("os create command '%s' returned error: %s output: %s",
690
                  result.cmd, result.fail_reason, result.output)
Iustin Pop's avatar
Iustin Pop committed
691
692
693
694
695
696
697
698
    return False

  return True


def _GetVGInfo(vg_name):
  """Get informations about the volume group.

Iustin Pop's avatar
Iustin Pop committed
699
700
701
702
703
704
705
706
  @type vg_name: str
  @param vg_name: the volume group which we query
  @rtype: dict
  @return:
    A dictionary with the following keys:
      - C{vg_size} is the total size of the volume group in MiB
      - C{vg_free} is the free size of the volume group in MiB
      - C{pv_count} are the number of physical disks in that VG
Iustin Pop's avatar
Iustin Pop committed
707

Iustin Pop's avatar
Iustin Pop committed
708
709
    If an error occurs during gathering of data, we return the same dict
    with keys all set to None.
710

Iustin Pop's avatar
Iustin Pop committed
711
  """
712
713
  retdic = dict.fromkeys(["vg_size", "vg_free", "pv_count"])

Iustin Pop's avatar
Iustin Pop committed
714
715
716
717
  retval = utils.RunCmd(["vgs", "-ovg_size,vg_free,pv_count", "--noheadings",
                         "--nosuffix", "--units=m", "--separator=:", vg_name])

  if retval.failed:
718
    logging.error("volume group %s not present", vg_name)
719
    return retdic
Iustin Pop's avatar
Iustin Pop committed
720
  valarr = retval.stdout.strip().rstrip(':').split(':')
721
722
723
724
725
726
727
728
  if len(valarr) == 3:
    try:
      retdic = {
        "vg_size": int(round(float(valarr[0]), 0)),
        "vg_free": int(round(float(valarr[1]), 0)),
        "pv_count": int(valarr[2]),
        }
    except ValueError, err:
729
      logging.exception("Fail to parse vgs output")
730
  else:
731
732
    logging.error("vgs output has the wrong number of fields (expected"
                  " three): %s", str(valarr))
Iustin Pop's avatar
Iustin Pop committed
733
734
735
736
737
738
739
740
741
  return retdic


def _GatherBlockDevs(instance):
  """Set up an instance's block device(s).

  This is run on the primary node at instance startup. The block
  devices must be already assembled.

Iustin Pop's avatar
Iustin Pop committed
742
743
744
745
746
  @type instance: L{objects.Instance}
  @param instance: the instance whose disks we shoul assemble
  @rtype: list of L{bdev.BlockDev}
  @return: list of the block devices

Iustin Pop's avatar
Iustin Pop committed
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
  """
  block_devices = []
  for disk in instance.disks:
    device = _RecursiveFindBD(disk)
    if device is None:
      raise errors.BlockDeviceError("Block device '%s' is not set up." %
                                    str(disk))
    device.Open()
    block_devices.append((disk, device))
  return block_devices


def StartInstance(instance, extra_args):
  """Start an instance.

Iustin Pop's avatar
Iustin Pop committed
762
  @type instance: L{objects.Instance}
763
764
765
  @param instance: the instance object
  @rtype: boolean
  @return: whether the startup was successful or not
Iustin Pop's avatar
Iustin Pop committed
766

767
  """
768
  running_instances = GetInstanceList([instance.hypervisor])
Iustin Pop's avatar
Iustin Pop committed
769
770
771
772
773

  if instance.name in running_instances:
    return True

  block_devices = _GatherBlockDevs(instance)
774
  hyper = hypervisor.GetHypervisor(instance.hypervisor)
Iustin Pop's avatar
Iustin Pop committed
775
776
777
778

  try:
    hyper.StartInstance(instance, block_devices, extra_args)
  except errors.HypervisorError, err:
779
    logging.exception("Failed to start instance")
Iustin Pop's avatar
Iustin Pop committed
780
781
782
783
784
785
786
787
    return False

  return True


def ShutdownInstance(instance):
  """Shut an instance down.

Iustin Pop's avatar
Iustin Pop committed
788
789
790
  @note: this functions uses polling with a hardcoded timeout.

  @type instance: L{objects.Instance}
791
792
793
  @param instance: the instance object
  @rtype: boolean
  @return: whether the startup was successful or not
Iustin Pop's avatar
Iustin Pop committed
794

795
  """
796
797
  hv_name = instance.hypervisor
  running_instances = GetInstanceList([hv_name])
Iustin Pop's avatar
Iustin Pop committed
798
799
800
801

  if instance.name not in running_instances:
    return True

802
  hyper = hypervisor.GetHypervisor(hv_name)
Iustin Pop's avatar
Iustin Pop committed
803
804
805
  try:
    hyper.StopInstance(instance)
  except errors.HypervisorError, err:
806
    logging.error("Failed to stop instance")
Iustin Pop's avatar
Iustin Pop committed
807
808
809
810
811
812
813
    return False

  # test every 10secs for 2min
  shutdown_ok = False

  time.sleep(1)
  for dummy in range(11):
814
    if instance.name not in GetInstanceList([hv_name]):
Iustin Pop's avatar
Iustin Pop committed
815
816
817
818
      break
    time.sleep(10)
  else:
    # the shutdown did not succeed
819
    logging.error("shutdown of '%s' unsuccessful, using destroy", instance)
Iustin Pop's avatar
Iustin Pop committed
820
821
822
823

    try:
      hyper.StopInstance(instance, force=True)
    except errors.HypervisorError, err:
824
      logging.exception("Failed to stop instance")
Iustin Pop's avatar
Iustin Pop committed
825
826
827
      return False

    time.sleep(1)
828
    if instance.name in GetInstanceList([hv_name]):
829
830
      logging.error("could not shutdown instance '%s' even by destroy",
                    instance.name)
Iustin Pop's avatar
Iustin Pop committed
831
832
833
834
835
      return False

  return True


836
837
838
def RebootInstance(instance, reboot_type, extra_args):
  """Reboot an instance.

Iustin Pop's avatar
Iustin Pop committed
839
840
841
842
843
844
845
846
847
848
849
850
851
852
  @type instance: L{objects.Instance}
  @param instance: the instance object to reboot
  @type reboot_type: str
  @param reboot_type: the type of reboot, one the following
    constants:
      - L{constants.INSTANCE_REBOOT_SOFT}: only reboot the
        instance OS, do not recreate the VM
      - L{constants.INSTANCE_REBOOT_HARD}: tear down and
        restart the VM (at the hypervisor level)
      - the other reboot type (L{constants.INSTANCE_REBOOT_HARD})
        is not accepted here, since that mode is handled
        differently
  @rtype: boolean
  @return: the success of the operation
853
854

  """
855
  running_instances = GetInstanceList([instance.hypervisor])
856
857

  if instance.name not in running_instances:
858
    logging.error("Cannot reboot instance that is not running")
859
860
    return False

861
  hyper = hypervisor.GetHypervisor(instance.hypervisor)
862
863
864
865
  if reboot_type == constants.INSTANCE_REBOOT_SOFT:
    try:
      hyper.RebootInstance(instance)
    except errors.HypervisorError, err:
866
      logging.exception("Failed to soft reboot instance")
867
868
869
870
871
872
      return False
  elif reboot_type == constants.INSTANCE_REBOOT_HARD:
    try:
      ShutdownInstance(instance)
      StartInstance(instance, extra_args)
    except errors.HypervisorError, err:
873
      logging.exception("Failed to hard reboot instance")
874
875
876
877
878
879
880
      return False
  else:
    raise errors.ParameterError("reboot_type invalid")

  return True


881
882
883
def MigrateInstance(instance, target, live):
  """Migrates an instance to another node.

Iustin Pop's avatar
Iustin Pop committed
884
  @type instance: L{objects.Instance}
885
886
887
888
889
890
891
892
893
894
895
  @param instance: the instance definition
  @type target: string
  @param target: the target node name
  @type live: boolean
  @param live: whether the migration should be done live or not (the
      interpretation of this parameter is left to the hypervisor)
  @rtype: tuple
  @return: a tuple of (success, msg) where:
      - succes is a boolean denoting the success/failure of the operation
      - msg is a string with details in case of failure

896
  """
897
  hyper = hypervisor.GetHypervisor(instance.hypervisor_name)
898
899

  try:
900
    hyper.MigrateInstance(instance.name, target, live)
901
902
  except errors.HypervisorError, err:
    msg = "Failed to migrate instance: %s" % str(err)
903
    logging.error(msg)
904
905
906
907
    return (False, msg)
  return (True, "Migration successfull")


908
def CreateBlockDevice(disk, size, owner, on_primary, info):
Iustin Pop's avatar
Iustin Pop committed
909
910
  """Creates a block device for an instance.

Iustin Pop's avatar
Iustin Pop committed
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
  @type disk: L{objects.Disk}
  @param disk: the object describing the disk we should create
  @type size: int
  @param size: the size of the physical underlying device, in MiB
  @type owner: str
  @param owner: the name of the instance for which disk is created,
      used for device cache data
  @type on_primary: boolean
  @param on_primary:  indicates if it is the primary node or not
  @type info: string
  @param info: string that will be sent to the physical device
      creation, used for example to set (LVM) tags on LVs

  @return: the new unique_id of the device (this can sometime be
      computed only after creation), or None. On secondary nodes,
      it's not required to return anything.
Iustin Pop's avatar
Iustin Pop committed
927
928
929
930
931

  """
  clist = []
  if disk.children:
    for child in disk.children:
932
      crdev = _RecursiveAssembleBD(child, owner, on_primary)
Iustin Pop's avatar
Iustin Pop committed
933
934
935
936
937
938
939
940
      if on_primary or disk.AssembleOnSecondary():
        # we need the children open in case the device itself has to
        # be assembled
        crdev.Open()
      clist.append(crdev)
  try:
    device = bdev.FindDevice(disk.dev_type, disk.physical_id, clist)
    if device is not None:
941
      logging.info("removing existing device %s", disk)
Iustin Pop's avatar
Iustin Pop committed
942
943
944
945
946
947
948
949
950
951
      device.Remove()
  except errors.BlockDeviceError, err:
    pass

  device = bdev.Create(disk.dev_type, disk.physical_id,
                       clist, size)
  if device is None:
    raise ValueError("Can't create child device for %s, %s" %
                     (disk, size))
  if on_primary or disk.AssembleOnSecondary():
952
    if not device.Assemble():
953
      errorstring = "Can't assemble device after creation"
954
      logging.error(errorstring)
955
956
      raise errors.BlockDeviceError("%s, very unusual event - check the node"
                                    " daemon logs" % errorstring)
957
    device.SetSyncSpeed(constants.SYNC_SPEED)
Iustin Pop's avatar
Iustin Pop committed
958
959
    if on_primary or disk.OpenOnSecondary():
      device.Open(force=True)
960
961
    DevCacheManager.UpdateCache(device.dev_path, owner,
                                on_primary, disk.iv_name)
962
963
964

  device.SetInfo(info)

Iustin Pop's avatar
Iustin Pop committed
965
966
967
968
969
970
971
  physical_id = device.unique_id
  return physical_id


def RemoveBlockDevice(disk):
  """Remove a block device.

Iustin Pop's avatar
Iustin Pop committed
972
973
  @note: This is intended to be called recursively.

Iustin Pop's avatar
Iustin Pop committed
974
  @type disk: L{objects.Disk}
Iustin Pop's avatar
Iustin Pop committed
975
976
977
  @param disk: the disk object we should remove
  @rtype: boolean
  @return: the success of the operation
Iustin Pop's avatar
Iustin Pop committed
978
979
980
981
982
983
984
985

  """
  try:
    # since we are removing the device, allow a partial match
    # this allows removal of broken mirrors
    rdev = _RecursiveFindBD(disk, allow_partial=True)
  except errors.BlockDeviceError, err:
    # probably can't attach
986
    logging.info("Can't attach to device %s in remove", disk)
Iustin Pop's avatar
Iustin Pop committed
987
988
    rdev = None
  if rdev is not None:
989
    r_path = rdev.dev_path
Iustin Pop's avatar
Iustin Pop committed
990
    result = rdev.Remove()
991
992
    if result:
      DevCacheManager.RemoveCache(r_path)
Iustin Pop's avatar
Iustin Pop committed
993
994
995
996
997
998
999
1000
  else:
    result = True
  if disk.children:
    for child in disk.children:
      result = result and RemoveBlockDevice(child)
  return result


1001
def _RecursiveAssembleBD(disk, owner, as_primary):
Iustin Pop's avatar
Iustin Pop committed
1002
1003
1004
1005
  """Activate a block device for an instance.

  This is run on the primary and secondary nodes for an instance.

Iustin Pop's avatar
Iustin Pop committed
1006
  @note: this function is called recursively.
Iustin Pop's avatar
Iustin Pop committed
1007

Iustin Pop's avatar
Iustin Pop committed
1008
1009
1010
1011
1012
1013
1014
  @type disk: L{objects.Disk}
  @param disk: the disk we try to assemble
  @type owner: str
  @param owner: the name of the instance which owns the disk
  @type as_primary: boolean
  @param as_primary: if we should make the block device
      read/write
Iustin Pop's avatar
Iustin Pop committed
1015

Iustin Pop's avatar
Iustin Pop committed
1016
1017
1018
1019
1020
  @return: the assembled device or None (in case no device
      was assembled)
  @raise errors.BlockDeviceError: in case there is an error
      during the activation of the children or the device
      itself
Iustin Pop's avatar
Iustin Pop committed
1021
1022
1023
1024

  """
  children = []
  if disk.children:
1025
1026
1027
1028
1029
    mcn = disk.ChildrenNeeded()
    if mcn == -1:
      mcn = 0 # max number of Nones allowed
    else:
      mcn = len(disk.children) - mcn # max number of Nones
Iustin Pop's avatar
Iustin Pop committed
1030
    for chld_disk in disk.children:
1031
1032
1033
      try:
        cdev = _RecursiveAssembleBD(chld_disk, owner, as_primary)
      except errors.BlockDeviceError, err:
1034
        if children.count(None) >= mcn:
1035
1036
          raise
        cdev = None
1037
        logging.debug("Error in child activation: %s", str(err))
1038
      children.append(cdev)
Iustin Pop's avatar
Iustin Pop committed
1039
1040
1041

  if as_primary or disk.AssembleOnSecondary():
    r_dev = bdev.AttachOrAssemble(disk.dev_type, disk.physical_id, children)
1042
    r_dev.SetSyncSpeed(constants.SYNC_SPEED)
Iustin Pop's avatar
Iustin Pop committed
1043
1044
1045
    result = r_dev
    if as_primary or disk.OpenOnSecondary():
      r_dev.Open()
1046
1047
1048
    DevCacheManager.UpdateCache(r_dev.dev_path, owner,
                                as_primary, disk.iv_name)

Iustin Pop's avatar
Iustin Pop committed
1049
1050
1051
1052
1053
  else:
    result = True
  return result


1054
def AssembleBlockDevice(disk, owner, as_primary):
Iustin Pop's avatar
Iustin Pop committed
1055
1056
1057
1058
  """Activate a block device for an instance.

  This is a wrapper over _RecursiveAssembleBD.

Iustin Pop's avatar
Iustin Pop committed
1059
1060
1061
  @rtype: str or boolean
  @return: a C{/dev/...} path for primary nodes, and
      C{True} for secondary nodes
Iustin Pop's avatar
Iustin Pop committed
1062
1063

  """
1064
  result = _RecursiveAssembleBD(disk, owner, as_primary)
Iustin Pop's avatar
Iustin Pop committed
1065
1066
1067
1068
1069
1070
1071
1072
  if isinstance(result, bdev.BlockDev):
    result = result.dev_path
  return result


def ShutdownBlockDevice(disk):
  """Shut down a block device.

Iustin Pop's avatar
Iustin Pop committed
1073
1074
1075
  First, if the device is assembled (Attach() is successfull), then
  the device is shutdown. Then the children of the device are
  shutdown.
Iustin Pop's avatar
Iustin Pop committed
1076
1077
1078
1079
1080

  This function is called recursively. Note that we don't cache the
  children or such, as oppossed to assemble, shutdown of different
  devices doesn't require that the upper device was active.

Iustin Pop's avatar
Iustin Pop committed
1081
1082
1083
1084
1085
1086
  @type disk: L{objects.Disk}
  @param disk: the description of the disk we should
      shutdown
  @rtype: boolean
  @return: the success of the operation

Iustin Pop's avatar
Iustin Pop committed
1087
1088
1089
  """
  r_dev = _RecursiveFindBD(disk)
  if r_dev is not None:
1090
    r_path = r_dev.dev_path
Iustin Pop's avatar
Iustin Pop committed
1091
    result = r_dev.Shutdown()
1092
1093
    if result:
      DevCacheManager.RemoveCache(r_path)
Iustin Pop's avatar
Iustin Pop committed
1094
1095
1096
1097
1098
1099
1100
1101
  else:
    result = True
  if disk.children:
    for child in disk.children:
      result = result and ShutdownBlockDevice(child)
  return result


1102
1103
def MirrorAddChildren(parent_cdev, new_cdevs):
  """Extend a mirrored block device.
Iustin Pop's avatar
Iustin Pop committed
1104

Iustin Pop's avatar
Iustin Pop committed
1105
1106
1107
1108
1109
1110
1111
  @type parent_cdev: L{objects.Disk}
  @param parent_cdev: the disk to which we should add children
  @type new_cdevs: list of L{objects.Disk}
  @param new_cdevs: the list of children which we should add
  @rtype: boolean
  @return: the success of the operation

Iustin Pop's avatar
Iustin Pop committed
1112
  """
1113
1114
  parent_bdev = _RecursiveFindBD(parent_cdev, allow_partial=True)
  if parent_bdev is None:
1115
    logging.error("Can't find parent device")
Iustin Pop's avatar
Iustin Pop committed
1116
    return False
1117
1118
  new_bdevs = [_RecursiveFindBD(disk) for disk in new_cdevs]
  if new_bdevs.count(None) > 0:
1119
1120
    logging.error("Can't find new device(s) to add: %s:%s",
                  new_bdevs, new_cdevs)
Iustin Pop's avatar
Iustin Pop committed
1121
    return False
1122
  parent_bdev.AddChildren(new_bdevs)
Iustin Pop's avatar
Iustin Pop committed
1123
1124
1125
  return True


1126
1127
def MirrorRemoveChildren(parent_cdev, new_cdevs):
  """Shrink a mirrored block device.
Iustin Pop's avatar
Iustin Pop committed
1128

Iustin Pop's avatar
Iustin Pop committed
1129
1130
1131
1132
1133
1134
1135
  @type parent_cdev: L{objects.Disk}
  @param parent_cdev: the disk from which we should remove children
  @type new_cdevs: list of L{objects.Disk}
  @param new_cdevs: the list of children which we should remove
  @rtype: boolean
  @return: the success of the operation

Iustin Pop's avatar
Iustin Pop committed
1136
  """
1137
1138
  parent_bdev = _RecursiveFindBD(parent_cdev)
  if parent_bdev is None:
1139
    logging.error("Can't find parent in remove children: %s", parent_cdev)
Iustin Pop's avatar
Iustin Pop committed
1140
    return False
1141
1142
1143
1144
1145
1146
  devs = []
  for disk in new_cdevs:
    rpath = disk.StaticDevPath()
    if rpath is None:
      bd = _RecursiveFindBD(disk)
      if bd is None:
1147
1148
        logging.error("Can't find dynamic device %s while removing children",
                      disk)
1149
1150
1151
1152
1153
1154
        return False
      else:
        devs.append(bd.dev_path)
    else:
      devs.append(rpath)
  parent_bdev.RemoveChildren(devs)
Iustin Pop's avatar
Iustin Pop committed
1155
1156
1157
1158
1159
1160
  return True


def GetMirrorStatus(disks):
  """Get the mirroring status of a list of devices.

Iustin Pop's avatar
Iustin Pop committed
1161
1162
1163
1164
1165
  @type disks: list of L{objects.Disk}
  @param disks: the list of disks which we should query
  @rtype: disk
  @return:
      a list of (mirror_done, estimated_time) tuples, which
Iustin Pop's avatar
Iustin Pop committed
1166
      are the result of L{bdev.BlockDev.CombinedSyncStatus}
Iustin Pop's avatar
Iustin Pop committed
1167
1168
  @raise errors.BlockDeviceError: if any of the disks cannot be
      found
Iustin Pop's avatar
Iustin Pop committed
1169
1170
1171
1172
1173
1174

  """
  stats = []
  for dsk in disks:
    rbd = _RecursiveFindBD(dsk)
    if rbd is None:
1175
      raise errors.BlockDeviceError("Can't find device %s" % str(dsk))
Iustin Pop's avatar
Iustin Pop committed
1176
1177
1178
1179
1180
1181
1182
1183
1184
    stats.append(rbd.CombinedSyncStatus())
  return stats


def _RecursiveFindBD(disk, allow_partial=False):
  """Check if a device is activated.

  If so, return informations about the real device.

Iustin Pop's avatar
Iustin Pop committed
1185
1186
1187
1188
1189
1190
  @type disk: L{objects.Disk}
  @param disk: the disk object we need to find
  @type allow_partial: boolean
  @param allow_partial: if true, don't abort the find if a
      child of the device can't be found; this is intended
      to be used when repairing mirrors
Iustin Pop's avatar
Iustin Pop committed
1191

Iustin Pop's avatar
Iustin Pop committed
1192
1193
  @return: None if the device can't be found,
      otherwise the device instance
Iustin Pop's avatar
Iustin Pop committed
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206

  """
  children = []
  if disk.children:
    for chdisk in disk.children:
      children.append(_RecursiveFindBD(chdisk))

  return bdev.FindDevice(disk.dev_type, disk.physical_id, children)


def FindBlockDevice(disk):
  """Check if a device is activated.

Iustin Pop's avatar
Iustin Pop committed
1207
  If it is, return informations about the real device.
Iustin Pop's avatar
Iustin Pop committed
1208

Iustin Pop's avatar
Iustin Pop committed
1209
1210
1211
1212
1213
1214
  @type disk: L{objects.Disk}
  @param disk: the disk to find
  @rtype: None or tuple
  @return: None if the disk cannot be found, otherwise a
      tuple (device_path, major, minor, sync_percent,
      estimated_time, is_degraded)
Iustin Pop's avatar
Iustin Pop committed
1215
1216
1217
1218 <