selftests/resctrl: Rename measure_vals() to measure_mem_bw_vals() & document

measure_vals() is awfully generic name so rename it to measure_mem_bw()
to describe better what it does and document the function parameters.

Signed-off-by: Ilpo Järvinen <ilpo.jarvinen@linux.intel.com>
Tested-by: Babu Moger <babu.moger@amd.com>
Reviewed-by: Reinette Chatre <reinette.chatre@intel.com>
Signed-off-by: Shuah Khan <skhan@linuxfoundation.org>

diff --git a/tools/testing/selftests/resctrl/resctrl_val.c b/tools/testing/selftests/resctrl/resctrl_val.c
index 3cf671cbb7a2c17a1db33b830436e15b391a881b..b33cb1de295be8460c0dc746cbf4dcf428a3618d 100644 (file)
--- a/tools/testing/selftests/resctrl/resctrl_val.c
+++ b/tools/testing/selftests/resctrl/resctrl_val.c
@@ -632,13 +632,18 @@ static void initialize_llc_occu_resctrl(const char *ctrlgrp, const char *mongrp,
 }
 
 /*
+ * measure_mem_bw - Measures memory bandwidth numbers while benchmark runs
+ * @uparams:           User supplied parameters
+ * @param:             Parameters passed to resctrl_val()
+ * @bm_pid:            PID that runs the benchmark
+ *
  * Measure memory bandwidth from resctrl and from another source which is
  * perf imc value or could be something else if perf imc event is not
  * available. Compare the two values to validate resctrl value. It takes
  * 1 sec to measure the data.
  */
-static int measure_vals(const struct user_params *uparams,
-                       struct resctrl_val_param *param, pid_t bm_pid)
+static int measure_mem_bw(const struct user_params *uparams,
+                         struct resctrl_val_param *param, pid_t bm_pid)
 {
        unsigned long bw_resc, bw_resc_start, bw_resc_end;
        FILE *mem_bw_fp;
@@ -902,7 +907,7 @@ int resctrl_val(const struct resctrl_test *test,
 
                if (!strncmp(resctrl_val, MBM_STR, sizeof(MBM_STR)) ||
                    !strncmp(resctrl_val, MBA_STR, sizeof(MBA_STR))) {
-                       ret = measure_vals(uparams, param, bm_pid);
+                       ret = measure_mem_bw(uparams, param, bm_pid);
                        if (ret)
                                break;
                } else if (!strncmp(resctrl_val, CMT_STR, sizeof(CMT_STR))) {