Preload disposables

Is a disposable state, it runs on the background and awaits to intercept
calls made to disposables of the same disposable template, having faster
execution times. Information of the design choices is present in the
DispVM class.

To use them, set the number of allowed preloaded for each disposable
template with the feature "preload-dispvm-max". In case there is not
enough available memory, the maximum won't be preloaded at this
instance, but will retry later on at any relevant event, such as a
preloaded being used or a normal qube being requested while a preload
can be created.

GUI daemon requires a running qube to connect to the GUI agent in the
qube, because of that, auto starting the preload mechanism only happens
after a GUI login.

Preloaded qubes are hidden from GUI applications until the qube itself
is requested to be used. Any GUI application that allows opening
applications on preloaded qubes before they are marked as used is
considered a bug. Applications that autostart on the qube are shown
before the qube has its state interrupted, it is also a bug but that
can't be fixed easily.

For: QubesOS/qubes-issues#1512
For: QubesOS/qubes-issues#9918

Author: ben-grande

.gitlab-ci.yml

@@ -63,6 +63,8 @@ include:
   project: QubesOS/qubes-continuous-integration
 - file: /r4.3/gitlab-host.yml
   project: QubesOS/qubes-continuous-integration
+- file: /r4.3/gitlab-host-openqa.yml
+  project: QubesOS/qubes-continuous-integration
 
 lint:
   extends: .lint

.pylintrc

@@ -58,19 +58,19 @@ const-rgx=(([A-Za-z_][A-Za-z0-9_]*)|(__.*__))$
 class-rgx=([A-Z_][a-zA-Z0-9]+|TC_\d\d_[a-zA-Z0-9_]+)$
 
 # Regular expression which should only match correct function names
-function-rgx=[a-z_][a-z0-9_]{2,30}$
+function-rgx=(test_[0-9]{3}_[a-z0-9_]{2,50}|[a-z_][a-z0-9_]{2,40})$
 
 # Regular expression which should only match correct method names
-method-rgx=[a-z_][a-z0-9_]{2,30}$
+method-rgx=(test_[0-9]{3}_[a-z0-9_]{2,50}|[a-z_][a-z0-9_]{2,40})$
 
 # Regular expression which should only match correct instance attribute names
-attr-rgx=[a-z_][a-z0-9_]{2,30}$
+attr-rgx=[a-z_][a-z0-9_]{2,40}$
 
 # Regular expression which should only match correct argument names
-argument-rgx=[a-z_][a-z0-9_]{2,30}$
+argument-rgx=[a-z_][a-z0-9_]{2,40}$
 
 # Regular expression which should only match correct variable names
-variable-rgx=[a-z_][a-z0-9_]{2,30}$
+variable-rgx=[a-z_][a-z0-9_]{2,40}$
 
 # Regular expression which should only match correct list comprehension /
 # generator expression variable names

Makefile

@@ -179,6 +179,7 @@ all:
 
 install:
 ifeq ($(OS),Linux)
+	$(MAKE) install -C linux/autostart
 	$(MAKE) install -C linux/systemd
 	$(MAKE) install -C linux/aux-tools
 	$(MAKE) install -C linux/system-config

linux/autostart/Makefile

@@ -0,0 +1,6 @@
+all:
+	true
+
+install:
+	mkdir -p $(DESTDIR)/etc/xdg/autostart
+	cp qubes-preload-dispvm.desktop $(DESTDIR)/etc/xdg/autostart

linux/autostart/qubes-preload-dispvm.desktop

@@ -0,0 +1,9 @@
+[Desktop Entry]
+Icon=qubes
+Name=Qubes Preload Disposables
+Comment=Workaround for session monitoring with qubes.WaitForSession
+Categories=System;Monitor;
+Exec=systemctl start qubes-preload-dispvm.service
+Terminal=false
+NoDisplay=true
+Type=Application

linux/aux-tools/Makefile

@@ -3,6 +3,7 @@ all:
 
 install:
 	mkdir -p $(DESTDIR)/usr/lib/qubes
-	cp cleanup-dispvms $(DESTDIR)/usr/lib/qubes
-	cp startup-misc.sh $(DESTDIR)/usr/lib/qubes
+	cp preload-dispvm $(DESTDIR)/usr/lib/qubes/
+	cp cleanup-dispvms $(DESTDIR)/usr/lib/qubes/
+	cp startup-misc.sh $(DESTDIR)/usr/lib/qubes/
 	cp fix-dir-perms.sh $(DESTDIR)/usr/lib/qubes/

linux/aux-tools/preload-dispvm

@@ -0,0 +1,35 @@
+#!/usr/bin/env python3
+
+import asyncio
+import concurrent.futures
+import qubesadmin
+
+
+def get_max(qube):
+    return int(qube.features.get("preload-dispvm-max", 0) or 0)
+
+
+async def main():
+    domains = qubesadmin.Qubes().domains
+    appvms = [
+        qube
+        for qube in domains
+        if get_max(qube) > 0
+        and qube.klass == "AppVM"
+        and getattr(qube, "template_for_dispvms", False)
+    ]
+    method = "admin.vm.CreateDisposable"
+    loop = asyncio.get_running_loop()
+    tasks = []
+    with concurrent.futures.ThreadPoolExecutor() as executor:
+        for qube in appvms:
+            maximum = get_max(qube)
+            print(f"{qube}:{maximum}")
+            exec_args = qube.qubesd_call, qube.name, method, "preload-autostart"
+            future = loop.run_in_executor(executor, *exec_args)
+            tasks.append(future)
+        await asyncio.gather(*tasks)
+
+
+if __name__ == "__main__":
+    asyncio.run(main())

linux/systemd/Makefile

@@ -9,6 +9,7 @@ install:
 	cp [email protected] $(DESTDIR)$(UNITDIR)
 	cp qubes-qmemman.service $(DESTDIR)$(UNITDIR)
 	cp qubesd.service $(DESTDIR)$(UNITDIR)
+	cp qubes-preload-dispvm.service $(DESTDIR)$(UNITDIR)
 	install -d $(DESTDIR)$(UNITDIR)/[email protected]
 	install -m 0644 [email protected]_30_qubes.conf \
 		$(DESTDIR)$(UNITDIR)/[email protected]/30_qubes.conf

linux/systemd/qubes-preload-dispvm.service

@@ -0,0 +1,14 @@
+[Unit]
+Description=Preload Qubes DispVMs
+ConditionKernelCommandLine=!qubes.skip_autostart
+# After qmemman so the daemon can create the file containing available memory.
+After=qubesd.service qubes-meminfo-writer-dom0.service
+
+[Service]
+Type=oneshot
+ExecStart=/usr/lib/qubes/preload-dispvm
+Group=qubes
+RemainAfterExit=yes
+
+[Install]
+WantedBy=multi-user.target

linux/systemd/[email protected]

@@ -1,12 +1,12 @@
 [Unit]
 Description=Start Qubes VM %i
 After=qubesd.service qubes-meminfo-writer-dom0.service
+Before=qubes-preload-dispvm.service
 ConditionKernelCommandLine=!qubes.skip_autostart
 
 [Service]
 Type=oneshot
-Environment=DISPLAY=:0
-ExecStart=/usr/bin/qvm-start --skip-if-running %i
+ExecStart=/usr/bin/qvm-start --skip-if-running -- %i
 Group=qubes
 RemainAfterExit=yes