123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447 |
- # vim: fileencoding=utf-8
- # pylint: disable=abstract-method
- #
- # The Qubes OS Project, http://www.qubes-os.org
- #
- # Copyright (C) 2016 Bahtiar `kalkin-` Gadimov <bahtiar@gadimov.de>
- #
- # 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.
- #
- ''' Driver for storing vm images in a LVM thin pool '''
- import logging
- import os
- import subprocess
- import qubes
- class ThinPool(qubes.storage.Pool):
- ''' LVM Thin based pool implementation
- ''' # pylint: disable=protected-access
- size_cache = None
- driver = 'lvm_thin'
- def __init__(self, volume_group, thin_pool, revisions_to_keep=1, **kwargs):
- super(ThinPool, self).__init__(revisions_to_keep=revisions_to_keep,
- **kwargs)
- self.volume_group = volume_group
- self.thin_pool = thin_pool
- self._pool_id = "{!s}/{!s}".format(volume_group, thin_pool)
- self.log = logging.getLogger('qube.storage.lvm.%s' % self._pool_id)
- def clone(self, source, target):
- cmd = ['clone', str(source), str(target)]
- qubes_lvm(cmd, self.log)
- return target
- def _commit(self, volume):
- msg = "Trying to commit {!s}, but it has save_on_stop == False"
- msg = msg.format(volume)
- assert volume.save_on_stop, msg
- msg = "Trying to commit {!s}, but it has rw == False"
- msg = msg.format(volume)
- assert volume.rw, msg
- assert hasattr(volume, '_vid_snap')
- cmd = ['remove', volume.vid + "-back"]
- qubes_lvm(cmd, self.log)
- cmd = ['clone', volume._vid_snap, volume.vid + "-back"]
- qubes_lvm(cmd, self.log)
- cmd = ['remove', volume.vid]
- qubes_lvm(cmd, self.log)
- cmd = ['clone', volume._vid_snap, volume.vid]
- qubes_lvm(cmd, self.log)
- cmd = ['remove', volume._vid_snap]
- @property
- def config(self):
- return {
- 'name': self.name,
- 'volume_group': self.volume_group,
- 'thin_pool': self.thin_pool,
- 'driver': ThinPool.driver
- }
- def create(self, volume):
- assert volume.vid
- assert volume.size
- if volume.source:
- return self.clone(volume.source, volume)
- else:
- cmd = [
- 'create',
- self._pool_id,
- volume.vid.split('/', 1)[1],
- str(volume.size)
- ]
- qubes_lvm(cmd, self.log)
- reset_cache()
- return volume
- def destroy(self):
- pass # TODO Should we remove an existing pool?
- def export(self, volume):
- ''' Returns an object that can be `open()`. '''
- return '/dev/' + volume.vid
- def init_volume(self, vm, volume_config):
- ''' Initialize a :py:class:`qubes.storage.Volume` from `volume_config`.
- '''
- if 'vid' not in volume_config.keys():
- if vm and hasattr(vm, 'name'):
- vm_name = vm.name
- else:
- # for the future if we have volumes not belonging to a vm
- vm_name = qubes.utils.random_string()
- assert self.name
- volume_config['vid'] = "{!s}/{!s}-{!s}".format(
- self.volume_group, vm_name, volume_config['name'])
- volume_config['volume_group'] = self.volume_group
- return ThinVolume(**volume_config)
- def import_volume(self, dst_pool, dst_volume, src_pool, src_volume):
- if not src_volume.save_on_stop:
- return dst_volume
- src_path = src_pool.export(src_volume)
- # HACK: neat trick to speed up testing if you have same physical thin
- # pool assigned to two qubes-pools i.e: qubes_dom0 and test-lvm
- # pylint: disable=line-too-long
- if isinstance(src_pool, ThinPool) and src_pool.thin_pool == dst_pool.thin_pool: # NOQA
- return self.clone(src_volume, dst_volume)
- else:
- dst_volume = self.create(dst_volume)
- cmd = ['sudo', 'qubes-lvm', 'import', dst_volume.vid]
- blk_size = 4096
- p = subprocess.Popen(cmd, stdin=subprocess.PIPE)
- dst = p.stdin
- with open(src_path, 'rb') as src:
- while True:
- tmp = src.read(blk_size)
- if not tmp:
- break
- else:
- dst.write(tmp)
- p.stdin.close()
- p.wait()
- reset_cache()
- return dst_volume
- def is_dirty(self, volume):
- if volume.save_on_stop:
- return os.path.exists(volume.path + '-snap')
- return False
- def remove(self, volume):
- assert volume.vid
- if self.is_dirty(volume):
- cmd = ['remove', volume._vid_snap]
- qubes_lvm(cmd, self.log)
- cmd = ['remove', volume.vid]
- qubes_lvm(cmd, self.log)
- reset_cache()
- def rename(self, volume, old_name, new_name):
- ''' Called when the domain changes its name '''
- new_vid = "{!s}/{!s}-{!s}".format(self.volume_group, new_name,
- volume.name)
- if volume.save_on_stop:
- cmd = ['clone', volume.vid, new_vid]
- qubes_lvm(cmd, self.log)
- if volume.save_on_stop or volume._is_volatile:
- cmd = ['remove', volume.vid]
- qubes_lvm(cmd, self.log)
- volume.vid = new_vid
- if not volume._is_volatile:
- volume._vid_snap = volume.vid + '-snap'
- reset_cache()
- return volume
- def revert(self, volume, revision=None):
- old_path = volume.path + '-back'
- if not os.path.exists(old_path):
- msg = "Volume {!s} has no {!s}".format(volume, old_path)
- raise qubes.storage.StoragePoolException(msg)
- cmd = ['remove', volume.vid]
- qubes_lvm(cmd, self.log)
- cmd = ['clone', volume.vid + '-back', volume.vid]
- qubes_lvm(cmd, self.log)
- reset_cache()
- return volume
- def resize(self, volume, size):
- ''' Expands volume, throws
- :py:class:`qubst.storage.qubes.storage.StoragePoolException` if
- given size is less than current_size
- '''
- if not volume.rw:
- msg = 'Can not resize reađonly volume {!s}'.format(volume)
- raise qubes.storage.StoragePoolException(msg)
- if size <= volume.size:
- raise qubes.storage.StoragePoolException(
- 'For your own safety, shrinking of %s is'
- ' disabled. If you really know what you'
- ' are doing, use `lvresize` on %s manually.' %
- (volume.name, volume.vid))
- cmd = ['extend', volume.vid, str(size)]
- qubes_lvm(cmd, self.log)
- reset_cache()
- def _reset(self, volume):
- try:
- self.remove(volume)
- except qubes.storage.StoragePoolException:
- pass
- self.create(volume)
- def setup(self):
- pass # TODO Should we create a non existing pool?
- def start(self, volume):
- if volume._is_snapshot:
- self._snapshot(volume)
- elif volume._is_volatile:
- self._reset(volume)
- else:
- if not self.is_dirty(volume):
- self._snapshot(volume)
- reset_cache()
- return volume
- def stop(self, volume):
- if volume.save_on_stop:
- self._commit(volume)
- if volume._is_snapshot:
- cmd = ['remove', volume._vid_snap]
- qubes_lvm(cmd, self.log)
- elif volume._is_volatile:
- cmd = ['remove', volume.vid]
- qubes_lvm(cmd, self.log)
- else:
- cmd = ['remove', volume._vid_snap]
- qubes_lvm(cmd, self.log)
- reset_cache()
- return volume
- def _snapshot(self, volume):
- try:
- cmd = ['remove', volume._vid_snap]
- qubes_lvm(cmd, self.log)
- except: # pylint: disable=bare-except
- pass
- if volume.source is None:
- cmd = ['clone', volume.vid, volume._vid_snap]
- else:
- cmd = ['clone', str(volume.source), volume._vid_snap]
- qubes_lvm(cmd, self.log)
- def verify(self, volume):
- ''' Verifies the volume. '''
- cmd = ['sudo', 'qubes-lvm', 'volumes',
- self.volume_group + '/' + self.thin_pool]
- p = subprocess.Popen(cmd, stdout=subprocess.PIPE)
- result = p.communicate()[0]
- for line in result.splitlines():
- if not line.strip():
- continue
- vid, atr = line.strip().split(' ')
- if vid == volume.vid:
- return atr[4] == 'a'
- return False
- @property
- def volumes(self):
- ''' Return a list of volumes managed by this pool '''
- cmd = ['sudo', 'qubes-lvm', 'volumes',
- self.volume_group + '/' + self.thin_pool]
- p = subprocess.Popen(cmd, stdout=subprocess.PIPE)
- result = p.communicate()[0]
- volumes = []
- for line in result.splitlines():
- if not line.strip():
- continue
- vid, atr = line.strip().split(' ')
- config = {
- 'pool': self.name,
- 'vid': vid,
- 'name': vid,
- 'volume_group': self.volume_group,
- 'rw': atr[1] == 'w',
- }
- volumes += [ThinVolume(**config)]
- return volumes
- def _reset_volume(self, volume):
- ''' Resets a volatile volume '''
- assert volume.volume_type == 'volatile', \
- 'Expected a volatile volume, but got {!r}'.format(volume)
- self.log.debug('Resetting volatile ' + volume.vid)
- cmd = ['remove', volume.vid]
- qubes_lvm(cmd, self.log)
- cmd = ['create', self._pool_id, volume.vid.split('/')[1],
- str(volume.size)]
- qubes_lvm(cmd, self.log)
- def init_cache(log=logging.getLogger('qube.storage.lvm')):
- cmd = ['sudo', 'lvs', '--noheadings', '-o',
- 'vg_name,name,lv_size,data_percent', '--units', 'b', '--separator',
- ',']
- p = subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
- out, err = p.communicate()
- return_code = p.returncode
- if return_code == 0 and err:
- log.warning(err)
- elif return_code != 0:
- raise qubes.storage.StoragePoolException(err)
- result = {}
- for line in out.splitlines():
- line = line.strip()
- pool_name, name, size, usage_percent = line.split(',', 3)
- if '' in [pool_name, name, size, usage_percent]:
- continue
- name = pool_name + "/" + name
- size = int(size[:-1])
- usage = int(size / 100 * float(usage_percent))
- result[name] = {'size':size, 'usage': usage}
- return result
- size_cache = init_cache()
- class ThinVolume(qubes.storage.Volume):
- ''' Default LVM thin volume implementation
- ''' # pylint: disable=too-few-public-methods
- def __init__(self, volume_group, size=0, **kwargs):
- self.volume_group = volume_group
- super(ThinVolume, self).__init__(size=size, **kwargs)
- if self.snap_on_start and self.source is None:
- msg = "snap_on_start specified on {!r} but no volume source set"
- msg = msg.format(self.name)
- raise qubes.storage.StoragePoolException(msg)
- elif not self.snap_on_start and self.source is not None:
- msg = "source specified on {!r} but no snap_on_start set"
- msg = msg.format(self.name)
- raise qubes.storage.StoragePoolException(msg)
- self.path = '/dev/' + self.vid
- if not self._is_volatile:
- self._vid_snap = self.vid + '-snap'
- self._size = size
- @property
- def revisions(self):
- path = self.path + '-back'
- if os.path.exists(path):
- seconds = os.path.getctime(path)
- iso_date = qubes.storage.isodate(seconds).split('.', 1)[0]
- return {iso_date: path}
- return {}
- @property
- def _is_origin(self):
- return not self.snap_on_start and self.save_on_stop
- @property
- def _is_origin_snapshot(self):
- return self.snap_on_start and self.save_on_stop
- @property
- def _is_snapshot(self):
- return self.snap_on_start and not self.save_on_stop
- @property
- def _is_volatile(self):
- return not self.snap_on_start and not self.save_on_stop
- @property
- def size(self):
- try:
- return qubes.storage.lvm.size_cache[self.vid]['size']
- except KeyError:
- return self._size
- @size.setter
- def size(self, _):
- raise qubes.storage.StoragePoolException(
- "You shouldn't use lvm size setter")
- @property
- def usage(self): # lvm thin usage always returns at least the same usage as
- # the parent
- try:
- return qubes.storage.lvm.size_cache[self.vid]['usage']
- except KeyError:
- return 0
- def pool_exists(pool_id):
- ''' Return true if pool exists '''
- cmd = ['pool', pool_id]
- return qubes_lvm(cmd)
- def qubes_lvm(cmd, log=logging.getLogger('qube.storage.lvm')):
- ''' Call :program:`qubes-lvm` to execute an LVM operation '''
- # TODO Refactor this ones the udev groups gets fixed and we don't need root
- # for operations on lvm devices
- cmd = ['sudo', 'qubes-lvm'] + cmd
- p = subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
- out, err = p.communicate()
- return_code = p.returncode
- if out:
- log.debug(out)
- if return_code == 0 and err:
- log.warning(err)
- elif return_code != 0:
- assert err, "Command exited unsuccessful, but printed nothing to stderr"
- raise qubes.storage.StoragePoolException(err)
- return True
- def reset_cache():
- qubes.storage.lvm.size_cache = init_cache()
|