src/shared/bus-util.h

   1 /* SPDX-License-Identifier: LGPL-2.1+ */
   2 #pragma once
   3
   4 /***
   5   Copyright 2013 Lennart Poettering
   6 ***/
   7
   8 #include <stdbool.h>
   9 #include <stddef.h>
  10 #include <stdint.h>
  11 #include <sys/types.h>
  12
  13 #include "sd-bus.h"
  14 #include "sd-event.h"
  15
  16 #include "hashmap.h"
  17 #include "macro.h"
  18 #include "string-util.h"
  19
  20 typedef enum BusTransport {
  21         BUS_TRANSPORT_LOCAL,
  22         BUS_TRANSPORT_REMOTE,
  23         BUS_TRANSPORT_MACHINE,
  24         _BUS_TRANSPORT_MAX,
  25         _BUS_TRANSPORT_INVALID = -1
  26 } BusTransport;
  27
  28 typedef int (*bus_property_set_t) (sd_bus *bus, const char *member, sd_bus_message *m, sd_bus_error *error, void *userdata);
  29
  30 struct bus_properties_map {
  31         const char *member;
  32         const char *signature;
  33         bus_property_set_t set;
  34         size_t offset;
  35 };
  36
  37 enum {
  38         BUS_MAP_STRDUP          = 1 << 0, /* If set, each "s" message is duplicated. Thus, each pointer needs to be freed. */
  39         BUS_MAP_BOOLEAN_AS_BOOL = 1 << 1, /* If set, each "b" message is written to a bool pointer. If not set, "b" is written to a int pointer. */
  40 };
  41
  42 int bus_map_id128(sd_bus *bus, const char *member, sd_bus_message *m, sd_bus_error *error, void *userdata);
  43
  44 #if 0 /// UNNEEDED by elogind
  45 #endif // 0
  46 int bus_message_map_all_properties(sd_bus_message *m, const struct bus_properties_map *map, unsigned flags, sd_bus_error *error, void *userdata);
  47 int bus_message_map_properties_changed(sd_bus_message *m, const struct bus_properties_map *map, unsigned flags, sd_bus_error *error, void *userdata);
  48 int bus_map_all_properties(sd_bus *bus, const char *destination, const char *path, const struct bus_properties_map *map,
  49                            unsigned flags, sd_bus_error *error, sd_bus_message **reply, void *userdata);
  50
  51 #if 0 /// UNNEEDED by elogind
  52 int bus_async_unregister_and_exit(sd_event *e, sd_bus *bus, const char *name);
  53 #endif // 0
  54
  55 typedef bool (*check_idle_t)(void *userdata);
  56
  57 #if 0 /// UNNEEDED by elogind
  58 int bus_event_loop_with_idle(sd_event *e, sd_bus *bus, const char *name, usec_t timeout, check_idle_t check_idle, void *userdata);
  59 #endif // 0
  60
  61 int bus_name_has_owner(sd_bus *c, const char *name, sd_bus_error *error);
  62
  63 #if 0 /// UNNEEDED by elogind
  64 int bus_check_peercred(sd_bus *c);
  65 #endif // 0
  66
  67 int bus_test_polkit(sd_bus_message *call, int capability, const char *action, const char **details, uid_t good_user, bool *_challenge, sd_bus_error *e);
  68
  69 int bus_verify_polkit_async(sd_bus_message *call, int capability, const char *action, const char **details, bool interactive, uid_t good_user, Hashmap **registry, sd_bus_error *error);
  70 void bus_verify_polkit_async_registry_free(Hashmap *registry);
  71
  72 #if 0 /// UNNEEDED by elogind
  73 #endif // 0
  74 int bus_connect_system_systemd(sd_bus **_bus);
  75 int bus_connect_user_systemd(sd_bus **_bus);
  76
  77 int bus_connect_transport(BusTransport transport, const char *host, bool user, sd_bus **bus);
  78 #if 0 /// UNNEEDED by elogind
  79 #endif // 0
  80 int bus_connect_transport_systemd(BusTransport transport, const char *host, bool user, sd_bus **bus);
  81
  82 typedef int (*bus_message_print_t) (const char *name, sd_bus_message *m, bool value, bool all);
  83
  84 int bus_print_property(const char *name, sd_bus_message *property, bool value, bool all);
  85 int bus_message_print_all_properties(sd_bus_message *m, bus_message_print_t func, char **filter, bool value, bool all, Set **found_properties);
  86 int bus_print_all_properties(sd_bus *bus, const char *dest, const char *path, bus_message_print_t func, char **filter, bool value, bool all, Set **found_properties);
  87
  88 int bus_property_get_bool(sd_bus *bus, const char *path, const char *interface, const char *property, sd_bus_message *reply, void *userdata, sd_bus_error *error);
  89 int bus_property_set_bool(sd_bus *bus, const char *path, const char *interface, const char *property, sd_bus_message *value, void *userdata, sd_bus_error *error);
  90 #if 0 /// UNNEEDED by elogind
  91 int bus_property_get_id128(sd_bus *bus, const char *path, const char *interface, const char *property, sd_bus_message *reply, void *userdata, sd_bus_error *error);
  92 #endif // 0
  93
  94 #define bus_property_get_usec ((sd_bus_property_get_t) NULL)
  95 #define bus_property_set_usec ((sd_bus_property_set_t) NULL)
  96
  97 assert_cc(sizeof(int) == sizeof(int32_t));
  98 #define bus_property_get_int ((sd_bus_property_get_t) NULL)
  99
 100 assert_cc(sizeof(unsigned) == sizeof(uint32_t));
 101 #define bus_property_get_unsigned ((sd_bus_property_get_t) NULL)
 102
 103 /* On 64bit machines we can use the default serializer for size_t and
 104  * friends, otherwise we need to cast this manually */
 105 #if __SIZEOF_SIZE_T__ == 8
 106 #define bus_property_get_size ((sd_bus_property_get_t) NULL)
 107 #else
 108 int bus_property_get_size(sd_bus *bus, const char *path, const char *interface, const char *property, sd_bus_message *reply, void *userdata, sd_bus_error *error);
 109 #endif
 110
 111 #if __SIZEOF_LONG__ == 8
 112 #define bus_property_get_long ((sd_bus_property_get_t) NULL)
 113 #define bus_property_get_ulong ((sd_bus_property_get_t) NULL)
 114 #else
 115 int bus_property_get_long(sd_bus *bus, const char *path, const char *interface, const char *property, sd_bus_message *reply, void *userdata, sd_bus_error *error);
 116 int bus_property_get_ulong(sd_bus *bus, const char *path, const char *interface, const char *property, sd_bus_message *reply, void *userdata, sd_bus_error *error);
 117 #endif
 118
 119 /* uid_t and friends on Linux 32 bit. This means we can just use the
 120  * default serializer for 32bit unsigned, for serializing it, and map
 121  * it to NULL here */
 122 assert_cc(sizeof(uid_t) == sizeof(uint32_t));
 123 #define bus_property_get_uid ((sd_bus_property_get_t) NULL)
 124
 125 assert_cc(sizeof(gid_t) == sizeof(uint32_t));
 126 #define bus_property_get_gid ((sd_bus_property_get_t) NULL)
 127
 128 assert_cc(sizeof(pid_t) == sizeof(uint32_t));
 129 #define bus_property_get_pid ((sd_bus_property_get_t) NULL)
 130
 131 assert_cc(sizeof(mode_t) == sizeof(uint32_t));
 132 #define bus_property_get_mode ((sd_bus_property_get_t) NULL)
 133
 134 int bus_log_parse_error(int r);
 135 int bus_log_create_error(int r);
 136
 137 #if 0 /// UNNEEDED by elogind
 138 #endif // 0
 139 #define BUS_DEFINE_PROPERTY_GET_GLOBAL(function, bus_type, val)         \
 140         int function(sd_bus *bus,                                       \
 141                      const char *path,                                  \
 142                      const char *interface,                             \
 143                      const char *property,                              \
 144                      sd_bus_message *reply,                             \
 145                      void *userdata,                                    \
 146                      sd_bus_error *error) {                             \
 147                                                                         \
 148                 assert(bus);                                            \
 149                 assert(reply);                                          \
 150                                                                         \
 151                 return sd_bus_message_append(reply, bus_type, val);     \
 152         }
 153
 154 #define BUS_DEFINE_PROPERTY_GET2(function, bus_type, data_type, get1, get2) \
 155         int function(sd_bus *bus,                                       \
 156                      const char *path,                                  \
 157                      const char *interface,                             \
 158                      const char *property,                              \
 159                      sd_bus_message *reply,                             \
 160                      void *userdata,                                    \
 161                      sd_bus_error *error) {                             \
 162                                                                         \
 163                 data_type *data = userdata;                             \
 164                                                                         \
 165                 assert(bus);                                            \
 166                 assert(reply);                                          \
 167                 assert(data);                                           \
 168                                                                         \
 169                 return sd_bus_message_append(reply, bus_type,           \
 170                                              get2(get1(data)));         \
 171         }
 172
 173 #define ident(x) (x)
 174 #define BUS_DEFINE_PROPERTY_GET(function, bus_type, data_type, get1) \
 175         BUS_DEFINE_PROPERTY_GET2(function, bus_type, data_type, get1, ident)
 176
 177 #define ref(x) (*(x))
 178 #define BUS_DEFINE_PROPERTY_GET_REF(function, bus_type, data_type, get) \
 179         BUS_DEFINE_PROPERTY_GET2(function, bus_type, data_type, ref, get)
 180
 181 #define BUS_DEFINE_PROPERTY_GET_ENUM(function, name, type)              \
 182         BUS_DEFINE_PROPERTY_GET_REF(function, "s", type, name##_to_string)
 183
 184 #define BUS_PROPERTY_DUAL_TIMESTAMP(name, offset, flags) \
 185         SD_BUS_PROPERTY(name, "t", bus_property_get_usec, (offset) + offsetof(struct dual_timestamp, realtime), (flags)), \
 186         SD_BUS_PROPERTY(name "Monotonic", "t", bus_property_get_usec, (offset) + offsetof(struct dual_timestamp, monotonic), (flags))
 187
 188 #if 0 /// UNNEEDED by elogind
 189 int bus_path_encode_unique(sd_bus *b, const char *prefix, const char *sender_id, const char *external_id, char **ret_path);
 190 int bus_path_decode_unique(const char *path, const char *prefix, char **ret_sender, char **ret_external);
 191 #endif // 0
 192
 193 #if 0 /// UNNEEDED by elogind
 194 int bus_property_get_rlimit(sd_bus *bus, const char *path, const char *interface, const char *property, sd_bus_message *reply, void *userdata, sd_bus_error *error);
 195
 196 int bus_track_add_name_many(sd_bus_track *t, char **l);
 197 #endif // 0
 198
 199 int bus_open_system_watch_bind_with_description(sd_bus **ret, const char *description);
 200 static inline int bus_open_system_watch_bind(sd_bus **ret) {
 201         return bus_open_system_watch_bind_with_description(ret, NULL);
 202 }
 203
 204 int bus_request_name_async_may_reload_dbus(sd_bus *bus, sd_bus_slot **ret_slot, const char *name, uint64_t flags, void *userdata);
 205
 206 int bus_reply_pair_array(sd_bus_message *m, char **l);