src/systemd/sd-bus.h

   1 /* SPDX-License-Identifier: LGPL-2.1+ */
   2 #ifndef foosdbushfoo
   3 #define foosdbushfoo
   4
   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
  22 #include <inttypes.h>
  23 #include <stdarg.h>
  24 #include <sys/types.h>
  25 #include <sys/uio.h>
  26
  27 #include "sd-event.h"
  28 #include "sd-id128.h"
  29
  30 #include "_sd-common.h"
  31
  32 _SD_BEGIN_DECLARATIONS;
  33
  34 #define SD_BUS_DEFAULT ((sd_bus *) 1)
  35 #define SD_BUS_DEFAULT_USER ((sd_bus *) 2)
  36 #define SD_BUS_DEFAULT_SYSTEM ((sd_bus *) 3)
  37
  38 /* Types */
  39
  40 typedef struct sd_bus sd_bus;
  41 typedef struct sd_bus_message sd_bus_message;
  42 typedef struct sd_bus_slot sd_bus_slot;
  43 typedef struct sd_bus_creds sd_bus_creds;
  44 typedef struct sd_bus_track sd_bus_track;
  45
  46 typedef struct {
  47         const char *name;
  48         const char *message;
  49         int _need_free;
  50 } sd_bus_error;
  51
  52 typedef struct {
  53         const char* name;
  54         int code;
  55 } sd_bus_error_map;
  56
  57 /* Flags */
  58
  59 enum {
  60         SD_BUS_CREDS_PID                = 1ULL << 0,
  61         SD_BUS_CREDS_TID                = 1ULL << 1,
  62         SD_BUS_CREDS_PPID               = 1ULL << 2,
  63         SD_BUS_CREDS_UID                = 1ULL << 3,
  64         SD_BUS_CREDS_EUID               = 1ULL << 4,
  65         SD_BUS_CREDS_SUID               = 1ULL << 5,
  66         SD_BUS_CREDS_FSUID              = 1ULL << 6,
  67         SD_BUS_CREDS_GID                = 1ULL << 7,
  68         SD_BUS_CREDS_EGID               = 1ULL << 8,
  69         SD_BUS_CREDS_SGID               = 1ULL << 9,
  70         SD_BUS_CREDS_FSGID              = 1ULL << 10,
  71         SD_BUS_CREDS_SUPPLEMENTARY_GIDS = 1ULL << 11,
  72         SD_BUS_CREDS_COMM               = 1ULL << 12,
  73         SD_BUS_CREDS_TID_COMM           = 1ULL << 13,
  74         SD_BUS_CREDS_EXE                = 1ULL << 14,
  75         SD_BUS_CREDS_CMDLINE            = 1ULL << 15,
  76         SD_BUS_CREDS_CGROUP             = 1ULL << 16,
  77         SD_BUS_CREDS_UNIT               = 1ULL << 17,
  78         SD_BUS_CREDS_SLICE              = 1ULL << 18,
  79         SD_BUS_CREDS_USER_UNIT          = 1ULL << 19,
  80         SD_BUS_CREDS_USER_SLICE         = 1ULL << 20,
  81         SD_BUS_CREDS_SESSION            = 1ULL << 21,
  82         SD_BUS_CREDS_OWNER_UID          = 1ULL << 22,
  83         SD_BUS_CREDS_EFFECTIVE_CAPS     = 1ULL << 23,
  84         SD_BUS_CREDS_PERMITTED_CAPS     = 1ULL << 24,
  85         SD_BUS_CREDS_INHERITABLE_CAPS   = 1ULL << 25,
  86         SD_BUS_CREDS_BOUNDING_CAPS      = 1ULL << 26,
  87         SD_BUS_CREDS_SELINUX_CONTEXT    = 1ULL << 27,
  88         SD_BUS_CREDS_AUDIT_SESSION_ID   = 1ULL << 28,
  89         SD_BUS_CREDS_AUDIT_LOGIN_UID    = 1ULL << 29,
  90         SD_BUS_CREDS_TTY                = 1ULL << 30,
  91         SD_BUS_CREDS_UNIQUE_NAME        = 1ULL << 31,
  92         SD_BUS_CREDS_WELL_KNOWN_NAMES   = 1ULL << 32,
  93         SD_BUS_CREDS_DESCRIPTION        = 1ULL << 33,
  94         SD_BUS_CREDS_AUGMENT            = 1ULL << 63, /* special flag, if on sd-bus will augment creds struct, in a potentially race-full way. */
  95         _SD_BUS_CREDS_ALL               = (1ULL << 34) -1
  96 };
  97
  98 enum {
  99         SD_BUS_NAME_REPLACE_EXISTING  = 1ULL << 0,
 100         SD_BUS_NAME_ALLOW_REPLACEMENT = 1ULL << 1,
 101         SD_BUS_NAME_QUEUE             = 1ULL << 2
 102 };
 103
 104 /* Callbacks */
 105
 106 typedef int (*sd_bus_message_handler_t)(sd_bus_message *m, void *userdata, sd_bus_error *ret_error);
 107 typedef int (*sd_bus_property_get_t) (sd_bus *bus, const char *path, const char *interface, const char *property, sd_bus_message *reply, void *userdata, sd_bus_error *ret_error);
 108 typedef int (*sd_bus_property_set_t) (sd_bus *bus, const char *path, const char *interface, const char *property, sd_bus_message *value, void *userdata, sd_bus_error *ret_error);
 109 typedef int (*sd_bus_object_find_t) (sd_bus *bus, const char *path, const char *interface, void *userdata, void **ret_found, sd_bus_error *ret_error);
 110 typedef int (*sd_bus_node_enumerator_t) (sd_bus *bus, const char *prefix, void *userdata, char ***ret_nodes, sd_bus_error *ret_error);
 111 typedef int (*sd_bus_track_handler_t) (sd_bus_track *track, void *userdata);
 112 typedef void (*sd_bus_destroy_t)(void *userdata);
 113
 114 #include "sd-bus-protocol.h"
 115 #include "sd-bus-vtable.h"
 116
 117 /* Connections */
 118
 119 int sd_bus_default(sd_bus **ret);
 120 int sd_bus_default_user(sd_bus **ret);
 121 int sd_bus_default_system(sd_bus **ret);
 122
 123 int sd_bus_open(sd_bus **ret);
 124 int sd_bus_open_with_description(sd_bus **ret, const char *description);
 125 int sd_bus_open_user(sd_bus **ret);
 126 int sd_bus_open_user_with_description(sd_bus **ret, const char *description);
 127 int sd_bus_open_system(sd_bus **ret);
 128 int sd_bus_open_system_with_description(sd_bus **ret, const char *description);
 129 int sd_bus_open_system_remote(sd_bus **ret, const char *host);
 130 int sd_bus_open_system_machine(sd_bus **ret, const char *machine);
 131
 132 int sd_bus_new(sd_bus **ret);
 133
 134 int sd_bus_set_address(sd_bus *bus, const char *address);
 135 int sd_bus_set_fd(sd_bus *bus, int input_fd, int output_fd);
 136 int sd_bus_set_exec(sd_bus *bus, const char *path, char *const argv[]);
 137 int sd_bus_get_address(sd_bus *bus, const char **address);
 138 int sd_bus_set_bus_client(sd_bus *bus, int b);
 139 int sd_bus_is_bus_client(sd_bus *bus);
 140 int sd_bus_set_server(sd_bus *bus, int b, sd_id128_t bus_id);
 141 int sd_bus_is_server(sd_bus *bus);
 142 int sd_bus_set_anonymous(sd_bus *bus, int b);
 143 int sd_bus_is_anonymous(sd_bus *bus);
 144 int sd_bus_set_trusted(sd_bus *bus, int b);
 145 int sd_bus_is_trusted(sd_bus *bus);
 146 int sd_bus_set_monitor(sd_bus *bus, int b);
 147 int sd_bus_is_monitor(sd_bus *bus);
 148 int sd_bus_set_description(sd_bus *bus, const char *description);
 149 int sd_bus_get_description(sd_bus *bus, const char **description);
 150 int sd_bus_negotiate_creds(sd_bus *bus, int b, uint64_t creds_mask);
 151 int sd_bus_negotiate_timestamp(sd_bus *bus, int b);
 152 int sd_bus_negotiate_fds(sd_bus *bus, int b);
 153 int sd_bus_can_send(sd_bus *bus, char type);
 154 int sd_bus_get_creds_mask(sd_bus *bus, uint64_t *creds_mask);
 155 int sd_bus_set_allow_interactive_authorization(sd_bus *bus, int b);
 156 int sd_bus_get_allow_interactive_authorization(sd_bus *bus);
 157 int sd_bus_set_exit_on_disconnect(sd_bus *bus, int b);
 158 int sd_bus_get_exit_on_disconnect(sd_bus *bus);
 159 int sd_bus_set_watch_bind(sd_bus *bus, int b);
 160 int sd_bus_get_watch_bind(sd_bus *bus);
 161 int sd_bus_set_connected_signal(sd_bus *bus, int b);
 162 int sd_bus_get_connected_signal(sd_bus *bus);
 163 int sd_bus_set_sender(sd_bus *bus, const char *sender);
 164 int sd_bus_get_sender(sd_bus *bus, const char **ret);
 165
 166 int sd_bus_start(sd_bus *bus);
 167
 168 int sd_bus_try_close(sd_bus *bus);
 169 void sd_bus_close(sd_bus *bus);
 170
 171 sd_bus *sd_bus_ref(sd_bus *bus);
 172 sd_bus *sd_bus_unref(sd_bus *bus);
 173 sd_bus *sd_bus_flush_close_unref(sd_bus *bus);
 174
 175 void sd_bus_default_flush_close(void);
 176
 177 int sd_bus_is_open(sd_bus *bus);
 178 int sd_bus_is_ready(sd_bus *bus);
 179
 180 int sd_bus_get_bus_id(sd_bus *bus, sd_id128_t *id);
 181 int sd_bus_get_scope(sd_bus *bus, const char **scope);
 182 int sd_bus_get_tid(sd_bus *bus, pid_t *tid);
 183 int sd_bus_get_owner_creds(sd_bus *bus, uint64_t creds_mask, sd_bus_creds **ret);
 184
 185 int sd_bus_send(sd_bus *bus, sd_bus_message *m, uint64_t *cookie);
 186 int sd_bus_send_to(sd_bus *bus, sd_bus_message *m, const char *destination, uint64_t *cookie);
 187 int sd_bus_call(sd_bus *bus, sd_bus_message *m, uint64_t usec, sd_bus_error *ret_error, sd_bus_message **reply);
 188 int sd_bus_call_async(sd_bus *bus, sd_bus_slot **slot, sd_bus_message *m, sd_bus_message_handler_t callback, void *userdata, uint64_t usec);
 189
 190 int sd_bus_get_fd(sd_bus *bus);
 191 int sd_bus_get_events(sd_bus *bus);
 192 int sd_bus_get_timeout(sd_bus *bus, uint64_t *timeout_usec);
 193 int sd_bus_process(sd_bus *bus, sd_bus_message **r);
 194 int sd_bus_process_priority(sd_bus *bus, int64_t max_priority, sd_bus_message **r);
 195 int sd_bus_wait(sd_bus *bus, uint64_t timeout_usec);
 196 int sd_bus_flush(sd_bus *bus);
 197
 198 sd_bus_slot* sd_bus_get_current_slot(sd_bus *bus);
 199 sd_bus_message* sd_bus_get_current_message(sd_bus *bus);
 200 sd_bus_message_handler_t sd_bus_get_current_handler(sd_bus *bus);
 201 void* sd_bus_get_current_userdata(sd_bus *bus);
 202
 203 int sd_bus_attach_event(sd_bus *bus, sd_event *e, int priority);
 204 int sd_bus_detach_event(sd_bus *bus);
 205 sd_event *sd_bus_get_event(sd_bus *bus);
 206
 207 int sd_bus_get_n_queued_read(sd_bus *bus, uint64_t *ret);
 208 int sd_bus_get_n_queued_write(sd_bus *bus, uint64_t *ret);
 209
 210 int sd_bus_add_filter(sd_bus *bus, sd_bus_slot **slot, sd_bus_message_handler_t callback, void *userdata);
 211 int sd_bus_add_match(sd_bus *bus, sd_bus_slot **slot, const char *match, sd_bus_message_handler_t callback, void *userdata);
 212 int sd_bus_add_match_async(sd_bus *bus, sd_bus_slot **slot, const char *match, sd_bus_message_handler_t callback, sd_bus_message_handler_t install_callback, void *userdata);
 213 int sd_bus_add_object(sd_bus *bus, sd_bus_slot **slot, const char *path, sd_bus_message_handler_t callback, void *userdata);
 214 int sd_bus_add_fallback(sd_bus *bus, sd_bus_slot **slot, const char *prefix, sd_bus_message_handler_t callback, void *userdata);
 215 int sd_bus_add_object_vtable(sd_bus *bus, sd_bus_slot **slot, const char *path, const char *interface, const sd_bus_vtable *vtable, void *userdata);
 216 int sd_bus_add_fallback_vtable(sd_bus *bus, sd_bus_slot **slot, const char *prefix, const char *interface, const sd_bus_vtable *vtable, sd_bus_object_find_t find, void *userdata);
 217 int sd_bus_add_node_enumerator(sd_bus *bus, sd_bus_slot **slot, const char *path, sd_bus_node_enumerator_t callback, void *userdata);
 218 int sd_bus_add_object_manager(sd_bus *bus, sd_bus_slot **slot, const char *path);
 219
 220 /* Slot object */
 221
 222 sd_bus_slot* sd_bus_slot_ref(sd_bus_slot *slot);
 223 sd_bus_slot* sd_bus_slot_unref(sd_bus_slot *slot);
 224
 225 sd_bus* sd_bus_slot_get_bus(sd_bus_slot *slot);
 226 void *sd_bus_slot_get_userdata(sd_bus_slot *slot);
 227 void *sd_bus_slot_set_userdata(sd_bus_slot *slot, void *userdata);
 228 int sd_bus_slot_set_description(sd_bus_slot *slot, const char *description);
 229 int sd_bus_slot_get_description(sd_bus_slot *slot, const char **description);
 230 int sd_bus_slot_get_floating(sd_bus_slot *slot);
 231 int sd_bus_slot_set_floating(sd_bus_slot *slot, int b);
 232 int sd_bus_slot_set_destroy_callback(sd_bus_slot *s, sd_bus_destroy_t callback);
 233 int sd_bus_slot_get_destroy_callback(sd_bus_slot *s, sd_bus_destroy_t *callback);
 234
 235 sd_bus_message* sd_bus_slot_get_current_message(sd_bus_slot *slot);
 236 sd_bus_message_handler_t sd_bus_slot_get_current_handler(sd_bus_slot *bus);
 237 void *sd_bus_slot_get_current_userdata(sd_bus_slot *slot);
 238
 239 /* Message object */
 240
 241 int sd_bus_message_new(sd_bus *bus, sd_bus_message **m, uint8_t type);
 242 int sd_bus_message_new_signal(sd_bus *bus, sd_bus_message **m, const char *path, const char *interface, const char *member);
 243 int sd_bus_message_new_method_call(sd_bus *bus, sd_bus_message **m, const char *destination, const char *path, const char *interface, const char *member);
 244 int sd_bus_message_new_method_return(sd_bus_message *call, sd_bus_message **m);
 245 int sd_bus_message_new_method_error(sd_bus_message *call, sd_bus_message **m, const sd_bus_error *e);
 246 int sd_bus_message_new_method_errorf(sd_bus_message *call, sd_bus_message **m, const char *name, const char *format, ...) _sd_printf_(4, 5);
 247 int sd_bus_message_new_method_errno(sd_bus_message *call, sd_bus_message **m, int error, const sd_bus_error *e);
 248 int sd_bus_message_new_method_errnof(sd_bus_message *call, sd_bus_message **m, int error, const char *format, ...) _sd_printf_(4, 5);
 249
 250 sd_bus_message* sd_bus_message_ref(sd_bus_message *m);
 251 sd_bus_message* sd_bus_message_unref(sd_bus_message *m);
 252
 253 int sd_bus_message_seal(sd_bus_message *m, uint64_t cookie, uint64_t timeout_usec);
 254
 255 int sd_bus_message_get_type(sd_bus_message *m, uint8_t *type);
 256 int sd_bus_message_get_cookie(sd_bus_message *m, uint64_t *cookie);
 257 int sd_bus_message_get_reply_cookie(sd_bus_message *m, uint64_t *cookie);
 258 int sd_bus_message_get_priority(sd_bus_message *m, int64_t *priority);
 259
 260 int sd_bus_message_get_expect_reply(sd_bus_message *m);
 261 int sd_bus_message_get_auto_start(sd_bus_message *m);
 262 int sd_bus_message_get_allow_interactive_authorization(sd_bus_message *m);
 263
 264 const char *sd_bus_message_get_signature(sd_bus_message *m, int complete);
 265 const char *sd_bus_message_get_path(sd_bus_message *m);
 266 const char *sd_bus_message_get_interface(sd_bus_message *m);
 267 const char *sd_bus_message_get_member(sd_bus_message *m);
 268 const char *sd_bus_message_get_destination(sd_bus_message *m);
 269 const char *sd_bus_message_get_sender(sd_bus_message *m);
 270 const sd_bus_error *sd_bus_message_get_error(sd_bus_message *m);
 271 int sd_bus_message_get_errno(sd_bus_message *m);
 272
 273 int sd_bus_message_get_monotonic_usec(sd_bus_message *m, uint64_t *usec);
 274 int sd_bus_message_get_realtime_usec(sd_bus_message *m, uint64_t *usec);
 275 int sd_bus_message_get_seqnum(sd_bus_message *m, uint64_t* seqnum);
 276
 277 sd_bus* sd_bus_message_get_bus(sd_bus_message *m);
 278 sd_bus_creds *sd_bus_message_get_creds(sd_bus_message *m); /* do not unref the result */
 279
 280 int sd_bus_message_is_signal(sd_bus_message *m, const char *interface, const char *member);
 281 int sd_bus_message_is_method_call(sd_bus_message *m, const char *interface, const char *member);
 282 int sd_bus_message_is_method_error(sd_bus_message *m, const char *name);
 283 int sd_bus_message_is_empty(sd_bus_message *m);
 284 int sd_bus_message_has_signature(sd_bus_message *m, const char *signature);
 285
 286 int sd_bus_message_set_expect_reply(sd_bus_message *m, int b);
 287 int sd_bus_message_set_auto_start(sd_bus_message *m, int b);
 288 int sd_bus_message_set_allow_interactive_authorization(sd_bus_message *m, int b);
 289
 290 int sd_bus_message_set_destination(sd_bus_message *m, const char *destination);
 291 int sd_bus_message_set_sender(sd_bus_message *m, const char *sender);
 292 int sd_bus_message_set_priority(sd_bus_message *m, int64_t priority);
 293
 294 int sd_bus_message_append(sd_bus_message *m, const char *types, ...);
 295 int sd_bus_message_appendv(sd_bus_message *m, const char *types, va_list ap);
 296 int sd_bus_message_append_basic(sd_bus_message *m, char type, const void *p);
 297 int sd_bus_message_append_array(sd_bus_message *m, char type, const void *ptr, size_t size);
 298 int sd_bus_message_append_array_space(sd_bus_message *m, char type, size_t size, void **ptr);
 299 int sd_bus_message_append_array_iovec(sd_bus_message *m, char type, const struct iovec *iov, unsigned n);
 300 int sd_bus_message_append_array_memfd(sd_bus_message *m, char type, int memfd, uint64_t offset, uint64_t size);
 301 int sd_bus_message_append_string_space(sd_bus_message *m, size_t size, char **s);
 302 int sd_bus_message_append_string_iovec(sd_bus_message *m, const struct iovec *iov, unsigned n);
 303 int sd_bus_message_append_string_memfd(sd_bus_message *m, int memfd, uint64_t offset, uint64_t size);
 304 int sd_bus_message_append_strv(sd_bus_message *m, char **l);
 305 int sd_bus_message_open_container(sd_bus_message *m, char type, const char *contents);
 306 int sd_bus_message_close_container(sd_bus_message *m);
 307 int sd_bus_message_copy(sd_bus_message *m, sd_bus_message *source, int all);
 308
 309 int sd_bus_message_read(sd_bus_message *m, const char *types, ...);
 310 int sd_bus_message_read_basic(sd_bus_message *m, char type, void *p);
 311 int sd_bus_message_read_array(sd_bus_message *m, char type, const void **ptr, size_t *size);
 312 int sd_bus_message_read_strv(sd_bus_message *m, char ***l); /* free the result! */
 313 int sd_bus_message_skip(sd_bus_message *m, const char *types);
 314 int sd_bus_message_enter_container(sd_bus_message *m, char type, const char *contents);
 315 int sd_bus_message_exit_container(sd_bus_message *m);
 316 int sd_bus_message_peek_type(sd_bus_message *m, char *type, const char **contents);
 317 int sd_bus_message_verify_type(sd_bus_message *m, char type, const char *contents);
 318 int sd_bus_message_at_end(sd_bus_message *m, int complete);
 319 int sd_bus_message_rewind(sd_bus_message *m, int complete);
 320
 321 /* Bus management */
 322
 323 int sd_bus_get_unique_name(sd_bus *bus, const char **unique);
 324 int sd_bus_request_name(sd_bus *bus, const char *name, uint64_t flags);
 325 int sd_bus_request_name_async(sd_bus *bus, sd_bus_slot **ret_slot, const char *name, uint64_t flags, sd_bus_message_handler_t callback, void *userdata);
 326 int sd_bus_release_name(sd_bus *bus, const char *name);
 327 int sd_bus_release_name_async(sd_bus *bus, sd_bus_slot **ret_slot, const char *name, sd_bus_message_handler_t callback, void *userdata);
 328 int sd_bus_list_names(sd_bus *bus, char ***acquired, char ***activatable); /* free the results */
 329 int sd_bus_get_name_creds(sd_bus *bus, const char *name, uint64_t mask, sd_bus_creds **creds); /* unref the result! */
 330 int sd_bus_get_name_machine_id(sd_bus *bus, const char *name, sd_id128_t *machine);
 331
 332 /* Convenience calls */
 333
 334 int sd_bus_call_method(sd_bus *bus, const char *destination, const char *path, const char *interface, const char *member, sd_bus_error *ret_error, sd_bus_message **reply, const char *types, ...);
 335 int sd_bus_call_method_async(sd_bus *bus, sd_bus_slot **slot, const char *destination, const char *path, const char *interface, const char *member, sd_bus_message_handler_t callback, void *userdata, const char *types, ...);
 336 int sd_bus_get_property(sd_bus *bus, const char *destination, const char *path, const char *interface, const char *member, sd_bus_error *ret_error, sd_bus_message **reply, const char *type);
 337 int sd_bus_get_property_trivial(sd_bus *bus, const char *destination, const char *path, const char *interface, const char *member, sd_bus_error *ret_error, char type, void *ret_ptr);
 338 int sd_bus_get_property_string(sd_bus *bus, const char *destination, const char *path, const char *interface, const char *member, sd_bus_error *ret_error, char **ret); /* free the result! */
 339 int sd_bus_get_property_strv(sd_bus *bus, const char *destination, const char *path, const char *interface, const char *member, sd_bus_error *ret_error, char ***ret); /* free the result! */
 340 int sd_bus_set_property(sd_bus *bus, const char *destination, const char *path, const char *interface, const char *member, sd_bus_error *ret_error, const char *type, ...);
 341
 342 int sd_bus_reply_method_return(sd_bus_message *call, const char *types, ...);
 343 int sd_bus_reply_method_error(sd_bus_message *call, const sd_bus_error *e);
 344 int sd_bus_reply_method_errorf(sd_bus_message *call, const char *name, const char *format, ...) _sd_printf_(3, 4);
 345 int sd_bus_reply_method_errno(sd_bus_message *call, int error, const sd_bus_error *e);
 346 int sd_bus_reply_method_errnof(sd_bus_message *call, int error, const char *format, ...) _sd_printf_(3, 4);
 347
 348 int sd_bus_emit_signal(sd_bus *bus, const char *path, const char *interface, const char *member, const char *types, ...);
 349
 350 int sd_bus_emit_properties_changed_strv(sd_bus *bus, const char *path, const char *interface, char **names);
 351 int sd_bus_emit_properties_changed(sd_bus *bus, const char *path, const char *interface, const char *name, ...) _sd_sentinel_;
 352
 353 int sd_bus_emit_object_added(sd_bus *bus, const char *path);
 354 int sd_bus_emit_object_removed(sd_bus *bus, const char *path);
 355 int sd_bus_emit_interfaces_added_strv(sd_bus *bus, const char *path, char **interfaces);
 356 int sd_bus_emit_interfaces_added(sd_bus *bus, const char *path, const char *interface, ...) _sd_sentinel_;
 357 int sd_bus_emit_interfaces_removed_strv(sd_bus *bus, const char *path, char **interfaces);
 358 int sd_bus_emit_interfaces_removed(sd_bus *bus, const char *path, const char *interface, ...) _sd_sentinel_;
 359
 360 int sd_bus_query_sender_creds(sd_bus_message *call, uint64_t mask, sd_bus_creds **creds);
 361 int sd_bus_query_sender_privilege(sd_bus_message *call, int capability);
 362
 363 int sd_bus_match_signal(sd_bus *bus, sd_bus_slot **ret, const char *sender, const char *path, const char *interface, const char *member, sd_bus_message_handler_t callback, void *userdata);
 364 int sd_bus_match_signal_async(sd_bus *bus, sd_bus_slot **ret, const char *sender, const char *path, const char *interface, const char *member, sd_bus_message_handler_t match_callback, sd_bus_message_handler_t add_callback, void *userdata);
 365
 366 /* Credential handling */
 367
 368 int sd_bus_creds_new_from_pid(sd_bus_creds **ret, pid_t pid, uint64_t creds_mask);
 369 sd_bus_creds *sd_bus_creds_ref(sd_bus_creds *c);
 370 sd_bus_creds *sd_bus_creds_unref(sd_bus_creds *c);
 371 uint64_t sd_bus_creds_get_mask(const sd_bus_creds *c);
 372 uint64_t sd_bus_creds_get_augmented_mask(const sd_bus_creds *c);
 373
 374 int sd_bus_creds_get_pid(sd_bus_creds *c, pid_t *pid);
 375 int sd_bus_creds_get_ppid(sd_bus_creds *c, pid_t *ppid);
 376 int sd_bus_creds_get_tid(sd_bus_creds *c, pid_t *tid);
 377 int sd_bus_creds_get_uid(sd_bus_creds *c, uid_t *uid);
 378 int sd_bus_creds_get_euid(sd_bus_creds *c, uid_t *euid);
 379 int sd_bus_creds_get_suid(sd_bus_creds *c, uid_t *suid);
 380 int sd_bus_creds_get_fsuid(sd_bus_creds *c, uid_t *fsuid);
 381 int sd_bus_creds_get_gid(sd_bus_creds *c, gid_t *gid);
 382 int sd_bus_creds_get_egid(sd_bus_creds *c, gid_t *egid);
 383 int sd_bus_creds_get_sgid(sd_bus_creds *c, gid_t *sgid);
 384 int sd_bus_creds_get_fsgid(sd_bus_creds *c, gid_t *fsgid);
 385 int sd_bus_creds_get_supplementary_gids(sd_bus_creds *c, const gid_t **gids);
 386 int sd_bus_creds_get_comm(sd_bus_creds *c, const char **comm);
 387 int sd_bus_creds_get_tid_comm(sd_bus_creds *c, const char **comm);
 388 int sd_bus_creds_get_exe(sd_bus_creds *c, const char **exe);
 389 int sd_bus_creds_get_cmdline(sd_bus_creds *c, char ***cmdline);
 390 int sd_bus_creds_get_cgroup(sd_bus_creds *c, const char **cgroup);
 391 #if 0 /** unsupported by elogind **/
 392 int sd_bus_creds_get_unit(sd_bus_creds *c, const char **unit);
 393 #endif /** 0 **/
 394 int sd_bus_creds_get_slice(sd_bus_creds *c, const char **slice);
 395 #if 0 /** UNNEEDED by elogind **/
 396 int sd_bus_creds_get_user_unit(sd_bus_creds *c, const char **unit);
 397 #endif /** 0 **/
 398 int sd_bus_creds_get_user_slice(sd_bus_creds *c, const char **slice);
 399 int sd_bus_creds_get_session(sd_bus_creds *c, const char **session);
 400 int sd_bus_creds_get_owner_uid(sd_bus_creds *c, uid_t *uid);
 401 int sd_bus_creds_has_effective_cap(sd_bus_creds *c, int capability);
 402 int sd_bus_creds_has_permitted_cap(sd_bus_creds *c, int capability);
 403 int sd_bus_creds_has_inheritable_cap(sd_bus_creds *c, int capability);
 404 int sd_bus_creds_has_bounding_cap(sd_bus_creds *c, int capability);
 405 int sd_bus_creds_get_selinux_context(sd_bus_creds *c, const char **context);
 406 int sd_bus_creds_get_audit_session_id(sd_bus_creds *c, uint32_t *sessionid);
 407 int sd_bus_creds_get_audit_login_uid(sd_bus_creds *c, uid_t *loginuid);
 408 int sd_bus_creds_get_tty(sd_bus_creds *c, const char **tty);
 409 int sd_bus_creds_get_unique_name(sd_bus_creds *c, const char **name);
 410 int sd_bus_creds_get_well_known_names(sd_bus_creds *c, char ***names);
 411 int sd_bus_creds_get_description(sd_bus_creds *c, const char **name);
 412
 413 /* Error structures */
 414
 415 #define SD_BUS_ERROR_MAKE_CONST(name, message) ((const sd_bus_error) {(name), (message), 0})
 416 #define SD_BUS_ERROR_NULL SD_BUS_ERROR_MAKE_CONST(NULL, NULL)
 417
 418 void sd_bus_error_free(sd_bus_error *e);
 419 int sd_bus_error_set(sd_bus_error *e, const char *name, const char *message);
 420 int sd_bus_error_setf(sd_bus_error *e, const char *name, const char *format, ...)  _sd_printf_(3, 4);
 421 int sd_bus_error_set_const(sd_bus_error *e, const char *name, const char *message);
 422 int sd_bus_error_set_errno(sd_bus_error *e, int error);
 423 int sd_bus_error_set_errnof(sd_bus_error *e, int error, const char *format, ...) _sd_printf_(3, 4);
 424 int sd_bus_error_set_errnofv(sd_bus_error *e, int error, const char *format, va_list ap) _sd_printf_(3,0);
 425 int sd_bus_error_get_errno(const sd_bus_error *e);
 426 int sd_bus_error_copy(sd_bus_error *dest, const sd_bus_error *e);
 427 int sd_bus_error_is_set(const sd_bus_error *e);
 428 int sd_bus_error_has_name(const sd_bus_error *e, const char *name);
 429
 430 #define SD_BUS_ERROR_MAP(_name, _code)          \
 431         {                                       \
 432                 .name = _name,                  \
 433                 .code = _code,                  \
 434         }
 435 #define SD_BUS_ERROR_MAP_END                    \
 436         {                                       \
 437                 .name = NULL,                   \
 438                 .code = - 'x',                  \
 439         }
 440
 441 int sd_bus_error_add_map(const sd_bus_error_map *map);
 442
 443 /* Auxiliary macros */
 444
 445 #define SD_BUS_MESSAGE_APPEND_ID128(x) 16,                              \
 446                 (x).bytes[0],  (x).bytes[1],  (x).bytes[2],  (x).bytes[3], \
 447                 (x).bytes[4],  (x).bytes[5],  (x).bytes[6],  (x).bytes[7], \
 448                 (x).bytes[8],  (x).bytes[9],  (x).bytes[10], (x).bytes[11], \
 449                 (x).bytes[12], (x).bytes[13], (x).bytes[14], (x).bytes[15]
 450
 451 #define SD_BUS_MESSAGE_READ_ID128(x) 16,                                \
 452                 &(x).bytes[0],  &(x).bytes[1],  &(x).bytes[2],  &(x).bytes[3], \
 453                 &(x).bytes[4],  &(x).bytes[5],  &(x).bytes[6],  &(x).bytes[7], \
 454                 &(x).bytes[8],  &(x).bytes[9],  &(x).bytes[10], &(x).bytes[11], \
 455                 &(x).bytes[12], &(x).bytes[13], &(x).bytes[14], &(x).bytes[15]
 456
 457 /* Label escaping */
 458
 459 int sd_bus_path_encode(const char *prefix, const char *external_id, char **ret_path);
 460 int sd_bus_path_encode_many(char **out, const char *path_template, ...);
 461 int sd_bus_path_decode(const char *path, const char *prefix, char **ret_external_id);
 462 int sd_bus_path_decode_many(const char *path, const char *path_template, ...);
 463
 464 /* Tracking peers */
 465
 466 int sd_bus_track_new(sd_bus *bus, sd_bus_track **track, sd_bus_track_handler_t handler, void *userdata);
 467 sd_bus_track* sd_bus_track_ref(sd_bus_track *track);
 468 sd_bus_track* sd_bus_track_unref(sd_bus_track *track);
 469
 470 sd_bus* sd_bus_track_get_bus(sd_bus_track *track);
 471 void *sd_bus_track_get_userdata(sd_bus_track *track);
 472 void *sd_bus_track_set_userdata(sd_bus_track *track, void *userdata);
 473
 474 int sd_bus_track_add_sender(sd_bus_track *track, sd_bus_message *m);
 475 int sd_bus_track_remove_sender(sd_bus_track *track, sd_bus_message *m);
 476 int sd_bus_track_add_name(sd_bus_track *track, const char *name);
 477 int sd_bus_track_remove_name(sd_bus_track *track, const char *name);
 478
 479 int sd_bus_track_set_recursive(sd_bus_track *track, int b);
 480 int sd_bus_track_get_recursive(sd_bus_track *track);
 481
 482 unsigned sd_bus_track_count(sd_bus_track *track);
 483 int sd_bus_track_count_sender(sd_bus_track *track, sd_bus_message *m);
 484 int sd_bus_track_count_name(sd_bus_track *track, const char *name);
 485
 486 const char* sd_bus_track_contains(sd_bus_track *track, const char *name);
 487 const char* sd_bus_track_first(sd_bus_track *track);
 488 const char* sd_bus_track_next(sd_bus_track *track);
 489
 490 int sd_bus_track_set_destroy_callback(sd_bus_track *s, sd_bus_destroy_t callback);
 491 int sd_bus_track_get_destroy_callback(sd_bus_track *s, sd_bus_destroy_t *ret);
 492
 493 /* Define helpers so that __attribute__((cleanup(sd_bus_unrefp))) and similar may be used. */
 494 _SD_DEFINE_POINTER_CLEANUP_FUNC(sd_bus, sd_bus_unref);
 495 _SD_DEFINE_POINTER_CLEANUP_FUNC(sd_bus, sd_bus_flush_close_unref);
 496 _SD_DEFINE_POINTER_CLEANUP_FUNC(sd_bus_slot, sd_bus_slot_unref);
 497 _SD_DEFINE_POINTER_CLEANUP_FUNC(sd_bus_message, sd_bus_message_unref);
 498 _SD_DEFINE_POINTER_CLEANUP_FUNC(sd_bus_creds, sd_bus_creds_unref);
 499 _SD_DEFINE_POINTER_CLEANUP_FUNC(sd_bus_track, sd_bus_track_unref);
 500
 501 _SD_END_DECLARATIONS;
 502
 503 #endif