include/babeltrace/ctf-ir/fields-internal.h

   1 #ifndef BABELTRACE_CTF_IR_FIELDS_INTERNAL_H
   2 #define BABELTRACE_CTF_IR_FIELDS_INTERNAL_H
   3
   4 /*
   5  * Babeltrace - CTF IR: 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-ir/field-types.h>
  31 #include <babeltrace/ctf-writer/event-fields.h>
  32 #include <babeltrace/object-internal.h>
  33 #include <babeltrace/babeltrace-internal.h>
  34 #include <stdint.h>
  35 #include <glib.h>
  36
  37 struct bt_ctf_stream_pos;
  38
  39 struct bt_ctf_field {
  40         struct bt_object base;
  41         struct bt_ctf_field_type *type;
  42         int payload_set;
  43         int frozen;
  44 };
  45
  46 struct bt_ctf_field_integer {
  47         struct bt_ctf_field parent;
  48         union {
  49                 int64_t signd;
  50                 uint64_t unsignd;
  51         } payload;
  52 };
  53
  54 struct bt_ctf_field_enumeration {
  55         struct bt_ctf_field parent;
  56         struct bt_ctf_field *payload;
  57 };
  58
  59 struct bt_ctf_field_floating_point {
  60         struct bt_ctf_field parent;
  61         double payload;
  62 };
  63
  64 struct bt_ctf_field_structure {
  65         struct bt_ctf_field parent;
  66         GHashTable *field_name_to_index;
  67         GPtrArray *fields; /* Array of pointers to struct bt_ctf_field */
  68 };
  69
  70 struct bt_ctf_field_variant {
  71         struct bt_ctf_field parent;
  72         struct bt_ctf_field *tag;
  73         struct bt_ctf_field *payload;
  74 };
  75
  76 struct bt_ctf_field_array {
  77         struct bt_ctf_field parent;
  78         GPtrArray *elements; /* Array of pointers to struct bt_ctf_field */
  79 };
  80
  81 struct bt_ctf_field_sequence {
  82         struct bt_ctf_field parent;
  83         struct bt_ctf_field *length;
  84         GPtrArray *elements; /* Array of pointers to struct bt_ctf_field */
  85 };
  86
  87 struct bt_ctf_field_string {
  88         struct bt_ctf_field parent;
  89         GString *payload;
  90 };
  91
  92 /*
  93  * Set a field's value with an already allocated field instance.
  94  */
  95 BT_HIDDEN
  96 int bt_ctf_field_structure_set_field(struct bt_ctf_field *structure,
  97                 const char *name, struct bt_ctf_field *value);
  98
  99 /* Validate that the field's payload is set (returns 0 if set). */
 100 BT_HIDDEN
 101 int bt_ctf_field_validate(struct bt_ctf_field *field);
 102
 103 /* Mark field payload as unset. */
 104 BT_HIDDEN
 105 int bt_ctf_field_reset(struct bt_ctf_field *field);
 106
 107 BT_HIDDEN
 108 int bt_ctf_field_serialize(struct bt_ctf_field *field,
 109                 struct bt_ctf_stream_pos *pos,
 110                 enum bt_ctf_byte_order native_byte_order);
 111
 112 BT_HIDDEN
 113 void bt_ctf_field_freeze(struct bt_ctf_field *field);
 114
 115 BT_HIDDEN
 116 bool bt_ctf_field_is_set(struct bt_ctf_field *field);
 117
 118 #endif /* BABELTRACE_CTF_IR_FIELDS_INTERNAL_H */