From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <pve-devel-bounces@lists.proxmox.com>
Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68])
	by lore.proxmox.com (Postfix) with ESMTPS id 20CD81FF16F
	for <inbox@lore.proxmox.com>; Tue, 15 Apr 2025 15:51:17 +0200 (CEST)
Received: from firstgate.proxmox.com (localhost [127.0.0.1])
	by firstgate.proxmox.com (Proxmox) with ESMTP id C97719547;
	Tue, 15 Apr 2025 15:50:59 +0200 (CEST)
From: Daniel Kral <d.kral@proxmox.com>
To: pve-devel@lists.proxmox.com
Date: Tue, 15 Apr 2025 15:50:19 +0200
Message-Id: <20250415135045.255272-2-d.kral@proxmox.com>
X-Mailer: git-send-email 2.39.5
In-Reply-To: <20250415135045.255272-1-d.kral@proxmox.com>
References: <20250415135045.255272-1-d.kral@proxmox.com>
MIME-Version: 1.0
X-SPAM-LEVEL: Spam detection results:  0
 AWL 0.013 Adjusted score from AWL reputation of From: address
 BAYES_00                 -1.9 Bayes spam probability is 0 to 1%
 DMARC_MISSING             0.1 Missing DMARC policy
 KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment
 RCVD_IN_VALIDITY_CERTIFIED_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to
 Validity was blocked. See
 https://knowledge.validity.com/hc/en-us/articles/20961730681243 for more
 information.
 RCVD_IN_VALIDITY_RPBL_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to
 Validity was blocked. See
 https://knowledge.validity.com/hc/en-us/articles/20961730681243 for more
 information.
 RCVD_IN_VALIDITY_SAFE_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to
 Validity was blocked. See
 https://knowledge.validity.com/hc/en-us/articles/20961730681243 for more
 information.
 SPF_HELO_NONE           0.001 SPF: HELO does not publish an SPF Record
 SPF_PASS               -0.001 SPF: sender matches SPF record
 URIBL_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to URIBL was blocked. See
 http://wiki.apache.org/spamassassin/DnsBlocklists#dnsbl-block for more
 information. [storage.pm]
Subject: [pve-devel] [PATCH storage v3 1/4] introduce helpers for content
 type assertions of storages and volumes
X-BeenThere: pve-devel@lists.proxmox.com
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: Proxmox VE development discussion <pve-devel.lists.proxmox.com>
List-Unsubscribe: <https://lists.proxmox.com/cgi-bin/mailman/options/pve-devel>, 
 <mailto:pve-devel-request@lists.proxmox.com?subject=unsubscribe>
List-Archive: <http://lists.proxmox.com/pipermail/pve-devel/>
List-Post: <mailto:pve-devel@lists.proxmox.com>
List-Help: <mailto:pve-devel-request@lists.proxmox.com?subject=help>
List-Subscribe: <https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel>, 
 <mailto:pve-devel-request@lists.proxmox.com?subject=subscribe>
Reply-To: Proxmox VE development discussion <pve-devel@lists.proxmox.com>
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: 7bit
Errors-To: pve-devel-bounces@lists.proxmox.com
Sender: "pve-devel" <pve-devel-bounces@lists.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 v2:
  * split documentation back to be above each helper
  * changed names of helpers from *_supported to *_available
  * made both helpers also assert whether storage is enabled

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

diff --git a/src/PVE/Storage.pm b/src/PVE/Storage.pm
index d0a696a..b5a2c8a 100755
--- a/src/PVE/Storage.pm
+++ b/src/PVE/Storage.pm
@@ -537,6 +537,53 @@ sub parse_volume_id {
     return PVE::Storage::Plugin::parse_volume_id($volid, $noerr);
 }
 
+=head3 assert_content_type_available($cfg, $storeid, $content_type [, $node])
+
+Asserts whether the storage with the identifier C<$storeid>, which is defined
+in C<$cfg>, is available and 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.
+
+=cut
+
+sub assert_content_type_available : prototype($$$;$) {
+    my ($cfg, $storeid, $content_type, $node) = @_;
+
+    my $scfg = storage_check_enabled($cfg, $storeid, $node);
+
+    die "storage '$storeid' does not support content type '$content_type'\n"
+	if !$scfg->{content}->{$content_type};
+}
+
+=head3 assert_volume_type_available($cfg, $volid [, $node])
+
+Asserts whether the volume with the identifier C<$volid>, which is on a storage
+defined in C<$cfg>, is available and supports the volume's content type
+determined by C<L<< parse_volname()|/parse_volname($cfg, $volid) >>>.
+
+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 volume's storage being unavailable or the storage not supporting the
+volume's content type.
+
+=cut
+
+sub assert_volume_type_available : prototype($$;$) {
+    my ($cfg, $volid, $node) = @_;
+
+    my ($storeid) = parse_volume_id($volid);
+    my ($vtype) = parse_volname($cfg, $volid);
+
+    assert_content_type_available($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