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