[v5,00/13] RISCV: Add KVM_GET_REG_LIST API

  KVM_GET_REG_LIST will dump all register IDs that are available to
KVM_GET/SET_ONE_REG and It's very useful to identify some platform
regression issue during VM migration.

Patch 1-7 re-structured the get-reg-list test in aarch64 to make some
of the code as common test framework that can be shared by riscv.

Patch 8 move reject_set check logic to a function so as to check for
different errno for different registers.
Patch 9 move finalize_vcpu back to run_test so that riscv can implement
its specific operation.
Patch 10 change to do the get/set operation only on present-blessed list.
Patch 11 add the skip_set facilities so that riscv can skip set operation
on some registers.
Patch 12 enabled the KVM_GET_REG_LIST API in riscv.
patch 13 added the corresponding kselftest for checking possible
register regressions.

The get-reg-list kvm selftest was ported from aarch64 and tested with
Linux v6.4 on a Qemu riscv64 virt machine.

---
Changed since v4:
  * Rebase to v6.4
  * Address Andrew's suggestions and comments:
      Added skip_set concept
      Updated errno check logic
      Modified finalize_vcpu as weak function

Andrew Jones (7):
  KVM: arm64: selftests: Replace str_with_index with strdup_printf
  KVM: arm64: selftests: Drop SVE cap check in print_reg
  KVM: arm64: selftests: Remove print_reg's dependency on vcpu_config
  KVM: arm64: selftests: Rename vcpu_config and add to kvm_util.h
  KVM: arm64: selftests: Delete core_reg_fixup
  KVM: arm64: selftests: Split get-reg-list test code
  KVM: arm64: selftests: Finish generalizing get-reg-list

Haibo Xu (6):
  KVM: arm64: selftests: Move reject_set check logic to a function
  KVM: arm64: selftests: Move finalize_vcpu back to run_test
  KVM: selftests: Only do get/set tests on present blessed list
  KVM: selftests: Add skip_set facility to get_reg_list test
  KVM: riscv: Add KVM_GET_REG_LIST API support
  KVM: riscv: selftests: Add get-reg-list test

 Documentation/virt/kvm/api.rst                |   2 +-
 arch/riscv/kvm/vcpu.c                         | 375 +++++++++
 tools/testing/selftests/kvm/Makefile          |  11 +-
 .../selftests/kvm/aarch64/get-reg-list.c      | 544 ++----------
 tools/testing/selftests/kvm/get-reg-list.c    | 395 +++++++++
 .../selftests/kvm/include/kvm_util_base.h     |  21 +
 .../selftests/kvm/include/riscv/processor.h   |   3 +
 .../testing/selftests/kvm/include/test_util.h |   2 +
 tools/testing/selftests/kvm/lib/test_util.c   |  15 +
 .../selftests/kvm/riscv/get-reg-list.c        | 780 ++++++++++++++++++
 10 files changed, 1655 insertions(+), 493 deletions(-)
 create mode 100644 tools/testing/selftests/kvm/get-reg-list.c
 create mode 100644 tools/testing/selftests/kvm/riscv/get-reg-list.c
  

On Sat, Jul 01, 2023 at 09:42:59PM +0800, Haibo Xu wrote:
> Add new skips_set members to vcpu_reg_sublist so as to skip
> set operation on some registers.
> 
> Suggested-by: Andrew Jones <ajones@ventanamicro.com>
> Signed-off-by: Haibo Xu <haibo1.xu@intel.com>
> ---
>  tools/testing/selftests/kvm/get-reg-list.c    | 20 +++++++++++++------
>  .../selftests/kvm/include/kvm_util_base.h     |  2 ++
>  2 files changed, 16 insertions(+), 6 deletions(-)
> 
> diff --git a/tools/testing/selftests/kvm/get-reg-list.c b/tools/testing/selftests/kvm/get-reg-list.c
> index 74fb6f6fdd09..1a32a900aeea 100644
> --- a/tools/testing/selftests/kvm/get-reg-list.c
> +++ b/tools/testing/selftests/kvm/get-reg-list.c
> @@ -157,6 +157,7 @@ static void run_test(struct vcpu_reg_list *c)
>  {
>  	int new_regs = 0, missing_regs = 0, i, n;
>  	int failed_get = 0, failed_set = 0, failed_reject = 0;
> +	int skipped_set = 0;
>  	struct kvm_vcpu *vcpu;
>  	struct kvm_vm *vm;
>  	struct vcpu_reg_sublist *s;
> @@ -210,7 +211,7 @@ static void run_test(struct vcpu_reg_list *c)
>  			.id = reg_list->reg[i],
>  			.addr = (__u64)&addr,
>  		};
> -		bool reject_reg = false;
> +		bool reject_reg = false, skip_reg = false;
>  		int ret;
>  
>  		ret = __vcpu_get_reg(vcpu, reg_list->reg[i], &addr);
> @@ -221,8 +222,8 @@ static void run_test(struct vcpu_reg_list *c)
>  			++failed_get;
>  		}
>  
> -		/* rejects_set registers are rejected after KVM_ARM_VCPU_FINALIZE */
>  		for_each_sublist(c, s) {
> +			/* rejects_set registers are rejected for set operation */
>  			if (s->rejects_set && find_reg(s->rejects_set, s->rejects_set_n, reg.id)) {
>  				reject_reg = true;
>  				ret = __vcpu_ioctl(vcpu, KVM_SET_ONE_REG, &reg);
> @@ -234,9 +235,16 @@ static void run_test(struct vcpu_reg_list *c)
>  				}
>  				break;
>  			}
> +
> +			/* skips_set registers are skipped for set operation */
> +			if (s->skips_set && find_reg(s->skips_set, s->skips_set_n, reg.id)) {
> +				skip_reg = true;
> +				++skipped_set;
> +				break;
> +			}
>  		}
>  
> -		if (!reject_reg) {
> +		if (!reject_reg && !skip_reg) {
>  			ret = __vcpu_ioctl(vcpu, KVM_SET_ONE_REG, &reg);
>  			if (ret) {
>  				printf("%s: Failed to set ", config_name(c));
> @@ -281,9 +289,9 @@ static void run_test(struct vcpu_reg_list *c)
>  	}
>  
>  	TEST_ASSERT(!missing_regs && !failed_get && !failed_set && !failed_reject,
> -		    "%s: There are %d missing registers; "
> -		    "%d registers failed get; %d registers failed set; %d registers failed reject",
> -		    config_name(c), missing_regs, failed_get, failed_set, failed_reject);
> +		    "%s: There are %d missing registers; %d registers failed get; "
> +		    "%d registers failed set; %d registers failed reject; %d registers skipped set",
> +		    config_name(c), missing_regs, failed_get, failed_set, failed_reject, skipped_set);
>  
>  	pr_info("%s: PASS\n", config_name(c));
>  	blessed_n = 0;
> diff --git a/tools/testing/selftests/kvm/include/kvm_util_base.h b/tools/testing/selftests/kvm/include/kvm_util_base.h
> index e4480049000d..67c031fe89a1 100644
> --- a/tools/testing/selftests/kvm/include/kvm_util_base.h
> +++ b/tools/testing/selftests/kvm/include/kvm_util_base.h
> @@ -134,6 +134,8 @@ struct vcpu_reg_sublist {
>  	__u64 regs_n;
>  	__u64 *rejects_set;
>  	__u64 rejects_set_n;
> +	__u64 *skips_set;
> +	__u64 skips_set_n;
>  };
>  
>  struct vcpu_reg_list {
> -- 
> 2.34.1
>

Reviewed-by: Andrew Jones <ajones@ventanamicro.com>
  

On Sat, Jul 1, 2023 at 10:28 PM Andrew Jones <ajones@ventanamicro.com> wrote:
>
> On Sat, Jul 01, 2023 at 09:42:59PM +0800, Haibo Xu wrote:
> > Add new skips_set members to vcpu_reg_sublist so as to skip
> > set operation on some registers.
> >
> > Suggested-by: Andrew Jones <ajones@ventanamicro.com>
> > Signed-off-by: Haibo Xu <haibo1.xu@intel.com>
> > ---
> >  tools/testing/selftests/kvm/get-reg-list.c    | 20 +++++++++++++------
> >  .../selftests/kvm/include/kvm_util_base.h     |  2 ++
> >  2 files changed, 16 insertions(+), 6 deletions(-)
> >
> > diff --git a/tools/testing/selftests/kvm/get-reg-list.c b/tools/testing/selftests/kvm/get-reg-list.c
> > index 74fb6f6fdd09..1a32a900aeea 100644
> > --- a/tools/testing/selftests/kvm/get-reg-list.c
> > +++ b/tools/testing/selftests/kvm/get-reg-list.c
> > @@ -157,6 +157,7 @@ static void run_test(struct vcpu_reg_list *c)
> >  {
> >       int new_regs = 0, missing_regs = 0, i, n;
> >       int failed_get = 0, failed_set = 0, failed_reject = 0;
> > +     int skipped_set = 0;
> >       struct kvm_vcpu *vcpu;
> >       struct kvm_vm *vm;
> >       struct vcpu_reg_sublist *s;
> > @@ -210,7 +211,7 @@ static void run_test(struct vcpu_reg_list *c)
> >                       .id = reg_list->reg[i],
> >                       .addr = (__u64)&addr,
> >               };
> > -             bool reject_reg = false;
> > +             bool reject_reg = false, skip_reg = false;
> >               int ret;
> >
> >               ret = __vcpu_get_reg(vcpu, reg_list->reg[i], &addr);
> > @@ -221,8 +222,8 @@ static void run_test(struct vcpu_reg_list *c)
> >                       ++failed_get;
> >               }
> >
> > -             /* rejects_set registers are rejected after KVM_ARM_VCPU_FINALIZE */
> >               for_each_sublist(c, s) {
> > +                     /* rejects_set registers are rejected for set operation */
> >                       if (s->rejects_set && find_reg(s->rejects_set, s->rejects_set_n, reg.id)) {
> >                               reject_reg = true;
> >                               ret = __vcpu_ioctl(vcpu, KVM_SET_ONE_REG, &reg);
> > @@ -234,9 +235,16 @@ static void run_test(struct vcpu_reg_list *c)
> >                               }
> >                               break;
> >                       }
> > +
> > +                     /* skips_set registers are skipped for set operation */
> > +                     if (s->skips_set && find_reg(s->skips_set, s->skips_set_n, reg.id)) {
> > +                             skip_reg = true;
> > +                             ++skipped_set;
> > +                             break;
> > +                     }
> >               }
> >
> > -             if (!reject_reg) {
> > +             if (!reject_reg && !skip_reg) {
> >                       ret = __vcpu_ioctl(vcpu, KVM_SET_ONE_REG, &reg);
> >                       if (ret) {
> >                               printf("%s: Failed to set ", config_name(c));
> > @@ -281,9 +289,9 @@ static void run_test(struct vcpu_reg_list *c)
> >       }
> >
> >       TEST_ASSERT(!missing_regs && !failed_get && !failed_set && !failed_reject,
> > -                 "%s: There are %d missing registers; "
> > -                 "%d registers failed get; %d registers failed set; %d registers failed reject",
> > -                 config_name(c), missing_regs, failed_get, failed_set, failed_reject);
> > +                 "%s: There are %d missing registers; %d registers failed get; "
> > +                 "%d registers failed set; %d registers failed reject; %d registers skipped set",
> > +                 config_name(c), missing_regs, failed_get, failed_set, failed_reject, skipped_set);
> >
> >       pr_info("%s: PASS\n", config_name(c));
> >       blessed_n = 0;
> > diff --git a/tools/testing/selftests/kvm/include/kvm_util_base.h b/tools/testing/selftests/kvm/include/kvm_util_base.h
> > index e4480049000d..67c031fe89a1 100644
> > --- a/tools/testing/selftests/kvm/include/kvm_util_base.h
> > +++ b/tools/testing/selftests/kvm/include/kvm_util_base.h
> > @@ -134,6 +134,8 @@ struct vcpu_reg_sublist {
> >       __u64 regs_n;
> >       __u64 *rejects_set;
> >       __u64 rejects_set_n;
> > +     __u64 *skips_set;
> > +     __u64 skips_set_n;
> >  };
> >
> >  struct vcpu_reg_list {
> > --
> > 2.34.1
> >
>
> Reviewed-by: Andrew Jones <ajones@ventanamicro.com>

Thanks!
  

On Sat, Jul 01, 2023 at 09:42:48PM +0800, Haibo Xu wrote:
> KVM_GET_REG_LIST will dump all register IDs that are available to
> KVM_GET/SET_ONE_REG and It's very useful to identify some platform
> regression issue during VM migration.
> 
> Patch 1-7 re-structured the get-reg-list test in aarch64 to make some
> of the code as common test framework that can be shared by riscv.
> 
> Patch 8 move reject_set check logic to a function so as to check for
> different errno for different registers.
> Patch 9 move finalize_vcpu back to run_test so that riscv can implement
> its specific operation.
> Patch 10 change to do the get/set operation only on present-blessed list.
> Patch 11 add the skip_set facilities so that riscv can skip set operation
> on some registers.
> Patch 12 enabled the KVM_GET_REG_LIST API in riscv.
> patch 13 added the corresponding kselftest for checking possible
> register regressions.
> 
> The get-reg-list kvm selftest was ported from aarch64 and tested with
> Linux v6.4 on a Qemu riscv64 virt machine.

Hi Haibo,

This series needs a rebase on top of these recent patches

 commit ee053e03b08e ("KVM: selftests: get-reg-list: support ID register features")
 commit 5f0419a0083b ("KVM: selftests: get-reg-list: add Permission Indirection registers")

The conflicts will be in my patches, which do the splitting of the test.
I'll do the rebase and push it to a branch for you to pick up.

Thanks,
drew
  

On Sat, Jul 1, 2023 at 10:53 PM Andrew Jones <ajones@ventanamicro.com> wrote:
>
> On Sat, Jul 01, 2023 at 09:42:48PM +0800, Haibo Xu wrote:
> > KVM_GET_REG_LIST will dump all register IDs that are available to
> > KVM_GET/SET_ONE_REG and It's very useful to identify some platform
> > regression issue during VM migration.
> >
> > Patch 1-7 re-structured the get-reg-list test in aarch64 to make some
> > of the code as common test framework that can be shared by riscv.
> >
> > Patch 8 move reject_set check logic to a function so as to check for
> > different errno for different registers.
> > Patch 9 move finalize_vcpu back to run_test so that riscv can implement
> > its specific operation.
> > Patch 10 change to do the get/set operation only on present-blessed list.
> > Patch 11 add the skip_set facilities so that riscv can skip set operation
> > on some registers.
> > Patch 12 enabled the KVM_GET_REG_LIST API in riscv.
> > patch 13 added the corresponding kselftest for checking possible
> > register regressions.
> >
> > The get-reg-list kvm selftest was ported from aarch64 and tested with
> > Linux v6.4 on a Qemu riscv64 virt machine.
>
> Hi Haibo,
>
> This series needs a rebase on top of these recent patches
>
>  commit ee053e03b08e ("KVM: selftests: get-reg-list: support ID register features")
>  commit 5f0419a0083b ("KVM: selftests: get-reg-list: add Permission Indirection registers")
>
> The conflicts will be in my patches, which do the splitting of the test.
> I'll do the rebase and push it to a branch for you to pick up.
>

Thanks for the heads up. I will include your changes in v6.

> Thanks,
> drew