1 /* SPDX-License-Identifier: LGPL-2.1+ */
3 Copyright 2013 Lennart Poettering
15 #include "alloc-util.h"
16 #include "bus-error.h"
17 #include "errno-list.h"
18 #include "string-util.h"
21 BUS_ERROR_MAP_ELF_REGISTER const sd_bus_error_map bus_standard_errors[] = {
22 SD_BUS_ERROR_MAP("org.freedesktop.DBus.Error.Failed", EACCES),
23 SD_BUS_ERROR_MAP("org.freedesktop.DBus.Error.NoMemory", ENOMEM),
24 SD_BUS_ERROR_MAP("org.freedesktop.DBus.Error.ServiceUnknown", EHOSTUNREACH),
25 SD_BUS_ERROR_MAP("org.freedesktop.DBus.Error.NameHasNoOwner", ENXIO),
26 SD_BUS_ERROR_MAP("org.freedesktop.DBus.Error.NoReply", ETIMEDOUT),
27 SD_BUS_ERROR_MAP("org.freedesktop.DBus.Error.IOError", EIO),
28 SD_BUS_ERROR_MAP("org.freedesktop.DBus.Error.BadAddress", EADDRNOTAVAIL),
29 SD_BUS_ERROR_MAP("org.freedesktop.DBus.Error.NotSupported", EOPNOTSUPP),
30 SD_BUS_ERROR_MAP("org.freedesktop.DBus.Error.LimitsExceeded", ENOBUFS),
31 SD_BUS_ERROR_MAP("org.freedesktop.DBus.Error.AccessDenied", EACCES),
32 SD_BUS_ERROR_MAP("org.freedesktop.DBus.Error.AuthFailed", EACCES),
33 SD_BUS_ERROR_MAP("org.freedesktop.DBus.Error.InteractiveAuthorizationRequired", EACCES),
34 SD_BUS_ERROR_MAP("org.freedesktop.DBus.Error.NoServer", EHOSTDOWN),
35 SD_BUS_ERROR_MAP("org.freedesktop.DBus.Error.Timeout", ETIMEDOUT),
36 SD_BUS_ERROR_MAP("org.freedesktop.DBus.Error.NoNetwork", ENONET),
37 SD_BUS_ERROR_MAP("org.freedesktop.DBus.Error.AddressInUse", EADDRINUSE),
38 SD_BUS_ERROR_MAP("org.freedesktop.DBus.Error.Disconnected", ECONNRESET),
39 SD_BUS_ERROR_MAP("org.freedesktop.DBus.Error.InvalidArgs", EINVAL),
40 SD_BUS_ERROR_MAP("org.freedesktop.DBus.Error.FileNotFound", ENOENT),
41 SD_BUS_ERROR_MAP("org.freedesktop.DBus.Error.FileExists", EEXIST),
42 SD_BUS_ERROR_MAP("org.freedesktop.DBus.Error.UnknownMethod", EBADR),
43 SD_BUS_ERROR_MAP("org.freedesktop.DBus.Error.UnknownObject", EBADR),
44 SD_BUS_ERROR_MAP("org.freedesktop.DBus.Error.UnknownInterface", EBADR),
45 SD_BUS_ERROR_MAP("org.freedesktop.DBus.Error.UnknownProperty", EBADR),
46 SD_BUS_ERROR_MAP("org.freedesktop.DBus.Error.PropertyReadOnly", EROFS),
47 SD_BUS_ERROR_MAP("org.freedesktop.DBus.Error.UnixProcessIdUnknown", ESRCH),
48 SD_BUS_ERROR_MAP("org.freedesktop.DBus.Error.InvalidSignature", EINVAL),
49 SD_BUS_ERROR_MAP("org.freedesktop.DBus.Error.InconsistentMessage", EBADMSG),
50 SD_BUS_ERROR_MAP("org.freedesktop.DBus.Error.TimedOut", ETIMEDOUT),
51 SD_BUS_ERROR_MAP("org.freedesktop.DBus.Error.MatchRuleInvalid", EINVAL),
52 SD_BUS_ERROR_MAP("org.freedesktop.DBus.Error.InvalidFileContent", EINVAL),
53 SD_BUS_ERROR_MAP("org.freedesktop.DBus.Error.MatchRuleNotFound", ENOENT),
54 SD_BUS_ERROR_MAP("org.freedesktop.DBus.Error.SELinuxSecurityContextUnknown", ESRCH),
55 SD_BUS_ERROR_MAP("org.freedesktop.DBus.Error.ObjectPathInUse", EBUSY),
59 /* GCC maps this magically to the beginning and end of the BUS_ERROR_MAP section */
60 extern const sd_bus_error_map __start_BUS_ERROR_MAP[];
61 extern const sd_bus_error_map __stop_BUS_ERROR_MAP[];
63 /* Additional maps registered with sd_bus_error_add_map() are in this
64 * NULL terminated array */
65 static const sd_bus_error_map **additional_error_maps = NULL;
67 static int bus_error_name_to_errno(const char *name) {
68 const sd_bus_error_map **map, *m;
75 p = startswith(name, "System.Error.");
77 r = errno_from_name(p);
84 if (additional_error_maps)
85 for (map = additional_error_maps; *map; map++)
86 for (m = *map;; m++) {
87 /* For additional error maps the end marker is actually the end marker */
88 if (m->code == BUS_ERROR_MAP_END_MARKER)
91 if (streq(m->name, name))
95 m = __start_BUS_ERROR_MAP;
96 #ifndef FUZZING_BUILD_MODE_UNSAFE_FOR_PRODUCTION
97 while (m < __stop_BUS_ERROR_MAP) {
98 /* For magic ELF error maps, the end marker might
99 * appear in the middle of things, since multiple maps
100 * might appear in the same section. Hence, let's skip
101 * over it, but realign the pointer to the next 8 byte
102 * boundary, which is the selected alignment for the
104 if (m->code == BUS_ERROR_MAP_END_MARKER) {
109 if (streq(m->name, name))
119 static sd_bus_error errno_to_bus_error_const(int error) {
127 return BUS_ERROR_OOM;
131 return SD_BUS_ERROR_MAKE_CONST(SD_BUS_ERROR_ACCESS_DENIED, "Access denied");
134 return SD_BUS_ERROR_MAKE_CONST(SD_BUS_ERROR_INVALID_ARGS, "Invalid argument");
137 return SD_BUS_ERROR_MAKE_CONST(SD_BUS_ERROR_UNIX_PROCESS_ID_UNKNOWN, "No such process");
140 return SD_BUS_ERROR_MAKE_CONST(SD_BUS_ERROR_FILE_NOT_FOUND, "File not found");
143 return SD_BUS_ERROR_MAKE_CONST(SD_BUS_ERROR_FILE_EXISTS, "File exists");
147 return SD_BUS_ERROR_MAKE_CONST(SD_BUS_ERROR_TIMEOUT, "Timed out");
150 return SD_BUS_ERROR_MAKE_CONST(SD_BUS_ERROR_IO_ERROR, "Input/output error");
155 return SD_BUS_ERROR_MAKE_CONST(SD_BUS_ERROR_DISCONNECTED, "Disconnected");
158 return SD_BUS_ERROR_MAKE_CONST(SD_BUS_ERROR_NOT_SUPPORTED, "Not supported");
161 return SD_BUS_ERROR_MAKE_CONST(SD_BUS_ERROR_BAD_ADDRESS, "Address not available");
164 return SD_BUS_ERROR_MAKE_CONST(SD_BUS_ERROR_LIMITS_EXCEEDED, "Limits exceeded");
167 return SD_BUS_ERROR_MAKE_CONST(SD_BUS_ERROR_ADDRESS_IN_USE, "Address in use");
170 return SD_BUS_ERROR_MAKE_CONST(SD_BUS_ERROR_INCONSISTENT_MESSAGE, "Inconsistent message");
173 return SD_BUS_ERROR_NULL;
176 static int errno_to_bus_error_name_new(int error, char **ret) {
183 name = errno_to_name(error);
187 n = strappend("System.Error.", name);
195 bool bus_error_is_dirty(sd_bus_error *e) {
199 return e->name || e->message || e->_need_free != 0;
202 _public_ void sd_bus_error_free(sd_bus_error *e) {
206 if (e->_need_free > 0) {
207 free((void*) e->name);
208 free((void*) e->message);
211 e->name = e->message = NULL;
215 _public_ int sd_bus_error_set(sd_bus_error *e, const char *name, const char *message) {
222 assert_return(!bus_error_is_dirty(e), -EINVAL);
224 e->name = strdup(name);
231 e->message = strdup(message);
236 return -bus_error_name_to_errno(name);
239 int bus_error_setfv(sd_bus_error *e, const char *name, const char *format, va_list ap) {
245 assert_return(!bus_error_is_dirty(e), -EINVAL);
247 e->name = strdup(name);
253 /* If we hit OOM on formatting the pretty message, we ignore
254 * this, since we at least managed to write the error name */
256 (void) vasprintf((char**) &e->message, format, ap);
261 return -bus_error_name_to_errno(name);
264 _public_ int sd_bus_error_setf(sd_bus_error *e, const char *name, const char *format, ...) {
270 va_start(ap, format);
271 r = bus_error_setfv(e, name, format, ap);
277 return sd_bus_error_set(e, name, NULL);
280 _public_ int sd_bus_error_copy(sd_bus_error *dest, const sd_bus_error *e) {
282 if (!sd_bus_error_is_set(e))
287 assert_return(!bus_error_is_dirty(dest), -EINVAL);
290 * _need_free < 0 indicates that the error is temporarily const, needs deep copying
291 * _need_free == 0 indicates that the error is perpetually const, needs no deep copying
292 * _need_free > 0 indicates that the error is fully dynamic, needs deep copying
295 if (e->_need_free == 0)
298 dest->name = strdup(e->name);
300 *dest = BUS_ERROR_OOM;
305 dest->message = strdup(e->message);
307 dest->_need_free = 1;
311 return -bus_error_name_to_errno(e->name);
314 _public_ int sd_bus_error_set_const(sd_bus_error *e, const char *name, const char *message) {
320 assert_return(!bus_error_is_dirty(e), -EINVAL);
322 *e = SD_BUS_ERROR_MAKE_CONST(name, message);
325 return -bus_error_name_to_errno(name);
328 _public_ int sd_bus_error_is_set(const sd_bus_error *e) {
335 _public_ int sd_bus_error_has_name(const sd_bus_error *e, const char *name) {
339 return streq_ptr(e->name, name);
342 _public_ int sd_bus_error_get_errno(const sd_bus_error* e) {
349 return bus_error_name_to_errno(e->name);
352 static void bus_error_strerror(sd_bus_error *e, int error) {
366 x = strerror_r(error, m, k);
367 if (errno == ERANGE || strlen(x) >= k - 1) {
379 if (e->_need_free > 0) {
380 /* Error is already dynamic, let's just update the message */
381 free((char*) e->message);
386 /* Error was const so far, let's make it dynamic, if we can */
401 if (e->_need_free > 0) {
404 /* Error is dynamic, let's hence make the message also dynamic */
409 free((char*) e->message);
412 /* Error is const, hence we can just override */
421 _public_ int sd_bus_error_set_errno(sd_bus_error *e, int error) {
431 assert_return(!bus_error_is_dirty(e), -EINVAL);
433 /* First, try a const translation */
434 *e = errno_to_bus_error_const(error);
436 if (!sd_bus_error_is_set(e)) {
439 /* If that didn't work, try a dynamic one. */
441 k = errno_to_bus_error_name_new(error, (char**) &e->name);
448 *e = BUS_ERROR_FAILED;
451 /* Now, fill in the message from strerror() if we can */
452 bus_error_strerror(e, error);
456 _public_ int sd_bus_error_set_errnofv(sd_bus_error *e, int error, const char *format, va_list ap) {
468 assert_return(!bus_error_is_dirty(e), -EINVAL);
470 /* First, try a const translation */
471 *e = errno_to_bus_error_const(error);
473 if (!sd_bus_error_is_set(e)) {
476 /* If that didn't work, try a dynamic one */
478 k = errno_to_bus_error_name_new(error, (char**) &e->name);
485 *e = BUS_ERROR_FAILED;
491 /* Then, let's try to fill in the supplied message */
493 errno = error; /* Make sure that %m resolves to the specified error */
494 r = vasprintf(&m, format, ap);
497 if (e->_need_free <= 0) {
510 free((char*) e->message);
517 /* If that didn't work, use strerror() for the message */
518 bus_error_strerror(e, error);
522 _public_ int sd_bus_error_set_errnof(sd_bus_error *e, int error, const char *format, ...) {
533 assert_return(!bus_error_is_dirty(e), -EINVAL);
538 va_start(ap, format);
539 r = sd_bus_error_set_errnofv(e, error, format, ap);
545 return sd_bus_error_set_errno(e, error);
548 const char *bus_error_message(const sd_bus_error *e, int error) {
551 /* Sometimes, the D-Bus server is a little bit too verbose with
552 * its error messages, so let's override them here */
553 if (sd_bus_error_has_name(e, SD_BUS_ERROR_ACCESS_DENIED))
554 return "Access denied";
563 return strerror(error);
566 static bool map_ok(const sd_bus_error_map *map) {
567 for (; map->code != BUS_ERROR_MAP_END_MARKER; map++)
568 if (!map->name || map->code <=0)
573 _public_ int sd_bus_error_add_map(const sd_bus_error_map *map) {
574 const sd_bus_error_map **maps = NULL;
577 assert_return(map, -EINVAL);
578 assert_return(map_ok(map), -EINVAL);
580 if (additional_error_maps)
581 for (; additional_error_maps[n] != NULL; n++)
582 if (additional_error_maps[n] == map)
585 maps = reallocarray(additional_error_maps, n + 2, sizeof(struct sd_bus_error_map*));
592 additional_error_maps = maps;