* http://www.efficios.com/ctf
*/
-#include <babeltrace/ctf/events.h>
#include <stdint.h>
#ifdef __cplusplus
struct bt_ctf_event;
struct bt_ctf_field_type;
struct bt_ctf_field;
+struct bt_ctf_field_path;
+
+/*
+ * Babeltrace 1.x enumerations that were also used in CTF writer's API.
+ * They are left here for backward compatibility reasons, but
+ * enum bt_ctf_type_id and enum bt_ctf_string_encoding should be used
+ * in new code. Both new enumerations are compatible with their legacy
+ * counterpart.
+ */
+enum ctf_type_id {
+ CTF_TYPE_UNKNOWN = 0,
+ CTF_TYPE_INTEGER,
+ CTF_TYPE_FLOAT,
+ CTF_TYPE_ENUM,
+ CTF_TYPE_STRING,
+ CTF_TYPE_STRUCT,
+ CTF_TYPE_UNTAGGED_VARIANT,
+ CTF_TYPE_VARIANT,
+ CTF_TYPE_ARRAY,
+ CTF_TYPE_SEQUENCE,
+ NR_CTF_TYPES,
+};
+
+/*
+ * Old enum.
+ */
+enum ctf_string_encoding {
+ CTF_STRING_NONE = 0,
+ CTF_STRING_UTF8,
+ CTF_STRING_ASCII,
+ CTF_STRING_UNKNOWN,
+};
+
+enum bt_ctf_type_id {
+ BT_CTF_TYPE_ID_UNKNOWN = CTF_TYPE_UNKNOWN,
+ BT_CTF_TYPE_ID_INTEGER = CTF_TYPE_INTEGER,
+ BT_CTF_TYPE_ID_FLOAT = CTF_TYPE_FLOAT,
+ BT_CTF_TYPE_ID_ENUM = CTF_TYPE_ENUM,
+ BT_CTF_TYPE_ID_STRING = CTF_TYPE_STRING,
+ BT_CTF_TYPE_ID_STRUCT = CTF_TYPE_STRUCT,
+ BT_CTF_TYPE_ID_UNTAGGED_VARIANT = CTF_TYPE_UNTAGGED_VARIANT,
+ BT_CTF_TYPE_ID_VARIANT = CTF_TYPE_VARIANT,
+ BT_CTF_TYPE_ID_ARRAY = CTF_TYPE_ARRAY,
+ BT_CTF_TYPE_ID_SEQUENCE = CTF_TYPE_SEQUENCE,
+ BT_CTF_NR_TYPE_IDS,
+};
enum bt_ctf_integer_base {
BT_CTF_INTEGER_BASE_UNKNOWN = -1,
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,
BT_CTF_BYTE_ORDER_NETWORK,
};
+enum bt_ctf_string_encoding {
+ BT_CTF_STRING_ENCODING_NONE = CTF_STRING_NONE,
+ BT_CTF_STRING_ENCODING_UTF8 = CTF_STRING_UTF8,
+ BT_CTF_STRING_ENCODING_ASCII = CTF_STRING_ASCII,
+ BT_CTF_STRING_ENCODING_UNKNOWN = CTF_STRING_UNKNOWN,
+};
+
+enum bt_ctf_scope {
+ BT_CTF_SCOPE_UNKNOWN = -1,
+ BT_CTF_SCOPE_ENV = 0,
+ BT_CTF_SCOPE_TRACE_PACKET_HEADER = 1,
+ BT_CTF_SCOPE_STREAM_PACKET_CONTEXT = 2,
+ BT_CTF_SCOPE_STREAM_EVENT_HEADER = 3,
+ BT_CTF_SCOPE_STREAM_EVENT_CONTEXT = 4,
+ BT_CTF_SCOPE_EVENT_CONTEXT = 5,
+ BT_CTF_SCOPE_EVENT_FIELDS = 6,
+};
+
/*
* 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.
*
*
* @param integer Integer type.
*
- * Returns the string field's encoding on success, CTF_STRING_UNKNOWN on error.
+ * Returns the string field's encoding on success,
+ * BT_CTF_STRING_ENCODING_UNKNOWN on error.
*/
-extern enum ctf_string_encoding bt_ctf_field_type_integer_get_encoding(
+extern enum bt_ctf_string_encoding bt_ctf_field_type_integer_get_encoding(
struct bt_ctf_field_type *integer);
/*
* a text character.
*
* @param integer Integer type.
- * @param encoding Integer output encoding, defaults to CTF_STRING_ENCODING_NONE
+ * @param encoding Integer output encoding, defaults to
+ * BT_CTF_STRING_ENCODING_NONE
*
* Returns 0 on success, a negative value on error.
*/
extern int bt_ctf_field_type_integer_set_encoding(
struct bt_ctf_field_type *integer,
- enum ctf_string_encoding encoding);
+ enum bt_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.
*
* 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);
/*
* 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);
/*
* 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);
*
* @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
*
* @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
*
* @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.
*
* 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);
/*
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
*
* @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);
*
* @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.
*
*
* 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);
/*
*/
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.
*
* @param string_type String type.
*
- * Returns the string's encoding on success, a CTF_STRING_UNKNOWN on error.
+ * Returns the string's encoding on success, a BT_CTF_STRING_ENCODING_UNKNOWN
+ * on error.
*/
-extern enum ctf_string_encoding bt_ctf_field_type_string_get_encoding(
+extern enum bt_ctf_string_encoding bt_ctf_field_type_string_get_encoding(
struct bt_ctf_field_type *string_type);
/*
* Set the string type's encoding.
*
* @param string_type String type.
- * @param encoding String field encoding, default CTF_STRING_ENCODING_ASCII.
- * Valid values are CTF_STRING_ENCODING_ASCII and CTF_STRING_ENCODING_UTF8.
+ * @param encoding String field encoding, default BT_CTF_STRING_ENCODING_ASCII.
+ * Valid values are BT_CTF_STRING_ENCODING_ASCII and
+ * BT_CTF_STRING_ENCODING_UTF8.
*
* Returns 0 on success, a negative value on error.
*/
extern int bt_ctf_field_type_string_set_encoding(
struct bt_ctf_field_type *string_type,
- enum ctf_string_encoding encoding);
+ enum bt_ctf_string_encoding encoding);
/*
* bt_ctf_field_type_get_alignment: get a field type's alignment.
*
* @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);
*
* @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.
*/
enum bt_ctf_byte_order byte_order);
/*
- * bt_ctf_field_type_get_type_id: get a field type's ctf_type_id.
+ * bt_ctf_field_type_variant_get_tag_field_path: get a variant's tag's field
+ * path.
+ *
+ * Get the variant's tag's field path.
*
* @param type Field type.
*
- * Returns the field type's ctf_type_id, CTF_TYPE_UNKNOWN on error.
+ * Returns the field path on success, NULL on error or if no field path is set.
*/
-extern enum ctf_type_id bt_ctf_field_type_get_type_id(
+extern struct bt_ctf_field_path *bt_ctf_field_type_variant_get_tag_field_path(
struct bt_ctf_field_type *type);
/*
- * bt_ctf_field_type_get_alias_nameL get a field type's alias name
+ * bt_ctf_field_type_sequence_get_length_field_path: get a sequence's length's
+ * field path.
+ *
+ * Get the sequence's length's field path.
*
- * A type's alias name is set if it was resolved from a typedef or
- * typealias. Note that types that are resolved from a ypealias or
- * typedef are distinct from the underlying type and can't be compared
- * pointer-wise.
+ * @param type Field type.
+ *
+ * Returns the field path on success, NULL on error or if no field path is set.
+ */
+extern struct bt_ctf_field_path *bt_ctf_field_type_sequence_get_length_field_path(
+ struct bt_ctf_field_type *type);
+
+/*
+ * bt_ctf_field_type_compare: compare two field types recursively
+ *
+ * Compare two field types recursively.
+ *
+ * The registered tag field type of a variant field type is ignored:
+ * only the tag strings are compared.
+ *
+ * @param type_a Field type A.
+ * @param type_b Field type B.
+ *
+ * Returns 0 if both field types are semantically equivalent, a positive
+ * value if they are not equivalent, or a negative value on error.
+ */
+extern int bt_ctf_field_type_compare(struct bt_ctf_field_type *type_a,
+ struct bt_ctf_field_type *type_b);
+
+/*
+ * bt_ctf_field_type_get_type_id: get a field type's bt_ctf_type_id.
*
* @param type Field type.
*
- * Returns a field type's alias name, NULL on error.
+ * Returns the field type's bt_ctf_type_id, CTF_TYPE_UNKNOWN on error.
*/
-extern const char *bt_ctf_field_type_get_alias_name(
+extern enum bt_ctf_type_id bt_ctf_field_type_get_type_id(
struct bt_ctf_field_type *type);
+/*
+ * bt_ctf_field_type_is_integer: returns whether or not a given field
+ * type is an integer type.
+ *
+ * @param type Field type.
+ *
+ * Returns 1 if the field type is an integer type, 0 otherwise.
+ */
+extern int bt_ctf_field_type_is_integer(struct bt_ctf_field_type *type);
+
+/*
+ * bt_ctf_field_type_is_floating_point: returns whether or not a given field
+ * type is a floating point number type.
+ *
+ * @param type Field type.
+ *
+ * Returns 1 if the field type is a floating point number type, 0 otherwise.
+ */
+extern int bt_ctf_field_type_is_floating_point(struct bt_ctf_field_type *type);
+
+/*
+ * bt_ctf_field_type_is_enumeration: returns whether or not a given field
+ * type is an enumeration type.
+ *
+ * @param type Field type.
+ *
+ * Returns 1 if the field type is an enumeration type, 0 otherwise.
+ */
+extern int bt_ctf_field_type_is_enumeration(struct bt_ctf_field_type *type);
+
+/*
+ * bt_ctf_field_type_is_string: returns whether or not a given field
+ * type is a string type.
+ *
+ * @param type Field type.
+ *
+ * Returns 1 if the field type is a string type, 0 otherwise.
+ */
+extern int bt_ctf_field_type_is_string(struct bt_ctf_field_type *type);
+
+/*
+ * bt_ctf_field_type_is_structure: returns whether or not a given field
+ * type is a structure type.
+ *
+ * @param type Field type.
+ *
+ * Returns 1 if the field type is a structure type, 0 otherwise.
+ */
+extern int bt_ctf_field_type_is_structure(struct bt_ctf_field_type *type);
+
+/*
+ * bt_ctf_field_type_is_array: returns whether or not a given field
+ * type is an array type.
+ *
+ * @param type Field type.
+ *
+ * Returns 1 if the field type is an array type, 0 otherwise.
+ */
+extern int bt_ctf_field_type_is_array(struct bt_ctf_field_type *type);
+
+/*
+ * bt_ctf_field_type_is_sequence: returns whether or not a given field
+ * type is a sequence type.
+ *
+ * @param type Field type.
+ *
+ * Returns 1 if the field type is a sequence type, 0 otherwise.
+ */
+extern int bt_ctf_field_type_is_sequence(struct bt_ctf_field_type *type);
+
+/*
+ * bt_ctf_field_type_is_variant: returns whether or not a given field
+ * type is a variant type.
+ *
+ * @param type Field type.
+ *
+ * Returns 1 if the field type is a variant type, 0 otherwise.
+ */
+extern int bt_ctf_field_type_is_variant(struct bt_ctf_field_type *type);
+
/*
* 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
projects / babeltrace.git / blobdiff