src/shared/bus-util.h

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