56 lines · plain
1===============================2The Linux Kernel Tracepoint API3===============================4 5:Author: Jason Baron6:Author: William Cohen7 8Introduction9============10 11Tracepoints are static probe points that are located in strategic points12throughout the kernel. 'Probes' register/unregister with tracepoints via13a callback mechanism. The 'probes' are strictly typed functions that are14passed a unique set of parameters defined by each tracepoint.15 16From this simple callback mechanism, 'probes' can be used to profile,17debug, and understand kernel behavior. There are a number of tools that18provide a framework for using 'probes'. These tools include Systemtap,19ftrace, and LTTng.20 21Tracepoints are defined in a number of header files via various macros.22Thus, the purpose of this document is to provide a clear accounting of23the available tracepoints. The intention is to understand not only what24tracepoints are available but also to understand where future25tracepoints might be added.26 27The API presented has functions of the form:28``trace_tracepointname(function parameters)``. These are the tracepoints29callbacks that are found throughout the code. Registering and30unregistering probes with these callback sites is covered in the31``Documentation/trace/*`` directory.32 33IRQ34===35 36.. kernel-doc:: include/trace/events/irq.h37 :internal:38 39SIGNAL40======41 42.. kernel-doc:: include/trace/events/signal.h43 :internal:44 45Block IO46========47 48.. kernel-doc:: include/trace/events/block.h49 :internal:50 51Workqueue52=========53 54.. kernel-doc:: include/trace/events/workqueue.h55 :internal:56