Add unit test module for AMD P-State driver
v6 cover Add unit test module for AMD P-State driver
Hi all:
AMD P-State unit test(amd-pstate-ut) is a kernel module for testing the functions of amd-pstate driver.
It could import as a module to launch some test tasks.
1) It can help all users to verify their processor support (SBIOS/ Firmware or Hardware).
2) Kernel can have a basic function test to avoid the kernel regression during the update.
3) We can introduce more functional or performance tests to align the together, it will benefit power and performance scale optimization.
We upstream out AMD P-state driver into Linux kernel and use this unit test module to verify the required conditions and basic functions of amd-pstate before integration test.
We use test module in the kselftest frameworks to implement it. We create amd-pstate-ut module and tie it into kselftest.
For example: The test case aput_acpi_cpc is used to check whether the _CPC object is exist in SBIOS.
The amd-pstate initialization will fail if the _CPC in ACPI SBIOS is not existed at the detected processor, so it is a necessary condition.
At present, it only implements the basic framework and some simple test cases.
TODO : 1) we will add more test cases to improve the depth and coverage of the test. E.X. use the script to trigger the tbench, gitsource, kernbench, netperf, speedometer, and etc. testing and monitor the cpu frequency and performance goals change, power consumption at runtime.
Please check the documentation amd-pstate.rst for details of the test steps.
See patch series in below git repo:
V1: https://lore.kernel.org/linux-pm/[email protected]/
V2: https://lore.kernel.org/lkml/[email protected]/
V3: https://lore.kernel.org/lkml/[email protected]/
V4: https://lore.kernel.org/lkml/[email protected]/
Changes from V1 -> V2:
- cpufreq: amd-pstate:
- - add a trailing of amd-pstate.h to MAINTAINER AMD PSTATE DRIVER.
- selftests: cpufreq:
- - add a wrapper shell script for the amd_pstate_testmod module.
- selftests: cpufreq:
- - remove amd_pstate_testmod kernel module to .../cpufreq/amd_pstate_testmod.
- Documentation: amd-pstate:
- - amd_pstate_testmod rst document is not provided at present.
Changes from V2 -> V3:
- cpufreq: amd-pstate:
- - adjust the order of add amd-pstate.h in MAINTAINERS.
- selftests: cpufreq:
- - remove the call of amd_pstate_testmod.sh from cpufreq Makefile to main.sh.
- selftests: cpufreq:
- - add explain the goal or intention of the AMD P-State Unit Test module.
- - modify comments.
- - use the checkpatch.pl to check my patches.
- - add conditions judgment before formal test.
- - delete some unnecessary test cases.
- - modify test cases about perf and performance etc.
Changes from V3 -> V4:
- selftests: amd-pstate:
- - remove script and test module to tools/testing/selftests/amd-pstate/
- - uniformly named amd-pstate-ut.
- - check current architectures and cpufreq driver in amd-pstate-ut.sh
- - delete codes about conditions in amd-pstate-ut.c
- Documentation: amd-pstate:
- - add introduce document about amd-pstate unit test.
Changes from V4 -> V5:
- selftests: amd-pstate:
- - add print the current scaling_driver.
- - add amd-pstate-ut.ko into TEST_GEN_FILES.
- - move "insmod/rmmod amd-pstate-ut.ko" stuff into script amd_pstate_ut.sh
- - add a check of read back from X86_FEATURE_CPPC in get_shared_mem().
- Documentation: amd-pstate:
- - delete the test step about insmod/rmmod amd-pstate-ut.ko
Changes from V5 -> V6:
- cpufreq: amd-pstate:
- - add amd-pstate-ut test codes to drivers/cpurfreq
- - add the macro CONFIG_X86_AMD_PSTATE_UT
- selftests: amd-pstate:
- - delete amd-pstate-ut test codes from tools/testing/selftests/amd-pstate/
Thanks,
Jasmine
Meng Li (4):
cpufreq: amd-pstate: Expose struct amd_cpudata
cpufreq: amd-pstate: Add test module for amd-pstate driver
selftests: amd-pstate: Add test trigger for amd-pstate driver
Documentation: amd-pstate: Add unit test introduction
Documentation/admin-guide/pm/amd-pstate.rst | 84 ++++++ MAINTAINERS | 1 + drivers/cpufreq/Kconfig.x86 | 6 + drivers/cpufreq/Makefile | 1 + drivers/cpufreq/amd-pstate-ut.c | 278 ++++++++++++++++++ drivers/cpufreq/amd-pstate.c | 60 +--- include/linux/amd-pstate.h | 77 +++++ tools/testing/selftests/Makefile | 1 + tools/testing/selftests/amd-pstate/Makefile | 8 + .../selftests/amd-pstate/amd-pstate-ut.sh | 34 +++ tools/testing/selftests/amd-pstate/config | 1 + 11 files changed, 492 insertions(+), 59 deletions(-) create mode 100644 drivers/cpufreq/amd-pstate-ut.c create mode 100644 include/linux/amd-pstate.h create mode 100644 tools/testing/selftests/amd-pstate/Makefile create mode 100755 tools/testing/selftests/amd-pstate/amd-pstate-ut.sh create mode 100644 tools/testing/selftests/amd-pstate/config
Signature · 1 line
2.25.1
PATCH v6 1/4 cpufreq: amd-pstate: Expose struct amd_cpudata
Expose struct amd_cpudata to AMD P-State unit test module.
This data struct will be used on the following AMD P-State unit test (amd-pstate-ut) module. The amd-pstate-ut module can get some AMD infomations by this data struct. For example: highest perf, nominal perf, boost supported etc.
--- MAINTAINERS | 1 + drivers/cpufreq/amd-pstate.c | 60 +--------------------------- include/linux/amd-pstate.h | 77 ++++++++++++++++++++++++++++++++++++ 3 files changed, 79 insertions(+), 59 deletions(-) create mode 100644 include/linux/amd-pstate.h
MAINTAINERS +1 -0
@@ -1021,6 +1021,7 @@ L: [email protected] S: Supported F: Documentation/admin-guide/pm/amd-pstate.rst F: drivers/cpufreq/amd-pstate* +F: include/linux/amd-pstate.h F: tools/power/x86/amd_pstate_tracer/amd_pstate_trace.py AMD PTDMA DRIVER
drivers/cpufreq/amd-pstate.c +1 -59
72 lines not on this page · raw message
include/linux/amd-pstate.h new file +77 -0
77 lines not on this page · raw message
Signature · 1 line
2.25.1
PATCH v6 2/4 cpufreq: amd-pstate: Add test module for amd-pstate driver
In reply to Meng LiAdd amd-pstate-ut module, which is conceptually out-of-tree module and provides ways for selftests/amd-pstate driver to test various kernel module-related functionality. This module will be expected by some of selftests to be present and loaded.
--- drivers/cpufreq/Kconfig.x86 | 6 + drivers/cpufreq/Makefile | 1 + drivers/cpufreq/amd-pstate-ut.c | 278 ++++++++++++++++++++++++++++++++ 3 files changed, 285 insertions(+) create mode 100644 drivers/cpufreq/amd-pstate-ut.c
drivers/cpufreq/Kconfig.x86 +6 -0
@@ -51,6 +51,12 @@ config X86_AMD_PSTATE If in doubt, say N. +config X86_AMD_PSTATE_UT + tristate "selftest for AMD Processor P-State driver" + depends on X86_AMD_PSTATE + help + This kernel module is used for testing. It's safe to say M here. + config X86_ACPI_CPUFREQ tristate "ACPI Processor P-States driver" depends on ACPI_PROCESSOR
drivers/cpufreq/Makefile +1 -0
@@ -30,6 +30,7 @@ amd_pstate-y := amd-pstate.o amd-pstate-trace.o obj-$(CONFIG_X86_ACPI_CPUFREQ) += acpi-cpufreq.o obj-$(CONFIG_X86_AMD_PSTATE) += amd_pstate.o +obj-$(CONFIG_X86_AMD_PSTATE_UT) += amd-pstate-ut.o obj-$(CONFIG_X86_POWERNOW_K8) += powernow-k8.o obj-$(CONFIG_X86_PCC_CPUFREQ) += pcc-cpufreq.o obj-$(CONFIG_X86_POWERNOW_K6) += powernow-k6.o
drivers/cpufreq/amd-pstate-ut.c new file +278 -0
278 lines not on this page · raw message
Signature · 1 line
2.25.1
Shuah Khan
maintainerRe: [PATCH V6 2/4] cpufreq: amd-pstate: Add test module for amd-pstate driver
Quoted 19 lines · Meng Li
Add amd-pstate-ut module, which is conceptually out-of-tree module and provides ways for selftests/amd-pstate driver to test various kernel module-related functionality. This module will be expected by some of selftests to be present and loaded.
Signed-off-by Meng Li <[email protected]>Acked-by Huang Rui <[email protected]>--- drivers/cpufreq/Kconfig.x86 | 6 + drivers/cpufreq/Makefile | 1 + drivers/cpufreq/amd-pstate-ut.c | 278 ++++++++++++++++++++++++++++++++ 3 files changed, 285 insertions(+)create mode 100644
drivers/cpufreq/amd-pstate-ut.cdrivers/cpufreq/Kconfig.x86 +0
-0
drivers/cpufreq/Kconfig.x86 config X86_AMD_PSTATE · line 56
Quoted 6 lines
drivers/cpufreq/Kconfig.x86 +3
-0@@ -51,6 +51,12 @@ config X86_AMD_PSTATE If in doubt, say N. +config X86_AMD_PSTATE_UT + tristate "selftest for AMD Processor P-State driver" + depends on X86_AMD_PSTATE
Please specify default value
Quoted 34 lines
drivers/cpufreq/Kconfig.x86 +3
-0+ help + This kernel module is used for testing. It's safe to say M here. + config X86_ACPI_CPUFREQ tristate "ACPI Processor P-States driver" depends on ACPI_PROCESSORdrivers/cpufreq/Makefile +1
-0@@ -30,6 +30,7 @@ amd_pstate-y := amd-pstate.o amd-pstate-trace.o obj-$(CONFIG_X86_ACPI_CPUFREQ) += acpi-cpufreq.o obj-$(CONFIG_X86_AMD_PSTATE) += amd_pstate.o +obj-$(CONFIG_X86_AMD_PSTATE_UT) += amd-pstate-ut.o obj-$(CONFIG_X86_POWERNOW_K8) += powernow-k8.o obj-$(CONFIG_X86_PCC_CPUFREQ) += pcc-cpufreq.o obj-$(CONFIG_X86_POWERNOW_K6) += powernow-k6.odrivers/cpufreq/amd-pstate-ut.c new file +10
-0@@ -0,0 +1,278 @@ +// SPDX-License-Identifier: GPL-1.0-or-later +/* +* AMD Processor P-state Frequency Driver Unit Test +* +* Copyright (C) 2022 Advanced Micro Devices, Inc. All Rights Reserved. +* +* Author: Meng Li <[email protected]> +* +* The AMD P-State Unit Test is a test module for testing the amd-pstate +* driver. 1) It can help all users to verify their processor support
drivers/cpufreq/amd-pstate-ut.c line 20
Quoted 10 lines
drivers/cpufreq/amd-pstate-ut.c new file +10
-0+* (SBIOS/Firmware or Hardware). 2) Kernel can have a basic function +* test to avoid the kernel regression during the update. 3) We can +* introduce more functional or performance tests to align the result +* together, it will benefit power and performance scale optimization. +* +* At present, it only implements the basic framework and some simple +* test cases. Next, 1) we will add a rst document. 2) we will add more +* test cases to improve the depth and coverage of the test. +*/ +
Rephrase this to say:
This driver implements basic framework with plnas to enhance it with additional test cases to improve the depth and coverage of the test.
Also you have the .rst in this patch series? Does the documentation comment still valid?
drivers/cpufreq/amd-pstate-ut.c line 23
Quoted 3 lines
drivers/cpufreq/amd-pstate-ut.c new file +3
-0+#define pr_fmt (fmt) KBUILD_MODNAME ": " fmt + +#include "../tools/testing/selftests/kselftest_module.h"
Remove this header include
Quoted 11 lines
drivers/cpufreq/amd-pstate-ut.c new file +11
-0+ +#include <linux/kernel.h> +#include <linux/module.h> +#include <linux/moduleparam.h> +#include <linux/fs.h> +#include <linux/amd-pstate.h> + +#include <acpi/cppc_acpi.h> + +/* +* Abbreviations:
drivers/cpufreq/amd-pstate-ut.c line 44
Quoted 10 lines
drivers/cpufreq/amd-pstate-ut.c new file +10
-0+* aput: used as a shortform for AMD P-State unit test. +* It helps to keep variable names smaller, simpler +*/ + +KSTM_MODULE_GLOBALS (); + +/* +* Kernel module for testing the AMD P-State unit test +*/ +enum aput_result {
Is "aput" short for amd_pstate_unit_test? Change "aput" to amd_pstate_ut instead. aput is rather confusing.
Same comment file wide on all function names and structure names.
Quoted 12 lines
drivers/cpufreq/amd-pstate-ut.c new file +12
-0+APUT_RESULT_PASS , +APUT_RESULT_FAIL , + MAX_APUT_RESULT, +}; + +struct aput_struct { +const char *name; +void (*func)(u32 index); +enum aput_result result; +}; + +static void aput_acpi_cpc (u32 index);
drivers/cpufreq/amd-pstate-ut.c line 66
Quoted 10 lines
drivers/cpufreq/amd-pstate-ut.c new file +10
-0+static void aput_check_enabled (u32 index); +static void aput_check_perf (u32 index); +static void aput_check_freq (u32 index); + +static struct aput_struct aput_cases[] = { + {"acpi_cpc_valid" , aput_acpi_cpc }, + {"check_enabled" , aput_check_enabled }, + {"check_perf" , aput_check_perf }, + {"check_freq" , aput_check_freq } +};
Add prefixes to these strings - amd_pstate_ut for example - it will be easier for users to parse the test output.
drivers/cpufreq/amd-pstate-ut.c line 77
Quoted 11 lines
drivers/cpufreq/amd-pstate-ut.c new file +11
-0+ +static bool get_shared_mem (void ) +{ +bool result = false; +char buf[5 ] = {0 }; +struct file *filp =NULL ; +loff_t pos =0 ; +ssize_t ret; + +if (!boot_cpu_has (X86_FEATURE_CPPC )) { + filp =filp_open ("/sys/module/amd_pstate/parameters/shared_mem" ,FMODE_PREAD ,0 );
Please add a define for this file and print this in error messages below.
drivers/cpufreq/amd-pstate-ut.c line 79
Quoted 2 lines
drivers/cpufreq/amd-pstate-ut.c new file +2
-0+if (IS_ERR (filp)) +pr_err ("%s Open param file fail!\n" , __func__);
Add filename to the error message.
drivers/cpufreq/amd-pstate-ut.c line 84
Quoted 5 lines
drivers/cpufreq/amd-pstate-ut.c new file +5
-0+else { + ret =kernel_read (filp, &buf,sizeof (buf), &pos); +if (ret <0 ) +pr_err ("%s ret=%ld unable to read from param file!\n" , + __func__, ret);
Same here.
drivers/cpufreq/amd-pstate-ut.c line 95
Quoted 11 lines
drivers/cpufreq/amd-pstate-ut.c new file +11
-0+filp_close (filp,NULL ); + } + +if ('Y' == *buf) + result = true; + } + +return result; +} + +static void aput_acpi_cpc (u32 index)
What does cpc stand for? Make the name descriptive to it is easeir to understand. Add a comment to say what this does.
Quoted 6 lines
drivers/cpufreq/amd-pstate-ut.c new file +6
-0+{ +if (acpi_cpc_valid ()) + aput_cases[index].result =APUT_RESULT_PASS ; +else + aput_cases[index].result =APUT_RESULT_FAIL ; +}
drivers/cpufreq/amd-pstate-ut.c line 111
Quoted 10 lines
drivers/cpufreq/amd-pstate-ut.c new file +10
-0+ +static void aput_pstate_enable (u32 index) +{ +int ret =0 ; +u64 cppc_enable =0 ; + + ret =rdmsrl_safe (MSR_AMD_CPPC_ENABLE , &cppc_enable); +if (ret) { + aput_cases[index].result =APUT_RESULT_FAIL ; +pr_err ("%s rdmsrl_safe MSR_AMD_CPPC_ENABLE ret=%d is error!\n" , __func__, ret);
Make this message to say what failed - did pstate enable fail? Just say that. "is" isn't necessary in this setence
drivers/cpufreq/amd-pstate-ut.c line 121
Quoted 10 lines
drivers/cpufreq/amd-pstate-ut.c new file +10
-0+return ; + } +if (cppc_enable) + aput_cases[index].result =APUT_RESULT_PASS ; +else + aput_cases[index].result =APUT_RESULT_FAIL ; +} + +/* +*Check if enabled amd pstate
Change this to "check if amd pstate is enabled"
drivers/cpufreq/amd-pstate-ut.c line 132
Quoted 11 lines
drivers/cpufreq/amd-pstate-ut.c new file +11
-0+*/ +static void aput_check_enabled (u32 index) +{ +if (get_shared_mem ()) + aput_cases[index].result =APUT_RESULT_PASS ; +else +aput_pstate_enable (index); +} + +/* +* Check if the each performance values are reasonable.
Check if performance values are reasonable
Quoted 14 lines
drivers/cpufreq/amd-pstate-ut.c new file +14
-0+* highest_perf >= nominal_perf > lowest_nonlinear_perf > lowest_perf > 0 +*/ +static void aput_check_perf (u32 index) +{ +int cpu =0 , ret =0 ; +u32 highest_perf =0 , nominal_perf =0 , lowest_nonlinear_perf =0 , lowest_perf =0 ; +u64 cap1 =0 ; +struct cppc_perf_caps cppc_perf; +struct cpufreq_policy *policy =NULL ; +struct amd_cpudata *cpudata =NULL ; + + highest_perf =amd_get_highest_perf (); + +for_each_possible_cpu (cpu) {
drivers/cpufreq/amd-pstate-ut.c line 156
Quoted 10 lines
drivers/cpufreq/amd-pstate-ut.c new file +10
-0+ policy =cpufreq_cpu_get (cpu); +if (!policy) +break ; + cpudata = policy->driver_data; + +if (get_shared_mem ()) { + ret =cppc_get_perf_caps (cpu, &cppc_perf); +if (ret) { + aput_cases[index].result =APUT_RESULT_FAIL ; +pr_err ("%s cppc_get_perf_caps ret=%d is error!\n" , __func__, ret);
Same here - say what failed - the return value is relevant, but does't give the right information. "is" isn't necessary in this setence
drivers/cpufreq/amd-pstate-ut.c line 167
Quoted 11 lines
drivers/cpufreq/amd-pstate-ut.c new file +11
-0+return ; + } + + nominal_perf = cppc_perf.nominal_perf; + lowest_nonlinear_perf = cppc_perf.lowest_nonlinear_perf; + lowest_perf = cppc_perf.lowest_perf; + }else { + ret =rdmsrl_safe_on_cpu (cpu,MSR_AMD_CPPC_CAP1 , &cap1); +if (ret) { + aput_cases[index].result =APUT_RESULT_FAIL ; +pr_err ("%s read CPPC_CAP1 ret=%d is error!\n" , __func__, ret);
Same here - "is" isn't necessary in this setence
Quoted 8 lines
drivers/cpufreq/amd-pstate-ut.c new file +8
-0+return ; + } + + nominal_perf =AMD_CPPC_NOMINAL_PERF (cap1); + lowest_nonlinear_perf =AMD_CPPC_LOWNONLIN_PERF (cap1); + lowest_perf =AMD_CPPC_LOWEST_PERF (cap1); + } +
drivers/cpufreq/amd-pstate-ut.c line 185
Quoted 10 lines
drivers/cpufreq/amd-pstate-ut.c new file +10
-0+if ((highest_perf !=READ_ONCE (cpudata->highest_perf)) || + (nominal_perf !=READ_ONCE (cpudata->nominal_perf)) || + (lowest_nonlinear_perf !=READ_ONCE (cpudata->lowest_nonlinear_perf)) || + (lowest_perf !=READ_ONCE (cpudata->lowest_perf))) { + aput_cases[index].result =APUT_RESULT_FAIL ; +pr_err ("%s cpu%d highest=%d %d nominal=%d %d lowest_nonlinear=%d %d lowest=%d %d are not equal!\n" , + __func__, cpu, highest_perf, cpudata->highest_perf, + nominal_perf, cpudata->nominal_perf, + lowest_nonlinear_perf, cpudata->lowest_nonlinear_perf, + lowest_perf, cpudata->lowest_perf);
Okay - are we testing for these to be equal. Say that in the message that they should be equal.
drivers/cpufreq/amd-pstate-ut.c line 196
Quoted 11 lines
drivers/cpufreq/amd-pstate-ut.c new file +11
-0+return ; + } + +if (!((highest_perf >= nominal_perf) && + (nominal_perf > lowest_nonlinear_perf) && + (lowest_nonlinear_perf > lowest_perf) && + (lowest_perf >0 ))) { + aput_cases[index].result =APUT_RESULT_FAIL ; +pr_err ("%s cpu%d highest=%d nominal=%d lowest_nonlinear=%d lowest=%d have error!\n" , + __func__, cpu, highest_perf, nominal_perf, + lowest_nonlinear_perf, lowest_perf);
What does this tell user - what does "have error" mean?
Quoted 22 lines
drivers/cpufreq/amd-pstate-ut.c new file +22
-0+return ; + } + } + + aput_cases[index].result =APUT_RESULT_PASS ; +} + +/* +* Check if the each frequency values are reasonable. +* max_freq >= nominal_freq > lowest_nonlinear_freq > min_freq > 0 +* check max freq when set support boost mode. +*/ +static void aput_check_freq (u32 index) +{ +int cpu =0 ; +struct cpufreq_policy *policy =NULL ; +struct amd_cpudata *cpudata =NULL ; + +for_each_possible_cpu (cpu) { + policy =cpufreq_cpu_get (cpu); +if (!policy) +break ;
drivers/cpufreq/amd-pstate-ut.c line 228
Quoted 10 lines
drivers/cpufreq/amd-pstate-ut.c new file +10
-0+ cpudata = policy->driver_data; + +if (!((cpudata->max_freq >= cpudata->nominal_freq) && + (cpudata->nominal_freq > cpudata->lowest_nonlinear_freq) && + (cpudata->lowest_nonlinear_freq > cpudata->min_freq) && + (cpudata->min_freq >0 ))) { + aput_cases[index].result =APUT_RESULT_FAIL ; +pr_err ("%s cpu%d max=%d nominal=%d lowest_nonlinear=%d min=%d have error!\n" , + __func__, cpu, cpudata->max_freq, cpudata->nominal_freq, + cpudata->lowest_nonlinear_freq, cpudata->min_freq);
Same comment as above about the clearity of the error message - what does "have error" mean
drivers/cpufreq/amd-pstate-ut.c line 235
Quoted 7 lines
drivers/cpufreq/amd-pstate-ut.c new file +7
-0+return ; + } + +if (cpudata->min_freq != policy->min) { + aput_cases[index].result =APUT_RESULT_FAIL ; +pr_err ("%s cpu%d cpudata_min_freq=%d policy_min=%d have error!\n" , + __func__, cpu, cpudata->min_freq, policy->min);
Same as above.
Quoted 7 lines
drivers/cpufreq/amd-pstate-ut.c new file +7
-0+return ; + } + +if (cpudata->boost_supported) { +if ((policy->max == cpudata->max_freq) || + (policy->max == cpudata->nominal_freq)) + aput_cases[index].result =APUT_RESULT_PASS ;
drivers/cpufreq/amd-pstate-ut.c line 252
Quoted 10 lines
drivers/cpufreq/amd-pstate-ut.c new file +10
-0+else { + aput_cases[index].result =APUT_RESULT_FAIL ; +pr_err ("%s cpu%d policy_max=%d cpu_max=%d cpu_nominal=%d have error!\n" , + __func__, cpu, policy->max, cpudata->max_freq, + cpudata->nominal_freq); +return ; + } + }else { + aput_cases[index].result =APUT_RESULT_FAIL ; +pr_err ("%s cpu%d not support boost!\n" , __func__, cpu);
cpu doesn't support boost?
drivers/cpufreq/amd-pstate-ut.c line 263
Quoted 11 lines
drivers/cpufreq/amd-pstate-ut.c new file +11
-0+return ; + } + } +} + +static void aput_do_test_case (void ) +{ +u32 i =0 , arr_size =ARRAY_SIZE (aput_cases); + +for (i =0 ; i < arr_size; i++) { +pr_info ("****** Begin %-5d\t %-20s\t ******\n" , i+1 , aput_cases[i].name);
This is where adding prefix helps improving the test report.
drivers/cpufreq/amd-pstate-ut.c line 266
Quoted 3 lines
drivers/cpufreq/amd-pstate-ut.c new file +3
-0+ aput_cases[i].func (i); +KSTM_CHECK_ZERO (aput_cases[i].result); +pr_info ("****** End %-5d\t %-20s\t ******\n" , i+1 , aput_cases[i].name);
This is where adding prefix helps improving the test report.
drivers/cpufreq/amd-pstate-ut.c line 270
Quoted 4 lines
drivers/cpufreq/amd-pstate-ut.c new file +4
-0+ } +} + +static void __init selftest (void )
Change this to amd_pstate_ut_selftest
drivers/cpufreq/amd-pstate-ut.c line 278
Quoted 9 lines
drivers/cpufreq/amd-pstate-ut.c new file +8
-0+{ +aput_do_test_case (); +} + +KSTM_MODULE_LOADERS (amd_pstate_ut); +MODULE_AUTHOR ("Meng Li <[email protected]>" ); +MODULE_DESCRIPTION ("Unit test for AMD P-state driver" ); +MODULE_LICENSE ("GPL" );
thanks,
-- Shuah
kernel test robot
build botRe: [PATCH V6 2/4] cpufreq: amd-pstate: Add test module for amd-pstate driver
In reply to Meng LiThank you for the patch! Perhaps something to improve:
Hi Meng,
Thank you for the patch! Perhaps something to improve:
[auto build test WARNING on shuah-kselftest/next]
[also build test WARNING on rafael-pm/linux-next linux/master linus/master v5.18-rc7] [If your patch is applied to the wrong git tree, kindly drop us a note. And when submitting patch, we suggest to use '--base' as documented in
https://git-scm.com/docs/git-format-patch]
url: https://github.com/intel-lab-lkp/linux/commits/Meng-Li/Add-unit-test-module-for-AMD-P-State-driver/20220519-215444 base: https://git.kernel.org/pub/scm/linux/kernel/git/shuah/linux-kselftest.git next config: i386-allyesconfig (https://download.01.org/0day-ci/archive/20220520/[email protected]/config) compiler: gcc-11 (Debian 11.3.0-1) 11.3.0 reproduce (this is a W=1 build): # https://github.com/intel-lab-lkp/linux/commit/5a00a68d142a32f76cf2e770d75463802273e7ed git remote add linux-review https://github.com/intel-lab-lkp/linux git fetch --no-tags linux-review Meng-Li/Add-unit-test-module-for-AMD-P-State-driver/20220519-215444 git checkout 5a00a68d142a32f76cf2e770d75463802273e7ed # save the config file mkdir build_dir && cp config build_dir/.config make W=1 O=build_dir ARCH=i386 SHELL=/bin/bash drivers/cpufreq/
If you fix the issue, kindly add following tag as appropriate
All warnings (new ones prefixed by >>):
In file included from include/linux/kernel.h:29,
from arch/x86/include/asm/percpu.h:27,
from arch/x86/include/asm/current.h:6,
from arch/x86/include/asm/processor.h:17,
from arch/x86/include/asm/timex.h:5,
from include/linux/timex.h:65,
from include/linux/time32.h:13,
from include/linux/time.h:60,
from include/linux/stat.h:19,
from include/linux/module.h:13,
from include/../tools/testing/selftests/kselftest_module.h:5,
from drivers/cpufreq/amd-pstate-ut.c:23:
drivers/cpufreq/amd-pstate-ut.c: In function 'get_shared_mem':
>> include/linux/kern_levels.h:5:25: warning: format '%ld' expects argument of type 'long int', but argument 3 has type 'ssize_t' {aka 'int'} [-Wformat=]
5 | #define KERN_SOH "\001" /* ASCII Start Of Header */
| ^~~~~~
include/linux/printk.h:418:25: note: in definition of macro 'printk_index_wrap'
418 | _p_func(_fmt, ##__VA_ARGS__); \
| ^~~~
include/linux/printk.h:489:9: note: in expansion of macro 'printk'
489 | printk(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
| ^~~~~~
include/linux/kern_levels.h:11:25: note: in expansion of macro 'KERN_SOH'
11 | #define KERN_ERR KERN_SOH "3" /* error conditions */
| ^~~~~~~~
include/linux/printk.h:489:16: note: in expansion of macro 'KERN_ERR'
489 | printk(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
| ^~~~~~~~
drivers/cpufreq/amd-pstate-ut.c:83:33: note: in expansion of macro 'pr_err'
83 | pr_err("%s ret=%ld unable to read from param file!\n",
| ^~~~~~vim +5 include/linux/kern_levels.h
314ba3520e513a Joe Perches 2012-07-30 404d2c8c83d0e3a Joe Perches 2012-07-30 @5 #define KERN_SOH "\001" /* ASCII Start Of Header */04d2c8c83d0e3a Joe Perches 2012-07-30 6 #define KERN_SOH_ASCII '\001'04d2c8c83d0e3a Joe Perches 2012-07-30 7
Signature · 2 lines
0-DAY CI Kernel Test Service https://01.org/lkp
Huang Rui
maintainerRe: [PATCH V6 2/4] cpufreq: amd-pstate: Add test module for amd-pstate driver
In reply to Meng LiQuoted 19 lines · Li (Jassmine)
Add amd-pstate-ut module, which is conceptually out-of-tree module and provides ways for selftests/amd-pstate driver to test various kernel module-related functionality. This module will be expected by some of selftests to be present and loaded.
Signed-off-by Meng Li <[email protected]>Acked-by Huang Rui <[email protected]>--- drivers/cpufreq/Kconfig.x86 | 6 + drivers/cpufreq/Makefile | 1 + drivers/cpufreq/amd-pstate-ut.c | 278 ++++++++++++++++++++++++++++++++ 3 files changed, 285 insertions(+) create mode 100644 drivers/cpufreq/amd-pstate-ut.cdrivers/cpufreq/Kconfig.x86 +0
-0
drivers/cpufreq/Kconfig.x86 config X86_AMD_PSTATE · line 56
Quoted 6 lines
drivers/cpufreq/Kconfig.x86 +3
-0@@ -51,6 +51,12 @@ config X86_AMD_PSTATE If in doubt, say N. +config X86_AMD_PSTATE_UT + tristate "selftest for AMD Processor P-State driver" + depends on X86_AMD_PSTATE
I think we won't set X86_AMD_PSTATE as the depends of this module, because even if the acpi-cpufreq is loaded, this module can test it out and tell user the result.
ACPI and ACPI_PROCESSOR should the dependencies.
Thanks,
Ray
Quoted 305 lines
drivers/cpufreq/Kconfig.x86 +3
-0+ help + This kernel module is used for testing. It's safe to say M here. + config X86_ACPI_CPUFREQ tristate "ACPI Processor P-States driver" depends on ACPI_PROCESSORdrivers/cpufreq/Makefile +1
-0@@ -30,6 +30,7 @@ amd_pstate-y := amd-pstate.o amd-pstate-trace.o obj-$(CONFIG_X86_ACPI_CPUFREQ) += acpi-cpufreq.o obj-$(CONFIG_X86_AMD_PSTATE) += amd_pstate.o +obj-$(CONFIG_X86_AMD_PSTATE_UT) += amd-pstate-ut.o obj-$(CONFIG_X86_POWERNOW_K8) += powernow-k8.o obj-$(CONFIG_X86_PCC_CPUFREQ) += pcc-cpufreq.o obj-$(CONFIG_X86_POWERNOW_K6) += powernow-k6.odrivers/cpufreq/amd-pstate-ut.c new file +278
-0@@ -0,0 +1,278 @@ +// SPDX-License-Identifier: GPL-1.0-or-later +/* +* AMD Processor P-state Frequency Driver Unit Test +* +* Copyright (C) 2022 Advanced Micro Devices, Inc. All Rights Reserved. +* +* Author: Meng Li <[email protected]> +* +* The AMD P-State Unit Test is a test module for testing the amd-pstate +* driver. 1) It can help all users to verify their processor support +* (SBIOS/Firmware or Hardware). 2) Kernel can have a basic function +* test to avoid the kernel regression during the update. 3) We can +* introduce more functional or performance tests to align the result +* together, it will benefit power and performance scale optimization. +* +* At present, it only implements the basic framework and some simple +* test cases. Next, 1) we will add a rst document. 2) we will add more +* test cases to improve the depth and coverage of the test. +*/ + +#define pr_fmt (fmt) KBUILD_MODNAME ": " fmt + +#include "../tools/testing/selftests/kselftest_module.h" + +#include <linux/kernel.h> +#include <linux/module.h> +#include <linux/moduleparam.h> +#include <linux/fs.h> +#include <linux/amd-pstate.h> + +#include <acpi/cppc_acpi.h> + +/* +* Abbreviations: +* aput: used as a shortform for AMD P-State unit test. +* It helps to keep variable names smaller, simpler +*/ + +KSTM_MODULE_GLOBALS (); + +/* +* Kernel module for testing the AMD P-State unit test +*/ +enum aput_result { +APUT_RESULT_PASS , +APUT_RESULT_FAIL , +MAX_APUT_RESULT , +}; + +struct aput_struct { +const char *name; +void (*func)(u32 index); +enum aput_result result; +}; + +static void aput_acpi_cpc (u32 index); +static void aput_check_enabled (u32 index); +static void aput_check_perf (u32 index); +static void aput_check_freq (u32 index); + +static struct aput_struct aput_cases[] = { + {"acpi_cpc_valid" , aput_acpi_cpc }, + {"check_enabled" , aput_check_enabled }, + {"check_perf" , aput_check_perf }, + {"check_freq" , aput_check_freq } +}; + +static bool get_shared_mem (void ) +{ +bool result = false; +char buf[5 ] = {0 }; +struct file *filp =NULL ; +loff_t pos =0 ; +ssize_t ret; + +if (!boot_cpu_has (X86_FEATURE_CPPC )) { + filp =filp_open ("/sys/module/amd_pstate/parameters/shared_mem" ,FMODE_PREAD ,0 ); +if (IS_ERR (filp)) +pr_err ("%s Open param file fail!\n" , __func__); +else { + ret =kernel_read (filp, &buf,sizeof (buf), &pos); +if (ret <0 ) +pr_err ("%s ret=%ld unable to read from param file!\n" , + __func__, ret); +filp_close (filp,NULL ); + } + +if ('Y' == *buf) + result = true; + } + +return result; +} + +static void aput_acpi_cpc (u32 index) +{ +if (acpi_cpc_valid ()) + aput_cases[index].result =APUT_RESULT_PASS ; +else + aput_cases[index].result =APUT_RESULT_FAIL ; +} + +static void aput_pstate_enable (u32 index) +{ +int ret =0 ; +u64 cppc_enable =0 ; + + ret =rdmsrl_safe (MSR_AMD_CPPC_ENABLE , &cppc_enable); +if (ret) { + aput_cases[index].result =APUT_RESULT_FAIL ; +pr_err ("%s rdmsrl_safe MSR_AMD_CPPC_ENABLE ret=%d is error!\n" , __func__, ret); +return ; + } +if (cppc_enable) + aput_cases[index].result =APUT_RESULT_PASS ; +else + aput_cases[index].result =APUT_RESULT_FAIL ; +} + +/* +*Check if enabled amd pstate +*/ +static void aput_check_enabled (u32 index) +{ +if (get_shared_mem ()) + aput_cases[index].result =APUT_RESULT_PASS ; +else +aput_pstate_enable (index); +} + +/* +* Check if the each performance values are reasonable. +* highest_perf >= nominal_perf > lowest_nonlinear_perf > lowest_perf > 0 +*/ +static void aput_check_perf (u32 index) +{ +int cpu =0 , ret =0 ; +u32 highest_perf =0 , nominal_perf =0 , lowest_nonlinear_perf =0 , lowest_perf =0 ; +u64 cap1 =0 ; +struct cppc_perf_caps cppc_perf; +struct cpufreq_policy *policy =NULL ; +struct amd_cpudata *cpudata =NULL ; + + highest_perf =amd_get_highest_perf (); + +for_each_possible_cpu (cpu) { + policy =cpufreq_cpu_get (cpu); +if (!policy) +break ; + cpudata = policy->driver_data; + +if (get_shared_mem ()) { + ret =cppc_get_perf_caps (cpu, &cppc_perf); +if (ret) { + aput_cases[index].result =APUT_RESULT_FAIL ; +pr_err ("%s cppc_get_perf_caps ret=%d is error!\n" , __func__, ret); +return ; + } + + nominal_perf = cppc_perf.nominal_perf; + lowest_nonlinear_perf = cppc_perf.lowest_nonlinear_perf; + lowest_perf = cppc_perf.lowest_perf; + }else { + ret =rdmsrl_safe_on_cpu (cpu,MSR_AMD_CPPC_CAP1 , &cap1); +if (ret) { + aput_cases[index].result =APUT_RESULT_FAIL ; +pr_err ("%s read CPPC_CAP1 ret=%d is error!\n" , __func__, ret); +return ; + } + + nominal_perf =AMD_CPPC_NOMINAL_PERF (cap1); + lowest_nonlinear_perf =AMD_CPPC_LOWNONLIN_PERF (cap1); + lowest_perf =AMD_CPPC_LOWEST_PERF (cap1); + } + +if ((highest_perf !=READ_ONCE (cpudata->highest_perf)) || + (nominal_perf !=READ_ONCE (cpudata->nominal_perf)) || + (lowest_nonlinear_perf !=READ_ONCE (cpudata->lowest_nonlinear_perf)) || + (lowest_perf !=READ_ONCE (cpudata->lowest_perf))) { + aput_cases[index].result =APUT_RESULT_FAIL ; +pr_err ("%s cpu%d highest=%d %d nominal=%d %d lowest_nonlinear=%d %d lowest=%d %d are not equal!\n" , + __func__, cpu, highest_perf, cpudata->highest_perf, + nominal_perf, cpudata->nominal_perf, + lowest_nonlinear_perf, cpudata->lowest_nonlinear_perf, + lowest_perf, cpudata->lowest_perf); +return ; + } + +if (!((highest_perf >= nominal_perf) && + (nominal_perf > lowest_nonlinear_perf) && + (lowest_nonlinear_perf > lowest_perf) && + (lowest_perf >0 ))) { + aput_cases[index].result =APUT_RESULT_FAIL ; +pr_err ("%s cpu%d highest=%d nominal=%d lowest_nonlinear=%d lowest=%d have error!\n" , + __func__, cpu, highest_perf, nominal_perf, + lowest_nonlinear_perf, lowest_perf); +return ; + } + } + + aput_cases[index].result =APUT_RESULT_PASS ; +} + +/* +* Check if the each frequency values are reasonable. +* max_freq >= nominal_freq > lowest_nonlinear_freq > min_freq > 0 +* check max freq when set support boost mode. +*/ +static void aput_check_freq (u32 index) +{ +int cpu =0 ; +struct cpufreq_policy *policy =NULL ; +struct amd_cpudata *cpudata =NULL ; + +for_each_possible_cpu (cpu) { + policy =cpufreq_cpu_get (cpu); +if (!policy) +break ; + cpudata = policy->driver_data; + +if (!((cpudata->max_freq >= cpudata->nominal_freq) && + (cpudata->nominal_freq > cpudata->lowest_nonlinear_freq) && + (cpudata->lowest_nonlinear_freq > cpudata->min_freq) && + (cpudata->min_freq >0 ))) { + aput_cases[index].result =APUT_RESULT_FAIL ; +pr_err ("%s cpu%d max=%d nominal=%d lowest_nonlinear=%d min=%d have error!\n" , + __func__, cpu, cpudata->max_freq, cpudata->nominal_freq, + cpudata->lowest_nonlinear_freq, cpudata->min_freq); +return ; + } + +if (cpudata->min_freq != policy->min) { + aput_cases[index].result =APUT_RESULT_FAIL ; +pr_err ("%s cpu%d cpudata_min_freq=%d policy_min=%d have error!\n" , + __func__, cpu, cpudata->min_freq, policy->min); +return ; + } + +if (cpudata->boost_supported) { +if ((policy->max == cpudata->max_freq) || + (policy->max == cpudata->nominal_freq)) + aput_cases[index].result =APUT_RESULT_PASS ; +else { + aput_cases[index].result =APUT_RESULT_FAIL ; +pr_err ("%s cpu%d policy_max=%d cpu_max=%d cpu_nominal=%d have error!\n" , + __func__, cpu, policy->max, cpudata->max_freq, + cpudata->nominal_freq); +return ; + } + }else { + aput_cases[index].result =APUT_RESULT_FAIL ; +pr_err ("%s cpu%d not support boost!\n" , __func__, cpu); +return ; + } + } +} + +static void aput_do_test_case (void ) +{ +u32 i =0 , arr_size =ARRAY_SIZE (aput_cases); + +for (i =0 ; i < arr_size; i++) { +pr_info ("****** Begin %-5d\t %-20s\t ******\n" , i+1 , aput_cases[i].name); + aput_cases[i].func (i); +KSTM_CHECK_ZERO (aput_cases[i].result); +pr_info ("****** End %-5d\t %-20s\t ******\n" , i+1 , aput_cases[i].name); + } +} + +static void __init selftest (void ) +{ +aput_do_test_case (); +} + +KSTM_MODULE_LOADERS (amd_pstate_ut); +MODULE_AUTHOR ("Meng Li <[email protected]>" ); +MODULE_DESCRIPTION ("Unit test for AMD P-state driver" ); +MODULE_LICENSE ("GPL" );Signature · 1 line
2.25.1
PATCH v6 3/4 selftests: amd-pstate: Add test trigger for amd-pstate driver
In reply to Meng LiAdd amd-pstate test trigger in kselftest, it will load/unload amd-pstate-ut module to test some cases etc.
--- tools/testing/selftests/Makefile | 1 + tools/testing/selftests/amd-pstate/Makefile | 8 +++++ .../selftests/amd-pstate/amd-pstate-ut.sh | 34 +++++++++++++++++++ tools/testing/selftests/amd-pstate/config | 1 + 4 files changed, 44 insertions(+) create mode 100644 tools/testing/selftests/amd-pstate/Makefile create mode 100755 tools/testing/selftests/amd-pstate/amd-pstate-ut.sh create mode 100644 tools/testing/selftests/amd-pstate/config
tools/testing/selftests/Makefile +1 -0
@@ -1,5 +1,6 @@ # SPDX-License-Identifier: GPL-2.0 TARGETS += alsa +TARGETS += amd-pstate TARGETS += arm64 TARGETS += bpf TARGETS += breakpoints
tools/testing/selftests/amd-pstate/Makefile new file +8 -0
@@ -0,0 +1,8 @@ +# SPDX-License-Identifier: GPL-2.0-only +# Makefile for amd-pstate/ function selftests + +TEST_PROGS := amd-pstate-ut.sh + +include ../lib.mk + +$(TEST_GEN_FILES): $(HEADERS)
tools/testing/selftests/amd-pstate/amd-pstate-ut.sh new file +34 -0
@@ -0,0 +1,34 @@ +#!/bin/sh +# SPDX-License-Identifier: GPL-2.0 + +# amd-pstate-ut is a test module for testing the amd-pstate driver. +# (1) It can help all users to verify their processor support +# (SBIOS/Firmware or Hardware). +# (2) Kernel can have a basic function test to avoid the kernel +# regression during the update. +# (3) We can introduce more functional or performance tests to align +# the result together, it will benefit power and performance scale optimization. + +# Kselftest framework requirement - SKIP code is 4. +ksft_skip=4 + +if ! uname -m | sed -e s/i.86/x86/ -e s/x86_64/x86/ | grep -q x86; then + echo "$0 # Skipped: Test can only run on x86 architectures." + exit $ksft_skip +fi + +msg="Skip all tests:" +if [ ! -w /dev ]; then + echo $msg please run this as root >&2 + exit $ksft_skip +fi + +scaling_driver=$(cat /sys/devices/system/cpu/cpufreq/policy0/scaling_driver) + +if [ "$scaling_driver" != "amd-pstate" ]; then + echo "$0 # Skipped: Test can only run on amd-pstate driver." + echo "$0 # Current cpufreq scaling drvier is $scaling_driver." + exit $ksft_skip +fi + +$(dirname $0)/../kselftest/module.sh "amd-pstate-ut" amd-pstate-ut
tools/testing/selftests/amd-pstate/config new file +1 -0
@@ -0,0 +1 @@ +CONFIG_X86_AMD_PSTATE_UT=m
Signature · 1 line
2.25.1
Shuah Khan
maintainerRe: [PATCH V6 3/4] selftests: amd-pstate: Add test trigger for amd-pstate driver
Quoted 32 lines · Meng Li
Add amd-pstate test trigger in kselftest, it will load/unload amd-pstate-ut module to test some cases etc.
Signed-off-by Meng Li <[email protected]>Acked-by Huang Rui <[email protected]>--- tools/testing/selftests/Makefile | 1 + tools/testing/selftests/amd-pstate/Makefile | 8 +++++ .../selftests/amd-pstate/amd-pstate-ut.sh | 34 +++++++++++++++++++ tools/testing/selftests/amd-pstate/config | 1 + 4 files changed, 44 insertions(+)create mode 100644
tools/testing/selftests/amd-pstate/Makefilecreate mode 100755tools/testing/selftests/amd-pstate/amd-pstate-ut.shcreate mode 100644tools/testing/selftests/amd-pstate/configtools/testing/selftests/Makefile +1
-0@@ -1,5 +1,6 @@ # SPDX-License-Identifier: GPL-2.0 TARGETS += alsa +TARGETS += amd-pstate TARGETS += arm64 TARGETS += bpf TARGETS += breakpointstools/testing/selftests/amd-pstate/Makefile new file +0
-0
tools/testing/selftests/amd-pstate/Makefile line 8
Quoted 8 lines
tools/testing/selftests/amd-pstate/Makefile new file +8
-0@@ -0,0 +1,8 @@ +# SPDX-License-Identifier: GPL-2.0-only +# Makefile for amd-pstate/ function selftests + +TEST_PROGS := amd-pstate-ut.sh + +include ../lib.mk + +$(TEST_GEN_FILES): $(HEADERS)
Do you still need this?
Quoted 11 lines
tools/testing/selftests/amd-pstate/amd-pstate-ut.sh new file +5
-0@@ -0,0 +1,34 @@ +#!/bin/sh +# SPDX-License-Identifier: GPL-2.0 + +# amd-pstate-ut is a test module for testing the amd-pstate driver. +# (1) It can help all users to verify their processor support
tools/testing/selftests/amd-pstate/amd-pstate-ut.sh line 15
Quoted 10 lines
tools/testing/selftests/amd-pstate/amd-pstate-ut.sh new file +10
-0+# (SBIOS/Firmware or Hardware). +# (2) Kernel can have a basic function test to avoid the kernel +# regression during the update. +# (3) We can introduce more functional or performance tests to align +# the result together, it will benefit power and performance scale optimization. + +# Kselftest framework requirement - SKIP code is 4. +ksft_skip=4 + +if ! uname -m | sed -e s/i.86/x86/ -e s/x86_64/x86/ | grep -q x86; then
This can be simpler - see prctl/Makefile or other tests that do arch checks. Also does this test run on non-amd x86_64 systems?
tools/testing/selftests/amd-pstate/amd-pstate-ut.sh line 16
Quoted 1 line
tools/testing/selftests/amd-pstate/amd-pstate-ut.sh new file +1
-0+ echo "$0 # Skipped: Test can only run on x86 architectures."
All x86 or x86_64 AMD systems? Does this run on Intel systems?
Quoted 8 lines
tools/testing/selftests/amd-pstate/amd-pstate-ut.sh new file +8
-0+ exit $ksft_skip +fi + +msg="Skip all tests:" +if [ ! -w /dev ]; then + echo $msg please run this as root >&2 + exit $ksft_skip +fi
tools/testing/selftests/amd-pstate/amd-pstate-ut.sh line 34
Quoted 10 lines
tools/testing/selftests/amd-pstate/amd-pstate-ut.sh new file +10
-0+ +scaling_driver=$(cat /sys/devices/system/cpu/cpufreq/policy0/scaling_driver) + +if [ "$scaling_driver" != "amd-pstate" ]; then + echo "$0 # Skipped: Test can only run on amd-pstate driver." + echo "$0 # Current cpufreq scaling drvier is $scaling_driver." + exit $ksft_skip +fi + +$(dirname $0)/../kselftest/module.sh "amd-pstate-ut" amd-pstate-ut
What does this do?
Has this script been updated after moving the module to drivers/cpufreq? Also doesn't this script need to to load the amd_pstate_ut module?
Please take a look at user/test_user_copy.sh for example on modprobe checks and appropriate test exit codes
tools/testing/selftests/amd-pstate/config line 1
Quoted 8 lines
tools/testing/selftests/amd-pstate/config new file +1
-0@@ -0,0 +1 @@ +CONFIG_X86_AMD_PSTATE_UT=m
thanks,
-- Shuah
PATCH v6 4/4 Documentation: amd-pstate: Add unit test introduction
In reply to Meng LiIntroduce the AMD P-State unit test module design and implementation.
--- Documentation/admin-guide/pm/amd-pstate.rst | 84 +++++++++++++++++++++ 1 file changed, 84 insertions(+)
Documentation/admin-guide/pm/amd-pstate.rst +84 -0
@@ -182,6 +182,7 @@ to the ``struct sugov_cpu`` that the utilization update belongs to. Then, ``amd-pstate`` updates the desired performance according to the CPU scheduler assigned. +.. _processor_support: Processor Support =======================
@@ -282,6 +283,8 @@ efficiency frequency management method on AMD processors. Kernel Module Options for ``amd-pstate`` ========================================= +.. _shared_mem: + ``shared_mem`` Use a module param (shared_mem) to enable related processors manually with **amd_pstate.shared_mem=1**.
@@ -393,6 +396,84 @@ about part of the output. :: CPU_005 712 116384 39 49 166 0.7565 9645075 2214891 38431470 25.1 11.646 469 2.496 kworker/5:0-40 CPU_006 712 116408 39 49 166 0.6769 8950227 1839034 37192089 24.06 11.272 470 2.496 kworker/6:0-1264 +Unit Tests for amd-pstate +------------------------- + +``amd-pstate-ut`` is a test module for testing the ``amd-pstate`` driver. + + * It can help all users to verify their processor support (SBIOS/Firmware or Hardware). + + * Kernel can have a basic function test to avoid the kernel regression during the update. + + * We can introduce more functional or performance tests to align the result together, it will benefit power and performance scale optimization. + +1. Test case decriptions + + +---------+--------------------------------+------------------------------------------------------------------------------------+ + | Index | Functions | Description | + +=========+================================+====================================================================================+ + | 0 | aput_acpi_cpc || Check whether the _CPC object is present in SBIOS. | + | | || | + | | || The detail refer to `Processor Support <processor_support_>`_. | + +---------+--------------------------------+------------------------------------------------------------------------------------+ + | 1 | aput_check_enabled || Check whether AMD P-State is enabled. | + | | || | + | | || AMD P-States and ACPI hardware P-States always can be supported in one processor. | + | | | But AMD P-States has the higher priority and if it is enabled with | + | | | :c:macro:`MSR_AMD_CPPC_ENABLE` or ``cppc_set_enable``, it will respond to the | + | | | request from AMD P-States. | + +---------+--------------------------------+------------------------------------------------------------------------------------+ + | 2 | aput_check_perf || Check if the each performance values are reasonable. | + | | || highest_perf >= nominal_perf > lowest_nonlinear_perf > lowest_perf > 0. | + +---------+--------------------------------+------------------------------------------------------------------------------------+ + | 3 | aput_check_freq || Check if the each frequency values and max freq when set support boost mode | + | | | are reasonable. | + | | || max_freq >= nominal_freq > lowest_nonlinear_freq > min_freq > 0 | + | | || If boost is not active but supported, this maximum frequency will be larger than | + | | | the one in ``cpuinfo``. | + +---------+--------------------------------+------------------------------------------------------------------------------------+ + +#. How to execute the tests + + We use test module in the kselftest frameworks to implement it. + We create amd-pstate-ut module and tie it into kselftest.(for + details refer to Linux Kernel Selftests [4]_). + + 1. Build + + + open the :c:macro:`CONFIG_X86_AMD_PSTATE` configuration option. + + set the :c:macro:`CONFIG_X86_AMD_PSTATE_UT` configuration option to M. + + make project + + make selftest :: + + jasminemeng@jasmine-meng:~/amd-brahma$ cd linux + jasminemeng@jasmine-meng:~/amd-brahma/linux$ make -C tools/testing/selftests + + #. Installation & Steps :: + + jasmine@jasmine-meng:~/amd-brahma/linux$ make -C tools/testing/selftests install INSTALL_PATH=~/kselftest + jasmine@jasmine-meng:~$ sudo ./kselftest/run_kselftest.sh -c amd-pstate + TAP version 13 + 1..1 + # selftests: amd-pstate: amd-pstate-ut.sh + # amd-pstate-ut: ok + ok 1 selftests: amd-pstate: amd-pstate-ut.sh + + #. Results :: + + jasmine@jasmine-meng:~$ dmesg | grep "amd-pstate-ut" | tee log.txt + [76697.480217] amd-pstate-ut: loaded. + [76697.480222] amd-pstate-ut: ****** Begin 1 acpi_cpc_valid ****** + [76697.480227] amd-pstate-ut: ****** End 1 acpi_cpc_valid ****** + [76697.480228] amd-pstate-ut: ****** Begin 2 check_enabled ****** + [76697.480253] amd-pstate-ut: ****** End 2 check_enabled ****** + [76697.480255] amd-pstate-ut: ****** Begin 3 check_perf ****** + [76697.480554] amd-pstate-ut: ****** End 3 check_perf ****** + [76697.480556] amd-pstate-ut: ****** Begin 4 check_freq ****** + [76697.480558] amd-pstate-ut: ****** End 4 check_freq ****** + [76697.480559] amd-pstate-ut: all 4 tests passed + [76697.482507] amd-pstate-ut: unloaded. + Reference ===========
@@ -405,3 +486,6 @@ Reference .. [3] Processor Programming Reference (PPR) for AMD Family 19h Model 51h, Revision A1 Processors https://www.amd.com/system/files/TechDocs/56569-A1-PUB.zip + +.. [4] Linux Kernel Selftests, + https://www.kernel.org/doc/html/latest/dev-tools/kselftest.html
Signature · 1 line
2.25.1