1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
6 This file is part of systemd.
8 Copyright 2010 Lennart Poettering
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.
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.
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/>.
24 #include <dbus/dbus.h>
26 #ifndef DBUS_ERROR_UNKNOWN_OBJECT
27 #define DBUS_ERROR_UNKNOWN_OBJECT "org.freedesktop.DBus.Error.UnknownObject"
30 #ifndef DBUS_ERROR_UNKNOWN_INTERFACE
31 #define DBUS_ERROR_UNKNOWN_INTERFACE "org.freedesktop.DBus.Error.UnknownInterface"
34 #ifndef DBUS_ERROR_UNKNOWN_PROPERTY
35 #define DBUS_ERROR_UNKNOWN_PROPERTY "org.freedesktop.DBus.Error.UnknownProperty"
38 #ifndef DBUS_ERROR_PROPERTY_READ_ONLY
39 #define DBUS_ERROR_PROPERTY_READ_ONLY "org.freedesktop.DBus.Error.PropertyReadOnly"
42 #define BUS_PROPERTIES_INTERFACE \
43 " <interface name=\"org.freedesktop.DBus.Properties\">\n" \
44 " <method name=\"Get\">\n" \
45 " <arg name=\"interface\" direction=\"in\" type=\"s\"/>\n" \
46 " <arg name=\"property\" direction=\"in\" type=\"s\"/>\n" \
47 " <arg name=\"value\" direction=\"out\" type=\"v\"/>\n" \
49 " <method name=\"GetAll\">\n" \
50 " <arg name=\"interface\" direction=\"in\" type=\"s\"/>\n" \
51 " <arg name=\"properties\" direction=\"out\" type=\"a{sv}\"/>\n" \
53 " <method name=\"Set\">\n" \
54 " <arg name=\"interface\" direction=\"in\" type=\"s\"/>\n" \
55 " <arg name=\"property\" direction=\"in\" type=\"s\"/>\n" \
56 " <arg name=\"value\" direction=\"in\" type=\"v\"/>\n" \
58 " <signal name=\"PropertiesChanged\">\n" \
59 " <arg type=\"s\" name=\"interface\"/>\n" \
60 " <arg type=\"a{sv}\" name=\"changed_properties\"/>\n" \
61 " <arg type=\"as\" name=\"invalidated_properties\"/>\n" \
65 #define BUS_INTROSPECTABLE_INTERFACE \
66 " <interface name=\"org.freedesktop.DBus.Introspectable\">\n" \
67 " <method name=\"Introspect\">\n" \
68 " <arg name=\"data\" type=\"s\" direction=\"out\"/>\n" \
72 #define BUS_PEER_INTERFACE \
73 "<interface name=\"org.freedesktop.DBus.Peer\">\n" \
74 " <method name=\"Ping\"/>\n" \
75 " <method name=\"GetMachineId\">\n" \
76 " <arg type=\"s\" name=\"machine_uuid\" direction=\"out\"/>\n" \
80 #define BUS_GENERIC_INTERFACES_LIST \
81 "org.freedesktop.DBus.Properties\0" \
82 "org.freedesktop.DBus.Introspectable\0" \
83 "org.freedesktop.DBus.Peer\0"
85 int bus_check_peercred(DBusConnection *c);
87 int bus_connect(DBusBusType t, DBusConnection **_bus, bool *private_bus, DBusError *error);
89 int bus_connect_system_ssh(const char *user, const char *host, DBusConnection **_bus, DBusError *error);
90 int bus_connect_system_polkit(DBusConnection **_bus, DBusError *error);
92 const char *bus_error_message(const DBusError *error);
93 const char *bus_error_message_or_strerror(const DBusError *error, int err);
95 typedef int (*BusPropertyCallback)(DBusMessageIter *iter, const char *property, void *data);
96 typedef int (*BusPropertySetCallback)(DBusMessageIter *iter, const char *property, void *data);
98 typedef struct BusProperty {
99 const char *property; /* name of the property */
100 BusPropertyCallback append; /* Function that is called to serialize this property */
101 const char *signature;
102 const uint16_t offset; /* Offset from BusBoundProperties::base address to the property data.
103 * uint16_t is sufficient, because we have no structs too big.
104 * -Werror=overflow will catch it if this does not hold. */
105 bool indirect; /* data is indirect, ie. not base+offset, but *(base+offset) */
106 BusPropertySetCallback set; /* Optional: Function that is called to set this property */
109 typedef struct BusBoundProperties {
110 const char *interface; /* interface of the properties */
111 const BusProperty *properties; /* array of properties, ended by a NULL-filled element */
112 const void *const base; /* base pointer to which the offset must be added to reach data */
113 } BusBoundProperties;
115 DBusHandlerResult bus_send_error_reply(
117 DBusMessage *message,
118 DBusError *bus_error,
121 DBusHandlerResult bus_default_message_handler(
123 DBusMessage *message,
124 const char *introspection,
125 const char *interfaces,
126 const BusBoundProperties *bound_properties);
128 int bus_property_append_string(DBusMessageIter *i, const char *property, void *data);
129 int bus_property_append_strv(DBusMessageIter *i, const char *property, void *data);
130 int bus_property_append_bool(DBusMessageIter *i, const char *property, void *data);
131 int bus_property_append_tristate_false(DBusMessageIter *i, const char *property, void *data);
132 int bus_property_append_int32(DBusMessageIter *i, const char *property, void *data);
133 int bus_property_append_uint32(DBusMessageIter *i, const char *property, void *data);
134 int bus_property_append_uint64(DBusMessageIter *i, const char *property, void *data);
135 int bus_property_append_size(DBusMessageIter *i, const char *property, void *data);
136 int bus_property_append_ul(DBusMessageIter *i, const char *property, void *data);
137 int bus_property_append_long(DBusMessageIter *i, const char *property, void *data);
139 #define bus_property_append_int bus_property_append_int32
140 #define bus_property_append_pid bus_property_append_uint32
141 #define bus_property_append_uid bus_property_append_uint32
142 #define bus_property_append_gid bus_property_append_uint32
143 #define bus_property_append_mode bus_property_append_uint32
144 #define bus_property_append_unsigned bus_property_append_uint32
145 #define bus_property_append_usec bus_property_append_uint64
147 int bus_property_set_uint64(DBusMessageIter *i, const char *property, void *data);
148 #define bus_property_set_usec bus_property_set_uint64
150 #define DEFINE_BUS_PROPERTY_APPEND_ENUM(function,name,type) \
151 int function(DBusMessageIter *i, const char *property, void *data) { \
153 type *field = data; \
158 value = strempty(name##_to_string(*field)); \
160 if (!dbus_message_iter_append_basic(i, DBUS_TYPE_STRING, &value)) \
166 #define DEFINE_BUS_PROPERTY_SET_ENUM(function,name,type) \
167 int function(DBusMessageIter *i, const char *property, void *data) { \
169 type f, *field = data; \
174 dbus_message_iter_get_basic(i, &value); \
176 f = name##_from_string(value); \
184 const char *bus_errno_to_dbus(int error);
186 DBusMessage* bus_properties_changed_new(const char *path, const char *interface, const char *properties);
187 DBusMessage* bus_properties_changed_one_new(const char *path, const char *interface, const char *property);
189 uint32_t bus_flags_to_events(DBusWatch *bus_watch);
190 unsigned bus_events_to_flags(uint32_t events);
192 int bus_parse_strv(DBusMessage *m, char ***_l);
193 int bus_parse_strv_iter(DBusMessageIter *iter, char ***_l);
195 int bus_append_strv_iter(DBusMessageIter *iter, char **l);
197 int bus_iter_get_basic_and_next(DBusMessageIter *iter, int type, void *data, bool next);
199 int generic_print_property(const char *name, DBusMessageIter *iter, bool all);
201 void bus_async_unregister_and_exit(DBusConnection *bus, const char *name);
203 DBusHandlerResult bus_exit_idle_filter(DBusConnection *bus, DBusMessage *m, void *userdata);
205 pid_t bus_get_unix_process_id(DBusConnection *connection, const char *name, DBusError *error);
207 bool bus_error_is_no_service(const DBusError *error);
208 int bus_method_call_with_reply(DBusConnection *bus,
209 const char *destination,
211 const char *interface,
213 DBusMessage **return_reply,
214 DBusError *return_error,
215 int first_arg_type, ...);
217 const char *bus_message_get_sender_with_fallback(DBusMessage *m);
219 void bus_message_unrefp(DBusMessage **reply);
221 #define _cleanup_dbus_message_unref_ __attribute__((cleanup(bus_message_unrefp)))