1 /* SPDX-License-Identifier: LGPL-2.1+ */
7 #include "alloc-util.h"
9 #include "bus-internal.h"
10 #include "bus-message.h"
11 #include "bus-signature.h"
14 #include "busctl-introspect.h"
18 #include "format-table.h"
20 #include "locale-util.h"
22 #include "main-func.h"
24 #include "parse-util.h"
25 #include "path-util.h"
26 #include "pretty-print.h"
28 #include "sort-util.h"
30 #include "terminal-util.h"
31 #include "user-util.h"
38 } arg_json
= JSON_OFF
;
39 static PagerFlags arg_pager_flags
= 0;
40 static bool arg_legend
= true;
41 static bool arg_full
= false;
42 static const char *arg_address
= NULL
;
43 static bool arg_unique
= false;
44 static bool arg_acquired
= false;
45 static bool arg_activatable
= false;
46 static bool arg_show_machine
= false;
47 static char **arg_matches
= NULL
;
48 static BusTransport arg_transport
= BUS_TRANSPORT_LOCAL
;
49 static const char *arg_host
= NULL
;
50 static bool arg_user
= false;
51 static size_t arg_snaplen
= 4096;
52 static bool arg_list
= false;
53 static bool arg_quiet
= false;
54 static bool arg_verbose
= false;
55 static bool arg_xml_interface
= false;
56 static bool arg_expect_reply
= true;
57 static bool arg_auto_start
= true;
58 static bool arg_allow_interactive_authorization
= true;
59 static bool arg_augment_creds
= true;
60 static bool arg_watch_bind
= false;
61 static usec_t arg_timeout
= 0;
62 static const char *arg_destination
= NULL
;
64 STATIC_DESTRUCTOR_REGISTER(arg_matches
, strv_freep
);
66 #define NAME_IS_ACQUIRED INT_TO_PTR(1)
67 #define NAME_IS_ACTIVATABLE INT_TO_PTR(2)
69 static int json_transform_message(sd_bus_message
*m
, JsonVariant
**ret
);
70 static void json_dump_with_flags(JsonVariant
*v
, FILE *f
);
72 static int acquire_bus(bool set_monitor
, sd_bus
**ret
) {
73 _cleanup_(sd_bus_close_unrefp
) sd_bus
*bus
= NULL
;
78 return log_error_errno(r
, "Failed to allocate bus: %m");
81 r
= sd_bus_set_monitor(bus
, true);
83 return log_error_errno(r
, "Failed to set monitor mode: %m");
85 r
= sd_bus_negotiate_creds(bus
, true, _SD_BUS_CREDS_ALL
);
87 return log_error_errno(r
, "Failed to enable credentials: %m");
89 r
= sd_bus_negotiate_timestamp(bus
, true);
91 return log_error_errno(r
, "Failed to enable timestamps: %m");
93 r
= sd_bus_negotiate_fds(bus
, true);
95 return log_error_errno(r
, "Failed to enable fds: %m");
98 r
= sd_bus_set_bus_client(bus
, true);
100 return log_error_errno(r
, "Failed to set bus client: %m");
102 r
= sd_bus_set_watch_bind(bus
, arg_watch_bind
);
104 return log_error_errno(r
, "Failed to set watch-bind setting to '%s': %m",
105 yes_no(arg_watch_bind
));
108 r
= sd_bus_set_address(bus
, arg_address
);
110 switch (arg_transport
) {
112 case BUS_TRANSPORT_LOCAL
:
114 r
= bus_set_address_user(bus
);
116 r
= bus_set_address_system(bus
);
119 case BUS_TRANSPORT_REMOTE
:
120 r
= bus_set_address_system_remote(bus
, arg_host
);
123 case BUS_TRANSPORT_MACHINE
:
124 r
= bus_set_address_system_machine(bus
, arg_host
);
128 assert_not_reached("Hmm, unknown transport type.");
132 return log_error_errno(r
, "Failed to set address: %m");
134 r
= sd_bus_start(bus
);
136 return log_error_errno(r
, "Failed to connect to bus: %m");
138 *ret
= TAKE_PTR(bus
);
143 static int list_bus_names(int argc
, char **argv
, void *userdata
) {
144 _cleanup_strv_free_
char **acquired
= NULL
, **activatable
= NULL
;
145 _cleanup_(sd_bus_flush_close_unrefp
) sd_bus
*bus
= NULL
;
146 _cleanup_hashmap_free_ Hashmap
*names
= NULL
;
147 _cleanup_(table_unrefp
) Table
*table
= NULL
;
166 if (!arg_unique
&& !arg_acquired
&& !arg_activatable
)
167 arg_unique
= arg_acquired
= arg_activatable
= true;
169 r
= acquire_bus(false, &bus
);
173 r
= sd_bus_list_names(bus
,
174 (arg_acquired
|| arg_unique
) ? &acquired
: NULL
,
175 arg_activatable
? &activatable
: NULL
);
177 return log_error_errno(r
, "Failed to list names: %m");
179 names
= hashmap_new(&string_hash_ops
);
183 STRV_FOREACH(i
, acquired
) {
184 r
= hashmap_put(names
, *i
, NAME_IS_ACQUIRED
);
186 return log_error_errno(r
, "Failed to add to hashmap: %m");
189 STRV_FOREACH(i
, activatable
) {
190 r
= hashmap_put(names
, *i
, NAME_IS_ACTIVATABLE
);
191 if (r
< 0 && r
!= -EEXIST
)
192 return log_error_errno(r
, "Failed to add to hashmap: %m");
195 table
= table_new("activatable",
209 table_set_width(table
, 0);
211 r
= table_set_align_percent(table
, table_get_cell(table
, 0, COLUMN_PID
), 100);
213 return log_error_errno(r
, "Failed to set alignment: %m");
215 r
= table_set_empty_string(table
, "-");
217 return log_error_errno(r
, "Failed to set empty string: %m");
219 r
= table_set_sort(table
, (size_t) COLUMN_NAME
, (size_t) -1);
221 return log_error_errno(r
, "Failed to set sort column: %m");
223 if (arg_show_machine
)
224 r
= table_set_display(table
, (size_t) COLUMN_NAME
,
226 (size_t) COLUMN_PROCESS
,
227 (size_t) COLUMN_USER
,
228 (size_t) COLUMN_CONNECTION
,
229 (size_t) COLUMN_UNIT
,
230 (size_t) COLUMN_SESSION
,
231 (size_t) COLUMN_DESCRIPTION
,
232 (size_t) COLUMN_MACHINE
,
235 r
= table_set_display(table
, (size_t) COLUMN_NAME
,
237 (size_t) COLUMN_PROCESS
,
238 (size_t) COLUMN_USER
,
239 (size_t) COLUMN_CONNECTION
,
240 (size_t) COLUMN_UNIT
,
241 (size_t) COLUMN_SESSION
,
242 (size_t) COLUMN_DESCRIPTION
,
246 return log_error_errno(r
, "Failed to set columns to display: %m");
248 table_set_header(table
, arg_legend
);
250 HASHMAP_FOREACH_KEY(v
, k
, names
, iterator
) {
251 _cleanup_(sd_bus_creds_unrefp
) sd_bus_creds
*creds
= NULL
;
253 if (v
== NAME_IS_ACTIVATABLE
) {
256 TABLE_INT
, PTR_TO_INT(v
),
261 TABLE_STRING
, "(activatable)", TABLE_SET_COLOR
, ansi_grey(),
267 return table_log_add_error(r
);
272 assert(v
== NAME_IS_ACQUIRED
);
274 if (!arg_unique
&& k
[0] == ':')
277 if (!arg_acquired
&& k
[0] != ':')
280 r
= table_add_many(table
,
281 TABLE_INT
, PTR_TO_INT(v
),
284 return table_log_add_error(r
);
286 r
= sd_bus_get_name_creds(
288 (arg_augment_creds
? SD_BUS_CREDS_AUGMENT
: 0) |
289 SD_BUS_CREDS_EUID
|SD_BUS_CREDS_PID
|SD_BUS_CREDS_COMM
|
290 SD_BUS_CREDS_UNIQUE_NAME
|SD_BUS_CREDS_UNIT
|SD_BUS_CREDS_SESSION
|
291 SD_BUS_CREDS_DESCRIPTION
, &creds
);
293 log_debug_errno(r
, "Failed to acquire credentials of service %s, ignoring: %m", k
);
295 r
= table_fill_empty(table
, COLUMN_MACHINE
);
297 const char *unique
= NULL
, *session
= NULL
, *unit
= NULL
, *cn
= NULL
;
301 r
= sd_bus_creds_get_pid(creds
, &pid
);
303 const char *comm
= NULL
;
305 (void) sd_bus_creds_get_comm(creds
, &comm
);
307 r
= table_add_many(table
,
309 TABLE_STRING
, strna(comm
));
311 r
= table_add_many(table
, TABLE_EMPTY
, TABLE_EMPTY
);
313 return table_log_add_error(r
);
315 r
= sd_bus_creds_get_euid(creds
, &uid
);
317 _cleanup_free_
char *u
= NULL
;
319 u
= uid_to_name(uid
);
323 r
= table_add_cell(table
, NULL
, TABLE_STRING
, u
);
325 r
= table_add_cell(table
, NULL
, TABLE_EMPTY
, NULL
);
327 return table_log_add_error(r
);
329 (void) sd_bus_creds_get_unique_name(creds
, &unique
);
330 (void) sd_bus_creds_get_unit(creds
, &unit
);
331 (void) sd_bus_creds_get_session(creds
, &session
);
332 (void) sd_bus_creds_get_description(creds
, &cn
);
336 TABLE_STRING
, unique
,
338 TABLE_STRING
, session
,
342 return table_log_add_error(r
);
344 if (arg_show_machine
) {
347 r
= sd_bus_get_name_machine_id(bus
, k
, &mid
);
349 log_debug_errno(r
, "Failed to acquire credentials of service %s, ignoring: %m", k
);
351 char m
[SD_ID128_STRING_MAX
];
353 r
= table_add_cell(table
, NULL
, TABLE_STRING
, sd_id128_to_string(mid
, m
));
355 return table_log_add_error(r
);
357 continue; /* line fully filled, no need to fill the remainder below */
361 r
= table_fill_empty(table
, 0);
363 return log_error_errno(r
, "Failed to fill line: %m");
366 (void) pager_open(arg_pager_flags
);
369 r
= table_print_json(table
, stdout
,
370 (arg_json
== JSON_PRETTY
? JSON_FORMAT_PRETTY
: JSON_FORMAT_NEWLINE
) | JSON_FORMAT_COLOR_AUTO
);
372 r
= table_print(table
, stdout
);
374 return table_log_print_error(r
);
379 static void print_subtree(const char *prefix
, const char *path
, char **l
) {
380 const char *vertical
, *space
;
383 /* We assume the list is sorted. Let's first skip over the
384 * entry we are looking at. */
389 if (!streq(*l
, path
))
395 vertical
= strjoina(prefix
, special_glyph(SPECIAL_GLYPH_TREE_VERTICAL
));
396 space
= strjoina(prefix
, special_glyph(SPECIAL_GLYPH_TREE_SPACE
));
399 bool has_more
= false;
401 if (!*l
|| !path_startswith(*l
, path
))
406 if (!*n
|| !path_startswith(*n
, path
))
409 if (!path_startswith(*n
, *l
)) {
419 special_glyph(has_more
? SPECIAL_GLYPH_TREE_BRANCH
: SPECIAL_GLYPH_TREE_RIGHT
),
422 print_subtree(has_more
? vertical
: space
, *l
, l
);
427 static void print_tree(char **l
) {
430 else if (strv_isempty(l
))
431 printf("No objects discovered.\n");
432 else if (streq(l
[0], "/") && !l
[1])
433 printf("Only root object discovered.\n");
435 print_subtree("", "/", l
);
438 static int on_path(const char *path
, void *userdata
) {
439 Set
*paths
= userdata
;
444 r
= set_put_strdup(&paths
, path
);
451 static int find_nodes(sd_bus
*bus
, const char *service
, const char *path
, Set
*paths
) {
452 static const XMLIntrospectOps ops
= {
456 _cleanup_(sd_bus_message_unrefp
) sd_bus_message
*reply
= NULL
;
457 _cleanup_(sd_bus_error_free
) sd_bus_error error
= SD_BUS_ERROR_NULL
;
461 r
= sd_bus_call_method(bus
, service
, path
,
462 "org.freedesktop.DBus.Introspectable", "Introspect",
465 printf("%sFailed to introspect object %s of service %s: %s%s\n",
466 ansi_highlight_red(),
467 path
, service
, bus_error_message(&error
, r
),
472 r
= sd_bus_message_read(reply
, "s", &xml
);
474 return bus_log_parse_error(r
);
476 return parse_xml_introspect(path
, xml
, &ops
, paths
);
479 static int tree_one(sd_bus
*bus
, const char *service
) {
480 _cleanup_set_free_ Set
*paths
= NULL
, *done
= NULL
, *failed
= NULL
;
481 _cleanup_free_
char **l
= NULL
;
484 r
= set_put_strdup(&paths
, "/");
488 done
= set_new(&string_hash_ops_free
);
492 failed
= set_new(&string_hash_ops_free
);
497 _cleanup_free_
char *p
= NULL
;
500 p
= set_steal_first(paths
);
504 if (set_contains(done
, p
) ||
505 set_contains(failed
, p
))
508 q
= find_nodes(bus
, service
, p
, paths
);
512 q
= set_consume(q
< 0 ? failed
: done
, TAKE_PTR(p
));
518 (void) pager_open(arg_pager_flags
);
520 l
= set_get_strv(done
);
532 static int tree(int argc
, char **argv
, void *userdata
) {
533 _cleanup_(sd_bus_flush_close_unrefp
) sd_bus
*bus
= NULL
;
537 /* Do superficial verification of arguments before even opening the bus */
538 STRV_FOREACH(i
, strv_skip(argv
, 1))
539 if (!sd_bus_service_name_is_valid(*i
))
540 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
541 "Invalid bus service name: %s", *i
);
543 if (!arg_unique
&& !arg_acquired
)
546 r
= acquire_bus(false, &bus
);
551 _cleanup_strv_free_
char **names
= NULL
;
552 bool not_first
= false;
554 r
= sd_bus_list_names(bus
, &names
, NULL
);
556 return log_error_errno(r
, "Failed to get name list: %m");
558 (void) pager_open(arg_pager_flags
);
560 STRV_FOREACH(i
, names
) {
563 if (!arg_unique
&& (*i
)[0] == ':')
566 if (!arg_acquired
&& (*i
)[0] == ':')
572 printf("Service %s%s%s:\n", ansi_highlight(), *i
, ansi_normal());
574 q
= tree_one(bus
, *i
);
581 STRV_FOREACH(i
, strv_skip(argv
, 1)) {
588 (void) pager_open(arg_pager_flags
);
589 printf("Service %s%s%s:\n", ansi_highlight(), *i
, ansi_normal());
592 q
= tree_one(bus
, *i
);
600 static int format_cmdline(sd_bus_message
*m
, FILE *f
, bool needs_space
) {
604 const char *contents
= NULL
;
619 r
= sd_bus_message_peek_type(m
, &type
, &contents
);
625 if (bus_type_is_container(type
) > 0) {
627 r
= sd_bus_message_enter_container(m
, type
, contents
);
631 if (type
== SD_BUS_TYPE_ARRAY
) {
634 /* count array entries */
637 r
= sd_bus_message_skip(m
, contents
);
646 r
= sd_bus_message_rewind(m
, false);
656 } else if (type
== SD_BUS_TYPE_VARIANT
) {
661 fprintf(f
, "%s", contents
);
665 r
= format_cmdline(m
, f
, needs_space
);
671 r
= sd_bus_message_exit_container(m
);
678 r
= sd_bus_message_read_basic(m
, type
, &basic
);
686 case SD_BUS_TYPE_BYTE
:
687 fprintf(f
, "%u", basic
.u8
);
690 case SD_BUS_TYPE_BOOLEAN
:
691 fputs(true_false(basic
.i
), f
);
694 case SD_BUS_TYPE_INT16
:
695 fprintf(f
, "%i", basic
.s16
);
698 case SD_BUS_TYPE_UINT16
:
699 fprintf(f
, "%u", basic
.u16
);
702 case SD_BUS_TYPE_INT32
:
703 fprintf(f
, "%i", basic
.s32
);
706 case SD_BUS_TYPE_UINT32
:
707 fprintf(f
, "%u", basic
.u32
);
710 case SD_BUS_TYPE_INT64
:
711 fprintf(f
, "%" PRIi64
, basic
.s64
);
714 case SD_BUS_TYPE_UINT64
:
715 fprintf(f
, "%" PRIu64
, basic
.u64
);
718 case SD_BUS_TYPE_DOUBLE
:
719 fprintf(f
, "%g", basic
.d64
);
722 case SD_BUS_TYPE_STRING
:
723 case SD_BUS_TYPE_OBJECT_PATH
:
724 case SD_BUS_TYPE_SIGNATURE
: {
725 _cleanup_free_
char *b
= NULL
;
727 b
= cescape(basic
.string
);
731 fprintf(f
, "\"%s\"", b
);
735 case SD_BUS_TYPE_UNIX_FD
:
736 fprintf(f
, "%i", basic
.i
);
740 assert_not_reached("Unknown basic type.");
747 typedef struct Member
{
758 static void member_hash_func(const Member
*m
, struct siphash
*state
) {
764 string_hash_func(m
->type
, state
);
766 arity
+= !!m
->name
+ !!m
->interface
;
768 uint64_hash_func(&arity
, state
);
771 string_hash_func(m
->name
, state
);
774 string_hash_func(m
->interface
, state
);
777 static int member_compare_func(const Member
*x
, const Member
*y
) {
785 d
= strcmp_ptr(x
->interface
, y
->interface
);
789 d
= strcmp(x
->type
, y
->type
);
793 return strcmp_ptr(x
->name
, y
->name
);
796 static int member_compare_funcp(Member
* const *a
, Member
* const *b
) {
797 return member_compare_func(*a
, *b
);
800 static void member_free(Member
*m
) {
812 DEFINE_TRIVIAL_CLEANUP_FUNC(Member
*, member_free
);
814 static void member_set_free(Set
*s
) {
815 set_free_with_destructor(s
, member_free
);
818 DEFINE_TRIVIAL_CLEANUP_FUNC(Set
*, member_set_free
);
820 static int on_interface(const char *interface
, uint64_t flags
, void *userdata
) {
821 _cleanup_(member_freep
) Member
*m
;
822 Set
*members
= userdata
;
837 r
= free_and_strdup(&m
->interface
, interface
);
841 r
= set_put(members
, m
);
843 return log_error_errno(r
, "Invalid introspection data: duplicate interface '%s'.", interface
);
851 static int on_method(const char *interface
, const char *name
, const char *signature
, const char *result
, uint64_t flags
, void *userdata
) {
852 _cleanup_(member_freep
) Member
*m
;
853 Set
*members
= userdata
;
868 r
= free_and_strdup(&m
->interface
, interface
);
872 r
= free_and_strdup(&m
->name
, name
);
876 r
= free_and_strdup(&m
->signature
, signature
);
880 r
= free_and_strdup(&m
->result
, result
);
884 r
= set_put(members
, m
);
886 return log_error_errno(r
, "Invalid introspection data: duplicate method '%s' on interface '%s'.", name
, interface
);
894 static int on_signal(const char *interface
, const char *name
, const char *signature
, uint64_t flags
, void *userdata
) {
895 _cleanup_(member_freep
) Member
*m
;
896 Set
*members
= userdata
;
911 r
= free_and_strdup(&m
->interface
, interface
);
915 r
= free_and_strdup(&m
->name
, name
);
919 r
= free_and_strdup(&m
->signature
, signature
);
923 r
= set_put(members
, m
);
925 return log_error_errno(r
, "Invalid introspection data: duplicate signal '%s' on interface '%s'.", name
, interface
);
933 static int on_property(const char *interface
, const char *name
, const char *signature
, bool writable
, uint64_t flags
, void *userdata
) {
934 _cleanup_(member_freep
) Member
*m
;
935 Set
*members
= userdata
;
948 .writable
= writable
,
951 r
= free_and_strdup(&m
->interface
, interface
);
955 r
= free_and_strdup(&m
->name
, name
);
959 r
= free_and_strdup(&m
->signature
, signature
);
963 r
= set_put(members
, m
);
965 return log_error_errno(r
, "Invalid introspection data: duplicate property '%s' on interface '%s'.", name
, interface
);
973 DEFINE_PRIVATE_HASH_OPS(member_hash_ops
, Member
, member_hash_func
, member_compare_func
);
975 static int introspect(int argc
, char **argv
, void *userdata
) {
976 static const XMLIntrospectOps ops
= {
977 .on_interface
= on_interface
,
978 .on_method
= on_method
,
979 .on_signal
= on_signal
,
980 .on_property
= on_property
,
983 _cleanup_(sd_bus_flush_close_unrefp
) sd_bus
*bus
= NULL
;
984 _cleanup_(sd_bus_message_unrefp
) sd_bus_message
*reply_xml
= NULL
;
985 _cleanup_(sd_bus_error_free
) sd_bus_error error
= SD_BUS_ERROR_NULL
;
986 _cleanup_(member_set_freep
) Set
*members
= NULL
;
987 unsigned name_width
, type_width
, signature_width
, result_width
, j
, k
= 0;
988 Member
*m
, **sorted
= NULL
;
993 r
= acquire_bus(false, &bus
);
997 members
= set_new(&member_hash_ops
);
1001 r
= sd_bus_call_method(bus
, argv
[1], argv
[2],
1002 "org.freedesktop.DBus.Introspectable", "Introspect",
1003 &error
, &reply_xml
, "");
1005 return log_error_errno(r
, "Failed to introspect object %s of service %s: %s",
1006 argv
[2], argv
[1], bus_error_message(&error
, r
));
1008 r
= sd_bus_message_read(reply_xml
, "s", &xml
);
1010 return bus_log_parse_error(r
);
1012 if (arg_xml_interface
) {
1013 /* Just dump the received XML and finish */
1014 (void) pager_open(arg_pager_flags
);
1019 /* First, get list of all properties */
1020 r
= parse_xml_introspect(argv
[2], xml
, &ops
, members
);
1024 /* Second, find the current values for them */
1025 SET_FOREACH(m
, members
, i
) {
1026 _cleanup_(sd_bus_message_unrefp
) sd_bus_message
*reply
= NULL
;
1028 if (!streq(m
->type
, "property"))
1034 if (argv
[3] && !streq(argv
[3], m
->interface
))
1037 r
= sd_bus_call_method(bus
, argv
[1], argv
[2],
1038 "org.freedesktop.DBus.Properties", "GetAll",
1039 &error
, &reply
, "s", m
->interface
);
1041 return log_error_errno(r
, "Failed to get all properties on interface %s: %s",
1042 m
->interface
, bus_error_message(&error
, r
));
1044 r
= sd_bus_message_enter_container(reply
, 'a', "{sv}");
1046 return bus_log_parse_error(r
);
1050 _cleanup_free_
char *buf
= NULL
;
1051 _cleanup_fclose_
FILE *mf
= NULL
;
1055 r
= sd_bus_message_enter_container(reply
, 'e', "sv");
1057 return bus_log_parse_error(r
);
1062 r
= sd_bus_message_read(reply
, "s", &name
);
1064 return bus_log_parse_error(r
);
1066 r
= sd_bus_message_enter_container(reply
, 'v', NULL
);
1068 return bus_log_parse_error(r
);
1070 mf
= open_memstream_unlocked(&buf
, &sz
);
1074 r
= format_cmdline(reply
, mf
, false);
1076 return bus_log_parse_error(r
);
1078 mf
= safe_fclose(mf
);
1080 z
= set_get(members
, &((Member
) {
1082 .interface
= m
->interface
,
1083 .name
= (char*) name
}));
1085 free_and_replace(z
->value
, buf
);
1087 r
= sd_bus_message_exit_container(reply
);
1089 return bus_log_parse_error(r
);
1091 r
= sd_bus_message_exit_container(reply
);
1093 return bus_log_parse_error(r
);
1096 r
= sd_bus_message_exit_container(reply
);
1098 return bus_log_parse_error(r
);
1101 name_width
= strlen("NAME");
1102 type_width
= strlen("TYPE");
1103 signature_width
= strlen("SIGNATURE");
1104 result_width
= strlen("RESULT/VALUE");
1106 sorted
= newa(Member
*, set_size(members
));
1108 SET_FOREACH(m
, members
, i
) {
1109 if (argv
[3] && !streq(argv
[3], m
->interface
))
1113 name_width
= MAX(name_width
, strlen(m
->interface
));
1115 name_width
= MAX(name_width
, strlen(m
->name
) + 1);
1117 type_width
= MAX(type_width
, strlen(m
->type
));
1119 signature_width
= MAX(signature_width
, strlen(m
->signature
));
1121 result_width
= MAX(result_width
, strlen(m
->result
));
1123 result_width
= MAX(result_width
, strlen(m
->value
));
1128 if (result_width
> 40)
1131 typesafe_qsort(sorted
, k
, member_compare_funcp
);
1133 (void) pager_open(arg_pager_flags
);
1136 printf("%-*s %-*s %-*s %-*s %s\n",
1137 (int) name_width
, "NAME",
1138 (int) type_width
, "TYPE",
1139 (int) signature_width
, "SIGNATURE",
1140 (int) result_width
, "RESULT/VALUE",
1144 for (j
= 0; j
< k
; j
++) {
1145 _cleanup_free_
char *ellipsized
= NULL
;
1151 if (argv
[3] && !streq(argv
[3], m
->interface
))
1154 is_interface
= streq(m
->type
, "interface");
1156 if (argv
[3] && is_interface
)
1160 ellipsized
= ellipsize(m
->value
, result_width
, 100);
1166 rv
= empty_to_dash(m
->result
);
1168 printf("%s%s%-*s%s %-*s %-*s %-*s%s%s%s%s%s%s\n",
1169 is_interface
? ansi_highlight() : "",
1170 is_interface
? "" : ".",
1171 - !is_interface
+ (int) name_width
,
1172 empty_to_dash(streq_ptr(m
->type
, "interface") ? m
->interface
: m
->name
),
1173 is_interface
? ansi_normal() : "",
1174 (int) type_width
, empty_to_dash(m
->type
),
1175 (int) signature_width
, empty_to_dash(m
->signature
),
1176 (int) result_width
, rv
,
1177 (m
->flags
& SD_BUS_VTABLE_DEPRECATED
) ? " deprecated" : (m
->flags
|| m
->writable
? "" : " -"),
1178 (m
->flags
& SD_BUS_VTABLE_METHOD_NO_REPLY
) ? " no-reply" : "",
1179 (m
->flags
& SD_BUS_VTABLE_PROPERTY_CONST
) ? " const" : "",
1180 (m
->flags
& SD_BUS_VTABLE_PROPERTY_EMITS_CHANGE
) ? " emits-change" : "",
1181 (m
->flags
& SD_BUS_VTABLE_PROPERTY_EMITS_INVALIDATION
) ? " emits-invalidation" : "",
1182 m
->writable
? " writable" : "");
1188 static int message_dump(sd_bus_message
*m
, FILE *f
) {
1189 return sd_bus_message_dump(m
, f
, SD_BUS_MESSAGE_DUMP_WITH_HEADER
);
1192 static int message_pcap(sd_bus_message
*m
, FILE *f
) {
1193 return bus_message_pcap_frame(m
, arg_snaplen
, f
);
1196 static int message_json(sd_bus_message
*m
, FILE *f
) {
1197 _cleanup_(json_variant_unrefp
) JsonVariant
*v
= NULL
, *w
= NULL
;
1201 r
= json_transform_message(m
, &v
);
1205 e
[0] = m
->header
->endian
;
1208 r
= json_build(&w
, JSON_BUILD_OBJECT(
1209 JSON_BUILD_PAIR("type", JSON_BUILD_STRING(bus_message_type_to_string(m
->header
->type
))),
1210 JSON_BUILD_PAIR("endian", JSON_BUILD_STRING(e
)),
1211 JSON_BUILD_PAIR("flags", JSON_BUILD_INTEGER(m
->header
->flags
)),
1212 JSON_BUILD_PAIR("version", JSON_BUILD_INTEGER(m
->header
->version
)),
1213 JSON_BUILD_PAIR("cookie", JSON_BUILD_INTEGER(BUS_MESSAGE_COOKIE(m
))),
1214 JSON_BUILD_PAIR_CONDITION(m
->reply_cookie
!= 0, "reply_cookie", JSON_BUILD_INTEGER(m
->reply_cookie
)),
1215 JSON_BUILD_PAIR_CONDITION(m
->sender
, "sender", JSON_BUILD_STRING(m
->sender
)),
1216 JSON_BUILD_PAIR_CONDITION(m
->destination
, "destination", JSON_BUILD_STRING(m
->destination
)),
1217 JSON_BUILD_PAIR_CONDITION(m
->path
, "path", JSON_BUILD_STRING(m
->path
)),
1218 JSON_BUILD_PAIR_CONDITION(m
->interface
, "interface", JSON_BUILD_STRING(m
->interface
)),
1219 JSON_BUILD_PAIR_CONDITION(m
->member
, "member", JSON_BUILD_STRING(m
->member
)),
1220 JSON_BUILD_PAIR_CONDITION(m
->monotonic
!= 0, "monotonic", JSON_BUILD_INTEGER(m
->monotonic
)),
1221 JSON_BUILD_PAIR_CONDITION(m
->realtime
!= 0, "realtime", JSON_BUILD_INTEGER(m
->realtime
)),
1222 JSON_BUILD_PAIR_CONDITION(m
->seqnum
!= 0, "seqnum", JSON_BUILD_INTEGER(m
->seqnum
)),
1223 JSON_BUILD_PAIR_CONDITION(m
->error
.name
, "error_name", JSON_BUILD_STRING(m
->error
.name
)),
1224 JSON_BUILD_PAIR("payload", JSON_BUILD_VARIANT(v
))));
1226 return log_error_errno(r
, "Failed to build JSON object: %m");
1228 json_dump_with_flags(w
, f
);
1232 static int monitor(int argc
, char **argv
, int (*dump
)(sd_bus_message
*m
, FILE *f
)) {
1233 _cleanup_(sd_bus_flush_close_unrefp
) sd_bus
*bus
= NULL
;
1234 _cleanup_(sd_bus_message_unrefp
) sd_bus_message
*message
= NULL
;
1235 _cleanup_(sd_bus_error_free
) sd_bus_error error
= SD_BUS_ERROR_NULL
;
1238 const char *unique_name
;
1239 bool is_monitor
= false;
1242 r
= acquire_bus(true, &bus
);
1246 /* upgrade connection; it's not used for anything else after this call */
1247 r
= sd_bus_message_new_method_call(bus
,
1249 "org.freedesktop.DBus",
1250 "/org/freedesktop/DBus",
1251 "org.freedesktop.DBus.Monitoring",
1254 return bus_log_create_error(r
);
1256 r
= sd_bus_message_open_container(message
, 'a', "s");
1258 return bus_log_create_error(r
);
1260 STRV_FOREACH(i
, argv
+1) {
1261 _cleanup_free_
char *m
= NULL
;
1263 if (!sd_bus_service_name_is_valid(*i
))
1264 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
), "Invalid service name '%s'", *i
);
1266 m
= strjoin("sender='", *i
, "'");
1270 r
= sd_bus_message_append_basic(message
, 's', m
);
1272 return bus_log_create_error(r
);
1275 m
= strjoin("destination='", *i
, "'");
1279 r
= sd_bus_message_append_basic(message
, 's', m
);
1281 return bus_log_create_error(r
);
1284 STRV_FOREACH(i
, arg_matches
) {
1285 r
= sd_bus_message_append_basic(message
, 's', *i
);
1287 return bus_log_create_error(r
);
1290 r
= sd_bus_message_close_container(message
);
1292 return bus_log_create_error(r
);
1294 r
= sd_bus_message_append_basic(message
, 'u', &flags
);
1296 return bus_log_create_error(r
);
1298 r
= sd_bus_call(bus
, message
, arg_timeout
, &error
, NULL
);
1300 return log_error_errno(r
, "Call to org.freedesktop.DBus.Monitoring.BecomeMonitor failed: %s",
1301 bus_error_message(&error
, r
));
1303 r
= sd_bus_get_unique_name(bus
, &unique_name
);
1305 return log_error_errno(r
, "Failed to get unique name: %m");
1307 log_info("Monitoring bus message stream.");
1310 _cleanup_(sd_bus_message_unrefp
) sd_bus_message
*m
= NULL
;
1312 r
= sd_bus_process(bus
, &m
);
1314 return log_error_errno(r
, "Failed to process bus: %m");
1319 /* wait until we lose our unique name */
1320 if (sd_bus_message_is_signal(m
, "org.freedesktop.DBus", "NameLost") <= 0)
1323 r
= sd_bus_message_read(m
, "s", &name
);
1325 return log_error_errno(r
, "Failed to read lost name: %m");
1327 if (streq(name
, unique_name
))
1337 if (sd_bus_message_is_signal(m
, "org.freedesktop.DBus.Local", "Disconnected") > 0) {
1338 log_info("Connection terminated, exiting.");
1348 r
= sd_bus_wait(bus
, (uint64_t) -1);
1350 return log_error_errno(r
, "Failed to wait for bus: %m");
1354 static int verb_monitor(int argc
, char **argv
, void *userdata
) {
1355 return monitor(argc
, argv
, arg_json
!= JSON_OFF
? message_json
: message_dump
);
1358 static int verb_capture(int argc
, char **argv
, void *userdata
) {
1361 if (isatty(fileno(stdout
)) > 0)
1362 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
1363 "Refusing to write message data to console, please redirect output to a file.");
1365 bus_pcap_header(arg_snaplen
, stdout
);
1367 r
= monitor(argc
, argv
, message_pcap
);
1371 r
= fflush_and_check(stdout
);
1373 return log_error_errno(r
, "Couldn't write capture file: %m");
1378 static int status(int argc
, char **argv
, void *userdata
) {
1379 _cleanup_(sd_bus_flush_close_unrefp
) sd_bus
*bus
= NULL
;
1380 _cleanup_(sd_bus_creds_unrefp
) sd_bus_creds
*creds
= NULL
;
1384 r
= acquire_bus(false, &bus
);
1388 (void) pager_open(arg_pager_flags
);
1390 if (!isempty(argv
[1])) {
1391 r
= parse_pid(argv
[1], &pid
);
1393 r
= sd_bus_get_name_creds(
1396 (arg_augment_creds
? SD_BUS_CREDS_AUGMENT
: 0) | _SD_BUS_CREDS_ALL
,
1399 r
= sd_bus_creds_new_from_pid(
1404 const char *scope
, *address
;
1407 r
= sd_bus_get_address(bus
, &address
);
1409 printf("BusAddress=%s%s%s\n", ansi_highlight(), address
, ansi_normal());
1411 r
= sd_bus_get_scope(bus
, &scope
);
1413 printf("BusScope=%s%s%s\n", ansi_highlight(), scope
, ansi_normal());
1415 r
= sd_bus_get_bus_id(bus
, &bus_id
);
1417 printf("BusID=%s" SD_ID128_FORMAT_STR
"%s\n",
1418 ansi_highlight(), SD_ID128_FORMAT_VAL(bus_id
), ansi_normal());
1420 r
= sd_bus_get_owner_creds(
1422 (arg_augment_creds
? SD_BUS_CREDS_AUGMENT
: 0) | _SD_BUS_CREDS_ALL
,
1427 return log_error_errno(r
, "Failed to get credentials: %m");
1429 bus_creds_dump(creds
, NULL
, false);
1433 static int message_append_cmdline(sd_bus_message
*m
, const char *signature
, char ***x
) {
1453 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
1454 "Too few parameters for signature.");
1461 case SD_BUS_TYPE_BOOLEAN
:
1463 r
= parse_boolean(v
);
1465 return log_error_errno(r
, "Failed to parse '%s' as boolean: %m", v
);
1467 r
= sd_bus_message_append_basic(m
, t
, &r
);
1470 case SD_BUS_TYPE_BYTE
: {
1473 r
= safe_atou8(v
, &z
);
1475 return log_error_errno(r
, "Failed to parse '%s' as byte (unsigned 8bit integer): %m", v
);
1477 r
= sd_bus_message_append_basic(m
, t
, &z
);
1481 case SD_BUS_TYPE_INT16
: {
1484 r
= safe_atoi16(v
, &z
);
1486 return log_error_errno(r
, "Failed to parse '%s' as signed 16bit integer: %m", v
);
1488 r
= sd_bus_message_append_basic(m
, t
, &z
);
1492 case SD_BUS_TYPE_UINT16
: {
1495 r
= safe_atou16(v
, &z
);
1497 return log_error_errno(r
, "Failed to parse '%s' as unsigned 16bit integer: %m", v
);
1499 r
= sd_bus_message_append_basic(m
, t
, &z
);
1503 case SD_BUS_TYPE_INT32
: {
1506 r
= safe_atoi32(v
, &z
);
1508 return log_error_errno(r
, "Failed to parse '%s' as signed 32bit integer: %m", v
);
1510 r
= sd_bus_message_append_basic(m
, t
, &z
);
1514 case SD_BUS_TYPE_UINT32
: {
1517 r
= safe_atou32(v
, &z
);
1519 return log_error_errno(r
, "Failed to parse '%s' as unsigned 32bit integer: %m", v
);
1521 r
= sd_bus_message_append_basic(m
, t
, &z
);
1525 case SD_BUS_TYPE_INT64
: {
1528 r
= safe_atoi64(v
, &z
);
1530 return log_error_errno(r
, "Failed to parse '%s' as signed 64bit integer: %m", v
);
1532 r
= sd_bus_message_append_basic(m
, t
, &z
);
1536 case SD_BUS_TYPE_UINT64
: {
1539 r
= safe_atou64(v
, &z
);
1541 return log_error_errno(r
, "Failed to parse '%s' as unsigned 64bit integer: %m", v
);
1543 r
= sd_bus_message_append_basic(m
, t
, &z
);
1547 case SD_BUS_TYPE_DOUBLE
: {
1550 r
= safe_atod(v
, &z
);
1552 return log_error_errno(r
, "Failed to parse '%s' as double precision floating point: %m", v
);
1554 r
= sd_bus_message_append_basic(m
, t
, &z
);
1558 case SD_BUS_TYPE_STRING
:
1559 case SD_BUS_TYPE_OBJECT_PATH
:
1560 case SD_BUS_TYPE_SIGNATURE
:
1562 r
= sd_bus_message_append_basic(m
, t
, v
);
1565 case SD_BUS_TYPE_ARRAY
: {
1569 r
= safe_atou32(v
, &n
);
1571 return log_error_errno(r
, "Failed to parse '%s' number of array entries: %m", v
);
1573 r
= signature_element_length(signature
, &k
);
1575 return log_error_errno(r
, "Invalid array signature: %m");
1579 memcpy(s
, signature
, k
);
1582 r
= sd_bus_message_open_container(m
, SD_BUS_TYPE_ARRAY
, s
);
1584 return bus_log_create_error(r
);
1586 for (unsigned i
= 0; i
< n
; i
++) {
1587 r
= message_append_cmdline(m
, s
, &p
);
1595 r
= sd_bus_message_close_container(m
);
1599 case SD_BUS_TYPE_VARIANT
:
1600 r
= sd_bus_message_open_container(m
, SD_BUS_TYPE_VARIANT
, v
);
1602 return bus_log_create_error(r
);
1604 r
= message_append_cmdline(m
, v
, &p
);
1608 r
= sd_bus_message_close_container(m
);
1611 case SD_BUS_TYPE_STRUCT_BEGIN
:
1612 case SD_BUS_TYPE_DICT_ENTRY_BEGIN
: {
1618 r
= signature_element_length(signature
, &k
);
1620 return log_error_errno(r
, "Invalid struct/dict entry signature: %m");
1624 memcpy(s
, signature
+ 1, k
- 2);
1627 const char ctype
= t
== SD_BUS_TYPE_STRUCT_BEGIN
?
1628 SD_BUS_TYPE_STRUCT
: SD_BUS_TYPE_DICT_ENTRY
;
1629 r
= sd_bus_message_open_container(m
, ctype
, s
);
1631 return bus_log_create_error(r
);
1633 r
= message_append_cmdline(m
, s
, &p
);
1640 r
= sd_bus_message_close_container(m
);
1644 case SD_BUS_TYPE_UNIX_FD
:
1645 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
1646 "UNIX file descriptor not supported as type.");
1649 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
1650 "Unknown signature type %c.", t
);
1654 return bus_log_create_error(r
);
1661 static int json_transform_one(sd_bus_message
*m
, JsonVariant
**ret
);
1663 static int json_transform_array_or_struct(sd_bus_message
*m
, JsonVariant
**ret
) {
1664 size_t n_elements
= 0, n_allocated
= 0;
1665 JsonVariant
**elements
= NULL
;
1672 r
= sd_bus_message_at_end(m
, false);
1674 bus_log_parse_error(r
);
1680 if (!GREEDY_REALLOC(elements
, n_allocated
, n_elements
+ 1)) {
1685 r
= json_transform_one(m
, elements
+ n_elements
);
1692 r
= json_variant_new_array(ret
, elements
, n_elements
);
1695 json_variant_unref_many(elements
, n_elements
);
1701 static int json_transform_variant(sd_bus_message
*m
, const char *contents
, JsonVariant
**ret
) {
1702 _cleanup_(json_variant_unrefp
) JsonVariant
*value
= NULL
;
1709 r
= json_transform_one(m
, &value
);
1713 r
= json_build(ret
, JSON_BUILD_OBJECT(JSON_BUILD_PAIR("type", JSON_BUILD_STRING(contents
)),
1714 JSON_BUILD_PAIR("data", JSON_BUILD_VARIANT(value
))));
1721 static int json_transform_dict_array(sd_bus_message
*m
, JsonVariant
**ret
) {
1722 size_t n_elements
= 0, n_allocated
= 0;
1723 JsonVariant
**elements
= NULL
;
1730 const char *contents
;
1733 r
= sd_bus_message_at_end(m
, false);
1735 bus_log_parse_error(r
);
1741 r
= sd_bus_message_peek_type(m
, &type
, &contents
);
1745 assert(type
== 'e');
1747 if (!GREEDY_REALLOC(elements
, n_allocated
, n_elements
+ 2)) {
1752 r
= sd_bus_message_enter_container(m
, type
, contents
);
1754 bus_log_parse_error(r
);
1758 r
= json_transform_one(m
, elements
+ n_elements
);
1764 r
= json_transform_one(m
, elements
+ n_elements
);
1770 r
= sd_bus_message_exit_container(m
);
1772 bus_log_parse_error(r
);
1777 r
= json_variant_new_object(ret
, elements
, n_elements
);
1780 json_variant_unref_many(elements
, n_elements
);
1786 static int json_transform_one(sd_bus_message
*m
, JsonVariant
**ret
) {
1787 _cleanup_(json_variant_unrefp
) JsonVariant
*v
= NULL
;
1788 const char *contents
;
1795 r
= sd_bus_message_peek_type(m
, &type
, &contents
);
1797 return bus_log_parse_error(r
);
1801 case SD_BUS_TYPE_BYTE
: {
1804 r
= sd_bus_message_read_basic(m
, type
, &b
);
1806 return bus_log_parse_error(r
);
1808 r
= json_variant_new_unsigned(&v
, b
);
1810 return log_error_errno(r
, "Failed to transform byte: %m");
1815 case SD_BUS_TYPE_BOOLEAN
: {
1818 r
= sd_bus_message_read_basic(m
, type
, &b
);
1820 return bus_log_parse_error(r
);
1822 r
= json_variant_new_boolean(&v
, b
);
1824 return log_error_errno(r
, "Failed to transform boolean: %m");
1829 case SD_BUS_TYPE_INT16
: {
1832 r
= sd_bus_message_read_basic(m
, type
, &b
);
1834 return bus_log_parse_error(r
);
1836 r
= json_variant_new_integer(&v
, b
);
1838 return log_error_errno(r
, "Failed to transform int16: %m");
1843 case SD_BUS_TYPE_UINT16
: {
1846 r
= sd_bus_message_read_basic(m
, type
, &b
);
1848 return bus_log_parse_error(r
);
1850 r
= json_variant_new_unsigned(&v
, b
);
1852 return log_error_errno(r
, "Failed to transform uint16: %m");
1857 case SD_BUS_TYPE_INT32
: {
1860 r
= sd_bus_message_read_basic(m
, type
, &b
);
1862 return bus_log_parse_error(r
);
1864 r
= json_variant_new_integer(&v
, b
);
1866 return log_error_errno(r
, "Failed to transform int32: %m");
1871 case SD_BUS_TYPE_UINT32
: {
1874 r
= sd_bus_message_read_basic(m
, type
, &b
);
1876 return bus_log_parse_error(r
);
1878 r
= json_variant_new_unsigned(&v
, b
);
1880 return log_error_errno(r
, "Failed to transform uint32: %m");
1885 case SD_BUS_TYPE_INT64
: {
1888 r
= sd_bus_message_read_basic(m
, type
, &b
);
1890 return bus_log_parse_error(r
);
1892 r
= json_variant_new_integer(&v
, b
);
1894 return log_error_errno(r
, "Failed to transform int64: %m");
1899 case SD_BUS_TYPE_UINT64
: {
1902 r
= sd_bus_message_read_basic(m
, type
, &b
);
1904 return bus_log_parse_error(r
);
1906 r
= json_variant_new_unsigned(&v
, b
);
1908 return log_error_errno(r
, "Failed to transform uint64: %m");
1913 case SD_BUS_TYPE_DOUBLE
: {
1916 r
= sd_bus_message_read_basic(m
, type
, &d
);
1918 return bus_log_parse_error(r
);
1920 r
= json_variant_new_real(&v
, d
);
1922 return log_error_errno(r
, "Failed to transform double: %m");
1927 case SD_BUS_TYPE_STRING
:
1928 case SD_BUS_TYPE_OBJECT_PATH
:
1929 case SD_BUS_TYPE_SIGNATURE
: {
1932 r
= sd_bus_message_read_basic(m
, type
, &s
);
1934 return bus_log_parse_error(r
);
1936 r
= json_variant_new_string(&v
, s
);
1938 return log_error_errno(r
, "Failed to transform double: %m");
1943 case SD_BUS_TYPE_UNIX_FD
:
1944 r
= sd_bus_message_read_basic(m
, type
, NULL
);
1946 return bus_log_parse_error(r
);
1948 r
= json_variant_new_null(&v
);
1950 return log_error_errno(r
, "Failed to transform fd: %m");
1954 case SD_BUS_TYPE_ARRAY
:
1955 case SD_BUS_TYPE_VARIANT
:
1956 case SD_BUS_TYPE_STRUCT
:
1957 r
= sd_bus_message_enter_container(m
, type
, contents
);
1959 return bus_log_parse_error(r
);
1961 if (type
== SD_BUS_TYPE_VARIANT
)
1962 r
= json_transform_variant(m
, contents
, &v
);
1963 else if (type
== SD_BUS_TYPE_ARRAY
&& contents
[0] == '{')
1964 r
= json_transform_dict_array(m
, &v
);
1966 r
= json_transform_array_or_struct(m
, &v
);
1970 r
= sd_bus_message_exit_container(m
);
1972 return bus_log_parse_error(r
);
1977 assert_not_reached("Unexpected element type");
1984 static int json_transform_message(sd_bus_message
*m
, JsonVariant
**ret
) {
1985 _cleanup_(json_variant_unrefp
) JsonVariant
*v
= NULL
;
1992 assert_se(type
= sd_bus_message_get_signature(m
, false));
1994 r
= json_transform_array_or_struct(m
, &v
);
1998 r
= json_build(ret
, JSON_BUILD_OBJECT(JSON_BUILD_PAIR("type", JSON_BUILD_STRING(type
)),
1999 JSON_BUILD_PAIR("data", JSON_BUILD_VARIANT(v
))));
2006 static void json_dump_with_flags(JsonVariant
*v
, FILE *f
) {
2008 json_variant_dump(v
,
2009 (arg_json
== JSON_PRETTY
? JSON_FORMAT_PRETTY
: JSON_FORMAT_NEWLINE
) |
2010 JSON_FORMAT_COLOR_AUTO
,
2014 static int call(int argc
, char **argv
, void *userdata
) {
2015 _cleanup_(sd_bus_flush_close_unrefp
) sd_bus
*bus
= NULL
;
2016 _cleanup_(sd_bus_error_free
) sd_bus_error error
= SD_BUS_ERROR_NULL
;
2017 _cleanup_(sd_bus_message_unrefp
) sd_bus_message
*m
= NULL
, *reply
= NULL
;
2020 r
= acquire_bus(false, &bus
);
2024 r
= sd_bus_message_new_method_call(bus
, &m
, argv
[1], argv
[2], argv
[3], argv
[4]);
2026 return bus_log_create_error(r
);
2028 r
= sd_bus_message_set_expect_reply(m
, arg_expect_reply
);
2030 return bus_log_create_error(r
);
2032 r
= sd_bus_message_set_auto_start(m
, arg_auto_start
);
2034 return bus_log_create_error(r
);
2036 r
= sd_bus_message_set_allow_interactive_authorization(m
, arg_allow_interactive_authorization
);
2038 return bus_log_create_error(r
);
2040 if (!isempty(argv
[5])) {
2045 r
= message_append_cmdline(m
, argv
[5], &p
);
2050 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
2051 "Too many parameters for signature.");
2054 if (!arg_expect_reply
) {
2055 r
= sd_bus_send(bus
, m
, NULL
);
2057 return log_error_errno(r
, "Failed to send message: %m");
2062 r
= sd_bus_call(bus
, m
, arg_timeout
, &error
, &reply
);
2064 return log_error_errno(r
, "Call failed: %s", bus_error_message(&error
, r
));
2066 r
= sd_bus_message_is_empty(reply
);
2068 return bus_log_parse_error(r
);
2070 if (r
== 0 && !arg_quiet
) {
2072 if (arg_json
!= JSON_OFF
) {
2073 _cleanup_(json_variant_unrefp
) JsonVariant
*v
= NULL
;
2075 if (arg_json
!= JSON_SHORT
)
2076 (void) pager_open(arg_pager_flags
);
2078 r
= json_transform_message(reply
, &v
);
2082 json_dump_with_flags(v
, stdout
);
2084 } else if (arg_verbose
) {
2085 (void) pager_open(arg_pager_flags
);
2087 r
= sd_bus_message_dump(reply
, stdout
, 0);
2092 fputs(sd_bus_message_get_signature(reply
, true), stdout
);
2095 r
= format_cmdline(reply
, stdout
, false);
2097 return bus_log_parse_error(r
);
2099 fputc('\n', stdout
);
2106 static int emit_signal(int argc
, char **argv
, void *userdata
) {
2107 _cleanup_(sd_bus_flush_close_unrefp
) sd_bus
*bus
= NULL
;
2108 _cleanup_(sd_bus_message_unrefp
) sd_bus_message
*m
= NULL
;
2111 r
= acquire_bus(false, &bus
);
2115 r
= sd_bus_message_new_signal(bus
, &m
, argv
[1], argv
[2], argv
[3]);
2117 return bus_log_create_error(r
);
2119 if (arg_destination
) {
2120 r
= sd_bus_message_set_destination(m
, arg_destination
);
2122 return bus_log_create_error(r
);
2125 r
= sd_bus_message_set_auto_start(m
, arg_auto_start
);
2127 return bus_log_create_error(r
);
2129 if (!isempty(argv
[4])) {
2134 r
= message_append_cmdline(m
, argv
[4], &p
);
2139 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
2140 "Too many parameters for signature.");
2143 r
= sd_bus_send(bus
, m
, NULL
);
2145 return log_error_errno(r
, "Failed to send signal: %m");
2150 static int get_property(int argc
, char **argv
, void *userdata
) {
2151 _cleanup_(sd_bus_flush_close_unrefp
) sd_bus
*bus
= NULL
;
2152 _cleanup_(sd_bus_error_free
) sd_bus_error error
= SD_BUS_ERROR_NULL
;
2156 r
= acquire_bus(false, &bus
);
2160 STRV_FOREACH(i
, argv
+ 4) {
2161 _cleanup_(sd_bus_message_unrefp
) sd_bus_message
*reply
= NULL
;
2162 const char *contents
= NULL
;
2165 r
= sd_bus_call_method(bus
, argv
[1], argv
[2],
2166 "org.freedesktop.DBus.Properties", "Get",
2167 &error
, &reply
, "ss", argv
[3], *i
);
2169 return log_error_errno(r
, "Failed to get property %s on interface %s: %s",
2171 bus_error_message(&error
, r
));
2173 r
= sd_bus_message_peek_type(reply
, &type
, &contents
);
2175 return bus_log_parse_error(r
);
2177 r
= sd_bus_message_enter_container(reply
, 'v', contents
);
2179 return bus_log_parse_error(r
);
2181 if (arg_json
!= JSON_OFF
) {
2182 _cleanup_(json_variant_unrefp
) JsonVariant
*v
= NULL
;
2184 if (arg_json
!= JSON_SHORT
)
2185 (void) pager_open(arg_pager_flags
);
2187 r
= json_transform_variant(reply
, contents
, &v
);
2191 json_dump_with_flags(v
, stdout
);
2193 } else if (arg_verbose
) {
2194 (void) pager_open(arg_pager_flags
);
2196 r
= sd_bus_message_dump(reply
, stdout
, SD_BUS_MESSAGE_DUMP_SUBTREE_ONLY
);
2200 fputs(contents
, stdout
);
2203 r
= format_cmdline(reply
, stdout
, false);
2205 return bus_log_parse_error(r
);
2207 fputc('\n', stdout
);
2210 r
= sd_bus_message_exit_container(reply
);
2212 return bus_log_parse_error(r
);
2218 static int set_property(int argc
, char **argv
, void *userdata
) {
2219 _cleanup_(sd_bus_flush_close_unrefp
) sd_bus
*bus
= NULL
;
2220 _cleanup_(sd_bus_message_unrefp
) sd_bus_message
*m
= NULL
;
2221 _cleanup_(sd_bus_error_free
) sd_bus_error error
= SD_BUS_ERROR_NULL
;
2225 r
= acquire_bus(false, &bus
);
2229 r
= sd_bus_message_new_method_call(bus
, &m
, argv
[1], argv
[2],
2230 "org.freedesktop.DBus.Properties", "Set");
2232 return bus_log_create_error(r
);
2234 r
= sd_bus_message_append(m
, "ss", argv
[3], argv
[4]);
2236 return bus_log_create_error(r
);
2238 r
= sd_bus_message_open_container(m
, 'v', argv
[5]);
2240 return bus_log_create_error(r
);
2243 r
= message_append_cmdline(m
, argv
[5], &p
);
2247 r
= sd_bus_message_close_container(m
);
2249 return bus_log_create_error(r
);
2252 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
), "Too many parameters for signature.");
2254 r
= sd_bus_call(bus
, m
, arg_timeout
, &error
, NULL
);
2256 return log_error_errno(r
, "Failed to set property %s on interface %s: %s",
2258 bus_error_message(&error
, r
));
2263 static int help(void) {
2264 _cleanup_free_
char *link
= NULL
;
2267 r
= terminal_urlify_man("busctl", "1", &link
);
2271 printf("%s [OPTIONS...] COMMAND ...\n\n"
2272 "%sIntrospect the D-Bus IPC bus.%s\n"
2274 " list List bus names\n"
2275 " status [SERVICE] Show bus service, process or bus owner credentials\n"
2276 " monitor [SERVICE...] Show bus traffic\n"
2277 " capture [SERVICE...] Capture bus traffic as pcap\n"
2278 " tree [SERVICE...] Show object tree of service\n"
2279 " introspect SERVICE OBJECT [INTERFACE]\n"
2280 " call SERVICE OBJECT INTERFACE METHOD [SIGNATURE [ARGUMENT...]]\n"
2282 " emit OBJECT INTERFACE SIGNAL [SIGNATURE [ARGUMENT...]]\n"
2284 " get-property SERVICE OBJECT INTERFACE PROPERTY...\n"
2285 " Get property value\n"
2286 " set-property SERVICE OBJECT INTERFACE PROPERTY SIGNATURE ARGUMENT...\n"
2287 " Set property value\n"
2288 " help Show this help\n"
2290 " -h --help Show this help\n"
2291 " --version Show package version\n"
2292 " --no-pager Do not pipe output into a pager\n"
2293 " --no-legend Do not show the headers and footers\n"
2294 " -l --full Do not ellipsize output\n"
2295 " --system Connect to system bus\n"
2296 " --user Connect to user bus\n"
2297 " -H --host=[USER@]HOST Operate on remote host\n"
2298 " -M --machine=CONTAINER Operate on local container\n"
2299 " --address=ADDRESS Connect to bus specified by address\n"
2300 " --show-machine Show machine ID column in list\n"
2301 " --unique Only show unique names\n"
2302 " --acquired Only show acquired names\n"
2303 " --activatable Only show activatable names\n"
2304 " --match=MATCH Only show matching messages\n"
2305 " --size=SIZE Maximum length of captured packet\n"
2306 " --list Don't show tree, but simple object path list\n"
2307 " -q --quiet Don't show method call reply\n"
2308 " --verbose Show result values in long format\n"
2309 " --json=MODE Output as JSON\n"
2310 " -j Same as --json=pretty on tty, --json=short otherwise\n"
2311 " --expect-reply=BOOL Expect a method call reply\n"
2312 " --auto-start=BOOL Auto-start destination service\n"
2313 " --allow-interactive-authorization=BOOL\n"
2314 " Allow interactive authorization for operation\n"
2315 " --timeout=SECS Maximum time to wait for method call completion\n"
2316 " --augment-creds=BOOL Extend credential data with data read from /proc/$PID\n"
2317 " --watch-bind=BOOL Wait for bus AF_UNIX socket to be bound in the file\n"
2319 " --destination=SERVICE Destination service of a signal\n"
2320 "\nSee the %s for details.\n"
2321 , program_invocation_short_name
2330 static int verb_help(int argc
, char **argv
, void *userdata
) {
2334 static int parse_argv(int argc
, char *argv
[]) {
2337 ARG_VERSION
= 0x100,
2354 ARG_ALLOW_INTERACTIVE_AUTHORIZATION
,
2362 static const struct option options
[] = {
2363 { "help", no_argument
, NULL
, 'h' },
2364 { "version", no_argument
, NULL
, ARG_VERSION
},
2365 { "no-pager", no_argument
, NULL
, ARG_NO_PAGER
},
2366 { "no-legend", no_argument
, NULL
, ARG_NO_LEGEND
},
2367 { "full", no_argument
, NULL
, 'l' },
2368 { "system", no_argument
, NULL
, ARG_SYSTEM
},
2369 { "user", no_argument
, NULL
, ARG_USER
},
2370 { "address", required_argument
, NULL
, ARG_ADDRESS
},
2371 { "show-machine", no_argument
, NULL
, ARG_SHOW_MACHINE
},
2372 { "unique", no_argument
, NULL
, ARG_UNIQUE
},
2373 { "acquired", no_argument
, NULL
, ARG_ACQUIRED
},
2374 { "activatable", no_argument
, NULL
, ARG_ACTIVATABLE
},
2375 { "match", required_argument
, NULL
, ARG_MATCH
},
2376 { "host", required_argument
, NULL
, 'H' },
2377 { "machine", required_argument
, NULL
, 'M' },
2378 { "size", required_argument
, NULL
, ARG_SIZE
},
2379 { "list", no_argument
, NULL
, ARG_LIST
},
2380 { "quiet", no_argument
, NULL
, 'q' },
2381 { "verbose", no_argument
, NULL
, ARG_VERBOSE
},
2382 { "xml-interface", no_argument
, NULL
, ARG_XML_INTERFACE
},
2383 { "expect-reply", required_argument
, NULL
, ARG_EXPECT_REPLY
},
2384 { "auto-start", required_argument
, NULL
, ARG_AUTO_START
},
2385 { "allow-interactive-authorization", required_argument
, NULL
, ARG_ALLOW_INTERACTIVE_AUTHORIZATION
},
2386 { "timeout", required_argument
, NULL
, ARG_TIMEOUT
},
2387 { "augment-creds", required_argument
, NULL
, ARG_AUGMENT_CREDS
},
2388 { "watch-bind", required_argument
, NULL
, ARG_WATCH_BIND
},
2389 { "json", required_argument
, NULL
, ARG_JSON
},
2390 { "destination", required_argument
, NULL
, ARG_DESTINATION
},
2399 while ((c
= getopt_long(argc
, argv
, "hH:M:qj", options
, NULL
)) >= 0)
2410 arg_pager_flags
|= PAGER_DISABLE
;
2430 arg_address
= optarg
;
2433 case ARG_SHOW_MACHINE
:
2434 arg_show_machine
= true;
2442 arg_acquired
= true;
2445 case ARG_ACTIVATABLE
:
2446 arg_activatable
= true;
2450 if (strv_extend(&arg_matches
, optarg
) < 0)
2457 r
= parse_size(optarg
, 1024, &sz
);
2459 return log_error_errno(r
, "Failed to parse size '%s': %m", optarg
);
2461 if ((uint64_t) (size_t) sz
!= sz
)
2462 return log_error_errno(SYNTHETIC_ERRNO(E2BIG
),
2463 "Size out of range.");
2465 arg_snaplen
= (size_t) sz
;
2474 arg_transport
= BUS_TRANSPORT_REMOTE
;
2479 arg_transport
= BUS_TRANSPORT_MACHINE
;
2491 case ARG_XML_INTERFACE
:
2492 arg_xml_interface
= true;
2495 case ARG_EXPECT_REPLY
:
2496 r
= parse_boolean(optarg
);
2498 return log_error_errno(r
, "Failed to parse --expect-reply= parameter '%s': %m", optarg
);
2500 arg_expect_reply
= r
;
2503 case ARG_AUTO_START
:
2504 r
= parse_boolean(optarg
);
2506 return log_error_errno(r
, "Failed to parse --auto-start= parameter '%s': %m", optarg
);
2511 case ARG_ALLOW_INTERACTIVE_AUTHORIZATION
:
2512 r
= parse_boolean(optarg
);
2514 return log_error_errno(r
, "Failed to parse --allow-interactive-authorization= parameter '%s': %m", optarg
);
2516 arg_allow_interactive_authorization
= r
;
2520 r
= parse_sec(optarg
, &arg_timeout
);
2522 return log_error_errno(r
, "Failed to parse --timeout= parameter '%s': %m", optarg
);
2526 case ARG_AUGMENT_CREDS
:
2527 r
= parse_boolean(optarg
);
2529 return log_error_errno(r
, "Failed to parse --augment-creds= parameter '%s': %m", optarg
);
2531 arg_augment_creds
= r
;
2534 case ARG_WATCH_BIND
:
2535 r
= parse_boolean(optarg
);
2537 return log_error_errno(r
, "Failed to parse --watch-bind= parameter '%s': %m", optarg
);
2544 arg_json
= JSON_PRETTY
;
2546 arg_json
= JSON_SHORT
;
2550 if (streq(optarg
, "short"))
2551 arg_json
= JSON_SHORT
;
2552 else if (streq(optarg
, "pretty"))
2553 arg_json
= JSON_PRETTY
;
2554 else if (streq(optarg
, "help")) {
2556 "pretty\n", stdout
);
2559 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
2560 "Unknown JSON out mode: %s",
2565 case ARG_DESTINATION
:
2566 arg_destination
= optarg
;
2573 assert_not_reached("Unhandled option");
2579 static int busctl_main(int argc
, char *argv
[]) {
2580 static const Verb verbs
[] = {
2581 { "list", VERB_ANY
, 1, VERB_DEFAULT
, list_bus_names
},
2582 { "status", VERB_ANY
, 2, 0, status
},
2583 { "monitor", VERB_ANY
, VERB_ANY
, 0, verb_monitor
},
2584 { "capture", VERB_ANY
, VERB_ANY
, 0, verb_capture
},
2585 { "tree", VERB_ANY
, VERB_ANY
, 0, tree
},
2586 { "introspect", 3, 4, 0, introspect
},
2587 { "call", 5, VERB_ANY
, 0, call
},
2588 { "emit", 4, VERB_ANY
, 0, emit_signal
},
2589 { "get-property", 5, VERB_ANY
, 0, get_property
},
2590 { "set-property", 6, VERB_ANY
, 0, set_property
},
2591 { "help", VERB_ANY
, VERB_ANY
, 0, verb_help
},
2595 return dispatch_verb(argc
, argv
, verbs
, NULL
);
2598 static int run(int argc
, char *argv
[]) {
2603 r
= parse_argv(argc
, argv
);
2607 return busctl_main(argc
, argv
);
2610 DEFINE_MAIN_FUNCTION(run
);