1 /* SPDX-License-Identifier: LGPL-2.1+ */
12 #include "bus-locator.h"
15 #include "string-util.h"
16 #include "time-util.h"
18 typedef enum BusTransport
{
21 BUS_TRANSPORT_MACHINE
,
23 _BUS_TRANSPORT_INVALID
= -1
27 typedef int (*bus_property_set_t
) (sd_bus
*bus
, const char *member
, sd_bus_message
*m
, sd_bus_error
*error
, void *userdata
);
29 struct bus_properties_map
{
31 const char *signature
;
32 bus_property_set_t set
;
37 BUS_MAP_STRDUP
= 1 << 0, /* If set, each "s" message is duplicated. Thus, each pointer needs to be freed. */
38 BUS_MAP_BOOLEAN_AS_BOOL
= 1 << 1, /* If set, each "b" message is written to a bool pointer. If not set, "b" is written to a int pointer. */
41 int bus_map_id128(sd_bus
*bus
, const char *member
, sd_bus_message
*m
, sd_bus_error
*error
, void *userdata
);
43 int bus_message_map_all_properties(sd_bus_message
*m
, const struct bus_properties_map
*map
, unsigned flags
, sd_bus_error
*error
, void *userdata
);
44 int bus_map_all_properties(sd_bus
*bus
, const char *destination
, const char *path
, const struct bus_properties_map
*map
,
45 unsigned flags
, sd_bus_error
*error
, sd_bus_message
**reply
, void *userdata
);
47 int bus_async_unregister_and_exit(sd_event
*e
, sd_bus
*bus
, const char *name
);
49 typedef bool (*check_idle_t
)(void *userdata
);
51 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
);
53 int bus_name_has_owner(sd_bus
*c
, const char *name
, sd_bus_error
*error
);
55 int bus_check_peercred(sd_bus
*c
);
57 int bus_connect_system_systemd(sd_bus
**_bus
);
58 int bus_connect_user_systemd(sd_bus
**_bus
);
60 int bus_connect_transport(BusTransport transport
, const char *host
, bool user
, sd_bus
**bus
);
61 int bus_connect_transport_systemd(BusTransport transport
, const char *host
, bool user
, sd_bus
**bus
);
63 typedef int (*bus_message_print_t
) (const char *name
, const char *expected_value
, sd_bus_message
*m
, bool value
, bool all
);
65 int bus_print_property_value(const char *name
, const char *expected_value
, bool only_value
, const char *value
);
66 int bus_print_property_valuef(const char *name
, const char *expected_value
, bool only_value
, const char *fmt
, ...) _printf_(4,5);
67 int bus_message_print_all_properties(sd_bus_message
*m
, bus_message_print_t func
, char **filter
, bool value
, bool all
, Set
**found_properties
);
68 int bus_print_all_properties(sd_bus
*bus
, const char *dest
, const char *path
, bus_message_print_t func
, char **filter
, bool value
, bool all
, Set
**found_properties
);
70 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
);
71 int bus_property_set_bool(sd_bus
*bus
, const char *path
, const char *interface
, const char *property
, sd_bus_message
*value
, void *userdata
, sd_bus_error
*error
);
72 int bus_property_get_id128(sd_bus
*bus
, const char *path
, const char *interface
, const char *property
, sd_bus_message
*reply
, void *userdata
, sd_bus_error
*error
);
74 #define bus_property_get_usec ((sd_bus_property_get_t) NULL)
75 #define bus_property_set_usec ((sd_bus_property_set_t) NULL)
77 assert_cc(sizeof(int) == sizeof(int32_t));
78 #define bus_property_get_int ((sd_bus_property_get_t) NULL)
80 assert_cc(sizeof(unsigned) == sizeof(uint32_t));
81 #define bus_property_get_unsigned ((sd_bus_property_get_t) NULL)
83 /* On 64bit machines we can use the default serializer for size_t and
84 * friends, otherwise we need to cast this manually */
85 #if __SIZEOF_SIZE_T__ == 8
86 #define bus_property_get_size ((sd_bus_property_get_t) NULL)
88 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
);
91 #if __SIZEOF_LONG__ == 8
92 #define bus_property_get_long ((sd_bus_property_get_t) NULL)
93 #define bus_property_get_ulong ((sd_bus_property_get_t) NULL)
95 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
);
96 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
);
99 /* uid_t and friends on Linux 32 bit. This means we can just use the
100 * default serializer for 32bit unsigned, for serializing it, and map
102 assert_cc(sizeof(uid_t
) == sizeof(uint32_t));
103 #define bus_property_get_uid ((sd_bus_property_get_t) NULL)
105 assert_cc(sizeof(gid_t
) == sizeof(uint32_t));
106 #define bus_property_get_gid ((sd_bus_property_get_t) NULL)
108 assert_cc(sizeof(pid_t
) == sizeof(uint32_t));
109 #define bus_property_get_pid ((sd_bus_property_get_t) NULL)
111 assert_cc(sizeof(mode_t
) == sizeof(uint32_t));
112 #define bus_property_get_mode ((sd_bus_property_get_t) NULL)
114 #define bus_log_parse_error(r) \
115 log_error_errno(r, "Failed to parse bus message: %m")
117 #define bus_log_create_error(r) \
118 log_error_errno(r, "Failed to create bus message: %m")
120 #define BUS_DEFINE_PROPERTY_GET_GLOBAL(function, bus_type, val) \
121 int function(sd_bus *bus, \
123 const char *interface, \
124 const char *property, \
125 sd_bus_message *reply, \
127 sd_bus_error *error) { \
132 return sd_bus_message_append(reply, bus_type, val); \
135 #define BUS_DEFINE_PROPERTY_GET2(function, bus_type, data_type, get1, get2) \
136 int function(sd_bus *bus, \
138 const char *interface, \
139 const char *property, \
140 sd_bus_message *reply, \
142 sd_bus_error *error) { \
144 data_type *data = userdata; \
150 return sd_bus_message_append(reply, bus_type, \
155 #define BUS_DEFINE_PROPERTY_GET(function, bus_type, data_type, get1) \
156 BUS_DEFINE_PROPERTY_GET2(function, bus_type, data_type, get1, ident)
158 #define ref(x) (*(x))
159 #define BUS_DEFINE_PROPERTY_GET_REF(function, bus_type, data_type, get) \
160 BUS_DEFINE_PROPERTY_GET2(function, bus_type, data_type, ref, get)
162 #define BUS_DEFINE_PROPERTY_GET_ENUM(function, name, type) \
163 BUS_DEFINE_PROPERTY_GET_REF(function, "s", type, name##_to_string)
165 #define BUS_PROPERTY_DUAL_TIMESTAMP(name, offset, flags) \
166 SD_BUS_PROPERTY(name, "t", bus_property_get_usec, (offset) + offsetof(struct dual_timestamp, realtime), (flags)), \
167 SD_BUS_PROPERTY(name "Monotonic", "t", bus_property_get_usec, (offset) + offsetof(struct dual_timestamp, monotonic), (flags))
169 int bus_path_encode_unique(sd_bus
*b
, const char *prefix
, const char *sender_id
, const char *external_id
, char **ret_path
);
170 int bus_path_decode_unique(const char *path
, const char *prefix
, char **ret_sender
, char **ret_external
);
172 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
);
174 int bus_track_add_name_many(sd_bus_track
*t
, char **l
);
176 int bus_open_system_watch_bind_with_description(sd_bus
**ret
, const char *description
);
177 static inline int bus_open_system_watch_bind(sd_bus
**ret
) {
178 return bus_open_system_watch_bind_with_description(ret
, NULL
);
181 int bus_reply_pair_array(sd_bus_message
*m
, char **l
);
183 extern const struct hash_ops bus_message_hash_ops
;
185 /* Shorthand flavors of the sd-bus convenience helpers with destination,path,interface
186 * strings encapsulated within a single struct.
188 int bus_call_method_async(sd_bus
*bus
, sd_bus_slot
**slot
, const BusLocator
*locator
, const char *member
, sd_bus_message_handler_t callback
, void *userdata
, const char *types
, ...);
189 int bus_call_method(sd_bus
*bus
, const BusLocator
*locator
, const char *member
, sd_bus_error
*error
, sd_bus_message
**reply
, const char *types
, ...);
190 int bus_get_property(sd_bus
*bus
, const BusLocator
*locator
, const char *member
, sd_bus_error
*error
, sd_bus_message
**reply
, const char *type
);
191 int bus_get_property_trivial(sd_bus
*bus
, const BusLocator
*locator
, const char *member
, sd_bus_error
*error
, char type
, void *ptr
);
192 int bus_get_property_string(sd_bus
*bus
, const BusLocator
*locator
, const char *member
, sd_bus_error
*error
, char **ret
);
193 int bus_get_property_strv(sd_bus
*bus
, const BusLocator
*locator
, const char *member
, sd_bus_error
*error
, char ***ret
);
194 int bus_set_property(sd_bus
*bus
, const BusLocator
*locator
, const char *member
, sd_bus_error
*error
, const char *type
, ...);
195 int bus_match_signal(sd_bus
*bus
, sd_bus_slot
**ret
, const BusLocator
*locator
, const char *member
, sd_bus_message_handler_t callback
, void *userdata
);
196 int bus_match_signal_async(sd_bus
*bus
, sd_bus_slot
**ret
, const BusLocator
*locator
, const char *member
, sd_bus_message_handler_t callback
, sd_bus_message_handler_t install_callback
, void *userdata
);
197 int bus_message_new_method_call(sd_bus
*bus
, sd_bus_message
**m
, const BusLocator
*locator
, const char *member
);