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-writer/event-fields.h>
  31 #include <babeltrace/object-internal.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_object base;
  38         struct bt_ctf_field_type *type;
  39         int payload_set;
  40         int frozen;
  41 };
  42
  43 struct bt_ctf_field_integer {
  44         struct bt_ctf_field parent;
  45         struct definition_integer definition;
  46 };
  47
  48 struct bt_ctf_field_enumeration {
  49         struct bt_ctf_field parent;
  50         struct bt_ctf_field *payload;
  51 };
  52
  53 struct bt_ctf_field_floating_point {
  54         struct bt_ctf_field parent;
  55         struct definition_float definition;
  56         struct definition_integer sign, mantissa, exp;
  57 };
  58
  59 struct bt_ctf_field_structure {
  60         struct bt_ctf_field parent;
  61         GHashTable *field_name_to_index;
  62         GPtrArray *fields; /* Array of pointers to struct bt_ctf_field */
  63 };
  64
  65 struct bt_ctf_field_variant {
  66         struct bt_ctf_field parent;
  67         struct bt_ctf_field *tag;
  68         struct bt_ctf_field *payload;
  69 };
  70
  71 struct bt_ctf_field_array {
  72         struct bt_ctf_field parent;
  73         GPtrArray *elements; /* Array of pointers to struct bt_ctf_field */
  74 };
  75
  76 struct bt_ctf_field_sequence {
  77         struct bt_ctf_field parent;
  78         struct bt_ctf_field *length;
  79         GPtrArray *elements; /* Array of pointers to struct bt_ctf_field */
  80 };
  81
  82 struct bt_ctf_field_string {
  83         struct bt_ctf_field parent;
  84         GString *payload;
  85 };
  86
  87 /*
  88  * Set a field's value with an already allocated field instance.
  89  */
  90 BT_HIDDEN
  91 int bt_ctf_field_structure_set_field(struct bt_ctf_field *structure,
  92                 const char *name, struct bt_ctf_field *value);
  93
  94 /* Validate that the field's payload is set (returns 0 if set). */
  95 BT_HIDDEN
  96 int bt_ctf_field_validate(struct bt_ctf_field *field);
  97
  98 /* Mark field payload as unset. */
  99 BT_HIDDEN
 100 int bt_ctf_field_reset(struct bt_ctf_field *field);
 101
 102 BT_HIDDEN
 103 int bt_ctf_field_serialize(struct bt_ctf_field *field,
 104                 struct ctf_stream_pos *pos);
 105
 106 BT_HIDDEN
 107 void bt_ctf_field_freeze(struct bt_ctf_field *field);
 108
 109 #endif /* BABELTRACE_CTF_IR_FIELDS_INTERNAL_H */