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
  28 #include <sd-id128.h>
  29 #include "sd-bus-protocol.h"
  30
  31 #ifdef __cplusplus
  32 extern "C" {
  33 #endif
  34
  35 #ifndef _sd_printf_attr_
  36 #  if __GNUC__ >= 4
  37 #    define _sd_printf_attr_(a,b) __attribute__ ((format (printf, a, b)))
  38 #  else
  39 #    define _sd_printf_attr_(a,b)
  40 #  endif
  41 #endif
  42
  43 /* TODO:
  44  * - add page donation logic
  45  * - api for appending/reading fixed arrays
  46  * - merge busctl into systemctl or so?
  47  * - default policy (allow uid == 0 and our own uid)
  48  *
  49  * - enforce alignment of pointers passed in
  50  * - negotiation for attach attributes
  51  */
  52
  53 typedef struct sd_bus sd_bus;
  54 typedef struct sd_bus_message sd_bus_message;
  55
  56 typedef struct {
  57         const char *name;
  58         const char *message;
  59         int need_free;
  60 } sd_bus_error;
  61
  62 typedef int (*sd_bus_message_handler_t)(sd_bus *bus, int ret, sd_bus_message *m, void *userdata);
  63
  64 /* Connections */
  65
  66 int sd_bus_open_system(sd_bus **ret);
  67 int sd_bus_open_user(sd_bus **ret);
  68
  69 int sd_bus_new(sd_bus **ret);
  70 int sd_bus_set_address(sd_bus *bus, const char *address);
  71 int sd_bus_set_fd(sd_bus *bus, int input_fd, int output_fd);
  72 int sd_bus_set_exec(sd_bus *bus, const char *path, char *const argv[]);
  73 int sd_bus_set_bus_client(sd_bus *bus, int b);
  74 int sd_bus_set_server(sd_bus *bus, int b, sd_id128_t server_id);
  75 int sd_bus_set_anonymous(sd_bus *bus, int b);
  76 int sd_bus_set_negotiate_fds(sd_bus *bus, int b);
  77 int sd_bus_start(sd_bus *ret);
  78
  79 void sd_bus_close(sd_bus *bus);
  80
  81 sd_bus *sd_bus_ref(sd_bus *bus);
  82 sd_bus *sd_bus_unref(sd_bus *bus);
  83
  84 int sd_bus_is_open(sd_bus *bus);
  85 int sd_bus_can_send(sd_bus *bus, char type);
  86 int sd_bus_get_server_id(sd_bus *bus, sd_id128_t *peer);
  87
  88 int sd_bus_send(sd_bus *bus, sd_bus_message *m, uint64_t *serial);
  89 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);
  90 int sd_bus_send_with_reply_cancel(sd_bus *bus, uint64_t serial);
  91 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);
  92
  93 int sd_bus_get_fd(sd_bus *bus);
  94 int sd_bus_get_events(sd_bus *bus);
  95 int sd_bus_get_timeout(sd_bus *bus, uint64_t *timeout_usec);
  96 int sd_bus_process(sd_bus *bus, sd_bus_message **r);
  97 int sd_bus_wait(sd_bus *bus, uint64_t timeout_usec);
  98 int sd_bus_flush(sd_bus *bus);
  99
 100 int sd_bus_add_filter(sd_bus *bus, sd_bus_message_handler_t callback, void *userdata);
 101 int sd_bus_remove_filter(sd_bus *bus, sd_bus_message_handler_t callback, void *userdata);
 102
 103 int sd_bus_add_object(sd_bus *bus, const char *path, sd_bus_message_handler_t callback, void *userdata);
 104 int sd_bus_remove_object(sd_bus *bus, const char *path, sd_bus_message_handler_t callback, void *userdata);
 105
 106 int sd_bus_add_fallback(sd_bus *bus, const char *prefix, sd_bus_message_handler_t callback, void *userdata);
 107 int sd_bus_remove_fallback(sd_bus *bus, const char *prefix, sd_bus_message_handler_t callback, void *userdata);
 108
 109 int sd_bus_add_match(sd_bus *bus, const char *match, sd_bus_message_handler_t callback, void *userdata);
 110 int sd_bus_remove_match(sd_bus *bus, const char *match, sd_bus_message_handler_t callback, void *userdata);
 111
 112 /* Message object */
 113
 114 int sd_bus_message_new_signal(sd_bus *bus, const char *path, const char *interface, const char *member, sd_bus_message **m);
 115 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);
 116 int sd_bus_message_new_method_return(sd_bus *bus, sd_bus_message *call, sd_bus_message **m);
 117 int sd_bus_message_new_method_error(sd_bus *bus, sd_bus_message *call, const sd_bus_error *e, sd_bus_message **m);
 118
 119 sd_bus_message* sd_bus_message_ref(sd_bus_message *m);
 120 sd_bus_message* sd_bus_message_unref(sd_bus_message *m);
 121
 122 int sd_bus_message_get_type(sd_bus_message *m, uint8_t *type);
 123 int sd_bus_message_get_serial(sd_bus_message *m, uint64_t *serial);
 124 int sd_bus_message_get_reply_serial(sd_bus_message *m, uint64_t *serial);
 125 int sd_bus_message_get_no_reply(sd_bus_message *m);
 126
 127 const char *sd_bus_message_get_path(sd_bus_message *m);
 128 const char *sd_bus_message_get_interface(sd_bus_message *m);
 129 const char *sd_bus_message_get_member(sd_bus_message *m);
 130 const char *sd_bus_message_get_destination(sd_bus_message *m);
 131 const char *sd_bus_message_get_sender(sd_bus_message *m);
 132 const sd_bus_error *sd_bus_message_get_error(sd_bus_message *m);
 133
 134 int sd_bus_message_get_monotonic_timestamp(sd_bus_message *m, uint64_t *usec);
 135 int sd_bus_message_get_realtime_timestamp(sd_bus_message *m, uint64_t *usec);
 136 int sd_bus_message_get_uid(sd_bus_message *m, uid_t *uid);
 137 int sd_bus_message_get_gid(sd_bus_message *m, gid_t *gid);
 138 int sd_bus_message_get_pid(sd_bus_message *m, pid_t *pid);
 139 int sd_bus_message_get_tid(sd_bus_message *m, pid_t *tid);
 140 int sd_bus_message_get_pid_starttime(sd_bus_message *m, uint64_t *usec);
 141 int sd_bus_message_get_selinux_context(sd_bus_message *m, const char **r);
 142 int sd_bus_message_get_comm(sd_bus_message *m, const char **r);
 143 int sd_bus_message_get_tid_comm(sd_bus_message *m, const char **r);
 144 int sd_bus_message_get_exe(sd_bus_message *m, const char **r);
 145 int sd_bus_message_get_cgroup(sd_bus_message *m, const char **r);
 146 int sd_bus_message_get_cmdline(sd_bus_message *m, char ***cmdline);
 147 int sd_bus_message_get_unit(sd_bus_message *m, const char **unit);
 148 int sd_bus_message_get_user_unit(sd_bus_message *m, const char **unit);
 149 int sd_bus_message_get_session(sd_bus_message *m, const char **session);
 150 int sd_bus_message_get_owner_uid(sd_bus_message *m, uid_t *uid);
 151 int sd_bus_message_get_audit_sessionid(sd_bus_message *m, uint32_t *sessionid);
 152 int sd_bus_message_get_audit_loginuid(sd_bus_message *m, uid_t *loginuid);
 153 int sd_bus_message_has_effective_cap(sd_bus_message *m, int capability);
 154
 155 int sd_bus_message_is_signal(sd_bus_message *m, const char *interface, const char *member);
 156 int sd_bus_message_is_method_call(sd_bus_message *m, const char *interface, const char *member);
 157 int sd_bus_message_is_method_error(sd_bus_message *m, const char *name);
 158
 159 int sd_bus_message_set_no_reply(sd_bus_message *m, int b);
 160 int sd_bus_message_set_destination(sd_bus_message *m, const char *destination);
 161
 162 int sd_bus_message_append(sd_bus_message *m, const char *types, ...);
 163 int sd_bus_message_append_basic(sd_bus_message *m, char type, const void *p);
 164 int sd_bus_message_open_container(sd_bus_message *m, char type, const char *contents);
 165 int sd_bus_message_close_container(sd_bus_message *m);
 166
 167 int sd_bus_message_read(sd_bus_message *m, const char *types, ...);
 168 int sd_bus_message_read_basic(sd_bus_message *m, char type, void *p);
 169 int sd_bus_message_enter_container(sd_bus_message *m, char type, const char *contents);
 170 int sd_bus_message_exit_container(sd_bus_message *m);
 171 int sd_bus_message_peek_type(sd_bus_message *m, char *type, const char **contents);
 172 int sd_bus_message_rewind(sd_bus_message *m, int complete);
 173
 174 /* Convenience calls */
 175
 176 int sd_bus_emit_signal(sd_bus *bus, const char *path, const char *interface, const char *member, const char *types, ...);
 177 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, ...);
 178 int sd_bus_reply_method_return(sd_bus *bus, sd_bus_message *call, const char *types, ...);
 179 int sd_bus_reply_method_error(sd_bus *bus, sd_bus_message *call, const sd_bus_error *e);
 180
 181 /* Bus management */
 182
 183 int sd_bus_get_unique_name(sd_bus *bus, const char **unique);
 184 int sd_bus_request_name(sd_bus *bus, const char *name, int flags);
 185 int sd_bus_release_name(sd_bus *bus, const char *name);
 186 int sd_bus_list_names(sd_bus *bus, char ***l);
 187 int sd_bus_get_owner(sd_bus *bus, const char *name, char **owner);
 188 int sd_bus_get_owner_uid(sd_bus *bus, const char *name, uid_t *uid);
 189 int sd_bus_get_owner_pid(sd_bus *bus, const char *name, pid_t *pid);
 190 int sd_bus_get_owner_machine_id(sd_bus *bus, const char *name, sd_id128_t *machine);
 191
 192 /* Error structures */
 193
 194 #define SD_BUS_ERROR_NULL ((sd_bus_error) {NULL, NULL, 0})
 195 #define SD_BUS_ERROR_MAKE(name, message) ((sd_bus_error) {(name), (message), 0})
 196
 197 void sd_bus_error_free(sd_bus_error *e);
 198 int sd_bus_error_set(sd_bus_error *e, const char *name, const char *format, ...)  _sd_printf_attr_(3, 0);
 199 void sd_bus_error_set_const(sd_bus_error *e, const char *name, const char *message);
 200 int sd_bus_error_copy(sd_bus_error *dest, const sd_bus_error *e);
 201 int sd_bus_error_is_set(const sd_bus_error *e);
 202 int sd_bus_error_has_name(const sd_bus_error *e, const char *name);
 203
 204 #ifdef __cplusplus
 205 }
 206 #endif
 207
 208 #endif