struct bt_ctf_event;
struct bt_ctf_field_type;
struct bt_ctf_field;
+struct bt_ctf_field_path;
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.
+ * 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_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.
*
*
* @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.
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.
*
*
* @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);
extern int bt_ctf_field_type_set_byte_order(struct bt_ctf_field_type *type,
enum bt_ctf_byte_order byte_order);
+/*
+ * 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 path on success, NULL on error or if no field path is set.
+ */
+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_sequence_get_length_field_path: get a sequence's length's
+ * field path.
+ *
+ * Get the sequence's length's field path.
+ *
+ * @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 ctf_type_id.
*
extern enum 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