Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
Subject: Re: [PATCH 1/1] efi/efi_test: read RuntimeServicesSupported
To:     ivanhu <ivan.hu@canonical.com>, Ard Biesheuvel <ardb@kernel.org>
Cc:     linux-efi@vger.kernel.org, linux-kernel@vger.kernel.org,
        Colin King <colin.king@canonical.com>,
        fwts-devel@lists.ubuntu.com
References: <20201127192051.1430-1-xypron.glpk@gmx.de>
 <1fbab8b3-3a37-f3f5-39b4-0c8123d27b29@canonical.com>
 <b1d8c534-8b47-5653-cf52-71ad5323ef14@gmx.de>
 <b230c85b-0015-d494-52ef-c6177f923e48@canonical.com>
From:   Heinrich Schuchardt <xypron.glpk@gmx.de>
Message-ID: <9feb54b4-447a-12f9-d781-e510623c2aef@gmx.de>
Date:   Wed, 2 Dec 2020 12:38:51 +0100
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:78.0) Gecko/20100101
 Thunderbird/78.5.0
MIME-Version: 1.0
In-Reply-To: <b230c85b-0015-d494-52ef-c6177f923e48@canonical.com>
Content-Type: text/plain; charset=utf-8; format=flowed
Content-Language: en-US
Content-Transfer-Encoding: quoted-printable
Precedence: bulk

On 11/30/20 11:38 AM, ivanhu wrote:
>
>
> On 11/30/20 5:17 PM, Heinrich Schuchardt wrote:
>> On 11/30/20 9:16 AM, ivanhu wrote:
>>> Hi Heinrich,
>>>
>>> Thanks for the patch.
>>> It looks good to me, but I noticed that the runtime_supported_mask was
>>> introduced after 5.7-rc1.
>>> Maybe we should add the kernel version checking for the old kernels.
>>
>> This is a kernel patch. Why should we check the kernel version in the
>> kernel code?
>>
>> As patches may be back-ported we should not make any assumptions in fwt=
s
>> based on the kernel version. If the ioctl() call fails with errno =3D
>> ENOTTY, we know that the kernel does not implement the ioctl call and w=
e
>> have to assume that all runtime services are available.
>
> Sounds good to me,
> Acked-by: Ivan Hu <ivan.hu@canonical.com>
>
> And I will replace the reading RuntimeServicesSupported efi variable by
> using efi_test in fwts RuntimeServicesSupported tests.
>
> FWTS will still test those Unsupported Runtime services to check if it
> returns EFI_UNSUPPORTED correctly.
> Is that could solve your problem?
> If I remember correctly, the problem from you is not to test those
> marked Unsupported Runtime services. But from the Spec. 8.1 Runtime
> Services Rules and Restrictions,

The problem I reported was that it is impossible to test UEFI runtime
services on U-Boot because FWTS tries to read the non-existent
RuntimeServicesSupported UEFI variable and mistakenly assumes that if
the variable does not exist none of the runtime services is implemented.

The correct thing to do in FWTS is:

* read RuntimeServicesSupported via the ioctl
* if the ioctl fails assume that all runtime services
   are implemented
* if the ioctl fails with errno !=3D ENOTTY write an error message
* for each runtime service marked as not supported
   check that it returns EFI_UNSUPPORTED
* for each service marked as supported
   check that it works correctly

Best regards

Heinrich

> "
> Note that this is merely a hint to the OS, which it is free to ignore,
> and so the platform is still required to provide callable
> implementations of unsupported runtime services that simply return
> EFI_UNSUPPORTED.
> "
>
> Cheers,
> Ivan
>>
>> Best regards
>>
>> Heinrich
>>
>>>
>>> Cheers,
>>> Ivan
>>>
>>> On 11/28/20 3:20 AM, Heinrich Schuchardt wrote:
>>>> Since the UEFI 2.8A specification the UEFI enabled firmware provides =
a
>>>> configuration table EFI_RT_PROPERTIES_TABLE which indicates which
>>>> runtime
>>>> services are enabled. The EFI stub reads this table and saves the
>>>> value of
>>>> the field RuntimeServicesSupported internally.
>>>>
>>>> The Firmware Test Suite requires the value to determine if UEFI runti=
me
>>>> services are correctly implemented.
>>>>
>>>> With this patch an IOCTL call is provided to read the value of the fi=
eld
>>>> RuntimeServicesSupported, e.g.
>>>>
>>>>  =C2=A0=C2=A0=C2=A0=C2=A0 #define EFI_RUNTIME_GET_SUPPORTED_MASK \
>>>>  =C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=
=C2=A0 _IOR('p', 0x0C, unsigned int)
>>>>  =C2=A0=C2=A0=C2=A0=C2=A0 unsigned int mask;
>>>>  =C2=A0=C2=A0=C2=A0=C2=A0 fd =3D open("/dev/efi_test", O_RDWR);
>>>>  =C2=A0=C2=A0=C2=A0=C2=A0 ret =3D ioctl(fd, EFI_RUNTIME_GET_SUPPORTED=
_MASK, &mask);
>>>>
>>>> Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
>>>> ---
>>>>  =C2=A0 drivers/firmware/efi/test/efi_test.c | 16 ++++++++++++++++
>>>>  =C2=A0 drivers/firmware/efi/test/efi_test.h |=C2=A0 3 +++
>>>>  =C2=A0 2 files changed, 19 insertions(+)
>>>>
>>>> diff --git a/drivers/firmware/efi/test/efi_test.c
>>>> b/drivers/firmware/efi/test/efi_test.c
>>>> index ddf9eae396fe..47d67bb0a516 100644
>>>> --- a/drivers/firmware/efi/test/efi_test.c
>>>> +++ b/drivers/firmware/efi/test/efi_test.c
>>>> @@ -663,6 +663,19 @@ static long
>>>> efi_runtime_query_capsulecaps(unsigned long arg)
>>>>  =C2=A0=C2=A0=C2=A0=C2=A0=C2=A0 return rv;
>>>>  =C2=A0 }
>>>>
>>>> +static long efi_runtime_get_supported_mask(unsigned long arg)
>>>> +{
>>>> +=C2=A0=C2=A0=C2=A0 unsigned int __user *supported_mask;
>>>> +=C2=A0=C2=A0=C2=A0 int rv =3D 0;
>>>> +
>>>> +=C2=A0=C2=A0=C2=A0 supported_mask =3D (unsigned int *)arg;
>>>> +
>>>> +=C2=A0=C2=A0=C2=A0 if (put_user(efi.runtime_supported_mask, supporte=
d_mask))
>>>> +=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0 rv =3D -EFAULT;
>>>> +
>>>> +=C2=A0=C2=A0=C2=A0 return rv;
>>>> +}
>>>> +
>>>>  =C2=A0 static long efi_test_ioctl(struct file *file, unsigned int cm=
d,
>>>>  =C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=
=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=
=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0 unsigned long arg)
>>>>  =C2=A0 {
>>>> @@ -699,6 +712,9 @@ static long efi_test_ioctl(struct file *file,
>>>> unsigned int cmd,
>>>>
>>>>  =C2=A0=C2=A0=C2=A0=C2=A0=C2=A0 case EFI_RUNTIME_RESET_SYSTEM:
>>>>  =C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0 return efi_ru=
ntime_reset_system(arg);
>>>> +
>>>> +=C2=A0=C2=A0=C2=A0 case EFI_RUNTIME_GET_SUPPORTED_MASK:
>>>> +=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0 return efi_runtime_get_su=
pported_mask(arg);
>>>>  =C2=A0=C2=A0=C2=A0=C2=A0=C2=A0 }
>>>>
>>>>  =C2=A0=C2=A0=C2=A0=C2=A0=C2=A0 return -ENOTTY;
>>>> diff --git a/drivers/firmware/efi/test/efi_test.h
>>>> b/drivers/firmware/efi/test/efi_test.h
>>>> index f2446aa1c2e3..117349e57993 100644
>>>> --- a/drivers/firmware/efi/test/efi_test.h
>>>> +++ b/drivers/firmware/efi/test/efi_test.h
>>>> @@ -118,4 +118,7 @@ struct efi_resetsystem {
>>>>  =C2=A0 #define EFI_RUNTIME_RESET_SYSTEM \
>>>>  =C2=A0=C2=A0=C2=A0=C2=A0=C2=A0 _IOW('p', 0x0B, struct efi_resetsyste=
m)
>>>>
>>>> +#define EFI_RUNTIME_GET_SUPPORTED_MASK \
>>>> +=C2=A0=C2=A0=C2=A0 _IOR('p', 0x0C, unsigned int)
>>>> +
>>>>  =C2=A0 #endif /* _DRIVERS_FIRMWARE_EFI_TEST_H_ */
>>>> --
>>>> 2.29.2
>>>>
>>