Also fix associated API doc.
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>
A trace class has the following properties:
- A \b name.
A trace class has the following properties:
- A \b name.
-- A <strong>default byte order</strong>: all the
+- A <strong>native byte order</strong>: all the
\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.
\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.
- <strong>Name</strong>: none. You can set a name
with bt_ctf_trace_set_name().
- <strong>Default byte order</strong>: #BT_CTF_BYTE_ORDER_NATIVE. You
- <strong>Name</strong>: none. You can set a name
with bt_ctf_trace_set_name().
- <strong>Default byte order</strong>: #BT_CTF_BYTE_ORDER_NATIVE. You
- can set a default byte order with bt_ctf_trace_set_native_byte_order().
+ can set a native byte order with bt_ctf_trace_set_native_byte_order().
- Note that you \em must set the default byte order if any field type
+ Note that you \em must set the native byte order if any field type
contained in the created trace class, in its stream classes, or in
its event classes, has a byte order set to #BT_CTF_BYTE_ORDER_NATIVE.
- <strong>Environment</strong>: empty. You can add environment entries
contained in the created trace class, in its stream classes, or in
its event classes, has a byte order set to #BT_CTF_BYTE_ORDER_NATIVE.
- <strong>Environment</strong>: empty. You can add environment entries
-@brief Returns the default byte order of the CTF IR trace class
+@brief Returns the native byte order of the CTF IR trace class
\p trace_class.
@param[in] trace_class Trace class of which to get the default byte
order.
\p trace_class.
@param[in] trace_class Trace class of which to get the default byte
order.
-@returns Default byte order of trace class
- \p trace_class, or #BT_CTF_BYTE_ORDER_UNKNOWN
- on error.
+@returns Default byte order of \p trace_class,
+ or #BT_CTF_BYTE_ORDER_UNKNOWN on error.
@prenotnull{trace_class}
@postrefcountsame{trace_class}
@prenotnull{trace_class}
@postrefcountsame{trace_class}
-@sa bt_ctf_trace_set_name(): Sets the name of a given trace class.
+@sa bt_ctf_trace_set_native_byte_order(): Sets the native byte order of
+ a given trace class.
-extern enum bt_ctf_byte_order bt_ctf_trace_get_byte_order(
+extern enum bt_ctf_byte_order bt_ctf_trace_get_native_byte_order(
struct bt_ctf_trace *trace_class);
/**
struct bt_ctf_trace *trace_class);
/**
-@brief Sets the default byte order of the CTF IR trace class
+@brief Sets the native byte order of the CTF IR trace class
\p trace_class to \p native_byte_order.
\p native_byte_order \em must be one of:
\p trace_class to \p native_byte_order.
\p native_byte_order \em must be one of:
- #BT_CTF_BYTE_ORDER_BIG_ENDIAN
- #BT_CTF_BYTE_ORDER_NETWORK
- #BT_CTF_BYTE_ORDER_BIG_ENDIAN
- #BT_CTF_BYTE_ORDER_NETWORK
-@param[in] trace_class Trace class of which to set the default byte
+@param[in] trace_class Trace class of which to set the native byte
order.
@param[in] native_byte_order Default byte order of the trace class.
@returns 0 on success, or a negative value on error.
@prenotnull{trace_class}
order.
@param[in] native_byte_order Default byte order of the trace class.
@returns 0 on success, or a negative value on error.
@prenotnull{trace_class}
@prehot{trace_class}
@pre \p native_byte_order is either #BT_CTF_BYTE_ORDER_LITTLE_ENDIAN,
#BT_CTF_BYTE_ORDER_BIG_ENDIAN, or
#BT_CTF_BYTE_ORDER_NETWORK.
@postrefcountsame{trace_class}
@prehot{trace_class}
@pre \p native_byte_order is either #BT_CTF_BYTE_ORDER_LITTLE_ENDIAN,
#BT_CTF_BYTE_ORDER_BIG_ENDIAN, or
#BT_CTF_BYTE_ORDER_NETWORK.
@postrefcountsame{trace_class}
-@sa bt_ctf_trace_get_name(): Returns the name of a given trace class.
+@sa bt_ctf_trace_get_native_byte_order(): Returns the native byte order of a
+ given trace class.
*/
extern int bt_ctf_trace_set_native_byte_order(struct bt_ctf_trace *trace_class,
enum bt_ctf_byte_order native_byte_order);
*/
extern int bt_ctf_trace_set_native_byte_order(struct bt_ctf_trace *trace_class,
enum bt_ctf_byte_order native_byte_order);
trace = bt_ctf_stream_class_borrow_trace(stream->stream_class);
assert(trace);
trace = bt_ctf_stream_class_borrow_trace(stream->stream_class);
assert(trace);
- native_byte_order = bt_ctf_trace_get_byte_order(trace);
+ native_byte_order = bt_ctf_trace_get_native_byte_order(trace);
empty_packet = (stream->events->len == 0);
/* mmap the next packet */
empty_packet = (stream->events->len == 0);
/* mmap the next packet */
-enum bt_ctf_byte_order bt_ctf_trace_get_byte_order(struct bt_ctf_trace *trace)
+enum bt_ctf_byte_order bt_ctf_trace_get_native_byte_order(
+ struct bt_ctf_trace *trace)
{
enum bt_ctf_byte_order ret = BT_CTF_BYTE_ORDER_UNKNOWN;
{
enum bt_ctf_byte_order ret = BT_CTF_BYTE_ORDER_UNKNOWN;
enum bt_ctf_byte_order bo = byte_order_from_unary_expr(ctx->efd, uexpr);
if (bo == BT_CTF_BYTE_ORDER_NATIVE) {
enum bt_ctf_byte_order bo = byte_order_from_unary_expr(ctx->efd, uexpr);
if (bo == BT_CTF_BYTE_ORDER_NATIVE) {
- bo = bt_ctf_trace_get_byte_order(ctx->trace);
+ bo = bt_ctf_trace_get_native_byte_order(ctx->trace);
enum bt_ctf_string_encoding encoding = BT_CTF_STRING_ENCODING_NONE;
enum bt_ctf_integer_base base = BT_CTF_INTEGER_BASE_DECIMAL;
enum bt_ctf_byte_order byte_order =
enum bt_ctf_string_encoding encoding = BT_CTF_STRING_ENCODING_NONE;
enum bt_ctf_integer_base base = BT_CTF_INTEGER_BASE_DECIMAL;
enum bt_ctf_byte_order byte_order =
- bt_ctf_trace_get_byte_order(ctx->trace);
+ bt_ctf_trace_get_native_byte_order(ctx->trace);
struct ctf_node *expression;
uint64_t alignment = 1, exp_dig = 0, mant_dig = 0;
enum bt_ctf_byte_order byte_order =
struct ctf_node *expression;
uint64_t alignment = 1, exp_dig = 0, mant_dig = 0;
enum bt_ctf_byte_order byte_order =
- bt_ctf_trace_get_byte_order(ctx->trace);
+ bt_ctf_trace_get_native_byte_order(ctx->trace);
"bt_ctf_writer_get_trace returns a bt_ctf_trace object");
ok(bt_ctf_trace_set_native_byte_order(trace, BT_CTF_BYTE_ORDER_BIG_ENDIAN) == 0,
"Set a trace's byte order to big endian");
"bt_ctf_writer_get_trace returns a bt_ctf_trace object");
ok(bt_ctf_trace_set_native_byte_order(trace, BT_CTF_BYTE_ORDER_BIG_ENDIAN) == 0,
"Set a trace's byte order to big endian");
- ok(bt_ctf_trace_get_byte_order(trace) == BT_CTF_BYTE_ORDER_BIG_ENDIAN,
- "bt_ctf_trace_get_byte_order returns a correct endianness");
+ ok(bt_ctf_trace_get_native_byte_order(trace) == BT_CTF_BYTE_ORDER_BIG_ENDIAN,
+ "bt_ctf_trace_get_native_byte_order returns a correct endianness");
/* Add environment context to the trace */
ret = gethostname(hostname, sizeof(hostname));
/* Add environment context to the trace */
ret = gethostname(hostname, sizeof(hostname));