src/shared/bus-util.h

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