include/babeltrace/ctf-text/types.h

   1 #ifndef _BABELTRACE_CTF_TEXT_TYPES_H
   2 #define _BABELTRACE_CTF_TEXT_TYPES_H
   3
   4 /*
   5  * Common Trace Format (Text Output)
   6  *
   7  * Type header
   8  *
   9  * Copyright 2010 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
  10  *
  11  * Permission is hereby granted, free of charge, to any person obtaining a copy
  12  * of this software and associated documentation files (the "Software"), to deal
  13  * in the Software without restriction, including without limitation the rights
  14  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  15  * copies of the Software, and to permit persons to whom the Software is
  16  * furnished to do so, subject to the following conditions:
  17  *
  18  * The above copyright notice and this permission notice shall be included in
  19  * all copies or substantial portions of the Software.
  20  *
  21  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  22  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  23  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  24  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  25  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  26  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  27  * SOFTWARE.
  28  */
  29
  30 #include <sys/mman.h>
  31 #include <errno.h>
  32 #include <stdint.h>
  33 #include <unistd.h>
  34 #include <glib.h>
  35 #include <babeltrace/babeltrace-internal.h>
  36 #include <babeltrace/types.h>
  37 #include <babeltrace/format.h>
  38
  39 /*
  40  * Inherit from both struct bt_stream_pos and struct bt_trace_descriptor.
  41  */
  42 struct ctf_text_stream_pos {
  43         struct bt_stream_pos parent;
  44         struct bt_trace_descriptor trace_descriptor;
  45         FILE *fp;               /* File pointer. NULL if unset. */
  46         int depth;
  47         int dummy;              /* disable output */
  48         int print_names;        /* print field names */
  49         int field_nr;
  50         uint64_t last_real_timestamp;   /* to print delta */
  51         uint64_t last_cycles_timestamp; /* to print delta */
  52         GString *string;        /* Current string */
  53 };
  54
  55 static inline
  56 struct ctf_text_stream_pos *ctf_text_pos(struct bt_stream_pos *pos)
  57 {
  58         return container_of(pos, struct ctf_text_stream_pos, parent);
  59 }
  60
  61 /*
  62  * Write only is supported for now.
  63  */
  64 BT_HIDDEN
  65 int ctf_text_integer_write(struct bt_stream_pos *pos, struct definition *definition);
  66 BT_HIDDEN
  67 int ctf_text_float_write(struct bt_stream_pos *pos, struct definition *definition);
  68 BT_HIDDEN
  69 int ctf_text_string_write(struct bt_stream_pos *pos, struct definition *definition);
  70 BT_HIDDEN
  71 int ctf_text_enum_write(struct bt_stream_pos *pos, struct definition *definition);
  72 BT_HIDDEN
  73 int ctf_text_struct_write(struct bt_stream_pos *pos, struct definition *definition);
  74 BT_HIDDEN
  75 int ctf_text_variant_write(struct bt_stream_pos *pos, struct definition *definition);
  76 BT_HIDDEN
  77 int ctf_text_array_write(struct bt_stream_pos *pos, struct definition *definition);
  78 BT_HIDDEN
  79 int ctf_text_sequence_write(struct bt_stream_pos *pos, struct definition *definition);
  80
  81 static inline
  82 void print_pos_tabs(struct ctf_text_stream_pos *pos)
  83 {
  84         int i;
  85
  86         for (i = 0; i < pos->depth; i++)
  87                 fprintf(pos->fp, "\t");
  88 }
  89
  90 /*
  91  * Check if the field must be printed.
  92  */
  93 BT_HIDDEN
  94 int print_field(struct definition *definition);
  95
  96 #endif /* _BABELTRACE_CTF_TEXT_TYPES_H */