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

[Daniel Kral]

On 5/5/25 16:51, Wolfgang Bumiller wrote:
> On Tue, Apr 15, 2025 at 03:50:21PM +0200, Daniel Kral wrote:
>> 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...)

Right, I wanted to use a hash reference here, so I'll go for that ;).

I'll fix the documentation in either a small fix up or v4 if something 
other comes up in the series.