diff mbox series

[V3] KVM: selftests: Add a new option to rseq_test

Message ID 20240416225153.23801-1-zide.chen@intel.com (mailing list archive)
State New
Headers show
Series [V3] KVM: selftests: Add a new option to rseq_test | expand

Commit Message

Zide Chen April 16, 2024, 10:51 p.m. UTC
Currently, the migration worker delays 1-10 us, assuming that one
KVM_RUN iteration only takes a few microseconds.  But if the CPU low
power wakeup latency is large enough, for example, hundreds or even
thousands of microseconds deep C-state exit latencies on x86 server
CPUs, it may happen that it's not able to wakeup the target CPU before
the migration worker starts to migrate the vCPU thread to the next CPU.

If the system workload is light, most CPUs could be at a certain low
power state, which may result in less successful migrations and fail the
migration/KVM_RUN ratio sanity check.  But this is not supposed to be
deemed a test failure.

This patch adds a command line option to skip the sanity check in
this case.

Signed-off-by: Zide Chen <zide.chen@intel.com>
Signed-off-by: donsheng <dongsheng.x.zhang@intel.com>

V2:
- removed the busy loop implementation
- add the new "-s" option

V3:
- drop the usleep randomization code
- removed the term C-state for less confusion for non-x86 archetectures
- changed subject
---
 tools/testing/selftests/kvm/rseq_test.c | 40 +++++++++++++++++++++++--
 1 file changed, 38 insertions(+), 2 deletions(-)

Comments

Sean Christopherson April 29, 2024, 7:39 p.m. UTC | #1
On Tue, Apr 16, 2024, Zide Chen wrote:
> Currently, the migration worker delays 1-10 us, assuming that one
> KVM_RUN iteration only takes a few microseconds.  But if the CPU low
> power wakeup latency is large enough, for example, hundreds or even
> thousands of microseconds deep C-state exit latencies on x86 server
> CPUs, it may happen that it's not able to wakeup the target CPU before
> the migration worker starts to migrate the vCPU thread to the next CPU.
> 
> If the system workload is light, most CPUs could be at a certain low
> power state, which may result in less successful migrations and fail the
> migration/KVM_RUN ratio sanity check.  But this is not supposed to be
> deemed a test failure.
> 
> This patch adds a command line option to skip the sanity check in
> this case.
> 
> Signed-off-by: Zide Chen <zide.chen@intel.com>
> Signed-off-by: donsheng <dongsheng.x.zhang@intel.com>

Why does this have Donghsheng's SoB?  Is this a Co-developed-by situation?

> 

Put per-patch notes that aren't intended for the final changelog...

> V2:
> - removed the busy loop implementation
> - add the new "-s" option
> 
> V3:
> - drop the usleep randomization code
> - removed the term C-state for less confusion for non-x86 archetectures
> - changed subject
> ---

...down here below the "---", as this section is ignored by `git am`.  That way
the maintainer (me) doesn't need to manually delete the notes when applying.

>  tools/testing/selftests/kvm/rseq_test.c | 40 +++++++++++++++++++++++--
>  1 file changed, 38 insertions(+), 2 deletions(-)

> +static void help(const char *name)
> +{
> +	puts("");
> +	printf("usage: %s [-h] [-s]\n", name);
> +	printf(" -s: skip the sanity check for successful KVM_RUN.\n");

Hmm, -s ends up being somewhat confusing because "sanity" also starts with 's',
e.g. my first thought is that "./rseq_test -s" would be "run the test with sanity
checks".

Maybe -u for unchecked/unverified?

	printf(" -u: Don't sanity check the number of successful KVM_RUNs\n");

> @@ -254,9 +277,22 @@ int main(int argc, char *argv[])
>  	 * getcpu() to stabilize.  A 2:1 migration:KVM_RUN ratio is a fairly
>  	 * conservative ratio on x86-64, which can do _more_ KVM_RUNs than
>  	 * migrations given the 1us+ delay in the migration task.
> +	 *
> +	 * Another reason why it may have small migration:KVM_RUN ratio is that,
> +	 * on systems with large low power mode wakeup latency, it may happen
> +	 * quite often that the scheduler is not able to wake up the target CPU
> +	 * before the vCPU thread is scheduled to another CPU.
>  	 */
> -	TEST_ASSERT(i > (NR_TASK_MIGRATIONS / 2),
> -		    "Only performed %d KVM_RUNs, task stalled too much?", i);
> +	TEST_ASSERT(skip_sanity_check || i > (NR_TASK_MIGRATIONS / 1),
> +		    "Only performed %d KVM_RUNs, task stalled too much? \n"
> +		    "  Try to run it with -s option, or disable deep sleep "
> +		    "states in the system,\n"
> +		    "  e.g., boot the host with cpuidle.off=1 or other driver "
> +		    "specific kernel options,\n"
> +		    "  or do it through the PM QoS interface at runtime: \n"
> +		    "    cat > /dev/cpu_dma_latency <(echo -e -n "
> +		    "\"\\x0\\x0\\x0\\x0\"; sleep inf) &\n"
> +		    "    PID=$! && run_the_test && kill $PID" , i);

I appreciate trying to be helpful, but this is a bit too verbose.  I would also
prefer to call out the command line option last, e.g. so that readers don't
automatically rerun with the sanity check disabled without reading the rest of
the error message.

How about this?


	TEST_ASSERT(skip_sanity_check || i > (NR_TASK_MIGRATIONS / 1),
		    "Only performed %d KVM_RUNs, task stalled too much? \n"
                    "Try disabling deep sleep states to reduce CPU wakeup latency,\n"
		    "e.g. via cpuidle.off=1 or setting /dev/cpu_dma_latency to '0',\n"
                    "or run with -u to disable this sanity check", i);
Zide Chen April 29, 2024, 11:16 p.m. UTC | #2
On 4/29/2024 12:39 PM, Sean Christopherson wrote:
>> Signed-off-by: Zide Chen <zide.chen@intel.com>
>> Signed-off-by: donsheng <dongsheng.x.zhang@intel.com>
> 
> Why does this have Donghsheng's SoB?  Is this a Co-developed-by situation?

Yes, Co-developed-by is more suitable.

>>
> 
> Put per-patch notes that aren't intended for the final changelog...
> 
>> V2:
>> - removed the busy loop implementation
>> - add the new "-s" option
>>
>> V3:
>> - drop the usleep randomization code
>> - removed the term C-state for less confusion for non-x86 archetectures
>> - changed subject
>> ---
> 
> ...down here below the "---", as this section is ignored by `git am`.  That way
> the maintainer (me) doesn't need to manually delete the notes when applying.

Got it, thank you very much!

>>  tools/testing/selftests/kvm/rseq_test.c | 40 +++++++++++++++++++++++--
>>  1 file changed, 38 insertions(+), 2 deletions(-)
> 
>> +static void help(const char *name)
>> +{
>> +	puts("");
>> +	printf("usage: %s [-h] [-s]\n", name);
>> +	printf(" -s: skip the sanity check for successful KVM_RUN.\n");
> 
> Hmm, -s ends up being somewhat confusing because "sanity" also starts with 's',
> e.g. my first thought is that "./rseq_test -s" would be "run the test with sanity
> checks".
> 
> Maybe -u for unchecked/unverified?

Agree, it's better.

> 	printf(" -u: Don't sanity check the number of successful KVM_RUNs\n");
> 
>> @@ -254,9 +277,22 @@ int main(int argc, char *argv[])
>>  	 * getcpu() to stabilize.  A 2:1 migration:KVM_RUN ratio is a fairly
>>  	 * conservative ratio on x86-64, which can do _more_ KVM_RUNs than
>>  	 * migrations given the 1us+ delay in the migration task.
>> +	 *
>> +	 * Another reason why it may have small migration:KVM_RUN ratio is that,
>> +	 * on systems with large low power mode wakeup latency, it may happen
>> +	 * quite often that the scheduler is not able to wake up the target CPU
>> +	 * before the vCPU thread is scheduled to another CPU.
>>  	 */
>> -	TEST_ASSERT(i > (NR_TASK_MIGRATIONS / 2),
>> -		    "Only performed %d KVM_RUNs, task stalled too much?", i);
>> +	TEST_ASSERT(skip_sanity_check || i > (NR_TASK_MIGRATIONS / 1),
>> +		    "Only performed %d KVM_RUNs, task stalled too much? \n"
>> +		    "  Try to run it with -s option, or disable deep sleep "
>> +		    "states in the system,\n"
>> +		    "  e.g., boot the host with cpuidle.off=1 or other driver "
>> +		    "specific kernel options,\n"
>> +		    "  or do it through the PM QoS interface at runtime: \n"
>> +		    "    cat > /dev/cpu_dma_latency <(echo -e -n "
>> +		    "\"\\x0\\x0\\x0\\x0\"; sleep inf) &\n"
>> +		    "    PID=$! && run_the_test && kill $PID" , i);
> 
> I appreciate trying to be helpful, but this is a bit too verbose.  I would also
> prefer to call out the command line option last, e.g. so that readers don't
> automatically rerun with the sanity check disabled without reading the rest of
> the error message.
> 
> How about this?
> 
> 
> 	TEST_ASSERT(skip_sanity_check || i > (NR_TASK_MIGRATIONS / 1),
> 		    "Only performed %d KVM_RUNs, task stalled too much? \n"
>                     "Try disabling deep sleep states to reduce CPU wakeup latency,\n"
> 		    "e.g. via cpuidle.off=1 or setting /dev/cpu_dma_latency to '0',\n"
>                     "or run with -u to disable this sanity check", i);

Thank you very much for your patience and your suggestions! I'll adopt
them to V4. How baout to add two white spaces in front of the 2nd, 3rd
and 4th in order to align with the first line (Only performed ... )?

==== Test Assertion Failure ====
  rseq_test.c:286: skip_sanity_check || i > (NR_TASK_MIGRATIONS / 1)
  pid=17851 tid=17851 errno=4 - Interrupted system call
     1  0x00000000004029da: main at rseq_test.c:286
     2  0x00007ff615029d8f: ?? ??:0
     3  0x00007ff615029e3f: ?? ??:0
     4  0x0000000000402ab4: _start at ??:?
  Only performed 22249 KVM_RUNs, task stalled too much?
  Try disabling deep sleep states to reduce CPU wakeup latency,
  e.g. via cpuidle.off=1 or setting /dev/cpu_dma_latency to '0',
  or run with -u to disable this sanity check.
diff mbox series

Patch

diff --git a/tools/testing/selftests/kvm/rseq_test.c b/tools/testing/selftests/kvm/rseq_test.c
index 28f97fb52044..1daac3f51447 100644
--- a/tools/testing/selftests/kvm/rseq_test.c
+++ b/tools/testing/selftests/kvm/rseq_test.c
@@ -186,12 +186,35 @@  static void calc_min_max_cpu(void)
 		       "Only one usable CPU, task migration not possible");
 }
 
+static void help(const char *name)
+{
+	puts("");
+	printf("usage: %s [-h] [-s]\n", name);
+	printf(" -s: skip the sanity check for successful KVM_RUN.\n");
+	puts("");
+	exit(0);
+}
+
 int main(int argc, char *argv[])
 {
 	int r, i, snapshot;
 	struct kvm_vm *vm;
 	struct kvm_vcpu *vcpu;
 	u32 cpu, rseq_cpu;
+	bool skip_sanity_check = false;
+	int opt;
+
+	while ((opt = getopt(argc, argv, "sh")) != -1) {
+		switch (opt) {
+		case 's':
+			skip_sanity_check = true;
+			break;
+		case 'h':
+		default:
+			help(argv[0]);
+			break;
+		}
+	}
 
 	r = sched_getaffinity(0, sizeof(possible_mask), &possible_mask);
 	TEST_ASSERT(!r, "sched_getaffinity failed, errno = %d (%s)", errno,
@@ -254,9 +277,22 @@  int main(int argc, char *argv[])
 	 * getcpu() to stabilize.  A 2:1 migration:KVM_RUN ratio is a fairly
 	 * conservative ratio on x86-64, which can do _more_ KVM_RUNs than
 	 * migrations given the 1us+ delay in the migration task.
+	 *
+	 * Another reason why it may have small migration:KVM_RUN ratio is that,
+	 * on systems with large low power mode wakeup latency, it may happen
+	 * quite often that the scheduler is not able to wake up the target CPU
+	 * before the vCPU thread is scheduled to another CPU.
 	 */
-	TEST_ASSERT(i > (NR_TASK_MIGRATIONS / 2),
-		    "Only performed %d KVM_RUNs, task stalled too much?", i);
+	TEST_ASSERT(skip_sanity_check || i > (NR_TASK_MIGRATIONS / 1),
+		    "Only performed %d KVM_RUNs, task stalled too much? \n"
+		    "  Try to run it with -s option, or disable deep sleep "
+		    "states in the system,\n"
+		    "  e.g., boot the host with cpuidle.off=1 or other driver "
+		    "specific kernel options,\n"
+		    "  or do it through the PM QoS interface at runtime: \n"
+		    "    cat > /dev/cpu_dma_latency <(echo -e -n "
+		    "\"\\x0\\x0\\x0\\x0\"; sleep inf) &\n"
+		    "    PID=$! && run_the_test && kill $PID" , i);
 
 	pthread_join(migration_thread, NULL);