[systemd.git] / src / shared / bus-util.h

/* SPDX-License-Identifier: LGPL-2.1+ */
#pragma once

#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
#include <sys/types.h>

#include "sd-bus.h"
#include "sd-event.h"

#include "hashmap.h"
#include "macro.h"
#include "string-util.h"

typedef enum BusTransport {
        BUS_TRANSPORT_LOCAL,
        BUS_TRANSPORT_REMOTE,
        BUS_TRANSPORT_MACHINE,
        _BUS_TRANSPORT_MAX,
        _BUS_TRANSPORT_INVALID = -1
} BusTransport;

typedef int (*bus_property_set_t) (sd_bus *bus, const char *member, sd_bus_message *m, sd_bus_error *error, void *userdata);

struct bus_properties_map {
        const char *member;
        const char *signature;
        bus_property_set_t set;
        size_t offset;
};

enum {
        BUS_MAP_STRDUP          = 1 << 0, /* If set, each "s" message is duplicated. Thus, each pointer needs to be freed. */
        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. */
};

int bus_map_id128(sd_bus *bus, const char *member, sd_bus_message *m, sd_bus_error *error, void *userdata);

int bus_message_map_all_properties(sd_bus_message *m, const struct bus_properties_map *map, unsigned flags, sd_bus_error *error, void *userdata);
int bus_map_all_properties(sd_bus *bus, const char *destination, const char *path, const struct bus_properties_map *map,
                           unsigned flags, sd_bus_error *error, sd_bus_message **reply, void *userdata);

int bus_async_unregister_and_exit(sd_event *e, sd_bus *bus, const char *name);

typedef bool (*check_idle_t)(void *userdata);

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);

int bus_name_has_owner(sd_bus *c, const char *name, sd_bus_error *error);

int bus_check_peercred(sd_bus *c);

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);

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);
void bus_verify_polkit_async_registry_free(Hashmap *registry);

int bus_connect_system_systemd(sd_bus **_bus);
int bus_connect_user_systemd(sd_bus **_bus);

int bus_connect_transport(BusTransport transport, const char *host, bool user, sd_bus **bus);
int bus_connect_transport_systemd(BusTransport transport, const char *host, bool user, sd_bus **bus);

typedef int (*bus_message_print_t) (const char *name, const char *expected_value, sd_bus_message *m, bool value, bool all);

int bus_print_property_value(const char *name, const char *expected_value, bool only_value, const char *fmt, ...) _printf_(4,5);
int bus_message_print_all_properties(sd_bus_message *m, bus_message_print_t func, char **filter, bool value, bool all, Set **found_properties);
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);

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);
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);
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);

#define bus_property_get_usec ((sd_bus_property_get_t) NULL)
#define bus_property_set_usec ((sd_bus_property_set_t) NULL)

assert_cc(sizeof(int) == sizeof(int32_t));
#define bus_property_get_int ((sd_bus_property_get_t) NULL)

assert_cc(sizeof(unsigned) == sizeof(uint32_t));
#define bus_property_get_unsigned ((sd_bus_property_get_t) NULL)

/* On 64bit machines we can use the default serializer for size_t and
 * friends, otherwise we need to cast this manually */
#if __SIZEOF_SIZE_T__ == 8
#define bus_property_get_size ((sd_bus_property_get_t) NULL)
#else
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);
#endif

#if __SIZEOF_LONG__ == 8
#define bus_property_get_long ((sd_bus_property_get_t) NULL)
#define bus_property_get_ulong ((sd_bus_property_get_t) NULL)
#else
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);
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);
#endif

/* uid_t and friends on Linux 32 bit. This means we can just use the
 * default serializer for 32bit unsigned, for serializing it, and map
 * it to NULL here */
assert_cc(sizeof(uid_t) == sizeof(uint32_t));
#define bus_property_get_uid ((sd_bus_property_get_t) NULL)

assert_cc(sizeof(gid_t) == sizeof(uint32_t));
#define bus_property_get_gid ((sd_bus_property_get_t) NULL)

assert_cc(sizeof(pid_t) == sizeof(uint32_t));
#define bus_property_get_pid ((sd_bus_property_get_t) NULL)

assert_cc(sizeof(mode_t) == sizeof(uint32_t));
#define bus_property_get_mode ((sd_bus_property_get_t) NULL)

int bus_log_parse_error(int r);
int bus_log_create_error(int r);

#define BUS_DEFINE_PROPERTY_GET_GLOBAL(function, bus_type, val)         \
        int function(sd_bus *bus,                                       \
                     const char *path,                                  \
                     const char *interface,                             \
                     const char *property,                              \
                     sd_bus_message *reply,                             \
                     void *userdata,                                    \
                     sd_bus_error *error) {                             \
                                                                        \
                assert(bus);                                            \
                assert(reply);                                          \
                                                                        \
                return sd_bus_message_append(reply, bus_type, val);     \
        }

#define BUS_DEFINE_PROPERTY_GET2(function, bus_type, data_type, get1, get2) \
        int function(sd_bus *bus,                                       \
                     const char *path,                                  \
                     const char *interface,                             \
                     const char *property,                              \
                     sd_bus_message *reply,                             \
                     void *userdata,                                    \
                     sd_bus_error *error) {                             \
                                                                        \
                data_type *data = userdata;                             \
                                                                        \
                assert(bus);                                            \
                assert(reply);                                          \
                assert(data);                                           \
                                                                        \
                return sd_bus_message_append(reply, bus_type,           \
                                             get2(get1(data)));         \
        }

#define ident(x) (x)
#define BUS_DEFINE_PROPERTY_GET(function, bus_type, data_type, get1) \
        BUS_DEFINE_PROPERTY_GET2(function, bus_type, data_type, get1, ident)

#define ref(x) (*(x))
#define BUS_DEFINE_PROPERTY_GET_REF(function, bus_type, data_type, get) \
        BUS_DEFINE_PROPERTY_GET2(function, bus_type, data_type, ref, get)

#define BUS_DEFINE_PROPERTY_GET_ENUM(function, name, type)              \
        BUS_DEFINE_PROPERTY_GET_REF(function, "s", type, name##_to_string)

#define BUS_PROPERTY_DUAL_TIMESTAMP(name, offset, flags) \
        SD_BUS_PROPERTY(name, "t", bus_property_get_usec, (offset) + offsetof(struct dual_timestamp, realtime), (flags)), \
        SD_BUS_PROPERTY(name "Monotonic", "t", bus_property_get_usec, (offset) + offsetof(struct dual_timestamp, monotonic), (flags))

int bus_path_encode_unique(sd_bus *b, const char *prefix, const char *sender_id, const char *external_id, char **ret_path);
int bus_path_decode_unique(const char *path, const char *prefix, char **ret_sender, char **ret_external);

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);

int bus_track_add_name_many(sd_bus_track *t, char **l);

int bus_open_system_watch_bind_with_description(sd_bus **ret, const char *description);
static inline int bus_open_system_watch_bind(sd_bus **ret) {
        return bus_open_system_watch_bind_with_description(ret, NULL);
}

int bus_reply_pair_array(sd_bus_message *m, char **l);
Commit	Line	Data
52ad194e	1	/* SPDX-License-Identifier: LGPL-2.1+ */
60f067b4 JS	2	#pragma once
60f067b4 JS	3
4c89c718 MP	4	#include <stdbool.h>
	5	#include <stddef.h>
	6	#include <stdint.h>
	7	#include <sys/types.h>
	8
60f067b4	9	#include "sd-bus.h"
db2df898 MP	10	#include "sd-event.h"
db2df898 MP	11
60f067b4	12	#include "hashmap.h"
4c89c718	13	#include "macro.h"
db2df898	14	#include "string-util.h"
60f067b4 JS	15
	16	typedef enum BusTransport {
	17	BUS_TRANSPORT_LOCAL,
	18	BUS_TRANSPORT_REMOTE,
e735f4d4	19	BUS_TRANSPORT_MACHINE,
60f067b4 JS	20	_BUS_TRANSPORT_MAX,
	21	_BUS_TRANSPORT_INVALID = -1
	22	} BusTransport;
	23
	24	typedef int (bus_property_set_t) (sd_bus bus, const char member, sd_bus_message m, sd_bus_error error, void userdata);
	25
	26	struct bus_properties_map {
	27	const char *member;
	28	const char *signature;
	29	bus_property_set_t set;
	30	size_t offset;
	31	};
	32
b012e921 MB	33	enum {
	34	BUS_MAP_STRDUP = 1 << 0, /* If set, each "s" message is duplicated. Thus, each pointer needs to be freed. */
	35	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. */
	36	};
	37
60f067b4 JS	38	int bus_map_id128(sd_bus bus, const char member, sd_bus_message m, sd_bus_error error, void *userdata);
60f067b4 JS	39
b012e921	40	int bus_message_map_all_properties(sd_bus_message m, const struct bus_properties_map map, unsigned flags, sd_bus_error error, void userdata);
b012e921 MB	41	int bus_map_all_properties(sd_bus bus, const char destination, const char path, const struct bus_properties_map map,
b012e921 MB	42	unsigned flags, sd_bus_error error, sd_bus_message reply, void userdata);
60f067b4 JS	43
	44	int bus_async_unregister_and_exit(sd_event e, sd_bus bus, const char *name);
	45
	46	typedef bool (check_idle_t)(void userdata);
	47
	48	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);
	49
	50	int bus_name_has_owner(sd_bus c, const char name, sd_bus_error *error);
	51
	52	int bus_check_peercred(sd_bus *c);
	53
d9dfd233	54	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);
60f067b4	55
d9dfd233	56	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);
5eef597e	57	void bus_verify_polkit_async_registry_free(Hashmap *registry);
60f067b4	58
6300502b MP	59	int bus_connect_system_systemd(sd_bus **_bus);
6300502b MP	60	int bus_connect_user_systemd(sd_bus **_bus);
60f067b4	61
6300502b MP	62	int bus_connect_transport(BusTransport transport, const char host, bool user, sd_bus *bus);
6300502b MP	63	int bus_connect_transport_systemd(BusTransport transport, const char host, bool user, sd_bus *bus);
60f067b4	64
6e866b33	65	typedef int (bus_message_print_t) (const char name, const char expected_value, sd_bus_message m, bool value, bool all);
b012e921	66
6e866b33	67	int bus_print_property_value(const char name, const char expected_value, bool only_value, const char *fmt, ...) _printf_(4,5);
b012e921 MB	68	int bus_message_print_all_properties(sd_bus_message m, bus_message_print_t func, char filter, bool value, bool all, Set *found_properties);
b012e921 MB	69	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);
60f067b4 JS	70
60f067b4 JS	71	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);
1d42b86d	72	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);
8a584da2	73	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);
60f067b4 JS	74
	75	#define bus_property_get_usec ((sd_bus_property_get_t) NULL)
	76	#define bus_property_set_usec ((sd_bus_property_set_t) NULL)
	77
	78	assert_cc(sizeof(int) == sizeof(int32_t));
	79	#define bus_property_get_int ((sd_bus_property_get_t) NULL)
	80
b012e921	81	assert_cc(sizeof(unsigned) == sizeof(uint32_t));
60f067b4 JS	82	#define bus_property_get_unsigned ((sd_bus_property_get_t) NULL)
	83
	84	/* On 64bit machines we can use the default serializer for size_t and
	85	* friends, otherwise we need to cast this manually */
	86	#if __SIZEOF_SIZE_T__ == 8
	87	#define bus_property_get_size ((sd_bus_property_get_t) NULL)
	88	#else
	89	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);
	90	#endif
	91
	92	#if __SIZEOF_LONG__ == 8
	93	#define bus_property_get_long ((sd_bus_property_get_t) NULL)
	94	#define bus_property_get_ulong ((sd_bus_property_get_t) NULL)
	95	#else
	96	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);
	97	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);
	98	#endif
	99
	100	/* uid_t and friends on Linux 32 bit. This means we can just use the
	101	* default serializer for 32bit unsigned, for serializing it, and map
	102	* it to NULL here */
	103	assert_cc(sizeof(uid_t) == sizeof(uint32_t));
	104	#define bus_property_get_uid ((sd_bus_property_get_t) NULL)
	105
	106	assert_cc(sizeof(gid_t) == sizeof(uint32_t));
	107	#define bus_property_get_gid ((sd_bus_property_get_t) NULL)
	108
	109	assert_cc(sizeof(pid_t) == sizeof(uint32_t));
	110	#define bus_property_get_pid ((sd_bus_property_get_t) NULL)
	111
	112	assert_cc(sizeof(mode_t) == sizeof(uint32_t));
	113	#define bus_property_get_mode ((sd_bus_property_get_t) NULL)
	114
	115	int bus_log_parse_error(int r);
	116	int bus_log_create_error(int r);
	117
b012e921	118	#define BUS_DEFINE_PROPERTY_GET_GLOBAL(function, bus_type, val) \
60f067b4 JS	119	int function(sd_bus *bus, \
	120	const char *path, \
	121	const char *interface, \
	122	const char *property, \
	123	sd_bus_message *reply, \
	124	void *userdata, \
	125	sd_bus_error *error) { \
	126	\
60f067b4 JS	127	assert(bus); \
60f067b4 JS	128	assert(reply); \
60f067b4	129	\
b012e921 MB	130	return sd_bus_message_append(reply, bus_type, val); \
	131	}
	132
	133	#define BUS_DEFINE_PROPERTY_GET2(function, bus_type, data_type, get1, get2) \
	134	int function(sd_bus *bus, \
	135	const char *path, \
	136	const char *interface, \
	137	const char *property, \
	138	sd_bus_message *reply, \
	139	void *userdata, \
	140	sd_bus_error *error) { \
60f067b4	141	\
b012e921 MB	142	data_type *data = userdata; \
	143	\
	144	assert(bus); \
	145	assert(reply); \
	146	assert(data); \
60f067b4	147	\
b012e921 MB	148	return sd_bus_message_append(reply, bus_type, \
	149	get2(get1(data))); \
	150	}
	151
	152	#define ident(x) (x)
	153	#define BUS_DEFINE_PROPERTY_GET(function, bus_type, data_type, get1) \
	154	BUS_DEFINE_PROPERTY_GET2(function, bus_type, data_type, get1, ident)
	155
	156	#define ref(x) (*(x))
	157	#define BUS_DEFINE_PROPERTY_GET_REF(function, bus_type, data_type, get) \
	158	BUS_DEFINE_PROPERTY_GET2(function, bus_type, data_type, ref, get)
	159
	160	#define BUS_DEFINE_PROPERTY_GET_ENUM(function, name, type) \
	161	BUS_DEFINE_PROPERTY_GET_REF(function, "s", type, name##_to_string)
60f067b4 JS	162
	163	#define BUS_PROPERTY_DUAL_TIMESTAMP(name, offset, flags) \
	164	SD_BUS_PROPERTY(name, "t", bus_property_get_usec, (offset) + offsetof(struct dual_timestamp, realtime), (flags)), \
	165	SD_BUS_PROPERTY(name "Monotonic", "t", bus_property_get_usec, (offset) + offsetof(struct dual_timestamp, monotonic), (flags))
	166
e3bff60a MP	167	int bus_path_encode_unique(sd_bus b, const char prefix, const char sender_id, const char external_id, char **ret_path);
	168	int bus_path_decode_unique(const char path, const char prefix, char ret_sender, char ret_external);
	169
db2df898	170	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);
2897b343 MP	171
2897b343 MP	172	int bus_track_add_name_many(sd_bus_track t, char *l);
1d42b86d	173
b012e921 MB	174	int bus_open_system_watch_bind_with_description(sd_bus *ret, const char description);
	175	static inline int bus_open_system_watch_bind(sd_bus **ret) {
	176	return bus_open_system_watch_bind_with_description(ret, NULL);
	177	}
	178
b012e921	179	int bus_reply_pair_array(sd_bus_message m, char *l);