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 "sd-bus.h"
  23 #include "sd-event.h"
  24
  25 #include "hashmap.h"
  26 //#include "install.h"
  27 #include "string-util.h"
  28 #include "time-util.h"
  29
  30 typedef enum BusTransport {
  31         BUS_TRANSPORT_LOCAL,
  32         BUS_TRANSPORT_REMOTE,
  33         BUS_TRANSPORT_MACHINE,
  34         _BUS_TRANSPORT_MAX,
  35         _BUS_TRANSPORT_INVALID = -1
  36 } BusTransport;
  37
  38 typedef int (*bus_property_set_t) (sd_bus *bus, const char *member, sd_bus_message *m, sd_bus_error *error, void *userdata);
  39
  40 struct bus_properties_map {
  41         const char *member;
  42         const char *signature;
  43         bus_property_set_t set;
  44         size_t offset;
  45 };
  46
  47 int bus_map_id128(sd_bus *bus, const char *member, sd_bus_message *m, sd_bus_error *error, void *userdata);
  48
  49 int bus_message_map_all_properties(sd_bus_message *m, const struct bus_properties_map *map,  void *userdata);
  50 #if 0 /// UNNEEDED by elogind
  51 int bus_message_map_properties_changed(sd_bus_message *m, const struct bus_properties_map *map, void *userdata);
  52 #endif // 0
  53 int bus_map_all_properties(sd_bus *bus, const char *destination, const char *path, const struct bus_properties_map *map, void *userdata);
  54
  55 #if 0 /// UNNEEDED by elogind
  56 int bus_async_unregister_and_exit(sd_event *e, sd_bus *bus, const char *name);
  57 #endif // 0
  58
  59 typedef bool (*check_idle_t)(void *userdata);
  60
  61 #if 0 /// UNNEEDED by elogind
  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 #endif // 0
  64
  65 int bus_name_has_owner(sd_bus *c, const char *name, sd_bus_error *error);
  66
  67 #if 0 /// UNNEEDED by elogind
  68 int bus_check_peercred(sd_bus *c);
  69 #endif // 0
  70
  71 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);
  72
  73 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);
  74 void bus_verify_polkit_async_registry_free(Hashmap *registry);
  75
  76 #if 0 /// UNNEEDED by elogind
  77 int bus_open_system_systemd(sd_bus **_bus);
  78 int bus_open_user_systemd(sd_bus **_bus);
  79 #endif // 0
  80
  81 int bus_connect_transport(BusTransport transport, const char *host, bool user, sd_bus **bus);
  82 #if 0 /// UNNEEDED by elogind
  83 bus_connect_transport_systemd(BusTransport transport, const char *host, bool user, sd_bus **bus);
  84 #endif // 0
  85
  86 int bus_print_property(const char *name, sd_bus_message *property, bool all);
  87 int bus_print_all_properties(sd_bus *bus, const char *dest, const char *path, char **filter, bool all);
  88
  89 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);
  90
  91 #define bus_property_get_usec ((sd_bus_property_get_t) NULL)
  92 #define bus_property_set_usec ((sd_bus_property_set_t) NULL)
  93
  94 assert_cc(sizeof(int) == sizeof(int32_t));
  95 #define bus_property_get_int ((sd_bus_property_get_t) NULL)
  96
  97 assert_cc(sizeof(unsigned) == sizeof(unsigned));
  98 #define bus_property_get_unsigned ((sd_bus_property_get_t) NULL)
  99
 100 /* On 64bit machines we can use the default serializer for size_t and
 101  * friends, otherwise we need to cast this manually */
 102 #if __SIZEOF_SIZE_T__ == 8
 103 #define bus_property_get_size ((sd_bus_property_get_t) NULL)
 104 #else
 105 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);
 106 #endif
 107
 108 #if __SIZEOF_LONG__ == 8
 109 #define bus_property_get_long ((sd_bus_property_get_t) NULL)
 110 #define bus_property_get_ulong ((sd_bus_property_get_t) NULL)
 111 #else
 112 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);
 113 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);
 114 #endif
 115
 116 /* uid_t and friends on Linux 32 bit. This means we can just use the
 117  * default serializer for 32bit unsigned, for serializing it, and map
 118  * it to NULL here */
 119 assert_cc(sizeof(uid_t) == sizeof(uint32_t));
 120 #define bus_property_get_uid ((sd_bus_property_get_t) NULL)
 121
 122 assert_cc(sizeof(gid_t) == sizeof(uint32_t));
 123 #define bus_property_get_gid ((sd_bus_property_get_t) NULL)
 124
 125 assert_cc(sizeof(pid_t) == sizeof(uint32_t));
 126 #define bus_property_get_pid ((sd_bus_property_get_t) NULL)
 127
 128 assert_cc(sizeof(mode_t) == sizeof(uint32_t));
 129 #define bus_property_get_mode ((sd_bus_property_get_t) NULL)
 130
 131 int bus_log_parse_error(int r);
 132 int bus_log_create_error(int r);
 133
 134 #if 0 /// UNNEEDED by elogind
 135 typedef struct UnitInfo {
 136         const char *machine;
 137         const char *id;
 138         const char *description;
 139         const char *load_state;
 140         const char *active_state;
 141         const char *sub_state;
 142         const char *following;
 143         const char *unit_path;
 144         uint32_t job_id;
 145         const char *job_type;
 146         const char *job_path;
 147 } UnitInfo;
 148
 149 int bus_parse_unit_info(sd_bus_message *message, UnitInfo *u);
 150 #endif // 0
 151
 152 DEFINE_TRIVIAL_CLEANUP_FUNC(sd_bus*, sd_bus_unref);
 153 DEFINE_TRIVIAL_CLEANUP_FUNC(sd_bus*, sd_bus_flush_close_unref);
 154 DEFINE_TRIVIAL_CLEANUP_FUNC(sd_bus_slot*, sd_bus_slot_unref);
 155 DEFINE_TRIVIAL_CLEANUP_FUNC(sd_bus_message*, sd_bus_message_unref);
 156 DEFINE_TRIVIAL_CLEANUP_FUNC(sd_bus_creds*, sd_bus_creds_unref);
 157 DEFINE_TRIVIAL_CLEANUP_FUNC(sd_bus_track*, sd_bus_track_unref);
 158
 159 #define _cleanup_bus_unref_ _cleanup_(sd_bus_unrefp)
 160 #define _cleanup_bus_flush_close_unref_ _cleanup_(sd_bus_flush_close_unrefp)
 161 #define _cleanup_bus_slot_unref_ _cleanup_(sd_bus_slot_unrefp)
 162 #define _cleanup_bus_message_unref_ _cleanup_(sd_bus_message_unrefp)
 163 #define _cleanup_bus_creds_unref_ _cleanup_(sd_bus_creds_unrefp)
 164 #define _cleanup_bus_track_unref_ _cleanup_(sd_bus_slot_unrefp)
 165 #define _cleanup_bus_error_free_ _cleanup_(sd_bus_error_free)
 166
 167 #define BUS_DEFINE_PROPERTY_GET_ENUM(function, name, type)              \
 168         int function(sd_bus *bus,                                       \
 169                      const char *path,                                  \
 170                      const char *interface,                             \
 171                      const char *property,                              \
 172                      sd_bus_message *reply,                             \
 173                      void *userdata,                                    \
 174                      sd_bus_error *error) {                             \
 175                                                                         \
 176                 const char *value;                                      \
 177                 type *field = userdata;                                 \
 178                 int r;                                                  \
 179                                                                         \
 180                 assert(bus);                                            \
 181                 assert(reply);                                          \
 182                 assert(field);                                          \
 183                                                                         \
 184                 value = strempty(name##_to_string(*field));             \
 185                                                                         \
 186                 r = sd_bus_message_append_basic(reply, 's', value);     \
 187                 if (r < 0)                                              \
 188                         return r;                                       \
 189                                                                         \
 190                 return 1;                                               \
 191         }                                                               \
 192         struct __useless_struct_to_allow_trailing_semicolon__
 193
 194 #define BUS_PROPERTY_DUAL_TIMESTAMP(name, offset, flags) \
 195         SD_BUS_PROPERTY(name, "t", bus_property_get_usec, (offset) + offsetof(struct dual_timestamp, realtime), (flags)), \
 196         SD_BUS_PROPERTY(name "Monotonic", "t", bus_property_get_usec, (offset) + offsetof(struct dual_timestamp, monotonic), (flags))
 197
 198 #if 0 /// UNNEEDED by elogind
 199 int bus_append_unit_property_assignment(sd_bus_message *m, const char *assignment);
 200
 201 typedef struct BusWaitForJobs BusWaitForJobs;
 202
 203 int bus_wait_for_jobs_new(sd_bus *bus, BusWaitForJobs **ret);
 204 void bus_wait_for_jobs_free(BusWaitForJobs *d);
 205 int bus_wait_for_jobs_add(BusWaitForJobs *d, const char *path);
 206 int bus_wait_for_jobs(BusWaitForJobs *d, bool quiet, const char *extra_args);
 207 int bus_wait_for_jobs_one(BusWaitForJobs *d, const char *path, bool quiet);
 208
 209 DEFINE_TRIVIAL_CLEANUP_FUNC(BusWaitForJobs*, bus_wait_for_jobs_free);
 210
 211 int bus_deserialize_and_dump_unit_file_changes(sd_bus_message *m, bool quiet, UnitFileChange **changes, unsigned *n_changes);
 212
 213 int bus_path_encode_unique(sd_bus *b, const char *prefix, const char *sender_id, const char *external_id, char **ret_path);
 214 int bus_path_decode_unique(const char *path, const char *prefix, char **ret_sender, char **ret_external);
 215 #endif // 0
 216
 217 bool is_kdbus_wanted(void);
 218 bool is_kdbus_available(void);
 219
 220 #if 0 /// UNNEEDED by elogind
 221 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);
 222 #endif // 0