src/shared/dbus-common.h

   1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
   2
   3 #ifndef foodbuscommonhfoo
   4 #define foodbuscommonhfoo
   5
   6 /***
   7   This file is part of systemd.
   8
   9   Copyright 2010 Lennart Poettering
  10
  11   systemd is free software; you can redistribute it and/or modify it
  12   under the terms of the GNU Lesser General Public License as published by
  13   the Free Software Foundation; either version 2.1 of the License, or
  14   (at your option) any later version.
  15
  16   systemd is distributed in the hope that it will be useful, but
  17   WITHOUT ANY WARRANTY; without even the implied warranty of
  18   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  19   Lesser General Public License for more details.
  20
  21   You should have received a copy of the GNU Lesser General Public License
  22   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  23 ***/
  24
  25 #include <dbus/dbus.h>
  26
  27 #ifndef DBUS_ERROR_UNKNOWN_OBJECT
  28 #define DBUS_ERROR_UNKNOWN_OBJECT "org.freedesktop.DBus.Error.UnknownObject"
  29 #endif
  30
  31 #ifndef DBUS_ERROR_UNKNOWN_INTERFACE
  32 #define DBUS_ERROR_UNKNOWN_INTERFACE "org.freedesktop.DBus.Error.UnknownInterface"
  33 #endif
  34
  35 #ifndef DBUS_ERROR_UNKNOWN_PROPERTY
  36 #define DBUS_ERROR_UNKNOWN_PROPERTY "org.freedesktop.DBus.Error.UnknownProperty"
  37 #endif
  38
  39 #ifndef DBUS_ERROR_PROPERTY_READ_ONLY
  40 #define DBUS_ERROR_PROPERTY_READ_ONLY "org.freedesktop.DBus.Error.PropertyReadOnly"
  41 #endif
  42
  43 #define BUS_PROPERTIES_INTERFACE                                        \
  44         " <interface name=\"org.freedesktop.DBus.Properties\">\n"       \
  45         "  <method name=\"Get\">\n"                                     \
  46         "   <arg name=\"interface\" direction=\"in\" type=\"s\"/>\n"    \
  47         "   <arg name=\"property\" direction=\"in\" type=\"s\"/>\n"     \
  48         "   <arg name=\"value\" direction=\"out\" type=\"v\"/>\n"       \
  49         "  </method>\n"                                                 \
  50         "  <method name=\"GetAll\">\n"                                  \
  51         "   <arg name=\"interface\" direction=\"in\" type=\"s\"/>\n"    \
  52         "   <arg name=\"properties\" direction=\"out\" type=\"a{sv}\"/>\n" \
  53         "  </method>\n"                                                 \
  54         "  <method name=\"Set\">\n"                                     \
  55         "   <arg name=\"interface\" direction=\"in\" type=\"s\"/>\n"    \
  56         "   <arg name=\"property\" direction=\"in\" type=\"s\"/>\n"     \
  57         "   <arg name=\"value\" direction=\"in\" type=\"v\"/>\n"        \
  58         "  </method>\n"                                                 \
  59         "  <signal name=\"PropertiesChanged\">\n"                       \
  60         "   <arg type=\"s\" name=\"interface\"/>\n"                     \
  61         "   <arg type=\"a{sv}\" name=\"changed_properties\"/>\n"        \
  62         "   <arg type=\"as\" name=\"invalidated_properties\"/>\n"       \
  63         "  </signal>\n"                                                 \
  64         " </interface>\n"
  65
  66 #define BUS_INTROSPECTABLE_INTERFACE                                    \
  67         " <interface name=\"org.freedesktop.DBus.Introspectable\">\n"   \
  68         "  <method name=\"Introspect\">\n"                              \
  69         "   <arg name=\"data\" type=\"s\" direction=\"out\"/>\n"        \
  70         "  </method>\n"                                                 \
  71         " </interface>\n"
  72
  73 #define BUS_PEER_INTERFACE                                              \
  74         "<interface name=\"org.freedesktop.DBus.Peer\">\n"              \
  75         " <method name=\"Ping\"/>\n"                                    \
  76         " <method name=\"GetMachineId\">\n"                             \
  77         "  <arg type=\"s\" name=\"machine_uuid\" direction=\"out\"/>\n" \
  78         " </method>\n"                                                  \
  79         "</interface>\n"
  80
  81 #define BUS_GENERIC_INTERFACES_LIST             \
  82         "org.freedesktop.DBus.Properties\0"     \
  83         "org.freedesktop.DBus.Introspectable\0" \
  84         "org.freedesktop.DBus.Peer\0"
  85
  86 int bus_check_peercred(DBusConnection *c);
  87
  88 int bus_connect(DBusBusType t, DBusConnection **_bus, bool *private_bus, DBusError *error);
  89
  90 int bus_connect_system_ssh(const char *user, const char *host, DBusConnection **_bus, DBusError *error);
  91 int bus_connect_system_polkit(DBusConnection **_bus, DBusError *error);
  92
  93 const char *bus_error_message(const DBusError *error);
  94 const char *bus_error_message_or_strerror(const DBusError *error, int err);
  95
  96 typedef int (*BusPropertyCallback)(DBusMessageIter *iter, const char *property, void *data);
  97 typedef int (*BusPropertySetCallback)(DBusMessageIter *iter, const char *property, void *data);
  98
  99 typedef struct BusProperty {
 100         const char *property;            /* name of the property */
 101         BusPropertyCallback append;      /* Function that is called to serialize this property */
 102         const char *signature;
 103         const uint16_t offset;           /* Offset from BusBoundProperties::base address to the property data.
 104                                           * uint16_t is sufficient, because we have no structs too big.
 105                                           * -Werror=overflow will catch it if this does not hold. */
 106         bool indirect;                   /* data is indirect, ie. not base+offset, but *(base+offset) */
 107         BusPropertySetCallback set;      /* Optional: Function that is called to set this property */
 108 } BusProperty;
 109
 110 typedef struct BusBoundProperties {
 111         const char *interface;           /* interface of the properties */
 112         const BusProperty *properties;   /* array of properties, ended by a NULL-filled element */
 113         const void *const base;          /* base pointer to which the offset must be added to reach data */
 114 } BusBoundProperties;
 115
 116 DBusHandlerResult bus_send_error_reply(
 117                 DBusConnection *c,
 118                 DBusMessage *message,
 119                 DBusError *bus_error,
 120                 int error);
 121
 122 DBusHandlerResult bus_default_message_handler(
 123                 DBusConnection *c,
 124                 DBusMessage *message,
 125                 const char *introspection,
 126                 const char *interfaces,
 127                 const BusBoundProperties *bound_properties);
 128
 129 int bus_property_append_string(DBusMessageIter *i, const char *property, void *data);
 130 int bus_property_append_strv(DBusMessageIter *i, const char *property, void *data);
 131 int bus_property_append_bool(DBusMessageIter *i, const char *property, void *data);
 132 int bus_property_append_tristate_false(DBusMessageIter *i, const char *property, void *data);
 133 int bus_property_append_int32(DBusMessageIter *i, const char *property, void *data);
 134 int bus_property_append_uint32(DBusMessageIter *i, const char *property, void *data);
 135 int bus_property_append_uint64(DBusMessageIter *i, const char *property, void *data);
 136 int bus_property_append_size(DBusMessageIter *i, const char *property, void *data);
 137 int bus_property_append_ul(DBusMessageIter *i, const char *property, void *data);
 138 int bus_property_append_long(DBusMessageIter *i, const char *property, void *data);
 139
 140 #define bus_property_append_int bus_property_append_int32
 141 #define bus_property_append_pid bus_property_append_uint32
 142 #define bus_property_append_uid bus_property_append_uint32
 143 #define bus_property_append_gid bus_property_append_uint32
 144 #define bus_property_append_mode bus_property_append_uint32
 145 #define bus_property_append_unsigned bus_property_append_uint32
 146 #define bus_property_append_usec bus_property_append_uint64
 147
 148 int bus_property_set_uint64(DBusMessageIter *i, const char *property, void *data);
 149 #define bus_property_set_usec bus_property_set_uint64
 150
 151 #define DEFINE_BUS_PROPERTY_APPEND_ENUM(function,name,type)             \
 152         int function(DBusMessageIter *i, const char *property, void *data) { \
 153                 const char *value;                                      \
 154                 type *field = data;                                     \
 155                                                                         \
 156                 assert(i);                                              \
 157                 assert(property);                                       \
 158                                                                         \
 159                 value = strempty(name##_to_string(*field));             \
 160                                                                         \
 161                 if (!dbus_message_iter_append_basic(i, DBUS_TYPE_STRING, &value)) \
 162                         return -ENOMEM;                                 \
 163                                                                         \
 164                 return 0;                                               \
 165         }
 166
 167 #define DEFINE_BUS_PROPERTY_SET_ENUM(function,name,type)                \
 168         int function(DBusMessageIter *i, const char *property, void *data) { \
 169                 const char *value;                                      \
 170                 type f, *field = data;                                  \
 171                                                                         \
 172                 assert(i);                                              \
 173                 assert(property);                                       \
 174                                                                         \
 175                 dbus_message_iter_get_basic(i, &value);                 \
 176                                                                         \
 177                 f = name##_from_string(value);                          \
 178                 if (f < 0)                                              \
 179                         return f;                                       \
 180                                                                         \
 181                 *field = f;                                             \
 182                 return 0;                                               \
 183         }
 184
 185 const char *bus_errno_to_dbus(int error);
 186
 187 DBusMessage* bus_properties_changed_new(const char *path, const char *interface, const char *properties);
 188 DBusMessage* bus_properties_changed_one_new(const char *path, const char *interface, const char *property);
 189
 190 uint32_t bus_flags_to_events(DBusWatch *bus_watch);
 191 unsigned bus_events_to_flags(uint32_t events);
 192
 193 int bus_parse_strv(DBusMessage *m, char ***_l);
 194 int bus_parse_strv_iter(DBusMessageIter *iter, char ***_l);
 195
 196 int bus_append_strv_iter(DBusMessageIter *iter, char **l);
 197
 198 int bus_iter_get_basic_and_next(DBusMessageIter *iter, int type, void *data, bool next);
 199
 200 int generic_print_property(const char *name, DBusMessageIter *iter, bool all);
 201
 202 void bus_async_unregister_and_exit(DBusConnection *bus, const char *name);
 203
 204 DBusHandlerResult bus_exit_idle_filter(DBusConnection *bus, DBusMessage *m, void *userdata);
 205
 206 pid_t bus_get_unix_process_id(DBusConnection *connection, const char *name, DBusError *error);
 207
 208 #endif