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, sd_bus_error *error, void *userdata);
  55 int bus_message_map_properties_changed(sd_bus_message *m, const struct bus_properties_map *map, 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, 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 int bus_print_property(const char *name, sd_bus_message *property, bool value, bool all);
  80 int bus_print_all_properties(sd_bus *bus, const char *dest, const char *path, char **filter, bool value, bool all);
  81
  82 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);
  83 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);
  84 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);
  85
  86 #define bus_property_get_usec ((sd_bus_property_get_t) NULL)
  87 #define bus_property_set_usec ((sd_bus_property_set_t) NULL)
  88
  89 assert_cc(sizeof(int) == sizeof(int32_t));
  90 #define bus_property_get_int ((sd_bus_property_get_t) NULL)
  91
  92 assert_cc(sizeof(unsigned) == sizeof(unsigned));
  93 #define bus_property_get_unsigned ((sd_bus_property_get_t) NULL)
  94
  95 /* On 64bit machines we can use the default serializer for size_t and
  96  * friends, otherwise we need to cast this manually */
  97 #if __SIZEOF_SIZE_T__ == 8
  98 #define bus_property_get_size ((sd_bus_property_get_t) NULL)
  99 #else
 100 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);
 101 #endif
 102
 103 #if __SIZEOF_LONG__ == 8
 104 #define bus_property_get_long ((sd_bus_property_get_t) NULL)
 105 #define bus_property_get_ulong ((sd_bus_property_get_t) NULL)
 106 #else
 107 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);
 108 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);
 109 #endif
 110
 111 /* uid_t and friends on Linux 32 bit. This means we can just use the
 112  * default serializer for 32bit unsigned, for serializing it, and map
 113  * it to NULL here */
 114 assert_cc(sizeof(uid_t) == sizeof(uint32_t));
 115 #define bus_property_get_uid ((sd_bus_property_get_t) NULL)
 116
 117 assert_cc(sizeof(gid_t) == sizeof(uint32_t));
 118 #define bus_property_get_gid ((sd_bus_property_get_t) NULL)
 119
 120 assert_cc(sizeof(pid_t) == sizeof(uint32_t));
 121 #define bus_property_get_pid ((sd_bus_property_get_t) NULL)
 122
 123 assert_cc(sizeof(mode_t) == sizeof(uint32_t));
 124 #define bus_property_get_mode ((sd_bus_property_get_t) NULL)
 125
 126 int bus_log_parse_error(int r);
 127 int bus_log_create_error(int r);
 128
 129 #define BUS_DEFINE_PROPERTY_GET_ENUM(function, name, type)              \
 130         int function(sd_bus *bus,                                       \
 131                      const char *path,                                  \
 132                      const char *interface,                             \
 133                      const char *property,                              \
 134                      sd_bus_message *reply,                             \
 135                      void *userdata,                                    \
 136                      sd_bus_error *error) {                             \
 137                                                                         \
 138                 const char *value;                                      \
 139                 type *field = userdata;                                 \
 140                 int r;                                                  \
 141                                                                         \
 142                 assert(bus);                                            \
 143                 assert(reply);                                          \
 144                 assert(field);                                          \
 145                                                                         \
 146                 value = strempty(name##_to_string(*field));             \
 147                                                                         \
 148                 r = sd_bus_message_append_basic(reply, 's', value);     \
 149                 if (r < 0)                                              \
 150                         return r;                                       \
 151                                                                         \
 152                 return 1;                                               \
 153         }                                                               \
 154         struct __useless_struct_to_allow_trailing_semicolon__
 155
 156 #define BUS_PROPERTY_DUAL_TIMESTAMP(name, offset, flags) \
 157         SD_BUS_PROPERTY(name, "t", bus_property_get_usec, (offset) + offsetof(struct dual_timestamp, realtime), (flags)), \
 158         SD_BUS_PROPERTY(name "Monotonic", "t", bus_property_get_usec, (offset) + offsetof(struct dual_timestamp, monotonic), (flags))
 159
 160 int bus_path_encode_unique(sd_bus *b, const char *prefix, const char *sender_id, const char *external_id, char **ret_path);
 161 int bus_path_decode_unique(const char *path, const char *prefix, char **ret_sender, char **ret_external);
 162
 163 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);
 164
 165 int bus_track_add_name_many(sd_bus_track *t, char **l);
 166
 167 int bus_open_system_watch_bind(sd_bus **ret);