]> git.ipfire.org Git - thirdparty/systemd.git/blob - src/run/run.c
run: exit early in --pty if service failed
[thirdparty/systemd.git] / src / run / run.c
1 /***
2 This file is part of systemd.
3
4 Copyright 2013 Lennart Poettering
5
6 systemd is free software; you can redistribute it and/or modify it
7 under the terms of the GNU Lesser General Public License as published by
8 the Free Software Foundation; either version 2.1 of the License, or
9 (at your option) any later version.
10
11 systemd is distributed in the hope that it will be useful, but
12 WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 Lesser General Public License for more details.
15
16 You should have received a copy of the GNU Lesser General Public License
17 along with systemd; If not, see <http://www.gnu.org/licenses/>.
18 ***/
19
20 #include <getopt.h>
21 #include <stdio.h>
22
23 #include "sd-bus.h"
24 #include "sd-event.h"
25
26 #include "alloc-util.h"
27 #include "bus-error.h"
28 #include "bus-unit-util.h"
29 #include "bus-util.h"
30 #include "calendarspec.h"
31 #include "env-util.h"
32 #include "fd-util.h"
33 #include "format-util.h"
34 #include "parse-util.h"
35 #include "path-util.h"
36 #include "process-util.h"
37 #include "ptyfwd.h"
38 #include "signal-util.h"
39 #include "spawn-polkit-agent.h"
40 #include "strv.h"
41 #include "terminal-util.h"
42 #include "unit-name.h"
43 #include "user-util.h"
44
45 static bool arg_ask_password = true;
46 static bool arg_scope = false;
47 static bool arg_remain_after_exit = false;
48 static bool arg_no_block = false;
49 static bool arg_wait = false;
50 static const char *arg_unit = NULL;
51 static const char *arg_description = NULL;
52 static const char *arg_slice = NULL;
53 static bool arg_send_sighup = false;
54 static BusTransport arg_transport = BUS_TRANSPORT_LOCAL;
55 static const char *arg_host = NULL;
56 static bool arg_user = false;
57 static const char *arg_service_type = NULL;
58 static const char *arg_exec_user = NULL;
59 static const char *arg_exec_group = NULL;
60 static int arg_nice = 0;
61 static bool arg_nice_set = false;
62 static char **arg_environment = NULL;
63 static char **arg_property = NULL;
64 static bool arg_pty = false;
65 static usec_t arg_on_active = 0;
66 static usec_t arg_on_boot = 0;
67 static usec_t arg_on_startup = 0;
68 static usec_t arg_on_unit_active = 0;
69 static usec_t arg_on_unit_inactive = 0;
70 static const char *arg_on_calendar = NULL;
71 static char **arg_timer_property = NULL;
72 static bool arg_quiet = false;
73
74 static void polkit_agent_open_if_enabled(void) {
75
76 /* Open the polkit agent as a child process if necessary */
77 if (!arg_ask_password)
78 return;
79
80 if (arg_transport != BUS_TRANSPORT_LOCAL)
81 return;
82
83 polkit_agent_open();
84 }
85
86 static void help(void) {
87 printf("%s [OPTIONS...] {COMMAND} [ARGS...]\n\n"
88 "Run the specified command in a transient scope or service.\n\n"
89 " -h --help Show this help\n"
90 " --version Show package version\n"
91 " --no-ask-password Do not prompt for password\n"
92 " --user Run as user unit\n"
93 " -H --host=[USER@]HOST Operate on remote host\n"
94 " -M --machine=CONTAINER Operate on local container\n"
95 " --scope Run this as scope rather than service\n"
96 " --unit=UNIT Run under the specified unit name\n"
97 " -p --property=NAME=VALUE Set service or scope unit property\n"
98 " --description=TEXT Description for unit\n"
99 " --slice=SLICE Run in the specified slice\n"
100 " --no-block Do not wait until operation finished\n"
101 " -r --remain-after-exit Leave service around until explicitly stopped\n"
102 " --wait Wait until service stopped again\n"
103 " --send-sighup Send SIGHUP when terminating\n"
104 " --service-type=TYPE Service type\n"
105 " --uid=USER Run as system user\n"
106 " --gid=GROUP Run as system group\n"
107 " --nice=NICE Nice level\n"
108 " -E --setenv=NAME=VALUE Set environment\n"
109 " -t --pty Run service on pseudo tty\n"
110 " -q --quiet Suppress information messages during runtime\n\n"
111 "Timer options:\n"
112 " --on-active=SECONDS Run after SECONDS delay\n"
113 " --on-boot=SECONDS Run SECONDS after machine was booted up\n"
114 " --on-startup=SECONDS Run SECONDS after systemd activation\n"
115 " --on-unit-active=SECONDS Run SECONDS after the last activation\n"
116 " --on-unit-inactive=SECONDS Run SECONDS after the last deactivation\n"
117 " --on-calendar=SPEC Realtime timer\n"
118 " --timer-property=NAME=VALUE Set timer unit property\n"
119 , program_invocation_short_name);
120 }
121
122 static bool with_timer(void) {
123 return arg_on_active || arg_on_boot || arg_on_startup || arg_on_unit_active || arg_on_unit_inactive || arg_on_calendar;
124 }
125
126 static int parse_argv(int argc, char *argv[]) {
127
128 enum {
129 ARG_VERSION = 0x100,
130 ARG_USER,
131 ARG_SYSTEM,
132 ARG_SCOPE,
133 ARG_UNIT,
134 ARG_DESCRIPTION,
135 ARG_SLICE,
136 ARG_SEND_SIGHUP,
137 ARG_SERVICE_TYPE,
138 ARG_EXEC_USER,
139 ARG_EXEC_GROUP,
140 ARG_NICE,
141 ARG_ON_ACTIVE,
142 ARG_ON_BOOT,
143 ARG_ON_STARTUP,
144 ARG_ON_UNIT_ACTIVE,
145 ARG_ON_UNIT_INACTIVE,
146 ARG_ON_CALENDAR,
147 ARG_TIMER_PROPERTY,
148 ARG_NO_BLOCK,
149 ARG_NO_ASK_PASSWORD,
150 ARG_WAIT,
151 };
152
153 static const struct option options[] = {
154 { "help", no_argument, NULL, 'h' },
155 { "version", no_argument, NULL, ARG_VERSION },
156 { "user", no_argument, NULL, ARG_USER },
157 { "system", no_argument, NULL, ARG_SYSTEM },
158 { "scope", no_argument, NULL, ARG_SCOPE },
159 { "unit", required_argument, NULL, ARG_UNIT },
160 { "description", required_argument, NULL, ARG_DESCRIPTION },
161 { "slice", required_argument, NULL, ARG_SLICE },
162 { "remain-after-exit", no_argument, NULL, 'r' },
163 { "send-sighup", no_argument, NULL, ARG_SEND_SIGHUP },
164 { "host", required_argument, NULL, 'H' },
165 { "machine", required_argument, NULL, 'M' },
166 { "service-type", required_argument, NULL, ARG_SERVICE_TYPE },
167 { "wait", no_argument, NULL, ARG_WAIT },
168 { "uid", required_argument, NULL, ARG_EXEC_USER },
169 { "gid", required_argument, NULL, ARG_EXEC_GROUP },
170 { "nice", required_argument, NULL, ARG_NICE },
171 { "setenv", required_argument, NULL, 'E' },
172 { "property", required_argument, NULL, 'p' },
173 { "tty", no_argument, NULL, 't' }, /* deprecated */
174 { "pty", no_argument, NULL, 't' },
175 { "quiet", no_argument, NULL, 'q' },
176 { "on-active", required_argument, NULL, ARG_ON_ACTIVE },
177 { "on-boot", required_argument, NULL, ARG_ON_BOOT },
178 { "on-startup", required_argument, NULL, ARG_ON_STARTUP },
179 { "on-unit-active", required_argument, NULL, ARG_ON_UNIT_ACTIVE },
180 { "on-unit-inactive", required_argument, NULL, ARG_ON_UNIT_INACTIVE },
181 { "on-calendar", required_argument, NULL, ARG_ON_CALENDAR },
182 { "timer-property", required_argument, NULL, ARG_TIMER_PROPERTY },
183 { "no-block", no_argument, NULL, ARG_NO_BLOCK },
184 { "no-ask-password", no_argument, NULL, ARG_NO_ASK_PASSWORD },
185 {},
186 };
187
188 int r, c;
189
190 assert(argc >= 0);
191 assert(argv);
192
193 while ((c = getopt_long(argc, argv, "+hrH:M:E:p:tq", options, NULL)) >= 0)
194
195 switch (c) {
196
197 case 'h':
198 help();
199 return 0;
200
201 case ARG_VERSION:
202 return version();
203
204 case ARG_NO_ASK_PASSWORD:
205 arg_ask_password = false;
206 break;
207
208 case ARG_USER:
209 arg_user = true;
210 break;
211
212 case ARG_SYSTEM:
213 arg_user = false;
214 break;
215
216 case ARG_SCOPE:
217 arg_scope = true;
218 break;
219
220 case ARG_UNIT:
221 arg_unit = optarg;
222 break;
223
224 case ARG_DESCRIPTION:
225 arg_description = optarg;
226 break;
227
228 case ARG_SLICE:
229 arg_slice = optarg;
230 break;
231
232 case ARG_SEND_SIGHUP:
233 arg_send_sighup = true;
234 break;
235
236 case 'r':
237 arg_remain_after_exit = true;
238 break;
239
240 case 'H':
241 arg_transport = BUS_TRANSPORT_REMOTE;
242 arg_host = optarg;
243 break;
244
245 case 'M':
246 arg_transport = BUS_TRANSPORT_MACHINE;
247 arg_host = optarg;
248 break;
249
250 case ARG_SERVICE_TYPE:
251 arg_service_type = optarg;
252 break;
253
254 case ARG_EXEC_USER:
255 arg_exec_user = optarg;
256 break;
257
258 case ARG_EXEC_GROUP:
259 arg_exec_group = optarg;
260 break;
261
262 case ARG_NICE:
263 r = parse_nice(optarg, &arg_nice);
264 if (r < 0)
265 return log_error_errno(r, "Failed to parse nice value: %s", optarg);
266
267 arg_nice_set = true;
268 break;
269
270 case 'E':
271 if (strv_extend(&arg_environment, optarg) < 0)
272 return log_oom();
273
274 break;
275
276 case 'p':
277 if (strv_extend(&arg_property, optarg) < 0)
278 return log_oom();
279
280 break;
281
282 case 't':
283 arg_pty = true;
284 break;
285
286 case 'q':
287 arg_quiet = true;
288 break;
289
290 case ARG_ON_ACTIVE:
291
292 r = parse_sec(optarg, &arg_on_active);
293 if (r < 0) {
294 log_error("Failed to parse timer value: %s", optarg);
295 return r;
296 }
297
298 break;
299
300 case ARG_ON_BOOT:
301
302 r = parse_sec(optarg, &arg_on_boot);
303 if (r < 0) {
304 log_error("Failed to parse timer value: %s", optarg);
305 return r;
306 }
307
308 break;
309
310 case ARG_ON_STARTUP:
311
312 r = parse_sec(optarg, &arg_on_startup);
313 if (r < 0) {
314 log_error("Failed to parse timer value: %s", optarg);
315 return r;
316 }
317
318 break;
319
320 case ARG_ON_UNIT_ACTIVE:
321
322 r = parse_sec(optarg, &arg_on_unit_active);
323 if (r < 0) {
324 log_error("Failed to parse timer value: %s", optarg);
325 return r;
326 }
327
328 break;
329
330 case ARG_ON_UNIT_INACTIVE:
331
332 r = parse_sec(optarg, &arg_on_unit_inactive);
333 if (r < 0) {
334 log_error("Failed to parse timer value: %s", optarg);
335 return r;
336 }
337
338 break;
339
340 case ARG_ON_CALENDAR: {
341 CalendarSpec *spec = NULL;
342
343 r = calendar_spec_from_string(optarg, &spec);
344 if (r < 0) {
345 log_error("Invalid calendar spec: %s", optarg);
346 return r;
347 }
348
349 calendar_spec_free(spec);
350 arg_on_calendar = optarg;
351 break;
352 }
353
354 case ARG_TIMER_PROPERTY:
355
356 if (strv_extend(&arg_timer_property, optarg) < 0)
357 return log_oom();
358
359 break;
360
361 case ARG_NO_BLOCK:
362 arg_no_block = true;
363 break;
364
365 case ARG_WAIT:
366 arg_wait = true;
367 break;
368
369 case '?':
370 return -EINVAL;
371
372 default:
373 assert_not_reached("Unhandled option");
374 }
375
376 if ((optind >= argc) && (!arg_unit || !with_timer())) {
377 log_error("Command line to execute required.");
378 return -EINVAL;
379 }
380
381 if (arg_user && arg_transport != BUS_TRANSPORT_LOCAL) {
382 log_error("Execution in user context is not supported on non-local systems.");
383 return -EINVAL;
384 }
385
386 if (arg_scope && arg_transport != BUS_TRANSPORT_LOCAL) {
387 log_error("Scope execution is not supported on non-local systems.");
388 return -EINVAL;
389 }
390
391 if (arg_scope && (arg_remain_after_exit || arg_service_type)) {
392 log_error("--remain-after-exit and --service-type= are not supported in --scope mode.");
393 return -EINVAL;
394 }
395
396 if (arg_pty && (with_timer() || arg_scope)) {
397 log_error("--pty is not compatible in timer or --scope mode.");
398 return -EINVAL;
399 }
400
401 if (arg_pty && arg_transport == BUS_TRANSPORT_REMOTE) {
402 log_error("--pty is only supported when connecting to the local system or containers.");
403 return -EINVAL;
404 }
405
406 if (arg_pty && arg_no_block) {
407 log_error("--pty is not compatible with --no-block.");
408 return -EINVAL;
409 }
410
411 if (arg_scope && with_timer()) {
412 log_error("Timer options are not supported in --scope mode.");
413 return -EINVAL;
414 }
415
416 if (arg_timer_property && !with_timer()) {
417 log_error("--timer-property= has no effect without any other timer options.");
418 return -EINVAL;
419 }
420
421 if (arg_wait) {
422 if (arg_no_block) {
423 log_error("--wait may not be combined with --no-block.");
424 return -EINVAL;
425 }
426
427 if (with_timer()) {
428 log_error("--wait may not be combined with timer operations.");
429 return -EINVAL;
430 }
431
432 if (arg_scope) {
433 log_error("--wait may not be combined with --scope.");
434 return -EINVAL;
435 }
436 }
437
438 return 1;
439 }
440
441 static int transient_unit_set_properties(sd_bus_message *m, char **properties) {
442 int r;
443
444 r = sd_bus_message_append(m, "(sv)", "Description", "s", arg_description);
445 if (r < 0)
446 return r;
447
448 r = bus_append_unit_property_assignment_many(m, properties);
449 if (r < 0)
450 return r;
451
452 return 0;
453 }
454
455 static int transient_cgroup_set_properties(sd_bus_message *m) {
456 int r;
457 assert(m);
458
459 if (!isempty(arg_slice)) {
460 _cleanup_free_ char *slice;
461
462 r = unit_name_mangle_with_suffix(arg_slice, UNIT_NAME_NOGLOB, ".slice", &slice);
463 if (r < 0)
464 return r;
465
466 r = sd_bus_message_append(m, "(sv)", "Slice", "s", slice);
467 if (r < 0)
468 return r;
469 }
470
471 return 0;
472 }
473
474 static int transient_kill_set_properties(sd_bus_message *m) {
475 assert(m);
476
477 if (arg_send_sighup)
478 return sd_bus_message_append(m, "(sv)", "SendSIGHUP", "b", arg_send_sighup);
479 else
480 return 0;
481 }
482
483 static int transient_service_set_properties(sd_bus_message *m, char **argv, const char *pty_path) {
484 int r;
485
486 assert(m);
487
488 r = transient_unit_set_properties(m, arg_property);
489 if (r < 0)
490 return r;
491
492 r = transient_kill_set_properties(m);
493 if (r < 0)
494 return r;
495
496 r = transient_cgroup_set_properties(m);
497 if (r < 0)
498 return r;
499
500 if (arg_wait) {
501 r = sd_bus_message_append(m, "(sv)", "AddRef", "b", 1);
502 if (r < 0)
503 return r;
504 }
505
506 if (arg_remain_after_exit) {
507 r = sd_bus_message_append(m, "(sv)", "RemainAfterExit", "b", arg_remain_after_exit);
508 if (r < 0)
509 return r;
510 }
511
512 if (arg_service_type) {
513 r = sd_bus_message_append(m, "(sv)", "Type", "s", arg_service_type);
514 if (r < 0)
515 return r;
516 }
517
518 if (arg_exec_user) {
519 r = sd_bus_message_append(m, "(sv)", "User", "s", arg_exec_user);
520 if (r < 0)
521 return r;
522 }
523
524 if (arg_exec_group) {
525 r = sd_bus_message_append(m, "(sv)", "Group", "s", arg_exec_group);
526 if (r < 0)
527 return r;
528 }
529
530 if (arg_nice_set) {
531 r = sd_bus_message_append(m, "(sv)", "Nice", "i", arg_nice);
532 if (r < 0)
533 return r;
534 }
535
536 if (pty_path) {
537 const char *e;
538
539 r = sd_bus_message_append(m,
540 "(sv)(sv)(sv)(sv)",
541 "StandardInput", "s", "tty",
542 "StandardOutput", "s", "tty",
543 "StandardError", "s", "tty",
544 "TTYPath", "s", pty_path);
545 if (r < 0)
546 return r;
547
548 e = getenv("TERM");
549 if (e) {
550 char *n;
551
552 n = strjoina("TERM=", e);
553 r = sd_bus_message_append(m,
554 "(sv)",
555 "Environment", "as", 1, n);
556 if (r < 0)
557 return r;
558 }
559 }
560
561 if (!strv_isempty(arg_environment)) {
562 r = sd_bus_message_open_container(m, 'r', "sv");
563 if (r < 0)
564 return r;
565
566 r = sd_bus_message_append(m, "s", "Environment");
567 if (r < 0)
568 return r;
569
570 r = sd_bus_message_open_container(m, 'v', "as");
571 if (r < 0)
572 return r;
573
574 r = sd_bus_message_append_strv(m, arg_environment);
575 if (r < 0)
576 return r;
577
578 r = sd_bus_message_close_container(m);
579 if (r < 0)
580 return r;
581
582 r = sd_bus_message_close_container(m);
583 if (r < 0)
584 return r;
585 }
586
587 /* Exec container */
588 {
589 r = sd_bus_message_open_container(m, 'r', "sv");
590 if (r < 0)
591 return r;
592
593 r = sd_bus_message_append(m, "s", "ExecStart");
594 if (r < 0)
595 return r;
596
597 r = sd_bus_message_open_container(m, 'v', "a(sasb)");
598 if (r < 0)
599 return r;
600
601 r = sd_bus_message_open_container(m, 'a', "(sasb)");
602 if (r < 0)
603 return r;
604
605 r = sd_bus_message_open_container(m, 'r', "sasb");
606 if (r < 0)
607 return r;
608
609 r = sd_bus_message_append(m, "s", argv[0]);
610 if (r < 0)
611 return r;
612
613 r = sd_bus_message_append_strv(m, argv);
614 if (r < 0)
615 return r;
616
617 r = sd_bus_message_append(m, "b", false);
618 if (r < 0)
619 return r;
620
621 r = sd_bus_message_close_container(m);
622 if (r < 0)
623 return r;
624
625 r = sd_bus_message_close_container(m);
626 if (r < 0)
627 return r;
628
629 r = sd_bus_message_close_container(m);
630 if (r < 0)
631 return r;
632
633 r = sd_bus_message_close_container(m);
634 if (r < 0)
635 return r;
636 }
637
638 return 0;
639 }
640
641 static int transient_scope_set_properties(sd_bus_message *m) {
642 int r;
643
644 assert(m);
645
646 r = transient_unit_set_properties(m, arg_property);
647 if (r < 0)
648 return r;
649
650 r = transient_kill_set_properties(m);
651 if (r < 0)
652 return r;
653
654 r = transient_cgroup_set_properties(m);
655 if (r < 0)
656 return r;
657
658 r = sd_bus_message_append(m, "(sv)", "PIDs", "au", 1, (uint32_t) getpid());
659 if (r < 0)
660 return r;
661
662 return 0;
663 }
664
665 static int transient_timer_set_properties(sd_bus_message *m) {
666 int r;
667
668 assert(m);
669
670 r = transient_unit_set_properties(m, arg_timer_property);
671 if (r < 0)
672 return r;
673
674 /* Automatically clean up our transient timers */
675 r = sd_bus_message_append(m, "(sv)", "RemainAfterElapse", "b", false);
676 if (r < 0)
677 return r;
678
679 if (arg_on_active) {
680 r = sd_bus_message_append(m, "(sv)", "OnActiveSec", "t", arg_on_active);
681 if (r < 0)
682 return r;
683 }
684
685 if (arg_on_boot) {
686 r = sd_bus_message_append(m, "(sv)", "OnBootSec", "t", arg_on_boot);
687 if (r < 0)
688 return r;
689 }
690
691 if (arg_on_startup) {
692 r = sd_bus_message_append(m, "(sv)", "OnStartupSec", "t", arg_on_startup);
693 if (r < 0)
694 return r;
695 }
696
697 if (arg_on_unit_active) {
698 r = sd_bus_message_append(m, "(sv)", "OnUnitActiveSec", "t", arg_on_unit_active);
699 if (r < 0)
700 return r;
701 }
702
703 if (arg_on_unit_inactive) {
704 r = sd_bus_message_append(m, "(sv)", "OnUnitInactiveSec", "t", arg_on_unit_inactive);
705 if (r < 0)
706 return r;
707 }
708
709 if (arg_on_calendar) {
710 r = sd_bus_message_append(m, "(sv)", "OnCalendar", "s", arg_on_calendar);
711 if (r < 0)
712 return r;
713 }
714
715 return 0;
716 }
717
718 static int make_unit_name(sd_bus *bus, UnitType t, char **ret) {
719 const char *unique, *id;
720 char *p;
721 int r;
722
723 assert(bus);
724 assert(t >= 0);
725 assert(t < _UNIT_TYPE_MAX);
726
727 r = sd_bus_get_unique_name(bus, &unique);
728 if (r < 0) {
729 sd_id128_t rnd;
730
731 /* We couldn't get the unique name, which is a pretty
732 * common case if we are connected to systemd
733 * directly. In that case, just pick a random uuid as
734 * name */
735
736 r = sd_id128_randomize(&rnd);
737 if (r < 0)
738 return log_error_errno(r, "Failed to generate random run unit name: %m");
739
740 if (asprintf(ret, "run-r" SD_ID128_FORMAT_STR ".%s", SD_ID128_FORMAT_VAL(rnd), unit_type_to_string(t)) < 0)
741 return log_oom();
742
743 return 0;
744 }
745
746 /* We managed to get the unique name, then let's use that to
747 * name our transient units. */
748
749 id = startswith(unique, ":1.");
750 if (!id) {
751 log_error("Unique name %s has unexpected format.", unique);
752 return -EINVAL;
753 }
754
755 p = strjoin("run-u", id, ".", unit_type_to_string(t));
756 if (!p)
757 return log_oom();
758
759 *ret = p;
760 return 0;
761 }
762
763 typedef struct RunContext {
764 sd_bus *bus;
765 sd_event *event;
766 PTYForward *forward;
767 sd_bus_slot *match;
768
769 /* The exit data of the unit */
770 char *active_state;
771 uint64_t inactive_exit_usec;
772 uint64_t inactive_enter_usec;
773 char *result;
774 uint64_t cpu_usage_nsec;
775 uint32_t exit_code;
776 uint32_t exit_status;
777 } RunContext;
778
779 static void run_context_free(RunContext *c) {
780 assert(c);
781
782 c->forward = pty_forward_free(c->forward);
783 c->match = sd_bus_slot_unref(c->match);
784 c->bus = sd_bus_unref(c->bus);
785 c->event = sd_event_unref(c->event);
786
787 free(c->active_state);
788 free(c->result);
789 }
790
791 static void run_context_check_done(RunContext *c) {
792 bool done;
793
794 assert(c);
795
796 if (c->match)
797 done = STRPTR_IN_SET(c->active_state, "inactive", "failed");
798 else
799 done = true;
800
801 if (c->forward && done) /* If the service is gone, it's time to drain the output */
802 done = pty_forward_drain(c->forward);
803
804 if (done)
805 sd_event_exit(c->event, EXIT_SUCCESS);
806 }
807
808 static int run_context_update(RunContext *c, const char *path) {
809
810 static const struct bus_properties_map map[] = {
811 { "ActiveState", "s", NULL, offsetof(RunContext, active_state) },
812 { "InactiveExitTimestampMonotonic", "t", NULL, offsetof(RunContext, inactive_exit_usec) },
813 { "InactiveEnterTimestampMonotonic", "t", NULL, offsetof(RunContext, inactive_enter_usec) },
814 { "Result", "s", NULL, offsetof(RunContext, result) },
815 { "ExecMainCode", "i", NULL, offsetof(RunContext, exit_code) },
816 { "ExecMainStatus", "i", NULL, offsetof(RunContext, exit_status) },
817 { "CPUUsageNSec", "t", NULL, offsetof(RunContext, cpu_usage_nsec) },
818 {}
819 };
820
821 int r;
822
823 r = bus_map_all_properties(c->bus,
824 "org.freedesktop.systemd1",
825 path,
826 map,
827 c);
828 if (r < 0) {
829 sd_event_exit(c->event, EXIT_FAILURE);
830 return log_error_errno(r, "Failed to query unit state: %m");
831 }
832
833 run_context_check_done(c);
834 return 0;
835 }
836
837 static int on_properties_changed(sd_bus_message *m, void *userdata, sd_bus_error *error) {
838 RunContext *c = userdata;
839
840 assert(m);
841 assert(c);
842
843 return run_context_update(c, sd_bus_message_get_path(m));
844 }
845
846 static int pty_forward_handler(PTYForward *f, int rcode, void *userdata) {
847 RunContext *c = userdata;
848
849 assert(f);
850
851 if (rcode < 0) {
852 sd_event_exit(c->event, EXIT_FAILURE);
853 return log_error_errno(rcode, "Error on PTY forwarding logic: %m");
854 }
855
856 run_context_check_done(c);
857 return 0;
858 }
859
860 static int start_transient_service(
861 sd_bus *bus,
862 char **argv,
863 int *retval) {
864
865 _cleanup_(sd_bus_message_unrefp) sd_bus_message *m = NULL, *reply = NULL;
866 _cleanup_(sd_bus_error_free) sd_bus_error error = SD_BUS_ERROR_NULL;
867 _cleanup_(bus_wait_for_jobs_freep) BusWaitForJobs *w = NULL;
868 _cleanup_free_ char *service = NULL, *pty_path = NULL;
869 _cleanup_close_ int master = -1;
870 int r;
871
872 assert(bus);
873 assert(argv);
874 assert(retval);
875
876 if (arg_pty) {
877
878 if (arg_transport == BUS_TRANSPORT_LOCAL) {
879 master = posix_openpt(O_RDWR|O_NOCTTY|O_CLOEXEC|O_NDELAY);
880 if (master < 0)
881 return log_error_errno(errno, "Failed to acquire pseudo tty: %m");
882
883 r = ptsname_malloc(master, &pty_path);
884 if (r < 0)
885 return log_error_errno(r, "Failed to determine tty name: %m");
886
887 if (unlockpt(master) < 0)
888 return log_error_errno(errno, "Failed to unlock tty: %m");
889
890 } else if (arg_transport == BUS_TRANSPORT_MACHINE) {
891 _cleanup_(sd_bus_unrefp) sd_bus *system_bus = NULL;
892 _cleanup_(sd_bus_message_unrefp) sd_bus_message *pty_reply = NULL;
893 const char *s;
894
895 r = sd_bus_default_system(&system_bus);
896 if (r < 0)
897 return log_error_errno(r, "Failed to connect to system bus: %m");
898
899 r = sd_bus_call_method(system_bus,
900 "org.freedesktop.machine1",
901 "/org/freedesktop/machine1",
902 "org.freedesktop.machine1.Manager",
903 "OpenMachinePTY",
904 &error,
905 &pty_reply,
906 "s", arg_host);
907 if (r < 0) {
908 log_error("Failed to get machine PTY: %s", bus_error_message(&error, -r));
909 return r;
910 }
911
912 r = sd_bus_message_read(pty_reply, "hs", &master, &s);
913 if (r < 0)
914 return bus_log_parse_error(r);
915
916 master = fcntl(master, F_DUPFD_CLOEXEC, 3);
917 if (master < 0)
918 return log_error_errno(errno, "Failed to duplicate master fd: %m");
919
920 pty_path = strdup(s);
921 if (!pty_path)
922 return log_oom();
923 } else
924 assert_not_reached("Can't allocate tty via ssh");
925 }
926
927 if (!arg_no_block) {
928 r = bus_wait_for_jobs_new(bus, &w);
929 if (r < 0)
930 return log_error_errno(r, "Could not watch jobs: %m");
931 }
932
933 if (arg_unit) {
934 r = unit_name_mangle_with_suffix(arg_unit, UNIT_NAME_NOGLOB, ".service", &service);
935 if (r < 0)
936 return log_error_errno(r, "Failed to mangle unit name: %m");
937 } else {
938 r = make_unit_name(bus, UNIT_SERVICE, &service);
939 if (r < 0)
940 return r;
941 }
942
943 r = sd_bus_message_new_method_call(
944 bus,
945 &m,
946 "org.freedesktop.systemd1",
947 "/org/freedesktop/systemd1",
948 "org.freedesktop.systemd1.Manager",
949 "StartTransientUnit");
950 if (r < 0)
951 return bus_log_create_error(r);
952
953 r = sd_bus_message_set_allow_interactive_authorization(m, arg_ask_password);
954 if (r < 0)
955 return bus_log_create_error(r);
956
957 /* Name and mode */
958 r = sd_bus_message_append(m, "ss", service, "fail");
959 if (r < 0)
960 return bus_log_create_error(r);
961
962 /* Properties */
963 r = sd_bus_message_open_container(m, 'a', "(sv)");
964 if (r < 0)
965 return bus_log_create_error(r);
966
967 r = transient_service_set_properties(m, argv, pty_path);
968 if (r < 0)
969 return bus_log_create_error(r);
970
971 r = sd_bus_message_close_container(m);
972 if (r < 0)
973 return bus_log_create_error(r);
974
975 /* Auxiliary units */
976 r = sd_bus_message_append(m, "a(sa(sv))", 0);
977 if (r < 0)
978 return bus_log_create_error(r);
979
980 polkit_agent_open_if_enabled();
981
982 r = sd_bus_call(bus, m, 0, &error, &reply);
983 if (r < 0)
984 return log_error_errno(r, "Failed to start transient service unit: %s", bus_error_message(&error, r));
985
986 if (w) {
987 const char *object;
988
989 r = sd_bus_message_read(reply, "o", &object);
990 if (r < 0)
991 return bus_log_parse_error(r);
992
993 r = bus_wait_for_jobs_one(w, object, arg_quiet);
994 if (r < 0)
995 return r;
996 }
997
998 if (!arg_quiet)
999 log_info("Running as unit: %s", service);
1000
1001 if (arg_wait || master >= 0) {
1002 _cleanup_(run_context_free) RunContext c = {};
1003 _cleanup_free_ char *path = NULL;
1004 const char *mt;
1005
1006 c.bus = sd_bus_ref(bus);
1007
1008 r = sd_event_default(&c.event);
1009 if (r < 0)
1010 return log_error_errno(r, "Failed to get event loop: %m");
1011
1012 if (master >= 0) {
1013 assert_se(sigprocmask_many(SIG_BLOCK, NULL, SIGWINCH, SIGTERM, SIGINT, -1) >= 0);
1014 (void) sd_event_add_signal(c.event, NULL, SIGINT, NULL, NULL);
1015 (void) sd_event_add_signal(c.event, NULL, SIGTERM, NULL, NULL);
1016
1017 if (!arg_quiet)
1018 log_info("Press ^] three times within 1s to disconnect TTY.");
1019
1020 r = pty_forward_new(c.event, master, PTY_FORWARD_IGNORE_INITIAL_VHANGUP, &c.forward);
1021 if (r < 0)
1022 return log_error_errno(r, "Failed to create PTY forwarder: %m");
1023
1024 pty_forward_set_handler(c.forward, pty_forward_handler, &c);
1025 }
1026
1027
1028 path = unit_dbus_path_from_name(service);
1029 if (!path)
1030 return log_oom();
1031
1032 mt = strjoina("type='signal',"
1033 "sender='org.freedesktop.systemd1',"
1034 "path='", path, "',"
1035 "interface='org.freedesktop.DBus.Properties',"
1036 "member='PropertiesChanged'");
1037 r = sd_bus_add_match(bus, &c.match, mt, on_properties_changed, &c);
1038 if (r < 0)
1039 return log_error_errno(r, "Failed to add properties changed signal.");
1040
1041 r = sd_bus_attach_event(bus, c.event, 0);
1042 if (r < 0)
1043 return log_error_errno(r, "Failed to attach bus to event loop.");
1044
1045 r = run_context_update(&c, path);
1046 if (r < 0)
1047 return r;
1048
1049 r = sd_event_loop(c.event);
1050 if (r < 0)
1051 return log_error_errno(r, "Failed to run event loop: %m");
1052
1053 if (c.forward) {
1054 char last_char = 0;
1055
1056 r = pty_forward_get_last_char(c.forward, &last_char);
1057 if (r >= 0 && !arg_quiet && last_char != '\n')
1058 fputc('\n', stdout);
1059 }
1060
1061 if (arg_wait && !arg_quiet) {
1062
1063 /* Explicitly destroy the PTY forwarder, so that the PTY device is usable again, in its
1064 * original settings (i.e. proper line breaks), so that we can show the summary in a pretty
1065 * way. */
1066 c.forward = pty_forward_free(c.forward);
1067
1068 if (!isempty(c.result))
1069 log_info("Finished with result: %s", strna(c.result));
1070
1071 if (c.exit_code == CLD_EXITED)
1072 log_info("Main processes terminated with: code=%s/status=%i", sigchld_code_to_string(c.exit_code), c.exit_status);
1073 else if (c.exit_code > 0)
1074 log_info("Main processes terminated with: code=%s/status=%s", sigchld_code_to_string(c.exit_code), signal_to_string(c.exit_status));
1075
1076 if (c.inactive_enter_usec > 0 && c.inactive_enter_usec != USEC_INFINITY &&
1077 c.inactive_exit_usec > 0 && c.inactive_exit_usec != USEC_INFINITY &&
1078 c.inactive_enter_usec > c.inactive_exit_usec) {
1079 char ts[FORMAT_TIMESPAN_MAX];
1080 log_info("Service runtime: %s", format_timespan(ts, sizeof(ts), c.inactive_enter_usec - c.inactive_exit_usec, USEC_PER_MSEC));
1081 }
1082
1083 if (c.cpu_usage_nsec > 0 && c.cpu_usage_nsec != NSEC_INFINITY) {
1084 char ts[FORMAT_TIMESPAN_MAX];
1085 log_info("CPU time consumed: %s", format_timespan(ts, sizeof(ts), (c.cpu_usage_nsec + NSEC_PER_USEC - 1) / NSEC_PER_USEC, USEC_PER_MSEC));
1086 }
1087 }
1088
1089 /* Try to propagate the service's return value */
1090 if (c.result && STR_IN_SET(c.result, "success", "exit-code") && c.exit_code == CLD_EXITED)
1091 *retval = c.exit_status;
1092 else
1093 *retval = EXIT_FAILURE;
1094 }
1095
1096 return 0;
1097 }
1098
1099 static int start_transient_scope(
1100 sd_bus *bus,
1101 char **argv) {
1102
1103 _cleanup_(sd_bus_error_free) sd_bus_error error = SD_BUS_ERROR_NULL;
1104 _cleanup_(sd_bus_message_unrefp) sd_bus_message *m = NULL, *reply = NULL;
1105 _cleanup_(bus_wait_for_jobs_freep) BusWaitForJobs *w = NULL;
1106 _cleanup_strv_free_ char **env = NULL, **user_env = NULL;
1107 _cleanup_free_ char *scope = NULL;
1108 const char *object = NULL;
1109 int r;
1110
1111 assert(bus);
1112 assert(argv);
1113
1114 r = bus_wait_for_jobs_new(bus, &w);
1115 if (r < 0)
1116 return log_oom();
1117
1118 if (arg_unit) {
1119 r = unit_name_mangle_with_suffix(arg_unit, UNIT_NAME_NOGLOB, ".scope", &scope);
1120 if (r < 0)
1121 return log_error_errno(r, "Failed to mangle scope name: %m");
1122 } else {
1123 r = make_unit_name(bus, UNIT_SCOPE, &scope);
1124 if (r < 0)
1125 return r;
1126 }
1127
1128 r = sd_bus_message_new_method_call(
1129 bus,
1130 &m,
1131 "org.freedesktop.systemd1",
1132 "/org/freedesktop/systemd1",
1133 "org.freedesktop.systemd1.Manager",
1134 "StartTransientUnit");
1135 if (r < 0)
1136 return bus_log_create_error(r);
1137
1138 r = sd_bus_message_set_allow_interactive_authorization(m, arg_ask_password);
1139 if (r < 0)
1140 return bus_log_create_error(r);
1141
1142 /* Name and Mode */
1143 r = sd_bus_message_append(m, "ss", scope, "fail");
1144 if (r < 0)
1145 return bus_log_create_error(r);
1146
1147 /* Properties */
1148 r = sd_bus_message_open_container(m, 'a', "(sv)");
1149 if (r < 0)
1150 return bus_log_create_error(r);
1151
1152 r = transient_scope_set_properties(m);
1153 if (r < 0)
1154 return bus_log_create_error(r);
1155
1156 r = sd_bus_message_close_container(m);
1157 if (r < 0)
1158 return bus_log_create_error(r);
1159
1160 /* Auxiliary units */
1161 r = sd_bus_message_append(m, "a(sa(sv))", 0);
1162 if (r < 0)
1163 return bus_log_create_error(r);
1164
1165 polkit_agent_open_if_enabled();
1166
1167 r = sd_bus_call(bus, m, 0, &error, &reply);
1168 if (r < 0) {
1169 log_error("Failed to start transient scope unit: %s", bus_error_message(&error, -r));
1170 return r;
1171 }
1172
1173 if (arg_nice_set) {
1174 if (setpriority(PRIO_PROCESS, 0, arg_nice) < 0)
1175 return log_error_errno(errno, "Failed to set nice level: %m");
1176 }
1177
1178 if (arg_exec_group) {
1179 gid_t gid;
1180
1181 r = get_group_creds(&arg_exec_group, &gid);
1182 if (r < 0)
1183 return log_error_errno(r, "Failed to resolve group %s: %m", arg_exec_group);
1184
1185 if (setresgid(gid, gid, gid) < 0)
1186 return log_error_errno(errno, "Failed to change GID to " GID_FMT ": %m", gid);
1187 }
1188
1189 if (arg_exec_user) {
1190 const char *home, *shell;
1191 uid_t uid;
1192 gid_t gid;
1193
1194 r = get_user_creds_clean(&arg_exec_user, &uid, &gid, &home, &shell);
1195 if (r < 0)
1196 return log_error_errno(r, "Failed to resolve user %s: %m", arg_exec_user);
1197
1198 if (home) {
1199 r = strv_extendf(&user_env, "HOME=%s", home);
1200 if (r < 0)
1201 return log_oom();
1202 }
1203
1204 if (shell) {
1205 r = strv_extendf(&user_env, "SHELL=%s", shell);
1206 if (r < 0)
1207 return log_oom();
1208 }
1209
1210 r = strv_extendf(&user_env, "USER=%s", arg_exec_user);
1211 if (r < 0)
1212 return log_oom();
1213
1214 r = strv_extendf(&user_env, "LOGNAME=%s", arg_exec_user);
1215 if (r < 0)
1216 return log_oom();
1217
1218 if (!arg_exec_group) {
1219 if (setresgid(gid, gid, gid) < 0)
1220 return log_error_errno(errno, "Failed to change GID to " GID_FMT ": %m", gid);
1221 }
1222
1223 if (setresuid(uid, uid, uid) < 0)
1224 return log_error_errno(errno, "Failed to change UID to " UID_FMT ": %m", uid);
1225 }
1226
1227 env = strv_env_merge(3, environ, user_env, arg_environment);
1228 if (!env)
1229 return log_oom();
1230
1231 r = sd_bus_message_read(reply, "o", &object);
1232 if (r < 0)
1233 return bus_log_parse_error(r);
1234
1235 r = bus_wait_for_jobs_one(w, object, arg_quiet);
1236 if (r < 0)
1237 return r;
1238
1239 if (!arg_quiet)
1240 log_info("Running scope as unit: %s", scope);
1241
1242 execvpe(argv[0], argv, env);
1243
1244 return log_error_errno(errno, "Failed to execute: %m");
1245 }
1246
1247 static int start_transient_timer(
1248 sd_bus *bus,
1249 char **argv) {
1250
1251 _cleanup_(sd_bus_error_free) sd_bus_error error = SD_BUS_ERROR_NULL;
1252 _cleanup_(sd_bus_message_unrefp) sd_bus_message *m = NULL, *reply = NULL;
1253 _cleanup_(bus_wait_for_jobs_freep) BusWaitForJobs *w = NULL;
1254 _cleanup_free_ char *timer = NULL, *service = NULL;
1255 const char *object = NULL;
1256 int r;
1257
1258 assert(bus);
1259 assert(argv);
1260
1261 r = bus_wait_for_jobs_new(bus, &w);
1262 if (r < 0)
1263 return log_oom();
1264
1265 if (arg_unit) {
1266 switch (unit_name_to_type(arg_unit)) {
1267
1268 case UNIT_SERVICE:
1269 service = strdup(arg_unit);
1270 if (!service)
1271 return log_oom();
1272
1273 r = unit_name_change_suffix(service, ".timer", &timer);
1274 if (r < 0)
1275 return log_error_errno(r, "Failed to change unit suffix: %m");
1276 break;
1277
1278 case UNIT_TIMER:
1279 timer = strdup(arg_unit);
1280 if (!timer)
1281 return log_oom();
1282
1283 r = unit_name_change_suffix(timer, ".service", &service);
1284 if (r < 0)
1285 return log_error_errno(r, "Failed to change unit suffix: %m");
1286 break;
1287
1288 default:
1289 r = unit_name_mangle_with_suffix(arg_unit, UNIT_NAME_NOGLOB, ".service", &service);
1290 if (r < 0)
1291 return log_error_errno(r, "Failed to mangle unit name: %m");
1292
1293 r = unit_name_mangle_with_suffix(arg_unit, UNIT_NAME_NOGLOB, ".timer", &timer);
1294 if (r < 0)
1295 return log_error_errno(r, "Failed to mangle unit name: %m");
1296
1297 break;
1298 }
1299 } else {
1300 r = make_unit_name(bus, UNIT_SERVICE, &service);
1301 if (r < 0)
1302 return r;
1303
1304 r = unit_name_change_suffix(service, ".timer", &timer);
1305 if (r < 0)
1306 return log_error_errno(r, "Failed to change unit suffix: %m");
1307 }
1308
1309 r = sd_bus_message_new_method_call(
1310 bus,
1311 &m,
1312 "org.freedesktop.systemd1",
1313 "/org/freedesktop/systemd1",
1314 "org.freedesktop.systemd1.Manager",
1315 "StartTransientUnit");
1316 if (r < 0)
1317 return bus_log_create_error(r);
1318
1319 r = sd_bus_message_set_allow_interactive_authorization(m, arg_ask_password);
1320 if (r < 0)
1321 return bus_log_create_error(r);
1322
1323 /* Name and Mode */
1324 r = sd_bus_message_append(m, "ss", timer, "fail");
1325 if (r < 0)
1326 return bus_log_create_error(r);
1327
1328 /* Properties */
1329 r = sd_bus_message_open_container(m, 'a', "(sv)");
1330 if (r < 0)
1331 return bus_log_create_error(r);
1332
1333 r = transient_timer_set_properties(m);
1334 if (r < 0)
1335 return bus_log_create_error(r);
1336
1337 r = sd_bus_message_close_container(m);
1338 if (r < 0)
1339 return bus_log_create_error(r);
1340
1341 r = sd_bus_message_open_container(m, 'a', "(sa(sv))");
1342 if (r < 0)
1343 return bus_log_create_error(r);
1344
1345 if (!strv_isempty(argv)) {
1346 r = sd_bus_message_open_container(m, 'r', "sa(sv)");
1347 if (r < 0)
1348 return bus_log_create_error(r);
1349
1350 r = sd_bus_message_append(m, "s", service);
1351 if (r < 0)
1352 return bus_log_create_error(r);
1353
1354 r = sd_bus_message_open_container(m, 'a', "(sv)");
1355 if (r < 0)
1356 return bus_log_create_error(r);
1357
1358 r = transient_service_set_properties(m, argv, NULL);
1359 if (r < 0)
1360 return bus_log_create_error(r);
1361
1362 r = sd_bus_message_close_container(m);
1363 if (r < 0)
1364 return bus_log_create_error(r);
1365
1366 r = sd_bus_message_close_container(m);
1367 if (r < 0)
1368 return bus_log_create_error(r);
1369 }
1370
1371 r = sd_bus_message_close_container(m);
1372 if (r < 0)
1373 return bus_log_create_error(r);
1374
1375 polkit_agent_open_if_enabled();
1376
1377 r = sd_bus_call(bus, m, 0, &error, &reply);
1378 if (r < 0) {
1379 log_error("Failed to start transient timer unit: %s", bus_error_message(&error, -r));
1380 return r;
1381 }
1382
1383 r = sd_bus_message_read(reply, "o", &object);
1384 if (r < 0)
1385 return bus_log_parse_error(r);
1386
1387 r = bus_wait_for_jobs_one(w, object, arg_quiet);
1388 if (r < 0)
1389 return r;
1390
1391 if (!arg_quiet) {
1392 log_info("Running timer as unit: %s", timer);
1393 if (argv[0])
1394 log_info("Will run service as unit: %s", service);
1395 }
1396
1397 return 0;
1398 }
1399
1400 int main(int argc, char* argv[]) {
1401 _cleanup_(sd_bus_flush_close_unrefp) sd_bus *bus = NULL;
1402 _cleanup_free_ char *description = NULL, *command = NULL;
1403 int r, retval = EXIT_SUCCESS;
1404
1405 log_parse_environment();
1406 log_open();
1407
1408 r = parse_argv(argc, argv);
1409 if (r <= 0)
1410 goto finish;
1411
1412 if (argc > optind && arg_transport == BUS_TRANSPORT_LOCAL) {
1413 /* Patch in an absolute path */
1414
1415 r = find_binary(argv[optind], &command);
1416 if (r < 0) {
1417 log_error_errno(r, "Failed to find executable %s: %m", argv[optind]);
1418 goto finish;
1419 }
1420
1421 argv[optind] = command;
1422 }
1423
1424 if (!arg_description) {
1425 description = strv_join(argv + optind, " ");
1426 if (!description) {
1427 r = log_oom();
1428 goto finish;
1429 }
1430
1431 if (arg_unit && isempty(description)) {
1432 r = free_and_strdup(&description, arg_unit);
1433 if (r < 0)
1434 goto finish;
1435 }
1436
1437 arg_description = description;
1438 }
1439
1440 /* If --wait is used connect via the bus, unconditionally, as ref/unref is not supported via the limited direct
1441 * connection */
1442 if (arg_wait || arg_pty)
1443 r = bus_connect_transport(arg_transport, arg_host, arg_user, &bus);
1444 else
1445 r = bus_connect_transport_systemd(arg_transport, arg_host, arg_user, &bus);
1446 if (r < 0) {
1447 log_error_errno(r, "Failed to create bus connection: %m");
1448 goto finish;
1449 }
1450
1451 if (arg_scope)
1452 r = start_transient_scope(bus, argv + optind);
1453 else if (with_timer())
1454 r = start_transient_timer(bus, argv + optind);
1455 else
1456 r = start_transient_service(bus, argv + optind, &retval);
1457
1458 finish:
1459 strv_free(arg_environment);
1460 strv_free(arg_property);
1461 strv_free(arg_timer_property);
1462
1463 return r < 0 ? EXIT_FAILURE : retval;
1464 }