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