src/libelogind/sd-bus/bus-error.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 <errno.h>
  21 #include <stdarg.h>
  22 #include <stdbool.h>
  23 #include <stdio.h>
  24 #include <stdlib.h>
  25 #include <string.h>
  26
  27 #include "sd-bus.h"
  28
  29 #include "alloc-util.h"
  30 #include "bus-error.h"
  31 #include "errno-list.h"
  32 #include "string-util.h"
  33 #include "util.h"
  34
  35 BUS_ERROR_MAP_ELF_REGISTER const sd_bus_error_map bus_standard_errors[] = {
  36         SD_BUS_ERROR_MAP("org.freedesktop.DBus.Error.Failed",                           EACCES),
  37         SD_BUS_ERROR_MAP("org.freedesktop.DBus.Error.NoMemory",                         ENOMEM),
  38         SD_BUS_ERROR_MAP("org.freedesktop.DBus.Error.ServiceUnknown",                   EHOSTUNREACH),
  39         SD_BUS_ERROR_MAP("org.freedesktop.DBus.Error.NameHasNoOwner",                   ENXIO),
  40         SD_BUS_ERROR_MAP("org.freedesktop.DBus.Error.NoReply",                          ETIMEDOUT),
  41         SD_BUS_ERROR_MAP("org.freedesktop.DBus.Error.IOError",                          EIO),
  42         SD_BUS_ERROR_MAP("org.freedesktop.DBus.Error.BadAddress",                       EADDRNOTAVAIL),
  43         SD_BUS_ERROR_MAP("org.freedesktop.DBus.Error.NotSupported",                     EOPNOTSUPP),
  44         SD_BUS_ERROR_MAP("org.freedesktop.DBus.Error.LimitsExceeded",                   ENOBUFS),
  45         SD_BUS_ERROR_MAP("org.freedesktop.DBus.Error.AccessDenied",                     EACCES),
  46         SD_BUS_ERROR_MAP("org.freedesktop.DBus.Error.AuthFailed",                       EACCES),
  47         SD_BUS_ERROR_MAP("org.freedesktop.DBus.Error.InteractiveAuthorizationRequired", EACCES),
  48         SD_BUS_ERROR_MAP("org.freedesktop.DBus.Error.NoServer",                         EHOSTDOWN),
  49         SD_BUS_ERROR_MAP("org.freedesktop.DBus.Error.Timeout",                          ETIMEDOUT),
  50         SD_BUS_ERROR_MAP("org.freedesktop.DBus.Error.NoNetwork",                        ENONET),
  51         SD_BUS_ERROR_MAP("org.freedesktop.DBus.Error.AddressInUse",                     EADDRINUSE),
  52         SD_BUS_ERROR_MAP("org.freedesktop.DBus.Error.Disconnected",                     ECONNRESET),
  53         SD_BUS_ERROR_MAP("org.freedesktop.DBus.Error.InvalidArgs",                      EINVAL),
  54         SD_BUS_ERROR_MAP("org.freedesktop.DBus.Error.FileNotFound",                     ENOENT),
  55         SD_BUS_ERROR_MAP("org.freedesktop.DBus.Error.FileExists",                       EEXIST),
  56         SD_BUS_ERROR_MAP("org.freedesktop.DBus.Error.UnknownMethod",                    EBADR),
  57         SD_BUS_ERROR_MAP("org.freedesktop.DBus.Error.UnknownObject",                    EBADR),
  58         SD_BUS_ERROR_MAP("org.freedesktop.DBus.Error.UnknownInterface",                 EBADR),
  59         SD_BUS_ERROR_MAP("org.freedesktop.DBus.Error.UnknownProperty",                  EBADR),
  60         SD_BUS_ERROR_MAP("org.freedesktop.DBus.Error.PropertyReadOnly",                 EROFS),
  61         SD_BUS_ERROR_MAP("org.freedesktop.DBus.Error.UnixProcessIdUnknown",             ESRCH),
  62         SD_BUS_ERROR_MAP("org.freedesktop.DBus.Error.InvalidSignature",                 EINVAL),
  63         SD_BUS_ERROR_MAP("org.freedesktop.DBus.Error.InconsistentMessage",              EBADMSG),
  64         SD_BUS_ERROR_MAP("org.freedesktop.DBus.Error.TimedOut",                         ETIMEDOUT),
  65         SD_BUS_ERROR_MAP("org.freedesktop.DBus.Error.MatchRuleInvalid",                 EINVAL),
  66         SD_BUS_ERROR_MAP("org.freedesktop.DBus.Error.InvalidFileContent",               EINVAL),
  67         SD_BUS_ERROR_MAP("org.freedesktop.DBus.Error.MatchRuleNotFound",                ENOENT),
  68         SD_BUS_ERROR_MAP("org.freedesktop.DBus.Error.SELinuxSecurityContextUnknown",    ESRCH),
  69         SD_BUS_ERROR_MAP("org.freedesktop.DBus.Error.ObjectPathInUse",                  EBUSY),
  70         SD_BUS_ERROR_MAP_END
  71 };
  72
  73 /* GCC maps this magically to the beginning and end of the BUS_ERROR_MAP section */
  74 extern const sd_bus_error_map __start_BUS_ERROR_MAP[];
  75 extern const sd_bus_error_map __stop_BUS_ERROR_MAP[];
  76
  77 /* Additional maps registered with sd_bus_error_add_map() are in this
  78  * NULL terminated array */
  79 static const sd_bus_error_map **additional_error_maps = NULL;
  80
  81 static int bus_error_name_to_errno(const char *name) {
  82         const sd_bus_error_map **map, *m;
  83         const char *p;
  84         int r;
  85
  86         if (!name)
  87                 return EINVAL;
  88
  89         p = startswith(name, "System.Error.");
  90         if (p) {
  91                 r = errno_from_name(p);
  92                 if (r < 0)
  93                         return EIO;
  94
  95                 return r;
  96         }
  97
  98         if (additional_error_maps)
  99                 for (map = additional_error_maps; *map; map++)
 100                         for (m = *map;; m++) {
 101                                 /* For additional error maps the end marker is actually the end marker */
 102                                 if (m->code == BUS_ERROR_MAP_END_MARKER)
 103                                         break;
 104
 105                                 if (streq(m->name, name))
 106                                         return m->code;
 107                         }
 108
 109         m = __start_BUS_ERROR_MAP;
 110         while (m < __stop_BUS_ERROR_MAP) {
 111                 /* For magic ELF error maps, the end marker might
 112                  * appear in the middle of things, since multiple maps
 113                  * might appear in the same section. Hence, let's skip
 114                  * over it, but realign the pointer to the next 8 byte
 115                  * boundary, which is the selected alignment for the
 116                  * arrays. */
 117                 if (m->code == BUS_ERROR_MAP_END_MARKER) {
 118                         m = ALIGN8_PTR(m+1);
 119                         continue;
 120                 }
 121
 122                 if (streq(m->name, name))
 123                         return m->code;
 124
 125                 m++;
 126         }
 127
 128         return EIO;
 129 }
 130
 131 static sd_bus_error errno_to_bus_error_const(int error) {
 132
 133         if (error < 0)
 134                 error = -error;
 135
 136         switch (error) {
 137
 138         case ENOMEM:
 139                 return BUS_ERROR_OOM;
 140
 141         case EPERM:
 142         case EACCES:
 143                 return SD_BUS_ERROR_MAKE_CONST(SD_BUS_ERROR_ACCESS_DENIED, "Access denied");
 144
 145         case EINVAL:
 146                 return SD_BUS_ERROR_MAKE_CONST(SD_BUS_ERROR_INVALID_ARGS, "Invalid argument");
 147
 148         case ESRCH:
 149                 return SD_BUS_ERROR_MAKE_CONST(SD_BUS_ERROR_UNIX_PROCESS_ID_UNKNOWN, "No such process");
 150
 151         case ENOENT:
 152                 return SD_BUS_ERROR_MAKE_CONST(SD_BUS_ERROR_FILE_NOT_FOUND, "File not found");
 153
 154         case EEXIST:
 155                 return SD_BUS_ERROR_MAKE_CONST(SD_BUS_ERROR_FILE_EXISTS, "File exists");
 156
 157         case ETIMEDOUT:
 158         case ETIME:
 159                 return SD_BUS_ERROR_MAKE_CONST(SD_BUS_ERROR_TIMEOUT, "Timed out");
 160
 161         case EIO:
 162                 return SD_BUS_ERROR_MAKE_CONST(SD_BUS_ERROR_IO_ERROR, "Input/output error");
 163
 164         case ENETRESET:
 165         case ECONNABORTED:
 166         case ECONNRESET:
 167                 return SD_BUS_ERROR_MAKE_CONST(SD_BUS_ERROR_DISCONNECTED, "Disconnected");
 168
 169         case EOPNOTSUPP:
 170                 return SD_BUS_ERROR_MAKE_CONST(SD_BUS_ERROR_NOT_SUPPORTED, "Not supported");
 171
 172         case EADDRNOTAVAIL:
 173                 return SD_BUS_ERROR_MAKE_CONST(SD_BUS_ERROR_BAD_ADDRESS, "Address not available");
 174
 175         case ENOBUFS:
 176                 return SD_BUS_ERROR_MAKE_CONST(SD_BUS_ERROR_LIMITS_EXCEEDED, "Limits exceeded");
 177
 178         case EADDRINUSE:
 179                 return SD_BUS_ERROR_MAKE_CONST(SD_BUS_ERROR_ADDRESS_IN_USE, "Address in use");
 180
 181         case EBADMSG:
 182                 return SD_BUS_ERROR_MAKE_CONST(SD_BUS_ERROR_INCONSISTENT_MESSAGE, "Inconsistent message");
 183         }
 184
 185         return SD_BUS_ERROR_NULL;
 186 }
 187
 188 static int errno_to_bus_error_name_new(int error, char **ret) {
 189         const char *name;
 190         char *n;
 191
 192         if (error < 0)
 193                 error = -error;
 194
 195         name = errno_to_name(error);
 196         if (!name)
 197                 return 0;
 198
 199         n = strappend("System.Error.", name);
 200         if (!n)
 201                 return -ENOMEM;
 202
 203         *ret = n;
 204         return 1;
 205 }
 206
 207 bool bus_error_is_dirty(sd_bus_error *e) {
 208         if (!e)
 209                 return false;
 210
 211         return e->name || e->message || e->_need_free != 0;
 212 }
 213
 214 _public_ void sd_bus_error_free(sd_bus_error *e) {
 215         if (!e)
 216                 return;
 217
 218         if (e->_need_free > 0) {
 219                 free((void*) e->name);
 220                 free((void*) e->message);
 221         }
 222
 223         e->name = e->message = NULL;
 224         e->_need_free = 0;
 225 }
 226
 227 _public_ int sd_bus_error_set(sd_bus_error *e, const char *name, const char *message) {
 228
 229         if (!name)
 230                 return 0;
 231         if (!e)
 232                 goto finish;
 233
 234         assert_return(!bus_error_is_dirty(e), -EINVAL);
 235
 236         e->name = strdup(name);
 237         if (!e->name) {
 238                 *e = BUS_ERROR_OOM;
 239                 return -ENOMEM;
 240         }
 241
 242         if (message)
 243                 e->message = strdup(message);
 244
 245         e->_need_free = 1;
 246
 247 finish:
 248         return -bus_error_name_to_errno(name);
 249 }
 250
 251 int bus_error_setfv(sd_bus_error *e, const char *name, const char *format, va_list ap) {
 252
 253         if (!name)
 254                 return 0;
 255
 256         if (e) {
 257                 assert_return(!bus_error_is_dirty(e), -EINVAL);
 258
 259                 e->name = strdup(name);
 260                 if (!e->name) {
 261                         *e = BUS_ERROR_OOM;
 262                         return -ENOMEM;
 263                 }
 264
 265                 /* If we hit OOM on formatting the pretty message, we ignore
 266                  * this, since we at least managed to write the error name */
 267                 if (format)
 268                         (void) vasprintf((char**) &e->message, format, ap);
 269
 270                 e->_need_free = 1;
 271         }
 272
 273         return -bus_error_name_to_errno(name);
 274 }
 275
 276 _public_ int sd_bus_error_setf(sd_bus_error *e, const char *name, const char *format, ...) {
 277
 278         if (format) {
 279                 int r;
 280                 va_list ap;
 281
 282                 va_start(ap, format);
 283                 r = bus_error_setfv(e, name, format, ap);
 284                 va_end(ap);
 285
 286                 return r;
 287         }
 288
 289         return sd_bus_error_set(e, name, NULL);
 290 }
 291
 292 _public_ int sd_bus_error_copy(sd_bus_error *dest, const sd_bus_error *e) {
 293
 294         if (!sd_bus_error_is_set(e))
 295                 return 0;
 296         if (!dest)
 297                 goto finish;
 298
 299         assert_return(!bus_error_is_dirty(dest), -EINVAL);
 300
 301         /*
 302          * _need_free  < 0 indicates that the error is temporarily const, needs deep copying
 303          * _need_free == 0 indicates that the error is perpetually const, needs no deep copying
 304          * _need_free  > 0 indicates that the error is fully dynamic, needs deep copying
 305          */
 306
 307         if (e->_need_free == 0)
 308                 *dest = *e;
 309         else {
 310                 dest->name = strdup(e->name);
 311                 if (!dest->name) {
 312                         *dest = BUS_ERROR_OOM;
 313                         return -ENOMEM;
 314                 }
 315
 316                 if (e->message)
 317                         dest->message = strdup(e->message);
 318
 319                 dest->_need_free = 1;
 320         }
 321
 322 finish:
 323         return -bus_error_name_to_errno(e->name);
 324 }
 325
 326 _public_ int sd_bus_error_set_const(sd_bus_error *e, const char *name, const char *message) {
 327         if (!name)
 328                 return 0;
 329         if (!e)
 330                 goto finish;
 331
 332         assert_return(!bus_error_is_dirty(e), -EINVAL);
 333
 334         *e = SD_BUS_ERROR_MAKE_CONST(name, message);
 335
 336 finish:
 337         return -bus_error_name_to_errno(name);
 338 }
 339
 340 _public_ int sd_bus_error_is_set(const sd_bus_error *e) {
 341         if (!e)
 342                 return 0;
 343
 344         return !!e->name;
 345 }
 346
 347 _public_ int sd_bus_error_has_name(const sd_bus_error *e, const char *name) {
 348         if (!e)
 349                 return 0;
 350
 351         return streq_ptr(e->name, name);
 352 }
 353
 354 _public_ int sd_bus_error_get_errno(const sd_bus_error* e) {
 355         if (!e)
 356                 return 0;
 357
 358         if (!e->name)
 359                 return 0;
 360
 361         return bus_error_name_to_errno(e->name);
 362 }
 363
 364 static void bus_error_strerror(sd_bus_error *e, int error) {
 365         size_t k = 64;
 366         char *m;
 367
 368         assert(e);
 369
 370         for (;;) {
 371                 char *x;
 372
 373                 m = new(char, k);
 374                 if (!m)
 375                         return;
 376
 377                 errno = 0;
 378                 x = strerror_r(error, m, k);
 379                 if (errno == ERANGE || strlen(x) >= k - 1) {
 380                         free(m);
 381                         k *= 2;
 382                         continue;
 383                 }
 384
 385                 if (errno) {
 386                         free(m);
 387                         return;
 388                 }
 389
 390                 if (x == m) {
 391                         if (e->_need_free > 0) {
 392                                 /* Error is already dynamic, let's just update the message */
 393                                 free((char*) e->message);
 394                                 e->message = x;
 395
 396                         } else {
 397                                 char *t;
 398                                 /* Error was const so far, let's make it dynamic, if we can */
 399
 400                                 t = strdup(e->name);
 401                                 if (!t) {
 402                                         free(m);
 403                                         return;
 404                                 }
 405
 406                                 e->_need_free = 1;
 407                                 e->name = t;
 408                                 e->message = x;
 409                         }
 410                 } else {
 411                         free(m);
 412
 413                         if (e->_need_free > 0) {
 414                                 char *t;
 415
 416                                 /* Error is dynamic, let's hence make the message also dynamic */
 417                                 t = strdup(x);
 418                                 if (!t)
 419                                         return;
 420
 421                                 free((char*) e->message);
 422                                 e->message = t;
 423                         } else {
 424                                 /* Error is const, hence we can just override */
 425                                 e->message = x;
 426                         }
 427                 }
 428
 429                 return;
 430         }
 431 }
 432
 433 _public_ int sd_bus_error_set_errno(sd_bus_error *e, int error) {
 434
 435         if (error < 0)
 436                 error = -error;
 437
 438         if (!e)
 439                 return -error;
 440         if (error == 0)
 441                 return -error;
 442
 443         assert_return(!bus_error_is_dirty(e), -EINVAL);
 444
 445         /* First, try a const translation */
 446         *e = errno_to_bus_error_const(error);
 447
 448         if (!sd_bus_error_is_set(e)) {
 449                 int k;
 450
 451                 /* If that didn't work, try a dynamic one. */
 452
 453                 k = errno_to_bus_error_name_new(error, (char**) &e->name);
 454                 if (k > 0)
 455                         e->_need_free = 1;
 456                 else if (k < 0) {
 457                         *e = BUS_ERROR_OOM;
 458                         return -error;
 459                 } else
 460                         *e = BUS_ERROR_FAILED;
 461         }
 462
 463         /* Now, fill in the message from strerror() if we can */
 464         bus_error_strerror(e, error);
 465         return -error;
 466 }
 467
 468 _public_ int sd_bus_error_set_errnofv(sd_bus_error *e, int error, const char *format, va_list ap) {
 469         PROTECT_ERRNO;
 470         int r;
 471
 472         if (error < 0)
 473                 error = -error;
 474
 475         if (!e)
 476                 return -error;
 477         if (error == 0)
 478                 return 0;
 479
 480         assert_return(!bus_error_is_dirty(e), -EINVAL);
 481
 482         /* First, try a const translation */
 483         *e = errno_to_bus_error_const(error);
 484
 485         if (!sd_bus_error_is_set(e)) {
 486                 int k;
 487
 488                 /* If that didn't work, try a dynamic one */
 489
 490                 k = errno_to_bus_error_name_new(error, (char**) &e->name);
 491                 if (k > 0)
 492                         e->_need_free = 1;
 493                 else if (k < 0) {
 494                         *e = BUS_ERROR_OOM;
 495                         return -ENOMEM;
 496                 } else
 497                         *e = BUS_ERROR_FAILED;
 498         }
 499
 500         if (format) {
 501                 char *m;
 502
 503                 /* Then, let's try to fill in the supplied message */
 504
 505                 errno = error; /* Make sure that %m resolves to the specified error */
 506                 r = vasprintf(&m, format, ap);
 507                 if (r >= 0) {
 508
 509                         if (e->_need_free <= 0) {
 510                                 char *t;
 511
 512                                 t = strdup(e->name);
 513                                 if (t) {
 514                                         e->_need_free = 1;
 515                                         e->name = t;
 516                                         e->message = m;
 517                                         return -error;
 518                                 }
 519
 520                                 free(m);
 521                         } else {
 522                                 free((char*) e->message);
 523                                 e->message = m;
 524                                 return -error;
 525                         }
 526                 }
 527         }
 528
 529         /* If that didn't work, use strerror() for the message */
 530         bus_error_strerror(e, error);
 531         return -error;
 532 }
 533
 534 _public_ int sd_bus_error_set_errnof(sd_bus_error *e, int error, const char *format, ...) {
 535         int r;
 536
 537         if (error < 0)
 538                 error = -error;
 539
 540         if (!e)
 541                 return -error;
 542         if (error == 0)
 543                 return 0;
 544
 545         assert_return(!bus_error_is_dirty(e), -EINVAL);
 546
 547         if (format) {
 548                 va_list ap;
 549
 550                 va_start(ap, format);
 551                 r = sd_bus_error_set_errnofv(e, error, format, ap);
 552                 va_end(ap);
 553
 554                 return r;
 555         }
 556
 557         return sd_bus_error_set_errno(e, error);
 558 }
 559
 560 const char *bus_error_message(const sd_bus_error *e, int error) {
 561
 562         if (e) {
 563                 /* Sometimes, the D-Bus server is a little bit too verbose with
 564                  * its error messages, so let's override them here */
 565                 if (sd_bus_error_has_name(e, SD_BUS_ERROR_ACCESS_DENIED))
 566                         return "Access denied";
 567
 568                 if (e->message)
 569                         return e->message;
 570         }
 571
 572         if (error < 0)
 573                 error = -error;
 574
 575         return strerror(error);
 576 }
 577
 578 static bool map_ok(const sd_bus_error_map *map) {
 579         for (; map->code != BUS_ERROR_MAP_END_MARKER; map++)
 580                 if (!map->name || map->code <=0)
 581                         return false;
 582         return true;
 583 }
 584
 585 _public_ int sd_bus_error_add_map(const sd_bus_error_map *map) {
 586         const sd_bus_error_map **maps = NULL;
 587         unsigned n = 0;
 588
 589         assert_return(map, -EINVAL);
 590         assert_return(map_ok(map), -EINVAL);
 591
 592         if (additional_error_maps)
 593                 for (; additional_error_maps[n] != NULL; n++)
 594                         if (additional_error_maps[n] == map)
 595                                 return 0;
 596
 597         maps = realloc_multiply(additional_error_maps, sizeof(struct sd_bus_error_map*), n + 2);
 598         if (!maps)
 599                 return -ENOMEM;
 600
 601         maps[n] = map;
 602         maps[n+1] = NULL;
 603
 604         additional_error_maps = maps;
 605         return 1;
 606 }