]>
git.ipfire.org Git - thirdparty/systemd.git/blob - src/shared/bus-wait-for-jobs.c
1 /* SPDX-License-Identifier: LGPL-2.1+ */
3 #include "alloc-util.h"
4 #include "bus-wait-for-jobs.h"
7 #include "bus-internal.h"
12 typedef struct BusWaitForJobs
{
19 sd_bus_slot
*slot_job_removed
;
20 sd_bus_slot
*slot_disconnected
;
23 static int match_disconnected(sd_bus_message
*m
, void *userdata
, sd_bus_error
*error
) {
26 log_error("Warning! D-Bus connection terminated.");
27 sd_bus_close(sd_bus_message_get_bus(m
));
32 static int match_job_removed(sd_bus_message
*m
, void *userdata
, sd_bus_error
*error
) {
33 const char *path
, *unit
, *result
;
34 BusWaitForJobs
*d
= userdata
;
42 r
= sd_bus_message_read(m
, "uoss", &id
, &path
, &unit
, &result
);
44 bus_log_parse_error(r
);
48 found
= set_remove(d
->jobs
, (char*) path
);
54 (void) free_and_strdup(&d
->result
, empty_to_null(result
));
55 (void) free_and_strdup(&d
->name
, empty_to_null(unit
));
60 void bus_wait_for_jobs_free(BusWaitForJobs
*d
) {
64 set_free_free(d
->jobs
);
66 sd_bus_slot_unref(d
->slot_disconnected
);
67 sd_bus_slot_unref(d
->slot_job_removed
);
77 int bus_wait_for_jobs_new(sd_bus
*bus
, BusWaitForJobs
**ret
) {
78 _cleanup_(bus_wait_for_jobs_freep
) BusWaitForJobs
*d
= NULL
;
84 d
= new(BusWaitForJobs
, 1);
88 *d
= (BusWaitForJobs
) {
89 .bus
= sd_bus_ref(bus
),
92 /* When we are a bus client we match by sender. Direct
93 * connections OTOH have no initialized sender field, and
94 * hence we ignore the sender then */
95 r
= sd_bus_match_signal_async(
98 bus
->bus_client
? "org.freedesktop.systemd1" : NULL
,
99 "/org/freedesktop/systemd1",
100 "org.freedesktop.systemd1.Manager",
102 match_job_removed
, NULL
, d
);
106 r
= sd_bus_match_signal_async(
108 &d
->slot_disconnected
,
109 "org.freedesktop.DBus.Local",
111 "org.freedesktop.DBus.Local",
113 match_disconnected
, NULL
, d
);
122 static int bus_process_wait(sd_bus
*bus
) {
126 r
= sd_bus_process(bus
, NULL
);
132 r
= sd_bus_wait(bus
, (uint64_t) -1);
138 static int bus_job_get_service_result(BusWaitForJobs
*d
, char **result
) {
139 _cleanup_free_
char *dbus_path
= NULL
;
145 if (!endswith(d
->name
, ".service"))
148 dbus_path
= unit_dbus_path_from_name(d
->name
);
152 return sd_bus_get_property_string(d
->bus
,
153 "org.freedesktop.systemd1",
155 "org.freedesktop.systemd1.Service",
161 static void log_job_error_with_service_result(const char* service
, const char *result
, const char* const* extra_args
) {
162 _cleanup_free_
char *service_shell_quoted
= NULL
;
163 const char *systemctl
= "systemctl", *journalctl
= "journalctl";
165 static const struct {
166 const char *result
, *explanation
;
168 { "resources", "of unavailable resources or another system error" },
169 { "protocol", "the service did not take the steps required by its unit configuration" },
170 { "timeout", "a timeout was exceeded" },
171 { "exit-code", "the control process exited with error code" },
172 { "signal", "a fatal signal was delivered to the control process" },
173 { "core-dump", "a fatal signal was delivered causing the control process to dump core" },
174 { "watchdog", "the service failed to send watchdog ping" },
175 { "start-limit", "start of the service was attempted too often" }
180 service_shell_quoted
= shell_maybe_quote(service
, ESCAPE_BACKSLASH
);
182 if (!strv_isempty((char**) extra_args
)) {
183 _cleanup_free_
char *t
;
185 t
= strv_join((char**) extra_args
, " ");
186 systemctl
= strjoina("systemctl ", t
? : "<args>");
187 journalctl
= strjoina("journalctl ", t
? : "<args>");
190 if (!isempty(result
)) {
193 for (i
= 0; i
< ELEMENTSOF(explanations
); ++i
)
194 if (streq(result
, explanations
[i
].result
))
197 if (i
< ELEMENTSOF(explanations
)) {
198 log_error("Job for %s failed because %s.\n"
199 "See \"%s status %s\" and \"%s -xe\" for details.\n",
201 explanations
[i
].explanation
,
203 service_shell_quoted
?: "<service>",
209 log_error("Job for %s failed.\n"
210 "See \"%s status %s\" and \"%s -xe\" for details.\n",
213 service_shell_quoted
?: "<service>",
217 /* For some results maybe additional explanation is required */
218 if (streq_ptr(result
, "start-limit"))
219 log_info("To force a start use \"%1$s reset-failed %2$s\"\n"
220 "followed by \"%1$s start %2$s\" again.",
222 service_shell_quoted
?: "<service>");
225 static int check_wait_response(BusWaitForJobs
*d
, bool quiet
, const char* const* extra_args
) {
231 if (streq(d
->result
, "canceled"))
232 log_error("Job for %s canceled.", strna(d
->name
));
233 else if (streq(d
->result
, "timeout"))
234 log_error("Job for %s timed out.", strna(d
->name
));
235 else if (streq(d
->result
, "dependency"))
236 log_error("A dependency job for %s failed. See 'journalctl -xe' for details.", strna(d
->name
));
237 else if (streq(d
->result
, "invalid"))
238 log_error("%s is not active, cannot reload.", strna(d
->name
));
239 else if (streq(d
->result
, "assert"))
240 log_error("Assertion failed on job for %s.", strna(d
->name
));
241 else if (streq(d
->result
, "unsupported"))
242 log_error("Operation on or unit type of %s not supported on this system.", strna(d
->name
));
243 else if (streq(d
->result
, "collected"))
244 log_error("Queued job for %s was garbage collected.", strna(d
->name
));
245 else if (streq(d
->result
, "once"))
246 log_error("Unit %s was started already once and can't be started again.", strna(d
->name
));
247 else if (!STR_IN_SET(d
->result
, "done", "skipped")) {
249 if (d
->name
&& endswith(d
->name
, ".service")) {
250 _cleanup_free_
char *result
= NULL
;
253 q
= bus_job_get_service_result(d
, &result
);
255 log_debug_errno(q
, "Failed to get Result property of unit %s: %m", d
->name
);
257 log_job_error_with_service_result(d
->name
, result
, extra_args
);
259 log_error("Job failed. See \"journalctl -xe\" for details.");
263 if (STR_IN_SET(d
->result
, "canceled", "collected"))
265 else if (streq(d
->result
, "timeout"))
267 else if (streq(d
->result
, "dependency"))
269 else if (streq(d
->result
, "invalid"))
271 else if (streq(d
->result
, "assert"))
273 else if (streq(d
->result
, "unsupported"))
275 else if (streq(d
->result
, "once"))
277 else if (STR_IN_SET(d
->result
, "done", "skipped"))
280 return log_debug_errno(SYNTHETIC_ERRNO(EIO
),
281 "Unexpected job result, assuming server side newer than us: %s", d
->result
);
284 int bus_wait_for_jobs(BusWaitForJobs
*d
, bool quiet
, const char* const* extra_args
) {
289 while (!set_isempty(d
->jobs
)) {
292 q
= bus_process_wait(d
->bus
);
294 return log_error_errno(q
, "Failed to wait for response: %m");
296 if (d
->name
&& d
->result
) {
297 q
= check_wait_response(d
, quiet
, extra_args
);
298 /* Return the first error as it is most likely to be
303 log_debug_errno(q
, "Got result %s/%m for job %s", d
->result
, d
->name
);
306 d
->name
= mfree(d
->name
);
307 d
->result
= mfree(d
->result
);
313 int bus_wait_for_jobs_add(BusWaitForJobs
*d
, const char *path
) {
318 r
= set_ensure_allocated(&d
->jobs
, &string_hash_ops
);
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
);