[WIP] Preload disposables #660

ben-grande · 2025-02-21T18:59:27Z

Untested and incomplete.

marmarek · 2025-02-21T20:26:11Z

qubes/api/internal.py

+
+        :return:
+        """
+        dispvm_template = self.arg


self.dest?

But also, who will call it? If something from inside qubesd, then it doesn't need to be an "API" method, just a function somewhere, probably next to the dispvm class.

self.dest?

WIll fix.

But also, who will call it? If something from inside qubesd, then it doesn't need to be an "API" method, just a function somewhere, probably next to the dispvm class.

Haven't determined yet who will call it and not sure it will be something inside qubesd, all I gethered so far is that it needs to run after the autostarted qubes starts, which I presume can be easily monitored.

marmarek · 2025-02-21T20:27:02Z

qubes/api/internal.py

+        dispvm_template = self.arg
+        preload_dispvm = dispvm_template.features.get("preload-dispvm", None)
+        ## TODO: should this function receive disposable name as argument
+        ##       or call admin.vm.CreateDisposable?


IMO makes more sense to create here.

There should be also somewhere a counter how many preloaded disposables should be and if that limit (which may be 0) is reached already, do nothing here.

marmarek · 2025-02-21T20:28:47Z

qubes/api/internal.py

+
+        :return:
+        """
+        used_dispvm = self.arg


self.dest?

marmarek · 2025-02-21T20:31:07Z

qubes/api/internal.py

+        preload_dispvm = preload_dispvm.split(" ")
+        if use_first:
+            used_dispvm_name = preload_dispvm[1:]
+        else:
+            used_dispvm_name = used_dispvm.name


This should also check if the selected dispvm is actually one of preloaded ones.
But also, what is the use case of pointing at specific DispVM, instead of its template?

This should also check if the selected dispvm is actually one of preloaded ones.

Will fix.

But also, what is the use case of pointing at specific DispVM, instead of its template?

In case a specific preloaded dispvm is unpaused.

marmarek · 2025-02-21T20:35:59Z

qubes/api/internal.py

+    @qubes.api.method(
+        "internal.dispvm.preload.Use", scope="local", write=True
+    )
+    async def dispvm_preload_use(self):


This should probably be an utility function somewhere, not an API method exposed to external callers.

I also moved internal.dispvm.preload.Create as a utility function instead of API method.

marmarek · 2025-02-21T20:38:36Z

qubes/vm/dispvm.py

+        if self.is_domain_preloaded():
+            self.pause()


This is easy thing to do, but requires testing if it isn't too early. Some services (especially gui-agent) may still be starting.
There is an qubes.WaitForSession service that may help (ensure to use async handler to not block qubesd while waiting on it).
And also, the event is called domain-start.

There is an qubes.WaitForSession service that may help (ensure to use async handler to not block qubesd while waiting on it).

What is preloaded dispvm has gui feature disabled in case the user is using the disposable to be qubes-builder-dvm for example, that doesn't require a GUI? What can be done in this case?

See also QubesOS/qubes-issues#9789 related to gui feature and +WaitForSession.

And also, the event is called domain-start.

Right... My mind was on domain-unpaused therefore domain-started.

What is preloaded dispvm has gui feature disabled in case the user is using the disposable to be qubes-builder-dvm for example, that doesn't require a GUI? What can be done in this case?

Very good question. In that case I guess start even is all we have. Maybe with some (configurable?) delay?

Added a delay for both enabled gui and disabled gui. There is attribute/prefs qrexec_timeout, I used a delay lower than that, not sure it should be configurable as I don't know the benefits. The preloaded DispVM is paused when the timeout is reached.

marmarek · 2025-02-21T20:39:28Z

qubes/vm/dispvm.py

+    def on_domain_unpaused(self):
+        """Mark unpaused preloaded domains as used."""
+        if self.is_domain_preloaded():
+            self.app.qubesd_call(


This doesn't exist in core-admin - it's only in core-admin-client. Here, you are running inside qubesd already, you can simply call appropriate function directly.

ben-grande · 2025-02-25T12:47:18Z

qubes/vm/dispvm.py

+            )
+            threshold = 1024 * 5
+            if memory >= (available_memory - threshold):
+                await DispVM.create_preloaded_dispvm(self)


This is wrong, should have called QubesAdminAPI.create_disposable with preload argument.

or rather DispVM.from_appvm

There is tiny bit of code that I didn't want to duplicate from create_disposable():

dispvm = await qubes.vm.dispvm.DispVM.from_appvm( dispvm_template, preload=preload ) # TODO: move this to extension (in race-free fashion, better than here) dispvm.tags.add("created-by-" + str(self.src)) dispvm.tags.add("disp-created-by-" + str(self.src))

The tags... although I see some tests not using it:

% rg from_appvm ../qubes-core-* ../qubes-core-admin/qubes/tests/vm/dispvm.py 90: def test_000_from_appvm(self, mock_storage, mock_makedirs, mock_symlink): 104: qubes.vm.dispvm.DispVM.from_appvm(self.appvm) 117: def test_001_from_appvm_reject_not_allowed(self): 120: qubes.vm.dispvm.DispVM.from_appvm(self.appvm) ../qubes-core-admin/qubes/tests/integ/dispvm.py 211: qubes.vm.dispvm.DispVM.from_appvm(self.disp_base) 229: qubes.vm.dispvm.DispVM.from_appvm(self.disp_base) ../qubes-core-admin/qubes/vm/dispvm.py 390: async def from_appvm(cls, appvm, preload=False, **kwargs): 401: >>> dispvm = qubes.vm.dispvm.DispVM.from_appvm(appvm).start() ../qubes-core-admin/qubes/api/admin.py 1291: dispvm = await qubes.vm.dispvm.DispVM.from_appvm( ../qubes-core-admin-client/qubesadmin/tools/qvm_run.py 277: dispvm = qubesadmin.vm.DispVM.from_appvm(args.app, ../qubes-core-admin-client/qubesadmin/tests/vm/dispvm.py 36: vm = qubesadmin.vm.DispVM.from_appvm(self.app, None) 55: vm = qubesadmin.vm.DispVM.from_appvm(self.app, 'test-vm') 66: vm = qubesadmin.vm.DispVM.from_appvm(self.app, None) 72: vm = qubesadmin.vm.DispVM.from_appvm(self.app, None) 82: vm = qubesadmin.vm.DispVM.from_appvm(self.app, 'test-vm') 92: vm = qubesadmin.vm.DispVM.from_appvm(self.app, None) ../qubes-core-admin-client/qubesadmin/vm/__init__.py 451: def from_appvm(cls, app, appvm):

And you are correct, using create in the name of something that is not creating something, but marking, gave me the impression it would create the qube...

marmarek · 2025-02-25T12:53:12Z

qubes/vm/dispvm.py

+            ##       before starting a qube?
+            memory = getattr(self, "memory", 0)
+            available_memory = (
+                psutil.virtual_memory().available / (1024 * 1024)


I get what you mean, but this will not work. This looks only at free memory in dom0, not the whole system. And even if it would look more globally, qmemman tries to allocate available memory as much as possible. Only qmemman knows how much "free" memory you really have, and currently there is no API to query that...

I will leave this for last, as it touches another component (qmmeman).

marmarek

I think the overall structure is getting close, but there are still several details. And tests missing, but this you know.

marmarek · 2025-02-25T13:14:27Z

qubes/vm/dispvm.py

+        preload_dispvm_max = int(
+            self.features.check_with_template("preload-dispvm-max", 0)
+        )
+        if preload_dispvm_max == 0:


This check is too late, no? I mean, the VM is created at this point already.

This check probably should be in from_appvm when preload=True. And also similar check for >0, if there aren't enough preloaded dispvms already (and if there are, probably raise an exception, not just return).

This check is too late, no?

Yes, moved to from_appvm.

And also similar check for >0, if there aren't enough preloaded dispvms already

This case will be handled as an event instead of API method. On the next push, let's see what you think about it.

(and if there are, probably raise an exception, not just return).

Done.

marmarek · 2025-02-25T13:15:31Z

qubes/vm/dispvm.py

+            dispvm_template = getattr(self, "template")
+            dispvm = self
+        elif (
+            self.klass == "AppVM"


This is defined in a DispVM class, the klass is always DispVM here.

Removing appvm clause.

marmarek · 2025-02-25T13:16:27Z

qubes/vm/dispvm.py

+            self.klass == "AppVM"
+            and getattr(self, "template_for_dispvms", False)
+        ):
+            dispvm_template = dispvm


Besides condition always being false, dispvm is not set anyway.

Fixed by removing appvm clause.

marmarek · 2025-02-25T13:18:27Z

qubes/vm/dispvm.py

+
+        preload_dispvm = dispvm_template.features.get("preload-dispvm", None)
+        if not preload_dispvm:
+            return


This looks wrong - this shouldn't happen, as use_preloaded_dispvm should only be called on a preloaded dispvm, at this point there should be something in this feature. This should at least be a warning, if not even an exception.

I removed as everything that calls use_preloaded is checking if it is empty or even if a specific disposable is in it.

marmarek · 2025-02-25T13:19:17Z

qubes/vm/dispvm.py

+            if dispvm.name not in preload_dispvm:
+                raise qubes.exc.QubesException("DispVM is not preloaded")
+            used_dispvm = dispvm.name
+        else:


same comment as above about the class

Fixed by removing clause.

marmarek · 2025-02-25T13:20:47Z

qubes/vm/dispvm.py

+        dispvm.features["internal"] = False
+        ## TODO: confirm if this guess of event code is correct
+        self.app.fire_event_for_permission(dispvm_template=dispvm_template)
+        dispvm_template.fire_event_async("domain-preloaded-dispvm-used")


_async needs await. And also, it may be useful to add dispvm (name? object?) as an event parameter.
And please document the event (there is specific sphinx syntax for events, see others for example).

marmarek · 2025-02-25T13:23:54Z

qubes/vm/dispvm.py

+            )
+            threshold = 1024 * 5
+            if memory >= (available_memory - threshold):
+                await DispVM.create_preloaded_dispvm(self)


or rather DispVM.from_appvm

marmarek · 2025-02-25T13:25:06Z

qubes/vm/dispvm.py

+    async def on_domain_unpaused(self):
+        """Mark unpaused preloaded domains as used."""
+        if self.is_domain_preloaded():
+            await DispVM.use_preloaded_dispvm(self)


self.use_preloaded_dispvm()

marmarek · 2025-02-25T13:26:11Z

qubes/vm/dispvm.py

        dispvm = app.add_new_vm(
            cls, template=appvm, auto_cleanup=True, **kwargs
        )
        await dispvm.create_on_disk()
+
+        if preload:
+            await DispVM.create_preloaded_dispvm(dispvm)


dispvm.create_preloaded_dispvm()
But also, I think this function should be named like mark_preloaded() or such, as it doesn't really create anything, it's called when the VM is already created.

marmarek · 2025-02-25T13:26:30Z

qubes/vm/dispvm.py

+            if preload_dispvm:
+                dispvm = preload_dispvm.split(" ")[0]
+                dispvm = app.domains[dispvm]
+                await DispVM.use_preloaded_dispvm(dispvm)


dispvm.use_preloaded_dispvm()

marmarek · 2025-02-27T21:44:40Z

linux/systemd/qubes-preload-dispvm.service

@@ -0,0 +1,17 @@
+[Unit]
+Description=Preload Qubes DispVMs
+[email protected]


Are you sure it will work this way? I don't think it will cover all instances of the qubes-vm@ units...
But maybe adding Before=qubes-preload-dispvm.service to [email protected] file will work?

Indeed my option failed. I did test without rebooting a qube enabling on runtime, not a valid test.
I did not want to touch qubes-vm@ but ordering after a template seems undocumented. Tested the way you said and it is best.

marmarek · 2025-02-27T21:45:34Z

linux/systemd/qubes-preload-dispvm.service

+
+[Service]
+Type=oneshot
+Environment=DISPLAY=:0


Is display really needed here? Xorg may not be running yet at this stage (and even when it is, user may not be logged in yet).

I copied from [email protected], if it is not needed here, it is not needed there also. Maybe it is needed for the gui agent to be able to create the sys-net Network Manager tray icon for example

I tested the following:

DISPLAY= qvm-start QUBE qvm-run -- QUBE xterm

Also tested the service with

Environment=DISPLAY= ExecStart=/usr/bin/qvm-start %i

And both worked.

It opened the terminal. It seems to not be needed. But in 2013 it was?

commit 59b9e43060c3b9bd717e9cc59979153f86f1b9b7 (tag: mm_59b9e430) Author: Marek Marczykowski-Górecki <[email protected]> Date: Tue Nov 26 16:53:26 2013 Fix VM autostart - set $DISPLAY env variable Without this, started qrexec-daemon would not have access to GUI, especially can't display Qubes RPC confirmation dialogs. diff --git a/linux/systemd/[email protected] b/linux/systemd/[email protected] index 1770d6d9..ffa61763 100644 --- a/linux/systemd/[email protected] +++ b/linux/systemd/[email protected] @@ -4,6 +4,7 @@ After=qubes-netvm.service [Service] Type=oneshot +Environment=DISPLAY=:0 ExecStart=/usr/bin/qvm-start --no-guid %i Group=qubes RemainAfterExit=yes

There is no option --no-guid anymore. For qvm_run.py, the default is to use args.gui if DISPLAY is set. I have found nothing special on qvm_start.py

Seems "safe" to remove from both services.

Yes, things have changed since 2013, now qvm-start only sends an API call to qubesd, it doesn't start those services as its own children anymore.

marmarek · 2025-02-27T21:48:03Z

qubes/tests/api_admin.py

+            b"admin.vm.CreateDisposable", b"dom0", arg="preload-autostart"
+        )
+        # TODO: doesn't return any value, so how to check if it was preloaded?
+        #dispvm_preload = self.vm.features.get("preload-dispvm", "").split(" ")


Check if there is (exactly) one entry?

:) Yes... will fix.

marmarek · 2025-02-27T21:50:12Z

qubes/vm/dispvm.py

+    def get_feat_preload(self, feature):
+        if feature not in ["preload-dispvm", "preload-dispvm-max"]:
+            raise qubes.exc.QubesException("Invalid feature provided")
+
+        if feature == "preload-dispvm":
+            default = ""
+        elif feature == "preload-dispvm-max":
+            default = 0
+
+        value = self.features.check_with_template(feature, default)
+
+        if feature == "preload-dispvm":
+            return value.split(" ")
+        if feature == "preload-dispvm-max":
+            return int(value)
+        return None


Wouldn't it be better to have two functions instead of the conditions in one?

Fixed. Is shorter, better.

marmarek · 2025-02-27T21:55:48Z

qubes/vm/dispvm.py

+    @qubes.events.handler(
+        "domain-preloaded-dispvm-used", "domain-preloaded-dispvm-autostart"
+    )
+    async def on_domain_preloaded_dispvm_used(self, event, delay=5, **kwargs):  # pylint: disable=unused-argument


The event is fired on disposable template, so it should be attached there, not to DispVM class. See DVMTemplateMixin.

marmarek · 2025-02-27T21:56:47Z

qubes/vm/dispvm.py

+        :returns:
+        """
+        await asyncio.sleep(delay)
+        while True:


There should be a check for preload-dispvm-max early. Right now, it looks like it will preload always at least one dispvm even if preload-dispvm-max is 0. I know preload-dispvm has a check for that, but it's still open for races, plus admin.vm.CreateDisposable method can be called by others too (it's a public API, for those with appropriate permission).

marmarek · 2025-02-27T22:07:31Z

qubes/vm/dispvm.py

+                # TODO: what to do if the maximum is never reached on autostart
+                # as there is not enough memory, and then a preloaded DispVM is
+                # used, calling for the creation of another one, while the
+                # autostart will also try to create one. Is this a race
+                # condition?


That's a very good question. Yes, I think this race condition is there. Maybe wrap preloading dispvm in a lock? The section under lock should do all checks (max count, free memory) + actual creating. And when the max is reached (regardless if it's autostart or not), simply exit the loop. This way, even if two instances of this function runs in parallel, still correct number of dispvms will be preloaded, and both instances will finish eventually.

Yeah, an async lock that exits when max is reached independent of the event seems like a great idea.

marmarek · 2025-02-27T22:09:03Z

qubes/vm/dispvm.py

+    # W0236 (invalid-overridden-method) Method 'on_domain_started' was expected
+    # to be 'non-async', found it instead as 'async'
+    # TODO: Seems to conflict with qubes.vm.mix.net, which is pretty strange.
+    # Larger bug? qubes.vm.qubesvm.QubesVM has NetVMMixin... which conflicts...


I think you need to rename this function to not override one from the mixin...

marmarek · 2025-02-27T22:11:13Z

qubes/vm/dispvm.py

+
+            proc = None
+            try:
+                proc = await asyncio.wait_for(


run_service only starts the service. You need to wait for it to complete with proc.communicate() for example. Or simply use run_service_for_stdio which will do that for you.

marmarek · 2025-02-27T22:22:07Z

qubes/vm/dispvm.py

+            if preload_dispvm:
+                dispvm = app.domains[preload_dispvm[0]]
+                await dispvm.use_preloaded()
+                return dispvm


Unpause needs to happen at some point. Normally caller expect to receive not running VM, so it will call start() on it. But this won't unpause it... One option would be to modify start() to unpause VM if it's paused. Sounds like a big change, but maybe nothing will explode?
Alternatively, unpause here, and rely on the fact that start() on a running VM is no-op, so all should work (I hope).

Both options seems to have different blast ranges. I will choose the smaller blast which is to unpause it here. Also in case it is not accompanied by .start(). Although I don't see any problem with unpausing when asking to start a qube, as running any Qrexec service targeting a qube already unpauses it.

marmarek · 2025-03-14T03:18:45Z

linux/systemd/[email protected]

@@ -1,12 +1,12 @@
 [Unit]
 Description=Start Qubes VM %i
 After=qubesd.service qubes-meminfo-writer-dom0.service
+[email protected]


Suggested change

Before=qubes-vm@.service

Before=qubes-preload-dispvm.service

marmarek · 2025-03-14T03:21:09Z

qubes/tests/api_admin.py

+        self.app.domains[self.vm].fire_event = self.emitter.fire_event
+        self.vm.features["preload-dispvm-max"] = "1"
+        self.app.default_dispvm = self.vm
+        # TODO: how to mock start of a qube that we don't have its object?


you can also patch the start method at the class level, like unittest.mock.patch("qubes.vm.dispvm.DispVM.start"). A heavier hammer, but should be fine in this test context.

Did this. Thanks.

marmarek · 2025-03-14T03:26:31Z

qubes/vm/dispvm.py

+        #   on it).
+        # TODO:
+        #   Test if pause isn't too late, what if application autostarts, will
+        #   it open before the qube is paused?


Yes, it will. Theoretically there is an "invisible" mode for gui-daemon for situation like this (it was used for very old implementation of DispVM that also kinda preloaded it). But there is no support for flipping it in runtime, gui-daemon needs to be restarted for that, so that's a broader change to use it in this version. Maybe later, I'd say it's okay to ignore this issue for now.

Add this comment there. Nothing to do about this now.

ben-grande · 2025-03-14T19:19:41Z

Removed draft but still not ready yet, but Gitlab CI fails to fetch amended and force pushed commits when using the Github API.

Having problems with events not being fired, trying to understand it.

marmarek · 2025-03-18T17:17:01Z

linux/aux-tools/preload-dispvm

+    ]
+    method = "admin.vm.CreateDisposable"
+    for qube in appvms:
+        qube.qubesd_call("dom0", method, "preload-autostart")


This looks wrong, as the first argument is the call target. So, it calls the method on dom0 several times, instead of each disposable template...
See how qubesd_call is used in qubesadmin.vm.QubesVM. But since that uses private attribute, I guess it needs a wrapper (and then make all self.qubesd_call(self._method_dest, ...) use that new wrapper?)

https://github.com/QubesOS/qubes-core-admin-client/blob/main/qubesadmin/vm/__init__.py#L436-L441

if self._method_dest.startswith('$dispvm:'): method_dest = self._method_dest[len('$dispvm:'):] else: method_dest = 'dom0' dispvm = self.app.qubesd_call(method_dest, 'admin.vm.CreateDisposable')

I guess it can always be the disposable template in this case?

for qube in appvms: qube.qubesd_call(qube.name, method, "preload-autostart")

Yes, the latter should work too.

marmarek · 2025-03-19T23:45:28Z

This didn't went far:

Mar 19 17:31:15.017096 dom0 qubesd[4569]: unhandled exception while calling src=b'dom0' meth=b'admin.vm.Start' dest=b'sys-firewall' arg=b'' len(untrusted_payload)=0
Mar 19 17:31:15.017096 dom0 qubesd[4569]: Traceback (most recent call last):
Mar 19 17:31:15.017096 dom0 qubesd[4569]:   File "/usr/lib/python3.13/site-packages/qubes/api/__init__.py", line 333, in respond
Mar 19 17:31:15.017096 dom0 qubesd[4569]:     response = await self.mgmt.execute(
Mar 19 17:31:15.017096 dom0 qubesd[4569]:                ^^^^^^^^^^^^^^^^^^^^^^^^
Mar 19 17:31:15.017096 dom0 qubesd[4569]:         untrusted_payload=untrusted_payload
Mar 19 17:31:15.017096 dom0 qubesd[4569]:         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Mar 19 17:31:15.017096 dom0 qubesd[4569]:     )
Mar 19 17:31:15.017096 dom0 qubesd[4569]:     ^
Mar 19 17:31:15.017096 dom0 qubesd[4569]:   File "/usr/lib/python3.13/site-packages/qubes/api/admin.py", line 947, in vm_start
Mar 19 17:31:15.017096 dom0 qubesd[4569]:     await self.dest.start()
Mar 19 17:31:15.017096 dom0 qubesd[4569]:   File "/usr/lib/python3.13/site-packages/qubes/vm/dispvm.py", line 426, in start
Mar 19 17:31:15.017096 dom0 qubesd[4569]:     await super().start(**kwargs)
Mar 19 17:31:15.017096 dom0 qubesd[4569]:   File "/usr/lib/python3.13/site-packages/qubes/vm/qubesvm.py", line 1522, in start
Mar 19 17:31:15.017096 dom0 qubesd[4569]:     await self.fire_event_async(
Mar 19 17:31:15.017096 dom0 qubesd[4569]:         "domain-start", start_guid=start_guid
Mar 19 17:31:15.017096 dom0 qubesd[4569]:     )
Mar 19 17:31:15.017096 dom0 qubesd[4569]:   File "/usr/lib/python3.13/site-packages/qubes/events.py", line 234, in fire_event_async
Mar 19 17:31:15.017096 dom0 qubesd[4569]:     sync_effects, async_effects = self._fire_event(
Mar 19 17:31:15.017096 dom0 qubesd[4569]:                                   ~~~~~~~~~~~~~~~~^
Mar 19 17:31:15.017096 dom0 qubesd[4569]:         event, kwargs, pre_event=pre_event
Mar 19 17:31:15.017096 dom0 qubesd[4569]:         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Mar 19 17:31:15.017096 dom0 qubesd[4569]:     )
Mar 19 17:31:15.017096 dom0 qubesd[4569]:     ^
Mar 19 17:31:15.017096 dom0 qubesd[4569]:   File "/usr/lib/python3.13/site-packages/qubes/events.py", line 169, in _fire_event
Mar 19 17:31:15.017096 dom0 qubesd[4569]:     effect = func(self, event, **kwargs)
Mar 19 17:31:15.017096 dom0 qubesd[4569]: TypeError: DispVM.on_domain_started_dispvm() got an unexpected keyword argument 'start_guid'

marmarek · 2025-03-19T23:48:07Z

And this:

Mar 19 17:31:05.021673 dom0 qubesd[4569]: vm.sys-firewall: Activating the sys-firewall VM
Mar 19 17:31:05.040131 dom0 qubesd[4569]: Uncaught exception from domain-unpaused handler for domain sys-firewall
Mar 19 17:31:05.040131 dom0 qubesd[4569]: Traceback (most recent call last):
Mar 19 17:31:05.040131 dom0 qubesd[4569]:   File "/usr/lib/python3.13/site-packages/qubes/app.py", line 1624, in _domain_event_callback
Mar 19 17:31:05.040131 dom0 qubesd[4569]:     vm.fire_event("domain-unpaused")
Mar 19 17:31:05.040131 dom0 qubesd[4569]:     ~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^
Mar 19 17:31:05.040131 dom0 qubesd[4569]:   File "/usr/lib/python3.13/site-packages/qubes/events.py", line 200, in fire_event
Mar 19 17:31:05.040131 dom0 qubesd[4569]:     sync_effects, async_effects = self._fire_event(
Mar 19 17:31:05.040131 dom0 qubesd[4569]:                                   ~~~~~~~~~~~~~~~~^
Mar 19 17:31:05.040131 dom0 qubesd[4569]:         event, kwargs, pre_event=pre_event
Mar 19 17:31:05.040131 dom0 qubesd[4569]:         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Mar 19 17:31:05.040131 dom0 qubesd[4569]:     )
Mar 19 17:31:05.040131 dom0 qubesd[4569]:     ^
Mar 19 17:31:05.040131 dom0 qubesd[4569]:   File "/usr/lib/python3.13/site-packages/qubes/events.py", line 169, in _fire_event
Mar 19 17:31:05.040131 dom0 qubesd[4569]:     effect = func(self, event, **kwargs)
Mar 19 17:31:05.040131 dom0 qubesd[4569]: TypeError: DispVM.on_domain_unpaused() takes 1 positional argument but 2 were given

marmarek · 2025-04-14T20:38:11Z

Looks like unit tests hanged, specifically qubes.tests.api_admin/TC_00_VMs/test_643_vm_create_disposable_preload_autostart ... (or the one after?)

ben-grande · 2025-04-15T06:45:08Z

Looks like unit tests hanged, specifically qubes.tests.api_admin/TC_00_VMs/test_643_vm_create_disposable_preload_autostart ... (or the one after?)

qubes.tests.api_admin/TC_00_VMs/test_643_vm_create_disposable_preload_autostart ... ok
started
Domain 'runner-32522443-project-22468673-concurrent-0-job-9718764351' destroyed
Domain 'runner-32522443-project-22468673-concurrent-0-job-9718764351' has been undefined

Strange, as they don't hang locally, only fail (as I haven't got them to work yet).

% ./run-tests -f qubes.tests.api_admin/TC_00_VMs/test_643_vm_create_disposable_preload_autostart
...
qubes.tests.api_admin/TC_00_VMs/test_643_vm_create_disposable_preload_autostart ... FAIL (AssertionError: AssertionError("event 'domain-preloaded-dispvm-autostart' did not fire on <qubes.tests.TestEmitter object at 0x7019b78e0dd0>"))
FAIL

======================================================================
FAIL: qubes.tests.api_admin/TC_00_VMs/test_643_vm_create_disposable_preload_autostart
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/usr/lib/python3.11/contextlib.py", line 81, in inner
    return func(*args, **kwds)
           ^^^^^^^^^^^^^^^^^^^
  File "/usr/lib/python3.11/unittest/mock.py", line 1369, in patched
    return func(*newargs, **newkeywargs)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/user/src/contrib/qubes-core-admin/qubes/tests/api_admin.py", line 3780, in test_643_vm_create_disposable_preload_autostart
    self.assertEventFired(self.emitter, "domain-preloaded-dispvm-autostart")
  File "/home/user/src/contrib/qubes-core-admin/qubes/tests/__init__.py", line 709, in assertEventFired
    self.fail(
AssertionError: event 'domain-preloaded-dispvm-autostart' did not fire on <qubes.tests.TestEmitter object at 0x7019b78e0dd0>

----------------------------------------------------------------------
Ran 1 test in 5.410s

FAILED (failures=1)

% ./run-tests -f qubes.tests.api_admin/TC_00_VMs/test_643_vm_create_disposable_preload_use
...
qubes.tests.api_admin/TC_00_VMs/test_643_vm_create_disposable_preload_use ... ERROR (RuntimeError: RuntimeError('\n{message : RuntimeWarning("coroutine \'TC_00_VMs.dummy_coro\' was never awaited"), category : \'RuntimeWarning\', filename : \'/home/user/src/contrib/qubes-core-admin/qubes/vm/dispvm.py\', lineno : 396, line : None}'))
ERROR (RuntimeError:
{message : RuntimeWarning("coroutine 'TC_00_VMs.dummy_coro' was never awaited"), category : 'RuntimeWarning', filename : '/home/user/src/contrib/qubes-core-admin/qubes/vm/dispvm.py', lineno : 396, line : None})

======================================================================
ERROR: qubes.tests.api_admin/TC_00_VMs/test_643_vm_create_disposable_preload_use
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/usr/lib/python3.11/contextlib.py", line 81, in inner
    return func(*args, **kwds)
           ^^^^^^^^^^^^^^^^^^^
  File "/usr/lib/python3.11/unittest/mock.py", line 1369, in patched
    return func(*newargs, **newkeywargs)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/user/src/contrib/qubes-core-admin/qubes/tests/api_admin.py", line 3828, in test_643_vm_create_disposable_preload_use
    self.assertEqual(dispvm.features.get("internal", False), False)
AssertionError: '1' != False

During handling of the above exception, another exception occurred:

RuntimeError:
{message : RuntimeWarning("coroutine 'TC_00_VMs.dummy_coro' was never awaited"), category : 'RuntimeWarning', filename : '/home/user/src/contrib/qubes-core-admin/qubes/vm/dispvm.py', lineno : 396, line : None}

----------------------------------------------------------------------
Ran 1 test in 0.477s

FAILED (errors=1)

marmarek · 2025-04-15T16:27:14Z

qubes/tests/run.py

+MODULE+"/"+CLASS+"/"+FUNCTION.
+Example: qubes.tests.basic/TC_00_Basic/test_000_create
+
+Some integration tests require the environment variable QUBES_TEST_TEMPLATES to


This is not true, none requires it (and if something requires this variable set, it's a bug that should never hit the main branch). You can use this variable to limit on what templates test are run (but when listing specific tests, it isn't really necessary as test names will include template name already, so you can select template this way instead).

Tests fails to load and be listed when QUBES_TEST_TEMPLATES is not set:

$ grep _FailedTest /tmp/out cli (unittest.loader._FailedTest.cli) qubes.tests.integ.basic (unittest.loader._FailedTest.qubes.tests.integ.basic) qubes.tests.integ.grub (unittest.loader._FailedTest.qubes.tests.integ.grub) qubes.tests.integ.devices_block (unittest.loader._FailedTest.qubes.tests.integ.devices_block) qubes.tests.integ.qrexec (unittest.loader._FailedTest.qubes.tests.integ.qrexec) qubes.tests.integ.qrexec_perf (unittest.loader._FailedTest.qubes.tests.integ.qrexec_perf) qubes.tests.integ.dom0_update (unittest.loader._FailedTest.qubes.tests.integ.dom0_update) qubes.tests.integ.vm_update (unittest.loader._FailedTest.qubes.tests.integ.vm_update) qubes.tests.integ.network (unittest.loader._FailedTest.qubes.tests.integ.network) qubes.tests.integ.network_ipv6 (unittest.loader._FailedTest.qubes.tests.integ.network_ipv6) qubes.tests.integ.dispvm (unittest.loader._FailedTest.qubes.tests.integ.dispvm) qubes.tests.integ.vm_qrexec_gui (unittest.loader._FailedTest.qubes.tests.integ.vm_qrexec_gui) qubes.tests.integ.audio (unittest.loader._FailedTest.qubes.tests.integ.audio) qubes.tests.integ.mime (unittest.loader._FailedTest.qubes.tests.integ.mime) qubes.tests.integ.salt (unittest.loader._FailedTest.qubes.tests.integ.salt) qubes.tests.integ.backup (unittest.loader._FailedTest.qubes.tests.integ.backup) qubes.tests.integ.backupdispvm (unittest.loader._FailedTest.qubes.tests.integ.backupdispvm)

And that is a problem to fix, not to workaround by setting this variable. Tests that fails to load this way is a blocking failure, I won't merge a PR that introduces such regression.

Try to import one of those modules in python interpreter manually and see what exactly fails.

Seems to be fixed now, will remove the comment.

For: QubesOS/qubes-issues#1512

- Clean the feature after it's qubes are removed - Start after qubesd - Separate feature set events - Convert maximum value to integer to not set '01' for example

marmarek · 2025-04-25T12:07:21Z

qubes/api/internal.py

@@ -113,6 +115,7 @@ def get_system_info(cls, app):
        system_info = {
            "domains": {
                domain.name: {
+                    "features": dict(domain.features.items()),


You setup events only for "internal" feature, not all of them, so changing others will lead to an outdated cache. I know others are not used right now, but it's easy to miss this when somebody would want to use it. I see two solutions:

add events to invalidate cache on other feature changes too

include only internal feature here (maybe even as a single entry, not a features dict, to not mislead that the list is complete; or maybe some-feature or something)

I slightly prefer the second option, as it will invalidate cache less often, but I'm okay with the first option too.

marmarek reviewed Feb 21, 2025

View reviewed changes

ben-grande force-pushed the preload-dispvm branch from 857b54b to db08c70 Compare February 24, 2025 19:40

ben-grande commented Feb 25, 2025

View reviewed changes

marmarek reviewed Feb 25, 2025

View reviewed changes

marmarek requested changes Feb 25, 2025

View reviewed changes

ben-grande force-pushed the preload-dispvm branch 3 times, most recently from 596c882 to a76ed3e Compare February 27, 2025 18:11

marmarek requested changes Feb 27, 2025

View reviewed changes

ben-grande force-pushed the preload-dispvm branch 2 times, most recently from a1fe380 to e6cffff Compare March 13, 2025 21:15

marmarek reviewed Mar 14, 2025

View reviewed changes

ben-grande marked this pull request as ready for review March 14, 2025 19:18

ben-grande changed the title ~~Preload disposables~~ [WIP] Preload disposables Mar 14, 2025

ben-grande force-pushed the preload-dispvm branch from 82e8ce1 to ba4516e Compare March 18, 2025 16:53

marmarek reviewed Mar 18, 2025

View reviewed changes

ben-grande force-pushed the preload-dispvm branch from ba4516e to 0cda3bb Compare March 19, 2025 17:25

marmarek added the openqa-pending label Mar 19, 2025

marmarek removed the openqa-pending label Mar 19, 2025

ben-grande force-pushed the preload-dispvm branch 3 times, most recently from 4026719 to eb1caff Compare March 20, 2025 20:20

marmarek added the openqa-pending label Mar 20, 2025

This was referenced Mar 21, 2025

Temporary manual upload of QWT for CI QubesOS/qubes-installer-qubes-os-windows-tools#5

Closed

Add Debug Console to Qui Domains systray widget QubesOS/qubes-desktop-linux-manager#249

Merged

ben-grande force-pushed the preload-dispvm branch 2 times, most recently from 6c641cc to 67e48e9 Compare April 14, 2025 19:02

ben-grande force-pushed the preload-dispvm branch 2 times, most recently from 3949e63 to 3eeae8b Compare April 15, 2025 16:18

marmarek reviewed Apr 15, 2025

View reviewed changes

ben-grande force-pushed the preload-dispvm branch 4 times, most recently from 1242780 to d884f1f Compare April 16, 2025 18:00

ben-grande mentioned this pull request Apr 17, 2025

Proposal and code for instantaneously started disposable VMs QubesOS/qubes-issues#1512

Open

25 tasks

ben-grande force-pushed the preload-dispvm branch 3 times, most recently from 394c3da to 7c186ba Compare April 24, 2025 09:12

ben-grande mentioned this pull request Apr 24, 2025

Add ability to flip qubes-guid option invisible mode on runtime QubesOS/qubes-issues#9907

Open

ben-grande force-pushed the preload-dispvm branch from 063fcb2 to 8b6bb09 Compare April 24, 2025 21:43

ben-grande added 11 commits April 25, 2025 11:39

Preload disposables

b479320

For: QubesOS/qubes-issues#1512

Improve preloaded dispvm tests

800dc4b

More preloaded dispvm tests

a425604

First working preloaded dispvm

60d660e

Focus on preloaded tests

c644f8e

Another preload test round

1e7366f

Fix for integration test

13bdca9

Get available memory from qmemman

68588f5

Dynamic preload when maximum feature changes

5a07e50

Fix preload dispvm autostart

fd03a9a

- Clean the feature after it's qubes are removed - Start after qubesd - Separate feature set events - Convert maximum value to integer to not set '01' for example

Decrease delays and add features to system info

aaebaca

ben-grande force-pushed the preload-dispvm branch from 8b6bb09 to aaebaca Compare April 25, 2025 09:40

marmarek reviewed Apr 25, 2025

View reviewed changes

[WIP] Preload disposables #660

Are you sure you want to change the base?

[WIP] Preload disposables #660

Conversation

ben-grande commented Feb 21, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

marmarek left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

marmarek Mar 14, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

marmarek Mar 14, 2025 •

edited

Loading