src/shared/bus-util.h

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