public inbox for pve-devel@lists.proxmox.com
 help / color / mirror / Atom feed
From: Daniel Kral <d.kral@proxmox.com>
To: pve-devel@lists.proxmox.com
Subject: [pve-devel] [PATCH pve-storage v2 2/5] introduce helpers for content type assertions of storages and volumes
Date: Tue, 11 Feb 2025 17:07:56 +0100	[thread overview]
Message-ID: <20250211160825.254167-3-d.kral@proxmox.com> (raw)
In-Reply-To: <20250211160825.254167-1-d.kral@proxmox.com>

Add subroutines for asserting the content types of storages and volumes
to reduce code duplication, e.g. when implementing preconditions in an
API handler before calling vdisk_alloc.

Signed-off-by: Daniel Kral <d.kral@proxmox.com>
---
changes since v1:
- moved from qemu-server to pve-storage
- add missing $node parameter to helpers
- adapt and fix wrong docs (copy paste error)
- remove `alloc_volume_disk` and `check_{volume,storage}_alloc`

 src/PVE/Storage.pm | 40 ++++++++++++++++++++++++++++++++++++++++
 1 file changed, 40 insertions(+)

diff --git a/src/PVE/Storage.pm b/src/PVE/Storage.pm
index 3b4f041..ca69cd6 100755
--- a/src/PVE/Storage.pm
+++ b/src/PVE/Storage.pm
@@ -529,6 +529,46 @@ sub parse_volume_id {
     return PVE::Storage::Plugin::parse_volume_id($volid, $noerr);
 }
 
+=head3 assert_content_type_supported($cfg, $storeid, $content_type [, $node])
+
+Asserts whether the storage with the identifier C<$storeid>, which is defined in C<$cfg>, supports
+the content type C<$content_type>.
+
+If C<$node> is set, the assertion is made for the specified C<$node>, else for the current node.
+
+If the check fails, the subroutine will C<die> with an error message for either the storage being
+unavailable or the storage not supporting the specified content type.
+
+=head3 assert_volume_type_supported($cfg, $volid [, $node])
+
+Asserts whether the volume with the identifier C<$volid>, which is on a storage defined in C<$cfg>,
+supports the volume's content type determined by L<parse_volname>.
+
+If C<$node> is set, the assertion is made for the specified C<$node>, else for the current node.
+
+If the check fails, the subroutine will C<die> with an error message for either the storage being
+unavailable or the storage not supporting the volume's content type.
+
+=cut
+
+sub assert_content_type_supported : prototype($$$;$) {
+    my ($cfg, $storeid, $content_type, $node) = @_;
+
+    my $scfg = storage_config($cfg, $storeid, $node);
+
+    die "storage '$storeid' does not support content type '$content_type'\n"
+	if !$scfg->{content}->{$content_type};
+}
+
+sub assert_volume_type_supported : prototype($$;$) {
+    my ($cfg, $volid, $node) = @_;
+
+    my ($storeid) = parse_volume_id($volid);
+    my ($vtype) = parse_volname($cfg, $volid);
+
+    assert_content_type_supported($cfg, $storeid, $vtype, $node);
+}
+
 # test if we have read access to volid
 sub check_volume_access {
     my ($rpcenv, $user, $cfg, $vmid, $volid, $type) = @_;
-- 
2.39.5



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


  parent reply	other threads:[~2025-02-11 16:10 UTC|newest]

Thread overview: 75+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-02-11 16:07 [pve-devel] [PATCH container/qemu-server/storage v2 00/31] consistent assertions for volume's content types Daniel Kral
2025-02-11 16:07 ` [pve-devel] [PATCH pve-storage v2 1/5] api: {upload, download}_url: factor out common parameter hash accesses Daniel Kral
2025-02-19 15:39   ` [pve-devel] applied: " Fiona Ebner
2025-02-11 16:07 ` Daniel Kral [this message]
2025-02-19 14:54   ` [pve-devel] [PATCH pve-storage v2 2/5] introduce helpers for content type assertions of storages and volumes Fiona Ebner
2025-02-20  9:14     ` Daniel Kral
2025-02-20  9:36       ` Fiona Ebner
2025-02-20 12:53         ` Daniel Kral
2025-02-20 12:58           ` Fiona Ebner
2025-02-11 16:07 ` [pve-devel] [PATCH pve-storage v2 3/5] tree-wide: make use of content type assertion helper Daniel Kral
2025-02-19 15:16   ` Fiona Ebner
2025-02-20  9:31     ` Daniel Kral
2025-02-11 16:07 ` [pve-devel] [PATCH pve-storage v2 4/5] vdisk_alloc: factor out optional parameters in options hash argument Daniel Kral
2025-02-20  8:49   ` Fiona Ebner
2025-02-20  9:34     ` Daniel Kral
2025-02-11 16:07 ` [pve-devel] [PATCH pve-storage v2 5/5] vdisk_alloc: add optional assertion for volume's content type Daniel Kral
2025-02-20  9:03   ` Fiona Ebner
2025-02-20 10:40     ` Fabian Grünbichler
2025-02-20 10:48       ` Fiona Ebner
2025-02-20 12:33         ` Daniel Kral
2025-02-20 13:09           ` Fiona Ebner
2025-02-11 16:08 ` [pve-devel] [PATCH qemu-server v2 01/15] test: cfg2cmd: expect error for invalid volume's storage " Daniel Kral
2025-02-19 15:45   ` Fiona Ebner
2025-02-11 16:08 ` [pve-devel] [PATCH qemu-server v2 02/15] fix #5284: api: move-disk: assert content type support for target storage Daniel Kral
2025-02-20 14:04   ` Fiona Ebner
2025-02-11 16:08 ` [pve-devel] [PATCH qemu-server v2 03/15] fix #5284: api: clone_vm: " Daniel Kral
2025-02-20 14:04   ` Fiona Ebner
2025-02-11 16:08 ` [pve-devel] [PATCH qemu-server v2 04/15] api: remove unused size variable in check_storage_access Daniel Kral
2025-02-20 14:04   ` Fiona Ebner
2025-02-11 16:08 ` [pve-devel] [PATCH qemu-server v2 05/15] api: remove unusable default storage parameter " Daniel Kral
2025-02-20 14:09   ` Fiona Ebner
2025-02-21  8:27     ` Daniel Kral
2025-02-21  9:15       ` Fiona Ebner
2025-02-20 14:15   ` Fiona Ebner
2025-02-11 16:08 ` [pve-devel] [PATCH qemu-server v2 06/15] fix #5284: api: update-vm: assert content type support for cloudinit images Daniel Kral
2025-02-20 14:23   ` Fiona Ebner
2025-02-21  8:30     ` Daniel Kral
2025-02-21  9:42       ` Fiona Ebner
2025-02-11 16:08 ` [pve-devel] [PATCH qemu-server v2 07/15] fix #5284: cli: importovf: assert content type support for target storage Daniel Kral
2025-02-20 14:29   ` Fiona Ebner
2025-02-11 16:08 ` [pve-devel] [PATCH qemu-server v2 08/15] tree-wide: update vdisk_alloc optional arguments signature Daniel Kral
2025-02-20 14:36   ` Fiona Ebner
2025-02-11 16:08 ` [pve-devel] [PATCH qemu-server v2 09/15] cfg2cmd: improve error message for invalid volume content type Daniel Kral
2025-02-11 16:08 ` [pve-devel] [PATCH qemu-server v2 10/15] api: {clone, move}_vm: use volume content type assertion helpers Daniel Kral
2025-02-11 16:08 ` [pve-devel] [PATCH qemu-server v2 11/15] api: {create, update}_vm: " Daniel Kral
2025-02-11 16:08 ` [pve-devel] [PATCH qemu-server v2 12/15] api: import{disk, ovf}: " Daniel Kral
2025-02-11 16:08 ` [pve-devel] [PATCH qemu-server v2 13/15] api: qmrestore: " Daniel Kral
2025-02-11 16:08 ` [pve-devel] [PATCH qemu-server v2 14/15] api: migrate_vm: " Daniel Kral
2025-02-20 14:46   ` Fiona Ebner
2025-02-20 17:50     ` Daniel Kral
2025-02-21  9:45       ` Fiona Ebner
2025-02-11 16:08 ` [pve-devel] [PATCH qemu-server v2 15/15] tree-wide: add todos for breaking content type assertions Daniel Kral
2025-02-20 14:47   ` Fiona Ebner
2025-02-11 16:08 ` [pve-devel] [PATCH container v2 01/11] migration: prepare: factor out common read-only variables Daniel Kral
2025-02-20  9:20   ` Fiona Ebner
2025-02-11 16:08 ` [pve-devel] [PATCH container v2 02/11] tests: add tests for expected behavior of alloc_disk wrapper Daniel Kral
2025-02-20 10:21   ` Fiona Ebner
2025-02-11 16:08 ` [pve-devel] [PATCH container v2 03/11] alloc_disk: fail fast if storage does not support content type rootdir Daniel Kral
2025-02-20 12:15   ` Fiona Ebner
2025-02-20 17:52     ` Daniel Kral
2025-02-11 16:08 ` [pve-devel] [PATCH container v2 04/11] alloc_disk: factor out common arguments for call to vdisk_alloc Daniel Kral
2025-02-20 13:11   ` Fiona Ebner
2025-02-11 16:08 ` [pve-devel] [PATCH container v2 05/11] alloc_disk: simplify storage-specific logic for vdisk_alloc arguments Daniel Kral
2025-02-20 13:22   ` Fiona Ebner
2025-02-11 16:08 ` [pve-devel] [PATCH container v2 06/11] alloc_disk: update vdisk_alloc optional arguments signature Daniel Kral
2025-02-20 13:24   ` Fiona Ebner
2025-02-11 16:08 ` [pve-devel] [PATCH container v2 07/11] alloc_disk: use volume content type assertion helpers Daniel Kral
2025-02-11 16:08 ` [pve-devel] [PATCH container v2 08/11] api: create: " Daniel Kral
2025-02-11 16:08 ` [pve-devel] [PATCH container v2 09/11] migration: prepare: " Daniel Kral
2025-02-11 16:08 ` [pve-devel] [PATCH container v2 10/11] api: update_vm: " Daniel Kral
2025-02-11 16:08 ` [pve-devel] [PATCH container v2 11/11] mount: raw/iso: " Daniel Kral
2025-02-20 13:29   ` Fiona Ebner
2025-02-21  8:38     ` Daniel Kral
2025-02-21  9:50 ` [pve-devel] [PATCH container/qemu-server/storage v2 00/31] consistent assertions for volume's content types Fiona Ebner
2025-02-28  8:46 ` [pve-devel] partially-applied: " 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=20250211160825.254167-3-d.kral@proxmox.com \
    --to=d.kral@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