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