public inbox for pve-devel@lists.proxmox.com
 help / color / mirror / Atom feed
From: Fiona Ebner <f.ebner@proxmox.com>
To: pve-devel@lists.proxmox.com
Subject: [pve-devel] [PATCH qemu-server v2 21/49] blockdev: add helpers for attaching and detaching block devices
Date: Tue,  1 Jul 2025 17:40:41 +0200	[thread overview]
Message-ID: <20250701154117.434512-22-f.ebner@proxmox.com> (raw)
In-Reply-To: <20250701154117.434512-1-f.ebner@proxmox.com>

Signed-off-by: Fiona Ebner <f.ebner@proxmox.com>
---

Changes in v2:
* Try to delete potentially left-over throttle group before attaching.
* Use newly introduced helpers for throttle and node names.
* Recursively try to detach file child nodes. Relies on new QEMU
  patch that includes the file child node name.
* Have attach() return the node name of the attached node.
* More compact POD.

 src/PVE/QemuServer/Blockdev.pm | 142 +++++++++++++++++++++++++++++++++
 1 file changed, 142 insertions(+)

diff --git a/src/PVE/QemuServer/Blockdev.pm b/src/PVE/QemuServer/Blockdev.pm
index 0f30f328..5e6e992d 100644
--- a/src/PVE/QemuServer/Blockdev.pm
+++ b/src/PVE/QemuServer/Blockdev.pm
@@ -11,6 +11,7 @@ use PVE::JSONSchema qw(json_bool);
 use PVE::Storage;
 
 use PVE::QemuServer::Drive qw(drive_is_cdrom);
+use PVE::QemuServer::Monitor qw(mon_cmd);
 
 my sub get_node_name {
     my ($type, $drive_id, $volid, $snap) = @_;
@@ -244,4 +245,145 @@ sub generate_drive_blockdev {
     };
 }
 
+my sub blockdev_add {
+    my ($vmid, $blockdev) = @_;
+
+    eval { mon_cmd($vmid, 'blockdev-add', $blockdev->%*); };
+    if (my $err = $@) {
+        my $node_name = $blockdev->{'node-name'} // 'undefined';
+        die "adding blockdev '$node_name' failed : $err\n" if $@;
+    }
+
+    return;
+}
+
+=pod
+
+=head3 attach
+
+    my $node_name = attach($storecfg, $vmid, $drive, $options);
+
+Attach the drive C<$drive> to the VM C<$vmid> considering the additional options C<$options>.
+Returns the node name of the (topmost) attached block device node.
+
+Parameters:
+
+=over
+
+=item C<$storecfg>: The storage configuration.
+
+=item C<$vmid>: The ID of the virtual machine.
+
+=item C<$drive>: The drive as parsed from a virtual machine configuration.
+
+=item C<$options>: A hash reference with additional options.
+
+=over
+
+=item C<< $options->{'read-only'} >>: Attach the image as read-only irrespective of the
+configuration in C<$drive>.
+
+=item C<< $options->{size} >>: Attach the image with this virtual size. Must be smaller than the
+actual size of the image. The image format must be C<raw>.
+
+=item C<< $options->{'snapshot-name'} >>: Attach this snapshot of the volume C<< $drive->{file} >>,
+rather than the volume itself.
+
+=back
+
+=back
+
+=cut
+
+sub attach {
+    my ($storecfg, $vmid, $drive, $options) = @_;
+
+    my $blockdev = generate_drive_blockdev($storecfg, $drive, $options);
+
+    my $throttle_group_id;
+    if (parse_top_node_name($blockdev->{'node-name'})) { # device top nodes need a throttle group
+        my $drive_id = PVE::QemuServer::Drive::get_drive_id($drive);
+        $throttle_group_id = throttle_group_id($drive_id);
+    }
+
+    eval {
+        if ($throttle_group_id) {
+            # Try to remove potential left-over.
+            eval { mon_cmd($vmid, 'object-del', id => $throttle_group_id); };
+
+            my $throttle_group = generate_throttle_group($drive);
+            mon_cmd($vmid, 'object-add', $throttle_group->%*);
+        }
+
+        blockdev_add($vmid, $blockdev);
+    };
+    if (my $err = $@) {
+        if ($throttle_group_id) {
+            eval { mon_cmd($vmid, 'object-del', id => $throttle_group_id); };
+        }
+        die $err;
+    }
+
+    return $blockdev->{'node-name'};
+}
+
+=pod
+
+=head3 detach
+
+    detach($vmid, $node_name);
+
+Detach the block device C<$node_name> from the VM C<$vmid>. Also removes associated child block
+nodes.
+
+Parameters:
+
+=over
+
+=item C<$vmid>: The ID of the virtual machine.
+
+=item C<$node_name>: The node name identifying the block node in QEMU.
+
+=back
+
+=cut
+
+sub detach {
+    my ($vmid, $node_name) = @_;
+
+    die "Blockdev::detach - no node name\n" if !$node_name;
+
+    my $block_info = mon_cmd($vmid, "query-named-block-nodes");
+    $block_info = { map { $_->{'node-name'} => $_ } $block_info->@* };
+
+    my $remove_throttle_group_id;
+    if ((my $drive_id = parse_top_node_name($node_name)) && $block_info->{$node_name}) {
+        $remove_throttle_group_id = throttle_group_id($drive_id);
+    }
+
+    while ($node_name) {
+        last if !$block_info->{$node_name}; # already gone
+
+        eval { mon_cmd($vmid, 'blockdev-del', 'node-name' => "$node_name"); };
+        if (my $err = $@) {
+            last if $err =~ m/Failed to find node with node-name/; # already gone
+            die "deleting blockdev '$node_name' failed : $err\n";
+        }
+
+        my $children =
+            { map { $_->{'child-name'} => $_ } $block_info->{$node_name}->{children}->@* };
+        # Recursively remove 'file' child nodes. QEMU will auto-remove implicitly added child nodes,
+        # but e.g. the child of the top throttle node might have been explicitly added as a mirror
+        # target, and needs to be removed manually.
+        $node_name = $children->{file}->{'node-name'};
+    }
+
+    if ($remove_throttle_group_id) {
+        eval { mon_cmd($vmid, 'object-del', id => $remove_throttle_group_id); };
+        die "removing throttle group failed - $@\n" if $@;
+    }
+
+    return;
+}
+
 1;
-- 
2.47.2



_______________________________________________
pve-devel mailing list
pve-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel


  parent reply	other threads:[~2025-07-01 15:48 UTC|newest]

Thread overview: 52+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-07-01 15:40 [pve-devel] [PATCH-SERIES qemu/storage/qemu-server v2 00/49] let's switch to blockdev, blockdev, blockdev, part four (final) Fiona Ebner
2025-07-01 15:40 ` [pve-devel] [PATCH qemu v2 01/49] PVE backup: prepare for the switch to using blockdev rather than drive Fiona Ebner
2025-07-01 15:40 ` [pve-devel] [PATCH qemu v2 02/49] block/zeroinit: support using as blockdev driver Fiona Ebner
2025-07-01 15:40 ` [pve-devel] [PATCH qemu v2 03/49] block/alloc-track: " Fiona Ebner
2025-07-01 15:40 ` [pve-devel] [PATCH qemu v2 04/49] block: include child references in block device info Fiona Ebner
2025-07-01 15:40 ` [pve-devel] [PATCH storage v4 05/49] plugin: add method to get qemu blockdevice options for volume Fiona Ebner
2025-07-01 15:40 ` [pve-devel] [PATCH storage v4 06/49] iscsi direct plugin: implement method to get qemu blockdevice options Fiona Ebner
2025-07-01 15:40 ` [pve-devel] [PATCH storage v4 07/49] zfs iscsi plugin: implement new " Fiona Ebner
2025-07-01 15:40 ` [pve-devel] [PATCH storage v4 08/49] zfs pool plugin: implement " Fiona Ebner
2025-07-01 15:40 ` [pve-devel] [PATCH storage v4 09/49] ceph/rbd: set 'keyring' in ceph configuration for externally managed RBD storages Fiona Ebner
2025-07-01 15:40 ` [pve-devel] [PATCH storage v4 10/49] rbd plugin: implement new method to get qemu blockdevice options Fiona Ebner
2025-07-01 15:40 ` [pve-devel] [PATCH storage v4 11/49] plugin: qemu block device: add hints option and EFI disk hint Fiona Ebner
2025-07-01 15:40 ` [pve-devel] [PATCH storage v4 12/49] plugin: qemu block device: add support for snapshot option Fiona Ebner
2025-07-01 15:40 ` [pve-devel] [PATCH storage v4 13/49] plugin: add machine version to qemu_blockdev_options() interface Fiona Ebner
2025-07-01 15:40 ` [pve-devel] [PATCH storage v4 14/49] plugin api: bump api version and age Fiona Ebner
2025-07-01 15:40 ` [pve-devel] [PATCH qemu-server v2 15/49] mirror: code style: avoid masking earlier declaration of $op Fiona Ebner
2025-07-01 15:40 ` [pve-devel] [PATCH qemu-server v2 16/49] test: collect mocked functions for QemuServer module Fiona Ebner
2025-07-01 15:40 ` [pve-devel] [PATCH qemu-server v2 17/49] drive: add helper to parse drive interface Fiona Ebner
2025-07-01 15:40 ` [pve-devel] [PATCH qemu-server v2 18/49] drive: drop invalid export of get_scsi_devicetype Fiona Ebner
2025-07-01 15:40 ` [pve-devel] [PATCH qemu-server v2 19/49] blockdev: add and use throttle_group_id() helper Fiona Ebner
2025-07-01 15:40 ` [pve-devel] [PATCH qemu-server v2 20/49] blockdev: introduce top_node_name() and parse_top_node_name() helpers Fiona Ebner
2025-07-01 15:40 ` Fiona Ebner [this message]
2025-07-01 15:40 ` [pve-devel] [PATCH qemu-server v2 22/49] blockdev: add missing include for JSON module Fiona Ebner
2025-07-01 15:40 ` [pve-devel] [PATCH qemu-server v2 23/49] backup: use blockdev for fleecing images Fiona Ebner
2025-07-01 15:40 ` [pve-devel] [PATCH qemu-server v2 24/49] backup: use blockdev for TPM state file Fiona Ebner
2025-07-01 15:40 ` [pve-devel] [PATCH qemu-server v2 25/49] blockdev: introduce qdev_id_to_drive_id() helper Fiona Ebner
2025-07-01 15:40 ` [pve-devel] [PATCH qemu-server v2 26/49] blockdev: introduce and use get_block_info() helper Fiona Ebner
2025-07-01 15:40 ` [pve-devel] [PATCH qemu-server v2 27/49] blockdev: move helper for resize into module Fiona Ebner
2025-07-01 15:40 ` [pve-devel] [PATCH qemu-server v2 28/49] blockdev: add helper to get node below throttle node Fiona Ebner
2025-07-01 15:40 ` [pve-devel] [PATCH qemu-server v2 29/49] blockdev: resize: query and use node name for resize operation Fiona Ebner
2025-07-01 15:40 ` [pve-devel] [PATCH qemu-server v2 30/49] blockdev: support using zeroinit filter Fiona Ebner
2025-07-01 15:40 ` [pve-devel] [PATCH qemu-server v2 31/49] blockdev: make some functions private Fiona Ebner
2025-07-01 15:40 ` [pve-devel] [PATCH qemu-server v2 32/49] blockdev: add 'no-throttle' option to skip generationg throttle top node Fiona Ebner
2025-07-01 15:40 ` [pve-devel] [PATCH qemu-server v2 33/49] block job: allow specifying a block node that should be detached upon completion Fiona Ebner
2025-07-01 15:40 ` [pve-devel] [PATCH qemu-server v2 34/49] block job: add blockdev mirror Fiona Ebner
2025-07-01 15:40 ` [pve-devel] [PATCH qemu-server v2 35/49] blockdev: add change_medium() helper Fiona Ebner
2025-07-01 15:40 ` [pve-devel] [PATCH qemu-server v2 36/49] blockdev: add blockdev_change_medium() helper Fiona Ebner
2025-07-01 15:40 ` [pve-devel] [PATCH qemu-server v2 37/49] blockdev: move helper for configuring throttle limits to module Fiona Ebner
2025-07-01 15:40 ` [pve-devel] [PATCH qemu-server v2 38/49] clone disk: skip check for aio=default (io_uring) compatibility starting with machine version 10.0 Fiona Ebner
2025-07-01 15:40 ` [pve-devel] [PATCH qemu-server v2 39/49] print drive device: don't reference any drive for 'none' " Fiona Ebner
2025-07-01 15:41 ` [pve-devel] [PATCH qemu-server v2 40/49] blockdev: add support for NBD paths Fiona Ebner
2025-07-01 15:41 ` [pve-devel] [PATCH qemu-server v2 41/49] blockdev: add helper to generate PBS block device for live restore Fiona Ebner
2025-07-01 15:41 ` [pve-devel] [PATCH qemu-server v2 42/49] blockdev: support alloc-track driver for live-{import, restore} Fiona Ebner
2025-07-01 15:41 ` [pve-devel] [PATCH qemu-server v2 43/49] live import: also record volid information Fiona Ebner
2025-07-01 15:41 ` [pve-devel] [PATCH qemu-server v2 44/49] live import/restore: query which node to use for operation Fiona Ebner
2025-07-01 15:41 ` [pve-devel] [PATCH qemu-server v2 45/49] live import/restore: use Blockdev::detach helper Fiona Ebner
2025-07-01 15:41 ` [pve-devel] [PATCH qemu-server v2 46/49] command line: switch to blockdev starting with machine version 10.0 Fiona Ebner
2025-07-01 15:41 ` [pve-devel] [PATCH qemu-server v2 47/49] test: migration: update running machine to 10.0 Fiona Ebner
2025-07-01 15:41 ` [pve-devel] [PATCH qemu-server v2 48/49] partially fix #3227: ensure that target image for mirror has the same size for EFI disks Fiona Ebner
2025-07-01 15:41 ` [pve-devel] [PATCH qemu-server v2 49/49] blockdev: pass along machine version to storage layer Fiona Ebner
2025-07-02  8:20 ` [pve-devel] [PATCH-SERIES qemu/storage/qemu-server v2 00/49] let's switch to blockdev, blockdev, blockdev, part four (final) DERUMIER, Alexandre via pve-devel
2025-07-02  8:36   ` Fiona Ebner

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20250701154117.434512-22-f.ebner@proxmox.com \
    --to=f.ebner@proxmox.com \
    --cc=pve-devel@lists.proxmox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal