From b8248cc00f72ac2448c697c76033c8862d8db673 Mon Sep 17 00:00:00 2001 From: Philippe Proulx Date: Thu, 19 Mar 2015 03:43:00 -0400 Subject: [PATCH] ir: add attributes support to event classes MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Signed-off-by: Philippe Proulx Signed-off-by: Jérémie Galarneau --- formats/ctf/ir/event.c | 346 ++++++++++++++++++--- formats/ctf/ir/stream-class.c | 14 +- formats/ctf/ir/trace.c | 8 +- include/babeltrace/ctf-ir/event-internal.h | 8 +- include/babeltrace/ctf-ir/event.h | 91 ++++++ 5 files changed, 417 insertions(+), 50 deletions(-) diff --git a/formats/ctf/ir/event.c b/formats/ctf/ir/event.c index e51087ba..d8def625 100644 --- a/formats/ctf/ir/event.c +++ b/formats/ctf/ir/event.c @@ -47,54 +47,122 @@ int set_integer_field_value(struct bt_ctf_field *field, uint64_t value); struct bt_ctf_event_class *bt_ctf_event_class_create(const char *name) { + int ret; + struct bt_object *obj = NULL; struct bt_ctf_event_class *event_class = NULL; if (bt_ctf_validate_identifier(name)) { - goto end; + goto error; } event_class = g_new0(struct bt_ctf_event_class, 1); if (!event_class) { - goto end; + goto error; } bt_ctf_ref_init(&event_class->ref_count); event_class->fields = bt_ctf_field_type_structure_create(); if (!event_class->fields) { - bt_ctf_event_class_put(event_class); - event_class = NULL; - goto end; + goto error; } - event_class->name = g_quark_from_string(name); -end: + event_class->attributes = bt_ctf_attributes_create(); + if (!event_class->attributes) { + goto error; + } + + obj = bt_object_integer_create_init(-1); + if (!obj) { + goto error; + } + + ret = bt_ctf_attributes_set_field_value(event_class->attributes, + "id", obj); + if (ret) { + goto error; + } + + BT_OBJECT_PUT(obj); + + obj = bt_object_string_create_init(name); + if (!obj) { + goto error; + } + + ret = bt_ctf_attributes_set_field_value(event_class->attributes, + "name", obj); + if (ret) { + goto error; + } + + BT_OBJECT_PUT(obj); + return event_class; + +error: + if (event_class) { + bt_ctf_event_class_put(event_class); + } + + BT_OBJECT_PUT(obj); + + return NULL; } const char *bt_ctf_event_class_get_name(struct bt_ctf_event_class *event_class) { + struct bt_object *obj = NULL; const char *name = NULL; if (!event_class) { goto end; } - name = g_quark_to_string(event_class->name); + obj = bt_ctf_attributes_get_field_value(event_class->attributes, + BT_CTF_EVENT_CLASS_ATTR_NAME_INDEX); + if (!obj) { + goto end; + } + + if (bt_object_string_get(obj, &name)) { + name = NULL; + } + end: + BT_OBJECT_PUT(obj); + return name; } int64_t bt_ctf_event_class_get_id(struct bt_ctf_event_class *event_class) { + struct bt_object *obj = NULL; int64_t ret; - if (!event_class || !event_class->id_set) { + if (!event_class) { + ret = -1; + goto end; + } + + obj = bt_ctf_attributes_get_field_value(event_class->attributes, + BT_CTF_EVENT_CLASS_ATTR_ID_INDEX); + if (!obj) { + goto end; + } + + if (bt_object_integer_get(obj, &ret)) { + ret = -1; + } + + if (ret < 0) { + /* means ID is not set */ ret = -1; goto end; } - ret = (int64_t) event_class->id; end: + BT_OBJECT_PUT(obj); + return ret; } @@ -102,6 +170,7 @@ int bt_ctf_event_class_set_id(struct bt_ctf_event_class *event_class, uint32_t id) { int ret = 0; + struct bt_object *obj = NULL; if (!event_class) { ret = -1; @@ -117,12 +186,142 @@ int bt_ctf_event_class_set_id(struct bt_ctf_event_class *event_class, goto end; } - event_class->id = id; - event_class->id_set = 1; + obj = bt_ctf_attributes_get_field_value(event_class->attributes, + BT_CTF_EVENT_CLASS_ATTR_ID_INDEX); + if (!obj) { + goto end; + } + + if (bt_object_integer_set(obj, id)) { + ret = -1; + goto end; + } + +end: + BT_OBJECT_PUT(obj); + + return ret; +} + +int bt_ctf_event_class_set_attribute( + struct bt_ctf_event_class *event_class, const char *name, + struct bt_object *value) +{ + int ret = 0; + + if (!event_class || !name || !value || event_class->frozen) { + ret = -1; + goto end; + } + + if (!strcmp(name, "id") || !strcmp(name, "loglevel")) { + if (!bt_object_is_integer(value)) { + ret = -1; + goto end; + } + } else if (!strcmp(name, "name") || !strcmp(name, "model.emf.uri")) { + if (!bt_object_is_string(value)) { + ret = -1; + goto end; + } + } else { + /* unknown attribute */ + ret = -1; + goto end; + } + + /* "id" special case: >= 0 */ + if (!strcmp(name, "id")) { + int64_t val; + + ret = bt_object_integer_get(value, &val); + + if (ret) { + goto end; + } + + if (val < 0) { + ret = -1; + goto end; + } + } + + ret = bt_ctf_attributes_set_field_value(event_class->attributes, + name, value); + end: return ret; } +int bt_ctf_event_class_get_attribute_count( + struct bt_ctf_event_class *event_class) +{ + int ret = 0; + + if (!event_class) { + ret = -1; + goto end; + } + + ret = bt_ctf_attributes_get_count(event_class->attributes); + +end: + return ret; +} + +const char * +bt_ctf_event_class_get_attribute_name( + struct bt_ctf_event_class *event_class, int index) +{ + const char *ret; + + if (!event_class) { + ret = NULL; + goto end; + } + + ret = bt_ctf_attributes_get_field_name(event_class->attributes, index); + +end: + return ret; +} + +struct bt_object * +bt_ctf_event_class_get_attribute_value(struct bt_ctf_event_class *event_class, + int index) +{ + struct bt_object *ret; + + if (!event_class) { + ret = NULL; + goto end; + } + + ret = bt_ctf_attributes_get_field_value(event_class->attributes, index); + +end: + return ret; +} + +struct bt_object * +bt_ctf_event_class_get_attribute_value_by_name( + struct bt_ctf_event_class *event_class, const char *name) +{ + struct bt_object *ret; + + if (!event_class || !name) { + ret = NULL; + goto end; + } + + ret = bt_ctf_attributes_get_field_value_by_name(event_class->attributes, + name); + +end: + return ret; + +} + struct bt_ctf_stream_class *bt_ctf_event_class_get_stream_class( struct bt_ctf_event_class *event_class) { @@ -328,22 +527,14 @@ void bt_ctf_event_class_put(struct bt_ctf_event_class *event_class) struct bt_ctf_event *bt_ctf_event_create(struct bt_ctf_event_class *event_class) { + int ret; + struct bt_object *obj = NULL; struct bt_ctf_event *event = NULL; if (!event_class) { goto end; } - event = g_new0(struct bt_ctf_event, 1); - if (!event) { - goto end; - } - - bt_ctf_ref_init(&event->ref_count); - bt_ctf_event_class_get(event_class); - bt_ctf_event_class_freeze(event_class); - event->event_class = event_class; - /* * The event class does not keep ownership of the stream class to * which it as been added. Therefore, it can't assume it has been @@ -351,10 +542,34 @@ struct bt_ctf_event *bt_ctf_event_create(struct bt_ctf_event_class *event_class) * associated stream class has been reclaimed. */ if (!event_class->stream_class) { - goto error_destroy; + goto end; } assert(event_class->stream_class->event_header_type); + /* set "stream_id" attribute now that we know its value */ + obj = bt_object_integer_create_init(event_class->stream_class->id); + if (!obj) { + goto end; + } + + ret = bt_ctf_attributes_set_field_value(event_class->attributes, + "stream_id", obj); + BT_OBJECT_PUT(obj); + + if (ret) { + goto end; + } + + event = g_new0(struct bt_ctf_event, 1); + if (!event) { + goto end; + } + + bt_ctf_ref_init(&event->ref_count); + bt_ctf_event_class_get(event_class); + bt_ctf_event_class_freeze(event_class); + event->event_class = event_class; + event->event_header = bt_ctf_field_create( event_class->stream_class->event_header_type); if (!event->event_header) { @@ -380,7 +595,10 @@ struct bt_ctf_event *bt_ctf_event_create(struct bt_ctf_event_class *event_class) end: return event; error_destroy: - bt_ctf_event_destroy(&event->ref_count); + if (event) { + bt_ctf_event_destroy(&event->ref_count); + } + return NULL; } @@ -625,6 +843,9 @@ void bt_ctf_event_class_destroy(struct bt_ctf_ref *ref) * bt_ctf_event_class_set_stream_class for explanation. */ event_class = container_of(ref, struct bt_ctf_event_class, ref_count); + if (event_class->attributes) { + bt_ctf_attributes_destroy(event_class->attributes); + } if (event_class->context) { bt_ctf_field_type_put(event_class->context); } @@ -710,6 +931,7 @@ void bt_ctf_event_class_freeze(struct bt_ctf_event_class *event_class) event_class->frozen = 1; bt_ctf_field_type_freeze(event_class->context); bt_ctf_field_type_freeze(event_class->fields); + bt_ctf_attributes_freeze(event_class->attributes); } BT_HIDDEN @@ -746,24 +968,76 @@ BT_HIDDEN int bt_ctf_event_class_serialize(struct bt_ctf_event_class *event_class, struct metadata_context *context) { + int i; + int count; int ret = 0; - int64_t stream_id; + struct bt_object *attr_value = NULL; assert(event_class); assert(context); - stream_id = bt_ctf_stream_class_get_id(event_class->stream_class); - if (stream_id < 0) { + + context->current_indentation_level = 1; + g_string_assign(context->field_name, ""); + g_string_append(context->string, "event {\n"); + count = bt_ctf_event_class_get_attribute_count(event_class); + + if (count < 0) { ret = -1; goto end; } - context->current_indentation_level = 1; - g_string_assign(context->field_name, ""); - g_string_append_printf(context->string, - "event {\n\tname = \"%s\";\n\tid = %u;\n\tstream_id = %" PRId64 ";\n", - g_quark_to_string(event_class->name), - event_class->id, - stream_id); + for (i = 0; i < count; ++i) { + const char *attr_name = NULL; + + attr_name = bt_ctf_event_class_get_attribute_name( + event_class, i); + attr_value = bt_ctf_event_class_get_attribute_value( + event_class, i); + + if (!attr_name || !attr_value) { + ret = -1; + goto end; + } + + switch (bt_object_get_type(attr_value)) { + case BT_OBJECT_TYPE_INTEGER: + { + int64_t value; + + ret = bt_object_integer_get(attr_value, &value); + + if (ret) { + goto end; + } + + g_string_append_printf(context->string, + "\t%s = %" PRId64 ";\n", attr_name, value); + break; + } + + case BT_OBJECT_TYPE_STRING: + { + const char *value; + + ret = bt_object_string_get(attr_value, &value); + + if (ret) { + goto end; + } + + g_string_append_printf(context->string, + "\t%s = \"%s\";\n", attr_name, value); + break; + } + + default: + /* should never happen */ + assert(false); + break; + } + + BT_OBJECT_PUT(attr_value); + } if (event_class->context) { g_string_append(context->string, "\tcontext := "); @@ -787,6 +1061,7 @@ int bt_ctf_event_class_serialize(struct bt_ctf_event_class *event_class, g_string_append(context->string, "};\n\n"); end: context->current_indentation_level = 0; + BT_OBJECT_PUT(attr_value); return ret; } @@ -867,7 +1142,8 @@ int bt_ctf_event_populate_event_header(struct bt_ctf_event *event) id_field = bt_ctf_field_structure_get_field(event->event_header, "id"); if (id_field) { ret = set_integer_field_value(id_field, - (uint64_t) event->event_class->id); + (uint64_t) bt_ctf_event_class_get_id( + event->event_class)); if (ret) { goto end; } diff --git a/formats/ctf/ir/stream-class.c b/formats/ctf/ir/stream-class.c index 409c5ab0..0f823ea7 100644 --- a/formats/ctf/ir/stream-class.c +++ b/formats/ctf/ir/stream-class.c @@ -309,24 +309,20 @@ struct bt_ctf_event_class *bt_ctf_stream_class_get_event_class_by_name( struct bt_ctf_stream_class *stream_class, const char *name) { size_t i; - GQuark name_quark; struct bt_ctf_event_class *event_class = NULL; if (!stream_class || !name) { goto end; } - name_quark = g_quark_try_string(name); - if (!name_quark) { - goto end; - } - for (i = 0; i < stream_class->event_classes->len; i++) { - struct bt_ctf_event_class *current_event_class = + struct bt_ctf_event_class *cur_event_class = g_ptr_array_index(stream_class->event_classes, i); + const char *cur_event_class_name = + bt_ctf_event_class_get_name(cur_event_class); - if (name_quark == current_event_class->name) { - event_class = current_event_class; + if (!strcmp(name, cur_event_class_name)) { + event_class = cur_event_class; bt_ctf_event_class_get(event_class); goto end; } diff --git a/formats/ctf/ir/trace.c b/formats/ctf/ir/trace.c index 6939ac34..e7dcfdae 100644 --- a/formats/ctf/ir/trace.c +++ b/formats/ctf/ir/trace.c @@ -561,8 +561,6 @@ void append_env_metadata(struct bt_ctf_trace *trace, for (i = 0; i < env_size; ++i) { struct bt_object *env_field_value_obj = NULL; const char *entry_name; - int64_t int_value; - int ret; entry_name = bt_ctf_attributes_get_field_name( trace->environment, i); @@ -575,6 +573,10 @@ void append_env_metadata(struct bt_ctf_trace *trace, switch (bt_object_get_type(env_field_value_obj)) { case BT_OBJECT_TYPE_INTEGER: + { + int ret; + int64_t int_value; + ret = bt_object_integer_get(env_field_value_obj, &int_value); @@ -586,7 +588,7 @@ void append_env_metadata(struct bt_ctf_trace *trace, "\t%s = %" PRId64 ";\n", entry_name, int_value); break; - + } case BT_OBJECT_TYPE_STRING: { int ret; diff --git a/include/babeltrace/ctf-ir/event-internal.h b/include/babeltrace/ctf-ir/event-internal.h index d26a9b99..171e7c78 100644 --- a/include/babeltrace/ctf-ir/event-internal.h +++ b/include/babeltrace/ctf-ir/event-internal.h @@ -31,14 +31,16 @@ #include #include #include +#include #include #include +#define BT_CTF_EVENT_CLASS_ATTR_ID_INDEX 0 +#define BT_CTF_EVENT_CLASS_ATTR_NAME_INDEX 1 + struct bt_ctf_event_class { struct bt_ctf_ref ref_count; - GQuark name; - int id_set; - uint32_t id; + struct bt_object *attributes; /* An event class does not have ownership of a stream class */ struct bt_ctf_stream_class *stream_class; /* Structure type containing the event's context */ diff --git a/include/babeltrace/ctf-ir/event.h b/include/babeltrace/ctf-ir/event.h index 102883d6..13abc80a 100644 --- a/include/babeltrace/ctf-ir/event.h +++ b/include/babeltrace/ctf-ir/event.h @@ -32,6 +32,7 @@ #include #include +#include #ifdef __cplusplus extern "C" { @@ -91,6 +92,96 @@ extern int64_t bt_ctf_event_class_get_id( extern int bt_ctf_event_class_set_id( struct bt_ctf_event_class *event_class, uint32_t id); +/* + * bt_ctf_event_class_set_attribute: sets an attribute to the event + * class. + * + * Sets an attribute to the event class. The name parameter is copied, + * whereas the value parameter's reference count is incremented + * (if the function succeeds). + * + * If an attribute exists in the event class for the specified name, it + * is replaced by the new value. + * + * Valid attributes and object types are: + * + * - "id": integer object with a value >= 0 + * - "name": string object + * - "loglevel": integer object with a value >= 0 + * - "model.emf.uri": string object + * + * @param event_class Event class. + * @param name Name of the attribute (will be copied). + * @param value Value of the attribute. + * + * Returns 0 on success, a negative value on error. + */ +extern int bt_ctf_event_class_set_attribute( + struct bt_ctf_event_class *event_class, const char *name, + struct bt_object *value); + +/* + * bt_ctf_event_class_get_attribute_count: get the number of attributes + * in this event class. + * + * Get the event class' attribute count. + * + * @param event_class Event class. + * + * Returns the attribute count, a negative value on error. + */ +extern int bt_ctf_event_class_get_attribute_count( + struct bt_ctf_event_class *event_class); + +/* + * bt_ctf_event_class_get_attribute_name: get attribute name. + * + * Get an attribute's name. The string's ownership is not + * transferred to the caller. The string data is valid as long as + * this event class' attributes are not modified. + * + * @param event_class Event class. + * @param index Index of the attribute. + * + * Returns the attribute's name, NULL on error. + */ +extern const char * +bt_ctf_event_class_get_attribute_name( + struct bt_ctf_event_class *event_class, int index); + +/* + * bt_ctf_event_class_get_attribute_value: get attribute value (an object). + * + * Get an attribute's value (an object). The returned object's + * reference count is incremented. When done with the object, the caller + * must call bt_object_put() on it. + * + * @param event_class Event class. + * @param index Index of the attribute. + * + * Returns the attribute's object value, NULL on error. + */ +extern struct bt_object * +bt_ctf_event_class_get_attribute_value(struct bt_ctf_event_class *event_class, + int index); + +/* + * bt_ctf_event_class_get_attribute_value_by_name: get attribute + * value (an object) by name. + * + * Get an attribute's value (an object) by its name. The returned object's + * reference count is incremented. When done with the object, the caller + * must call bt_object_put() on it. + * + * @param event_class Event class. + * @param name Attribute's name + * + * Returns the attribute's object value, NULL on error. + */ +extern struct bt_object * +bt_ctf_event_class_get_attribute_value_by_name( + struct bt_ctf_event_class *event_class, const char *name); + /* * bt_ctf_event_class_get_stream_class: Get an event class' stream class. * -- 2.34.1