mirror of https://github.com/Qortal/Brooklyn
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
192 lines
11 KiB
192 lines
11 KiB
libtraceevent(3) |
|
================ |
|
|
|
NAME |
|
---- |
|
libtraceevent - Linux kernel trace event library |
|
|
|
SYNOPSIS |
|
-------- |
|
[verse] |
|
-- |
|
*#include <event-parse.h>* |
|
|
|
Management of tep handler data structure and access of its members: |
|
struct tep_handle pass:[*]*tep_alloc*(void); |
|
void *tep_free*(struct tep_handle pass:[*]_tep_); |
|
void *tep_ref*(struct tep_handle pass:[*]_tep_); |
|
void *tep_unref*(struct tep_handle pass:[*]_tep_); |
|
int *tep_get_ref*(struct tep_handle pass:[*]_tep_); |
|
void *tep_set_flag*(struct tep_handle pass:[*]_tep_, enum tep_flag _flag_); |
|
void *tep_clear_flag*(struct tep_handle pass:[*]_tep_, enum tep_flag _flag_); |
|
bool *tep_test_flag*(struct tep_handle pass:[*]_tep_, enum tep_flag _flags_); |
|
int *tep_get_cpus*(struct tep_handle pass:[*]_tep_); |
|
void *tep_set_cpus*(struct tep_handle pass:[*]_tep_, int _cpus_); |
|
int *tep_get_long_size*(strucqt tep_handle pass:[*]_tep_); |
|
void *tep_set_long_size*(struct tep_handle pass:[*]_tep_, int _long_size_); |
|
int *tep_get_page_size*(struct tep_handle pass:[*]_tep_); |
|
void *tep_set_page_size*(struct tep_handle pass:[*]_tep_, int _page_size_); |
|
int *tep_get_header_page_size*(struct tep_handle pass:[*]_tep_); |
|
int *tep_get_header_timestamp_size*(struct tep_handle pass:[*]_tep_); |
|
bool *tep_is_old_format*(struct tep_handle pass:[*]_tep_); |
|
int *tep_strerror*(struct tep_handle pass:[*]_tep_, enum tep_errno _errnum_, char pass:[*]_buf_, size_t _buflen_); |
|
|
|
Register / unregister APIs: |
|
int *tep_register_function*(struct tep_handle pass:[*]_tep_, char pass:[*]_name_, unsigned long long _addr_, char pass:[*]_mod_); |
|
int *tep_register_event_handler*(struct tep_handle pass:[*]_tep_, int _id_, const char pass:[*]_sys_name_, const char pass:[*]_event_name_, tep_event_handler_func _func_, void pass:[*]_context_); |
|
int *tep_unregister_event_handler*(struct tep_handle pass:[*]tep, int id, const char pass:[*]sys_name, const char pass:[*]event_name, tep_event_handler_func func, void pass:[*]_context_); |
|
int *tep_register_print_string*(struct tep_handle pass:[*]_tep_, const char pass:[*]_fmt_, unsigned long long _addr_); |
|
int *tep_register_print_function*(struct tep_handle pass:[*]_tep_, tep_func_handler _func_, enum tep_func_arg_type _ret_type_, char pass:[*]_name_, _..._); |
|
int *tep_unregister_print_function*(struct tep_handle pass:[*]_tep_, tep_func_handler _func_, char pass:[*]_name_); |
|
|
|
Plugins management: |
|
struct tep_plugin_list pass:[*]*tep_load_plugins*(struct tep_handle pass:[*]_tep_); |
|
void *tep_unload_plugins*(struct tep_plugin_list pass:[*]_plugin_list_, struct tep_handle pass:[*]_tep_); |
|
char pass:[*]pass:[*]*tep_plugin_list_options*(void); |
|
void *tep_plugin_free_options_list*(char pass:[*]pass:[*]_list_); |
|
int *tep_plugin_add_options*(const char pass:[*]_name_, struct tep_plugin_option pass:[*]_options_); |
|
void *tep_plugin_remove_options*(struct tep_plugin_option pass:[*]_options_); |
|
void *tep_print_plugins*(struct trace_seq pass:[*]_s_, const char pass:[*]_prefix_, const char pass:[*]_suffix_, const struct tep_plugin_list pass:[*]_list_); |
|
|
|
Event related APIs: |
|
struct tep_event pass:[*]*tep_get_event*(struct tep_handle pass:[*]_tep_, int _index_); |
|
struct tep_event pass:[*]*tep_get_first_event*(struct tep_handle pass:[*]_tep_); |
|
int *tep_get_events_count*(struct tep_handle pass:[*]_tep_); |
|
struct tep_event pass:[*]pass:[*]*tep_list_events*(struct tep_handle pass:[*]_tep_, enum tep_event_sort_type _sort_type_); |
|
struct tep_event pass:[*]pass:[*]*tep_list_events_copy*(struct tep_handle pass:[*]_tep_, enum tep_event_sort_type _sort_type_); |
|
void *tep_print_event*(struct tep_handle pass:[*]_tep_, struct trace_seq pass:[*]_s_, struct tep_record pass:[*]_record_, const char pass:[*]_fmt_, _..._); |
|
|
|
Event finding: |
|
struct tep_event pass:[*]*tep_find_event*(struct tep_handle pass:[*]_tep_, int _id_); |
|
struct tep_event pass:[*]*tep_find_event_by_name*(struct tep_handle pass:[*]_tep_, const char pass:[*]_sys_, const char pass:[*]_name_); |
|
struct tep_event pass:[*]*tep_find_event_by_record*(struct tep_handle pass:[*]_tep_, struct tep_record pass:[*]_record_); |
|
|
|
Parsing of event files: |
|
int *tep_parse_header_page*(struct tep_handle pass:[*]_tep_, char pass:[*]_buf_, unsigned long _size_, int _long_size_); |
|
enum tep_errno *tep_parse_event*(struct tep_handle pass:[*]_tep_, const char pass:[*]_buf_, unsigned long _size_, const char pass:[*]_sys_); |
|
enum tep_errno *tep_parse_format*(struct tep_handle pass:[*]_tep_, struct tep_event pass:[*]pass:[*]_eventp_, const char pass:[*]_buf_, unsigned long _size_, const char pass:[*]_sys_); |
|
|
|
APIs related to fields from event's format files: |
|
struct tep_format_field pass:[*]pass:[*]*tep_event_common_fields*(struct tep_event pass:[*]_event_); |
|
struct tep_format_field pass:[*]pass:[*]*tep_event_fields*(struct tep_event pass:[*]_event_); |
|
void pass:[*]*tep_get_field_raw*(struct trace_seq pass:[*]_s_, struct tep_event pass:[*]_event_, const char pass:[*]_name_, struct tep_record pass:[*]_record_, int pass:[*]_len_, int _err_); |
|
int *tep_get_field_val*(struct trace_seq pass:[*]_s_, struct tep_event pass:[*]_event_, const char pass:[*]_name_, struct tep_record pass:[*]_record_, unsigned long long pass:[*]_val_, int _err_); |
|
int *tep_get_common_field_val*(struct trace_seq pass:[*]_s_, struct tep_event pass:[*]_event_, const char pass:[*]_name_, struct tep_record pass:[*]_record_, unsigned long long pass:[*]_val_, int _err_); |
|
int *tep_get_any_field_val*(struct trace_seq pass:[*]_s_, struct tep_event pass:[*]_event_, const char pass:[*]_name_, struct tep_record pass:[*]_record_, unsigned long long pass:[*]_val_, int _err_); |
|
int *tep_read_number_field*(struct tep_format_field pass:[*]_field_, const void pass:[*]_data_, unsigned long long pass:[*]_value_); |
|
|
|
Event fields printing: |
|
void *tep_print_field*(struct trace_seq pass:[*]_s_, void pass:[*]_data_, struct tep_format_field pass:[*]_field_); |
|
void *tep_print_fields*(struct trace_seq pass:[*]_s_, void pass:[*]_data_, int _size_, struct tep_event pass:[*]_event_); |
|
int *tep_print_num_field*(struct trace_seq pass:[*]_s_, const char pass:[*]_fmt_, struct tep_event pass:[*]_event_, const char pass:[*]_name_, struct tep_record pass:[*]_record_, int _err_); |
|
int *tep_print_func_field*(struct trace_seq pass:[*]_s_, const char pass:[*]_fmt_, struct tep_event pass:[*]_event_, const char pass:[*]_name_, struct tep_record pass:[*]_record_, int _err_); |
|
|
|
Event fields finding: |
|
struct tep_format_field pass:[*]*tep_find_common_field*(struct tep_event pass:[*]_event_, const char pass:[*]_name_); |
|
struct tep_format_field pass:[*]*tep_find_field*(struct tep_event_ormat pass:[*]_event_, const char pass:[*]_name_); |
|
struct tep_format_field pass:[*]*tep_find_any_field*(struct tep_event pass:[*]_event_, const char pass:[*]_name_); |
|
|
|
Functions resolver: |
|
int *tep_set_function_resolver*(struct tep_handle pass:[*]_tep_, tep_func_resolver_t pass:[*]_func_, void pass:[*]_priv_); |
|
void *tep_reset_function_resolver*(struct tep_handle pass:[*]_tep_); |
|
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_); |
|
|
|
Filter management: |
|
struct tep_event_filter pass:[*]*tep_filter_alloc*(struct tep_handle pass:[*]_tep_); |
|
enum tep_errno *tep_filter_add_filter_str*(struct tep_event_filter pass:[*]_filter_, const char pass:[*]_filter_str_); |
|
enum tep_errno *tep_filter_match*(struct tep_event_filter pass:[*]_filter_, struct tep_record pass:[*]_record_); |
|
int *tep_filter_strerror*(struct tep_event_filter pass:[*]_filter_, enum tep_errno _err_, char pass:[*]buf, size_t _buflen_); |
|
int *tep_event_filtered*(struct tep_event_filter pass:[*]_filter_, int _event_id_); |
|
void *tep_filter_reset*(struct tep_event_filter pass:[*]_filter_); |
|
void *tep_filter_free*(struct tep_event_filter pass:[*]_filter_); |
|
char pass:[*]*tep_filter_make_string*(struct tep_event_filter pass:[*]_filter_, int _event_id_); |
|
int *tep_filter_remove_event*(struct tep_event_filter pass:[*]_filter_, int _event_id_); |
|
int *tep_filter_copy*(struct tep_event_filter pass:[*]_dest_, struct tep_event_filter pass:[*]_source_); |
|
int *tep_filter_compare*(struct tep_event_filter pass:[*]_filter1_, struct tep_event_filter pass:[*]_filter2_); |
|
|
|
Parsing various data from the records: |
|
int *tep_data_type*(struct tep_handle pass:[*]_tep_, struct tep_record pass:[*]_rec_); |
|
int *tep_data_pid*(struct tep_handle pass:[*]_tep_, struct tep_record pass:[*]_rec_); |
|
int *tep_data_preempt_count*(struct tep_handle pass:[*]_tep_, struct tep_record pass:[*]_rec_); |
|
int *tep_data_flags*(struct tep_handle pass:[*]_tep_, struct tep_record pass:[*]_rec_); |
|
|
|
Command and task related APIs: |
|
const char pass:[*]*tep_data_comm_from_pid*(struct tep_handle pass:[*]_tep_, int _pid_); |
|
struct cmdline pass:[*]*tep_data_pid_from_comm*(struct tep_handle pass:[*]_tep_, const char pass:[*]_comm_, struct cmdline pass:[*]_next_); |
|
int *tep_register_comm*(struct tep_handle pass:[*]_tep_, const char pass:[*]_comm_, int _pid_); |
|
int *tep_override_comm*(struct tep_handle pass:[*]_tep_, const char pass:[*]_comm_, int _pid_); |
|
bool *tep_is_pid_registered*(struct tep_handle pass:[*]_tep_, int _pid_); |
|
int *tep_cmdline_pid*(struct tep_handle pass:[*]_tep_, struct cmdline pass:[*]_cmdline_); |
|
|
|
Endian related APIs: |
|
int *tep_is_bigendian*(void); |
|
unsigned long long *tep_read_number*(struct tep_handle pass:[*]_tep_, const void pass:[*]_ptr_, int _size_); |
|
bool *tep_is_file_bigendian*(struct tep_handle pass:[*]_tep_); |
|
void *tep_set_file_bigendian*(struct tep_handle pass:[*]_tep_, enum tep_endian _endian_); |
|
bool *tep_is_local_bigendian*(struct tep_handle pass:[*]_tep_); |
|
void *tep_set_local_bigendian*(struct tep_handle pass:[*]_tep_, enum tep_endian _endian_); |
|
|
|
Trace sequences: |
|
*#include <trace-seq.h>* |
|
void *trace_seq_init*(struct trace_seq pass:[*]_s_); |
|
void *trace_seq_reset*(struct trace_seq pass:[*]_s_); |
|
void *trace_seq_destroy*(struct trace_seq pass:[*]_s_); |
|
int *trace_seq_printf*(struct trace_seq pass:[*]_s_, const char pass:[*]_fmt_, ...); |
|
int *trace_seq_vprintf*(struct trace_seq pass:[*]_s_, const char pass:[*]_fmt_, va_list _args_); |
|
int *trace_seq_puts*(struct trace_seq pass:[*]_s_, const char pass:[*]_str_); |
|
int *trace_seq_putc*(struct trace_seq pass:[*]_s_, unsigned char _c_); |
|
void *trace_seq_terminate*(struct trace_seq pass:[*]_s_); |
|
int *trace_seq_do_fprintf*(struct trace_seq pass:[*]_s_, FILE pass:[*]_fp_); |
|
int *trace_seq_do_printf*(struct trace_seq pass:[*]_s_); |
|
-- |
|
|
|
DESCRIPTION |
|
----------- |
|
The libtraceevent(3) library provides APIs to access kernel tracepoint events, |
|
located in the tracefs file system under the events directory. |
|
|
|
ENVIRONMENT |
|
----------- |
|
[verse] |
|
-- |
|
TRACEEVENT_PLUGIN_DIR |
|
Additional plugin directory. All shared object files, located in this directory will be loaded as traceevent plugins. |
|
-- |
|
|
|
FILES |
|
----- |
|
[verse] |
|
-- |
|
*event-parse.h* |
|
Header file to include in order to have access to the library APIs. |
|
*trace-seq.h* |
|
Header file to include in order to have access to trace sequences related APIs. |
|
Trace sequences are used to allow a function to call several other functions |
|
to create a string of data to use. |
|
*-ltraceevent* |
|
Linker switch to add when building a program that uses the library. |
|
-- |
|
|
|
SEE ALSO |
|
-------- |
|
_trace-cmd(1)_ |
|
|
|
AUTHOR |
|
------ |
|
[verse] |
|
-- |
|
*Steven Rostedt* <[email protected]>, author of *libtraceevent*. |
|
*Tzvetomir Stoyanov* <[email protected]>, author of this man page. |
|
-- |
|
REPORTING BUGS |
|
-------------- |
|
Report bugs to <[email protected]> |
|
|
|
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
|
|
|