public inbox for pve-devel@lists.proxmox.com
 help / color / mirror / Atom feed
From: Wolfgang Bumiller <w.bumiller@proxmox.com>
To: Daniel Kral <d.kral@proxmox.com>
Cc: pve-devel@lists.proxmox.com
Subject: Re: [pve-devel] [PATCH storage v3 3/4] vdisk_alloc: factor out optional parameters in options hash argument
Date: Mon, 5 May 2025 16:51:48 +0200	[thread overview]
Message-ID: <34ne6csctoxhbdjt5keirw53lxjrjuhu23zmezbcvvhc34tt25@yirnz2u373gd> (raw)
In-Reply-To: <20250415135045.255272-4-d.kral@proxmox.com>

On Tue, Apr 15, 2025 at 03:50:21PM +0200, Daniel Kral wrote:
> Move the optional parameter `name` into an optional hash argument at the
> end of the subroutine signature of vdisk_alloc().
> 
> This allows to add more optional arguments in the future and makes the
> function call easier to follow when a name is not required.
> 
> This requires a versioned break for packages that call vdisk_alloc(),
> which are currently qemu-server and pve-container.
> 
> Signed-off-by: Daniel Kral <d.kral@proxmox.com>
> ---
> changes since v2:
>   * wrap 100+ char lines correctly
>   * add $fmt back as a required parameter as it didn't make sense to
>     have it be optional because of only a few places
> 
>  src/PVE/API2/Storage/Content.pm    |  5 ++---
>  src/PVE/GuestImport.pm             |  2 +-
>  src/PVE/Storage.pm                 | 32 ++++++++++++++++++++++++++++--
>  src/test/run_test_zfspoolplugin.pl |  8 ++++----
>  4 files changed, 37 insertions(+), 10 deletions(-)
> 
> diff --git a/src/PVE/API2/Storage/Content.pm b/src/PVE/API2/Storage/Content.pm
> index 8fbfbe9..64ed56d 100644
> --- a/src/PVE/API2/Storage/Content.pm
> +++ b/src/PVE/API2/Storage/Content.pm
> @@ -218,9 +218,8 @@ __PACKAGE__->register_method ({
>  
>  	my $cfg = PVE::Storage::config();
>  
> -	my $volid = PVE::Storage::vdisk_alloc ($cfg, $storeid, $param->{vmid},
> -					       $param->{format},
> -					       $name, $size);
> +	my $volid = PVE::Storage::vdisk_alloc(
> +	    $cfg, $storeid, $param->{vmid}, $param->{format}, $size, { name => $name });

↑ Here opts is a reference (iow. a scalar, as in `$opts`, not `%opts`).

>  
>  	return $volid;
>      }});
> diff --git a/src/PVE/GuestImport.pm b/src/PVE/GuestImport.pm
> index 16099ca..76ebc9d 100644
> --- a/src/PVE/GuestImport.pm
> +++ b/src/PVE/GuestImport.pm
> @@ -69,7 +69,7 @@ sub extract_disk_from_import_file {
>  
>  	# create temporary 1M image that will get overwritten by the rename
>  	# to reserve the filename and take care of locking
> -	$target_volid = PVE::Storage::vdisk_alloc($cfg, $target_storeid, $vmid, $inner_fmt, undef, 1024);
> +	$target_volid = PVE::Storage::vdisk_alloc($cfg, $target_storeid, $vmid, $inner_fmt, 1024);
>  	$target_path = PVE::Storage::path($cfg, $target_volid);
>  
>  	print "renaming $source_path to $target_path\n";
> diff --git a/src/PVE/Storage.pm b/src/PVE/Storage.pm
> index eea51e9..ab4dcdd 100755
> --- a/src/PVE/Storage.pm
> +++ b/src/PVE/Storage.pm
> @@ -1056,8 +1056,36 @@ sub unmap_volume {
>      return $plugin->unmap_volume($storeid, $scfg, $volname, $snapname);
>  }
>  
> -sub vdisk_alloc {
> -    my ($cfg, $storeid, $vmid, $fmt, $name, $size) = @_;
> +=head3 vdisk_alloc($cfg, $storeid, $vmid, $fmt, $size [, %opts])

↑ Here you document it as an inline hash.

> +
> +Allocates a volume on the storage with the identifier C<$storeid> (defined in
> +the storage config C<$cfg>) for the VM with the id C<$vmid> with format C<$fmt>
> +and a size of C<$size> kilobytes.
> +
> +The format C<$fmt> can be C<'raw'>, C<'qcow2'>, C<'subvol'> or C<'vmdk'>. If
> +C<$fmt> is left undefined, it will fallback on the default format of the storage
> +type of C<$storeid>.
> +
> +Optionally, the following key-value pairs are available for C<%opts>:
> +
> +=over
> +
> +=item * C<< $name => $string >>
> +
> +Specifies the name of the new volume.
> +
> +If undefined, the name will be automatically generated.
> +
> +=back
> +
> +Returns the identifier for the new volume in the format C<"$storeid:$volname">.
> +
> +=cut
> +
> +sub vdisk_alloc : prototype($$$$$;%) {
> +    my ($cfg, $storeid, $vmid, $fmt, $size, $opts) = @_;

↑ Here you use % for the prototype, but $ for the parameter.

You need to stick with one variant. ;-)

(These days, personally I'd go for a reference ($), since we use %
rarely, and it's a nicer separation from the unnamed parameters IMO...)

> +
> +    my $name = $opts->{name};
>  
>      die "no storage ID specified\n" if !$storeid;
>  
> diff --git a/src/test/run_test_zfspoolplugin.pl b/src/test/run_test_zfspoolplugin.pl
> index 095ccb3..7dd0a2b 100755
> --- a/src/test/run_test_zfspoolplugin.pl
> +++ b/src/test/run_test_zfspoolplugin.pl
> @@ -565,7 +565,7 @@ my $test13 = sub {
>      print "\nrun test13 \"vdisk_alloc\"\n";
>  
>      eval {
> -	my $tmp_volid = PVE::Storage::vdisk_alloc($cfg, $storagename, "112", "raw", undef ,1024 * 1024);
> +	my $tmp_volid = PVE::Storage::vdisk_alloc($cfg, $storagename, "112", "raw", 1024 * 1024);
>  
>  	if ($tmp_volid ne "$storagename:vm-112-disk-0") {
>  	    die "volname:$tmp_volid don't match\n";
> @@ -589,7 +589,7 @@ my $test13 = sub {
>      }
>  
>      eval {
> -	my $tmp_volid = PVE::Storage::vdisk_alloc($cfg, $storagename, "112", "raw", undef ,2048 * 1024);
> +	my $tmp_volid = PVE::Storage::vdisk_alloc($cfg, $storagename, "112", "raw", 2048 * 1024);
>  
>  	if ($tmp_volid ne "$storagename:vm-112-disk-1") {
>  	    die "volname:$tmp_volid don't match\n";
> @@ -613,7 +613,7 @@ my $test13 = sub {
>      }
>  
>      eval {
> -	my $tmp_volid = PVE::Storage::vdisk_alloc($cfg, $storagename, "113", "subvol", undef ,1024 * 1024);
> +	my $tmp_volid = PVE::Storage::vdisk_alloc($cfg, $storagename, "113", "subvol", 1024 * 1024);
>  
>  	if ($tmp_volid ne "$storagename:subvol-113-disk-0") {
>  	    die "volname:$tmp_volid  don't match\n";
> @@ -637,7 +637,7 @@ my $test13 = sub {
>      }
>  
>      eval {
> -	my $tmp_volid = PVE::Storage::vdisk_alloc($cfg, $storagename, "113", "subvol", undef ,2048 * 1024);
> +	my $tmp_volid = PVE::Storage::vdisk_alloc($cfg, $storagename, "113", "subvol", 2048 * 1024);
>  
>  	if ($tmp_volid ne "$storagename:subvol-113-disk-1") {
>  	    die "volname:$tmp_volid  don't match\n";
> -- 
> 2.39.5


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

  reply	other threads:[~2025-05-05 14:51 UTC|newest]

Thread overview: 32+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-04-15 13:50 [pve-devel] [PATCH storage/qemu-server/container v3 00/27] consistent assertions for volume's content types Daniel Kral
2025-04-15 13:50 ` [pve-devel] [PATCH storage v3 1/4] introduce helpers for content type assertions of storages and volumes Daniel Kral
2025-04-15 13:50 ` [pve-devel] [PATCH storage v3 2/4] tree-wide: make use of content type assertion helper Daniel Kral
2025-04-15 13:50 ` [pve-devel] [PATCH storage v3 3/4] vdisk_alloc: factor out optional parameters in options hash argument Daniel Kral
2025-05-05 14:51   ` Wolfgang Bumiller [this message]
2025-05-06  7:33     ` Daniel Kral
2025-04-15 13:50 ` [pve-devel] [PATCH storage v3 4/4] vdisk_alloc: add assertion for volume's content type Daniel Kral
2025-04-15 13:50 ` [pve-devel] [PATCH qemu-server v3 01/12] fix #5284: cli: importovf: assert content type support for target storage Daniel Kral
2025-04-15 13:50 ` [pve-devel] [PATCH qemu-server v3 02/12] api: remove unusable default storage parameter in check_storage_access Daniel Kral
2025-04-15 13:50 ` [pve-devel] [PATCH qemu-server v3 03/12] fix #5284: api: update-vm: assert content type support for cloudinit images Daniel Kral
2025-04-15 13:50 ` [pve-devel] [PATCH qemu-server v3 04/12] tree-wide: update vdisk_alloc optional arguments signature Daniel Kral
2025-04-15 13:50 ` [pve-devel] [PATCH qemu-server v3 05/12] tree-wide: update vdisk_alloc vtype argument signature Daniel Kral
2025-04-15 13:50 ` [pve-devel] [PATCH qemu-server v3 06/12] cfg2cmd: improve error message for invalid volume content type Daniel Kral
2025-04-15 13:50 ` [pve-devel] [PATCH qemu-server v3 07/12] api: {clone, move}_vm: use volume content type assertion helpers Daniel Kral
2025-04-15 13:50 ` [pve-devel] [PATCH qemu-server v3 08/12] api: {create, update}_vm: " Daniel Kral
2025-04-15 13:50 ` [pve-devel] [PATCH qemu-server v3 09/12] api: import{disk, ovf}: " Daniel Kral
2025-04-15 13:50 ` [pve-devel] [PATCH qemu-server v3 10/12] api: qmrestore: " Daniel Kral
2025-04-15 13:50 ` [pve-devel] [PATCH qemu-server v3 11/12] api: migrate_vm: " Daniel Kral
2025-04-15 13:50 ` [pve-devel] [PATCH qemu-server v3 12/12] tree-wide: add todos for breaking content type assertions Daniel Kral
2025-04-15 13:50 ` [pve-devel] [PATCH container v3 01/11] migration: prepare: factor out common read-only variables Daniel Kral
2025-04-15 13:50 ` [pve-devel] [PATCH container v3 02/11] tests: add tests for expected behavior of alloc_disk wrapper Daniel Kral
2025-04-15 13:50 ` [pve-devel] [PATCH container v3 03/11] alloc disk: fix content type check for ZFS storages Daniel Kral
2025-04-15 13:50 ` [pve-devel] [PATCH container v3 04/11] alloc_disk: factor out common arguments for call to vdisk_alloc Daniel Kral
2025-04-15 13:50 ` [pve-devel] [PATCH container v3 05/11] alloc_disk: simplify storage-specific logic for vdisk_alloc arguments Daniel Kral
2025-04-15 13:50 ` [pve-devel] [PATCH container v3 06/11] alloc_disk: update vdisk_alloc optional arguments signature Daniel Kral
2025-04-15 13:50 ` [pve-devel] [PATCH container v3 07/11] alloc_disk: use volume content type assertion helpers Daniel Kral
2025-04-15 13:50 ` [pve-devel] [PATCH container v3 08/11] api: create: " Daniel Kral
2025-04-15 13:50 ` [pve-devel] [PATCH container v3 09/11] migration: prepare: " Daniel Kral
2025-04-15 13:50 ` [pve-devel] [PATCH container v3 10/11] api: update_vm: " Daniel Kral
2025-04-15 13:50 ` [pve-devel] [PATCH container v3 11/11] mount: raw/iso: " Daniel Kral
2025-05-06  8:33 ` [pve-devel] [PATCH storage/qemu-server/container v3 00/27] consistent assertions for volume's content types Wolfgang Bumiller
2025-05-09  8:11   ` Fabian Grünbichler

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=34ne6csctoxhbdjt5keirw53lxjrjuhu23zmezbcvvhc34tt25@yirnz2u373gd \
    --to=w.bumiller@proxmox.com \
    --cc=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