core-admin-client/qubesadmin/events/utils.py
Marek Marczykowski-Górecki aea41511de
events: implicitly enable caching when creating EventsDispatcher
Application that runs EventsDispatcher can safely use also cache , which
greatly improve performance. This is because cache then is properly
updated/invalidated when needed.
Instead of modifying each application to explicitly enable cache based
on this simple rule, make it implicit when EventsDispatcher is created.

Do not enable caching when EventsDispatcher is created only temporarily
in wait_for_domain_shutdown.

QubesOS/qubes-issues#3293
2020-05-22 19:28:51 +02:00

69 lines
2.1 KiB
Python

# -*- encoding: utf8 -*-
#
# The Qubes OS Project, http://www.qubes-os.org
#
# Copyright (C) 2017 Marek Marczykowski-Górecki
# <marmarek@invisiblethingslab.com>
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as published by
# the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License along
# with this program; if not, see <http://www.gnu.org/licenses/>.
''' Utilities for common events-based actions '''
import asyncio
import functools
import qubesadmin.events
import qubesadmin.exc
class Interrupt(Exception):
'''Interrupt events processing'''
def interrupt_on_vm_shutdown(vms, subject, event):
'''Interrupt events processing when given VM was shutdown'''
# pylint: disable=unused-argument
if event == 'connection-established':
if all(vm.is_halted() for vm in sorted(vms)):
raise Interrupt
elif event == 'domain-shutdown' and subject in vms:
vms.remove(subject)
if not vms:
raise Interrupt
@asyncio.coroutine
def wait_for_domain_shutdown(vms):
''' Helper function to wait for domain shutdown.
This function wait for domain shutdown, but do not initiate the shutdown
itself.
:param vms: QubesVM object collection to wait for shutdown on
'''
if not vms:
return
app = list(vms)[0].app
vms = set(vms)
events = qubesadmin.events.EventsDispatcher(app, enable_cache=False)
events.add_handler('domain-shutdown',
functools.partial(interrupt_on_vm_shutdown, vms))
events.add_handler('connection-established',
functools.partial(interrupt_on_vm_shutdown, vms))
try:
yield from events.listen_for_events()
except Interrupt:
pass