rtla/cli: Unify and improve range validation logic
Subsystems (2)
Tomas Glozar
maintainerPATCH 1/1 rtla/cli: Unify and improve range validation logic
Several RTLA options do range validation inside the CLI parser layer (e.g. -p/--period). When RTLA migrated CLI parsing to libsubcmd, this logic was moved unchanged inside opt_*() callbacks.
Unify range validation so that all options use two newly added functions, check_llong_range() and check_int_range(), to validate the range.
The new range validation returns -1 from opt_*() callbacks rather than hard-exit with fatal(), allowing the help message for the specific option to be automatically displayed by libsubcmd logic.
Many options no longer need a custom callback, as they use the unified range validation of opt_llong_callback() and opt_int_callback(). Validation for several other options is improved:
- timerlat -p/--period: lower bound raised from 1 to 100 us to match the kernel's timerlat_min_period in trace_osnoise.c.
- timerlat -A/--aligned: reject negative values.
- timerlat --deepest-idle-state: add range [-1, INT_MAX]; previously, values <= -2 were read as "option not set".
- timerlat -p/--period, -A/--aligned, -b/--bucket-size: properly reject negative values instead of passing them to the tracer.
Remove unit tests for removed callbacks and test the new range validation functionality of opt_llong_callback() and opt_int_callback().
Update runtime tests for histogram options to account for the new error messages and exit value.
---
Dependencies:
- "rtla: Allow unsetting non-list custom-callback CLI options" patchset
tools/tracing/rtla/src/cli_p.h | 234 +++++------- tools/tracing/rtla/tests/osnoise.t | 2 +- tools/tracing/rtla/tests/timerlat.t | 2 +- .../rtla/tests/unit/cli_opt_callback.c | 353 ++++++------------ 4 files changed, 215 insertions(+), 376 deletions(-)
tools/tracing/rtla/src/cli_p.h +99 -135
@@ -5,6 +5,7 @@#error "Private header file included outside of cli.c module"#endif +#include <limits.h> #include <linux/kernel.h> #include <subcmd/parse-options.h>
@@ -32,9 +33,73 @@ static const int default_bucket_size = 1;static const int default_entries =256 ;static const enum stack_format default_stack_format =STACK_FORMAT_TRUNCATE ; +/* +* Range checking for long long and int option callbacks. +* +* Pass a pointer to a const struct as opt->data to enable range checking. +* If opt->data is NULL, no range check is performed. +*/ +struct llong_range { +long long min; +long long max; +}; + +struct int_range { +int min; +int max; +}; + +#define LLONG_RANGE (lo, hi) \ + (&(const struct llong_range){ .min = (lo), .max = (hi) }) + +#define INT_RANGE (lo, hi) \ + (&(const struct int_range){ .min = (lo), .max = (hi) }) + +static int check_llong_range (const struct option *opt,long long value) +{ +const struct llong_range *range = opt->data; + +if (!range) +return 0 ; +if (value < range->min || value > range->max) { +fprintf (stderr," Error: --%s value %lld is out of range [%lld, %lld]\n" , + opt->long_name, value, range->min, range->max); +return -1 ; + } +return 0 ; +} + +static int check_int_range (const struct option *opt,int value) +{ +const struct int_range *range = opt->data; + +if (!range) +return 0 ; +if (value < range->min || value > range->max) { +fprintf (stderr," Error: --%s value %d is out of range [%d, %d]\n" , + opt->long_name, value, range->min, range->max); +return -1 ; + } +return 0 ; +} + +/* +* OPT_CALLBACK variant that populates .data (for range checking). +*/ +#define RTLA_OPT_CALLBACK_DATA (s, l, v, a, h, f, d) \ + { .type = OPTION_CALLBACK, .short_name = (s), .long_name = (l), \ + .value = (v), .argh = (a), .help = (h), .callback = (f), \ + .data = (void *)(d) } + +#define RTLA_OPT_CALLBACK_DATA_DEFVAL (s, l, v, a, h, f, d, dv) \ + { .type = OPTION_CALLBACK, .short_name = (s), .long_name = (l), \ + .value = (v), .argh = (a), .help = (h), .callback = (f), \ + .data = (void *)(d), .defval = (intptr_t)(dv) } +/* * Shorthand macros for integer/long long command line options using -* opt_int_callback/opt_llong_callback, with variants that set defval. +* opt_int_callback/opt_llong_callback, with variants that set defval +* and/or data (for range checking). * * Note: defval's type is intptr_t. opt_int_callback interprets it directly as * an int, opt_llong_callback interprets it as a pointer to a long long, as
@@ -47,6 +112,10 @@ static const enum stack_format default_stack_format = STACK_FORMAT_TRUNCATE; .short_name = (s), .long_name = (l), .value = (v), .argh = (a), \ .help = (h), .callback = opt_llong_callback, .defval = (intptr_t)(d) } +#define RTLA_OPT_LLONG_DATA (s, l, v, a, h, d) { .type = OPTION_CALLBACK, \ + .short_name = (s), .long_name = (l), .value = (v), .argh = (a), \ + .help = (h), .callback = opt_llong_callback, .data = (void *)(d) } +#define RTLA_OPT_INT (s, l, v, a, h) \ OPT_CALLBACK(s, l, v, a, h, opt_int_callback)
@@ -54,6 +123,11 @@ static const enum stack_format default_stack_format = STACK_FORMAT_TRUNCATE; .short_name = (s), .long_name = (l), .value = (v), .argh = (a), \ .help = (h), .callback = opt_int_callback, .defval = (intptr_t)(d) } +#define RTLA_OPT_INT_DATA_DEFVAL (s, l, v, a, h, d, dv) { .type = OPTION_CALLBACK, \ + .short_name = (s), .long_name = (l), .value = (v), .argh = (a), \ + .help = (h), .callback = opt_int_callback, \ + .data = (void *)(d), .defval = (intptr_t)(dv) } +/* * Macros for command line options common to all tools *
@@ -182,6 +256,8 @@ static int opt_llong_callback(const struct option *opt, const char *arg, int unsreturn -1 ; *value =get_llong_from_str ((char *)arg); +if (check_llong_range (opt, *value)) +return -1 ;return 0 ; }
@@ -199,6 +275,8 @@ static int opt_int_callback(const struct option *opt, const char *arg, int unsetif (strtoi (arg, value))return -1 ; +if (check_int_range (opt, *value)) +return -1 ;return 0 ; }
@@ -359,13 +437,13 @@ static int opt_filter_cb(const struct option *opt, const char *arg, int unset)/* * Macros for command line options specific to osnoise */ -#define OSNOISE_OPT_PERIOD OPT_CALLBACK('p', "period", ¶ms->period, "us", \ +#define OSNOISE_OPT_PERIOD RTLA_OPT_LLONG_DATA('p', "period", ¶ms->period, "us", \ "osnoise period in us", \ - opt_osnoise_period_cb) + LLONG_RANGE(1, 10000000)) -#define OSNOISE_OPT_RUNTIME OPT_CALLBACK('r', "runtime", ¶ms->runtime, "us", \ +#define OSNOISE_OPT_RUNTIME RTLA_OPT_LLONG_DATA('r', "runtime", ¶ms->runtime, "us", \ "osnoise runtime in us", \ - opt_osnoise_runtime_cb) + LLONG_RANGE(100, LLONG_MAX))#define OSNOISE_OPT_THRESHOLD RTLA_OPT_LLONG('T', "threshold", ¶ms->threshold, "us", \ "the minimum delta to be considered a noise")
@@ -400,44 +478,6 @@ static int opt_osnoise_auto_cb(const struct option *opt, const char *arg, int unreturn 0 ; } -static int opt_osnoise_period_cb (const struct option *opt,const char *arg,int unset) -{ -unsigned long long *period = opt->value; - -if (unset) { - *period =0 ; -return 0 ; - } - -if (!arg) -return -1 ; - - *period =get_llong_from_str ((char *)arg); -if (*period >10000000 ) -fatal ("Period longer than 10 s" ); - -return 0 ; -} - -static int opt_osnoise_runtime_cb (const struct option *opt,const char *arg,int unset) -{ -unsigned long long *runtime = opt->value; - -if (unset) { - *runtime =0 ; -return 0 ; - } - -if (!arg) -return -1 ; - - *runtime =get_llong_from_str ((char *)arg); -if (*runtime <100 ) -fatal ("Runtime shorter than 100 us" ); - -return 0 ; -} -static int opt_osnoise_trace_output_cb (const struct option *opt,const char *arg,int unset) {const char **trace_output = opt->value;
@@ -492,9 +532,9 @@ static int opt_osnoise_on_end_cb(const struct option *opt, const char *arg, int/* * Macros for command line options specific to timerlat */ -#define TIMERLAT_OPT_PERIOD OPT_CALLBACK('p', "period", ¶ms->timerlat_period_us, "us", \ +#define TIMERLAT_OPT_PERIOD RTLA_OPT_LLONG_DATA('p', "period", ¶ms->timerlat_period_us, "us", \ "timerlat period in us", \ - opt_timerlat_period_cb) + LLONG_RANGE(100, 1000000))#define TIMERLAT_OPT_STACK RTLA_OPT_LLONG('s', "stack", ¶ms->print_stack, "us", \ "save the stack trace at the IRQ if a thread latency is higher than the argument in us")
@@ -503,14 +543,15 @@ static int opt_osnoise_on_end_cb(const struct option *opt, const char *arg, int "display data in nanoseconds", \ opt_nano_cb) -#define TIMERLAT_OPT_DMA_LATENCY OPT_CALLBACK(0, "dma-latency", ¶ms->dma_latency, "us", \ +#define TIMERLAT_OPT_DMA_LATENCY RTLA_OPT_INT_DATA_DEFVAL(0, "dma-latency", \ + ¶ms->dma_latency, "us", \ "set /dev/cpu_dma_latency latency <us> to reduce exit from idle latency", \ - opt_dma_latency_cb) + INT_RANGE(0, 10000), default_dma_latency) -#define TIMERLAT_OPT_DEEPEST_IDLE_STATE RTLA_OPT_INT_DEFVAL(0, "deepest-idle-state", \ +#define TIMERLAT_OPT_DEEPEST_IDLE_STATE RTLA_OPT_INT_DATA_DEFVAL(0, "deepest-idle-state", \ ¶ms->deepest_idle_state, "n", \ "only go down to idle state n on cpus used by timerlat to reduce exit from idle latency", \ - default_deepest_idle_state) + INT_RANGE(-1, INT_MAX), default_deepest_idle_state)#define TIMERLAT_OPT_AA_ONLY OPT_CALLBACK(0, "aa-only", params, "us", \ "stop if <us> latency is hit, only printing the auto analysis (reduces CPU usage)", \
@@ -530,33 +571,14 @@ static int opt_osnoise_on_end_cb(const struct option *opt, const char *arg, int "set the stack format (truncate, skip, full)", \ opt_stack_format_cb) -#define TIMERLAT_OPT_ALIGNED OPT_CALLBACK('A', "aligned", params, "us", \ +#define TIMERLAT_OPT_ALIGNED RTLA_OPT_CALLBACK_DATA('A', "aligned", params, "us", \ "align thread wakeups to a specific offset", \ - opt_timerlat_align_cb) + opt_timerlat_align_cb, LLONG_RANGE(0, LLONG_MAX))/* * Callback functions for command line options for timerlat tools */ -static int opt_timerlat_period_cb (const struct option *opt,const char *arg,int unset) -{ -long long *period = opt->value; - -if (unset) { - *period =0 ; -return 0 ; - } - -if (!arg) -return -1 ; - - *period =get_llong_from_str ((char *)arg); -if (*period >1000000 ) -fatal ("Period longer than 1 s" ); - -return 0 ; -} -static int opt_timerlat_auto_cb (const struct option *opt,const char *arg,int unset) {struct timerlat_cb_data *cb_data = opt->value;
@@ -585,28 +607,6 @@ static int opt_timerlat_auto_cb(const struct option *opt, const char *arg, int ureturn 0 ; } -static int opt_dma_latency_cb (const struct option *opt,const char *arg,int unset) -{ -int *dma_latency = opt->value; -int retval; - -if (unset) { - *dma_latency = default_dma_latency; -return 0 ; - } - -if (!arg) -return -1 ; - - retval =strtoi ((char *)arg, dma_latency); -if (retval) -fatal ("Invalid -dma-latency %s" , arg); -if (*dma_latency <0 || *dma_latency >10000 ) -fatal ("--dma-latency needs to be >= 0 and <= 10000" ); - -return 0 ; -} -static int opt_aa_only_cb (const struct option *opt,const char *arg,int unset) {struct timerlat_params *params = opt->value;
@@ -748,6 +748,8 @@ static int opt_timerlat_align_cb(const struct option *opt, const char *arg, int params->timerlat_align = true; params->timerlat_align_us =get_llong_from_str ((char *)arg); +if (check_llong_range (opt, params->timerlat_align_us)) +return -1 ;return 0 ; }
@@ -756,14 +758,15 @@ static int opt_timerlat_align_cb(const struct option *opt, const char *arg, int* Macros for command line options specific to histogram-based tools */ -#define HIST_OPT_BUCKET_SIZE OPT_CALLBACK('b', "bucket-size", \ +#define HIST_OPT_BUCKET_SIZE RTLA_OPT_INT_DATA_DEFVAL('b', "bucket-size", \ ¶ms->common.hist.bucket_size, "N", \ "set the histogram bucket size (default 1)", \ - opt_bucket_size_cb) + INT_RANGE(1, 999999), default_bucket_size) -#define HIST_OPT_ENTRIES OPT_CALLBACK('E', "entries", ¶ms->common.hist.entries, "N", \ +#define HIST_OPT_ENTRIES RTLA_OPT_INT_DATA_DEFVAL('E', "entries", \ + ¶ms->common.hist.entries, "N", \ "set the number of entries of the histogram (default 256)", \ - opt_entries_cb) + INT_RANGE(10, 9999999), default_entries)#define HIST_OPT_NO_IRQ OPT_BOOLEAN_FLAG(0, "no-irq", ¶ms->common.hist.no_irq, \ "ignore IRQ latencies", PARSE_OPT_NOAUTONEG)
@@ -783,42 +786,3 @@ static int opt_timerlat_align_cb(const struct option *opt, const char *arg, int#define HIST_OPT_WITH_ZEROS OPT_BOOLEAN(0, "with-zeros", ¶ms->common.hist.with_zeros, \ "print zero only entries") -/* Histogram-specific callbacks */ - -static int opt_bucket_size_cb (const struct option *opt,const char *arg,int unset) -{ -int *bucket_size = opt->value; - -if (unset) { - *bucket_size = default_bucket_size; -return 0 ; - } - -if (!arg) -return -1 ; - - *bucket_size =get_llong_from_str ((char *)arg); -if (*bucket_size ==0 || *bucket_size >=1000000 ) -fatal ("Bucket size needs to be > 0 and <= 1000000" ); - -return 0 ; -} - -static int opt_entries_cb (const struct option *opt,const char *arg,int unset) -{ -int *entries = opt->value; - -if (unset) { - *entries = default_entries; -return 0 ; - } - -if (!arg) -return -1 ; - - *entries =get_llong_from_str ((char *)arg); -if (*entries <10 || *entries >9999999 ) -fatal ("Entries must be > 10 and < 10000000" ); - -return 0 ; -}
tools/tracing/rtla/tests/osnoise.t +1 -1
@@ -32,7 +32,7 @@ check "hist with -b/--bucket-size" \ check "hist with -E/--entries" \ "osnoise hist -E 10 -d 1s" check "hist with -E/--entries out of range" \ - "osnoise hist -E 1 -d 1s" 1 "^Entries must be > 10 and < 10000000$" + "osnoise hist -E 1 -d 1s" 129 "out of range \[10, 9999999\]" check "hist with --no-header" \ "osnoise hist --no-header -d 1s" 0 "" "RTLA osnoise histogram" check "hist with --with-zeros" \
tools/tracing/rtla/tests/timerlat.t +1 -1
@@ -61,7 +61,7 @@ check "hist with -b/--bucket-size" \ check "hist with -E/--entries" \ "timerlat hist -E 10 -d 1s" check "hist with -E/--entries out of range" \ - "timerlat hist -E 1 -d 1s" 1 "^Entries must be > 10 and < 10000000$" + "timerlat hist -E 1 -d 1s" 129 "out of range \[10, 9999999\]" check "hist with --no-header" \ "timerlat hist --no-header -d 1s" 0 "" "RTLA timerlat histogram" check "hist with --with-zeros" \
tools/tracing/rtla/tests/unit/cli_opt_callback.c +114 -239
438 lines not on this page · raw message
Signature · 1 line
2.55.0