include/babeltrace/ctf-ir/fields.h

   1 #ifndef BABELTRACE_CTF_IR_FIELDS_H
   2 #define BABELTRACE_CTF_IR_FIELDS_H
   3
   4 /*
   5  * Babeltrace - CTF IR: Event Fields
   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  * The Common Trace Format (CTF) Specification is available at
  30  * http://www.efficios.com/ctf
  31  */
  32
  33 #include <stdint.h>
  34 #include <stddef.h>
  35
  36 #ifdef __cplusplus
  37 extern "C" {
  38 #endif
  39
  40 struct bt_ctf_event_class;
  41 struct bt_ctf_event;
  42 struct bt_ctf_field;
  43 struct bt_ctf_field_type;
  44
  45 /*
  46  * bt_ctf_field_create: create an instance of a field.
  47  *
  48  * Allocate a new field of the type described by the bt_ctf_field_type
  49  * structure.The creation of a field sets its reference count to 1.
  50  *
  51  * @param type Field type to be instanciated.
  52  *
  53  * Returns an allocated field on success, NULL on error.
  54  */
  55 extern struct bt_ctf_field *bt_ctf_field_create(
  56                 struct bt_ctf_field_type *type);
  57
  58 /*
  59  * bt_ctf_field_variant_get_field: get a variant's selected field.
  60  *
  61  * Return the variant's selected field. The "tag" field is the selector enum
  62  * field. bt_ctf_field_put() must be called on the returned value.
  63  *
  64  * @param variant Variant field instance.
  65  * @param tag Selector enumeration field.
  66  *
  67  * Returns a field instance on success, NULL on error.
  68  */
  69 extern struct bt_ctf_field *bt_ctf_field_variant_get_field(
  70                 struct bt_ctf_field *variant, struct bt_ctf_field *tag);
  71
  72 /*
  73  * bt_ctf_field_structure_get_field: get a structure's field.
  74  *
  75  * Get the structure's field corresponding to the provided field name.
  76  * bt_ctf_field_put() must be called on the returned value.
  77  *
  78  * @param structure Structure field instance.
  79  * @param name Name of the field in the provided structure.
  80  *
  81  * Returns a field instance on success, NULL on error.
  82  */
  83 extern struct bt_ctf_field *bt_ctf_field_structure_get_field(
  84                 struct bt_ctf_field *structure, const char *name);
  85
  86 /*
  87  * bt_ctf_field_array_get_field: get an array's field at position "index".
  88  *
  89  * Return the array's field at position "index". bt_ctf_field_put() must be
  90  * called on the returned value.
  91  *
  92  * @param array Array field instance.
  93  * @param index Position of the array's desired element.
  94  *
  95  * Returns a field instance on success, NULL on error.
  96  */
  97 extern struct bt_ctf_field *bt_ctf_field_array_get_field(
  98                 struct bt_ctf_field *array, uint64_t index);
  99
 100 /*
 101  * bt_ctf_field_sequence_set_length: set a sequence's length.
 102  *
 103  * Set the sequence's length field.
 104  *
 105  * @param sequence Sequence field instance.
 106  * @param length_field Unsigned integer field instance indicating the
 107  *        sequence's length.
 108  *
 109  * Returns 0 on success, a negative value on error.
 110  */
 111 extern int bt_ctf_field_sequence_set_length(struct bt_ctf_field *sequence,
 112                 struct bt_ctf_field *length_field);
 113
 114 /*
 115  * bt_ctf_field_sequence_get_field: get a sequence's field at position "index".
 116  *
 117  * Return the sequence's field at position "index". The sequence's length must
 118  * have been set prior to calling this function using
 119  * bt_ctf_field_sequence_set_length().
 120  * bt_ctf_field_put() must be called on the returned value.
 121  *
 122  * @param array Sequence field instance.
 123  * @param index Position of the sequence's desired element.
 124  *
 125  * Returns a field instance on success, NULL on error.
 126  */
 127 extern struct bt_ctf_field *bt_ctf_field_sequence_get_field(
 128                 struct bt_ctf_field *sequence, uint64_t index);
 129
 130 /*
 131  * bt_ctf_field_enumeration_get_container: get an enumeration field's container.
 132  *
 133  * Return the enumeration's underlying container field (an integer).
 134  * bt_ctf_field_put() must be called on the returned value.
 135  *
 136  * @param enumeration Enumeration field instance.
 137  *
 138  * Returns a field instance on success, NULL on error.
 139  */
 140 extern struct bt_ctf_field *bt_ctf_field_enumeration_get_container(
 141                 struct bt_ctf_field *enumeration);
 142
 143 /*
 144  * bt_ctf_field_signed_integer_set_value: set a signed integer field's value
 145  *
 146  * Set a signed integer field's value. The value is checked to make sure it
 147  * can be stored in the underlying field.
 148  *
 149  * @param integer Signed integer field instance.
 150  * @param value Signed integer field value.
 151  *
 152  * Returns 0 on success, a negative value on error.
 153  */
 154 extern int bt_ctf_field_signed_integer_set_value(struct bt_ctf_field *integer,
 155                 int64_t value);
 156
 157 /*
 158  * bt_ctf_field_unsigned_integer_set_value: set unsigned integer field's value
 159  *
 160  * Set an unsigned integer field's value. The value is checked to make sure it
 161  * can be stored in the underlying field.
 162  *
 163  * @param integer Unsigned integer field instance.
 164  * @param value Unsigned integer field value.
 165  *
 166  * Returns 0 on success, a negative value on error.
 167  */
 168 extern int bt_ctf_field_unsigned_integer_set_value(struct bt_ctf_field *integer,
 169                 uint64_t value);
 170
 171 /*
 172  * bt_ctf_field_floating_point_set_value: set a floating point field's value
 173  *
 174  * Set a floating point field's value. The underlying type may not support the
 175  * double's full precision.
 176  *
 177  * @param floating_point Floating point field instance.
 178  * @param value Floating point field value.
 179  *
 180  * Returns 0 on success, a negative value on error.
 181  */
 182 extern int bt_ctf_field_floating_point_set_value(
 183                 struct bt_ctf_field *floating_point,
 184                 double value);
 185
 186 /*
 187  * bt_ctf_field_string_set_value: set a string field's value
 188  *
 189  * Set a string field's value.
 190  *
 191  * @param string_field String field instance.
 192  * @param value String field value (will be copied).
 193  *
 194  * Returns 0 on success, a negative value on error.
 195  */
 196 extern int bt_ctf_field_string_set_value(struct bt_ctf_field *string_field,
 197                 const char *value);
 198
 199 #ifdef __cplusplus
 200 }
 201 #endif
 202
 203 #endif /* BABELTRACE_CTF_IR_FIELDS_H */