rte_power APIs enhancement
cover rte_power APIs enhancement
From: Marcin Hajkowski <[email protected]>
Modifications to assure thread safety of rte_power APIs for power env set and unset, better user notification by returning more suitable value and internal data cleaning corrections.
Marcin Hajkowski (4):
power: fix non thread-safe power env modification
power: return error in set env when power env already set
power: reset function pointers on unset env
power: add UTs for all power env types
app/test/test_power.c | 155 +++++++++++++++++++------ doc/guides/rel_notes/release_19_05.rst | 6 + lib/librte_power/rte_power.c | 52 +++++++-- lib/librte_power/rte_power.h | 3 +- 4 files changed, 170 insertions(+), 46 deletions(-)
Signature · 13 lines
2.17.2 -------------------------------------------------------------- Intel Research and Development Ireland Limited Registered in Ireland Registered Office: Collinstown Industrial Park, Leixlip, County Kildare Registered Number: 308263 This e-mail and any attachments may contain confidential material for the sole use of the intended recipient(s). Any review or distribution by others is strictly prohibited. If you are not the intended recipient, please contact the sender and delete all copies.
PATCH 1/4 power: fix non thread-safe power env modification
From: Marcin Hajkowski <[email protected]>
Due to lack of thread safety in exisiting solution use spinlock mechanism for atomic modification of power environment related data.
--- doc/guides/rel_notes/release_19_05.rst | 2 ++ lib/librte_power/rte_power.c | 30 ++++++++++++++++++-------- lib/librte_power/rte_power.h | 2 +- 3 files changed, 24 insertions(+), 10 deletions(-)
doc/guides/rel_notes/release_19_05.rst +2 -0
@@ -120,6 +120,8 @@ API Changes Also, make sure to start the actual text at the margin. ========================================================= + * power: ``rte_power_set_env`` and ``rte_power_unset_env`` functions + have been modified to be thread safe. ABI Changes -----------
lib/librte_power/rte_power.c +21 -9
@@ -2,7 +2,7 @@* Copyright(c) 2010-2014 Intel Corporation */ -#include <rte_atomic.h> +#include <rte_spinlock.h> #include "rte_power.h" #include "power_acpi_cpufreq.h"
@@ -12,7 +12,7 @@enum power_management_env global_default_env =PM_ENV_NOT_SET ; -volatile uint32_t global_env_cfg_status =0 ; +static rte_spinlock_t global_env_cfg_lock =RTE_SPINLOCK_INITIALIZER ;/* function pointers */ rte_power_freqs_t rte_power_freqs =NULL ;
@@ -30,9 +30,15 @@ rte_power_get_capabilities_t rte_power_get_capabilities;int rte_power_set_env (enum power_management_env env) { -if (rte_atomic32_cmpset (&global_env_cfg_status,0 ,1 ) ==0 ) { +rte_spinlock_lock (&global_env_cfg_lock); + +if (global_default_env !=PM_ENV_NOT_SET ) { +rte_spinlock_unlock (&global_env_cfg_lock);return 0 ; } + +int ret =0 ; +if (env ==PM_ENV_ACPI_CPUFREQ ) { rte_power_freqs = power_acpi_cpufreq_freqs; rte_power_get_freq = power_acpi_cpufreq_get_freq;
@@ -73,18 +79,24 @@ rte_power_set_env(enum power_management_env env) }else {RTE_LOG (ERR ,POWER ,"Invalid Power Management Environment(%d) set\n" , env); -rte_power_unset_env (); -return -1 ; + ret =-1 ; } - global_default_env = env; -return 0 ; + +if (ret ==0 ) + global_default_env = env; +else + global_default_env =PM_ENV_NOT_SET ; + +rte_spinlock_unlock (&global_env_cfg_lock); +return ret; }void rte_power_unset_env (void ) { -if (rte_atomic32_cmpset (&global_env_cfg_status,1 ,0 ) !=0 ) - global_default_env =PM_ENV_NOT_SET ; +rte_spinlock_lock (&global_env_cfg_lock); + global_default_env =PM_ENV_NOT_SET ; +rte_spinlock_unlock (&global_env_cfg_lock); }enum power_management_env
lib/librte_power/rte_power.h +1 -1
@@ -26,7 +26,7 @@ enum power_management_env {PM_ENV_NOT_SET, PM_ENV_ACPI_CPUFREQ, PM_ENV_KVM_VM,/** * Set the default power management implementation. If this is not called prior * to rte_power_init(), then auto-detect of the environment will take place. -* It is not thread safe. +* It is thread safe. * * @param env * env. The environment in which to initialise Power Management for.
Signature · 13 lines
2.17.2 -------------------------------------------------------------- Intel Research and Development Ireland Limited Registered in Ireland Registered Office: Collinstown Industrial Park, Leixlip, County Kildare Registered Number: 308263 This e-mail and any attachments may contain confidential material for the sole use of the intended recipient(s). Any review or distribution by others is strictly prohibited. If you are not the intended recipient, please contact the sender and delete all copies.
PATCH 2/4 power: return error in set env when power env already set
In reply to HajkowskiFrom: Marcin Hajkowski <[email protected]>
On attempt to set_env in already initialized state notify user by returning error that operation cannot be performed.
--- doc/guides/rel_notes/release_19_05.rst | 4 ++++ lib/librte_power/rte_power.c | 3 ++- lib/librte_power/rte_power.h | 3 ++- 3 files changed, 8 insertions(+), 2 deletions(-)
doc/guides/rel_notes/release_19_05.rst +4 -0
@@ -120,9 +120,13 @@ API Changes Also, make sure to start the actual text at the margin. ========================================================= + * power: ``rte_power_set_env`` and ``rte_power_unset_env`` functions have been modified to be thread safe. + * power: Function ``rte_power_set_env`` modified to return -1 if environment + has been already set. + ABI Changes -----------
lib/librte_power/rte_power.c +2 -1
@@ -33,8 +33,9 @@ rte_power_set_env(enum power_management_env env)rte_spinlock_lock (&global_env_cfg_lock);if (global_default_env !=PM_ENV_NOT_SET ) { +RTE_LOG (ERR ,POWER ,"Power Management Environment already set.\n" );rte_spinlock_unlock (&global_env_cfg_lock); -return 0 ; +return -1 ; }int ret =0 ;
lib/librte_power/rte_power.h +2 -1
@@ -26,7 +26,8 @@ enum power_management_env {PM_ENV_NOT_SET, PM_ENV_ACPI_CPUFREQ, PM_ENV_KVM_VM,/** * Set the default power management implementation. If this is not called prior * to rte_power_init(), then auto-detect of the environment will take place. -* It is thread safe. +* It is thread safe. New env can be set only in unitialized state +* (thus rte_power_unset_env must be called if different env was already set). * * @param env * env. The environment in which to initialise Power Management for.
Signature · 13 lines
2.17.2 -------------------------------------------------------------- Intel Research and Development Ireland Limited Registered in Ireland Registered Office: Collinstown Industrial Park, Leixlip, County Kildare Registered Number: 308263 This e-mail and any attachments may contain confidential material for the sole use of the intended recipient(s). Any review or distribution by others is strictly prohibited. If you are not the intended recipient, please contact the sender and delete all copies.
PATCH 3/4 power: reset function pointers on unset env
In reply to HajkowskiFrom: Marcin Hajkowski <[email protected]>
Set all power environment related function pointers to NULL when unset is being made.
--- lib/librte_power/rte_power.c | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-)
lib/librte_power/rte_power.c +20 -1
@@ -27,6 +27,22 @@ rte_power_freq_change_t rte_power_freq_enable_turbo;rte_power_freq_change_t rte_power_freq_disable_turbo;rte_power_get_capabilities_t rte_power_get_capabilities; +static void +reset_power_function_ptrs (void ) +{ + rte_power_freqs =NULL ; + rte_power_get_freq =NULL ; + rte_power_set_freq =NULL ; + rte_power_freq_up =NULL ; + rte_power_freq_down =NULL ; + rte_power_freq_max =NULL ; + rte_power_freq_min =NULL ; + rte_power_turbo_status =NULL ; + rte_power_freq_enable_turbo =NULL ; + rte_power_freq_disable_turbo =NULL ; + rte_power_get_capabilities =NULL ; +} +int rte_power_set_env (enum power_management_env env) {
@@ -85,8 +101,10 @@ rte_power_set_env(enum power_management_env env)if (ret ==0 ) global_default_env = env; -else +else { global_default_env =PM_ENV_NOT_SET ; +reset_power_function_ptrs (); + }rte_spinlock_unlock (&global_env_cfg_lock);return ret;
@@ -97,6 +115,7 @@ rte_power_unset_env(void) {rte_spinlock_lock (&global_env_cfg_lock); global_default_env =PM_ENV_NOT_SET ; +reset_power_function_ptrs ();rte_spinlock_unlock (&global_env_cfg_lock); }
Signature · 13 lines
2.17.2 -------------------------------------------------------------- Intel Research and Development Ireland Limited Registered in Ireland Registered Office: Collinstown Industrial Park, Leixlip, County Kildare Registered Number: 308263 This e-mail and any attachments may contain confidential material for the sole use of the intended recipient(s). Any review or distribution by others is strictly prohibited. If you are not the intended recipient, please contact the sender and delete all copies.
PATCH 4/4 power: add UTs for all power env types
In reply to HajkowskiFrom: Marcin Hajkowski <[email protected]>
Test all existing power environment configuration to verify if related data is properly initialized and clean in set/unset scenarios.
--- app/test/test_power.c | 155 ++++++++++++++++++++++++++++++++---------- 1 file changed, 120 insertions(+), 35 deletions(-)
app/test/test_power.c +120 -35
@@ -7,6 +7,7 @@#include <unistd.h> #include <limits.h> #include <string.h> +#include <stdbool.h> #include "test.h"
@@ -23,6 +24,86 @@ test_power(void)#include <rte_power.h> +static int +check_function_ptrs (void ) +{ +enum power_management_env env =rte_power_get_env (); + +const bool not_null_expected = !(env ==PM_ENV_NOT_SET ); + +const char *inject_not_string1 = not_null_expected ?" not" :"" ; +const char *inject_not_string2 = not_null_expected ?"" :" not" ; + +if ((rte_power_freqs ==NULL ) == not_null_expected) { +printf ("rte_power_freqs should%s be NULL, environment has%s been " +"initialised\n" , inject_not_string1, + inject_not_string2); +return -1 ; + } +if ((rte_power_get_freq ==NULL ) == not_null_expected) { +printf ("rte_power_get_freq should%s be NULL, environment has%s been " +"initialised\n" , inject_not_string1, + inject_not_string2); +return -1 ; + } +if ((rte_power_set_freq ==NULL ) == not_null_expected) { +printf ("rte_power_set_freq should%s be NULL, environment has%s been " +"initialised\n" , inject_not_string1, + inject_not_string2); +return -1 ; + } +if ((rte_power_freq_up ==NULL ) == not_null_expected) { +printf ("rte_power_freq_up should%s be NULL, environment has%s been " +"initialised\n" , inject_not_string1, + inject_not_string2); +return -1 ; + } +if ((rte_power_freq_down ==NULL ) == not_null_expected) { +printf ("rte_power_freq_down should%s be NULL, environment has%s been " +"initialised\n" , inject_not_string1, + inject_not_string2); +return -1 ; + } +if ((rte_power_freq_max ==NULL ) == not_null_expected) { +printf ("rte_power_freq_max should%s be NULL, environment has%s been " +"initialised\n" , inject_not_string1, + inject_not_string2); +return -1 ; + } +if ((rte_power_freq_min ==NULL ) == not_null_expected) { +printf ("rte_power_freq_min should%s be NULL, environment has%s been " +"initialised\n" , inject_not_string1, + inject_not_string2); +return -1 ; + } +if ((rte_power_turbo_status ==NULL ) == not_null_expected) { +printf ("rte_power_turbo_status should%s be NULL, environment has%s been " +"initialised\n" , inject_not_string1, + inject_not_string2); +return -1 ; + } +if ((rte_power_freq_enable_turbo ==NULL ) == not_null_expected) { +printf ("rte_power_freq_enable_turbo should%s be NULL, environment has%s been " +"initialised\n" , inject_not_string1, + inject_not_string2); +return -1 ; + } +if ((rte_power_freq_disable_turbo ==NULL ) == not_null_expected) { +printf ("rte_power_freq_disable_turbo should%s be NULL, environment has%s been " +"initialised\n" , inject_not_string1, + inject_not_string2); +return -1 ; + } +if ((rte_power_get_capabilities ==NULL ) == not_null_expected) { +printf ("rte_power_get_capabilities should%s be NULL, environment has%s been " +"initialised\n" , inject_not_string1, + inject_not_string2); +return -1 ; + } + +return 0 ; +} +static int test_power (void ) {
@@ -43,43 +124,47 @@ test_power(void)return -1 ; } -/* verify that function pointers are NULL */ -if (rte_power_freqs !=NULL ) { -printf ("rte_power_freqs should be NULL, environment has not been " -"initialised\n" ); - goto fail_all; - } -if (rte_power_get_freq !=NULL ) { -printf ("rte_power_get_freq should be NULL, environment has not been " -"initialised\n" ); - goto fail_all; - } -if (rte_power_set_freq !=NULL ) { -printf ("rte_power_set_freq should be NULL, environment has not been " -"initialised\n" ); - goto fail_all; - } -if (rte_power_freq_up !=NULL ) { -printf ("rte_power_freq_up should be NULL, environment has not been " -"initialised\n" ); - goto fail_all; - } -if (rte_power_freq_down !=NULL ) { -printf ("rte_power_freq_down should be NULL, environment has not been " -"initialised\n" ); - goto fail_all; - } -if (rte_power_freq_max !=NULL ) { -printf ("rte_power_freq_max should be NULL, environment has not been " -"initialised\n" ); - goto fail_all; - } -if (rte_power_freq_min !=NULL ) { -printf ("rte_power_freq_min should be NULL, environment has not been " -"initialised\n" ); +/* Verify that function pointers are NULL */ +if (check_function_ptrs () <0 ) goto fail_all; - } +rte_power_unset_env (); + +/* Perform tests for valid environments.*/ +const enum power_management_env envs[] = {PM_ENV_ACPI_CPUFREQ , +PM_ENV_KVM_VM , +PM_ENV_PSTATE_CPUFREQ }; + +const int envs_size =sizeof (envs)/sizeof (enum power_management_env ); + +for (int i =0 ; i < envs_size; ++i) { + +/* Test setting a valid environment */ + ret =rte_power_set_env (envs[i]); +if (ret !=0 ) { +printf ("Unexpectedly unsucceeded on setting a valid environment\n" ); +return -1 ; + } + +/* Test that the environment has been set */ + env =rte_power_get_env (); +if (env != envs[i]) { +printf ("Not expected environment configuration\n" ); +return -1 ; + } + +/* Verify that function pointers are NOT NULL */ +if (check_function_ptrs () <0 ) + goto fail_all; + +rte_power_unset_env (); + +/* Verify that function pointers are NULL */ +if (check_function_ptrs () <0 ) + goto fail_all; + + } +return 0 ; fail_all:rte_power_unset_env ();
Signature · 13 lines
2.17.2 -------------------------------------------------------------- Intel Research and Development Ireland Limited Registered in Ireland Registered Office: Collinstown Industrial Park, Leixlip, County Kildare Registered Number: 308263 This e-mail and any attachments may contain confidential material for the sole use of the intended recipient(s). Any review or distribution by others is strictly prohibited. If you are not the intended recipient, please contact the sender and delete all copies.