X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=include%2Fbabeltrace%2Fctf-ir%2Fevent-types.h;h=d777ce6b40603c23ff438ea28ec38e45fd561c2b;hb=de3dd40e6fcad56e227f5fc8a8290fbaa88b4e07;hp=96200ce42d2d06d996b6ede6483345ac887abf55;hpb=b92ddaaaabecef22b73d6276d19a0f9ddc700720;p=babeltrace.git

diff --git a/include/babeltrace/ctf-ir/event-types.h b/include/babeltrace/ctf-ir/event-types.h
index 96200ce4..d777ce6b 100644
--- 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,
@@ -62,7 +67,7 @@ enum bt_ctf_byte_order {
  * bt_ctf_field_type_integer_create: create an integer field type.
  *
  * Allocate a new integer field type of the given size. The creation of a field
- * type sets its reference countto 1.
+ * type sets its reference count to 1.
  *
  * @param size Integer field type size/length in bits.
  *
@@ -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.
  *
@@ -229,7 +256,7 @@ extern int bt_ctf_field_type_enumeration_add_mapping_unsigned(
  *
  * Returns the mapping count on success, a negative value on error.
  */
-extern int64_t bt_ctf_field_type_enumeration_get_mapping_count(
+extern int bt_ctf_field_type_enumeration_get_mapping_count(
 		struct bt_ctf_field_type *enumeration);
 
 /*
@@ -247,7 +274,7 @@ extern int64_t bt_ctf_field_type_enumeration_get_mapping_count(
  * Returns 0 on success, a negative value on error.
  */
 extern int bt_ctf_field_type_enumeration_get_mapping(
-		struct bt_ctf_field_type *enumeration, size_t index,
+		struct bt_ctf_field_type *enumeration, int index,
 		const char **name, int64_t *range_start, int64_t *range_end);
 
 /*
@@ -265,7 +292,7 @@ extern int bt_ctf_field_type_enumeration_get_mapping(
  * Returns 0 on success, a negative value on error.
  */
 extern int bt_ctf_field_type_enumeration_get_mapping_unsigned(
-		struct bt_ctf_field_type *enumeration, size_t index,
+		struct bt_ctf_field_type *enumeration, int index,
 		const char **name, uint64_t *range_start,
 		uint64_t *range_end);
 
@@ -275,13 +302,11 @@ extern int bt_ctf_field_type_enumeration_get_mapping_unsigned(
  *
  * @param enumeration Enumeration type.
  * @param name Mapping name.
- * @param index Pointer where the enumeration's mapping index will be returned.
  *
- * Returns 0 on success, a negative value on error.
+ * Returns mapping index on success, a negative value on error.
  */
 extern int bt_ctf_field_type_enumeration_get_mapping_index_by_name(
-		struct bt_ctf_field_type *enumeration, const char *name,
-		size_t *index);
+		struct bt_ctf_field_type *enumeration, const char *name);
 
 /*
  * bt_ctf_field_type_enumeration_get_mapping_index_by_value: get an
@@ -289,13 +314,11 @@ extern int bt_ctf_field_type_enumeration_get_mapping_index_by_name(
  *
  * @param enumeration Enumeration type.
  * @param value Value.
- * @param index Pointer where the enumeration's mapping index will be returned.
  *
- * Returns 0 on success, a negative value on error.
+ * Returns mapping index on success, a negative value on error.
  */
 extern int bt_ctf_field_type_enumeration_get_mapping_index_by_value(
-		struct bt_ctf_field_type *enumeration, int64_t value,
-		size_t *index);
+		struct bt_ctf_field_type *enumeration, int64_t value);
 
 /*
  * bt_ctf_field_type_enumeration_get_mapping_index_by_unsigned_value: get an
@@ -303,13 +326,11 @@ extern int bt_ctf_field_type_enumeration_get_mapping_index_by_value(
  *
  * @param enumeration Enumeration type.
  * @param value Value.
- * @param index Pointer where the enumeration's mapping index will be returned.
  *
  * Returns 0 on success, a negative value on error.
  */
 extern int bt_ctf_field_type_enumeration_get_mapping_index_by_unsigned_value(
-		struct bt_ctf_field_type *enumeration, uint64_t value,
-		size_t *index);
+		struct bt_ctf_field_type *enumeration, uint64_t value);
 
 /*
  * bt_ctf_field_type_floating_point_create: create a floating point field type.
@@ -412,7 +433,7 @@ extern int bt_ctf_field_type_structure_add_field(
  *
  * Returns the field count on success, a negative value on error.
  */
-extern int64_t bt_ctf_field_type_structure_get_field_count(
+extern int bt_ctf_field_type_structure_get_field_count(
 		struct bt_ctf_field_type *structure);
 
 /*
@@ -430,7 +451,7 @@ extern int64_t bt_ctf_field_type_structure_get_field_count(
 extern int bt_ctf_field_type_structure_get_field(
 		struct bt_ctf_field_type *structure,
 		const char **field_name, struct bt_ctf_field_type **field_type,
-		size_t index);
+		int index);
 
 /*
  * bt_ctf_field_type_structure_get_field_type_by_name: get a structure field's
@@ -465,7 +486,7 @@ extern struct bt_ctf_field_type *bt_ctf_field_type_variant_create(
  *
  * @param variant Variant type.
  *
- * Returns a field type instance on success, NULL on error.
+ * Returns a field type instance on success, NULL if unset.
  */
 extern struct bt_ctf_field_type *bt_ctf_field_type_variant_get_tag_type(
 		struct bt_ctf_field_type *variant);
@@ -475,11 +496,22 @@ extern struct bt_ctf_field_type *bt_ctf_field_type_variant_get_tag_type(
  *
  * @param variant Variant type.
  *
- * Returns the tag field's name, NULL on error.
+ * Returns the tag field's name, NULL if unset.
  */
 extern const char *bt_ctf_field_type_variant_get_tag_name(
 		struct bt_ctf_field_type *variant);
 
+/*
+ * bt_ctf_field_type_variant_set_tag_name: set a variant's tag name.
+ *
+ * @param variant Variant type.
+ * @param name Tag field name.
+ *
+ * Returns 0 on success, a negative value on error.
+ */
+extern int bt_ctf_field_type_variant_set_tag_name(
+		struct bt_ctf_field_type *variant, const char *name);
+
 /*
  * bt_ctf_field_type_variant_add_field: add a field to a variant.
  *
@@ -531,7 +563,7 @@ struct bt_ctf_field_type *bt_ctf_field_type_variant_get_field_type_from_tag(
  *
  * Returns the field count on success, a negative value on error.
  */
-extern int64_t bt_ctf_field_type_variant_get_field_count(
+extern int bt_ctf_field_type_variant_get_field_count(
 		struct bt_ctf_field_type *variant);
 
 /*
@@ -548,7 +580,7 @@ extern int64_t bt_ctf_field_type_variant_get_field_count(
  */
 extern int bt_ctf_field_type_variant_get_field(
 		struct bt_ctf_field_type *variant, const char **field_name,
-		struct bt_ctf_field_type **field_type, size_t index);
+		struct bt_ctf_field_type **field_type, int index);
 
 /*
  * bt_ctf_field_type_array_create: create an array field type.
@@ -665,7 +697,8 @@ extern int bt_ctf_field_type_string_set_encoding(
  *
  * @param type Field type.
  *
- * Returns the field type's alignment on success, a negative value on error.
+ * Returns the field type's alignment on success, a negative value on error and
+ * 0 if the alignment is undefined (as in the case of a variant).
  */
 extern int bt_ctf_field_type_get_alignment(struct bt_ctf_field_type *type);
 
@@ -701,7 +734,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.
  */
@@ -722,6 +755,8 @@ extern enum ctf_type_id bt_ctf_field_type_get_type_id(
  * bt_ctf_field_type_get and bt_ctf_field_type_put: increment and decrement
  * the field type's reference count.
  *
+ * You may also use bt_ctf_get() and bt_ctf_put() with field type objects.
+ *
  * These functions ensure that the field type won't be destroyed while it
  * is in use. The same number of get and put (plus one extra put to
  * release the initial reference done at creation) have to be done to