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"
19 #include "glyph-util.h"
22 #include "main-func.h"
25 #include "parse-argument.h"
26 #include "parse-util.h"
27 #include "path-util.h"
28 #include "pretty-print.h"
30 #include "sort-util.h"
32 #include "terminal-util.h"
33 #include "user-util.h"
37 static JsonFormatFlags arg_json_format_flags
= JSON_FORMAT_OFF
;
38 static PagerFlags arg_pager_flags
= 0;
39 static bool arg_legend
= true;
40 static bool arg_full
= false;
41 static const char *arg_address
= NULL
;
42 static bool arg_unique
= false;
43 static bool arg_acquired
= false;
44 static bool arg_activatable
= false;
45 static bool arg_show_machine
= false;
46 static char **arg_matches
= NULL
;
47 static BusTransport arg_transport
= BUS_TRANSPORT_LOCAL
;
48 static const char *arg_host
= NULL
;
49 static bool arg_user
= false;
50 static size_t arg_snaplen
= 4096;
51 static bool arg_list
= false;
52 static bool arg_quiet
= false;
53 static bool arg_verbose
= false;
54 static bool arg_xml_interface
= false;
55 static bool arg_expect_reply
= true;
56 static bool arg_auto_start
= true;
57 static bool arg_allow_interactive_authorization
= true;
58 static bool arg_augment_creds
= true;
59 static bool arg_watch_bind
= false;
60 static usec_t arg_timeout
= 0;
61 static const char *arg_destination
= NULL
;
63 STATIC_DESTRUCTOR_REGISTER(arg_matches
, strv_freep
);
65 #define NAME_IS_ACQUIRED INT_TO_PTR(1)
66 #define NAME_IS_ACTIVATABLE INT_TO_PTR(2)
68 static int json_transform_message(sd_bus_message
*m
, JsonVariant
**ret
);
70 static int acquire_bus(bool set_monitor
, sd_bus
**ret
) {
71 _cleanup_(sd_bus_close_unrefp
) sd_bus
*bus
= NULL
;
76 return log_error_errno(r
, "Failed to allocate bus: %m");
79 r
= sd_bus_set_monitor(bus
, true);
81 return log_error_errno(r
, "Failed to set monitor mode: %m");
83 r
= sd_bus_negotiate_creds(bus
, true, _SD_BUS_CREDS_ALL
);
85 return log_error_errno(r
, "Failed to enable credentials: %m");
87 r
= sd_bus_negotiate_timestamp(bus
, true);
89 return log_error_errno(r
, "Failed to enable timestamps: %m");
91 r
= sd_bus_negotiate_fds(bus
, true);
93 return log_error_errno(r
, "Failed to enable fds: %m");
96 r
= sd_bus_set_bus_client(bus
, true);
98 return log_error_errno(r
, "Failed to set bus client: %m");
100 r
= sd_bus_set_watch_bind(bus
, arg_watch_bind
);
102 return log_error_errno(r
, "Failed to set watch-bind setting to '%s': %m",
103 yes_no(arg_watch_bind
));
106 r
= sd_bus_set_address(bus
, arg_address
);
108 switch (arg_transport
) {
110 case BUS_TRANSPORT_LOCAL
:
112 r
= bus_set_address_user(bus
);
114 r
= bus_set_address_system(bus
);
117 case BUS_TRANSPORT_REMOTE
:
118 r
= bus_set_address_system_remote(bus
, arg_host
);
121 case BUS_TRANSPORT_MACHINE
:
122 r
= bus_set_address_machine(bus
, arg_user
, arg_host
);
126 assert_not_reached();
130 return bus_log_address_error(r
, arg_transport
);
132 r
= sd_bus_start(bus
);
134 return bus_log_connect_error(r
, arg_transport
);
136 *ret
= TAKE_PTR(bus
);
141 static int list_bus_names(int argc
, char **argv
, void *userdata
) {
142 _cleanup_strv_free_
char **acquired
= NULL
, **activatable
= NULL
;
143 _cleanup_(sd_bus_flush_close_unrefp
) sd_bus
*bus
= NULL
;
144 _cleanup_hashmap_free_ Hashmap
*names
= NULL
;
145 _cleanup_(table_unrefp
) Table
*table
= NULL
;
163 if (!arg_unique
&& !arg_acquired
&& !arg_activatable
)
164 arg_unique
= arg_acquired
= arg_activatable
= true;
166 r
= acquire_bus(false, &bus
);
170 r
= sd_bus_list_names(bus
,
171 (arg_acquired
|| arg_unique
) ? &acquired
: NULL
,
172 arg_activatable
? &activatable
: NULL
);
174 return log_error_errno(r
, "Failed to list names: %m");
176 names
= hashmap_new(&string_hash_ops
);
180 STRV_FOREACH(i
, acquired
) {
181 r
= hashmap_put(names
, *i
, NAME_IS_ACQUIRED
);
183 return log_error_errno(r
, "Failed to add to hashmap: %m");
186 STRV_FOREACH(i
, activatable
) {
187 r
= hashmap_put(names
, *i
, NAME_IS_ACTIVATABLE
);
188 if (r
< 0 && r
!= -EEXIST
)
189 return log_error_errno(r
, "Failed to add to hashmap: %m");
192 table
= table_new("activatable",
206 table_set_width(table
, 0);
208 r
= table_set_align_percent(table
, table_get_cell(table
, 0, COLUMN_PID
), 100);
210 return log_error_errno(r
, "Failed to set alignment: %m");
212 r
= table_set_empty_string(table
, "-");
214 return log_error_errno(r
, "Failed to set empty string: %m");
216 r
= table_set_sort(table
, (size_t) COLUMN_NAME
);
218 return log_error_errno(r
, "Failed to set sort column: %m");
220 if (arg_show_machine
)
221 r
= table_set_display(table
, (size_t) COLUMN_NAME
,
223 (size_t) COLUMN_PROCESS
,
224 (size_t) COLUMN_USER
,
225 (size_t) COLUMN_CONNECTION
,
226 (size_t) COLUMN_UNIT
,
227 (size_t) COLUMN_SESSION
,
228 (size_t) COLUMN_DESCRIPTION
,
229 (size_t) COLUMN_MACHINE
);
231 r
= table_set_display(table
, (size_t) COLUMN_NAME
,
233 (size_t) COLUMN_PROCESS
,
234 (size_t) COLUMN_USER
,
235 (size_t) COLUMN_CONNECTION
,
236 (size_t) COLUMN_UNIT
,
237 (size_t) COLUMN_SESSION
,
238 (size_t) COLUMN_DESCRIPTION
);
241 return log_error_errno(r
, "Failed to set columns to display: %m");
243 HASHMAP_FOREACH_KEY(v
, k
, names
) {
244 _cleanup_(sd_bus_creds_unrefp
) sd_bus_creds
*creds
= NULL
;
246 if (v
== NAME_IS_ACTIVATABLE
) {
249 TABLE_INT
, PTR_TO_INT(v
),
254 TABLE_STRING
, "(activatable)", TABLE_SET_COLOR
, ansi_grey(),
260 return table_log_add_error(r
);
265 assert(v
== NAME_IS_ACQUIRED
);
267 if (!arg_unique
&& k
[0] == ':')
270 if (!arg_acquired
&& k
[0] != ':')
273 r
= table_add_many(table
,
274 TABLE_INT
, PTR_TO_INT(v
),
277 return table_log_add_error(r
);
279 r
= sd_bus_get_name_creds(
281 (arg_augment_creds
? SD_BUS_CREDS_AUGMENT
: 0) |
282 SD_BUS_CREDS_EUID
|SD_BUS_CREDS_PID
|SD_BUS_CREDS_COMM
|
283 SD_BUS_CREDS_UNIQUE_NAME
|SD_BUS_CREDS_UNIT
|SD_BUS_CREDS_SESSION
|
284 SD_BUS_CREDS_DESCRIPTION
, &creds
);
286 log_debug_errno(r
, "Failed to acquire credentials of service %s, ignoring: %m", k
);
288 r
= table_fill_empty(table
, COLUMN_MACHINE
);
290 const char *unique
= NULL
, *session
= NULL
, *unit
= NULL
, *cn
= NULL
;
294 r
= sd_bus_creds_get_pid(creds
, &pid
);
296 const char *comm
= NULL
;
298 (void) sd_bus_creds_get_comm(creds
, &comm
);
300 r
= table_add_many(table
,
302 TABLE_STRING
, strna(comm
));
304 r
= table_add_many(table
, TABLE_EMPTY
, TABLE_EMPTY
);
306 return table_log_add_error(r
);
308 r
= sd_bus_creds_get_euid(creds
, &uid
);
310 _cleanup_free_
char *u
= NULL
;
312 u
= uid_to_name(uid
);
316 r
= table_add_cell(table
, NULL
, TABLE_STRING
, u
);
318 r
= table_add_cell(table
, NULL
, TABLE_EMPTY
, NULL
);
320 return table_log_add_error(r
);
322 (void) sd_bus_creds_get_unique_name(creds
, &unique
);
323 (void) sd_bus_creds_get_unit(creds
, &unit
);
324 (void) sd_bus_creds_get_session(creds
, &session
);
325 (void) sd_bus_creds_get_description(creds
, &cn
);
329 TABLE_STRING
, unique
,
331 TABLE_STRING
, session
,
335 return table_log_add_error(r
);
337 if (arg_show_machine
) {
340 r
= sd_bus_get_name_machine_id(bus
, k
, &mid
);
342 log_debug_errno(r
, "Failed to acquire credentials of service %s, ignoring: %m", k
);
344 r
= table_add_cell(table
, NULL
, TABLE_ID128
, &mid
);
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
, "/");
470 _cleanup_free_
char *p
= NULL
;
473 p
= set_steal_first(paths
);
477 if (set_contains(done
, p
) ||
478 set_contains(failed
, p
))
481 q
= find_nodes(bus
, service
, p
, paths
);
485 q
= set_ensure_consume(q
< 0 ? &failed
: &done
, &string_hash_ops_free
, TAKE_PTR(p
));
491 pager_open(arg_pager_flags
);
493 l
= set_get_strv(done
);
505 static int tree(int argc
, char **argv
, void *userdata
) {
506 _cleanup_(sd_bus_flush_close_unrefp
) sd_bus
*bus
= NULL
;
510 /* Do superficial verification of arguments before even opening the bus */
511 STRV_FOREACH(i
, strv_skip(argv
, 1))
512 if (!sd_bus_service_name_is_valid(*i
))
513 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
514 "Invalid bus service name: %s", *i
);
516 if (!arg_unique
&& !arg_acquired
)
519 r
= acquire_bus(false, &bus
);
524 _cleanup_strv_free_
char **names
= NULL
;
525 bool not_first
= false;
527 r
= sd_bus_list_names(bus
, &names
, NULL
);
529 return log_error_errno(r
, "Failed to get name list: %m");
531 pager_open(arg_pager_flags
);
533 STRV_FOREACH(i
, names
) {
536 if (!arg_unique
&& (*i
)[0] == ':')
539 if (!arg_acquired
&& (*i
)[0] == ':')
545 printf("Service %s%s%s:\n", ansi_highlight(), *i
, ansi_normal());
547 q
= tree_one(bus
, *i
);
554 STRV_FOREACH(i
, strv_skip(argv
, 1)) {
561 pager_open(arg_pager_flags
);
562 printf("Service %s%s%s:\n", ansi_highlight(), *i
, ansi_normal());
565 q
= tree_one(bus
, *i
);
573 static int format_cmdline(sd_bus_message
*m
, FILE *f
, bool needs_space
) {
577 const char *contents
= NULL
;
592 r
= sd_bus_message_peek_type(m
, &type
, &contents
);
598 if (bus_type_is_container(type
) > 0) {
600 r
= sd_bus_message_enter_container(m
, type
, contents
);
604 if (type
== SD_BUS_TYPE_ARRAY
) {
607 /* count array entries */
610 r
= sd_bus_message_skip(m
, contents
);
619 r
= sd_bus_message_rewind(m
, false);
629 } else if (type
== SD_BUS_TYPE_VARIANT
) {
634 fprintf(f
, "%s", contents
);
638 r
= format_cmdline(m
, f
, needs_space
);
644 r
= sd_bus_message_exit_container(m
);
651 r
= sd_bus_message_read_basic(m
, type
, &basic
);
659 case SD_BUS_TYPE_BYTE
:
660 fprintf(f
, "%u", basic
.u8
);
663 case SD_BUS_TYPE_BOOLEAN
:
664 fputs(true_false(basic
.i
), f
);
667 case SD_BUS_TYPE_INT16
:
668 fprintf(f
, "%i", basic
.s16
);
671 case SD_BUS_TYPE_UINT16
:
672 fprintf(f
, "%u", basic
.u16
);
675 case SD_BUS_TYPE_INT32
:
676 fprintf(f
, "%i", basic
.s32
);
679 case SD_BUS_TYPE_UINT32
:
680 fprintf(f
, "%u", basic
.u32
);
683 case SD_BUS_TYPE_INT64
:
684 fprintf(f
, "%" PRIi64
, basic
.s64
);
687 case SD_BUS_TYPE_UINT64
:
688 fprintf(f
, "%" PRIu64
, basic
.u64
);
691 case SD_BUS_TYPE_DOUBLE
:
692 fprintf(f
, "%g", basic
.d64
);
695 case SD_BUS_TYPE_STRING
:
696 case SD_BUS_TYPE_OBJECT_PATH
:
697 case SD_BUS_TYPE_SIGNATURE
: {
698 _cleanup_free_
char *b
= NULL
;
700 b
= cescape(basic
.string
);
704 fprintf(f
, "\"%s\"", b
);
708 case SD_BUS_TYPE_UNIX_FD
:
709 fprintf(f
, "%i", basic
.i
);
713 assert_not_reached();
720 typedef struct Member
{
731 static void member_hash_func(const Member
*m
, struct siphash
*state
) {
737 string_hash_func(m
->type
, state
);
739 arity
+= !!m
->name
+ !!m
->interface
;
741 uint64_hash_func(&arity
, state
);
744 string_hash_func(m
->name
, state
);
747 string_hash_func(m
->interface
, state
);
750 static int member_compare_func(const Member
*x
, const Member
*y
) {
758 d
= strcmp_ptr(x
->interface
, y
->interface
);
762 d
= strcmp(x
->type
, y
->type
);
766 return strcmp_ptr(x
->name
, y
->name
);
769 static int member_compare_funcp(Member
* const *a
, Member
* const *b
) {
770 return member_compare_func(*a
, *b
);
773 static Member
* member_free(Member
*m
) {
784 DEFINE_TRIVIAL_CLEANUP_FUNC(Member
*, member_free
);
786 static Set
* member_set_free(Set
*s
) {
787 return set_free_with_destructor(s
, member_free
);
789 DEFINE_TRIVIAL_CLEANUP_FUNC(Set
*, member_set_free
);
791 static int on_interface(const char *interface
, uint64_t flags
, void *userdata
) {
792 _cleanup_(member_freep
) Member
*m
= NULL
;
793 Set
*members
= userdata
;
808 r
= free_and_strdup(&m
->interface
, interface
);
812 r
= set_put(members
, m
);
814 return log_error_errno(r
, "Invalid introspection data: duplicate interface '%s'.", interface
);
822 static int on_method(const char *interface
, const char *name
, const char *signature
, const char *result
, uint64_t flags
, void *userdata
) {
823 _cleanup_(member_freep
) Member
*m
= NULL
;
824 Set
*members
= userdata
;
839 r
= free_and_strdup(&m
->interface
, interface
);
843 r
= free_and_strdup(&m
->name
, name
);
847 r
= free_and_strdup(&m
->signature
, signature
);
851 r
= free_and_strdup(&m
->result
, result
);
855 r
= set_put(members
, m
);
857 return log_error_errno(r
, "Invalid introspection data: duplicate method '%s' on interface '%s'.", name
, interface
);
865 static int on_signal(const char *interface
, const char *name
, const char *signature
, uint64_t flags
, void *userdata
) {
866 _cleanup_(member_freep
) Member
*m
= NULL
;
867 Set
*members
= userdata
;
882 r
= free_and_strdup(&m
->interface
, interface
);
886 r
= free_and_strdup(&m
->name
, name
);
890 r
= free_and_strdup(&m
->signature
, signature
);
894 r
= set_put(members
, m
);
896 return log_error_errno(r
, "Invalid introspection data: duplicate signal '%s' on interface '%s'.", name
, interface
);
904 static int on_property(const char *interface
, const char *name
, const char *signature
, bool writable
, uint64_t flags
, void *userdata
) {
905 _cleanup_(member_freep
) Member
*m
= NULL
;
906 Set
*members
= userdata
;
919 .writable
= writable
,
922 r
= free_and_strdup(&m
->interface
, interface
);
926 r
= free_and_strdup(&m
->name
, name
);
930 r
= free_and_strdup(&m
->signature
, signature
);
934 r
= set_put(members
, m
);
936 return log_error_errno(r
, "Invalid introspection data: duplicate property '%s' on interface '%s'.", name
, interface
);
944 DEFINE_PRIVATE_HASH_OPS(member_hash_ops
, Member
, member_hash_func
, member_compare_func
);
946 static int introspect(int argc
, char **argv
, void *userdata
) {
947 static const XMLIntrospectOps ops
= {
948 .on_interface
= on_interface
,
949 .on_method
= on_method
,
950 .on_signal
= on_signal
,
951 .on_property
= on_property
,
954 _cleanup_(sd_bus_flush_close_unrefp
) sd_bus
*bus
= NULL
;
955 _cleanup_(sd_bus_message_unrefp
) sd_bus_message
*reply_xml
= NULL
;
956 _cleanup_(sd_bus_error_free
) sd_bus_error error
= SD_BUS_ERROR_NULL
;
957 _cleanup_(member_set_freep
) Set
*members
= NULL
;
958 unsigned name_width
, type_width
, signature_width
, result_width
, j
, k
= 0;
959 Member
*m
, **sorted
= NULL
;
963 r
= acquire_bus(false, &bus
);
967 members
= set_new(&member_hash_ops
);
971 r
= sd_bus_call_method(bus
, argv
[1], argv
[2],
972 "org.freedesktop.DBus.Introspectable", "Introspect",
973 &error
, &reply_xml
, NULL
);
975 return log_error_errno(r
, "Failed to introspect object %s of service %s: %s",
976 argv
[2], argv
[1], bus_error_message(&error
, r
));
978 r
= sd_bus_message_read(reply_xml
, "s", &xml
);
980 return bus_log_parse_error(r
);
982 if (arg_xml_interface
) {
983 /* Just dump the received XML and finish */
984 pager_open(arg_pager_flags
);
989 /* First, get list of all properties */
990 r
= parse_xml_introspect(argv
[2], xml
, &ops
, members
);
994 /* Second, find the current values for them */
995 SET_FOREACH(m
, members
) {
996 _cleanup_(sd_bus_message_unrefp
) sd_bus_message
*reply
= NULL
;
998 if (!streq(m
->type
, "property"))
1004 if (argv
[3] && !streq(argv
[3], m
->interface
))
1007 r
= sd_bus_call_method(bus
, argv
[1], argv
[2],
1008 "org.freedesktop.DBus.Properties", "GetAll",
1009 &error
, &reply
, "s", m
->interface
);
1011 return log_error_errno(r
, "Failed to get all properties on interface %s: %s",
1012 m
->interface
, bus_error_message(&error
, r
));
1014 r
= sd_bus_message_enter_container(reply
, 'a', "{sv}");
1016 return bus_log_parse_error(r
);
1020 _cleanup_free_
char *buf
= NULL
;
1021 _cleanup_fclose_
FILE *mf
= NULL
;
1025 r
= sd_bus_message_enter_container(reply
, 'e', "sv");
1027 return bus_log_parse_error(r
);
1032 r
= sd_bus_message_read(reply
, "s", &name
);
1034 return bus_log_parse_error(r
);
1036 r
= sd_bus_message_enter_container(reply
, 'v', NULL
);
1038 return bus_log_parse_error(r
);
1040 mf
= open_memstream_unlocked(&buf
, &sz
);
1044 r
= format_cmdline(reply
, mf
, false);
1046 return bus_log_parse_error(r
);
1048 mf
= safe_fclose(mf
);
1050 z
= set_get(members
, &((Member
) {
1052 .interface
= m
->interface
,
1053 .name
= (char*) name
}));
1055 free_and_replace(z
->value
, buf
);
1057 r
= sd_bus_message_exit_container(reply
);
1059 return bus_log_parse_error(r
);
1061 r
= sd_bus_message_exit_container(reply
);
1063 return bus_log_parse_error(r
);
1066 r
= sd_bus_message_exit_container(reply
);
1068 return bus_log_parse_error(r
);
1071 name_width
= strlen("NAME");
1072 type_width
= strlen("TYPE");
1073 signature_width
= strlen("SIGNATURE");
1074 result_width
= strlen("RESULT/VALUE");
1076 sorted
= newa(Member
*, set_size(members
));
1078 SET_FOREACH(m
, members
) {
1079 if (argv
[3] && !streq(argv
[3], m
->interface
))
1083 name_width
= MAX(name_width
, strlen(m
->interface
));
1085 name_width
= MAX(name_width
, strlen(m
->name
) + 1);
1087 type_width
= MAX(type_width
, strlen(m
->type
));
1089 signature_width
= MAX(signature_width
, strlen(m
->signature
));
1091 result_width
= MAX(result_width
, strlen(m
->result
));
1093 result_width
= MAX(result_width
, strlen(m
->value
));
1098 if (result_width
> 40)
1101 typesafe_qsort(sorted
, k
, member_compare_funcp
);
1103 pager_open(arg_pager_flags
);
1106 printf("%-*s %-*s %-*s %-*s %s\n",
1107 (int) name_width
, "NAME",
1108 (int) type_width
, "TYPE",
1109 (int) signature_width
, "SIGNATURE",
1110 (int) result_width
, "RESULT/VALUE",
1113 for (j
= 0; j
< k
; j
++) {
1114 _cleanup_free_
char *ellipsized
= NULL
;
1120 if (argv
[3] && !streq(argv
[3], m
->interface
))
1123 is_interface
= streq(m
->type
, "interface");
1125 if (argv
[3] && is_interface
)
1129 ellipsized
= ellipsize(m
->value
, result_width
, 100);
1135 rv
= empty_to_dash(m
->result
);
1137 printf("%s%s%-*s%s %-*s %-*s %-*s%s%s%s%s%s%s\n",
1138 is_interface
? ansi_highlight() : "",
1139 is_interface
? "" : ".",
1140 - !is_interface
+ (int) name_width
,
1141 empty_to_dash(streq_ptr(m
->type
, "interface") ? m
->interface
: m
->name
),
1142 is_interface
? ansi_normal() : "",
1143 (int) type_width
, empty_to_dash(m
->type
),
1144 (int) signature_width
, empty_to_dash(m
->signature
),
1145 (int) result_width
, rv
,
1146 (m
->flags
& SD_BUS_VTABLE_DEPRECATED
) ? " deprecated" : (m
->flags
|| m
->writable
? "" : " -"),
1147 (m
->flags
& SD_BUS_VTABLE_METHOD_NO_REPLY
) ? " no-reply" : "",
1148 (m
->flags
& SD_BUS_VTABLE_PROPERTY_CONST
) ? " const" : "",
1149 (m
->flags
& SD_BUS_VTABLE_PROPERTY_EMITS_CHANGE
) ? " emits-change" : "",
1150 (m
->flags
& SD_BUS_VTABLE_PROPERTY_EMITS_INVALIDATION
) ? " emits-invalidation" : "",
1151 m
->writable
? " writable" : "");
1157 static int message_dump(sd_bus_message
*m
, FILE *f
) {
1158 return sd_bus_message_dump(m
, f
, SD_BUS_MESSAGE_DUMP_WITH_HEADER
);
1161 static int message_pcap(sd_bus_message
*m
, FILE *f
) {
1162 return bus_message_pcap_frame(m
, arg_snaplen
, f
);
1165 static int message_json(sd_bus_message
*m
, FILE *f
) {
1166 _cleanup_(json_variant_unrefp
) JsonVariant
*v
= NULL
, *w
= NULL
;
1171 r
= json_transform_message(m
, &v
);
1175 e
[0] = m
->header
->endian
;
1180 ts
= now(CLOCK_REALTIME
);
1182 r
= json_build(&w
, JSON_BUILD_OBJECT(
1183 JSON_BUILD_PAIR("type", JSON_BUILD_STRING(bus_message_type_to_string(m
->header
->type
))),
1184 JSON_BUILD_PAIR("endian", JSON_BUILD_STRING(e
)),
1185 JSON_BUILD_PAIR("flags", JSON_BUILD_INTEGER(m
->header
->flags
)),
1186 JSON_BUILD_PAIR("version", JSON_BUILD_INTEGER(m
->header
->version
)),
1187 JSON_BUILD_PAIR("cookie", JSON_BUILD_INTEGER(BUS_MESSAGE_COOKIE(m
))),
1188 JSON_BUILD_PAIR_CONDITION(m
->reply_cookie
!= 0, "reply_cookie", JSON_BUILD_INTEGER(m
->reply_cookie
)),
1189 JSON_BUILD_PAIR("timestamp-realtime", JSON_BUILD_UNSIGNED(ts
)),
1190 JSON_BUILD_PAIR_CONDITION(m
->sender
, "sender", JSON_BUILD_STRING(m
->sender
)),
1191 JSON_BUILD_PAIR_CONDITION(m
->destination
, "destination", JSON_BUILD_STRING(m
->destination
)),
1192 JSON_BUILD_PAIR_CONDITION(m
->path
, "path", JSON_BUILD_STRING(m
->path
)),
1193 JSON_BUILD_PAIR_CONDITION(m
->interface
, "interface", JSON_BUILD_STRING(m
->interface
)),
1194 JSON_BUILD_PAIR_CONDITION(m
->member
, "member", JSON_BUILD_STRING(m
->member
)),
1195 JSON_BUILD_PAIR_CONDITION(m
->monotonic
!= 0, "monotonic", JSON_BUILD_INTEGER(m
->monotonic
)),
1196 JSON_BUILD_PAIR_CONDITION(m
->realtime
!= 0, "realtime", JSON_BUILD_INTEGER(m
->realtime
)),
1197 JSON_BUILD_PAIR_CONDITION(m
->seqnum
!= 0, "seqnum", JSON_BUILD_INTEGER(m
->seqnum
)),
1198 JSON_BUILD_PAIR_CONDITION(m
->error
.name
, "error_name", JSON_BUILD_STRING(m
->error
.name
)),
1199 JSON_BUILD_PAIR("payload", JSON_BUILD_VARIANT(v
))));
1201 return log_error_errno(r
, "Failed to build JSON object: %m");
1203 json_variant_dump(w
, arg_json_format_flags
, f
, NULL
);
1207 static int monitor(int argc
, char **argv
, int (*dump
)(sd_bus_message
*m
, FILE *f
)) {
1208 _cleanup_(sd_bus_flush_close_unrefp
) sd_bus
*bus
= NULL
;
1209 _cleanup_(sd_bus_message_unrefp
) sd_bus_message
*message
= NULL
;
1210 _cleanup_(sd_bus_error_free
) sd_bus_error error
= SD_BUS_ERROR_NULL
;
1213 const char *unique_name
;
1214 bool is_monitor
= false;
1217 r
= acquire_bus(true, &bus
);
1221 /* upgrade connection; it's not used for anything else after this call */
1222 r
= sd_bus_message_new_method_call(bus
,
1224 "org.freedesktop.DBus",
1225 "/org/freedesktop/DBus",
1226 "org.freedesktop.DBus.Monitoring",
1229 return bus_log_create_error(r
);
1231 r
= sd_bus_message_open_container(message
, 'a', "s");
1233 return bus_log_create_error(r
);
1235 STRV_FOREACH(i
, argv
+1) {
1236 _cleanup_free_
char *m
= NULL
;
1238 if (!sd_bus_service_name_is_valid(*i
))
1239 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
), "Invalid service name '%s'", *i
);
1241 m
= strjoin("sender='", *i
, "'");
1245 r
= sd_bus_message_append_basic(message
, 's', m
);
1247 return bus_log_create_error(r
);
1250 m
= strjoin("destination='", *i
, "'");
1254 r
= sd_bus_message_append_basic(message
, 's', m
);
1256 return bus_log_create_error(r
);
1259 STRV_FOREACH(i
, arg_matches
) {
1260 r
= sd_bus_message_append_basic(message
, 's', *i
);
1262 return bus_log_create_error(r
);
1265 r
= sd_bus_message_close_container(message
);
1267 return bus_log_create_error(r
);
1269 r
= sd_bus_message_append_basic(message
, 'u', &flags
);
1271 return bus_log_create_error(r
);
1273 r
= sd_bus_call(bus
, message
, arg_timeout
, &error
, NULL
);
1275 return log_error_errno(r
, "Call to org.freedesktop.DBus.Monitoring.BecomeMonitor failed: %s",
1276 bus_error_message(&error
, r
));
1278 r
= sd_bus_get_unique_name(bus
, &unique_name
);
1280 return log_error_errno(r
, "Failed to get unique name: %m");
1282 log_info("Monitoring bus message stream.");
1285 _cleanup_(sd_bus_message_unrefp
) sd_bus_message
*m
= NULL
;
1287 r
= sd_bus_process(bus
, &m
);
1289 return log_error_errno(r
, "Failed to process bus: %m");
1294 /* wait until we lose our unique name */
1295 if (sd_bus_message_is_signal(m
, "org.freedesktop.DBus", "NameLost") <= 0)
1298 r
= sd_bus_message_read(m
, "s", &name
);
1300 return bus_log_parse_error(r
);
1302 if (streq(name
, unique_name
))
1312 if (sd_bus_message_is_signal(m
, "org.freedesktop.DBus.Local", "Disconnected") > 0) {
1313 log_info("Connection terminated, exiting.");
1323 r
= sd_bus_wait(bus
, UINT64_MAX
);
1325 return log_error_errno(r
, "Failed to wait for bus: %m");
1329 static int verb_monitor(int argc
, char **argv
, void *userdata
) {
1330 return monitor(argc
, argv
, (arg_json_format_flags
& JSON_FORMAT_OFF
) ? message_dump
: message_json
);
1333 static int verb_capture(int argc
, char **argv
, void *userdata
) {
1334 _cleanup_free_
char *osname
= NULL
;
1335 static const char info
[] =
1336 "busctl (systemd) " STRINGIFY(PROJECT_VERSION
) " (Git " GIT_VERSION
")";
1339 if (isatty(fileno(stdout
)) > 0)
1340 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
1341 "Refusing to write message data to console, please redirect output to a file.");
1343 r
= parse_os_release(NULL
, "PRETTY_NAME", &osname
);
1345 log_full_errno(r
== -ENOENT
? LOG_DEBUG
: LOG_INFO
, r
,
1346 "Failed to read os-release file, ignoring: %m");
1347 bus_pcap_header(arg_snaplen
, osname
, info
, stdout
);
1349 r
= monitor(argc
, argv
, message_pcap
);
1353 r
= fflush_and_check(stdout
);
1355 return log_error_errno(r
, "Couldn't write capture file: %m");
1360 static int status(int argc
, char **argv
, void *userdata
) {
1361 _cleanup_(sd_bus_flush_close_unrefp
) sd_bus
*bus
= NULL
;
1362 _cleanup_(sd_bus_creds_unrefp
) sd_bus_creds
*creds
= NULL
;
1366 r
= acquire_bus(false, &bus
);
1370 pager_open(arg_pager_flags
);
1372 if (!isempty(argv
[1])) {
1373 r
= parse_pid(argv
[1], &pid
);
1375 r
= sd_bus_get_name_creds(
1378 (arg_augment_creds
? SD_BUS_CREDS_AUGMENT
: 0) | _SD_BUS_CREDS_ALL
,
1381 r
= sd_bus_creds_new_from_pid(
1386 const char *scope
, *address
;
1389 r
= sd_bus_get_address(bus
, &address
);
1391 printf("BusAddress=%s%s%s\n", ansi_highlight(), address
, ansi_normal());
1393 r
= sd_bus_get_scope(bus
, &scope
);
1395 printf("BusScope=%s%s%s\n", ansi_highlight(), scope
, ansi_normal());
1397 r
= sd_bus_get_bus_id(bus
, &bus_id
);
1399 printf("BusID=%s" SD_ID128_FORMAT_STR
"%s\n",
1400 ansi_highlight(), SD_ID128_FORMAT_VAL(bus_id
), ansi_normal());
1402 r
= sd_bus_get_owner_creds(
1404 (arg_augment_creds
? SD_BUS_CREDS_AUGMENT
: 0) | _SD_BUS_CREDS_ALL
,
1409 return log_error_errno(r
, "Failed to get credentials: %m");
1411 bus_creds_dump(creds
, NULL
, false);
1415 static int message_append_cmdline(sd_bus_message
*m
, const char *signature
, char ***x
) {
1435 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
1436 "Too few parameters for signature.");
1443 case SD_BUS_TYPE_BOOLEAN
:
1445 r
= parse_boolean(v
);
1447 return log_error_errno(r
, "Failed to parse '%s' as boolean: %m", v
);
1449 r
= sd_bus_message_append_basic(m
, t
, &r
);
1452 case SD_BUS_TYPE_BYTE
: {
1455 r
= safe_atou8(v
, &z
);
1457 return log_error_errno(r
, "Failed to parse '%s' as byte (unsigned 8bit integer): %m", v
);
1459 r
= sd_bus_message_append_basic(m
, t
, &z
);
1463 case SD_BUS_TYPE_INT16
: {
1466 r
= safe_atoi16(v
, &z
);
1468 return log_error_errno(r
, "Failed to parse '%s' as signed 16bit integer: %m", v
);
1470 r
= sd_bus_message_append_basic(m
, t
, &z
);
1474 case SD_BUS_TYPE_UINT16
: {
1477 r
= safe_atou16(v
, &z
);
1479 return log_error_errno(r
, "Failed to parse '%s' as unsigned 16bit integer: %m", v
);
1481 r
= sd_bus_message_append_basic(m
, t
, &z
);
1485 case SD_BUS_TYPE_INT32
: {
1488 r
= safe_atoi32(v
, &z
);
1490 return log_error_errno(r
, "Failed to parse '%s' as signed 32bit integer: %m", v
);
1492 r
= sd_bus_message_append_basic(m
, t
, &z
);
1496 case SD_BUS_TYPE_UINT32
: {
1499 r
= safe_atou32(v
, &z
);
1501 return log_error_errno(r
, "Failed to parse '%s' as unsigned 32bit integer: %m", v
);
1503 r
= sd_bus_message_append_basic(m
, t
, &z
);
1507 case SD_BUS_TYPE_INT64
: {
1510 r
= safe_atoi64(v
, &z
);
1512 return log_error_errno(r
, "Failed to parse '%s' as signed 64bit integer: %m", v
);
1514 r
= sd_bus_message_append_basic(m
, t
, &z
);
1518 case SD_BUS_TYPE_UINT64
: {
1521 r
= safe_atou64(v
, &z
);
1523 return log_error_errno(r
, "Failed to parse '%s' as unsigned 64bit integer: %m", v
);
1525 r
= sd_bus_message_append_basic(m
, t
, &z
);
1529 case SD_BUS_TYPE_DOUBLE
: {
1532 r
= safe_atod(v
, &z
);
1534 return log_error_errno(r
, "Failed to parse '%s' as double precision floating point: %m", v
);
1536 r
= sd_bus_message_append_basic(m
, t
, &z
);
1540 case SD_BUS_TYPE_STRING
:
1541 case SD_BUS_TYPE_OBJECT_PATH
:
1542 case SD_BUS_TYPE_SIGNATURE
:
1544 r
= sd_bus_message_append_basic(m
, t
, v
);
1547 case SD_BUS_TYPE_ARRAY
: {
1551 r
= safe_atou32(v
, &n
);
1553 return log_error_errno(r
, "Failed to parse '%s' number of array entries: %m", v
);
1555 r
= signature_element_length(signature
, &k
);
1557 return log_error_errno(r
, "Invalid array signature: %m");
1561 memcpy(s
, signature
, k
);
1564 r
= sd_bus_message_open_container(m
, SD_BUS_TYPE_ARRAY
, s
);
1566 return bus_log_create_error(r
);
1568 for (unsigned i
= 0; i
< n
; i
++) {
1569 r
= message_append_cmdline(m
, s
, &p
);
1577 r
= sd_bus_message_close_container(m
);
1581 case SD_BUS_TYPE_VARIANT
:
1582 r
= sd_bus_message_open_container(m
, SD_BUS_TYPE_VARIANT
, v
);
1584 return bus_log_create_error(r
);
1586 r
= message_append_cmdline(m
, v
, &p
);
1590 r
= sd_bus_message_close_container(m
);
1593 case SD_BUS_TYPE_STRUCT_BEGIN
:
1594 case SD_BUS_TYPE_DICT_ENTRY_BEGIN
: {
1600 r
= signature_element_length(signature
, &k
);
1602 return log_error_errno(r
, "Invalid struct/dict entry signature: %m");
1606 memcpy(s
, signature
+ 1, k
- 2);
1609 const char ctype
= t
== SD_BUS_TYPE_STRUCT_BEGIN
?
1610 SD_BUS_TYPE_STRUCT
: SD_BUS_TYPE_DICT_ENTRY
;
1611 r
= sd_bus_message_open_container(m
, ctype
, s
);
1613 return bus_log_create_error(r
);
1615 r
= message_append_cmdline(m
, s
, &p
);
1622 r
= sd_bus_message_close_container(m
);
1626 case SD_BUS_TYPE_UNIX_FD
:
1627 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
1628 "UNIX file descriptor not supported as type.");
1631 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
1632 "Unknown signature type %c.", t
);
1636 return bus_log_create_error(r
);
1643 static int json_transform_one(sd_bus_message
*m
, JsonVariant
**ret
);
1645 static int json_transform_array_or_struct(sd_bus_message
*m
, JsonVariant
**ret
) {
1646 JsonVariant
**elements
= NULL
;
1647 size_t n_elements
= 0;
1654 r
= sd_bus_message_at_end(m
, false);
1656 bus_log_parse_error(r
);
1662 if (!GREEDY_REALLOC(elements
, n_elements
+ 1)) {
1667 r
= json_transform_one(m
, elements
+ n_elements
);
1674 r
= json_variant_new_array(ret
, elements
, n_elements
);
1677 json_variant_unref_many(elements
, n_elements
);
1683 static int json_transform_variant(sd_bus_message
*m
, const char *contents
, JsonVariant
**ret
) {
1684 _cleanup_(json_variant_unrefp
) JsonVariant
*value
= NULL
;
1691 r
= json_transform_one(m
, &value
);
1695 r
= json_build(ret
, JSON_BUILD_OBJECT(JSON_BUILD_PAIR("type", JSON_BUILD_STRING(contents
)),
1696 JSON_BUILD_PAIR("data", JSON_BUILD_VARIANT(value
))));
1703 static int json_transform_dict_array(sd_bus_message
*m
, JsonVariant
**ret
) {
1704 JsonVariant
**elements
= NULL
;
1705 size_t n_elements
= 0;
1712 const char *contents
;
1715 r
= sd_bus_message_at_end(m
, false);
1717 bus_log_parse_error(r
);
1723 r
= sd_bus_message_peek_type(m
, &type
, &contents
);
1727 assert(type
== 'e');
1729 if (!GREEDY_REALLOC(elements
, n_elements
+ 2)) {
1734 r
= sd_bus_message_enter_container(m
, type
, contents
);
1736 bus_log_parse_error(r
);
1740 r
= json_transform_one(m
, elements
+ n_elements
);
1746 r
= json_transform_one(m
, elements
+ n_elements
);
1752 r
= sd_bus_message_exit_container(m
);
1754 bus_log_parse_error(r
);
1759 r
= json_variant_new_object(ret
, elements
, n_elements
);
1762 json_variant_unref_many(elements
, n_elements
);
1768 static int json_transform_one(sd_bus_message
*m
, JsonVariant
**ret
) {
1769 _cleanup_(json_variant_unrefp
) JsonVariant
*v
= NULL
;
1770 const char *contents
;
1777 r
= sd_bus_message_peek_type(m
, &type
, &contents
);
1779 return bus_log_parse_error(r
);
1783 case SD_BUS_TYPE_BYTE
: {
1786 r
= sd_bus_message_read_basic(m
, type
, &b
);
1788 return bus_log_parse_error(r
);
1790 r
= json_variant_new_unsigned(&v
, b
);
1792 return log_error_errno(r
, "Failed to transform byte: %m");
1797 case SD_BUS_TYPE_BOOLEAN
: {
1800 r
= sd_bus_message_read_basic(m
, type
, &b
);
1802 return bus_log_parse_error(r
);
1804 r
= json_variant_new_boolean(&v
, b
);
1806 return log_error_errno(r
, "Failed to transform boolean: %m");
1811 case SD_BUS_TYPE_INT16
: {
1814 r
= sd_bus_message_read_basic(m
, type
, &b
);
1816 return bus_log_parse_error(r
);
1818 r
= json_variant_new_integer(&v
, b
);
1820 return log_error_errno(r
, "Failed to transform int16: %m");
1825 case SD_BUS_TYPE_UINT16
: {
1828 r
= sd_bus_message_read_basic(m
, type
, &b
);
1830 return bus_log_parse_error(r
);
1832 r
= json_variant_new_unsigned(&v
, b
);
1834 return log_error_errno(r
, "Failed to transform uint16: %m");
1839 case SD_BUS_TYPE_INT32
: {
1842 r
= sd_bus_message_read_basic(m
, type
, &b
);
1844 return bus_log_parse_error(r
);
1846 r
= json_variant_new_integer(&v
, b
);
1848 return log_error_errno(r
, "Failed to transform int32: %m");
1853 case SD_BUS_TYPE_UINT32
: {
1856 r
= sd_bus_message_read_basic(m
, type
, &b
);
1858 return bus_log_parse_error(r
);
1860 r
= json_variant_new_unsigned(&v
, b
);
1862 return log_error_errno(r
, "Failed to transform uint32: %m");
1867 case SD_BUS_TYPE_INT64
: {
1870 r
= sd_bus_message_read_basic(m
, type
, &b
);
1872 return bus_log_parse_error(r
);
1874 r
= json_variant_new_integer(&v
, b
);
1876 return log_error_errno(r
, "Failed to transform int64: %m");
1881 case SD_BUS_TYPE_UINT64
: {
1884 r
= sd_bus_message_read_basic(m
, type
, &b
);
1886 return bus_log_parse_error(r
);
1888 r
= json_variant_new_unsigned(&v
, b
);
1890 return log_error_errno(r
, "Failed to transform uint64: %m");
1895 case SD_BUS_TYPE_DOUBLE
: {
1898 r
= sd_bus_message_read_basic(m
, type
, &d
);
1900 return bus_log_parse_error(r
);
1902 r
= json_variant_new_real(&v
, d
);
1904 return log_error_errno(r
, "Failed to transform double: %m");
1909 case SD_BUS_TYPE_STRING
:
1910 case SD_BUS_TYPE_OBJECT_PATH
:
1911 case SD_BUS_TYPE_SIGNATURE
: {
1914 r
= sd_bus_message_read_basic(m
, type
, &s
);
1916 return bus_log_parse_error(r
);
1918 r
= json_variant_new_string(&v
, s
);
1920 return log_error_errno(r
, "Failed to transform double: %m");
1925 case SD_BUS_TYPE_UNIX_FD
:
1926 r
= sd_bus_message_read_basic(m
, type
, NULL
);
1928 return bus_log_parse_error(r
);
1930 r
= json_variant_new_null(&v
);
1932 return log_error_errno(r
, "Failed to transform fd: %m");
1936 case SD_BUS_TYPE_ARRAY
:
1937 case SD_BUS_TYPE_VARIANT
:
1938 case SD_BUS_TYPE_STRUCT
:
1939 r
= sd_bus_message_enter_container(m
, type
, contents
);
1941 return bus_log_parse_error(r
);
1943 if (type
== SD_BUS_TYPE_VARIANT
)
1944 r
= json_transform_variant(m
, contents
, &v
);
1945 else if (type
== SD_BUS_TYPE_ARRAY
&& contents
[0] == '{')
1946 r
= json_transform_dict_array(m
, &v
);
1948 r
= json_transform_array_or_struct(m
, &v
);
1952 r
= sd_bus_message_exit_container(m
);
1954 return bus_log_parse_error(r
);
1959 assert_not_reached();
1966 static int json_transform_message(sd_bus_message
*m
, JsonVariant
**ret
) {
1967 _cleanup_(json_variant_unrefp
) JsonVariant
*v
= NULL
;
1974 assert_se(type
= sd_bus_message_get_signature(m
, false));
1976 r
= json_transform_array_or_struct(m
, &v
);
1980 r
= json_build(ret
, JSON_BUILD_OBJECT(JSON_BUILD_PAIR("type", JSON_BUILD_STRING(type
)),
1981 JSON_BUILD_PAIR("data", JSON_BUILD_VARIANT(v
))));
1988 static int call(int argc
, char **argv
, void *userdata
) {
1989 _cleanup_(sd_bus_flush_close_unrefp
) sd_bus
*bus
= NULL
;
1990 _cleanup_(sd_bus_error_free
) sd_bus_error error
= SD_BUS_ERROR_NULL
;
1991 _cleanup_(sd_bus_message_unrefp
) sd_bus_message
*m
= NULL
, *reply
= NULL
;
1994 r
= acquire_bus(false, &bus
);
1998 r
= sd_bus_message_new_method_call(bus
, &m
, argv
[1], argv
[2], argv
[3], argv
[4]);
2000 return bus_log_create_error(r
);
2002 r
= sd_bus_message_set_expect_reply(m
, arg_expect_reply
);
2004 return bus_log_create_error(r
);
2006 r
= sd_bus_message_set_auto_start(m
, arg_auto_start
);
2008 return bus_log_create_error(r
);
2010 r
= sd_bus_message_set_allow_interactive_authorization(m
, arg_allow_interactive_authorization
);
2012 return bus_log_create_error(r
);
2014 if (!isempty(argv
[5])) {
2019 r
= message_append_cmdline(m
, argv
[5], &p
);
2024 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
2025 "Too many parameters for signature.");
2028 if (!arg_expect_reply
) {
2029 r
= sd_bus_send(bus
, m
, NULL
);
2031 return log_error_errno(r
, "Failed to send message: %m");
2036 r
= sd_bus_call(bus
, m
, arg_timeout
, &error
, &reply
);
2038 return log_error_errno(r
, "Call failed: %s", bus_error_message(&error
, r
));
2040 r
= sd_bus_message_is_empty(reply
);
2042 return bus_log_parse_error(r
);
2044 if (r
== 0 && !arg_quiet
) {
2046 if (!FLAGS_SET(arg_json_format_flags
, JSON_FORMAT_OFF
)) {
2047 _cleanup_(json_variant_unrefp
) JsonVariant
*v
= NULL
;
2049 if (arg_json_format_flags
& (JSON_FORMAT_PRETTY
|JSON_FORMAT_PRETTY_AUTO
))
2050 pager_open(arg_pager_flags
);
2052 r
= json_transform_message(reply
, &v
);
2056 json_variant_dump(v
, arg_json_format_flags
, NULL
, NULL
);
2058 } else if (arg_verbose
) {
2059 pager_open(arg_pager_flags
);
2061 r
= sd_bus_message_dump(reply
, stdout
, 0);
2066 fputs(sd_bus_message_get_signature(reply
, true), stdout
);
2069 r
= format_cmdline(reply
, stdout
, false);
2071 return bus_log_parse_error(r
);
2073 fputc('\n', stdout
);
2080 static int emit_signal(int argc
, char **argv
, void *userdata
) {
2081 _cleanup_(sd_bus_flush_close_unrefp
) sd_bus
*bus
= NULL
;
2082 _cleanup_(sd_bus_message_unrefp
) sd_bus_message
*m
= NULL
;
2085 r
= acquire_bus(false, &bus
);
2089 r
= sd_bus_message_new_signal(bus
, &m
, argv
[1], argv
[2], argv
[3]);
2091 return bus_log_create_error(r
);
2093 if (arg_destination
) {
2094 r
= sd_bus_message_set_destination(m
, arg_destination
);
2096 return bus_log_create_error(r
);
2099 r
= sd_bus_message_set_auto_start(m
, arg_auto_start
);
2101 return bus_log_create_error(r
);
2103 if (!isempty(argv
[4])) {
2108 r
= message_append_cmdline(m
, argv
[4], &p
);
2113 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
2114 "Too many parameters for signature.");
2117 r
= sd_bus_send(bus
, m
, NULL
);
2119 return log_error_errno(r
, "Failed to send signal: %m");
2124 static int get_property(int argc
, char **argv
, void *userdata
) {
2125 _cleanup_(sd_bus_flush_close_unrefp
) sd_bus
*bus
= NULL
;
2126 _cleanup_(sd_bus_error_free
) sd_bus_error error
= SD_BUS_ERROR_NULL
;
2130 r
= acquire_bus(false, &bus
);
2134 STRV_FOREACH(i
, argv
+ 4) {
2135 _cleanup_(sd_bus_message_unrefp
) sd_bus_message
*reply
= NULL
;
2136 const char *contents
= NULL
;
2139 r
= sd_bus_call_method(bus
, argv
[1], argv
[2],
2140 "org.freedesktop.DBus.Properties", "Get",
2141 &error
, &reply
, "ss", argv
[3], *i
);
2143 return log_error_errno(r
, "Failed to get property %s on interface %s: %s",
2145 bus_error_message(&error
, r
));
2147 r
= sd_bus_message_peek_type(reply
, &type
, &contents
);
2149 return bus_log_parse_error(r
);
2151 r
= sd_bus_message_enter_container(reply
, 'v', contents
);
2153 return bus_log_parse_error(r
);
2155 if (!FLAGS_SET(arg_json_format_flags
, JSON_FORMAT_OFF
)) {
2156 _cleanup_(json_variant_unrefp
) JsonVariant
*v
= NULL
;
2158 if (arg_json_format_flags
& (JSON_FORMAT_PRETTY
|JSON_FORMAT_PRETTY_AUTO
))
2159 pager_open(arg_pager_flags
);
2161 r
= json_transform_variant(reply
, contents
, &v
);
2165 json_variant_dump(v
, arg_json_format_flags
, NULL
, NULL
);
2167 } else if (arg_verbose
) {
2168 pager_open(arg_pager_flags
);
2170 r
= sd_bus_message_dump(reply
, stdout
, SD_BUS_MESSAGE_DUMP_SUBTREE_ONLY
);
2174 fputs(contents
, stdout
);
2177 r
= format_cmdline(reply
, stdout
, false);
2179 return bus_log_parse_error(r
);
2181 fputc('\n', stdout
);
2184 r
= sd_bus_message_exit_container(reply
);
2186 return bus_log_parse_error(r
);
2192 static int set_property(int argc
, char **argv
, void *userdata
) {
2193 _cleanup_(sd_bus_flush_close_unrefp
) sd_bus
*bus
= NULL
;
2194 _cleanup_(sd_bus_message_unrefp
) sd_bus_message
*m
= NULL
;
2195 _cleanup_(sd_bus_error_free
) sd_bus_error error
= SD_BUS_ERROR_NULL
;
2199 r
= acquire_bus(false, &bus
);
2203 r
= sd_bus_message_new_method_call(bus
, &m
, argv
[1], argv
[2],
2204 "org.freedesktop.DBus.Properties", "Set");
2206 return bus_log_create_error(r
);
2208 r
= sd_bus_message_append(m
, "ss", argv
[3], argv
[4]);
2210 return bus_log_create_error(r
);
2212 r
= sd_bus_message_open_container(m
, 'v', argv
[5]);
2214 return bus_log_create_error(r
);
2217 r
= message_append_cmdline(m
, argv
[5], &p
);
2221 r
= sd_bus_message_close_container(m
);
2223 return bus_log_create_error(r
);
2226 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
), "Too many parameters for signature.");
2228 r
= sd_bus_call(bus
, m
, arg_timeout
, &error
, NULL
);
2230 return log_error_errno(r
, "Failed to set property %s on interface %s: %s",
2232 bus_error_message(&error
, r
));
2237 static int help(void) {
2238 _cleanup_free_
char *link
= NULL
;
2241 r
= terminal_urlify_man("busctl", "1", &link
);
2245 pager_open(arg_pager_flags
);
2247 printf("%s [OPTIONS...] COMMAND ...\n\n"
2248 "%sIntrospect the D-Bus IPC bus.%s\n"
2250 " list List bus names\n"
2251 " status [SERVICE] Show bus service, process or bus owner credentials\n"
2252 " monitor [SERVICE...] Show bus traffic\n"
2253 " capture [SERVICE...] Capture bus traffic as pcap\n"
2254 " tree [SERVICE...] Show object tree of service\n"
2255 " introspect SERVICE OBJECT [INTERFACE]\n"
2256 " call SERVICE OBJECT INTERFACE METHOD [SIGNATURE [ARGUMENT...]]\n"
2258 " emit OBJECT INTERFACE SIGNAL [SIGNATURE [ARGUMENT...]]\n"
2260 " get-property SERVICE OBJECT INTERFACE PROPERTY...\n"
2261 " Get property value\n"
2262 " set-property SERVICE OBJECT INTERFACE PROPERTY SIGNATURE ARGUMENT...\n"
2263 " Set property value\n"
2264 " help Show this help\n"
2266 " -h --help Show this help\n"
2267 " --version Show package version\n"
2268 " --no-pager Do not pipe output into a pager\n"
2269 " --no-legend Do not show the headers and footers\n"
2270 " -l --full Do not ellipsize output\n"
2271 " --system Connect to system bus\n"
2272 " --user Connect to user bus\n"
2273 " -H --host=[USER@]HOST Operate on remote host\n"
2274 " -M --machine=CONTAINER Operate on local container\n"
2275 " --address=ADDRESS Connect to bus specified by address\n"
2276 " --show-machine Show machine ID column in list\n"
2277 " --unique Only show unique names\n"
2278 " --acquired Only show acquired names\n"
2279 " --activatable Only show activatable names\n"
2280 " --match=MATCH Only show matching messages\n"
2281 " --size=SIZE Maximum length of captured packet\n"
2282 " --list Don't show tree, but simple object path list\n"
2283 " -q --quiet Don't show method call reply\n"
2284 " --verbose Show result values in long format\n"
2285 " --json=MODE Output as JSON\n"
2286 " -j Same as --json=pretty on tty, --json=short otherwise\n"
2287 " --expect-reply=BOOL Expect a method call reply\n"
2288 " --auto-start=BOOL Auto-start destination service\n"
2289 " --allow-interactive-authorization=BOOL\n"
2290 " Allow interactive authorization for operation\n"
2291 " --timeout=SECS Maximum time to wait for method call completion\n"
2292 " --augment-creds=BOOL Extend credential data with data read from /proc/$PID\n"
2293 " --watch-bind=BOOL Wait for bus AF_UNIX socket to be bound in the file\n"
2295 " --destination=SERVICE Destination service of a signal\n"
2296 "\nSee the %s for details.\n",
2297 program_invocation_short_name
,
2305 static int verb_help(int argc
, char **argv
, void *userdata
) {
2309 static int parse_argv(int argc
, char *argv
[]) {
2312 ARG_VERSION
= 0x100,
2329 ARG_ALLOW_INTERACTIVE_AUTHORIZATION
,
2337 static const struct option options
[] = {
2338 { "help", no_argument
, NULL
, 'h' },
2339 { "version", no_argument
, NULL
, ARG_VERSION
},
2340 { "no-pager", no_argument
, NULL
, ARG_NO_PAGER
},
2341 { "no-legend", no_argument
, NULL
, ARG_NO_LEGEND
},
2342 { "full", no_argument
, NULL
, 'l' },
2343 { "system", no_argument
, NULL
, ARG_SYSTEM
},
2344 { "user", no_argument
, NULL
, ARG_USER
},
2345 { "address", required_argument
, NULL
, ARG_ADDRESS
},
2346 { "show-machine", no_argument
, NULL
, ARG_SHOW_MACHINE
},
2347 { "unique", no_argument
, NULL
, ARG_UNIQUE
},
2348 { "acquired", no_argument
, NULL
, ARG_ACQUIRED
},
2349 { "activatable", no_argument
, NULL
, ARG_ACTIVATABLE
},
2350 { "match", required_argument
, NULL
, ARG_MATCH
},
2351 { "host", required_argument
, NULL
, 'H' },
2352 { "machine", required_argument
, NULL
, 'M' },
2353 { "size", required_argument
, NULL
, ARG_SIZE
},
2354 { "list", no_argument
, NULL
, ARG_LIST
},
2355 { "quiet", no_argument
, NULL
, 'q' },
2356 { "verbose", no_argument
, NULL
, ARG_VERBOSE
},
2357 { "xml-interface", no_argument
, NULL
, ARG_XML_INTERFACE
},
2358 { "expect-reply", required_argument
, NULL
, ARG_EXPECT_REPLY
},
2359 { "auto-start", required_argument
, NULL
, ARG_AUTO_START
},
2360 { "allow-interactive-authorization", required_argument
, NULL
, ARG_ALLOW_INTERACTIVE_AUTHORIZATION
},
2361 { "timeout", required_argument
, NULL
, ARG_TIMEOUT
},
2362 { "augment-creds", required_argument
, NULL
, ARG_AUGMENT_CREDS
},
2363 { "watch-bind", required_argument
, NULL
, ARG_WATCH_BIND
},
2364 { "json", required_argument
, NULL
, ARG_JSON
},
2365 { "destination", required_argument
, NULL
, ARG_DESTINATION
},
2374 while ((c
= getopt_long(argc
, argv
, "hH:M:qjl", options
, NULL
)) >= 0)
2385 arg_pager_flags
|= PAGER_DISABLE
;
2405 arg_address
= optarg
;
2408 case ARG_SHOW_MACHINE
:
2409 arg_show_machine
= true;
2417 arg_acquired
= true;
2420 case ARG_ACTIVATABLE
:
2421 arg_activatable
= true;
2425 if (strv_extend(&arg_matches
, optarg
) < 0)
2432 r
= parse_size(optarg
, 1024, &sz
);
2434 return log_error_errno(r
, "Failed to parse size '%s': %m", optarg
);
2436 if ((uint64_t) (size_t) sz
!= sz
)
2437 return log_error_errno(SYNTHETIC_ERRNO(E2BIG
),
2438 "Size out of range.");
2440 arg_snaplen
= (size_t) sz
;
2449 arg_transport
= BUS_TRANSPORT_REMOTE
;
2454 arg_transport
= BUS_TRANSPORT_MACHINE
;
2466 case ARG_XML_INTERFACE
:
2467 arg_xml_interface
= true;
2470 case ARG_EXPECT_REPLY
:
2471 r
= parse_boolean_argument("--expect-reply=", optarg
, &arg_expect_reply
);
2476 case ARG_AUTO_START
:
2477 r
= parse_boolean_argument("--auto-start=", optarg
, &arg_auto_start
);
2482 case ARG_ALLOW_INTERACTIVE_AUTHORIZATION
:
2483 r
= parse_boolean_argument("--allow-interactive-authorization=", optarg
,
2484 &arg_allow_interactive_authorization
);
2490 r
= parse_sec(optarg
, &arg_timeout
);
2492 return log_error_errno(r
, "Failed to parse --timeout= parameter '%s': %m", optarg
);
2496 case ARG_AUGMENT_CREDS
:
2497 r
= parse_boolean_argument("--augment-creds=", optarg
, &arg_augment_creds
);
2502 case ARG_WATCH_BIND
:
2503 r
= parse_boolean_argument("--watch-bind=", optarg
, &arg_watch_bind
);
2509 arg_json_format_flags
= JSON_FORMAT_PRETTY_AUTO
|JSON_FORMAT_COLOR_AUTO
;
2513 r
= parse_json_argument(optarg
, &arg_json_format_flags
);
2519 case ARG_DESTINATION
:
2520 arg_destination
= optarg
;
2527 assert_not_reached();
2533 static int busctl_main(int argc
, char *argv
[]) {
2534 static const Verb verbs
[] = {
2535 { "list", VERB_ANY
, 1, VERB_DEFAULT
, list_bus_names
},
2536 { "status", VERB_ANY
, 2, 0, status
},
2537 { "monitor", VERB_ANY
, VERB_ANY
, 0, verb_monitor
},
2538 { "capture", VERB_ANY
, VERB_ANY
, 0, verb_capture
},
2539 { "tree", VERB_ANY
, VERB_ANY
, 0, tree
},
2540 { "introspect", 3, 4, 0, introspect
},
2541 { "call", 5, VERB_ANY
, 0, call
},
2542 { "emit", 4, VERB_ANY
, 0, emit_signal
},
2543 { "get-property", 5, VERB_ANY
, 0, get_property
},
2544 { "set-property", 6, VERB_ANY
, 0, set_property
},
2545 { "help", VERB_ANY
, VERB_ANY
, 0, verb_help
},
2549 return dispatch_verb(argc
, argv
, verbs
, NULL
);
2552 static int run(int argc
, char *argv
[]) {
2557 r
= parse_argv(argc
, argv
);
2561 return busctl_main(argc
, argv
);
2564 DEFINE_MAIN_FUNCTION(run
);