tools/lib/traceevent/Documentation/libtraceevent-handle.txt

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