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