new device API

doc/manpages/qvm-device.rst

@@ -9,7 +9,10 @@ Synopsis
 | :command:`qvm-device` *DEVICE_CLASS* {list,ls,l} [*options*] <*vm-name*>
 | :command:`qvm-device` *DEVICE_CLASS* {attach,at,a} [*options*] <*vm-name*> <*device*>
 | :command:`qvm-device` *DEVICE_CLASS* {detach,dt,d} [*options*] <*vm-name*> [<*device*>]
-| :command:`qvm-*DEVICE_CLASS*` {list,ls,l,attach,at,a,detach,dt,d} [*options*] <*vmname*> ...
+| :command:`qvm-device` *DEVICE_CLASS* {assign,s} [*options*] <*vm-name*> <*device*>
+| :command:`qvm-device` *DEVICE_CLASS* {unassign,u} [*options*] <*vm-name*> [<*device*>]
+| :command:`qvm-device` *DEVICE_CLASS* {info,i} [*options*] <*vm-name*> [<*device*>]
+| :command:`qvm-*DEVICE_CLASS*` {list,ls,l,attach,at,a,detach,dt,d,assign,s,unassign,u,info,i} [*options*] <*vmname*> ...
 
 .. note:: :command:`qvm-block`, :command:`qvm-usb` and :command:`qvm-pci` are just aliases for :command:`qvm-device block`, :command:`qvm-device usb` and :command:`qvm-device pci` respectively.
 
@@ -73,7 +76,7 @@ Attach the device with *DEVICE_ID* from *BACKEND_DOMAIN* to the domain *VMNAME*
 
 .. option:: --persistent, -p
 
-   Attach device persistently, which means have it attached also after qube restart.
+   Alias for `assign --required` for backward compatibility.
 
 aliases: a, at
 
@@ -87,6 +90,52 @@ If no device is given, detach all *DEVICE_CLASS* devices.
 
 aliases: d, dt
 
+assign
+^^^^^^
+
+| :command:`qvm-device` *DEVICE_CLASS* assign [-h] [--verbose] [--quiet] [--ro] *VMNAME* *BACKEND_DOMAIN:DEVICE_ID*
+
+Assign the device with *DEVICE_ID* from *BACKEND_DOMAIN* to the domain *VMNAME*
+
+.. option:: --option, -o
+
+   Specify device-class specific option, use `name=value` format. You can
+   specify this option multiple times. See below for options specific to
+   different device classes.
+
+.. option:: --ro
+
+   Alias for the `read-only=yes` option. If you specify both `--ro` and
+   `--option read-only=no`, `--ro` takes precedence.
+
+.. option:: --required, -r
+
+   Assign device persistently which means it will be required to the qube's startup and then automatically attached.
+
+.. option:: --port
+
+   Ignore device presented identity and attach any device connected to the given port number.
+
+aliases: s
+
+unassign
+^^^^^^^^
+
+| :command:`qvm-device` *DEVICE_CLASS* unassign [-h] [--verbose] [--quiet] *VMNAME* *BACKEND_DOMAIN:DEVICE_ID*
+
+Remove assignment of device with *BACKEND_DOMAIN:DEVICE_ID* from domain *VMNAME*.
+If no device is given, remove assignments of all *DEVICE_CLASS* devices.
+
+aliases: u
+
+info
+^^^^
+
+| :command:`qvm-device` *DEVICE_CLASS* info [-h] [--verbose] [--quiet] *VMNAME* *BACKEND_DOMAIN:DEVICE_ID*
+
+Show info about the device with *DEVICE_ID* from *BACKEND_DOMAIN* attached to the domain *VMNAME*
+
+aliases: i
 
 Device classes
 ==============
@@ -127,5 +176,6 @@ Authors
 | Rafal Wojtczuk <rafal at invisiblethingslab dot com>
 | Marek Marczykowski <marmarek at invisiblethingslab dot com>
 | Frédéric Pierret <frederic.pierret at qubes dash os dot org>
+| Piotr Bartman-Szwarc <prbartman at invisiblethingslab dot com>
 
 | For complete author list see: https://github.com/QubesOS/qubes-core-admin-client.git

doc/manpages/qvm-volume.rst

@@ -1,7 +1,7 @@
 .. program:: qvm-volume
 
 :program:`qvm-volume` -- Qubes volume and block device management
-================================================================
+=================================================================
 
 Synopsis
 --------

qubesadmin/app.py

@@ -39,7 +39,7 @@
 import qubesadmin.utils
 import qubesadmin.vm
 import qubesadmin.config
-import qubesadmin.devices
+import qubesadmin.device_protocol
 
 try:
     import qubesdb
@@ -542,14 +542,11 @@ def clone_vm(self, src_vm, new_name, new_cls=None, pool=None, pools=None,
         if not ignore_devices:
             try:
                 for devclass in src_vm.devices:
-                    for assignment in src_vm.devices[devclass].assignments(
-                            persistent=True):
-                        new_assignment = qubesadmin.devices.DeviceAssignment(
-                            backend_domain=assignment.backend_domain,
-                            ident=assignment.ident,
-                            options=assignment.options,
-                            persistent=assignment.persistent)
-                        dst_vm.devices[devclass].attach(new_assignment)
+                    for assignment in (
+                            src_vm.devices[devclass].get_assigned_devices()):
+                        new_assignment = assignment.clone(
+                            frontend_domain=dst_vm)
+                        dst_vm.devices[devclass].assign(new_assignment)
             except qubesadmin.exc.QubesException:
                 if not ignore_errors:
                     del self.domains[dst_vm.name]

qubesadmin/backup/core2.py

@@ -336,11 +336,10 @@ def import_core2_vm(self, element):
         if pcidevs:
             pcidevs = ast.literal_eval(pcidevs)
         for pcidev in pcidevs:
-            if not pci_strictreset:
-                vm.devices['pci'][('dom0', pcidev.replace(':', '_'))] = {
-                    'no-strict-reset': True}
-            else:
-                vm.devices['pci'][('dom0', pcidev.replace(':', '_'))] = {}
+            ident = pcidev.replace(':', '_')
+            options = {'no-strict-reset': True} if not pci_strictreset else {}
+            options['required'] = True
+            vm.devices['pci'][('dom0', ident)] = options
 
     def load(self):
         with open(self.store, encoding='utf-8') as fh:

qubesadmin/backup/core3.py

@@ -26,6 +26,8 @@
 
 import qubesadmin.backup
 import qubesadmin.firewall
+from qubesadmin import device_protocol
+
 
 class Core3VM(qubesadmin.backup.BackupVM):
     '''VM object'''
@@ -125,6 +127,8 @@ def import_core3_vm(self, element):
                 for opt_node in node.findall('./option'):
                     opt_name = opt_node.get('name')
                     options[opt_name] = opt_node.text
+                options['required'] = device_protocol.qbool(
+                    node.get('required', 'yes'))
                 vm.devices[bus_name][(backend_domain, ident)] = options
 
         # extract base properties

qubesadmin/backup/restore.py

@@ -50,7 +50,7 @@
 from qubesadmin.backup import BackupVM
 from qubesadmin.backup.core2 import Core2Qubes
 from qubesadmin.backup.core3 import Core3Qubes
-from qubesadmin.devices import DeviceAssignment
+from qubesadmin.device_protocol import DeviceAssignment
 from qubesadmin.exc import QubesException
 from qubesadmin.utils import size_to_human
 
@@ -2087,16 +2087,24 @@ def _restore_vms_metadata(self, restore_info):
             for bus in vm.devices:
                 for backend_domain, ident in vm.devices[bus]:
                     options = vm.devices[bus][(backend_domain, ident)]
+                    if 'required' in options:
+                        required = options['required']
+                        del options['required']
+                    else:
+                        required = False
                     assignment = DeviceAssignment(
-                        backend_domain=backend_domain,
+                        backend_domain=self.app.domains[backend_domain],
                         ident=ident,
+                        devclass=bus,
                         options=options,
-                        persistent=True)
+                        attach_automatically=True,
+                        required=required,
+                    )
                     try:
                         if not self.options.verify_only:
-                            new_vm.devices[bus].attach(assignment)
+                            new_vm.devices[bus].assign(assignment)
                     except Exception as err:  # pylint: disable=broad-except
-                        self.log.error('Error attaching device %s:%s to %s: %s',
+                        self.log.error('Error assigning device %s:%s to %s: %s',
                             bus, ident, vm.name, err)
 
         # Set VM dependencies - only non-default setting