e1de82ea53
Especially inherit from QubesException, so tools will treat this as properly handled error. QubesOS/qubes-issues#2257
300 lines
10 KiB
Python
300 lines
10 KiB
Python
#!/usr/bin/python2 -O
|
|
# vim: fileencoding=utf-8
|
|
|
|
#
|
|
# The Qubes OS Project, https://www.qubes-os.org/
|
|
#
|
|
# Copyright (C) 2010-2016 Joanna Rutkowska <joanna@invisiblethingslab.com>
|
|
# Copyright (C) 2015-2016 Wojtek Porczyk <woju@invisiblethingslab.com>
|
|
# 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.
|
|
#
|
|
|
|
'''API for various types of devices.
|
|
|
|
Main concept is that some domain main
|
|
expose (potentially multiple) devices, which can be attached to other domains.
|
|
Devices can be of different classes (like 'pci', 'usb', etc). Each device
|
|
class is implemented by an extension.
|
|
|
|
Devices are identified by pair of (backend domain, `ident`), where `ident` is
|
|
:py:class:`str`.
|
|
|
|
Such extension should provide:
|
|
- `qubes.devices` endpoint - a class descendant from
|
|
:py:class:`qubes.devices.DeviceInfo`, designed to hold device description (
|
|
including class-specific properties)
|
|
- handle `device-attach:class` and `device-detach:class` events for
|
|
performing the attach/detach action; events are fired even when domain isn't
|
|
running and extension should be prepared for this
|
|
- handle `device-list:class` event - list devices exposed by particular
|
|
domain; it should return list of appropriate DeviceInfo objects
|
|
- handle `device-get:class` event - get one device object exposed by this
|
|
domain of given identifier
|
|
- handle `device-list-attached:class` event - list currently attached
|
|
devices to this domain
|
|
'''
|
|
import qubes.utils
|
|
|
|
|
|
class DeviceNotAttached(qubes.exc.QubesException, KeyError):
|
|
'''Trying to detach not attached device'''
|
|
pass
|
|
|
|
class DeviceAlreadyAttached(qubes.exc.QubesException, KeyError):
|
|
'''Trying to attach already attached device'''
|
|
pass
|
|
|
|
|
|
class DeviceCollection(object):
|
|
'''Bag for devices.
|
|
|
|
Used as default value for :py:meth:`DeviceManager.__missing__` factory.
|
|
|
|
:param vm: VM for which we manage devices
|
|
:param class_: device class
|
|
|
|
This class emits following events on VM object:
|
|
|
|
.. event:: device-attach:<class> (device)
|
|
|
|
Fired when device is attached to a VM.
|
|
|
|
:param device: :py:class:`DeviceInfo` object to be attached
|
|
|
|
.. event:: device-pre-attach:<class> (device)
|
|
|
|
Fired before device is attached to a VM
|
|
|
|
:param device: :py:class:`DeviceInfo` object to be attached
|
|
|
|
.. event:: device-detach:<class> (device)
|
|
|
|
Fired when device is detached from a VM.
|
|
|
|
:param device: :py:class:`DeviceInfo` object to be attached
|
|
|
|
.. event:: device-pre-detach:<class> (device)
|
|
|
|
Fired before device is detached from a VM
|
|
|
|
:param device: :py:class:`DeviceInfo` object to be attached
|
|
|
|
.. event:: device-list:<class>
|
|
|
|
Fired to get list of devices exposed by a VM. Handlers of this
|
|
event should return a list of py:class:`DeviceInfo` objects (or
|
|
appropriate class specific descendant)
|
|
|
|
.. event:: device-get:<class> (ident)
|
|
|
|
Fired to get a single device, given by the `ident` parameter.
|
|
Handlers of this event should either return appropriate object of
|
|
:py:class:`DeviceInfo`, or :py:obj:`None`. Especially should not
|
|
raise :py:class:`exceptions.KeyError`.
|
|
|
|
.. event:: device-list-attached:<class> (persistent)
|
|
|
|
Fired to get list of currently attached devices to a VM. Handlers
|
|
of this event should return list of devices actually attached to
|
|
a domain, regardless of its settings.
|
|
|
|
'''
|
|
|
|
def __init__(self, vm, class_):
|
|
self._vm = vm
|
|
self._class = class_
|
|
self._set = set()
|
|
|
|
self.devclass = qubes.utils.get_entry_point_one(
|
|
'qubes.devices', self._class)
|
|
|
|
def attach(self, device, persistent=True):
|
|
'''Attach (add) device to domain.
|
|
|
|
:param DeviceInfo device: device object
|
|
'''
|
|
|
|
if device in self.attached():
|
|
raise DeviceAlreadyAttached(
|
|
'device {!r} of class {} already attached to {!r}'.format(
|
|
device, self._class, self._vm))
|
|
self._vm.fire_event_pre('device-pre-attach:' + self._class, device)
|
|
if persistent:
|
|
self._set.add(device)
|
|
self._vm.fire_event('device-attach:' + self._class, device)
|
|
|
|
|
|
def detach(self, device, persistent=True):
|
|
'''Detach (remove) device from domain.
|
|
|
|
:param DeviceInfo device: device object
|
|
'''
|
|
|
|
if device not in self.attached():
|
|
raise DeviceNotAttached(
|
|
'device {!s} of class {} not attached to {!s}'.format(
|
|
device, self._class, self._vm))
|
|
self._vm.fire_event_pre('device-pre-detach:' + self._class, device)
|
|
if persistent:
|
|
self._set.remove(device)
|
|
self._vm.fire_event('device-detach:' + self._class, device)
|
|
|
|
def attached(self, persistent=None):
|
|
'''List devices which are (or may be) attached to this vm
|
|
|
|
Devices may be attached persistently (so they are included in
|
|
:file:`qubes.xml`) or not. Device can also be in :file:`qubes.xml`,
|
|
but be temporarily detached.
|
|
|
|
:param bool persistent: only include devices which are (or are not) \
|
|
attached persistently - None means both
|
|
'''
|
|
seen = self._set.copy()
|
|
|
|
# ask for really attached devices only when requested not only
|
|
# persistent ones
|
|
if persistent is not True:
|
|
attached = self._vm.fire_event(
|
|
'device-list-attached:' + self._class,
|
|
persistent=persistent)
|
|
for device in attached:
|
|
device_persistent = device in self._set
|
|
if persistent is not None and device_persistent != persistent:
|
|
continue
|
|
assert device.frontend_domain == self._vm, \
|
|
'{!r} != {!r}'.format(device.frontend_domain, self._vm)
|
|
|
|
yield device
|
|
|
|
try:
|
|
seen.remove(device)
|
|
except KeyError:
|
|
pass
|
|
|
|
if persistent is False:
|
|
return
|
|
|
|
for device in seen:
|
|
# get fresh object - may contain updated information
|
|
device = device.backend_domain.devices[self._class][device.ident]
|
|
yield device
|
|
|
|
def available(self):
|
|
'''List devices exposed by this vm'''
|
|
devices = self._vm.fire_event('device-list:' + self._class)
|
|
return devices
|
|
|
|
def __iter__(self):
|
|
return iter(self.available())
|
|
|
|
def __getitem__(self, ident):
|
|
'''Get device object with given ident.
|
|
|
|
:returns: py:class:`DeviceInfo`
|
|
|
|
If domain isn't running, it is impossible to check device validity,
|
|
so return UnknownDevice object. Also do the same for non-existing
|
|
devices - otherwise it will be impossible to detach already
|
|
disconnected device.
|
|
|
|
:raises AssertionError: when multiple devices with the same ident are
|
|
found
|
|
'''
|
|
dev = self._vm.fire_event('device-get:' + self._class, ident)
|
|
if dev:
|
|
assert len(dev) == 1
|
|
return dev[0]
|
|
else:
|
|
return UnknownDevice(self._vm, ident)
|
|
|
|
|
|
class DeviceManager(dict):
|
|
'''Device manager that hold all devices by their classess.
|
|
|
|
:param vm: VM for which we manage devices
|
|
'''
|
|
|
|
def __init__(self, vm):
|
|
super(DeviceManager, self).__init__()
|
|
self._vm = vm
|
|
|
|
def __missing__(self, key):
|
|
self[key] = DeviceCollection(self._vm, key)
|
|
return self[key]
|
|
|
|
|
|
class DeviceInfo(object):
|
|
# pylint: disable=too-few-public-methods
|
|
def __init__(self, backend_domain, ident, description=None,
|
|
frontend_domain=None, **kwargs):
|
|
#: domain providing this device
|
|
self.backend_domain = backend_domain
|
|
#: device identifier (unique for given domain and device type)
|
|
self.ident = ident
|
|
#: human readable description/name of the device
|
|
self.description = description
|
|
#: (running) domain to which device is currently attached
|
|
self.frontend_domain = frontend_domain
|
|
self.data = kwargs
|
|
|
|
if hasattr(self, 'regex'):
|
|
# pylint: disable=no-member
|
|
dev_match = self.regex.match(ident)
|
|
if not dev_match:
|
|
raise ValueError('Invalid device identifier: {!r}'.format(
|
|
ident))
|
|
|
|
for group in self.regex.groupindex:
|
|
setattr(self, group, dev_match.group(group))
|
|
|
|
def __hash__(self):
|
|
return hash(self.ident)
|
|
|
|
def __eq__(self, other):
|
|
return (
|
|
self.backend_domain == other.backend_domain and
|
|
self.ident == other.ident
|
|
)
|
|
|
|
def __str__(self):
|
|
return '{!s}:{!s}'.format(self.backend_domain, self.ident)
|
|
|
|
class UnknownDevice(DeviceInfo):
|
|
# pylint: disable=too-few-public-methods
|
|
'''Unknown device - for example exposed by domain not running currently'''
|
|
|
|
def __init__(self, backend_domain, ident, description=None,
|
|
frontend_domain=None, **kwargs):
|
|
if description is None:
|
|
description = "Unknown device"
|
|
super(UnknownDevice, self).__init__(backend_domain, ident, description,
|
|
frontend_domain, **kwargs)
|
|
|
|
|
|
class BlockDevice(object):
|
|
# pylint: disable=too-few-public-methods
|
|
def __init__(self, path, name, script=None, rw=True, domain=None,
|
|
devtype='disk'):
|
|
assert name, 'Missing device name'
|
|
assert path, 'Missing device path'
|
|
self.path = path
|
|
self.name = name
|
|
self.rw = rw
|
|
self.script = script
|
|
self.domain = domain
|
|
self.devtype = devtype
|