Browse Source

Documentation: ftrace: clarify filters with dynamic ftrace and graph

I fell into the trap of having set up function tracer with a very
limited filter and then switched over to function_graph and was
erroneously wondering why the latter did not trace what I expected,
which was the full unabridged graph recursion.

Signed-off-by: Steffen Maier <maier@linux.ibm.com>
Reviewed-by: Steven Rostedt (VMware) <rostedt@goodmis.org>
Cc: Ingo Molnar <mingo@redhat.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Steffen Maier 7 years ago
parent
commit
32fb7ef69a
1 changed files with 6 additions and 1 deletions
  1. 6 1
      Documentation/trace/ftrace.rst

+ 6 - 1
Documentation/trace/ftrace.rst

@@ -224,6 +224,8 @@ of ftrace. Here is a list of some of the key files:
 	has a side effect of enabling or disabling specific functions
 	has a side effect of enabling or disabling specific functions
 	to be traced. Echoing names of functions into this file
 	to be traced. Echoing names of functions into this file
 	will limit the trace to only those functions.
 	will limit the trace to only those functions.
+	This influences the tracers "function" and "function_graph"
+	and thus also function profiling (see "function_profile_enabled").
 
 
 	The functions listed in "available_filter_functions" are what
 	The functions listed in "available_filter_functions" are what
 	can be written into this file.
 	can be written into this file.
@@ -265,6 +267,8 @@ of ftrace. Here is a list of some of the key files:
 	Functions listed in this file will cause the function graph
 	Functions listed in this file will cause the function graph
 	tracer to only trace these functions and the functions that
 	tracer to only trace these functions and the functions that
 	they call. (See the section "dynamic ftrace" for more details).
 	they call. (See the section "dynamic ftrace" for more details).
+	Note, set_ftrace_filter and set_ftrace_notrace still affects
+	what functions are being traced.
 
 
   set_graph_notrace:
   set_graph_notrace:
 
 
@@ -277,7 +281,8 @@ of ftrace. Here is a list of some of the key files:
 
 
 	This lists the functions that ftrace has processed and can trace.
 	This lists the functions that ftrace has processed and can trace.
 	These are the function names that you can pass to
 	These are the function names that you can pass to
-	"set_ftrace_filter" or "set_ftrace_notrace".
+	"set_ftrace_filter", "set_ftrace_notrace",
+	"set_graph_function", or "set_graph_notrace".
 	(See the section "dynamic ftrace" below for more details.)
 	(See the section "dynamic ftrace" below for more details.)
 
 
   dyn_ftrace_total_info:
   dyn_ftrace_total_info: