mirror of
https://github.com/torvalds/linux.git
synced 2024-12-26 04:42:12 +00:00
c818e2dbe4
Added new man pages, describing function related libtraceevent APIs: tep_register_function(), tep_register_print_string(), tep_find_function(), tep_find_function_address(), tep_set_function_resolver(), tep_reset_function_resolver() Signed-off-by: Tzvetomir Stoyanov <tstoyanov@vmware.com> Cc: Andrew Morton <akpm@linux-foundation.org> Cc: Jiri Olsa <jolsa@redhat.com> Cc: Namhyung Kim <namhyung@kernel.org> Cc: linux-trace-devel@vger.kernel.org Link: http://lore.kernel.org/linux-trace-devel/20190503091119.23399-12-tstoyanov@vmware.com Link: http://lkml.kernel.org/r/20190510200107.701962205@goodmis.org Signed-off-by: Steven Rostedt (VMware) <rostedt@goodmis.org> Signed-off-by: Arnaldo Carvalho de Melo <acme@redhat.com>
89 lines
2.2 KiB
Plaintext
89 lines
2.2 KiB
Plaintext
libtraceevent(3)
|
|
================
|
|
|
|
NAME
|
|
----
|
|
tep_find_function,tep_find_function_address - Find function name / start address.
|
|
|
|
SYNOPSIS
|
|
--------
|
|
[verse]
|
|
--
|
|
*#include <event-parse.h>*
|
|
|
|
const char pass:[*]*tep_find_function*(struct tep_handle pass:[*]_tep_, unsigned long long _addr_);
|
|
unsigned long long *tep_find_function_address*(struct tep_handle pass:[*]_tep_, unsigned long long _addr_);
|
|
--
|
|
|
|
DESCRIPTION
|
|
-----------
|
|
These functions can be used to find function name and start address, by given
|
|
address. The given address does not have to be exact, it will select the function
|
|
that would contain it.
|
|
|
|
The _tep_find_function()_ function returns the function name, which contains the
|
|
given address _addr_. The _tep_ argument is the trace event parser context.
|
|
|
|
The _tep_find_function_address()_ function returns the function start address,
|
|
by given address _addr_. The _addr_ does not have to be exact, it will select the
|
|
function that would contain it. The _tep_ argument is the trace event parser context.
|
|
|
|
RETURN VALUE
|
|
------------
|
|
The _tep_find_function()_ function returns the function name, or NULL in case
|
|
it cannot be found.
|
|
|
|
The _tep_find_function_address()_ function returns the function start address,
|
|
or 0 in case it cannot be found.
|
|
|
|
EXAMPLE
|
|
-------
|
|
[source,c]
|
|
--
|
|
#include <event-parse.h>
|
|
...
|
|
struct tep_handle *tep = tep_alloc();
|
|
...
|
|
void show_function( unsigned long long addr)
|
|
{
|
|
const char *fname = tep_find_function(tep, addr);
|
|
unsigned long long fstart = tep_find_function_address(tep, addr);
|
|
|
|
/* addr is in function named fname, starting at fstart address, at offset (addr - fstart) */
|
|
}
|
|
...
|
|
--
|
|
|
|
FILES
|
|
-----
|
|
[verse]
|
|
--
|
|
*event-parse.h*
|
|
Header file to include in order to have access to the library APIs.
|
|
*-ltraceevent*
|
|
Linker switch to add when building a program that uses the library.
|
|
--
|
|
|
|
SEE ALSO
|
|
--------
|
|
_libtraceevent(3)_, _trace-cmd(1)_
|
|
|
|
AUTHOR
|
|
------
|
|
[verse]
|
|
--
|
|
*Steven Rostedt* <rostedt@goodmis.org>, author of *libtraceevent*.
|
|
*Tzvetomir Stoyanov* <tz.stoyanov@gmail.com>, author of this man page.
|
|
--
|
|
REPORTING BUGS
|
|
--------------
|
|
Report bugs to <linux-trace-devel@vger.kernel.org>
|
|
|
|
LICENSE
|
|
-------
|
|
libtraceevent is Free Software licensed under the GNU LGPL 2.1
|
|
|
|
RESOURCES
|
|
---------
|
|
https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
|