tracing/rtla: Updates for 5.19
Subsystems (2)
Steven Rostedt
maintainerPATCH 4/6 rtla: Minor grammar fix for rtla README
In reply to Steven RostedtFrom: John Kacur <[email protected]>
- Change to "The rtla meta-tool includes"
- Remove an unnecessary "But, "
- Adjust the formatting of the paragraph resulting from the changes.
- Simplify the wording for the libraries and tools.
--- tools/tracing/rtla/README.txt | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-)
tools/tracing/rtla/README.txt +5 -7
@@ -1,15 +1,13 @@ RTLA: Real-Time Linux Analysis tools -The rtla is a meta-tool that includes a set of commands that -aims to analyze the real-time properties of Linux. But, instead of -testing Linux as a black box, rtla leverages kernel tracing -capabilities to provide precise information about the properties -and root causes of unexpected results. +The rtla meta-tool includes a set of commands that aims to analyze +the real-time properties of Linux. Instead of testing Linux as a black box, +rtla leverages kernel tracing capabilities to provide precise information +about the properties and root causes of unexpected results. Installing RTLA -RTLA depends on some libraries and tools. More precisely, it depends on the -following libraries: +RTLA depends on the following libraries and tools: - libtracefs - libtraceevent
Signature · 1 line
2.35.1
Steven Rostedt
maintainerPATCH 3/6 rtla: Dont overwrite existing directory mode
In reply to Steven RostedtFrom: John Kacur <[email protected]>
The mode on /usr/bin is often 555 these days,
but make install on rtla overwrites this with 755
Fix this by preserving the current directory if it exists.
--- tools/tracing/rtla/Makefile | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-)
tools/tracing/rtla/Makefile +2 -1
@@ -23,6 +23,7 @@ $(call allow-override,LD_SO_CONF_PATH,/etc/ld.so.conf.d/) $(call allow-override,LDCONFIG,ldconfig) INSTALL = install +MKDIR = mkdir FOPTS := -flto=auto -ffat-lto-objects -fexceptions -fstack-protector-strong \ -fasynchronous-unwind-tables -fstack-clash-protection WOPTS := -Wall -Werror=format-security -Wp,-D_FORTIFY_SOURCE=2 -Wp,-D_GLIBCXX_ASSERTIONS -Wno-maybe-uninitialized
@@ -103,7 +104,7 @@ static: $(OBJ) .PHONY: install install: doc_install - $(INSTALL) -d -m 755 $(DESTDIR)$(BINDIR) + $(MKDIR) -p $(DESTDIR)$(BINDIR) $(INSTALL) rtla -m 755 $(DESTDIR)$(BINDIR) $(STRIP) $(DESTDIR)$(BINDIR)/rtla @test ! -f $(DESTDIR)$(BINDIR)/osnoise || rm $(DESTDIR)$(BINDIR)/osnoise
Signature · 1 line
2.35.1
Steven Rostedt
maintainerPATCH 5/6 rtla: Fix __set_sched_attr error message
In reply to Steven RostedtFrom: Daniel Bristot de Oliveira <[email protected]>
rtla's function __set_sched_attr() was borrowed from stalld, but I forgot to update the error message to something meaningful for rtla.
Update the error message from:
boost_with_deadline failed to boost pid PID: STRERROR
to a proper one:
Failed to set sched attributes to the pid PID: STRERROR
--- tools/tracing/rtla/src/utils.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
tools/tracing/rtla/src/utils.c +1 -1
@@ -255,7 +255,7 @@ int __set_sched_attr(int pid, struct sched_attr *attr) retval =sched_setattr (pid, attr, flags);if (retval <0 ) { -err_msg ("boost_with_deadline failed to boost pid %d: %s\n" , +err_msg ("Failed to set sched attributes to the pid %d: %s\n" , pid,strerror (errno));return 1 ; }
Signature · 1 line
2.35.1
Steven Rostedt
maintainercover tracing/rtla: Updates for 5.19
git://git.kernel.org/pub/scm/linux/kernel/git/rostedt/linux-trace.git
for-next-rtla
Head SHA1: dada03db9bb1984826e61cfcf1418ac73848324d
Daniel Bristot de Oliveira (3):
rtla/Makefile: Properly handle dependencies
rtla: Fix __set_sched_attr error message
rtla: Remove procps-ng dependency
John Kacur (2):
rtla: Don't overwrite existing directory mode
rtla: Minor grammar fix for rtla README
Wan Jiabing (1):
rtla: Avoid record NULL pointer dereference
----
Documentation/tools/rtla/Makefile | 14 ++++- tools/tracing/rtla/Makefile | 40 +++++++++++- tools/tracing/rtla/README.txt | 13 ++-- tools/tracing/rtla/src/osnoise_hist.c | 5 +- tools/tracing/rtla/src/osnoise_top.c | 9 +-- tools/tracing/rtla/src/timerlat_hist.c | 11 ++-- tools/tracing/rtla/src/timerlat_top.c | 11 ++-- tools/tracing/rtla/src/utils.c | 108 ++++++++++++++++++++++++++------- tools/tracing/rtla/src/utils.h | 3 +- 9 files changed, 164 insertions(+), 50 deletions(-)
Steven Rostedt
maintainerPATCH 2/6 rtla: Avoid record NULL pointer dereference
From: Wan Jiabing <[email protected]>
Fix the following null/deref_null.cocci errors:
./tools/tracing/rtla/src/osnoise_hist.c:870:31-36: ERROR: record is NULL but dereferenced. ./tools/tracing/rtla/src/osnoise_top.c:650:31-36: ERROR: record is NULL but dereferenced. ./tools/tracing/rtla/src/timerlat_hist.c:905:31-36: ERROR: record is NULL but dereferenced. ./tools/tracing/rtla/src/timerlat_top.c:700:31-36: ERROR: record is NULL but dereferenced.
"record" is NULL before calling osnoise_init_trace_tool. Add a tag "out_free" to avoid dereferring a NULL pointer.
--- tools/tracing/rtla/src/osnoise_hist.c | 5 +++-- tools/tracing/rtla/src/osnoise_top.c | 9 +++++---- tools/tracing/rtla/src/timerlat_hist.c | 11 ++++++----- tools/tracing/rtla/src/timerlat_top.c | 11 ++++++----- 4 files changed, 20 insertions(+), 16 deletions(-)
tools/tracing/rtla/src/osnoise_hist.c +3 -2
@@ -809,7 +809,7 @@ int osnoise_hist_main(int argc, char *argv[]) retval =set_comm_sched_attr ("osnoise/" , ¶ms->sched_param);if (retval) {err_msg ("Failed to set sched parameters\n" ); - goto out_hist; + goto out_free; } }
@@ -819,7 +819,7 @@ int osnoise_hist_main(int argc, char *argv[]) record =osnoise_init_trace_tool ("osnoise" );if (!record) {err_msg ("Failed to enable the trace instance\n" ); - goto out_hist; + goto out_free; }if (params->events) {
@@ -869,6 +869,7 @@ int osnoise_hist_main(int argc, char *argv[]) out_hist:trace_events_destroy (&record->trace, params->events); params->events =NULL ; +out_free:osnoise_free_histogram (tool->data); out_destroy:osnoise_destroy_tool (record);
tools/tracing/rtla/src/osnoise_top.c +5 -4
@@ -572,7 +572,7 @@ int osnoise_top_main(int argc, char **argv) retval =osnoise_top_apply_config (tool, params);if (retval) {err_msg ("Could not apply config\n" ); - goto out_top; + goto out_free; } trace = &tool->trace;
@@ -580,14 +580,14 @@ int osnoise_top_main(int argc, char **argv) retval =enable_osnoise (trace);if (retval) {err_msg ("Failed to enable osnoise tracer\n" ); - goto out_top; + goto out_free; }if (params->set_sched) { retval =set_comm_sched_attr ("osnoise/" , ¶ms->sched_param);if (retval) {err_msg ("Failed to set sched parameters\n" ); - goto out_top; + goto out_free; } }
@@ -597,7 +597,7 @@ int osnoise_top_main(int argc, char **argv) record =osnoise_init_trace_tool ("osnoise" );if (!record) {err_msg ("Failed to enable the trace instance\n" ); - goto out_top; + goto out_free; }if (params->events) {
@@ -649,6 +649,7 @@ int osnoise_top_main(int argc, char **argv) out_top:trace_events_destroy (&record->trace, params->events); params->events =NULL ; +out_free:osnoise_free_top (tool->data);osnoise_destroy_tool (record);osnoise_destroy_tool (tool);
tools/tracing/rtla/src/timerlat_hist.c +6 -5
@@ -821,7 +821,7 @@ int timerlat_hist_main(int argc, char *argv[]) retval =timerlat_hist_apply_config (tool, params);if (retval) {err_msg ("Could not apply config\n" ); - goto out_hist; + goto out_free; } trace = &tool->trace;
@@ -829,14 +829,14 @@ int timerlat_hist_main(int argc, char *argv[]) retval =enable_timerlat (trace);if (retval) {err_msg ("Failed to enable timerlat tracer\n" ); - goto out_hist; + goto out_free; }if (params->set_sched) { retval =set_comm_sched_attr ("timerlat/" , ¶ms->sched_param);if (retval) {err_msg ("Failed to set sched parameters\n" ); - goto out_hist; + goto out_free; } }
@@ -844,7 +844,7 @@ int timerlat_hist_main(int argc, char *argv[]) dma_latency_fd =set_cpu_dma_latency (params->dma_latency);if (dma_latency_fd <0 ) {err_msg ("Could not set /dev/cpu_dma_latency.\n" ); - goto out_hist; + goto out_free; } }
@@ -854,7 +854,7 @@ int timerlat_hist_main(int argc, char *argv[]) record =osnoise_init_trace_tool ("timerlat" );if (!record) {err_msg ("Failed to enable the trace instance\n" ); - goto out_hist; + goto out_free; }if (params->events) {
@@ -904,6 +904,7 @@ int timerlat_hist_main(int argc, char *argv[])close (dma_latency_fd);trace_events_destroy (&record->trace, params->events); params->events =NULL ; +out_free:timerlat_free_histogram (tool->data);osnoise_destroy_tool (record);osnoise_destroy_tool (tool);
tools/tracing/rtla/src/timerlat_top.c +6 -5
@@ -612,7 +612,7 @@ int timerlat_top_main(int argc, char *argv[]) retval =timerlat_top_apply_config (top, params);if (retval) {err_msg ("Could not apply config\n" ); - goto out_top; + goto out_free; } trace = &top->trace;
@@ -620,14 +620,14 @@ int timerlat_top_main(int argc, char *argv[]) retval =enable_timerlat (trace);if (retval) {err_msg ("Failed to enable timerlat tracer\n" ); - goto out_top; + goto out_free; }if (params->set_sched) { retval =set_comm_sched_attr ("timerlat/" , ¶ms->sched_param);if (retval) {err_msg ("Failed to set sched parameters\n" ); - goto out_top; + goto out_free; } }
@@ -635,7 +635,7 @@ int timerlat_top_main(int argc, char *argv[]) dma_latency_fd =set_cpu_dma_latency (params->dma_latency);if (dma_latency_fd <0 ) {err_msg ("Could not set /dev/cpu_dma_latency.\n" ); - goto out_top; + goto out_free; } }
@@ -645,7 +645,7 @@ int timerlat_top_main(int argc, char *argv[]) record =osnoise_init_trace_tool ("timerlat" );if (!record) {err_msg ("Failed to enable the trace instance\n" ); - goto out_top; + goto out_free; }if (params->events) {
@@ -699,6 +699,7 @@ int timerlat_top_main(int argc, char *argv[])close (dma_latency_fd);trace_events_destroy (&record->trace, params->events); params->events =NULL ; +out_free:timerlat_free_top (top->data);osnoise_destroy_tool (record);osnoise_destroy_tool (top);
Signature · 1 line
2.35.1
Steven Rostedt
maintainerPATCH 1/6 rtla/Makefile: Properly handle dependencies
In reply to Steven RostedtFrom: Daniel Bristot de Oliveira <[email protected]>
Linus had a problem compiling RTLA, saying:
"[...] I wish the tracing tools would do a bit more package checking and helpful error messages too, rather than just fail with:
fatal error: tracefs.h: No such file or directory"
Which is indeed not a helpful message. Update the Makefile, adding proper checks for the dependencies, with useful information about how to resolve possible problems.
For example, the previous error is now reported as:
$ make
********************************************
** NOTICE: libtracefs version 1.3 or higher not found
**
** Consider installing the latest libtracefs from your
** distribution, e.g., 'dnf install libtracefs' on Fedora,
** or from source:
**
** https://git.kernel.org/pub/scm/libs/libtrace/libtracefs.git/
**
********************************************These messages are inspired by the ones used on trace-cmd, as suggested by Stevel Rostedt.
Changes from V1:
- Moved the rst2man check to the install phase (when it is used).
- Removed the procps-ng lib check [1] as it is being removed.
[1] a0f9f8c1030c66305c9b921057c3d483064d5529.1651220820.git.bristot@kernel.org
--- Documentation/tools/rtla/Makefile | 14 ++++++++++++- tools/tracing/rtla/Makefile | 35 +++++++++++++++++++++++++++++++ 2 files changed, 48 insertions(+), 1 deletion(-)
Documentation/tools/rtla/Makefile +13 -1
@@ -17,9 +17,21 @@ DOC_MAN1 = $(addprefix $(OUTPUT),$(_DOC_MAN1)) RST2MAN_DEP := $(shell command -v rst2man 2>/dev/null) RST2MAN_OPTS += --verbose +TEST_RST2MAN = $(shell sh -c "rst2man --version > /dev/null 2>&1 || echo n") + $(OUTPUT)%.1: %.rst ifndef RST2MAN_DEP - $(error "rst2man not found, but required to generate man pages") + $(info ********************************************) + $(info ** NOTICE: rst2man not found) + $(info **) + $(info ** Consider installing the latest rst2man from your) + $(info ** distribution, e.g., 'dnf install python3-docutils' on Fedora,) + $(info ** or from source:) + $(info **) + $(info ** https://docutils.sourceforge.io/docs/dev/repository.html ) + $(info **) + $(info ********************************************) + $(error NOTICE: rst2man required to generate man pages) endif rst2man $(RST2MAN_OPTS) $< > $@
tools/tracing/rtla/Makefile +35 -0
@@ -57,6 +57,41 @@ else DOCSRC = $(SRCTREE)/../../../Documentation/tools/rtla/ endif +LIBTRACEEVENT_MIN_VERSION = 1.5 +LIBTRACEFS_MIN_VERSION = 1.3 + +TEST_LIBTRACEEVENT = $(shell sh -c "$(PKG_CONFIG) --atleast-version $(LIBTRACEEVENT_MIN_VERSION) libtraceevent > /dev/null 2>&1 || echo n") +ifeq ("$(TEST_LIBTRACEEVENT)", "n") +.PHONY: warning_traceevent +warning_traceevent: + @echo "********************************************" + @echo "** NOTICE: libtraceevent version $(LIBTRACEEVENT_MIN_VERSION) or higher not found" + @echo "**" + @echo "** Consider installing the latest libtraceevent from your" + @echo "** distribution, e.g., 'dnf install libtraceevent' on Fedora," + @echo "** or from source:" + @echo "**" + @echo "** https://git.kernel.org/pub/scm/libs/libtrace/libtraceevent.git/ " + @echo "**" + @echo "********************************************" +endif + +TEST_LIBTRACEFS = $(shell sh -c "$(PKG_CONFIG) --atleast-version $(LIBTRACEFS_MIN_VERSION) libtracefs > /dev/null 2>&1 || echo n") +ifeq ("$(TEST_LIBTRACEFS)", "n") +.PHONY: warning_tracefs +warning_tracefs: + @echo "********************************************" + @echo "** NOTICE: libtracefs version $(LIBTRACEFS_MIN_VERSION) or higher not found" + @echo "**" + @echo "** Consider installing the latest libtracefs from your" + @echo "** distribution, e.g., 'dnf install libtracefs' on Fedora," + @echo "** or from source:" + @echo "**" + @echo "** https://git.kernel.org/pub/scm/libs/libtrace/libtracefs.git/ " + @echo "**" + @echo "********************************************" +endif + .PHONY: all all: rtla
Signature · 1 line
2.35.1
Steven Rostedt
maintainerPATCH 6/6 rtla: Remove procps-ng dependency
In reply to Steven RostedtFrom: Daniel Bristot de Oliveira <[email protected]>
Daniel Wagner reported to me that readproc.h got deprecated. Also, while the procps-ng library was available on Fedora, it was not available on RHEL, which is a piece of evidence that it was not that used.
rtla uses procps-ng only to find the PID of the tracers' workload.
I used the procps-ng library to avoid reinventing the wheel. But in this case, reinventing the wheel took me less time than the time we already took trying to work around problems.
Implement a function that reads /proc/ entries, checking if:
- the entry is a directory
- the directory name is composed only of digits (PID)
- the directory contains the comm file
- the comm file contains a comm that matches the tracers' workload prefix.
- then return true; otherwise, return false.
And use it instead of procps-ng.
--- tools/tracing/rtla/Makefile | 2 +- tools/tracing/rtla/README.txt | 1 - tools/tracing/rtla/src/utils.c | 106 ++++++++++++++++++++++++++------- tools/tracing/rtla/src/utils.h | 3 +- 4 files changed, 88 insertions(+), 24 deletions(-)
tools/tracing/rtla/Makefile +1 -1
@@ -32,7 +32,7 @@ TRACEFS_HEADERS := $$($(PKG_CONFIG) --cflags libtracefs) CFLAGS := -O -g -DVERSION=\"$(VERSION)\" $(FOPTS) $(MOPTS) $(WOPTS) $(TRACEFS_HEADERS) LDFLAGS := -ggdb -LIBS := $$($(PKG_CONFIG) --libs libtracefs) -lprocps +LIBS := $$($(PKG_CONFIG) --libs libtracefs) SRC := $(wildcard src/*.c) HDR := $(wildcard src/*.h)
tools/tracing/rtla/README.txt +0 -1
@@ -11,7 +11,6 @@ RTLA depends on the following libraries and tools: - libtracefs - libtraceevent - - procps It also depends on python3-docutils to compile man pages.
tools/tracing/rtla/src/utils.c +85 -21
135 lines not on this page · raw message
tools/tracing/rtla/src/utils.h +2 -1
@@ -6,6 +6,7 @@* '18446744073709551615\0' */ #define BUFF_U64_STR_SIZE 24 +#define MAX_PATH 1024#define container_of (ptr, type, member)({ \ const typeof(((type *)0)->member) *__mptr = (ptr); \
@@ -53,5 +54,5 @@ struct sched_attr { };int parse_prio (char *arg,struct sched_attr *sched_param); -int set_comm_sched_attr (const char *comm,struct sched_attr *attr); +int set_comm_sched_attr (const char *comm_prefix,struct sched_attr *attr);int set_cpu_dma_latency (int32_t latency);
Signature · 1 line
2.35.1