Python: document writer.StructureFieldDeclaration

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

Python: document writer.FloatingPointFieldDeclaration

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

Pytnon: document writer.EnumerationFieldDeclaration

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

Python: document writer.IntegerFieldDeclaration

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

Python: add top-level class writer.IntegerBase

Documenting, and using in general, top-level classes
is easier than nested classes in Python.
babeltrace.writer.FieldDeclaration.IntegerBase still
exists for backward compatibility.

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

Python: document writer.FieldDeclaration

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

Python: document writer.Clock

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

Python: document writer.EnumerationMapping

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

Python: examples: import explicit BT modules

The best practice in Python is generally to import
explicit modules rather than importing all its exposed
members.

This also makes the examples hide the fact that
reader/writer members are exposed directly by the package,
whereas this is only a backward compatibility layer now.

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

Python: split API in reader/writer modules

babeltrace package's modules are now:

  common:
    class CTFStringEncoding
    class ByteOrder
    class CTFTypeId
    class CTFScope
  reader: everything related to reading
  writer: CTF writer API

Backward compatibility is ensured by importing the
appropriate modules into the package itself.

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

Python: document IntegerFieldDeclaration

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

Python: document VariantFieldDeclaration

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

Python: document StringFieldDeclaration

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

Python: document StructureFieldDeclaration

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

Python: document FloatFieldDeclaration

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

Python: document SequenceFieldDeclaration

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

Python: document ArrayFieldDeclaration

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

Python: document EnumerationFieldDeclaration

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

Python: document FieldDeclaration

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

Python: document EventDeclaration

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

Python: document FieldError

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

Python: document Event

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

Python: document CTFScope

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

Python: document CTFTypeId

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

Python: document ByteOrder

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

Python: document CTFStringEncoding

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

Python: document TraceHandle

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

Remove print_format_list Python function

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

Python: document TraceCollection

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

Python: CTFWriter: forbid Stream.__init__()

In the CTF writer API, a Stream object may only
be created using Writer.create_stream(), therefore
rendering Stream.__init__() useless for the user,
since the resulting object is not, and cannot, be
associated with a Writer object.

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

Python: CTFWriter: add FloatingPointFieldDeclaration

This class is added in order to keep the API
consistent, as there is a FloatingPointField class.
It inherits FloatFieldDeclaration so that the API is
not broken.

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

Python: CTFWriter: FloatFieldingPoint -> FloatingPointField

Human error. Since CTFWriter.FloatFieldingPoint is
publicly exposed, we keep it there, making it inherit from
CTFWriter.FloatingPointField.

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

Python: bt: do not expose ClockType

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

Python: remove useless 'return None'

A Python function's default return value is None already.

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

Python: bt.py: PEP 8 + improve readability

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

Python: remove explicit inheritance from object

This is a Python 3 binding, and all classes are new-style
classes in Python 3, so there is no need to inherit from object
explicitly.

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

Python: decouple Python iface from native binding

With this patch, all the SWIG stuff is isolated into
nativebt.i, whereas the real Babeltrace Python interface
is plain Python in bt.py.

The Babeltrace Python binding is now a Python package, but
backward compatibility with the original module is ensured
by importing all public symbols from the bt module in the
package itself (__init__.py), which is named like the
original module, babeltrace.

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

Populate event header from mapped timestamp clock

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

Map default event header timestamp field to the stream class' clock

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

Fix: erroneous use of semicolon instead of comma in TSDL serialization

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

Fix: Don't freeze field type on addition to structure

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

Tests: fix misleading comment

The test only validates that the event header's default field are
as documented in the API's documentation.

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

CTF-Writer tests: Delete trace after test

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

Add support for clock mapping on integer field type

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

Docs: fix bt_ctf_clock_get_offset function header

The function header refers to the function as bt_ctf_clocl_get_offset_s.

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

ctf-ir: allow 1-bit signed integer types

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

ctf-ir: disallow creating a 0-bit integer type

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

Fix: missing paragraph in python bindings license (MIT)

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

Tests: Add event packet header accessors test

Tests: Don't use diag() to output errors from child processes

diag() appends a newline character to the child processes' output
which causes the test's output to have extra blank lines.

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

Cleanup: line over 80 chars

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

Add support for custom event headers

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

Cleanup: Use a switch case instead of conditionals

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

Fix: Field types native byte order refers to the trace

Following a misunderstanding of the CTF specification, the native
byte order was implemented as meaning the host's endianness. It should
refer to the Trace's endianness.

This modification ensures that stream classes, event classes and field
types correctly inherit the trace's endianness when "native" is used.

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

Fix: duplicate function declaration in stream.h

bt_ctf_stream_set_event_context() should be
bt_ctf_stream_set_event_header().

Fixes #874

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

Test: Add a test that validates that empty streams are valid

Empty streams should be backed by a file of size 0 and be readable
by a CTF reader. This test validates that the problem described in
28362f2b is fixed.

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

Fix: lazy-mmap() streams when flushing

This fixes an issue when empty streams are created as the stream
creation will mmap() the file in preparation for the first event.

This results in "empty" stream files ending up with a non-zero size
which is invalid since no packet headers are found by the reader.

This change ensures that stream files are only mmap'ed on the first
stream flush and that empty streams are stored as size-0 files.

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

Fix: lock stream class after assigning stream id

Fixes a bug that was introduced by 2f100782 which made it possible
to set custom stream class IDs.

The stream class is frozen when a stream of its type is instanciated.
However, the trace or writer must still assign a unique ID to the stream
class if none were set prior. This modification moves the stream class
locking (freeze) after the ID assignment check.

Reported-by: Jiri Olsa <jolsa@redhat.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

Fix: handle 64-bit trace IDs on 32-bit systems

Signed-off-by: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>

Fix: print format type mismatch warnings on 32-bit

Signed-off-by: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>

Add utility function to validate CTF identifiers

Introduces bt_ctf_validate_identifier() which validates a given
identifier against the list of CTF reserved keywords.

This function may evolve to perform additional validity checks in
the future as the CTF specification moves forward.

Acked-by: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

Revert "Add event header accessors and support for custom event headers"

This reverts commit 9f476966aa40bd0de2cd0654623ea03f8a3254eb.

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

Fix: missing parenthesis in offset_align_floor

Is currently unused. Triggers a compile error when used.

Signed-off-by: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>

Add event header accessors and support for custom event headers

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

Tests: Add tests for stream class accessor

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

Add missing stream class accessor

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

Cleanup: Typo in bt_ctf_field_type_integer_create's documentation

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

Tests: Add tests for trace packet header accessors

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

Add stream packet header accessors

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

Add trace packet header accessors and support custom headers

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

Fix: Only allow setting a stream class when not frozen

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

Fix: allow empty CTF files

There are expected situtations in which CTF producers (like LTTng) can
generate empty CTF trace files. The current babeltrace behavior is to
trigger an error when an empty file is encountered. Change this to allow
reading the rest of the trace anyway.

Signed-off-by: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>

Revert test fix: uncomment trace unlink

8c627304e5adb715ef3d359ac24febab2bb279b3 introduced changes that
were unintended, namely commenting the trace unlinking in the
CTFWriter test suite.

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

Tests fix: Unchecked return value

Reported by Coverity
** CID 1258705:  Unchecked return value  (CHECKED_RETURN)

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

Tests: Add event context accessors unit tests

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

Docs: Indicate that stream event context is sampled on event append

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

Add event context accessors

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

Docs: Remove extra underscore from function header

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

Fix: Check integer signedness in packet header when auto-populating

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

Docs: Add a comment about event validation in bt_ctf_stream_append_event

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

Cleanup: Misplaced end label in bt_ctf_stream_get_packet_context

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

Tests: Add unit tests for stream event context accessors

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

Add stream_event_context accessors

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

Cleanup: Remove unnecessary argument name

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

Tests: Add unit tests for stream event context accessors

Cleanup: Missing whitespace in comment

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

Fix: Only allow setting a packet context on a non-frozen stream class

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

Add stream_event_context accessors

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

Implement bt_ctf_field deep copy

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

Fix: Incorrect variant tag validation

An erroneous tag validation causes bt_ctf_field_variant_get_field() to
fail when called a second time on a given variant field.

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

Fix: Missing description NULL check in bt_ctf_clock when serializing

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

Fix: Ensure a packet context is a structure

bt_ctf_stream_class_set_packet_context_type was checking the current
stream packet context's type instead of the one being passed.

Added a test to validate that the check is done appropriately.

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

Add comment indicating the type of ctf_traces' elements

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

Fix: sanity check in iterator creation

This function is part of the public API; we need more
sanity checks before using the structures provided by the caller.

Refs: #827

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

Fix: iterate manually over each live trace to add to catch errors

Instead of using g_hash_table_foreach, we now control the iteration over
the hash table, so we can handle properly the errors.
For now, if there is an error for any trace, we consider this a fatal
issue and exit.

We could allow the process to continue and only skip the problematic
traces, but we will wait until this becomes a real use-case.

Fixes: #827
Signed-off-by: Julien Desfossez <jdesfossez@efficios.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

Remove duplicate include of unistd in test_ctf_writer

Signed-off-by: Christian Babeux <christian.babeux@efficios.com>

Fix: make sure we can exit the get_new_metadata loop

Signed-off-by: Julien Desfossez <jdesfossez@efficios.com>

Fix: respect signed integers' length when printing in hex base

Make sure we don't print a full 64-bit sign-extended value
when printing a negative integer in hexadecimal base.

Fixes #848

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

Ensure types used for index and count in CTF IR API match

This makes it easier for users to write code not producing
warnings.

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

Cleanup: Missing space after cast operator

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