Add support for clock mapping on integer field type

[babeltrace.git] / include / babeltrace / ctf-ir / event-types.h

diff --git a/include/babeltrace/ctf-ir/event-types.h b/include/babeltrace/ctf-ir/event-types.h
index d445812f4363292a16ccfd0a01967e9a7d1de7bd..774a88ed651d402c3fb20b82a3d6694463ae6518 100644 (file)
--- a/include/babeltrace/ctf-ir/event-types.h
+++ b/include/babeltrace/ctf-ir/event-types.h
@@ -52,6 +52,11 @@ enum bt_ctf_integer_base {
 
 enum bt_ctf_byte_order {
        BT_CTF_BYTE_ORDER_UNKNOWN = -1,
+       /*
+        * Note that native, in the context of the CTF specification, is defined as
+        * "the byte order described in the trace" and does not mean that the host's
+        * endianness will be used.
+        */
        BT_CTF_BYTE_ORDER_NATIVE = 0,
        BT_CTF_BYTE_ORDER_LITTLE_ENDIAN,
        BT_CTF_BYTE_ORDER_BIG_ENDIAN,
@@ -159,6 +164,28 @@ extern int bt_ctf_field_type_integer_set_encoding(
                struct bt_ctf_field_type *integer,
                enum ctf_string_encoding encoding);
 
+/**
+ * bt_ctf_field_type_integer_get_mapped_clock: get an integer type's mapped clock.
+ *
+ * @param integer Integer type.
+ *
+ * Returns the integer's mapped clock (if any), NULL on error.
+ */
+extern struct bt_ctf_clock *bt_ctf_field_type_integer_get_mapped_clock(
+               struct bt_ctf_field_type *integer);
+
+/**
+ * bt_ctf_field_type_integer_set_mapped_clock: set an integer type's mapped clock.
+ *
+ * @param integer Integer type.
+ * @param clock Clock to map.
+ *
+ * Returns 0 on success, a negative value on error.
+ */
+extern int bt_ctf_field_type_integer_set_mapped_clock(
+               struct bt_ctf_field_type *integer,
+               struct bt_ctf_clock *clock);
+
 /*
  * bt_ctf_field_type_enumeration_create: create an enumeration field type.
  *
@@ -695,7 +722,7 @@ extern enum bt_ctf_byte_order bt_ctf_field_type_get_byte_order(
  *
  * @param type Field type.
  * @param byte_order Field type's byte order. Defaults to
- * BT_CTF_BYTE_ORDER_NATIVE, the host machine's endianness.
+ * BT_CTF_BYTE_ORDER_NATIVE; the trace's endianness.
  *
  * Returns 0 on success, a negative value on error.
  */