Implement bt_ctf_event_class_get/set_payload()

Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

diff --git a/formats/ctf/ir/event.c b/formats/ctf/ir/event.c
index c4fe4b4870726a0310a4abdf5b4fc9834ad680cc..2c1dad47500b1480569369ab581d776bb9933ee1 100644 (file)
--- a/formats/ctf/ir/event.c
+++ b/formats/ctf/ir/event.c
@@ -59,6 +59,13 @@ struct bt_ctf_event_class *bt_ctf_event_class_create(const char *name)
        }
 
        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;
+       }
+
        event_class->name = g_quark_from_string(name);
 end:
        return event_class;
@@ -131,6 +138,38 @@ end:
        return stream_class;
 }
 
+struct bt_ctf_field_type *bt_ctf_event_class_get_payload_type(
+               struct bt_ctf_event_class *event_class)
+{
+       struct bt_ctf_field_type *payload = NULL;
+
+       if (!event_class) {
+               goto end;
+       }
+
+       bt_ctf_field_type_get(event_class->fields);
+       payload = event_class->fields;
+end:
+       return payload;
+}
+
+int bt_ctf_event_class_set_payload_type(struct bt_ctf_event_class *event_class,
+               struct bt_ctf_field_type *payload)
+{
+       int ret = 0;
+
+       if (!event_class || !payload) {
+               ret = -1;
+               goto end;
+       }
+
+       bt_ctf_field_type_get(payload);
+       bt_ctf_field_type_put(event_class->fields);
+       event_class->fields = payload;
+end:
+       return ret;
+}
+
 int bt_ctf_event_class_add_field(struct bt_ctf_event_class *event_class,
                struct bt_ctf_field_type *type,
                const char *name)
@@ -143,12 +182,10 @@ int bt_ctf_event_class_add_field(struct bt_ctf_event_class *event_class,
                goto end;
        }
 
-       if (!event_class->fields) {
-               event_class->fields = bt_ctf_field_type_structure_create();
-               if (!event_class->fields) {
-                       ret = -1;
-                       goto end;
-               }
+       if (bt_ctf_field_type_get_type_id(event_class->fields) !=
+               CTF_TYPE_STRUCT) {
+               ret = -1;
+               goto end;
        }
 
        ret = bt_ctf_field_type_structure_add_field(event_class->fields,
@@ -167,6 +204,12 @@ int bt_ctf_event_class_get_field_count(
                goto end;
        }
 
+       if (bt_ctf_field_type_get_type_id(event_class->fields) !=
+               CTF_TYPE_STRUCT) {
+               ret = -1;
+               goto end;
+       }
+
        ret = bt_ctf_field_type_structure_get_field_count(event_class->fields);
 end:
        return ret;
@@ -183,6 +226,12 @@ int bt_ctf_event_class_get_field(struct bt_ctf_event_class *event_class,
                goto end;
        }
 
+       if (bt_ctf_field_type_get_type_id(event_class->fields) !=
+               CTF_TYPE_STRUCT) {
+               ret = -1;
+               goto end;
+       }
+
        ret = bt_ctf_field_type_structure_get_field(event_class->fields,
                field_name, field_type, index);
 end:
@@ -199,6 +248,11 @@ struct bt_ctf_field_type *bt_ctf_event_class_get_field_by_name(
                goto end;
        }
 
+       if (bt_ctf_field_type_get_type_id(event_class->fields) !=
+               CTF_TYPE_STRUCT) {
+               goto end;
+       }
+
        name_quark = g_quark_try_string(name);
        if (!name_quark) {
                goto end;
@@ -378,17 +432,32 @@ end:
 
 int bt_ctf_event_set_payload(struct bt_ctf_event *event,
                const char *name,
-               struct bt_ctf_field *value)
+               struct bt_ctf_field *payload)
 {
        int ret = 0;
 
-       if (!event || !value || bt_ctf_validate_identifier(name)) {
+       if (!event || !payload) {
                ret = -1;
                goto end;
        }
 
-       ret = bt_ctf_field_structure_set_field(event->fields_payload,
-               name, value);
+       if (name) {
+               ret = bt_ctf_field_structure_set_field(event->fields_payload,
+                       name, payload);
+       } else {
+               struct bt_ctf_field_type *payload_type;
+
+               payload_type = bt_ctf_field_get_type(payload);
+               if (payload_type == event->event_class->fields) {
+                       bt_ctf_field_put(event->fields_payload);
+                       bt_ctf_field_get(payload);
+                       event->fields_payload = payload;
+               } else {
+                       ret = -1;
+               }
+
+               bt_ctf_field_type_put(payload_type);
+       }
 end:
        return ret;
 }
@@ -399,11 +468,17 @@ struct bt_ctf_field *bt_ctf_event_get_payload(struct bt_ctf_event *event,
 {
        struct bt_ctf_field *field = NULL;
 
-       if (!event || !name) {
+       if (!event) {
                goto end;
        }
 
-       field = bt_ctf_field_structure_get_field(event->fields_payload, name);
+       if (name) {
+               field = bt_ctf_field_structure_get_field(event->fields_payload,
+                       name);
+       } else {
+               field = event->fields_payload;
+               bt_ctf_field_get(field);
+       }
 end:
        return field;
 }

diff --git a/include/babeltrace/ctf-ir/event.h b/include/babeltrace/ctf-ir/event.h
index 30b790035456eefbd4ffff13a3fe45e09522b7c0..83aa044a908e32a744899a84008f6f775d15aa0d 100644 (file)
--- a/include/babeltrace/ctf-ir/event.h
+++ b/include/babeltrace/ctf-ir/event.h
@@ -102,6 +102,32 @@ extern int bt_ctf_event_class_set_id(
 extern struct bt_ctf_stream_class *bt_ctf_event_class_get_stream_class(
                struct bt_ctf_event_class *event_class);
 
+/*
+ * bt_ctf_event_class_get_payload_type: get an event class' payload.
+ *
+ * Get an event class' payload type.
+ *
+ * @param event_class Event class.
+ *
+ * Returns the event class' payload, NULL on error.
+ */
+extern struct bt_ctf_field_type *bt_ctf_event_class_get_payload_type(
+               struct bt_ctf_event_class *event_class);
+
+/*
+ * bt_ctf_event_class_set_payload_type: set an event class' payload.
+ *
+ * Set an event class' payload type.
+ *
+ * @param event_class Event class.
+ * @param payload The payload's type.
+ *
+ * Returns 0 on success, a negative value on error.
+ */
+extern int bt_ctf_event_class_set_payload_type(
+               struct bt_ctf_event_class *event_class,
+               struct bt_ctf_field_type *payload);
+
 /*
  * bt_ctf_event_class_add_field: add a field to an event class.
  *
@@ -114,6 +140,8 @@ extern struct bt_ctf_stream_class *bt_ctf_event_class_get_stream_class(
  * @param name Name of the new field.
  *
  * Returns 0 on success, a negative value on error.
+ *
+ * Note: Returns an error if the payload is not a structure.
  */
 extern int bt_ctf_event_class_add_field(struct bt_ctf_event_class *event_class,
                struct bt_ctf_field_type *type,
@@ -125,6 +153,8 @@ extern int bt_ctf_event_class_add_field(struct bt_ctf_event_class *event_class,
  * @param event_class Event class.
  *
  * Returns the event class' field count, a negative value on error.
+ *
+ * Note: Returns an error if the payload is not a structure.
  */
 extern int bt_ctf_event_class_get_field_count(
                struct bt_ctf_event_class *event_class);
@@ -140,6 +170,8 @@ extern int bt_ctf_event_class_get_field_count(
  * @param index Index of field.
  *
  * Returns 0 on success, a negative error on value.
+ *
+ * Note: Returns an error if the payload is not a structure.
  */
 extern int bt_ctf_event_class_get_field(struct bt_ctf_event_class *event_class,
                const char **field_name, struct bt_ctf_field_type **field_type,
@@ -152,6 +184,8 @@ extern int bt_ctf_event_class_get_field(struct bt_ctf_event_class *event_class,
  * @param name Name of the field.
  *
  * Returns a field type on success, NULL on error.
+ *
+ * Note: Returns an error if the payload is not a structure.
  */
 extern struct bt_ctf_field_type *bt_ctf_event_class_get_field_by_name(
                struct bt_ctf_event_class *event_class, const char *name);
@@ -239,9 +273,13 @@ extern struct bt_ctf_clock *bt_ctf_event_get_clock(
  * returned value.
  *
  * @param event Event instance.
- * @param name Event field name.
+ * @param name Event field name, see notes.
  *
  * Returns a field instance on success, NULL on error.
+ *
+ * Note: Passing a name will cause the function to perform a look-up by
+ *     name assuming the event's payload is a structure. This will return
+ *     the raw payload instance if name is NULL.
  */
 extern struct bt_ctf_field *bt_ctf_event_get_payload(struct bt_ctf_event *event,
                const char *name);
@@ -254,10 +292,14 @@ extern struct bt_ctf_field *bt_ctf_event_get_payload(struct bt_ctf_event *event,
  * bt_ctf_field_put() must be called on the returned value.
  *
  * @param event Event instance.
- * @param name Event field name.
+ * @param name Event field name, see notes.
  * @param value Instance of a field whose type corresponds to the event's field.
  *
  * Returns 0 on success, a negative value on error.
+ *
+ * Note: The function will return an error if a name is provided and the payload
+ *     type is not a structure. If name is NULL, the payload field will be set
+ *     directly and must match the event class' payload's type.
  */
 extern int bt_ctf_event_set_payload(struct bt_ctf_event *event,
                const char *name,
@@ -274,6 +316,8 @@ extern int bt_ctf_event_set_payload(struct bt_ctf_event *event,
  * @param index Index of field.
  *
  * Returns the event's field, NULL on error.
+ *
+ * Note: Will return an error if the payload's type is not a structure.
  */
 extern struct bt_ctf_field *bt_ctf_event_get_payload_by_index(
                struct bt_ctf_event *event, int index);