src/systemd/sd-bus.h

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