[pve-devel] [PATCH storage v3 3/4] vdisk_alloc: factor out optional parameters in options hash argument

[Wolfgang Bumiller]

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 at 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