2 * Copyright (C) 2013 Kay Sievers
3 * Copyright (C) 2013 Greg Kroah-Hartman <gregkh@linuxfoundation.org>
4 * Copyright (C) 2013 Linux Foundation
5 * Copyright (C) 2013 Lennart Poettering
6 * Copyright (C) 2013 Daniel Mack <daniel@zonque.org>
8 * kdbus is free software; you can redistribute it and/or modify it under
9 * the terms of the GNU Lesser General Public License as published by the
10 * Free Software Foundation; either version 2.1 of the License, or (at
11 * your option) any later version.
18 #include <sys/ioctl.h>
19 #include <sys/types.h>
20 #include <linux/types.h>
23 /* todo #define KDBUS_MSG_MAX_PAYLOAD_VEC_SIZE SZ_8M - maximum size of message header and items
24 * taken from internal.h of kdbus
25 * finally it should be placed higher - e.g. kdbus.h of kdbus kernel module
27 #define KDBUS_MSG_MAX_PAYLOAD_VEC_SIZE 0x00800000 /* maximum size of message header and items */
29 #define KDBUS_IOC_MAGIC 0x95
30 #define KDBUS_SRC_ID_KERNEL (0)
31 #define KDBUS_DST_ID_WELL_KNOWN_NAME (0)
32 #define KDBUS_MATCH_SRC_ID_ANY (~0ULL)
33 #define KDBUS_DST_ID_BROADCAST (~0ULL)
35 /* Common first elements in a structure which are used to iterate over
36 * a list of elements. */
37 #define KDBUS_PART_HEADER \
43 /* Message sent from kernel to userspace, when the owner or starter of
44 * a well-known name changes */
45 struct kdbus_manager_msg_name_change {
48 __u64 flags; /* 0 or (possibly?) KDBUS_NAME_IN_QUEUE */
52 struct kdbus_manager_msg_id_change {
54 __u64 flags; /* The kernel flags field from KDBUS_HELLO */
63 /* The starttime of the process PID. This is useful to detect
64 PID overruns from the client side. i.e. if you use the PID to
65 look something up in /proc/$PID/ you can afterwards check the
66 starttime field of it to ensure you didn't run into a PID
76 struct kdbus_timestamp {
95 /* Message Item Types */
99 /* Filled in by userspace */
100 KDBUS_MSG_PAYLOAD_VEC, /* .data_vec, reference to memory area */
101 KDBUS_MSG_PAYLOAD_OFF, /* .data_vec, reference to memory area */
102 KDBUS_MSG_PAYLOAD_MEMFD, /* file descriptor of a special data file */
103 KDBUS_MSG_FDS, /* .data_fds of file descriptors */
104 KDBUS_MSG_BLOOM, /* for broadcasts, carries bloom filter blob in .data */
105 KDBUS_MSG_DST_NAME, /* destination's well-known name, in .str */
106 KDBUS_MSG_PRIORITY, /* queue priority for message */
108 /* Filled in by kernelspace */
109 KDBUS_MSG_SRC_NAMES = 0x400,/* NUL separated string list with well-known names of source */
110 KDBUS_MSG_TIMESTAMP, /* .timestamp */
111 KDBUS_MSG_SRC_CREDS, /* .creds */
112 KDBUS_MSG_SRC_PID_COMM, /* optional, in .str */
113 KDBUS_MSG_SRC_TID_COMM, /* optional, in .str */
114 KDBUS_MSG_SRC_EXE, /* optional, in .str */
115 KDBUS_MSG_SRC_CMDLINE, /* optional, in .str (a chain of NUL str) */
116 KDBUS_MSG_SRC_CGROUP, /* optional, in .str */
117 KDBUS_MSG_SRC_CAPS, /* caps data blob, in .data */
118 KDBUS_MSG_SRC_SECLABEL, /* NUL terminated string, in .str */
119 KDBUS_MSG_SRC_AUDIT, /* .audit */
121 /* Special messages from kernel, consisting of one and only one of these data blocks */
122 KDBUS_MSG_NAME_ADD = 0x800,/* .name_change */
123 KDBUS_MSG_NAME_REMOVE, /* .name_change */
124 KDBUS_MSG_NAME_CHANGE, /* .name_change */
125 KDBUS_MSG_ID_ADD, /* .id_change */
126 KDBUS_MSG_ID_REMOVE, /* .id_change */
127 KDBUS_MSG_REPLY_TIMEOUT, /* empty, but .reply_cookie in .kdbus_msg is filled in */
128 KDBUS_MSG_REPLY_DEAD, /* dito */
132 * struct kdbus_item - chain of data blocks
134 * size: overall data record size
135 * type: kdbus_item type of data
150 struct kdbus_vec vec;
152 /* process credentials and properties*/
153 struct kdbus_creds creds;
154 struct kdbus_audit audit;
155 struct kdbus_timestamp timestamp;
157 /* specific fields */
158 struct kdbus_memfd memfd;
160 struct kdbus_manager_msg_name_change name_change;
161 struct kdbus_manager_msg_id_change id_change;
166 KDBUS_MSG_FLAGS_EXPECT_REPLY = 1 << 0,
167 KDBUS_MSG_FLAGS_NO_AUTO_START = 1 << 1,
171 KDBUS_PAYLOAD_KERNEL,
172 KDBUS_PAYLOAD_DBUS1 = 0x4442757356657231ULL, /* 'DBusVer1' */
173 KDBUS_PAYLOAD_GVARIANT = 0x4756617269616e74ULL, /* 'GVariant' */
180 * dst_id: destination id
181 * flags: KDBUS_MSG_FLAGS_*
182 * items: data records
185 * src_id: who sent the message
190 __u64 dst_id; /* connection, 0 == name in data, ~0 broadcast */
191 __u64 src_id; /* connection, 0 == kernel */
192 __u64 payload_type; /* 'DBusVer1', 'GVariant', ... */
193 __u64 cookie; /* userspace-supplied cookie */
195 __u64 cookie_reply; /* cookie we reply to */
196 __u64 timeout_ns; /* timespan to wait for reply */
198 struct kdbus_item items[0];
208 _KDBUS_POLICY_ACCESS_NULL,
209 KDBUS_POLICY_ACCESS_USER,
210 KDBUS_POLICY_ACCESS_GROUP,
211 KDBUS_POLICY_ACCESS_WORLD,
215 KDBUS_POLICY_RECV = 1 << 2,
216 KDBUS_POLICY_SEND = 1 << 1,
217 KDBUS_POLICY_OWN = 1 << 0,
220 struct kdbus_policy_access {
221 __u64 type; /* USER, GROUP, WORLD */
222 __u64 bits; /* RECV, SEND, OWN */
223 __u64 id; /* uid, gid, 0 */
226 //FIXME: convert access to access[]
227 struct kdbus_policy {
231 struct kdbus_policy_access access;
235 /* A series of KDBUS_POLICY_NAME, plus one or more KDBUS_POLICY_ACCESS */
236 struct kdbus_cmd_policy {
238 struct kdbus_policy policies[0];
241 /* Flags for struct kdbus_cmd_hello */
243 KDBUS_HELLO_STARTER = 1 << 0,
244 KDBUS_HELLO_ACCEPT_FD = 1 << 1,
246 /* The following have an effect on directed messages only --
247 * not for broadcasts */
248 KDBUS_HELLO_ATTACH_COMM = 1 << 10,
249 KDBUS_HELLO_ATTACH_EXE = 1 << 11,
250 KDBUS_HELLO_ATTACH_CMDLINE = 1 << 12,
251 KDBUS_HELLO_ATTACH_CGROUP = 1 << 13,
252 KDBUS_HELLO_ATTACH_CAPS = 1 << 14,
253 KDBUS_HELLO_ATTACH_SECLABEL = 1 << 15,
254 KDBUS_HELLO_ATTACH_AUDIT = 1 << 16,
257 struct kdbus_cmd_hello {
260 /* userspace → kernel, kernel → userspace */
261 __u64 conn_flags; /* userspace specifies its
262 * capabilities and more, kernel
263 * returns its capabilites and
264 * more. Kernel might refuse client's
265 * capabilities by returning an error
266 * from KDBUS_HELLO */
268 /* kernel → userspace */
269 __u64 bus_flags; /* this is .flags copied verbatim from
270 * from original KDBUS_CMD_BUS_MAKE
271 * ioctl. It's intended to be useful
272 * to do negotiation of features of
273 * the payload that is transfreted. */
274 __u64 id; /* id assigned to this connection */
275 __u64 bloom_size; /* The bloom filter size chosen by the
277 __u64 pool_size; /* maximum size of pool buffer */
278 struct kdbus_item items[0];
281 /* Flags for kdbus_cmd_{bus,ep,ns}_make */
283 KDBUS_MAKE_ACCESS_GROUP = 1 << 0,
284 KDBUS_MAKE_ACCESS_WORLD = 1 << 1,
285 KDBUS_MAKE_POLICY_OPEN = 1 << 2,
288 /* Items to append to kdbus_cmd_{bus,ep,ns}_make */
292 KDBUS_MAKE_CGROUP, /* the cgroup hierarchy ID for which to attach
293 * cgroup membership paths to messages.
294 * FIXME: remove, use *the* hierarchy */
295 KDBUS_MAKE_CRED, /* allow translator services which connect
296 * to the bus on behalf of somebody else,
297 * allow specifiying the credentials of the
298 * client to connect on behalf on. Needs
302 struct kdbus_cmd_bus_make {
304 __u64 flags; /* userspace → kernel, kernel → userspace
305 * When creating a bus feature
306 * kernel negotiation. */
307 __u64 bus_flags; /* userspace → kernel
308 * When a bus is created this value is
309 * copied verbatim into the bus
310 * structure and returned from
311 * KDBUS_CMD_HELLO, later */
312 __u64 bloom_size; /* size of the bloom filter for this bus */
313 struct kdbus_item items[0];
316 struct kdbus_cmd_ep_make {
318 __u64 flags; /* userspace → kernel, kernel → userspace
319 * When creating an entry point
320 * feature kernel negotiation done the
322 * KDBUS_CMD_BUS_MAKE. Unused for
324 struct kdbus_item items[0];
327 struct kdbus_cmd_ns_make {
329 __u64 flags; /* userspace → kernel, kernel → userspace
330 * When creating an entry point
331 * feature kernel negotiation done the
333 * KDBUS_CMD_BUS_MAKE. Unused for
335 struct kdbus_item items[0];
339 /* userspace → kernel */
340 KDBUS_NAME_REPLACE_EXISTING = 1 << 0,
341 KDBUS_NAME_QUEUE = 1 << 1,
342 KDBUS_NAME_ALLOW_REPLACEMENT = 1 << 2,
344 /* kernel → userspace */
345 KDBUS_NAME_IN_QUEUE = 1 << 16,
348 /* We allow (de)regestration of names of other peers */
349 struct kdbus_cmd_name {
357 struct kdbus_cmd_names {
359 struct kdbus_cmd_name names[0];
363 _KDBUS_NAME_INFO_ITEM_NULL,
364 KDBUS_NAME_INFO_ITEM_NAME, /* userspace → kernel */
365 KDBUS_NAME_INFO_ITEM_SECLABEL, /* kernel → userspace */
366 KDBUS_NAME_INFO_ITEM_AUDIT, /* kernel → userspace */
369 struct kdbus_cmd_name_info {
370 __u64 size; /* overall size of info */
372 __u64 id; /* either ID, or 0 and _ITEM_NAME follows */
373 struct kdbus_creds creds;
374 struct kdbus_item items[0]; /* list of item records */
379 KDBUS_MATCH_BLOOM, /* Matches a mask blob against KDBUS_MSG_BLOOM */
380 KDBUS_MATCH_SRC_NAME, /* Matches a name string against KDBUS_MSG_SRC_NAMES */
381 KDBUS_MATCH_NAME_ADD, /* Matches a name string against KDBUS_MSG_NAME_ADD */
382 KDBUS_MATCH_NAME_REMOVE, /* Matches a name string against KDBUS_MSG_NAME_REMOVE */
383 KDBUS_MATCH_NAME_CHANGE, /* Matches a name string against KDBUS_MSG_NAME_CHANGE */
384 KDBUS_MATCH_ID_ADD, /* Matches an ID against KDBUS_MSG_ID_ADD */
385 KDBUS_MATCH_ID_REMOVE, /* Matches an ID against KDBUS_MSG_ID_REMOVE */
388 struct kdbus_cmd_match {
390 __u64 id; /* We allow registration/deregestration of matches for other peers */
391 __u64 cookie; /* userspace supplied cookie; when removing; kernel deletes everything with same cookie */
392 __u64 src_id; /* ~0: any. other: exact unique match */
393 struct kdbus_item items[0];
396 struct kdbus_cmd_monitor {
397 __u64 id; /* We allow setting the monitor flag of other peers */
398 unsigned int enable; /* A boolean to enable/disable monitoring */
403 * control nodes: unset
404 * bus owner (via KDBUS_CMD_BUS_MAKE)
405 * ns owner (via KDBUS_CMD_NS_MAKE)
408 * connected (via KDBUS_CMD_HELLO)
409 * starter (via KDBUS_CMD_HELLO with KDBUS_CMD_HELLO_STARTER)
410 * ep owner (via KDBUS_CMD_EP_MAKE)
413 /* kdbus control node commands: require unset state */
414 KDBUS_CMD_BUS_MAKE = _IOW(KDBUS_IOC_MAGIC, 0x00, struct kdbus_cmd_bus_make),
415 KDBUS_CMD_NS_MAKE = _IOR(KDBUS_IOC_MAGIC, 0x10, struct kdbus_cmd_ns_make),
417 /* kdbus ep node commands: require unset state */
418 KDBUS_CMD_EP_MAKE = _IOW(KDBUS_IOC_MAGIC, 0x20, struct kdbus_cmd_ep_make),
419 KDBUS_CMD_HELLO = _IOWR(KDBUS_IOC_MAGIC, 0x30, struct kdbus_cmd_hello),
421 /* kdbus ep node commands: require connected state */
422 KDBUS_CMD_MSG_SEND = _IOW(KDBUS_IOC_MAGIC, 0x40, struct kdbus_msg),
423 KDBUS_CMD_MSG_RECV = _IOR(KDBUS_IOC_MAGIC, 0x41, __u64 *),
424 KDBUS_CMD_MSG_RELEASE = _IOW(KDBUS_IOC_MAGIC, 0x42, __u64 *),
426 KDBUS_CMD_NAME_ACQUIRE = _IOWR(KDBUS_IOC_MAGIC, 0x50, struct kdbus_cmd_name),
427 KDBUS_CMD_NAME_RELEASE = _IOW(KDBUS_IOC_MAGIC, 0x51, struct kdbus_cmd_name),
428 KDBUS_CMD_NAME_LIST = _IOWR(KDBUS_IOC_MAGIC, 0x52, struct kdbus_cmd_names),
429 KDBUS_CMD_NAME_QUERY = _IOWR(KDBUS_IOC_MAGIC, 0x53, struct kdbus_cmd_name_info),
431 KDBUS_CMD_MATCH_ADD = _IOW(KDBUS_IOC_MAGIC, 0x60, struct kdbus_cmd_match),
432 KDBUS_CMD_MATCH_REMOVE = _IOW(KDBUS_IOC_MAGIC, 0x61, struct kdbus_cmd_match),
433 KDBUS_CMD_MONITOR = _IOW(KDBUS_IOC_MAGIC, 0x62, struct kdbus_cmd_monitor),
435 /* kdbus ep node commands: require ep owner state */
436 KDBUS_CMD_EP_POLICY_SET = _IOW(KDBUS_IOC_MAGIC, 0x70, struct kdbus_cmd_policy),
438 /* kdbus memfd commands: */
439 KDBUS_CMD_MEMFD_NEW = _IOR(KDBUS_IOC_MAGIC, 0x80, int *),
440 KDBUS_CMD_MEMFD_SIZE_GET = _IOR(KDBUS_IOC_MAGIC, 0x81, __u64 *),
441 KDBUS_CMD_MEMFD_SIZE_SET = _IOW(KDBUS_IOC_MAGIC, 0x82, __u64 *),
442 KDBUS_CMD_MEMFD_SEAL_GET = _IOR(KDBUS_IOC_MAGIC, 0x83, int *),
443 KDBUS_CMD_MEMFD_SEAL_SET = _IO(KDBUS_IOC_MAGIC, 0x84),