]>
git.ipfire.org Git - thirdparty/systemd.git/blob - src/shared/bus-wait-for-jobs.c
1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
3 #include "alloc-util.h"
4 #include "bus-wait-for-jobs.h"
7 #include "bus-internal.h"
12 typedef struct BusWaitForJobs
{
15 /* The set of jobs to wait for, as bus object paths */
18 /* The unit name and job result of the last Job message */
22 sd_bus_slot
*slot_job_removed
;
23 sd_bus_slot
*slot_disconnected
;
26 static int match_disconnected(sd_bus_message
*m
, void *userdata
, sd_bus_error
*error
) {
29 log_error("Warning! D-Bus connection terminated.");
30 sd_bus_close(sd_bus_message_get_bus(m
));
35 static int match_job_removed(sd_bus_message
*m
, void *userdata
, sd_bus_error
*error
) {
36 const char *path
, *unit
, *result
;
37 BusWaitForJobs
*d
= userdata
;
45 r
= sd_bus_message_read(m
, "uoss", &id
, &path
, &unit
, &result
);
47 bus_log_parse_error(r
);
51 found
= set_remove(d
->jobs
, (char*) path
);
57 (void) free_and_strdup(&d
->result
, empty_to_null(result
));
59 (void) free_and_strdup(&d
->name
, empty_to_null(unit
));
64 BusWaitForJobs
* bus_wait_for_jobs_free(BusWaitForJobs
*d
) {
70 sd_bus_slot_unref(d
->slot_disconnected
);
71 sd_bus_slot_unref(d
->slot_job_removed
);
81 int bus_wait_for_jobs_new(sd_bus
*bus
, BusWaitForJobs
**ret
) {
82 _cleanup_(bus_wait_for_jobs_freep
) BusWaitForJobs
*d
= NULL
;
88 d
= new(BusWaitForJobs
, 1);
92 *d
= (BusWaitForJobs
) {
93 .bus
= sd_bus_ref(bus
),
96 /* When we are a bus client we match by sender. Direct
97 * connections OTOH have no initialized sender field, and
98 * hence we ignore the sender then */
99 r
= sd_bus_match_signal_async(
101 &d
->slot_job_removed
,
102 bus
->bus_client
? "org.freedesktop.systemd1" : NULL
,
103 "/org/freedesktop/systemd1",
104 "org.freedesktop.systemd1.Manager",
106 match_job_removed
, NULL
, d
);
110 r
= sd_bus_match_signal_async(
112 &d
->slot_disconnected
,
113 "org.freedesktop.DBus.Local",
115 "org.freedesktop.DBus.Local",
117 match_disconnected
, NULL
, d
);
126 static int bus_process_wait(sd_bus
*bus
) {
130 r
= sd_bus_process(bus
, NULL
);
136 r
= sd_bus_wait(bus
, UINT64_MAX
);
142 static int bus_job_get_service_result(BusWaitForJobs
*d
, char **result
) {
143 _cleanup_free_
char *dbus_path
= NULL
;
149 if (!endswith(d
->name
, ".service"))
152 dbus_path
= unit_dbus_path_from_name(d
->name
);
156 return sd_bus_get_property_string(d
->bus
,
157 "org.freedesktop.systemd1",
159 "org.freedesktop.systemd1.Service",
165 static void log_job_error_with_service_result(const char* service
, const char *result
, const char* const* extra_args
) {
166 _cleanup_free_
char *service_shell_quoted
= NULL
;
167 const char *systemctl
= "systemctl", *journalctl
= "journalctl";
169 static const struct {
170 const char *result
, *explanation
;
172 { "resources", "of unavailable resources or another system error" },
173 { "protocol", "the service did not take the steps required by its unit configuration" },
174 { "timeout", "a timeout was exceeded" },
175 { "exit-code", "the control process exited with error code" },
176 { "signal", "a fatal signal was delivered to the control process" },
177 { "core-dump", "a fatal signal was delivered causing the control process to dump core" },
178 { "watchdog", "the service failed to send watchdog ping" },
179 { "start-limit", "start of the service was attempted too often" }
184 service_shell_quoted
= shell_maybe_quote(service
, ESCAPE_BACKSLASH
);
186 if (!strv_isempty((char**) extra_args
)) {
187 _cleanup_free_
char *t
;
189 t
= strv_join((char**) extra_args
, " ");
190 systemctl
= strjoina("systemctl ", t
? : "<args>");
191 journalctl
= strjoina("journalctl ", t
? : "<args>");
194 if (!isempty(result
)) {
197 for (i
= 0; i
< ELEMENTSOF(explanations
); ++i
)
198 if (streq(result
, explanations
[i
].result
))
201 if (i
< ELEMENTSOF(explanations
)) {
202 log_error("Job for %s failed because %s.\n"
203 "See \"%s status %s\" and \"%s -xeu %s\" for details.\n",
205 explanations
[i
].explanation
,
207 service_shell_quoted
?: "<service>",
209 service_shell_quoted
?: "<service>");
214 log_error("Job for %s failed.\n"
215 "See \"%s status %s\" and \"%s -xeu %s\" for details.\n",
218 service_shell_quoted
?: "<service>",
220 service_shell_quoted
?: "<service>");
223 /* For some results maybe additional explanation is required */
224 if (streq_ptr(result
, "start-limit"))
225 log_info("To force a start use \"%1$s reset-failed %2$s\"\n"
226 "followed by \"%1$s start %2$s\" again.",
228 service_shell_quoted
?: "<service>");
231 static int check_wait_response(BusWaitForJobs
*d
, bool quiet
, const char* const* extra_args
) {
237 if (streq(d
->result
, "canceled"))
238 log_error("Job for %s canceled.", strna(d
->name
));
239 else if (streq(d
->result
, "timeout"))
240 log_error("Job for %s timed out.", strna(d
->name
));
241 else if (streq(d
->result
, "dependency"))
242 log_error("A dependency job for %s failed. See 'journalctl -xe' for details.", strna(d
->name
));
243 else if (streq(d
->result
, "invalid"))
244 log_error("%s is not active, cannot reload.", strna(d
->name
));
245 else if (streq(d
->result
, "assert"))
246 log_error("Assertion failed on job for %s.", strna(d
->name
));
247 else if (streq(d
->result
, "unsupported"))
248 log_error("Operation on or unit type of %s not supported on this system.", strna(d
->name
));
249 else if (streq(d
->result
, "collected"))
250 log_error("Queued job for %s was garbage collected.", strna(d
->name
));
251 else if (streq(d
->result
, "once"))
252 log_error("Unit %s was started already once and can't be started again.", strna(d
->name
));
253 else if (!STR_IN_SET(d
->result
, "done", "skipped")) {
255 if (d
->name
&& endswith(d
->name
, ".service")) {
256 _cleanup_free_
char *result
= NULL
;
259 q
= bus_job_get_service_result(d
, &result
);
261 log_debug_errno(q
, "Failed to get Result property of unit %s: %m", d
->name
);
263 log_job_error_with_service_result(d
->name
, result
, extra_args
);
265 log_error("Job failed. See \"journalctl -xe\" for details.");
269 if (STR_IN_SET(d
->result
, "canceled", "collected"))
271 else if (streq(d
->result
, "timeout"))
273 else if (streq(d
->result
, "dependency"))
275 else if (streq(d
->result
, "invalid"))
277 else if (streq(d
->result
, "assert"))
279 else if (streq(d
->result
, "unsupported"))
281 else if (streq(d
->result
, "once"))
283 else if (STR_IN_SET(d
->result
, "done", "skipped"))
286 return log_debug_errno(SYNTHETIC_ERRNO(EIO
),
287 "Unexpected job result, assuming server side newer than us: %s", d
->result
);
290 int bus_wait_for_jobs(BusWaitForJobs
*d
, bool quiet
, const char* const* extra_args
) {
295 while (!set_isempty(d
->jobs
)) {
298 q
= bus_process_wait(d
->bus
);
300 return log_error_errno(q
, "Failed to wait for response: %m");
302 if (d
->name
&& d
->result
) {
303 q
= check_wait_response(d
, quiet
, extra_args
);
304 /* Return the first error as it is most likely to be
309 log_debug_errno(q
, "Got result %s/%m for job %s", d
->result
, d
->name
);
312 d
->name
= mfree(d
->name
);
313 d
->result
= mfree(d
->result
);
319 int bus_wait_for_jobs_add(BusWaitForJobs
*d
, const char *path
) {
322 return set_put_strdup(&d
->jobs
, path
);
325 int bus_wait_for_jobs_one(BusWaitForJobs
*d
, const char *path
, bool quiet
) {
328 r
= bus_wait_for_jobs_add(d
, path
);
332 return bus_wait_for_jobs(d
, quiet
, NULL
);