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 int bus_message_map_all_properties(sd_bus_message *m, const struct bus_properties_map *map, unsigned flags, sd_bus_error *error, void *userdata);
  60 int bus_message_map_properties_changed(sd_bus_message *m, const struct bus_properties_map *map, unsigned flags, sd_bus_error *error, void *userdata);
  61 int bus_map_all_properties(sd_bus *bus, const char *destination, const char *path, const struct bus_properties_map *map,
  62                            unsigned flags, sd_bus_error *error, sd_bus_message **reply, void *userdata);
  63
  64 int bus_async_unregister_and_exit(sd_event *e, sd_bus *bus, const char *name);
  65
  66 typedef bool (*check_idle_t)(void *userdata);
  67
  68 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);
  69
  70 int bus_name_has_owner(sd_bus *c, const char *name, sd_bus_error *error);
  71
  72 int bus_check_peercred(sd_bus *c);
  73
  74 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);
  75
  76 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);
  77 void bus_verify_polkit_async_registry_free(Hashmap *registry);
  78
  79 int bus_connect_system_systemd(sd_bus **_bus);
  80 int bus_connect_user_systemd(sd_bus **_bus);
  81
  82 int bus_connect_transport(BusTransport transport, const char *host, bool user, sd_bus **bus);
  83 int bus_connect_transport_systemd(BusTransport transport, const char *host, bool user, sd_bus **bus);
  84
  85 typedef int (*bus_message_print_t) (const char *name, sd_bus_message *m, bool value, bool all);
  86
  87 int bus_print_property(const char *name, sd_bus_message *property, bool value, bool all);
  88 int bus_message_print_all_properties(sd_bus_message *m, bus_message_print_t func, char **filter, bool value, bool all, Set **found_properties);
  89 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);
  90
  91 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);
  92 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);
  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
  95 #define bus_property_get_usec ((sd_bus_property_get_t) NULL)
  96 #define bus_property_set_usec ((sd_bus_property_set_t) NULL)
  97
  98 assert_cc(sizeof(int) == sizeof(int32_t));
  99 #define bus_property_get_int ((sd_bus_property_get_t) NULL)
 100
 101 assert_cc(sizeof(unsigned) == sizeof(uint32_t));
 102 #define bus_property_get_unsigned ((sd_bus_property_get_t) NULL)
 103
 104 /* On 64bit machines we can use the default serializer for size_t and
 105  * friends, otherwise we need to cast this manually */
 106 #if __SIZEOF_SIZE_T__ == 8
 107 #define bus_property_get_size ((sd_bus_property_get_t) NULL)
 108 #else
 109 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);
 110 #endif
 111
 112 #if __SIZEOF_LONG__ == 8
 113 #define bus_property_get_long ((sd_bus_property_get_t) NULL)
 114 #define bus_property_get_ulong ((sd_bus_property_get_t) NULL)
 115 #else
 116 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);
 117 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);
 118 #endif
 119
 120 /* uid_t and friends on Linux 32 bit. This means we can just use the
 121  * default serializer for 32bit unsigned, for serializing it, and map
 122  * it to NULL here */
 123 assert_cc(sizeof(uid_t) == sizeof(uint32_t));
 124 #define bus_property_get_uid ((sd_bus_property_get_t) NULL)
 125
 126 assert_cc(sizeof(gid_t) == sizeof(uint32_t));
 127 #define bus_property_get_gid ((sd_bus_property_get_t) NULL)
 128
 129 assert_cc(sizeof(pid_t) == sizeof(uint32_t));
 130 #define bus_property_get_pid ((sd_bus_property_get_t) NULL)
 131
 132 assert_cc(sizeof(mode_t) == sizeof(uint32_t));
 133 #define bus_property_get_mode ((sd_bus_property_get_t) NULL)
 134
 135 int bus_log_parse_error(int r);
 136 int bus_log_create_error(int r);
 137
 138 #define BUS_DEFINE_PROPERTY_GET_ENUM(function, name, type)              \
 139         int function(sd_bus *bus,                                       \
 140                      const char *path,                                  \
 141                      const char *interface,                             \
 142                      const char *property,                              \
 143                      sd_bus_message *reply,                             \
 144                      void *userdata,                                    \
 145                      sd_bus_error *error) {                             \
 146                                                                         \
 147                 const char *value;                                      \
 148                 type *field = userdata;                                 \
 149                 int r;                                                  \
 150                                                                         \
 151                 assert(bus);                                            \
 152                 assert(reply);                                          \
 153                 assert(field);                                          \
 154                                                                         \
 155                 value = strempty(name##_to_string(*field));             \
 156                                                                         \
 157                 r = sd_bus_message_append_basic(reply, 's', value);     \
 158                 if (r < 0)                                              \
 159                         return r;                                       \
 160                                                                         \
 161                 return 1;                                               \
 162         }
 163
 164 #define BUS_PROPERTY_DUAL_TIMESTAMP(name, offset, flags) \
 165         SD_BUS_PROPERTY(name, "t", bus_property_get_usec, (offset) + offsetof(struct dual_timestamp, realtime), (flags)), \
 166         SD_BUS_PROPERTY(name "Monotonic", "t", bus_property_get_usec, (offset) + offsetof(struct dual_timestamp, monotonic), (flags))
 167
 168 int bus_path_encode_unique(sd_bus *b, const char *prefix, const char *sender_id, const char *external_id, char **ret_path);
 169 int bus_path_decode_unique(const char *path, const char *prefix, char **ret_sender, char **ret_external);
 170
 171 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);
 172
 173 int bus_track_add_name_many(sd_bus_track *t, char **l);
 174
 175 int bus_open_system_watch_bind(sd_bus **ret);