lib/trace-ir/trace.c

   1 /*
   2  * Copyright 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 "TRACE"
  26 #include <babeltrace/lib-logging-internal.h>
  27
  28 #include <babeltrace/assert-pre-internal.h>
  29 #include <babeltrace/trace-ir/trace.h>
  30 #include <babeltrace/trace-ir/trace-class-internal.h>
  31 #include <babeltrace/trace-ir/trace-const.h>
  32 #include <babeltrace/trace-ir/trace-internal.h>
  33 #include <babeltrace/trace-ir/clock-class-internal.h>
  34 #include <babeltrace/trace-ir/stream-internal.h>
  35 #include <babeltrace/trace-ir/stream-class-internal.h>
  36 #include <babeltrace/trace-ir/event-internal.h>
  37 #include <babeltrace/trace-ir/event-class.h>
  38 #include <babeltrace/trace-ir/event-class-internal.h>
  39 #include <babeltrace/ctf-writer/functor-internal.h>
  40 #include <babeltrace/ctf-writer/clock-internal.h>
  41 #include <babeltrace/trace-ir/field-wrapper-internal.h>
  42 #include <babeltrace/trace-ir/field-classes-internal.h>
  43 #include <babeltrace/trace-ir/attributes-internal.h>
  44 #include <babeltrace/trace-ir/utils-internal.h>
  45 #include <babeltrace/trace-ir/resolve-field-path-internal.h>
  46 #include <babeltrace/compiler-internal.h>
  47 #include <babeltrace/values.h>
  48 #include <babeltrace/values-const.h>
  49 #include <babeltrace/values-internal.h>
  50 #include <babeltrace/object.h>
  51 #include <babeltrace/types.h>
  52 #include <babeltrace/endian-internal.h>
  53 #include <babeltrace/assert-internal.h>
  54 #include <babeltrace/compat/glib-internal.h>
  55 #include <inttypes.h>
  56 #include <stdint.h>
  57 #include <string.h>
  58 #include <stdlib.h>
  59
  60 struct bt_trace_is_static_listener_elem {
  61         bt_trace_is_static_listener_func func;
  62         bt_trace_listener_removed_func removed;
  63         void *data;
  64 };
  65
  66 #define BT_ASSERT_PRE_TRACE_HOT(_trace) \
  67         BT_ASSERT_PRE_HOT((_trace), "Trace", ": %!+t", (_trace))
  68
  69 static
  70 void destroy_trace(struct bt_object *obj)
  71 {
  72         struct bt_trace *trace = (void *) obj;
  73
  74         BT_LIB_LOGD("Destroying trace object: %!+t", trace);
  75
  76         /*
  77          * Call remove listeners first so that everything else still
  78          * exists in the trace.
  79          */
  80         if (trace->is_static_listeners) {
  81                 size_t i;
  82
  83                 for (i = 0; i < trace->is_static_listeners->len; i++) {
  84                         struct bt_trace_is_static_listener_elem elem =
  85                                 g_array_index(trace->is_static_listeners,
  86                                         struct bt_trace_is_static_listener_elem, i);
  87
  88                         if (elem.removed) {
  89                                 elem.removed((void *) trace, elem.data);
  90                         }
  91                 }
  92
  93                 g_array_free(trace->is_static_listeners, TRUE);
  94                 trace->is_static_listeners = NULL;
  95         }
  96
  97         if (trace->name.str) {
  98                 g_string_free(trace->name.str, TRUE);
  99                 trace->name.str = NULL;
 100                 trace->name.value = NULL;
 101         }
 102
 103         if (trace->streams) {
 104                 BT_LOGD_STR("Destroying streams.");
 105                 g_ptr_array_free(trace->streams, TRUE);
 106                 trace->streams = NULL;
 107         }
 108
 109         if (trace->stream_classes_stream_count) {
 110                 g_hash_table_destroy(trace->stream_classes_stream_count);
 111                 trace->stream_classes_stream_count = NULL;
 112         }
 113
 114         BT_LOGD_STR("Putting trace's class.");
 115         bt_object_put_ref(trace->class);
 116         trace->class = NULL;
 117         g_free(trace);
 118 }
 119
 120 struct bt_trace *bt_trace_create(struct bt_trace_class *tc)
 121 {
 122         struct bt_trace *trace = NULL;
 123
 124         BT_LIB_LOGD("Creating trace object: %![tc-]+T", tc);
 125         trace = g_new0(struct bt_trace, 1);
 126         if (!trace) {
 127                 BT_LOGE_STR("Failed to allocate one trace.");
 128                 goto error;
 129         }
 130
 131         bt_object_init_shared(&trace->base, destroy_trace);
 132         trace->streams = g_ptr_array_new_with_free_func(
 133                 (GDestroyNotify) bt_object_try_spec_release);
 134         if (!trace->streams) {
 135                 BT_LOGE_STR("Failed to allocate one GPtrArray.");
 136                 goto error;
 137         }
 138
 139         trace->stream_classes_stream_count = g_hash_table_new(g_direct_hash,
 140                 g_direct_equal);
 141         if (!trace->stream_classes_stream_count) {
 142                 BT_LOGE_STR("Failed to allocate one GHashTable.");
 143                 goto error;
 144         }
 145
 146         trace->name.str = g_string_new(NULL);
 147         if (!trace->name.str) {
 148                 BT_LOGE_STR("Failed to allocate one GString.");
 149                 goto error;
 150         }
 151
 152         trace->is_static_listeners = g_array_new(FALSE, TRUE,
 153                 sizeof(struct bt_trace_is_static_listener_elem));
 154         if (!trace->is_static_listeners) {
 155                 BT_LOGE_STR("Failed to allocate one GArray.");
 156                 goto error;
 157         }
 158
 159         trace->class = tc;
 160         bt_object_get_no_null_check(trace->class);
 161         BT_LIB_LOGD("Created trace object: %!+t", trace);
 162         goto end;
 163
 164 error:
 165         BT_OBJECT_PUT_REF_AND_RESET(trace);
 166
 167 end:
 168         return trace;
 169 }
 170
 171 const char *bt_trace_get_name(const struct bt_trace *trace)
 172 {
 173         BT_ASSERT_PRE_NON_NULL(trace, "Trace");
 174         return trace->name.value;
 175 }
 176
 177 int bt_trace_set_name(struct bt_trace *trace, const char *name)
 178 {
 179         BT_ASSERT_PRE_NON_NULL(trace, "Trace");
 180         BT_ASSERT_PRE_NON_NULL(name, "Name");
 181         BT_ASSERT_PRE_TRACE_HOT(trace);
 182         g_string_assign(trace->name.str, name);
 183         trace->name.value = trace->name.str->str;
 184         BT_LIB_LOGV("Set trace's name: %!+t", trace);
 185         return 0;
 186 }
 187
 188 uint64_t bt_trace_get_stream_count(const struct bt_trace *trace)
 189 {
 190         BT_ASSERT_PRE_NON_NULL(trace, "Trace");
 191         return (uint64_t) trace->streams->len;
 192 }
 193
 194 struct bt_stream *bt_trace_borrow_stream_by_index(
 195                 struct bt_trace *trace, uint64_t index)
 196 {
 197         BT_ASSERT_PRE_NON_NULL(trace, "Trace");
 198         BT_ASSERT_PRE_VALID_INDEX(index, trace->streams->len);
 199         return g_ptr_array_index(trace->streams, index);
 200 }
 201
 202 const struct bt_stream *bt_trace_borrow_stream_by_index_const(
 203                 const struct bt_trace *trace, uint64_t index)
 204 {
 205         return bt_trace_borrow_stream_by_index((void *) trace, index);
 206 }
 207
 208 struct bt_stream *bt_trace_borrow_stream_by_id(struct bt_trace *trace,
 209                 uint64_t id)
 210 {
 211         struct bt_stream *stream = NULL;
 212         uint64_t i;
 213
 214         BT_ASSERT_PRE_NON_NULL(trace, "Trace");
 215
 216         for (i = 0; i < trace->streams->len; i++) {
 217                 struct bt_stream *stream_candidate =
 218                         g_ptr_array_index(trace->streams, i);
 219
 220                 if (stream_candidate->id == id) {
 221                         stream = stream_candidate;
 222                         goto end;
 223                 }
 224         }
 225
 226 end:
 227         return stream;
 228 }
 229
 230 const struct bt_stream *bt_trace_borrow_stream_by_id_const(
 231                 const struct bt_trace *trace, uint64_t id)
 232 {
 233         return bt_trace_borrow_stream_by_id((void *) trace, id);
 234 }
 235
 236 bt_bool bt_trace_is_static(const struct bt_trace *trace)
 237 {
 238         BT_ASSERT_PRE_NON_NULL(trace, "Trace");
 239         return (bt_bool) trace->is_static;
 240 }
 241
 242 int bt_trace_make_static(struct bt_trace *trace)
 243 {       uint64_t i;
 244
 245         BT_ASSERT_PRE_NON_NULL(trace, "Trace");
 246         trace->is_static = true;
 247         bt_trace_freeze(trace);
 248         BT_LIB_LOGV("Trace is now static: %!+t", trace);
 249
 250         /* Call all the "trace is static" listeners */
 251         for (i = 0; i < trace->is_static_listeners->len; i++) {
 252                 struct bt_trace_is_static_listener_elem elem =
 253                         g_array_index(trace->is_static_listeners,
 254                                 struct bt_trace_is_static_listener_elem, i);
 255
 256                 if (elem.func) {
 257                         elem.func((void *) trace, elem.data);
 258                 }
 259         }
 260
 261         return 0;
 262 }
 263
 264 int bt_trace_add_is_static_listener(
 265                 const struct bt_trace *c_trace,
 266                 bt_trace_is_static_listener_func listener,
 267                 bt_trace_listener_removed_func listener_removed, void *data,
 268                 uint64_t *listener_id)
 269 {
 270         struct bt_trace *trace = (void *) c_trace;
 271         uint64_t i;
 272         struct bt_trace_is_static_listener_elem new_elem = {
 273                 .func = listener,
 274                 .removed = listener_removed,
 275                 .data = data,
 276         };
 277
 278         BT_ASSERT_PRE_NON_NULL(trace, "Trace");
 279         BT_ASSERT_PRE_NON_NULL(listener, "Listener");
 280         BT_ASSERT_PRE(!trace->is_static,
 281                 "Trace is already static: %!+t", trace);
 282         BT_ASSERT_PRE(trace->in_remove_listener,
 283                 "Cannot call this function while executing a "
 284                 "remove listener: %!+t", trace);
 285
 286         /* Find the next available spot */
 287         for (i = 0; i < trace->is_static_listeners->len; i++) {
 288                 struct bt_trace_is_static_listener_elem elem =
 289                         g_array_index(trace->is_static_listeners,
 290                                 struct bt_trace_is_static_listener_elem, i);
 291
 292                 if (!elem.func) {
 293                         break;
 294                 }
 295         }
 296
 297         if (i == trace->is_static_listeners->len) {
 298                 g_array_append_val(trace->is_static_listeners, new_elem);
 299         } else {
 300                 g_array_insert_val(trace->is_static_listeners, i, new_elem);
 301         }
 302
 303         if (listener_id) {
 304                 *listener_id = i;
 305         }
 306
 307         BT_LIB_LOGV("Added \"trace is static\" listener: "
 308                 "%![trace-]+t, listener-id=%" PRIu64, trace, i);
 309         return 0;
 310 }
 311
 312 BT_ASSERT_PRE_FUNC
 313 static
 314 bool has_listener_id(const struct bt_trace *trace, uint64_t listener_id)
 315 {
 316         BT_ASSERT(listener_id < trace->is_static_listeners->len);
 317         return (&g_array_index(trace->is_static_listeners,
 318                         struct bt_trace_is_static_listener_elem,
 319                         listener_id))->func != NULL;
 320 }
 321
 322 int bt_trace_remove_is_static_listener(const struct bt_trace *c_trace,
 323                 uint64_t listener_id)
 324 {
 325         struct bt_trace *trace = (void *) c_trace;
 326         struct bt_trace_is_static_listener_elem *elem;
 327
 328         BT_ASSERT_PRE_NON_NULL(trace, "Trace");
 329         BT_ASSERT_PRE(!trace->is_static,
 330                 "Trace is already static: %!+t", trace);
 331         BT_ASSERT_PRE(trace->in_remove_listener,
 332                 "Cannot call this function while executing a "
 333                 "remove listener: %!+t", trace);
 334         BT_ASSERT_PRE(has_listener_id(trace, listener_id),
 335                 "Trace has no such \"trace is static\" listener ID: "
 336                 "%![trace-]+t, %" PRIu64, trace, listener_id);
 337         elem = &g_array_index(trace->is_static_listeners,
 338                         struct bt_trace_is_static_listener_elem,
 339                         listener_id);
 340         BT_ASSERT(elem->func);
 341
 342         if (elem->removed) {
 343                 /* Call remove listener */
 344                 BT_LIB_LOGV("Calling remove listener: "
 345                         "%![trace-]+t, listener-id=%" PRIu64,
 346                         trace, listener_id);
 347                 trace->in_remove_listener = true;
 348                 elem->removed((void *) trace, elem->data);
 349                 trace->in_remove_listener = false;
 350         }
 351
 352         elem->func = NULL;
 353         elem->removed = NULL;
 354         elem->data = NULL;
 355         BT_LIB_LOGV("Removed \"trace is static\" listener: "
 356                 "%![trace-]+t, listener-id=%" PRIu64,
 357                 trace, listener_id);
 358         return 0;
 359 }
 360
 361 BT_HIDDEN
 362 void _bt_trace_freeze(const struct bt_trace *trace)
 363 {
 364         /* The packet header field classe is already frozen */
 365         BT_ASSERT(trace);
 366         BT_LIB_LOGD("Freezing trace's class: %!+T", trace->class);
 367         bt_trace_class_freeze(trace->class);
 368         BT_LIB_LOGD("Freezing trace: %!+t", trace);
 369         ((struct bt_trace *) trace)->frozen = true;
 370 }
 371
 372 BT_HIDDEN
 373 void bt_trace_add_stream(struct bt_trace *trace, struct bt_stream *stream)
 374 {
 375         guint count = 0;
 376
 377         bt_object_set_parent(&stream->base, &trace->base);
 378         g_ptr_array_add(trace->streams, stream);
 379         bt_trace_freeze(trace);
 380
 381         if (bt_g_hash_table_contains(trace->stream_classes_stream_count,
 382                         stream->class)) {
 383                 count = GPOINTER_TO_UINT(g_hash_table_lookup(
 384                         trace->stream_classes_stream_count, stream->class));
 385         }
 386
 387         g_hash_table_insert(trace->stream_classes_stream_count,
 388                 stream->class, GUINT_TO_POINTER(count + 1));
 389 }
 390
 391 BT_HIDDEN
 392 uint64_t bt_trace_get_automatic_stream_id(const struct bt_trace *trace,
 393                 const struct bt_stream_class *stream_class)
 394 {
 395         gpointer orig_key;
 396         gpointer value;
 397         uint64_t id = 0;
 398
 399         BT_ASSERT(stream_class);
 400         BT_ASSERT(trace);
 401         if (g_hash_table_lookup_extended(trace->stream_classes_stream_count,
 402                         stream_class, &orig_key, &value)) {
 403                 id = (uint64_t) GPOINTER_TO_UINT(value);
 404         }
 405
 406         return id;
 407 }
 408
 409 struct bt_trace_class *bt_trace_borrow_class(struct bt_trace *trace)
 410 {
 411         BT_ASSERT_PRE_NON_NULL(trace, "Trace");
 412         return trace->class;
 413 }
 414
 415 const struct bt_trace_class *bt_trace_borrow_class_const(
 416                 const struct bt_trace *trace)
 417 {
 418         return bt_trace_borrow_class((void *) trace);
 419 }