2 * Copyright 2017 Philippe Proulx <pproulx@efficios.com>
4 * Permission is hereby granted, free of charge, to any person obtaining a copy
5 * of this software and associated documentation files (the "Software"), to deal
6 * in the Software without restriction, including without limitation the rights
7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8 * copies of the Software, and to permit persons to whom the Software is
9 * furnished to do so, subject to the following conditions:
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
24 #include <babeltrace/values.h>
25 #include <babeltrace/private-values.h>
26 #include <babeltrace/common-internal.h>
27 #include "babeltrace-cfg.h"
28 #include "babeltrace-cfg-cli-args-connect.h"
30 static bool all_named_and_printable_in_array(GPtrArray
*comps
)
33 bool all_named_and_printable
= true;
35 for (i
= 0; i
< comps
->len
; i
++) {
36 struct bt_config_component
*comp
= g_ptr_array_index(comps
, i
);
38 if (comp
->instance_name
->len
== 0) {
39 all_named_and_printable
= false;
43 if (!bt_common_string_is_printable(comp
->instance_name
->str
)) {
44 all_named_and_printable
= false;
50 return all_named_and_printable
;
53 static bool all_named_and_printable(struct bt_config
*cfg
)
55 return all_named_and_printable_in_array(cfg
->cmd_data
.run
.sources
) &&
56 all_named_and_printable_in_array(cfg
->cmd_data
.run
.filters
) &&
57 all_named_and_printable_in_array(cfg
->cmd_data
.run
.sinks
);
60 static struct bt_config_connection
*bt_config_connection_create(const char *arg
)
62 struct bt_config_connection
*cfg_connection
;
64 cfg_connection
= g_new0(struct bt_config_connection
, 1);
65 if (!cfg_connection
) {
69 cfg_connection
->upstream_comp_name
= g_string_new(NULL
);
70 if (!cfg_connection
->upstream_comp_name
) {
74 cfg_connection
->downstream_comp_name
= g_string_new(NULL
);
75 if (!cfg_connection
->downstream_comp_name
) {
79 cfg_connection
->upstream_port_glob
= g_string_new("*");
80 if (!cfg_connection
->upstream_port_glob
) {
84 cfg_connection
->downstream_port_glob
= g_string_new("*");
85 if (!cfg_connection
->downstream_port_glob
) {
89 cfg_connection
->arg
= g_string_new(arg
);
90 if (!cfg_connection
->arg
) {
97 g_free(cfg_connection
);
98 cfg_connection
= NULL
;
101 return cfg_connection
;
104 static bool validate_port_glob(const char *port_glob
)
106 bool is_valid
= true;
107 const char *ch
= port_glob
;
109 BT_ASSERT(port_glob
);
111 while (*ch
!= '\0') {
124 * This is reserved for future use, to support
125 * full globbing patterns. Those characters must
126 * be escaped with `\`.
140 static int normalize_glob_pattern(GString
*glob_pattern_gs
)
143 char *glob_pattern
= strdup(glob_pattern_gs
->str
);
150 bt_common_normalize_star_glob_pattern(glob_pattern
);
151 g_string_assign(glob_pattern_gs
, glob_pattern
);
158 static struct bt_config_connection
*cfg_connection_from_arg(const char *arg
)
160 const char *at
= arg
;
162 struct bt_config_connection
*cfg_conn
= NULL
;
168 DOWNSTREAM_PORT_GLOB
,
169 } state
= UPSTREAM_NAME
;
171 if (!bt_common_string_is_printable(arg
)) {
175 cfg_conn
= bt_config_connection_create(arg
);
183 gs
= bt_common_string_until(at
, ".:\\", ".:", &end_pos
);
184 if (!gs
|| gs
->len
== 0) {
188 g_string_free(cfg_conn
->upstream_comp_name
, TRUE
);
189 cfg_conn
->upstream_comp_name
= gs
;
192 if (at
[end_pos
] == ':') {
193 state
= DOWNSTREAM_NAME
;
194 } else if (at
[end_pos
] == '.') {
195 state
= UPSTREAM_PORT_GLOB
;
202 case DOWNSTREAM_NAME
:
203 gs
= bt_common_string_until(at
, ".:\\", ".:", &end_pos
);
204 if (!gs
|| gs
->len
== 0) {
208 g_string_free(cfg_conn
->downstream_comp_name
, TRUE
);
209 cfg_conn
->downstream_comp_name
= gs
;
212 if (at
[end_pos
] == '.') {
213 state
= DOWNSTREAM_PORT_GLOB
;
214 } else if (at
[end_pos
] == '\0') {
222 case UPSTREAM_PORT_GLOB
:
223 gs
= bt_common_string_until(at
, ".:", ".:", &end_pos
);
224 if (!gs
|| gs
->len
== 0) {
228 if (!validate_port_glob(gs
->str
)) {
232 if (normalize_glob_pattern(gs
)) {
236 g_string_free(cfg_conn
->upstream_port_glob
, TRUE
);
237 cfg_conn
->upstream_port_glob
= gs
;
240 if (at
[end_pos
] == ':') {
241 state
= DOWNSTREAM_NAME
;
248 case DOWNSTREAM_PORT_GLOB
:
249 gs
= bt_common_string_until(at
, ".:", ".:", &end_pos
);
250 if (!gs
|| gs
->len
== 0) {
254 if (!validate_port_glob(gs
->str
)) {
258 if (normalize_glob_pattern(gs
)) {
262 g_string_free(cfg_conn
->downstream_port_glob
, TRUE
);
263 cfg_conn
->downstream_port_glob
= gs
;
266 if (at
[end_pos
] == '\0') {
278 bt_config_connection_destroy(cfg_conn
);
283 g_string_free(gs
, TRUE
);
289 static struct bt_config_component
*find_component_in_array(GPtrArray
*comps
,
293 struct bt_config_component
*found_comp
= NULL
;
295 for (i
= 0; i
< comps
->len
; i
++) {
296 struct bt_config_component
*comp
= g_ptr_array_index(comps
, i
);
298 if (strcmp(name
, comp
->instance_name
->str
) == 0) {
300 bt_object_get_ref(found_comp
);
309 static struct bt_config_component
*find_component(struct bt_config
*cfg
,
312 struct bt_config_component
*comp
;
314 comp
= find_component_in_array(cfg
->cmd_data
.run
.sources
, name
);
319 comp
= find_component_in_array(cfg
->cmd_data
.run
.filters
, name
);
324 comp
= find_component_in_array(cfg
->cmd_data
.run
.sinks
, name
);
333 static int validate_all_endpoints_exist(struct bt_config
*cfg
, char *error_buf
,
334 size_t error_buf_size
)
339 for (i
= 0; i
< cfg
->cmd_data
.run
.connections
->len
; i
++) {
340 struct bt_config_connection
*connection
=
341 g_ptr_array_index(cfg
->cmd_data
.run
.connections
, i
);
342 struct bt_config_component
*comp
;
344 comp
= find_component(cfg
, connection
->upstream_comp_name
->str
);
345 bt_object_put_ref(comp
);
347 snprintf(error_buf
, error_buf_size
,
348 "Invalid connection: cannot find upstream component `%s`:\n %s\n",
349 connection
->upstream_comp_name
->str
,
350 connection
->arg
->str
);
355 comp
= find_component(cfg
, connection
->downstream_comp_name
->str
);
356 bt_object_put_ref(comp
);
358 snprintf(error_buf
, error_buf_size
,
359 "Invalid connection: cannot find downstream component `%s`:\n %s\n",
360 connection
->downstream_comp_name
->str
,
361 connection
->arg
->str
);
371 static int validate_connection_directions(struct bt_config
*cfg
,
372 char *error_buf
, size_t error_buf_size
)
376 struct bt_config_component
*src_comp
= NULL
;
377 struct bt_config_component
*dst_comp
= NULL
;
379 for (i
= 0; i
< cfg
->cmd_data
.run
.connections
->len
; i
++) {
380 struct bt_config_connection
*connection
=
381 g_ptr_array_index(cfg
->cmd_data
.run
.connections
, i
);
383 src_comp
= find_component(cfg
,
384 connection
->upstream_comp_name
->str
);
386 dst_comp
= find_component(cfg
,
387 connection
->downstream_comp_name
->str
);
390 if (src_comp
->type
== BT_COMPONENT_CLASS_TYPE_SOURCE
) {
391 if (dst_comp
->type
!= BT_COMPONENT_CLASS_TYPE_FILTER
&&
392 dst_comp
->type
!= BT_COMPONENT_CLASS_TYPE_SINK
) {
393 snprintf(error_buf
, error_buf_size
,
394 "Invalid connection: source component `%s` not connected to filter or sink component:\n %s\n",
395 connection
->upstream_comp_name
->str
,
396 connection
->arg
->str
);
400 } else if (src_comp
->type
== BT_COMPONENT_CLASS_TYPE_FILTER
) {
401 if (dst_comp
->type
!= BT_COMPONENT_CLASS_TYPE_FILTER
&&
402 dst_comp
->type
!= BT_COMPONENT_CLASS_TYPE_SINK
) {
403 snprintf(error_buf
, error_buf_size
,
404 "Invalid connection: filter component `%s` not connected to filter or sink component:\n %s\n",
405 connection
->upstream_comp_name
->str
,
406 connection
->arg
->str
);
411 snprintf(error_buf
, error_buf_size
,
412 "Invalid connection: cannot connect sink component `%s` to component `%s`:\n %s\n",
413 connection
->upstream_comp_name
->str
,
414 connection
->downstream_comp_name
->str
,
415 connection
->arg
->str
);
420 BT_OBJECT_PUT_REF_AND_RESET(src_comp
);
421 BT_OBJECT_PUT_REF_AND_RESET(dst_comp
);
425 bt_object_put_ref(src_comp
);
426 bt_object_put_ref(dst_comp
);
430 static int validate_no_cycles_rec(struct bt_config
*cfg
, GPtrArray
*path
,
431 char *error_buf
, size_t error_buf_size
)
435 const char *src_comp_name
;
437 BT_ASSERT(path
&& path
->len
> 0);
438 src_comp_name
= g_ptr_array_index(path
, path
->len
- 1);
440 for (conn_i
= 0; conn_i
< cfg
->cmd_data
.run
.connections
->len
; conn_i
++) {
441 struct bt_config_connection
*conn
=
442 g_ptr_array_index(cfg
->cmd_data
.run
.connections
, conn_i
);
444 if (strcmp(conn
->upstream_comp_name
->str
, src_comp_name
) == 0) {
447 for (path_i
= 0; path_i
< path
->len
; path_i
++) {
448 const char *comp_name
=
449 g_ptr_array_index(path
, path_i
);
451 if (strcmp(comp_name
, conn
->downstream_comp_name
->str
) == 0) {
452 snprintf(error_buf
, error_buf_size
,
453 "Invalid connection: connection forms a cycle:\n %s\n",
460 g_ptr_array_add(path
, conn
->downstream_comp_name
->str
);
461 ret
= validate_no_cycles_rec(cfg
, path
, error_buf
,
467 g_ptr_array_remove_index(path
, path
->len
- 1);
475 static int validate_no_cycles(struct bt_config
*cfg
, char *error_buf
,
476 size_t error_buf_size
)
482 path
= g_ptr_array_new();
488 g_ptr_array_add(path
, NULL
);
490 for (i
= 0; i
< cfg
->cmd_data
.run
.connections
->len
; i
++) {
491 struct bt_config_connection
*conn
=
492 g_ptr_array_index(cfg
->cmd_data
.run
.connections
, i
);
494 g_ptr_array_index(path
, 0) = conn
->upstream_comp_name
->str
;
495 ret
= validate_no_cycles_rec(cfg
, path
,
496 error_buf
, error_buf_size
);
504 g_ptr_array_free(path
, TRUE
);
510 static int validate_all_components_connected_in_array(GPtrArray
*comps
,
511 struct bt_value
*connected_components
,
512 char *error_buf
, size_t error_buf_size
)
517 for (i
= 0; i
< comps
->len
; i
++) {
518 struct bt_config_component
*comp
= g_ptr_array_index(comps
, i
);
520 if (!bt_value_map_has_entry(connected_components
,
521 comp
->instance_name
->str
)) {
522 snprintf(error_buf
, error_buf_size
,
523 "Component `%s` is not connected\n",
524 comp
->instance_name
->str
);
534 static int validate_all_components_connected(struct bt_config
*cfg
,
535 char *error_buf
, size_t error_buf_size
)
539 struct bt_private_value
*connected_components
=
540 bt_private_value_map_create();
542 if (!connected_components
) {
547 for (i
= 0; i
< cfg
->cmd_data
.run
.connections
->len
; i
++) {
548 struct bt_config_connection
*connection
=
549 g_ptr_array_index(cfg
->cmd_data
.run
.connections
, i
);
551 ret
= bt_private_value_map_insert_entry(connected_components
,
552 connection
->upstream_comp_name
->str
, bt_value_null
);
557 ret
= bt_private_value_map_insert_entry(connected_components
,
558 connection
->downstream_comp_name
->str
, bt_value_null
);
564 ret
= validate_all_components_connected_in_array(
565 cfg
->cmd_data
.run
.sources
,
566 bt_private_value_as_value(connected_components
),
567 error_buf
, error_buf_size
);
572 ret
= validate_all_components_connected_in_array(
573 cfg
->cmd_data
.run
.filters
,
574 bt_private_value_as_value(connected_components
),
575 error_buf
, error_buf_size
);
580 ret
= validate_all_components_connected_in_array(
581 cfg
->cmd_data
.run
.sinks
,
582 bt_private_value_as_value(connected_components
),
583 error_buf
, error_buf_size
);
589 bt_object_put_ref(connected_components
);
593 static int validate_no_duplicate_connection(struct bt_config
*cfg
,
594 char *error_buf
, size_t error_buf_size
)
598 struct bt_private_value
*flat_connection_names
=
599 bt_private_value_map_create();
600 GString
*flat_connection_name
= NULL
;
602 if (!flat_connection_names
) {
607 flat_connection_name
= g_string_new(NULL
);
608 if (!flat_connection_name
) {
613 for (i
= 0; i
< cfg
->cmd_data
.run
.connections
->len
; i
++) {
614 struct bt_config_connection
*connection
=
615 g_ptr_array_index(cfg
->cmd_data
.run
.connections
, i
);
617 g_string_printf(flat_connection_name
, "%s\x01%s\x01%s\x01%s",
618 connection
->upstream_comp_name
->str
,
619 connection
->upstream_port_glob
->str
,
620 connection
->downstream_comp_name
->str
,
621 connection
->downstream_port_glob
->str
);
623 if (bt_value_map_has_entry(bt_private_value_as_value(
624 flat_connection_names
),
625 flat_connection_name
->str
)) {
626 snprintf(error_buf
, error_buf_size
,
627 "Duplicate connection:\n %s\n",
628 connection
->arg
->str
);
633 ret
= bt_private_value_map_insert_entry(flat_connection_names
,
634 flat_connection_name
->str
, bt_value_null
);
641 bt_object_put_ref(flat_connection_names
);
643 if (flat_connection_name
) {
644 g_string_free(flat_connection_name
, TRUE
);
650 static int validate_connections(struct bt_config
*cfg
, char *error_buf
,
651 size_t error_buf_size
)
655 ret
= validate_all_endpoints_exist(cfg
, error_buf
, error_buf_size
);
660 ret
= validate_connection_directions(cfg
, error_buf
, error_buf_size
);
665 ret
= validate_all_components_connected(cfg
, error_buf
, error_buf_size
);
670 ret
= validate_no_duplicate_connection(cfg
, error_buf
, error_buf_size
);
675 ret
= validate_no_cycles(cfg
, error_buf
, error_buf_size
);
684 int bt_config_cli_args_create_connections(struct bt_config
*cfg
,
685 struct bt_value
*connection_args
,
686 char *error_buf
, size_t error_buf_size
)
691 if (!all_named_and_printable(cfg
)) {
692 snprintf(error_buf
, error_buf_size
,
693 "One or more components are unnamed (use --name) or contain a non-printable character\n");
697 for (i
= 0; i
< bt_value_array_get_size(connection_args
); i
++) {
698 struct bt_value
*arg_value
=
699 bt_value_array_borrow_element_by_index(
702 struct bt_config_connection
*cfg_connection
;
704 arg
= bt_value_string_get(arg_value
);
705 cfg_connection
= cfg_connection_from_arg(arg
);
706 if (!cfg_connection
) {
707 snprintf(error_buf
, error_buf_size
, "Cannot parse --connect option's argument:\n %s\n",
712 g_ptr_array_add(cfg
->cmd_data
.run
.connections
,
717 ret
= validate_connections(cfg
, error_buf
, error_buf_size
);