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

   1 #ifndef BABELTRACE_CTF_IR_EVENT_INTERNAL_H
   2 #define BABELTRACE_CTF_IR_EVENT_INTERNAL_H
   3
   4 /*
   5  * Babeltrace - CTF IR: Event 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-types.h>
  31 #include <babeltrace/ctf-writer/event-fields.h>
  32 #include <babeltrace/babeltrace-internal.h>
  33 #include <babeltrace/values.h>
  34 #include <babeltrace/ctf/types.h>
  35 #include <babeltrace/ctf-ir/stream-class.h>
  36 #include <babeltrace/ctf-ir/packet.h>
  37 #include <babeltrace/object-internal.h>
  38 #include <glib.h>
  39
  40 struct bt_ctf_event {
  41         struct bt_object base;
  42         struct bt_ctf_event_class *event_class;
  43         struct bt_ctf_packet *packet;
  44         struct bt_ctf_field *event_header;
  45         struct bt_ctf_field *stream_event_context;
  46         struct bt_ctf_field *context_payload;
  47         struct bt_ctf_field *fields_payload;
  48         GHashTable *clock_values; /* Maps clock addresses to (uint64_t *) */
  49         int frozen;
  50 };
  51
  52 BT_HIDDEN
  53 int bt_ctf_event_register_stream_clock_values(struct bt_ctf_event *event);
  54
  55 BT_HIDDEN
  56 int bt_ctf_event_validate(struct bt_ctf_event *event);
  57
  58 BT_HIDDEN
  59 int bt_ctf_event_serialize(struct bt_ctf_event *event,
  60                 struct ctf_stream_pos *pos);
  61
  62 /*
  63  * Attempt to populate the "id" and "timestamp" fields of the event header if
  64  * they are present, unset and their types are integers.
  65  *
  66  * Not finding these fields or encountering unexpected types is not an error
  67  * since the user may have defined a different event header layout. In this
  68  * case, it is expected that the fields be manually populated before appending
  69  * an event to a stream.
  70  */
  71 BT_HIDDEN
  72 int bt_ctf_event_populate_event_header(struct bt_ctf_event *event);
  73
  74 BT_HIDDEN
  75 void bt_ctf_event_freeze(struct bt_ctf_event *event);
  76
  77 /*
  78  * bt_ctf_event_get_class: get an event's class.
  79  *
  80  * @param event Event.
  81  *
  82  * Returns the event's class, NULL on error.
  83  */
  84 BT_HIDDEN
  85 struct bt_ctf_event_class *bt_ctf_event_get_class(struct bt_ctf_event *event);
  86
  87 /*
  88  * bt_ctf_event_get_stream: get an event's associated stream.
  89  *
  90  * @param event Event.
  91  *
  92  * Returns the event's associated stream, NULL on error.
  93  */
  94 BT_HIDDEN
  95 struct bt_ctf_stream *bt_ctf_event_get_stream(struct bt_ctf_event *event);
  96
  97 /*
  98  * bt_ctf_event_get_clock: get an event's associated clock.
  99  *
 100  * @param event Event.
 101  *
 102  * Returns the event's clock, NULL on error.
 103  */
 104 BT_HIDDEN
 105 struct bt_ctf_clock *bt_ctf_event_get_clock(struct bt_ctf_event *event);
 106
 107 /*
 108  * bt_ctf_event_get_payload_field: get an event's payload.
 109  *
 110  * @param event Event instance.
 111  *
 112  * Returns a field instance on success, NULL on error.
 113  */
 114 BT_HIDDEN
 115 struct bt_ctf_field *bt_ctf_event_get_payload_field(struct bt_ctf_event *event);
 116
 117 /*
 118  * bt_ctf_event_set_payload_field: set an event's payload.
 119  *
 120  * @param event Event instance.
 121  * @param payload Field instance (must be a structure).
 122  *
 123  * Returns 0 on success, a negative value on error.
 124  */
 125 BT_HIDDEN
 126 int bt_ctf_event_set_payload_field(struct bt_ctf_event *event,
 127                 struct bt_ctf_field *payload);
 128
 129 /*
 130  * bt_ctf_event_get_payload_by_index: Get event's field by index.
 131  *
 132  * Returns the field associated with the provided index. bt_ctf_field_put()
 133  * must be called on the returned value. The indexes to be provided are
 134  * the same as can be retrieved from the event class.
 135  *
 136  * @param event Event.
 137  * @param index Index of field.
 138  *
 139  * Returns the event's field, NULL on error.
 140  *
 141  * Note: Will return an error if the payload's type is not a structure.
 142  */
 143 BT_HIDDEN
 144 struct bt_ctf_field *bt_ctf_event_get_payload_by_index(
 145                 struct bt_ctf_event *event, int index);
 146
 147 /*
 148  * bt_ctf_event_get_header: get an event's header.
 149  *
 150  * @param event Event instance.
 151  *
 152  * Returns a field instance on success, NULL on error.
 153  */
 154 BT_HIDDEN
 155 struct bt_ctf_field *bt_ctf_event_get_header(struct bt_ctf_event *event);
 156
 157 /*
 158  * bt_ctf_event_get_event_context: Get an event's context
 159  *
 160  * @param event_class Event class.
 161  *
 162  * Returns a field on success (a structure), NULL on error.
 163  *
 164  * Note: This function is named this way instead of the expected
 165  * "bt_ctf_event_get_context" in order to work around a name clash with
 166  * an unrelated function bearing this name in context.h.
 167  */
 168 BT_HIDDEN
 169 struct bt_ctf_field *bt_ctf_event_get_event_context(struct bt_ctf_event *event);
 170
 171 /*
 172  * bt_ctf_event_get_stream_event_context: Get an event's stream event context
 173  *
 174  * @param event_class Event class.
 175  *
 176  * Returns a field on success (a structure), NULL on error.
 177  */
 178 BT_HIDDEN
 179 struct bt_ctf_field *bt_ctf_event_get_stream_event_context(
 180                 struct bt_ctf_event *event);
 181
 182 BT_HIDDEN
 183 uint64_t bt_ctf_event_get_clock_value(struct bt_ctf_event *event,
 184                 struct bt_ctf_clock *clock);
 185
 186 /*
 187  * bt_ctf_event_set_header: set an event's header.
 188  *
 189  * The event header's type must match the stream class' event
 190  * header type.
 191  *
 192  * @param event Event instance.
 193  * @param header Event header field instance.
 194  *
 195  * Returns a field instance on success, NULL on error.
 196  */
 197 BT_HIDDEN
 198 int bt_ctf_event_set_header(
 199                 struct bt_ctf_event *event,
 200                 struct bt_ctf_field *header);
 201
 202 /*
 203  * bt_ctf_event_set_event_context: Set an event's context
 204  *
 205  * @param event Event.
 206  * @param context Event context field (must match the event class'
 207  *      context type).
 208  *
 209  * Returns 0 on success, a negative value on error.
 210  */
 211 BT_HIDDEN
 212 int bt_ctf_event_set_event_context(struct bt_ctf_event *event,
 213                 struct bt_ctf_field *context);
 214
 215 /*
 216  * bt_ctf_event_set_stream_event_context: Set an event's stream event context
 217  *
 218  * @param event Event.
 219  * @param context Event stream context field (must match the stream class'
 220  *      stream event context type).
 221  *
 222  * Returns 0 on success, a negative value on error.
 223  */
 224 BT_HIDDEN
 225 int bt_ctf_event_set_stream_event_context(struct bt_ctf_event *event,
 226                 struct bt_ctf_field *context);
 227
 228 BT_HIDDEN
 229 int bt_ctf_event_set_packet(struct bt_ctf_event *event,
 230                 struct bt_ctf_packet *packet);
 231
 232 #endif /* BABELTRACE_CTF_IR_EVENT_INTERNAL_H */