strace: add arguments to --syscall-times and --relative-timestamps
* defs.h (Tflag_scale, Tflag_width): New declarations.
* strace.c (Tflag_scale, Tflag_width, rflag_scale, rflag_width): New
variables.
(printleader): Parametrise relative timestamp printing with rflag_width
and rflag_scale.
(init) <longopts>: Change second field of "relative-timestamps" and
"syscall-times" from no_argument to optional_argument.
(init) <case 'r', case 'T'>: Handle optarg, fail if the scale variable
is set to -1.
(usage): Document it.
* strace.1.in (.SS Output format): Likewise.
* syscall.c (syscall_exiting_trace): Parametrise syscall time printing
* with Tflag_width and Tflag_scale.
* tests/gen_tests.in (strace--relative-timestamps-s,
strace--relative-timestamps-ms, strace--relative-timestamps-us,
strace--relative-timestamps-ns): New tests.
* tests/options-syntax.test: New checks for --relative-timestamps and
--syscall-times option syntax.
* tests/strace--relative-timestamps-ms.expected: New file.
* tests/strace--relative-timestamps-ns.expected: Likewise.
* tests/strace--relative-timestamps-s.expected: Likewise.
* tests/strace--relative-timestamps-us.expected: Likewise.
* tests/strace--syscall-times-ms.expected: Likewise.
* tests/strace--syscall-times-ns.expected: Likewise.
* tests/strace--syscall-times-s.expected: Likewise.
* tests/strace--syscall-times-us.expected: Likewise.
* tests/Makefile.am (EXTRA_DIST): Add them.
In preparation of using elsewhere.
* defs.h (str2timescale_ex): New declaration.
(str2timescale_optarg, str2timescale_sfx): New macros.
* util.c (str2timescale_ex): New function.
(parse_ts): Remove units, unit, assign str2timescale_sfx result to a new
variable scale and use it instead of unit->val.
pathtrace: add a quiet flag for path resolution messages
And also quote the paths.
* number_set.h (enum quiet_bits): Add QUIET_PATH_RESOLVE.
* filter_qualify.c (quietstr_to_uint) <quiet_strs>: Add a string
representation for QUIET_PATH_RESOLVE.
* pathtrace.c (pathtrace_select_set): Put "Requested path"... message
under QUIET_PATH_RESOLVE flag check; process path and rpath with
string_quote.
* strace.c (usage): Document it.
* strace.1.in (.SS Output format) <-e quiet>: Likewise.
syscall: print personality switch messages in tcb's output
Personality switch is a rather normal event, it's unclear why it has
been always treated as a diagnostics/error information. Having it under
qflag makes even less sense, as it was impossible to get
this information when the -o option was used. With this change,
it is at least possible to get it with something like
strace -f -o out --quiet=none PROG
One caveat, though, is its rather odd format, with square brackets,
"PID=", and a dot, but it seems that we're stuck with it forever, as it
traces back for decades, albeit with a prefix change in commit
v4.11~509 ("Consistently use error_msg instead of fprintf(stderr)").
* syscall.c (update_personality): Use printleader/tprintf/line_ended
instead of error_msg.
* tests/bexecve.test: Add --quiet=personality to strace invocations.
* tests/strace-ff.test: Likewise.
strace: respect quietness setting when reporting unknown tracees
Since the situations where these processes can appear are relatively
normal, it makes little sense to print them irrespective of quietness
setting.
* strace.c (maybe_allocate_tcb): Put the message about exit of unknown
process under QUIET_EXIT check; put message about detach of unknown
process under QUIET_ATTACH check.
* tests/clone_parent--quiet-exit.c: New file.
* tests/clone_parent-q.c: Likewise.
* tests/clone_parent-qq.c: Likewise.
* tests/clone_ptrace--quiet-attach.c: Likewise.
* tests/clone_ptrace--quiet-exit.c: Likewise.
* tests/clone_ptrace-q.c: Likewise.
* tests/clone_ptrace-qq.c: Likewise.
* tests/.gitignore: Add clone_parent--quiet-exit, clone_parent-q,
clone_parent-qq, clone_ptrace--quiet-attach, clone_ptrace--quiet-exit,
clone_ptrace-q, and clone_ptrace-qq.
* tests/Makefile.am (check_PROGRAMS): Likewise.
* tests/gen_tests.in: Add clone_parent--quiet-exit, clone_parent-q,
clone_parent-qq, clone_ptrace--quiet-attach, clone_ptrace--quiet-exit,
clone_ptrace-q, and clone_ptrace-qq tests.
* tests/clone_parent.c [!QUIET_MSG] (QUIET_MSG): New macro.
(main): Print exit messages only if QUIET_MSG set to zero.
* tests/clone_ptrace.c [!QUIET_ATTACH] (QUIET_ATTACH): New macro.
[!QUIET_EXIT] (QUIET_EXIT): Likewise.
(main): Print information about unknown pid detach only if QUIET_ATTACH
is 0; print information about process exiting only if QUIET_EXIT is 0.
* tests/clone_ptrace.test: Add the first argument to args, add
"--quiet=personality" if it is empty.
strace: add long option aliases for -r, -T, and -O
The last trivial ones.
* strace.c (init) <longopts>: Add "summary-syscall-overhead" as an alias
for 'O', "relative-timestamps" as an alias for 'r', and "syscall-times"
as an alias for 'T'.
(usage): Document it.
* strace.1.in: Likewise.
* tests/count.test: Add --summary-syscall-overhead checks.
* tests/gen_tests.in: Add strace--relative-timestamps and
strace--syscall-times tests.
* tests/strace-T.test: Allow passing option to check as the first
* argument.
* tests/strace-r.test: Likewise.
* tests/strace--relative-timestamps.expected: New file.
* tests/strace--syscall-times.expected: Likewise.
* tests/Makefile.am (EXTRA_DIST): Add them.
Provide a new qualifier, quiet, and add a (hopefully) sensible handling
for it.
* defs.h (qflag): Remove declaration.
(qualify_quiet): New declaration.
* filter_qualify.c (quiet_set, quiet_set_updated): New variables.
(quietstr_to_uint, qualify_quiet): New functions.
(qual_options): Add "quiet", "silence", "silent", "q" that are handled
by qualify_quiet.
* number_set.h (enum quiet_bits): New enumeration.
(quiet_set_updated, quiet_set): New declarations.
* strace.c (qflag): Remove.
(detach, attach_tcb, maybe_allocate_tcb): Change qflag check to
is_number_in_set(QUIET_ATTACH, quiet_set).
(init) <qflag_qual, qqflag_qual>: New static constants.
(init) <enum>: Add GETOPT_QUAL_QUIET.
(init) <longopts>: Add "quiet", "silent", "silence".
(init) <case 'q'>: Increment qflag_short instead of qflag.
(init) <case GETOPT_QUAL_QUIET>: Call qualify_quiet with either optarg
or qflag_qual is the former is NULL.
(init) <if (outfname && argc)>: Check qflag_short and quiet_set_updated
instead of qflag for changing the default quietness setting.
(init): Check if qflag_short is set, if quiet_set_updated is set as well,
bail out, call qualify_quiet with the appropriate set otherwise.
(print_exited): Change qflag check to
is_number_in_set(QUIET_EXIT, quiet_set).
(usage): Document it.
* strace.1.in: Likewise.
* syscall.c (update_personality): Change qflag check to
is_number_in_set(QUIET_PERSONALITY, quiet_set).
* tests/clone-flags.test: Use --silence=exits instead of -qq.
* tests/count-f.test: Use -e silent=attach instead of -q.
* tests/options-syntax.test: Add checks.
* tests/strace-D.test: Use -e q=attach instead of -q.
* defs.h (enum xflag_opts): New enumeration.
* strace.c (xflag_str): New static variable.
(init) <xflag_long>: New variable.
(init) <enum>: Add GETOPT_HEX_STR.
(init) <longopts>: Add "string-in-hex" long option.
(init) <case GETOPT_HEX_STR>: Parse the argument using find_arg_val.
(init): Fail if both xflag_long and xflag are set; copy xflag_long
to xflag if only the former is set.
(usage): Document it.
* strace.1.in: Likewise.
* tests/gen_tests.in (strace--strings-in-hex,
strace--strings-in-hex-all, strace--strings-in-hex-non-ascii, strace-x,
strace-xx): New tests.
* tests/pure_executables.list: Add them.
* tests/.gitignore: Likewise.
* tests/options-syntax.test: Add checks.
* tests/strace--strings-in-hex-all.c: New file.
* tests/strace--strings-in-hex-non-ascii.c: Likewise.
* tests/strace--strings-in-hex.c: Likewise.
* tests/strace-x.c: Likewise.
* tests/strace-xx.c: Likewise.
Don't fail those who provide --daemonise or --daemonized as well.
Since multiple -D instances change behaviour and with long options
the last instance wins, it is better just to forbid the simultaneous
usage of the short and long option variants.
* strace.c (daemonize_str): New static constant.
(init) <daemonized_tracer_long>: New variable.
(init) <enum>: Add GETOPT_DAEMONIZE.
(init) <longopts>: Add "daemonize" long option variants.
(init) <case GETOPT_DAEMONIZE>: Use find_arg_val for argument parsing.
(init): Fail if both daemonized_tracer_long and daemonized_tracer are
set; copy daemonized_tracer_long to daemonized_tracer if only the former
is set; update the error messages that mention -D option with the alias.
(usage): Document it.
* strace.1.in: Likewise.
* tests/options-syntax.test: Add checks, update existing ones.
strace: mention long option aliases in error messages
If a user has provided a long option alias, current error messages could
be confusing otherwise.
* strace.c (init): Augment error messages with long option aliases where
appropriate.
* tests/options-syntax.test: Update expected output.
strace: print long options in the option error message
If a long option alias is used with incorrect argument, it's better show it
in the error message instead of the short option equivalent.
* strace.c (error_opt_arg): Add lopt argument, print its name
if it is non-NULL.
(init): Add lopt_idx variable, pass it to getopt_long, set loop-local
lopt variable to an option pointer based on lopt_idx; pass lopt
in error_opt_arg calls.
* tests/options-syntax.test: Update expected output.
And add more human-comprehensible values for it.
* strace.c (parse_interruptible_arg): New function.
(init) <longopts>: Add "interruptible" long option alias for 'I'.
(init) <case 'I'>: Call parse_interruptible_arg.
(usage): Document new long option alias and values.
* strace.1.in (parse_interruptible_arg): Likewise.
* tests/options-syntax.test: Add checks for the new syntax.
* tests/sigblock.test: Introduce -I syntax variety.
* tests/sigign.test: Likewise.
filter_qualify: rewrite statusstr_to_uint using find_xlat_val
* filter_qualify.c (*statuses): Move inside statusstr_to_uint, change
the type to const struct xlat_data[], change the initialisation
accordingly.
(statusstr_to_uint): Call find_arg_val instead of open-coding search
in a string array.
util: rewrite parse_ts suffix matching using find_xlat_val
A known behavioural change is that suffix can have any case, which
matches other places of option argument parsing.
* util.c (parse_ts): Change type of units to struct xlat_data[]; move
definition of units variable to its first usage, change its type
to const struct xlat_data *; use find_xlat_val instead of open-coding
search in units array.
The commonly open-coded snippet throughout the code, especially in the
argument parsing code, is searching in a string-value pair array of
string, so let's provide a function (or, more precisely, two functions,
one generic and another one that targets specifically argument parsing)
that does precisely that, on top of existing string-value pair
struct xlat_data type.
* defs.h (enum find_xlat_flag_bits, enum find_xlat_flags): New
enumerations.
(find_xlat_val_ex, find_arg_val_): New declarations.
(find_xlat_val, find_xlat_val_case, find_arg_val): New macros.
* util.c (find_xlat_val_ex, find_arg_val_): New functions.
syscall: handle fd printing regardless of show_fd_path setting
As of now, the way the higher 32 bits of the syscall return value
are printed depends on the show_fd_path (-y) setting: if it is set,
they are trimmed, which is pretty inconsistent.
* syscall.c (syscall_exiting_trace) <case RVAL_FD>: Check if tcp->u_rval
fits in int before passing it to printfd instead of a (redundant) show_fd_path
check (that is also done inside printfd itself).
* tests/bpf-success-long-y.c: New file.
* tests/bpf-success-long-y.test: New test.
* tests/.gitignore: Add bpf-success-long-y.
* tests/Makefile.am (check_PROGRAMS): Likewise.
(DECODER_TESTS): Add bpf-success-long-y.test.
* tests/bpf.c [!FD0_PATH] (FD0_PATH): New macro.
[INJECT_RETVAL] (sys_bpf): Print INJECT_RETVAL as long.
(BPF_MAP_CREATE_checks, BPF_OBJ_PIN_checks, BPF_OBJ_PIN_checks,
BPF_PROG_ATTACH_checks, BPF_RAW_TRACEPOINT_OPEN_checks,
BPF_TASK_FD_QUERY_checks): Append FD0_PATH to places where fd 0
is printed.
(print_BPF_PROG_QUERY_attr4, print_BPF_PROG_QUERY_attr5): Do not
conditionalise part of the strings with INJECT_RETVAL > 0, as we always
inject positive values so far.
tests/io_uring_register: properly handle big endian architectures
tests/io_uring_register.c (BE_LE): New macro.
(main): Use BE_LE to select the address to print based on endianness.
Fixes: v5.5~41 "io_uring: add support for IORING_REGISTER_FILES_UPDATE"
tests: fail if patterns file is not readable in match_grep
Otherwise, the test will not fail if the patterns file is missing.
* tests/init.sh (match_grep): Fail in case of non-zero exit status
of the read loop.
Co-authored-by: Dmitry V. Levin <ldv@altlinux.org>
strace --help: document long option aliases of -w and -X options
* strace.c (usage): Document --summary-wall-clock as the long option
alias of -w option; document --const-print-style as the long option
alias of -X option.
Fixes: v5.5~11 "Add long option aliases to some options"
struct pt_regs has no member r1, only a1.
* linux/csky/get_scno.c (arch_get_scno) [!__CSKYABIV2__]: Replace
csky_regs.r1 with csky_regs.a1.
* linux/csky/set_scno.c (arch_set_scno) [!__CSKYABIV2__]: Likewise.
* NEWS: Mention this fix.
Fixes: v5.1~99 "Add C-SKY architecture support"
Signed-off-by: Ma Jun <majun258@linux.alibaba.com>
Signed-off-by: Dmitry V. Levin <ldv@altlinux.org>
strace: produce a sensible error if -k option is used but not compiled in
* strace.c (init) <optstring>: Do not put "k" option under
ENABLE_STACKTRACE.
(init) <longopts>: Do not put "stack-traces" option under
ENABLE_STACKTRACE.
(init) <case 'k'> [!ENABLE_STACKTRACE]: Print an error message.
* tests/options-syntax.test: Check that the expected error message
is printed if -k is not compiled in.
tests: move getstr/getoption from strace-V.test to init.sh
And rename to more generic get_config_str/get_config_option.
* tests/strace-V.test (getstr, getoption): Rename to get_config_str
and get_config_option, respectively. All users updated.
(get_config_str, get_config_option): Move ...
* tests/init.sh: ... here.
match_diff and match_grep take the error message as the third argument
and pass it on to fail_, while the calling code expects that they simply
return non-zero in case of error.
* tests/syntax.sh (check_exit_status_and_stderr,
check_exit_status_and_stderr_using_grep): Specify the error message as
the third argument to match_diff/match grep instead of trying to handle
the erroneous status code.
* strace.c (init): Use qualify_trace, qualify_abbrev, qualify_verbose,
qualify_status, and qualify_signals instead of qualify.
Complements: v5.4-100-g490bfd465 "Add long options for qualifiers"
* strace.c (init) <longopts>: Add "columns" for "a",
"detach-on" for "b", "summary-only" for "c", "summary" for "C",
"env" for "E", "instruction-pointer" for "i", "stack-traces" for "k",
"output" for "o", "attach" for "p", "trace-path" for "P", "string-limit"
for "s", "summary-sort-by" for "S", "user" for "u", "no-abbrev" for "v",
"summary-wall-clock" for "w", and "const-print-style" for "X".
(usage): Document it.
* strace.1.in: Likewise.
So it is a bit more clear how to use them (especially such elaborate
ones as -e inject).
* strace.c (usage): Add -e trace, -e signal, and -e status option
descriptions to the Filtering section; add -e abbrev, -e verbose,
-e raw, -e read, -e write, and -e kvm option descriptions to the Output
format section; add Tampering section with description of -e inject
and -e fault options.
strace: capitalise placeholders in option declarations in usage
It is already capitalised in descriptions (rather inconsistently,
however), the capitalisation is already used for "PROG" and "ARGS",
and it allows consistently distinguish placeholders from literals.
The manual page does not need the same treatment, it seems,
as the italic script is used there for that purpose.
Capitalise the "usage:" part, as it is often capitalised in the usage
messages of some other programs.
* strace.c (usage): Capitalise "expr", "column", "interruptible",
"path", "file", "var", "val", "strsize", "pid", "format", "overhead",
"sortby" placeholders where appropriate. Capitalise the first letter
in "usage:".
They had discrepancies in section/optoin order for no reason.
* strace.c (usage): Move -e option in a separate General section,
put the rest of the sections in Startup, Tracing, Filtering, Output
format, Statistics, Miscellaneous order, as it is in the manual page;
add -ttt option description, swap -E var=val and -E var options, put
-A option description after -o, put --seccomp-bpf option description
after -h.
* NEWS: Mention this change.
Comma is not historically used in strace.1 to separate option aliases.
* strace.1.in (.SS Miscellaneous): Remove comma after -d, -h, and -V
declarations.
Eugene Syromyatnikov
MaJun
Dmitry V. Levin