2 * Copyright (C) 2013-2014 Kay Sievers
3 * Copyright (C) 2013-2014 Greg Kroah-Hartman <gregkh@linuxfoundation.org>
4 * Copyright (C) 2013-2014 Linux Foundation
5 * Copyright (C) 2013-2014 Lennart Poettering
6 * Copyright (C) 2013-2014 Daniel Mack <daniel@zonque.org>
7 * Copyright (C) 2013-2014 David Herrmann <dh.herrmann@gmail.com>
9 * kdbus is free software; you can redistribute it and/or modify it under
10 * the terms of the GNU Lesser General Public License as published by the
11 * Free Software Foundation; either version 2.1 of the License, or (at
12 * your option) any later version.
14 * "Everything should be made as simple as possible, but not simpler."
18 #ifndef _KDBUS_UAPI_H_
19 #define _KDBUS_UAPI_H_
21 #include <linux/ioctl.h>
22 #include <linux/types.h>
24 #define KDBUS_IOCTL_MAGIC 0x95
25 #define KDBUS_SRC_ID_KERNEL (0)
26 #define KDBUS_DST_ID_NAME (0)
27 #define KDBUS_MATCH_ID_ANY (~0ULL)
28 #define KDBUS_DST_ID_BROADCAST (~0ULL)
29 #define KDBUS_FLAG_KERNEL (1ULL << 63)
32 * struct kdbus_notify_id_change - name registry change message
33 * @id: New or former owner of the name
34 * @flags: flags field from KDBUS_HELLO_*
36 * Sent from kernel to userspace when the owner or activator of
37 * a well-known name changes.
41 * KDBUS_ITEM_ID_REMOVE
43 struct kdbus_notify_id_change {
49 * struct kdbus_notify_name_change - name registry change message
50 * @old_id: ID and flags of former owner of a name
51 * @new_id: ID and flags of new owner of a name
52 * @name: Well-known name
54 * Sent from kernel to userspace when the owner or activator of
55 * a well-known name changes.
59 * KDBUS_ITEM_NAME_REMOVE
60 * KDBUS_ITEM_NAME_CHANGE
62 struct kdbus_notify_name_change {
63 struct kdbus_notify_id_change old_id;
64 struct kdbus_notify_id_change new_id;
69 * struct kdbus_creds - process credentials
74 * @starttime: Starttime of the process
76 * The starttime of the process PID. This is useful to detect PID overruns
77 * from the client side. i.e. if you use the PID to look something up in
78 * /proc/$PID/ you can afterwards check the starttime field of it, to ensure
79 * you didn't run into a PID overrun.
93 * struct kdbus_audit - audit information
94 * @sessionid: The audit session ID
95 * @loginuid: The audit login uid
106 * struct kdbus_timestamp
107 * @seqnum: Global per-domain message sequence number
108 * @monotonic_ns: Monotonic timestamp, in nanoseconds
109 * @realtime_ns: Realtime timestamp, in nanoseconds
112 * KDBUS_ITEM_TIMESTAMP
114 struct kdbus_timestamp {
121 * struct kdbus_vec - I/O vector for kdbus payload items
122 * @size: The size of the vector
123 * @address: Memory address of data buffer
124 * @offset: Offset in the in-message payload memory,
125 * relative to the message head
128 * KDBUS_ITEM_PAYLOAD_VEC, KDBUS_ITEM_PAYLOAD_OFF
139 * struct kdbus_bloom_parameter - bus-wide bloom parameters
140 * @size: Size of the bit field in bytes (m / 8)
141 * @n_hash: Number of hash functions used (k)
143 struct kdbus_bloom_parameter {
149 * struct kdbus_bloom_filter - bloom filter containing n elements
150 * @generation: Generation of the element set in the filter
151 * @data: Bit field, multiple of 8 bytes
153 struct kdbus_bloom_filter {
159 * struct kdbus_memfd - a kdbus memfd
160 * @size: The memfd's size
161 * @fd: The file descriptor number
162 * @__pad: Padding to ensure proper alignment and size
165 * KDBUS_ITEM_PAYLOAD_MEMFD
174 * struct kdbus_name - a registered well-known name with its flags
175 * @flags: Flags from KDBUS_NAME_*
176 * @name: Well-known name
187 * struct kdbus_policy_access - policy access item
188 * @type: One of KDBUS_POLICY_ACCESS_* types
189 * @access: Access to grant
190 * @id: For KDBUS_POLICY_ACCESS_USER, the uid
191 * For KDBUS_POLICY_ACCESS_GROUP, the gid
193 struct kdbus_policy_access {
194 __u64 type; /* USER, GROUP, WORLD */
195 __u64 access; /* OWN, TALK, SEE */
196 __u64 id; /* uid, gid, 0 */
200 * enum kdbus_item_type - item types to chain data in a list
201 * @_KDBUS_ITEM_NULL: Uninitialized/invalid
202 * @_KDBUS_ITEM_USER_BASE: Start of user items
203 * @KDBUS_ITEM_PAYLOAD_VEC: Vector to data
204 * @KDBUS_ITEM_PAYLOAD_OFF: Data at returned offset to message head
205 * @KDBUS_ITEM_PAYLOAD_MEMFD: Data as sealed memfd
206 * @KDBUS_ITEM_FDS: Attached file descriptors
207 * @KDBUS_ITEM_BLOOM_PARAMETER: Bus-wide bloom parameters, used with
208 * KDBUS_CMD_BUS_MAKE, carries a
209 * struct kdbus_bloom_parameter
210 * @KDBUS_ITEM_BLOOM_FILTER: Bloom filter carried with a message, used to
211 * match against a bloom mask of a connection,
212 * carries a struct kdbus_bloom_filter
213 * @KDBUS_ITEM_BLOOM_MASK: Bloom mask used to match against a message's
215 * @KDBUS_ITEM_DST_NAME: Destination's well-known name
216 * @KDBUS_ITEM_MAKE_NAME: Name of domain, bus, endpoint
217 * @KDBUS_ITEM_ATTACH_FLAGS: Attach-flags, used for updating which metadata
218 * a connection subscribes to
219 * @_KDBUS_ITEM_ATTACH_BASE: Start of metadata attach items
220 * @KDBUS_ITEM_NAME: Well-know name with flags
221 * @KDBUS_ITEM_ID: Connection ID
222 * @KDBUS_ITEM_TIMESTAMP: Timestamp
223 * @KDBUS_ITEM_CREDS: Process credential
224 * @KDBUS_ITEM_AUXGROUPS: Auxiliary process groups
225 * @KDBUS_ITEM_PID_COMM: Process ID "comm" identifier
226 * @KDBUS_ITEM_TID_COMM: Thread ID "comm" identifier
227 * @KDBUS_ITEM_EXE: The path of the executable
228 * @KDBUS_ITEM_CMDLINE: The process command line
229 * @KDBUS_ITEM_CGROUP: The croup membership
230 * @KDBUS_ITEM_CAPS: The process capabilities
231 * @KDBUS_ITEM_SECLABEL: The security label
232 * @KDBUS_ITEM_AUDIT: The audit IDs
233 * @KDBUS_ITEM_CONN_NAME: The connection's human-readable name (debugging)
234 * @_KDBUS_ITEM_POLICY_BASE: Start of policy items
235 * @KDBUS_ITEM_POLICY_ACCESS: Policy access block
236 * @_KDBUS_ITEM_KERNEL_BASE: Start of kernel-generated message items
237 * @KDBUS_ITEM_NAME_ADD: Notify in struct kdbus_notify_name_change
238 * @KDBUS_ITEM_NAME_REMOVE: Notify in struct kdbus_notify_name_change
239 * @KDBUS_ITEM_NAME_CHANGE: Notify in struct kdbus_notify_name_change
240 * @KDBUS_ITEM_ID_ADD: Notify in struct kdbus_notify_id_change
241 * @KDBUS_ITEM_ID_REMOVE: Notify in struct kdbus_notify_id_change
242 * @KDBUS_ITEM_REPLY_TIMEOUT: Timeout has been reached
243 * @KDBUS_ITEM_REPLY_DEAD: Destination died
245 enum kdbus_item_type {
247 _KDBUS_ITEM_USER_BASE,
248 KDBUS_ITEM_PAYLOAD_VEC = _KDBUS_ITEM_USER_BASE,
249 KDBUS_ITEM_PAYLOAD_OFF,
250 KDBUS_ITEM_PAYLOAD_MEMFD,
252 KDBUS_ITEM_BLOOM_PARAMETER,
253 KDBUS_ITEM_BLOOM_FILTER,
254 KDBUS_ITEM_BLOOM_MASK,
256 KDBUS_ITEM_MAKE_NAME,
257 KDBUS_ITEM_ATTACH_FLAGS,
259 _KDBUS_ITEM_ATTACH_BASE = 0x1000,
260 KDBUS_ITEM_NAME = _KDBUS_ITEM_ATTACH_BASE,
262 KDBUS_ITEM_TIMESTAMP,
264 KDBUS_ITEM_AUXGROUPS,
273 KDBUS_ITEM_CONN_NAME,
275 _KDBUS_ITEM_POLICY_BASE = 0x2000,
276 KDBUS_ITEM_POLICY_ACCESS = _KDBUS_ITEM_POLICY_BASE,
278 _KDBUS_ITEM_KERNEL_BASE = 0x8000,
279 KDBUS_ITEM_NAME_ADD = _KDBUS_ITEM_KERNEL_BASE,
280 KDBUS_ITEM_NAME_REMOVE,
281 KDBUS_ITEM_NAME_CHANGE,
283 KDBUS_ITEM_ID_REMOVE,
284 KDBUS_ITEM_REPLY_TIMEOUT,
285 KDBUS_ITEM_REPLY_DEAD,
289 * struct kdbus_item - chain of data blocks
290 * @size: Overall data record size
291 * @type: Kdbus_item type of data
292 * @data: Generic bytes
293 * @data32: Generic 32 bit array
294 * @data64: Generic 64 bit array
295 * @str: Generic string
297 * @vec: KDBUS_ITEM_PAYLOAD_VEC
298 * @creds: KDBUS_ITEM_CREDS
299 * @audit: KDBUS_ITEM_AUDIT
300 * @timestamp: KDBUS_ITEM_TIMESTAMP
301 * @name: KDBUS_ITEM_NAME
302 * @bloom_parameter: KDBUS_ITEM_BLOOM_PARAMETER
303 * @bloom_filter: KDBUS_ITEM_BLOOM_FILTER
304 * @memfd: KDBUS_ITEM_PAYLOAD_MEMFD
305 * @name_change: KDBUS_ITEM_NAME_ADD
306 * KDBUS_ITEM_NAME_REMOVE
307 * KDBUS_ITEM_NAME_CHANGE
308 * @id_change: KDBUS_ITEM_ID_ADD
309 * KDBUS_ITEM_ID_REMOVE
310 * @policy: KDBUS_ITEM_POLICY_ACCESS
322 struct kdbus_vec vec;
323 struct kdbus_creds creds;
324 struct kdbus_audit audit;
325 struct kdbus_timestamp timestamp;
326 struct kdbus_name name;
327 struct kdbus_bloom_parameter bloom_parameter;
328 struct kdbus_bloom_filter bloom_filter;
329 struct kdbus_memfd memfd;
331 struct kdbus_notify_name_change name_change;
332 struct kdbus_notify_id_change id_change;
333 struct kdbus_policy_access policy_access;
338 * enum kdbus_msg_flags - type of message
339 * @KDBUS_MSG_FLAGS_EXPECT_REPLY: Expect a reply message, used for
340 * method calls. The userspace-supplied
341 * cookie identifies the message and the
342 * respective reply carries the cookie
344 * @KDBUS_MSG_FLAGS_SYNC_REPLY: Wait for destination connection to
345 * reply to this message. The
346 * KDBUS_CMD_MSG_SEND ioctl() will block
347 * until the reply is received, and
348 * offset_reply in struct kdbus_msg will
349 * yield the offset in the sender's pool
350 * where the reply can be found.
351 * This flag is only valid if
352 * @KDBUS_MSG_FLAGS_EXPECT_REPLY is set as
354 * @KDBUS_MSG_FLAGS_NO_AUTO_START: Do not start a service, if the addressed
355 * name is not currently active
357 enum kdbus_msg_flags {
358 KDBUS_MSG_FLAGS_EXPECT_REPLY = 1ULL << 0,
359 KDBUS_MSG_FLAGS_SYNC_REPLY = 1ULL << 1,
360 KDBUS_MSG_FLAGS_NO_AUTO_START = 1ULL << 2,
364 * enum kdbus_payload_type - type of payload carried by message
365 * @KDBUS_PAYLOAD_KERNEL: Kernel-generated simple message
366 * @KDBUS_PAYLOAD_DBUS: D-Bus marshalling "DBusDBus"
368 enum kdbus_payload_type {
369 KDBUS_PAYLOAD_KERNEL,
370 KDBUS_PAYLOAD_DBUS = 0x4442757344427573ULL,
374 * struct kdbus_msg - the representation of a kdbus message
375 * @size: Total size of the message
376 * @flags: Message flags (KDBUS_MSG_FLAGS_*)
377 * @priority: Message queue priority value
378 * @dst_id: 64-bit ID of the destination connection
379 * @src_id: 64-bit ID of the source connection
380 * @payload_type: Payload type (KDBUS_PAYLOAD_*)
381 * @cookie: Userspace-supplied cookie, for the connection
382 * to identify its messages
383 * @timeout_ns: The time to wait for a message reply from the peer.
384 * If there is no reply, a kernel-generated message
385 * with an attached KDBUS_ITEM_REPLY_TIMEOUT item
386 * is sent to @src_id.
387 * @cookie_reply: A reply to the requesting message with the same
388 * cookie. The requesting connection can match its
389 * request and the reply with this value
390 * @offset_reply: If KDBUS_MSG_FLAGS_EXPECT_REPLY, this field will
391 * contain the offset in the sender's pool where the
393 * @items: A list of kdbus_items containing the message payload
408 struct kdbus_item items[0];
409 } __attribute__((aligned(8)));
412 * enum kdbus_recv_flags - flags for de-queuing messages
413 * @KDBUS_RECV_PEEK: Return the next queued message without
414 * actually de-queuing it, and without installing
415 * any file descriptors or other resources. It is
416 * usually used to determine the activating
417 * connection of a bus name.
418 * @KDBUS_RECV_DROP: Drop and free the next queued message and all
419 * its resources without actually receiving it.
420 * @KDBUS_RECV_USE_PRIORITY: Only de-queue messages with the specified or
421 * higher priority (lowest values); if not set,
422 * the priority value is ignored.
424 enum kdbus_recv_flags {
425 KDBUS_RECV_PEEK = 1ULL << 0,
426 KDBUS_RECV_DROP = 1ULL << 1,
427 KDBUS_RECV_USE_PRIORITY = 1ULL << 2,
431 * struct kdbus_cmd_recv - struct to de-queue a buffered message
432 * @flags: KDBUS_RECV_* flags
433 * @priority: Minimum priority of the messages to de-queue. Lowest
434 * values have the highest priority.
435 * @offset: Returned offset in the pool where the message is
436 * stored. The user must use KDBUS_CMD_FREE to free
437 * the allocated memory.
439 * This struct is used with the KDBUS_CMD_MSG_RECV ioctl.
441 struct kdbus_cmd_recv {
445 } __attribute__((aligned(8)));
448 * struct kdbus_cmd_cancel - struct to cancel a synchronously pending message
449 * @cookie The cookie of the pending message
450 * @flags Flags for the free command. Currently unused.
452 * This struct is used with the KDBUS_CMD_CANCEL ioctl.
454 struct kdbus_cmd_cancel {
457 } __attribute__((aligned(8)));
460 * struct kdbus_cmd_free - struct to free a slice of memory in the pool
461 * @offset The offset of the memory slice, as returned by other
463 * @flags Flags for the free command. Currently unused.
465 * This struct is used with the KDBUS_CMD_FREE ioctl.
467 struct kdbus_cmd_free {
470 } __attribute__((aligned(8)));
473 * enum kdbus_policy_access_type - permissions of a policy record
474 * @_KDBUS_POLICY_ACCESS_NULL: Uninitialized/invalid
475 * @KDBUS_POLICY_ACCESS_USER: Grant access to a uid
476 * @KDBUS_POLICY_ACCESS_GROUP: Grant access to gid
477 * @KDBUS_POLICY_ACCESS_WORLD: World-accessible
479 enum kdbus_policy_access_type {
480 _KDBUS_POLICY_ACCESS_NULL,
481 KDBUS_POLICY_ACCESS_USER,
482 KDBUS_POLICY_ACCESS_GROUP,
483 KDBUS_POLICY_ACCESS_WORLD,
487 * enum kdbus_policy_access_flags - mode flags
488 * @KDBUS_POLICY_OWN: Allow to own a well-known name
489 * Implies KDBUS_POLICY_TALK and KDBUS_POLICY_SEE
490 * @KDBUS_POLICY_TALK: Allow communication to a well-known name
491 * Implies KDBUS_POLICY_SEE
492 * @KDBUS_POLICY_SEE: Allow to see a well-known name
494 enum kdbus_policy_type {
495 KDBUS_POLICY_SEE = 0,
501 * enum kdbus_hello_flags - flags for struct kdbus_cmd_hello
502 * @KDBUS_HELLO_ACCEPT_FD: The connection allows the reception of
503 * any passed file descriptors
504 * @KDBUS_HELLO_ACTIVATOR: Special-purpose connection which registers
505 * a well-know name for a process to be started
506 * when traffic arrives
507 * @KDBUS_HELLO_POLICY_HOLDER: Special-purpose connection which registers
508 * policy entries for a name. The provided name
509 * is not activated and not registered with the
510 * name database, it only allows unprivileged
511 * connections to aquire a name, talk or discover
513 * @KDBUS_HELLO_MONITOR: Special-purpose connection to monitor
516 enum kdbus_hello_flags {
517 KDBUS_HELLO_ACCEPT_FD = 1ULL << 0,
518 KDBUS_HELLO_ACTIVATOR = 1ULL << 1,
519 KDBUS_HELLO_POLICY_HOLDER = 1ULL << 2,
520 KDBUS_HELLO_MONITOR = 1ULL << 3,
524 * enum kdbus_attach_flags - flags for metadata attachments
525 * @KDBUS_ATTACH_TIMESTAMP: Timestamp
526 * @KDBUS_ATTACH_CREDS: Credentials
527 * @KDBUS_ATTACH_AUXGROUPS: Auxiliary groups
528 * @KDBUS_ATTACH_NAMES: Well-known names
529 * @KDBUS_ATTACH_COMM: The "comm" process identifier
530 * @KDBUS_ATTACH_EXE: The path of the executable
531 * @KDBUS_ATTACH_CMDLINE: The process command line
532 * @KDBUS_ATTACH_CGROUP: The croup membership
533 * @KDBUS_ATTACH_CAPS: The process capabilities
534 * @KDBUS_ATTACH_SECLABEL: The security label
535 * @KDBUS_ATTACH_AUDIT: The audit IDs
536 * @KDBUS_ATTACH_CONN_NAME: The human-readable connection name
537 * @_KDBUS_ATTACH_ALL: All of the above
539 enum kdbus_attach_flags {
540 KDBUS_ATTACH_TIMESTAMP = 1ULL << 0,
541 KDBUS_ATTACH_CREDS = 1ULL << 1,
542 KDBUS_ATTACH_AUXGROUPS = 1ULL << 2,
543 KDBUS_ATTACH_NAMES = 1ULL << 3,
544 KDBUS_ATTACH_COMM = 1ULL << 4,
545 KDBUS_ATTACH_EXE = 1ULL << 5,
546 KDBUS_ATTACH_CMDLINE = 1ULL << 6,
547 KDBUS_ATTACH_CGROUP = 1ULL << 7,
548 KDBUS_ATTACH_CAPS = 1ULL << 8,
549 KDBUS_ATTACH_SECLABEL = 1ULL << 9,
550 KDBUS_ATTACH_AUDIT = 1ULL << 10,
551 KDBUS_ATTACH_CONN_NAME = 1ULL << 11,
552 _KDBUS_ATTACH_ALL = (1ULL << 12) - 1,
556 * struct kdbus_cmd_hello - struct to say hello to kdbus
557 * @size: The total size of the structure
558 * @conn_flags: Connection flags (KDBUS_HELLO_*).
559 * @attach_flags: Mask of metadata to attach to each message sent
561 * @bus_flags: The flags field copied verbatim from the original
562 * KDBUS_CMD_BUS_MAKE ioctl. It's intended to be useful
563 * to do negotiation of features of the payload that is
564 * transferred (kernel → userspace)
565 * @id: The ID of this connection (kernel → userspace)
566 * @pool_size: Size of the connection's buffer where the received
567 * messages are placed
568 * @bloom: The bloom properties of the bus, specified
569 * by the bus creator (kernel → userspace)
570 * @id128: Unique 128-bit ID of the bus (kernel → userspace)
571 * @items: A list of items
573 * This struct is used with the KDBUS_CMD_HELLO ioctl.
575 struct kdbus_cmd_hello {
582 struct kdbus_bloom_parameter bloom;
584 struct kdbus_item items[0];
585 } __attribute__((aligned(8)));
588 * enum kdbus_make_flags - Flags for KDBUS_CMD_{BUS,EP,NS}_MAKE
589 * @KDBUS_MAKE_ACCESS_GROUP: Make the device node group-accessible
590 * @KDBUS_MAKE_ACCESS_WORLD: Make the device node world-accessible
592 enum kdbus_make_flags {
593 KDBUS_MAKE_ACCESS_GROUP = 1ULL << 0,
594 KDBUS_MAKE_ACCESS_WORLD = 1ULL << 1,
598 * struct kdbus_cmd_make - struct to make a bus, an endpoint or a domain
599 * @size: The total size of the struct
600 * @flags: Properties for the bus/ep/domain to create
601 * @items: Items describing details
603 * This structure is used with the KDBUS_CMD_BUS_MAKE, KDBUS_CMD_ENDPOINT_MAKE
604 * and KDBUS_CMD_DOMAIN_MAKE ioctls.
606 struct kdbus_cmd_make {
609 struct kdbus_item items[0];
610 } __attribute__((aligned(8)));
613 * enum kdbus_name_flags - properties of a well-known name
614 * @KDBUS_NAME_REPLACE_EXISTING: Try to replace name of other connections
615 * @KDBUS_NAME_ALLOW_REPLACEMENT: Allow the replacement of the name
616 * @KDBUS_NAME_QUEUE: Name should be queued if busy
617 * @KDBUS_NAME_IN_QUEUE: Name is queued
618 * @KDBUS_NAME_ACTIVATOR: Name is owned by a activator connection
620 enum kdbus_name_flags {
621 KDBUS_NAME_REPLACE_EXISTING = 1ULL << 0,
622 KDBUS_NAME_ALLOW_REPLACEMENT = 1ULL << 1,
623 KDBUS_NAME_QUEUE = 1ULL << 2,
624 KDBUS_NAME_IN_QUEUE = 1ULL << 3,
625 KDBUS_NAME_ACTIVATOR = 1ULL << 4,
629 * struct kdbus_cmd_name - struct to describe a well-known name
630 * @size: The total size of the struct
631 * @flags: Flags for a name entry (KDBUS_NAME_*)
632 * @owner_id: The current owner of the name
633 * @conn_flags: The flags of the owning connection (KDBUS_HELLO_*)
634 * @items: Item list, containing the well-known name as
637 * This structure is used with the KDBUS_CMD_NAME_ACQUIRE ioctl.
639 struct kdbus_cmd_name {
644 struct kdbus_item items[0];
645 } __attribute__((aligned(8)));
648 * enum kdbus_name_list_flags - what to include into the returned list
649 * @KDBUS_NAME_LIST_UNIQUE: All active connections
650 * @KDBUS_NAME_LIST_NAMES: All known well-known names
651 * @KDBUS_NAME_LIST_ACTIVATORS: All activator connections
652 * @KDBUS_NAME_LIST_QUEUED: All queued-up names
654 enum kdbus_name_list_flags {
655 KDBUS_NAME_LIST_UNIQUE = 1ULL << 0,
656 KDBUS_NAME_LIST_NAMES = 1ULL << 1,
657 KDBUS_NAME_LIST_ACTIVATORS = 1ULL << 2,
658 KDBUS_NAME_LIST_QUEUED = 1ULL << 3,
662 * struct kdbus_cmd_name_list - request a list of name entries
663 * @flags: Flags for the query (KDBUS_NAME_LIST_*)
664 * @offset: The returned offset in the caller's pool buffer.
665 * The user must use KDBUS_CMD_FREE to free the
668 * This structure is used with the KDBUS_CMD_NAME_LIST ioctl.
670 struct kdbus_cmd_name_list {
673 } __attribute__((aligned(8)));
676 * struct kdbus_name_list - information returned by KDBUS_CMD_NAME_LIST
677 * @size: The total size of the structure
678 * @names: A list of names
680 * Note that the user is responsible for freeing the allocated memory with
681 * the KDBUS_CMD_FREE ioctl.
683 struct kdbus_name_list {
685 struct kdbus_cmd_name names[0];
689 * struct kdbus_cmd_conn_info - struct used for KDBUS_CMD_CONN_INFO ioctl
690 * @size: The total size of the struct
691 * @flags: KDBUS_ATTACH_* flags
692 * @id: The 64-bit ID of the connection. If set to zero, passing
693 * @name is required. kdbus will look up the name to
694 * determine the ID in this case.
695 * @offset: Returned offset in the caller's pool buffer where the
696 * kdbus_conn_info struct result is stored. The user must
697 * use KDBUS_CMD_FREE to free the allocated memory.
698 * @name: The optional well-known name to look up. Only needed in
701 * On success, the KDBUS_CMD_CONN_INFO ioctl will return 0 and @offset will
702 * tell the user the offset in the connection pool buffer at which to find the
703 * result in a struct kdbus_conn_info.
705 struct kdbus_cmd_conn_info {
710 struct kdbus_item items[0];
711 } __attribute__((aligned(8)));
714 * struct kdbus_conn_info - information returned by KDBUS_CMD_CONN_INFO
715 * @size: The total size of the struct
716 * @id: The connection's 64-bit ID
717 * @flags: The connection's flags
718 * @items: A list of struct kdbus_item
720 * Note that the user is responsible for freeing the allocated memory with
721 * the KDBUS_CMD_FREE ioctl.
723 struct kdbus_conn_info {
727 struct kdbus_item items[0];
731 * struct kdbus_cmd_update - update flags of a connection
732 * @size: The total size of the struct
733 * @items: A list of struct kdbus_item
735 * This struct is used with the KDBUS_CMD_CONN_UPDATE ioctl.
737 struct kdbus_cmd_update {
740 struct kdbus_item items[0];
741 } __attribute__((aligned(8)));
744 * enum kdbus_cmd_match_flags - flags to control the KDBUS_CMD_MATCH_ADD ioctl
745 * @KDBUS_MATCH_REPLACE: If entries with the supplied cookie already
746 * exists, remove them before installing the new
749 enum kdbus_cmd_match_flags {
750 KDBUS_MATCH_REPLACE = 1ULL << 0,
754 * struct kdbus_cmd_match - struct to add or remove matches
755 * @size: The total size of the struct
756 * @cookie: Userspace supplied cookie. When removing, the cookie
757 * identifies the match to remove
758 * @items: A list of items for additional information
760 * This structure is used with the KDBUS_CMD_ADD_MATCH and
761 * KDBUS_CMD_REMOVE_MATCH ioctl.
763 struct kdbus_cmd_match {
767 struct kdbus_item items[0];
768 } __attribute__((aligned(8)));
771 * enum kdbus_ioctl_type - Ioctl API
772 * @KDBUS_CMD_BUS_MAKE: After opening the "control" device node, this
773 * command creates a new bus with the specified
774 * name. The bus is immediately shut down and
775 * cleaned up when the opened "control" device node
777 * @KDBUS_CMD_DOMAIN_MAKE: Similar to KDBUS_CMD_BUS_MAKE, but it creates a
779 * @KDBUS_CMD_ENDPOINT_MAKE: Creates a new named special endpoint to talk to
780 * the bus. Such endpoints usually carry a more
781 * restrictive policy and grant restricted access
782 * to specific applications.
783 * @KDBUS_CMD_HELLO: By opening the bus device node a connection is
784 * created. After a HELLO the opened connection
785 * becomes an active peer on the bus.
786 * @KDBUS_CMD_BYEBYE: Disconnect a connection. If there are no
787 * messages queued up in the connection's pool,
788 * the call succeeds, and the handle is rendered
789 * unusable. Otherwise, -EBUSY is returned without
790 * any further side-effects.
791 * @KDBUS_CMD_MSG_SEND: Send a message and pass data from userspace to
793 * @KDBUS_CMD_MSG_RECV: Receive a message from the kernel which is
794 * placed in the receiver's pool.
795 * @KDBUS_CMD_MSG_CANCEL: Cancel a pending request of a message that
796 * blocks while waiting for a reply. The parameter
797 * denotes the cookie of the message in flight.
798 * @KDBUS_CMD_FREE: Release the allocated memory in the receiver's
800 * @KDBUS_CMD_NAME_ACQUIRE: Request a well-known bus name to associate with
801 * the connection. Well-known names are used to
802 * address a peer on the bus.
803 * @KDBUS_CMD_NAME_RELEASE: Release a well-known name the connection
805 * @KDBUS_CMD_NAME_LIST: Retrieve the list of all currently registered
806 * well-known and unique names.
807 * @KDBUS_CMD_CONN_INFO: Retrieve credentials and properties of the
808 * initial creator of the connection. The data was
809 * stored at registration time and does not
810 * necessarily represent the connected process or
811 * the actual state of the process.
812 * @KDBUS_CMD_CONN_UPDATE: Update the properties of a connection. Used to
813 * update the metadata subscription mask and
815 * @KDBUS_CMD_ENDPOINT_UPDATE: Update the properties of a custom enpoint. Used
816 * to update the policy.
817 * @KDBUS_CMD_MATCH_ADD: Install a match which broadcast messages should
818 * be delivered to the connection.
819 * @KDBUS_CMD_MATCH_REMOVE: Remove a current match for broadcast messages.
821 enum kdbus_ioctl_type {
822 KDBUS_CMD_BUS_MAKE = _IOW(KDBUS_IOCTL_MAGIC, 0x00,
823 struct kdbus_cmd_make),
824 KDBUS_CMD_DOMAIN_MAKE = _IOW(KDBUS_IOCTL_MAGIC, 0x10,
825 struct kdbus_cmd_make),
826 KDBUS_CMD_ENDPOINT_MAKE = _IOW(KDBUS_IOCTL_MAGIC, 0x20,
827 struct kdbus_cmd_make),
829 KDBUS_CMD_HELLO = _IOWR(KDBUS_IOCTL_MAGIC, 0x30,
830 struct kdbus_cmd_hello),
831 KDBUS_CMD_BYEBYE = _IO(KDBUS_IOCTL_MAGIC, 0x31),
833 KDBUS_CMD_MSG_SEND = _IOWR(KDBUS_IOCTL_MAGIC, 0x40,
835 KDBUS_CMD_MSG_RECV = _IOWR(KDBUS_IOCTL_MAGIC, 0x41,
836 struct kdbus_cmd_recv),
837 KDBUS_CMD_MSG_CANCEL = _IOW(KDBUS_IOCTL_MAGIC, 0x42,
838 struct kdbus_cmd_cancel),
839 KDBUS_CMD_FREE = _IOW(KDBUS_IOCTL_MAGIC, 0x43,
840 struct kdbus_cmd_free),
842 KDBUS_CMD_NAME_ACQUIRE = _IOWR(KDBUS_IOCTL_MAGIC, 0x50,
843 struct kdbus_cmd_name),
844 KDBUS_CMD_NAME_RELEASE = _IOW(KDBUS_IOCTL_MAGIC, 0x51,
845 struct kdbus_cmd_name),
846 KDBUS_CMD_NAME_LIST = _IOWR(KDBUS_IOCTL_MAGIC, 0x52,
847 struct kdbus_cmd_name_list),
849 KDBUS_CMD_CONN_INFO = _IOWR(KDBUS_IOCTL_MAGIC, 0x60,
850 struct kdbus_cmd_conn_info),
851 KDBUS_CMD_CONN_UPDATE = _IOW(KDBUS_IOCTL_MAGIC, 0x61,
852 struct kdbus_cmd_update),
854 KDBUS_CMD_ENDPOINT_UPDATE = _IOW(KDBUS_IOCTL_MAGIC, 0x71,
855 struct kdbus_cmd_update),
857 KDBUS_CMD_MATCH_ADD = _IOW(KDBUS_IOCTL_MAGIC, 0x80,
858 struct kdbus_cmd_match),
859 KDBUS_CMD_MATCH_REMOVE = _IOW(KDBUS_IOCTL_MAGIC, 0x81,
860 struct kdbus_cmd_match),
863 #endif /* _KDBUS_UAPI_H_ */