backend.py 52.2 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
Iustin Pop's avatar
Iustin Pop committed
34
35
36
37
38
39
40
41
42

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


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


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

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

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

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

  return True


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

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

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

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

  return True


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

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

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

100
101
102
103
104
105
  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
106

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

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

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

  return True


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

  """
121
122
123
124
125
  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
126

127
128
129
130
  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)
131
132
    return

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

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

142
143
144
  # Return a reassuring string to the caller, and quit
  raise errors.QuitGanetiException(False, 'Shutdown scheduled')

Iustin Pop's avatar
Iustin Pop committed
145
146

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

  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

159
  """
Iustin Pop's avatar
Iustin Pop committed
160
161
162
163
164
165
166
167
168
169
  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)

170
171
172
173
174
175
  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
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
204
205
206
  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'] = {}
207
    random.shuffle(what['nodelist'])
Iustin Pop's avatar
Iustin Pop committed
208
    for node in what['nodelist']:
209
      success, message = _GetSshRunner().VerifyNodeHostname(node)
Iustin Pop's avatar
Iustin Pop committed
210
211
      if not success:
        result['nodelist'][node] = message
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
  if 'node-net-test' in what:
    result['node-net-test'] = {}
    my_name = utils.HostInfo().name
    my_pip = my_sip = None
    for name, pip, sip in what['node-net-test']:
      if name == my_name:
        my_pip = pip
        my_sip = sip
        break
    if not my_pip:
      result['node-net-test'][my_name] = ("Can't find my own"
                                          " primary/secondary IP"
                                          " in the node list")
    else:
      port = ssconf.SimpleStore().GetNodeDaemonPort()
      for name, pip, sip in what['node-net-test']:
        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:
          result['node-net-test'][name] = ("failure using the %s"
                                           " interface(s)" %
                                           " and ".join(fail))

Iustin Pop's avatar
Iustin Pop committed
239
240
241
242
243
244
245
  return result


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

  Returns:
246
247
248
    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
249
250

  """
251
252
253
254
255
  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
256
257
258
  if result.failed:
    logger.Error("Failed to list logical volumes, lvs output: %s" %
                 result.output)
259
    return result.output
260

261
  valid_line_re = re.compile("^ *([^|]+)\|([0-9.]+)\|([^|]{6})\|?$")
262
  for line in result.stdout.splitlines():
263
264
265
266
267
268
    line = line.strip()
    match = valid_line_re.match(line)
    if not match:
      logger.Error("Invalid line returned from lvs output: '%s'" % line)
      continue
    name, size, attr = match.groups()
269
270
271
272
273
    inactive = attr[4] == '-'
    online = attr[5] == 'o'
    lvs[name] = (size, inactive, online)

  return lvs
Iustin Pop's avatar
Iustin Pop committed
274
275
276


def ListVolumeGroups():
Alexander Schreiber's avatar
Alexander Schreiber committed
277
  """List the volume groups and their size.
Iustin Pop's avatar
Iustin Pop committed
278
279
280
281
282
283
284
285

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

  """
  return utils.ListVolumeGroups()


286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
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(),
    }

312
313
  return [map_line(line.split('|')) for line in result.stdout.splitlines()
          if line.count('|') >= 3]
314
315


Iustin Pop's avatar
Iustin Pop committed
316
def BridgesExist(bridges_list):
Alexander Schreiber's avatar
Alexander Schreiber committed
317
  """Check if a list of bridges exist on the current node.
Iustin Pop's avatar
Iustin Pop committed
318
319
320
321
322
323
324
325
326
327
328
329
330

  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
331
  """Provides a list of instances.
Iustin Pop's avatar
Iustin Pop committed
332
333
334
335
336
337

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

338
  """
Iustin Pop's avatar
Iustin Pop committed
339
340
341
342
343
344
345
346
347
348
  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
349
  """Gives back the informations about an instance as a dictionary.
Iustin Pop's avatar
Iustin Pop committed
350
351
352
353
354
355
356
357
358
359
360

  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)

361
  """
Iustin Pop's avatar
Iustin Pop committed
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
  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

389
  """
Iustin Pop's avatar
Iustin Pop committed
390
391
392
393
  output = {}

  iinfo = hypervisor.GetHypervisor().GetAllInstancesInfo()
  if iinfo:
394
    for name, inst_id, memory, vcpus, state, times in iinfo:
Iustin Pop's avatar
Iustin Pop committed
395
396
397
398
399
400
401
402
403
404
405
      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
406
  """Add an OS to an instance.
Iustin Pop's avatar
Iustin Pop committed
407
408
409
410
411
412
413
414
415
416
417

  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
418
419
  os_device = instance.FindDisk(os_disk)
  if os_device is None:
Iustin Pop's avatar
Iustin Pop committed
420
421
422
    logger.Error("Can't find this device-visible name '%s'" % os_disk)
    return False

Iustin Pop's avatar
Iustin Pop committed
423
424
  swap_device = instance.FindDisk(swap_disk)
  if swap_device is None:
Iustin Pop's avatar
Iustin Pop committed
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
    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)

445
  command = utils.BuildShellCmd("cd %s && %s -i %s -b %s -s %s &>%s",
Iustin Pop's avatar
Iustin Pop committed
446
447
448
                                inst_os.path, create_script, instance.name,
                                real_os_dev.dev_path, real_swap_dev.dev_path,
                                logfile)
449
450
451

  result = utils.RunCmd(command)
  if result.failed:
452
    logger.Error("os create command '%s' returned error: %s, logfile: %s,"
453
                 " output: %s" %
454
                 (command, result.fail_reason, logfile, result.output))
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
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
495
496
497
498
499
500
501
502
503
504
505
    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
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530

  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

531
532
533
  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
534
  """
535
536
  retdic = dict.fromkeys(["vg_size", "vg_free", "pv_count"])

Iustin Pop's avatar
Iustin Pop committed
537
538
539
540
541
542
  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)
543
    return retdic
Iustin Pop's avatar
Iustin Pop committed
544
  valarr = retval.stdout.strip().rstrip(':').split(':')
545
546
547
548
549
550
551
552
553
554
555
556
  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
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
  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.

584
  """
Iustin Pop's avatar
Iustin Pop committed
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
  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.

608
  """
Iustin Pop's avatar
Iustin Pop committed
609
610
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
646
  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


647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
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


682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
def MigrateInstance(instance, target, live):
  """Migrates an instance to another node.

  """
  hyper = hypervisor.GetHypervisor()

  try:
    hyper.MigrateInstance(instance, target, live)
  except errors.HypervisorError, err:
    msg = "Failed to migrate instance: %s" % str(err)
    logger.Error(msg)
    return (False, msg)
  return (True, "Migration successfull")


697
def CreateBlockDevice(disk, size, owner, on_primary, info):
Iustin Pop's avatar
Iustin Pop committed
698
699
700
  """Creates a block device for an instance.

  Args:
701
702
703
   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
704
705
   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
706
707
708
709
710
711
712
713
714
715

  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:
716
      crdev = _RecursiveAssembleBD(child, owner, on_primary)
Iustin Pop's avatar
Iustin Pop committed
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
      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():
736
    if not device.Assemble():
737
738
739
740
      errorstring = "Can't assemble device after creation"
      logger.Error(errorstring)
      raise errors.BlockDeviceError("%s, very unusual event - check the node"
                                    " daemon logs" % errorstring)
741
    device.SetSyncSpeed(constants.SYNC_SPEED)
Iustin Pop's avatar
Iustin Pop committed
742
743
    if on_primary or disk.OpenOnSecondary():
      device.Open(force=True)
744
745
    DevCacheManager.UpdateCache(device.dev_path, owner,
                                on_primary, disk.iv_name)
746
747
748

  device.SetInfo(info)

Iustin Pop's avatar
Iustin Pop committed
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
  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:
768
    r_path = rdev.dev_path
Iustin Pop's avatar
Iustin Pop committed
769
    result = rdev.Remove()
770
771
    if result:
      DevCacheManager.RemoveCache(r_path)
Iustin Pop's avatar
Iustin Pop committed
772
773
774
775
776
777
778
779
  else:
    result = True
  if disk.children:
    for child in disk.children:
      result = result and RemoveBlockDevice(child)
  return result


780
def _RecursiveAssembleBD(disk, owner, as_primary):
Iustin Pop's avatar
Iustin Pop committed
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
  """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:
799
800
801
802
803
    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
804
    for chld_disk in disk.children:
805
806
807
      try:
        cdev = _RecursiveAssembleBD(chld_disk, owner, as_primary)
      except errors.BlockDeviceError, err:
808
        if children.count(None) >= mcn:
809
810
811
812
          raise
        cdev = None
        logger.Debug("Error in child activation: %s" % str(err))
      children.append(cdev)
Iustin Pop's avatar
Iustin Pop committed
813
814
815

  if as_primary or disk.AssembleOnSecondary():
    r_dev = bdev.AttachOrAssemble(disk.dev_type, disk.physical_id, children)
816
    r_dev.SetSyncSpeed(constants.SYNC_SPEED)
Iustin Pop's avatar
Iustin Pop committed
817
818
819
    result = r_dev
    if as_primary or disk.OpenOnSecondary():
      r_dev.Open()
820
821
822
    DevCacheManager.UpdateCache(r_dev.dev_path, owner,
                                as_primary, disk.iv_name)

Iustin Pop's avatar
Iustin Pop committed
823
824
825
826
827
  else:
    result = True
  return result


828
def AssembleBlockDevice(disk, owner, as_primary):
Iustin Pop's avatar
Iustin Pop committed
829
830
831
832
833
834
835
836
837
  """Activate a block device for an instance.

  This is a wrapper over _RecursiveAssembleBD.

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

  """
838
  result = _RecursiveAssembleBD(disk, owner, as_primary)
Iustin Pop's avatar
Iustin Pop committed
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
  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:
857
    r_path = r_dev.dev_path
Iustin Pop's avatar
Iustin Pop committed
858
    result = r_dev.Shutdown()
859
860
    if result:
      DevCacheManager.RemoveCache(r_path)
Iustin Pop's avatar
Iustin Pop committed
861
862
863
864
865
866
867
868
  else:
    result = True
  if disk.children:
    for child in disk.children:
      result = result and ShutdownBlockDevice(child)
  return result


869
870
def MirrorAddChildren(parent_cdev, new_cdevs):
  """Extend a mirrored block device.
Iustin Pop's avatar
Iustin Pop committed
871
872

  """
873
874
875
  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
876
    return False
877
878
  new_bdevs = [_RecursiveFindBD(disk) for disk in new_cdevs]
  if new_bdevs.count(None) > 0:
879
880
    logger.Error("Can't find new device(s) to add: %s:%s" %
                 (new_bdevs, new_cdevs))
Iustin Pop's avatar
Iustin Pop committed
881
    return False
882
  parent_bdev.AddChildren(new_bdevs)
Iustin Pop's avatar
Iustin Pop committed
883
884
885
  return True


886
887
def MirrorRemoveChildren(parent_cdev, new_cdevs):
  """Shrink a mirrored block device.
Iustin Pop's avatar
Iustin Pop committed
888
889

  """
890
891
  parent_bdev = _RecursiveFindBD(parent_cdev)
  if parent_bdev is None:
892
    logger.Error("Can't find parent in remove children: %s" % parent_cdev)
Iustin Pop's avatar
Iustin Pop committed
893
    return False
894
895
896
897
898
899
900
901
902
903
904
905
906
907
  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
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
  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:
926
      raise errors.BlockDeviceError("Can't find device %s" % str(dsk))
Iustin Pop's avatar
Iustin Pop committed
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
    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
970
  return (rbd.dev_path, rbd.major, rbd.minor) + rbd.GetSyncStatus()
Iustin Pop's avatar
Iustin Pop committed
971
972
973
974
975
976
977
978
979
980
981
982
983
984


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

985
986
987
988
  allowed_files = [
    constants.CLUSTER_CONF_FILE,
    constants.ETC_HOSTS,
    constants.SSH_KNOWN_HOSTS_FILE,
989
    constants.VNC_PASSWORD_FILE,
990
    ]
991
992
  allowed_files.extend(ssconf.SimpleStore().GetFileList())
  if file_name not in allowed_files:
Iustin Pop's avatar
Iustin Pop committed
993
994
995
996
    logger.Error("Filename passed to UploadFile not in allowed"
                 " upload targets: '%s'" % file_name)
    return False

997
998
  utils.WriteFile(file_name, data=data, mode=mode, uid=uid, gid=gid,
                  atime=atime, mtime=mtime)
Iustin Pop's avatar
Iustin Pop committed
999
1000
  return True

1001

Iustin Pop's avatar
Iustin Pop committed
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
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
1016

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

Alexander Schreiber's avatar
Alexander Schreiber committed
1020
  This function will try to read the API version of the os given by
1021
1022
1023
1024
  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
1025
1026
1027
1028
1029
1030
1031

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

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

  if not stat.S_ISREG(stat.S_IFMT(st.st_mode)):
1036
    raise errors.InvalidOS(name, os_dir, "'ganeti_api_version' file is not"
1037
                           " a regular file")
Iustin Pop's avatar
Iustin Pop committed
1038
1039
1040
1041
1042
1043
1044
1045

  try:
    f = open(api_file)
    try:
      api_version = f.read(256)
    finally:
      f.close()
  except EnvironmentError, err:
1046
    raise errors.InvalidOS(name, os_dir, "error while reading the"
1047
                           " API version (%s)" % _ErrnoOrStr(err))
Iustin Pop's avatar
Iustin Pop committed
1048
1049
1050
1051
1052

  api_version = api_version.strip()
  try:
    api_version = int(api_version)
  except (TypeError, ValueError), err:
1053
1054
    raise errors.InvalidOS(name, os_dir,
                           "API version is not integer (%s)" % str(err))
Iustin Pop's avatar
Iustin Pop committed
1055
1056
1057

  return api_version

1058

1059
def DiagnoseOS(top_dirs=None):
Iustin Pop's avatar
Iustin Pop committed
1060
1061
  """Compute the validity for all OSes.

1062
1063
  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
1064
1065

  Returns:
1066
    list of OS objects
Iustin Pop's avatar
Iustin Pop committed
1067
1068

  """
1069
1070
  if top_dirs is None:
    top_dirs = constants.OS_SEARCH_PATH
Iustin Pop's avatar
Iustin Pop committed
1071
1072

  result = []
Iustin Pop's avatar
Iustin Pop committed
1073
1074
  for dir_name in top_dirs:
    if os.path.isdir(dir_name):
1075
      try:
Iustin Pop's avatar
Iustin Pop committed
1076
        f_names = utils.ListVisibleFiles(dir_name)
1077
      except EnvironmentError, err:
Iustin Pop's avatar
Iustin Pop committed
1078
1079
        logger.Error("Can't list the OS directory %s: %s" %
                     (dir_name, str(err)))
1080
1081
1082
        break
      for name in f_names:
        try:
Iustin Pop's avatar
Iustin Pop committed
1083
          os_inst = OSFromDisk(name, base_dir=dir_name)
1084
1085
          result.append(os_inst)
        except errors.InvalidOS, err:
1086
          result.append(objects.OS.FromInvalidOS(err))
Iustin Pop's avatar
Iustin Pop committed
1087
1088
1089
1090

  return result


1091
def OSFromDisk(name, base_dir=None):
Iustin Pop's avatar
Iustin Pop committed
1092
1093
1094
1095
1096
1097
1098
  """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.

1099
1100
1101
1102
  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
1103
  """
1104

1105
  if base_dir is None:
1106
    os_dir = utils.FindFile(name, constants.OS_SEARCH_PATH, os.path.isdir)
1107
1108
1109
1110
    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
1111

1112
  api_version = _OSOndiskVersion(name, os_dir)
Iustin Pop's avatar
Iustin Pop committed
1113
1114

  if api_version != constants.OS_API_VERSION:
1115
1116
    raise errors.InvalidOS(name, os_dir, "API version mismatch"
                           " (found %s want %s)"
1117
                           % (api_version, constants.OS_API_VERSION))
Iustin Pop's avatar
Iustin Pop committed
1118
1119

  # OS Scripts dictionary, we will populate it with the actual script names
1120
  os_scripts = {'create': '', 'export': '', 'import': '', 'rename': ''}
Iustin Pop's avatar
Iustin Pop committed
1121
1122
1123
1124
1125
1126
1127

  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:
1128
      raise errors.InvalidOS(name, os_dir, "'%s' script missing (%s)" %
1129
                             (script, _ErrnoOrStr(err)))
Iustin Pop's avatar
Iustin Pop committed
1130
1131

    if stat.S_IMODE(st.st_mode) & stat.S_IXUSR != stat.S_IXUSR:
1132
1133
      raise errors.InvalidOS(name, os_dir, "'%s' script not executable" %
                             script)
Iustin Pop's avatar
Iustin Pop committed
1134
1135

    if not stat.S_ISREG(stat.S_IFMT(st.st_mode)):
1136
1137
      raise errors.InvalidOS(name, os_dir, "'%s' is not a regular file" %
                             script)
Iustin Pop's avatar
Iustin Pop committed
1138
1139


1140
  return objects.OS(name=name, path=os_dir, status=constants.OS_VALID_STATUS,
Iustin Pop's avatar
Iustin Pop committed
1141
1142
1143
                    create_script=os_scripts['create'],
                    export_script=os_scripts['export'],
                    import_script=os_scripts['import'],
1144
                    rename_script=os_scripts['rename'],
Iustin Pop's avatar
Iustin Pop committed
1145
1146
1147
                    api_version=api_version)


1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
def GrowBlockDevice(disk, amount):
  """Grow a stack of block devices.

  This function is called recursively, with the childrens being the
  first one resize.

  Args:
    disk: the disk to be grown

  Returns: a tuple of (status, result), with:
    status: the result (true/false) of the operation
    result: the error message if the operation failed, otherwise not used

  """
  r_dev = _RecursiveFindBD(disk)
  if r_dev is None:
    return False, "Cannot find block device %s" % (disk,)

  try:
    r_dev.Grow(amount)
  except errors.BlockDeviceError, err:
    return False, str(err)

  return True, None


Iustin Pop's avatar
Iustin Pop committed
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
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.

1186
  """
Iustin Pop's avatar
Iustin Pop committed
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
  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)
1197
  elif disk.dev_type == constants.LD_LV:
Iustin Pop's avatar
Iustin Pop committed
1198
1199
1200
1201
1202
1203
1204
    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:
1205
    raise errors.ProgrammerError("Cannot snapshot non-lvm block device"
1206
                                 " '%s' of type '%s'" %
1207
                                 (disk.unique_id, disk.dev_type))
Iustin Pop's avatar
Iustin Pop committed
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220


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.

1221
  """
Iustin Pop's avatar
Iustin Pop committed
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
  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"

1249
  destcmd = utils.BuildShellCmd("mkdir -p %s && cat > %s/%s",
1250
                                destdir, destdir, destfile)
1251
1252
  remotecmd = _GetSshRunner().BuildCmd(dest_node, constants.GANETI_RUNAS,
                                       destcmd)
Iustin Pop's avatar
Iustin Pop committed
1253
1254

  # all commands have been checked, so we're safe to combine them
1255
  command = '|'.join([expcmd, comprcmd, utils.ShellQuoteArgs(remotecmd)])
Iustin Pop's avatar
Iustin Pop committed
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277

  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.

1278
  """
Iustin Pop's avatar
Iustin Pop committed
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
  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)
1296
1297

  nic_count = 0
Iustin Pop's avatar
Iustin Pop committed
1298
1299
1300
1301
  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
1302
    config.set(constants.INISECT_INS, 'nic%d_bridge' % nic_count, '%s' % nic.bridge)
Iustin Pop's avatar
Iustin Pop committed
1303
1304
1305
  # TODO: redundant: on load can read nics until it doesn't exist
  config.set(constants.INISECT_INS, 'nic_count' , '%d' % nic_count)

1306
  disk_count = 0
Iustin Pop's avatar
Iustin Pop committed
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
  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
1368
1369
  os_device = instance.FindDisk(os_disk)
  if os_device is None:
Iustin Pop's avatar
Iustin Pop committed
1370
1371
1372
    logger.Error("Can't find this device-visible name '%s'" % os_disk)
    return False

Iustin Pop's avatar
Iustin Pop committed
1373
1374
  swap_device = instance.FindDisk(swap_disk)
  if swap_device is None:
Iustin Pop's avatar
Iustin Pop committed
1375
1376
1377
1378
1379
    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:
1380
1381
    raise errors.BlockDeviceError("Block device '%s' is not set up" %
                                  str(os_device))
Iustin Pop's avatar
Iustin Pop committed
1382
1383
1384
1385
  real_os_dev.Open()

  real_swap_dev = _RecursiveFindBD(swap_device)
  if real_swap_dev is None:
1386
1387
    raise errors.BlockDeviceError("Block device '%s' is not set up" %
                                  str(swap_device))
Iustin Pop's avatar
Iustin Pop committed
1388
1389
1390
1391
1392
1393
1394
  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)

1395
  destcmd = utils.BuildShellCmd('cat %s', src_image)
1396
1397
  remotecmd = _GetSshRunner().BuildCmd(src_node, constants.GANETI_RUNAS,
                                       destcmd)
Iustin Pop's avatar
Iustin Pop committed
1398
1399
1400
1401
1402
1403
1404

  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)

1405
  command = '|'.join([utils.ShellQuoteArgs(remotecmd), comprcmd, impcmd])
Iustin Pop's avatar
Iustin Pop committed
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419

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

Iustin Pop's avatar
Iustin Pop committed
1421
1422
  """
  if os.path.isdir(constants.EXPORT_DIR):
1423
    return utils.ListVisibleFiles(constants.EXPORT_DIR)
Iustin Pop's avatar
Iustin Pop committed
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
  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.

1437
  """
Iustin Pop's avatar
Iustin Pop committed
1438
1439
1440
1441
1442
1443
1444
1445
1446
  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
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
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:
1462
      old_rpath = dev.dev_path
Iustin Pop's avatar
Iustin Pop committed
1463
      dev.Rename(unique_id)
1464
1465
1466
1467
1468
1469
1470
1471
      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
1472
1473
1474
1475
1476
1477
1478
    except errors.BlockDeviceError, err:
      logger.Error("Can't rename device '%s' to '%s': %s" %
                   (dev, unique_id, err))
      result = False
  return result


1479
1480
1481
1482
1483
1484
1485
1486
1487
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
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
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
1561
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
1601
1602
  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


1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
def CloseBlockDevices(disks):
  """Closes the given block devices.

  This means they will be switched to secondary mode (in case of DRBD).

  """
  bdevs = []
  for cf in disks:
    rd = _RecursiveFindBD(cf)
    if rd is None:
      return (False, "Can't find device %s" % cf)
    bdevs.append(rd)

  msg = []
  for rd in bdevs:
    try:
      rd.Close()
    except errors.BlockDeviceError, err:
      msg.append(str(err))
  if msg:
    return (False, "Can't make devices secondary: %s" % ",".join(msg))
  else:
    return (True, "All devices secondary")


Iustin Pop's avatar
Iustin Pop committed
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639