]>
git.ipfire.org Git - thirdparty/systemd.git/blob - src/shared/bus-util.h
1 /* SPDX-License-Identifier: LGPL-2.1+ */
5 This file is part of systemd.
7 Copyright 2013 Lennart Poettering
13 #include <sys/types.h>
20 #include "string-util.h"
22 typedef enum BusTransport
{
25 BUS_TRANSPORT_MACHINE
,
27 _BUS_TRANSPORT_INVALID
= - 1
30 typedef int (* bus_property_set_t
) ( sd_bus
* bus
, const char * member
, sd_bus_message
* m
, sd_bus_error
* error
, void * userdata
);
32 struct bus_properties_map
{
34 const char * signature
;
35 bus_property_set_t set
;
40 BUS_MAP_STRDUP
= 1U << 0 , /* If set, each "s" message is duplicated. Thus, each pointer needs to be freed. */
41 BUS_MAP_BOOLEAN_AS_BOOL
= 1U << 1 , /* If set, each "b" message is written to a bool pointer. If not set, "b" is written to a int pointer. */
44 int bus_map_id128 ( sd_bus
* bus
, const char * member
, sd_bus_message
* m
, sd_bus_error
* error
, void * userdata
);
46 int bus_message_map_all_properties ( sd_bus_message
* m
, const struct bus_properties_map
* map
, unsigned flags
, sd_bus_error
* error
, void * userdata
);
47 int bus_message_map_properties_changed ( sd_bus_message
* m
, const struct bus_properties_map
* map
, unsigned flags
, sd_bus_error
* error
, void * userdata
);
48 int bus_map_all_properties ( sd_bus
* bus
, const char * destination
, const char * path
, const struct bus_properties_map
* map
,
49 unsigned flags
, sd_bus_error
* error
, sd_bus_message
** reply
, void * userdata
);
51 int bus_async_unregister_and_exit ( sd_event
* e
, sd_bus
* bus
, const char * name
);
53 typedef bool (* check_idle_t
)( void * userdata
);
55 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
);
57 int bus_name_has_owner ( sd_bus
* c
, const char * name
, sd_bus_error
* error
);
59 int bus_check_peercred ( sd_bus
* c
);
61 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
);
63 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
);
64 void bus_verify_polkit_async_registry_free ( Hashmap
* registry
);
66 int bus_connect_system_systemd ( sd_bus
** _bus
);
67 int bus_connect_user_systemd ( sd_bus
** _bus
);
69 int bus_connect_transport ( BusTransport transport
, const char * host
, bool user
, sd_bus
** bus
);
70 int bus_connect_transport_systemd ( BusTransport transport
, const char * host
, bool user
, sd_bus
** bus
);
72 typedef int (* bus_message_print_t
) ( const char * name
, sd_bus_message
* m
, bool value
, bool all
);
74 int bus_print_property ( const char * name
, sd_bus_message
* property
, bool value
, bool all
);
75 int bus_message_print_all_properties ( sd_bus_message
* m
, bus_message_print_t func
, char ** filter
, bool value
, bool all
, Set
** found_properties
);
76 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
);
78 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
);
79 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
);
80 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
);
82 #define bus_property_get_usec ((sd_bus_property_get_t) NULL)
83 #define bus_property_set_usec ((sd_bus_property_set_t) NULL)
85 assert_cc ( sizeof ( int ) == sizeof ( int32_t ));
86 #define bus_property_get_int ((sd_bus_property_get_t) NULL)
88 assert_cc ( sizeof ( unsigned ) == sizeof ( uint32_t ));
89 #define bus_property_get_unsigned ((sd_bus_property_get_t) NULL)
91 /* On 64bit machines we can use the default serializer for size_t and
92 * friends, otherwise we need to cast this manually */
93 #if __SIZEOF_SIZE_T__ == 8
94 #define bus_property_get_size ((sd_bus_property_get_t) NULL)
96 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
);
99 #if __SIZEOF_LONG__ == 8
100 #define bus_property_get_long ((sd_bus_property_get_t) NULL)
101 #define bus_property_get_ulong ((sd_bus_property_get_t) NULL)
103 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
);
104 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
);
107 /* uid_t and friends on Linux 32 bit. This means we can just use the
108 * default serializer for 32bit unsigned, for serializing it, and map
110 assert_cc ( sizeof ( uid_t
) == sizeof ( uint32_t ));
111 #define bus_property_get_uid ((sd_bus_property_get_t) NULL)
113 assert_cc ( sizeof ( gid_t
) == sizeof ( uint32_t ));
114 #define bus_property_get_gid ((sd_bus_property_get_t) NULL)
116 assert_cc ( sizeof ( pid_t
) == sizeof ( uint32_t ));
117 #define bus_property_get_pid ((sd_bus_property_get_t) NULL)
119 assert_cc ( sizeof ( mode_t
) == sizeof ( uint32_t ));
120 #define bus_property_get_mode ((sd_bus_property_get_t) NULL)
122 int bus_log_parse_error ( int r
);
123 int bus_log_create_error ( int r
);
125 #define BUS_DEFINE_PROPERTY_GET_GLOBAL(function, bus_type, val) \
126 int function(sd_bus *bus, \
128 const char *interface, \
129 const char *property, \
130 sd_bus_message *reply, \
132 sd_bus_error *error) { \
137 return sd_bus_message_append(reply, bus_type, val); \
140 #define BUS_DEFINE_PROPERTY_GET2(function, bus_type, data_type, get1, get2) \
141 int function(sd_bus *bus, \
143 const char *interface, \
144 const char *property, \
145 sd_bus_message *reply, \
147 sd_bus_error *error) { \
149 data_type *data = userdata; \
155 return sd_bus_message_append(reply, bus_type, \
160 #define BUS_DEFINE_PROPERTY_GET(function, bus_type, data_type, get1) \
161 BUS_DEFINE_PROPERTY_GET2(function, bus_type, data_type, get1, ident)
163 #define ref(x) (*(x))
164 #define BUS_DEFINE_PROPERTY_GET_REF(function, bus_type, data_type, get) \
165 BUS_DEFINE_PROPERTY_GET2(function, bus_type, data_type, ref, get)
167 #define BUS_DEFINE_PROPERTY_GET_ENUM(function, name, type) \
168 BUS_DEFINE_PROPERTY_GET_REF(function, "s" , type, name##_to_string)
170 #define BUS_PROPERTY_DUAL_TIMESTAMP(name, offset, flags) \
171 SD_BUS_PROPERTY(name, "t" , bus_property_get_usec, (offset) + offsetof(struct dual_timestamp, realtime), (flags)), \
172 SD_BUS_PROPERTY(name "Monotonic" , "t" , bus_property_get_usec, (offset) + offsetof(struct dual_timestamp, monotonic), (flags))
174 int bus_path_encode_unique ( sd_bus
* b
, const char * prefix
, const char * sender_id
, const char * external_id
, char ** ret_path
);
175 int bus_path_decode_unique ( const char * path
, const char * prefix
, char ** ret_sender
, char ** ret_external
);
177 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
);
179 int bus_track_add_name_many ( sd_bus_track
* t
, char ** l
);
181 int bus_open_system_watch_bind_with_description ( sd_bus
** ret
, const char * description
);
182 static inline int bus_open_system_watch_bind ( sd_bus
** ret
) {
183 return bus_open_system_watch_bind_with_description ( ret
, NULL
);
186 int bus_request_name_async_may_reload_dbus ( sd_bus
* bus
, sd_bus_slot
** ret_slot
, const char * name
, uint64_t flags
, void * userdata
);