src/lib/trace-ir/stream-class.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 "common/assert.h"
  28 #include "common/common.h"
  29 #include <babeltrace2/trace-ir/stream-class.h>
  30 #include "lib/object.h"
  31 #include "lib/object-pool.h"
  32 #include "common/macros.h"
  33 #include <glib.h>
  34 #include <inttypes.h>
  35 #include <stdbool.h>
  36
  37 #include "field-class.h"
  38 #include "utils.h"
  39
  40 struct bt_stream_class {
  41         struct bt_object base;
  42
  43         /* Owned by this */
  44         struct bt_value *user_attributes;
  45
  46         struct {
  47                 GString *str;
  48
  49                 /* NULL or `str->str` above */
  50                 const char *value;
  51         } name;
  52
  53         uint64_t id;
  54         bool assigns_automatic_event_class_id;
  55         bool assigns_automatic_stream_id;
  56         bool supports_packets;
  57         bool packets_have_beginning_default_clock_snapshot;
  58         bool packets_have_end_default_clock_snapshot;
  59         bool supports_discarded_events;
  60         bool supports_discarded_packets;
  61         bool discarded_events_have_default_clock_snapshots;
  62         bool discarded_packets_have_default_clock_snapshots;
  63         struct bt_field_class *packet_context_fc;
  64         struct bt_field_class *event_common_context_fc;
  65         struct bt_clock_class *default_clock_class;
  66
  67         /* Array of `struct bt_event_class *` */
  68         GPtrArray *event_classes;
  69
  70         /* Pool of `struct bt_field_wrapper *` */
  71         struct bt_object_pool packet_context_field_pool;
  72
  73         bool frozen;
  74 };
  75
  76 BT_HIDDEN
  77 void _bt_stream_class_freeze(const struct bt_stream_class *stream_class);
  78
  79 #ifdef BT_DEV_MODE
  80 # define bt_stream_class_freeze         _bt_stream_class_freeze
  81 #else
  82 # define bt_stream_class_freeze(_sc)
  83 #endif
  84
  85 static inline
  86 struct bt_trace_class *bt_stream_class_borrow_trace_class_inline(
  87                 const struct bt_stream_class *stream_class)
  88 {
  89         BT_ASSERT_DBG(stream_class);
  90         return (void *) bt_object_borrow_parent(&stream_class->base);
  91 }
  92
  93 #endif /* BABELTRACE_TRACE_IR_STREAM_CLASS_INTERNAL_H */