lib/trace-ir/stream.c

   1 /*
   2  * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   3  *
   4  * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a copy
   7  * of this software and associated documentation files (the "Software"), to deal
   8  * in the Software without restriction, including without limitation the rights
   9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10  * copies of the Software, and to permit persons to whom the Software is
  11  * furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included in
  14  * all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  22  * SOFTWARE.
  23  */
  24
  25 #define BT_LOG_TAG "STREAM"
  26 #include <babeltrace/lib-logging-internal.h>
  27
  28 #include <babeltrace/assert-pre-internal.h>
  29 #include <babeltrace/trace-ir/private-stream.h>
  30 #include <babeltrace/trace-ir/stream.h>
  31 #include <babeltrace/trace-ir/stream-internal.h>
  32 #include <babeltrace/trace-ir/stream-class.h>
  33 #include <babeltrace/trace-ir/stream-class-internal.h>
  34 #include <babeltrace/trace-ir/trace.h>
  35 #include <babeltrace/trace-ir/trace-internal.h>
  36 #include <babeltrace/trace-ir/packet-internal.h>
  37 #include <babeltrace/object.h>
  38 #include <babeltrace/compiler-internal.h>
  39 #include <babeltrace/align-internal.h>
  40 #include <babeltrace/assert-internal.h>
  41 #include <babeltrace/property-internal.h>
  42 #include <inttypes.h>
  43 #include <unistd.h>
  44
  45 #define BT_ASSERT_PRE_STREAM_HOT(_stream) \
  46         BT_ASSERT_PRE_HOT((_stream), "Stream", ": %!+s", (_stream))
  47
  48 static
  49 void destroy_stream(struct bt_object *obj)
  50 {
  51         struct bt_stream *stream = (void *) obj;
  52
  53         BT_LIB_LOGD("Destroying stream object: %!+s", stream);
  54
  55         if (stream->name.str) {
  56                 g_string_free(stream->name.str, TRUE);
  57         }
  58
  59         bt_object_pool_finalize(&stream->packet_pool);
  60         g_free(stream);
  61 }
  62
  63 static
  64 void bt_stream_free_packet(struct bt_packet *packet, struct bt_stream *stream)
  65 {
  66         bt_packet_destroy(packet);
  67 }
  68
  69 BT_ASSERT_PRE_FUNC
  70 static inline
  71 bool stream_id_is_unique(struct bt_trace *trace,
  72                 struct bt_stream_class *stream_class, uint64_t id)
  73 {
  74         uint64_t i;
  75         bool is_unique = true;
  76
  77         for (i = 0; i < trace->streams->len; i++) {
  78                 struct bt_stream *stream = trace->streams->pdata[i];
  79
  80                 if (stream->class != stream_class) {
  81                         continue;
  82                 }
  83
  84                 if (stream->id == id) {
  85                         is_unique = false;
  86                         goto end;
  87                 }
  88         }
  89
  90 end:
  91         return is_unique;
  92 }
  93
  94 static
  95 struct bt_stream *create_stream_with_id(struct bt_stream_class *stream_class,
  96                   uint64_t id)
  97 {
  98         int ret;
  99         struct bt_stream *stream;
 100         struct bt_trace *trace;
 101
 102         BT_ASSERT(stream_class);
 103         trace = bt_stream_class_borrow_trace_inline(stream_class);
 104         BT_ASSERT_PRE(stream_id_is_unique(trace, stream_class, id),
 105                 "Duplicate stream ID: %![trace-]+t, id=%" PRIu64, trace, id);
 106         BT_ASSERT_PRE(!trace->is_static,
 107                 "Trace is static: %![trace-]+t", trace);
 108         BT_LIB_LOGD("Creating stream object: %![trace-]+t, id=%" PRIu64,
 109                 trace, id);
 110         stream = g_new0(struct bt_stream, 1);
 111         if (!stream) {
 112                 BT_LOGE_STR("Failed to allocate one stream.");
 113                 goto error;
 114         }
 115
 116         bt_object_init_shared_with_parent(&stream->base, destroy_stream);
 117         stream->name.str = g_string_new(NULL);
 118         if (!stream->name.str) {
 119                 BT_LOGE_STR("Failed to allocate a GString.");
 120                 goto error;
 121         }
 122
 123         stream->id = id;
 124         ret = bt_object_pool_initialize(&stream->packet_pool,
 125                 (bt_object_pool_new_object_func) bt_packet_new,
 126                 (bt_object_pool_destroy_object_func) bt_stream_free_packet,
 127                 stream);
 128         if (ret) {
 129                 BT_LOGE("Failed to initialize packet pool: ret=%d", ret);
 130                 goto error;
 131         }
 132
 133         stream->class = stream_class;
 134         bt_trace_add_stream(trace, stream);
 135         bt_stream_class_freeze(stream_class);
 136         BT_LIB_LOGD("Created stream object: %!+s", stream);
 137         goto end;
 138
 139 error:
 140         BT_OBJECT_PUT_REF_AND_RESET(stream);
 141
 142 end:
 143         return stream;
 144 }
 145
 146 struct bt_private_stream *bt_private_stream_create(
 147                 struct bt_private_stream_class *priv_stream_class)
 148 {
 149         struct bt_stream_class *stream_class = (void *) priv_stream_class;
 150         uint64_t id;
 151
 152         BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
 153         BT_ASSERT_PRE(stream_class->assigns_automatic_stream_id,
 154                 "Stream class does not automatically assigns stream IDs: "
 155                 "%![sc-]+S", stream_class);
 156         id = bt_trace_get_automatic_stream_id(
 157                         bt_stream_class_borrow_trace_inline(stream_class),
 158                         stream_class);
 159         return (void *) create_stream_with_id(stream_class, id);
 160 }
 161
 162 struct bt_private_stream *bt_private_stream_create_with_id(
 163                 struct bt_private_stream_class *priv_stream_class,
 164                 uint64_t id)
 165 {
 166         struct bt_stream_class *stream_class = (void *) priv_stream_class;
 167
 168         BT_ASSERT_PRE(!stream_class->assigns_automatic_stream_id,
 169                 "Stream class automatically assigns stream IDs: "
 170                 "%![sc-]+S", stream_class);
 171         return (void *) create_stream_with_id(stream_class, id);
 172 }
 173
 174 struct bt_stream_class *bt_stream_borrow_class(struct bt_stream *stream)
 175 {
 176         BT_ASSERT_PRE_NON_NULL(stream, "Stream");
 177         return stream->class;
 178 }
 179
 180 struct bt_private_stream_class *bt_private_stream_borrow_private_class(
 181                 struct bt_private_stream *priv_stream)
 182 {
 183         return (void *) bt_stream_borrow_class((void *) priv_stream);
 184 }
 185
 186 const char *bt_stream_get_name(struct bt_stream *stream)
 187 {
 188         BT_ASSERT_PRE_NON_NULL(stream, "Stream class");
 189         return stream->name.value;
 190 }
 191
 192 int bt_private_stream_set_name(struct bt_private_stream *priv_stream,
 193                 const char *name)
 194 {
 195         struct bt_stream *stream = (void *) priv_stream;
 196
 197         BT_ASSERT_PRE_NON_NULL(stream, "Clock class");
 198         BT_ASSERT_PRE_NON_NULL(name, "Name");
 199         BT_ASSERT_PRE_STREAM_HOT(stream);
 200         g_string_assign(stream->name.str, name);
 201         stream->name.value = stream->name.str->str;
 202         BT_LIB_LOGV("Set stream class's name: %!+s", stream);
 203         return 0;
 204 }
 205
 206 uint64_t bt_stream_get_id(struct bt_stream *stream)
 207 {
 208         BT_ASSERT_PRE_NON_NULL(stream, "Stream class");
 209         return stream->id;
 210 }
 211
 212 BT_HIDDEN
 213 void _bt_stream_freeze(struct bt_stream *stream)
 214 {
 215         /* The field classes and default clock class are already frozen */
 216         BT_ASSERT(stream);
 217         BT_LIB_LOGD("Freezing stream: %!+s", stream);
 218         stream->frozen = true;
 219 }
 220
 221 struct bt_stream *bt_stream_borrow_from_private(
 222                 struct bt_private_stream *priv_stream)
 223 {
 224         return (void *) priv_stream;
 225 }