From: Simon Marchi Date: Tue, 3 Sep 2019 19:28:20 +0000 (-0400) Subject: rename `babeltrace.trace-info` to `babeltrace.trace-infos`, `streams` to `stream... X-Git-Url: http://git.efficios.com/?p=babeltrace.git;a=commitdiff_plain;h=5f2a1585bf407f3f3aa7e63d9041b75390cf8563 rename `babeltrace.trace-info` to `babeltrace.trace-infos`, `streams` to `stream-infos` Because the query response is a list of potentially multiple trace infos, use the plural form for the object name. Change-Id: I6b742b4993d1a1552c1d189c54759821d4fd069c Signed-off-by: Simon Marchi Reviewed-on: https://review.lttng.org/c/babeltrace/+/1999 Tested-by: jenkins Reviewed-by: Francis Deslauriers --- diff --git a/src/bindings/python/bt2/bt2/trace_collection_message_iterator.py b/src/bindings/python/bt2/bt2/trace_collection_message_iterator.py index ea1d7eb3..821b5eae 100644 --- a/src/bindings/python/bt2/bt2/trace_collection_message_iterator.py +++ b/src/bindings/python/bt2/bt2/trace_collection_message_iterator.py @@ -345,27 +345,30 @@ class TraceCollectionMessageIterator(bt2_message_iterator._MessageIterator): self._stream_inter_port_to_range = {} for src_comp_and_spec in self._src_comps_and_specs: - # query the port's component for the `babeltrace.trace-info` + # Query the port's component for the `babeltrace.trace-infos` # object which contains the range for each stream, from which we can # compute the intersection of the streams in each trace. query_exec = bt2.QueryExecutor( src_comp_and_spec.spec.component_class, - 'babeltrace.trace-info', + 'babeltrace.trace-infos', src_comp_and_spec.spec.params, ) trace_infos = query_exec.query() for trace_info in trace_infos: begin = max( - [stream['range-ns']['begin'] for stream in trace_info['streams']] + [ + stream['range-ns']['begin'] + for stream in trace_info['stream-infos'] + ] ) end = min( - [stream['range-ns']['end'] for stream in trace_info['streams']] + [stream['range-ns']['end'] for stream in trace_info['stream-infos']] ) # Each port associated to this trace will have this computed # range. - for stream in trace_info['streams']: + for stream in trace_info['stream-infos']: # A port name is unique within a component, but not # necessarily across all components. Use a component # and port name pair to make it unique across the graph. diff --git a/src/cli/babeltrace2-cfg-cli-args.c b/src/cli/babeltrace2-cfg-cli-args.c index 9544139b..e7ee709a 100644 --- a/src/cli/babeltrace2-cfg-cli-args.c +++ b/src/cli/babeltrace2-cfg-cli-args.c @@ -3849,7 +3849,7 @@ struct bt_config *bt_config_convert_from_args(int argc, const char *argv[], case OPT_STREAM_INTERSECTION: /* * Applies to all traces implementing the - * babeltrace.trace-info query. + * babeltrace.trace-infos query. */ stream_intersection_mode = true; break; diff --git a/src/cli/babeltrace2.c b/src/cli/babeltrace2.c index c32fa477..aa195d1c 100644 --- a/src/cli/babeltrace2.c +++ b/src/cli/babeltrace2.c @@ -1951,7 +1951,7 @@ int compute_stream_intersection(const bt_value *streams, stream_value = bt_value_array_borrow_element_by_index_const(streams, i); if (bt_value_get_type(stream_value) != BT_VALUE_TYPE_MAP) { - BT_CLI_LOGE_APPEND_CAUSE("Unexpected format of `babeltrace.trace-info` query result: " + BT_CLI_LOGE_APPEND_CAUSE("Unexpected format of `babeltrace.trace-infos` query result: " "expected streams array element to be a map, got %s.", bt_common_value_type_string(bt_value_get_type(stream_value))); goto error; @@ -1960,13 +1960,13 @@ int compute_stream_intersection(const bt_value *streams, range_ns_value = bt_value_map_borrow_entry_value_const( stream_value, "range-ns"); if (!range_ns_value) { - BT_CLI_LOGE_APPEND_CAUSE("Unexpected format of `babeltrace.trace-info` query result: " + BT_CLI_LOGE_APPEND_CAUSE("Unexpected format of `babeltrace.trace-infos` query result: " "missing expected `range-ns` key in stream map."); goto error; } if (bt_value_get_type(range_ns_value) != BT_VALUE_TYPE_MAP) { - BT_CLI_LOGE_APPEND_CAUSE("Unexpected format of `babeltrace.trace-info` query result: " + BT_CLI_LOGE_APPEND_CAUSE("Unexpected format of `babeltrace.trace-infos` query result: " "expected `range-ns` entry value of stream map to be a map, got %s.", bt_common_value_type_string(bt_value_get_type(range_ns_value))); goto error; @@ -1974,13 +1974,13 @@ int compute_stream_intersection(const bt_value *streams, begin_value = bt_value_map_borrow_entry_value_const(range_ns_value, "begin"); if (!begin_value) { - BT_CLI_LOGE_APPEND_CAUSE("Unexpected format of `babeltrace.trace-info` query result: " + BT_CLI_LOGE_APPEND_CAUSE("Unexpected format of `babeltrace.trace-infos` query result: " "missing expected `begin` key in range-ns map."); goto error; } if (bt_value_get_type(begin_value) != BT_VALUE_TYPE_SIGNED_INTEGER) { - BT_CLI_LOGE_APPEND_CAUSE("Unexpected format of `babeltrace.trace-info` query result: " + BT_CLI_LOGE_APPEND_CAUSE("Unexpected format of `babeltrace.trace-infos` query result: " "expected `begin` entry value of range-ns map to be a signed integer, got %s.", bt_common_value_type_string(bt_value_get_type(range_ns_value))); goto error; @@ -1988,13 +1988,13 @@ int compute_stream_intersection(const bt_value *streams, end_value = bt_value_map_borrow_entry_value_const(range_ns_value, "end"); if (!end_value) { - BT_CLI_LOGE_APPEND_CAUSE("Unexpected format of `babeltrace.trace-info` query result: " + BT_CLI_LOGE_APPEND_CAUSE("Unexpected format of `babeltrace.trace-infos` query result: " "missing expected `end` key in range-ns map."); goto error; } if (bt_value_get_type(end_value) != BT_VALUE_TYPE_SIGNED_INTEGER) { - BT_CLI_LOGE_APPEND_CAUSE("Unexpected format of `babeltrace.trace-info` query result: " + BT_CLI_LOGE_APPEND_CAUSE("Unexpected format of `babeltrace.trace-infos` query result: " "expected `end` entry value of range-ns map to be a signed integer, got %s.", bt_common_value_type_string(bt_value_get_type(range_ns_value))); goto error; @@ -2049,11 +2049,11 @@ int set_stream_intersections(struct cmd_run_ctx *ctx, const bt_component_class *comp_cls = bt_component_class_source_as_component_class_const(src_comp_cls); - ret = query(ctx->cfg, comp_cls, "babeltrace.trace-info", + ret = query(ctx->cfg, comp_cls, "babeltrace.trace-infos", cfg_comp->params, &query_result, &fail_reason); if (ret) { - BT_CLI_LOGE_APPEND_CAUSE("Component class does not support the `babeltrace.trace-info` query: %s: " + BT_CLI_LOGE_APPEND_CAUSE("Component class does not support the `babeltrace.trace-infos` query: %s: " "comp-class-name=\"%s\"", fail_reason, bt_component_class_get_name(comp_cls)); ret = -1; @@ -2063,7 +2063,7 @@ int set_stream_intersections(struct cmd_run_ctx *ctx, BT_ASSERT(query_result); if (!bt_value_is_array(query_result)) { - BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-info` query: expecting result to be an array: " + BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: expecting result to be an array: " "component-class-name=%s, actual-type=%s", bt_component_class_get_name(comp_cls), bt_common_value_type_string(bt_value_get_type(query_result))); @@ -2073,7 +2073,7 @@ int set_stream_intersections(struct cmd_run_ctx *ctx, trace_count = bt_value_array_get_length(query_result); if (trace_count < 0) { - BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-info` query: result is empty: " + BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: result is empty: " "component-class-name=%s", bt_component_class_get_name(comp_cls)); ret = -1; goto end; @@ -2089,7 +2089,7 @@ int set_stream_intersections(struct cmd_run_ctx *ctx, BT_ASSERT(trace_info); if (!bt_value_is_map(trace_info)) { ret = -1; - BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-info` query: expecting element to be a map: " + BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: expecting element to be a map: " "component-class-name=%s, actual-type=%s", bt_component_class_get_name(comp_cls), bt_common_value_type_string(bt_value_get_type(trace_info))); @@ -2097,10 +2097,10 @@ int set_stream_intersections(struct cmd_run_ctx *ctx, } stream_infos = bt_value_map_borrow_entry_value_const( - trace_info, "streams"); + trace_info, "stream-infos"); if (!stream_infos) { ret = -1; - BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-info` query: missing `streams` key in trace info map: " + BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: missing `streams` key in trace info map: " "component-class-name=%s", bt_component_class_get_name(comp_cls)); goto end; @@ -2108,7 +2108,7 @@ int set_stream_intersections(struct cmd_run_ctx *ctx, if (!bt_value_is_array(stream_infos)) { ret = -1; - BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-info` query: expecting `streams` entry of trace info map to be an array: " + BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: expecting `streams` entry of trace info map to be an array: " "component-class-name=%s, actual-type=%s", bt_component_class_get_name(comp_cls), bt_common_value_type_string(bt_value_get_type(stream_infos))); @@ -2118,7 +2118,7 @@ int set_stream_intersections(struct cmd_run_ctx *ctx, stream_count = bt_value_array_get_length(stream_infos); if (stream_count < 0) { ret = -1; - BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-info` query: list of streams is empty: " + BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: list of streams is empty: " "component-class-name=%s", bt_component_class_get_name(comp_cls)); goto end; @@ -2163,7 +2163,7 @@ int set_stream_intersections(struct cmd_run_ctx *ctx, BT_ASSERT(stream_info); if (!bt_value_is_map(stream_info)) { ret = -1; - BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-info` query: " + BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: " "expecting element of stream list to be a map: " "component-class-name=%s, actual-type=%s", bt_component_class_get_name(comp_cls), @@ -2174,7 +2174,7 @@ int set_stream_intersections(struct cmd_run_ctx *ctx, port_name = bt_value_map_borrow_entry_value_const(stream_info, "port-name"); if (!port_name) { ret = -1; - BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-info` query: " + BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: " "missing `port-name` key in stream info map: " "component-class-name=%s", bt_component_class_get_name(comp_cls)); @@ -2183,7 +2183,7 @@ int set_stream_intersections(struct cmd_run_ctx *ctx, if (!bt_value_is_string(port_name)) { ret = -1; - BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-info` query: " + BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: " "expecting `port-name` entry of stream info map to be a string: " "component-class-name=%s, actual-type=%s", bt_component_class_get_name(comp_cls), diff --git a/src/plugins/ctf/fs-src/fs.c b/src/plugins/ctf/fs-src/fs.c index 65d62f96..9fa1792e 100644 --- a/src/plugins/ctf/fs-src/fs.c +++ b/src/plugins/ctf/fs-src/fs.c @@ -2361,8 +2361,8 @@ bt_component_class_query_method_status ctf_fs_query( if (strcmp(object, "metadata-info") == 0) { status = metadata_info_query(comp_class, params, log_level, result); - } else if (strcmp(object, "babeltrace.trace-info") == 0) { - status = trace_info_query(comp_class, params, log_level, + } else if (strcmp(object, "babeltrace.trace-infos") == 0) { + status = trace_infos_query(comp_class, params, log_level, result); } else if (!strcmp(object, "babeltrace.support-info")) { status = support_info_query(comp_class, params, log_level, result); diff --git a/src/plugins/ctf/fs-src/query.c b/src/plugins/ctf/fs-src/query.c index cc58872c..82e9c90e 100644 --- a/src/plugins/ctf/fs-src/query.c +++ b/src/plugins/ctf/fs-src/query.c @@ -294,7 +294,7 @@ int populate_trace_info(const struct ctf_fs_trace *trace, bt_value *trace_info) } insert_status = bt_value_map_insert_empty_array_entry(trace_info, - "streams", &file_groups); + "stream-infos", &file_groups); if (insert_status != BT_VALUE_MAP_INSERT_ENTRY_STATUS_OK) { ret = -1; goto end; @@ -326,7 +326,7 @@ end: } BT_HIDDEN -bt_component_class_query_method_status trace_info_query( +bt_component_class_query_method_status trace_infos_query( bt_self_component_class_source *self_comp_class_src, const bt_value *params, bt_logging_level log_level, const bt_value **user_result) diff --git a/src/plugins/ctf/fs-src/query.h b/src/plugins/ctf/fs-src/query.h index 527474fa..66356076 100644 --- a/src/plugins/ctf/fs-src/query.h +++ b/src/plugins/ctf/fs-src/query.h @@ -35,7 +35,7 @@ bt_component_class_query_method_status metadata_info_query( bt_logging_level log_level, const bt_value **result); BT_HIDDEN -bt_component_class_query_method_status trace_info_query( +bt_component_class_query_method_status trace_infos_query( bt_self_component_class_source *comp_class, const bt_value *params, bt_logging_level log_level, const bt_value **result); diff --git a/tests/bindings/python/bt2/test_trace_collection_message_iterator.py b/tests/bindings/python/bt2/test_trace_collection_message_iterator.py index 065b46e9..7181a1e5 100644 --- a/tests/bindings/python/bt2/test_trace_collection_message_iterator.py +++ b/tests/bindings/python/bt2/test_trace_collection_message_iterator.py @@ -298,7 +298,7 @@ class TraceCollectionMessageIteratorTestCase(unittest.TestCase): def test_iter_intersection_params(self): # Check that all params used to create the source component are passed - # to the `babeltrace.trace-info` query. + # to the `babeltrace.trace-infos` query. specs = [ bt2.ComponentSpec.from_named_plugin_and_component_class( 'ctf', diff --git a/tests/plugins/src.ctf.fs/query/test_query_trace_info.py b/tests/plugins/src.ctf.fs/query/test_query_trace_info.py index 52ce764c..41b2b831 100644 --- a/tests/plugins/src.ctf.fs/query/test_query_trace_info.py +++ b/tests/plugins/src.ctf.fs/query/test_query_trace_info.py @@ -39,20 +39,20 @@ class QueryTraceInfoClockOffsetTestCase(unittest.TestCase): ] def _check(self, trace, offset): - streams = sorted(trace['streams'], key=sort_predictably) + streams = sorted(trace['stream-infos'], key=sort_predictably) self.assertEqual(streams[0]['range-ns']['begin'], 13515309000000000 + offset) self.assertEqual(streams[0]['range-ns']['end'], 13515309000000100 + offset) self.assertEqual(streams[1]['range-ns']['begin'], 13515309000000070 + offset) self.assertEqual(streams[1]['range-ns']['end'], 13515309000000120 + offset) # Test various cominations of the clock-class-offset-s and - # clock-class-offset-ns parameters to babeltrace.trace-info queries. + # clock-class-offset-ns parameters to babeltrace.trace-infos queries. # Without clock class offset def test_no_clock_class_offset(self): res = bt2.QueryExecutor( - self._fs, 'babeltrace.trace-info', {'inputs': self._inputs} + self._fs, 'babeltrace.trace-infos', {'inputs': self._inputs} ).query() trace = res[0] self._check(trace, 0) @@ -62,7 +62,7 @@ class QueryTraceInfoClockOffsetTestCase(unittest.TestCase): def test_clock_class_offset_s(self): res = bt2.QueryExecutor( self._fs, - 'babeltrace.trace-info', + 'babeltrace.trace-infos', {'inputs': self._inputs, 'clock-class-offset-s': 2}, ).query() trace = res[0] @@ -73,7 +73,7 @@ class QueryTraceInfoClockOffsetTestCase(unittest.TestCase): def test_clock_class_offset_ns(self): res = bt2.QueryExecutor( self._fs, - 'babeltrace.trace-info', + 'babeltrace.trace-infos', {'inputs': self._inputs, 'clock-class-offset-ns': 2}, ).query() trace = res[0] @@ -84,7 +84,7 @@ class QueryTraceInfoClockOffsetTestCase(unittest.TestCase): def test_clock_class_offset_both(self): res = bt2.QueryExecutor( self._fs, - 'babeltrace.trace-info', + 'babeltrace.trace-infos', { 'inputs': self._inputs, 'clock-class-offset-s': -2, @@ -98,7 +98,7 @@ class QueryTraceInfoClockOffsetTestCase(unittest.TestCase): with self.assertRaises(bt2._Error): bt2.QueryExecutor( self._fs, - 'babeltrace.trace-info', + 'babeltrace.trace-infos', {'inputs': self._inputs, 'clock-class-offset-s': "2"}, ).query() @@ -106,7 +106,7 @@ class QueryTraceInfoClockOffsetTestCase(unittest.TestCase): with self.assertRaises(bt2._Error): bt2.QueryExecutor( self._fs, - 'babeltrace.trace-info', + 'babeltrace.trace-infos', {'inputs': self._inputs, 'clock-class-offset-s': None}, ).query() @@ -114,7 +114,7 @@ class QueryTraceInfoClockOffsetTestCase(unittest.TestCase): with self.assertRaises(bt2._Error): bt2.QueryExecutor( self._fs, - 'babeltrace.trace-info', + 'babeltrace.trace-infos', {'inputs': self._inputs, 'clock-class-offset-ns': "2"}, ).query() @@ -122,7 +122,7 @@ class QueryTraceInfoClockOffsetTestCase(unittest.TestCase): with self.assertRaises(bt2._Error): bt2.QueryExecutor( self._fs, - 'babeltrace.trace-info', + 'babeltrace.trace-infos', {'inputs': self._inputs, 'clock-class-offset-ns': None}, ).query() @@ -135,7 +135,7 @@ class QueryTraceInfoPortNameTestCase(unittest.TestCase): def test_trace_uuid_stream_class_id_no_stream_id(self): res = bt2.QueryExecutor( self._fs, - "babeltrace.trace-info", + "babeltrace.trace-infos", { "inputs": [ os.path.join( @@ -153,7 +153,7 @@ class QueryTraceInfoPortNameTestCase(unittest.TestCase): self.assertEqual(len(res), 1) trace = res[0] - streams = sorted(trace["streams"], key=sort_predictably) + streams = sorted(trace["stream-infos"], key=sort_predictably) self.assertEqual(len(streams), 2) self.assertRegexpMatches( str(streams[0]["port-name"]), @@ -171,7 +171,7 @@ class QueryTraceInfoPortNameTestCase(unittest.TestCase): def test_trace_uuid_no_stream_class_id_no_stream_id(self): res = bt2.QueryExecutor( self._fs, - "babeltrace.trace-info", + "babeltrace.trace-infos", {"inputs": [os.path.join(test_ctf_traces_path, "succeed", "succeed1")]}, ).query() @@ -183,7 +183,7 @@ class QueryTraceInfoPortNameTestCase(unittest.TestCase): self.assertEqual(len(res), 1) trace = res[0] - streams = sorted(trace["streams"], key=sort_predictably) + streams = sorted(trace["stream-infos"], key=sort_predictably) self.assertEqual(len(streams), 1) self.assertRegexpMatches( str(streams[0]["port-name"]), @@ -200,19 +200,19 @@ class QueryTraceInfoRangeTestCase(unittest.TestCase): def test_trace_no_range(self): # This trace has no `timestamp_begin` and `timestamp_end` in its - # packet context. The `babeltrace.trace-info` query should omit + # packet context. The `babeltrace.trace-infos` query should omit # the `range-ns` fields in the `trace` and `stream` data # structures. res = bt2.QueryExecutor( self._fs, - "babeltrace.trace-info", + "babeltrace.trace-infos", {"inputs": [os.path.join(test_ctf_traces_path, "succeed", "succeed1")]}, ).query() self.assertEqual(len(res), 1) trace = res[0] - streams = trace["streams"] + streams = trace["stream-infos"] self.assertEqual(len(streams), 1) self.assertRaises(KeyError, lambda: trace['range-ns']) @@ -228,7 +228,7 @@ class QueryTraceInfoPacketTimestampQuirksTestCase(unittest.TestCase): def _test_lttng_quirks(self, trace_name): res = bt2.QueryExecutor( self._fs, - "babeltrace.trace-info", + "babeltrace.trace-infos", {"inputs": [os.path.join(self._path, trace_name)]}, ).query() @@ -237,7 +237,7 @@ class QueryTraceInfoPacketTimestampQuirksTestCase(unittest.TestCase): def test_event_after_packet(self): trace = self._test_lttng_quirks("lttng-event-after-packet") - streams = trace["streams"] + streams = trace["stream-infos"] self.assertEqual(len(streams), 1) self.assertEqual(streams[0]['range-ns']['begin'], 1565957300948091100) @@ -245,7 +245,7 @@ class QueryTraceInfoPacketTimestampQuirksTestCase(unittest.TestCase): def test_lttng_crash(self): trace = self._test_lttng_quirks("lttng-crash") - streams = trace["streams"] + streams = trace["stream-infos"] self.assertEqual(len(streams), 1) self.assertEqual(streams[0]['range-ns']['begin'], 1565891729288866738)