1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
4 This file is part of systemd.
6 Copyright 2013 Lennart Poettering
8 systemd is free software; you can redistribute it and/or modify it
9 under the terms of the GNU Lesser General Public License as published by
10 the Free Software Foundation; either version 2.1 of the License, or
11 (at your option) any later version.
13 systemd is distributed in the hope that it will be useful, but
14 WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 Lesser General Public License for more details.
18 You should have received a copy of the GNU Lesser General Public License
19 along with systemd; If not, see <http://www.gnu.org/licenses/>.
30 #include "path-util.h"
33 #include "bus-message.h"
34 #include "bus-internal.h"
37 #include "bus-signature.h"
39 #include "busctl-introspect.h"
41 static bool arg_no_pager = false;
42 static bool arg_legend = true;
43 static char *arg_address = NULL;
44 static bool arg_unique = false;
45 static bool arg_acquired = false;
46 static bool arg_activatable = false;
47 static bool arg_show_machine = false;
48 static char **arg_matches = NULL;
49 static BusTransport arg_transport = BUS_TRANSPORT_LOCAL;
50 static char *arg_host = NULL;
51 static bool arg_user = false;
52 static size_t arg_snaplen = 4096;
53 static bool arg_list = false;
54 static bool arg_quiet = false;
55 static bool arg_verbose = false;
56 static bool arg_expect_reply = true;
57 static bool arg_auto_start = true;
58 static bool arg_allow_interactive_authorization = true;
59 static bool arg_augment_creds = true;
60 static usec_t arg_timeout = 0;
62 static void pager_open_if_enabled(void) {
64 /* Cache result before we open the pager */
71 #define NAME_IS_ACQUIRED INT_TO_PTR(1)
72 #define NAME_IS_ACTIVATABLE INT_TO_PTR(2)
74 static int list_bus_names(sd_bus *bus, char **argv) {
75 _cleanup_strv_free_ char **acquired = NULL, **activatable = NULL;
76 _cleanup_free_ char **merged = NULL;
77 _cleanup_hashmap_free_ Hashmap *names = NULL;
88 if (!arg_unique && !arg_acquired && !arg_activatable)
89 arg_unique = arg_acquired = arg_activatable = true;
91 r = sd_bus_list_names(bus, (arg_acquired || arg_unique) ? &acquired : NULL, arg_activatable ? &activatable : NULL);
93 return log_error_errno(r, "Failed to list names: %m");
95 pager_open_if_enabled();
97 names = hashmap_new(&string_hash_ops);
101 STRV_FOREACH(i, acquired) {
102 max_i = MAX(max_i, strlen(*i));
104 r = hashmap_put(names, *i, NAME_IS_ACQUIRED);
106 return log_error_errno(r, "Failed to add to hashmap: %m");
109 STRV_FOREACH(i, activatable) {
110 max_i = MAX(max_i, strlen(*i));
112 r = hashmap_put(names, *i, NAME_IS_ACTIVATABLE);
113 if (r < 0 && r != -EEXIST)
114 return log_error_errno(r, "Failed to add to hashmap: %m");
117 merged = new(char*, hashmap_size(names) + 1);
118 HASHMAP_FOREACH_KEY(v, k, names, iterator)
125 printf("%-*s %*s %-*s %-*s %-*s %-*s %-*s %-*s",
126 (int) max_i, "NAME", 10, "PID", 15, "PROCESS", 16, "USER", 13, "CONNECTION", 25, "UNIT", 10, "SESSION", 19, "DESCRIPTION");
128 if (arg_show_machine)
134 STRV_FOREACH(i, merged) {
135 _cleanup_bus_creds_unref_ sd_bus_creds *creds = NULL;
138 if (hashmap_get(names, *i) == NAME_IS_ACTIVATABLE) {
141 printf("%-*s", (int) max_i, *i);
142 printf(" - - - (activatable) - - ");
143 if (arg_show_machine)
151 if (!arg_unique && (*i)[0] == ':')
154 if (!arg_acquired && (*i)[0] != ':')
157 printf("%-*s", (int) max_i, *i);
159 r = sd_bus_get_name_creds(
161 (arg_augment_creds ? SD_BUS_CREDS_AUGMENT : 0) |
162 SD_BUS_CREDS_UID|SD_BUS_CREDS_PID|SD_BUS_CREDS_COMM|
163 SD_BUS_CREDS_UNIQUE_NAME|SD_BUS_CREDS_UNIT|SD_BUS_CREDS_SESSION|
164 SD_BUS_CREDS_DESCRIPTION, &creds);
166 const char *unique, *session, *unit, *cn;
170 r = sd_bus_creds_get_pid(creds, &pid);
172 const char *comm = NULL;
174 sd_bus_creds_get_comm(creds, &comm);
176 printf(" %10lu %-15s", (unsigned long) pid, strna(comm));
178 fputs(" - - ", stdout);
180 r = sd_bus_creds_get_uid(creds, &uid);
182 _cleanup_free_ char *u = NULL;
184 u = uid_to_name(uid);
193 fputs(" - ", stdout);
195 r = sd_bus_creds_get_unique_name(creds, &unique);
197 printf(" %-13s", unique);
199 fputs(" - ", stdout);
201 r = sd_bus_creds_get_unit(creds, &unit);
203 _cleanup_free_ char *e;
205 e = ellipsize(unit, 25, 100);
211 fputs(" - ", stdout);
213 r = sd_bus_creds_get_session(creds, &session);
215 printf(" %-10s", session);
217 fputs(" - ", stdout);
219 r = sd_bus_creds_get_description(creds, &cn);
221 printf(" %-19s", cn);
223 fputs(" - ", stdout);
226 printf(" - - - - - - - ");
228 if (arg_show_machine) {
229 r = sd_bus_get_name_machine_id(bus, *i, &mid);
231 char m[SD_ID128_STRING_MAX];
232 printf(" %s\n", sd_id128_to_string(mid, m));
242 static void print_subtree(const char *prefix, const char *path, char **l) {
243 const char *vertical, *space;
246 /* We assume the list is sorted. Let's first skip over the
247 * entry we are looking at. */
252 if (!streq(*l, path))
258 vertical = strappenda(prefix, draw_special_char(DRAW_TREE_VERTICAL));
259 space = strappenda(prefix, draw_special_char(DRAW_TREE_SPACE));
262 bool has_more = false;
264 if (!*l || !path_startswith(*l, path))
269 if (!*n || !path_startswith(*n, path))
272 if (!path_startswith(*n, *l)) {
280 printf("%s%s%s\n", prefix, draw_special_char(has_more ? DRAW_TREE_BRANCH : DRAW_TREE_RIGHT), *l);
282 print_subtree(has_more ? vertical : space, *l, l);
287 static void print_tree(const char *prefix, char **l) {
289 pager_open_if_enabled();
291 prefix = strempty(prefix);
297 printf("%s%s\n", prefix, *i);
301 if (strv_isempty(l)) {
302 printf("No objects discovered.\n");
306 if (streq(l[0], "/") && !l[1]) {
307 printf("Only root object discovered.\n");
311 print_subtree(prefix, "/", l);
314 static int on_path(const char *path, void *userdata) {
315 Set *paths = userdata;
320 r = set_put_strdup(paths, path);
327 static int find_nodes(sd_bus *bus, const char *service, const char *path, Set *paths, bool many) {
328 static const XMLIntrospectOps ops = {
332 _cleanup_bus_message_unref_ sd_bus_message *reply = NULL;
333 _cleanup_bus_error_free_ sd_bus_error error = SD_BUS_ERROR_NULL;
337 r = sd_bus_call_method(bus, service, path, "org.freedesktop.DBus.Introspectable", "Introspect", &error, &reply, "");
340 printf("Failed to introspect object %s of service %s: %s\n", path, service, bus_error_message(&error, r));
342 log_error("Failed to introspect object %s of service %s: %s", path, service, bus_error_message(&error, r));
346 r = sd_bus_message_read(reply, "s", &xml);
348 return bus_log_parse_error(r);
350 return parse_xml_introspect(path, xml, &ops, paths);
353 static int tree_one(sd_bus *bus, const char *service, const char *prefix, bool many) {
354 _cleanup_set_free_free_ Set *paths = NULL, *done = NULL, *failed = NULL;
355 _cleanup_free_ char **l = NULL;
359 paths = set_new(&string_hash_ops);
363 done = set_new(&string_hash_ops);
367 failed = set_new(&string_hash_ops);
375 r = set_put(paths, m);
382 _cleanup_free_ char *p = NULL;
385 p = set_steal_first(paths);
389 if (set_contains(done, p) ||
390 set_contains(failed, p))
393 q = find_nodes(bus, service, p, paths, many);
398 q = set_put(failed, p);
400 q = set_put(done, p);
409 pager_open_if_enabled();
411 l = set_get_strv(done);
416 print_tree(prefix, l);
423 static int tree(sd_bus *bus, char **argv) {
427 if (!arg_unique && !arg_acquired)
430 if (strv_length(argv) <= 1) {
431 _cleanup_strv_free_ char **names = NULL;
432 bool not_first = false;
434 r = sd_bus_list_names(bus, &names, NULL);
436 return log_error_errno(r, "Failed to get name list: %m");
438 pager_open_if_enabled();
440 STRV_FOREACH(i, names) {
443 if (!arg_unique && (*i)[0] == ':')
446 if (!arg_acquired && (*i)[0] == ':')
452 printf("Service %s%s%s:\n", ansi_highlight(), *i, ansi_highlight_off());
454 q = tree_one(bus, *i, NULL, true);
461 STRV_FOREACH(i, argv+1) {
468 pager_open_if_enabled();
469 printf("Service %s%s%s:\n", ansi_highlight(), *i, ansi_highlight_off());
472 q = tree_one(bus, *i, NULL, !!argv[2]);
481 static int format_cmdline(sd_bus_message *m, FILE *f, bool needs_space) {
485 const char *contents = NULL;
500 r = sd_bus_message_peek_type(m, &type, &contents);
504 if (bus_type_is_container(type) > 0) {
506 r = sd_bus_message_enter_container(m, type, contents);
510 if (type == SD_BUS_TYPE_ARRAY) {
513 /* count array entries */
516 r = sd_bus_message_skip(m, contents);
525 r = sd_bus_message_rewind(m, false);
533 } else if (type == SD_BUS_TYPE_VARIANT) {
538 fprintf(f, "%s", contents);
541 r = format_cmdline(m, f, needs_space || IN_SET(type, SD_BUS_TYPE_ARRAY, SD_BUS_TYPE_VARIANT));
545 r = sd_bus_message_exit_container(m);
552 r = sd_bus_message_read_basic(m, type, &basic);
560 case SD_BUS_TYPE_BYTE:
561 fprintf(f, "%u", basic.u8);
564 case SD_BUS_TYPE_BOOLEAN:
565 fputs(true_false(basic.i), f);
568 case SD_BUS_TYPE_INT16:
569 fprintf(f, "%i", basic.s16);
572 case SD_BUS_TYPE_UINT16:
573 fprintf(f, "%u", basic.u16);
576 case SD_BUS_TYPE_INT32:
577 fprintf(f, "%i", basic.s32);
580 case SD_BUS_TYPE_UINT32:
581 fprintf(f, "%u", basic.u32);
584 case SD_BUS_TYPE_INT64:
585 fprintf(f, "%" PRIi64, basic.s64);
588 case SD_BUS_TYPE_UINT64:
589 fprintf(f, "%" PRIu64, basic.u64);
592 case SD_BUS_TYPE_DOUBLE:
593 fprintf(f, "%g", basic.d64);
596 case SD_BUS_TYPE_STRING:
597 case SD_BUS_TYPE_OBJECT_PATH:
598 case SD_BUS_TYPE_SIGNATURE: {
599 _cleanup_free_ char *b = NULL;
601 b = cescape(basic.string);
605 fprintf(f, "\"%s\"", b);
609 case SD_BUS_TYPE_UNIX_FD:
610 fprintf(f, "%i", basic.i);
614 assert_not_reached("Unknown basic type.");
621 typedef struct Member {
632 static unsigned long member_hash_func(const void *p, const uint8_t hash_key[]) {
639 ul = string_hash_func(m->type, hash_key);
642 ul ^= string_hash_func(m->name, hash_key);
645 ul ^= string_hash_func(m->interface, hash_key);
650 static int member_compare_func(const void *a, const void *b) {
651 const Member *x = a, *y = b;
659 if (!x->interface && y->interface)
661 if (x->interface && !y->interface)
663 if (x->interface && y->interface) {
664 d = strcmp(x->interface, y->interface);
669 d = strcmp(x->type, y->type);
673 if (!x->name && y->name)
675 if (x->name && !y->name)
677 if (x->name && y->name)
678 return strcmp(x->name, y->name);
683 static int member_compare_funcp(const void *a, const void *b) {
684 const Member *const * x = (const Member *const *) a, * const *y = (const Member *const *) b;
686 return member_compare_func(*x, *y);
689 static void member_free(Member *m) {
701 DEFINE_TRIVIAL_CLEANUP_FUNC(Member*, member_free);
703 static void member_set_free(Set *s) {
706 while ((m = set_steal_first(s)))
712 DEFINE_TRIVIAL_CLEANUP_FUNC(Set*, member_set_free);
714 static int on_interface(const char *interface, uint64_t flags, void *userdata) {
715 _cleanup_(member_freep) Member *m;
716 Set *members = userdata;
726 m->type = "interface";
729 r = free_and_strdup(&m->interface, interface);
733 r = set_put(members, m);
735 log_error("Duplicate interface");
743 static int on_method(const char *interface, const char *name, const char *signature, const char *result, uint64_t flags, void *userdata) {
744 _cleanup_(member_freep) Member *m;
745 Set *members = userdata;
758 r = free_and_strdup(&m->interface, interface);
762 r = free_and_strdup(&m->name, name);
766 r = free_and_strdup(&m->signature, signature);
770 r = free_and_strdup(&m->result, result);
774 r = set_put(members, m);
776 log_error("Duplicate method");
784 static int on_signal(const char *interface, const char *name, const char *signature, uint64_t flags, void *userdata) {
785 _cleanup_(member_freep) Member *m;
786 Set *members = userdata;
799 r = free_and_strdup(&m->interface, interface);
803 r = free_and_strdup(&m->name, name);
807 r = free_and_strdup(&m->signature, signature);
811 r = set_put(members, m);
813 log_error("Duplicate signal");
821 static int on_property(const char *interface, const char *name, const char *signature, bool writable, uint64_t flags, void *userdata) {
822 _cleanup_(member_freep) Member *m;
823 Set *members = userdata;
833 m->type = "property";
835 m->writable = writable;
837 r = free_and_strdup(&m->interface, interface);
841 r = free_and_strdup(&m->name, name);
845 r = free_and_strdup(&m->signature, signature);
849 r = set_put(members, m);
851 log_error("Duplicate property");
859 static const char *strdash(const char *x) {
860 return isempty(x) ? "-" : x;
863 static int introspect(sd_bus *bus, char **argv) {
864 static const struct hash_ops member_hash_ops = {
865 .hash = member_hash_func,
866 .compare = member_compare_func,
869 static const XMLIntrospectOps ops = {
870 .on_interface = on_interface,
871 .on_method = on_method,
872 .on_signal = on_signal,
873 .on_property = on_property,
876 _cleanup_bus_message_unref_ sd_bus_message *reply = NULL;
877 _cleanup_bus_error_free_ sd_bus_error error = SD_BUS_ERROR_NULL;
878 _cleanup_(member_set_freep) Set *members = NULL;
883 unsigned name_width, type_width, signature_width, result_width;
884 Member **sorted = NULL;
887 if (strv_length(argv) != 3) {
888 log_error("Requires service and object path argument.");
892 members = set_new(&member_hash_ops);
896 r = sd_bus_call_method(bus, argv[1], argv[2], "org.freedesktop.DBus.Introspectable", "Introspect", &error, &reply, "");
898 log_error("Failed to introspect object %s of service %s: %s", argv[2], argv[1], bus_error_message(&error, r));
902 r = sd_bus_message_read(reply, "s", &xml);
904 return bus_log_parse_error(r);
906 /* First, get list of all properties */
907 r = parse_xml_introspect(argv[2], xml, &ops, members);
911 /* Second, find the current values for them */
912 SET_FOREACH(m, members, i) {
914 if (!streq(m->type, "property"))
920 r = sd_bus_call_method(bus, argv[1], argv[2], "org.freedesktop.DBus.Properties", "GetAll", &error, &reply, "s", m->interface);
922 log_error("%s", bus_error_message(&error, r));
926 r = sd_bus_message_enter_container(reply, 'a', "{sv}");
928 return bus_log_parse_error(r);
932 _cleanup_free_ char *buf = NULL;
933 _cleanup_fclose_ FILE *mf = NULL;
937 r = sd_bus_message_enter_container(reply, 'e', "sv");
939 return bus_log_parse_error(r);
944 r = sd_bus_message_read(reply, "s", &name);
946 return bus_log_parse_error(r);
948 r = sd_bus_message_enter_container(reply, 'v', NULL);
950 return bus_log_parse_error(r);
952 mf = open_memstream(&buf, &sz);
956 r = format_cmdline(reply, mf, false);
958 return bus_log_parse_error(r);
963 z = set_get(members, &((Member) {
965 .interface = m->interface,
966 .name = (char*) name }));
973 r = sd_bus_message_exit_container(reply);
975 return bus_log_parse_error(r);
977 r = sd_bus_message_exit_container(reply);
979 return bus_log_parse_error(r);
982 r = sd_bus_message_exit_container(reply);
984 return bus_log_parse_error(r);
987 pager_open_if_enabled();
989 name_width = strlen("NAME");
990 type_width = strlen("TYPE");
991 signature_width = strlen("SIGNATURE");
992 result_width = strlen("RESULT/VALUE");
994 sorted = newa(Member*, set_size(members));
996 SET_FOREACH(m, members, i) {
998 name_width = MAX(name_width, strlen(m->interface));
1000 name_width = MAX(name_width, strlen(m->name) + 1);
1002 type_width = MAX(type_width, strlen(m->type));
1004 signature_width = MAX(signature_width, strlen(m->signature));
1006 result_width = MAX(result_width, strlen(m->result));
1008 result_width = MAX(result_width, strlen(m->value));
1013 if (result_width > 40)
1016 assert(k == set_size(members));
1017 qsort(sorted, k, sizeof(Member*), member_compare_funcp);
1020 printf("%-*s %-*s %-*s %-*s %s\n",
1021 (int) name_width, "NAME",
1022 (int) type_width, "TYPE",
1023 (int) signature_width, "SIGNATURE",
1024 (int) result_width, "RESULT/VALUE",
1028 for (j = 0; j < k; j++) {
1029 _cleanup_free_ char *ellipsized = NULL;
1035 is_interface = streq(m->type, "interface");
1038 ellipsized = ellipsize(m->value, result_width, 100);
1044 rv = strdash(m->result);
1046 printf("%s%s%-*s%s %-*s %-*s %-*s%s%s%s%s%s%s\n",
1047 is_interface ? ansi_highlight() : "",
1048 is_interface ? "" : ".",
1049 - !is_interface + (int) name_width, strdash(streq_ptr(m->type, "interface") ? m->interface : m->name),
1050 is_interface ? ansi_highlight_off() : "",
1051 (int) type_width, strdash(m->type),
1052 (int) signature_width, strdash(m->signature),
1053 (int) result_width, rv,
1054 (m->flags & SD_BUS_VTABLE_DEPRECATED) ? " deprecated" : (m->flags || m->writable ? "" : " -"),
1055 (m->flags & SD_BUS_VTABLE_METHOD_NO_REPLY) ? " no-reply" : "",
1056 (m->flags & SD_BUS_VTABLE_PROPERTY_CONST) ? " const" : "",
1057 (m->flags & SD_BUS_VTABLE_PROPERTY_EMITS_CHANGE) ? " emits-change" : "",
1058 (m->flags & SD_BUS_VTABLE_PROPERTY_EMITS_INVALIDATION) ? " emits-invalidation" : "",
1059 m->writable ? " writable" : "");
1065 static int message_dump(sd_bus_message *m, FILE *f) {
1066 return bus_message_dump(m, f, BUS_MESSAGE_DUMP_WITH_HEADER);
1069 static int message_pcap(sd_bus_message *m, FILE *f) {
1070 return bus_message_pcap_frame(m, arg_snaplen, f);
1073 static int monitor(sd_bus *bus, char *argv[], int (*dump)(sd_bus_message *m, FILE *f)) {
1074 bool added_something = false;
1078 STRV_FOREACH(i, argv+1) {
1079 _cleanup_free_ char *m = NULL;
1081 if (!service_name_is_valid(*i)) {
1082 log_error("Invalid service name '%s'", *i);
1086 m = strjoin("sender='", *i, "'", NULL);
1090 r = sd_bus_add_match(bus, NULL, m, NULL, NULL);
1092 return log_error_errno(r, "Failed to add match: %m");
1094 added_something = true;
1097 STRV_FOREACH(i, arg_matches) {
1098 r = sd_bus_add_match(bus, NULL, *i, NULL, NULL);
1100 return log_error_errno(r, "Failed to add match: %m");
1102 added_something = true;
1105 if (!added_something) {
1106 r = sd_bus_add_match(bus, NULL, "", NULL, NULL);
1108 return log_error_errno(r, "Failed to add match: %m");
1112 _cleanup_bus_message_unref_ sd_bus_message *m = NULL;
1114 r = sd_bus_process(bus, &m);
1116 return log_error_errno(r, "Failed to process bus: %m");
1126 r = sd_bus_wait(bus, (uint64_t) -1);
1128 return log_error_errno(r, "Failed to wait for bus: %m");
1132 static int capture(sd_bus *bus, char *argv[]) {
1135 if (isatty(fileno(stdout)) > 0) {
1136 log_error("Refusing to write message data to console, please redirect output to a file.");
1140 bus_pcap_header(arg_snaplen, stdout);
1142 r = monitor(bus, argv, message_pcap);
1146 if (ferror(stdout)) {
1147 log_error("Couldn't write capture file.");
1154 static int status(sd_bus *bus, char *argv[]) {
1155 _cleanup_bus_creds_unref_ sd_bus_creds *creds = NULL;
1161 if (strv_length(argv) > 2) {
1162 log_error("Expects no or one argument.");
1167 r = parse_pid(argv[1], &pid);
1169 r = sd_bus_get_name_creds(
1172 (arg_augment_creds ? SD_BUS_CREDS_AUGMENT : 0) | _SD_BUS_CREDS_ALL,
1175 r = sd_bus_creds_new_from_pid(
1180 const char *scope, *address;
1183 r = sd_bus_get_address(bus, &address);
1185 printf("BusAddress=%s%s%s\n", ansi_highlight(), address, ansi_highlight_off());
1187 r = sd_bus_get_scope(bus, &scope);
1189 printf("BusScope=%s%s%s\n", ansi_highlight(), scope, ansi_highlight_off());
1191 r = sd_bus_get_bus_id(bus, &bus_id);
1193 printf("BusID=%s" SD_ID128_FORMAT_STR "%s\n", ansi_highlight(), SD_ID128_FORMAT_VAL(bus_id), ansi_highlight_off());
1195 r = sd_bus_get_owner_creds(
1197 (arg_augment_creds ? SD_BUS_CREDS_AUGMENT : 0) | _SD_BUS_CREDS_ALL,
1202 return log_error_errno(r, "Failed to get credentials: %m");
1204 bus_creds_dump(creds, NULL, false);
1208 static int message_append_cmdline(sd_bus_message *m, const char *signature, char ***x) {
1228 log_error("Too few parameters for signature.");
1237 case SD_BUS_TYPE_BOOLEAN:
1239 r = parse_boolean(v);
1241 log_error("Failed to parse as boolean: %s", v);
1245 r = sd_bus_message_append_basic(m, t, &r);
1248 case SD_BUS_TYPE_BYTE: {
1251 r = safe_atou8(v, &z);
1253 log_error("Failed to parse as byte (unsigned 8bit integer): %s", v);
1257 r = sd_bus_message_append_basic(m, t, &z);
1261 case SD_BUS_TYPE_INT16: {
1264 r = safe_atoi16(v, &z);
1266 log_error("Failed to parse as signed 16bit integer: %s", v);
1270 r = sd_bus_message_append_basic(m, t, &z);
1274 case SD_BUS_TYPE_UINT16: {
1277 r = safe_atou16(v, &z);
1279 log_error("Failed to parse as unsigned 16bit integer: %s", v);
1283 r = sd_bus_message_append_basic(m, t, &z);
1287 case SD_BUS_TYPE_INT32: {
1290 r = safe_atoi32(v, &z);
1292 log_error("Failed to parse as signed 32bit integer: %s", v);
1296 r = sd_bus_message_append_basic(m, t, &z);
1300 case SD_BUS_TYPE_UINT32: {
1303 r = safe_atou32(v, &z);
1305 log_error("Failed to parse as unsigned 32bit integer: %s", v);
1309 r = sd_bus_message_append_basic(m, t, &z);
1313 case SD_BUS_TYPE_INT64: {
1316 r = safe_atoi64(v, &z);
1318 log_error("Failed to parse as signed 64bit integer: %s", v);
1322 r = sd_bus_message_append_basic(m, t, &z);
1326 case SD_BUS_TYPE_UINT64: {
1329 r = safe_atou64(v, &z);
1331 log_error("Failed to parse as unsigned 64bit integer: %s", v);
1335 r = sd_bus_message_append_basic(m, t, &z);
1340 case SD_BUS_TYPE_DOUBLE: {
1343 r = safe_atod(v, &z);
1345 log_error("Failed to parse as double precision floating point: %s", v);
1349 r = sd_bus_message_append_basic(m, t, &z);
1353 case SD_BUS_TYPE_STRING:
1354 case SD_BUS_TYPE_OBJECT_PATH:
1355 case SD_BUS_TYPE_SIGNATURE:
1357 r = sd_bus_message_append_basic(m, t, v);
1360 case SD_BUS_TYPE_ARRAY: {
1364 r = safe_atou32(v, &n);
1366 log_error("Failed to parse number of array entries: %s", v);
1370 r = signature_element_length(signature, &k);
1372 log_error("Invalid array signature.");
1379 memcpy(s, signature, k);
1382 r = sd_bus_message_open_container(m, SD_BUS_TYPE_ARRAY, s);
1384 return bus_log_create_error(r);
1386 for (i = 0; i < n; i++) {
1387 r = message_append_cmdline(m, s, &p);
1395 r = sd_bus_message_close_container(m);
1399 case SD_BUS_TYPE_VARIANT:
1400 r = sd_bus_message_open_container(m, SD_BUS_TYPE_VARIANT, v);
1402 return bus_log_create_error(r);
1404 r = message_append_cmdline(m, v, &p);
1408 r = sd_bus_message_close_container(m);
1411 case SD_BUS_TYPE_STRUCT_BEGIN:
1412 case SD_BUS_TYPE_DICT_ENTRY_BEGIN: {
1418 r = signature_element_length(signature, &k);
1420 log_error("Invalid struct/dict entry signature.");
1426 memcpy(s, signature + 1, k - 2);
1429 r = sd_bus_message_open_container(m, t == SD_BUS_TYPE_STRUCT_BEGIN ? SD_BUS_TYPE_STRUCT : SD_BUS_TYPE_DICT_ENTRY, s);
1431 return bus_log_create_error(r);
1433 r = message_append_cmdline(m, s, &p);
1440 r = sd_bus_message_close_container(m);
1444 case SD_BUS_TYPE_UNIX_FD:
1445 log_error("UNIX file descriptor not supported as type.");
1449 log_error("Unknown signature type %c.", t);
1454 return bus_log_create_error(r);
1461 static int call(sd_bus *bus, char *argv[]) {
1462 _cleanup_bus_error_free_ sd_bus_error error = SD_BUS_ERROR_NULL;
1463 _cleanup_bus_message_unref_ sd_bus_message *m = NULL, *reply = NULL;
1468 if (strv_length(argv) < 5) {
1469 log_error("Expects at least four arguments.");
1473 r = sd_bus_message_new_method_call(bus, &m, argv[1], argv[2], argv[3], argv[4]);
1475 return bus_log_create_error(r);
1477 r = sd_bus_message_set_expect_reply(m, arg_expect_reply);
1479 return bus_log_create_error(r);
1481 r = sd_bus_message_set_auto_start(m, arg_auto_start);
1483 return bus_log_create_error(r);
1485 r = sd_bus_message_set_allow_interactive_authorization(m, arg_allow_interactive_authorization);
1487 return bus_log_create_error(r);
1489 if (!isempty(argv[5])) {
1494 r = message_append_cmdline(m, argv[5], &p);
1499 log_error("Too many parameters for signature.");
1504 if (!arg_expect_reply) {
1505 r = sd_bus_send(bus, m, NULL);
1507 log_error("Failed to send message.");
1514 r = sd_bus_call(bus, m, arg_timeout, &error, &reply);
1516 log_error("%s", bus_error_message(&error, r));
1520 r = sd_bus_message_is_empty(reply);
1522 return bus_log_parse_error(r);
1524 if (r == 0 && !arg_quiet) {
1527 pager_open_if_enabled();
1529 r = bus_message_dump(reply, stdout, 0);
1534 fputs(sd_bus_message_get_signature(reply, true), stdout);
1537 r = format_cmdline(reply, stdout, false);
1539 return bus_log_parse_error(r);
1541 fputc('\n', stdout);
1548 static int get_property(sd_bus *bus, char *argv[]) {
1549 _cleanup_bus_error_free_ sd_bus_error error = SD_BUS_ERROR_NULL;
1556 n = strv_length(argv);
1558 log_error("Expects at least four arguments.");
1562 STRV_FOREACH(i, argv + 4) {
1563 _cleanup_bus_message_unref_ sd_bus_message *reply = NULL;
1564 const char *contents = NULL;
1567 r = sd_bus_call_method(bus, argv[1], argv[2], "org.freedesktop.DBus.Properties", "Get", &error, &reply, "ss", argv[3], *i);
1569 log_error("%s", bus_error_message(&error, r));
1573 r = sd_bus_message_peek_type(reply, &type, &contents);
1575 return bus_log_parse_error(r);
1577 r = sd_bus_message_enter_container(reply, 'v', contents);
1579 return bus_log_parse_error(r);
1582 pager_open_if_enabled();
1584 r = bus_message_dump(reply, stdout, BUS_MESSAGE_DUMP_SUBTREE_ONLY);
1588 fputs(contents, stdout);
1591 r = format_cmdline(reply, stdout, false);
1593 return bus_log_parse_error(r);
1595 fputc('\n', stdout);
1598 r = sd_bus_message_exit_container(reply);
1600 return bus_log_parse_error(r);
1606 static int set_property(sd_bus *bus, char *argv[]) {
1607 _cleanup_bus_message_unref_ sd_bus_message *m = NULL;
1608 _cleanup_bus_error_free_ sd_bus_error error = SD_BUS_ERROR_NULL;
1615 n = strv_length(argv);
1617 log_error("Expects at least five arguments.");
1621 r = sd_bus_message_new_method_call(bus, &m, argv[1], argv[2], "org.freedesktop.DBus.Properties", "Set");
1623 return bus_log_create_error(r);
1625 r = sd_bus_message_append(m, "ss", argv[3], argv[4]);
1627 return bus_log_create_error(r);
1629 r = sd_bus_message_open_container(m, 'v', argv[5]);
1631 return bus_log_create_error(r);
1634 r = message_append_cmdline(m, argv[5], &p);
1638 r = sd_bus_message_close_container(m);
1640 return bus_log_create_error(r);
1643 log_error("Too many parameters for signature.");
1647 r = sd_bus_call(bus, m, arg_timeout, &error, NULL);
1649 log_error("%s", bus_error_message(&error, r));
1656 static int help(void) {
1657 printf("%s [OPTIONS...] {COMMAND} ...\n\n"
1658 "Introspect the bus.\n\n"
1659 " -h --help Show this help\n"
1660 " --version Show package version\n"
1661 " --no-pager Do not pipe output into a pager\n"
1662 " --no-legend Do not show the headers and footers\n"
1663 " --system Connect to system bus\n"
1664 " --user Connect to user bus\n"
1665 " -H --host=[USER@]HOST Operate on remote host\n"
1666 " -M --machine=CONTAINER Operate on local container\n"
1667 " --address=ADDRESS Connect to bus specified by address\n"
1668 " --show-machine Show machine ID column in list\n"
1669 " --unique Only show unique names\n"
1670 " --acquired Only show acquired names\n"
1671 " --activatable Only show activatable names\n"
1672 " --match=MATCH Only show matching messages\n"
1673 " --list Don't show tree, but simple object path list\n"
1674 " --quiet Don't show method call reply\n"
1675 " --verbose Show result values in long format\n"
1676 " --expect-reply=BOOL Expect a method call reply\n"
1677 " --auto-start=BOOL Auto-start destination service\n"
1678 " --allow-interactive-authorization=BOOL\n"
1679 " Allow interactive authorization for operation\n"
1680 " --timeout=SECS Maximum time to wait for method call completion\n"
1681 " --augment-creds=BOOL Extend credential data with data read from /proc/$PID\n\n"
1683 " list List bus names\n"
1684 " status [SERVICE] Show bus service, process or bus owner credentials\n"
1685 " monitor [SERVICE...] Show bus traffic\n"
1686 " capture [SERVICE...] Capture bus traffic as pcap\n"
1687 " tree [SERVICE...] Show object tree of service\n"
1688 " introspect SERVICE OBJECT\n"
1689 " call SERVICE OBJECT INTERFACE METHOD [SIGNATURE [ARGUMENT...]]\n"
1691 " get-property SERVICE OBJECT INTERFACE PROPERTY...\n"
1692 " Get property value\n"
1693 " set-property SERVICE OBJECT INTERFACE PROPERTY SIGNATURE ARGUMENT...\n"
1694 " Set property value\n"
1695 " help Show this help\n"
1696 , program_invocation_short_name);
1701 static int parse_argv(int argc, char *argv[]) {
1704 ARG_VERSION = 0x100,
1720 ARG_ALLOW_INTERACTIVE_AUTHORIZATION,
1725 static const struct option options[] = {
1726 { "help", no_argument, NULL, 'h' },
1727 { "version", no_argument, NULL, ARG_VERSION },
1728 { "no-pager", no_argument, NULL, ARG_NO_PAGER },
1729 { "no-legend", no_argument, NULL, ARG_NO_LEGEND },
1730 { "system", no_argument, NULL, ARG_SYSTEM },
1731 { "user", no_argument, NULL, ARG_USER },
1732 { "address", required_argument, NULL, ARG_ADDRESS },
1733 { "show-machine", no_argument, NULL, ARG_SHOW_MACHINE },
1734 { "unique", no_argument, NULL, ARG_UNIQUE },
1735 { "acquired", no_argument, NULL, ARG_ACQUIRED },
1736 { "activatable", no_argument, NULL, ARG_ACTIVATABLE },
1737 { "match", required_argument, NULL, ARG_MATCH },
1738 { "host", required_argument, NULL, 'H' },
1739 { "machine", required_argument, NULL, 'M' },
1740 { "size", required_argument, NULL, ARG_SIZE },
1741 { "list", no_argument, NULL, ARG_LIST },
1742 { "quiet", no_argument, NULL, 'q' },
1743 { "verbose", no_argument, NULL, ARG_VERBOSE },
1744 { "expect-reply", required_argument, NULL, ARG_EXPECT_REPLY },
1745 { "auto-start", required_argument, NULL, ARG_AUTO_START },
1746 { "allow-interactive-authorization", required_argument, NULL, ARG_ALLOW_INTERACTIVE_AUTHORIZATION },
1747 { "timeout", required_argument, NULL, ARG_TIMEOUT },
1748 { "augment-creds",required_argument, NULL, ARG_AUGMENT_CREDS},
1757 while ((c = getopt_long(argc, argv, "hH:M:q", options, NULL)) >= 0)
1765 puts(PACKAGE_STRING);
1766 puts(SYSTEMD_FEATURES);
1770 arg_no_pager = true;
1786 arg_address = optarg;
1789 case ARG_SHOW_MACHINE:
1790 arg_show_machine = true;
1798 arg_acquired = true;
1801 case ARG_ACTIVATABLE:
1802 arg_activatable = true;
1806 if (strv_extend(&arg_matches, optarg) < 0)
1813 r = parse_size(optarg, 0, &o);
1815 log_error("Failed to parse size: %s", optarg);
1819 if ((off_t) (size_t) o != o) {
1820 log_error("Size out of range.");
1824 arg_snaplen = (size_t) o;
1833 arg_transport = BUS_TRANSPORT_REMOTE;
1838 arg_transport = BUS_TRANSPORT_CONTAINER;
1850 case ARG_EXPECT_REPLY:
1851 r = parse_boolean(optarg);
1853 log_error("Failed to parse --expect-reply= parameter.");
1857 arg_expect_reply = !!r;
1861 case ARG_AUTO_START:
1862 r = parse_boolean(optarg);
1864 log_error("Failed to parse --auto-start= parameter.");
1868 arg_auto_start = !!r;
1872 case ARG_ALLOW_INTERACTIVE_AUTHORIZATION:
1873 r = parse_boolean(optarg);
1875 log_error("Failed to parse --allow-interactive-authorization= parameter.");
1879 arg_allow_interactive_authorization = !!r;
1883 r = parse_sec(optarg, &arg_timeout);
1885 log_error("Failed to parse --timeout= parameter.");
1891 case ARG_AUGMENT_CREDS:
1892 r = parse_boolean(optarg);
1894 log_error("Failed to parse --augment-creds= parameter.");
1898 arg_augment_creds = !!r;
1905 assert_not_reached("Unhandled option");
1911 static int busctl_main(sd_bus *bus, int argc, char *argv[]) {
1914 if (optind >= argc ||
1915 streq(argv[optind], "list"))
1916 return list_bus_names(bus, argv + optind);
1918 if (streq(argv[optind], "monitor"))
1919 return monitor(bus, argv + optind, message_dump);
1921 if (streq(argv[optind], "capture"))
1922 return capture(bus, argv + optind);
1924 if (streq(argv[optind], "status"))
1925 return status(bus, argv + optind);
1927 if (streq(argv[optind], "tree"))
1928 return tree(bus, argv + optind);
1930 if (streq(argv[optind], "introspect"))
1931 return introspect(bus, argv + optind);
1933 if (streq(argv[optind], "call"))
1934 return call(bus, argv + optind);
1936 if (streq(argv[optind], "get-property"))
1937 return get_property(bus, argv + optind);
1939 if (streq(argv[optind], "set-property"))
1940 return set_property(bus, argv + optind);
1942 if (streq(argv[optind], "help"))
1945 log_error("Unknown command '%s'", argv[optind]);
1949 int main(int argc, char *argv[]) {
1950 _cleanup_bus_close_unref_ sd_bus *bus = NULL;
1953 log_parse_environment();
1956 r = parse_argv(argc, argv);
1960 r = sd_bus_new(&bus);
1962 log_error_errno(r, "Failed to allocate bus: %m");
1966 if (streq_ptr(argv[optind], "monitor") ||
1967 streq_ptr(argv[optind], "capture")) {
1969 r = sd_bus_set_monitor(bus, true);
1971 log_error_errno(r, "Failed to set monitor mode: %m");
1975 r = sd_bus_negotiate_creds(bus, true, _SD_BUS_CREDS_ALL);
1977 log_error_errno(r, "Failed to enable credentials: %m");
1981 r = sd_bus_negotiate_timestamp(bus, true);
1983 log_error_errno(r, "Failed to enable timestamps: %m");
1987 r = sd_bus_negotiate_fds(bus, true);
1989 log_error_errno(r, "Failed to enable fds: %m");
1995 r = sd_bus_set_address(bus, arg_address);
1997 r = sd_bus_set_bus_client(bus, true);
1999 log_error_errno(r, "Failed to set bus client: %m");
2003 switch (arg_transport) {
2005 case BUS_TRANSPORT_LOCAL:
2007 bus->is_user = true;
2008 r = bus_set_address_user(bus);
2010 bus->is_system = true;
2011 r = bus_set_address_system(bus);
2015 case BUS_TRANSPORT_REMOTE:
2016 r = bus_set_address_system_remote(bus, arg_host);
2019 case BUS_TRANSPORT_CONTAINER:
2020 r = bus_set_address_system_container(bus, arg_host);
2024 assert_not_reached("Hmm, unknown transport type.");
2028 log_error_errno(r, "Failed to set address: %m");
2032 r = sd_bus_start(bus);
2034 log_error_errno(r, "Failed to connect to bus: %m");
2038 r = busctl_main(bus, argc, argv);
2043 strv_free(arg_matches);
2045 return r < 0 ? EXIT_FAILURE : EXIT_SUCCESS;