Philippe Proulx [Wed, 10 Jul 2019 06:15:51 +0000 (02:15 -0400)] 
lib: put __BT_UPCAST() and __BT_UPCAST_CONST() in `babeltrace.h`
This makes it possible to clear those macros at the end of
`babeltrace.h`. This is safe because each public header is guaranteed to
be included from `babeltrace.h`.
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Change-Id: Ib030f70869b48e76bd78a91be55e581aeb3f3435
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1676
Tested-by: jenkins <jenkins@lttng.org>
Philippe Proulx [Wed, 10 Jul 2019 06:05:42 +0000 (02:05 -0400)]
Move `include/babeltrace2/ctf-writer` -> `include/babeltrace2-ctf-writer`
CTF writer is not part of the Babeltrace library.
With this patch, `include/babeltrace2` contains only the Babeltrace
library public headers, and `include/babeltrace2-ctf-writer` contains
only the Babeltrace CTF writer library public headers.
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Change-Id: I605ef01e1afbf0188f1ba5b094aed48717d46aff
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1675
Tested-by: jenkins <jenkins@lttng.org>
Philippe Proulx [Wed, 10 Jul 2019 06:01:05 +0000 (02:01 -0400)]
Remove legacy `include/babeltrace2/{ctf-ir,ctf}` directories
Because Babeltrace 2's CTF writer is not exactly a drop-in replacement
of Babeltrace 1's CTF writer since all the headers are part of the
`babeltrace2` directory (to be able to install both on the same system),
we can remove those legacy directories.
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Change-Id: I28362031162aae851cfd42d2d8d07828e5f69515
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1674
Tested-by: jenkins <jenkins@lttng.org>
Philippe Proulx [Wed, 10 Jul 2019 05:58:12 +0000 (01:58 -0400)]
lib: standardize public header copyright notice
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Change-Id: I7be25f0d622d6ec98fb83ec48d19b3578078ca4a
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1673
Tested-by: jenkins <jenkins@lttng.org>
Philippe Proulx [Wed, 10 Jul 2019 05:51:15 +0000 (01:51 -0400)]
lib: remove "For *" comments in public headers
Those comments are very hard to maintain and are pretty much useless.
There are tools to ensure that headers include exactly what they need.
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Change-Id: Idb7545526426e0a18e6a2fa8af20b9f22ed88407
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1672
Tested-by: jenkins <jenkins@lttng.org>
Philippe Proulx [Wed, 10 Jul 2019 05:33:02 +0000 (01:33 -0400)]
lib: force user to include `<babeltrace2/babeltrace.h>`
This patch makes all the library headers except
`<babeltrace2/babeltrace.h>` refuse to be included directly. This will
allow us to change how those headers are organized, and even remove some
if needed (as long as we move the existing content to another existing
header), because we know the user does not include specific headers.
To do this, the main `<babeltrace2/babeltrace.h>` defines
`__BT_IN_BABELTRACE_H`, and each specific header does:
#ifndef __BT_IN_BABELTRACE_H
# error "Please include <babeltrace2/babeltrace.h> instead."
#endif
at the beginning.
Because each specific header has the guarantee that it is included from
`<babeltrace2/babeltrace.h>`, they don't include
`<babeltrace2/func-status.h>`: `<babeltrace2/babeltrace.h>` includes it,
and clears the private status definitions itself at the end. Therefore
this patch removes `undef-func-status.h`.
Some parts of the project need to have access to the `__BT_FUNC_STATUS_*`
definitions. To do that, they do:
#define __BT_IN_BABELTRACE_H
#include <babeltrace2/func-status.h>
Because `<babeltrace2/babeltrace.h>` is now manually written and
maintained, this patch removes `extras/gen-babeltrace-h.py` which we
used to generate it from `include/Makefile.am`.
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Change-Id: Icc3bf0bec18a465024b316f02f84df7a75429b87
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1671
Tested-by: jenkins <jenkins@lttng.org>
Philippe Proulx [Wed, 10 Jul 2019 04:23:35 +0000 (00:23 -0400)]
lib: standardize public include guards
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Change-Id: Ic65bbac790724a2cd05bde25049f5a02a702e383
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1670
Tested-by: jenkins <jenkins@lttng.org>
Philippe Proulx [Wed, 10 Jul 2019 05:39:33 +0000 (01:39 -0400)]
src/{ctfser,fd-cache}/Makefile.am: remove unneeded `AM_CPPFLAGS`
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Change-Id: Id18bcca5047c89335de39a55c4e890683188c2f6
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1669
Tested-by: jenkins <jenkins@lttng.org>
Philippe Proulx [Wed, 10 Jul 2019 05:31:15 +0000 (01:31 -0400)]
Fix: lib: conflicting types for `bt_plugin_set_get_plugin_count`
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Change-Id: I8324668d820bf8139a54df66bfa1a81312c5da3c
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1668
Tested-by: jenkins <jenkins@lttng.org>
Philippe Proulx [Wed, 10 Jul 2019 05:28:13 +0000 (01:28 -0400)]
Fix: CTF writer: make library have its own public `types.h`
This was overlooked when segregating the CTF writer library from the
Babeltrace library: CTF writer needs its own `bt_ctf_bool` type with its
own `BT_CTF_TRUE` and `BT_CTF_FALSE` definitions.
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Change-Id: I4e6d0b2d0956479a554cc8358d646fc1676873f6
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1667
Tested-by: jenkins <jenkins@lttng.org>
Philippe Proulx [Tue, 9 Jul 2019 12:25:44 +0000 (08:25 -0400)]
lib: make BT_ASSERT_{PRE,POST}() always on; add BT_ASSERT_{PRE,POST}_DEV()
This patch makes the BT_ASSERT_PRE() and BT_ASSERT_POST() macros, and
all their variants, always executed. In other words, the checks are
executed in developer mode and in production mode.
What used to be BT_ASSERT_PRE() and BT_ASSERT_POST(), enabled only in
developer mode, is now BT_ASSERT_PRE_DEV() and BT_ASSERT_POST_DEV().
The goal of this patch is to add precondition and postcondition checks
on the slow path which are enabled in production to catch more
programming errors. As I meticulously chose which one to invoke at each
site, this patch does not change the performance of the library during a
graph run, which is most of the execution time.
Because all the freezing functions are only enabled in developer mode,
`assert-pre.h` only offers BT_ASSERT_PRE_DEV_HOT() currently (there's no
production mode BT_ASSERT_PRE_HOT()). This is because some freezing
functions can be called on the fast path (for example, the internal
bt_event_create() freezes the event class, packet, and stream; this is
called for each event message), while other are only called on the slow
path. This patch does not decouple the frequent ones from the infrequent
ones; this work should be done by a subsequent patch.
Where all the precondition/postcondition assertions used to be only
enabled in developer mode, the library now contains 105 production
checks.
When I test with a 1.4 GiB CTF trace and a dummy output in production
mode, the difference of the total execution times with and without this
patch falls within the range of uncertainty.
The guideline to use one or the other is:
* Use BT_ASSERT_PRE_DEV() and BT_ASSERT_POST_DEV() when the call site
could occur at least once per message.
This is why all the borrowing functions use the developer mode
versions as we don't know at which frequency what will be accessed.
* Use BT_ASSERT_PRE() and BT_ASSERT_POST() everywhere else.
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Change-Id: I2ccdec4cee332a13d330474d287c564b7cb90352
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1661
Tested-by: jenkins <jenkins@lttng.org>
Philippe Proulx [Tue, 9 Jul 2019 20:11:44 +0000 (16:11 -0400)]
lib: rename `bt_*_labels_by_value` -> `bt_*_labels_for_value`
It just feels more right this way.
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Change-Id: I6cbe9542417ba4b9688d1920189591727597d3ba
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1665
Tested-by: jenkins <jenkins@lttng.org>
Philippe Proulx [Tue, 9 Jul 2019 19:37:09 +0000 (15:37 -0400)]
Rename WARN log level to WARNING
It's weird that this log level is abbreviated, but not the other ones.
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Change-Id: Id14da1ba6cd38f7d824079218280bff9dea1e276
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1663
Tested-by: jenkins <jenkins@lttng.org>
Philippe Proulx [Tue, 9 Jul 2019 06:48:49 +0000 (02:48 -0400)]
src/lib/{current-thread,error}.c: put precond. assertion at right place
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Change-Id: Id43d7d881253cd00e9dec46770ba517fc22f0adf
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1660
Reviewed-by: Simon Marchi <simon.marchi@efficios.com>
Tested-by: jenkins <jenkins@lttng.org>
Philippe Proulx [Tue, 9 Jul 2019 12:25:53 +0000 (08:25 -0400)]
lib/lib-logging.c: fix GCC warning: check return value of snprintf()
This patch fixes this GCC warning:
lib-logging.c: In function ‘format_component’:
lib-logging.c:110:44: error: ‘%s’ directive output may be truncated
writing 10 bytes into a region of size between 0 and 127
[-Werror=format-truncation=]
snprintf(tmp_prefix, TMP_PREFIX_LEN - 1, "%s%s", \
^~~~~~
prefix, (_prefix2)); \
~~~~~~~~~~
lib-logging.c:1013:3: note: in expansion of macro ‘SET_TMP_PREFIX’
SET_TMP_PREFIX("so-handle-");
^~~~~~~~~~~~~~
lib-logging.c:110:3: note: ‘snprintf’ output between 11 and 138
bytes into a destination of size 127
snprintf(tmp_prefix, TMP_PREFIX_LEN - 1, "%s%s", \
^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
prefix, (_prefix2)); \
~~~~~~~~~~~~~~~~~~~
lib-logging.c:1013:3: note: in expansion of macro ‘SET_TMP_PREFIX’
SET_TMP_PREFIX("so-handle-");
^~~~~~~~~~~~~~
The macro aborts when the return value is unexpected, but this will
never happen as we control the prefixes internally.
Boosting the buffer's size to 128 just in case.
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Change-Id: I6cbb43de3c9ae03b5d85074d1698069084659c3b
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1658
Philippe Proulx [Tue, 9 Jul 2019 16:55:58 +0000 (12:55 -0400)]
cli: append error cause when graph or query executor is canceled by user
Otherwise the CLI prints "unknown error" at the end. Now it prints:
ERROR: [Babeltrace CLI] (babeltrace2.c:2579)
Graph was canceled by user.
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Change-Id: Ia910e91d75586e30bb017bd9332615891606c115
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1659
Tested-by: jenkins <jenkins@lttng.org>
Philippe Proulx [Mon, 8 Jul 2019 16:33:30 +0000 (12:33 -0400)]
lib: make packets and packet messages optional, disabled by default
This patch makes it optional for the streams of a given stream class to
support the concept of packets, much like the support for discarded
events and discarded packets is already optional.
Packets exist to support trace formats which group events into packets,
all the packet's events sharing the same packet context information. CTF
is currently the single input format which needs the packet concept.
Other, more simple sources (existing and future) which do not need the
packet concept need, before this patch, to create at least one and, for
each stream, to emit the packet beginning and packet end messages at the
right locations within the message flow. This makes this part of the API
cumbersome and unnecessary.
With this patch, a message iterator can simply emit:
1. Stream beginning message
2. Event messages
3. Stream end message
API changes
===========
When you create a stream class with bt_stream_class_create() or
bt_stream_class_create_with_id(), the created stream class does NOT
support packets by default. This is to make the initial stream class's
configuration as simple as possible. This means that:
* You cannot create packet objects from the instances of this stream
class (bt_packet_create()).
* You cannot create packet beginning and packet end messages for the
instances of this stream class because you don't have any packet
object (bt_message_packet_beginning_create(),
bt_message_packet_beginning_create_with_default_clock_snapshot(),
bt_message_packet_end_create(), and
bt_message_packet_end_create_with_default_clock_snapshot()).
* The stream class cannot support discarded packets
(bt_stream_class_set_supports_discarded_packets()).
* The stream class cannot have a packet context field class
(bt_stream_class_set_packet_context_field_class()).
* You cannot create a detached packet context field from this stream
class (bt_packet_context_field_create()).
* You cannot create an event message with a packet object
(bt_message_event_create() and
bt_message_event_create_with_default_clock_snapshot(); more about this
below).
To make a stream class support packets, you need to call
bt_stream_class_set_supports_packets(). This is also where you specify
whether or not the stream class's stream packets have a beginning and/or
an end default clock snapshot from now on.
You can use bt_stream_class_supports_packets() to know if a given stream
class supports packets.
The functions bt_message_event_create() and
bt_message_event_create_with_default_clock_snapshot() are renamed to
bt_message_event_create_with_packet() and
bt_message_event_create_with_packet_and_default_clock_snapshot(). The
functions bt_message_event_create() and
bt_message_event_create_with_default_clock_snapshot() now accept a
`const bt_stream *` parameter to associate the event to a stream.
You can borrow the stream to which an event is associated with
bt_event_borrow_stream_const(), however it was created.
bt_event_borrow_packet_const() returns `NULL` if the event's stream
class does not support packets.
When a stream class supports packets, it is required that you emit the
packet beginning and packet end messages at the correct locations within
an iterator's message flow for a given instance of this stream class.
When a stream class does not support packets, it is required that you do
not create packet beginning and packet end messages for the instances of
this stream class.
Plugin changes
==============
`src.ctf.fs` and `src.ctf.lttng-live`:
The message iterators always create stream classes supporting
packets.
`sink.ctf.fs`:
The component requires that packets are supported if a stream class
also supports discarded events. This is because the way to indicate
discarded events in CTF 1.8 is with packet contexts.
When packets are not supported for a given stream, the component
creates "artificial" packets. I chose to make it create packets of
about 4 MiB. This could become configurable in the future.
`flt.lttng-utils.debug-info`:
The message iterator copies whether or not the stream class supports
packets.
`src.text.dmesg`:
The message iterator does not emit packet beginning and end messages
anymore.
`sink.text.details`:
The component prints whether or not a given stream class supports
packets. The component only prints the "packets have beginning
default clock snapshot" and "packets have end default clock
snapshot" stream class properties if packets are supported to reduce
textual noise.
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Change-Id: I79a8063b4a85140004789d024364cf37ef076c45
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1656
Reviewed-by: Simon Marchi <simon.marchi@efficios.com>
Tested-by: jenkins <jenkins@lttng.org>
Jonathan Rajotte [Mon, 8 Jul 2019 19:47:21 +0000 (15:47 -0400)] 
fix: test_trimmer on macOs and Solaris
The 'wc' tool on BSD based system adds leading spaces to it's output,
which breaks the quoted compare. Use bash parameter expansion to trim all
spaces from the 'num_events' variable.
Signed-off-by: Jonathan Rajotte <jonathan.rajotte-julien@efficios.com>
Change-Id: I884f59cf1fcdcb33419dd02c69886715ce4db71b
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1654
Tested-by: jenkins <jenkins@lttng.org>
Reviewed-by: Philippe Proulx <eeppeliteloop@gmail.com>
Reviewed-by: Michael Jeanson <mjeanson@efficios.com>
Jonathan Rajotte [Mon, 8 Jul 2019 19:25:16 +0000 (15:25 -0400)]
tests: Use DYLD_LIBRARY_PATH on macOSX
We could also use DYLD_FALLBACK_LIBRARY_PATH.
The dyld manual have this note regarding System Integrity Protection
(SIP).
Note: If System Integrity Protection is enabled, these environment
variables are ignored when executing binaries protected by System
Integrity Protection.
If using restricted executables (e.g python), the DYLD_* will not be
honoured.
It might prove to be a problem in the wild. I'm not sure how to mitigate
this.
Signed-off-by: Jonathan Rajotte <jonathan.rajotte-julien@efficios.com>
Change-Id: I9d62c4615f01e3a60d3068a13b5e2b1061aef6b4
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1653
Tested-by: jenkins <jenkins@lttng.org>
Reviewed-by: Michael Jeanson <mjeanson@efficios.com>
Reviewed-by: Philippe Proulx <eeppeliteloop@gmail.com>
Jonathan Rajotte [Mon, 8 Jul 2019 18:06:53 +0000 (14:06 -0400)]
doc: Use DYLD_LIBRARY_PATH on macOSX
Sphinx fails on python bindings documentation generation:
PYTHONPATH="/Users/jenkins/test/babeltrace/src/bindings/python/bt2/build/build_lib" LD_LIBRARY_PATH="/Users/jenkins/test/babeltrace/src/lib/.libs" /opt/local/bin/python3 -m sphinx -b html -E ./source build/html
Running Sphinx v2.1.2
Configuration error:
There is a programmable error in your configuration file:
Traceback (most recent call last):
File "/Users/jenkins/test/babeltrace/src/bindings/python/bt2/build/build_lib/bt2/native_bt.py", line 14, in swig_import_helper
return importlib.import_module(mname)
File "/opt/local/Library/Frameworks/Python.framework/Versions/3.7/lib/python3.7/importlib/__init__.py", line 127, in import_module
return _bootstrap._gcd_import(name[level:], package, level)
File "<frozen importlib._bootstrap>", line 1006, in _gcd_import
File "<frozen importlib._bootstrap>", line 983, in _find_and_load
File "<frozen importlib._bootstrap>", line 967, in _find_and_load_unlocked
File "<frozen importlib._bootstrap>", line 670, in _load_unlocked
File "<frozen importlib._bootstrap>", line 583, in module_from_spec
File "<frozen importlib._bootstrap_external>", line 1043, in create_module
File "<frozen importlib._bootstrap>", line 219, in _call_with_frames_removed
ImportError: dlopen(/Users/jenkins/test/babeltrace/src/bindings/python/bt2/build/build_lib/bt2/_native_bt.cpython-37m-darwin.so, 2): Library not loaded: /usr/local/lib/libbabeltrace2.0.dylib
Referenced from: /Users/jenkins/test/babeltrace/src/bindings/python/bt2/build/build_lib/bt2/_native_bt.cpython-37m-darwin.so
Reason: image not found
During handling of the above exception, another exception occurred:
Traceback (most recent call last):
File "/opt/local/Library/Frameworks/Python.framework/Versions/3.7/lib/python3.7/site-packages/sphinx/config.py", line 361, in eval_config_file
execfile_(filename, namespace)
File "/opt/local/Library/Frameworks/Python.framework/Versions/3.7/lib/python3.7/site-packages/sphinx/util/pycompat.py", line 86, in execfile_
exec(code, _globals)
File "/Users/jenkins/test/babeltrace/doc/bindings/python/source/conf.py", line 3, in <module>
import bt2
File "/Users/jenkins/test/babeltrace/src/bindings/python/bt2/build/build_lib/bt2/__init__.py", line 26, in <module>
from bt2.clock_class import *
File "/Users/jenkins/test/babeltrace/src/bindings/python/bt2/build/build_lib/bt2/clock_class.py", line 23, in <module>
from bt2 import native_bt, object, utils
File "/Users/jenkins/test/babeltrace/src/bindings/python/bt2/build/build_lib/bt2/native_bt.py", line 17, in <module>
_native_bt = swig_import_helper()
File "/Users/jenkins/test/babeltrace/src/bindings/python/bt2/build/build_lib/bt2/native_bt.py", line 16, in swig_import_helper
return importlib.import_module('_native_bt')
File "/opt/local/Library/Frameworks/Python.framework/Versions/3.7/lib/python3.7/importlib/__init__.py", line 127, in import_module
return _bootstrap._gcd_import(name[level:], package, level)
ModuleNotFoundError: No module named '_native_bt'
Sphinx simply fails to find libbabeltrace2.0.dylib since that
on macOSX LD_LIBRARY_PATH have no meaning for the dynamic linker,
DYLD_LIBRARY_PATH does.
We could also use DYLD_FALLBACK_LIBRARY_PATH.
The dyld manual have this note regarding System Integrity Protection
(SIP).
Note: If System Integrity Protection is enabled, these environment
variables are ignored when executing binaries protected by System
Integrity Protection.
This patch was tested on our builder and with SIP enabled without any
problem:
ci-node-macosx-01:babeltrace jenkins$ system_profiler SPSoftwareDataType
Software:
System Software Overview:
System Version: macOS 10.14.5 (18F203)
Kernel Version: Darwin 18.6.0
Boot Volume: Macintosh HD
Boot Mode: Normal
Computer Name: ci-node-macosx-01
User Name: Jenkins CI (jenkins)
Secure Virtual Memory: Enabled
System Integrity Protection: Enabled
Time since boot: 32 days 3:36
This mostly works because the python3 executed is not flagged
restricted:
ci-node-macosx-01:~ jenkins$ ls -laO /opt/local/bin/python3
lrwxr-xr-x 1 root admin - 24 27 Jun 14:16 /opt/local/bin/python3 -> /opt/local/bin/python3.7
The same command would most probably not work if using a
"system" python.
ci-node-macosx-01:~ jenkins$ ls -laO /usr/bin/python
-rwxr-xr-x 1 root wheel restricted,compressed 66880 4 May 02:49 /usr/bin/python
I was unable to test this scenario.
User building on macOSX could face this issue in the future. I am not sure
how to mitigate this.
Signed-off-by: Jonathan Rajotte <jonathan.rajotte-julien@efficios.com>
Change-Id: Ia828ac133e2c05b614427f03064c8db02f34f741
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1652
Reviewed-by: Philippe Proulx <eeppeliteloop@gmail.com>
Reviewed-by: Michael Jeanson <mjeanson@efficios.com>
Philippe Proulx [Mon, 8 Jul 2019 20:27:19 +0000 (16:27 -0400)]
Tests: move `test_bitfield` outside lib tests, add `check-no-bitfield` target
While the bitfield test (`test_bitfield`) is very valuable, it is also
very slow with a typical Babeltrace developer configuration, that is:
BABELTRACE_DEV_MODE=1 BABELTRACE_DEBUG_MODE=1 \
BABELTRACE_MINIMAL_LOG_LEVEL=TRACE \
CFLAGS='-O0 -g3 -Werror -Wall -Wno-error=unused-function'
On my system and with the build configuration above, `test_bitfield`
takes 3:10 to run, while all the other tests, including the Python
bindings tests, but excluding `test_bitfield`, take 0:16.
Because `test_bitfield` exclusively tests the functions in the
`bitfield.h` header, and because they almost never change, I never run
the `test_bitfield` test, removing the line in `tests/Makefile.am` every
time. The CI runs all the tests anyway, so for a first pass, I believe
it's not worth the wait.
This patch moves `test_bitfield` into its own `tests/bitfield`
directory: `bitfield.h` is not part of the library anyway, so I don't
know why it's in `tests/lib` in the first place.
In `tests/Makefile.am`, a new `check-bitfield` target is added to run
just this test, as well as a new `check-no-bitfield` target which runs
all the tests but `test_bitfield`.
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Change-Id: Ib9f6a8e7cb9d01e7ef117b1a4d9c84788a4a68d2
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1655
Tested-by: jenkins <jenkins@lttng.org>
Philippe Proulx [Mon, 8 Jul 2019 19:18:25 +0000 (15:18 -0400)]
Fix: bt_plugin_so_shared_lib_handle_destroy(): use `#ifdef`, not `#ifndef`
This is a bug which comes from
3f3b176151b4163f9ae85bc583865850a18a6ce4,
where `NDEBUG` was changed to `BT_DEBUG_MODE` without also inverting the
preprocessor condition.
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Change-Id: I435bbc376323803403ee133971bcb4b7c559afe5
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1648
Philippe Proulx [Mon, 8 Jul 2019 19:52:21 +0000 (15:52 -0400)]
lib/graph/message/stream.c: fix clock snapshot leak
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Change-Id: I77283f7f65b4cb2e36b0c16c48dfcdf534a16548
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1650
Philippe Proulx [Mon, 8 Jul 2019 19:51:33 +0000 (15:51 -0400)]
lib/trace-ir/clock-snapshot.c: assert that the parameter is not `NULL`
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Change-Id: I8943dd2d89cf23f6ef5f0c35d06dfe41bbfd8635
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1649
Philippe Proulx [Mon, 8 Jul 2019 20:01:05 +0000 (16:01 -0400)]
sink.text.details: write discarded events/packets CS props when supported
It is known that, for a given stream class, when discarded events and
packets are not supported, they also don't have default clock snapshots.
This patch makes the output go from:
Trace class:
Stream class (ID 0):
Packets have beginning default clock snapshot: Yes
Packets have end default clock snapshot: Yes
Supports discarded events: No
Discarded events have default clock snapshots: No
Supports discarded packets: No
Discarded packets have default clock snapshots: No
to:
Trace class:
Stream class (ID 0):
Packets have beginning default clock snapshot: Yes
Packets have end default clock snapshot: Yes
Supports discarded events: No
Supports discarded packets: No
so as to remove some noise.
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Change-Id: Ib8c32a2dcad1ea51fedb37ca8a73d7255df0972e
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1651
Reviewed-by: Simon Marchi <simon.marchi@efficios.com>
Michael Jeanson [Wed, 3 Jul 2019 22:09:56 +0000 (18:09 -0400)] 
tests: replace xargs workaround with bash array expansion
Bash has a nice feature called 'Quoted array expansion' which we can
use to pass parameters between functions without convoluted quote
escaping. The syntax might not be extremmely clear at first though,
for example:
"${myarray[@]}"
will be expanded to:
"${myarray[1]}" "${myarray[2]}" ... "${myarray[n]}"
Which can be passed as a series of parameters to a function and then
converted back to a array for further use with :
local params=("$@")
This uses the special '$@' variable which is an array of all the
parameters to a function, 'shift' can be used to skip some parameters at
the beginning of the array.
An array can also be expanded as a single string with the members
separated by a space, with this syntax:
"${myarray[*]}"
Using this, I reworked the bt_diff functions to get rid of the xargs
call, I had to move the expected file parameter to the beginning so it
could be shifted and the rest of the parameters passed directly to CLI
executable.
Signed-off-by: Michael Jeanson <mjeanson@efficios.com>
Change-Id: Ie107c5259c9561fe158f923a53eeb0eaf7ee8b00
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1627
Tested-by: jenkins <jenkins@lttng.org>
Reviewed-by: Philippe Proulx <eeppeliteloop@gmail.com>
Michael Jeanson [Thu, 27 Jun 2019 21:41:53 +0000 (17:41 -0400)]
Replace libuuid with internal implementation
We use a very small subset of libuuid features to transform UUIDs
between their string and binary representation. Plus we have a lot of
compat code for different platforms with some unspecified default
behavior regarding the use of upper/lower case.
Drop the dependency on libuuid and replace it with a minimal internal
implementation that respects RFC4122.
Change-Id: Ic170ce26ade23d177195cad117bd0fab590b328e
Signed-off-by: Michael Jeanson <mjeanson@efficios.com>
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1572
Tested-by: jenkins <jenkins@lttng.org>
Reviewed-by: Philippe Proulx <eeppeliteloop@gmail.com>
Philippe Proulx [Mon, 8 Jul 2019 14:06:22 +0000 (10:06 -0400)]
cli: move `--params` option's format parsing to its own file
This is just for clarity.
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Change-Id: I91b34cc7a3ad60512c135cbb7ab8328b487e5b8d
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1647
Tested-by: jenkins <jenkins@lttng.org>
Simon Marchi [Thu, 20 Jun 2019 21:14:46 +0000 (17:14 -0400)] 
lib: remove stream activity messages
The stream activity messages were introduced to support eventual use
cases where the tracer could indicate when it stopped tracing and
started again. To this day, no tracer which produces CTF provides this
information, so these messages are not currently useful. Stream
activity beginning messages are only ever sent just after stream
beginning, and stream activity end messages are only ever sent just
before stream end.
Given that we will introduce a versioning system for the inter-component
communication protocol, which will allow adding new features, we can
remove the stream activity messages for now and add them at a latter
time, if need be. This will reduce a little bit the amount of
boilerplate needed to implement a simple source.
So this patch removes the stream activity messages and handles all the
fallout.
One thing is that the stream activity messages optionally carried a
default clock snapshot, which is used by the trimmer component. To
compensate for this loss of feature, the stream beginning/end messages
now have an optional default clock snapshot.
Impacts around the codebase include (on top of simply removing handling
of stream activity messages):
- sink.text.details: Update to include the default clock snapshot for
stream beginning/end.
- flt.utils.trimmer: read clock snapshots from stream beginning/end
messages (if not unknown). These messages can now trigger the end of
the trimming, if their default clock snapshot is greater than the end
time of the trimmer. Set the clock snapshot of the generated stream
end message if the stream is ended by the trimmer's end bound (see
note below for more details). If the stream is ended because of a
stream end message that is within the trimmer's bounds, the stream
end message is not modified.
- iterator: handle stream message clock snapshots when validating clock
monotonicity and doing an auto seek.
Note about clock snapshot handling
----------------------------------
This patch fixes a bug in trimmer's handle_message_with_stream function,
where it currently always returns BT_SELF_MESSAGE_ITERATOR_STATUS_OK,
even when something fails. Changing it to return the "status" variable
(as I suppose the original intention was) uncovers a latent bug with
the clock snapshots of the "stream end" messages we
generate (or for stream activity end messages, before this patch).
Imagine a clock with a frequency of 1 and offset of 1000s. This means
that the raw clock value 0 corresponds to the real time 1000s, 50 is
1050, and so on. This clock is unable to represent real times prior to
1000s. The sequence of messages generated by the source is:
1. Stream beginning, no clock snapshot
2. Packet beginning at 1050s (raw value 50)
Here's what happens in the trimmer's mind if we pass --end=200:
- Receive message 1, record that a stream is open
- Receive message 2, realize its clock snapshot is greater than the end
bound. Drop it and end the streams.
- Generate a stream end message, use own end bound (200s) as the clock
snapshot
- Try to convert 200s to a raw value of the clock described above: it
fails because 200s can't be represented by that clock.
This is fixed by recording whether we have seen a message with a valid
clock snapshot associated with the stream (which can therefore be
represented by the stream's class' clock class). If we have, it means
that the clock snapshot we'll choose for the stream end message we'll
generate will be safe to convert to a clock value of that clock class.
If we haven't, we are not sure.
A similar problem happens in the iterator auto-seek code when using
'--begin=200' and the same setup as above. We'll try to generate a
stream beginning message with clock snapshot 200s, which is invalid.
Note that this approach could be problematic in some corner cases,
here's a known one:
Once trimmer supports packet beginning/end messages without clock
snapshots (remember that whether these messages have a clock
snapshot or not is dictated by the stream class, it's not a choice per
message), this could happen:
- stream class defines that packet beginning messages don't have clock
snapshots, but packet end messages do.
- get stream beginning message without clock snapshot
- get packet beginning message without clock snapshot
- get event message with clock snapshot, greater than the end bound of
200s
- since the stream class defines that packet end messages must have a
clock snapshot, we can't get away by not putting one as is done by
this patch.
A more complex solution along these lines would probably be needed:
- When trimmer receives the stream and packet beginning messages without
clock snapshot, don't send them downstream but take a note of the
state of the stream
- When we do get a first message with a clock snapshot, then send the
required stream and packet beginning messages.
- If the trimming ends without having sent any content in this
stream/packet, just pretend it never existed.
Change-Id: I9a30a4c33b3f94497254ef93b24fed3b463e13fa
Signed-off-by: Simon Marchi <simon.marchi@efficios.com>
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1527
Tested-by: jenkins <jenkins@lttng.org>
Reviewed-by: Philippe Proulx <eeppeliteloop@gmail.com>
Philippe Proulx [Fri, 5 Jul 2019 22:28:56 +0000 (18:28 -0400)]
Fix: bt_ctfser_write_float64(): use `double` in union, not `float`
This bug made both CTF writer and `sink.ctf.fs` write wrong 64-bit
floating point fields.
This patch also adds two `sink.ctf.fs` tests to catch this. Both tests
run a CTF generator which uses CTF writer, then run
babeltrace2 /path/to/generated/trace -o ctf -w /path/to/converted/trace
and then pass the converted trace into a `sink.text.details` sink to
verify that the content is expected.
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Change-Id: If69ee9a0e1d4038dd28a72860ecc11f18bb6b50e
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1645
Tested-by: jenkins <jenkins@lttng.org>
Reviewed-by: Simon Marchi <simon.marchi@efficios.com>
Simon Marchi [Wed, 3 Jul 2019 19:23:15 +0000 (15:23 -0400)]
tests: don't swallow stderr when running babeltrace CLI
I have found it very difficult to investigate failing tests if we don't
show stderr, so I suggest we just let it get printed. Some tests are
expected to print to stderr in their normal course of operation (because
they test babeltrace error cases), so it means there will be some
additional output in a normal test run. But I think it's a fair
trade-off.
Change-Id: Ia9bc5a706dd756ce0c9d1be4fec7510b12dface7
Signed-off-by: Simon Marchi <simon.marchi@efficios.com>
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1609
CI-Build: Philippe Proulx <eeppeliteloop@gmail.com>
Tested-by: jenkins <jenkins@lttng.org>
Reviewed-by: Philippe Proulx <eeppeliteloop@gmail.com>
Philippe Proulx [Fri, 5 Jul 2019 19:11:11 +0000 (15:11 -0400)]
lib: move trace class's name, UUID, and environment props to trace API
This patch moves the name, UUID, and environment properties of the trace
class API to the trace API. The rationale behind this is that those
properties fundamentally belong to the instance of a trace class, not to
the class itself, as many traces with different names, UUIDs, and
environments can be created from a single trace class.
With this patch, a trace class becomes a simple container of stream
classes. Its name property is removed because it's not needed currently.
Specific, non-trivial changes:
`ctf` plugin:
ctf_trace_class_translate() does not translate the UUID and
environment anymore. Those properties are still part of a CTF IR
trace class however. Instead, the new
ctf_trace_class_configure_ir_trace() function can configure a trace
IR trace object from the properties of a CTF IR trace class object.
Both `src.ctf.fs` and `src.ctf.lttng-live` use
ctf_trace_class_configure_ir_trace().
`sink.ctf.fs`:
The private CTF IR trace class object is renamed to
`fs_sink_ctf_trace` as it represents a single trace anyway.
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Change-Id: Idaffd34c3ce28682b2c490588fccc963fcb1f3fa
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1640
Tested-by: jenkins <jenkins@lttng.org>
Philippe Proulx [Thu, 4 Jul 2019 06:00:18 +0000 (02:00 -0400)]
cli: print current thread's error causes, if any, before exiting
This patch makes the CLI print the error causes of the current thread's
error object, if any, before it finally exits.
The causes are printed from the most recent to the least recent. In
other words, the root cause, or deepest cause, is printed at the end of
the list. This is similar to what Python does when it prints a
traceback.
The CLI prints error causes with colors if supported to highlight the
cause's module name, specific properties, file name, and line number.
The CLI prints the messages indented with two spaces and folded on the
terminal's current width if available, otherwise on 80 columns.
You can test the output with
babeltrace2 $(uuidgen)
This prints something like:
ERROR: [Babeltrace CLI] (babeltrace2.c:2531)
Cannot create components.
CAUSED BY [Babeltrace CLI] (babeltrace2.c:2355)
Cannot create component: plugin-name="ctf", comp-cls-name="fs",
comp-cls-type=0, comp-name="source-ctf-fs"
CAUSED BY [Babeltrace library] (graph.c:1336)
Component initialization method failed: status=ERROR,
comp-addr=0x5590750b8fa0, comp-name="source-ctf-fs",
comp-log-level=BT_LOGGING_LEVEL_WARN,
comp-class-type=BT_COMPONENT_CLASS_TYPE_SOURCE, comp-class-name="fs",
comp-class-partial-descr="Read CTF traces from the file sy",
comp-class-is-frozen=0, comp-class-so-handle-addr=0x5590750b2aa0,
comp-class-so-handle-path="babeltrace2/plugins/babeltrace-plugin-ctf.so",
comp-input-port-count=0, comp-output-port-count=0
CAUSED BY [source-ctf-fs: 'source.ctf.fs'] (fs.c:1320)
No CTF traces recursively found in
`
6419ec89-991d-4cf7-ab7f-
b143a9901562`.
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Change-Id: Ib8101e097acf98db305775ac5b90f4eb006ce4ff
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1622
Tested-by: jenkins <jenkins@lttng.org>
Reviewed-by: Francis Deslauriers <francis.deslauriers@efficios.com>
Reviewed-by: Simon Marchi <simon.marchi@efficios.com>
Philippe Proulx [Thu, 4 Jul 2019 05:50:02 +0000 (01:50 -0400)]
Add bt_common_get_term_size()
Using ioctl() instead of the `COLUMNS` environment variable because
`COLUMNS` is in fact a shell variable which is not exported.
The function is not supported on Windows yet.
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Change-Id: I84942830f0392ff1aca3e1aff54fffc534ddda05
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1621
Tested-by: jenkins <jenkins@lttng.org>
Reviewed-by: Francis Deslauriers <francis.deslauriers@efficios.com>
Philippe Proulx [Wed, 3 Jul 2019 20:37:21 +0000 (16:37 -0400)]
Add bt_common_fold()
See bt_common_fold()'s comment for more details.
The plan is to use this when printing error causes from the CLI.
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Change-Id: I57a90da90c0f65ed6909af84dc939c74addfe6eb
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1620
Tested-by: jenkins <jenkins@lttng.org>
Philippe Proulx [Thu, 4 Jul 2019 05:51:33 +0000 (01:51 -0400)]
src.ctf.fs: append error cause when no traces are found in directory
This is just to have at least one way to test the CLI error reporting
with a component actor.
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Change-Id: Iaf59163123c48944168e4e6d0ad1c87ea51cdc5a
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1619
Tested-by: jenkins <jenkins@lttng.org>
Reviewed-by: Francis Deslauriers <francis.deslauriers@efficios.com>
Reviewed-by: Simon Marchi <simon.marchi@efficios.com>
Philippe Proulx [Fri, 21 Jun 2019 18:17:29 +0000 (14:17 -0400)]
lib: use BT_LIB_LOG*_APPEND_CAUSE() where appropriate
Use BT_LIB_LOGE_APPEND_CAUSE() or BT_LIB_LOGW_APPEND_CAUSE() where
appropriate, that is, where a public library function eventually fails
(returns an error status code or `NULL` for a creation function).
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Change-Id: I86f8588accfdd7e0c8b69e3977d214d30ccbd67d
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1618
Tested-by: jenkins <jenkins@lttng.org>
Reviewed-by: Francis Deslauriers <francis.deslauriers@efficios.com>
Reviewed-by: Simon Marchi <simon.marchi@efficios.com>
Philippe Proulx [Fri, 21 Jun 2019 05:26:43 +0000 (01:26 -0400)]
lib: add internal BT_LIB_LOG*_APPEND_CAUSE() macros
The new BT_LIB_LOGE_APPEND_CAUSE() and BT_LIB_LOGF_APPEND_CAUSE()
functions are like BT_LIB_LOGE() and BT_LIB_LOGF(), but they also call
bt_current_thread_error_append_cause_from_unknown() with the formatted
message to append a cause to the current thread's error object.
I plan to use them in lieu of BT_LIB_LOGE() and BT_LIB_LOGF() where
those are already used within the library to make support error
reporting from the library with minimal changes.
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Change-Id: I6d7e3a5feac977f576c29c2451b5f0da8d42ae2b
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1617
Tested-by: jenkins <jenkins@lttng.org>
Reviewed-by: Francis Deslauriers <francis.deslauriers@efficios.com>
Reviewed-by: Simon Marchi <simon.marchi@efficios.com>
Philippe Proulx [Wed, 3 Jul 2019 07:17:37 +0000 (03:17 -0400)]
cli: introduce BT_CLI_LOG*_APPEND_CAUSE() and use it where appropriate
BT_CLI_LOGE_APPEND_CAUSE() and BT_CLI_LOGW_APPEND_CAUSE() are internal
CLI macros which log and append an error cause with the same message,
using "Babeltrace CLI" as the cause's module name.
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Change-Id: I2202ce81582860247232cd3aeea82aa3561e1227
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1616
Tested-by: jenkins <jenkins@lttng.org>
Reviewed-by: Francis Deslauriers <francis.deslauriers@efficios.com>
Philippe Proulx [Thu, 4 Jul 2019 06:16:33 +0000 (02:16 -0400)]
tests: call bt_current_thread_clear_error() when handling an error
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Change-Id: I5e0774fc50936e74320d27313738ce673f5d3c44
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1615
Tested-by: jenkins <jenkins@lttng.org>
Reviewed-by: Francis Deslauriers <francis.deslauriers@efficios.com>
Reviewed-by: Simon Marchi <simon.marchi@efficios.com>
Philippe Proulx [Thu, 4 Jul 2019 05:58:46 +0000 (01:58 -0400)]
cli: clear current thread's error, if any, before exiting
Because the CLI is not consuming the current thread's error yet, clear
it every time to avoid a memory leak.
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Change-Id: Ifb36292a20a5592e660ce16201ee13e017d01780
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1614
Tested-by: jenkins <jenkins@lttng.org>
Reviewed-by: Francis Deslauriers <francis.deslauriers@efficios.com>
Reviewed-by: Simon Marchi <simon.marchi@efficios.com>
Philippe Proulx [Wed, 3 Jul 2019 20:31:56 +0000 (16:31 -0400)]
plugins: call bt_current_thread_clear_error() when not propagating error
Most of the locations where bt_current_thread_clear_error() is called in
this patch need to be replaced with proper error handling, except in
finalization methods which cannot fail. This work will be done by a
subsequent patch.
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Change-Id: I10fb2eb98f46e685e6abf563346a2750b46b01d9
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1613
Tested-by: jenkins <jenkins@lttng.org>
Reviewed-by: Simon Marchi <simon.marchi@efficios.com>
Philippe Proulx [Sat, 15 Jun 2019 20:48:07 +0000 (16:48 -0400)]
lib: add thread-safe error reporting API
This patch adds an API for rich error reporting from an internal module
(library, Python plugin provider, etc.), from a component, from a
component class (query operation), from a message iterator, or from a
graph listener function.
The goal of this is, as a library user, to have access to an organized
list of causes leading to a specific error when a library function
fails. Those causes have module name and message properties, and can
occur within user code. This is similar to a stack trace carried by an
exception object in other languages.
The objective is that a program (the CLI, for example) can print a
report like this (module name between square brackets):
ERROR: Graph failed to run completely:
[ctf1 (stream0): src.ctf.fs] Cannot decode packet header for packet
#546 in file `/path/to/stream/file`:
invalid packet size (17 bits).
CAUSED:
[ctf1 (stream0): src.ctf.fs] Cannot get next message.
CAUSED:
[Babeltrace library] Message iterator's "next" method failed; port
`port-name` of component `ctf1` (`src.ctf.fs`).
CAUSED:
[mux (out): flt.utils.muxer] Cannot get next upstream message
iterator's message for input port `in3`.
CAUSED:
[Babeltrace library] Message iterator's "next" method failed; port
`out` of component `mux` (`flt.utils.muxer`).
CAUSED:
[txt: sink.text.pretty] Cannot get next upstream message iterator's
message.
CAUSED:
[Babeltrace library] Sink component's "consume" method failed.
CAUSED:
[Babeltrace library] Graph stopped running.
The new concepts are:
Error cause actor:
The actor which is responsible for the cause of an error. The
available actors are:
Unknown:
No specific actor (the library will use this, for example, as
well as graph listeners).
Component:
The user code of a component caused the error.
Component class:
The user code of a component class (during a query operation)
caused the error.
Message iterator:
The user code of a message iterator caused the error.
Error cause:
The cause of an error, that is, the context in which the error
occured. An error cause has an actor type, a module name, a message,
and, depending on its actor, other properties.
For example, a single error cause could contain a whole Python stack
trace as its message.
The API function names start with `bt_error_cause`.
Error:
A list of error causes.
The API function names start with `bt_error`.
Current thread:
Everything related to the current thread. The only available
property is its error object.
The API function names start with `bt_current_thread`.
The library header `error-const.h` contains what you need to borrow the
causes of an error object: bt_error_get_cause_count() returns the number
of contained error causes, and with bt_error_borrow_cause_by_index() you
can borrow a specific error cause.
When you call a library function and it returns an error status, you
MUST either:
* Handle the error, and then continue. In that case, you need to clear
the current thread's error object somehow.
If you don't care about the causes of the error, you can call
bt_current_thread_clear_error().
If you need to check the causes of the error, call
bt_current_thread_take_error() which transfers the ownership of the
current thread's error to you, clearing the thread's error at the same
time. This is similar, for example, to how PyErr_Fetch() retrieves the
error indicator and then clears it.
Once you're done with the error object you now own, you can either:
* Discard it with bt_error_release().
* Move it back to the current thread as its error object with
bt_current_thread_move_error().
* Propagate the error, that is, return an error status yourself.
Optionally, you can append an error cause (from your context) to the
current thread's error object with one of the
bt_current_thread_error_append_cause_from_*() functions or
BT_CURRENT_THREAD_ERROR_APPEND_CAUSE_FROM_*() macros (more details
below).
In that case, the error will be handled as explained above by one of
your callers.
The error cause API, depending on the error cause actor, offers the
component name, component class name and type, plugin name (if
available), and component output port name.
I'm not comfortable keeping a weak reference on the component, component
class, plugin, or message iterator object within the error cause object
itself because the error could possibly outlive the component object.
I'm also not comfortable keeping a strong reference because I'm pretty
sure someone will forget to call bt_current_thread_clear_error() or
bt_error_release() eventually and in that case it could cause important
leaks. Leaking a few strings is not the end of the world, but if you
leak the whole graph, then some finalization methods won't be called and
you could have some serious incompleteness.
You cannot append error causes to any error object because this would
require taking the current thread's error object and then moving it back
each time you need to append an error cause.
Instead, you can append an error cause to the current thread's error
specifically with one of:
bt_current_thread_error_append_cause_status
bt_current_thread_error_append_cause_from_unknown(
const char *module_name, const char *file_name,
uint64_t line_no, const char *msg_fmt, ...);
bt_current_thread_error_append_cause_status
bt_current_thread_error_append_cause_from_component(
bt_self_component *self_comp, const char *file_name,
uint64_t line_no, const char *msg_fmt, ...);
bt_current_thread_error_append_cause_status
bt_current_thread_error_append_cause_from_component_class(
bt_self_component_class *self_comp_class, const char *file_name,
uint64_t line_no, const char *msg_fmt, ...);
bt_current_thread_error_append_cause_status
bt_current_thread_error_append_cause_from_message_iterator(
bt_self_message_iterator *self_iter, const char *file_name,
uint64_t line_no, const char *msg_fmt, ...);
#define BT_CURRENT_THREAD_ERROR_APPEND_CAUSE_FROM_UNKNOWN(
_module_name, _msg_fmt, ...)
#define BT_CURRENT_THREAD_ERROR_APPEND_CAUSE_FROM_COMPONENT(
_self_comp, _msg_fmt, ...)
#define BT_CURRENT_THREAD_ERROR_APPEND_CAUSE_FROM_COMPONENT_CLASS(
_self_cc, _msg_fmt, ...)
#define BT_CURRENT_THREAD_ERROR_APPEND_CAUSE_FROM_MESSAGE_ITERATOR(
_self_iter, _msg_fmt, ...)
The only available `bt_current_thread_error_append_cause_status` values
are:
* `BT_CURRENT_THREAD_ERROR_APPEND_CAUSE_STATUS_OK`
* `BT_CURRENT_THREAD_ERROR_APPEND_CAUSE_STATUS_MEMORY_ERROR`
The macro versions call the non-macro versions with `__FILE__` and
`__LINE__` for the `file_name` and `line_no` parameters.
The functions above work like printf() from their `msg_fmt` argument to
set the error cause's message.
For bt_current_thread_error_append_cause_from_unknown(), the module name
can be anything. It should clearly identify the actor (for example,
`Babeltrace library`, `Babeltrace CLI`, `Python bindings`). When the
error cause's actor is not unknown, then the module name is conveniently
set automatically:
Component:
`my-comp: src.ctf.fs`
Component class:
`src.ctf.fs` or `src.comp-cls` (no plugin)
Message iterator:
`my-comp (out2): src.ctf.fs`
As of this patch, the projet does not use the new API. This work is
reserved for subsequent patches.
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Change-Id: Ia791b2ff9bbf7a91e7c37416ba748c1186ee69a4
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1474
Tested-by: jenkins <jenkins@lttng.org>
Philippe Proulx [Wed, 19 Jun 2019 21:08:09 +0000 (17:08 -0400)]
lib: keep plugin name, if any, in component class structure
This is to make the plugin name available when having a component class
object in an upcoming error reporting API.
We don't keep the `bt_plugin` object itself because it's a component
class's owner, and a component class can outlive its containing plugin:
only the shared object data is kept alive in that case.
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Change-Id: I9cfbac32d88a6e7edac238b5a63b232695613b8c
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1523
Tested-by: jenkins <jenkins@lttng.org>
Reviewed-by: Simon Marchi <simon.marchi@efficios.com>
Reviewed-by: Francis Deslauriers <francis.deslauriers@efficios.com>
Francis Deslauriers [Fri, 5 Jul 2019 20:34:51 +0000 (16:34 -0400)] 
src.ctf.fs: remove leftover use of pointer arithmetics
This change should have been include in the commit:
commit
de38c26a14b60cb3b6d31cc124c187e2c1816bf5
Author: Francis Deslauriers <francis.deslauriers@efficios.com>
Date: Fri Jul 5 11:19:32 2019 -0400
Fix: src.ctf.fs: pointer arithmetics on non-adjacent memory
Signed-off-by: Francis Deslauriers <francis.deslauriers@efficios.com>
Change-Id: If44dc7f5330f070c865b241d507082e253a92a4b
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1641
Tested-by: jenkins <jenkins@lttng.org>
Reviewed-by: Philippe Proulx <eeppeliteloop@gmail.com>
Francis Deslauriers [Fri, 5 Jul 2019 05:11:10 +0000 (01:11 -0400)]
bt2: namespace private attributes of inheritable classes
Add `_bt` prefix to all private attributes and methods of classes of
which the user can inherit. This is done to prevent attribute name
clashes between the base class and the user class. We will document that
the user must not have any attribute with the `_bt_` prefix.
Here are the attribute and method names of inheritable classes with this
commit:
_UserSinkComponent:
self._add_input_port
self._bt_as_component_class_ptr
self._bt_as_component_ptr
self._bt_as_not_self_specific_component_ptr
self._bt_as_self_component_ptr
self._bt_borrow_component_class_ptr
self._bt_cc_ptr
self._bt_comp_cls_type
self._bt_graph_is_configured_from_native
self._bt_port_connected_from_native
self._bt_ptr
self._consume
self._create_clock_class
self._create_trace_class
self._finalize
self._input_ports
self._port_connected
self.addr
self.cls
self.logging_level
self.name
_UserMessageIterator:
self._bt_can_seek_beginning_from_native
self._bt_init_from_native
self._bt_next_from_native
self._bt_ptr
self._bt_seek_beginning_from_native
self._bt_validate_stream_activity_message_default_clock_snapshot
self._can_seek_beginning
self._component
self._create_discarded_events_message
self._create_discarded_packets_message
self._create_event_message
self._create_message_iterator_inactivity_message
self._create_packet_beginning_message
self._create_packet_end_message
self._create_stream_activity_beginning_message
self._create_stream_activity_end_message
self._create_stream_beginning_message
self._create_stream_end_message
self._finalize
self._infinite_clock_snapshot
self._seek_beginning
self._unknown_clock_snapshot
self.addr
Signed-off-by: Francis Deslauriers <francis.deslauriers@efficios.com>
Change-Id: Ia42f247038cc3d054199a8c94becddcb088b646a
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1626
Tested-by: jenkins <jenkins@lttng.org>
Reviewed-by: Philippe Proulx <eeppeliteloop@gmail.com>
Francis Deslauriers [Thu, 4 Jul 2019 01:43:40 +0000 (21:43 -0400)]
tests: bt2: use `addr` attribute instead of private `_ptr`
Signed-off-by: Francis Deslauriers <francis.deslauriers@efficios.com>
Change-Id: I5e8ae217d0d3869207af3fa0c92e05a6fabc1a16
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1624
Tested-by: jenkins <jenkins@lttng.org>
Reviewed-by: Simon Marchi <simon.marchi@efficios.com>
Reviewed-by: Philippe Proulx <eeppeliteloop@gmail.com>
Simon Marchi [Fri, 5 Jul 2019 17:31:44 +0000 (13:31 -0400)]
cli: fix typo in error message
The lttng-live component can be used with the --input-format switch, not
--output-format.
Change-Id: I6217d52756373f5db3a123bb2aeb209a8c6789c8
Signed-off-by: Simon Marchi <simon.marchi@efficios.com>
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1639
Reviewed-by: Philippe Proulx <eeppeliteloop@gmail.com>
Francis Deslauriers [Tue, 25 Jun 2019 15:01:30 +0000 (11:01 -0400)]
Fix: src.ctf.fs: segfault following `bt_msg_iter_seek()`
Issue
=====
Seeking a `bt_msg_iter` right after its creation leaves its `mmap_addr`
field uninitialized which may lead to a segmentation fault when
`medop_request_byte()` is called.
It triggers a segfault in `medop_request_byte()` because
`ds_file->mmap_len` field is 0 and `ds_file->request_offset` field is
larger than 0. This makes the call to `remaining_mmap_bytes()` return
non-zero.
It makes it so that the call to `ds_file_mmap_next()` is skipped and
`ds_file->mmap_addr` is dereferenced without being initialized.
The real underlying issue is that `medop_seek()` returns success even
when no file is mapped.
Solution
========
When seeking, map the right file if `mmap_addr` is still uninitialized.
Drawback
========
None.
Notes
=====
I also added comments and `BT_ASSERT()` that helped me track down this
issue and that I believe could be useful for other developers.
Signed-off-by: Francis Deslauriers <francis.deslauriers@efficios.com>
Change-Id: I041dc89159953a6ffce016b8c094969fb9c3f862
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1532
Reviewed-by: Philippe Proulx <eeppeliteloop@gmail.com>
CI-Build: Philippe Proulx <eeppeliteloop@gmail.com>
Tested-by: jenkins <jenkins@lttng.org>
Francis Deslauriers [Wed, 12 Jun 2019 20:32:46 +0000 (16:32 -0400)]
Fix: src.ctf.fs: trace-info: port_name memory leak
Valgrind report:
==21704== 256 bytes in 4 blocks are definitely lost in loss record 29 of 38
==21704== at 0x4C31D2F: realloc (in /usr/lib/valgrind/vgpreload_memcheck-amd64-linux.so)
==21704== by 0x555EA1F: g_realloc (gmem.c:164)
==21704== by 0x557AF56: g_string_maybe_expand (gstring.c:102)
==21704== by 0x557B2E4: g_string_insert_len (gstring.c:476)
==21704== by 0x557B44C: g_string_assign (gstring.c:349)
==21704== by 0x6B2D8C5: ctf_fs_make_port_name (fs.c:427)
==21704== by 0x6B31FCD: populate_stream_info (query.c:342)
==21704== by 0x6B321E9: populate_trace_info (query.c:417)
==21704== by 0x6B32592: trace_info_query (query.c:525)
==21704== by 0x6B3104C: ctf_fs_query (fs.c:2326)
==21704== by 0x4E7ED6A: bt_query_executor_query (query-executor.c:128)
==21704== by 0x10DCDA: query (babeltrace2.c:201)
Reported-by: Valgrind Memcheck
Signed-off-by: Francis Deslauriers <francis.deslauriers@efficios.com>
Change-Id: I4e8ac593327d170005fd984ef7744656e7feb47d
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1419
Tested-by: jenkins <jenkins@lttng.org>
Reviewed-by: Philippe Proulx <eeppeliteloop@gmail.com>
Simon Marchi [Fri, 5 Jul 2019 14:58:45 +0000 (10:58 -0400)]
bt2: remove probing of BABELTRACE_PYTHON_BT2_NO_TRACEBACK env var
This was used previously when handling exceptions thrown by user code,
to decide whether we printed exceptions or not. Nowadays, we let
exceptions propagate to the native code, which logs it. I believe we
can remove this.
Change-Id: I14adae265c83a169d176dda9d83d4d05fcd26edc
Signed-off-by: Simon Marchi <simon.marchi@efficios.com>
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1636
Tested-by: jenkins <jenkins@lttng.org>
Reviewed-by: Philippe Proulx <eeppeliteloop@gmail.com>
Simon Marchi [Thu, 4 Jul 2019 20:31:00 +0000 (16:31 -0400)]
trimmer: use g_match_info_free instead of g_match_info_unref
The build fails with glib 2.22:
trimmer.c: In function ‘compile_and_match’:
trimmer.c:201:3: error: implicit declaration of function ‘g_match_info_unref’; did you mean ‘g_match_info_free’? [-Werror=implicit-function-declaration]
g_match_info_unref(*match_info);
^~~~~~~~~~~~~~~~~~
g_match_info_free
The g_match_info_unref function is only available from glib 2.30. Use
g_match_info_free instead, which does the same for our use case.
Change-Id: I9357b9dd18501749e19481e9ef08ec9b01379ee6
Signed-off-by: Simon Marchi <simon.marchi@efficios.com>
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1633
Tested-by: jenkins <jenkins@lttng.org>
Reviewed-by: Philippe Proulx <eeppeliteloop@gmail.com>
Francis Deslauriers [Wed, 3 Jul 2019 19:21:09 +0000 (15:21 -0400)]
tests: bt2: Fix `run_python_bt2` usage example
Signed-off-by: Francis Deslauriers <francis.deslauriers@efficios.com>
Change-Id: I873b18a351b66f0559987ed0e32aa455b7b4e7d6
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1607
Reviewed-by: Philippe Proulx <eeppeliteloop@gmail.com>
Tested-by: jenkins <jenkins@lttng.org>
Francis Deslauriers [Wed, 3 Jul 2019 15:34:02 +0000 (11:34 -0400)]
CONTRIBUTING.adoc: add how to run `bt2` tests
This commit adds a tiny testing section containing an introduction and a
few useful commands to run the `bt2` tests.
Philippe will without a doubt rework this section upon the release of
Babeltrace 2.0. So this commit simply adds commands useful to developers
in the meantime.
Signed-off-by: Francis Deslauriers <francis.deslauriers@efficios.com>
Change-Id: If4be315ddcc09efe9224e42de62c5b01c73ead8f
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1602
Reviewed-by: Philippe Proulx <eeppeliteloop@gmail.com>
Tested-by: jenkins <jenkins@lttng.org>
Francis Deslauriers [Wed, 3 Jul 2019 21:40:52 +0000 (17:40 -0400)]
tests: bt2: add `--test-case` argument to testrunner.py
The `-t/--test-case` argument allows to specify the exact test case to
run.
Make the `--test-case` and the existing `--pattern` options mutually
exclusive and require that one of the two is provided.
It can be used like this:
./tests/utils/run_python_bt2 python3 ./tests/utils/python/testrunner.py \
-t test_event.EventTestCase.test_clock_value \
./tests/bindings/python/bt2
Signed-off-by: Francis Deslauriers <francis.deslauriers@efficios.com>
Change-Id: Icc9204d05bac4cef9cc509f2b19a9e515b0a40e7
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1612
Reviewed-by: Simon Marchi <simon.marchi@efficios.com>
Reviewed-by: Philippe Proulx <eeppeliteloop@gmail.com>
Tested-by: jenkins <jenkins@lttng.org>
Francis Deslauriers [Fri, 5 Jul 2019 15:19:32 +0000 (11:19 -0400)]
Fix: src.ctf.fs: pointer arithmetics on non-adjacent memory
Issue
=====
When indexing a trace using `*.idx` files, if streams span more than one
packet the user may witness the following warning message:
W PLUGIN/SRC.CTF.FS/DS build_index_from_idx_file@data-stream-file.c:400
[source-ctf-fs] Invalid, non-monotonic, packet offset encountered in
LTTng trace index file: previous offset=
14757395258967641292, current offset=4096
This is caused by the fact the we're using pointer arithmetics to get
the pointer to the previous entry of an array. This ends returning
garbage because it's a pointer array and not a regular array storing the
objects as the code expects to.
This regression was most probably introduced by the following commit:
commit
7ed5243afe12c7c12fa5305fff99b93ad23bbdff
Author: Francis Deslauriers <francis.deslauriers@efficios.com>
Date: Wed May 15 14:59:10 2019 -0400
src.ctf.fs: merge all indexes to the fs_ds_group level
This problematic commit changes the `entries` fields of the `struct
ctf_fs_ds_index` from a `GArray *` to `GPtrArray * without changing the
pointer arithmetics.
This was not an error because indexing using `*.idx` files is optional
and indexing may fail back to direct packet indexing.
Solution
========
Use a local variable to store a pointer to the previous index_entry
rather than using pointer arithmetics.
Drawbacks
=========
None.
Signed-off-by: Francis Deslauriers <francis.deslauriers@efficios.com>
Change-Id: I3e5608d0359be2a447e79415517068c64f5a2817
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1637
Tested-by: jenkins <jenkins@lttng.org>
Reviewed-by: Philippe Proulx <eeppeliteloop@gmail.com>
Francis Deslauriers [Fri, 5 Jul 2019 14:03:55 +0000 (10:03 -0400)]
bt2: update `pyproject.toml` following directories changes
Signed-off-by: Francis Deslauriers <francis.deslauriers@efficios.com>
Change-Id: Iedf5db3a1a60329ce0a73f8f7d9bac544b3cf217
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1635
Tested-by: jenkins <jenkins@lttng.org>
Reviewed-by: Simon Marchi <simon.marchi@efficios.com>
Reviewed-by: Philippe Proulx <eeppeliteloop@gmail.com>
Jonathan Rajotte [Thu, 4 Jul 2019 18:31:16 +0000 (14:31 -0400)]
Do not use diagnostic pragma when GCC version is lower than 4.6.0
Building on a SLES11 SP4.
gcc (SUSE Linux) 4.3.4 [gcc-4_3-branch revision 152973
bison (GNU Bison) 2.4
autoconf (GNU Autoconf) 2.69
automake (GNU automake) 1.15
GNU Make 3.81
The same would probably happen if using RHEL6 and its default compiler
since it uses GCC 4.4 [1].
The README suggest that we support GCC > 3.2.
Officially the diagnostic pragma are supported starting in 4.6. [2]
But they were present before 4.6 with limitation.
Error encountered:
integer.c: In function 'ctf_integer_read':
integer.c:271: error: #pragma GCC diagnostic not allowed inside functions
integer.c:271: error: #pragma GCC diagnostic not allowed inside functions
integer.c:271: error: #pragma GCC diagnostic not allowed inside functions
integer.c:276: error: #pragma GCC diagnostic not allowed inside functions
integer.c:276: error: #pragma GCC diagnostic not allowed inside functions
integer.c:276: error: #pragma GCC diagnostic not allowed inside functions
integer.c:282: error: #pragma GCC diagnostic not allowed inside functions
integer.c:282: error: #pragma GCC diagnostic not allowed inside functions
integer.c:282: error: #pragma GCC diagnostic not allowed inside functions
integer.c:287: error: #pragma GCC diagnostic not allowed inside functions
integer.c:287: error: #pragma GCC diagnostic not allowed inside functions
integer.c:287: error: #pragma GCC diagnostic not allowed inside functions
[1] https://access.redhat.com/solutions/19458
[2] https://gcc.gnu.org/gcc-4.6/changes.html
Signed-off-by: Jonathan Rajotte <jonathan.rajotte-julien@efficios.com>
Change-Id: Ie6e4e8bd631f7aab1435fece929621c9a11990e4
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1630
Reviewed-by: Philippe Proulx <eeppeliteloop@gmail.com>
Jonathan Rajotte [Thu, 4 Jul 2019 18:28:49 +0000 (14:28 -0400)]
Missing define when not building with gcc
Error encountered:
../../../../../src/compat/bitfield.h:471:2: error: unknown type name ‘_BT_DIAG_IGNORE_TYPE_LIMITS’; did you mean ‘_BT_DIAG_IGNORE’?
_BT_DIAG_IGNORE_TYPE_LIMITS \
^
../../../../../src/compat/bitfield.h:535:2: note: in expansion of macro ‘_bt_bitfield_read_be’
_bt_bitfield_read_be(ptr, unsigned char, start, length, vptr)
^~~~~~~~~~~~~~~~~~~~
bfcr.c:473:3: note: in expansion of macro ‘bt_bitfield_read_be’
bt_bitfield_read_be(buf, uint8_t, at, field_size, v);
^~~~~~~~~~~~~~~~~~~
../../../../../src/compat/bitfield.h:472:2: error: conflicting types for ‘_is_signed_type’
_is_signed_type = _bt_is_signed_type(__typeof__(_v)); \
^
../../../../../src/compat/bitfield.h:535:2: note: in expansion of macro ‘_bt_bitfield_read_be’
_bt_bitfield_read_be(ptr, unsigned char, start, length, vptr)
^~~~~~~~~~~~~~~~~~~~
bfcr.c:473:3: note: in expansion of macro ‘bt_bitfield_read_be’
bt_bitfield_read_be(buf, uint8_t, at, field_size, v);
^~~~~~~~~~~~~~~~~~~
../../../../../src/compat/bitfield.h:458:7: note: previous declaration of ‘_is_signed_type’ was here
bool _is_signed_type; \
^
../../../../../src/compat/bitfield.h:535:2: note: in expansion of macro ‘_bt_bitfield_read_be’
_bt_bitfield_read_be(ptr, unsigned char, start, length, vptr)
^~~~~~~~~~~~~~~~~~~~
bfcr.c:473:3: note: in expansion of macro ‘bt_bitfield_read_be’
bt_bitfield_read_be(buf, uint8_t, at, field_size, v);
^~~~~~~~~~~~~~~~~~~
../../../../../src/compat/bitfield.h:399:2: error: unknown type name ‘_BT_DIAG_IGNORE_TYPE_LIMITS’; did you mean ‘_BT_DIAG_IGNORE’?
_BT_DIAG_IGNORE_TYPE_LIMITS \
^
../../../../../src/compat/bitfield.h:532:2: note: in expansion of macro ‘_bt_bitfield_read_le’
_bt_bitfield_read_le(ptr, type, start, length, vptr)
^~~~~~~~~~~~~~~~~~~~
bfcr.c:476:3: note: in expansion of macro ‘bt_bitfield_read_le’
bt_bitfield_read_le(buf, uint8_t, at, field_size, v);
^~~~~~~~~~~~~~~~~~~
../../../../../src/compat/bitfield.h:400:2: error: conflicting types for ‘_is_signed_type’
_is_signed_type = _bt_is_signed_type(__typeof__(_v)); \
^
../../../../../src/compat/bitfield.h:532:2: note: in expansion of macro ‘_bt_bitfield_read_le’
_bt_bitfield_read_le(ptr, type, start, length, vptr)
^~~~~~~~~~~~~~~~~~~~
bfcr.c:476:3: note: in expansion of macro ‘bt_bitfield_read_le’
bt_bitfield_read_le(buf, uint8_t, at, field_size, v);
^~~~~~~~~~~~~~~~~~~
../../../../../src/compat/bitfield.h:386:7: note: previous declaration of ‘_is_signed_type’ was here
bool _is_signed_type; \
^
../../../../../src/compat/bitfield.h:532:2: note: in expansion of macro ‘_bt_bitfield_read_le’
_bt_bitfield_read_le(ptr, type, start, length, vptr)
^~~~~~~~~~~~~~~~~~~~
bfcr.c:476:3: note: in expansion of macro ‘bt_bitfield_read_le’
bt_bitfield_read_le(buf, uint8_t, at, field_size, v);
^~~~~~~~~~~~~~~~~~~
bfcr.c: In function ‘read_signed_bitfield’:
../../../../../src/compat/bitfield.h:471:2: error: unknown type name ‘_BT_DIAG_IGNORE_TYPE_LIMITS’; did you mean ‘_BT_DIAG_IGNORE’?
_BT_DIAG_IGNORE_TYPE_LIMITS \
^
../../../../../src/compat/bitfield.h:535:2: note: in expansion of macro ‘_bt_bitfield_read_be’
_bt_bitfield_read_be(ptr, unsigned char, start, length, vptr)
^~~~~~~~~~~~~~~~~~~~
bfcr.c:492:3: note: in expansion of macro ‘bt_bitfield_read_be’
bt_bitfield_read_be(buf, uint8_t, at, field_size, v);
^~~~~~~~~~~~~~~~~~~
../../../../../src/compat/bitfield.h:472:2: error: conflicting types for ‘_is_signed_type’
_is_signed_type = _bt_is_signed_type(__typeof__(_v)); \
^
../../../../../src/compat/bitfield.h:535:2: note: in expansion of macro ‘_bt_bitfield_read_be’
_bt_bitfield_read_be(ptr, unsigned char, start, length, vptr)
^~~~~~~~~~~~~~~~~~~~
bfcr.c:492:3: note: in expansion of macro ‘bt_bitfield_read_be’
bt_bitfield_read_be(buf, uint8_t, at, field_size, v);
^~~~~~~~~~~~~~~~~~~
../../../../../src/compat/bitfield.h:458:7: note: previous declaration of ‘_is_signed_type’ was here
bool _is_signed_type; \
^
../../../../../src/compat/bitfield.h:535:2: note: in expansion of macro ‘_bt_bitfield_read_be’
_bt_bitfield_read_be(ptr, unsigned char, start, length, vptr)
^~~~~~~~~~~~~~~~~~~~
bfcr.c:492:3: note: in expansion of macro ‘bt_bitfield_read_be’
bt_bitfield_read_be(buf, uint8_t, at, field_size, v);
^~~~~~~~~~~~~~~~~~~
../../../../../src/compat/bitfield.h:399:2: error: unknown type name ‘_BT_DIAG_IGNORE_TYPE_LIMITS’; did you mean ‘_BT_DIAG_IGNORE’?
_BT_DIAG_IGNORE_TYPE_LIMITS \
^
../../../../../src/compat/bitfield.h:532:2: note: in expansion of macro ‘_bt_bitfield_read_le’
_bt_bitfield_read_le(ptr, type, start, length, vptr)
^~~~~~~~~~~~~~~~~~~~
bfcr.c:495:3: note: in expansion of macro ‘bt_bitfield_read_le’
bt_bitfield_read_le(buf, uint8_t, at, field_size, v);
^~~~~~~~~~~~~~~~~~~
../../../../../src/compat/bitfield.h:400:2: error: conflicting types for ‘_is_signed_type’
_is_signed_type = _bt_is_signed_type(__typeof__(_v)); \
^
../../../../../src/compat/bitfield.h:532:2: note: in expansion of macro ‘_bt_bitfield_read_le’
_bt_bitfield_read_le(ptr, type, start, length, vptr)
^~~~~~~~~~~~~~~~~~~~
bfcr.c:495:3: note: in expansion of macro ‘bt_bitfield_read_le’
bt_bitfield_read_le(buf, uint8_t, at, field_size, v);
^~~~~~~~~~~~~~~~~~~
../../../../../src/compat/bitfield.h:386:7: note: previous declaration of ‘_is_signed_type’ was here
bool _is_signed_type; \
^
../../../../../src/compat/bitfield.h:532:2: note: in expansion of macro ‘_bt_bitfield_read_le’
_bt_bitfield_read_le(ptr, type, start, length, vptr)
^~~~~~~~~~~~~~~~~~~~
bfcr.c:495:3: note: in expansion of macro ‘bt_bitfield_read_le’
bt_bitfield_read_le(buf, uint8_t, at, field_size, v);
^~~~~~~~~~~~~~~~~~~
Signed-off-by: Jonathan Rajotte <jonathan.rajotte-julien@efficios.com>
Change-Id: Ie9438e87c69f21ad4062b277d26ee09551ae4c97
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1629
Reviewed-by: Simon Marchi <simon.marchi@efficios.com>
Reviewed-by: Philippe Proulx <eeppeliteloop@gmail.com>
Tested-by: jenkins <jenkins@lttng.org>
Jonathan Rajotte [Thu, 4 Jul 2019 21:27:29 +0000 (17:27 -0400)]
Assign *_STATUS_OK to ret
pretty.c:227 'ret' may be used uninitialized in this function [-Wmaybe-uninitialized]
This *could* happen if next_status is BT_MESSAGE_ITERATOR_NEXT_STATUS_OK
and count is still 0.
Signed-off-by: Jonathan Rajotte <jonathan.rajotte-julien@efficios.com>
Change-Id: I4a08d1bcc2f9b56e225ca17a210a4597169ed746
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1634
Reviewed-by: Philippe Proulx <eeppeliteloop@gmail.com>
Philippe Proulx [Thu, 4 Jul 2019 07:04:20 +0000 (03:04 -0400)]
Fix: sink.text.pretty: support unknown event class name
An event class's name property is optional. Add support in
`sink.text.pretty` for a nonexistent event class name. The component
prints `<unknown>`, the same way it prints this for an enumeration field
value without a corresponding mapping.
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Change-Id: I26740a254956534d0a47b3760456314466afc4d7
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1623
Tested-by: jenkins <jenkins@lttng.org>
Michael Jeanson [Thu, 4 Jul 2019 14:40:41 +0000 (10:40 -0400)]
tests: Remove stale tests launcher
Those 2 unused test launcher scripts were accidentaly commited when the
test suite was reworked.
Signed-off-by: Michael Jeanson <mjeanson@efficios.com>
Change-Id: Iadcddf7b91acd021298bee68d14985924f3244b8
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1625
Reviewed-by: Francis Deslauriers <francis.deslauriers@efficios.com>
Reviewed-by: Philippe Proulx <eeppeliteloop@gmail.com>
CI-Build: Francis Deslauriers <francis.deslauriers@efficios.com>
Tested-by: jenkins <jenkins@lttng.org>
Jonathan Rajotte [Wed, 3 Jul 2019 21:02:59 +0000 (17:02 -0400)]
tests: Add ".exe" when running on a mingw system
libtool wrapper fail to resolve executable without ".exe" suffix on
mingw system.
tests/ctf-writer/test_ctf_writer:
babeltrace2:./.libs/lt-babeltrace2.c:237: FATAL: couldn't find ./../utils/../../src/cli/babeltrace2.
not ok 325 - Babeltrace could read the resulting trace
Change-Id: I4e916077925b34745e6b70d14d86e263427d081e
Signed-off-by: Jonathan Rajotte <jonathan.rajotte-julien@efficios.com>
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1611
Reviewed-by: Philippe Proulx <eeppeliteloop@gmail.com>
Reviewed-by: Michael Jeanson <mjeanson@efficios.com>
Jonathan Rajotte [Wed, 3 Jul 2019 21:46:45 +0000 (17:46 -0400)]
Fix: log_level usage on mingw platform
The mingw build was simply broken.
For example:
mman.c: In function 'mmap_lock':
mman.c:29:30: error: 'mapping' undeclared (first use in this function)
29 | #define BT_LOG_OUTPUT_LEVEL (mapping->log_level)
| ^~~~~~~
../../src/logging/log.h:165:31: note: in expansion of macro 'BT_LOG_OUTPUT_LEVEL'
165 | #define _BT_LOG_OUTPUT_LEVEL BT_LOG_OUTPUT_LEVEL
| ^~~~~~~~~~~~~~~~~~~
../../src/logging/log.h:671:38: note: in expansion of macro '_BT_LOG_OUTPUT_LEVEL'
671 | (BT_LOG_ENABLED((lvl)) && (lvl) >= _BT_LOG_OUTPUT_LEVEL)
| ^~~~~~~~~~~~~~~~~~~~
../../src/logging/log.h:835:9: note: in expansion of macro 'BT_LOG_ON'
835 | if (BT_LOG_ON(lvl)) \
| ^~~~~~~~~
../../src/logging/log.h:974:4: note: in expansion of macro 'BT_LOG_WRITE'
974 | BT_LOG_WRITE(BT_LOG_FATAL, _BT_LOG_TAG, __VA_ARGS__)
| ^~~~~~~~~~~~
../../src/logging/log.h:995:24: note: in expansion of macro 'BT_LOGF'
995 | #define BT_LOGF_STR(s) BT_LOGF("%s", (s))
| ^~~~~~~
mman.c:122:3: note: in expansion of macro 'BT_LOGF_STR'
122 | BT_LOGF_STR("Failed to acquire mmap_mutex.");
| ^~~~~~~~~~~
mman.c:29:30: note: each undeclared identifier is reported only once for each function it appears in
29 | #define BT_LOG_OUTPUT_LEVEL (mapping->log_level)
| ^~~~~~~
../../src/logging/log.h:165:31: note: in expansion of macro 'BT_LOG_OUTPUT_LEVEL'
165 | #define _BT_LOG_OUTPUT_LEVEL BT_LOG_OUTPUT_LEVEL
| ^~~~~~~~~~~~~~~~~~~
../../src/logging/log.h:671:38: note: in expansion of macro '_BT_LOG_OUTPUT_LEVEL'
671 | (BT_LOG_ENABLED((lvl)) && (lvl) >= _BT_LOG_OUTPUT_LEVEL)
| ^~~~~~~~~~~~~~~~~~~~
../../src/logging/log.h:835:9: note: in expansion of macro 'BT_LOG_ON'
835 | if (BT_LOG_ON(lvl)) \
| ^~~~~~~~~
../../src/logging/log.h:974:4: note: in expansion of macro 'BT_LOG_WRITE'
974 | BT_LOG_WRITE(BT_LOG_FATAL, _BT_LOG_TAG, __VA_ARGS__)
| ^~~~~~~~~~~~
../../src/logging/log.h:995:24: note: in expansion of macro 'BT_LOGF'
995 | #define BT_LOGF_STR(s) BT_LOGF("%s", (s))
| ^~~~~~~
mman.c:122:3: note: in expansion of macro 'BT_LOGF_STR'
122 | BT_LOGF_STR("Failed to acquire mmap_mutex.");
| ^~~~~~~~~~~
mman.c: In function 'mmap_unlock':
mman.c:29:30: error: 'mapping' undeclared (first use in this function)
29 | #define BT_LOG_OUTPUT_LEVEL (mapping->log_level)
| ^~~~~~~
../../src/logging/log.h:165:31: note: in expansion of macro 'BT_LOG_OUTPUT_LEVEL'
165 | #define _BT_LOG_OUTPUT_LEVEL BT_LOG_OUTPUT_LEVEL
| ^~~~~~~~~~~~~~~~~~~
../../src/logging/log.h:671:38: note: in expansion of macro '_BT_LOG_OUTPUT_LEVEL'
671 | (BT_LOG_ENABLED((lvl)) && (lvl) >= _BT_LOG_OUTPUT_LEVEL)
| ^~~~~~~~~~~~~~~~~~~~
../../src/logging/log.h:835:9: note: in expansion of macro 'BT_LOG_ON'
835 | if (BT_LOG_ON(lvl)) \
| ^~~~~~~~~
../../src/logging/log.h:974:4: note: in expansion of macro 'BT_LOG_WRITE'
974 | BT_LOG_WRITE(BT_LOG_FATAL, _BT_LOG_TAG, __VA_ARGS__)
| ^~~~~~~~~~~~
../../src/logging/log.h:995:24: note: in expansion of macro 'BT_LOGF'
995 | #define BT_LOGF_STR(s) BT_LOGF("%s", (s))
| ^~~~~~~
mman.c:131:3: note: in expansion of macro 'BT_LOGF_STR'
131 | BT_LOGF_STR("Failed to release mmap_mutex.");
| ^~~~~~~~~~~
mman.c: At top level:
mman.c:173:7: error: conflicting types for 'bt_mmap'
173 | void *bt_mmap(void *addr, size_t length, int prot, int flags, int fd,
| ^~~~~~~
In file included from mman.c:53:
../../src/compat/mman.h:48:7: note: previous declaration of 'bt_mmap' was here
48 | void *bt_mmap(void *addr, size_t length, int prot, int flags, int fd,
| ^~~~~~~
mman.c: In function 'bt_mmap':
mman.c:202:12: error: too many arguments to function 'mapping_create'
202 | mapping = mapping_create(log_level);
| ^~~~~~~~~~~~~~
mman.c:73:22: note: declared here
73 | struct mmap_mapping *mapping_create(void)
| ^~~~~~~~~~~~~~
make[2]: *** [Makefile:501: mman.lo] Error 1
Change-Id: I71b36504541382cadf09953d9e113adc6c3641b6
Signed-off-by: Jonathan Rajotte <jonathan.rajotte-julien@efficios.com>
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1610
Tested-by: jenkins <jenkins@lttng.org>
Reviewed-by: Philippe Proulx <eeppeliteloop@gmail.com>
Simon Marchi [Wed, 3 Jul 2019 19:46:14 +0000 (15:46 -0400)]
tests: add python plugin provider path to lib search path
I am working on a test that uses a component class implemented in a
Python plugin. For it to work, babeltrace therefore needs to be able to
load the python plugin provider lib. It currently isn't found:
LIB/PLUGIN init_python_plugin_provider@plugin.c:84 Loading Python plugin provider module.
LIB/PLUGIN init_python_plugin_provider@plugin.c:94 Cannot open `libbabeltrace2-python-plugin-provider.so`: libbabeltrace2-python-plugin -provider.so: cannot open shared object file: No such file or directory: continuing without Python plugin support.
This patch makes run_python_bt2 add the right path to LD_LIBRARY_PATH
(PATH on Windows) so that babeltrace can load python plugins.
With this added we don't need the feature of run_python_bt2 and
run_python_bt2 that allowed to append an additional directory to
LD_LIBRARY_PATH, so it is removed.
Change-Id: Ie72f59c9ef4866c7f0eae0e6f49025d2fa1ba127
Signed-off-by: Simon Marchi <simon.marchi@efficios.com>
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1608
CI-Build: Michael Jeanson <mjeanson@efficios.com>
Reviewed-by: Michael Jeanson <mjeanson@efficios.com>
Reviewed-by: Philippe Proulx <eeppeliteloop@gmail.com>
Tested-by: jenkins <jenkins@lttng.org>
Simon Marchi [Thu, 6 Jun 2019 20:59:44 +0000 (16:59 -0400)]
Fix: trimmer: use regexes to parse dates and times
This patch fixes a few issues related to how the trimmer component
parses timestamps.
1. Less than 9 digits in the nanoseconds position is not interpreted
correctly.
Passing "2019-01-02 12:34:56.444", we expect the nanosecond portion
to mean 444 ms, or
444000000 ns. Currently, it is interpreted as 444
ns.
2. We wrongfully accept missing digits in the various fields
It is currently possible to pass a date as "2019-1-2" (instead of
"2019-01-02") or a time as "1:2:3" (instead of "01:02:03"). This
patch makes the parsing stricter, in order to only accept the right
number of digits when parsing dates (in the form "YYYY-MM-DD") and
times (in the form "HH:MM:SS"). The nanosecond portion, if present,
can contain anywhere from 1 to 9 digits.
Change-Id: Ie315cec0bc7387ecdaa999d6c5f82f70035412f3
Signed-off-by: Simon Marchi <simon.marchi@efficios.com>
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1389
CI-Build: Philippe Proulx <eeppeliteloop@gmail.com>
Tested-by: jenkins <jenkins@lttng.org>
Reviewed-by: Philippe Proulx <eeppeliteloop@gmail.com>
Simon Marchi [Wed, 3 Jul 2019 15:40:49 +0000 (11:40 -0400)]
tests: Use diff -u
We are all more used to "unified" diff output formats than other
formats, so I suggest we use that for differences between expected and
actual results.
Change-Id: I681fcd232459eedf9c084514ca9d54be9732adcc
Signed-off-by: Simon Marchi <simon.marchi@efficios.com>
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1601
Reviewed-by: Jonathan Rajotte Julien <jonathan.rajotte-julien@efficios.com>
Reviewed-by: Michael Jeanson <mjeanson@efficios.com>
Reviewed-by: Philippe Proulx <eeppeliteloop@gmail.com>
CI-Build: Michael Jeanson <mjeanson@efficios.com>
Tested-by: jenkins <jenkins@lttng.org>
Philippe Proulx [Wed, 3 Jul 2019 18:30:55 +0000 (14:30 -0400)]
Fix compiler -Wall warnings (mostly incompatible enumerations)
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Change-Id: I399b4f8d69d116e057e4b7c89ae758744ec3f5a9
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1605
Tested-by: jenkins <jenkins@lttng.org>
Simon Marchi [Wed, 3 Jul 2019 18:20:02 +0000 (14:20 -0400)]
trimmer: remove unused function
Change-Id: Ic77198b4d94673dd97b63a5d042ca50e5b292081
Signed-off-by: Simon Marchi <simon.marchi@efficios.com>
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1604
Reviewed-by: Philippe Proulx <eeppeliteloop@gmail.com>
Philippe Proulx [Wed, 3 Jul 2019 17:00:01 +0000 (13:00 -0400)]
Add back (adapted) `test_bt_values` and `test_graph_topo`
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Change-Id: If030ce3688e94162060ed5d220449bf3f7895c6a
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1603
Tested-by: jenkins <jenkins@lttng.org>
Philippe Proulx [Tue, 2 Jul 2019 21:16:27 +0000 (17:16 -0400)]
Allow only TRACE, DEBUG, and INFO as the build-time, minimal log level
As there's no noticeable performance difference between having the INFO
log level and the FATAL log level as the build's minimal log level,
force it to be TRACE, DEBUG, or INFO. This means that INFO, WARN, ERROR,
and FATAL logging is always enabled, whatever the build configuration.
This seems reasonable and could prove useful to support/debugging
operations.
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Change-Id: Ie4261fd16d344587ef4b37ea1715d7302ad25087
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1590
Philippe Proulx [Sun, 30 Jun 2019 06:26:38 +0000 (02:26 -0400)]
lib: strictly type function return status enumerations
Rigour strikes again.
This patch makes each function (or group of related functions) of the
library which returns a status enumeration return its own,
function-specific status enumeration.
For example, where bt_graph_run() used to return the generic
`bt_graph_status` type, it now returns `bt_graph_run_status`.
The benefits are:
* Each function defines its own set of available status codes. With
appropriate compiler warnings, you can catch comparisons between a
returned status and an incompatible enumerator, and assignments of
incompatible enumerators. For example, with clang 8:
file.c:13:13: warning: implicit conversion from enumeration type
'enum bt_component_class_init_method_status'
to different enumeration type
'enum bt_component_class_port_connected_method_status'
[-Wenum-conversion]
bt_component_class_port_connected_method_status status =
BT_COMPONENT_CLASS_INIT_METHOD_STATUS_ERROR;
This was not possible before because all the status-returning
functions of a given header could possibly return any value defined by
the header-wide status enumeration.
* A function's possible return values are self-documented: there's no
need to document that a given function can only return some subset of
the header-wide status enumerators.
* In future minor releases of Babeltrace 2, we can add new status codes
for a specific function.
* Some smart IDEs will list the possible enumerators when checking the
return value of a function or when returning a value from a function.
To uniformize the status enumerator integer values, the new
`<babeltrace2/func-status.h>` public header contains definitions for all
the possible status codes. They are definitions instead of enumerators
because they are not meant to be used directly by user code.
To make sure a user does not write:
#include <babeltrace2/func-status.h>
to use the `__BT_FUNC_STATUS_*` definitions directly (which would
inhibit the precious type checking that this patch is all about), the
compiler will show the error:
> Do NOT include <babeltrace2/func-status.h> in user code.
unless you define `__BT_FUNC_STATUS_ENABLE` before including the header.
Each public header which needs `__BT_FUNC_STATUS_*` definitions to
define its own status enumerations does:
/* For __BT_FUNC_STATUS_* */
#define __BT_FUNC_STATUS_ENABLE
#include <babeltrace2/func-status.h>
#undef __BT_FUNC_STATUS_ENABLE
at the beginning of the file, and:
#include <babeltrace2/undef-func-status.h>
at the end of the file. The `<babeltrace2/undef-func-status.h>` header
cancels all the existing `__BT_FUNC_STATUS_*` definitions so that they
are not available to user code.
Within the library, `"lib/func-status.h"` uses the definitions of
`<babeltrace2/func-status.h>` to define its own, similar definitions,
but without the `__` prefix for improved internal code readability.
Internal library code does not need to "undefine" those definitions.
As this system guarantees that any public status enumerator is an alias
of one of the `__BT_FUNC_STATUS_*` definitions, the library code never
uses the function-specific status enumerators directly: it always uses
one of the `BT_FUNC_STATUS_*` definitions found in
`"lib/func-status.h"`. This made it easier to adapt existing code. This
also allows to pass such status codes easily between internal and public
functions because they are `int` values until they finally reach public
enumeration types where they are implicitly casted.
When an internal (hidden, static) function returns a status code, it now
returns `int`, using one of the `BT_FUNC_STATUS_*` values, where this
could be used by at least two functions returning different public
status enumerations.
In internal headers, all the bt_*_status_string() are removed in favor
of bt_common_func_status_string() which returns only the suffix string
(e.g., `OK`, `ERROR`, `OVERFLOW`). This function is typically used when
logging.
The `*_NOMEM` enumerators are renamed to `*_MEMORY_ERROR` to make this
clear and remove this abbreviation which was the only one amongst other
public status enumerators.
Because the Python bindings are within the Babeltrace project, they use
the `__BT_FUNC_STATUS_*` definitions internally. Those values will not
change in the future anyway. All the _handle_*status() and
bt2.utils._handle_ret() functions are removed in favor of
bt2.utils._handle_func_status() which can handle all the possible status
codes and raise a corresponding exception, possibly with a given
message.
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Change-Id: I3966ac0e691219102897920617711c518c34fbdf
Philippe Proulx [Tue, 2 Jul 2019 19:34:42 +0000 (15:34 -0400)]
tests/lib: remove `test_bt_values` and `test_graph_topo`
What those programs test is already tested by the thorough Python
bindings tests.
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Change-Id: I89fe31e7f087bc317ff93861fd3dc257b2b00bf0
Philippe Proulx [Wed, 3 Jul 2019 01:26:25 +0000 (21:26 -0400)]
Fix: bt_packet_context_field_create(): remove "frozen" SC precondition
In bt_packet_context_field_create(), it is not a precondition that the
stream class be frozen. It used to mean that the stream class was
previously added to a trace class, but this is always the case now that
you pass the trace class to bt_stream_class_create().
bt_packet_context_field_create() freezes the stream class on success.
This shows that you can call bt_packet_context_field_create() with a
fresh, hot stream class, and then it becomes frozen.
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Change-Id: I7487a516344d8b666e17d1c5e1a7dcefd1fd182e
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1591
Tested-by: jenkins <jenkins@lttng.org>
Philippe Proulx [Sat, 29 Jun 2019 16:30:09 +0000 (12:30 -0400)]
test_{field,value}.py: array test cases: add non-sequence equality tests
The new tests verify that an array field or an array value is not equal
to another iterable object which would provide the correct element
values, but which is not a `collections.abc.Sequence`. This is similar
to how
[1, 3, 5] == collections.OrderedDict([(1, 2), (3, 4), (5, 6)])
is false.
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Change-Id: If7402e4f0e747d2c9d17ddb5ce7aa4fc4156314d
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1588
Tested-by: jenkins <jenkins@lttng.org>
Reviewed-by: Francis Deslauriers <francis.deslauriers@efficios.com>
Philippe Proulx [Sat, 29 Jun 2019 16:16:38 +0000 (12:16 -0400)]
test_{field,value}.py: test complex number RHS for binary operations
This patch adds injected tests for numeric field and value test cases in
which the RHS operand of the tested binary operations is a complex
number, both `-23+19j` and `0j`.
This is to ensure that a binary operator applied to a field object or a
value object and a Python complex number returns what's expected by the
langage, so you can do:
print(my_field + 8+4.2j)
if you wish.
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Change-Id: I5cade062e285752d0a917a8b751824b0ebc97f16
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1587
Tested-by: jenkins <jenkins@lttng.org>
Reviewed-by: Francis Deslauriers <francis.deslauriers@efficios.com>
Philippe Proulx [Sat, 29 Jun 2019 16:04:41 +0000 (12:04 -0400)]
test_value.py: make `BoolValueTestCase` inherit `_TestNumericValue`
`BoolValue` is a numeric value, so `BoolValueTestCase` can inherit
`_TestNumericValue` and get more tests.
_inject_numeric_testing_methods() is also called on `BoolValueTestCase`
to test the different unary and binary operators.
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Change-Id: I8fff73a0dda1e9ec9f6737739dde255c9b079ebf
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1586
Tested-by: jenkins <jenkins@lttng.org>
Reviewed-by: Francis Deslauriers <francis.deslauriers@efficios.com>
Philippe Proulx [Sat, 29 Jun 2019 15:41:36 +0000 (11:41 -0400)]
test_value.py: _inject_numeric_testing_methods(): remove `has_neg`
This was only required for "self", __i*__() operators, which needed to
modify the value object. For example, you couldn't do:
u = bt2.UnsignedIntegerValue(34)
u -= 100
because the assignment in __isub__() had an invalid value.
Now the __i*__() operators do not exist anymore, so all RHS negative
values work.
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Change-Id: Ib2217150bd5c90b2ab72e5ed3b02c5d5206a22c3
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1585
Tested-by: jenkins <jenkins@lttng.org>
Reviewed-by: Francis Deslauriers <francis.deslauriers@efficios.com>
Philippe Proulx [Sat, 29 Jun 2019 15:28:34 +0000 (11:28 -0400)]
test_{field,value}.py: add comments
Those files contain code which is very similar. It should be a single
helper base class eventually, but this patch only adds comments to both
files to clarify the usage of some classes and methods.
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Change-Id: I15d8d4e1d8d3444491b9f01deb6d2cdcc5d406d1
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1584
Tested-by: jenkins <jenkins@lttng.org>
Reviewed-by: Francis Deslauriers <francis.deslauriers@efficios.com>
Philippe Proulx [Fri, 28 Jun 2019 05:16:21 +0000 (01:16 -0400)]
bt2: create_value(): check `numbers` and `collections.abc` types
This is just like what's done within _NumericValue._extract_value(),
_IntegerValue._value_to_int(), RealValue._value_to_float(),
StringValue._value_to_str(), ArrayValue.__eq__(), and MapValue.__eq__().
It is more versatile than checking for the specific built-in types.
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Change-Id: I93902e58b6adf3f9cd5c03c7c422148d577b5f0f
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1571
Tested-by: jenkins <jenkins@lttng.org>
Reviewed-by: Francis Deslauriers <francis.deslauriers@efficios.com>
Reviewed-by: Simon Marchi <simon.marchi@efficios.com>
Philippe Proulx [Fri, 28 Jun 2019 05:12:11 +0000 (01:12 -0400)]
bt2: _ArrayField.__setitem__(): do not check type
There's no need to check the type of the parameter because
field.value = value
will raise a type error if `value` has an unexpected type.
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Change-Id: I0ae91873024e9a52a00bb1ac6f03ff830a19dea7
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1570
Tested-by: jenkins <jenkins@lttng.org>
Reviewed-by: Francis Deslauriers <francis.deslauriers@efficios.com>
Reviewed-by: Simon Marchi <simon.marchi@efficios.com>
Philippe Proulx [Fri, 28 Jun 2019 05:08:25 +0000 (01:08 -0400)]
bt2: field.py: _value_to_int(): require `numbers.Integral`
Be more strict in the _value_to_int() functions: require that the
parameter's type is an instance of `numbers.Integral` instead of
`numbers.Real` to make the following raise a type error:
my_int_field.value = 17.5
I believe it's better to be strict here than to arbitrarily choose to
use the parameter's value's floor.
RealValue._value_to_float() already requires a real value, so this is
just analogous.
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Change-Id: I3b981e90f7e2c133fa4d56e79333c4fe600eca8b
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1569
Tested-by: jenkins <jenkins@lttng.org>
Reviewed-by: Francis Deslauriers <francis.deslauriers@efficios.com>
Reviewed-by: Simon Marchi <simon.marchi@efficios.com>
Philippe Proulx [Fri, 28 Jun 2019 05:03:18 +0000 (01:03 -0400)]
bt2: field.py: numeric classes: remove __i*__ operators
Those operators do a binary operation to a field object and another
operand, and then set the result as the field object's value.
Now that I think about it, it is weird to do something like:
my_int_field += 17.5
and that, when the value of `my_int_field` was 23, its value after the
operation becomes 40. This is not a problem for a native Python object
because `a` does not name the same object after the operation:
a = 23
type(a) # int
id(a) #
140669243488160
a += 17.5
type(a) # float
id(a) #
140669043054920
but we can't do this with our field object: this is internal Python's
magic.
So I believe we should be more strict. But this means you can't do:
my_int_field += 17.5
anymore (a `TypeError` exception would be raised).
This means a lot of specific automatically injected tests must
conditionally exist (depending on whether or not the test is possible
with the two operands, whereas it's always possible now).
Instead of doing this work, I choose to completely remove the support
for "self" operators. We can add useful ones in the future when we have
time, but I don't even think they are super useful: because a field
object becomes conceptually frozen as soon as you emit a message which
owns it indirectly, there's no point in doing `+=`, `-=`, `**=`, `<<=`,
and so on. For those rare cases, you can always do:
my_int_field = my_int_field + 17
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Change-Id: I5410ff8fdb2c3a1910e788542376d521601fdf8f
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1568
Tested-by: jenkins <jenkins@lttng.org>
Reviewed-by: Francis Deslauriers <francis.deslauriers@efficios.com>
Reviewed-by: Simon Marchi <simon.marchi@efficios.com>
Philippe Proulx [Fri, 28 Jun 2019 04:44:04 +0000 (00:44 -0400)]
bt2: value.py: _IntegerValue._value_to_int(): require `numbers.Integral`
Be more strict in _IntegerValue._value_to_int(): require that the
parameter's type is an instance of `numbers.Integral` instead of
`numbers.Real` to make the following raise a type error:
bt2.UnsignedIntegerValue(17.5)
and
a = bt2.UnsignedIntegerValue()
a.value = 17.5
I believe it's better to be strict here than to arbitrarily choose to
use the parameter's value's floor.
BoolValue._value_to_bool() and RealValue._value_to_float() already
require resp. a boolean value and a real value, so this is just
analogous.
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Change-Id: I374baf8c5d69400b687daabea873598eb2543a47
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1567
Tested-by: jenkins <jenkins@lttng.org>
Reviewed-by: Francis Deslauriers <francis.deslauriers@efficios.com>
Reviewed-by: Simon Marchi <simon.marchi@efficios.com>
Philippe Proulx [Fri, 28 Jun 2019 04:32:14 +0000 (00:32 -0400)]
bt2: value.py: numeric classes: remove __i*__ operators
Those operators do a binary operation to a value object and another
operand, and then set the result as the value object's value.
Now that I think about it, it is weird to do something like:
a = bt2.UnsignedIntegerValue(23)
a += 17.5
and that the value of `a` becomes 40. This is not a problem for a native
Python object because `a` does not name the same object after the
operation:
a = 23
type(a) # int
id(a) #
140669243488160
a += 17.5
type(a) # float
id(a) #
140669043054920
but we can't do this with our value object: this is internal Python's
magic.
So I believe we should be more strict. But this means you can't do:
a = bt2.UnsignedIntegerValue(23)
a += 17.5
anymore (a `TypeError` exception would be raised).
This means a lot of specific automatically injected tests must
conditionally exist (depending on whether or not the test is possible
with the two operands, whereas it's always possible now).
Instead of doing this work, I choose to completely remove the support
for "self" operators. We can add useful ones in the future when we have
time, but I don't even think they are super useful: because a value
object becomes conceptually frozen as soon as you use it somehow,
there's no point in doing `+=`, `-=`, `**=`, `<<=`, and so on. For those
rare cases, you can always do:
a = bt2.UnsignedIntegerValue(23)
a = a + 17
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Change-Id: Icd5f0a9d0232c2f7ba91133561235fec7526083b
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1566
Tested-by: jenkins <jenkins@lttng.org>
Reviewed-by: Francis Deslauriers <francis.deslauriers@efficios.com>
Reviewed-by: Simon Marchi <simon.marchi@efficios.com>
Philippe Proulx [Fri, 28 Jun 2019 04:02:01 +0000 (00:02 -0400)]
bt2: make `BoolValue` inherit `_IntegralValue`
This is just like
issubclass(bool, numbers.Integral)
issubclass(bool, int)
are true.
It makes `BoolValue` behave even more like `bool`, for example you can
now do:
3 << bt2.BoolValue(True)
(which is 6).
Also remove BoolValue.__eq__() because _NumericValue.__eq__() does the
job now.
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Change-Id: Icbcd8d41b9f064c77586e0b7bfdf4a772c15f0f7
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1565
Tested-by: jenkins <jenkins@lttng.org>
Reviewed-by: Simon Marchi <simon.marchi@efficios.com>
Philippe Proulx [Fri, 28 Jun 2019 03:54:08 +0000 (23:54 -0400)]
bt2: field.py: refactor field comparison
Changed:
* In _NumericField._extract_value(), do not check the `False`, and
`True` special cases: check that the parameter is an instance of the
`bool` type to return a boolean object.
* In _ArrayField.__eq__(), be more strict: expect that the parameter is
a sequence object, not just an iterable object. Before this, it was
possible to compare an array field to an ordered dict with keys equal
to the array field content, and this seems wrong as:
collections.OrderedDict((('A', 23), ('B', 42))) == ['A', 'B']
is false. An ordered dict is not a sequence.
* In _StructureField.__eq__(), be more strict: expect that the parameter
is a mapping object, not just an iterable and indexable object. The
reason is similar to the _ArrayField.__eq__() case above. This should
be enough to compare to another structure field or to a dict (or
ordered dict).
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Change-Id: I17f33c24e9dea526e59b5058235d57facb51cfbf
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1564
Tested-by: jenkins <jenkins@lttng.org>
Reviewed-by: Francis Deslauriers <francis.deslauriers@efficios.com>
Philippe Proulx [Fri, 28 Jun 2019 03:51:24 +0000 (23:51 -0400)]
bt2: value.py: refactor value comparison
Changed:
* Remove _spec_eq() methods: each class implements its own __eq__()
method directly.
* Do not use native_bt.value_compare(): we never reached that, because
container value classes (`ArrayValue` and `MapValue`) implement their
own rich, recursive comparison.
* In _NumericValue._extract_value(), do not check the `_NumericValue`,
`False`, and `True` special case: check for `BoolValue` and `bool` to
return a boolean object in those cases.
* In NumericValue.__lt__() and NumericValue.__eq__(), do not check that
the parameter is a number object: self._extract_value() does this
already.
* In BoolValue._value_to_bool(), return the boolean value directly,
not using int(): it's already an integral number.
* In ArrayValue.__eq__(), be more strict: expect that the parameter is
a sequence object, not just an iterable object. Before this, it was
possible to compare an array value to an ordered dict with keys equal
to the array value content, and this seems wrong as:
collections.OrderedDict((('A', 23), ('B', 42))) == ['A', 'B']
is false. An ordered dict is not a sequence.
* In MapValue.__eq__(), be more strict: expect that the parameter is a
mapping object, not just an iterable and indexable object. The reason
is similar to the ArrayValue.__eq__() case above. This should be
enough to compare to another map value or to a dict (or ordered dict).
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Change-Id: I9941d2d82942e2efa8d5380c8ff5a4a2d2cb3a84
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1563
Tested-by: jenkins <jenkins@lttng.org>
Philippe Proulx [Fri, 28 Jun 2019 03:39:21 +0000 (23:39 -0400)]
bt2: make `_ArrayField` inherit `collections.abc.MutableSequence`
An array field is conceptually a mutable sequence just like an array
value (`ArrayValue`).
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Change-Id: Ia3f27fd524286e924b5529030963df33e7553336
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1562
Tested-by: jenkins <jenkins@lttng.org>
Reviewed-by: Simon Marchi <simon.marchi@efficios.com>
Reviewed-by: Francis Deslauriers <francis.deslauriers@efficios.com>
Simon Marchi [Thu, 27 Jun 2019 03:33:58 +0000 (23:33 -0400)]
bt2: let Python message iterators implement seek beginning
This patch adds the possibility for message iterators implemented in
Python to implement the "can seek beginning" and "seek beginning"
operations.
A message iterator can support "seek beginning" by defining a
_seek_beginning method:
class MyIter(bt2._UserMessageIterator):
def _seek_beginning(self):
# Do the needful.
It can support the "can seek beginning" operation by defining a
_can_seek_beginning property, which must evaluate to a bool:
class MyIter(bt2._UserMessageIterator):
@property
def _can_seek_beginning(self):
# Do the needful, including returning a bool.
The behavior of the "can seek beginning" operation is made to mimic
the C API:
- If the iterator has a _can_seek_beginning attribute, it is used to
determine whether the iterator can seek beginning.
- Otherwise, the presence or absence of a _seek_beginning method
indicates whether it can.
Change-Id: I68c48b5cd30090bff833529cda9fa918c7e72b0b
Signed-off-by: Simon Marchi <simon.marchi@efficios.com>
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1555
Reviewed-by: Philippe Proulx <eeppeliteloop@gmail.com>
Philippe Proulx [Fri, 28 Jun 2019 21:03:27 +0000 (17:03 -0400)]
lib: internal: message.h: require logging
This patch makes the internal `message.h` require what it needs instead
of using the macros only if they exist. This makes it impossible to skip
logging in this header.
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Change-Id: I2dd300931479a1d0752b6f90079c826324e19ce1
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1581
Tested-by: jenkins <jenkins@lttng.org>
Reviewed-by: Simon Marchi <simon.marchi@efficios.com>
Philippe Proulx [Fri, 28 Jun 2019 21:01:51 +0000 (17:01 -0400)]
lib: internal: object-pool.h: require logging
This patch makes the internal `object-pool.h` require what it needs
instead of using the macros only if they exist. This makes it impossible
to skip logging in this header.
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Change-Id: I5f1b5550dfca7c7f3e8d62134a2917b059e4da0c
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1580
Tested-by: jenkins <jenkins@lttng.org>
Reviewed-by: Simon Marchi <simon.marchi@efficios.com>
Philippe Proulx [Fri, 28 Jun 2019 21:01:10 +0000 (17:01 -0400)]
Fix: CTF writer: include CTF writer (own) version of `object-pool.h`
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Change-Id: I9261eea60e71e85b56b1abe6bd21d1eb4ebfdeab
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1579
Tested-by: jenkins <jenkins@lttng.org>
Reviewed-by: Simon Marchi <simon.marchi@efficios.com>
Philippe Proulx [Fri, 28 Jun 2019 20:55:38 +0000 (16:55 -0400)]
lib: internal: clock-snapshot-set.h: require logging
This patch makes the internal `clock-snapshot-set.h` require what it
needs instead of using the macros only if they exist. This makes it
impossible to skip logging in this header.
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Change-Id: Ib8b3def2869ab214a3d38e3a1cea7b9954fc056c
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1578
Tested-by: jenkins <jenkins@lttng.org>
Reviewed-by: Simon Marchi <simon.marchi@efficios.com>
Philippe Proulx [Fri, 28 Jun 2019 20:52:42 +0000 (16:52 -0400)]
lib: internal: graph.h: require logging and BT_ASSERT_{PRE,POST}()
This patch makes the internal `graph.h` require what it needs instead of
using the macros only if they exist. This makes it impossible to skip
logging or precondition/postcondition validation in this header.
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Change-Id: I157809be7b56720b2f4a241c45491413f5b8366d
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1577
Tested-by: jenkins <jenkins@lttng.org>
Reviewed-by: Simon Marchi <simon.marchi@efficios.com>
Philippe Proulx [Fri, 28 Jun 2019 20:45:01 +0000 (16:45 -0400)]
lib: internal: define `BT_ASSERT_{PRE,POST}_SUPPORTED` in headers
This is to make some headers require that precondition and postcondition
assertion macros exist when including them, just like
`src/lib/logging.h` defines `BT_LIB_LOG_SUPPORTED` for the same reason.
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Change-Id: Ia2db609ae540b29129b9260c237f8b8d9657d977
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1576
Tested-by: jenkins <jenkins@lttng.org>
Reviewed-by: Simon Marchi <simon.marchi@efficios.com>
Philippe Proulx [Fri, 28 Jun 2019 20:44:25 +0000 (16:44 -0400)]
lib: internal: replace BT_ASSERT_PRE* -> BT_ASSERT_POST* where applicable
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Change-Id: I8acc12b771a7d4040bc136d5860311fc7646295f
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1575
Tested-by: jenkins <jenkins@lttng.org>
Reviewed-by: Simon Marchi <simon.marchi@efficios.com>
Philippe Proulx [Fri, 28 Jun 2019 19:55:56 +0000 (15:55 -0400)]
lib: internal: add BT_ASSERT_POST()
BT_ASSERT_POST() is just like BT_ASSERT_PRE(), but it is used to
validate the returned values of user functions and methods.
The only difference with BT_ASSERT_PRE() is that its error message
indicates that a postcondition was not satisfied instead of a
precondition. This is simply more accurate.
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Change-Id: I91815301ada19b42ba58f32db7b9c412cbe641e0
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1574
Tested-by: jenkins <jenkins@lttng.org>
Reviewed-by: Simon Marchi <simon.marchi@efficios.com>
Philippe Proulx [Thu, 27 Jun 2019 16:24:23 +0000 (12:24 -0400)]
Add `src/py-common`, containing bt_py_common_format_exception() for now
This new convenience library is meant to contain functions used by
Python bindings and the Python plugin provider.
As of this patch, it only offers bt_py_common_format_exception(), which
is similar to what bt2_py_loge_exception() used to do in
`native_bt_component_class.i`, except that it returns the formatted
exception string instead of logging it directly. Now
bt2_py_loge_exception() uses bt_py_common_format_exception().
bt_py_common_format_exception() will be needed in a future patch to set
the message of an error cause when appending from the Python plugin
provider.
No functional change intended.
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Change-Id: Iaa9dc081e7d8a3d6c85420fcbbfc045a9d79bf27
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1556
Tested-by: jenkins <jenkins@lttng.org>
Michael Jeanson [Fri, 28 Jun 2019 20:01:56 +0000 (16:01 -0400)]
fix: don't use realpath from GNU coreutils
Turns out 'realpath' is specific to GNU coretuils, we'll have to live
with uglier relative unresolved paths.
Signed-off-by: Michael Jeanson <mjeanson@efficios.com>
Change-Id: I7febbd12dd7f8d49c938f3fffc6db44c6dd89d6a
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1573
Tested-by: jenkins <jenkins@lttng.org>
Reviewed-by: Philippe Proulx <eeppeliteloop@gmail.com>
This page took 0.057789 seconds and 4 git commands to generate.
projects / babeltrace.git / log
