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 <babeltrace/types.h>
  35 #include <stdint.h>
  36 #include <stdbool.h>
  37 #include <glib.h>
  38
  39 struct bt_ctf_stream_pos;
  40
  41 struct bt_ctf_field {
  42         struct bt_object base;
  43         struct bt_ctf_field_type *type;
  44         bool payload_set;
  45         bool frozen;
  46 };
  47
  48 struct bt_ctf_field_integer {
  49         struct bt_ctf_field parent;
  50         union {
  51                 int64_t signd;
  52                 uint64_t unsignd;
  53         } payload;
  54 };
  55
  56 struct bt_ctf_field_enumeration {
  57         struct bt_ctf_field parent;
  58         struct bt_ctf_field *payload;
  59 };
  60
  61 struct bt_ctf_field_floating_point {
  62         struct bt_ctf_field parent;
  63         double payload;
  64 };
  65
  66 struct bt_ctf_field_structure {
  67         struct bt_ctf_field parent;
  68         GPtrArray *fields; /* Array of pointers to struct bt_ctf_field */
  69 };
  70
  71 struct bt_ctf_field_variant {
  72         struct bt_ctf_field parent;
  73         struct bt_ctf_field *tag;
  74         struct bt_ctf_field *payload;
  75 };
  76
  77 struct bt_ctf_field_array {
  78         struct bt_ctf_field parent;
  79         GPtrArray *elements; /* Array of pointers to struct bt_ctf_field */
  80 };
  81
  82 struct bt_ctf_field_sequence {
  83         struct bt_ctf_field parent;
  84         struct bt_ctf_field *length;
  85         GPtrArray *elements; /* Array of pointers to struct bt_ctf_field */
  86 };
  87
  88 struct bt_ctf_field_string {
  89         struct bt_ctf_field parent;
  90         GString *payload;
  91 };
  92
  93 /* Validate that the field's payload is set (returns 0 if 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 bt_ctf_stream_pos *pos,
 104                 enum bt_ctf_byte_order native_byte_order);
 105
 106 BT_HIDDEN
 107 void bt_ctf_field_freeze(struct bt_ctf_field *field);
 108
 109 BT_HIDDEN
 110 bt_bool bt_ctf_field_is_set(struct bt_ctf_field *field);
 111
 112 #endif /* BABELTRACE_CTF_IR_FIELDS_INTERNAL_H */