backend.py 49.3 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
33
34
35
36
37
38
39
40
41
#

# 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

from ganeti import logger
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
42
from ganeti import ssconf
Iustin Pop's avatar
Iustin Pop committed
43
44


45
46
47
48
def _GetSshRunner():
  return ssh.SshRunner()


Iustin Pop's avatar
Iustin Pop committed
49
50
51
52
def StartMaster():
  """Activate local node as master node.

  There are two needed steps for this:
53
    - run the master script
Iustin Pop's avatar
Iustin Pop committed
54
55
56
    - register the cron script

  """
57
  result = utils.RunCmd([constants.MASTER_SCRIPT, "-d", "start"])
Iustin Pop's avatar
Iustin Pop committed
58
59
60

  if result.failed:
    logger.Error("could not activate cluster interface with command %s,"
61
                 " error: '%s'" % (result.cmd, result.output))
Iustin Pop's avatar
Iustin Pop committed
62
63
64
65
66
67
68
69
    return False

  return True


def StopMaster():
  """Deactivate this node as master.

70
  This runs the master stop script.
Iustin Pop's avatar
Iustin Pop committed
71
72

  """
73
  result = utils.RunCmd([constants.MASTER_SCRIPT, "-d", "stop"])
Iustin Pop's avatar
Iustin Pop committed
74
75
76

  if result.failed:
    logger.Error("could not deactivate cluster interface with command %s,"
77
                 " error: '%s'" % (result.cmd, result.output))
Iustin Pop's avatar
Iustin Pop committed
78
79
80
81
82
    return False

  return True


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

86
87
88
89
  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
90

91
  """
92
93
94
95
  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)]
96
  for name, content, mode in sshd_keys:
97
    utils.WriteFile(name, data=content, mode=mode)
Iustin Pop's avatar
Iustin Pop committed
98

99
100
101
102
103
104
  try:
    priv_key, pub_key, auth_keys = ssh.GetUserFiles(constants.GANETI_RUNAS,
                                                    mkdir=True)
  except errors.OpExecError, err:
    logger.Error("Error while processing user ssh files: %s" % err)
    return False
Iustin Pop's avatar
Iustin Pop committed
105

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

109
  utils.AddAuthorizedKey(auth_keys, sshpub)
Iustin Pop's avatar
Iustin Pop committed
110

111
  utils.RunCmd([constants.SSH_INITD_SCRIPT, "restart"])
Iustin Pop's avatar
Iustin Pop committed
112
113
114
115
116
117
118
119

  return True


def LeaveCluster():
  """Cleans up the current node and prepares it to be removed from the cluster.

  """
120
121
122
123
124
  if os.path.isdir(constants.DATA_DIR):
    for rel_name in utils.ListVisibleFiles(constants.DATA_DIR):
      full_name = os.path.join(constants.DATA_DIR, rel_name)
      if os.path.isfile(full_name) and not os.path.islink(full_name):
        utils.RemoveFile(full_name)
Iustin Pop's avatar
Iustin Pop committed
125

126
127
128
129
  try:
    priv_key, pub_key, auth_keys = ssh.GetUserFiles(constants.GANETI_RUNAS)
  except errors.OpExecError, err:
    logger.Error("Error while processing ssh files: %s" % err)
130
131
    return

132
  f = open(pub_key, 'r')
Iustin Pop's avatar
Iustin Pop committed
133
  try:
134
    utils.RemoveAuthorizedKey(auth_keys, f.read(8192))
Iustin Pop's avatar
Iustin Pop committed
135
136
137
  finally:
    f.close()

138
139
  utils.RemoveFile(priv_key)
  utils.RemoveFile(pub_key)
Iustin Pop's avatar
Iustin Pop committed
140
141
142


def GetNodeInfo(vgname):
Alexander Schreiber's avatar
Alexander Schreiber committed
143
  """Gives back a hash with different informations about the node.
Iustin Pop's avatar
Iustin Pop committed
144
145
146
147
148
149
150
151
152
153
154

  Returns:
    { 'vg_size' : xxx,  'vg_free' : xxx, 'memory_domain0': xxx,
      'memory_free' : xxx, 'memory_total' : xxx }
    where
    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

155
  """
Iustin Pop's avatar
Iustin Pop committed
156
157
158
159
160
161
162
163
164
165
  outputarray = {}
  vginfo = _GetVGInfo(vgname)
  outputarray['vg_size'] = vginfo['vg_size']
  outputarray['vg_free'] = vginfo['vg_free']

  hyper = hypervisor.GetHypervisor()
  hyp_info = hyper.GetNodeInfo()
  if hyp_info is not None:
    outputarray.update(hyp_info)

166
167
168
169
170
171
  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
172
173
174
175
176
177
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
  return outputarray


def VerifyNode(what):
  """Verify the status of the local node.

  Args:
    what - a dictionary of things to check:
      'filelist' : list of files for which to compute checksums
      'nodelist' : list of nodes we should check communication with
      'hypervisor': run the hypervisor-specific verify

  Requested files on local node are checksummed and the result returned.

  The nodelist is traversed, with the following checks being made
  for each node:
  - known_hosts key correct
  - correct resolving of node name (target node returns its own hostname
    by ssh-execution of 'hostname', result compared against name in list.

  """
  result = {}

  if 'hypervisor' in what:
    result['hypervisor'] = hypervisor.GetHypervisor().Verify()

  if 'filelist' in what:
    result['filelist'] = utils.FingerprintFiles(what['filelist'])

  if 'nodelist' in what:
    result['nodelist'] = {}
    for node in what['nodelist']:
204
      success, message = _GetSshRunner().VerifyNodeHostname(node)
Iustin Pop's avatar
Iustin Pop committed
205
206
207
208
209
210
211
212
213
      if not success:
        result['nodelist'][node] = message
  return result


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

  Returns:
214
215
216
    dictionary of all partions (key) with their size (in MiB), inactive
    and online status:
    {'test1': ('20.06', True, True)}
Iustin Pop's avatar
Iustin Pop committed
217
218

  """
219
220
221
222
223
  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
224
225
226
  if result.failed:
    logger.Error("Failed to list logical volumes, lvs output: %s" %
                 result.output)
227
    return result.output
228
229
230
231
232
233
234
235
236
237
238

  for line in result.stdout.splitlines():
    line = line.strip().rstrip(sep)
    name, size, attr = line.split(sep)
    if len(attr) != 6:
      attr = '------'
    inactive = attr[4] == '-'
    online = attr[5] == 'o'
    lvs[name] = (size, inactive, online)

  return lvs
Iustin Pop's avatar
Iustin Pop committed
239
240
241


def ListVolumeGroups():
Alexander Schreiber's avatar
Alexander Schreiber committed
242
  """List the volume groups and their size.
Iustin Pop's avatar
Iustin Pop committed
243
244
245
246
247
248
249
250

  Returns:
    Dictionary with keys volume name and values the size of the volume

  """
  return utils.ListVolumeGroups()


251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
def NodeVolumes():
  """List all volumes on this node.

  """
  result = utils.RunCmd(["lvs", "--noheadings", "--units=m", "--nosuffix",
                         "--separator=|",
                         "--options=lv_name,lv_size,devices,vg_name"])
  if result.failed:
    logger.Error("Failed to list logical volumes, lvs output: %s" %
                 result.output)
    return {}

  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(),
    }

277
  return [map_line(line.split('|')) for line in result.stdout.splitlines()]
278
279


Iustin Pop's avatar
Iustin Pop committed
280
def BridgesExist(bridges_list):
Alexander Schreiber's avatar
Alexander Schreiber committed
281
  """Check if a list of bridges exist on the current node.
Iustin Pop's avatar
Iustin Pop committed
282
283
284
285
286
287
288
289
290
291
292
293
294

  Returns:
    True if all of them exist, false otherwise

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

  return True


def GetInstanceList():
Alexander Schreiber's avatar
Alexander Schreiber committed
295
  """Provides a list of instances.
Iustin Pop's avatar
Iustin Pop committed
296
297
298
299
300
301

  Returns:
    A list of all running instances on the current node
    - instance1.example.com
    - instance2.example.com

302
  """
Iustin Pop's avatar
Iustin Pop committed
303
304
305
306
307
308
309
310
311
312
  try:
    names = hypervisor.GetHypervisor().ListInstances()
  except errors.HypervisorError, err:
    logger.Error("error enumerating instances: %s" % str(err))
    raise

  return names


def GetInstanceInfo(instance):
Alexander Schreiber's avatar
Alexander Schreiber committed
313
  """Gives back the informations about an instance as a dictionary.
Iustin Pop's avatar
Iustin Pop committed
314
315
316
317
318
319
320
321
322
323
324

  Args:
    instance: name of the instance (ex. instance1.example.com)

  Returns:
    { 'memory' : 511, 'state' : '-b---', 'time' : 3188.8, }
    where
    memory: memory size of instance (int)
    state: xen state of instance (string)
    time: cpu time of instance (float)

325
  """
Iustin Pop's avatar
Iustin Pop committed
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
  output = {}

  iinfo = hypervisor.GetHypervisor().GetInstanceInfo(instance)
  if iinfo is not None:
    output['memory'] = iinfo[2]
    output['state'] = iinfo[4]
    output['time'] = iinfo[5]

  return output


def GetAllInstancesInfo():
  """Gather data about all instances.

  This is the equivalent of `GetInstanceInfo()`, except that it
  computes data for all instances at once, thus being faster if one
  needs data about more than one instance.

  Returns: a dictionary of dictionaries, keys being the instance name,
    and with values:
    { 'memory' : 511, 'state' : '-b---', 'time' : 3188.8, }
    where
    memory: memory size of instance (int)
    state: xen state of instance (string)
    time: cpu time of instance (float)
    vcpus: the number of cpus

353
  """
Iustin Pop's avatar
Iustin Pop committed
354
355
356
357
  output = {}

  iinfo = hypervisor.GetHypervisor().GetAllInstancesInfo()
  if iinfo:
358
    for name, inst_id, memory, vcpus, state, times in iinfo:
Iustin Pop's avatar
Iustin Pop committed
359
360
361
362
363
364
365
366
367
368
369
      output[name] = {
        'memory': memory,
        'vcpus': vcpus,
        'state': state,
        'time': times,
        }

  return output


def AddOSToInstance(instance, os_disk, swap_disk):
Alexander Schreiber's avatar
Alexander Schreiber committed
370
  """Add an OS to an instance.
Iustin Pop's avatar
Iustin Pop committed
371
372
373
374
375
376
377
378
379
380
381

  Args:
    instance: the instance object
    os_disk: the instance-visible name of the os device
    swap_disk: the instance-visible name of the swap device

  """
  inst_os = OSFromDisk(instance.os)

  create_script = inst_os.create_script

Iustin Pop's avatar
Iustin Pop committed
382
383
  os_device = instance.FindDisk(os_disk)
  if os_device is None:
Iustin Pop's avatar
Iustin Pop committed
384
385
386
    logger.Error("Can't find this device-visible name '%s'" % os_disk)
    return False

Iustin Pop's avatar
Iustin Pop committed
387
388
  swap_device = instance.FindDisk(swap_disk)
  if swap_device is None:
Iustin Pop's avatar
Iustin Pop committed
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
    logger.Error("Can't find this device-visible name '%s'" % swap_disk)
    return False

  real_os_dev = _RecursiveFindBD(os_device)
  if real_os_dev is None:
    raise errors.BlockDeviceError("Block device '%s' is not set up" %
                                  str(os_device))
  real_os_dev.Open()

  real_swap_dev = _RecursiveFindBD(swap_device)
  if real_swap_dev is None:
    raise errors.BlockDeviceError("Block device '%s' is not set up" %
                                  str(swap_device))
  real_swap_dev.Open()

  logfile = "%s/add-%s-%s-%d.log" % (constants.LOG_OS_DIR, instance.os,
                                     instance.name, int(time.time()))
  if not os.path.exists(constants.LOG_OS_DIR):
    os.mkdir(constants.LOG_OS_DIR, 0750)

409
  command = utils.BuildShellCmd("cd %s && %s -i %s -b %s -s %s &>%s",
Iustin Pop's avatar
Iustin Pop committed
410
411
412
                                inst_os.path, create_script, instance.name,
                                real_os_dev.dev_path, real_swap_dev.dev_path,
                                logfile)
413
414
415

  result = utils.RunCmd(command)
  if result.failed:
416
    logger.Error("os create command '%s' returned error: %s, logfile: %s,"
417
                 " output: %s" %
418
                 (command, result.fail_reason, logfile, result.output))
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
    return False

  return True


def RunRenameInstance(instance, old_name, os_disk, swap_disk):
  """Run the OS rename script for an instance.

  Args:
    instance: the instance object
    old_name: the old name of the instance
    os_disk: the instance-visible name of the os device
    swap_disk: the instance-visible name of the swap device

  """
  inst_os = OSFromDisk(instance.os)

  script = inst_os.rename_script

  os_device = instance.FindDisk(os_disk)
  if os_device is None:
    logger.Error("Can't find this device-visible name '%s'" % os_disk)
    return False

  swap_device = instance.FindDisk(swap_disk)
  if swap_device is None:
    logger.Error("Can't find this device-visible name '%s'" % swap_disk)
    return False

  real_os_dev = _RecursiveFindBD(os_device)
  if real_os_dev is None:
    raise errors.BlockDeviceError("Block device '%s' is not set up" %
                                  str(os_device))
  real_os_dev.Open()

  real_swap_dev = _RecursiveFindBD(swap_device)
  if real_swap_dev is None:
    raise errors.BlockDeviceError("Block device '%s' is not set up" %
                                  str(swap_device))
  real_swap_dev.Open()

  logfile = "%s/rename-%s-%s-%s-%d.log" % (constants.LOG_OS_DIR, instance.os,
                                           old_name,
                                           instance.name, int(time.time()))
  if not os.path.exists(constants.LOG_OS_DIR):
    os.mkdir(constants.LOG_OS_DIR, 0750)

  command = utils.BuildShellCmd("cd %s && %s -o %s -n %s -b %s -s %s &>%s",
                                inst_os.path, script, old_name, instance.name,
                                real_os_dev.dev_path, real_swap_dev.dev_path,
                                logfile)
Iustin Pop's avatar
Iustin Pop committed
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494

  result = utils.RunCmd(command)

  if result.failed:
    logger.Error("os create command '%s' returned error: %s"
                 " output: %s" %
                 (command, result.fail_reason, result.output))
    return False

  return True


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

  Args:
    vg_name: the volume group

  Returns:
    { 'vg_size' : xxx, 'vg_free' : xxx, 'pv_count' : xxx }
    where
    vg_size is the total size of the volume group in MiB
    vg_free is the free size of the volume group in MiB
    pv_count are the number of physical disks in that vg

495
496
497
  If an error occurs during gathering of data, we return the same dict
  with keys all set to None.

Iustin Pop's avatar
Iustin Pop committed
498
  """
499
500
  retdic = dict.fromkeys(["vg_size", "vg_free", "pv_count"])

Iustin Pop's avatar
Iustin Pop committed
501
502
503
504
505
506
  retval = utils.RunCmd(["vgs", "-ovg_size,vg_free,pv_count", "--noheadings",
                         "--nosuffix", "--units=m", "--separator=:", vg_name])

  if retval.failed:
    errmsg = "volume group %s not present" % vg_name
    logger.Error(errmsg)
507
    return retdic
Iustin Pop's avatar
Iustin Pop committed
508
  valarr = retval.stdout.strip().rstrip(':').split(':')
509
510
511
512
513
514
515
516
517
518
519
520
  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:
      logger.Error("Fail to parse vgs output: %s" % str(err))
  else:
    logger.Error("vgs output has the wrong number of fields (expected"
                 " three): %s" % str(valarr))
Iustin Pop's avatar
Iustin Pop committed
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
  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.

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

  Args:
    instance - name of instance to start.

548
  """
Iustin Pop's avatar
Iustin Pop committed
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
  running_instances = GetInstanceList()

  if instance.name in running_instances:
    return True

  block_devices = _GatherBlockDevs(instance)
  hyper = hypervisor.GetHypervisor()

  try:
    hyper.StartInstance(instance, block_devices, extra_args)
  except errors.HypervisorError, err:
    logger.Error("Failed to start instance: %s" % err)
    return False

  return True


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

  Args:
    instance - name of instance to shutdown.

572
  """
Iustin Pop's avatar
Iustin Pop committed
573
574
575
576
577
578
579
580
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
  running_instances = GetInstanceList()

  if instance.name not in running_instances:
    return True

  hyper = hypervisor.GetHypervisor()
  try:
    hyper.StopInstance(instance)
  except errors.HypervisorError, err:
    logger.Error("Failed to stop instance: %s" % err)
    return False

  # test every 10secs for 2min
  shutdown_ok = False

  time.sleep(1)
  for dummy in range(11):
    if instance.name not in GetInstanceList():
      break
    time.sleep(10)
  else:
    # the shutdown did not succeed
    logger.Error("shutdown of '%s' unsuccessful, using destroy" % instance)

    try:
      hyper.StopInstance(instance, force=True)
    except errors.HypervisorError, err:
      logger.Error("Failed to stop instance: %s" % err)
      return False

    time.sleep(1)
    if instance.name in GetInstanceList():
      logger.Error("could not shutdown instance '%s' even by destroy")
      return False

  return True


611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
def RebootInstance(instance, reboot_type, extra_args):
  """Reboot an instance.

  Args:
    instance    - name of instance to reboot
    reboot_type - how to reboot [soft,hard,full]

  """
  running_instances = GetInstanceList()

  if instance.name not in running_instances:
    logger.Error("Cannot reboot instance that is not running")
    return False

  hyper = hypervisor.GetHypervisor()
  if reboot_type == constants.INSTANCE_REBOOT_SOFT:
    try:
      hyper.RebootInstance(instance)
    except errors.HypervisorError, err:
      logger.Error("Failed to soft reboot instance: %s" % err)
      return False
  elif reboot_type == constants.INSTANCE_REBOOT_HARD:
    try:
      ShutdownInstance(instance)
      StartInstance(instance, extra_args)
    except errors.HypervisorError, err:
      logger.Error("Failed to hard reboot instance: %s" % err)
      return False
  else:
    raise errors.ParameterError("reboot_type invalid")


  return True


646
def CreateBlockDevice(disk, size, owner, on_primary, info):
Iustin Pop's avatar
Iustin Pop committed
647
648
649
  """Creates a block device for an instance.

  Args:
650
651
652
   disk: a ganeti.objects.Disk object
   size: the size of the physical underlying device
   owner: a string with the name of the instance
Manuel Franceschini's avatar
Manuel Franceschini committed
653
654
   on_primary: a boolean indicating if it is the primary node or not
   info: string that will be sent to the physical device creation
Iustin Pop's avatar
Iustin Pop committed
655
656
657
658
659
660
661
662
663
664

  Returns:
    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.

  """
  clist = []
  if disk.children:
    for child in disk.children:
665
      crdev = _RecursiveAssembleBD(child, owner, on_primary)
Iustin Pop's avatar
Iustin Pop committed
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
      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:
      logger.Info("removing existing device %s" % disk)
      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():
685
    if not device.Assemble():
686
687
688
689
      errorstring = "Can't assemble device after creation"
      logger.Error(errorstring)
      raise errors.BlockDeviceError("%s, very unusual event - check the node"
                                    " daemon logs" % errorstring)
690
    device.SetSyncSpeed(constants.SYNC_SPEED)
Iustin Pop's avatar
Iustin Pop committed
691
692
    if on_primary or disk.OpenOnSecondary():
      device.Open(force=True)
693
694
    DevCacheManager.UpdateCache(device.dev_path, owner,
                                on_primary, disk.iv_name)
695
696
697

  device.SetInfo(info)

Iustin Pop's avatar
Iustin Pop committed
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
  physical_id = device.unique_id
  return physical_id


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

  This is intended to be called recursively.

  """
  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
    logger.Info("Can't attach to device %s in remove" % disk)
    rdev = None
  if rdev is not None:
717
    r_path = rdev.dev_path
Iustin Pop's avatar
Iustin Pop committed
718
    result = rdev.Remove()
719
720
    if result:
      DevCacheManager.RemoveCache(r_path)
Iustin Pop's avatar
Iustin Pop committed
721
722
723
724
725
726
727
728
  else:
    result = True
  if disk.children:
    for child in disk.children:
      result = result and RemoveBlockDevice(child)
  return result


729
def _RecursiveAssembleBD(disk, owner, as_primary):
Iustin Pop's avatar
Iustin Pop committed
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
  """Activate a block device for an instance.

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

  This function is called recursively.

  Args:
    disk: a objects.Disk object
    as_primary: if we should make the block device read/write

  Returns:
    the assembled device or None (in case no device was assembled)

  If the assembly is not successful, an exception is raised.

  """
  children = []
  if disk.children:
748
749
750
751
752
    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
753
    for chld_disk in disk.children:
754
755
756
      try:
        cdev = _RecursiveAssembleBD(chld_disk, owner, as_primary)
      except errors.BlockDeviceError, err:
757
        if children.count(None) >= mcn:
758
759
760
761
          raise
        cdev = None
        logger.Debug("Error in child activation: %s" % str(err))
      children.append(cdev)
Iustin Pop's avatar
Iustin Pop committed
762
763
764

  if as_primary or disk.AssembleOnSecondary():
    r_dev = bdev.AttachOrAssemble(disk.dev_type, disk.physical_id, children)
765
    r_dev.SetSyncSpeed(constants.SYNC_SPEED)
Iustin Pop's avatar
Iustin Pop committed
766
767
768
    result = r_dev
    if as_primary or disk.OpenOnSecondary():
      r_dev.Open()
769
770
771
    DevCacheManager.UpdateCache(r_dev.dev_path, owner,
                                as_primary, disk.iv_name)

Iustin Pop's avatar
Iustin Pop committed
772
773
774
775
776
  else:
    result = True
  return result


777
def AssembleBlockDevice(disk, owner, as_primary):
Iustin Pop's avatar
Iustin Pop committed
778
779
780
781
782
783
784
785
786
  """Activate a block device for an instance.

  This is a wrapper over _RecursiveAssembleBD.

  Returns:
    a /dev path for primary nodes
    True for secondary nodes

  """
787
  result = _RecursiveAssembleBD(disk, owner, as_primary)
Iustin Pop's avatar
Iustin Pop committed
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
  if isinstance(result, bdev.BlockDev):
    result = result.dev_path
  return result


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

  First, if the device is assembled (can `Attach()`), then the device
  is shutdown. Then the children of the device are shutdown.

  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.

  """
  r_dev = _RecursiveFindBD(disk)
  if r_dev is not None:
806
    r_path = r_dev.dev_path
Iustin Pop's avatar
Iustin Pop committed
807
    result = r_dev.Shutdown()
808
809
    if result:
      DevCacheManager.RemoveCache(r_path)
Iustin Pop's avatar
Iustin Pop committed
810
811
812
813
814
815
816
817
  else:
    result = True
  if disk.children:
    for child in disk.children:
      result = result and ShutdownBlockDevice(child)
  return result


818
819
def MirrorAddChildren(parent_cdev, new_cdevs):
  """Extend a mirrored block device.
Iustin Pop's avatar
Iustin Pop committed
820
821

  """
822
823
824
  parent_bdev = _RecursiveFindBD(parent_cdev, allow_partial=True)
  if parent_bdev is None:
    logger.Error("Can't find parent device")
Iustin Pop's avatar
Iustin Pop committed
825
    return False
826
827
  new_bdevs = [_RecursiveFindBD(disk) for disk in new_cdevs]
  if new_bdevs.count(None) > 0:
828
829
    logger.Error("Can't find new device(s) to add: %s:%s" %
                 (new_bdevs, new_cdevs))
Iustin Pop's avatar
Iustin Pop committed
830
    return False
831
  parent_bdev.AddChildren(new_bdevs)
Iustin Pop's avatar
Iustin Pop committed
832
833
834
  return True


835
836
def MirrorRemoveChildren(parent_cdev, new_cdevs):
  """Shrink a mirrored block device.
Iustin Pop's avatar
Iustin Pop committed
837
838

  """
839
840
  parent_bdev = _RecursiveFindBD(parent_cdev)
  if parent_bdev is None:
841
    logger.Error("Can't find parent in remove children: %s" % parent_cdev)
Iustin Pop's avatar
Iustin Pop committed
842
    return False
843
844
845
846
847
848
849
850
851
852
853
854
855
856
  devs = []
  for disk in new_cdevs:
    rpath = disk.StaticDevPath()
    if rpath is None:
      bd = _RecursiveFindBD(disk)
      if bd is None:
        logger.Error("Can't find dynamic device %s while removing children" %
                     disk)
        return False
      else:
        devs.append(bd.dev_path)
    else:
      devs.append(rpath)
  parent_bdev.RemoveChildren(devs)
Iustin Pop's avatar
Iustin Pop committed
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
  return True


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

  Args:
    disks: list of `objects.Disk`

  Returns:
    list of (mirror_done, estimated_time) tuples, which
    are the result of bdev.BlockDevice.CombinedSyncStatus()

  """
  stats = []
  for dsk in disks:
    rbd = _RecursiveFindBD(dsk)
    if rbd is None:
875
      raise errors.BlockDeviceError("Can't find device %s" % str(dsk))
Iustin Pop's avatar
Iustin Pop committed
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
    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.

  Args:
    disk: the objects.Disk instance
    allow_partial: don't abort the find if a child of the
                   device can't be found; this is intended to be
                   used when repairing mirrors

  Returns:
    None if the device can't be found
    otherwise the device instance

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

  If so, return informations about the real device.

  Args:
    disk: the objects.Disk instance
  Returns:
    None if the device can't be found
    (device_path, major, minor, sync_percent, estimated_time, is_degraded)

  """
  rbd = _RecursiveFindBD(disk)
  if rbd is None:
    return rbd
919
  return (rbd.dev_path, rbd.major, rbd.minor) + rbd.GetSyncStatus()
Iustin Pop's avatar
Iustin Pop committed
920
921
922
923
924
925
926
927
928
929
930
931
932
933


def UploadFile(file_name, data, mode, uid, gid, atime, mtime):
  """Write a file to the filesystem.

  This allows the master to overwrite(!) a file. It will only perform
  the operation if the file belongs to a list of configuration files.

  """
  if not os.path.isabs(file_name):
    logger.Error("Filename passed to UploadFile is not absolute: '%s'" %
                 file_name)
    return False

934
935
936
937
938
  allowed_files = [
    constants.CLUSTER_CONF_FILE,
    constants.ETC_HOSTS,
    constants.SSH_KNOWN_HOSTS_FILE,
    ]
939
940
  allowed_files.extend(ssconf.SimpleStore().GetFileList())
  if file_name not in allowed_files:
Iustin Pop's avatar
Iustin Pop committed
941
942
943
944
    logger.Error("Filename passed to UploadFile not in allowed"
                 " upload targets: '%s'" % file_name)
    return False

945
946
  utils.WriteFile(file_name, data=data, mode=mode, uid=uid, gid=gid,
                  atime=atime, mtime=mtime)
Iustin Pop's avatar
Iustin Pop committed
947
948
  return True

949

Iustin Pop's avatar
Iustin Pop committed
950
951
952
953
954
955
956
957
958
959
960
961
962
963
def _ErrnoOrStr(err):
  """Format an EnvironmentError exception.

  If the `err` argument has an errno attribute, it will be looked up
  and converted into a textual EXXXX description. Otherwise the string
  representation of the error will be returned.

  """
  if hasattr(err, 'errno'):
    detail = errno.errorcode[err.errno]
  else:
    detail = str(err)
  return detail

Iustin Pop's avatar
Iustin Pop committed
964

965
def _OSOndiskVersion(name, os_dir):
Alexander Schreiber's avatar
Alexander Schreiber committed
966
  """Compute and return the API version of a given OS.
Iustin Pop's avatar
Iustin Pop committed
967

Alexander Schreiber's avatar
Alexander Schreiber committed
968
  This function will try to read the API version of the os given by
969
970
971
972
  the 'name' parameter and residing in the 'os_dir' directory.

  Return value will be either an integer denoting the version or None in the
  case when this is not a valid OS name.
Iustin Pop's avatar
Iustin Pop committed
973
974
975
976
977
978
979

  """
  api_file = os.path.sep.join([os_dir, "ganeti_api_version"])

  try:
    st = os.stat(api_file)
  except EnvironmentError, err:
980
    raise errors.InvalidOS(name, os_dir, "'ganeti_api_version' file not"
981
                           " found (%s)" % _ErrnoOrStr(err))
Iustin Pop's avatar
Iustin Pop committed
982
983

  if not stat.S_ISREG(stat.S_IFMT(st.st_mode)):
984
    raise errors.InvalidOS(name, os_dir, "'ganeti_api_version' file is not"
985
                           " a regular file")
Iustin Pop's avatar
Iustin Pop committed
986
987
988
989
990
991
992
993

  try:
    f = open(api_file)
    try:
      api_version = f.read(256)
    finally:
      f.close()
  except EnvironmentError, err:
994
    raise errors.InvalidOS(name, os_dir, "error while reading the"
995
                           " API version (%s)" % _ErrnoOrStr(err))
Iustin Pop's avatar
Iustin Pop committed
996
997
998
999
1000

  api_version = api_version.strip()
  try:
    api_version = int(api_version)
  except (TypeError, ValueError), err:
1001
1002
    raise errors.InvalidOS(name, os_dir,
                           "API version is not integer (%s)" % str(err))
Iustin Pop's avatar
Iustin Pop committed
1003
1004
1005

  return api_version

1006

1007
def DiagnoseOS(top_dirs=None):
Iustin Pop's avatar
Iustin Pop committed
1008
1009
  """Compute the validity for all OSes.

1010
1011
  Returns an OS object for each name in all the given top directories
  (if not given defaults to constants.OS_SEARCH_PATH)
Iustin Pop's avatar
Iustin Pop committed
1012
1013

  Returns:
1014
    list of OS objects
Iustin Pop's avatar
Iustin Pop committed
1015
1016

  """
1017
1018
  if top_dirs is None:
    top_dirs = constants.OS_SEARCH_PATH
Iustin Pop's avatar
Iustin Pop committed
1019
1020

  result = []
Iustin Pop's avatar
Iustin Pop committed
1021
1022
  for dir_name in top_dirs:
    if os.path.isdir(dir_name):
1023
      try:
Iustin Pop's avatar
Iustin Pop committed
1024
        f_names = utils.ListVisibleFiles(dir_name)
1025
      except EnvironmentError, err:
Iustin Pop's avatar
Iustin Pop committed
1026
1027
        logger.Error("Can't list the OS directory %s: %s" %
                     (dir_name, str(err)))
1028
1029
1030
        break
      for name in f_names:
        try:
Iustin Pop's avatar
Iustin Pop committed
1031
          os_inst = OSFromDisk(name, base_dir=dir_name)
1032
1033
          result.append(os_inst)
        except errors.InvalidOS, err:
1034
          result.append(objects.OS.FromInvalidOS(err))
Iustin Pop's avatar
Iustin Pop committed
1035
1036
1037
1038

  return result


1039
def OSFromDisk(name, base_dir=None):
Iustin Pop's avatar
Iustin Pop committed
1040
1041
1042
1043
1044
1045
1046
  """Create an OS instance from disk.

  This function will return an OS instance if the given name is a
  valid OS name. Otherwise, it will raise an appropriate
  `errors.InvalidOS` exception, detailing why this is not a valid
  OS.

1047
1048
1049
1050
  Args:
    os_dir: Directory containing the OS scripts. Defaults to a search
            in all the OS_SEARCH_PATH directories.

Iustin Pop's avatar
Iustin Pop committed
1051
  """
1052

1053
  if base_dir is None:
1054
    os_dir = utils.FindFile(name, constants.OS_SEARCH_PATH, os.path.isdir)
1055
1056
1057
1058
    if os_dir is None:
      raise errors.InvalidOS(name, None, "OS dir not found in search path")
  else:
    os_dir = os.path.sep.join([base_dir, name])
Iustin Pop's avatar
Iustin Pop committed
1059

1060
  api_version = _OSOndiskVersion(name, os_dir)
Iustin Pop's avatar
Iustin Pop committed
1061
1062

  if api_version != constants.OS_API_VERSION:
1063
1064
    raise errors.InvalidOS(name, os_dir, "API version mismatch"
                           " (found %s want %s)"
1065
                           % (api_version, constants.OS_API_VERSION))
Iustin Pop's avatar
Iustin Pop committed
1066
1067

  # OS Scripts dictionary, we will populate it with the actual script names
1068
  os_scripts = {'create': '', 'export': '', 'import': '', 'rename': ''}
Iustin Pop's avatar
Iustin Pop committed
1069
1070
1071
1072
1073
1074
1075

  for script in os_scripts:
    os_scripts[script] = os.path.sep.join([os_dir, script])

    try:
      st = os.stat(os_scripts[script])
    except EnvironmentError, err:
1076
      raise errors.InvalidOS(name, os_dir, "'%s' script missing (%s)" %
1077
                             (script, _ErrnoOrStr(err)))
Iustin Pop's avatar
Iustin Pop committed
1078
1079

    if stat.S_IMODE(st.st_mode) & stat.S_IXUSR != stat.S_IXUSR:
1080
1081
      raise errors.InvalidOS(name, os_dir, "'%s' script not executable" %
                             script)
Iustin Pop's avatar
Iustin Pop committed
1082
1083

    if not stat.S_ISREG(stat.S_IFMT(st.st_mode)):
1084
1085
      raise errors.InvalidOS(name, os_dir, "'%s' is not a regular file" %
                             script)
Iustin Pop's avatar
Iustin Pop committed
1086
1087


1088
  return objects.OS(name=name, path=os_dir, status=constants.OS_VALID_STATUS,
Iustin Pop's avatar
Iustin Pop committed
1089
1090
1091
                    create_script=os_scripts['create'],
                    export_script=os_scripts['export'],
                    import_script=os_scripts['import'],
1092
                    rename_script=os_scripts['rename'],
Iustin Pop's avatar
Iustin Pop committed
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
                    api_version=api_version)


def SnapshotBlockDevice(disk):
  """Create a snapshot copy of a block device.

  This function is called recursively, and the snapshot is actually created
  just for the leaf lvm backend device.

  Args:
    disk: the disk to be snapshotted

  Returns:
    a config entry for the actual lvm device snapshotted.

1108
  """
Iustin Pop's avatar
Iustin Pop committed
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
  if disk.children:
    if len(disk.children) == 1:
      # only one child, let's recurse on it
      return SnapshotBlockDevice(disk.children[0])
    else:
      # more than one child, choose one that matches
      for child in disk.children:
        if child.size == disk.size:
          # return implies breaking the loop
          return SnapshotBlockDevice(child)
1119
  elif disk.dev_type == constants.LD_LV:
Iustin Pop's avatar
Iustin Pop committed
1120
1121
1122
1123
1124
1125
1126
    r_dev = _RecursiveFindBD(disk)
    if r_dev is not None:
      # let's stay on the safe side and ask for the full size, for now
      return r_dev.Snapshot(disk.size)
    else:
      return None
  else:
1127
    raise errors.ProgrammerError("Cannot snapshot non-lvm block device"
1128
                                 " '%s' of type '%s'" %
1129
                                 (disk.unique_id, disk.dev_type))
Iustin Pop's avatar
Iustin Pop committed
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142


def ExportSnapshot(disk, dest_node, instance):
  """Export a block device snapshot to a remote node.

  Args:
    disk: the snapshot block device
    dest_node: the node to send the image to
    instance: instance being exported

  Returns:
    True if successful, False otherwise.

1143
  """
Iustin Pop's avatar
Iustin Pop committed
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
  inst_os = OSFromDisk(instance.os)
  export_script = inst_os.export_script

  logfile = "%s/exp-%s-%s-%s.log" % (constants.LOG_OS_DIR, inst_os.name,
                                     instance.name, int(time.time()))
  if not os.path.exists(constants.LOG_OS_DIR):
    os.mkdir(constants.LOG_OS_DIR, 0750)

  real_os_dev = _RecursiveFindBD(disk)
  if real_os_dev is None:
    raise errors.BlockDeviceError("Block device '%s' is not set up" %
                                  str(disk))
  real_os_dev.Open()

  destdir = os.path.join(constants.EXPORT_DIR, instance.name + ".new")
  destfile = disk.physical_id[1]

  # the target command is built out of three individual commands,
  # which are joined by pipes; we check each individual command for
  # valid parameters

  expcmd = utils.BuildShellCmd("cd %s; %s -i %s -b %s 2>%s", inst_os.path,
                               export_script, instance.name,
                               real_os_dev.dev_path, logfile)

  comprcmd = "gzip"

1171
  destcmd = utils.BuildShellCmd("mkdir -p %s && cat > %s/%s",
1172
                                destdir, destdir, destfile)
1173
1174
  remotecmd = _GetSshRunner().BuildCmd(dest_node, constants.GANETI_RUNAS,
                                       destcmd)
Iustin Pop's avatar
Iustin Pop committed
1175
1176

  # all commands have been checked, so we're safe to combine them
1177
  command = '|'.join([expcmd, comprcmd, utils.ShellQuoteArgs(remotecmd)])
Iustin Pop's avatar
Iustin Pop committed
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199

  result = utils.RunCmd(command)

  if result.failed:
    logger.Error("os snapshot export command '%s' returned error: %s"
                 " output: %s" %
                 (command, result.fail_reason, result.output))
    return False

  return True


def FinalizeExport(instance, snap_disks):
  """Write out the export configuration information.

  Args:
    instance: instance configuration
    snap_disks: snapshot block devices

  Returns:
    False in case of error, True otherwise.

1200
  """
Iustin Pop's avatar
Iustin Pop committed
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
  destdir = os.path.join(constants.EXPORT_DIR, instance.name + ".new")
  finaldestdir = os.path.join(constants.EXPORT_DIR, instance.name)

  config = objects.SerializableConfigParser()

  config.add_section(constants.INISECT_EXP)
  config.set(constants.INISECT_EXP, 'version', '0')
  config.set(constants.INISECT_EXP, 'timestamp', '%d' % int(time.time()))
  config.set(constants.INISECT_EXP, 'source', instance.primary_node)
  config.set(constants.INISECT_EXP, 'os', instance.os)
  config.set(constants.INISECT_EXP, 'compression', 'gzip')

  config.add_section(constants.INISECT_INS)
  config.set(constants.INISECT_INS, 'name', instance.name)
  config.set(constants.INISECT_INS, 'memory', '%d' % instance.memory)
  config.set(constants.INISECT_INS, 'vcpus', '%d' % instance.vcpus)
  config.set(constants.INISECT_INS, 'disk_template', instance.disk_template)
1218
1219

  nic_count = 0
Iustin Pop's avatar
Iustin Pop committed
1220
1221
1222
1223
  for nic_count, nic in enumerate(instance.nics):
    config.set(constants.INISECT_INS, 'nic%d_mac' %
               nic_count, '%s' % nic.mac)
    config.set(constants.INISECT_INS, 'nic%d_ip' % nic_count, '%s' % nic.ip)
Guido Trotter's avatar
Guido Trotter committed
1224
    config.set(constants.INISECT_INS, 'nic%d_bridge' % nic_count, '%s' % nic.bridge)
Iustin Pop's avatar
Iustin Pop committed
1225
1226
1227
  # TODO: redundant: on load can read nics until it doesn't exist
  config.set(constants.INISECT_INS, 'nic_count' , '%d' % nic_count)

1228
  disk_count = 0
Iustin Pop's avatar
Iustin Pop committed
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
  for disk_count, disk in enumerate(snap_disks):
    config.set(constants.INISECT_INS, 'disk%d_ivname' % disk_count,
               ('%s' % disk.iv_name))
    config.set(constants.INISECT_INS, 'disk%d_dump' % disk_count,
               ('%s' % disk.physical_id[1]))
    config.set(constants.INISECT_INS, 'disk%d_size' % disk_count,
               ('%d' % disk.size))
  config.set(constants.INISECT_INS, 'disk_count' , '%d' % disk_count)

  cff = os.path.join(destdir, constants.EXPORT_CONF_FILE)
  cfo = open(cff, 'w')
  try:
    config.write(cfo)
  finally:
    cfo.close()

  shutil.rmtree(finaldestdir, True)
  shutil.move(destdir, finaldestdir)

  return True


def ExportInfo(dest):
  """Get export configuration information.

  Args:
    dest: directory containing the export

  Returns:
    A serializable config file containing the export info.

  """
  cff = os.path.join(dest, constants.EXPORT_CONF_FILE)

  config = objects.SerializableConfigParser()
  config.read(cff)

  if (not config.has_section(constants.INISECT_EXP) or
      not config.has_section(constants.INISECT_INS)):
    return None

  return config


def ImportOSIntoInstance(instance, os_disk, swap_disk, src_node, src_image):
  """Import an os image into an instance.

  Args:
    instance: the instance object
    os_disk: the instance-visible name of the os device
    swap_disk: the instance-visible name of the swap device
    src_node: node holding the source image
    src_image: path to the source image on src_node

  Returns:
    False in case of error, True otherwise.

  """
  inst_os = OSFromDisk(instance.os)
  import_script = inst_os.import_script

Iustin Pop's avatar
Iustin Pop committed
1290
1291
  os_device = instance.FindDisk(os_disk)
  if os_device is None:
Iustin Pop's avatar
Iustin Pop committed
1292
1293
1294
    logger.Error("Can't find this device-visible name '%s'" % os_disk)
    return False

Iustin Pop's avatar
Iustin Pop committed
1295
1296
  swap_device = instance.FindDisk(swap_disk)
  if swap_device is None:
Iustin Pop's avatar
Iustin Pop committed
1297
1298
1299
1300
1301
    logger.Error("Can't find this device-visible name '%s'" % swap_disk)
    return False

  real_os_dev = _RecursiveFindBD(os_device)
  if real_os_dev is None:
1302
1303
    raise errors.BlockDeviceError("Block device '%s' is not set up" %
                                  str(os_device))
Iustin Pop's avatar
Iustin Pop committed
1304
1305
1306
1307
  real_os_dev.Open()

  real_swap_dev = _RecursiveFindBD(swap_device)
  if real_swap_dev is None:
1308
1309
    raise errors.BlockDeviceError("Block device '%s' is not set up" %
                                  str(swap_device))
Iustin Pop's avatar
Iustin Pop committed
1310
1311
1312
1313
1314
1315
1316
  real_swap_dev.Open()

  logfile = "%s/import-%s-%s-%s.log" % (constants.LOG_OS_DIR, instance.os,
                                        instance.name, int(time.time()))
  if not os.path.exists(constants.LOG_OS_DIR):
    os.mkdir(constants.LOG_OS_DIR, 0750)

1317
  destcmd = utils.BuildShellCmd('cat %s', src_image)
1318
1319
  remotecmd = _GetSshRunner().BuildCmd(src_node, constants.GANETI_RUNAS,
                                       destcmd)
Iustin Pop's avatar
Iustin Pop committed
1320
1321
1322
1323
1324
1325
1326

  comprcmd = "gunzip"
  impcmd = utils.BuildShellCmd("(cd %s; %s -i %s -b %s -s %s &>%s)",
                               inst_os.path, import_script, instance.name,
                               real_os_dev.dev_path, real_swap_dev.dev_path,
                               logfile)

1327
  command = '|'.join([utils.ShellQuoteArgs(remotecmd), comprcmd, impcmd])
Iustin Pop's avatar
Iustin Pop committed
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341

  result = utils.RunCmd(command)

  if result.failed:
    logger.Error("os import command '%s' returned error: %s"
                 " output: %s" %
                 (command, result.fail_reason, result.output))
    return False

  return True


def ListExports():
  """Return a list of exports currently available on this machine.
1342

Iustin Pop's avatar
Iustin Pop committed
1343
1344
  """
  if os.path.isdir(constants.EXPORT_DIR):
1345
    return utils.ListVisibleFiles(constants.EXPORT_DIR)
Iustin Pop's avatar
Iustin Pop committed
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
  else:
    return []


def RemoveExport(export):
  """Remove an existing export from the node.

  Args:
    export: the name of the export to remove

  Returns:
    False in case of error, True otherwise.

1359
  """
Iustin Pop's avatar
Iustin Pop committed
1360
1361
1362
1363
1364
1365
1366
1367
1368
  target = os.path.join(constants.EXPORT_DIR, export)

  shutil.rmtree(target)
  # TODO: catch some of the relevant exceptions and provide a pretty
  # error message if rmtree fails.

  return True


Iustin Pop's avatar
Iustin Pop committed
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
def RenameBlockDevices(devlist):
  """Rename a list of block devices.

  The devlist argument is a list of tuples (disk, new_logical,
  new_physical). The return value will be a combined boolean result
  (True only if all renames succeeded).

  """
  result = True
  for disk, unique_id in devlist:
    dev = _RecursiveFindBD(disk)
    if dev is None:
      result = False
      continue
    try:
1384
      old_rpath = dev.dev_path
Iustin Pop's avatar
Iustin Pop committed
1385
      dev.Rename(unique_id)
1386
1387
1388
1389
1390
1391
1392
1393
      new_rpath = dev.dev_path
      if old_rpath != new_rpath:
        DevCacheManager.RemoveCache(old_rpath)
        # FIXME: we should add the new cache information here, like:
        # DevCacheManager.UpdateCache(new_rpath, owner, ...)
        # but we don't have the owner here - maybe parse from existing
        # cache? for now, we only lose lvm data when we rename, which
        # is less critical than DRBD or MD
Iustin Pop's avatar
Iustin Pop committed
1394
1395
1396
1397
1398
1399
1400
    except errors.BlockDeviceError, err:
      logger.Error("Can't rename device '%s' to '%s': %s" %
                   (dev, unique_id, err))
      result = False
  return result


1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
def _TransformFileStorageDir(file_storage_dir):
  """Checks whether given file_storage_dir is valid.

  Checks wheter the given file_storage_dir is within the cluster-wide
  default file_storage_dir stored in SimpleStore. Only paths under that
  directory are allowed.

  Args:
    file_storage_dir: string with path
  
  Returns:
    normalized file_storage_dir (string) if valid, None otherwise

  """
  file_storage_dir = os.path.normpath(file_storage_dir)
  base_file_storage_dir = ssconf.SimpleStore().GetFileStorageDir()
  if (not os.path.commonprefix([file_storage_dir, base_file_storage_dir]) ==
      base_file_storage_dir):
    logger.Error("file storage directory '%s' is not under base file"
                 " storage directory '%s'" %
                 (file_storage_dir, base_file_storage_dir))
    return None
  return file_storage_dir


def CreateFileStorageDir(file_storage_dir):
  """Create file storage directory.

  Args:
    file_storage_dir: string containing the path

  Returns:
    tuple with first element a boolean indicating wheter dir
    creation was successful or not

  """
  file_storage_dir = _TransformFileStorageDir(file_storage_dir)
  result = True,
  if not file_storage_dir:
    result = False,
  else:
    if os.path.exists(file_storage_dir):
      if not os.path.isdir(file_storage_dir):
        logger.Error("'%s' is not a directory" % file_storage_dir)
        result = False,
    else:
      try:
        os.makedirs(file_storage_dir, 0750)
      except OSError, err:
        logger.Error("Cannot create file storage directory '%s': %s" %
                     (file_storage_dir, err))
        result = False,
  return result


def RemoveFileStorageDir(file_storage_dir):
  """Remove file storage directory.

  Remove it only if it's empty. If not log an error and return.

  Args:
    file_storage_dir: string containing the path

  Returns:
    tuple with first element a boolean indicating wheter dir
    removal was successful or not

  """
  file_storage_dir = _TransformFileStorageDir(file_storage_dir)
  result = True,
  if not file_storage_dir:
    result = False,
  else:
    if os.path.exists(file_storage_dir):
      if not os.path.isdir(file_storage_dir):
        logger.Error("'%s' is not a directory" % file_storage_dir)
        result = False,
      # deletes dir only if empty, otherwise we want to return False
      try:
        os.rmdir(file_storage_dir)
      except OSError, err:
        logger.Error("Cannot remove file storage directory '%s': %s" %
                     (file_storage_dir, err))
        result = False,
  return result


def RenameFileStorageDir(old_file_storage_dir, new_file_storage_dir):
  """Rename the file storage directory.

  Args:
    old_file_storage_dir: string containing the old path
    new_file_storage_dir: string containing the new path

  Returns:
    tuple with first element a boolean indicating wheter dir
    rename was successful or not

  """
  old_file_storage_dir = _TransformFileStorageDir(old_file_storage_dir)
  new_file_storage_dir = _TransformFileStorageDir(new_file_storage_dir)
  result = True,
  if not old_file_storage_dir or not new_file_storage_dir:
    result = False,
  else:
    if not os.path.exists(new_file_storage_dir):
      if os.path.isdir(old_file_storage_dir):
        try:
          os.rename(old_file_storage_dir, new_file_storage_dir)
        except OSError, err:
          logger.Error("Cannot rename '%s' to '%s': %s"
                       % (old_file_storage_dir, new_file_storage_dir, err))
          result =  False,
      else:
        logger.Error("'%s' is not a directory" % old_file_storage_dir)
        result = False,
    else:
      if os.path.exists(old_file_storage_dir):
        logger.Error("Cannot rename '%s' to '%s'. Both locations exist." %
                     old_file_storage_dir, new_file_storage_dir)
        result = False,
  return result


Iustin Pop's avatar
Iustin Pop committed
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
class HooksRunner(object):
  """Hook runner.

  This class is instantiated on the node side (ganeti-noded) and not on
  the master side.

  """
  RE_MASK = re.compile("^[a-zA-Z0-9_-]+$")

  def __init__(self, hooks_base_dir=None):
    """Constructor for hooks runner.

    Args:
      - hooks_base_dir: if not None, this overrides the
        constants.HOOKS_BASE_DIR (useful for unittests)

    """
    if hooks_base_dir is None:
      hooks_base_dir = constants.HOOKS_BASE_DIR
    self._BASE_DIR = hooks_base_dir

  @staticmethod
  def ExecHook(script, env):
    """Exec one hook script.

    Args:
     - script: the full path to the script
     - env: the environment with which to exec the script

    """
    # exec the process using subprocess and log the output
    fdstdin = None
    try:
      fdstdin = open("/dev/null", "r")
      child = subprocess.Popen([script], stdin=fdstdin, stdout=subprocess.PIPE,
                               stderr=subprocess.STDOUT, close_fds=True,
Iustin Pop's avatar
Iustin Pop committed
1561
                               shell=False, cwd="/", env=env)
Iustin Pop's avatar
Iustin Pop committed
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
      output = ""
      try:
        output = child.stdout.read(4096)
        child.stdout.close()
      except EnvironmentError, err:
        output += "Hook script error: %s" % str(err)

      while True:
        try:
          result = child.wait()
          break
        except EnvironmentError, err:
          if err.errno == errno.EINTR:
            continue
          raise
    finally:
      # try not to leak fds
      for fd in (fdstdin, ):
        if fd is not None:
          try:
            fd.close()
          except EnvironmentError, err:
            # just log the error
            #logger.Error("While closing fd %s: %s" % (fd, err))
            pass

    return result == 0, output

  def RunHooks(self, hpath, phase, env):
    """Run the scripts in the hooks directory.

    This method will not be usually overriden by child opcodes.

    """
    if phase == constants.HOOKS_PHASE_PRE:
      suffix = "pre"
    elif phase == constants.HOOKS_PHASE_POST:
      suffix = "post"
    else:
1601
      raise errors.ProgrammerError("Unknown hooks phase: '%s'" % phase)
Iustin Pop's avatar
Iustin Pop committed
1602
1603
1604
1605
1606
    rr = []

    subdir = "%s-%s.d" % (hpath, suffix)
    dir_name = "%s/%s" % (self._BASE_DIR, subdir)
    try:
1607
      dir_contents = utils.ListVisibleFiles(dir_name)
Iustin Pop's avatar
Iustin Pop committed
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
    except OSError, err:
      # must log
      return rr

    # we use the standard python sort order,
    # so 00name is the recommended naming scheme
    dir_contents.sort()
    for relname in dir_contents:
      fname = os.path.join(dir_name, relname)
      if not (os.path.isfile(fname) and os.access(fname, os.X_OK) and
          self.RE_MASK.match(relname) is not None):
        rrval = constants.HKR_SKIP
        output = ""
      else:
        result, output = self.ExecHook(fname, env)
        if not result:
          rrval = constants.HKR_FAIL
        else:
          rrval = constants.HKR_SUCCESS
      rr.append(("%s/%s" % (subdir, relname), rrval, output))

    return rr
1630
1631


1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
class IAllocatorRunner(object):
  """IAllocator runner.

  This class is instantiated on the node side (ganeti-noded) and not on
  the master side.

  """
  def Run(self, name, idata):
    """Run an iallocator script.

    Return value: tuple of:
       - run status (one of the IARUN_ constants)
       - stdout
       - stderr
       - fail reason (as from utils.RunResult)

    """
    alloc_script = utils.FindFile(name, constants.IALLOCATOR_SEARCH_PATH,
                                  os.path.isfile)
    if alloc_script is None:
      return (constants.IARUN_NOTFOUND, None, None, None)

    fd, fin_name = tempfile.mkstemp(prefix="ganeti-iallocator.")
    try:
      os.write(fd, idata)
      os.close(fd)
      result = utils.RunCmd([alloc_script, fin_name])
      if result.failed:
        return (constants.IARUN_FAILURE, result.stdout, result.stderr,
                result.fail_reason)
    finally:
      os.unlink(fin_name)

    return (constants.IARUN_SUCCESS, result.stdout, result.stderr, None)


1668
class DevCacheManager(object):
1669
  """Simple class for managing a cache of block device information.
1670
1671
1672
1673
1674
1675
1676
1677
1678