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