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/ref-internal.h>
  31 #include <babeltrace/ctf-writer/event-types.h>
  32 #include <babeltrace/ctf-writer/event-fields.h>
  33 #include <babeltrace/babeltrace-internal.h>
  34 #include <babeltrace/ctf/types.h>
  35 #include <glib.h>
  36
  37 struct bt_ctf_event_class {
  38         struct bt_ctf_ref ref_count;
  39         GQuark name;
  40         int id_set;
  41         uint32_t id;
  42         /* An event class does not have ownership of a stream class */
  43         struct bt_ctf_stream_class *stream_class;
  44         /* Structure type containing the event's context */
  45         struct bt_ctf_field_type *context;
  46         /* Structure type containing the event's fields */
  47         struct bt_ctf_field_type *fields;
  48         int frozen;
  49 };
  50
  51 struct bt_ctf_event {
  52         struct bt_ctf_ref ref_count;
  53         struct bt_ctf_event_class *event_class;
  54         struct bt_ctf_field *event_header;
  55         struct bt_ctf_field *context_payload;
  56         struct bt_ctf_field *fields_payload;
  57 };
  58
  59 BT_HIDDEN
  60 void bt_ctf_event_class_freeze(struct bt_ctf_event_class *event_class);
  61
  62 BT_HIDDEN
  63 int bt_ctf_event_class_set_stream_class(struct bt_ctf_event_class *event_class,
  64                 struct bt_ctf_stream_class *stream_class);
  65
  66 BT_HIDDEN
  67 int bt_ctf_event_class_serialize(struct bt_ctf_event_class *event_class,
  68                 struct metadata_context *context);
  69
  70 BT_HIDDEN
  71 void bt_ctf_event_class_set_native_byte_order(
  72                 struct bt_ctf_event_class *event_class,
  73                 int byte_order);
  74
  75 BT_HIDDEN
  76 int bt_ctf_event_validate(struct bt_ctf_event *event);
  77
  78 BT_HIDDEN
  79 int bt_ctf_event_serialize(struct bt_ctf_event *event,
  80                 struct ctf_stream_pos *pos);
  81
  82 /*
  83  * Attempt to populate the "id" and "timestamp" fields of the event header if
  84  * they are present, unset and their types are integers.
  85  *
  86  * Not finding these fields or encountering unexpected types is not an error
  87  * since the user may have defined a different event header layout. In this
  88  * case, it is expected that the fields be manually populated before appending
  89  * an event to a stream.
  90  */
  91 BT_HIDDEN
  92 int bt_ctf_event_populate_event_header(struct bt_ctf_event *event);
  93
  94 #endif /* BABELTRACE_CTF_IR_EVENT_INTERNAL_H */