1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
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-argument.h"
25 #include "parse-util.h"
26 #include "path-util.h"
27 #include "pretty-print.h"
29 #include "sort-util.h"
31 #include "terminal-util.h"
32 #include "user-util.h"
35 static JsonFormatFlags arg_json_format_flags
= JSON_FORMAT_OFF
;
36 static PagerFlags arg_pager_flags
= 0;
37 static bool arg_legend
= true;
38 static bool arg_full
= false;
39 static const char *arg_address
= NULL
;
40 static bool arg_unique
= false;
41 static bool arg_acquired
= false;
42 static bool arg_activatable
= false;
43 static bool arg_show_machine
= false;
44 static char **arg_matches
= NULL
;
45 static BusTransport arg_transport
= BUS_TRANSPORT_LOCAL
;
46 static const char *arg_host
= NULL
;
47 static bool arg_user
= false;
48 static size_t arg_snaplen
= 4096;
49 static bool arg_list
= false;
50 static bool arg_quiet
= false;
51 static bool arg_verbose
= false;
52 static bool arg_xml_interface
= false;
53 static bool arg_expect_reply
= true;
54 static bool arg_auto_start
= true;
55 static bool arg_allow_interactive_authorization
= true;
56 static bool arg_augment_creds
= true;
57 static bool arg_watch_bind
= false;
58 static usec_t arg_timeout
= 0;
59 static const char *arg_destination
= NULL
;
61 STATIC_DESTRUCTOR_REGISTER(arg_matches
, strv_freep
);
63 #define NAME_IS_ACQUIRED INT_TO_PTR(1)
64 #define NAME_IS_ACTIVATABLE INT_TO_PTR(2)
66 static int json_transform_message(sd_bus_message
*m
, JsonVariant
**ret
);
68 static int acquire_bus(bool set_monitor
, sd_bus
**ret
) {
69 _cleanup_(sd_bus_close_unrefp
) sd_bus
*bus
= NULL
;
74 return log_error_errno(r
, "Failed to allocate bus: %m");
77 r
= sd_bus_set_monitor(bus
, true);
79 return log_error_errno(r
, "Failed to set monitor mode: %m");
81 r
= sd_bus_negotiate_creds(bus
, true, _SD_BUS_CREDS_ALL
);
83 return log_error_errno(r
, "Failed to enable credentials: %m");
85 r
= sd_bus_negotiate_timestamp(bus
, true);
87 return log_error_errno(r
, "Failed to enable timestamps: %m");
89 r
= sd_bus_negotiate_fds(bus
, true);
91 return log_error_errno(r
, "Failed to enable fds: %m");
94 r
= sd_bus_set_bus_client(bus
, true);
96 return log_error_errno(r
, "Failed to set bus client: %m");
98 r
= sd_bus_set_watch_bind(bus
, arg_watch_bind
);
100 return log_error_errno(r
, "Failed to set watch-bind setting to '%s': %m",
101 yes_no(arg_watch_bind
));
104 r
= sd_bus_set_address(bus
, arg_address
);
106 switch (arg_transport
) {
108 case BUS_TRANSPORT_LOCAL
:
110 r
= bus_set_address_user(bus
);
112 r
= bus_set_address_system(bus
);
115 case BUS_TRANSPORT_REMOTE
:
116 r
= bus_set_address_system_remote(bus
, arg_host
);
119 case BUS_TRANSPORT_MACHINE
:
120 r
= bus_set_address_machine(bus
, arg_user
, arg_host
);
124 assert_not_reached("Hmm, unknown transport type.");
128 return bus_log_address_error(r
);
130 r
= sd_bus_start(bus
);
132 return bus_log_connect_error(r
);
134 *ret
= TAKE_PTR(bus
);
139 static int list_bus_names(int argc
, char **argv
, void *userdata
) {
140 _cleanup_strv_free_
char **acquired
= NULL
, **activatable
= NULL
;
141 _cleanup_(sd_bus_flush_close_unrefp
) sd_bus
*bus
= NULL
;
142 _cleanup_hashmap_free_ Hashmap
*names
= NULL
;
143 _cleanup_(table_unrefp
) Table
*table
= NULL
;
161 if (!arg_unique
&& !arg_acquired
&& !arg_activatable
)
162 arg_unique
= arg_acquired
= arg_activatable
= true;
164 r
= acquire_bus(false, &bus
);
168 r
= sd_bus_list_names(bus
,
169 (arg_acquired
|| arg_unique
) ? &acquired
: NULL
,
170 arg_activatable
? &activatable
: NULL
);
172 return log_error_errno(r
, "Failed to list names: %m");
174 names
= hashmap_new(&string_hash_ops
);
178 STRV_FOREACH(i
, acquired
) {
179 r
= hashmap_put(names
, *i
, NAME_IS_ACQUIRED
);
181 return log_error_errno(r
, "Failed to add to hashmap: %m");
184 STRV_FOREACH(i
, activatable
) {
185 r
= hashmap_put(names
, *i
, NAME_IS_ACTIVATABLE
);
186 if (r
< 0 && r
!= -EEXIST
)
187 return log_error_errno(r
, "Failed to add to hashmap: %m");
190 table
= table_new("activatable",
204 table_set_width(table
, 0);
206 r
= table_set_align_percent(table
, table_get_cell(table
, 0, COLUMN_PID
), 100);
208 return log_error_errno(r
, "Failed to set alignment: %m");
210 r
= table_set_empty_string(table
, "-");
212 return log_error_errno(r
, "Failed to set empty string: %m");
214 r
= table_set_sort(table
, (size_t) COLUMN_NAME
);
216 return log_error_errno(r
, "Failed to set sort column: %m");
218 if (arg_show_machine
)
219 r
= table_set_display(table
, (size_t) COLUMN_NAME
,
221 (size_t) COLUMN_PROCESS
,
222 (size_t) COLUMN_USER
,
223 (size_t) COLUMN_CONNECTION
,
224 (size_t) COLUMN_UNIT
,
225 (size_t) COLUMN_SESSION
,
226 (size_t) COLUMN_DESCRIPTION
,
227 (size_t) COLUMN_MACHINE
);
229 r
= table_set_display(table
, (size_t) COLUMN_NAME
,
231 (size_t) COLUMN_PROCESS
,
232 (size_t) COLUMN_USER
,
233 (size_t) COLUMN_CONNECTION
,
234 (size_t) COLUMN_UNIT
,
235 (size_t) COLUMN_SESSION
,
236 (size_t) COLUMN_DESCRIPTION
);
239 return log_error_errno(r
, "Failed to set columns to display: %m");
241 HASHMAP_FOREACH_KEY(v
, k
, names
) {
242 _cleanup_(sd_bus_creds_unrefp
) sd_bus_creds
*creds
= NULL
;
244 if (v
== NAME_IS_ACTIVATABLE
) {
247 TABLE_INT
, PTR_TO_INT(v
),
252 TABLE_STRING
, "(activatable)", TABLE_SET_COLOR
, ansi_grey(),
258 return table_log_add_error(r
);
263 assert(v
== NAME_IS_ACQUIRED
);
265 if (!arg_unique
&& k
[0] == ':')
268 if (!arg_acquired
&& k
[0] != ':')
271 r
= table_add_many(table
,
272 TABLE_INT
, PTR_TO_INT(v
),
275 return table_log_add_error(r
);
277 r
= sd_bus_get_name_creds(
279 (arg_augment_creds
? SD_BUS_CREDS_AUGMENT
: 0) |
280 SD_BUS_CREDS_EUID
|SD_BUS_CREDS_PID
|SD_BUS_CREDS_COMM
|
281 SD_BUS_CREDS_UNIQUE_NAME
|SD_BUS_CREDS_UNIT
|SD_BUS_CREDS_SESSION
|
282 SD_BUS_CREDS_DESCRIPTION
, &creds
);
284 log_debug_errno(r
, "Failed to acquire credentials of service %s, ignoring: %m", k
);
286 r
= table_fill_empty(table
, COLUMN_MACHINE
);
288 const char *unique
= NULL
, *session
= NULL
, *unit
= NULL
, *cn
= NULL
;
292 r
= sd_bus_creds_get_pid(creds
, &pid
);
294 const char *comm
= NULL
;
296 (void) sd_bus_creds_get_comm(creds
, &comm
);
298 r
= table_add_many(table
,
300 TABLE_STRING
, strna(comm
));
302 r
= table_add_many(table
, TABLE_EMPTY
, TABLE_EMPTY
);
304 return table_log_add_error(r
);
306 r
= sd_bus_creds_get_euid(creds
, &uid
);
308 _cleanup_free_
char *u
= NULL
;
310 u
= uid_to_name(uid
);
314 r
= table_add_cell(table
, NULL
, TABLE_STRING
, u
);
316 r
= table_add_cell(table
, NULL
, TABLE_EMPTY
, NULL
);
318 return table_log_add_error(r
);
320 (void) sd_bus_creds_get_unique_name(creds
, &unique
);
321 (void) sd_bus_creds_get_unit(creds
, &unit
);
322 (void) sd_bus_creds_get_session(creds
, &session
);
323 (void) sd_bus_creds_get_description(creds
, &cn
);
327 TABLE_STRING
, unique
,
329 TABLE_STRING
, session
,
333 return table_log_add_error(r
);
335 if (arg_show_machine
) {
338 r
= sd_bus_get_name_machine_id(bus
, k
, &mid
);
340 log_debug_errno(r
, "Failed to acquire credentials of service %s, ignoring: %m", k
);
342 char m
[SD_ID128_STRING_MAX
];
344 r
= table_add_cell(table
, NULL
, TABLE_STRING
, sd_id128_to_string(mid
, m
));
346 return table_log_add_error(r
);
348 continue; /* line fully filled, no need to fill the remainder below */
352 r
= table_fill_empty(table
, 0);
354 return log_error_errno(r
, "Failed to fill line: %m");
357 return table_print_with_pager(table
, arg_json_format_flags
, arg_pager_flags
, arg_legend
);
360 static void print_subtree(const char *prefix
, const char *path
, char **l
) {
361 const char *vertical
, *space
;
364 /* We assume the list is sorted. Let's first skip over the
365 * entry we are looking at. */
370 if (!streq(*l
, path
))
376 vertical
= strjoina(prefix
, special_glyph(SPECIAL_GLYPH_TREE_VERTICAL
));
377 space
= strjoina(prefix
, special_glyph(SPECIAL_GLYPH_TREE_SPACE
));
380 bool has_more
= false;
382 if (!*l
|| !path_startswith(*l
, path
))
387 if (!*n
|| !path_startswith(*n
, path
))
390 if (!path_startswith(*n
, *l
)) {
400 special_glyph(has_more
? SPECIAL_GLYPH_TREE_BRANCH
: SPECIAL_GLYPH_TREE_RIGHT
),
403 print_subtree(has_more
? vertical
: space
, *l
, l
);
408 static void print_tree(char **l
) {
411 else if (strv_isempty(l
))
412 printf("No objects discovered.\n");
413 else if (streq(l
[0], "/") && !l
[1])
414 printf("Only root object discovered.\n");
416 print_subtree("", "/", l
);
419 static int on_path(const char *path
, void *userdata
) {
420 Set
*paths
= userdata
;
425 r
= set_put_strdup(&paths
, path
);
432 static int find_nodes(sd_bus
*bus
, const char *service
, const char *path
, Set
*paths
) {
433 static const XMLIntrospectOps ops
= {
437 _cleanup_(sd_bus_message_unrefp
) sd_bus_message
*reply
= NULL
;
438 _cleanup_(sd_bus_error_free
) sd_bus_error error
= SD_BUS_ERROR_NULL
;
442 r
= sd_bus_call_method(bus
, service
, path
,
443 "org.freedesktop.DBus.Introspectable", "Introspect",
444 &error
, &reply
, NULL
);
446 printf("%sFailed to introspect object %s of service %s: %s%s\n",
447 ansi_highlight_red(),
448 path
, service
, bus_error_message(&error
, r
),
453 r
= sd_bus_message_read(reply
, "s", &xml
);
455 return bus_log_parse_error(r
);
457 return parse_xml_introspect(path
, xml
, &ops
, paths
);
460 static int tree_one(sd_bus
*bus
, const char *service
) {
461 _cleanup_set_free_ Set
*paths
= NULL
, *done
= NULL
, *failed
= NULL
;
462 _cleanup_free_
char **l
= NULL
;
465 r
= set_put_strdup(&paths
, "/");
469 done
= set_new(&string_hash_ops_free
);
473 failed
= set_new(&string_hash_ops_free
);
478 _cleanup_free_
char *p
= NULL
;
481 p
= set_steal_first(paths
);
485 if (set_contains(done
, p
) ||
486 set_contains(failed
, p
))
489 q
= find_nodes(bus
, service
, p
, paths
);
493 q
= set_consume(q
< 0 ? failed
: done
, TAKE_PTR(p
));
499 (void) pager_open(arg_pager_flags
);
501 l
= set_get_strv(done
);
513 static int tree(int argc
, char **argv
, void *userdata
) {
514 _cleanup_(sd_bus_flush_close_unrefp
) sd_bus
*bus
= NULL
;
518 /* Do superficial verification of arguments before even opening the bus */
519 STRV_FOREACH(i
, strv_skip(argv
, 1))
520 if (!sd_bus_service_name_is_valid(*i
))
521 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
522 "Invalid bus service name: %s", *i
);
524 if (!arg_unique
&& !arg_acquired
)
527 r
= acquire_bus(false, &bus
);
532 _cleanup_strv_free_
char **names
= NULL
;
533 bool not_first
= false;
535 r
= sd_bus_list_names(bus
, &names
, NULL
);
537 return log_error_errno(r
, "Failed to get name list: %m");
539 (void) pager_open(arg_pager_flags
);
541 STRV_FOREACH(i
, names
) {
544 if (!arg_unique
&& (*i
)[0] == ':')
547 if (!arg_acquired
&& (*i
)[0] == ':')
553 printf("Service %s%s%s:\n", ansi_highlight(), *i
, ansi_normal());
555 q
= tree_one(bus
, *i
);
562 STRV_FOREACH(i
, strv_skip(argv
, 1)) {
569 (void) pager_open(arg_pager_flags
);
570 printf("Service %s%s%s:\n", ansi_highlight(), *i
, ansi_normal());
573 q
= tree_one(bus
, *i
);
581 static int format_cmdline(sd_bus_message
*m
, FILE *f
, bool needs_space
) {
585 const char *contents
= NULL
;
600 r
= sd_bus_message_peek_type(m
, &type
, &contents
);
606 if (bus_type_is_container(type
) > 0) {
608 r
= sd_bus_message_enter_container(m
, type
, contents
);
612 if (type
== SD_BUS_TYPE_ARRAY
) {
615 /* count array entries */
618 r
= sd_bus_message_skip(m
, contents
);
627 r
= sd_bus_message_rewind(m
, false);
637 } else if (type
== SD_BUS_TYPE_VARIANT
) {
642 fprintf(f
, "%s", contents
);
646 r
= format_cmdline(m
, f
, needs_space
);
652 r
= sd_bus_message_exit_container(m
);
659 r
= sd_bus_message_read_basic(m
, type
, &basic
);
667 case SD_BUS_TYPE_BYTE
:
668 fprintf(f
, "%u", basic
.u8
);
671 case SD_BUS_TYPE_BOOLEAN
:
672 fputs(true_false(basic
.i
), f
);
675 case SD_BUS_TYPE_INT16
:
676 fprintf(f
, "%i", basic
.s16
);
679 case SD_BUS_TYPE_UINT16
:
680 fprintf(f
, "%u", basic
.u16
);
683 case SD_BUS_TYPE_INT32
:
684 fprintf(f
, "%i", basic
.s32
);
687 case SD_BUS_TYPE_UINT32
:
688 fprintf(f
, "%u", basic
.u32
);
691 case SD_BUS_TYPE_INT64
:
692 fprintf(f
, "%" PRIi64
, basic
.s64
);
695 case SD_BUS_TYPE_UINT64
:
696 fprintf(f
, "%" PRIu64
, basic
.u64
);
699 case SD_BUS_TYPE_DOUBLE
:
700 fprintf(f
, "%g", basic
.d64
);
703 case SD_BUS_TYPE_STRING
:
704 case SD_BUS_TYPE_OBJECT_PATH
:
705 case SD_BUS_TYPE_SIGNATURE
: {
706 _cleanup_free_
char *b
= NULL
;
708 b
= cescape(basic
.string
);
712 fprintf(f
, "\"%s\"", b
);
716 case SD_BUS_TYPE_UNIX_FD
:
717 fprintf(f
, "%i", basic
.i
);
721 assert_not_reached("Unknown basic type.");
728 typedef struct Member
{
739 static void member_hash_func(const Member
*m
, struct siphash
*state
) {
745 string_hash_func(m
->type
, state
);
747 arity
+= !!m
->name
+ !!m
->interface
;
749 uint64_hash_func(&arity
, state
);
752 string_hash_func(m
->name
, state
);
755 string_hash_func(m
->interface
, state
);
758 static int member_compare_func(const Member
*x
, const Member
*y
) {
766 d
= strcmp_ptr(x
->interface
, y
->interface
);
770 d
= strcmp(x
->type
, y
->type
);
774 return strcmp_ptr(x
->name
, y
->name
);
777 static int member_compare_funcp(Member
* const *a
, Member
* const *b
) {
778 return member_compare_func(*a
, *b
);
781 static Member
* member_free(Member
*m
) {
792 DEFINE_TRIVIAL_CLEANUP_FUNC(Member
*, member_free
);
794 static Set
* member_set_free(Set
*s
) {
795 return set_free_with_destructor(s
, member_free
);
797 DEFINE_TRIVIAL_CLEANUP_FUNC(Set
*, member_set_free
);
799 static int on_interface(const char *interface
, uint64_t flags
, void *userdata
) {
800 _cleanup_(member_freep
) Member
*m
;
801 Set
*members
= userdata
;
816 r
= free_and_strdup(&m
->interface
, interface
);
820 r
= set_put(members
, m
);
822 return log_error_errno(r
, "Invalid introspection data: duplicate interface '%s'.", interface
);
830 static int on_method(const char *interface
, const char *name
, const char *signature
, const char *result
, uint64_t flags
, void *userdata
) {
831 _cleanup_(member_freep
) Member
*m
;
832 Set
*members
= userdata
;
847 r
= free_and_strdup(&m
->interface
, interface
);
851 r
= free_and_strdup(&m
->name
, name
);
855 r
= free_and_strdup(&m
->signature
, signature
);
859 r
= free_and_strdup(&m
->result
, result
);
863 r
= set_put(members
, m
);
865 return log_error_errno(r
, "Invalid introspection data: duplicate method '%s' on interface '%s'.", name
, interface
);
873 static int on_signal(const char *interface
, const char *name
, const char *signature
, uint64_t flags
, void *userdata
) {
874 _cleanup_(member_freep
) Member
*m
;
875 Set
*members
= userdata
;
890 r
= free_and_strdup(&m
->interface
, interface
);
894 r
= free_and_strdup(&m
->name
, name
);
898 r
= free_and_strdup(&m
->signature
, signature
);
902 r
= set_put(members
, m
);
904 return log_error_errno(r
, "Invalid introspection data: duplicate signal '%s' on interface '%s'.", name
, interface
);
912 static int on_property(const char *interface
, const char *name
, const char *signature
, bool writable
, uint64_t flags
, void *userdata
) {
913 _cleanup_(member_freep
) Member
*m
;
914 Set
*members
= userdata
;
927 .writable
= writable
,
930 r
= free_and_strdup(&m
->interface
, interface
);
934 r
= free_and_strdup(&m
->name
, name
);
938 r
= free_and_strdup(&m
->signature
, signature
);
942 r
= set_put(members
, m
);
944 return log_error_errno(r
, "Invalid introspection data: duplicate property '%s' on interface '%s'.", name
, interface
);
952 DEFINE_PRIVATE_HASH_OPS(member_hash_ops
, Member
, member_hash_func
, member_compare_func
);
954 static int introspect(int argc
, char **argv
, void *userdata
) {
955 static const XMLIntrospectOps ops
= {
956 .on_interface
= on_interface
,
957 .on_method
= on_method
,
958 .on_signal
= on_signal
,
959 .on_property
= on_property
,
962 _cleanup_(sd_bus_flush_close_unrefp
) sd_bus
*bus
= NULL
;
963 _cleanup_(sd_bus_message_unrefp
) sd_bus_message
*reply_xml
= NULL
;
964 _cleanup_(sd_bus_error_free
) sd_bus_error error
= SD_BUS_ERROR_NULL
;
965 _cleanup_(member_set_freep
) Set
*members
= NULL
;
966 unsigned name_width
, type_width
, signature_width
, result_width
, j
, k
= 0;
967 Member
*m
, **sorted
= NULL
;
971 r
= acquire_bus(false, &bus
);
975 members
= set_new(&member_hash_ops
);
979 r
= sd_bus_call_method(bus
, argv
[1], argv
[2],
980 "org.freedesktop.DBus.Introspectable", "Introspect",
981 &error
, &reply_xml
, NULL
);
983 return log_error_errno(r
, "Failed to introspect object %s of service %s: %s",
984 argv
[2], argv
[1], bus_error_message(&error
, r
));
986 r
= sd_bus_message_read(reply_xml
, "s", &xml
);
988 return bus_log_parse_error(r
);
990 if (arg_xml_interface
) {
991 /* Just dump the received XML and finish */
992 (void) pager_open(arg_pager_flags
);
997 /* First, get list of all properties */
998 r
= parse_xml_introspect(argv
[2], xml
, &ops
, members
);
1002 /* Second, find the current values for them */
1003 SET_FOREACH(m
, members
) {
1004 _cleanup_(sd_bus_message_unrefp
) sd_bus_message
*reply
= NULL
;
1006 if (!streq(m
->type
, "property"))
1012 if (argv
[3] && !streq(argv
[3], m
->interface
))
1015 r
= sd_bus_call_method(bus
, argv
[1], argv
[2],
1016 "org.freedesktop.DBus.Properties", "GetAll",
1017 &error
, &reply
, "s", m
->interface
);
1019 return log_error_errno(r
, "Failed to get all properties on interface %s: %s",
1020 m
->interface
, bus_error_message(&error
, r
));
1022 r
= sd_bus_message_enter_container(reply
, 'a', "{sv}");
1024 return bus_log_parse_error(r
);
1028 _cleanup_free_
char *buf
= NULL
;
1029 _cleanup_fclose_
FILE *mf
= NULL
;
1033 r
= sd_bus_message_enter_container(reply
, 'e', "sv");
1035 return bus_log_parse_error(r
);
1040 r
= sd_bus_message_read(reply
, "s", &name
);
1042 return bus_log_parse_error(r
);
1044 r
= sd_bus_message_enter_container(reply
, 'v', NULL
);
1046 return bus_log_parse_error(r
);
1048 mf
= open_memstream_unlocked(&buf
, &sz
);
1052 r
= format_cmdline(reply
, mf
, false);
1054 return bus_log_parse_error(r
);
1056 mf
= safe_fclose(mf
);
1058 z
= set_get(members
, &((Member
) {
1060 .interface
= m
->interface
,
1061 .name
= (char*) name
}));
1063 free_and_replace(z
->value
, buf
);
1065 r
= sd_bus_message_exit_container(reply
);
1067 return bus_log_parse_error(r
);
1069 r
= sd_bus_message_exit_container(reply
);
1071 return bus_log_parse_error(r
);
1074 r
= sd_bus_message_exit_container(reply
);
1076 return bus_log_parse_error(r
);
1079 name_width
= strlen("NAME");
1080 type_width
= strlen("TYPE");
1081 signature_width
= strlen("SIGNATURE");
1082 result_width
= strlen("RESULT/VALUE");
1084 sorted
= newa(Member
*, set_size(members
));
1086 SET_FOREACH(m
, members
) {
1087 if (argv
[3] && !streq(argv
[3], m
->interface
))
1091 name_width
= MAX(name_width
, strlen(m
->interface
));
1093 name_width
= MAX(name_width
, strlen(m
->name
) + 1);
1095 type_width
= MAX(type_width
, strlen(m
->type
));
1097 signature_width
= MAX(signature_width
, strlen(m
->signature
));
1099 result_width
= MAX(result_width
, strlen(m
->result
));
1101 result_width
= MAX(result_width
, strlen(m
->value
));
1106 if (result_width
> 40)
1109 typesafe_qsort(sorted
, k
, member_compare_funcp
);
1111 (void) pager_open(arg_pager_flags
);
1114 printf("%-*s %-*s %-*s %-*s %s\n",
1115 (int) name_width
, "NAME",
1116 (int) type_width
, "TYPE",
1117 (int) signature_width
, "SIGNATURE",
1118 (int) result_width
, "RESULT/VALUE",
1121 for (j
= 0; j
< k
; j
++) {
1122 _cleanup_free_
char *ellipsized
= NULL
;
1128 if (argv
[3] && !streq(argv
[3], m
->interface
))
1131 is_interface
= streq(m
->type
, "interface");
1133 if (argv
[3] && is_interface
)
1137 ellipsized
= ellipsize(m
->value
, result_width
, 100);
1143 rv
= empty_to_dash(m
->result
);
1145 printf("%s%s%-*s%s %-*s %-*s %-*s%s%s%s%s%s%s\n",
1146 is_interface
? ansi_highlight() : "",
1147 is_interface
? "" : ".",
1148 - !is_interface
+ (int) name_width
,
1149 empty_to_dash(streq_ptr(m
->type
, "interface") ? m
->interface
: m
->name
),
1150 is_interface
? ansi_normal() : "",
1151 (int) type_width
, empty_to_dash(m
->type
),
1152 (int) signature_width
, empty_to_dash(m
->signature
),
1153 (int) result_width
, rv
,
1154 (m
->flags
& SD_BUS_VTABLE_DEPRECATED
) ? " deprecated" : (m
->flags
|| m
->writable
? "" : " -"),
1155 (m
->flags
& SD_BUS_VTABLE_METHOD_NO_REPLY
) ? " no-reply" : "",
1156 (m
->flags
& SD_BUS_VTABLE_PROPERTY_CONST
) ? " const" : "",
1157 (m
->flags
& SD_BUS_VTABLE_PROPERTY_EMITS_CHANGE
) ? " emits-change" : "",
1158 (m
->flags
& SD_BUS_VTABLE_PROPERTY_EMITS_INVALIDATION
) ? " emits-invalidation" : "",
1159 m
->writable
? " writable" : "");
1165 static int message_dump(sd_bus_message
*m
, FILE *f
) {
1166 return sd_bus_message_dump(m
, f
, SD_BUS_MESSAGE_DUMP_WITH_HEADER
);
1169 static int message_pcap(sd_bus_message
*m
, FILE *f
) {
1170 return bus_message_pcap_frame(m
, arg_snaplen
, f
);
1173 static int message_json(sd_bus_message
*m
, FILE *f
) {
1174 _cleanup_(json_variant_unrefp
) JsonVariant
*v
= NULL
, *w
= NULL
;
1179 r
= json_transform_message(m
, &v
);
1183 e
[0] = m
->header
->endian
;
1188 ts
= now(CLOCK_REALTIME
);
1190 r
= json_build(&w
, JSON_BUILD_OBJECT(
1191 JSON_BUILD_PAIR("type", JSON_BUILD_STRING(bus_message_type_to_string(m
->header
->type
))),
1192 JSON_BUILD_PAIR("endian", JSON_BUILD_STRING(e
)),
1193 JSON_BUILD_PAIR("flags", JSON_BUILD_INTEGER(m
->header
->flags
)),
1194 JSON_BUILD_PAIR("version", JSON_BUILD_INTEGER(m
->header
->version
)),
1195 JSON_BUILD_PAIR("cookie", JSON_BUILD_INTEGER(BUS_MESSAGE_COOKIE(m
))),
1196 JSON_BUILD_PAIR_CONDITION(m
->reply_cookie
!= 0, "reply_cookie", JSON_BUILD_INTEGER(m
->reply_cookie
)),
1197 JSON_BUILD_PAIR("timestamp-realtime", JSON_BUILD_UNSIGNED(ts
)),
1198 JSON_BUILD_PAIR_CONDITION(m
->sender
, "sender", JSON_BUILD_STRING(m
->sender
)),
1199 JSON_BUILD_PAIR_CONDITION(m
->destination
, "destination", JSON_BUILD_STRING(m
->destination
)),
1200 JSON_BUILD_PAIR_CONDITION(m
->path
, "path", JSON_BUILD_STRING(m
->path
)),
1201 JSON_BUILD_PAIR_CONDITION(m
->interface
, "interface", JSON_BUILD_STRING(m
->interface
)),
1202 JSON_BUILD_PAIR_CONDITION(m
->member
, "member", JSON_BUILD_STRING(m
->member
)),
1203 JSON_BUILD_PAIR_CONDITION(m
->monotonic
!= 0, "monotonic", JSON_BUILD_INTEGER(m
->monotonic
)),
1204 JSON_BUILD_PAIR_CONDITION(m
->realtime
!= 0, "realtime", JSON_BUILD_INTEGER(m
->realtime
)),
1205 JSON_BUILD_PAIR_CONDITION(m
->seqnum
!= 0, "seqnum", JSON_BUILD_INTEGER(m
->seqnum
)),
1206 JSON_BUILD_PAIR_CONDITION(m
->error
.name
, "error_name", JSON_BUILD_STRING(m
->error
.name
)),
1207 JSON_BUILD_PAIR("payload", JSON_BUILD_VARIANT(v
))));
1209 return log_error_errno(r
, "Failed to build JSON object: %m");
1211 json_variant_dump(w
, arg_json_format_flags
, f
, NULL
);
1215 static int monitor(int argc
, char **argv
, int (*dump
)(sd_bus_message
*m
, FILE *f
)) {
1216 _cleanup_(sd_bus_flush_close_unrefp
) sd_bus
*bus
= NULL
;
1217 _cleanup_(sd_bus_message_unrefp
) sd_bus_message
*message
= NULL
;
1218 _cleanup_(sd_bus_error_free
) sd_bus_error error
= SD_BUS_ERROR_NULL
;
1221 const char *unique_name
;
1222 bool is_monitor
= false;
1225 r
= acquire_bus(true, &bus
);
1229 /* upgrade connection; it's not used for anything else after this call */
1230 r
= sd_bus_message_new_method_call(bus
,
1232 "org.freedesktop.DBus",
1233 "/org/freedesktop/DBus",
1234 "org.freedesktop.DBus.Monitoring",
1237 return bus_log_create_error(r
);
1239 r
= sd_bus_message_open_container(message
, 'a', "s");
1241 return bus_log_create_error(r
);
1243 STRV_FOREACH(i
, argv
+1) {
1244 _cleanup_free_
char *m
= NULL
;
1246 if (!sd_bus_service_name_is_valid(*i
))
1247 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
), "Invalid service name '%s'", *i
);
1249 m
= strjoin("sender='", *i
, "'");
1253 r
= sd_bus_message_append_basic(message
, 's', m
);
1255 return bus_log_create_error(r
);
1258 m
= strjoin("destination='", *i
, "'");
1262 r
= sd_bus_message_append_basic(message
, 's', m
);
1264 return bus_log_create_error(r
);
1267 STRV_FOREACH(i
, arg_matches
) {
1268 r
= sd_bus_message_append_basic(message
, 's', *i
);
1270 return bus_log_create_error(r
);
1273 r
= sd_bus_message_close_container(message
);
1275 return bus_log_create_error(r
);
1277 r
= sd_bus_message_append_basic(message
, 'u', &flags
);
1279 return bus_log_create_error(r
);
1281 r
= sd_bus_call(bus
, message
, arg_timeout
, &error
, NULL
);
1283 return log_error_errno(r
, "Call to org.freedesktop.DBus.Monitoring.BecomeMonitor failed: %s",
1284 bus_error_message(&error
, r
));
1286 r
= sd_bus_get_unique_name(bus
, &unique_name
);
1288 return log_error_errno(r
, "Failed to get unique name: %m");
1290 log_info("Monitoring bus message stream.");
1293 _cleanup_(sd_bus_message_unrefp
) sd_bus_message
*m
= NULL
;
1295 r
= sd_bus_process(bus
, &m
);
1297 return log_error_errno(r
, "Failed to process bus: %m");
1302 /* wait until we lose our unique name */
1303 if (sd_bus_message_is_signal(m
, "org.freedesktop.DBus", "NameLost") <= 0)
1306 r
= sd_bus_message_read(m
, "s", &name
);
1308 return bus_log_parse_error(r
);
1310 if (streq(name
, unique_name
))
1320 if (sd_bus_message_is_signal(m
, "org.freedesktop.DBus.Local", "Disconnected") > 0) {
1321 log_info("Connection terminated, exiting.");
1331 r
= sd_bus_wait(bus
, UINT64_MAX
);
1333 return log_error_errno(r
, "Failed to wait for bus: %m");
1337 static int verb_monitor(int argc
, char **argv
, void *userdata
) {
1338 return monitor(argc
, argv
, (arg_json_format_flags
& JSON_FORMAT_OFF
) ? message_dump
: message_json
);
1341 static int verb_capture(int argc
, char **argv
, void *userdata
) {
1344 if (isatty(fileno(stdout
)) > 0)
1345 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
1346 "Refusing to write message data to console, please redirect output to a file.");
1348 bus_pcap_header(arg_snaplen
, stdout
);
1350 r
= monitor(argc
, argv
, message_pcap
);
1354 r
= fflush_and_check(stdout
);
1356 return log_error_errno(r
, "Couldn't write capture file: %m");
1361 static int status(int argc
, char **argv
, void *userdata
) {
1362 _cleanup_(sd_bus_flush_close_unrefp
) sd_bus
*bus
= NULL
;
1363 _cleanup_(sd_bus_creds_unrefp
) sd_bus_creds
*creds
= NULL
;
1367 r
= acquire_bus(false, &bus
);
1371 (void) pager_open(arg_pager_flags
);
1373 if (!isempty(argv
[1])) {
1374 r
= parse_pid(argv
[1], &pid
);
1376 r
= sd_bus_get_name_creds(
1379 (arg_augment_creds
? SD_BUS_CREDS_AUGMENT
: 0) | _SD_BUS_CREDS_ALL
,
1382 r
= sd_bus_creds_new_from_pid(
1387 const char *scope
, *address
;
1390 r
= sd_bus_get_address(bus
, &address
);
1392 printf("BusAddress=%s%s%s\n", ansi_highlight(), address
, ansi_normal());
1394 r
= sd_bus_get_scope(bus
, &scope
);
1396 printf("BusScope=%s%s%s\n", ansi_highlight(), scope
, ansi_normal());
1398 r
= sd_bus_get_bus_id(bus
, &bus_id
);
1400 printf("BusID=%s" SD_ID128_FORMAT_STR
"%s\n",
1401 ansi_highlight(), SD_ID128_FORMAT_VAL(bus_id
), ansi_normal());
1403 r
= sd_bus_get_owner_creds(
1405 (arg_augment_creds
? SD_BUS_CREDS_AUGMENT
: 0) | _SD_BUS_CREDS_ALL
,
1410 return log_error_errno(r
, "Failed to get credentials: %m");
1412 bus_creds_dump(creds
, NULL
, false);
1416 static int message_append_cmdline(sd_bus_message
*m
, const char *signature
, char ***x
) {
1436 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
1437 "Too few parameters for signature.");
1444 case SD_BUS_TYPE_BOOLEAN
:
1446 r
= parse_boolean(v
);
1448 return log_error_errno(r
, "Failed to parse '%s' as boolean: %m", v
);
1450 r
= sd_bus_message_append_basic(m
, t
, &r
);
1453 case SD_BUS_TYPE_BYTE
: {
1456 r
= safe_atou8(v
, &z
);
1458 return log_error_errno(r
, "Failed to parse '%s' as byte (unsigned 8bit integer): %m", v
);
1460 r
= sd_bus_message_append_basic(m
, t
, &z
);
1464 case SD_BUS_TYPE_INT16
: {
1467 r
= safe_atoi16(v
, &z
);
1469 return log_error_errno(r
, "Failed to parse '%s' as signed 16bit integer: %m", v
);
1471 r
= sd_bus_message_append_basic(m
, t
, &z
);
1475 case SD_BUS_TYPE_UINT16
: {
1478 r
= safe_atou16(v
, &z
);
1480 return log_error_errno(r
, "Failed to parse '%s' as unsigned 16bit integer: %m", v
);
1482 r
= sd_bus_message_append_basic(m
, t
, &z
);
1486 case SD_BUS_TYPE_INT32
: {
1489 r
= safe_atoi32(v
, &z
);
1491 return log_error_errno(r
, "Failed to parse '%s' as signed 32bit integer: %m", v
);
1493 r
= sd_bus_message_append_basic(m
, t
, &z
);
1497 case SD_BUS_TYPE_UINT32
: {
1500 r
= safe_atou32(v
, &z
);
1502 return log_error_errno(r
, "Failed to parse '%s' as unsigned 32bit integer: %m", v
);
1504 r
= sd_bus_message_append_basic(m
, t
, &z
);
1508 case SD_BUS_TYPE_INT64
: {
1511 r
= safe_atoi64(v
, &z
);
1513 return log_error_errno(r
, "Failed to parse '%s' as signed 64bit integer: %m", v
);
1515 r
= sd_bus_message_append_basic(m
, t
, &z
);
1519 case SD_BUS_TYPE_UINT64
: {
1522 r
= safe_atou64(v
, &z
);
1524 return log_error_errno(r
, "Failed to parse '%s' as unsigned 64bit integer: %m", v
);
1526 r
= sd_bus_message_append_basic(m
, t
, &z
);
1530 case SD_BUS_TYPE_DOUBLE
: {
1533 r
= safe_atod(v
, &z
);
1535 return log_error_errno(r
, "Failed to parse '%s' as double precision floating point: %m", v
);
1537 r
= sd_bus_message_append_basic(m
, t
, &z
);
1541 case SD_BUS_TYPE_STRING
:
1542 case SD_BUS_TYPE_OBJECT_PATH
:
1543 case SD_BUS_TYPE_SIGNATURE
:
1545 r
= sd_bus_message_append_basic(m
, t
, v
);
1548 case SD_BUS_TYPE_ARRAY
: {
1552 r
= safe_atou32(v
, &n
);
1554 return log_error_errno(r
, "Failed to parse '%s' number of array entries: %m", v
);
1556 r
= signature_element_length(signature
, &k
);
1558 return log_error_errno(r
, "Invalid array signature: %m");
1562 memcpy(s
, signature
, k
);
1565 r
= sd_bus_message_open_container(m
, SD_BUS_TYPE_ARRAY
, s
);
1567 return bus_log_create_error(r
);
1569 for (unsigned i
= 0; i
< n
; i
++) {
1570 r
= message_append_cmdline(m
, s
, &p
);
1578 r
= sd_bus_message_close_container(m
);
1582 case SD_BUS_TYPE_VARIANT
:
1583 r
= sd_bus_message_open_container(m
, SD_BUS_TYPE_VARIANT
, v
);
1585 return bus_log_create_error(r
);
1587 r
= message_append_cmdline(m
, v
, &p
);
1591 r
= sd_bus_message_close_container(m
);
1594 case SD_BUS_TYPE_STRUCT_BEGIN
:
1595 case SD_BUS_TYPE_DICT_ENTRY_BEGIN
: {
1601 r
= signature_element_length(signature
, &k
);
1603 return log_error_errno(r
, "Invalid struct/dict entry signature: %m");
1607 memcpy(s
, signature
+ 1, k
- 2);
1610 const char ctype
= t
== SD_BUS_TYPE_STRUCT_BEGIN
?
1611 SD_BUS_TYPE_STRUCT
: SD_BUS_TYPE_DICT_ENTRY
;
1612 r
= sd_bus_message_open_container(m
, ctype
, s
);
1614 return bus_log_create_error(r
);
1616 r
= message_append_cmdline(m
, s
, &p
);
1623 r
= sd_bus_message_close_container(m
);
1627 case SD_BUS_TYPE_UNIX_FD
:
1628 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
1629 "UNIX file descriptor not supported as type.");
1632 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
1633 "Unknown signature type %c.", t
);
1637 return bus_log_create_error(r
);
1644 static int json_transform_one(sd_bus_message
*m
, JsonVariant
**ret
);
1646 static int json_transform_array_or_struct(sd_bus_message
*m
, JsonVariant
**ret
) {
1647 size_t n_elements
= 0, n_allocated
= 0;
1648 JsonVariant
**elements
= NULL
;
1655 r
= sd_bus_message_at_end(m
, false);
1657 bus_log_parse_error(r
);
1663 if (!GREEDY_REALLOC(elements
, n_allocated
, n_elements
+ 1)) {
1668 r
= json_transform_one(m
, elements
+ n_elements
);
1675 r
= json_variant_new_array(ret
, elements
, n_elements
);
1678 json_variant_unref_many(elements
, n_elements
);
1684 static int json_transform_variant(sd_bus_message
*m
, const char *contents
, JsonVariant
**ret
) {
1685 _cleanup_(json_variant_unrefp
) JsonVariant
*value
= NULL
;
1692 r
= json_transform_one(m
, &value
);
1696 r
= json_build(ret
, JSON_BUILD_OBJECT(JSON_BUILD_PAIR("type", JSON_BUILD_STRING(contents
)),
1697 JSON_BUILD_PAIR("data", JSON_BUILD_VARIANT(value
))));
1704 static int json_transform_dict_array(sd_bus_message
*m
, JsonVariant
**ret
) {
1705 size_t n_elements
= 0, n_allocated
= 0;
1706 JsonVariant
**elements
= NULL
;
1713 const char *contents
;
1716 r
= sd_bus_message_at_end(m
, false);
1718 bus_log_parse_error(r
);
1724 r
= sd_bus_message_peek_type(m
, &type
, &contents
);
1728 assert(type
== 'e');
1730 if (!GREEDY_REALLOC(elements
, n_allocated
, n_elements
+ 2)) {
1735 r
= sd_bus_message_enter_container(m
, type
, contents
);
1737 bus_log_parse_error(r
);
1741 r
= json_transform_one(m
, elements
+ n_elements
);
1747 r
= json_transform_one(m
, elements
+ n_elements
);
1753 r
= sd_bus_message_exit_container(m
);
1755 bus_log_parse_error(r
);
1760 r
= json_variant_new_object(ret
, elements
, n_elements
);
1763 json_variant_unref_many(elements
, n_elements
);
1769 static int json_transform_one(sd_bus_message
*m
, JsonVariant
**ret
) {
1770 _cleanup_(json_variant_unrefp
) JsonVariant
*v
= NULL
;
1771 const char *contents
;
1778 r
= sd_bus_message_peek_type(m
, &type
, &contents
);
1780 return bus_log_parse_error(r
);
1784 case SD_BUS_TYPE_BYTE
: {
1787 r
= sd_bus_message_read_basic(m
, type
, &b
);
1789 return bus_log_parse_error(r
);
1791 r
= json_variant_new_unsigned(&v
, b
);
1793 return log_error_errno(r
, "Failed to transform byte: %m");
1798 case SD_BUS_TYPE_BOOLEAN
: {
1801 r
= sd_bus_message_read_basic(m
, type
, &b
);
1803 return bus_log_parse_error(r
);
1805 r
= json_variant_new_boolean(&v
, b
);
1807 return log_error_errno(r
, "Failed to transform boolean: %m");
1812 case SD_BUS_TYPE_INT16
: {
1815 r
= sd_bus_message_read_basic(m
, type
, &b
);
1817 return bus_log_parse_error(r
);
1819 r
= json_variant_new_integer(&v
, b
);
1821 return log_error_errno(r
, "Failed to transform int16: %m");
1826 case SD_BUS_TYPE_UINT16
: {
1829 r
= sd_bus_message_read_basic(m
, type
, &b
);
1831 return bus_log_parse_error(r
);
1833 r
= json_variant_new_unsigned(&v
, b
);
1835 return log_error_errno(r
, "Failed to transform uint16: %m");
1840 case SD_BUS_TYPE_INT32
: {
1843 r
= sd_bus_message_read_basic(m
, type
, &b
);
1845 return bus_log_parse_error(r
);
1847 r
= json_variant_new_integer(&v
, b
);
1849 return log_error_errno(r
, "Failed to transform int32: %m");
1854 case SD_BUS_TYPE_UINT32
: {
1857 r
= sd_bus_message_read_basic(m
, type
, &b
);
1859 return bus_log_parse_error(r
);
1861 r
= json_variant_new_unsigned(&v
, b
);
1863 return log_error_errno(r
, "Failed to transform uint32: %m");
1868 case SD_BUS_TYPE_INT64
: {
1871 r
= sd_bus_message_read_basic(m
, type
, &b
);
1873 return bus_log_parse_error(r
);
1875 r
= json_variant_new_integer(&v
, b
);
1877 return log_error_errno(r
, "Failed to transform int64: %m");
1882 case SD_BUS_TYPE_UINT64
: {
1885 r
= sd_bus_message_read_basic(m
, type
, &b
);
1887 return bus_log_parse_error(r
);
1889 r
= json_variant_new_unsigned(&v
, b
);
1891 return log_error_errno(r
, "Failed to transform uint64: %m");
1896 case SD_BUS_TYPE_DOUBLE
: {
1899 r
= sd_bus_message_read_basic(m
, type
, &d
);
1901 return bus_log_parse_error(r
);
1903 r
= json_variant_new_real(&v
, d
);
1905 return log_error_errno(r
, "Failed to transform double: %m");
1910 case SD_BUS_TYPE_STRING
:
1911 case SD_BUS_TYPE_OBJECT_PATH
:
1912 case SD_BUS_TYPE_SIGNATURE
: {
1915 r
= sd_bus_message_read_basic(m
, type
, &s
);
1917 return bus_log_parse_error(r
);
1919 r
= json_variant_new_string(&v
, s
);
1921 return log_error_errno(r
, "Failed to transform double: %m");
1926 case SD_BUS_TYPE_UNIX_FD
:
1927 r
= sd_bus_message_read_basic(m
, type
, NULL
);
1929 return bus_log_parse_error(r
);
1931 r
= json_variant_new_null(&v
);
1933 return log_error_errno(r
, "Failed to transform fd: %m");
1937 case SD_BUS_TYPE_ARRAY
:
1938 case SD_BUS_TYPE_VARIANT
:
1939 case SD_BUS_TYPE_STRUCT
:
1940 r
= sd_bus_message_enter_container(m
, type
, contents
);
1942 return bus_log_parse_error(r
);
1944 if (type
== SD_BUS_TYPE_VARIANT
)
1945 r
= json_transform_variant(m
, contents
, &v
);
1946 else if (type
== SD_BUS_TYPE_ARRAY
&& contents
[0] == '{')
1947 r
= json_transform_dict_array(m
, &v
);
1949 r
= json_transform_array_or_struct(m
, &v
);
1953 r
= sd_bus_message_exit_container(m
);
1955 return bus_log_parse_error(r
);
1960 assert_not_reached("Unexpected element type");
1967 static int json_transform_message(sd_bus_message
*m
, JsonVariant
**ret
) {
1968 _cleanup_(json_variant_unrefp
) JsonVariant
*v
= NULL
;
1975 assert_se(type
= sd_bus_message_get_signature(m
, false));
1977 r
= json_transform_array_or_struct(m
, &v
);
1981 r
= json_build(ret
, JSON_BUILD_OBJECT(JSON_BUILD_PAIR("type", JSON_BUILD_STRING(type
)),
1982 JSON_BUILD_PAIR("data", JSON_BUILD_VARIANT(v
))));
1989 static int call(int argc
, char **argv
, void *userdata
) {
1990 _cleanup_(sd_bus_flush_close_unrefp
) sd_bus
*bus
= NULL
;
1991 _cleanup_(sd_bus_error_free
) sd_bus_error error
= SD_BUS_ERROR_NULL
;
1992 _cleanup_(sd_bus_message_unrefp
) sd_bus_message
*m
= NULL
, *reply
= NULL
;
1995 r
= acquire_bus(false, &bus
);
1999 r
= sd_bus_message_new_method_call(bus
, &m
, argv
[1], argv
[2], argv
[3], argv
[4]);
2001 return bus_log_create_error(r
);
2003 r
= sd_bus_message_set_expect_reply(m
, arg_expect_reply
);
2005 return bus_log_create_error(r
);
2007 r
= sd_bus_message_set_auto_start(m
, arg_auto_start
);
2009 return bus_log_create_error(r
);
2011 r
= sd_bus_message_set_allow_interactive_authorization(m
, arg_allow_interactive_authorization
);
2013 return bus_log_create_error(r
);
2015 if (!isempty(argv
[5])) {
2020 r
= message_append_cmdline(m
, argv
[5], &p
);
2025 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
2026 "Too many parameters for signature.");
2029 if (!arg_expect_reply
) {
2030 r
= sd_bus_send(bus
, m
, NULL
);
2032 return log_error_errno(r
, "Failed to send message: %m");
2037 r
= sd_bus_call(bus
, m
, arg_timeout
, &error
, &reply
);
2039 return log_error_errno(r
, "Call failed: %s", bus_error_message(&error
, r
));
2041 r
= sd_bus_message_is_empty(reply
);
2043 return bus_log_parse_error(r
);
2045 if (r
== 0 && !arg_quiet
) {
2047 if (!FLAGS_SET(arg_json_format_flags
, JSON_FORMAT_OFF
)) {
2048 _cleanup_(json_variant_unrefp
) JsonVariant
*v
= NULL
;
2050 if (arg_json_format_flags
& (JSON_FORMAT_PRETTY
|JSON_FORMAT_PRETTY_AUTO
))
2051 (void) pager_open(arg_pager_flags
);
2053 r
= json_transform_message(reply
, &v
);
2057 json_variant_dump(v
, arg_json_format_flags
, NULL
, NULL
);
2059 } else if (arg_verbose
) {
2060 (void) pager_open(arg_pager_flags
);
2062 r
= sd_bus_message_dump(reply
, stdout
, 0);
2067 fputs(sd_bus_message_get_signature(reply
, true), stdout
);
2070 r
= format_cmdline(reply
, stdout
, false);
2072 return bus_log_parse_error(r
);
2074 fputc('\n', stdout
);
2081 static int emit_signal(int argc
, char **argv
, void *userdata
) {
2082 _cleanup_(sd_bus_flush_close_unrefp
) sd_bus
*bus
= NULL
;
2083 _cleanup_(sd_bus_message_unrefp
) sd_bus_message
*m
= NULL
;
2086 r
= acquire_bus(false, &bus
);
2090 r
= sd_bus_message_new_signal(bus
, &m
, argv
[1], argv
[2], argv
[3]);
2092 return bus_log_create_error(r
);
2094 if (arg_destination
) {
2095 r
= sd_bus_message_set_destination(m
, arg_destination
);
2097 return bus_log_create_error(r
);
2100 r
= sd_bus_message_set_auto_start(m
, arg_auto_start
);
2102 return bus_log_create_error(r
);
2104 if (!isempty(argv
[4])) {
2109 r
= message_append_cmdline(m
, argv
[4], &p
);
2114 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
2115 "Too many parameters for signature.");
2118 r
= sd_bus_send(bus
, m
, NULL
);
2120 return log_error_errno(r
, "Failed to send signal: %m");
2125 static int get_property(int argc
, char **argv
, void *userdata
) {
2126 _cleanup_(sd_bus_flush_close_unrefp
) sd_bus
*bus
= NULL
;
2127 _cleanup_(sd_bus_error_free
) sd_bus_error error
= SD_BUS_ERROR_NULL
;
2131 r
= acquire_bus(false, &bus
);
2135 STRV_FOREACH(i
, argv
+ 4) {
2136 _cleanup_(sd_bus_message_unrefp
) sd_bus_message
*reply
= NULL
;
2137 const char *contents
= NULL
;
2140 r
= sd_bus_call_method(bus
, argv
[1], argv
[2],
2141 "org.freedesktop.DBus.Properties", "Get",
2142 &error
, &reply
, "ss", argv
[3], *i
);
2144 return log_error_errno(r
, "Failed to get property %s on interface %s: %s",
2146 bus_error_message(&error
, r
));
2148 r
= sd_bus_message_peek_type(reply
, &type
, &contents
);
2150 return bus_log_parse_error(r
);
2152 r
= sd_bus_message_enter_container(reply
, 'v', contents
);
2154 return bus_log_parse_error(r
);
2156 if (!FLAGS_SET(arg_json_format_flags
, JSON_FORMAT_OFF
)) {
2157 _cleanup_(json_variant_unrefp
) JsonVariant
*v
= NULL
;
2159 if (arg_json_format_flags
& (JSON_FORMAT_PRETTY
|JSON_FORMAT_PRETTY_AUTO
))
2160 (void) pager_open(arg_pager_flags
);
2162 r
= json_transform_variant(reply
, contents
, &v
);
2166 json_variant_dump(v
, arg_json_format_flags
, NULL
, NULL
);
2168 } else if (arg_verbose
) {
2169 (void) pager_open(arg_pager_flags
);
2171 r
= sd_bus_message_dump(reply
, stdout
, SD_BUS_MESSAGE_DUMP_SUBTREE_ONLY
);
2175 fputs(contents
, stdout
);
2178 r
= format_cmdline(reply
, stdout
, false);
2180 return bus_log_parse_error(r
);
2182 fputc('\n', stdout
);
2185 r
= sd_bus_message_exit_container(reply
);
2187 return bus_log_parse_error(r
);
2193 static int set_property(int argc
, char **argv
, void *userdata
) {
2194 _cleanup_(sd_bus_flush_close_unrefp
) sd_bus
*bus
= NULL
;
2195 _cleanup_(sd_bus_message_unrefp
) sd_bus_message
*m
= NULL
;
2196 _cleanup_(sd_bus_error_free
) sd_bus_error error
= SD_BUS_ERROR_NULL
;
2200 r
= acquire_bus(false, &bus
);
2204 r
= sd_bus_message_new_method_call(bus
, &m
, argv
[1], argv
[2],
2205 "org.freedesktop.DBus.Properties", "Set");
2207 return bus_log_create_error(r
);
2209 r
= sd_bus_message_append(m
, "ss", argv
[3], argv
[4]);
2211 return bus_log_create_error(r
);
2213 r
= sd_bus_message_open_container(m
, 'v', argv
[5]);
2215 return bus_log_create_error(r
);
2218 r
= message_append_cmdline(m
, argv
[5], &p
);
2222 r
= sd_bus_message_close_container(m
);
2224 return bus_log_create_error(r
);
2227 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
), "Too many parameters for signature.");
2229 r
= sd_bus_call(bus
, m
, arg_timeout
, &error
, NULL
);
2231 return log_error_errno(r
, "Failed to set property %s on interface %s: %s",
2233 bus_error_message(&error
, r
));
2238 static int help(void) {
2239 _cleanup_free_
char *link
= NULL
;
2242 r
= terminal_urlify_man("busctl", "1", &link
);
2246 (void) pager_open(arg_pager_flags
);
2248 printf("%s [OPTIONS...] COMMAND ...\n\n"
2249 "%sIntrospect the D-Bus IPC bus.%s\n"
2251 " list List bus names\n"
2252 " status [SERVICE] Show bus service, process or bus owner credentials\n"
2253 " monitor [SERVICE...] Show bus traffic\n"
2254 " capture [SERVICE...] Capture bus traffic as pcap\n"
2255 " tree [SERVICE...] Show object tree of service\n"
2256 " introspect SERVICE OBJECT [INTERFACE]\n"
2257 " call SERVICE OBJECT INTERFACE METHOD [SIGNATURE [ARGUMENT...]]\n"
2259 " emit OBJECT INTERFACE SIGNAL [SIGNATURE [ARGUMENT...]]\n"
2261 " get-property SERVICE OBJECT INTERFACE PROPERTY...\n"
2262 " Get property value\n"
2263 " set-property SERVICE OBJECT INTERFACE PROPERTY SIGNATURE ARGUMENT...\n"
2264 " Set property value\n"
2265 " help Show this help\n"
2267 " -h --help Show this help\n"
2268 " --version Show package version\n"
2269 " --no-pager Do not pipe output into a pager\n"
2270 " --no-legend Do not show the headers and footers\n"
2271 " -l --full Do not ellipsize output\n"
2272 " --system Connect to system bus\n"
2273 " --user Connect to user bus\n"
2274 " -H --host=[USER@]HOST Operate on remote host\n"
2275 " -M --machine=CONTAINER Operate on local container\n"
2276 " --address=ADDRESS Connect to bus specified by address\n"
2277 " --show-machine Show machine ID column in list\n"
2278 " --unique Only show unique names\n"
2279 " --acquired Only show acquired names\n"
2280 " --activatable Only show activatable names\n"
2281 " --match=MATCH Only show matching messages\n"
2282 " --size=SIZE Maximum length of captured packet\n"
2283 " --list Don't show tree, but simple object path list\n"
2284 " -q --quiet Don't show method call reply\n"
2285 " --verbose Show result values in long format\n"
2286 " --json=MODE Output as JSON\n"
2287 " -j Same as --json=pretty on tty, --json=short otherwise\n"
2288 " --expect-reply=BOOL Expect a method call reply\n"
2289 " --auto-start=BOOL Auto-start destination service\n"
2290 " --allow-interactive-authorization=BOOL\n"
2291 " Allow interactive authorization for operation\n"
2292 " --timeout=SECS Maximum time to wait for method call completion\n"
2293 " --augment-creds=BOOL Extend credential data with data read from /proc/$PID\n"
2294 " --watch-bind=BOOL Wait for bus AF_UNIX socket to be bound in the file\n"
2296 " --destination=SERVICE Destination service of a signal\n"
2297 "\nSee the %s for details.\n",
2298 program_invocation_short_name
,
2306 static int verb_help(int argc
, char **argv
, void *userdata
) {
2310 static int parse_argv(int argc
, char *argv
[]) {
2313 ARG_VERSION
= 0x100,
2330 ARG_ALLOW_INTERACTIVE_AUTHORIZATION
,
2338 static const struct option options
[] = {
2339 { "help", no_argument
, NULL
, 'h' },
2340 { "version", no_argument
, NULL
, ARG_VERSION
},
2341 { "no-pager", no_argument
, NULL
, ARG_NO_PAGER
},
2342 { "no-legend", no_argument
, NULL
, ARG_NO_LEGEND
},
2343 { "full", no_argument
, NULL
, 'l' },
2344 { "system", no_argument
, NULL
, ARG_SYSTEM
},
2345 { "user", no_argument
, NULL
, ARG_USER
},
2346 { "address", required_argument
, NULL
, ARG_ADDRESS
},
2347 { "show-machine", no_argument
, NULL
, ARG_SHOW_MACHINE
},
2348 { "unique", no_argument
, NULL
, ARG_UNIQUE
},
2349 { "acquired", no_argument
, NULL
, ARG_ACQUIRED
},
2350 { "activatable", no_argument
, NULL
, ARG_ACTIVATABLE
},
2351 { "match", required_argument
, NULL
, ARG_MATCH
},
2352 { "host", required_argument
, NULL
, 'H' },
2353 { "machine", required_argument
, NULL
, 'M' },
2354 { "size", required_argument
, NULL
, ARG_SIZE
},
2355 { "list", no_argument
, NULL
, ARG_LIST
},
2356 { "quiet", no_argument
, NULL
, 'q' },
2357 { "verbose", no_argument
, NULL
, ARG_VERBOSE
},
2358 { "xml-interface", no_argument
, NULL
, ARG_XML_INTERFACE
},
2359 { "expect-reply", required_argument
, NULL
, ARG_EXPECT_REPLY
},
2360 { "auto-start", required_argument
, NULL
, ARG_AUTO_START
},
2361 { "allow-interactive-authorization", required_argument
, NULL
, ARG_ALLOW_INTERACTIVE_AUTHORIZATION
},
2362 { "timeout", required_argument
, NULL
, ARG_TIMEOUT
},
2363 { "augment-creds", required_argument
, NULL
, ARG_AUGMENT_CREDS
},
2364 { "watch-bind", required_argument
, NULL
, ARG_WATCH_BIND
},
2365 { "json", required_argument
, NULL
, ARG_JSON
},
2366 { "destination", required_argument
, NULL
, ARG_DESTINATION
},
2375 while ((c
= getopt_long(argc
, argv
, "hH:M:qjl", options
, NULL
)) >= 0)
2386 arg_pager_flags
|= PAGER_DISABLE
;
2406 arg_address
= optarg
;
2409 case ARG_SHOW_MACHINE
:
2410 arg_show_machine
= true;
2418 arg_acquired
= true;
2421 case ARG_ACTIVATABLE
:
2422 arg_activatable
= true;
2426 if (strv_extend(&arg_matches
, optarg
) < 0)
2433 r
= parse_size(optarg
, 1024, &sz
);
2435 return log_error_errno(r
, "Failed to parse size '%s': %m", optarg
);
2437 if ((uint64_t) (size_t) sz
!= sz
)
2438 return log_error_errno(SYNTHETIC_ERRNO(E2BIG
),
2439 "Size out of range.");
2441 arg_snaplen
= (size_t) sz
;
2450 arg_transport
= BUS_TRANSPORT_REMOTE
;
2455 arg_transport
= BUS_TRANSPORT_MACHINE
;
2467 case ARG_XML_INTERFACE
:
2468 arg_xml_interface
= true;
2471 case ARG_EXPECT_REPLY
:
2472 r
= parse_boolean_argument("--expect-reply=", optarg
, &arg_expect_reply
);
2477 case ARG_AUTO_START
:
2478 r
= parse_boolean_argument("--auto-start=", optarg
, &arg_auto_start
);
2483 case ARG_ALLOW_INTERACTIVE_AUTHORIZATION
:
2484 r
= parse_boolean_argument("--allow-interactive-authorization=", optarg
,
2485 &arg_allow_interactive_authorization
);
2491 r
= parse_sec(optarg
, &arg_timeout
);
2493 return log_error_errno(r
, "Failed to parse --timeout= parameter '%s': %m", optarg
);
2497 case ARG_AUGMENT_CREDS
:
2498 r
= parse_boolean_argument("--augment-creds=", optarg
, &arg_augment_creds
);
2503 case ARG_WATCH_BIND
:
2504 r
= parse_boolean_argument("--watch-bind=", optarg
, &arg_watch_bind
);
2510 arg_json_format_flags
= JSON_FORMAT_PRETTY_AUTO
|JSON_FORMAT_COLOR_AUTO
;
2514 r
= parse_json_argument(optarg
, &arg_json_format_flags
);
2520 case ARG_DESTINATION
:
2521 arg_destination
= optarg
;
2528 assert_not_reached("Unhandled option");
2534 static int busctl_main(int argc
, char *argv
[]) {
2535 static const Verb verbs
[] = {
2536 { "list", VERB_ANY
, 1, VERB_DEFAULT
, list_bus_names
},
2537 { "status", VERB_ANY
, 2, 0, status
},
2538 { "monitor", VERB_ANY
, VERB_ANY
, 0, verb_monitor
},
2539 { "capture", VERB_ANY
, VERB_ANY
, 0, verb_capture
},
2540 { "tree", VERB_ANY
, VERB_ANY
, 0, tree
},
2541 { "introspect", 3, 4, 0, introspect
},
2542 { "call", 5, VERB_ANY
, 0, call
},
2543 { "emit", 4, VERB_ANY
, 0, emit_signal
},
2544 { "get-property", 5, VERB_ANY
, 0, get_property
},
2545 { "set-property", 6, VERB_ANY
, 0, set_property
},
2546 { "help", VERB_ANY
, VERB_ANY
, 0, verb_help
},
2550 return dispatch_verb(argc
, argv
, verbs
, NULL
);
2553 static int run(int argc
, char *argv
[]) {
2558 r
= parse_argv(argc
, argv
);
2562 return busctl_main(argc
, argv
);
2565 DEFINE_MAIN_FUNCTION(run
);