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);
  50 typedef int (*sd_bus_property_get_t) (sd_bus *bus, const char *path, const char *interface, const char *property, sd_bus_message *reply, sd_bus_error *error, void *userdata);
  51 typedef int (*sd_bus_property_set_t) (sd_bus *bus, const char *path, const char *interface, const char *property, sd_bus_message *value, sd_bus_error *error, void *userdata);
  52 typedef int (*sd_bus_object_find_t) (sd_bus *bus, const char *path, const char *interface, void **found, void *userdata);
  53 typedef int (*sd_bus_node_enumerator_t) (sd_bus *bus, const char *path, char ***nodes, void *userdata);
  54
  55 #include "sd-bus-protocol.h"
  56 #include "sd-bus-vtable.h"
  57
  58 /* Connections */
  59
  60 int sd_bus_open_user(sd_bus **ret);
  61 int sd_bus_open_system(sd_bus **ret);
  62 int sd_bus_open_system_remote(const char *host, sd_bus **ret);
  63 int sd_bus_open_system_container(const char *machine, sd_bus **ret);
  64
  65 int sd_bus_new(sd_bus **ret);
  66 int sd_bus_set_address(sd_bus *bus, const char *address);
  67 int sd_bus_set_fd(sd_bus *bus, int input_fd, int output_fd);
  68 int sd_bus_set_exec(sd_bus *bus, const char *path, char *const argv[]);
  69 int sd_bus_set_bus_client(sd_bus *bus, int b);
  70 int sd_bus_set_server(sd_bus *bus, int b, sd_id128_t server_id);
  71 int sd_bus_set_anonymous(sd_bus *bus, int b);
  72 int sd_bus_negotiate_fds(sd_bus *bus, int b);
  73 int sd_bus_negotiate_attach_comm(sd_bus *bus, int b);
  74 int sd_bus_negotiate_attach_exe(sd_bus *bus, int b);
  75 int sd_bus_negotiate_attach_cmdline(sd_bus *bus, int b);
  76 int sd_bus_negotiate_attach_cgroup(sd_bus *bus, int b);
  77 int sd_bus_negotiate_attach_caps(sd_bus *bus, int b);
  78 int sd_bus_negotiate_attach_selinux_context(sd_bus *bus, int b);
  79 int sd_bus_negotiate_attach_audit(sd_bus *bus, int b);
  80 int sd_bus_start(sd_bus *ret);
  81
  82 void sd_bus_close(sd_bus *bus);
  83
  84 sd_bus *sd_bus_ref(sd_bus *bus);
  85 sd_bus *sd_bus_unref(sd_bus *bus);
  86
  87 int sd_bus_is_open(sd_bus *bus);
  88 int sd_bus_can_send(sd_bus *bus, char type);
  89 int sd_bus_get_server_id(sd_bus *bus, sd_id128_t *peer);
  90
  91 int sd_bus_send(sd_bus *bus, sd_bus_message *m, uint64_t *serial);
  92 int sd_bus_send_with_reply(sd_bus *bus, sd_bus_message *m, sd_bus_message_handler_t callback, void *userdata, uint64_t usec, uint64_t *serial);
  93 int sd_bus_send_with_reply_cancel(sd_bus *bus, uint64_t serial);
  94 int sd_bus_send_with_reply_and_block(sd_bus *bus, sd_bus_message *m, uint64_t usec, sd_bus_error *error, sd_bus_message **r);
  95
  96 int sd_bus_get_fd(sd_bus *bus);
  97 int sd_bus_get_events(sd_bus *bus);
  98 int sd_bus_get_timeout(sd_bus *bus, uint64_t *timeout_usec);
  99 int sd_bus_process(sd_bus *bus, sd_bus_message **r);
 100 int sd_bus_wait(sd_bus *bus, uint64_t timeout_usec);
 101 int sd_bus_flush(sd_bus *bus);
 102
 103 sd_bus_message* sd_bus_get_current(sd_bus *bus);
 104
 105 int sd_bus_attach_event(sd_bus *bus, sd_event *e, int priority);
 106 int sd_bus_detach_event(sd_bus *bus);
 107
 108 int sd_bus_add_filter(sd_bus *bus, sd_bus_message_handler_t callback, void *userdata);
 109 int sd_bus_remove_filter(sd_bus *bus, sd_bus_message_handler_t callback, void *userdata);
 110
 111 int sd_bus_add_match(sd_bus *bus, const char *match, sd_bus_message_handler_t callback, void *userdata);
 112 int sd_bus_remove_match(sd_bus *bus, const char *match, sd_bus_message_handler_t callback, void *userdata);
 113
 114 int sd_bus_add_object(sd_bus *bus, const char *path, sd_bus_message_handler_t callback, void *userdata);
 115 int sd_bus_remove_object(sd_bus *bus, const char *path, sd_bus_message_handler_t callback, void *userdata);
 116
 117 int sd_bus_add_fallback(sd_bus *bus, const char *prefix, sd_bus_message_handler_t callback, void *userdata);
 118 int sd_bus_remove_fallback(sd_bus *bus, const char *prefix, sd_bus_message_handler_t callback, void *userdata);
 119
 120 int sd_bus_add_object_vtable(sd_bus *bus, const char *path, const char *interface, const sd_bus_vtable *vtable, void *userdata);
 121 int sd_bus_remove_object_vtable(sd_bus *bus, const char *path, const char *interface);
 122
 123 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);
 124 int sd_bus_remove_fallback_vtable(sd_bus *bus, const char *path, const char *interface);
 125
 126 int sd_bus_add_node_enumerator(sd_bus *bus, const char *path, sd_bus_node_enumerator_t callback, void *userdata);
 127 int sd_bus_remove_node_enumerator(sd_bus *bus, const char *path, sd_bus_node_enumerator_t callback, void *userdata);
 128
 129 int sd_bus_add_object_manager(sd_bus *bus, const char *path);
 130 int sd_bus_remove_object_manager(sd_bus *bus, const char *path);
 131
 132 /* Message object */
 133 int sd_bus_message_new_signal(sd_bus *bus, const char *path, const char *interface, const char *member, sd_bus_message **m);
 134 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);
 135 int sd_bus_message_new_method_return(sd_bus *bus, sd_bus_message *call, sd_bus_message **m);
 136 int sd_bus_message_new_method_error(sd_bus *bus, sd_bus_message *call, const sd_bus_error *e, sd_bus_message **m);
 137 int sd_bus_message_new_method_errorf(sd_bus *bus, sd_bus_message *call, sd_bus_message **m, const char *name, const char *format, ...) _sd_printf_(5, 0);
 138 int sd_bus_message_new_method_errno(sd_bus *bus, sd_bus_message *call, int error, const sd_bus_error *e, sd_bus_message **m);
 139 int sd_bus_message_new_method_errnof(sd_bus *bus, sd_bus_message *call, sd_bus_message **m, int error, const char *format, ...) _sd_printf_(5, 0);
 140
 141 sd_bus_message* sd_bus_message_ref(sd_bus_message *m);
 142 sd_bus_message* sd_bus_message_unref(sd_bus_message *m);
 143
 144 int sd_bus_message_get_type(sd_bus_message *m, uint8_t *type);
 145 int sd_bus_message_get_serial(sd_bus_message *m, uint64_t *serial);
 146 int sd_bus_message_get_reply_serial(sd_bus_message *m, uint64_t *serial);
 147 int sd_bus_message_get_no_reply(sd_bus_message *m);
 148
 149 const char *sd_bus_message_get_signature(sd_bus_message *m, int complete);
 150 const char *sd_bus_message_get_path(sd_bus_message *m);
 151 const char *sd_bus_message_get_interface(sd_bus_message *m);
 152 const char *sd_bus_message_get_member(sd_bus_message *m);
 153 const char *sd_bus_message_get_destination(sd_bus_message *m);
 154 const char *sd_bus_message_get_sender(sd_bus_message *m);
 155 const sd_bus_error *sd_bus_message_get_error(sd_bus_message *m);
 156 int sd_bus_message_get_errno(sd_bus_message *m);
 157
 158 int sd_bus_message_get_monotonic_timestamp(sd_bus_message *m, uint64_t *usec);
 159 int sd_bus_message_get_realtime_timestamp(sd_bus_message *m, uint64_t *usec);
 160 int sd_bus_message_get_uid(sd_bus_message *m, uid_t *uid);
 161 int sd_bus_message_get_gid(sd_bus_message *m, gid_t *gid);
 162 int sd_bus_message_get_pid(sd_bus_message *m, pid_t *pid);
 163 int sd_bus_message_get_tid(sd_bus_message *m, pid_t *tid);
 164 int sd_bus_message_get_pid_starttime(sd_bus_message *m, uint64_t *usec);
 165 int sd_bus_message_get_selinux_context(sd_bus_message *m, const char **r);
 166 int sd_bus_message_get_comm(sd_bus_message *m, const char **r);
 167 int sd_bus_message_get_tid_comm(sd_bus_message *m, const char **r);
 168 int sd_bus_message_get_exe(sd_bus_message *m, const char **r);
 169 int sd_bus_message_get_cgroup(sd_bus_message *m, const char **r);
 170 int sd_bus_message_get_cmdline(sd_bus_message *m, char ***cmdline);
 171 int sd_bus_message_get_unit(sd_bus_message *m, const char **unit);
 172 int sd_bus_message_get_user_unit(sd_bus_message *m, const char **unit);
 173 int sd_bus_message_get_session(sd_bus_message *m, const char **session);
 174 int sd_bus_message_get_owner_uid(sd_bus_message *m, uid_t *uid);
 175 int sd_bus_message_get_audit_sessionid(sd_bus_message *m, uint32_t *sessionid);
 176 int sd_bus_message_get_audit_loginuid(sd_bus_message *m, uid_t *loginuid);
 177 int sd_bus_message_has_effective_cap(sd_bus_message *m, int capability);
 178
 179 int sd_bus_message_is_signal(sd_bus_message *m, const char *interface, const char *member);
 180 int sd_bus_message_is_method_call(sd_bus_message *m, const char *interface, const char *member);
 181 int sd_bus_message_is_method_error(sd_bus_message *m, const char *name);
 182
 183 int sd_bus_message_set_no_reply(sd_bus_message *m, int b);
 184 int sd_bus_message_set_destination(sd_bus_message *m, const char *destination);
 185
 186 int sd_bus_message_append(sd_bus_message *m, const char *types, ...);
 187 int sd_bus_message_append_basic(sd_bus_message *m, char type, const void *p);
 188 int sd_bus_message_append_array(sd_bus_message *m, char type, const void *ptr, size_t size);
 189 int sd_bus_message_append_array_space(sd_bus_message *m, char type, size_t size, void **ptr);
 190 int sd_bus_message_append_array_iovec(sd_bus_message *m, char type, const struct iovec *iov, unsigned n);
 191 int sd_bus_message_append_array_memfd(sd_bus_message *m, char type, sd_memfd *memfd);
 192 int sd_bus_message_append_string_space(sd_bus_message *m, size_t size, char **s);
 193 int sd_bus_message_append_string_iovec(sd_bus_message *m, const struct iovec *iov, unsigned n);
 194 int sd_bus_message_append_string_memfd(sd_bus_message *m, sd_memfd* memfd);
 195 int sd_bus_message_append_strv(sd_bus_message *m, char **l);
 196 int sd_bus_message_open_container(sd_bus_message *m, char type, const char *contents);
 197 int sd_bus_message_close_container(sd_bus_message *m);
 198 int sd_bus_message_copy(sd_bus_message *m, sd_bus_message *source, int all);
 199
 200 int sd_bus_message_read(sd_bus_message *m, const char *types, ...);
 201 int sd_bus_message_read_basic(sd_bus_message *m, char type, void *p);
 202 int sd_bus_message_read_array(sd_bus_message *m, char type, const void **ptr, size_t *size);
 203 int sd_bus_message_read_strv(sd_bus_message *m, char ***l); /* free the result! */
 204 int sd_bus_message_skip(sd_bus_message *m, const char *types);
 205 int sd_bus_message_enter_container(sd_bus_message *m, char type, const char *contents);
 206 int sd_bus_message_exit_container(sd_bus_message *m);
 207 int sd_bus_message_peek_type(sd_bus_message *m, char *type, const char **contents);
 208 int sd_bus_message_verify_type(sd_bus_message *m, char type, const char *contents);
 209 int sd_bus_message_at_end(sd_bus_message *m, int complete);
 210 int sd_bus_message_rewind(sd_bus_message *m, int complete);
 211
 212 /* Convenience calls */
 213
 214 int sd_bus_call_method(sd_bus *bus, const char *destination, const char *path, const char *interface, const char *member, sd_bus_error *error, sd_bus_message **reply, const char *types, ...);
 215 int sd_bus_get_property(sd_bus *bus, const char *destination, const char *path, const char *interface, const char *member, sd_bus_error *error, sd_bus_message **reply, const char *type);
 216 int sd_bus_get_property_trivial(sd_bus *bus, const char *destination, const char *path, const char *interface, const char *member, sd_bus_error *error, char type, void *ptr);
 217 int sd_bus_get_property_string(sd_bus *bus, const char *destination, const char *path, const char *interface, const char *member, sd_bus_error *error, char **ret); /* free the result! */
 218 int sd_bus_get_property_strv(sd_bus *bus, const char *destination, const char *path, const char *interface, const char *member, sd_bus_error *error, char ***ret); /* free the result! */
 219 int sd_bus_set_property(sd_bus *bus, const char *destination, const char *path, const char *interface, const char *member, sd_bus_error *error, const char *type, ...);
 220 int sd_bus_reply_method_return(sd_bus *bus, sd_bus_message *call, const char *types, ...);
 221 int sd_bus_reply_method_error(sd_bus *bus, sd_bus_message *call, const sd_bus_error *e);
 222 int sd_bus_reply_method_errorf(sd_bus *bus, sd_bus_message *call, const char *name, const char *format, ...) _sd_printf_(4, 0);
 223 int sd_bus_reply_method_errno(sd_bus *bus, sd_bus_message *call, int error, const sd_bus_error *e);
 224 int sd_bus_reply_method_errnof(sd_bus *bus, sd_bus_message *call, int error, const char *format, ...) _sd_printf_(4, 0);
 225
 226 int sd_bus_emit_signal(sd_bus *bus, const char *path, const char *interface, const char *member, const char *types, ...);
 227
 228 int sd_bus_emit_properties_changed_strv(sd_bus *bus, const char *path, const char *interface, char **names);
 229 int sd_bus_emit_properties_changed(sd_bus *bus, const char *path, const char *interface, const char *name, ...) _sd_sentinel_;
 230
 231 int sd_bus_emit_interfaces_added_strv(sd_bus *bus, const char *path, char **interfaces);
 232 int sd_bus_emit_interfaces_added(sd_bus *bus, const char *path, const char *interface, ...) _sd_sentinel_;
 233 int sd_bus_emit_interfaces_removed_strv(sd_bus *bus, const char *path, char **interfaces);
 234 int sd_bus_emit_interfaces_removed(sd_bus *bus, const char *path, const char *interface, ...) _sd_sentinel_;
 235
 236 /* Bus management */
 237
 238 int sd_bus_get_unique_name(sd_bus *bus, const char **unique);
 239 int sd_bus_request_name(sd_bus *bus, const char *name, int flags);
 240 int sd_bus_release_name(sd_bus *bus, const char *name);
 241 int sd_bus_list_names(sd_bus *bus, char ***l);
 242 int sd_bus_get_owner(sd_bus *bus, const char *name, char **owner); /* free the result! */
 243 int sd_bus_get_owner_uid(sd_bus *bus, const char *name, uid_t *uid);
 244 int sd_bus_get_owner_pid(sd_bus *bus, const char *name, pid_t *pid);
 245 int sd_bus_get_owner_machine_id(sd_bus *bus, const char *name, sd_id128_t *machine);
 246
 247 /* Error structures */
 248
 249 #define SD_BUS_ERROR_MAKE(name, message) ((sd_bus_error) {(name), (message), 0})
 250 #define SD_BUS_ERROR_NULL SD_BUS_ERROR_MAKE(NULL, NULL)
 251
 252 void sd_bus_error_free(sd_bus_error *e);
 253 int sd_bus_error_set(sd_bus_error *e, const char *name, const char *message);
 254 int sd_bus_error_setf(sd_bus_error *e, const char *name, const char *format, ...)  _sd_printf_(3, 0);
 255 int sd_bus_error_set_const(sd_bus_error *e, const char *name, const char *message);
 256 int sd_bus_error_set_errno(sd_bus_error *e, int error);
 257 int sd_bus_error_set_errnof(sd_bus_error *e, int error, const char *format, ...) _sd_printf_(3, 0);
 258 int sd_bus_error_get_errno(const sd_bus_error *e);
 259 int sd_bus_error_copy(sd_bus_error *dest, const sd_bus_error *e);
 260 int sd_bus_error_is_set(const sd_bus_error *e);
 261 int sd_bus_error_has_name(const sd_bus_error *e, const char *name);
 262
 263 #define SD_BUS_MESSAGE_APPEND_ID128(x) 16,                              \
 264                 (x).bytes[0],  (x).bytes[1],  (x).bytes[2],  (x).bytes[3], \
 265                 (x).bytes[4],  (x).bytes[5],  (x).bytes[6],  (x).bytes[7], \
 266                 (x).bytes[8],  (x).bytes[9],  (x).bytes[10], (x).bytes[11], \
 267                 (x).bytes[12], (x).bytes[13], (x).bytes[14], (x).bytes[15]
 268
 269 #define SD_BUS_MESSAGE_READ_ID128(x) 16,                                \
 270                 &(x).bytes[0],  &(x).bytes[1],  &(x).bytes[2],  &(x).bytes[3], \
 271                 &(x).bytes[4],  &(x).bytes[5],  &(x).bytes[6],  &(x).bytes[7], \
 272                 &(x).bytes[8],  &(x).bytes[9],  &(x).bytes[10], &(x).bytes[11], \
 273                 &(x).bytes[12], &(x).bytes[13], &(x).bytes[14], &(x).bytes[15]
 274
 275 _SD_END_DECLARATIONS;
 276
 277 #endif