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

#pragma once

/***
  This file is part of systemd.

  Copyright 2013 Lennart Poettering

  systemd is free software; you can redistribute it and/or modify it
  under the terms of the GNU Lesser General Public License as published by
  the Free Software Foundation; either version 2.1 of the License, or
  (at your option) any later version.

  systemd is distributed in the hope that it will be useful, but
  WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General Public License
  along with systemd; If not, see <http://www.gnu.org/licenses/>.
***/

#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;
};

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,  void *userdata);
int bus_message_map_properties_changed(sd_bus_message *m, const struct bus_properties_map *map, void *userdata);
int bus_map_all_properties(sd_bus *bus, const char *destination, const char *path, const struct bus_properties_map *map, 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);

int bus_print_property(const char *name, sd_bus_message *property, bool value, bool all);
int bus_print_all_properties(sd_bus *bus, const char *dest, const char *path, char **filter, bool value, bool all);

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_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(unsigned));
#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_ENUM(function, name, type)              \
        int function(sd_bus *bus,                                       \
                     const char *path,                                  \
                     const char *interface,                             \
                     const char *property,                              \
                     sd_bus_message *reply,                             \
                     void *userdata,                                    \
                     sd_bus_error *error) {                             \
                                                                        \
                const char *value;                                      \
                type *field = userdata;                                 \
                int r;                                                  \
                                                                        \
                assert(bus);                                            \
                assert(reply);                                          \
                assert(field);                                          \
                                                                        \
                value = strempty(name##_to_string(*field));             \
                                                                        \
                r = sd_bus_message_append_basic(reply, 's', value);     \
                if (r < 0)                                              \
                        return r;                                       \
                                                                        \
                return 1;                                               \
        }                                                               \
        struct __useless_struct_to_allow_trailing_semicolon__

#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);
Commit	Line	Data
40ca29a1 LP	1	#pragma once
	2
	3	/***
	4	This file is part of systemd.
	5
	6	Copyright 2013 Lennart Poettering
	7
	8	systemd is free software; you can redistribute it and/or modify it
	9	under the terms of the GNU Lesser General Public License as published by
	10	the Free Software Foundation; either version 2.1 of the License, or
	11	(at your option) any later version.
	12
	13	systemd is distributed in the hope that it will be useful, but
	14	WITHOUT ANY WARRANTY; without even the implied warranty of
	15	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	16	Lesser General Public License for more details.
	17
	18	You should have received a copy of the GNU Lesser General Public License
	19	along with systemd; If not, see <http://www.gnu.org/licenses/>.
	20	***/
	21
a8fbdf54 TA	22	#include <stdbool.h>
	23	#include <stddef.h>
	24	#include <stdint.h>
	25	#include <sys/types.h>
	26
40ca29a1	27	#include "sd-bus.h"
07630cea LP	28	#include "sd-event.h"
07630cea LP	29
40ca29a1	30	#include "hashmap.h"
a8fbdf54	31	#include "macro.h"
07630cea	32	#include "string-util.h"
40ca29a1	33
057171ef DH	34	typedef enum BusTransport {
	35	BUS_TRANSPORT_LOCAL,
	36	BUS_TRANSPORT_REMOTE,
	37	BUS_TRANSPORT_MACHINE,
	38	_BUS_TRANSPORT_MAX,
	39	_BUS_TRANSPORT_INVALID = -1
	40	} BusTransport;
	41
9f6eb1cd KS	42	typedef int (bus_property_set_t) (sd_bus bus, const char member, sd_bus_message m, sd_bus_error error, void userdata);
9f6eb1cd KS	43
ffc06c35	44	struct bus_properties_map {
9f6eb1cd KS	45	const char *member;
	46	const char *signature;
	47	bus_property_set_t set;
	48	size_t offset;
ffc06c35 KS	49	};
ffc06c35 KS	50
9f6eb1cd KS	51	int bus_map_id128(sd_bus bus, const char member, sd_bus_message m, sd_bus_error error, void *userdata);
9f6eb1cd KS	52
fe506d56 LP	53	int bus_message_map_all_properties(sd_bus_message m, const struct bus_properties_map map, void *userdata);
	54	int bus_message_map_properties_changed(sd_bus_message m, const struct bus_properties_map map, void *userdata);
	55	int bus_map_all_properties(sd_bus bus, const char destination, const char path, const struct bus_properties_map map, void *userdata);
ffc06c35	56
6203e07a	57	int bus_async_unregister_and_exit(sd_event e, sd_bus bus, const char *name);
40ca29a1	58
37224a5f LP	59	typedef bool (check_idle_t)(void userdata);
	60
	61	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);
718db961	62
5fd38859 DH	63	int bus_name_has_owner(sd_bus c, const char name, sd_bus_error *error);
5fd38859 DH	64
718db961	65	int bus_check_peercred(sd_bus *c);
40ca29a1	66
403ed0e5	67	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);
40ca29a1	68
403ed0e5	69	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);
36e34057	70	void bus_verify_polkit_async_registry_free(Hashmap *registry);
40ca29a1	71
266f3e26 LP	72	int bus_connect_system_systemd(sd_bus **_bus);
266f3e26 LP	73	int bus_connect_user_systemd(sd_bus **_bus);
a1da8583	74
266f3e26 LP	75	int bus_connect_transport(BusTransport transport, const char host, bool user, sd_bus *bus);
266f3e26 LP	76	int bus_connect_transport_systemd(BusTransport transport, const char host, bool user, sd_bus *bus);
d21ed1ea	77
4f9a9105	78	int bus_print_property(const char name, sd_bus_message property, bool value, bool all);
85500523	79	int bus_print_all_properties(sd_bus bus, const char dest, const char path, char *filter, bool value, bool all);
0c842e0a	80
ebcf1f97	81	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);
766c94ad	82	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);
e6504030	83
718db961 LP	84	#define bus_property_get_usec ((sd_bus_property_get_t) NULL)
	85	#define bus_property_set_usec ((sd_bus_property_set_t) NULL)
	86
	87	assert_cc(sizeof(int) == sizeof(int32_t));
	88	#define bus_property_get_int ((sd_bus_property_get_t) NULL)
	89
	90	assert_cc(sizeof(unsigned) == sizeof(unsigned));
	91	#define bus_property_get_unsigned ((sd_bus_property_get_t) NULL)
	92
	93	/* On 64bit machines we can use the default serializer for size_t and
	94	* friends, otherwise we need to cast this manually */
	95	#if __SIZEOF_SIZE_T__ == 8
	96	#define bus_property_get_size ((sd_bus_property_get_t) NULL)
	97	#else
ebcf1f97	98	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);
718db961 LP	99	#endif
	100
	101	#if __SIZEOF_LONG__ == 8
	102	#define bus_property_get_long ((sd_bus_property_get_t) NULL)
	103	#define bus_property_get_ulong ((sd_bus_property_get_t) NULL)
	104	#else
ebcf1f97 LP	105	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);
ebcf1f97 LP	106	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);
718db961 LP	107	#endif
	108
	109	/* uid_t and friends on Linux 32 bit. This means we can just use the
	110	* default serializer for 32bit unsigned, for serializing it, and map
	111	* it to NULL here */
	112	assert_cc(sizeof(uid_t) == sizeof(uint32_t));
	113	#define bus_property_get_uid ((sd_bus_property_get_t) NULL)
	114
	115	assert_cc(sizeof(gid_t) == sizeof(uint32_t));
	116	#define bus_property_get_gid ((sd_bus_property_get_t) NULL)
	117
	118	assert_cc(sizeof(pid_t) == sizeof(uint32_t));
	119	#define bus_property_get_pid ((sd_bus_property_get_t) NULL)
	120
	121	assert_cc(sizeof(mode_t) == sizeof(uint32_t));
	122	#define bus_property_get_mode ((sd_bus_property_get_t) NULL)
e6504030	123
5b30bef8	124	int bus_log_parse_error(int r);
f459b602 MAP	125	int bus_log_create_error(int r);
f459b602 MAP	126
c3350683 LP	127	#define BUS_DEFINE_PROPERTY_GET_ENUM(function, name, type) \
	128	int function(sd_bus *bus, \
	129	const char *path, \
	130	const char *interface, \
	131	const char *property, \
	132	sd_bus_message *reply, \
ebcf1f97 LP	133	void *userdata, \
ebcf1f97 LP	134	sd_bus_error *error) { \
c3350683 LP	135	\
	136	const char *value; \
	137	type *field = userdata; \
	138	int r; \
	139	\
	140	assert(bus); \
	141	assert(reply); \
	142	assert(field); \
	143	\
	144	value = strempty(name##_to_string(*field)); \
	145	\
	146	r = sd_bus_message_append_basic(reply, 's', value); \
	147	if (r < 0) \
	148	return r; \
	149	\
	150	return 1; \
	151	} \
	152	struct __useless_struct_to_allow_trailing_semicolon__
	153
718db961	154	#define BUS_PROPERTY_DUAL_TIMESTAMP(name, offset, flags) \
edb5dd18 LP	155	SD_BUS_PROPERTY(name, "t", bus_property_get_usec, (offset) + offsetof(struct dual_timestamp, realtime), (flags)), \
edb5dd18 LP	156	SD_BUS_PROPERTY(name "Monotonic", "t", bus_property_get_usec, (offset) + offsetof(struct dual_timestamp, monotonic), (flags))
ebcf1f97	157
98a4c30b DH	158	int bus_path_encode_unique(sd_bus b, const char prefix, const char sender_id, const char external_id, char **ret_path);
98a4c30b DH	159	int bus_path_decode_unique(const char path, const char prefix, char ret_sender, char ret_external);
057171ef	160
c9d031c3	161	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);