src/libsystemd-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 #include "util.h"
  29
  30 typedef enum BusTransport {
  31         BUS_TRANSPORT_LOCAL,
  32         BUS_TRANSPORT_REMOTE,
  33         BUS_TRANSPORT_CONTAINER,
  34         _BUS_TRANSPORT_MAX,
  35         _BUS_TRANSPORT_INVALID = -1
  36 } BusTransport;
  37
  38 typedef int (*bus_property_set_t) (sd_bus *bus, const char *member, sd_bus_message *m, sd_bus_error *error, void *userdata);
  39
  40 struct bus_properties_map {
  41         const char *member;
  42         const char *signature;
  43         bus_property_set_t set;
  44         size_t offset;
  45 };
  46
  47 int bus_map_id128(sd_bus *bus, const char *member, sd_bus_message *m, sd_bus_error *error, void *userdata);
  48
  49 int bus_map_all_properties(sd_bus *bus,
  50                            const char *destination,
  51                            const char *path,
  52                            const struct bus_properties_map *map,
  53                            void *userdata);
  54
  55 int bus_async_unregister_and_quit(sd_event *e, sd_bus *bus, const char *name);
  56
  57 int bus_event_loop_with_idle(sd_event *e, sd_bus *bus, const char *name, usec_t timeout);
  58
  59 int bus_check_peercred(sd_bus *c);
  60
  61 int bus_verify_polkit(sd_bus *bus, sd_bus_message *m, const char *action, bool interactive, bool *_challenge, sd_bus_error *e);
  62
  63 int bus_verify_polkit_async(sd_bus *bus, Hashmap **registry, sd_bus_message *m, const char *action, bool interactive, sd_bus_error *error, sd_bus_message_handler_t callback, void *userdata);
  64 void bus_verify_polkit_async_registry_free(sd_bus *bus, Hashmap *registry);
  65
  66 int bus_open_system_systemd(sd_bus **_bus);
  67 int bus_open_user_systemd(sd_bus **_bus);
  68
  69 int bus_open_transport(BusTransport transport, const char *host, bool user, sd_bus **bus);
  70 int bus_open_transport_systemd(BusTransport transport, const char *host, bool user, sd_bus **bus);
  71
  72 int bus_print_property(const char *name, sd_bus_message *property, bool all);
  73 int bus_print_all_properties(sd_bus *bus, const char *dest, const char *path, char **filter, bool all);
  74
  75 int bus_property_get_tristate(sd_bus *bus, const char *path, const char *interface, const char *property, sd_bus_message *reply, void *userdata, sd_bus_error *error);
  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 *id;
 123         const char *description;
 124         const char *load_state;
 125         const char *active_state;
 126         const char *sub_state;
 127         const char *following;
 128         const char *unit_path;
 129         uint32_t job_id;
 130         const char *job_type;
 131         const char *job_path;
 132 } UnitInfo;
 133
 134 int bus_parse_unit_info(sd_bus_message *message, UnitInfo *u);
 135
 136 DEFINE_TRIVIAL_CLEANUP_FUNC(sd_bus*, sd_bus_unref);
 137 DEFINE_TRIVIAL_CLEANUP_FUNC(sd_bus_message*, sd_bus_message_unref);
 138
 139 #define _cleanup_bus_unref_ _cleanup_(sd_bus_unrefp)
 140 #define _cleanup_bus_message_unref_ _cleanup_(sd_bus_message_unrefp)
 141 #define _cleanup_bus_error_free_ _cleanup_(sd_bus_error_free)
 142
 143 #define BUS_DEFINE_PROPERTY_GET_ENUM(function, name, type)              \
 144         int function(sd_bus *bus,                                       \
 145                      const char *path,                                  \
 146                      const char *interface,                             \
 147                      const char *property,                              \
 148                      sd_bus_message *reply,                             \
 149                      void *userdata,                                    \
 150                      sd_bus_error *error) {                             \
 151                                                                         \
 152                 const char *value;                                      \
 153                 type *field = userdata;                                 \
 154                 int r;                                                  \
 155                                                                         \
 156                 assert(bus);                                            \
 157                 assert(reply);                                          \
 158                 assert(field);                                          \
 159                                                                         \
 160                 value = strempty(name##_to_string(*field));             \
 161                                                                         \
 162                 r = sd_bus_message_append_basic(reply, 's', value);     \
 163                 if (r < 0)                                              \
 164                         return r;                                       \
 165                                                                         \
 166                 return 1;                                               \
 167         }                                                               \
 168         struct __useless_struct_to_allow_trailing_semicolon__
 169
 170 #define BUS_PROPERTY_DUAL_TIMESTAMP(name, offset, flags) \
 171         SD_BUS_PROPERTY(name, "t", bus_property_get_usec, (offset) + offsetof(struct dual_timestamp, realtime), (flags)), \
 172         SD_BUS_PROPERTY(name "Monotonic", "t", bus_property_get_usec, (offset) + offsetof(struct dual_timestamp, monotonic), (flags))
 173
 174 int bus_maybe_reply_error(sd_bus_message *m, int r, sd_bus_error *error);