]>
git.ipfire.org Git - thirdparty/systemd.git/blob - src/shared/bus-util.h
1 /* SPDX-License-Identifier: LGPL-2.1+ */
14 #include "string-util.h"
16 typedef enum BusTransport
{
19 BUS_TRANSPORT_MACHINE
,
21 _BUS_TRANSPORT_INVALID
= - 1
24 typedef int (* bus_property_set_t
) ( sd_bus
* bus
, const char * member
, sd_bus_message
* m
, sd_bus_error
* error
, void * userdata
);
26 struct bus_properties_map
{
28 const char * signature
;
29 bus_property_set_t set
;
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. */
38 int bus_map_id128 ( sd_bus
* bus
, const char * member
, sd_bus_message
* m
, sd_bus_error
* error
, void * userdata
);
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
);
41 int bus_map_all_properties ( sd_bus
* bus
, const char * destination
, const char * path
, const struct bus_properties_map
* map
,
42 unsigned flags
, sd_bus_error
* error
, sd_bus_message
** reply
, void * userdata
);
44 int bus_async_unregister_and_exit ( sd_event
* e
, sd_bus
* bus
, const char * name
);
46 typedef bool (* check_idle_t
)( void * userdata
);
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
);
50 int bus_name_has_owner ( sd_bus
* c
, const char * name
, sd_bus_error
* error
);
52 int bus_check_peercred ( sd_bus
* c
);
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
);
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
);
57 void bus_verify_polkit_async_registry_free ( Hashmap
* registry
);
59 int bus_connect_system_systemd ( sd_bus
** _bus
);
60 int bus_connect_user_systemd ( sd_bus
** _bus
);
62 int bus_connect_transport ( BusTransport transport
, const char * host
, bool user
, sd_bus
** bus
);
63 int bus_connect_transport_systemd ( BusTransport transport
, const char * host
, bool user
, sd_bus
** bus
);
65 typedef int (* bus_message_print_t
) ( const char * name
, const char * expected_value
, sd_bus_message
* m
, bool value
, bool all
);
67 int bus_print_property_value ( const char * name
, const char * expected_value
, bool only_value
, const char * value
);
68 int bus_print_property_valuef ( const char * name
, const char * expected_value
, bool only_value
, const char * fmt
, ...) _printf_ ( 4 , 5 );
69 int bus_message_print_all_properties ( sd_bus_message
* m
, bus_message_print_t func
, char ** filter
, bool value
, bool all
, Set
** found_properties
);
70 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
);
72 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
);
73 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
);
74 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
);
76 #define bus_property_get_usec ((sd_bus_property_get_t) NULL)
77 #define bus_property_set_usec ((sd_bus_property_set_t) NULL)
79 assert_cc ( sizeof ( int ) == sizeof ( int32_t ));
80 #define bus_property_get_int ((sd_bus_property_get_t) NULL)
82 assert_cc ( sizeof ( unsigned ) == sizeof ( uint32_t ));
83 #define bus_property_get_unsigned ((sd_bus_property_get_t) NULL)
85 /* On 64bit machines we can use the default serializer for size_t and
86 * friends, otherwise we need to cast this manually */
87 #if __SIZEOF_SIZE_T__ == 8
88 #define bus_property_get_size ((sd_bus_property_get_t) NULL)
90 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
);
93 #if __SIZEOF_LONG__ == 8
94 #define bus_property_get_long ((sd_bus_property_get_t) NULL)
95 #define bus_property_get_ulong ((sd_bus_property_get_t) NULL)
97 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
);
98 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
);
101 /* uid_t and friends on Linux 32 bit. This means we can just use the
102 * default serializer for 32bit unsigned, for serializing it, and map
104 assert_cc ( sizeof ( uid_t
) == sizeof ( uint32_t ));
105 #define bus_property_get_uid ((sd_bus_property_get_t) NULL)
107 assert_cc ( sizeof ( gid_t
) == sizeof ( uint32_t ));
108 #define bus_property_get_gid ((sd_bus_property_get_t) NULL)
110 assert_cc ( sizeof ( pid_t
) == sizeof ( uint32_t ));
111 #define bus_property_get_pid ((sd_bus_property_get_t) NULL)
113 assert_cc ( sizeof ( mode_t
) == sizeof ( uint32_t ));
114 #define bus_property_get_mode ((sd_bus_property_get_t) NULL)
116 int bus_log_parse_error ( int r
);
117 int bus_log_create_error ( int r
);
119 #define BUS_DEFINE_PROPERTY_GET_GLOBAL(function, bus_type, val) \
120 int function(sd_bus *bus, \
122 const char *interface, \
123 const char *property, \
124 sd_bus_message *reply, \
126 sd_bus_error *error) { \
131 return sd_bus_message_append(reply, bus_type, val); \
134 #define BUS_DEFINE_PROPERTY_GET2(function, bus_type, data_type, get1, get2) \
135 int function(sd_bus *bus, \
137 const char *interface, \
138 const char *property, \
139 sd_bus_message *reply, \
141 sd_bus_error *error) { \
143 data_type *data = userdata; \
149 return sd_bus_message_append(reply, bus_type, \
154 #define BUS_DEFINE_PROPERTY_GET(function, bus_type, data_type, get1) \
155 BUS_DEFINE_PROPERTY_GET2(function, bus_type, data_type, get1, ident)
157 #define ref(x) (*(x))
158 #define BUS_DEFINE_PROPERTY_GET_REF(function, bus_type, data_type, get) \
159 BUS_DEFINE_PROPERTY_GET2(function, bus_type, data_type, ref, get)
161 #define BUS_DEFINE_PROPERTY_GET_ENUM(function, name, type) \
162 BUS_DEFINE_PROPERTY_GET_REF(function, "s" , type, name##_to_string)
164 #define BUS_PROPERTY_DUAL_TIMESTAMP(name, offset, flags) \
165 SD_BUS_PROPERTY(name, "t" , bus_property_get_usec, (offset) + offsetof(struct dual_timestamp, realtime), (flags)), \
166 SD_BUS_PROPERTY(name "Monotonic" , "t" , bus_property_get_usec, (offset) + offsetof(struct dual_timestamp, monotonic), (flags))
168 int bus_path_encode_unique ( sd_bus
* b
, const char * prefix
, const char * sender_id
, const char * external_id
, char ** ret_path
);
169 int bus_path_decode_unique ( const char * path
, const char * prefix
, char ** ret_sender
, char ** ret_external
);
171 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
);
173 int bus_track_add_name_many ( sd_bus_track
* t
, char ** l
);
175 int bus_open_system_watch_bind_with_description ( sd_bus
** ret
, const char * description
);
176 static inline int bus_open_system_watch_bind ( sd_bus
** ret
) {
177 return bus_open_system_watch_bind_with_description ( ret
, NULL
);
180 int bus_reply_pair_array ( sd_bus_message
* m
, char ** l
);