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/stream.h>
  37 #include <babeltrace/object-internal.h>
  38 #include <glib.h>
  39
  40 #define BT_CTF_EVENT_CLASS_ATTR_ID_INDEX        0
  41 #define BT_CTF_EVENT_CLASS_ATTR_NAME_INDEX      1
  42
  43 struct bt_ctf_event_class {
  44         struct bt_object base;
  45         struct bt_value *attributes;
  46         /*
  47          * Weak reference; an event class does not have ownership of a
  48          * stream class.
  49          */
  50         struct bt_ctf_stream_class *stream_class;
  51         /* Structure type containing the event's context */
  52         struct bt_ctf_field_type *context;
  53         /* Structure type containing the event's fields */
  54         struct bt_ctf_field_type *fields;
  55         int frozen;
  56 };
  57
  58 struct bt_ctf_event {
  59         struct bt_object base;
  60         struct bt_ctf_event_class *event_class;
  61         /* Weak reference; an event does not have ownership of a stream */
  62         struct bt_ctf_stream *stream;
  63         struct bt_ctf_field *event_header;
  64         struct bt_ctf_field *context_payload;
  65         struct bt_ctf_field *fields_payload;
  66 };
  67
  68 BT_HIDDEN
  69 void bt_ctf_event_class_freeze(struct bt_ctf_event_class *event_class);
  70
  71 BT_HIDDEN
  72 int bt_ctf_event_class_set_stream_class(struct bt_ctf_event_class *event_class,
  73                 struct bt_ctf_stream_class *stream_class);
  74
  75 BT_HIDDEN
  76 int bt_ctf_event_class_serialize(struct bt_ctf_event_class *event_class,
  77                 struct metadata_context *context);
  78
  79 BT_HIDDEN
  80 void bt_ctf_event_class_set_native_byte_order(
  81                 struct bt_ctf_event_class *event_class,
  82                 int byte_order);
  83
  84 BT_HIDDEN
  85 int bt_ctf_event_class_set_stream_id(struct bt_ctf_event_class *event_class,
  86                 uint32_t stream_id);
  87
  88 BT_HIDDEN
  89 int bt_ctf_event_validate(struct bt_ctf_event *event);
  90
  91 BT_HIDDEN
  92 int bt_ctf_event_serialize(struct bt_ctf_event *event,
  93                 struct ctf_stream_pos *pos);
  94
  95 BT_HIDDEN
  96 int bt_ctf_event_set_stream(struct bt_ctf_event *event,
  97                 struct bt_ctf_stream *stream);
  98
  99 /*
 100  * Attempt to populate the "id" and "timestamp" fields of the event header if
 101  * they are present, unset and their types are integers.
 102  *
 103  * Not finding these fields or encountering unexpected types is not an error
 104  * since the user may have defined a different event header layout. In this
 105  * case, it is expected that the fields be manually populated before appending
 106  * an event to a stream.
 107  */
 108 BT_HIDDEN
 109 int bt_ctf_event_populate_event_header(struct bt_ctf_event *event);
 110
 111 #endif /* BABELTRACE_CTF_IR_EVENT_INTERNAL_H */