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