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

   1 libtraceevent(3)
   2 ================
   3
   4 NAME
   5 ----
   6 tep_is_file_bigendian, tep_set_file_bigendian - Get / set the endianness of the
   7 raw data being accessed by the tep handler.
   8
   9 SYNOPSIS
  10 --------
  11 [verse]
  12 --
  13 *#include <event-parse.h>*
  14
  15 enum *tep_endian* {
  16         TEP_LITTLE_ENDIAN = 0,
  17         TEP_BIG_ENDIAN
  18 };
  19
  20 bool *tep_is_file_bigendian*(struct tep_handle pass:[*]_tep_);
  21 void *tep_set_file_bigendian*(struct tep_handle pass:[*]_tep_, enum tep_endian _endian_);
  22
  23 --
  24 DESCRIPTION
  25 -----------
  26 The _tep_is_file_bigendian()_ function gets the endianness of the raw data,
  27 being accessed by the tep handler. The _tep_ argument is trace event parser
  28 context.
  29
  30 The _tep_set_file_bigendian()_ function sets the endianness of raw data being
  31 accessed by the tep handler. The _tep_ argument is trace event parser context.
  32 [verse]
  33 --
  34 The _endian_ argument is the endianness:
  35         _TEP_LITTLE_ENDIAN_ - the raw data is in little endian format,
  36         _TEP_BIG_ENDIAN_ - the raw data is in big endian format.
  37 --
  38 RETURN VALUE
  39 ------------
  40 The _tep_is_file_bigendian()_ function returns true if the data is in bigendian
  41 format, false otherwise.
  42
  43 EXAMPLE
  44 -------
  45 [source,c]
  46 --
  47 #include <event-parse.h>
  48 ...
  49 struct tep_handle *tep = tep_alloc();
  50 ...
  51         tep_set_file_bigendian(tep, TEP_LITTLE_ENDIAN);
  52 ...
  53         if (tep_is_file_bigendian(tep)) {
  54                 /* The raw data is in big endian */
  55         } else {
  56                 /* The raw data is in little endian */
  57         }
  58 --
  59
  60 FILES
  61 -----
  62 [verse]
  63 --
  64 *event-parse.h*
  65         Header file to include in order to have access to the library APIs.
  66 *-ltraceevent*
  67         Linker switch to add when building a program that uses the library.
  68 --
  69
  70 SEE ALSO
  71 --------
  72 _libtraceevent(3)_, _trace-cmd(1)_
  73
  74 AUTHOR
  75 ------
  76 [verse]
  77 --
  78 *Steven Rostedt* <rostedt@goodmis.org>, author of *libtraceevent*.
  79 *Tzvetomir Stoyanov* <tz.stoyanov@gmail.com>, author of this man page.
  80 --
  81 REPORTING BUGS
  82 --------------
  83 Report bugs to  <linux-trace-devel@vger.kernel.org>
  84
  85 LICENSE
  86 -------
  87 libtraceevent is Free Software licensed under the GNU LGPL 2.1
  88
  89 RESOURCES
  90 ---------
  91 https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git