ir: add bt_ctf_trace_get_stream_class_by_id()

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

ir: add internal field path getters

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

Rename bt_object to bt_value

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

ir: add BT_CTF_MOVE()

Adds semantics to ownership transfers of CTF IR objects.

This is something that is done often enough to justify the
existence of this macro:

    struct bt_ctf_field_type *type;
    struct bt_ctf_field_type *ret_type;

    /* ... */

    /* move ownership */
    ret_type = type;
    type = NULL;

    /* ... */

    /* put both (safe since type was set to NULL) */
    bt_ctf_put(ret_type);
    bt_ctf_put(type);

With BT_CTF_MOVE():

    struct bt_ctf_field_type *type;
    struct bt_ctf_field_type *ret_type;

    /* ... */

    /* move ownership */
    BT_CTF_MOVE(ret_type, type);

    /* ... */

    /* put both (safe since ownership was moved) */
    bt_ctf_put(ret_type);
    bt_ctf_put(type);

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

test_ctf_writer.c: use bt_ctf_put() everywhere

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

ir: consolidate reference counting functions

This patch adds the bt_ctf_get() and bt_ctf_put() functions
which resp. get and put references of any CTF IR object.

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

Fix: allow structure types to have a minimum align

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

test_ctf_writer: add type alignment tests

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

Fix: require power of two for type alignment

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

Fix: do not init. BO of enums/arrays/sequences

The functions used to create enumeration, array, and
sequence types are different from the other creation
functions in that they register another type at creation
time. Other compound types are empty when created. When a
type is initialized, its byte order setting function is
called, which is recursive for compound types and for the
enumeration type. This overrides the previously set byte
order of the underlying type passed to those creation functions.

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

Build: Update m4 for bison & flex version check to match autoconf-archive file

Officials m4 were merged in [1][2].

[1] https://github.com/peti/autoconf-archive/commit/b2bdd8591b2d6b1eb580ead5f978a30e3ecfc36c
[2] https://github.com/peti/autoconf-archive/commit/fd1f2862c1524e73495d67646d26000e2e85e807

Signed-off-by: Jonathan Rajotte <jonathan.rajotte-julien@efficios.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

Build: add version check on flex

This new m4 macro is valid starting from [1].

[1]http://sourceforge.net/p/flex/flex/ci/712c03b38fb35f9d7f16e0fdd27441c3efda0071/tree/

Signed-off-by: Jonathan Rajotte <jonathan.rajotte-julien@efficios.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

Build: add version check on autoconf

Signed-off-by: Jonathan Rajotte <jonathan.rajotte-julien@efficios.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

Build: m4 macro for Bison version check

This new m4 macro make check for a supported version of Bison.
This macro is valid starting from commit id
e79137accc7ea0352cd4677ff22818f9c68d4eab of the GNU Bison git tree[1].
This check works for version 1.29b to this day.

[1] http://git.savannah.gnu.org/cgit/bison.git/commit/?id=e79137accc7ea0352cd4677ff22818f9c68d4eab

Fixes: #891
Signed-off-by: Jonathan Rajotte <jonathan.rajotte-julien@efficios.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

Test: Add a test to ensure multiple keywords can be used in a field path

Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

Fix: Missing postfix_expression DOT keywords in CTF grammar

This would cause expressions of the form:

uint32_t a[stream.event.header.seq_len]

to fail to parse since two keywords (stream and event) are used in the
path.

Reported-by: Staffan Mansson <staffan@mansson-net.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

Fix: Create stream after adding its stream class to a trace

This ensures that a stream class' id is set before we create a stream
instance and initialize its packet header. Otherwise, the packet header
stream_id is initialized to its default value (0).

Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

Fix: Remove overly-strict freeze check on variants and structures

bt_ctf_field_type_structure_set_field_index() and
bt_ctf_field_type_variant_set_field_index() are both internal APIs
which are used when resolving field paths.

For exemple, when a sequence's field path is resolved, the sequence
is copied and replaced in its parent since we are setting the
resolved path as part of the sequence. This is done so that different
sequence members which would have been declared using the same sequence
type instance can have length fields which resolve to different absolute
paths.

Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

Docs: A stream has no ownership of its trace

Add a comment to explain why the trace's refcount is not incremented
when setting a stream's trace.

Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

Fix: Missing NULL check in bt_ctf_field_sequence_destroy

A sequence's "elements" array might be NULL if
bt_ctf_field_sequence_set_length() was never called during its lifetime.

Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

Add test_bt_objects to .gitignore

Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

ir: add tests for bt_ctf_field_variant_get_current_field()

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

ir: add bt_ctf_field_variant_get_current_field()

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

Clean-up: get_field_type should only have one return statement

Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

Fix: bt_ctf_trace_freeze must fail if type resolving fails

Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

Fix: Return a variant's alignment as 0 (undefined).

Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

ir: copy variants and sequences when setting a field path

Variants and sequences might be used in multiple structures. Therefore,
they are replaced by a copy with the path to their tag or sequence
length field set.

This is done on freeze, hence a user should not expect to be able
to modify a sequence's or variant's attributes subsequently.

Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

Fix: ir: disallow setting the alignment of certain types

Setting the alignment of sequences, arrays, variants and structures
makes no sense.

Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

ir: compute array, sequence and structure alignment dynamically

Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

ir: support optional parameters in bt_ctf_field_type_variant_get_field

Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

ir: support optional parameters in bt_ctf_field_type_structure_get_field

Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

Clean-up: clean multi-line function call

Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

Tests: fix possible null pointer dereference

Reported by Coverity Scan
*** CID 1297896:  Null pointer dereferences  (NULL_RETURNS)
/tests/lib/test_ctf_writer.c: 865 in append_complex_event()

Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

Fix: Check validity of returned ctf_type_id

Reported by Coverity Scan as
** CID 1297897:  Error handling issues  (CHECKED_RETURN)
/formats/ctf/ir/visitor.c: 726 in print_path()

Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

Fix: Missing check that token linked-list is not NULL

Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

ir: validate sequence length fields and variant tags of stream classes

Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

ir: validate sequence length fields and variant tags of event classes

Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

ir: Implement a field type visitor to resolve dynamic scopes

Implement a visitor looking for sequences' length field and variants'
tag names and resolve them to their proper type field in the trace.

Validate that sequence lengths are unsigned integers and variant
tags are enumerations and that both respect CTF's lexical and dynamic
scoping rules.

Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

ir: only perform trace freeze if not already frozen

Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

Clean-up: line exceeding 80 chars in trace.c

Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

Docs: add comment about bt_ctf_trace_add_stream_class validation

Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

ir: add bt_ctf_field_type_variant_set_tag()

Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

ir: add tag field path to variant field type

Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

ir: add length_field_path to sequence field type

Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

ir: add bt_ctf_field_path internal API

Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

ir: add bt_ctf_field_type_variant_get_field_name_index()

Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

ir: add bt_ctf_field_type_structure_get_field_name_index()

Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

Clean-up: Missing space in event-types-internal.h

Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

Docs: Updated available input formats on manpage

Signed-off-by: Glen Keane <glenkeane.94@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

ir: add tests for bt_ctf_event_copy()

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

Fix: ir: match .h names for get/set_header()

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

ir: add bt_ctf_event_set_payload_field()

Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

ir: add bt_ctf_event_get_payload_field()

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

ir: add bt_ctf_event_copy() (event deep copy)

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

ir: add tests for bt_ctf_field_copy()

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

ir: make bt_ctf_field_copy() public

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

Fix: ir: copy struct/seq/array NULL fields

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

Fix: ir: incr ref of existing sequence/array field

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

Fix: ir: return current variant's field if possible

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

Fix: ir: seq copy: initialize internal array

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

Fix: ir: bt_ctf_field_copy(): copy payload_set

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

objects: Doxygen: note about frozen copy

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

Docs: weird phrasing in Babeltrace(1)

Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

Replace g_string_insert_len() by g_string_append_len()

bt_ctf_field_string_append_len uses g_string_insert_len() with a
position of "-1" to append to the end of the string field's payload
which is what g_string_append_len() does by default.

Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

Add tests for bt_ctf_field_string_append_len()

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

ir: add bt_ctf_field_string_append_len()

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

Add tests for bt_ctf_field_string_append()

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

ir: add bt_ctf_field_string_append()

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

Fix: return event timestamp in _timestamp_at_pos

Signed-off-by: Antoine Busque <abusque@efficios.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

Fix: ir: make sure "stream_id" attr is always right

Make sure the "stream_id" attribute of all the event
classes of a given stream class is updated at the following
places:

  * user sets the stream class ID manually: calling
    bt_ctf_stream_class_set_id()
  * stream class ID is automatically set: in
    bt_ctf_trace_add_stream_class()
  * an event class is added to an existing stream
    class: in bt_ctf_stream_class_add_event_class()

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

Tests: add environment field can be added after stream creation

Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

Fix: Allow the addition of environment fields to a frozen trace

Commit 7f800dc7 introduced a behavior change which made it
impossible to add environment fields to a frozen trace (after the
creation of a stream).

This fix makes it possible to add new fields to a trace's
environment while making it impossible to modify existing fields
hereby restoring CTF Writer's v1.2 behavior.

Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

Cleanup: Remove unused trace environment types

Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

Cleanup: introduce internal bt_ctf_trace_freeze()

Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

Move bt_ctf_attributes API to internal headers

Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

Remove stale file from include/Makefile.am

Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

Fix: possible NULL pointer dereference in CTF Writer/IR tests

Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

Fix: Ensure assertions have no side-effect

Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

Fix: Uninitialized return value in bt_ctf_event_class_get_id

Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

ir: add tests for bt_ctf_event's stream accessor

Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

ir: add tests for bt_ctf_stream_class trace accessor

Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

ir: add trace accessor to bt_ctf_stream_class

Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

ir: add stream accessor to bt_ctf_event

Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

Cleanup: remove unused bt_ctf_stream_set_trace function

Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

ir: add weak reference to parent trace to bt_ctf_stream_class

Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

ir: add weak reference to parent stream to bt_ctf_event

Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

ir: add tests for duplicate event classes

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

Fix: ir: make duplicate event classes check smarter

This patch makes bt_ctf_stream_class_add_event_class()
compare not only event classes pointers when checking
for duplicate, but also equal names and equal IDs.

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

ir: add tests for event class attributes

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

ir: add attributes support to event classes

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

ir: make trace environment use bt_object

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

objects: Doxygen: bt_object_type: minor fix

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

objects: optimize loops by using i instead of x

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

objects: Doxygen: add cross-references

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

objects: Doxygen: more details on bt_object_null

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

objects: add bt_object_freeze() and more statuses

This patch adds the possibility to freeze an object.
By doing this, it introduces a new status code,
BT_OBJECT_STATUS_FROZEN, which is returned when trying
to alter a frozen object. Thus, all functions returning
either 0 or -1 are modified to return an
enum bt_object_status value instead.

The status code BT_OBJECT_STATUS_INVAL is also introduced
to signal invalid arguments, to differentiate this error
from other errors.

Finally, this patch adapts the objects tests and the
documentation to the changes.

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

objects: make static functions also inline

This makes GCC mask the "unused function" warning.

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

objects: Doxygen: \i -> \em

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

objects: introduce enum bt_object_status

Those new statuses make it possible for
bt_object_map_foreach() to report if its loop was
cancelled by the user function or if a general error
occured.

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

objects tests: bt_object_array_set()

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>