]> git.ipfire.org Git - thirdparty/systemd.git/blob - src/systemctl/systemctl-list-units.c
Merge pull request #18611 from poettering/ifname-validate-tighter
[thirdparty/systemd.git] / src / systemctl / systemctl-list-units.c
1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
2
3 #include "sd-login.h"
4
5 #include "bus-error.h"
6 #include "format-table.h"
7 #include "locale-util.h"
8 #include "set.h"
9 #include "sort-util.h"
10 #include "systemctl-list-units.h"
11 #include "systemctl-util.h"
12 #include "systemctl.h"
13 #include "terminal-util.h"
14
15 static void message_set_freep(Set **set) {
16 set_free_with_destructor(*set, sd_bus_message_unref);
17 }
18
19 static int get_unit_list_recursive(
20 sd_bus *bus,
21 char **patterns,
22 UnitInfo **ret_unit_infos,
23 Set **ret_replies,
24 char ***ret_machines) {
25
26 _cleanup_free_ UnitInfo *unit_infos = NULL;
27 _cleanup_(message_set_freep) Set *replies;
28 sd_bus_message *reply;
29 int c, r;
30
31 assert(bus);
32 assert(ret_replies);
33 assert(ret_unit_infos);
34 assert(ret_machines);
35
36 replies = set_new(NULL);
37 if (!replies)
38 return log_oom();
39
40 c = get_unit_list(bus, NULL, patterns, &unit_infos, 0, &reply);
41 if (c < 0)
42 return c;
43
44 r = set_put(replies, reply);
45 if (r < 0) {
46 sd_bus_message_unref(reply);
47 return log_oom();
48 }
49
50 if (arg_recursive) {
51 _cleanup_strv_free_ char **machines = NULL;
52 char **i;
53
54 r = sd_get_machine_names(&machines);
55 if (r < 0)
56 return log_error_errno(r, "Failed to get machine names: %m");
57
58 STRV_FOREACH(i, machines) {
59 _cleanup_(sd_bus_flush_close_unrefp) sd_bus *container = NULL;
60 int k;
61
62 r = sd_bus_open_system_machine(&container, *i);
63 if (r < 0) {
64 log_warning_errno(r, "Failed to connect to container %s, ignoring: %m", *i);
65 continue;
66 }
67
68 k = get_unit_list(container, *i, patterns, &unit_infos, c, &reply);
69 if (k < 0)
70 return k;
71
72 c = k;
73
74 r = set_put(replies, reply);
75 if (r < 0) {
76 sd_bus_message_unref(reply);
77 return log_oom();
78 }
79 }
80
81 *ret_machines = TAKE_PTR(machines);
82 } else
83 *ret_machines = NULL;
84
85 *ret_unit_infos = TAKE_PTR(unit_infos);
86 *ret_replies = TAKE_PTR(replies);
87
88 return c;
89 }
90
91 static int output_units_list(const UnitInfo *unit_infos, unsigned c) {
92 _cleanup_(table_unrefp) Table *table = NULL;
93 unsigned job_count = 0;
94 int r;
95
96 table = table_new("", "unit", "load", "active", "sub", "job", "description");
97 if (!table)
98 return log_oom();
99
100 table_set_header(table, !arg_no_legend);
101 if (arg_plain) {
102 /* Hide the 'glyph' column when --plain is requested */
103 r = table_hide_column_from_display(table, 0);
104 if (r < 0)
105 return log_error_errno(r, "Failed to hide column: %m");
106 }
107 if (arg_full)
108 table_set_width(table, 0);
109
110 (void) table_set_empty_string(table, "-");
111
112 for (const UnitInfo *u = unit_infos; unit_infos && (size_t) (u - unit_infos) < c; u++) {
113 _cleanup_free_ char *j = NULL;
114 const char *on_underline = "", *on_loaded = "", *on_active = "";
115 const char *on_circle = "", *id;
116 bool circle = false, underline = false;
117
118 if (u + 1 < unit_infos + c &&
119 !streq(unit_type_suffix(u->id), unit_type_suffix((u + 1)->id))) {
120 on_underline = ansi_underline();
121 underline = true;
122 }
123
124 if (STR_IN_SET(u->load_state, "error", "not-found", "bad-setting", "masked") && !arg_plain) {
125 on_circle = underline ? ansi_highlight_yellow_underline() : ansi_highlight_yellow();
126 circle = true;
127 on_loaded = underline ? ansi_highlight_red_underline() : ansi_highlight_red();
128 } else if (streq(u->active_state, "failed") && !arg_plain) {
129 on_circle = underline ? ansi_highlight_red_underline() : ansi_highlight_red();
130 circle = true;
131 on_active = underline ? ansi_highlight_red_underline() : ansi_highlight_red();
132 } else {
133 on_circle = on_underline;
134 on_active = on_underline;
135 on_loaded = on_underline;
136 }
137
138 if (u->machine) {
139 j = strjoin(u->machine, ":", u->id);
140 if (!j)
141 return log_oom();
142
143 id = j;
144 } else
145 id = u->id;
146
147 r = table_add_many(table,
148 TABLE_STRING, circle ? special_glyph(SPECIAL_GLYPH_BLACK_CIRCLE) : " ",
149 TABLE_SET_BOTH_COLORS, on_circle,
150 TABLE_STRING, id,
151 TABLE_SET_BOTH_COLORS, on_active,
152 TABLE_STRING, u->load_state,
153 TABLE_SET_BOTH_COLORS, on_loaded,
154 TABLE_STRING, u->active_state,
155 TABLE_SET_BOTH_COLORS, on_active,
156 TABLE_STRING, u->sub_state,
157 TABLE_SET_BOTH_COLORS, on_active,
158 TABLE_STRING, u->job_id ? u->job_type: "",
159 TABLE_SET_BOTH_COLORS, on_underline,
160 TABLE_STRING, u->description,
161 TABLE_SET_BOTH_COLORS, on_underline);
162 if (r < 0)
163 return table_log_add_error(r);
164
165 if (u->job_id != 0)
166 job_count++;
167 }
168
169 if (job_count == 0) {
170 /* There's no data in the JOB column, so let's hide it */
171 r = table_hide_column_from_display(table, 5);
172 if (r < 0)
173 return log_error_errno(r, "Failed to hide column: %m");
174 }
175
176 r = output_table(table);
177 if (r < 0)
178 return r;
179
180 if (!arg_no_legend) {
181 const char *on, *off;
182 size_t records = table_get_rows(table) - 1;
183
184 if (records > 0) {
185 puts("\n"
186 "LOAD = Reflects whether the unit definition was properly loaded.\n"
187 "ACTIVE = The high-level unit activation state, i.e. generalization of SUB.\n"
188 "SUB = The low-level unit activation state, values depend on unit type.");
189 if (job_count > 0)
190 puts("JOB = Pending job for the unit.\n");
191 on = ansi_highlight();
192 off = ansi_normal();
193 } else {
194 on = ansi_highlight_red();
195 off = ansi_normal();
196 }
197
198 if (arg_all || strv_contains(arg_states, "inactive"))
199 printf("%s%zu loaded units listed.%s\n"
200 "To show all installed unit files use 'systemctl list-unit-files'.\n",
201 on, records, off);
202 else if (!arg_states)
203 printf("%s%zu loaded units listed.%s Pass --all to see loaded but inactive units, too.\n"
204 "To show all installed unit files use 'systemctl list-unit-files'.\n",
205 on, records, off);
206 else
207 printf("%zu loaded units listed.\n", records);
208 }
209
210 return 0;
211 }
212
213 int list_units(int argc, char *argv[], void *userdata) {
214 _cleanup_free_ UnitInfo *unit_infos = NULL;
215 _cleanup_(message_set_freep) Set *replies = NULL;
216 _cleanup_strv_free_ char **machines = NULL;
217 sd_bus *bus;
218 int r;
219
220 r = acquire_bus(BUS_MANAGER, &bus);
221 if (r < 0)
222 return r;
223
224 (void) pager_open(arg_pager_flags);
225
226 if (arg_with_dependencies) {
227 _cleanup_strv_free_ char **names = NULL;
228
229 r = append_unit_dependencies(bus, strv_skip(argv, 1), &names);
230 if (r < 0)
231 return r;
232
233 r = get_unit_list_recursive(bus, names, &unit_infos, &replies, &machines);
234 if (r < 0)
235 return r;
236 } else {
237 r = get_unit_list_recursive(bus, strv_skip(argv, 1), &unit_infos, &replies, &machines);
238 if (r < 0)
239 return r;
240 }
241
242 typesafe_qsort(unit_infos, r, unit_info_compare);
243 return output_units_list(unit_infos, r);
244 }
245
246 static int get_triggered_units(
247 sd_bus *bus,
248 const char* path,
249 char*** ret) {
250
251 _cleanup_(sd_bus_error_free) sd_bus_error error = SD_BUS_ERROR_NULL;
252 int r;
253
254 assert(bus);
255 assert(path);
256 assert(ret);
257
258 r = sd_bus_get_property_strv(
259 bus,
260 "org.freedesktop.systemd1",
261 path,
262 "org.freedesktop.systemd1.Unit",
263 "Triggers",
264 &error,
265 ret);
266 if (r < 0)
267 return log_error_errno(r, "Failed to determine triggers: %s", bus_error_message(&error, r));
268
269 return 0;
270 }
271
272 static int get_listening(
273 sd_bus *bus,
274 const char* unit_path,
275 char*** listening) {
276
277 _cleanup_(sd_bus_error_free) sd_bus_error error = SD_BUS_ERROR_NULL;
278 _cleanup_(sd_bus_message_unrefp) sd_bus_message *reply = NULL;
279 const char *type, *path;
280 int r, n = 0;
281
282 r = sd_bus_get_property(
283 bus,
284 "org.freedesktop.systemd1",
285 unit_path,
286 "org.freedesktop.systemd1.Socket",
287 "Listen",
288 &error,
289 &reply,
290 "a(ss)");
291 if (r < 0)
292 return log_error_errno(r, "Failed to get list of listening sockets: %s", bus_error_message(&error, r));
293
294 r = sd_bus_message_enter_container(reply, SD_BUS_TYPE_ARRAY, "(ss)");
295 if (r < 0)
296 return bus_log_parse_error(r);
297
298 while ((r = sd_bus_message_read(reply, "(ss)", &type, &path)) > 0) {
299
300 r = strv_extend(listening, type);
301 if (r < 0)
302 return log_oom();
303
304 r = strv_extend(listening, path);
305 if (r < 0)
306 return log_oom();
307
308 n++;
309 }
310 if (r < 0)
311 return bus_log_parse_error(r);
312
313 r = sd_bus_message_exit_container(reply);
314 if (r < 0)
315 return bus_log_parse_error(r);
316
317 return n;
318 }
319
320 struct socket_info {
321 const char *machine;
322 const char* id;
323
324 char* type;
325 char* path;
326
327 /* Note: triggered is a list here, although it almost certainly will always be one
328 * unit. Nevertheless, dbus API allows for multiple values, so let's follow that. */
329 char** triggered;
330
331 /* The strv above is shared. free is set only in the first one. */
332 bool own_triggered;
333 };
334
335 static int socket_info_compare(const struct socket_info *a, const struct socket_info *b) {
336 int r;
337
338 assert(a);
339 assert(b);
340
341 r = strcasecmp_ptr(a->machine, b->machine);
342 if (r != 0)
343 return r;
344
345 r = strcmp(a->path, b->path);
346 if (r != 0)
347 return r;
348
349 return strcmp(a->type, b->type);
350 }
351
352 static int output_sockets_list(struct socket_info *socket_infos, unsigned cs) {
353 _cleanup_(table_unrefp) Table *table = NULL;
354 const char *on, *off;
355 int r;
356
357 table = table_new("listen", "type", "unit", "activates");
358 if (!table)
359 return log_oom();
360
361 if (!arg_show_types) {
362 /* Hide the second (TYPE) column */
363 r = table_set_display(table, (size_t) 0, (size_t) 2, (size_t) 3, (size_t) -1);
364 if (r < 0)
365 return log_error_errno(r, "Failed to set columns to display: %m");
366 }
367
368 table_set_header(table, !arg_no_legend);
369 if (arg_full)
370 table_set_width(table, 0);
371
372 (void) table_set_empty_string(table, "-");
373
374 if (cs) {
375 for (struct socket_info *s = socket_infos; s < socket_infos + cs; s++) {
376 _cleanup_free_ char *j = NULL;
377 const char *path;
378
379 if (s->machine) {
380 j = strjoin(s->machine, ":", s->path);
381 if (!j)
382 return log_oom();
383 path = j;
384 } else
385 path = s->path;
386
387 r = table_add_many(table,
388 TABLE_STRING, path,
389 TABLE_STRING, s->type,
390 TABLE_STRING, s->id);
391 if (r < 0)
392 return table_log_add_error(r);
393
394 if (strv_isempty(s->triggered))
395 r = table_add_cell(table, NULL, TABLE_EMPTY, NULL);
396 else if (strv_length(s->triggered) == 1)
397 r = table_add_cell(table, NULL, TABLE_STRING, s->triggered[0]);
398 else
399 /* This should never happen, currently our socket units can only trigger a
400 * single unit. But let's handle this anyway, who knows what the future
401 * brings? */
402 r = table_add_cell(table, NULL, TABLE_STRV, s->triggered);
403 if (r < 0)
404 return table_log_add_error(r);
405
406 }
407
408 on = ansi_highlight();
409 off = ansi_normal();
410 } else {
411 on = ansi_highlight_red();
412 off = ansi_normal();
413 }
414
415 r = output_table(table);
416 if (r < 0)
417 return r;
418
419 if (!arg_no_legend) {
420 printf("\n%s%u sockets listed.%s\n", on, cs, off);
421 if (!arg_all)
422 printf("Pass --all to see loaded but inactive sockets, too.\n");
423 }
424
425 return 0;
426 }
427
428 int list_sockets(int argc, char *argv[], void *userdata) {
429 _cleanup_(message_set_freep) Set *replies = NULL;
430 _cleanup_strv_free_ char **machines = NULL;
431 _cleanup_strv_free_ char **sockets_with_suffix = NULL;
432 _cleanup_free_ UnitInfo *unit_infos = NULL;
433 _cleanup_free_ struct socket_info *socket_infos = NULL;
434 unsigned cs = 0;
435 size_t size = 0;
436 int r, n;
437 sd_bus *bus;
438
439 r = acquire_bus(BUS_MANAGER, &bus);
440 if (r < 0)
441 return r;
442
443 (void) pager_open(arg_pager_flags);
444
445 r = expand_unit_names(bus, strv_skip(argv, 1), ".socket", &sockets_with_suffix, NULL);
446 if (r < 0)
447 return r;
448
449 if (argc == 1 || sockets_with_suffix) {
450 n = get_unit_list_recursive(bus, sockets_with_suffix, &unit_infos, &replies, &machines);
451 if (n < 0)
452 return n;
453
454 for (const UnitInfo *u = unit_infos; u < unit_infos + n; u++) {
455 _cleanup_strv_free_ char **listening = NULL, **triggered = NULL;
456 int c;
457
458 if (!endswith(u->id, ".socket"))
459 continue;
460
461 r = get_triggered_units(bus, u->unit_path, &triggered);
462 if (r < 0)
463 goto cleanup;
464
465 c = get_listening(bus, u->unit_path, &listening);
466 if (c < 0) {
467 r = c;
468 goto cleanup;
469 }
470
471 if (!GREEDY_REALLOC(socket_infos, size, cs + c)) {
472 r = log_oom();
473 goto cleanup;
474 }
475
476 for (int i = 0; i < c; i++)
477 socket_infos[cs + i] = (struct socket_info) {
478 .machine = u->machine,
479 .id = u->id,
480 .type = listening[i*2],
481 .path = listening[i*2 + 1],
482 .triggered = triggered,
483 .own_triggered = i==0,
484 };
485
486 /* from this point on we will cleanup those socket_infos */
487 cs += c;
488 free(listening);
489 listening = triggered = NULL; /* avoid cleanup */
490 }
491
492 typesafe_qsort(socket_infos, cs, socket_info_compare);
493 }
494
495 output_sockets_list(socket_infos, cs);
496
497 cleanup:
498 assert(cs == 0 || socket_infos);
499 for (struct socket_info *s = socket_infos; s < socket_infos + cs; s++) {
500 free(s->type);
501 free(s->path);
502 if (s->own_triggered)
503 strv_free(s->triggered);
504 }
505
506 return r;
507 }
508
509 static int get_next_elapse(
510 sd_bus *bus,
511 const char *path,
512 dual_timestamp *next) {
513
514 _cleanup_(sd_bus_error_free) sd_bus_error error = SD_BUS_ERROR_NULL;
515 dual_timestamp t;
516 int r;
517
518 assert(bus);
519 assert(path);
520 assert(next);
521
522 r = sd_bus_get_property_trivial(
523 bus,
524 "org.freedesktop.systemd1",
525 path,
526 "org.freedesktop.systemd1.Timer",
527 "NextElapseUSecMonotonic",
528 &error,
529 't',
530 &t.monotonic);
531 if (r < 0)
532 return log_error_errno(r, "Failed to get next elapse time: %s", bus_error_message(&error, r));
533
534 r = sd_bus_get_property_trivial(
535 bus,
536 "org.freedesktop.systemd1",
537 path,
538 "org.freedesktop.systemd1.Timer",
539 "NextElapseUSecRealtime",
540 &error,
541 't',
542 &t.realtime);
543 if (r < 0)
544 return log_error_errno(r, "Failed to get next elapse time: %s", bus_error_message(&error, r));
545
546 *next = t;
547 return 0;
548 }
549
550 static int get_last_trigger(
551 sd_bus *bus,
552 const char *path,
553 usec_t *last) {
554
555 _cleanup_(sd_bus_error_free) sd_bus_error error = SD_BUS_ERROR_NULL;
556 int r;
557
558 assert(bus);
559 assert(path);
560 assert(last);
561
562 r = sd_bus_get_property_trivial(
563 bus,
564 "org.freedesktop.systemd1",
565 path,
566 "org.freedesktop.systemd1.Timer",
567 "LastTriggerUSec",
568 &error,
569 't',
570 last);
571 if (r < 0)
572 return log_error_errno(r, "Failed to get last trigger time: %s", bus_error_message(&error, r));
573
574 return 0;
575 }
576
577 struct timer_info {
578 const char* machine;
579 const char* id;
580 usec_t next_elapse;
581 usec_t last_trigger;
582 char** triggered;
583 };
584
585 static int timer_info_compare(const struct timer_info *a, const struct timer_info *b) {
586 int r;
587
588 assert(a);
589 assert(b);
590
591 r = strcasecmp_ptr(a->machine, b->machine);
592 if (r != 0)
593 return r;
594
595 r = CMP(a->next_elapse, b->next_elapse);
596 if (r != 0)
597 return r;
598
599 return strcmp(a->id, b->id);
600 }
601
602 static int output_timers_list(struct timer_info *timer_infos, unsigned n) {
603 _cleanup_(table_unrefp) Table *table = NULL;
604 const char *on, *off;
605 int r;
606
607 assert(timer_infos || n == 0);
608
609 table = table_new("next", "left", "last", "passed", "unit", "activates");
610 if (!table)
611 return log_oom();
612
613 table_set_header(table, !arg_no_legend);
614 if (arg_full)
615 table_set_width(table, 0);
616
617 (void) table_set_empty_string(table, "-");
618
619 for (struct timer_info *t = timer_infos; t < timer_infos + n; t++) {
620 _cleanup_free_ char *j = NULL, *activates = NULL;
621 const char *unit;
622
623 if (t->machine) {
624 j = strjoin(t->machine, ":", t->id);
625 if (!j)
626 return log_oom();
627 unit = j;
628 } else
629 unit = t->id;
630
631 activates = strv_join(t->triggered, ", ");
632 if (!activates)
633 return log_oom();
634
635 r = table_add_many(table,
636 TABLE_TIMESTAMP, t->next_elapse,
637 TABLE_TIMESTAMP_RELATIVE, t->next_elapse,
638 TABLE_TIMESTAMP, t->last_trigger,
639 TABLE_TIMESTAMP_RELATIVE, t->last_trigger,
640 TABLE_STRING, unit,
641 TABLE_STRING, activates);
642 if (r < 0)
643 return table_log_add_error(r);
644 }
645
646 if (n > 0) {
647 on = ansi_highlight();
648 off = ansi_normal();
649 } else {
650 on = ansi_highlight_red();
651 off = ansi_normal();
652 }
653
654 r = output_table(table);
655 if (r < 0)
656 return r;
657
658 if (!arg_no_legend) {
659 printf("\n%s%u timers listed.%s\n", on, n, off);
660 if (!arg_all)
661 printf("Pass --all to see loaded but inactive timers, too.\n");
662 }
663
664 return 0;
665 }
666
667 usec_t calc_next_elapse(dual_timestamp *nw, dual_timestamp *next) {
668 usec_t next_elapse;
669
670 assert(nw);
671 assert(next);
672
673 if (timestamp_is_set(next->monotonic)) {
674 usec_t converted;
675
676 if (next->monotonic > nw->monotonic)
677 converted = nw->realtime + (next->monotonic - nw->monotonic);
678 else
679 converted = nw->realtime - (nw->monotonic - next->monotonic);
680
681 if (timestamp_is_set(next->realtime))
682 next_elapse = MIN(converted, next->realtime);
683 else
684 next_elapse = converted;
685
686 } else
687 next_elapse = next->realtime;
688
689 return next_elapse;
690 }
691
692 int list_timers(int argc, char *argv[], void *userdata) {
693 _cleanup_(message_set_freep) Set *replies = NULL;
694 _cleanup_strv_free_ char **machines = NULL;
695 _cleanup_strv_free_ char **timers_with_suffix = NULL;
696 _cleanup_free_ struct timer_info *timer_infos = NULL;
697 _cleanup_free_ UnitInfo *unit_infos = NULL;
698 size_t size = 0;
699 int n, c = 0;
700 dual_timestamp nw;
701 sd_bus *bus;
702 int r;
703
704 r = acquire_bus(BUS_MANAGER, &bus);
705 if (r < 0)
706 return r;
707
708 (void) pager_open(arg_pager_flags);
709
710 r = expand_unit_names(bus, strv_skip(argv, 1), ".timer", &timers_with_suffix, NULL);
711 if (r < 0)
712 return r;
713
714 if (argc == 1 || timers_with_suffix) {
715 n = get_unit_list_recursive(bus, timers_with_suffix, &unit_infos, &replies, &machines);
716 if (n < 0)
717 return n;
718
719 dual_timestamp_get(&nw);
720
721 for (const UnitInfo *u = unit_infos; u < unit_infos + n; u++) {
722 _cleanup_strv_free_ char **triggered = NULL;
723 dual_timestamp next = DUAL_TIMESTAMP_NULL;
724 usec_t m, last = 0;
725
726 if (!endswith(u->id, ".timer"))
727 continue;
728
729 r = get_triggered_units(bus, u->unit_path, &triggered);
730 if (r < 0)
731 goto cleanup;
732
733 r = get_next_elapse(bus, u->unit_path, &next);
734 if (r < 0)
735 goto cleanup;
736
737 get_last_trigger(bus, u->unit_path, &last);
738
739 if (!GREEDY_REALLOC(timer_infos, size, c+1)) {
740 r = log_oom();
741 goto cleanup;
742 }
743
744 m = calc_next_elapse(&nw, &next);
745
746 timer_infos[c++] = (struct timer_info) {
747 .machine = u->machine,
748 .id = u->id,
749 .next_elapse = m,
750 .last_trigger = last,
751 .triggered = TAKE_PTR(triggered),
752 };
753 }
754
755 typesafe_qsort(timer_infos, c, timer_info_compare);
756 }
757
758 output_timers_list(timer_infos, c);
759
760 cleanup:
761 for (struct timer_info *t = timer_infos; t < timer_infos + c; t++)
762 strv_free(t->triggered);
763
764 return r;
765 }