[pve-devel] [PATCH guest-common v3 1/4] mapping: pci: rework properties check

[Fiona Ebner]

Am 19.04.24 um 14:45 schrieb Dominik Csapak:
> rename '$cfg' to '$mapping', 'correct' to 'expected'
> reword the error messages
> also check keys from the configured props not only the expected ones
> 

Would've been nicer as multiple commits.

> previously we only checked the keys from the 'correct_props' hash
> but that was unintended. We now check the keys from both, but extract
> the relevant properties first.
> 
> Signed-off-by: Dominik Csapak <d.csapak at proxmox.com>
> ---
> changes from v2:
> * don't refactor the properties check out
> * use properties from both configured and expected hashes
> * extract the relevant configured properties from the mapping
>   instead of using all (previously we only used the expected ones
>   by accident)
>  src/PVE/Mapping/PCI.pm | 34 +++++++++++++++++++---------------
>  1 file changed, 19 insertions(+), 15 deletions(-)
> 
> diff --git a/src/PVE/Mapping/PCI.pm b/src/PVE/Mapping/PCI.pm
> index 725e106..ef1bd8d 100644
> --- a/src/PVE/Mapping/PCI.pm
> +++ b/src/PVE/Mapping/PCI.pm
> @@ -131,9 +131,9 @@ sub options {
>  
>  # checks if the given config is valid for the current node
>  sub assert_valid {
> -    my ($name, $cfg) = @_;
> +    my ($name, $mapping) = @_;
>  
> -    my @paths = split(';', $cfg->{path} // '');
> +    my @paths = split(';', $mapping->{path} // '');
>  
>      my $idx = 0;
>      for my $path (@paths) {
> @@ -148,32 +148,36 @@ sub assert_valid {
>  	my $info = PVE::SysFSTools::pci_device_info($path, 1);
>  	die "pci device '$path' not found\n" if !defined($info);
>  
> -	my $correct_props = {

My suggestion is the following code changes. See below for rationale[0].

# make sure to initialize all keys that should be checked below!

> +	my $expected_props = {
>  	    id => "$info->{vendor}:$info->{device}",
>  	    iommugroup => $info->{iommugroup},

'subsystem-id' => undef,

>  	};
>  
>  	if (defined($info->{'subsystem_vendor'}) && defined($info->{'subsystem_device'})) {
> -	    $correct_props->{'subsystem-id'} = "$info->{'subsystem_vendor'}:$info->{'subsystem_device'}";
> +	    $expected_props->{'subsystem-id'} = "$info->{'subsystem_vendor'}:$info->{'subsystem_device'}";
>  	}
>  
> -	for my $prop (sort keys %$correct_props) {
> +	my $configured_props = { $mapping->%{qw(id iommugroup subsystem-id)} };
> +
> +	my $merged = { %$expected_props, %$configured_props }; # just for the keys
> +	for my $prop (sort keys %$merged) {

I'd prefer to just extract the keys directly and avoid the comment:

my @keys = keys { $expected_props->%*, $configured_props->%* }->%*;

[0]: But we could also just initialize $expected_props like mentioned
above and then simply use the keys from there. Then you also don't need
to construct a new hash for $configured_props and introduce a new
hard-coded list ;)

>  	    next if $prop eq 'iommugroup' && $idx > 0; # check iommu only on the first device
>  
> -	    next if !defined($correct_props->{$prop}) && !defined($cfg->{$prop});
> -	    die "no '$prop' for device '$path'\n"
> -		if defined($correct_props->{$prop}) && !defined($cfg->{$prop});
> -	    die "'$prop' configured but should not be\n"
> -		if !defined($correct_props->{$prop}) && defined($cfg->{$prop});
> +	    next if !defined($expected_props->{$prop}) && !defined($configured_props->{$prop});
> +	    die "missing expected property '$prop' for device '$path'\n"
> +		if defined($expected_props->{$prop}) && !defined($configured_props->{$prop});
> +	    die "unexpected property '$prop' configured for device '$path'\n"
> +		if !defined($expected_props->{$prop}) && defined($configured_props->{$prop});
>  
> -	    my $correct_prop = $correct_props->{$prop};
> -	    $correct_prop =~ s/0x//g;
> -	    my $configured_prop = $cfg->{$prop};
> +	    my $expected_prop = $expected_props->{$prop};
> +	    $expected_prop =~ s/0x//g;
> +	    my $configured_prop = $configured_props->{$prop};
>  	    $configured_prop =~ s/0x//g;
>  
> -	    die "'$prop' does not match for '$name' ($correct_prop != $configured_prop)\n"
> -		if $correct_prop ne $configured_prop;
> +	    die "'$prop' does not match for '$name' ($expected_prop != $configured_prop)\n"
> +		if $expected_prop ne $configured_prop;
>  	}
> +
>  	$idx++;
>      }
>