Source code for qubes.vm.appvm

# The Qubes OS Project,
# Copyright (C) 2014-2016  Wojtek Porczyk <>
# Copyright (C) 2016       Marek Marczykowski <>)
# Copyright (C) 2016       Bahtiar `kalkin-` Gadimov <>
# This library 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 library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# Lesser General Public License for more details.
# You should have received a copy of the GNU Lesser General Public
# License along with this library; if not, see <>.
''' This module contains the AppVM implementation '''

import copy

import qubes.vm.qubesvm
from qubes.config import defaults

[docs]class AppVM(qubes.vm.qubesvm.QubesVM): '''Application VM''' template = qubes.VMProperty('template', load_stage=4, vmclass=qubes.vm.templatevm.TemplateVM, doc='Template, on which this AppVM is based.') template_for_dispvms ='template_for_dispvms', type=bool, default=False, doc='Should this VM be allowed to start as Disposable VM') default_volume_config = { 'root': { 'name': 'root', 'snap_on_start': True, 'save_on_stop': False, 'rw': True, 'source': None, }, 'private': { 'name': 'private', 'snap_on_start': False, 'save_on_stop': True, 'rw': True, 'size': defaults['private_img_size'], }, 'volatile': { 'name': 'volatile', 'snap_on_start': False, 'save_on_stop': False, 'size': defaults['root_img_size'], 'rw': True, }, 'kernel': { 'name': 'kernel', 'snap_on_start': False, 'save_on_stop': False, 'rw': False, } } def __init__(self, app, xml, **kwargs): # migrate renamed properties if xml is not None: node_dispvm_allowed = xml.find( './properties/property[@name=\'dispvm_allowed\']') if node_dispvm_allowed is not None: kwargs['template_for_dispvms'] = \, None, node_dispvm_allowed.text) node_dispvm_allowed.getparent().remove(node_dispvm_allowed) self.volume_config = copy.deepcopy(self.default_volume_config) template = kwargs.get('template', None) if template is not None: # template is only passed if the AppVM is created, in other cases we # don't need to patch the volume_config because the config is # coming from XML, already as we need it for name, config in template.volume_config.items(): # in case the template vm has more volumes add them to own # config if name not in self.volume_config: self.volume_config[name] = config.copy() if 'vid' in self.volume_config[name]: del self.volume_config[name]['vid'] super(AppVM, self).__init__(app, xml, **kwargs) @property def dispvms(self): ''' Returns a generator containing all Disposable VMs based on the current AppVM. ''' for vm in if hasattr(vm, 'template') and vm.template is self: yield vm
[docs]'domain-load') def on_domain_loaded(self, event): ''' When domain is loaded assert that this vm has a template. ''' # pylint: disable=unused-argument assert self.template
[docs]'property-pre-reset:template') def on_property_pre_reset_template(self, event, name, oldvalue=None): '''Forbid deleting template of running VM ''' # pylint: disable=unused-argument,no-self-use raise qubes.exc.QubesValueError('Cannot unset template')
[docs]'property-pre-set:template') def on_property_pre_set_template(self, event, name, newvalue, oldvalue=None): '''Forbid changing template of running VM ''' # pylint: disable=unused-argument if not self.is_halted(): raise qubes.exc.QubesVMNotHaltedError(self, 'Cannot change template while qube is running') if any(self.dispvms): raise qubes.exc.QubesVMInUseError(self, 'Cannot change template ' 'while there are DispVMs based on this qube')
[docs]'property-set:template') def on_property_set_template(self, event, name, newvalue, oldvalue=None): ''' Adjust root (and possibly other snap_on_start=True) volume on template change. ''' # pylint: disable=unused-argument for volume_name, conf in self.default_volume_config.items(): if conf.get('snap_on_start', False) and \ conf.get('source', None) is None: config = conf.copy() self.volume_config[volume_name] = config, config)