lib: field path: have a specific item for "current array element"

[babeltrace.git] / include / babeltrace / common-internal.h

diff --git a/include/babeltrace/common-internal.h b/include/babeltrace/common-internal.h
index eebe592616b959c9c41948bf2118722199476e12..0e84e8fa49007b706e1214195cb1507e14a34eb1 100644 (file)
--- a/include/babeltrace/common-internal.h
+++ b/include/babeltrace/common-internal.h
@@ -30,6 +30,7 @@
 #include <babeltrace/trace-ir/field-class-const.h>
 #include <babeltrace/trace-ir/field-path-const.h>
 #include <babeltrace/trace-ir/event-class-const.h>
+#include <babeltrace/graph/self-message-iterator.h>
 #include <babeltrace/value.h>
 #include <stdarg.h>
 #include <inttypes.h>
@@ -354,12 +355,8 @@ static inline
 const char *bt_common_scope_string(enum bt_scope scope)
 {
        switch (scope) {
-       case BT_SCOPE_PACKET_HEADER:
-               return "BT_SCOPE_PACKET_HEADER";
        case BT_SCOPE_PACKET_CONTEXT:
                return "BT_SCOPE_PACKET_CONTEXT";
-       case BT_SCOPE_EVENT_HEADER:
-               return "BT_SCOPE_EVENT_HEADER";
        case BT_SCOPE_EVENT_COMMON_CONTEXT:
                return "BT_SCOPE_EVENT_COMMON_CONTEXT";
        case BT_SCOPE_EVENT_SPECIFIC_CONTEXT:
@@ -435,7 +432,7 @@ const char *bt_common_value_type_string(enum bt_value_type type)
 };
 
 static inline
-GString *bt_field_path_string(struct bt_field_path *path)
+GString *bt_common_field_path_string(struct bt_field_path *path)
 {
        GString *str = g_string_new(NULL);
        uint64_t i;
@@ -449,9 +446,21 @@ GString *bt_field_path_string(struct bt_field_path *path)
        g_string_append_printf(str, "[%s", bt_common_scope_string(
                bt_field_path_get_root_scope(path)));
 
-       for (i = 0; i < bt_field_path_get_index_count(path); i++) {
-               g_string_append_printf(str, ", %" PRIu64,
-                       bt_field_path_get_index_by_index(path, i));
+       for (i = 0; i < bt_field_path_get_item_count(path); i++) {
+               const struct bt_field_path_item *fp_item =
+                       bt_field_path_borrow_item_by_index_const(path, i);
+
+               switch (bt_field_path_item_get_type(fp_item)) {
+               case BT_FIELD_PATH_ITEM_TYPE_INDEX:
+                       g_string_append_printf(str, ", %" PRIu64,
+                               bt_field_path_item_index_get_index(fp_item));
+                       break;
+               case BT_FIELD_PATH_ITEM_TYPE_CURRENT_ARRAY_ELEMENT:
+                       g_string_append(str, ", <CUR>");
+                       break;
+               default:
+                       abort();
+               }
        }
 
        g_string_append(str, "]");
@@ -460,4 +469,121 @@ end:
        return str;
 }
 
+static inline
+const char *bt_common_self_message_iterator_status_string(
+               enum bt_self_message_iterator_status status)
+{
+       switch (status) {
+       case BT_SELF_MESSAGE_ITERATOR_STATUS_AGAIN:
+               return "BT_SELF_MESSAGE_ITERATOR_STATUS_AGAIN";
+       case BT_SELF_MESSAGE_ITERATOR_STATUS_END:
+               return "BT_SELF_MESSAGE_ITERATOR_STATUS_END";
+       case BT_SELF_MESSAGE_ITERATOR_STATUS_OK:
+               return "BT_SELF_MESSAGE_ITERATOR_STATUS_OK";
+       case BT_SELF_MESSAGE_ITERATOR_STATUS_ERROR:
+               return "BT_SELF_MESSAGE_ITERATOR_STATUS_ERROR";
+       case BT_SELF_MESSAGE_ITERATOR_STATUS_NOMEM:
+               return "BT_SELF_MESSAGE_ITERATOR_STATUS_NOMEM";
+       default:
+               return "(unknown)";
+       }
+};
+
+#define NS_PER_S_I     INT64_C(1000000000)
+#define NS_PER_S_U     UINT64_C(1000000000)
+
+static inline
+int bt_common_clock_value_from_ns_from_origin(
+               int64_t cc_offset_seconds, uint64_t cc_offset_cycles,
+               uint64_t cc_freq, int64_t ns_from_origin,
+               uint64_t *raw_value)
+{
+       int ret = 0;
+       int64_t offset_in_ns;
+       uint64_t value_in_ns;
+       uint64_t rem_value_in_ns;
+       uint64_t value_periods;
+       uint64_t value_period_cycles;
+       int64_t ns_to_add;
+
+       BT_ASSERT(raw_value);
+
+       /* Compute offset part of requested value, in nanoseconds */
+       if (!bt_safe_to_mul_int64(cc_offset_seconds, NS_PER_S_I)) {
+               ret = -1;
+               goto end;
+       }
+
+       offset_in_ns = cc_offset_seconds * NS_PER_S_I;
+
+       if (cc_freq == NS_PER_S_U) {
+               ns_to_add = (int64_t) cc_offset_cycles;
+       } else {
+               if (!bt_safe_to_mul_int64((int64_t) cc_offset_cycles,
+                               NS_PER_S_I)) {
+                       ret = -1;
+                       goto end;
+               }
+
+               ns_to_add = ((int64_t) cc_offset_cycles * NS_PER_S_I) /
+                       (int64_t) cc_freq;
+       }
+
+       if (!bt_safe_to_add_int64(offset_in_ns, ns_to_add)) {
+               ret = -1;
+               goto end;
+       }
+
+       offset_in_ns += ns_to_add;
+
+       /* Value part in nanoseconds */
+       if (ns_from_origin < offset_in_ns) {
+               ret = -1;
+               goto end;
+       }
+
+       value_in_ns = (uint64_t) (ns_from_origin - offset_in_ns);
+
+       /* Number of whole clock periods in `value_in_ns` */
+       value_periods = value_in_ns / NS_PER_S_U;
+
+       /* Remaining nanoseconds in cycles + whole clock periods in cycles */
+       rem_value_in_ns = value_in_ns - value_periods * NS_PER_S_U;
+
+       if (value_periods > UINT64_MAX / cc_freq) {
+               ret = -1;
+               goto end;
+       }
+
+       if (!bt_safe_to_mul_uint64(value_periods, cc_freq)) {
+               ret = -1;
+               goto end;
+       }
+
+       value_period_cycles = value_periods * cc_freq;
+
+       if (!bt_safe_to_mul_uint64(cc_freq, rem_value_in_ns)) {
+               ret = -1;
+               goto end;
+       }
+
+       if (!bt_safe_to_add_uint64(cc_freq * rem_value_in_ns / NS_PER_S_U,
+                       value_period_cycles)) {
+               ret = -1;
+               goto end;
+       }
+
+       *raw_value = cc_freq * rem_value_in_ns / NS_PER_S_U +
+               value_period_cycles;
+
+end:
+       return ret;
+}
+
+static inline
+enum bt_self_message_iterator_status bt_common_message_iterator_status_to_self(
+               enum bt_message_iterator_status status)
+{
+       return (int) status;
+}
 #endif /* BABELTRACE_COMMON_INTERNAL_H */