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   systemd is free software; you can redistribute it and/or modify it
  10   under the terms of the GNU Lesser General Public License as published by
  11   the Free Software Foundation; either version 2.1 of the License, or
  12   (at your option) any later version.
  13
  14   systemd is distributed in the hope that it will be useful, but
  15   WITHOUT ANY WARRANTY; without even the implied warranty of
  16   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  17   Lesser General Public License for more details.
  18
  19   You should have received a copy of the GNU Lesser General Public License
  20   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  21 ***/
  22
  23 #include <stdbool.h>
  24 #include <stddef.h>
  25 #include <stdint.h>
  26 #include <sys/types.h>
  27
  28 #include "sd-bus.h"
  29 #include "sd-event.h"
  30
  31 #include "hashmap.h"
  32 #include "macro.h"
  33 #include "string-util.h"
  34
  35 typedef enum BusTransport {
  36         BUS_TRANSPORT_LOCAL,
  37         BUS_TRANSPORT_REMOTE,
  38         BUS_TRANSPORT_MACHINE,
  39         _BUS_TRANSPORT_MAX,
  40         _BUS_TRANSPORT_INVALID = -1
  41 } BusTransport;
  42
  43 typedef int (*bus_property_set_t) (sd_bus *bus, const char *member, sd_bus_message *m, sd_bus_error *error, void *userdata);
  44
  45 struct bus_properties_map {
  46         const char *member;
  47         const char *signature;
  48         bus_property_set_t set;
  49         size_t offset;
  50 };
  51
  52 enum {
  53         BUS_MAP_STRDUP          = 1U << 0, /* If set, each "s" message is duplicated. Thus, each pointer needs to be freed. */
  54         BUS_MAP_BOOLEAN_AS_BOOL = 1U << 1, /* If set, each "b" message is written to a bool pointer. If not set, "b" is written to a int pointer. */
  55 };
  56
  57 int bus_map_id128(sd_bus *bus, const char *member, sd_bus_message *m, sd_bus_error *error, void *userdata);
  58
  59 #if 0 /// UNNEEDED by elogind
  60 #endif // 0
  61 int bus_message_map_all_properties(sd_bus_message *m, const struct bus_properties_map *map, unsigned flags, sd_bus_error *error, void *userdata);
  62 int bus_message_map_properties_changed(sd_bus_message *m, const struct bus_properties_map *map, unsigned flags, sd_bus_error *error, void *userdata);
  63 int bus_map_all_properties(sd_bus *bus, const char *destination, const char *path, const struct bus_properties_map *map,
  64                            unsigned flags, sd_bus_error *error, sd_bus_message **reply, void *userdata);
  65
  66 #if 0 /// UNNEEDED by elogind
  67 int bus_async_unregister_and_exit(sd_event *e, sd_bus *bus, const char *name);
  68 #endif // 0
  69
  70 typedef bool (*check_idle_t)(void *userdata);
  71
  72 #if 0 /// UNNEEDED by elogind
  73 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);
  74 #endif // 0
  75
  76 int bus_name_has_owner(sd_bus *c, const char *name, sd_bus_error *error);
  77
  78 #if 0 /// UNNEEDED by elogind
  79 int bus_check_peercred(sd_bus *c);
  80 #endif // 0
  81
  82 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);
  83
  84 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);
  85 void bus_verify_polkit_async_registry_free(Hashmap *registry);
  86
  87 #if 0 /// UNNEEDED by elogind
  88 #endif // 0
  89 int bus_connect_system_systemd(sd_bus **_bus);
  90 int bus_connect_user_systemd(sd_bus **_bus);
  91
  92 int bus_connect_transport(BusTransport transport, const char *host, bool user, sd_bus **bus);
  93 #if 0 /// UNNEEDED by elogind
  94 #endif // 0
  95 int bus_connect_transport_systemd(BusTransport transport, const char *host, bool user, sd_bus **bus);
  96
  97 typedef int (*bus_message_print_t) (const char *name, sd_bus_message *m, bool value, bool all);
  98
  99 int bus_print_property(const char *name, sd_bus_message *property, bool value, bool all);
 100 int bus_message_print_all_properties(sd_bus_message *m, bus_message_print_t func, char **filter, bool value, bool all, Set **found_properties);
 101 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);
 102
 103 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);
 104 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);
 105 #if 0 /// UNNEEDED by elogind
 106 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);
 107 #endif // 0
 108
 109 #define bus_property_get_usec ((sd_bus_property_get_t) NULL)
 110 #define bus_property_set_usec ((sd_bus_property_set_t) NULL)
 111
 112 assert_cc(sizeof(int) == sizeof(int32_t));
 113 #define bus_property_get_int ((sd_bus_property_get_t) NULL)
 114
 115 assert_cc(sizeof(unsigned) == sizeof(uint32_t));
 116 #define bus_property_get_unsigned ((sd_bus_property_get_t) NULL)
 117
 118 /* On 64bit machines we can use the default serializer for size_t and
 119  * friends, otherwise we need to cast this manually */
 120 #if __SIZEOF_SIZE_T__ == 8
 121 #define bus_property_get_size ((sd_bus_property_get_t) NULL)
 122 #else
 123 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);
 124 #endif
 125
 126 #if __SIZEOF_LONG__ == 8
 127 #define bus_property_get_long ((sd_bus_property_get_t) NULL)
 128 #define bus_property_get_ulong ((sd_bus_property_get_t) NULL)
 129 #else
 130 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);
 131 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);
 132 #endif
 133
 134 /* uid_t and friends on Linux 32 bit. This means we can just use the
 135  * default serializer for 32bit unsigned, for serializing it, and map
 136  * it to NULL here */
 137 assert_cc(sizeof(uid_t) == sizeof(uint32_t));
 138 #define bus_property_get_uid ((sd_bus_property_get_t) NULL)
 139
 140 assert_cc(sizeof(gid_t) == sizeof(uint32_t));
 141 #define bus_property_get_gid ((sd_bus_property_get_t) NULL)
 142
 143 assert_cc(sizeof(pid_t) == sizeof(uint32_t));
 144 #define bus_property_get_pid ((sd_bus_property_get_t) NULL)
 145
 146 assert_cc(sizeof(mode_t) == sizeof(uint32_t));
 147 #define bus_property_get_mode ((sd_bus_property_get_t) NULL)
 148
 149 int bus_log_parse_error(int r);
 150 int bus_log_create_error(int r);
 151
 152 #if 0 /// UNNEEDED by elogind
 153 #endif // 0
 154 #define BUS_DEFINE_PROPERTY_GET_ENUM(function, name, type)              \
 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                 const char *value;                                      \
 164                 type *field = userdata;                                 \
 165                 int r;                                                  \
 166                                                                         \
 167                 assert(bus);                                            \
 168                 assert(reply);                                          \
 169                 assert(field);                                          \
 170                                                                         \
 171                 value = strempty(name##_to_string(*field));             \
 172                                                                         \
 173                 r = sd_bus_message_append_basic(reply, 's', value);     \
 174                 if (r < 0)                                              \
 175                         return r;                                       \
 176                                                                         \
 177                 return 1;                                               \
 178         }
 179
 180 #define BUS_PROPERTY_DUAL_TIMESTAMP(name, offset, flags) \
 181         SD_BUS_PROPERTY(name, "t", bus_property_get_usec, (offset) + offsetof(struct dual_timestamp, realtime), (flags)), \
 182         SD_BUS_PROPERTY(name "Monotonic", "t", bus_property_get_usec, (offset) + offsetof(struct dual_timestamp, monotonic), (flags))
 183
 184 #if 0 /// UNNEEDED by elogind
 185 int bus_path_encode_unique(sd_bus *b, const char *prefix, const char *sender_id, const char *external_id, char **ret_path);
 186 int bus_path_decode_unique(const char *path, const char *prefix, char **ret_sender, char **ret_external);
 187 #endif // 0
 188
 189 #if 0 /// UNNEEDED by elogind
 190 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);
 191
 192 int bus_track_add_name_many(sd_bus_track *t, char **l);
 193 #endif // 0
 194
 195 int bus_open_system_watch_bind(sd_bus **ret);