1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
7 This file is part of systemd.
9 Copyright 2013 Lennart Poettering
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.
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.
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/>.
26 #include <sys/types.h>
29 #include "sd-bus-protocol.h"
35 #ifndef _sd_printf_attr_
37 # define _sd_printf_attr_(a,b) __attribute__ ((format (printf, a, b)))
39 # define _sd_printf_attr_(a,b)
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)
49 * - enforce alignment of pointers passed in
50 * - negotiation for attach attributes
52 * - for kernel and unix transports allow setting the unix user/access mode for the node
55 typedef struct sd_bus sd_bus;
56 typedef struct sd_bus_message sd_bus_message;
64 typedef int (*sd_bus_message_handler_t)(sd_bus *bus, int ret, sd_bus_message *m, void *userdata);
68 int sd_bus_open_system(sd_bus **ret);
69 int sd_bus_open_user(sd_bus **ret);
71 int sd_bus_new(sd_bus **ret);
72 int sd_bus_set_address(sd_bus *bus, const char *address);
73 int sd_bus_set_fd(sd_bus *bus, int input_fd, int output_fd);
74 int sd_bus_set_exec(sd_bus *bus, const char *path, char *const argv[]);
75 int sd_bus_set_bus_client(sd_bus *bus, int b);
76 int sd_bus_set_server(sd_bus *bus, int b, sd_id128_t server_id);
77 int sd_bus_set_anonymous(sd_bus *bus, int b);
78 int sd_bus_set_negotiate_fds(sd_bus *bus, int b);
79 int sd_bus_start(sd_bus *ret);
81 void sd_bus_close(sd_bus *bus);
83 sd_bus *sd_bus_ref(sd_bus *bus);
84 sd_bus *sd_bus_unref(sd_bus *bus);
86 int sd_bus_is_open(sd_bus *bus);
87 int sd_bus_can_send(sd_bus *bus, char type);
88 int sd_bus_get_server_id(sd_bus *bus, sd_id128_t *peer);
90 int sd_bus_send(sd_bus *bus, sd_bus_message *m, uint64_t *serial);
91 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);
92 int sd_bus_send_with_reply_cancel(sd_bus *bus, uint64_t serial);
93 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 int sd_bus_get_fd(sd_bus *bus);
96 int sd_bus_get_events(sd_bus *bus);
97 int sd_bus_get_timeout(sd_bus *bus, uint64_t *timeout_usec);
98 int sd_bus_process(sd_bus *bus, sd_bus_message **r);
99 int sd_bus_wait(sd_bus *bus, uint64_t timeout_usec);
100 int sd_bus_flush(sd_bus *bus);
102 int sd_bus_add_filter(sd_bus *bus, sd_bus_message_handler_t callback, void *userdata);
103 int sd_bus_remove_filter(sd_bus *bus, sd_bus_message_handler_t callback, void *userdata);
105 int sd_bus_add_object(sd_bus *bus, const char *path, sd_bus_message_handler_t callback, void *userdata);
106 int sd_bus_remove_object(sd_bus *bus, const char *path, sd_bus_message_handler_t callback, void *userdata);
108 int sd_bus_add_fallback(sd_bus *bus, const char *prefix, sd_bus_message_handler_t callback, void *userdata);
109 int sd_bus_remove_fallback(sd_bus *bus, const char *prefix, sd_bus_message_handler_t callback, void *userdata);
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);
116 int sd_bus_message_new_signal(sd_bus *bus, const char *path, const char *interface, const char *member, sd_bus_message **m);
117 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);
118 int sd_bus_message_new_method_return(sd_bus *bus, sd_bus_message *call, sd_bus_message **m);
119 int sd_bus_message_new_method_error(sd_bus *bus, sd_bus_message *call, const sd_bus_error *e, sd_bus_message **m);
121 sd_bus_message* sd_bus_message_ref(sd_bus_message *m);
122 sd_bus_message* sd_bus_message_unref(sd_bus_message *m);
124 int sd_bus_message_get_type(sd_bus_message *m, uint8_t *type);
125 int sd_bus_message_get_serial(sd_bus_message *m, uint64_t *serial);
126 int sd_bus_message_get_reply_serial(sd_bus_message *m, uint64_t *serial);
127 int sd_bus_message_get_no_reply(sd_bus_message *m);
129 const char *sd_bus_message_get_path(sd_bus_message *m);
130 const char *sd_bus_message_get_interface(sd_bus_message *m);
131 const char *sd_bus_message_get_member(sd_bus_message *m);
132 const char *sd_bus_message_get_destination(sd_bus_message *m);
133 const char *sd_bus_message_get_sender(sd_bus_message *m);
134 const sd_bus_error *sd_bus_message_get_error(sd_bus_message *m);
136 int sd_bus_message_get_monotonic_timestamp(sd_bus_message *m, uint64_t *usec);
137 int sd_bus_message_get_realtime_timestamp(sd_bus_message *m, uint64_t *usec);
138 int sd_bus_message_get_uid(sd_bus_message *m, uid_t *uid);
139 int sd_bus_message_get_gid(sd_bus_message *m, gid_t *gid);
140 int sd_bus_message_get_pid(sd_bus_message *m, pid_t *pid);
141 int sd_bus_message_get_tid(sd_bus_message *m, pid_t *tid);
142 int sd_bus_message_get_pid_starttime(sd_bus_message *m, uint64_t *usec);
143 int sd_bus_message_get_selinux_context(sd_bus_message *m, const char **r);
144 int sd_bus_message_get_comm(sd_bus_message *m, const char **r);
145 int sd_bus_message_get_tid_comm(sd_bus_message *m, const char **r);
146 int sd_bus_message_get_exe(sd_bus_message *m, const char **r);
147 int sd_bus_message_get_cgroup(sd_bus_message *m, const char **r);
148 int sd_bus_message_get_cmdline(sd_bus_message *m, char ***cmdline);
149 int sd_bus_message_get_unit(sd_bus_message *m, const char **unit);
150 int sd_bus_message_get_user_unit(sd_bus_message *m, const char **unit);
151 int sd_bus_message_get_session(sd_bus_message *m, const char **session);
152 int sd_bus_message_get_owner_uid(sd_bus_message *m, uid_t *uid);
153 int sd_bus_message_get_audit_sessionid(sd_bus_message *m, uint32_t *sessionid);
154 int sd_bus_message_get_audit_loginuid(sd_bus_message *m, uid_t *loginuid);
155 int sd_bus_message_has_effective_cap(sd_bus_message *m, int capability);
157 int sd_bus_message_is_signal(sd_bus_message *m, const char *interface, const char *member);
158 int sd_bus_message_is_method_call(sd_bus_message *m, const char *interface, const char *member);
159 int sd_bus_message_is_method_error(sd_bus_message *m, const char *name);
161 int sd_bus_message_set_no_reply(sd_bus_message *m, int b);
162 int sd_bus_message_set_destination(sd_bus_message *m, const char *destination);
164 int sd_bus_message_append(sd_bus_message *m, const char *types, ...);
165 int sd_bus_message_append_basic(sd_bus_message *m, char type, const void *p);
166 int sd_bus_message_open_container(sd_bus_message *m, char type, const char *contents);
167 int sd_bus_message_close_container(sd_bus_message *m);
169 int sd_bus_message_read(sd_bus_message *m, const char *types, ...);
170 int sd_bus_message_read_basic(sd_bus_message *m, char type, void *p);
171 int sd_bus_message_enter_container(sd_bus_message *m, char type, const char *contents);
172 int sd_bus_message_exit_container(sd_bus_message *m);
173 int sd_bus_message_peek_type(sd_bus_message *m, char *type, const char **contents);
174 int sd_bus_message_rewind(sd_bus_message *m, int complete);
176 /* Convenience calls */
178 int sd_bus_emit_signal(sd_bus *bus, const char *path, const char *interface, const char *member, const char *types, ...);
179 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, ...);
180 int sd_bus_reply_method_return(sd_bus *bus, sd_bus_message *call, const char *types, ...);
181 int sd_bus_reply_method_error(sd_bus *bus, sd_bus_message *call, const sd_bus_error *e);
185 int sd_bus_get_unique_name(sd_bus *bus, const char **unique);
186 int sd_bus_request_name(sd_bus *bus, const char *name, int flags);
187 int sd_bus_release_name(sd_bus *bus, const char *name);
188 int sd_bus_list_names(sd_bus *bus, char ***l);
189 int sd_bus_get_owner(sd_bus *bus, const char *name, char **owner);
190 int sd_bus_get_owner_uid(sd_bus *bus, const char *name, uid_t *uid);
191 int sd_bus_get_owner_pid(sd_bus *bus, const char *name, pid_t *pid);
192 int sd_bus_get_owner_machine_id(sd_bus *bus, const char *name, sd_id128_t *machine);
194 /* Error structures */
196 #define SD_BUS_ERROR_NULL ((sd_bus_error) {NULL, NULL, 0})
197 #define SD_BUS_ERROR_MAKE(name, message) ((sd_bus_error) {(name), (message), 0})
199 void sd_bus_error_free(sd_bus_error *e);
200 int sd_bus_error_set(sd_bus_error *e, const char *name, const char *format, ...) _sd_printf_attr_(3, 0);
201 void sd_bus_error_set_const(sd_bus_error *e, const char *name, const char *message);
202 int sd_bus_error_copy(sd_bus_error *dest, const sd_bus_error *e);
203 int sd_bus_error_is_set(const sd_bus_error *e);
204 int sd_bus_error_has_name(const sd_bus_error *e, const char *name);