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

   1 #ifndef BABELTRACE_TRACE_IR_STREAM_CLASS_INTERNAL_H
   2 #define BABELTRACE_TRACE_IR_STREAM_CLASS_INTERNAL_H
   3
   4 /*
   5  * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
   6  * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   7  *
   8  * Permission is hereby granted, free of charge, to any person obtaining a copy
   9  * of this software and associated documentation files (the "Software"), to deal
  10  * in the Software without restriction, including without limitation the rights
  11  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  12  * copies of the Software, and to permit persons to whom the Software is
  13  * furnished to do so, subject to the following conditions:
  14  *
  15  * The above copyright notice and this permission notice shall be included in
  16  * all copies or substantial portions of the Software.
  17  *
  18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  19  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  20  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  21  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  22  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  23  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  24  * SOFTWARE.
  25  */
  26
  27 #include <babeltrace/assert-internal.h>
  28 #include <babeltrace/common-internal.h>
  29 #include <babeltrace/trace-ir/field-class-internal.h>
  30 #include <babeltrace/trace-ir/utils-internal.h>
  31 #include <babeltrace/trace-ir/stream-class.h>
  32 #include <babeltrace/object-internal.h>
  33 #include <babeltrace/object-pool-internal.h>
  34 #include <babeltrace/babeltrace-internal.h>
  35 #include <glib.h>
  36 #include <inttypes.h>
  37
  38 struct bt_stream_class {
  39         struct bt_object base;
  40
  41         struct {
  42                 GString *str;
  43
  44                 /* NULL or `str->str` above */
  45                 const char *value;
  46         } name;
  47
  48         uint64_t id;
  49         bool assigns_automatic_event_class_id;
  50         bool assigns_automatic_stream_id;
  51         bool packets_have_default_beginning_clock_snapshot;
  52         bool packets_have_default_end_clock_snapshot;
  53         struct bt_field_class *packet_context_fc;
  54         struct bt_field_class *event_common_context_fc;
  55         struct bt_clock_class *default_clock_class;
  56
  57         /* Array of `struct bt_event_class *` */
  58         GPtrArray *event_classes;
  59
  60         /* Pool of `struct bt_field_wrapper *` */
  61         struct bt_object_pool packet_context_field_pool;
  62
  63         bool frozen;
  64 };
  65
  66 BT_HIDDEN
  67 void _bt_stream_class_freeze(const struct bt_stream_class *stream_class);
  68
  69 #ifdef BT_DEV_MODE
  70 # define bt_stream_class_freeze         _bt_stream_class_freeze
  71 #else
  72 # define bt_stream_class_freeze(_sc)
  73 #endif
  74
  75 static inline
  76 struct bt_trace_class *bt_stream_class_borrow_trace_class_inline(
  77                 const struct bt_stream_class *stream_class)
  78 {
  79         BT_ASSERT(stream_class);
  80         return (void *) bt_object_borrow_parent(&stream_class->base);
  81 }
  82
  83 #endif /* BABELTRACE_TRACE_IR_STREAM_CLASS_INTERNAL_H */