Commit 4d66020d authored by Linus Torvalds's avatar Linus Torvalds
Browse files

Merge tag 'trace-v5.17' of git://git.kernel.org/pub/scm/linux/kernel/git/rostedt/linux-trace 

Pull tracing updates from Steven Rostedt:
 "New:

   - The Real Time Linux Analysis (RTLA) tool is added to the tools
     directory.

   - Can safely filter on user space pointers with: field.ustring ~
     "match-string"

   - eprobes can now be filtered like any other event.

   - trace_marker(_raw) now uses stream_open() to allow multiple threads
     to safely write to it. Note, this could possibly break existing
     user space, but we will not know until we hear about it, and then
     can revert the change if need be.

   - New field in events to display when bottom halfs are disabled.

   - Sorting of the ftrace functions are now done at compile time
     instead of at bootup.

  Infrastructure changes to support future efforts:

   - Added __rel_loc type for trace events. Similar to __data_loc but
     the offset to the dynamic data is based off of the location of the
     descriptor and not the beginning of the event. Needed for user
     defined events.

   - Some simplification of event trigger code.

   - Make synthetic events process its callback better to not hinder
     other event callbacks that are registered. Needed for user defined
     events.

  And other small fixes and cleanups"

* tag 'trace-v5.17' of git://git.kernel.org/pub/scm/linux/kernel/git/rostedt/linux-trace: (50 commits)
  tracing: Add ustring operation to filtering string pointers
  rtla: Add rtla timerlat hist documentation
  rtla: Add rtla timerlat top documentation
  rtla: Add rtla timerlat documentation
  rtla: Add rtla osnoise hist documentation
  rtla: Add rtla osnoise top documentation
  rtla: Add rtla osnoise man page
  rtla: Add Documentation
  rtla/timerlat: Add timerlat hist mode
  rtla: Add timerlat tool and timelart top mode
  rtla/osnoise: Add the hist mode
  rtla/osnoise: Add osnoise top mode
  rtla: Add osnoise tool
  rtla: Helper functions for rtla
  rtla: Real-Time Linux Analysis tool
  tracing/osnoise: Properly unhook events if start_per_cpu_kthreads() fails
  tracing: Remove duplicate warnings when calling trace_create_file()
  tracing/kprobes: 'nmissed' not showed correctly for kretprobe
  tracing: Add test for user space strings when filtering on string pointers
  tracing: Have syscall trace events use trace_event_buffer_lock_reserve()
  ...
parents 77dbd72b f37c3bbc

Documentation/tools/rtla/Makefile

0 → 100644
+41 −0
Original line number Diff line number Diff line 
# SPDX-License-Identifier: GPL-2.0-only

# Based on bpftool's Documentation Makefile



INSTALL		?= install

RM		?= rm -f

RMDIR		?= rmdir --ignore-fail-on-non-empty



PREFIX		?= /usr/share

MANDIR		?= $(PREFIX)/man

MAN1DIR		= $(MANDIR)/man1



MAN1_RST	= $(wildcard rtla*.rst)



_DOC_MAN1	= $(patsubst %.rst,%.1,$(MAN1_RST))

DOC_MAN1	= $(addprefix $(OUTPUT),$(_DOC_MAN1))



RST2MAN_DEP	:= $(shell command -v rst2man 2>/dev/null)

RST2MAN_OPTS	+= --verbose



$(OUTPUT)%.1: %.rst

ifndef RST2MAN_DEP

	$(error "rst2man not found, but required to generate man pages")

endif

	rst2man $(RST2MAN_OPTS) $< > $@



man1: $(DOC_MAN1)

man: man1



clean:

	$(RM) $(DOC_MAN1)



install: man

	$(INSTALL) -d -m 755 $(DESTDIR)$(MAN1DIR)

	$(INSTALL) -m 644 $(DOC_MAN1) $(DESTDIR)$(MAN1DIR)



uninstall:

	$(RM) $(addprefix $(DESTDIR)$(MAN1DIR)/,$(_DOC_MAN1))

	$(RMDIR) $(DESTDIR)$(MAN1DIR)



.PHONY: man man1 clean install uninstall

.DEFAULT_GOAL := man

Documentation/tools/rtla/common_appendix.rst

0 → 100644
+12 −0
Original line number Diff line number Diff line 
REPORTING BUGS

==============

Report bugs to <lkml@vger.kernel.org>



LICENSE

=======

**rtla** is Free Software licensed under the GNU GPLv2



COPYING

=======

Copyright \(C) 2021 Red Hat, Inc. Free use of this software is granted under

the terms of the GNU Public License (GPL).

Documentation/tools/rtla/common_hist_options.rst

0 → 100644
+23 −0
Original line number Diff line number Diff line 
**-b**, **--bucket-size** *N*



        Set the histogram bucket size (default *1*).



**-e**, **--entries** *N*



        Set the number of entries of the histogram (default 256).



**--no-header**



        Do not print header.



**--no-summary**



        Do not print summary.



**--no-index**



        Do not print index.



**--with-zeros**



        Print zero only entries.

Documentation/tools/rtla/common_options.rst

0 → 100644
+28 −0
Original line number Diff line number Diff line 
**-c**, **--cpus** *cpu-list*



        Set the osnoise tracer to run the sample threads in the cpu-list.



**-d**, **--duration** *time[s|m|h|d]*



        Set the duration of the session.



**-D**, **--debug**



        Print debug info.



**-t**, **--trace**\[*=file*]



        Save the stopped trace to [*file|osnoise_trace.txt*].



**-P**, **--priority** *o:prio|r:prio|f:prio|d:runtime:period*



        Set scheduling parameters to the osnoise tracer threads, the format to set the priority are:



        - *o:prio* - use SCHED_OTHER with *prio*;

        - *r:prio* - use SCHED_RR with *prio*;

        - *f:prio* - use SCHED_FIFO with *prio*;

        - *d:runtime[us|ms|s]:period[us|ms|s]* - use SCHED_DEADLINE with *runtime* and *period* in nanoseconds.



**-h**, **--help**



        Print help menu.

Documentation/tools/rtla/common_osnoise_description.rst

0 → 100644
+8 −0
Original line number Diff line number Diff line 
The **rtla osnoise** tool is an interface for the *osnoise* tracer. The

*osnoise* tracer dispatches a kernel thread per-cpu. These threads read the

time in a loop while with preemption, softirq and IRQs enabled, thus

allowing all the sources of operating systme noise during its execution.

The *osnoise*'s tracer threads take note of the delta between each time

read, along with an interference counter of all sources of interference.

At the end of each period, the *osnoise* tracer displays a summary of

the results.