src/systemd/sd-bus.h

   1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
   2
   3 #ifndef foosdbushfoo
   4 #define foosdbushfoo
   5
   6 /***
   7   This file is part of systemd.
   8
   9   Copyright 2013 Lennart Poettering
  10
  11   systemd is free software; you can redistribute it and/or modify it
  12   under the terms of the GNU Lesser General Public License as published by
  13   the Free Software Foundation; either version 2.1 of the License, or
  14   (at your option) any later version.
  15
  16   systemd is distributed in the hope that it will be useful, but
  17   WITHOUT ANY WARRANTY; without even the implied warranty of
  18   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  19   Lesser General Public License for more details.
  20
  21   You should have received a copy of the GNU Lesser General Public License
  22   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  23 ***/
  24
  25 #include <inttypes.h>
  26 #include <sys/types.h>
  27 #include <sys/uio.h>
  28
  29 #include "sd-id128.h"
  30 #include "sd-event.h"
  31 #include "sd-memfd.h"
  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
  41 typedef struct {
  42         const char *name;
  43         const char *message;
  44         int need_free;
  45 } sd_bus_error;
  46
  47 /* Callbacks */
  48
  49 typedef int (*sd_bus_message_handler_t)(sd_bus *bus, sd_bus_message *m, void *userdata, sd_bus_error *ret_error);
  50 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);
  51 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);
  52 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);
  53 typedef int (*sd_bus_node_enumerator_t) (sd_bus *bus, const char *path, void *userdata, char ***ret_nodes, sd_bus_error *ret_error);
  54
  55 #include "sd-bus-protocol.h"
  56 #include "sd-bus-vtable.h"
  57
  58 /* Connections */
  59
  60 int sd_bus_default_user(sd_bus **ret);
  61 int sd_bus_default_system(sd_bus **ret);
  62
  63 int sd_bus_open_user(sd_bus **ret);
  64 int sd_bus_open_system(sd_bus **ret);
  65 int sd_bus_open_system_remote(const char *host, sd_bus **ret);
  66 int sd_bus_open_system_container(const char *machine, sd_bus **ret);
  67
  68 int sd_bus_new(sd_bus **ret);
  69 int sd_bus_set_address(sd_bus *bus, const char *address);
  70 int sd_bus_set_fd(sd_bus *bus, int input_fd, int output_fd);
  71 int sd_bus_set_exec(sd_bus *bus, const char *path, char *const argv[]);
  72 int sd_bus_set_bus_client(sd_bus *bus, int b);
  73 int sd_bus_set_server(sd_bus *bus, int b, sd_id128_t server_id);
  74 int sd_bus_set_anonymous(sd_bus *bus, int b);
  75 int sd_bus_negotiate_fds(sd_bus *bus, int b);
  76 int sd_bus_negotiate_attach_timestamp(sd_bus *bus, int b);
  77 int sd_bus_negotiate_attach_creds(sd_bus *bus, int b);
  78 int sd_bus_negotiate_attach_comm(sd_bus *bus, int b);
  79 int sd_bus_negotiate_attach_exe(sd_bus *bus, int b);
  80 int sd_bus_negotiate_attach_cmdline(sd_bus *bus, int b);
  81 int sd_bus_negotiate_attach_cgroup(sd_bus *bus, int b);
  82 int sd_bus_negotiate_attach_caps(sd_bus *bus, int b);
  83 int sd_bus_negotiate_attach_selinux_context(sd_bus *bus, int b);
  84 int sd_bus_negotiate_attach_audit(sd_bus *bus, int b);
  85 int sd_bus_start(sd_bus *ret);
  86
  87 void sd_bus_close(sd_bus *bus);
  88
  89 sd_bus *sd_bus_ref(sd_bus *bus);
  90 sd_bus *sd_bus_unref(sd_bus *bus);
  91
  92 int sd_bus_is_open(sd_bus *bus);
  93 int sd_bus_can_send(sd_bus *bus, char type);
  94 int sd_bus_get_server_id(sd_bus *bus, sd_id128_t *peer);
  95
  96 int sd_bus_send(sd_bus *bus, sd_bus_message *m, uint64_t *serial);
  97 int sd_bus_send_to(sd_bus *bus, sd_bus_message *m, const char *destination, uint64_t *serial);
  98 int sd_bus_call(sd_bus *bus, sd_bus_message *m, uint64_t usec, sd_bus_error *ret_error, sd_bus_message **reply);
  99 int sd_bus_call_async(sd_bus *bus, sd_bus_message *m, sd_bus_message_handler_t callback, void *userdata, uint64_t usec, uint64_t *serial);
 100 int sd_bus_call_async_cancel(sd_bus *bus, uint64_t serial);
 101
 102 int sd_bus_get_fd(sd_bus *bus);
 103 int sd_bus_get_events(sd_bus *bus);
 104 int sd_bus_get_timeout(sd_bus *bus, uint64_t *timeout_usec);
 105 int sd_bus_process(sd_bus *bus, sd_bus_message **r);
 106 int sd_bus_wait(sd_bus *bus, uint64_t timeout_usec);
 107 int sd_bus_flush(sd_bus *bus);
 108
 109 sd_bus_message* sd_bus_get_current(sd_bus *bus);
 110 int sd_bus_get_tid(sd_bus *bus, pid_t *tid);
 111
 112 int sd_bus_attach_event(sd_bus *bus, sd_event *e, int priority);
 113 int sd_bus_detach_event(sd_bus *bus);
 114 sd_event *sd_bus_get_event(sd_bus *bus);
 115
 116 int sd_bus_add_filter(sd_bus *bus, sd_bus_message_handler_t callback, void *userdata);
 117 int sd_bus_remove_filter(sd_bus *bus, sd_bus_message_handler_t callback, void *userdata);
 118
 119 int sd_bus_add_match(sd_bus *bus, const char *match, sd_bus_message_handler_t callback, void *userdata);
 120 int sd_bus_remove_match(sd_bus *bus, const char *match, sd_bus_message_handler_t callback, void *userdata);
 121
 122 int sd_bus_add_object(sd_bus *bus, const char *path, sd_bus_message_handler_t callback, void *userdata);
 123 int sd_bus_remove_object(sd_bus *bus, const char *path, sd_bus_message_handler_t callback, void *userdata);
 124
 125 int sd_bus_add_fallback(sd_bus *bus, const char *prefix, sd_bus_message_handler_t callback, void *userdata);
 126 int sd_bus_remove_fallback(sd_bus *bus, const char *prefix, sd_bus_message_handler_t callback, void *userdata);
 127
 128 int sd_bus_add_object_vtable(sd_bus *bus, const char *path, const char *interface, const sd_bus_vtable *vtable, void *userdata);
 129 int sd_bus_remove_object_vtable(sd_bus *bus, const char *path, const char *interface, const sd_bus_vtable *vtable, void *userdata);
 130
 131 int sd_bus_add_fallback_vtable(sd_bus *bus, const char *path, const char *interface, const sd_bus_vtable *vtable, sd_bus_object_find_t find, void *userdata);
 132 int sd_bus_remove_fallback_vtable(sd_bus *bus, const char *path, const char *interface, const sd_bus_vtable *vtable, sd_bus_object_find_t find, void *userdata);
 133
 134 int sd_bus_add_node_enumerator(sd_bus *bus, const char *path, sd_bus_node_enumerator_t callback, void *userdata);
 135 int sd_bus_remove_node_enumerator(sd_bus *bus, const char *path, sd_bus_node_enumerator_t callback, void *userdata);
 136
 137 int sd_bus_add_object_manager(sd_bus *bus, const char *path);
 138 int sd_bus_remove_object_manager(sd_bus *bus, const char *path);
 139
 140 /* Message object */
 141 int sd_bus_message_new_signal(sd_bus *bus, const char *path, const char *interface, const char *member, sd_bus_message **m);
 142 int sd_bus_message_new_method_call(sd_bus *bus, const char *destination, const char *path, const char *interface, const char *member, sd_bus_message **m);
 143 int sd_bus_message_new_method_return(sd_bus_message *call, sd_bus_message **m);
 144 int sd_bus_message_new_method_error(sd_bus_message *call, const sd_bus_error *e, sd_bus_message **m);
 145 int sd_bus_message_new_method_errorf(sd_bus_message *call, sd_bus_message **m, const char *name, const char *format, ...) _sd_printf_(4, 0);
 146 int sd_bus_message_new_method_errno(sd_bus_message *call, int error, const sd_bus_error *e, sd_bus_message **m);
 147 int sd_bus_message_new_method_errnof(sd_bus_message *call, sd_bus_message **m, int error, const char *format, ...) _sd_printf_(4, 0);
 148
 149 sd_bus_message* sd_bus_message_ref(sd_bus_message *m);
 150 sd_bus_message* sd_bus_message_unref(sd_bus_message *m);
 151
 152 int sd_bus_message_get_type(sd_bus_message *m, uint8_t *type);
 153 int sd_bus_message_get_serial(sd_bus_message *m, uint64_t *serial);
 154 int sd_bus_message_get_reply_serial(sd_bus_message *m, uint64_t *serial);
 155 int sd_bus_message_get_no_reply(sd_bus_message *m);
 156 int sd_bus_message_get_no_auto_start(sd_bus_message *m);
 157
 158 const char *sd_bus_message_get_signature(sd_bus_message *m, int complete);
 159 const char *sd_bus_message_get_path(sd_bus_message *m);
 160 const char *sd_bus_message_get_interface(sd_bus_message *m);
 161 const char *sd_bus_message_get_member(sd_bus_message *m);
 162 const char *sd_bus_message_get_destination(sd_bus_message *m);
 163 const char *sd_bus_message_get_sender(sd_bus_message *m);
 164 const sd_bus_error *sd_bus_message_get_error(sd_bus_message *m);
 165 int sd_bus_message_get_errno(sd_bus_message *m);
 166
 167 sd_bus* sd_bus_message_get_bus(sd_bus_message *m);
 168
 169 int sd_bus_message_get_monotonic_timestamp(sd_bus_message *m, uint64_t *usec);
 170 int sd_bus_message_get_realtime_timestamp(sd_bus_message *m, uint64_t *usec);
 171 int sd_bus_message_get_uid(sd_bus_message *m, uid_t *uid);
 172 int sd_bus_message_get_gid(sd_bus_message *m, gid_t *gid);
 173 int sd_bus_message_get_pid(sd_bus_message *m, pid_t *pid);
 174 int sd_bus_message_get_tid(sd_bus_message *m, pid_t *tid);
 175 int sd_bus_message_get_pid_starttime(sd_bus_message *m, uint64_t *usec);
 176 int sd_bus_message_get_selinux_context(sd_bus_message *m, const char **r);
 177 int sd_bus_message_get_comm(sd_bus_message *m, const char **r);
 178 int sd_bus_message_get_tid_comm(sd_bus_message *m, const char **r);
 179 int sd_bus_message_get_exe(sd_bus_message *m, const char **r);
 180 int sd_bus_message_get_cgroup(sd_bus_message *m, const char **r);
 181 int sd_bus_message_get_cmdline(sd_bus_message *m, char ***cmdline);
 182 int sd_bus_message_get_unit(sd_bus_message *m, const char **unit);
 183 int sd_bus_message_get_user_unit(sd_bus_message *m, const char **unit);
 184 int sd_bus_message_get_session(sd_bus_message *m, const char **session);
 185 int sd_bus_message_get_owner_uid(sd_bus_message *m, uid_t *uid);
 186 int sd_bus_message_get_audit_sessionid(sd_bus_message *m, uint32_t *sessionid);
 187 int sd_bus_message_get_audit_loginuid(sd_bus_message *m, uid_t *loginuid);
 188 int sd_bus_message_has_effective_cap(sd_bus_message *m, int capability);
 189
 190 int sd_bus_message_is_signal(sd_bus_message *m, const char *interface, const char *member);
 191 int sd_bus_message_is_method_call(sd_bus_message *m, const char *interface, const char *member);
 192 int sd_bus_message_is_method_error(sd_bus_message *m, const char *name);
 193
 194 int sd_bus_message_set_no_reply(sd_bus_message *m, int b);
 195 int sd_bus_message_set_no_auto_start(sd_bus_message *m, int b);
 196 int sd_bus_message_set_destination(sd_bus_message *m, const char *destination);
 197
 198 int sd_bus_message_append(sd_bus_message *m, const char *types, ...);
 199 int sd_bus_message_append_basic(sd_bus_message *m, char type, const void *p);
 200 int sd_bus_message_append_array(sd_bus_message *m, char type, const void *ptr, size_t size);
 201 int sd_bus_message_append_array_space(sd_bus_message *m, char type, size_t size, void **ptr);
 202 int sd_bus_message_append_array_iovec(sd_bus_message *m, char type, const struct iovec *iov, unsigned n);
 203 int sd_bus_message_append_array_memfd(sd_bus_message *m, char type, sd_memfd *memfd);
 204 int sd_bus_message_append_string_space(sd_bus_message *m, size_t size, char **s);
 205 int sd_bus_message_append_string_iovec(sd_bus_message *m, const struct iovec *iov, unsigned n);
 206 int sd_bus_message_append_string_memfd(sd_bus_message *m, sd_memfd* memfd);
 207 int sd_bus_message_append_strv(sd_bus_message *m, char **l);
 208 int sd_bus_message_open_container(sd_bus_message *m, char type, const char *contents);
 209 int sd_bus_message_close_container(sd_bus_message *m);
 210 int sd_bus_message_copy(sd_bus_message *m, sd_bus_message *source, int all);
 211
 212 int sd_bus_message_read(sd_bus_message *m, const char *types, ...);
 213 int sd_bus_message_read_basic(sd_bus_message *m, char type, void *p);
 214 int sd_bus_message_read_array(sd_bus_message *m, char type, const void **ptr, size_t *size);
 215 int sd_bus_message_read_strv(sd_bus_message *m, char ***l); /* free the result! */
 216 int sd_bus_message_skip(sd_bus_message *m, const char *types);
 217 int sd_bus_message_enter_container(sd_bus_message *m, char type, const char *contents);
 218 int sd_bus_message_exit_container(sd_bus_message *m);
 219 int sd_bus_message_peek_type(sd_bus_message *m, char *type, const char **contents);
 220 int sd_bus_message_verify_type(sd_bus_message *m, char type, const char *contents);
 221 int sd_bus_message_at_end(sd_bus_message *m, int complete);
 222 int sd_bus_message_rewind(sd_bus_message *m, int complete);
 223
 224 /* Convenience calls */
 225
 226 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, ...);
 227 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);
 228 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);
 229 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! */
 230 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! */
 231 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 *ret_type, ...);
 232
 233 int sd_bus_reply_method_return(sd_bus_message *call, const char *types, ...);
 234 int sd_bus_reply_method_error(sd_bus_message *call, const sd_bus_error *e);
 235 int sd_bus_reply_method_errorf(sd_bus_message *call, const char *name, const char *format, ...) _sd_printf_(3, 0);
 236 int sd_bus_reply_method_errno(sd_bus_message *call, int error, const sd_bus_error *e);
 237 int sd_bus_reply_method_errnof(sd_bus_message *call, int error, const char *format, ...) _sd_printf_(3, 0);
 238
 239 int sd_bus_emit_signal(sd_bus *bus, const char *path, const char *interface, const char *member, const char *types, ...);
 240
 241 int sd_bus_emit_properties_changed_strv(sd_bus *bus, const char *path, const char *interface, char **names);
 242 int sd_bus_emit_properties_changed(sd_bus *bus, const char *path, const char *interface, const char *name, ...) _sd_sentinel_;
 243
 244 int sd_bus_emit_interfaces_added_strv(sd_bus *bus, const char *path, char **interfaces);
 245 int sd_bus_emit_interfaces_added(sd_bus *bus, const char *path, const char *interface, ...) _sd_sentinel_;
 246 int sd_bus_emit_interfaces_removed_strv(sd_bus *bus, const char *path, char **interfaces);
 247 int sd_bus_emit_interfaces_removed(sd_bus *bus, const char *path, const char *interface, ...) _sd_sentinel_;
 248
 249 /* Bus management */
 250
 251 int sd_bus_get_unique_name(sd_bus *bus, const char **unique);
 252 int sd_bus_request_name(sd_bus *bus, const char *name, int flags);
 253 int sd_bus_release_name(sd_bus *bus, const char *name);
 254 int sd_bus_list_names(sd_bus *bus, char ***l);
 255 int sd_bus_get_owner(sd_bus *bus, const char *name, char **owner); /* free the result! */
 256 int sd_bus_get_owner_uid(sd_bus *bus, const char *name, uid_t *uid);
 257 int sd_bus_get_owner_pid(sd_bus *bus, const char *name, pid_t *pid);
 258 int sd_bus_get_owner_machine_id(sd_bus *bus, const char *name, sd_id128_t *machine);
 259
 260 /* Error structures */
 261
 262 #define SD_BUS_ERROR_MAKE_CONST(name, message) ((sd_bus_error) {(name), (message), 0})
 263 #define SD_BUS_ERROR_NULL SD_BUS_ERROR_MAKE_CONST(NULL, NULL)
 264
 265 void sd_bus_error_free(sd_bus_error *e);
 266 int sd_bus_error_set(sd_bus_error *e, const char *name, const char *message);
 267 int sd_bus_error_setf(sd_bus_error *e, const char *name, const char *format, ...)  _sd_printf_(3, 0);
 268 int sd_bus_error_set_const(sd_bus_error *e, const char *name, const char *message);
 269 int sd_bus_error_set_errno(sd_bus_error *e, int error);
 270 int sd_bus_error_set_errnof(sd_bus_error *e, int error, const char *format, ...) _sd_printf_(3, 0);
 271 int sd_bus_error_get_errno(const sd_bus_error *e);
 272 int sd_bus_error_copy(sd_bus_error *dest, const sd_bus_error *e);
 273 int sd_bus_error_is_set(const sd_bus_error *e);
 274 int sd_bus_error_has_name(const sd_bus_error *e, const char *name);
 275
 276 #define SD_BUS_MESSAGE_APPEND_ID128(x) 16,                              \
 277                 (x).bytes[0],  (x).bytes[1],  (x).bytes[2],  (x).bytes[3], \
 278                 (x).bytes[4],  (x).bytes[5],  (x).bytes[6],  (x).bytes[7], \
 279                 (x).bytes[8],  (x).bytes[9],  (x).bytes[10], (x).bytes[11], \
 280                 (x).bytes[12], (x).bytes[13], (x).bytes[14], (x).bytes[15]
 281
 282 #define SD_BUS_MESSAGE_READ_ID128(x) 16,                                \
 283                 &(x).bytes[0],  &(x).bytes[1],  &(x).bytes[2],  &(x).bytes[3], \
 284                 &(x).bytes[4],  &(x).bytes[5],  &(x).bytes[6],  &(x).bytes[7], \
 285                 &(x).bytes[8],  &(x).bytes[9],  &(x).bytes[10], &(x).bytes[11], \
 286                 &(x).bytes[12], &(x).bytes[13], &(x).bytes[14], &(x).bytes[15]
 287
 288 char *sd_bus_label_escape(const char *s);
 289 char *sd_bus_label_unescape(const char *f);
 290
 291 _SD_END_DECLARATIONS;
 292
 293 #endif