From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from gate001.proxmox.com (gate001.proxmox.com [IPv6:2a0f:8001:1:32::40]) by lore.proxmox.com (Postfix) with ESMTPS id A03471FF0DE for ; Thu, 19 Nov 2026 15:16:35 +0100 (CET) Received: from gate001.proxmox.com (localhost.localdomain [127.0.0.1]) by gate001.proxmox.com (Proxmox) with ESMTP id 7B082216E7; Thu, 19 Nov 2026 15:15:24 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=genua.de; s=202307; t=1795097663; bh=iCZj/2sms0H/lP4h9iG9ZnWqHYF2WCKDnrlcqN0PSUI=; h=Date:From:To:Subject:References:In-Reply-To:From; b=ynB7EyscM/xmI+gBJhNrcEv7CnIJ6DUJLRIBtGL62NN6Qwvx92hmk9gJxkuwQb+2l Tc44hq9DCbs1+QqZf6aPCp4ZjjoKlkdfMpQRWYwbpANTYLvYAQpemAdY0hH5vsd5Kh 3sOvmiUN9T2CRbRgboCSA6R8cMFk4yWeO5ZEzdymykr2DX6RJcuRoOUKAFDGp+9dG9 ruKWHFZcAUg8ccyKT/B0fOSoMZuhKkPqdMix14UMO6dUfKLa0SFaubN5Rx/JQEclaa FefZbmD8T2THSmbafBZUiMn/Olh/gbpJD+1Rsa+ocdJcn060ltl+Y+bLu8ydN0QT9a ZD78+eo3/JGug== Date: Thu, 19 Nov 2026 15:14:21 +0100 From: Christian Ludwig To: Subject: [PATCH qemu-server v4 11/20] bios: add a custom firmware sub-property Message-ID: <80a075e5ab2987413c6f3540a22070b1e9435063.1795092172.git.christian_ludwig@genua.de> References: MIME-Version: 1.0 In-Reply-To: X-Originating-IP: [192.168.217.185] X-ClientProxiedBy: kch1-mta08.win.genua.de (10.208.16.108) To kch1-mta07.win.genua.de (10.208.16.107) Content-Type: text/plain; charset="us-ascii" Content-Disposition: inline X-SPAM-LEVEL: Spam detection results: 0 AWL 0.052 Adjusted score from AWL reputation of From: address DKIM_SIGNED 0.1 Message has a DKIM or DK signature, not necessarily valid DKIM_VALID -0.1 Message has at least one valid DKIM or DK signature DKIM_VALID_AU -0.1 Message has a valid DKIM or DK signature from author's domain DKIM_VALID_EF -0.1 Message has a valid DKIM or DK signature from envelope-from domain DMARC_PASS -0.1 DMARC pass policy RCVD_IN_DNSWL_NONE -0.0001 Sender listed at https://www.dnswl.org/, no trust SPF_HELO_PASS -0.001 SPF: HELO matches SPF record SPF_PASS -0.001 SPF: sender matches SPF record UNPARSEABLE_RELAY 0.001 Informational: message has unparseable relay lines Message-ID-Hash: GAGXBGF6AUNO4Y3A73RMNCKED3EGDXXM X-Message-ID-Hash: GAGXBGF6AUNO4Y3A73RMNCKED3EGDXXM X-MailFrom: christian_ludwig@genua.de X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; loop; banned-address; emergency; member-moderation; nonmember-moderation; administrivia; implicit-dest; max-recipients; max-size; news-moderation; no-subject; digests; suspicious-header X-Mailman-Version: 3.3.10 Precedence: list List-Id: Proxmox VE development discussion List-Help: List-Owner: List-Post: List-Subscribe: List-Unsubscribe: Add the 'firmware' sub-property to the bios option, pointing to a volume of the efi-firmware content type: bios: ovmf,firmware=local:efi-firmware/custom.fd Custom firmware images are only supported with OVMF for now, so require the 'ovmf' BIOS type when generating the command line. The image replaces the system OVMF code image for the pflash, blockdev and '-bios' variants. Include the volume when activating a VM's volumes. Check the volume's storage and content type before that, so that errors are reported in the context of the custom firmware, e.g. when a template or a restored VM references an image that is not available on the node. Firmware images are content and not owned by the VM, like ISO images, so refuse migration unless they are on a shared storage, and include them in the storage availability checks of the migrate APIs and in the list of shared nodes of the feature API. They are never copied, so refuse remote migration too. For the same reason, skip them for replication, and do not deactivate them when the VM stops or fails to start, as other VMs might still use them. Signed-off-by: Christian Ludwig --- src/PVE/QemuConfig.pm | 15 +++++++++ src/PVE/QemuMigrate.pm | 7 ++++ src/PVE/QemuServer.pm | 44 ++++++++++++++++++------ src/PVE/QemuServer/BIOS.pm | 26 +++++++++++++++ src/PVE/QemuServer/OVMF.pm | 68 ++++++++++++++++++++++++++++++++------ 5 files changed, 139 insertions(+), 21 deletions(-) diff --git a/src/PVE/QemuConfig.pm b/src/PVE/QemuConfig.pm index 0fbd312c..14ed76e9 100644 --- a/src/PVE/QemuConfig.pm +++ b/src/PVE/QemuConfig.pm @@ -116,6 +116,17 @@ sub parse_volume { die $err; } $volume = { 'file' => $volume_string }; + } elsif ($key eq 'bios') { + my $bios = eval { PVE::QemuServer::BIOS::parse_bios($volume_string) }; + if (my $err = $@) { + return if $noerr; + die $err; + } + # only a custom firmware image is a volume, plain BIOS settings are not + return if !defined($bios->{firmware}); + + $bios->{file} = delete($bios->{firmware}); + $volume = $bios; } else { $volume = PVE::QemuServer::Drive::parse_drive($key, $volume_string); } @@ -128,6 +139,9 @@ sub parse_volume { sub print_volume { my ($class, $key, $volume) = @_; + # the bios option is only parsed as a volume for iterating, it is not printed as one + die "unable to print 'bios' as a volume\n" if $key eq 'bios'; + return PVE::QemuServer::Drive::print_drive($volume); } @@ -146,6 +160,7 @@ sub get_replicatable_volumes { my ($volid, $attr) = @_; return if $attr->{cdrom}; + return if $attr->{is_firmware}; return if !$cleanup && !$attr->{replicate}; diff --git a/src/PVE/QemuMigrate.pm b/src/PVE/QemuMigrate.pm index 2d362140..8ff0293a 100644 --- a/src/PVE/QemuMigrate.pm +++ b/src/PVE/QemuMigrate.pm @@ -440,6 +440,10 @@ sub scan_local_volumes { # check if storage is available on both nodes my $scfg = PVE::Storage::storage_check_enabled($storecfg, $sid); + # the custom firmware image is not owned by the VM, so it is never copied over + die "remote migration with a custom BIOS firmware image is not possible\n" + if $attr->{is_firmware} && $self->{opts}->{remote}; + my $targetsid = $sid; # NOTE: local ignores shared mappings, remote maps them if (!$scfg->{shared} || $self->{opts}->{remote}) { @@ -449,6 +453,9 @@ sub scan_local_volumes { $self->target_storage_check_available($storecfg, $targetsid, $volid); return if $scfg->{shared} && !$self->{opts}->{remote}; + die "bios: custom firmware image '$volid' is on local storage - use a shared storage\n" + if $attr->{is_firmware}; + $local_volumes->{$volid}->{ref} = 'pending' if $attr->{referenced_in_pending}; $local_volumes->{$volid}->{ref} = 'snapshot' if $attr->{referenced_in_snapshot}; $local_volumes->{$volid}->{ref} = 'unused' if $attr->{is_unused}; diff --git a/src/PVE/QemuServer.pm b/src/PVE/QemuServer.pm index a64c0ee9..7875bca5 100644 --- a/src/PVE/QemuServer.pm +++ b/src/PVE/QemuServer.pm @@ -2213,8 +2213,9 @@ sub config_list { sub check_storage_availability { my ($storecfg, $conf, $node) = @_; - PVE::QemuConfig->foreach_volume( + PVE::QemuConfig->foreach_volume_full( $conf, + { extra_keys => ['bios'] }, sub { my ($ds, $drive) = @_; @@ -2244,8 +2245,9 @@ sub shared_nodes { my $nodehash = { map { $_ => 1 } @$nodelist }; my $nodename = nodename(); - PVE::QemuConfig->foreach_volume( + PVE::QemuConfig->foreach_volume_full( $conf, + { extra_keys => ['bios'] }, sub { my ($ds, $drive) = @_; @@ -2279,8 +2281,9 @@ sub check_local_storage_availability { my $nodelist = PVE::Cluster::get_nodelist(); my $nodehash = { map { $_ => {} } @$nodelist }; - PVE::QemuConfig->foreach_volume( + PVE::QemuConfig->foreach_volume_full( $conf, + { extra_keys => ['bios'] }, sub { my ($ds, $drive) = @_; @@ -3258,6 +3261,9 @@ sub config_to_command { push @$cmd, '-smbios', "type=1" . $smbios_string; } + PVE::QemuServer::BIOS::check_bios($conf->{bios}); + PVE::QemuServer::OVMF::check_custom_firmware($storecfg, $conf); + if (get_bios_type($conf) eq 'ovmf') { die "OVMF (UEFI) BIOS is not supported on 32-bit CPU types\n" if !$forcecpu && get_cpu_bitness($conf->{cpu}, $arch) == 32; @@ -4388,11 +4394,14 @@ sub foreach_volid { $volhash->{$volid}->{is_tpmstate} //= 0; $volhash->{$volid}->{is_tpmstate} = 1 if $key eq 'tpmstate0'; + $volhash->{$volid}->{is_firmware} //= 0; + $volhash->{$volid}->{is_firmware} = 1 if $key eq 'bios'; + $volhash->{$volid}->{drivename} = $key if is_valid_drivename($key); }; my $include_opts = { - extra_keys => ['vmstate'], + extra_keys => ['vmstate', 'bios'], include_unused => 1, }; @@ -5556,6 +5565,10 @@ sub vm_start_nolock { my $vollist = get_current_vm_volumes($storecfg, $conf); push $vollist->@*, $statefile if $statefile_is_a_volume; + # the custom firmware image is not owned by the VM and might be in use by other VMs + my $firmware = PVE::QemuServer::BIOS::get_bios_firmware($conf); + my $owned_vollist = [grep { !defined($firmware) || $_ ne $firmware } $vollist->@*]; + my ($cmd, $spice_port, $start_timeout); my $pci_reserve_list = []; eval { @@ -5601,7 +5614,7 @@ sub vm_start_nolock { push @$cmd, '-uuid', $uuid if defined($uuid); }; if (my $err = $@) { - eval { PVE::Storage::deactivate_volumes($storecfg, $vollist); }; + eval { PVE::Storage::deactivate_volumes($storecfg, $owned_vollist); }; warn $@ if $@; eval { cleanup_pci_devices($vmid, $conf) }; warn $@ if $@; @@ -5787,7 +5800,7 @@ sub vm_start_nolock { if (my $err = $@) { # deactivate volumes if start fails - eval { PVE::Storage::deactivate_volumes($storecfg, $vollist); }; + eval { PVE::Storage::deactivate_volumes($storecfg, $owned_vollist); }; warn $@ if $@; eval { cleanup_pci_devices($vmid, $conf) }; warn $@ if $@; @@ -6023,8 +6036,9 @@ sub vm_reset { ); } +# If $skip_firmware is set, the custom firmware image is not included. sub get_vm_volumes { - my ($conf) = @_; + my ($conf, $skip_firmware) = @_; my $vollist = []; foreach_volid( @@ -6032,6 +6046,7 @@ sub get_vm_volumes { sub { my ($volid, $attr) = @_; + return if $skip_firmware && $attr->{is_firmware}; return if classify_drive_file($volid) eq "absolute"; my ($sid, $volname) = PVE::Storage::parse_volume_id($volid, 1); @@ -6044,7 +6059,8 @@ sub get_vm_volumes { return $vollist; } -# Get volumes defined in the current VM configuration, including the VM state file. +# Get volumes defined in the current VM configuration, including the VM state file and the custom +# firmware image. sub get_current_vm_volumes { my ($storecfg, $conf) = @_; @@ -6052,12 +6068,17 @@ sub get_current_vm_volumes { PVE::QemuConfig->foreach_volume_full( $conf, - { extra_keys => ['vmstate'] }, + { extra_keys => ['vmstate', 'bios'] }, sub { my ($ds, $drive) = @_; if (classify_drive_file($drive->{file}) eq "volume") { - check_volume_storage_type($storecfg, $drive->{file}); + if ($ds eq 'bios') { + # report errors in the context of the custom firmware + PVE::QemuServer::OVMF::check_custom_firmware($storecfg, $conf); + } else { + check_volume_storage_type($storecfg, $drive->{file}); + } push $volumes->@*, $drive->{file}; } }, @@ -6139,7 +6160,8 @@ sub vm_stop_cleanup { PVE::QemuServer::DBusVMState::qemu_del_dbus_vmstate($vmid, quiet => 1); if (!$keepActive) { - my $vollist = get_vm_volumes($conf); + # the custom firmware image is not owned by the VM and might be in use by other VMs + my $vollist = get_vm_volumes($conf, 1); PVE::Storage::deactivate_volumes($storecfg, $vollist); } diff --git a/src/PVE/QemuServer/BIOS.pm b/src/PVE/QemuServer/BIOS.pm index aa160348..4466c708 100644 --- a/src/PVE/QemuServer/BIOS.pm +++ b/src/PVE/QemuServer/BIOS.pm @@ -10,6 +10,8 @@ our @EXPORT_OK = qw( parse_bios print_bios get_bios_type + get_bios_firmware + check_bios ); my $bios_fmt = { @@ -20,6 +22,15 @@ my $bios_fmt = { description => "Select BIOS implementation.", default => 'seabios', }, + firmware => { + type => 'string', + format => 'pve-volume-id', + format_description => 'volume', + description => "Custom firmware image to use instead of the one provided by the system." + . " Must reference a volume with content type 'efi-firmware', for example" + . " 'local:efi-firmware/custom.fd'. Only supported with the 'ovmf' BIOS type.", + optional => 1, + }, }; PVE::JSONSchema::register_format('pve-qm-bios', $bios_fmt); @@ -39,4 +50,19 @@ sub get_bios_type($conf) { return parse_bios($conf->{bios})->{type} // 'seabios'; } +# Returns the volume ID of the custom firmware image, if one is configured. +sub get_bios_firmware($conf) { + return parse_bios($conf->{bios})->{firmware}; +} + +# Dies if the combination of settings in the bios property-string is not supported. +sub check_bios($value) { + my $bios = parse_bios($value); + + die "a custom firmware image requires the 'ovmf' BIOS type\n" + if defined($bios->{firmware}) && $bios->{type} ne 'ovmf'; + + return; +} + 1; diff --git a/src/PVE/QemuServer/OVMF.pm b/src/PVE/QemuServer/OVMF.pm index 67665c7c..544b7083 100644 --- a/src/PVE/QemuServer/OVMF.pm +++ b/src/PVE/QemuServer/OVMF.pm @@ -11,6 +11,7 @@ use PVE::RESTEnvironment qw(log_warn); use PVE::Storage; use PVE::Tools; +use PVE::QemuServer::BIOS; use PVE::QemuServer::Blockdev; use PVE::QemuServer::Drive qw(checked_volume_format parse_drive print_drive); use PVE::QemuServer::Helpers; @@ -60,26 +61,69 @@ my $OVMF = { my $temporary_efidisk_dir = '/run/qemu-server/efidisk'; -my sub get_ovmf_files($$$$) { - my ($arch, $efidisk, $smm, $cvm_type) = @_; +# Check that the custom firmware image configured for the VM, if any, can be used on this node. +# The image itself is not checked, because the storage might not be activated yet. +sub check_custom_firmware { + my ($storecfg, $conf) = @_; + + my $volid = PVE::QemuServer::BIOS::get_bios_firmware($conf) // return; + + eval { + my ($storeid) = PVE::Storage::parse_volume_id($volid); + my $scfg = PVE::Storage::storage_check_enabled($storecfg, $storeid); + + my ($vtype) = PVE::Storage::parse_volname($storecfg, $volid); + die "volume has content type '$vtype', expected 'efi-firmware'\n" + if $vtype ne 'efi-firmware'; + + die "storage '$storeid' does not support content type 'efi-firmware'\n" + if !PVE::Storage::Common::content_allows($scfg->{content}, 'efi-firmware'); + }; + die "bios: custom firmware '$volid' - $@" if $@; + + return; +} + +my sub get_custom_firmware_path { + my ($storecfg, $conf) = @_; + + my $volid = PVE::QemuServer::BIOS::get_bios_firmware($conf) // return; + + return PVE::Storage::path($storecfg, $volid); +} + +# If $custom_code is set, it is used instead of the system-provided code image. +my sub get_ovmf_files($$$$;$) { + my ($arch, $efidisk, $smm, $cvm_type, $custom_code) = @_; my $types = $OVMF->{$arch} or die "no OVMF images known for architecture '$arch'\n"; + my $check_code_image = sub { + my ($ovmf_code) = @_; + + if (defined($custom_code)) { + die "custom firmware image '$custom_code' not found\n" + if !file_exists($custom_code); + return $custom_code; + } + + die "EFI base image '$ovmf_code' not found\n" if !file_exists($ovmf_code); + return $ovmf_code; + }; + my $type = 'default'; if ($arch eq 'x86_64') { if ($cvm_type && $cvm_type eq 'snp') { $type = "4m-snp"; my ($ovmf) = $types->{$type}->@*; - die "EFI base image '$ovmf' not found\n" if !file_exists($ovmf); - return ($ovmf); + return ($check_code_image->($ovmf)); } elsif ($cvm_type && ($cvm_type eq 'std' || $cvm_type eq 'es')) { $type = "4m-sev"; } elsif ($cvm_type && $cvm_type eq 'tdx') { $type = "4m-tdx"; my ($ovmf) = $types->{$type}->@*; - die "EFI base image '$ovmf' not found\n" if !file_exists($ovmf); - return ($ovmf); + return ($check_code_image->($ovmf)); } elsif (defined($efidisk->{efitype}) && $efidisk->{efitype} eq '4m') { $type = $smm ? "4m" : "4m-no-smm"; $type .= '-ms' if $efidisk->{'pre-enrolled-keys'}; @@ -103,7 +147,7 @@ my sub get_ovmf_files($$$$) { } my ($ovmf_code, $ovmf_vars) = $types->{$type}->@*; - die "EFI base image '$ovmf_code' not found\n" if !file_exists($ovmf_code); + $ovmf_code = $check_code_image->($ovmf_code); die "EFI vars image '$ovmf_vars' not found\n" if !file_exists($ovmf_vars); return ($ovmf_code, $ovmf_vars); @@ -122,7 +166,8 @@ my sub print_ovmf_drive_commandlines { die "Attempting to configure TDX with pflash devices instead of using `-bios`\n" if $cvm_type && $cvm_type eq 'tdx'; - my ($ovmf_code, $ovmf_vars) = get_ovmf_files($arch, $d, $q35, $cvm_type); + my $custom_code = get_custom_firmware_path($storecfg, $conf); + my ($ovmf_code, $ovmf_vars) = get_ovmf_files($arch, $d, $q35, $cvm_type, $custom_code); my $ovmf_vars_size = file_get_size($ovmf_vars); my $var_drive_str = "if=pflash,unit=1,id=drive-efidisk0"; @@ -218,7 +263,8 @@ my sub generate_ovmf_blockdev { die "Attempting to configure SEV-SNP with pflash devices instead of using `-bios`\n" if $cvm_type && $cvm_type eq 'snp'; - my ($ovmf_code, $ovmf_vars) = get_ovmf_files($arch, $drive, $q35, $cvm_type); + my $custom_code = get_custom_firmware_path($storecfg, $conf); + my ($ovmf_code, $ovmf_vars) = get_ovmf_files($arch, $drive, $q35, $cvm_type, $custom_code); my $ovmf_code_blockdev = { driver => 'raw', @@ -277,7 +323,9 @@ sub print_ovmf_commandline { "EFI disks are not supported with Confidential Virtual Machines and will be ignored" ); } - push $cmd->@*, '-bios', get_ovmf_files($hw_info->{arch}, undef, undef, $cvm_type); + my $custom_code = get_custom_firmware_path($storecfg, $conf); + push $cmd->@*, '-bios', + get_ovmf_files($hw_info->{arch}, undef, undef, $cvm_type, $custom_code); } else { if ($version_guard->(10, 0, 0)) { # for the switch to -blockdev my ($code_blockdev, $vars_blockdev, $throttle_group) = -- 2.34.1