+++ /dev/null
-/*
- * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
- * Copyright 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
-#define BT_LOG_TAG "TRACE"
-#include <babeltrace2/lib-logging-internal.h>
-
-#include <babeltrace2/assert-pre-internal.h>
-#include <babeltrace2/trace-ir/trace.h>
-#include <babeltrace2/trace-ir/trace-class-internal.h>
-#include <babeltrace2/trace-ir/trace-const.h>
-#include <babeltrace2/trace-ir/trace-internal.h>
-#include <babeltrace2/trace-ir/clock-class-internal.h>
-#include <babeltrace2/trace-ir/stream-internal.h>
-#include <babeltrace2/trace-ir/stream-class-internal.h>
-#include <babeltrace2/trace-ir/event-internal.h>
-#include <babeltrace2/trace-ir/event-class.h>
-#include <babeltrace2/trace-ir/event-class-internal.h>
-#include <babeltrace2/ctf-writer/functor-internal.h>
-#include <babeltrace2/ctf-writer/clock-internal.h>
-#include <babeltrace2/trace-ir/field-wrapper-internal.h>
-#include <babeltrace2/trace-ir/field-class-internal.h>
-#include <babeltrace2/trace-ir/attributes-internal.h>
-#include <babeltrace2/trace-ir/utils-internal.h>
-#include <babeltrace2/trace-ir/resolve-field-path-internal.h>
-#include <babeltrace2/compiler-internal.h>
-#include <babeltrace2/value.h>
-#include <babeltrace2/value-const.h>
-#include <babeltrace2/value-internal.h>
-#include <babeltrace2/types.h>
-#include <babeltrace2/endian-internal.h>
-#include <babeltrace2/assert-internal.h>
-#include <babeltrace2/compat/glib-internal.h>
-#include <inttypes.h>
-#include <stdint.h>
-#include <string.h>
-#include <stdlib.h>
-
-struct bt_trace_destruction_listener_elem {
- bt_trace_destruction_listener_func func;
- void *data;
-};
-
-#define BT_ASSERT_PRE_TRACE_HOT(_trace) \
- BT_ASSERT_PRE_HOT((_trace), "Trace", ": %!+t", (_trace))
-
-static
-void destroy_trace(struct bt_object *obj)
-{
- struct bt_trace *trace = (void *) obj;
-
- BT_LIB_LOGD("Destroying trace object: %!+t", trace);
-
- /*
- * Call destruction listener functions so that everything else
- * still exists in the trace.
- */
- if (trace->destruction_listeners) {
- uint64_t i;
- BT_LIB_LOGV("Calling trace destruction listener(s): %!+t", trace);
-
- /*
- * The trace's reference count is 0 if we're here. Increment
- * it to avoid a double-destroy (possibly infinitely recursive).
- * This could happen for example if a destruction listener did
- * bt_object_get_ref() (or anything that causes
- * bt_object_get_ref() to be called) on the trace (ref.
- * count goes from 0 to 1), and then bt_object_put_ref(): the
- * reference count would go from 1 to 0 again and this function
- * would be called again.
- */
- trace->base.ref_count++;
-
- /* Call all the trace destruction listeners */
- for (i = 0; i < trace->destruction_listeners->len; i++) {
- struct bt_trace_destruction_listener_elem elem =
- g_array_index(trace->destruction_listeners,
- struct bt_trace_destruction_listener_elem, i);
-
- if (elem.func) {
- elem.func(trace, elem.data);
- }
-
- /*
- * The destruction listener should not have kept a
- * reference to the trace.
- */
- BT_ASSERT_PRE(trace->base.ref_count == 1, "Destruction listener kept a reference to the trace being destroyed: %![trace-]+t", trace);
- }
- g_array_free(trace->destruction_listeners, TRUE);
- trace->destruction_listeners = NULL;
- }
-
- if (trace->name.str) {
- g_string_free(trace->name.str, TRUE);
- trace->name.str = NULL;
- trace->name.value = NULL;
- }
-
- if (trace->streams) {
- BT_LOGD_STR("Destroying streams.");
- g_ptr_array_free(trace->streams, TRUE);
- trace->streams = NULL;
- }
-
- if (trace->stream_classes_stream_count) {
- g_hash_table_destroy(trace->stream_classes_stream_count);
- trace->stream_classes_stream_count = NULL;
- }
-
- BT_LOGD_STR("Putting trace's class.");
- bt_object_put_ref(trace->class);
- trace->class = NULL;
- g_free(trace);
-}
-
-struct bt_trace *bt_trace_create(struct bt_trace_class *tc)
-{
- struct bt_trace *trace = NULL;
-
- BT_LIB_LOGD("Creating trace object: %![tc-]+T", tc);
- trace = g_new0(struct bt_trace, 1);
- if (!trace) {
- BT_LOGE_STR("Failed to allocate one trace.");
- goto error;
- }
-
- bt_object_init_shared(&trace->base, destroy_trace);
- trace->streams = g_ptr_array_new_with_free_func(
- (GDestroyNotify) bt_object_try_spec_release);
- if (!trace->streams) {
- BT_LOGE_STR("Failed to allocate one GPtrArray.");
- goto error;
- }
-
- trace->stream_classes_stream_count = g_hash_table_new(g_direct_hash,
- g_direct_equal);
- if (!trace->stream_classes_stream_count) {
- BT_LOGE_STR("Failed to allocate one GHashTable.");
- goto error;
- }
-
- trace->name.str = g_string_new(NULL);
- if (!trace->name.str) {
- BT_LOGE_STR("Failed to allocate one GString.");
- goto error;
- }
-
- trace->destruction_listeners = g_array_new(FALSE, TRUE,
- sizeof(struct bt_trace_destruction_listener_elem));
- if (!trace->destruction_listeners) {
- BT_LOGE_STR("Failed to allocate one GArray.");
- goto error;
- }
-
- trace->class = tc;
- bt_object_get_no_null_check(trace->class);
- BT_LIB_LOGD("Created trace object: %!+t", trace);
- goto end;
-
-error:
- BT_OBJECT_PUT_REF_AND_RESET(trace);
-
-end:
- return trace;
-}
-
-const char *bt_trace_get_name(const struct bt_trace *trace)
-{
- BT_ASSERT_PRE_NON_NULL(trace, "Trace");
- return trace->name.value;
-}
-
-enum bt_trace_status bt_trace_set_name(struct bt_trace *trace, const char *name)
-{
- BT_ASSERT_PRE_NON_NULL(trace, "Trace");
- BT_ASSERT_PRE_NON_NULL(name, "Name");
- BT_ASSERT_PRE_TRACE_HOT(trace);
- g_string_assign(trace->name.str, name);
- trace->name.value = trace->name.str->str;
- BT_LIB_LOGV("Set trace's name: %!+t", trace);
- return BT_TRACE_STATUS_OK;
-}
-
-uint64_t bt_trace_get_stream_count(const struct bt_trace *trace)
-{
- BT_ASSERT_PRE_NON_NULL(trace, "Trace");
- return (uint64_t) trace->streams->len;
-}
-
-struct bt_stream *bt_trace_borrow_stream_by_index(
- struct bt_trace *trace, uint64_t index)
-{
- BT_ASSERT_PRE_NON_NULL(trace, "Trace");
- BT_ASSERT_PRE_VALID_INDEX(index, trace->streams->len);
- return g_ptr_array_index(trace->streams, index);
-}
-
-const struct bt_stream *bt_trace_borrow_stream_by_index_const(
- const struct bt_trace *trace, uint64_t index)
-{
- return bt_trace_borrow_stream_by_index((void *) trace, index);
-}
-
-struct bt_stream *bt_trace_borrow_stream_by_id(struct bt_trace *trace,
- uint64_t id)
-{
- struct bt_stream *stream = NULL;
- uint64_t i;
-
- BT_ASSERT_PRE_NON_NULL(trace, "Trace");
-
- for (i = 0; i < trace->streams->len; i++) {
- struct bt_stream *stream_candidate =
- g_ptr_array_index(trace->streams, i);
-
- if (stream_candidate->id == id) {
- stream = stream_candidate;
- goto end;
- }
- }
-
-end:
- return stream;
-}
-
-const struct bt_stream *bt_trace_borrow_stream_by_id_const(
- const struct bt_trace *trace, uint64_t id)
-{
- return bt_trace_borrow_stream_by_id((void *) trace, id);
-}
-
-enum bt_trace_status bt_trace_add_destruction_listener(
- const struct bt_trace *c_trace,
- bt_trace_destruction_listener_func listener,
- void *data, uint64_t *listener_id)
-{
- struct bt_trace *trace = (void *) c_trace;
- uint64_t i;
- struct bt_trace_destruction_listener_elem new_elem = {
- .func = listener,
- .data = data,
- };
-
- BT_ASSERT_PRE_NON_NULL(trace, "Trace");
- BT_ASSERT_PRE_NON_NULL(listener, "Listener");
-
- /* Find the next available spot */
- for (i = 0; i < trace->destruction_listeners->len; i++) {
- struct bt_trace_destruction_listener_elem elem =
- g_array_index(trace->destruction_listeners,
- struct bt_trace_destruction_listener_elem, i);
-
- if (!elem.func) {
- break;
- }
- }
-
- if (i == trace->destruction_listeners->len) {
- g_array_append_val(trace->destruction_listeners, new_elem);
- } else {
- g_array_insert_val(trace->destruction_listeners, i, new_elem);
- }
-
- if (listener_id) {
- *listener_id = i;
- }
-
- BT_LIB_LOGV("Added destruction listener: " "%![trace-]+t, "
- "listener-id=%" PRIu64, trace, i);
- return BT_TRACE_STATUS_OK;
-}
-
-BT_ASSERT_PRE_FUNC
-static
-bool has_listener_id(const struct bt_trace *trace, uint64_t listener_id)
-{
- BT_ASSERT(listener_id < trace->destruction_listeners->len);
- return (&g_array_index(trace->destruction_listeners,
- struct bt_trace_destruction_listener_elem,
- listener_id))->func != NULL;
-}
-
-enum bt_trace_status bt_trace_remove_destruction_listener(
- const struct bt_trace *c_trace, uint64_t listener_id)
-{
- struct bt_trace *trace = (void *) c_trace;
- struct bt_trace_destruction_listener_elem *elem;
-
- BT_ASSERT_PRE_NON_NULL(trace, "Trace");
- BT_ASSERT_PRE(has_listener_id(trace, listener_id),
- "Trace has no such trace destruction listener ID: "
- "%![trace-]+t, %" PRIu64, trace, listener_id);
- elem = &g_array_index(trace->destruction_listeners,
- struct bt_trace_destruction_listener_elem,
- listener_id);
- BT_ASSERT(elem->func);
-
- elem->func = NULL;
- elem->data = NULL;
- BT_LIB_LOGV("Removed \"trace destruction listener: "
- "%![trace-]+t, listener-id=%" PRIu64,
- trace, listener_id);
- return BT_TRACE_STATUS_OK;
-}
-
-BT_HIDDEN
-void _bt_trace_freeze(const struct bt_trace *trace)
-{
- BT_ASSERT(trace);
- BT_LIB_LOGD("Freezing trace's class: %!+T", trace->class);
- bt_trace_class_freeze(trace->class);
- BT_LIB_LOGD("Freezing trace: %!+t", trace);
- ((struct bt_trace *) trace)->frozen = true;
-}
-
-BT_HIDDEN
-void bt_trace_add_stream(struct bt_trace *trace, struct bt_stream *stream)
-{
- guint count = 0;
-
- bt_object_set_parent(&stream->base, &trace->base);
- g_ptr_array_add(trace->streams, stream);
- bt_trace_freeze(trace);
-
- if (bt_g_hash_table_contains(trace->stream_classes_stream_count,
- stream->class)) {
- count = GPOINTER_TO_UINT(g_hash_table_lookup(
- trace->stream_classes_stream_count, stream->class));
- }
-
- g_hash_table_insert(trace->stream_classes_stream_count,
- stream->class, GUINT_TO_POINTER(count + 1));
-}
-
-BT_HIDDEN
-uint64_t bt_trace_get_automatic_stream_id(const struct bt_trace *trace,
- const struct bt_stream_class *stream_class)
-{
- gpointer orig_key;
- gpointer value;
- uint64_t id = 0;
-
- BT_ASSERT(stream_class);
- BT_ASSERT(trace);
- if (g_hash_table_lookup_extended(trace->stream_classes_stream_count,
- stream_class, &orig_key, &value)) {
- id = (uint64_t) GPOINTER_TO_UINT(value);
- }
-
- return id;
-}
-
-struct bt_trace_class *bt_trace_borrow_class(struct bt_trace *trace)
-{
- BT_ASSERT_PRE_NON_NULL(trace, "Trace");
- return trace->class;
-}
-
-const struct bt_trace_class *bt_trace_borrow_class_const(
- const struct bt_trace *trace)
-{
- return bt_trace_borrow_class((void *) trace);
-}
-
-void bt_trace_get_ref(const struct bt_trace *trace)
-{
- bt_object_get_ref(trace);
-}
-
-void bt_trace_put_ref(const struct bt_trace *trace)
-{
- bt_object_put_ref(trace);
-}