lib/babeltrace/ctf-ir/event-fields-internal.h

   1 #ifndef BABELTRACE_CTF_WRITER_EVENT_FIELDS_INTERNAL_H
   2 #define BABELTRACE_CTF_WRITER_EVENT_FIELDS_INTERNAL_H
   3
   4 /*
   5  * BabelTrace - CTF Writer: Event Fields internal
   6  *
   7  * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   8  *
   9  * Author: Jérémie Galarneau <jeremie.galarneau@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 <babeltrace/ctf-writer/ref-internal.h>
  31 #include <babeltrace/ctf-writer/event-fields.h>
  32 #include <babeltrace/babeltrace-internal.h>
  33 #include <babeltrace/ctf/types.h>
  34 #include <glib.h>
  35
  36 struct bt_ctf_field {
  37         struct bt_ctf_ref ref_count;
  38         struct bt_ctf_field_type *type;
  39         int payload_set;
  40 };
  41
  42 struct bt_ctf_field_integer {
  43         struct bt_ctf_field parent;
  44         struct definition_integer definition;
  45 };
  46
  47 struct bt_ctf_field_enumeration {
  48         struct bt_ctf_field parent;
  49         struct bt_ctf_field *payload;
  50 };
  51
  52 struct bt_ctf_field_floating_point {
  53         struct bt_ctf_field parent;
  54         struct definition_float definition;
  55         struct definition_integer sign, mantissa, exp;
  56 };
  57
  58 struct bt_ctf_field_structure {
  59         struct bt_ctf_field parent;
  60         GHashTable *field_name_to_index;
  61         GPtrArray *fields; /* Array of pointers to struct bt_ctf_field */
  62 };
  63
  64 struct bt_ctf_field_variant {
  65         struct bt_ctf_field parent;
  66         struct bt_ctf_field *tag;
  67         struct bt_ctf_field *payload;
  68 };
  69
  70 struct bt_ctf_field_array {
  71         struct bt_ctf_field parent;
  72         GPtrArray *elements; /* Array of pointers to struct bt_ctf_field */
  73 };
  74
  75 struct bt_ctf_field_sequence {
  76         struct bt_ctf_field parent;
  77         struct bt_ctf_field *length;
  78         GPtrArray *elements; /* Array of pointers to struct bt_ctf_field */
  79 };
  80
  81 struct bt_ctf_field_string {
  82         struct bt_ctf_field parent;
  83         GString *payload;
  84 };
  85
  86 /*
  87  * Set a field's value with an already allocated field instance.
  88  */
  89 BT_HIDDEN
  90 int bt_ctf_field_structure_set_field(struct bt_ctf_field *structure,
  91                 const char *name, struct bt_ctf_field *value);
  92
  93 /* Validate that the field's payload is set. */
  94 BT_HIDDEN
  95 int bt_ctf_field_validate(struct bt_ctf_field *field);
  96
  97 /* Mark field payload as unset. */
  98 BT_HIDDEN
  99 int bt_ctf_field_reset(struct bt_ctf_field *field);
 100
 101 BT_HIDDEN
 102 int bt_ctf_field_serialize(struct bt_ctf_field *field,
 103                 struct ctf_stream_pos *pos);
 104
 105 #endif /* BABELTRACE_CTF_WRITER_EVENT_FIELDS_INTERNAL_H */