]> git.ipfire.org Git - thirdparty/systemd.git/blob - src/shared/bus-util.h
sd-bus: do not connect to dbus-1 socket when kdbus is available
[thirdparty/systemd.git] / src / shared / bus-util.h
1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
2
3 #pragma once
4
5 /***
6 This file is part of systemd.
7
8 Copyright 2013 Lennart Poettering
9
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.
14
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.
19
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/>.
22 ***/
23
24 #include "sd-event.h"
25 #include "sd-bus.h"
26 #include "bus-error.h"
27 #include "bus-internal.h"
28 #include "hashmap.h"
29 #include "install.h"
30 #include "time-util.h"
31
32 typedef int (*bus_property_set_t) (sd_bus *bus, const char *member, sd_bus_message *m, sd_bus_error *error, void *userdata);
33
34 struct bus_properties_map {
35 const char *member;
36 const char *signature;
37 bus_property_set_t set;
38 size_t offset;
39 };
40
41 int bus_map_id128(sd_bus *bus, const char *member, sd_bus_message *m, sd_bus_error *error, void *userdata);
42
43 int bus_message_map_all_properties(sd_bus_message *m, const struct bus_properties_map *map, void *userdata);
44 int bus_message_map_properties_changed(sd_bus_message *m, const struct bus_properties_map *map, void *userdata);
45 int bus_map_all_properties(sd_bus *bus, const char *destination, const char *path, const struct bus_properties_map *map, void *userdata);
46
47 int bus_async_unregister_and_exit(sd_event *e, sd_bus *bus, const char *name);
48
49 typedef bool (*check_idle_t)(void *userdata);
50
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);
52
53 int bus_name_has_owner(sd_bus *c, const char *name, sd_bus_error *error);
54
55 int bus_check_peercred(sd_bus *c);
56
57 int bus_test_polkit(sd_bus_message *call, int capability, const char *action, uid_t good_user, bool *_challenge, sd_bus_error *e);
58
59 int bus_verify_polkit_async(sd_bus_message *call, int capability, const char *action, bool interactive, uid_t good_user, Hashmap **registry, sd_bus_error *error);
60 void bus_verify_polkit_async_registry_free(Hashmap *registry);
61
62 int bus_open_system_systemd(sd_bus **_bus);
63 int bus_open_user_systemd(sd_bus **_bus);
64
65 int bus_open_transport(BusTransport transport, const char *host, bool user, sd_bus **bus);
66 int bus_open_transport_systemd(BusTransport transport, const char *host, bool user, sd_bus **bus);
67
68 int bus_print_property(const char *name, sd_bus_message *property, bool all);
69 int bus_print_all_properties(sd_bus *bus, const char *dest, const char *path, char **filter, bool all);
70
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);
72
73 #define bus_property_get_usec ((sd_bus_property_get_t) NULL)
74 #define bus_property_set_usec ((sd_bus_property_set_t) NULL)
75
76 assert_cc(sizeof(int) == sizeof(int32_t));
77 #define bus_property_get_int ((sd_bus_property_get_t) NULL)
78
79 assert_cc(sizeof(unsigned) == sizeof(unsigned));
80 #define bus_property_get_unsigned ((sd_bus_property_get_t) NULL)
81
82 /* On 64bit machines we can use the default serializer for size_t and
83 * friends, otherwise we need to cast this manually */
84 #if __SIZEOF_SIZE_T__ == 8
85 #define bus_property_get_size ((sd_bus_property_get_t) NULL)
86 #else
87 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);
88 #endif
89
90 #if __SIZEOF_LONG__ == 8
91 #define bus_property_get_long ((sd_bus_property_get_t) NULL)
92 #define bus_property_get_ulong ((sd_bus_property_get_t) NULL)
93 #else
94 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);
95 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);
96 #endif
97
98 /* uid_t and friends on Linux 32 bit. This means we can just use the
99 * default serializer for 32bit unsigned, for serializing it, and map
100 * it to NULL here */
101 assert_cc(sizeof(uid_t) == sizeof(uint32_t));
102 #define bus_property_get_uid ((sd_bus_property_get_t) NULL)
103
104 assert_cc(sizeof(gid_t) == sizeof(uint32_t));
105 #define bus_property_get_gid ((sd_bus_property_get_t) NULL)
106
107 assert_cc(sizeof(pid_t) == sizeof(uint32_t));
108 #define bus_property_get_pid ((sd_bus_property_get_t) NULL)
109
110 assert_cc(sizeof(mode_t) == sizeof(uint32_t));
111 #define bus_property_get_mode ((sd_bus_property_get_t) NULL)
112
113 int bus_log_parse_error(int r);
114 int bus_log_create_error(int r);
115
116 typedef struct UnitInfo {
117 const char *machine;
118 const char *id;
119 const char *description;
120 const char *load_state;
121 const char *active_state;
122 const char *sub_state;
123 const char *following;
124 const char *unit_path;
125 uint32_t job_id;
126 const char *job_type;
127 const char *job_path;
128 } UnitInfo;
129
130 int bus_parse_unit_info(sd_bus_message *message, UnitInfo *u);
131
132 #define BUS_DEFINE_PROPERTY_GET_ENUM(function, name, type) \
133 int function(sd_bus *bus, \
134 const char *path, \
135 const char *interface, \
136 const char *property, \
137 sd_bus_message *reply, \
138 void *userdata, \
139 sd_bus_error *error) { \
140 \
141 const char *value; \
142 type *field = userdata; \
143 int r; \
144 \
145 assert(bus); \
146 assert(reply); \
147 assert(field); \
148 \
149 value = strempty(name##_to_string(*field)); \
150 \
151 r = sd_bus_message_append_basic(reply, 's', value); \
152 if (r < 0) \
153 return r; \
154 \
155 return 1; \
156 } \
157 struct __useless_struct_to_allow_trailing_semicolon__
158
159 #define BUS_PROPERTY_DUAL_TIMESTAMP(name, offset, flags) \
160 SD_BUS_PROPERTY(name, "t", bus_property_get_usec, (offset) + offsetof(struct dual_timestamp, realtime), (flags)), \
161 SD_BUS_PROPERTY(name "Monotonic", "t", bus_property_get_usec, (offset) + offsetof(struct dual_timestamp, monotonic), (flags))
162
163 int bus_append_unit_property_assignment(sd_bus_message *m, const char *assignment);
164
165 typedef struct BusWaitForJobs BusWaitForJobs;
166
167 int bus_wait_for_jobs_new(sd_bus *bus, BusWaitForJobs **ret);
168 void bus_wait_for_jobs_free(BusWaitForJobs *d);
169 int bus_wait_for_jobs_add(BusWaitForJobs *d, const char *path);
170 int bus_wait_for_jobs(BusWaitForJobs *d, bool quiet);
171 int bus_wait_for_jobs_one(BusWaitForJobs *d, const char *path, bool quiet);
172
173 DEFINE_TRIVIAL_CLEANUP_FUNC(BusWaitForJobs*, bus_wait_for_jobs_free);
174
175 int bus_deserialize_and_dump_unit_file_changes(sd_bus_message *m, bool quiet, UnitFileChange **changes, unsigned *n_changes);
176
177 int bus_path_encode_unique(sd_bus *b, const char *prefix, const char *sender_id, const char *external_id, char **ret_path);
178 int bus_path_decode_unique(const char *path, const char *prefix, char **ret_sender, char **ret_external);