X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=include%2Fbabeltrace%2Fctf-ir%2Ftrace.h;h=a95e206ee4fc6790ccd5709b100658bbeb0781d8;hb=ac0c6bddcdde51dcbb46fc73c61d4f2330774451;hp=93878ebc3e837442e23ecc2ce0061adfd21d8918;hpb=c2f29fb98a1e9088434fe8872d68695afd8e9dd3;p=babeltrace.git diff --git a/include/babeltrace/ctf-ir/trace.h b/include/babeltrace/ctf-ir/trace.h index 93878ebc..a95e206e 100644 --- a/include/babeltrace/ctf-ir/trace.h +++ b/include/babeltrace/ctf-ir/trace.h @@ -56,14 +56,14 @@ You can obtain a trace class in two different modes: - Normal mode: use bt_ctf_trace_create() to create a default, empty trace class. -- CTF IR writer mode: use bt_ctf_writer_get_trace() to - get the trace class created by a given CTF IR writer object. +- CTF writer mode: use bt_ctf_writer_get_trace() to + get the trace class created by a given CTF writer object. A trace class has the following properties: - A \b name. - A default byte order: all the - \link ctfirfieldtype field types\endlink eventually part of the trace + \link ctfirfieldtypes field types\endlink eventually part of the trace class with a byte order set to #BT_CTF_BYTE_ORDER_NATIVE have this "real" byte order. - An \b environment, which is a custom key-value mapping. Keys are @@ -109,14 +109,14 @@ success: - bt_ctf_trace_add_stream_class() - bt_ctf_writer_create_stream() - (\link ctfirwriter CTF IR writer\endlink mode only) + (\link ctfwriter CTF writer\endlink mode only) You cannot modify a frozen trace class: it is considered immutable, except for: - Adding a stream class to it with bt_ctf_trace_add_stream_class(). -- Adding a clock class to it with bt_ctf_trace_add_clock(). +- Adding a clock class to it with bt_ctf_trace_add_clock_class(). - \link refs Reference counting\endlink. You can add a custom listener with bt_ctf_trace_add_listener() to get @@ -144,7 +144,7 @@ or if a clock class is added. struct bt_ctf_trace; struct bt_ctf_stream; struct bt_ctf_stream_class; -struct bt_ctf_clock; +struct bt_ctf_clock_class; /** @name Creation function @@ -478,11 +478,13 @@ extern int bt_ctf_trace_set_environment_field_string( @param[in] trace_class Trace class of which to get the packet header field type. @returns Packet header field type of \p trace_class, - or \c NULL on error. + or \c NULL if \p trace_class has no packet header field + type or on error. @prenotnull{trace_class} @postrefcountsame{trace_class} -@postsuccessrefcountretinc +@post On success, if the return value is a field type, its + reference count is incremented. @sa bt_ctf_trace_set_packet_header_type(): Sets the packet header field type of a given trace class. @@ -492,22 +494,29 @@ extern struct bt_ctf_field_type *bt_ctf_trace_get_packet_header_type( /** @brief Sets the packet header field type of the CTF IR trace class - \p trace_class to \p packet_context_type. + \p trace_class to \p packet_header_type, or unsets the current packet + header field type from \p trace_class. + +If \p packet_header_type is \c NULL, then this function unsets the current +packet header field type from \p trace_class, effectively making \p trace_class +a trace without a packet header field type. -As of Babeltrace \btversion, \p packet_context_type \em must be a -CTF IR structure field type object. +As of Babeltrace \btversion, if \p packet_header_type is not \c NULL, +\p packet_header_type \em must be a CTF IR structure field type object. @param[in] trace_class Trace class of which to set the packet header field type. -@param[in] packet_header_type Packet header field type. +@param[in] packet_header_type Packet header field type, or \c NULL to unset + the current packet header field type. @returns 0 on success, or a negative value on error. @prenotnull{trace_class} -@prenotnull{packet_header_type} @prehot{trace_class} -@preisstructft{packet_header_type} +@pre \p packet_header_type, if not \c NULL, is a CTF IR + structure field type. @postrefcountsame{trace_class} -@postsuccessrefcountinc{packet_header_type} +@post On success, if \p packet_header_type is not \c NULL, + the reference count of \p packet_header_type is incremented. @sa bt_ctf_trace_get_packet_header_type(): Returns the packet header field type of a given trace class. @@ -535,7 +544,7 @@ extern int bt_ctf_trace_set_packet_header_type(struct bt_ctf_trace *trace_class, @prenotnull{trace_class} @postrefcountsame{trace_class} */ -extern int bt_ctf_trace_get_clock_count(struct bt_ctf_trace *trace_class); +extern int bt_ctf_trace_get_clock_class_count(struct bt_ctf_trace *trace_class); /** @brief Returns the clock class at index \p index in the CTF IR trace @@ -549,14 +558,14 @@ extern int bt_ctf_trace_get_clock_count(struct bt_ctf_trace *trace_class); @prenotnull{trace_class} @pre \p index is lesser than the number of clock classes contained in the trace class \p trace_class (see - bt_ctf_trace_get_clock_count()). + bt_ctf_trace_get_clock_class_count()). @postrefcountsame{trace_class} @postsuccessrefcountretinc -@sa bt_ctf_trace_get_clock_by_name(): Finds a clock class by name. -@sa bt_ctf_trace_add_clock(): Adds a clock class to a trace class. +@sa bt_ctf_trace_get_clock_class_by_name(): Finds a clock class by name. +@sa bt_ctf_trace_add_clock_class(): Adds a clock class to a trace class. */ -extern struct bt_ctf_clock *bt_ctf_trace_get_clock( +extern struct bt_ctf_clock_class *bt_ctf_trace_get_clock_class( struct bt_ctf_trace *trace_class, int index); /** @@ -573,11 +582,11 @@ extern struct bt_ctf_clock *bt_ctf_trace_get_clock( @postrefcountsame{trace_class} @postsuccessrefcountretinc -@sa bt_ctf_trace_get_clock(): Returns the clock class contained in a - given trace class at a given index. -@sa bt_ctf_trace_add_clock(): Adds a clock class to a trace class. +@sa bt_ctf_trace_get_clock_class(): Returns the clock class contained + in a given trace class at a given index. +@sa bt_ctf_trace_add_clock_class(): Adds a clock class to a trace class. */ -extern struct bt_ctf_clock *bt_ctf_trace_get_clock_by_name( +extern struct bt_ctf_clock_class *bt_ctf_trace_get_clock_class_by_name( struct bt_ctf_trace *trace_class, const char *name); /** @@ -599,12 +608,12 @@ You can call this function even if \p trace_class is frozen. @post On success, if \p trace_class is frozen, \p clock_class is frozen. -@sa bt_ctf_trace_get_clock(): Returns the clock class contained in a - given trace class at a given index. -@sa bt_ctf_trace_get_clock_by_name(): Finds a clock class by name. +@sa bt_ctf_trace_get_clock_class(): Returns the clock class contained + in a given trace class at a given index. +@sa bt_ctf_trace_get_clock_class_by_name(): Finds a clock class by name. */ -extern int bt_ctf_trace_add_clock(struct bt_ctf_trace *trace_class, - struct bt_ctf_clock *clock_class); +extern int bt_ctf_trace_add_clock_class(struct bt_ctf_trace *trace_class, + struct bt_ctf_clock_class *clock_class); /** @} */ @@ -663,8 +672,8 @@ extern struct bt_ctf_stream_class *bt_ctf_trace_get_stream_class( @postrefcountsame{trace_class} @postsuccessrefcountretinc -@sa bt_ctf_trace_get_clock(): Returns the stream class contained in a - given trace class at a given index. +@sa bt_ctf_trace_get_stream_class(): Returns the stream class contained + in a given trace class at a given index. @sa bt_ctf_trace_add_stream_class(): Adds a stream class to a trace class. */ extern struct bt_ctf_stream_class *bt_ctf_trace_get_stream_class_by_id( @@ -680,6 +689,13 @@ You can only add a given stream class to one trace class. You can call this function even if \p trace_class is frozen. +This function tries to resolve the needed +\link ctfirfieldtypes CTF IR field type\endlink of the dynamic field +types that are found anywhere in the root field types of +\p stream_class and of all its currently contained +\link ctfireventclass CTF IR event classes\endlink. If any automatic +resolving fails, then this function fails. + @param[in] trace_class Trace class to which to add \p stream_class. @param[in] stream_class Stream class to add to \p trace_class. @returns 0 on success, or a negative value on error. @@ -690,8 +706,8 @@ You can call this function even if \p trace_class is frozen. @postsuccessrefcountinc{stream_class} @postsuccessfrozen{stream_class} -@sa bt_ctf_trace_get_clock(): Returns the stream class contained in a - given trace class at a given index. +@sa bt_ctf_trace_get_stream_class(): Returns the stream class contained + in a given trace class at a given index. @sa bt_ctf_trace_get_stream_class_by_id(): Finds a stream class by ID. */ extern int bt_ctf_trace_add_stream_class(struct bt_ctf_trace *trace_class, @@ -758,6 +774,8 @@ extern int bt_ctf_trace_visit(struct bt_ctf_trace *trace_class, /** @} */ +/** @} */ + /* * bt_ctf_trace_get_metadata_string: get metadata string. *