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