mirror of
https://github.com/torvalds/linux.git
synced 2024-12-26 04:42:12 +00:00
95ec2822a9
Create man page for libtraceevent API tep_read_number_field(). 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-21-tstoyanov@vmware.com Link: http://lkml.kernel.org/r/20190510200109.219394901@goodmis.org Signed-off-by: Steven Rostedt (VMware) <rostedt@goodmis.org> Signed-off-by: Arnaldo Carvalho de Melo <acme@redhat.com>
82 lines
1.8 KiB
Plaintext
82 lines
1.8 KiB
Plaintext
libtraceevent(3)
|
|
================
|
|
|
|
NAME
|
|
----
|
|
tep_read_number_field - Reads a number from raw data.
|
|
|
|
SYNOPSIS
|
|
--------
|
|
[verse]
|
|
--
|
|
*#include <event-parse.h>*
|
|
|
|
int *tep_read_number_field*(struct tep_format_field pass:[*]_field_, const void pass:[*]_data_, unsigned long long pass:[*]_value_);
|
|
--
|
|
|
|
DESCRIPTION
|
|
-----------
|
|
The _tep_read_number_field()_ function reads the value of the _field_ from the
|
|
raw _data_ and stores it in the _value_. The function sets the _value_ according
|
|
to the endianness of the raw data and the current machine and stores it in
|
|
_value_.
|
|
|
|
RETURN VALUE
|
|
------------
|
|
The _tep_read_number_field()_ function retunrs 0 in case of success, or -1 in
|
|
case of an error.
|
|
|
|
EXAMPLE
|
|
-------
|
|
[source,c]
|
|
--
|
|
#include <event-parse.h>
|
|
...
|
|
struct tep_handle *tep = tep_alloc();
|
|
...
|
|
struct tep_event *event = tep_find_event_by_name(tep, "timer", "hrtimer_start");
|
|
...
|
|
void process_record(struct tep_record *record)
|
|
{
|
|
unsigned long long pid;
|
|
struct tep_format_field *field_pid = tep_find_common_field(event, "common_pid");
|
|
|
|
if (tep_read_number_field(field_pid, record->data, &pid) != 0) {
|
|
/* Failed to get "common_pid" value */
|
|
}
|
|
}
|
|
...
|
|
--
|
|
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
|