1libtraceevent(3) 2================ 3 4NAME 5---- 6tep_alloc, tep_free,tep_ref, tep_unref,tep_get_ref - Create, destroy, manage 7references of trace event parser context. 8 9SYNOPSIS 10-------- 11[verse] 12-- 13*#include <event-parse.h>* 14 15struct tep_handle pass:[*]*tep_alloc*(void); 16void *tep_free*(struct tep_handle pass:[*]_tep_); 17void *tep_ref*(struct tep_handle pass:[*]_tep_); 18void *tep_unref*(struct tep_handle pass:[*]_tep_); 19int *tep_get_ref*(struct tep_handle pass:[*]_tep_); 20-- 21 22DESCRIPTION 23----------- 24These are the main functions to create and destroy tep_handle - the main 25structure, representing the trace event parser context. This context is used as 26the input parameter of most library APIs. 27 28The _tep_alloc()_ function allocates and initializes the tep context. 29 30The _tep_free()_ function will decrement the reference of the _tep_ handler. 31When there is no more references, then it will free the handler, as well 32as clean up all its resources that it had used. The argument _tep_ is 33the pointer to the trace event parser context. 34 35The _tep_ref()_ function adds a reference to the _tep_ handler. 36 37The _tep_unref()_ function removes a reference from the _tep_ handler. When 38the last reference is removed, the _tep_ is destroyed, and all resources that 39it had used are cleaned up. 40 41The _tep_ref_get()_ functions gets the current references of the _tep_ handler. 42 43RETURN VALUE 44------------ 45_tep_alloc()_ returns a pointer to a newly created tep_handle structure. 46NULL is returned in case there is not enough free memory to allocate it. 47 48_tep_ref_get()_ returns the current references of _tep_. 49If _tep_ is NULL, 0 is returned. 50 51EXAMPLE 52------- 53[source,c] 54-- 55#include <event-parse.h> 56 57... 58struct tep_handle *tep = tep_alloc(); 59... 60int ref = tep_get_ref(tep); 61tep_ref(tep); 62if ( (ref+1) != tep_get_ref(tep)) { 63 /* Something wrong happened, the counter is not incremented by 1 */ 64} 65tep_unref(tep); 66... 67tep_free(tep); 68... 69-- 70FILES 71----- 72[verse] 73-- 74*event-parse.h* 75 Header file to include in order to have access to the library APIs. 76*-ltraceevent* 77 Linker switch to add when building a program that uses the library. 78-- 79 80SEE ALSO 81-------- 82_libtraceevent(3)_, _trace-cmd(1)_ 83 84AUTHOR 85------ 86[verse] 87-- 88*Steven Rostedt* <rostedt@goodmis.org>, author of *libtraceevent*. 89*Tzvetomir Stoyanov* <tz.stoyanov@gmail.com>, author of this man page. 90-- 91REPORTING BUGS 92-------------- 93Report bugs to <linux-trace-devel@vger.kernel.org> 94 95LICENSE 96------- 97libtraceevent is Free Software licensed under the GNU LGPL 2.1 98 99RESOURCES 100--------- 101https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git 102