]> git.ipfire.org Git - thirdparty/systemd.git/blame - src/libsystemd/sd-bus/bus-util.h
test: fix strtod test for real
[thirdparty/systemd.git] / src / libsystemd / sd-bus / bus-util.h
CommitLineData
40ca29a1
LP
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 "hashmap.h"
27#include "time-util.h"
28#include "util.h"
29
d21ed1ea
LP
30typedef enum BusTransport {
31 BUS_TRANSPORT_LOCAL,
32 BUS_TRANSPORT_REMOTE,
33 BUS_TRANSPORT_CONTAINER,
34 _BUS_TRANSPORT_MAX,
35 _BUS_TRANSPORT_INVALID = -1
36} BusTransport;
37
9f6eb1cd
KS
38typedef int (*bus_property_set_t) (sd_bus *bus, const char *member, sd_bus_message *m, sd_bus_error *error, void *userdata);
39
ffc06c35 40struct bus_properties_map {
9f6eb1cd
KS
41 const char *member;
42 const char *signature;
43 bus_property_set_t set;
44 size_t offset;
ffc06c35
KS
45};
46
9f6eb1cd
KS
47int bus_map_id128(sd_bus *bus, const char *member, sd_bus_message *m, sd_bus_error *error, void *userdata);
48
ffc06c35
KS
49int bus_map_all_properties(sd_bus *bus,
50 const char *destination,
51 const char *path,
9f6eb1cd
KS
52 const struct bus_properties_map *map,
53 void *userdata);
ffc06c35 54
6203e07a 55int bus_async_unregister_and_exit(sd_event *e, sd_bus *bus, const char *name);
40ca29a1 56
37224a5f
LP
57typedef bool (*check_idle_t)(void *userdata);
58
59int 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 60
5fd38859
DH
61int bus_name_has_owner(sd_bus *c, const char *name, sd_bus_error *error);
62
718db961 63int bus_check_peercred(sd_bus *c);
40ca29a1
LP
64
65int bus_verify_polkit(sd_bus *bus, sd_bus_message *m, const char *action, bool interactive, bool *_challenge, sd_bus_error *e);
66
67int bus_verify_polkit_async(sd_bus *bus, Hashmap **registry, sd_bus_message *m, const char *action, bool interactive, sd_bus_error *error, sd_bus_message_handler_t callback, void *userdata);
68void bus_verify_polkit_async_registry_free(sd_bus *bus, Hashmap *registry);
69
0f8bd8de 70int bus_open_system_systemd(sd_bus **_bus);
41dd15e4 71int bus_open_user_systemd(sd_bus **_bus);
a1da8583 72
d21ed1ea 73int bus_open_transport(BusTransport transport, const char *host, bool user, sd_bus **bus);
41dd15e4 74int bus_open_transport_systemd(BusTransport transport, const char *host, bool user, sd_bus **bus);
d21ed1ea 75
9f6eb1cd 76int bus_print_property(const char *name, sd_bus_message *property, bool all);
27e72d6b 77int bus_print_all_properties(sd_bus *bus, const char *dest, const char *path, char **filter, bool all);
0c842e0a 78
ebcf1f97 79int 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);
e6504030 80
718db961
LP
81#define bus_property_get_usec ((sd_bus_property_get_t) NULL)
82#define bus_property_set_usec ((sd_bus_property_set_t) NULL)
83
84assert_cc(sizeof(int) == sizeof(int32_t));
85#define bus_property_get_int ((sd_bus_property_get_t) NULL)
86
87assert_cc(sizeof(unsigned) == sizeof(unsigned));
88#define bus_property_get_unsigned ((sd_bus_property_get_t) NULL)
89
90/* On 64bit machines we can use the default serializer for size_t and
91 * friends, otherwise we need to cast this manually */
92#if __SIZEOF_SIZE_T__ == 8
93#define bus_property_get_size ((sd_bus_property_get_t) NULL)
94#else
ebcf1f97 95int 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
96#endif
97
98#if __SIZEOF_LONG__ == 8
99#define bus_property_get_long ((sd_bus_property_get_t) NULL)
100#define bus_property_get_ulong ((sd_bus_property_get_t) NULL)
101#else
ebcf1f97
LP
102int 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);
103int 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
104#endif
105
106/* uid_t and friends on Linux 32 bit. This means we can just use the
107 * default serializer for 32bit unsigned, for serializing it, and map
108 * it to NULL here */
109assert_cc(sizeof(uid_t) == sizeof(uint32_t));
110#define bus_property_get_uid ((sd_bus_property_get_t) NULL)
111
112assert_cc(sizeof(gid_t) == sizeof(uint32_t));
113#define bus_property_get_gid ((sd_bus_property_get_t) NULL)
114
115assert_cc(sizeof(pid_t) == sizeof(uint32_t));
116#define bus_property_get_pid ((sd_bus_property_get_t) NULL)
117
118assert_cc(sizeof(mode_t) == sizeof(uint32_t));
119#define bus_property_get_mode ((sd_bus_property_get_t) NULL)
e6504030 120
5b30bef8 121int bus_log_parse_error(int r);
f459b602
MAP
122int bus_log_create_error(int r);
123
124typedef struct UnitInfo {
1238ee09 125 const char *machine;
f459b602
MAP
126 const char *id;
127 const char *description;
128 const char *load_state;
129 const char *active_state;
130 const char *sub_state;
131 const char *following;
132 const char *unit_path;
133 uint32_t job_id;
134 const char *job_type;
135 const char *job_path;
136} UnitInfo;
137
138int bus_parse_unit_info(sd_bus_message *message, UnitInfo *u);
5b30bef8 139
24996861
LP
140static inline void sd_bus_close_unrefp(sd_bus **bus) {
141 if (*bus) {
142 sd_bus_flush(*bus);
143 sd_bus_close(*bus);
144 sd_bus_unref(*bus);
145 }
146}
147
40ca29a1 148DEFINE_TRIVIAL_CLEANUP_FUNC(sd_bus*, sd_bus_unref);
19befb2d 149DEFINE_TRIVIAL_CLEANUP_FUNC(sd_bus_slot*, sd_bus_slot_unref);
40ca29a1 150DEFINE_TRIVIAL_CLEANUP_FUNC(sd_bus_message*, sd_bus_message_unref);
5b12334d 151DEFINE_TRIVIAL_CLEANUP_FUNC(sd_bus_creds*, sd_bus_creds_unref);
19befb2d 152DEFINE_TRIVIAL_CLEANUP_FUNC(sd_bus_track*, sd_bus_track_unref);
40ca29a1
LP
153
154#define _cleanup_bus_unref_ _cleanup_(sd_bus_unrefp)
24996861 155#define _cleanup_bus_close_unref_ _cleanup_(sd_bus_close_unrefp)
19befb2d 156#define _cleanup_bus_slot_unref_ _cleanup_(sd_bus_slot_unrefp)
40ca29a1 157#define _cleanup_bus_message_unref_ _cleanup_(sd_bus_message_unrefp)
5b12334d 158#define _cleanup_bus_creds_unref_ _cleanup_(sd_bus_creds_unrefp)
19befb2d 159#define _cleanup_bus_track_unref_ _cleanup_(sd_bus_slot_unrefp)
c3350683
LP
160#define _cleanup_bus_error_free_ _cleanup_(sd_bus_error_free)
161
162#define BUS_DEFINE_PROPERTY_GET_ENUM(function, name, type) \
163 int function(sd_bus *bus, \
164 const char *path, \
165 const char *interface, \
166 const char *property, \
167 sd_bus_message *reply, \
ebcf1f97
LP
168 void *userdata, \
169 sd_bus_error *error) { \
c3350683
LP
170 \
171 const char *value; \
172 type *field = userdata; \
173 int r; \
174 \
175 assert(bus); \
176 assert(reply); \
177 assert(field); \
178 \
179 value = strempty(name##_to_string(*field)); \
180 \
181 r = sd_bus_message_append_basic(reply, 's', value); \
182 if (r < 0) \
183 return r; \
184 \
185 return 1; \
186 } \
187 struct __useless_struct_to_allow_trailing_semicolon__
188
718db961 189#define BUS_PROPERTY_DUAL_TIMESTAMP(name, offset, flags) \
edb5dd18
LP
190 SD_BUS_PROPERTY(name, "t", bus_property_get_usec, (offset) + offsetof(struct dual_timestamp, realtime), (flags)), \
191 SD_BUS_PROPERTY(name "Monotonic", "t", bus_property_get_usec, (offset) + offsetof(struct dual_timestamp, monotonic), (flags))
ebcf1f97
LP
192
193int bus_maybe_reply_error(sd_bus_message *m, int r, sd_bus_error *error);
df31a6c0
LP
194
195int bus_append_unit_property_assignment(sd_bus_message *m, const char *assignment);