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.h"
  28 #include "sd-event.h"
  29
  30 #include "hashmap.h"
  31 #include "macro.h"
  32 #include "string-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 #if 0 /// UNNEEDED by elogind
  55 int bus_message_map_properties_changed(sd_bus_message *m, const struct bus_properties_map *map, void *userdata);
  56 #endif // 0
  57 int bus_map_all_properties(sd_bus *bus, const char *destination, const char *path, const struct bus_properties_map *map, void *userdata);
  58
  59 #if 0 /// UNNEEDED by elogind
  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 #if 0 /// UNNEEDED by elogind
  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 #endif // 0
  68
  69 int bus_name_has_owner(sd_bus *c, const char *name, sd_bus_error *error);
  70
  71 #if 0 /// UNNEEDED by elogind
  72 int bus_check_peercred(sd_bus *c);
  73 #endif // 0
  74
  75 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);
  76
  77 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);
  78 void bus_verify_polkit_async_registry_free(Hashmap *registry);
  79
  80 #if 0 /// UNNEEDED by elogind
  81 #endif // 0
  82 int bus_connect_system_systemd(sd_bus **_bus);
  83 int bus_connect_user_systemd(sd_bus **_bus);
  84
  85 int bus_connect_transport(BusTransport transport, const char *host, bool user, sd_bus **bus);
  86 #if 0 /// UNNEEDED by elogind
  87 #endif // 0
  88 int bus_connect_transport_systemd(BusTransport transport, const char *host, bool user, sd_bus **bus);
  89
  90 int bus_print_property(const char *name, sd_bus_message *property, bool value, bool all);
  91 int bus_print_all_properties(sd_bus *bus, const char *dest, const char *path, char **filter, bool value, bool all);
  92
  93 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);
  94
  95 #define bus_property_get_usec ((sd_bus_property_get_t) NULL)
  96 #define bus_property_set_usec ((sd_bus_property_set_t) NULL)
  97
  98 assert_cc(sizeof(int) == sizeof(int32_t));
  99 #define bus_property_get_int ((sd_bus_property_get_t) NULL)
 100
 101 assert_cc(sizeof(unsigned) == sizeof(unsigned));
 102 #define bus_property_get_unsigned ((sd_bus_property_get_t) NULL)
 103
 104 /* On 64bit machines we can use the default serializer for size_t and
 105  * friends, otherwise we need to cast this manually */
 106 #if __SIZEOF_SIZE_T__ == 8
 107 #define bus_property_get_size ((sd_bus_property_get_t) NULL)
 108 #else
 109 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);
 110 #endif
 111
 112 #if __SIZEOF_LONG__ == 8
 113 #define bus_property_get_long ((sd_bus_property_get_t) NULL)
 114 #define bus_property_get_ulong ((sd_bus_property_get_t) NULL)
 115 #else
 116 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);
 117 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);
 118 #endif
 119
 120 /* uid_t and friends on Linux 32 bit. This means we can just use the
 121  * default serializer for 32bit unsigned, for serializing it, and map
 122  * it to NULL here */
 123 assert_cc(sizeof(uid_t) == sizeof(uint32_t));
 124 #define bus_property_get_uid ((sd_bus_property_get_t) NULL)
 125
 126 assert_cc(sizeof(gid_t) == sizeof(uint32_t));
 127 #define bus_property_get_gid ((sd_bus_property_get_t) NULL)
 128
 129 assert_cc(sizeof(pid_t) == sizeof(uint32_t));
 130 #define bus_property_get_pid ((sd_bus_property_get_t) NULL)
 131
 132 assert_cc(sizeof(mode_t) == sizeof(uint32_t));
 133 #define bus_property_get_mode ((sd_bus_property_get_t) NULL)
 134
 135 int bus_log_parse_error(int r);
 136 int bus_log_create_error(int r);
 137
 138 #if 0 /// UNNEEDED by elogind
 139 #endif // 0
 140 #define BUS_DEFINE_PROPERTY_GET_ENUM(function, name, type)              \
 141         int function(sd_bus *bus,                                       \
 142                      const char *path,                                  \
 143                      const char *interface,                             \
 144                      const char *property,                              \
 145                      sd_bus_message *reply,                             \
 146                      void *userdata,                                    \
 147                      sd_bus_error *error) {                             \
 148                                                                         \
 149                 const char *value;                                      \
 150                 type *field = userdata;                                 \
 151                 int r;                                                  \
 152                                                                         \
 153                 assert(bus);                                            \
 154                 assert(reply);                                          \
 155                 assert(field);                                          \
 156                                                                         \
 157                 value = strempty(name##_to_string(*field));             \
 158                                                                         \
 159                 r = sd_bus_message_append_basic(reply, 's', value);     \
 160                 if (r < 0)                                              \
 161                         return r;                                       \
 162                                                                         \
 163                 return 1;                                               \
 164         }                                                               \
 165         struct __useless_struct_to_allow_trailing_semicolon__
 166
 167 #define BUS_PROPERTY_DUAL_TIMESTAMP(name, offset, flags) \
 168         SD_BUS_PROPERTY(name, "t", bus_property_get_usec, (offset) + offsetof(struct dual_timestamp, realtime), (flags)), \
 169         SD_BUS_PROPERTY(name "Monotonic", "t", bus_property_get_usec, (offset) + offsetof(struct dual_timestamp, monotonic), (flags))
 170
 171 #if 0 /// UNNEEDED by elogind
 172 int bus_path_encode_unique(sd_bus *b, const char *prefix, const char *sender_id, const char *external_id, char **ret_path);
 173 int bus_path_decode_unique(const char *path, const char *prefix, char **ret_sender, char **ret_external);
 174 #endif // 0
 175
 176 #if 0 /// UNNEEDED by elogind
 177 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);
 178 #endif // 0