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