src/systemd/sd-bus.h

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