src/libelogind/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_message *m, const struct bus_properties_map *map,  void *userdata);
  49 int bus_message_map_properties_changed(sd_bus_message *m, const struct bus_properties_map *map, void *userdata);
  50 int bus_map_all_properties(sd_bus *bus, const char *destination, const char *path, const struct bus_properties_map *map, void *userdata);
  51
  52 int bus_async_unregister_and_exit(sd_event *e, sd_bus *bus, const char *name);
  53
  54 typedef bool (*check_idle_t)(void *userdata);
  55
  56 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);
  57
  58 int bus_name_has_owner(sd_bus *c, const char *name, sd_bus_error *error);
  59
  60 int bus_check_peercred(sd_bus *c);
  61
  62 int bus_test_polkit(sd_bus_message *call, int capability, const char *action, uid_t good_user, bool *_challenge, sd_bus_error *e);
  63
  64 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);
  65 void bus_verify_polkit_async_registry_free(Hashmap *registry);
  66
  67 int bus_open_system_systemd(sd_bus **_bus);
  68 int bus_open_user_systemd(sd_bus **_bus);
  69
  70 int bus_open_transport(BusTransport transport, const char *host, bool user, sd_bus **bus);
  71 int bus_open_transport_systemd(BusTransport transport, const char *host, bool user, sd_bus **bus);
  72
  73 int bus_print_property(const char *name, sd_bus_message *property, bool all);
  74 int bus_print_all_properties(sd_bus *bus, const char *dest, const char *path, char **filter, bool all);
  75
  76 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);
  77
  78 #define bus_property_get_usec ((sd_bus_property_get_t) NULL)
  79 #define bus_property_set_usec ((sd_bus_property_set_t) NULL)
  80
  81 assert_cc(sizeof(int) == sizeof(int32_t));
  82 #define bus_property_get_int ((sd_bus_property_get_t) NULL)
  83
  84 assert_cc(sizeof(unsigned) == sizeof(unsigned));
  85 #define bus_property_get_unsigned ((sd_bus_property_get_t) NULL)
  86
  87 /* On 64bit machines we can use the default serializer for size_t and
  88  * friends, otherwise we need to cast this manually */
  89 #if __SIZEOF_SIZE_T__ == 8
  90 #define bus_property_get_size ((sd_bus_property_get_t) NULL)
  91 #else
  92 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);
  93 #endif
  94
  95 #if __SIZEOF_LONG__ == 8
  96 #define bus_property_get_long ((sd_bus_property_get_t) NULL)
  97 #define bus_property_get_ulong ((sd_bus_property_get_t) NULL)
  98 #else
  99 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);
 100 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);
 101 #endif
 102
 103 /* uid_t and friends on Linux 32 bit. This means we can just use the
 104  * default serializer for 32bit unsigned, for serializing it, and map
 105  * it to NULL here */
 106 assert_cc(sizeof(uid_t) == sizeof(uint32_t));
 107 #define bus_property_get_uid ((sd_bus_property_get_t) NULL)
 108
 109 assert_cc(sizeof(gid_t) == sizeof(uint32_t));
 110 #define bus_property_get_gid ((sd_bus_property_get_t) NULL)
 111
 112 assert_cc(sizeof(pid_t) == sizeof(uint32_t));
 113 #define bus_property_get_pid ((sd_bus_property_get_t) NULL)
 114
 115 assert_cc(sizeof(mode_t) == sizeof(uint32_t));
 116 #define bus_property_get_mode ((sd_bus_property_get_t) NULL)
 117
 118 int bus_log_parse_error(int r);
 119 int bus_log_create_error(int r);
 120
 121 typedef struct UnitInfo {
 122         const char *machine;
 123         const char *id;
 124         const char *description;
 125         const char *load_state;
 126         const char *active_state;
 127         const char *sub_state;
 128         const char *following;
 129         const char *unit_path;
 130         uint32_t job_id;
 131         const char *job_type;
 132         const char *job_path;
 133 } UnitInfo;
 134
 135 int bus_parse_unit_info(sd_bus_message *message, UnitInfo *u);
 136
 137 static inline void sd_bus_close_unrefp(sd_bus **bus) {
 138         if (*bus) {
 139                 sd_bus_flush(*bus);
 140                 sd_bus_close(*bus);
 141                 sd_bus_unref(*bus);
 142         }
 143 }
 144
 145 DEFINE_TRIVIAL_CLEANUP_FUNC(sd_bus*, sd_bus_unref);
 146 DEFINE_TRIVIAL_CLEANUP_FUNC(sd_bus_slot*, sd_bus_slot_unref);
 147 DEFINE_TRIVIAL_CLEANUP_FUNC(sd_bus_message*, sd_bus_message_unref);
 148 DEFINE_TRIVIAL_CLEANUP_FUNC(sd_bus_creds*, sd_bus_creds_unref);
 149 DEFINE_TRIVIAL_CLEANUP_FUNC(sd_bus_track*, sd_bus_track_unref);
 150
 151 #define _cleanup_bus_unref_ _cleanup_(sd_bus_unrefp)
 152 #define _cleanup_bus_close_unref_ _cleanup_(sd_bus_close_unrefp)
 153 #define _cleanup_bus_slot_unref_ _cleanup_(sd_bus_slot_unrefp)
 154 #define _cleanup_bus_message_unref_ _cleanup_(sd_bus_message_unrefp)
 155 #define _cleanup_bus_creds_unref_ _cleanup_(sd_bus_creds_unrefp)
 156 #define _cleanup_bus_track_unref_ _cleanup_(sd_bus_slot_unrefp)
 157 #define _cleanup_bus_error_free_ _cleanup_(sd_bus_error_free)
 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 int bus_maybe_reply_error(sd_bus_message *m, int r, sd_bus_error *error);
 191
 192 int bus_append_unit_property_assignment(sd_bus_message *m, const char *assignment);
 193
 194 typedef struct BusWaitForJobs BusWaitForJobs;
 195
 196 int bus_wait_for_jobs_new(sd_bus *bus, BusWaitForJobs **ret);
 197 void bus_wait_for_jobs_free(BusWaitForJobs *d);
 198 int bus_wait_for_jobs_add(BusWaitForJobs *d, const char *path);
 199 int bus_wait_for_jobs(BusWaitForJobs *d, 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);
 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);