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

   1 #ifndef BABELTRACE_CTF_IR_STREAM_CLASS_INTERNAL_H
   2 #define BABELTRACE_CTF_IR_STREAM_CLASS_INTERNAL_H
   3
   4 /*
   5  * BabelTrace - CTF IR: Stream 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/assert-internal.h>
  31 #include <babeltrace/common-internal.h>
  32 #include <babeltrace/ctf-ir/validation-internal.h>
  33 #include <babeltrace/ctf-ir/field-types-internal.h>
  34 #include <babeltrace/ctf-ir/utils-internal.h>
  35 #include <babeltrace/ctf-ir/visitor.h>
  36 #include <babeltrace/ctf-ir/stream-class.h>
  37 #include <babeltrace/object-internal.h>
  38 #include <babeltrace/object-pool-internal.h>
  39 #include <babeltrace/babeltrace-internal.h>
  40 #include <glib.h>
  41 #include <inttypes.h>
  42
  43 struct bt_stream_class {
  44         struct bt_object base;
  45         GString *name;
  46
  47         /* Array of pointers to event class addresses */
  48         GPtrArray *event_classes;
  49
  50         /* event class id (int64_t) to event class address */
  51         GHashTable *event_classes_ht;
  52         int id_set;
  53         int64_t id;
  54         int64_t next_event_id;
  55         struct bt_field_type *packet_context_field_type;
  56         struct bt_field_type *event_header_field_type;
  57         struct bt_field_type *event_context_field_type;
  58         int frozen;
  59         int byte_order;
  60
  61         /*
  62          * This flag indicates if the stream class is valid. A valid
  63          * stream class is _always_ frozen.
  64          */
  65         int valid;
  66
  67         /*
  68          * Unique clock class mapped to any field type within this
  69          * stream class, including all the stream class's event class
  70          * field types. This is only set if the stream class is frozen.
  71          *
  72          * If the stream class is frozen and this is still NULL, it is
  73          * still possible that it becomes non-NULL because
  74          * bt_stream_class_add_event_class() can add an event class
  75          * containing a field type mapped to some clock class. In this
  76          * case, this is the mapped clock class, and at this point, both
  77          * the new event class and the stream class are frozen, so the
  78          * next added event classes are expected to contain field types
  79          * which only map to this specific clock class.
  80          *
  81          * If this is a CTF writer stream class, then this is the
  82          * backing clock class of the `clock` member above.
  83          */
  84         struct bt_clock_class *clock_class;
  85
  86         /* Pool of `struct bt_field_wrapper *` */
  87         struct bt_object_pool event_header_field_pool;
  88
  89         /* Pool of `struct bt_field_wrapper *` */
  90         struct bt_object_pool packet_context_field_pool;
  91 };
  92
  93 struct bt_event_class;
  94
  95 BT_HIDDEN
  96 void bt_stream_class_freeze(struct bt_stream_class *stream_class);
  97
  98 BT_HIDDEN
  99 int bt_stream_class_validate_single_clock_class(
 100                 struct bt_stream_class *stream_class,
 101                 struct bt_clock_class **expected_clock_class);
 102
 103 BT_HIDDEN
 104 int bt_stream_class_visit(struct bt_stream_class *stream_class,
 105                 bt_visitor visitor, void *data);
 106
 107 static inline
 108 void _bt_stream_class_set_id(
 109                 struct bt_stream_class *stream_class, int64_t id)
 110 {
 111         BT_ASSERT(stream_class);
 112         stream_class->id = id;
 113         stream_class->id_set = 1;
 114         BT_LOGV("Set stream class's ID (internal): "
 115                 "addr=%p, name=\"%s\", id=%" PRId64,
 116                 stream_class, bt_stream_class_get_name(stream_class),
 117                 bt_stream_class_get_id(stream_class));
 118 }
 119
 120 static inline
 121 int bt_stream_class_set_id_no_check(
 122                 struct bt_stream_class *stream_class, int64_t id)
 123 {
 124         _bt_stream_class_set_id(stream_class, id);
 125         return 0;
 126 }
 127
 128 #endif /* BABELTRACE_CTF_IR_STREAM_CLASS_INTERNAL_H */