#define BT_LOG_TAG "EVENT-CLASS"
#include <babeltrace/lib-logging-internal.h>
+#include <babeltrace/assert-pre-internal.h>
+#include <babeltrace/ctf-ir/clock-value-internal.h>
#include <babeltrace/ctf-ir/fields-internal.h>
#include <babeltrace/ctf-ir/field-types-internal.h>
#include <babeltrace/ctf-ir/event-class.h>
#include <babeltrace/ctf-ir/event-class-internal.h>
+#include <babeltrace/ctf-ir/event-internal.h>
#include <babeltrace/ctf-ir/stream-class.h>
#include <babeltrace/ctf-ir/stream-class-internal.h>
#include <babeltrace/ctf-ir/trace-internal.h>
#include <babeltrace/ctf-ir/validation-internal.h>
#include <babeltrace/ctf-ir/utils.h>
+#include <babeltrace/ctf-ir/utils-internal.h>
#include <babeltrace/ref.h>
#include <babeltrace/ctf-ir/attributes-internal.h>
#include <babeltrace/compiler-internal.h>
#include <babeltrace/endian-internal.h>
#include <babeltrace/types.h>
#include <babeltrace/values-internal.h>
+#include <babeltrace/assert-internal.h>
#include <inttypes.h>
#include <stdlib.h>
-static
-void bt_event_class_destroy(struct bt_object *obj);
-
-struct bt_event_class *bt_event_class_create(const char *name)
+static inline
+void bt_event_class_finalize(struct bt_object *obj)
{
- struct bt_value *obj = NULL;
- struct bt_event_class *event_class = NULL;
+ struct bt_event_class *event_class;
- BT_LOGD("Creating event class object: name=\"%s\"",
- name);
+ event_class = container_of(obj, struct bt_event_class, base);
+ BT_LOGD("Finalizing event class: addr=%p, name=\"%s\", id=%" PRId64,
+ event_class, bt_event_class_get_name(event_class),
+ bt_event_class_get_id(event_class));
- if (!name) {
- BT_LOGW_STR("Invalid parameter: name is NULL.");
- goto error;
+ if (event_class->name) {
+ g_string_free(event_class->name, TRUE);
}
- event_class = g_new0(struct bt_event_class, 1);
- if (!event_class) {
- BT_LOGE_STR("Failed to allocate one event class.");
- goto error;
+ if (event_class->emf_uri) {
+ g_string_free(event_class->emf_uri, TRUE);
}
- bt_object_init(event_class, bt_event_class_destroy);
- event_class->fields = bt_field_type_structure_create();
- if (!event_class->fields) {
+ BT_LOGD_STR("Putting context field type.");
+ bt_put(event_class->context_field_type);
+ BT_LOGD_STR("Putting payload field type.");
+ bt_put(event_class->payload_field_type);
+}
+
+static inline
+int bt_event_class_initialize(struct bt_event_class *event_class,
+ const char *name, bt_object_release_func release_func,
+ bt_field_type_structure_create_func ft_struct_create_func)
+{
+ int ret = 0;
+
+ BT_LOGD("Initializing event class object: name=\"%s\"",
+ name);
+ bt_object_init_shared_with_parent(&event_class->base, release_func);
+ event_class->payload_field_type = ft_struct_create_func();
+ if (!event_class->payload_field_type) {
BT_LOGE_STR("Cannot create event class's initial payload field type object.");
goto error;
}
}
event_class->log_level = BT_EVENT_CLASS_LOG_LEVEL_UNSPECIFIED;
- BT_PUT(obj);
- BT_LOGD("Created event class object: addr=%p, name=\"%s\"",
+ BT_LOGD("Initialized event class object: addr=%p, name=\"%s\"",
event_class, bt_event_class_get_name(event_class));
- return event_class;
+ return ret;
error:
- BT_PUT(event_class);
- BT_PUT(obj);
- return event_class;
+ ret = -1;
+ return ret;
}
-const char *bt_event_class_get_name(struct bt_event_class *event_class)
+static
+void bt_event_class_destroy(struct bt_object *obj)
{
- const char *name = NULL;
+ struct bt_event_class *event_class = (void *) obj;
- if (!event_class) {
- BT_LOGW_STR("Invalid parameter: event class is NULL.");
- goto end;
- }
-
- name = event_class->name->str;
+ BT_LOGD("Destroying event class: addr=%p", obj);
+ bt_event_class_finalize(obj);
+ bt_object_pool_finalize(&event_class->event_pool);
+ g_free(obj);
+}
-end:
- return name;
+static
+void free_event(struct bt_event *event,
+ struct bt_event_class *event_class)
+{
+ bt_event_destroy(event);
}
-int64_t bt_event_class_get_id(struct bt_event_class *event_class)
+struct bt_event_class *bt_event_class_create(const char *name)
{
- int64_t ret = 0;
+ int ret;
+ struct bt_event_class *event_class = NULL;
+
+ if (!name) {
+ BT_LOGW_STR("Invalid parameter: name is NULL.");
+ goto error;
+ }
+ BT_LOGD("Creating event class object: name=\"%s\"",
+ name);
+ event_class = g_new0(struct bt_event_class, 1);
if (!event_class) {
- BT_LOGW_STR("Invalid parameter: event class is NULL.");
- ret = (int64_t) -1;
- goto end;
+ BT_LOGE_STR("Failed to allocate one event class.");
+ goto error;
+ }
+
+ ret = bt_event_class_initialize(event_class,
+ name, bt_event_class_destroy,
+ (bt_field_type_structure_create_func)
+ bt_field_type_structure_create);
+ if (ret) {
+ goto error;
}
- ret = event_class->id;
+ ret = bt_object_pool_initialize(&event_class->event_pool,
+ (bt_object_pool_new_object_func) bt_event_new,
+ (bt_object_pool_destroy_object_func) free_event,
+ event_class);
+ if (ret) {
+ BT_LOGE("Failed to initialize event pool: ret=%d",
+ ret);
+ goto error;
+ }
+
+ BT_LOGD("Created event class object: addr=%p, name=\"%s\"",
+ event_class, bt_event_class_get_name(event_class));
+ goto end;
+
+error:
+ bt_put(event_class);
end:
- return ret;
+ return event_class;
+}
+
+const char *bt_event_class_get_name(struct bt_event_class *event_class)
+{
+ BT_ASSERT_PRE_NON_NULL(event_class, "Event class");
+ BT_ASSERT(event_class->name);
+ return event_class->name->str;
+}
+
+int64_t bt_event_class_get_id(struct bt_event_class *event_class)
+{
+ BT_ASSERT_PRE_NON_NULL(event_class, "Event class");
+ return event_class->id;
}
int bt_event_class_set_id(struct bt_event_class *event_class,
if (event_class->frozen) {
BT_LOGW("Invalid parameter: event class is frozen: "
"addr=%p, name=\"%s\", id=%" PRId64,
- event_class, bt_event_class_get_name(event_class),
+ event_class,
+ bt_event_class_get_name(event_class),
bt_event_class_get_id(event_class));
ret = -1;
goto end;
if (id < 0) {
BT_LOGW("Invalid parameter: invalid event class's ID: "
"addr=%p, name=\"%s\", id=%" PRIu64,
- event_class, bt_event_class_get_name(event_class),
+ event_class,
+ bt_event_class_get_name(event_class),
id_param);
ret = -1;
goto end;
enum bt_event_class_log_level bt_event_class_get_log_level(
struct bt_event_class *event_class)
{
- enum bt_event_class_log_level log_level;
-
- if (!event_class) {
- BT_LOGW_STR("Invalid parameter: event class is NULL.");
- log_level = BT_EVENT_CLASS_LOG_LEVEL_UNKNOWN;
- goto end;
- }
-
- log_level = event_class->log_level;
-
-end:
- return log_level;
+ BT_ASSERT_PRE_NON_NULL(event_class, "Event class");
+ return event_class->log_level;
}
int bt_event_class_set_log_level(struct bt_event_class *event_class,
if (event_class->frozen) {
BT_LOGW("Invalid parameter: event class is frozen: "
"addr=%p, name=\"%s\", id=%" PRId64,
- event_class, bt_event_class_get_name(event_class),
+ event_class,
+ bt_event_class_get_name(event_class),
bt_event_class_get_id(event_class));
ret = -1;
goto end;
"addr=%p, name=\"%s\", id=%" PRId64 ", log-level=%s",
event_class, bt_event_class_get_name(event_class),
bt_event_class_get_id(event_class),
- bt_event_class_log_level_string(log_level));
+ bt_common_event_class_log_level_string(log_level));
end:
return ret;
}
-const char *bt_event_class_get_emf_uri(
- struct bt_event_class *event_class)
+const char *bt_event_class_get_emf_uri(struct bt_event_class *event_class)
{
const char *emf_uri = NULL;
- if (!event_class) {
- BT_LOGW_STR("Invalid parameter: event class is NULL.");
- goto end;
- }
+ BT_ASSERT_PRE_NON_NULL(event_class, "Event class");
if (event_class->emf_uri->len > 0) {
emf_uri = event_class->emf_uri->str;
}
-end:
return emf_uri;
}
return ret;
}
-struct bt_stream_class *bt_event_class_get_stream_class(
+struct bt_stream_class *bt_event_class_borrow_stream_class(
struct bt_event_class *event_class)
{
- return event_class ?
- bt_get(bt_event_class_borrow_stream_class(event_class)) :
- NULL;
+ BT_ASSERT_PRE_NON_NULL(event_class, "Event class");
+ return (void *) bt_object_borrow_parent(&event_class->base);
}
-struct bt_field_type *bt_event_class_get_payload_type(
+struct bt_field_type *bt_event_class_borrow_payload_field_type(
struct bt_event_class *event_class)
{
- struct bt_field_type *payload = NULL;
-
- if (!event_class) {
- BT_LOGW_STR("Invalid parameter: event class is NULL.");
- goto end;
- }
-
- bt_get(event_class->fields);
- payload = event_class->fields;
-end:
- return payload;
+ BT_ASSERT_PRE_NON_NULL(event_class, "Event class");
+ return event_class->payload_field_type;
}
-int bt_event_class_set_payload_type(struct bt_event_class *event_class,
- struct bt_field_type *payload)
+int bt_event_class_set_payload_field_type(struct bt_event_class *event_class,
+ struct bt_field_type *field_type)
{
int ret = 0;
goto end;
}
- if (payload && bt_field_type_get_type_id(payload) !=
+ if (field_type && bt_field_type_get_type_id(field_type) !=
BT_FIELD_TYPE_ID_STRUCT) {
BT_LOGW("Invalid parameter: event class's payload field type must be a structure: "
"addr=%p, name=\"%s\", id=%" PRId64 ", "
"payload-ft-addr=%p, payload-ft-id=%s",
event_class, bt_event_class_get_name(event_class),
- bt_event_class_get_id(event_class), payload,
- bt_field_type_id_string(
- bt_field_type_get_type_id(payload)));
+ bt_event_class_get_id(event_class), field_type,
+ bt_common_field_type_id_string(
+ bt_field_type_get_type_id(field_type)));
ret = -1;
goto end;
}
- bt_put(event_class->fields);
- event_class->fields = bt_get(payload);
+ bt_put(event_class->payload_field_type);
+ event_class->payload_field_type = bt_get(field_type);
BT_LOGV("Set event class's payload field type: "
"event-class-addr=%p, event-class-name=\"%s\", "
"event-class-id=%" PRId64 ", payload-ft-addr=%p",
event_class, bt_event_class_get_name(event_class),
- bt_event_class_get_id(event_class), payload);
-end:
- return ret;
-}
-
-int bt_event_class_add_field(struct bt_event_class *event_class,
- struct bt_field_type *type,
- const char *name)
-{
- int ret = 0;
-
- if (!event_class || !type) {
- BT_LOGW("Invalid parameter: event class or field type is NULL: "
- "event-class-addr=%p, field-type-addr=%p",
- event_class, type);
- ret = -1;
- goto end;
- }
-
- if (bt_identifier_is_valid(name)) {
- BT_LOGW("Invalid parameter: event class's payload field type's field name is not a valid CTF identifier: "
- "addr=%p, name=\"%s\", id=%" PRId64 ", field-name=\"%s\"",
- event_class, bt_event_class_get_name(event_class),
- bt_event_class_get_id(event_class),
- name);
- ret = -1;
- goto end;
- }
-
- if (event_class->frozen) {
- BT_LOGW("Invalid parameter: event class is frozen: "
- "addr=%p, name=\"%s\", id=%" PRId64,
- event_class, bt_event_class_get_name(event_class),
- bt_event_class_get_id(event_class));
- ret = -1;
- goto end;
- }
-
- if (!event_class->fields) {
- BT_LOGW("Event class has no payload field type: "
- "addr=%p, name=\"%s\", id=%" PRId64,
- event_class, bt_event_class_get_name(event_class),
- bt_event_class_get_id(event_class));
- ret = -1;
- goto end;
- }
-
- assert(bt_field_type_get_type_id(event_class->fields) ==
- BT_FIELD_TYPE_ID_STRUCT);
- ret = bt_field_type_structure_add_field(event_class->fields,
- type, name);
- BT_LOGV("Added field to event class's payload field type: "
- "event-class-addr=%p, event-class-name=\"%s\", "
- "event-class-id=%" PRId64 ", field-name=\"%s\", ft-addr=%p",
- event_class, bt_event_class_get_name(event_class),
- bt_event_class_get_id(event_class), name, type);
+ bt_event_class_get_id(event_class), field_type);
end:
return ret;
}
-int64_t bt_event_class_get_payload_type_field_count(
+struct bt_field_type *bt_event_class_borrow_context_field_type(
struct bt_event_class *event_class)
{
- int64_t ret;
-
- if (!event_class) {
- BT_LOGW_STR("Invalid parameter: event class is NULL.");
- ret = (int64_t) -1;
- goto end;
- }
-
- if (!event_class->fields) {
- BT_LOGV("Event class has no payload field type: "
- "addr=%p, name=\"%s\", id=%" PRId64,
- event_class, bt_event_class_get_name(event_class),
- bt_event_class_get_id(event_class));
- ret = (int64_t) -1;
- goto end;
- }
-
- assert(bt_field_type_get_type_id(event_class->fields) ==
- BT_FIELD_TYPE_ID_STRUCT);
- ret = bt_field_type_structure_get_field_count(event_class->fields);
-end:
- return ret;
-}
-
-int bt_event_class_get_payload_type_field_by_index(
- struct bt_event_class *event_class,
- const char **field_name, struct bt_field_type **field_type,
- uint64_t index)
-{
- int ret;
+ struct bt_field_type *context_ft = NULL;
- if (!event_class) {
- BT_LOGW_STR("Invalid parameter: event class is NULL.");
- ret = -1;
- goto end;
- }
-
- if (!event_class->fields) {
- BT_LOGV("Event class has no payload field type: "
- "addr=%p, name=\"%s\", id=%" PRId64 ", index=%" PRIu64,
- event_class, bt_event_class_get_name(event_class),
- bt_event_class_get_id(event_class), index);
- ret = -1;
- goto end;
- }
+ BT_ASSERT_PRE_NON_NULL(event_class, "Event class");
- assert(bt_field_type_get_type_id(event_class->fields) ==
- BT_FIELD_TYPE_ID_STRUCT);
- ret = bt_field_type_structure_get_field_by_index(event_class->fields,
- field_name, field_type, index);
-end:
- return ret;
-}
-
-struct bt_field_type *
-bt_event_class_get_payload_type_field_type_by_name(
- struct bt_event_class *event_class, const char *name)
-{
- GQuark name_quark;
- struct bt_field_type *field_type = NULL;
-
- if (!event_class || !name) {
- BT_LOGW("Invalid parameter: event class or name is NULL: "
- "event-class-addr=%p, name-addr=%p",
- event_class, name);
- goto end;
- }
-
- if (!event_class->fields) {
- BT_LOGV("Event class has no payload field type: "
- "addr=%p, name=\"%s\", id=%" PRId64,
- event_class, bt_event_class_get_name(event_class),
- bt_event_class_get_id(event_class));
- goto end;
- }
-
- assert(bt_field_type_get_type_id(event_class->fields) ==
- BT_FIELD_TYPE_ID_STRUCT);
- name_quark = g_quark_try_string(name);
- if (!name_quark) {
- BT_LOGE("Cannot get GQuark: string=\"%s\"", name);
- goto end;
- }
-
- /*
- * No need to increment field_type's reference count since getting it
- * from the structure already does.
- */
- field_type = bt_field_type_structure_get_field_type_by_name(
- event_class->fields, name);
-end:
- return field_type;
-}
-
-struct bt_field_type *bt_event_class_get_context_type(
- struct bt_event_class *event_class)
-{
- struct bt_field_type *context_type = NULL;
-
- if (!event_class) {
- BT_LOGW_STR("Invalid parameter: event class is NULL.");
- goto end;
- }
-
- if (!event_class->context) {
+ if (!event_class->context_field_type) {
BT_LOGV("Event class has no context field type: "
"addr=%p, name=\"%s\", id=%" PRId64,
event_class, bt_event_class_get_name(event_class),
goto end;
}
- bt_get(event_class->context);
- context_type = event_class->context;
+ context_ft = event_class->context_field_type;
+
end:
- return context_type;
+ return context_ft;
}
-int bt_event_class_set_context_type(
+int bt_event_class_set_context_field_type(
struct bt_event_class *event_class,
- struct bt_field_type *context)
+ struct bt_field_type *field_type)
{
int ret = 0;
goto end;
}
- if (context && bt_field_type_get_type_id(context) !=
+ if (field_type && bt_field_type_get_type_id(field_type) !=
BT_FIELD_TYPE_ID_STRUCT) {
BT_LOGW("Invalid parameter: event class's context field type must be a structure: "
"addr=%p, name=\"%s\", id=%" PRId64 ", "
"context-ft-id=%s",
event_class, bt_event_class_get_name(event_class),
bt_event_class_get_id(event_class),
- bt_field_type_id_string(
- bt_field_type_get_type_id(context)));
+ bt_common_field_type_id_string(
+ bt_field_type_get_type_id(field_type)));
ret = -1;
goto end;
}
- bt_put(event_class->context);
- event_class->context = bt_get(context);
+ bt_put(event_class->context_field_type);
+ event_class->context_field_type = bt_get(field_type);
BT_LOGV("Set event class's context field type: "
"event-class-addr=%p, event-class-name=\"%s\", "
"event-class-id=%" PRId64 ", context-ft-addr=%p",
event_class, bt_event_class_get_name(event_class),
- bt_event_class_get_id(event_class), context);
+ bt_event_class_get_id(event_class), field_type);
+
end:
return ret;
-
-}
-
-/* Pre-2.0 CTF writer backward compatibility */
-void bt_ctf_event_class_get(struct bt_event_class *event_class)
-{
- bt_get(event_class);
-}
-
-/* Pre-2.0 CTF writer backward compatibility */
-void bt_ctf_event_class_put(struct bt_event_class *event_class)
-{
- bt_put(event_class);
-}
-
-static
-void bt_event_class_destroy(struct bt_object *obj)
-{
- struct bt_event_class *event_class;
-
- event_class = container_of(obj, struct bt_event_class, base);
- BT_LOGD("Destroying event class: addr=%p, name=\"%s\", id=%" PRId64,
- event_class, bt_event_class_get_name(event_class),
- bt_event_class_get_id(event_class));
- g_string_free(event_class->name, TRUE);
- g_string_free(event_class->emf_uri, TRUE);
- BT_LOGD_STR("Putting context field type.");
- bt_put(event_class->context);
- BT_LOGD_STR("Putting payload field type.");
- bt_put(event_class->fields);
- g_free(event_class);
}
BT_HIDDEN
void bt_event_class_freeze(struct bt_event_class *event_class)
{
- assert(event_class);
+ BT_ASSERT(event_class);
if (event_class->frozen) {
return;
bt_event_class_get_id(event_class));
event_class->frozen = 1;
BT_LOGD_STR("Freezing event class's context field type.");
- bt_field_type_freeze(event_class->context);
+ bt_field_type_freeze(event_class->context_field_type);
BT_LOGD_STR("Freezing event class's payload field type.");
- bt_field_type_freeze(event_class->fields);
+ bt_field_type_freeze(event_class->payload_field_type);
}
BT_HIDDEN
-int bt_event_class_serialize(struct bt_event_class *event_class,
- struct metadata_context *context)
+int bt_event_class_validate_single_clock_class(
+ struct bt_event_class *event_class,
+ struct bt_clock_class **expected_clock_class)
{
int ret = 0;
- struct bt_value *attr_value = NULL;
-
- assert(event_class);
- assert(context);
- BT_LOGD("Serializing event class's metadata: "
- "event-class-addr=%p, event-class-name=\"%s\", "
- "event-class-id=%" PRId64 ", metadata-context-addr=%p",
- event_class, bt_event_class_get_name(event_class),
- bt_event_class_get_id(event_class), context);
- context->current_indentation_level = 1;
- g_string_assign(context->field_name, "");
- g_string_append(context->string, "event {\n");
-
- /* Serialize attributes */
- g_string_append_printf(context->string, "\tname = \"%s\";\n",
- event_class->name->str);
- assert(event_class->id >= 0);
- g_string_append_printf(context->string, "\tid = %" PRId64 ";\n",
- event_class->id);
- g_string_append_printf(context->string, "\tstream_id = %" PRId64 ";\n",
- bt_stream_class_get_id(
- bt_event_class_borrow_stream_class(event_class)));
-
- if (event_class->log_level != BT_EVENT_CLASS_LOG_LEVEL_UNSPECIFIED) {
- g_string_append_printf(context->string, "\tloglevel = %d;\n",
- (int) event_class->log_level);
- }
-
- if (event_class->emf_uri->len > 0) {
- g_string_append_printf(context->string, "\tmodel.emf.uri = \"%s\";\n",
- event_class->emf_uri->str);
- }
- /* Serialize context field type */
- if (event_class->context) {
- g_string_append(context->string, "\tcontext := ");
- BT_LOGD_STR("Serializing event class's context field type metadata.");
- ret = bt_field_type_serialize(event_class->context,
- context);
- if (ret) {
- BT_LOGW("Cannot serialize event class's context field type's metadata: "
- "ret=%d", ret);
- goto end;
- }
- g_string_append(context->string, ";\n");
- }
-
- /* Serialize payload field type */
- if (event_class->fields) {
- g_string_append(context->string, "\tfields := ");
- BT_LOGD_STR("Serializing event class's payload field type metadata.");
- ret = bt_field_type_serialize(event_class->fields, context);
- if (ret) {
- BT_LOGW("Cannot serialize event class's payload field type's metadata: "
- "ret=%d", ret);
- goto end;
- }
- g_string_append(context->string, ";\n");
+ BT_ASSERT(event_class);
+ BT_ASSERT(expected_clock_class);
+ ret = bt_field_type_validate_single_clock_class(
+ event_class->context_field_type,
+ expected_clock_class);
+ if (ret) {
+ BT_LOGW("Event class's context field type "
+ "is not recursively mapped to the "
+ "expected clock class: "
+ "event-class-addr=%p, "
+ "event-class-name=\"%s\", "
+ "event-class-id=%" PRId64 ", "
+ "ft-addr=%p",
+ event_class,
+ bt_event_class_get_name(event_class),
+ event_class->id,
+ event_class->context_field_type);
+ goto end;
+ }
+
+ ret = bt_field_type_validate_single_clock_class(
+ event_class->payload_field_type,
+ expected_clock_class);
+ if (ret) {
+ BT_LOGW("Event class's payload field type "
+ "is not recursively mapped to the "
+ "expected clock class: "
+ "event-class-addr=%p, "
+ "event-class-name=\"%s\", "
+ "event-class-id=%" PRId64 ", "
+ "ft-addr=%p",
+ event_class,
+ bt_event_class_get_name(event_class),
+ event_class->id,
+ event_class->payload_field_type);
+ goto end;
}
- g_string_append(context->string, "};\n\n");
end:
- context->current_indentation_level = 0;
- BT_PUT(attr_value);
return ret;
}