Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit b3fdd1f9 authored by Changbin Du's avatar Changbin Du Committed by Jonathan Corbet
Browse files

trace doc: add ftrace-uses.rst to doc tree



Add ftrace-uses.rst into Sphinx TOC tree. Few format issues are fixed.

Cc: Steven Rostedt <rostedt@goodmis.org>
Signed-off-by: default avatarChangbin Du <changbin.du@intel.com>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent fcdeddc9
Loading
Loading
Loading
Loading
+12 −11
Original line number Diff line number Diff line
@@ -21,8 +21,9 @@ how to use ftrace to implement your own function callbacks.

The ftrace context
==================
.. warning::

WARNING: The ability to add a callback to almost any function within the
  The ability to add a callback to almost any function within the
  kernel comes with risks. A callback can be called from any context
  (normal, softirq, irq, and NMI). Callbacks can also be called just before
  going to idle, during CPU bring up and takedown, or going to user space.
@@ -54,15 +55,15 @@ an ftrace_ops with ftrace:

Both .flags and .private are optional. Only .func is required.

To enable tracing call::
To enable tracing call:

.. c:function::  register_ftrace_function(&ops);

To disable tracing call::
To disable tracing call:

.. c:function::  unregister_ftrace_function(&ops);

The above is defined by including the header::
The above is defined by including the header:

.. c:function:: #include <linux/ftrace.h>

@@ -200,7 +201,7 @@ match a specific pattern.

See Filter Commands in :file:`Documentation/trace/ftrace.txt`.

To just trace the schedule function::
To just trace the schedule function:

.. code-block:: c

@@ -210,7 +211,7 @@ To add more functions, call the ftrace_set_filter() more than once with the
@reset parameter set to zero. To remove the current filter set and replace it
with new functions defined by @buf, have @reset be non-zero.

To remove all the filtered functions and trace all functions::
To remove all the filtered functions and trace all functions:

.. code-block:: c

+1 −0
Original line number Diff line number Diff line
@@ -6,3 +6,4 @@ Linux Tracing Technologies
   :maxdepth: 2

   ftrace-design
   ftrace-uses