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

   1 #ifndef BABELTRACE_CTF_IR_EVENT_CLASS_INTERNAL_H
   2 #define BABELTRACE_CTF_IR_EVENT_CLASS_INTERNAL_H
   3
   4 /*
   5  * Babeltrace - CTF IR: Event class 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-ir/field-types.h>
  31 #include <babeltrace/ctf-ir/fields.h>
  32 #include <babeltrace/babeltrace-internal.h>
  33 #include <babeltrace/values.h>
  34 #include <babeltrace/ctf-ir/stream-class.h>
  35 #include <babeltrace/ctf-ir/stream.h>
  36 #include <babeltrace/object-internal.h>
  37 #include <glib.h>
  38
  39 #define BT_CTF_EVENT_CLASS_ATTR_ID_INDEX        0
  40 #define BT_CTF_EVENT_CLASS_ATTR_NAME_INDEX      1
  41
  42 struct bt_ctf_event_class {
  43         struct bt_object base;
  44         struct bt_value *attributes;
  45         /* Structure type containing the event's context */
  46         struct bt_ctf_field_type *context;
  47         /* Structure type containing the event's fields */
  48         struct bt_ctf_field_type *fields;
  49         int frozen;
  50
  51         /*
  52          * This flag indicates if the event class is valid. A valid
  53          * event class is _always_ frozen. However, an event class
  54          * may be frozen, but not valid yet. This is okay, as long as
  55          * no events are created out of this event class.
  56          */
  57         int valid;
  58
  59         /* Cached values */
  60         const char *name;
  61         int64_t id;
  62 };
  63
  64 BT_HIDDEN
  65 void bt_ctf_event_class_freeze(struct bt_ctf_event_class *event_class);
  66
  67 BT_HIDDEN
  68 int bt_ctf_event_class_serialize(struct bt_ctf_event_class *event_class,
  69                 struct metadata_context *context);
  70
  71 BT_HIDDEN
  72 void bt_ctf_event_class_set_native_byte_order(
  73                 struct bt_ctf_event_class *event_class,
  74                 int byte_order);
  75
  76 BT_HIDDEN
  77 int bt_ctf_event_class_set_stream_id(struct bt_ctf_event_class *event_class,
  78                 uint32_t stream_id);
  79
  80 static inline
  81 struct bt_ctf_stream_class *bt_ctf_event_class_borrow_stream_class(
  82                 struct bt_ctf_event_class *event_class)
  83 {
  84         assert(event_class);
  85         return (void *) bt_object_borrow_parent(event_class);
  86 }
  87
  88 #endif /* BABELTRACE_CTF_IR_EVENT_CLASS_INTERNAL_H */