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 #define KDBUS_IOC_MAGIC 0x95
24 #define KDBUS_SRC_ID_KERNEL (0)
25 #define KDBUS_DST_ID_WELL_KNOWN_NAME (0)
26 #define KDBUS_MATCH_SRC_ID_ANY (~0ULL)
27 #define KDBUS_DST_ID_BROADCAST (~0ULL)
29 /* Common first elements in a structure which are used to iterate over
30 * a list of elements. */
31 #define KDBUS_PART_HEADER \
37 /* Message sent from kernel to userspace, when the owner or starter of
38 * a well-known name changes */
39 struct kdbus_notify_name_change {
42 __u64 flags; /* 0 or (possibly?) KDBUS_NAME_IN_QUEUE */
46 struct kdbus_notify_id_change {
48 __u64 flags; /* The kernel flags field from KDBUS_HELLO */
57 /* The starttime of the process PID. This is useful to detect
58 PID overruns from the client side. i.e. if you use the PID to
59 look something up in /proc/$PID/ you can afterwards check the
60 starttime field of it to ensure you didn't run into a PID
70 struct kdbus_timestamp {
89 /* Message Item Types */
93 /* Filled in by userspace */
94 _KDBUS_ITEM_USER_BASE = 1,
95 KDBUS_ITEM_PAYLOAD_VEC = 1,/* .data_vec, reference to memory area */
96 KDBUS_ITEM_PAYLOAD_OFF, /* .data_vec, reference to memory area */
97 KDBUS_ITEM_PAYLOAD_MEMFD, /* file descriptor of a special data file */
98 KDBUS_ITEM_FDS, /* .data_fds of file descriptors */
99 KDBUS_ITEM_BLOOM, /* for broadcasts, carries bloom filter blob in .data */
100 KDBUS_ITEM_DST_NAME, /* destination's well-known name, in .str */
101 KDBUS_ITEM_PRIORITY, /* queue priority for message */
103 /* Filled in by kernelspace */
104 _KDBUS_ITEM_ATTACH_BASE = 0x400,
105 KDBUS_ITEM_NAMES = 0x400,/* NUL separated string list with well-known names of source */
106 KDBUS_ITEM_TIMESTAMP, /* .timestamp */
108 /* when appended to a message, the following items refer to the sender */
109 KDBUS_ITEM_CREDS, /* .creds */
110 KDBUS_ITEM_PID_COMM, /* optional, in .str */
111 KDBUS_ITEM_TID_COMM, /* optional, in .str */
112 KDBUS_ITEM_EXE, /* optional, in .str */
113 KDBUS_ITEM_CMDLINE, /* optional, in .str (a chain of NUL str) */
114 KDBUS_ITEM_CGROUP, /* optional, in .str */
115 KDBUS_ITEM_CAPS, /* caps data blob, in .data */
116 KDBUS_ITEM_SECLABEL, /* NUL terminated string, in .str */
117 KDBUS_ITEM_AUDIT, /* .audit */
119 /* Special messages from kernel, consisting of one and only one of these data blocks */
120 _KDBUS_ITEM_KERNEL_BASE = 0x800,
121 KDBUS_ITEM_NAME_ADD = 0x800,/* .name_change */
122 KDBUS_ITEM_NAME_REMOVE, /* .name_change */
123 KDBUS_ITEM_NAME_CHANGE, /* .name_change */
124 KDBUS_ITEM_ID_ADD, /* .id_change */
125 KDBUS_ITEM_ID_REMOVE, /* .id_change */
126 KDBUS_ITEM_REPLY_TIMEOUT, /* empty, but .reply_cookie in .kdbus_msg is filled in */
127 KDBUS_ITEM_REPLY_DEAD, /* dito */
131 * struct kdbus_item - chain of data blocks
133 * size: overall data record size
134 * type: kdbus_item type of data
149 struct kdbus_vec vec;
151 /* process credentials and properties*/
152 struct kdbus_creds creds;
153 struct kdbus_audit audit;
154 struct kdbus_timestamp timestamp;
156 /* specific fields */
157 struct kdbus_memfd memfd;
159 struct kdbus_notify_name_change name_change;
160 struct kdbus_notify_id_change id_change;
165 KDBUS_MSG_FLAGS_EXPECT_REPLY = 1 << 0,
166 KDBUS_MSG_FLAGS_NO_AUTO_START = 1 << 1,
170 KDBUS_PAYLOAD_KERNEL,
171 KDBUS_PAYLOAD_DBUS1 = 0x4442757356657231ULL, /* 'DBusVer1' */
172 KDBUS_PAYLOAD_GVARIANT = 0x4756617269616e74ULL, /* 'GVariant' */
179 * dst_id: destination id
180 * flags: KDBUS_MSG_FLAGS_*
181 * items: data records
184 * src_id: who sent the message
189 __u64 dst_id; /* connection, 0 == name in data, ~0 broadcast */
190 __u64 src_id; /* connection, 0 == kernel */
191 __u64 payload_type; /* 'DBusVer1', 'GVariant', ... */
192 __u64 cookie; /* userspace-supplied cookie */
194 __u64 cookie_reply; /* cookie we reply to */
195 __u64 timeout_ns; /* timespan to wait for reply */
197 struct kdbus_item items[0];
207 _KDBUS_POLICY_ACCESS_NULL,
208 KDBUS_POLICY_ACCESS_USER,
209 KDBUS_POLICY_ACCESS_GROUP,
210 KDBUS_POLICY_ACCESS_WORLD,
214 KDBUS_POLICY_RECV = 1 << 2,
215 KDBUS_POLICY_SEND = 1 << 1,
216 KDBUS_POLICY_OWN = 1 << 0,
219 struct kdbus_policy_access {
220 __u64 type; /* USER, GROUP, WORLD */
221 __u64 bits; /* RECV, SEND, OWN */
222 __u64 id; /* uid, gid, 0 */
225 //FIXME: convert access to access[]
226 struct kdbus_policy {
230 struct kdbus_policy_access access;
234 /* A series of KDBUS_POLICY_NAME, plus one or more KDBUS_POLICY_ACCESS */
235 struct kdbus_cmd_policy {
237 struct kdbus_policy policies[0];
240 /* Flags for struct kdbus_cmd_hello */
242 KDBUS_HELLO_STARTER = 1 << 0,
243 KDBUS_HELLO_ACCEPT_FD = 1 << 1,
246 /* Flags for message attachments */
248 KDBUS_ATTACH_TIMESTAMP = 1 << 0,
249 KDBUS_ATTACH_CREDS = 1 << 1,
250 KDBUS_ATTACH_NAMES = 1 << 2,
251 KDBUS_ATTACH_COMM = 1 << 3,
252 KDBUS_ATTACH_EXE = 1 << 4,
253 KDBUS_ATTACH_CMDLINE = 1 << 5,
254 KDBUS_ATTACH_CGROUP = 1 << 6,
255 KDBUS_ATTACH_CAPS = 1 << 7,
256 KDBUS_ATTACH_SECLABEL = 1 << 8,
257 KDBUS_ATTACH_AUDIT = 1 << 9,
260 struct kdbus_cmd_hello {
263 /* userspace → kernel, kernel → userspace */
264 __u64 conn_flags; /* userspace specifies its
265 * capabilities and more, kernel
266 * returns its capabilites and
267 * more. Kernel might refuse client's
268 * capabilities by returning an error
269 * from KDBUS_HELLO */
270 __u64 attach_flags; /* userspace specifies the metadata
271 * attachments it wishes to receive with
274 /* kernel → userspace */
275 __u64 bus_flags; /* this is .flags copied verbatim from
276 * from original KDBUS_CMD_BUS_MAKE
277 * ioctl. It's intended to be useful
278 * to do negotiation of features of
279 * the payload that is transfreted. */
280 __u64 id; /* id assigned to this connection */
281 __u64 bloom_size; /* The bloom filter size chosen by the
283 __u64 pool_size; /* maximum size of pool buffer */
284 __u8 id128[16]; /* the unique id of the bus */
286 struct kdbus_item items[0];
289 /* Flags for kdbus_cmd_{bus,ep,ns}_make */
291 KDBUS_MAKE_ACCESS_GROUP = 1 << 0,
292 KDBUS_MAKE_ACCESS_WORLD = 1 << 1,
293 KDBUS_MAKE_POLICY_OPEN = 1 << 2,
296 /* Items to append to kdbus_cmd_{bus,ep,ns}_make */
300 KDBUS_MAKE_CRED, /* allow translator services which connect
301 * to the bus on behalf of somebody else,
302 * allow specifying the credentials of the
303 * client to connect on behalf on. Needs
307 struct kdbus_cmd_bus_make {
309 __u64 flags; /* userspace → kernel, kernel → userspace
310 * When creating a bus feature
311 * kernel negotiation. */
312 __u64 bus_flags; /* userspace → kernel
313 * When a bus is created this value is
314 * copied verbatim into the bus
315 * structure and returned from
316 * KDBUS_CMD_HELLO, later */
317 __u64 bloom_size; /* size of the bloom filter for this bus */
318 struct kdbus_item items[0];
321 struct kdbus_cmd_ep_make {
323 __u64 flags; /* userspace → kernel, kernel → userspace
324 * When creating an entry point
325 * feature kernel negotiation done the
327 * KDBUS_CMD_BUS_MAKE. Unused for
329 struct kdbus_item items[0];
332 struct kdbus_cmd_ns_make {
334 __u64 flags; /* userspace → kernel, kernel → userspace
335 * When creating an entry point
336 * feature kernel negotiation done the
338 * KDBUS_CMD_BUS_MAKE. Unused for
340 struct kdbus_item items[0];
344 /* userspace → kernel */
345 KDBUS_NAME_REPLACE_EXISTING = 1 << 0,
346 KDBUS_NAME_QUEUE = 1 << 1,
347 KDBUS_NAME_ALLOW_REPLACEMENT = 1 << 2,
349 /* kernel → userspace */
350 KDBUS_NAME_IN_QUEUE = 1 << 16,
353 /* We allow (de)regestration of names of other peers */
354 struct kdbus_cmd_name {
363 KDBUS_NAME_LIST_UNIQUE_NAMES = 1 << 0,
366 struct kdbus_cmd_names {
369 struct kdbus_cmd_name names[0];
373 _KDBUS_NAME_INFO_ITEM_NULL,
374 KDBUS_NAME_INFO_ITEM_NAME, /* userspace → kernel */
375 KDBUS_NAME_INFO_ITEM_SECLABEL, /* kernel → userspace */
376 KDBUS_NAME_INFO_ITEM_AUDIT, /* kernel → userspace */
379 struct kdbus_cmd_name_info {
380 __u64 size; /* overall size of info */
381 __u64 flags; /* query flags */
382 __u64 attach_flags; /* which meta data payload to attach */
383 __u64 id; /* either ID, or 0 and _ITEM_NAME follows */
384 struct kdbus_creds creds;
385 struct kdbus_item items[0]; /* list of item records */
390 KDBUS_MATCH_BLOOM, /* Matches a mask blob against KDBUS_MSG_BLOOM */
391 KDBUS_MATCH_SRC_NAME, /* Matches a name string against KDBUS_MSG_SRC_NAMES */
392 KDBUS_MATCH_NAME_ADD, /* Matches a name string against KDBUS_MSG_NAME_ADD */
393 KDBUS_MATCH_NAME_REMOVE, /* Matches a name string against KDBUS_MSG_NAME_REMOVE */
394 KDBUS_MATCH_NAME_CHANGE, /* Matches a name string against KDBUS_MSG_NAME_CHANGE */
395 KDBUS_MATCH_ID_ADD, /* Matches an ID against KDBUS_MSG_ID_ADD */
396 KDBUS_MATCH_ID_REMOVE, /* Matches an ID against KDBUS_MSG_ID_REMOVE */
399 struct kdbus_cmd_match {
401 __u64 id; /* We allow registration/deregestration of matches for other peers */
402 __u64 cookie; /* userspace supplied cookie; when removing; kernel deletes everything with same cookie */
403 __u64 src_id; /* ~0: any. other: exact unique match */
404 struct kdbus_item items[0];
407 struct kdbus_cmd_monitor {
408 __u64 id; /* We allow setting the monitor flag of other peers */
409 unsigned int enable; /* A boolean to enable/disable monitoring */
414 * control nodes: unset
415 * bus owner (via KDBUS_CMD_BUS_MAKE)
416 * ns owner (via KDBUS_CMD_NS_MAKE)
419 * connected (via KDBUS_CMD_HELLO)
420 * starter (via KDBUS_CMD_HELLO with KDBUS_CMD_HELLO_STARTER)
421 * ep owner (via KDBUS_CMD_EP_MAKE)
424 /* kdbus control node commands: require unset state */
425 KDBUS_CMD_BUS_MAKE = _IOW(KDBUS_IOC_MAGIC, 0x00, struct kdbus_cmd_bus_make),
426 KDBUS_CMD_NS_MAKE = _IOR(KDBUS_IOC_MAGIC, 0x10, struct kdbus_cmd_ns_make),
428 /* kdbus ep node commands: require unset state */
429 KDBUS_CMD_EP_MAKE = _IOW(KDBUS_IOC_MAGIC, 0x20, struct kdbus_cmd_ep_make),
430 KDBUS_CMD_HELLO = _IOWR(KDBUS_IOC_MAGIC, 0x30, struct kdbus_cmd_hello),
432 /* kdbus ep node commands: require connected state */
433 KDBUS_CMD_MSG_SEND = _IOW(KDBUS_IOC_MAGIC, 0x40, struct kdbus_msg),
434 KDBUS_CMD_MSG_RECV = _IOR(KDBUS_IOC_MAGIC, 0x41, __u64 *),
435 KDBUS_CMD_MSG_RELEASE = _IOW(KDBUS_IOC_MAGIC, 0x42, __u64 *),
437 KDBUS_CMD_NAME_ACQUIRE = _IOWR(KDBUS_IOC_MAGIC, 0x50, struct kdbus_cmd_name),
438 KDBUS_CMD_NAME_RELEASE = _IOW(KDBUS_IOC_MAGIC, 0x51, struct kdbus_cmd_name),
439 KDBUS_CMD_NAME_LIST = _IOWR(KDBUS_IOC_MAGIC, 0x52, struct kdbus_cmd_names),
440 KDBUS_CMD_NAME_QUERY = _IOWR(KDBUS_IOC_MAGIC, 0x53, struct kdbus_cmd_name_info),
442 KDBUS_CMD_MATCH_ADD = _IOW(KDBUS_IOC_MAGIC, 0x60, struct kdbus_cmd_match),
443 KDBUS_CMD_MATCH_REMOVE = _IOW(KDBUS_IOC_MAGIC, 0x61, struct kdbus_cmd_match),
444 KDBUS_CMD_MONITOR = _IOW(KDBUS_IOC_MAGIC, 0x62, struct kdbus_cmd_monitor),
446 /* kdbus ep node commands: require ep owner state */
447 KDBUS_CMD_EP_POLICY_SET = _IOW(KDBUS_IOC_MAGIC, 0x70, struct kdbus_cmd_policy),
449 /* kdbus memfd commands: */
450 KDBUS_CMD_MEMFD_NEW = _IOR(KDBUS_IOC_MAGIC, 0x80, int *),
451 KDBUS_CMD_MEMFD_SIZE_GET = _IOR(KDBUS_IOC_MAGIC, 0x81, __u64 *),
452 KDBUS_CMD_MEMFD_SIZE_SET = _IOW(KDBUS_IOC_MAGIC, 0x82, __u64 *),
453 KDBUS_CMD_MEMFD_SEAL_GET = _IOR(KDBUS_IOC_MAGIC, 0x83, int *),
454 KDBUS_CMD_MEMFD_SEAL_SET = _IO(KDBUS_IOC_MAGIC, 0x84),