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/field-types-internal.h>
  33 #include <babeltrace/ctf-ir/utils-internal.h>
  34 #include <babeltrace/ctf-ir/stream-class.h>
  35 #include <babeltrace/object-internal.h>
  36 #include <babeltrace/object-pool-internal.h>
  37 #include <babeltrace/babeltrace-internal.h>
  38 #include <glib.h>
  39 #include <inttypes.h>
  40
  41 struct bt_stream_class {
  42         struct bt_object base;
  43
  44         struct {
  45                 GString *str;
  46
  47                 /* NULL or `str->str` above */
  48                 const char *value;
  49         } name;
  50
  51         uint64_t id;
  52         bool assigns_automatic_event_class_id;
  53         bool assigns_automatic_stream_id;
  54         bool packets_have_discarded_event_counter_snapshot;
  55         bool packets_have_packet_counter_snapshot;
  56         bool packets_have_default_beginning_cv;
  57         bool packets_have_default_end_cv;
  58         struct bt_field_type *packet_context_ft;
  59         struct bt_field_type *event_header_ft;
  60         struct bt_field_type *event_common_context_ft;
  61         struct bt_clock_class *default_clock_class;
  62
  63         /* Array of `struct bt_event_class *` */
  64         GPtrArray *event_classes;
  65
  66         /* Pool of `struct bt_field_wrapper *` */
  67         struct bt_object_pool event_header_field_pool;
  68
  69         /* Pool of `struct bt_field_wrapper *` */
  70         struct bt_object_pool packet_context_field_pool;
  71
  72         bool frozen;
  73 };
  74
  75 BT_HIDDEN
  76 void _bt_stream_class_freeze(struct bt_stream_class *stream_class);
  77
  78 #ifdef BT_DEV_MODE
  79 # define bt_stream_class_freeze         _bt_stream_class_freeze
  80 #else
  81 # define bt_stream_class_freeze(_sc)
  82 #endif
  83
  84 static inline
  85 struct bt_trace *bt_stream_class_borrow_trace_inline(
  86                 struct bt_stream_class *stream_class)
  87 {
  88         BT_ASSERT(stream_class);
  89         return (void *) bt_object_borrow_parent(&stream_class->base);
  90 }
  91
  92 #endif /* BABELTRACE_CTF_IR_STREAM_CLASS_INTERNAL_H */