src/libelogind/sd-bus/bus-error.h

   1 /* SPDX-License-Identifier: LGPL-2.1+ */
   2 #pragma once
   3
   4 /***
   5   This file is part of systemd.
   6
   7   Copyright 2013 Lennart Poettering
   8 ***/
   9
  10 #include <stdbool.h>
  11
  12 #include "sd-bus.h"
  13
  14 #include "macro.h"
  15
  16 bool bus_error_is_dirty(sd_bus_error *e);
  17
  18 const char *bus_error_message(const sd_bus_error *e, int error);
  19
  20 int bus_error_setfv(sd_bus_error *e, const char *name, const char *format, va_list ap) _printf_(3,0);
  21 int bus_error_set_errnofv(sd_bus_error *e, int error, const char *format, va_list ap) _printf_(3,0);
  22
  23 #define BUS_ERROR_OOM SD_BUS_ERROR_MAKE_CONST(SD_BUS_ERROR_NO_MEMORY, "Out of memory")
  24 #define BUS_ERROR_FAILED SD_BUS_ERROR_MAKE_CONST(SD_BUS_ERROR_FAILED, "Operation failed")
  25
  26 /*
  27  * There are two ways to register error maps with the error translation
  28  * logic: by using BUS_ERROR_MAP_ELF_REGISTER, which however only
  29  * works when linked into the same ELF module, or via
  30  * sd_bus_error_add_map() which is the official, external API, that
  31  * works from any module.
  32  *
  33  * Note that BUS_ERROR_MAP_ELF_REGISTER has to be used as decorator in
  34  * the bus error table, and BUS_ERROR_MAP_ELF_USE has to be used at
  35  * least once per compilation unit (i.e. per library), to ensure that
  36  * the error map is really added to the final binary.
  37  */
  38
  39 #define BUS_ERROR_MAP_ELF_REGISTER                                      \
  40         __attribute__ ((__section__("BUS_ERROR_MAP")))                  \
  41         __attribute__ ((__used__))                                      \
  42         __attribute__ ((aligned(8)))
  43
  44 #define BUS_ERROR_MAP_ELF_USE(errors)                                   \
  45         extern const sd_bus_error_map errors[];                         \
  46         __attribute__ ((used)) static const sd_bus_error_map * const CONCATENATE(errors ## _copy_, __COUNTER__) = errors;
  47
  48 /* We use something exotic as end marker, to ensure people build the
  49  * maps using the macsd-ros. */
  50 #define BUS_ERROR_MAP_END_MARKER -'x'
  51
  52 BUS_ERROR_MAP_ELF_USE(bus_standard_errors);