tools/rtla: Create common_apply_config()

Merge the common bits of osnoise_apply_config() and
timerlat_apply_config().  Put the result in a new common.c, and move
enough things to common.h so that common.c does not need to include
osnoise.h.

Cc: John Kacur <jkacur@redhat.com>
Cc: Costa Shulyupin <costa.shul@redhat.com>
Link: https://lore.kernel.org/20250907022325.243930-4-crwood@redhat.com
Reviewed-by: Tomas Glozar  <tglozar@redhat.com>
Signed-off-by: Crystal Wood <crwood@redhat.com>
Signed-off-by: Steven Rostedt (Google) <rostedt@goodmis.org>

diff --git a/tools/tracing/rtla/src/Build b/tools/tracing/rtla/src/Build
index 66631280b75b9274fb6220e39922ae51d8a17c4a..329e24a40cf758bed4a0017c55c34ab655543365 100644 (file)
--- a/tools/tracing/rtla/src/Build
+++ b/tools/tracing/rtla/src/Build
@@ -1,6 +1,7 @@
 rtla-y += trace.o
 rtla-y += utils.o
 rtla-y += actions.o
+rtla-y += common.o
 rtla-y += osnoise.o
 rtla-y += osnoise_top.o
 rtla-y += osnoise_hist.o

diff --git a/tools/tracing/rtla/src/common.c b/tools/tracing/rtla/src/common.c
new file mode 100644 (file)
index 0000000..32a6faf
--- /dev/null
+++ b/tools/tracing/rtla/src/common.c
@@ -0,0 +1,63 @@
+// SPDX-License-Identifier: GPL-2.0
+#define _GNU_SOURCE
+
+#include <unistd.h>
+#include "common.h"
+
+/*
+ * common_apply_config - apply common configs to the initialized tool
+ */
+int
+common_apply_config(struct osnoise_tool *tool, struct common_params *params)
+{
+       int retval, i;
+
+       if (!params->sleep_time)
+               params->sleep_time = 1;
+
+       retval = osnoise_set_cpus(tool->context, params->cpus ? params->cpus : "all");
+       if (retval) {
+               err_msg("Failed to apply CPUs config\n");
+               goto out_err;
+       }
+
+       if (!params->cpus) {
+               for (i = 0; i < sysconf(_SC_NPROCESSORS_CONF); i++)
+                       CPU_SET(i, &params->monitored_cpus);
+       }
+
+       if (params->hk_cpus) {
+               retval = sched_setaffinity(getpid(), sizeof(params->hk_cpu_set),
+                                          &params->hk_cpu_set);
+               if (retval == -1) {
+                       err_msg("Failed to set rtla to the house keeping CPUs\n");
+                       goto out_err;
+               }
+       } else if (params->cpus) {
+               /*
+                * Even if the user do not set a house-keeping CPU, try to
+                * move rtla to a CPU set different to the one where the user
+                * set the workload to run.
+                *
+                * No need to check results as this is an automatic attempt.
+                */
+               auto_house_keeping(&params->monitored_cpus);
+       }
+
+       /*
+        * Set workload according to type of thread if the kernel supports it.
+        * On kernels without support, user threads will have already failed
+        * on missing fd, and kernel threads do not need it.
+        */
+       retval = osnoise_set_workload(tool->context, params->kernel_workload);
+       if (retval < -1) {
+               err_msg("Failed to set OSNOISE_WORKLOAD option\n");
+               goto out_err;
+       }
+
+       return 0;
+
+out_err:
+       return -1;
+}
+

diff --git a/tools/tracing/rtla/src/common.h b/tools/tracing/rtla/src/common.h
index 276dfbc7f95507c5ac66191800aed4b5bc720f6b..c306ba50268837a852c133007e486574412782bb 100644 (file)
--- a/tools/tracing/rtla/src/common.h
+++ b/tools/tracing/rtla/src/common.h
@@ -1,8 +1,67 @@
 /* SPDX-License-Identifier: GPL-2.0 */
 #pragma once
 
+#include "trace.h"
 #include "utils.h"
 
+/*
+ * osnoise_context - read, store, write, restore osnoise configs.
+ */
+struct osnoise_context {
+       int                     flags;
+       int                     ref;
+
+       char                    *curr_cpus;
+       char                    *orig_cpus;
+
+       /* 0 as init value */
+       unsigned long long      orig_runtime_us;
+       unsigned long long      runtime_us;
+
+       /* 0 as init value */
+       unsigned long long      orig_period_us;
+       unsigned long long      period_us;
+
+       /* 0 as init value */
+       long long               orig_timerlat_period_us;
+       long long               timerlat_period_us;
+
+       /* 0 as init value */
+       long long               orig_tracing_thresh;
+       long long               tracing_thresh;
+
+       /* -1 as init value because 0 is disabled */
+       long long               orig_stop_us;
+       long long               stop_us;
+
+       /* -1 as init value because 0 is disabled */
+       long long               orig_stop_total_us;
+       long long               stop_total_us;
+
+       /* -1 as init value because 0 is disabled */
+       long long               orig_print_stack;
+       long long               print_stack;
+
+       /* -1 as init value because 0 is off */
+       int                     orig_opt_irq_disable;
+       int                     opt_irq_disable;
+
+       /* -1 as init value because 0 is off */
+       int                     orig_opt_workload;
+       int                     opt_workload;
+};
+
+/*
+ * osnoise_tool -  osnoise based tool definition.
+ */
+struct osnoise_tool {
+       struct trace_instance           trace;
+       struct osnoise_context          *context;
+       void                            *data;
+       void                            *params;
+       time_t                          start_time;
+};
+
 struct hist_params {
        char                    no_irq;
        char                    no_thread;
@@ -44,4 +103,12 @@ struct common_params {
        int                     output_divisor;
        int                     pretty_output;
        int                     quiet;
+       int                     kernel_workload;
 };
+
+int osnoise_set_cpus(struct osnoise_context *context, char *cpus);
+void osnoise_restore_cpus(struct osnoise_context *context);
+
+int osnoise_set_workload(struct osnoise_context *context, bool onoff);
+
+int common_apply_config(struct osnoise_tool *tool, struct common_params *params);

diff --git a/tools/tracing/rtla/src/osnoise.c b/tools/tracing/rtla/src/osnoise.c
index 06ae7437c2c74d0b20a815474f937fcaa82843e7..4051b21db69aa4c987ae6b9a5b24521071f991c6 100644 (file)
--- a/tools/tracing/rtla/src/osnoise.c
+++ b/tools/tracing/rtla/src/osnoise.c
@@ -1120,21 +1120,14 @@ osnoise_report_missed_events(struct osnoise_tool *tool)
 }
 
 /*
- * osnoise_apply_config - apply common configs to the initialized tool
+ * osnoise_apply_config - apply osnoise configs to the initialized tool
  */
 int
 osnoise_apply_config(struct osnoise_tool *tool, struct osnoise_params *params)
 {
        int retval;
 
-       if (!params->common.sleep_time)
-               params->common.sleep_time = 1;
-
-       retval = osnoise_set_cpus(tool->context, params->common.cpus ? params->common.cpus : "all");
-       if (retval) {
-               err_msg("Failed to apply CPUs config\n");
-               goto out_err;
-       }
+       params->common.kernel_workload = true;
 
        if (params->runtime || params->period) {
                retval = osnoise_set_runtime_period(tool->context,
@@ -1169,31 +1162,7 @@ osnoise_apply_config(struct osnoise_tool *tool, struct osnoise_params *params)
                goto out_err;
        }
 
-       if (params->common.hk_cpus) {
-               retval = sched_setaffinity(getpid(), sizeof(params->common.hk_cpu_set),
-                                          &params->common.hk_cpu_set);
-               if (retval == -1) {
-                       err_msg("Failed to set rtla to the house keeping CPUs\n");
-                       goto out_err;
-               }
-       } else if (params->common.cpus) {
-               /*
-                * Even if the user do not set a house-keeping CPU, try to
-                * move rtla to a CPU set different to the one where the user
-                * set the workload to run.
-                *
-                * No need to check results as this is an automatic attempt.
-                */
-               auto_house_keeping(&params->common.monitored_cpus);
-       }
-
-       retval = osnoise_set_workload(tool->context, true);
-       if (retval < -1) {
-               err_msg("Failed to set OSNOISE_WORKLOAD option\n");
-               goto out_err;
-       }
-
-       return 0;
+       return common_apply_config(tool, &params->common);
 
 out_err:
        return -1;

diff --git a/tools/tracing/rtla/src/osnoise.h b/tools/tracing/rtla/src/osnoise.h
index b64b39de97b5c82b6504b4ff0361bc20b46f273b..25baf46a25206a1b068af9991991d72802afd920 100644 (file)
--- a/tools/tracing/rtla/src/osnoise.h
+++ b/tools/tracing/rtla/src/osnoise.h
@@ -2,7 +2,6 @@
 #pragma once
 
 #include "common.h"
-#include "trace.h"
 
 enum osnoise_mode {
        MODE_OSNOISE = 0,
@@ -18,53 +17,6 @@ struct osnoise_params {
        enum osnoise_mode       mode;
 };
 
-/*
- * osnoise_context - read, store, write, restore osnoise configs.
- */
-struct osnoise_context {
-       int                     flags;
-       int                     ref;
-
-       char                    *curr_cpus;
-       char                    *orig_cpus;
-
-       /* 0 as init value */
-       unsigned long long      orig_runtime_us;
-       unsigned long long      runtime_us;
-
-       /* 0 as init value */
-       unsigned long long      orig_period_us;
-       unsigned long long      period_us;
-
-       /* 0 as init value */
-       long long               orig_timerlat_period_us;
-       long long               timerlat_period_us;
-
-       /* 0 as init value */
-       long long               orig_tracing_thresh;
-       long long               tracing_thresh;
-
-       /* -1 as init value because 0 is disabled */
-       long long               orig_stop_us;
-       long long               stop_us;
-
-       /* -1 as init value because 0 is disabled */
-       long long               orig_stop_total_us;
-       long long               stop_total_us;
-
-       /* -1 as init value because 0 is disabled */
-       long long               orig_print_stack;
-       long long               print_stack;
-
-       /* -1 as init value because 0 is off */
-       int                     orig_opt_irq_disable;
-       int                     opt_irq_disable;
-
-       /* -1 as init value because 0 is off */
-       int                     orig_opt_workload;
-       int                     opt_workload;
-};
-
 /*
  * *_INIT_VALs are also invalid values, they are used to
  * communicate errors.
@@ -76,9 +28,6 @@ struct osnoise_context *osnoise_context_alloc(void);
 int osnoise_get_context(struct osnoise_context *context);
 void osnoise_put_context(struct osnoise_context *context);
 
-int osnoise_set_cpus(struct osnoise_context *context, char *cpus);
-void osnoise_restore_cpus(struct osnoise_context *context);
-
 int osnoise_set_runtime_period(struct osnoise_context *context,
                               unsigned long long runtime,
                               unsigned long long period);
@@ -105,19 +54,6 @@ int osnoise_set_print_stack(struct osnoise_context *context,
                            long long print_stack);
 
 int osnoise_set_irq_disable(struct osnoise_context *context, bool onoff);
-int osnoise_set_workload(struct osnoise_context *context, bool onoff);
-
-/*
- * osnoise_tool -  osnoise based tool definition.
- */
-struct osnoise_tool {
-       struct trace_instance           trace;
-       struct osnoise_context          *context;
-       void                            *data;
-       void                            *params;
-       time_t                          start_time;
-};
-
 void osnoise_destroy_tool(struct osnoise_tool *top);
 struct osnoise_tool *osnoise_init_tool(char *tool_name);
 struct osnoise_tool *osnoise_init_trace_tool(char *tracer);

diff --git a/tools/tracing/rtla/src/timerlat.c b/tools/tracing/rtla/src/timerlat.c
index 0b2f03e1e6120a9218b499dc7b34a206190f3a94..e4bf58db1dd239cb933b8c017f05756703413598 100644 (file)
--- a/tools/tracing/rtla/src/timerlat.c
+++ b/tools/tracing/rtla/src/timerlat.c
@@ -24,21 +24,7 @@
 int
 timerlat_apply_config(struct osnoise_tool *tool, struct timerlat_params *params)
 {
-       int retval, i;
-
-       if (!params->common.sleep_time)
-               params->common.sleep_time = 1;
-
-       retval = osnoise_set_cpus(tool->context, params->common.cpus ? params->common.cpus : "all");
-       if (retval) {
-               err_msg("Failed to apply CPUs config\n");
-               goto out_err;
-       }
-
-       if (!params->common.cpus) {
-               for (i = 0; i < sysconf(_SC_NPROCESSORS_CONF); i++)
-                       CPU_SET(i, &params->common.monitored_cpus);
-       }
+       int retval;
 
        if (params->mode != TRACING_MODE_BPF) {
                /*
@@ -75,29 +61,11 @@ timerlat_apply_config(struct osnoise_tool *tool, struct timerlat_params *params)
                goto out_err;
        }
 
-       if (params->common.hk_cpus) {
-               retval = sched_setaffinity(getpid(), sizeof(params->common.hk_cpu_set),
-                                          &params->common.hk_cpu_set);
-               if (retval == -1) {
-                       err_msg("Failed to set rtla to the house keeping CPUs\n");
-                       goto out_err;
-               }
-       } else if (params->common.cpus) {
-               /*
-                * Even if the user do not set a house-keeping CPU, try to
-                * move rtla to a CPU set different to the one where the user
-                * set the workload to run.
-                *
-                * No need to check results as this is an automatic attempt.
-                */
-               auto_house_keeping(&params->common.monitored_cpus);
-       }
-
        /*
         * If the user did not specify a type of thread, try user-threads first.
         * Fall back to kernel threads otherwise.
         */
-       if (!params->kernel_workload && !params->user_data) {
+       if (!params->common.kernel_workload && !params->user_data) {
                retval = tracefs_file_exists(NULL, "osnoise/per_cpu/cpu0/timerlat_fd");
                if (retval) {
                        debug_msg("User-space interface detected, setting user-threads\n");
@@ -105,22 +73,11 @@ timerlat_apply_config(struct osnoise_tool *tool, struct timerlat_params *params)
                        params->user_data = 1;
                } else {
                        debug_msg("User-space interface not detected, setting kernel-threads\n");
-                       params->kernel_workload = 1;
+                       params->common.kernel_workload = 1;
                }
        }
 
-       /*
-        * Set workload according to type of thread if the kernel supports it.
-        * On kernels without support, user threads will have already failed
-        * on missing timerlat_fd, and kernel threads do not need it.
-        */
-       retval = osnoise_set_workload(tool->context, params->kernel_workload);
-       if (retval < -1) {
-               err_msg("Failed to set OSNOISE_WORKLOAD option\n");
-               goto out_err;
-       }
-
-       return 0;
+       return common_apply_config(tool, &params->common);
 
 out_err:
        return -1;

diff --git a/tools/tracing/rtla/src/timerlat.h b/tools/tracing/rtla/src/timerlat.h
index 212ee7971bab1c6db4101732f66166c3b3fef47c..86cd9bac8855d84b364f7a21af016e941ab6a452 100644 (file)
--- a/tools/tracing/rtla/src/timerlat.h
+++ b/tools/tracing/rtla/src/timerlat.h
@@ -27,7 +27,6 @@ struct timerlat_params {
        int                     no_aa;
        int                     dump_tasks;
        int                     user_workload;
-       int                     kernel_workload;
        int                     user_data;
        int                     deepest_idle_state;
        int                     aa_only;

diff --git a/tools/tracing/rtla/src/timerlat_hist.c b/tools/tracing/rtla/src/timerlat_hist.c
index 4dc22a7498858660f540aec44bb1bfbae2a3ca75..d339e2cffae22deea7aeb2a9cc76647ecfc2d4b6 100644 (file)
--- a/tools/tracing/rtla/src/timerlat_hist.c
+++ b/tools/tracing/rtla/src/timerlat_hist.c
@@ -941,7 +941,7 @@ static struct timerlat_params
                        params->common.stop_us = get_llong_from_str(optarg);
                        break;
                case 'k':
-                       params->kernel_workload = 1;
+                       params->common.kernel_workload = 1;
                        break;
                case 'n':
                        params->common.output_divisor = 1;
@@ -1081,7 +1081,7 @@ static struct timerlat_params
        if (!params->common.stop_us && !params->common.stop_total_us)
                params->no_aa = 1;
 
-       if (params->kernel_workload && params->user_workload)
+       if (params->common.kernel_workload && params->user_workload)
                timerlat_hist_usage("--kernel-threads and --user-threads are mutually exclusive!");
 
        /*

diff --git a/tools/tracing/rtla/src/timerlat_top.c b/tools/tracing/rtla/src/timerlat_top.c
index 72be083d7d71ed7800b64bce13af13dc6f41958a..bb42697d2575d6a587da5341bd812764cef6cf8c 100644 (file)
--- a/tools/tracing/rtla/src/timerlat_top.c
+++ b/tools/tracing/rtla/src/timerlat_top.c
@@ -694,7 +694,7 @@ static struct timerlat_params
                        params->common.stop_us = get_llong_from_str(optarg);
                        break;
                case 'k':
-                       params->kernel_workload = true;
+                       params->common.kernel_workload = true;
                        break;
                case 'n':
                        params->common.output_divisor = 1;
@@ -816,7 +816,7 @@ static struct timerlat_params
        if (params->no_aa && params->aa_only)
                timerlat_top_usage("--no-aa and --aa-only are mutually exclusive!");
 
-       if (params->kernel_workload && params->user_workload)
+       if (params->common.kernel_workload && params->user_workload)
                timerlat_top_usage("--kernel-threads and --user-threads are mutually exclusive!");
 
        /*