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_user(sd_bus **ret);
 126 int sd_bus_open_system(sd_bus **ret);
 127 int sd_bus_open_system_remote(sd_bus **ret, const char *host);
 128 int sd_bus_open_system_machine(sd_bus **ret, const char *machine);
 129
 130 int sd_bus_new(sd_bus **ret);
 131
 132 int sd_bus_set_address(sd_bus *bus, const char *address);
 133 int sd_bus_set_fd(sd_bus *bus, int input_fd, int output_fd);
 134 int sd_bus_set_exec(sd_bus *bus, const char *path, char *const argv[]);
 135 int sd_bus_get_address(sd_bus *bus, const char **address);
 136 int sd_bus_set_bus_client(sd_bus *bus, int b);
 137 int sd_bus_is_bus_client(sd_bus *bus);
 138 int sd_bus_set_server(sd_bus *bus, int b, sd_id128_t bus_id);
 139 int sd_bus_is_server(sd_bus *bus);
 140 int sd_bus_set_anonymous(sd_bus *bus, int b);
 141 int sd_bus_is_anonymous(sd_bus *bus);
 142 int sd_bus_set_trusted(sd_bus *bus, int b);
 143 int sd_bus_is_trusted(sd_bus *bus);
 144 int sd_bus_set_monitor(sd_bus *bus, int b);
 145 int sd_bus_is_monitor(sd_bus *bus);
 146 int sd_bus_set_description(sd_bus *bus, const char *description);
 147 int sd_bus_get_description(sd_bus *bus, const char **description);
 148 int sd_bus_negotiate_creds(sd_bus *bus, int b, uint64_t creds_mask);
 149 int sd_bus_negotiate_timestamp(sd_bus *bus, int b);
 150 int sd_bus_negotiate_fds(sd_bus *bus, int b);
 151 int sd_bus_can_send(sd_bus *bus, char type);
 152 int sd_bus_get_creds_mask(sd_bus *bus, uint64_t *creds_mask);
 153 int sd_bus_set_allow_interactive_authorization(sd_bus *bus, int b);
 154 int sd_bus_get_allow_interactive_authorization(sd_bus *bus);
 155 int sd_bus_set_exit_on_disconnect(sd_bus *bus, int b);
 156 int sd_bus_get_exit_on_disconnect(sd_bus *bus);
 157 int sd_bus_set_watch_bind(sd_bus *bus, int b);
 158 int sd_bus_get_watch_bind(sd_bus *bus);
 159 int sd_bus_set_connected_signal(sd_bus *bus, int b);
 160 int sd_bus_get_connected_signal(sd_bus *bus);
 161 int sd_bus_set_sender(sd_bus *bus, const char *sender);
 162 int sd_bus_get_sender(sd_bus *bus, const char **ret);
 163
 164 int sd_bus_start(sd_bus *bus);
 165
 166 int sd_bus_try_close(sd_bus *bus);
 167 void sd_bus_close(sd_bus *bus);
 168
 169 sd_bus *sd_bus_ref(sd_bus *bus);
 170 sd_bus *sd_bus_unref(sd_bus *bus);
 171 sd_bus *sd_bus_flush_close_unref(sd_bus *bus);
 172
 173 void sd_bus_default_flush_close(void);
 174
 175 int sd_bus_is_open(sd_bus *bus);
 176 int sd_bus_is_ready(sd_bus *bus);
 177
 178 int sd_bus_get_bus_id(sd_bus *bus, sd_id128_t *id);
 179 int sd_bus_get_scope(sd_bus *bus, const char **scope);
 180 int sd_bus_get_tid(sd_bus *bus, pid_t *tid);
 181 int sd_bus_get_owner_creds(sd_bus *bus, uint64_t creds_mask, sd_bus_creds **ret);
 182
 183 int sd_bus_send(sd_bus *bus, sd_bus_message *m, uint64_t *cookie);
 184 int sd_bus_send_to(sd_bus *bus, sd_bus_message *m, const char *destination, uint64_t *cookie);
 185 int sd_bus_call(sd_bus *bus, sd_bus_message *m, uint64_t usec, sd_bus_error *ret_error, sd_bus_message **reply);
 186 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);
 187
 188 int sd_bus_get_fd(sd_bus *bus);
 189 int sd_bus_get_events(sd_bus *bus);
 190 int sd_bus_get_timeout(sd_bus *bus, uint64_t *timeout_usec);
 191 int sd_bus_process(sd_bus *bus, sd_bus_message **r);
 192 int sd_bus_process_priority(sd_bus *bus, int64_t max_priority, sd_bus_message **r);
 193 int sd_bus_wait(sd_bus *bus, uint64_t timeout_usec);
 194 int sd_bus_flush(sd_bus *bus);
 195
 196 sd_bus_slot* sd_bus_get_current_slot(sd_bus *bus);
 197 sd_bus_message* sd_bus_get_current_message(sd_bus *bus);
 198 sd_bus_message_handler_t sd_bus_get_current_handler(sd_bus *bus);
 199 void* sd_bus_get_current_userdata(sd_bus *bus);
 200
 201 int sd_bus_attach_event(sd_bus *bus, sd_event *e, int priority);
 202 int sd_bus_detach_event(sd_bus *bus);
 203 sd_event *sd_bus_get_event(sd_bus *bus);
 204
 205 int sd_bus_add_filter(sd_bus *bus, sd_bus_slot **slot, sd_bus_message_handler_t callback, void *userdata);
 206 int sd_bus_add_match(sd_bus *bus, sd_bus_slot **slot, const char *match, sd_bus_message_handler_t callback, void *userdata);
 207 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);
 208 int sd_bus_add_object(sd_bus *bus, sd_bus_slot **slot, const char *path, sd_bus_message_handler_t callback, void *userdata);
 209 int sd_bus_add_fallback(sd_bus *bus, sd_bus_slot **slot, const char *prefix, sd_bus_message_handler_t callback, void *userdata);
 210 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);
 211 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);
 212 int sd_bus_add_node_enumerator(sd_bus *bus, sd_bus_slot **slot, const char *path, sd_bus_node_enumerator_t callback, void *userdata);
 213 int sd_bus_add_object_manager(sd_bus *bus, sd_bus_slot **slot, const char *path);
 214
 215 /* Slot object */
 216
 217 sd_bus_slot* sd_bus_slot_ref(sd_bus_slot *slot);
 218 sd_bus_slot* sd_bus_slot_unref(sd_bus_slot *slot);
 219
 220 sd_bus* sd_bus_slot_get_bus(sd_bus_slot *slot);
 221 void *sd_bus_slot_get_userdata(sd_bus_slot *slot);
 222 void *sd_bus_slot_set_userdata(sd_bus_slot *slot, void *userdata);
 223 int sd_bus_slot_set_description(sd_bus_slot *slot, const char *description);
 224 int sd_bus_slot_get_description(sd_bus_slot *slot, const char **description);
 225
 226 sd_bus_message* sd_bus_slot_get_current_message(sd_bus_slot *slot);
 227 sd_bus_message_handler_t sd_bus_slot_get_current_handler(sd_bus_slot *bus);
 228 void *sd_bus_slot_get_current_userdata(sd_bus_slot *slot);
 229
 230 /* Message object */
 231
 232 int sd_bus_message_new(sd_bus *bus, sd_bus_message **m, uint8_t type);
 233 int sd_bus_message_new_signal(sd_bus *bus, sd_bus_message **m, const char *path, const char *interface, const char *member);
 234 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);
 235 int sd_bus_message_new_method_return(sd_bus_message *call, sd_bus_message **m);
 236 int sd_bus_message_new_method_error(sd_bus_message *call, sd_bus_message **m, const sd_bus_error *e);
 237 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);
 238 int sd_bus_message_new_method_errno(sd_bus_message *call, sd_bus_message **m, int error, const sd_bus_error *e);
 239 int sd_bus_message_new_method_errnof(sd_bus_message *call, sd_bus_message **m, int error, const char *format, ...) _sd_printf_(4, 5);
 240
 241 sd_bus_message* sd_bus_message_ref(sd_bus_message *m);
 242 sd_bus_message* sd_bus_message_unref(sd_bus_message *m);
 243
 244 int sd_bus_message_seal(sd_bus_message *m, uint64_t cookie, uint64_t timeout_usec);
 245
 246 int sd_bus_message_get_type(sd_bus_message *m, uint8_t *type);
 247 int sd_bus_message_get_cookie(sd_bus_message *m, uint64_t *cookie);
 248 int sd_bus_message_get_reply_cookie(sd_bus_message *m, uint64_t *cookie);
 249 int sd_bus_message_get_priority(sd_bus_message *m, int64_t *priority);
 250
 251 int sd_bus_message_get_expect_reply(sd_bus_message *m);
 252 int sd_bus_message_get_auto_start(sd_bus_message *m);
 253 int sd_bus_message_get_allow_interactive_authorization(sd_bus_message *m);
 254
 255 const char *sd_bus_message_get_signature(sd_bus_message *m, int complete);
 256 const char *sd_bus_message_get_path(sd_bus_message *m);
 257 const char *sd_bus_message_get_interface(sd_bus_message *m);
 258 const char *sd_bus_message_get_member(sd_bus_message *m);
 259 const char *sd_bus_message_get_destination(sd_bus_message *m);
 260 const char *sd_bus_message_get_sender(sd_bus_message *m);
 261 const sd_bus_error *sd_bus_message_get_error(sd_bus_message *m);
 262 int sd_bus_message_get_errno(sd_bus_message *m);
 263
 264 int sd_bus_message_get_monotonic_usec(sd_bus_message *m, uint64_t *usec);
 265 int sd_bus_message_get_realtime_usec(sd_bus_message *m, uint64_t *usec);
 266 int sd_bus_message_get_seqnum(sd_bus_message *m, uint64_t* seqnum);
 267
 268 sd_bus* sd_bus_message_get_bus(sd_bus_message *m);
 269 sd_bus_creds *sd_bus_message_get_creds(sd_bus_message *m); /* do not unref the result */
 270
 271 int sd_bus_message_is_signal(sd_bus_message *m, const char *interface, const char *member);
 272 int sd_bus_message_is_method_call(sd_bus_message *m, const char *interface, const char *member);
 273 int sd_bus_message_is_method_error(sd_bus_message *m, const char *name);
 274 int sd_bus_message_is_empty(sd_bus_message *m);
 275 int sd_bus_message_has_signature(sd_bus_message *m, const char *signature);
 276
 277 int sd_bus_message_set_expect_reply(sd_bus_message *m, int b);
 278 int sd_bus_message_set_auto_start(sd_bus_message *m, int b);
 279 int sd_bus_message_set_allow_interactive_authorization(sd_bus_message *m, int b);
 280
 281 int sd_bus_message_set_destination(sd_bus_message *m, const char *destination);
 282 int sd_bus_message_set_sender(sd_bus_message *m, const char *sender);
 283 int sd_bus_message_set_priority(sd_bus_message *m, int64_t priority);
 284
 285 int sd_bus_message_append(sd_bus_message *m, const char *types, ...);
 286 int sd_bus_message_appendv(sd_bus_message *m, const char *types, va_list ap);
 287 int sd_bus_message_append_basic(sd_bus_message *m, char type, const void *p);
 288 int sd_bus_message_append_array(sd_bus_message *m, char type, const void *ptr, size_t size);
 289 int sd_bus_message_append_array_space(sd_bus_message *m, char type, size_t size, void **ptr);
 290 int sd_bus_message_append_array_iovec(sd_bus_message *m, char type, const struct iovec *iov, unsigned n);
 291 int sd_bus_message_append_array_memfd(sd_bus_message *m, char type, int memfd, uint64_t offset, uint64_t size);
 292 int sd_bus_message_append_string_space(sd_bus_message *m, size_t size, char **s);
 293 int sd_bus_message_append_string_iovec(sd_bus_message *m, const struct iovec *iov, unsigned n);
 294 int sd_bus_message_append_string_memfd(sd_bus_message *m, int memfd, uint64_t offset, uint64_t size);
 295 int sd_bus_message_append_strv(sd_bus_message *m, char **l);
 296 int sd_bus_message_open_container(sd_bus_message *m, char type, const char *contents);
 297 int sd_bus_message_close_container(sd_bus_message *m);
 298 int sd_bus_message_copy(sd_bus_message *m, sd_bus_message *source, int all);
 299
 300 int sd_bus_message_read(sd_bus_message *m, const char *types, ...);
 301 int sd_bus_message_read_basic(sd_bus_message *m, char type, void *p);
 302 int sd_bus_message_read_array(sd_bus_message *m, char type, const void **ptr, size_t *size);
 303 int sd_bus_message_read_strv(sd_bus_message *m, char ***l); /* free the result! */
 304 int sd_bus_message_skip(sd_bus_message *m, const char *types);
 305 int sd_bus_message_enter_container(sd_bus_message *m, char type, const char *contents);
 306 int sd_bus_message_exit_container(sd_bus_message *m);
 307 int sd_bus_message_peek_type(sd_bus_message *m, char *type, const char **contents);
 308 int sd_bus_message_verify_type(sd_bus_message *m, char type, const char *contents);
 309 int sd_bus_message_at_end(sd_bus_message *m, int complete);
 310 int sd_bus_message_rewind(sd_bus_message *m, int complete);
 311
 312 /* Bus management */
 313
 314 int sd_bus_get_unique_name(sd_bus *bus, const char **unique);
 315 int sd_bus_request_name(sd_bus *bus, const char *name, uint64_t flags);
 316 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);
 317 int sd_bus_release_name(sd_bus *bus, const char *name);
 318 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);
 319 int sd_bus_list_names(sd_bus *bus, char ***acquired, char ***activatable); /* free the results */
 320 int sd_bus_get_name_creds(sd_bus *bus, const char *name, uint64_t mask, sd_bus_creds **creds); /* unref the result! */
 321 int sd_bus_get_name_machine_id(sd_bus *bus, const char *name, sd_id128_t *machine);
 322
 323 /* Convenience calls */
 324
 325 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, ...);
 326 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, ...);
 327 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);
 328 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);
 329 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! */
 330 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! */
 331 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, ...);
 332
 333 int sd_bus_reply_method_return(sd_bus_message *call, const char *types, ...);
 334 int sd_bus_reply_method_error(sd_bus_message *call, const sd_bus_error *e);
 335 int sd_bus_reply_method_errorf(sd_bus_message *call, const char *name, const char *format, ...) _sd_printf_(3, 4);
 336 int sd_bus_reply_method_errno(sd_bus_message *call, int error, const sd_bus_error *e);
 337 int sd_bus_reply_method_errnof(sd_bus_message *call, int error, const char *format, ...) _sd_printf_(3, 4);
 338
 339 int sd_bus_emit_signal(sd_bus *bus, const char *path, const char *interface, const char *member, const char *types, ...);
 340
 341 int sd_bus_emit_properties_changed_strv(sd_bus *bus, const char *path, const char *interface, char **names);
 342 int sd_bus_emit_properties_changed(sd_bus *bus, const char *path, const char *interface, const char *name, ...) _sd_sentinel_;
 343
 344 int sd_bus_emit_object_added(sd_bus *bus, const char *path);
 345 int sd_bus_emit_object_removed(sd_bus *bus, const char *path);
 346 int sd_bus_emit_interfaces_added_strv(sd_bus *bus, const char *path, char **interfaces);
 347 int sd_bus_emit_interfaces_added(sd_bus *bus, const char *path, const char *interface, ...) _sd_sentinel_;
 348 int sd_bus_emit_interfaces_removed_strv(sd_bus *bus, const char *path, char **interfaces);
 349 int sd_bus_emit_interfaces_removed(sd_bus *bus, const char *path, const char *interface, ...) _sd_sentinel_;
 350
 351 int sd_bus_query_sender_creds(sd_bus_message *call, uint64_t mask, sd_bus_creds **creds);
 352 int sd_bus_query_sender_privilege(sd_bus_message *call, int capability);
 353
 354 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);
 355 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);
 356
 357 /* Credential handling */
 358
 359 int sd_bus_creds_new_from_pid(sd_bus_creds **ret, pid_t pid, uint64_t creds_mask);
 360 sd_bus_creds *sd_bus_creds_ref(sd_bus_creds *c);
 361 sd_bus_creds *sd_bus_creds_unref(sd_bus_creds *c);
 362 uint64_t sd_bus_creds_get_mask(const sd_bus_creds *c);
 363 uint64_t sd_bus_creds_get_augmented_mask(const sd_bus_creds *c);
 364
 365 int sd_bus_creds_get_pid(sd_bus_creds *c, pid_t *pid);
 366 int sd_bus_creds_get_ppid(sd_bus_creds *c, pid_t *ppid);
 367 int sd_bus_creds_get_tid(sd_bus_creds *c, pid_t *tid);
 368 int sd_bus_creds_get_uid(sd_bus_creds *c, uid_t *uid);
 369 int sd_bus_creds_get_euid(sd_bus_creds *c, uid_t *euid);
 370 int sd_bus_creds_get_suid(sd_bus_creds *c, uid_t *suid);
 371 int sd_bus_creds_get_fsuid(sd_bus_creds *c, uid_t *fsuid);
 372 int sd_bus_creds_get_gid(sd_bus_creds *c, gid_t *gid);
 373 int sd_bus_creds_get_egid(sd_bus_creds *c, gid_t *egid);
 374 int sd_bus_creds_get_sgid(sd_bus_creds *c, gid_t *sgid);
 375 int sd_bus_creds_get_fsgid(sd_bus_creds *c, gid_t *fsgid);
 376 int sd_bus_creds_get_supplementary_gids(sd_bus_creds *c, const gid_t **gids);
 377 int sd_bus_creds_get_comm(sd_bus_creds *c, const char **comm);
 378 int sd_bus_creds_get_tid_comm(sd_bus_creds *c, const char **comm);
 379 int sd_bus_creds_get_exe(sd_bus_creds *c, const char **exe);
 380 int sd_bus_creds_get_cmdline(sd_bus_creds *c, char ***cmdline);
 381 int sd_bus_creds_get_cgroup(sd_bus_creds *c, const char **cgroup);
 382 #if 0 /** unsupported by elogind **/
 383 int sd_bus_creds_get_unit(sd_bus_creds *c, const char **unit);
 384 #endif /** 0 **/
 385 int sd_bus_creds_get_slice(sd_bus_creds *c, const char **slice);
 386 #if 0 /** UNNEEDED by elogind **/
 387 int sd_bus_creds_get_user_unit(sd_bus_creds *c, const char **unit);
 388 #endif /** 0 **/
 389 int sd_bus_creds_get_user_slice(sd_bus_creds *c, const char **slice);
 390 int sd_bus_creds_get_session(sd_bus_creds *c, const char **session);
 391 int sd_bus_creds_get_owner_uid(sd_bus_creds *c, uid_t *uid);
 392 int sd_bus_creds_has_effective_cap(sd_bus_creds *c, int capability);
 393 int sd_bus_creds_has_permitted_cap(sd_bus_creds *c, int capability);
 394 int sd_bus_creds_has_inheritable_cap(sd_bus_creds *c, int capability);
 395 int sd_bus_creds_has_bounding_cap(sd_bus_creds *c, int capability);
 396 int sd_bus_creds_get_selinux_context(sd_bus_creds *c, const char **context);
 397 int sd_bus_creds_get_audit_session_id(sd_bus_creds *c, uint32_t *sessionid);
 398 int sd_bus_creds_get_audit_login_uid(sd_bus_creds *c, uid_t *loginuid);
 399 int sd_bus_creds_get_tty(sd_bus_creds *c, const char **tty);
 400 int sd_bus_creds_get_unique_name(sd_bus_creds *c, const char **name);
 401 int sd_bus_creds_get_well_known_names(sd_bus_creds *c, char ***names);
 402 int sd_bus_creds_get_description(sd_bus_creds *c, const char **name);
 403
 404 /* Error structures */
 405
 406 #define SD_BUS_ERROR_MAKE_CONST(name, message) ((const sd_bus_error) {(name), (message), 0})
 407 #define SD_BUS_ERROR_NULL SD_BUS_ERROR_MAKE_CONST(NULL, NULL)
 408
 409 void sd_bus_error_free(sd_bus_error *e);
 410 int sd_bus_error_set(sd_bus_error *e, const char *name, const char *message);
 411 int sd_bus_error_setf(sd_bus_error *e, const char *name, const char *format, ...)  _sd_printf_(3, 4);
 412 int sd_bus_error_set_const(sd_bus_error *e, const char *name, const char *message);
 413 int sd_bus_error_set_errno(sd_bus_error *e, int error);
 414 int sd_bus_error_set_errnof(sd_bus_error *e, int error, const char *format, ...) _sd_printf_(3, 4);
 415 int sd_bus_error_set_errnofv(sd_bus_error *e, int error, const char *format, va_list ap) _sd_printf_(3,0);
 416 int sd_bus_error_get_errno(const sd_bus_error *e);
 417 int sd_bus_error_copy(sd_bus_error *dest, const sd_bus_error *e);
 418 int sd_bus_error_is_set(const sd_bus_error *e);
 419 int sd_bus_error_has_name(const sd_bus_error *e, const char *name);
 420
 421 #define SD_BUS_ERROR_MAP(_name, _code)          \
 422         {                                       \
 423                 .name = _name,                  \
 424                 .code = _code,                  \
 425         }
 426 #define SD_BUS_ERROR_MAP_END                    \
 427         {                                       \
 428                 .name = NULL,                   \
 429                 .code = - 'x',                  \
 430         }
 431
 432 int sd_bus_error_add_map(const sd_bus_error_map *map);
 433
 434 /* Auxiliary macros */
 435
 436 #define SD_BUS_MESSAGE_APPEND_ID128(x) 16,                              \
 437                 (x).bytes[0],  (x).bytes[1],  (x).bytes[2],  (x).bytes[3], \
 438                 (x).bytes[4],  (x).bytes[5],  (x).bytes[6],  (x).bytes[7], \
 439                 (x).bytes[8],  (x).bytes[9],  (x).bytes[10], (x).bytes[11], \
 440                 (x).bytes[12], (x).bytes[13], (x).bytes[14], (x).bytes[15]
 441
 442 #define SD_BUS_MESSAGE_READ_ID128(x) 16,                                \
 443                 &(x).bytes[0],  &(x).bytes[1],  &(x).bytes[2],  &(x).bytes[3], \
 444                 &(x).bytes[4],  &(x).bytes[5],  &(x).bytes[6],  &(x).bytes[7], \
 445                 &(x).bytes[8],  &(x).bytes[9],  &(x).bytes[10], &(x).bytes[11], \
 446                 &(x).bytes[12], &(x).bytes[13], &(x).bytes[14], &(x).bytes[15]
 447
 448 /* Label escaping */
 449
 450 int sd_bus_path_encode(const char *prefix, const char *external_id, char **ret_path);
 451 int sd_bus_path_encode_many(char **out, const char *path_template, ...);
 452 int sd_bus_path_decode(const char *path, const char *prefix, char **ret_external_id);
 453 int sd_bus_path_decode_many(const char *path, const char *path_template, ...);
 454
 455 /* Tracking peers */
 456
 457 int sd_bus_track_new(sd_bus *bus, sd_bus_track **track, sd_bus_track_handler_t handler, void *userdata);
 458 sd_bus_track* sd_bus_track_ref(sd_bus_track *track);
 459 sd_bus_track* sd_bus_track_unref(sd_bus_track *track);
 460
 461 sd_bus* sd_bus_track_get_bus(sd_bus_track *track);
 462 void *sd_bus_track_get_userdata(sd_bus_track *track);
 463 void *sd_bus_track_set_userdata(sd_bus_track *track, void *userdata);
 464
 465 int sd_bus_track_add_sender(sd_bus_track *track, sd_bus_message *m);
 466 int sd_bus_track_remove_sender(sd_bus_track *track, sd_bus_message *m);
 467 int sd_bus_track_add_name(sd_bus_track *track, const char *name);
 468 int sd_bus_track_remove_name(sd_bus_track *track, const char *name);
 469
 470 int sd_bus_track_set_recursive(sd_bus_track *track, int b);
 471 int sd_bus_track_get_recursive(sd_bus_track *track);
 472
 473 unsigned sd_bus_track_count(sd_bus_track *track);
 474 int sd_bus_track_count_sender(sd_bus_track *track, sd_bus_message *m);
 475 int sd_bus_track_count_name(sd_bus_track *track, const char *name);
 476
 477 const char* sd_bus_track_contains(sd_bus_track *track, const char *name);
 478 const char* sd_bus_track_first(sd_bus_track *track);
 479 const char* sd_bus_track_next(sd_bus_track *track);
 480
 481 /* Define helpers so that __attribute__((cleanup(sd_bus_unrefp))) and similar may be used. */
 482 _SD_DEFINE_POINTER_CLEANUP_FUNC(sd_bus, sd_bus_unref);
 483 _SD_DEFINE_POINTER_CLEANUP_FUNC(sd_bus, sd_bus_flush_close_unref);
 484 _SD_DEFINE_POINTER_CLEANUP_FUNC(sd_bus_slot, sd_bus_slot_unref);
 485 _SD_DEFINE_POINTER_CLEANUP_FUNC(sd_bus_message, sd_bus_message_unref);
 486 _SD_DEFINE_POINTER_CLEANUP_FUNC(sd_bus_creds, sd_bus_creds_unref);
 487 _SD_DEFINE_POINTER_CLEANUP_FUNC(sd_bus_track, sd_bus_track_unref);
 488
 489 _SD_END_DECLARATIONS;
 490
 491 #endif