2 * kdbus is free software; you can redistribute it and/or modify it under
3 * the terms of the GNU Lesser General Public License as published by the
4 * Free Software Foundation; either version 2.1 of the License, or (at
5 * your option) any later version.
11 #include <linux/ioctl.h>
12 #include <linux/types.h>
14 #define KDBUS_IOCTL_MAGIC 0x95
15 #define KDBUS_SRC_ID_KERNEL (0)
16 #define KDBUS_DST_ID_NAME (0)
17 #define KDBUS_MATCH_ID_ANY (~0ULL)
18 #define KDBUS_DST_ID_BROADCAST (~0ULL)
19 #define KDBUS_FLAG_KERNEL (1ULL << 63)
22 * struct kdbus_notify_id_change - name registry change message
23 * @id: New or former owner of the name
24 * @flags: flags field from KDBUS_HELLO_*
26 * Sent from kernel to userspace when the owner or activator of
27 * a well-known name changes.
31 * KDBUS_ITEM_ID_REMOVE
33 struct kdbus_notify_id_change {
39 * struct kdbus_notify_name_change - name registry change message
40 * @old_id: ID and flags of former owner of a name
41 * @new_id: ID and flags of new owner of a name
42 * @name: Well-known name
44 * Sent from kernel to userspace when the owner or activator of
45 * a well-known name changes.
49 * KDBUS_ITEM_NAME_REMOVE
50 * KDBUS_ITEM_NAME_CHANGE
52 struct kdbus_notify_name_change {
53 struct kdbus_notify_id_change old_id;
54 struct kdbus_notify_id_change new_id;
59 * struct kdbus_creds - process credentials
61 * @euid: Effective UID
63 * @fsuid: Filesystem UID
65 * @egid: Effective GID
67 * @fsgid: Filesystem GID
84 * struct kdbus_pids - process identifiers
87 * @starttime: Starttime of the process
89 * The PID, TID and starttime of a process. The start tmie is useful to detect
90 * PID overruns from the client side. i.e. if you use the PID to look something
91 * up in /proc/$PID/ you can afterwards check the starttime field of it, to
92 * ensure you didn't run into a PID overrun.
104 * struct kdbus_caps - process capabilities
105 * @last_cap: Highest currently known capability bit
106 * @caps: Variable number of 32-bit capabilities flags
108 * Contains a variable number of 32-bit capabilities flags.
119 * struct kdbus_audit - audit information
120 * @sessionid: The audit session ID
121 * @loginuid: The audit login uid
132 * struct kdbus_timestamp
133 * @seqnum: Global per-domain message sequence number
134 * @monotonic_ns: Monotonic timestamp, in nanoseconds
135 * @realtime_ns: Realtime timestamp, in nanoseconds
138 * KDBUS_ITEM_TIMESTAMP
140 struct kdbus_timestamp {
147 * struct kdbus_vec - I/O vector for kdbus payload items
148 * @size: The size of the vector
149 * @address: Memory address of data buffer
150 * @offset: Offset in the in-message payload memory,
151 * relative to the message head
154 * KDBUS_ITEM_PAYLOAD_VEC, KDBUS_ITEM_PAYLOAD_OFF
165 * struct kdbus_bloom_parameter - bus-wide bloom parameters
166 * @size: Size of the bit field in bytes (m / 8)
167 * @n_hash: Number of hash functions used (k)
169 struct kdbus_bloom_parameter {
175 * struct kdbus_bloom_filter - bloom filter containing n elements
176 * @generation: Generation of the element set in the filter
177 * @data: Bit field, multiple of 8 bytes
179 struct kdbus_bloom_filter {
185 * struct kdbus_memfd - a kdbus memfd
186 * @start: The offset into the memfd where the segment starts
187 * @size: The size of the memfd segment
188 * @fd: The file descriptor number
189 * @__pad: Padding to ensure proper alignment and size
192 * KDBUS_ITEM_PAYLOAD_MEMFD
202 * struct kdbus_name - a registered well-known name with its flags
203 * @flags: Flags from KDBUS_NAME_*
204 * @name: Well-known name
207 * KDBUS_ITEM_OWNED_NAME
215 * struct kdbus_policy_access - policy access item
216 * @type: One of KDBUS_POLICY_ACCESS_* types
217 * @access: Access to grant
218 * @id: For KDBUS_POLICY_ACCESS_USER, the uid
219 * For KDBUS_POLICY_ACCESS_GROUP, the gid
221 struct kdbus_policy_access {
222 __u64 type; /* USER, GROUP, WORLD */
223 __u64 access; /* OWN, TALK, SEE */
224 __u64 id; /* uid, gid, 0 */
228 * enum kdbus_item_type - item types to chain data in a list
229 * @_KDBUS_ITEM_NULL: Uninitialized/invalid
230 * @_KDBUS_ITEM_USER_BASE: Start of user items
231 * @KDBUS_ITEM_PAYLOAD_VEC: Vector to data
232 * @KDBUS_ITEM_PAYLOAD_OFF: Data at returned offset to message head
233 * @KDBUS_ITEM_PAYLOAD_MEMFD: Data as sealed memfd
234 * @KDBUS_ITEM_FDS: Attached file descriptors
235 * @KDBUS_ITEM_BLOOM_PARAMETER: Bus-wide bloom parameters, used with
236 * KDBUS_CMD_BUS_MAKE, carries a
237 * struct kdbus_bloom_parameter
238 * @KDBUS_ITEM_BLOOM_FILTER: Bloom filter carried with a message,
239 * used to match against a bloom mask of a
240 * connection, carries a struct
242 * @KDBUS_ITEM_BLOOM_MASK: Bloom mask used to match against a
243 * message'sbloom filter
244 * @KDBUS_ITEM_DST_NAME: Destination's well-known name
245 * @KDBUS_ITEM_MAKE_NAME: Name of domain, bus, endpoint
246 * @KDBUS_ITEM_ATTACH_FLAGS_SEND: Attach-flags, used for updating which
247 * metadata a connection opts in to send
248 * @KDBUS_ITEM_ATTACH_FLAGS_RECV: Attach-flags, used for updating which
249 * metadata a connection requests to
250 * receive for each reeceived message
251 * @KDBUS_ITEM_ID: Connection ID
252 * @KDBUS_ITEM_NAME: Well-know name with flags
253 * @_KDBUS_ITEM_ATTACH_BASE: Start of metadata attach items
254 * @KDBUS_ITEM_TIMESTAMP: Timestamp
255 * @KDBUS_ITEM_CREDS: Process credentials
256 * @KDBUS_ITEM_PIDS: Process identifiers
257 * @KDBUS_ITEM_AUXGROUPS: Auxiliary process groups
258 * @KDBUS_ITEM_OWNED_NAME: A name owned by the associated
260 * @KDBUS_ITEM_TID_COMM: Thread ID "comm" identifier
261 * (Don't trust this, see below.)
262 * @KDBUS_ITEM_PID_COMM: Process ID "comm" identifier
263 * (Don't trust this, see below.)
264 * @KDBUS_ITEM_EXE: The path of the executable
265 * (Don't trust this, see below.)
266 * @KDBUS_ITEM_CMDLINE: The process command line
267 * (Don't trust this, see below.)
268 * @KDBUS_ITEM_CGROUP: The croup membership
269 * @KDBUS_ITEM_CAPS: The process capabilities
270 * @KDBUS_ITEM_SECLABEL: The security label
271 * @KDBUS_ITEM_AUDIT: The audit IDs
272 * @KDBUS_ITEM_CONN_DESCRIPTION: The connection's human-readable name
274 * @_KDBUS_ITEM_POLICY_BASE: Start of policy items
275 * @KDBUS_ITEM_POLICY_ACCESS: Policy access block
276 * @_KDBUS_ITEM_KERNEL_BASE: Start of kernel-generated message items
277 * @KDBUS_ITEM_NAME_ADD: Notification in kdbus_notify_name_change
278 * @KDBUS_ITEM_NAME_REMOVE: Notification in kdbus_notify_name_change
279 * @KDBUS_ITEM_NAME_CHANGE: Notification in kdbus_notify_name_change
280 * @KDBUS_ITEM_ID_ADD: Notification in kdbus_notify_id_change
281 * @KDBUS_ITEM_ID_REMOVE: Notification in kdbus_notify_id_change
282 * @KDBUS_ITEM_REPLY_TIMEOUT: Timeout has been reached
283 * @KDBUS_ITEM_REPLY_DEAD: Destination died
285 * N.B: The process and thread COMM fields, as well as the CMDLINE and
286 * EXE fields may be altered by unprivileged processes und should
287 * hence *not* used for security decisions. Peers should make use of
288 * these items only for informational purposes, such as generating log
291 enum kdbus_item_type {
293 _KDBUS_ITEM_USER_BASE,
294 KDBUS_ITEM_PAYLOAD_VEC = _KDBUS_ITEM_USER_BASE,
295 KDBUS_ITEM_PAYLOAD_OFF,
296 KDBUS_ITEM_PAYLOAD_MEMFD,
298 KDBUS_ITEM_BLOOM_PARAMETER,
299 KDBUS_ITEM_BLOOM_FILTER,
300 KDBUS_ITEM_BLOOM_MASK,
302 KDBUS_ITEM_MAKE_NAME,
303 KDBUS_ITEM_ATTACH_FLAGS_SEND,
304 KDBUS_ITEM_ATTACH_FLAGS_RECV,
308 /* keep these item types in sync with KDBUS_ATTACH_* flags */
309 _KDBUS_ITEM_ATTACH_BASE = 0x1000,
310 KDBUS_ITEM_TIMESTAMP = _KDBUS_ITEM_ATTACH_BASE,
313 KDBUS_ITEM_AUXGROUPS,
314 KDBUS_ITEM_OWNED_NAME,
323 KDBUS_ITEM_CONN_DESCRIPTION,
325 _KDBUS_ITEM_POLICY_BASE = 0x2000,
326 KDBUS_ITEM_POLICY_ACCESS = _KDBUS_ITEM_POLICY_BASE,
328 _KDBUS_ITEM_KERNEL_BASE = 0x8000,
329 KDBUS_ITEM_NAME_ADD = _KDBUS_ITEM_KERNEL_BASE,
330 KDBUS_ITEM_NAME_REMOVE,
331 KDBUS_ITEM_NAME_CHANGE,
333 KDBUS_ITEM_ID_REMOVE,
334 KDBUS_ITEM_REPLY_TIMEOUT,
335 KDBUS_ITEM_REPLY_DEAD,
339 * struct kdbus_item - chain of data blocks
340 * @size: Overall data record size
341 * @type: Kdbus_item type of data
342 * @data: Generic bytes
343 * @data32: Generic 32 bit array
344 * @data64: Generic 64 bit array
345 * @str: Generic string
347 * @vec: KDBUS_ITEM_PAYLOAD_VEC
348 * @creds: KDBUS_ITEM_CREDS
349 * @audit: KDBUS_ITEM_AUDIT
350 * @timestamp: KDBUS_ITEM_TIMESTAMP
351 * @name: KDBUS_ITEM_NAME
352 * @bloom_parameter: KDBUS_ITEM_BLOOM_PARAMETER
353 * @bloom_filter: KDBUS_ITEM_BLOOM_FILTER
354 * @memfd: KDBUS_ITEM_PAYLOAD_MEMFD
355 * @name_change: KDBUS_ITEM_NAME_ADD
356 * KDBUS_ITEM_NAME_REMOVE
357 * KDBUS_ITEM_NAME_CHANGE
358 * @id_change: KDBUS_ITEM_ID_ADD
359 * KDBUS_ITEM_ID_REMOVE
360 * @policy: KDBUS_ITEM_POLICY_ACCESS
372 struct kdbus_vec vec;
373 struct kdbus_creds creds;
374 struct kdbus_pids pids;
375 struct kdbus_audit audit;
376 struct kdbus_caps caps;
377 struct kdbus_timestamp timestamp;
378 struct kdbus_name name;
379 struct kdbus_bloom_parameter bloom_parameter;
380 struct kdbus_bloom_filter bloom_filter;
381 struct kdbus_memfd memfd;
383 struct kdbus_notify_name_change name_change;
384 struct kdbus_notify_id_change id_change;
385 struct kdbus_policy_access policy_access;
390 * enum kdbus_msg_flags - type of message
391 * @KDBUS_MSG_FLAGS_EXPECT_REPLY: Expect a reply message, used for
392 * method calls. The userspace-supplied
393 * cookie identifies the message and the
394 * respective reply carries the cookie
396 * @KDBUS_MSG_FLAGS_SYNC_REPLY: Wait for destination connection to
397 * reply to this message. The
398 * KDBUS_CMD_MSG_SEND ioctl() will block
399 * until the reply is received, and
400 * offset_reply in struct kdbus_msg will
401 * yield the offset in the sender's pool
402 * where the reply can be found.
403 * This flag is only valid if
404 * @KDBUS_MSG_FLAGS_EXPECT_REPLY is set as
406 * @KDBUS_MSG_FLAGS_NO_AUTO_START: Do not start a service, if the addressed
407 * name is not currently active
409 enum kdbus_msg_flags {
410 KDBUS_MSG_FLAGS_EXPECT_REPLY = 1ULL << 0,
411 KDBUS_MSG_FLAGS_SYNC_REPLY = 1ULL << 1,
412 KDBUS_MSG_FLAGS_NO_AUTO_START = 1ULL << 2,
416 * enum kdbus_payload_type - type of payload carried by message
417 * @KDBUS_PAYLOAD_KERNEL: Kernel-generated simple message
418 * @KDBUS_PAYLOAD_DBUS: D-Bus marshalling "DBusDBus"
420 enum kdbus_payload_type {
421 KDBUS_PAYLOAD_KERNEL,
422 KDBUS_PAYLOAD_DBUS = 0x4442757344427573ULL,
426 * struct kdbus_msg - the representation of a kdbus message
427 * @size: Total size of the message
428 * @flags: Message flags (KDBUS_MSG_FLAGS_*), userspace → kernel
429 * @kernel_flags: Supported message flags, kernel → userspace
430 * @priority: Message queue priority value
431 * @dst_id: 64-bit ID of the destination connection
432 * @src_id: 64-bit ID of the source connection
433 * @payload_type: Payload type (KDBUS_PAYLOAD_*)
434 * @cookie: Userspace-supplied cookie, for the connection
435 * to identify its messages
436 * @timeout_ns: The time to wait for a message reply from the peer.
437 * If there is no reply, a kernel-generated message
438 * with an attached KDBUS_ITEM_REPLY_TIMEOUT item
439 * is sent to @src_id. The timeout is expected in
440 * nanoseconds and as absolute CLOCK_MONOTONIC value.
441 * @cookie_reply: A reply to the requesting message with the same
442 * cookie. The requesting connection can match its
443 * request and the reply with this value
444 * @offset_reply: If KDBUS_MSG_FLAGS_EXPECT_REPLY, this field will
445 * contain the offset in the sender's pool where the
447 * @items: A list of kdbus_items containing the message payload
463 struct kdbus_item items[0];
464 } __attribute__((aligned(8)));
467 * enum kdbus_recv_flags - flags for de-queuing messages
468 * @KDBUS_RECV_PEEK: Return the next queued message without
469 * actually de-queuing it, and without installing
470 * any file descriptors or other resources. It is
471 * usually used to determine the activating
472 * connection of a bus name.
473 * @KDBUS_RECV_DROP: Drop and free the next queued message and all
474 * its resources without actually receiving it.
475 * @KDBUS_RECV_USE_PRIORITY: Only de-queue messages with the specified or
476 * higher priority (lowest values); if not set,
477 * the priority value is ignored.
479 enum kdbus_recv_flags {
480 KDBUS_RECV_PEEK = 1ULL << 0,
481 KDBUS_RECV_DROP = 1ULL << 1,
482 KDBUS_RECV_USE_PRIORITY = 1ULL << 2,
486 * struct kdbus_cmd_recv - struct to de-queue a buffered message
487 * @flags: KDBUS_RECV_* flags, userspace → kernel
488 * @kernel_flags: Supported KDBUS_RECV_* flags, kernel → userspace
489 * @priority: Minimum priority of the messages to de-queue. Lowest
490 * values have the highest priority.
491 * @offset: Returned offset in the pool where the message is
492 * stored. The user must use KDBUS_CMD_FREE to free
493 * the allocated memory.
494 * @dropped_msgs: In case the KDBUS_CMD_MSG_RECV ioctl returns
495 * -EOVERFLOW, this field will contain the number of
496 * broadcast messages that have been lost since the
498 * @msg_size: Filled by the kernel with the actual message size. This
499 * is the full size of the slice placed at @offset. It
500 * includes the memory used for the kdbus_msg object, but
501 * also for all appended VECs. By using @msg_size and
502 * @offset, you can map a single message, instead of
503 * mapping the whole pool.
505 * This struct is used with the KDBUS_CMD_MSG_RECV ioctl.
507 struct kdbus_cmd_recv {
516 } __attribute__((aligned(8)));
519 * struct kdbus_cmd_cancel - struct to cancel a synchronously pending message
520 * @cookie: The cookie of the pending message
521 * @flags: Flags for the free command. Currently unused.
523 * This struct is used with the KDBUS_CMD_CANCEL ioctl.
525 struct kdbus_cmd_cancel {
528 } __attribute__((aligned(8)));
531 * struct kdbus_cmd_free - struct to free a slice of memory in the pool
532 * @offset: The offset of the memory slice, as returned by other
534 * @flags: Flags for the free command, userspace → kernel
535 * @kernel_flags: Supported flags of the free command, userspace → kernel
537 * This struct is used with the KDBUS_CMD_FREE ioctl.
539 struct kdbus_cmd_free {
543 } __attribute__((aligned(8)));
546 * enum kdbus_policy_access_type - permissions of a policy record
547 * @_KDBUS_POLICY_ACCESS_NULL: Uninitialized/invalid
548 * @KDBUS_POLICY_ACCESS_USER: Grant access to a uid
549 * @KDBUS_POLICY_ACCESS_GROUP: Grant access to gid
550 * @KDBUS_POLICY_ACCESS_WORLD: World-accessible
552 enum kdbus_policy_access_type {
553 _KDBUS_POLICY_ACCESS_NULL,
554 KDBUS_POLICY_ACCESS_USER,
555 KDBUS_POLICY_ACCESS_GROUP,
556 KDBUS_POLICY_ACCESS_WORLD,
560 * enum kdbus_policy_access_flags - mode flags
561 * @KDBUS_POLICY_OWN: Allow to own a well-known name
562 * Implies KDBUS_POLICY_TALK and KDBUS_POLICY_SEE
563 * @KDBUS_POLICY_TALK: Allow communication to a well-known name
564 * Implies KDBUS_POLICY_SEE
565 * @KDBUS_POLICY_SEE: Allow to see a well-known name
567 enum kdbus_policy_type {
568 KDBUS_POLICY_SEE = 0,
574 * enum kdbus_hello_flags - flags for struct kdbus_cmd_hello
575 * @KDBUS_HELLO_ACCEPT_FD: The connection allows the reception of
576 * any passed file descriptors
577 * @KDBUS_HELLO_ACTIVATOR: Special-purpose connection which registers
578 * a well-know name for a process to be started
579 * when traffic arrives
580 * @KDBUS_HELLO_POLICY_HOLDER: Special-purpose connection which registers
581 * policy entries for a name. The provided name
582 * is not activated and not registered with the
583 * name database, it only allows unprivileged
584 * connections to aquire a name, talk or discover
586 * @KDBUS_HELLO_MONITOR: Special-purpose connection to monitor
588 * @KDBUS_HELLO_UNPRIVILEGED: Don't treat this connection as privileged once
589 * the bus connection was established.
591 enum kdbus_hello_flags {
592 KDBUS_HELLO_ACCEPT_FD = 1ULL << 0,
593 KDBUS_HELLO_ACTIVATOR = 1ULL << 1,
594 KDBUS_HELLO_POLICY_HOLDER = 1ULL << 2,
595 KDBUS_HELLO_MONITOR = 1ULL << 3,
596 KDBUS_HELLO_UNPRIVILEGED = 1ULL << 4,
600 * enum kdbus_attach_flags - flags for metadata attachments
601 * @KDBUS_ATTACH_TIMESTAMP: Timestamp
602 * @KDBUS_ATTACH_CREDS: Credentials
603 * @KDBUS_ATTACH_PIDS: PIDs
604 * @KDBUS_ATTACH_AUXGROUPS: Auxiliary groups
605 * @KDBUS_ATTACH_NAMES: Well-known names
606 * @KDBUS_ATTACH_TID_COMM: The "comm" process identifier of the TID
607 * @KDBUS_ATTACH_PID_COMM: The "comm" process identifier of the PID
608 * @KDBUS_ATTACH_EXE: The path of the executable
609 * @KDBUS_ATTACH_CMDLINE: The process command line
610 * @KDBUS_ATTACH_CGROUP: The croup membership
611 * @KDBUS_ATTACH_CAPS: The process capabilities
612 * @KDBUS_ATTACH_SECLABEL: The security label
613 * @KDBUS_ATTACH_AUDIT: The audit IDs
614 * @KDBUS_ATTACH_CONN_DESCRIPTION: The human-readable connection name
615 * @_KDBUS_ATTACH_ALL: All of the above
616 * @_KDBUS_ATTACH_ANY: Wildcard match to enable any kind of
619 enum kdbus_attach_flags {
620 KDBUS_ATTACH_TIMESTAMP = 1ULL << 0,
621 KDBUS_ATTACH_CREDS = 1ULL << 1,
622 KDBUS_ATTACH_PIDS = 1ULL << 2,
623 KDBUS_ATTACH_AUXGROUPS = 1ULL << 3,
624 KDBUS_ATTACH_NAMES = 1ULL << 4,
625 KDBUS_ATTACH_TID_COMM = 1ULL << 5,
626 KDBUS_ATTACH_PID_COMM = 1ULL << 6,
627 KDBUS_ATTACH_EXE = 1ULL << 7,
628 KDBUS_ATTACH_CMDLINE = 1ULL << 8,
629 KDBUS_ATTACH_CGROUP = 1ULL << 9,
630 KDBUS_ATTACH_CAPS = 1ULL << 10,
631 KDBUS_ATTACH_SECLABEL = 1ULL << 11,
632 KDBUS_ATTACH_AUDIT = 1ULL << 12,
633 KDBUS_ATTACH_CONN_DESCRIPTION = 1ULL << 13,
634 _KDBUS_ATTACH_ALL = (1ULL << 14) - 1,
635 _KDBUS_ATTACH_ANY = ~0ULL
639 * struct kdbus_cmd_hello - struct to say hello to kdbus
640 * @size: The total size of the structure
641 * @flags: Connection flags (KDBUS_HELLO_*), userspace → kernel
642 * @kernel_flags: Supported connection flags, kernel → userspace
643 * @attach_flags_send: Mask of metadata to attach to each message sent
644 * off by this connection (KDBUS_ATTACH_*)
645 * @attach_flags_recv: Mask of metadata to attach to each message receieved
646 * by the new connection (KDBUS_ATTACH_*)
647 * @bus_flags: The flags field copied verbatim from the original
648 * KDBUS_CMD_BUS_MAKE ioctl. It's intended to be useful
649 * to do negotiation of features of the payload that is
650 * transferred (kernel → userspace)
651 * @id: The ID of this connection (kernel → userspace)
652 * @pool_size: Size of the connection's buffer where the received
653 * messages are placed
654 * @bloom: The bloom properties of the bus, specified
655 * by the bus creator (kernel → userspace)
656 * @id128: Unique 128-bit ID of the bus (kernel → userspace)
657 * @items: A list of items
659 * This struct is used with the KDBUS_CMD_HELLO ioctl.
661 struct kdbus_cmd_hello {
665 __u64 attach_flags_send;
666 __u64 attach_flags_recv;
670 struct kdbus_bloom_parameter bloom;
672 struct kdbus_item items[0];
673 } __attribute__((aligned(8)));
676 * enum kdbus_make_flags - Flags for KDBUS_CMD_{BUS,EP,NS}_MAKE
677 * @KDBUS_MAKE_ACCESS_GROUP: Make the bus or endpoint node group-accessible
678 * @KDBUS_MAKE_ACCESS_WORLD: Make the bus or endpoint node world-accessible
680 enum kdbus_make_flags {
681 KDBUS_MAKE_ACCESS_GROUP = 1ULL << 0,
682 KDBUS_MAKE_ACCESS_WORLD = 1ULL << 1,
686 * struct kdbus_cmd_make - struct to make a bus, an endpoint or a domain
687 * @size: The total size of the struct
688 * @flags: Properties for the bus/ep/domain to create,
690 * @kernel_flags: Supported flags for the used command, kernel → userspace
691 * @items: Items describing details
693 * This structure is used with the KDBUS_CMD_BUS_MAKE and
694 * KDBUS_CMD_ENDPOINT_MAKE ioctls.
696 struct kdbus_cmd_make {
700 struct kdbus_item items[0];
701 } __attribute__((aligned(8)));
704 * enum kdbus_name_flags - properties of a well-known name
705 * @KDBUS_NAME_REPLACE_EXISTING: Try to replace name of other connections
706 * @KDBUS_NAME_ALLOW_REPLACEMENT: Allow the replacement of the name
707 * @KDBUS_NAME_QUEUE: Name should be queued if busy
708 * @KDBUS_NAME_IN_QUEUE: Name is queued
709 * @KDBUS_NAME_ACTIVATOR: Name is owned by a activator connection
711 enum kdbus_name_flags {
712 KDBUS_NAME_REPLACE_EXISTING = 1ULL << 0,
713 KDBUS_NAME_ALLOW_REPLACEMENT = 1ULL << 1,
714 KDBUS_NAME_QUEUE = 1ULL << 2,
715 KDBUS_NAME_IN_QUEUE = 1ULL << 3,
716 KDBUS_NAME_ACTIVATOR = 1ULL << 4,
720 * struct kdbus_cmd_name - struct to describe a well-known name
721 * @size: The total size of the struct
722 * @flags: Flags for a name entry (KDBUS_NAME_*),
723 * userspace → kernel, kernel → userspace
724 * @kernel_flags: Supported flags for a name entry, kernel → userspace
725 * @items: Item list, containing the well-known name as
728 * This structure is used with the KDBUS_CMD_NAME_ACQUIRE ioctl.
730 struct kdbus_cmd_name {
734 struct kdbus_item items[0];
735 } __attribute__((aligned(8)));
738 * struct kdbus_name_info - struct to describe a well-known name
739 * @size: The total size of the struct
740 * @conn_flags: The flags of the owning connection (KDBUS_HELLO_*)
741 * @owner_id: The current owner of the name
742 * @items: Item list, containing the well-known name as
743 * KDBUS_ITEM_OWNED_NAME
745 * This structure is used as return struct for the KDBUS_CMD_NAME_LIST ioctl.
747 struct kdbus_name_info {
751 struct kdbus_item items[0];
752 } __attribute__((aligned(8)));
755 * enum kdbus_name_list_flags - what to include into the returned list
756 * @KDBUS_NAME_LIST_UNIQUE: All active connections
757 * @KDBUS_NAME_LIST_NAMES: All known well-known names
758 * @KDBUS_NAME_LIST_ACTIVATORS: All activator connections
759 * @KDBUS_NAME_LIST_QUEUED: All queued-up names
761 enum kdbus_name_list_flags {
762 KDBUS_NAME_LIST_UNIQUE = 1ULL << 0,
763 KDBUS_NAME_LIST_NAMES = 1ULL << 1,
764 KDBUS_NAME_LIST_ACTIVATORS = 1ULL << 2,
765 KDBUS_NAME_LIST_QUEUED = 1ULL << 3,
769 * struct kdbus_cmd_name_list - request a list of name entries
770 * @flags: Flags for the query (KDBUS_NAME_LIST_*),
772 * @kernel_flags: Supported flags for queries, kernel → userspace
773 * @offset: The returned offset in the caller's pool buffer.
774 * The user must use KDBUS_CMD_FREE to free the
777 * This structure is used with the KDBUS_CMD_NAME_LIST ioctl.
779 struct kdbus_cmd_name_list {
783 } __attribute__((aligned(8)));
786 * struct kdbus_name_list - information returned by KDBUS_CMD_NAME_LIST
787 * @size: The total size of the structure
788 * @names: A list of names
790 * Note that the user is responsible for freeing the allocated memory with
791 * the KDBUS_CMD_FREE ioctl.
793 struct kdbus_name_list {
795 struct kdbus_name_info names[0];
799 * struct kdbus_cmd_info - struct used for KDBUS_CMD_CONN_INFO ioctl
800 * @size: The total size of the struct
801 * @flags: KDBUS_ATTACH_* flags, userspace → kernel
802 * @kernel_flags: Supported KDBUS_ATTACH_* flags, kernel → userspace
803 * @id: The 64-bit ID of the connection. If set to zero, passing
804 * @name is required. kdbus will look up the name to
805 * determine the ID in this case.
806 * @offset: Returned offset in the caller's pool buffer where the
807 * kdbus_info struct result is stored. The user must
808 * use KDBUS_CMD_FREE to free the allocated memory.
809 * @items: The optional item list, containing the
810 * well-known name to look up as a KDBUS_ITEM_NAME.
811 * Only needed in case @id is zero.
813 * On success, the KDBUS_CMD_CONN_INFO ioctl will return 0 and @offset will
814 * tell the user the offset in the connection pool buffer at which to find the
815 * result in a struct kdbus_info.
817 struct kdbus_cmd_info {
823 struct kdbus_item items[0];
824 } __attribute__((aligned(8)));
827 * struct kdbus_info - information returned by KDBUS_CMD_*_INFO
828 * @size: The total size of the struct
829 * @id: The connection's or bus' 64-bit ID
830 * @flags: The connection's or bus' flags
831 * @items: A list of struct kdbus_item
833 * Note that the user is responsible for freeing the allocated memory with
834 * the KDBUS_CMD_FREE ioctl.
840 struct kdbus_item items[0];
844 * struct kdbus_cmd_update - update flags of a connection
845 * @size: The total size of the struct
846 * @flags: Flags for the update command, userspace → kernel
847 * @kernel_flags: Supported flags for this command, kernel → userspace
848 * @items: A list of struct kdbus_item
850 * This struct is used with the KDBUS_CMD_CONN_UPDATE ioctl.
852 struct kdbus_cmd_update {
856 struct kdbus_item items[0];
857 } __attribute__((aligned(8)));
860 * enum kdbus_cmd_match_flags - flags to control the KDBUS_CMD_MATCH_ADD ioctl
861 * @KDBUS_MATCH_REPLACE: If entries with the supplied cookie already
862 * exists, remove them before installing the new
865 enum kdbus_cmd_match_flags {
866 KDBUS_MATCH_REPLACE = 1ULL << 0,
870 * struct kdbus_cmd_match - struct to add or remove matches
871 * @size: The total size of the struct
872 * @cookie: Userspace supplied cookie. When removing, the cookie
873 * identifies the match to remove
874 * @flags: Flags for match command (KDBUS_MATCH_*),
876 * @kernel_flags: Supported flags of the used command, kernel → userspace
877 * @items: A list of items for additional information
879 * This structure is used with the KDBUS_CMD_MATCH_ADD and
880 * KDBUS_CMD_MATCH_REMOVE ioctl.
882 struct kdbus_cmd_match {
887 struct kdbus_item items[0];
888 } __attribute__((aligned(8)));
892 * KDBUS_CMD_BUS_MAKE: After opening the "control" node, this command
893 * creates a new bus with the specified
894 * name. The bus is immediately shut down and
895 * cleaned up when the opened file descriptor is
897 * KDBUS_CMD_ENDPOINT_MAKE: Creates a new named special endpoint to talk to
898 * the bus. Such endpoints usually carry a more
899 * restrictive policy and grant restricted access
900 * to specific applications.
901 * KDBUS_CMD_HELLO: By opening the bus node, a connection is
902 * created. After a HELLO the opened connection
903 * becomes an active peer on the bus.
904 * KDBUS_CMD_BYEBYE: Disconnect a connection. If there are no
905 * messages queued up in the connection's pool,
906 * the call succeeds, and the handle is rendered
907 * unusable. Otherwise, -EBUSY is returned without
908 * any further side-effects.
909 * KDBUS_CMD_MSG_SEND: Send a message and pass data from userspace to
911 * KDBUS_CMD_MSG_RECV: Receive a message from the kernel which is
912 * placed in the receiver's pool.
913 * KDBUS_CMD_MSG_CANCEL: Cancel a pending request of a message that
914 * blocks while waiting for a reply. The parameter
915 * denotes the cookie of the message in flight.
916 * KDBUS_CMD_FREE: Release the allocated memory in the receiver's
918 * KDBUS_CMD_NAME_ACQUIRE: Request a well-known bus name to associate with
919 * the connection. Well-known names are used to
920 * address a peer on the bus.
921 * KDBUS_CMD_NAME_RELEASE: Release a well-known name the connection
923 * KDBUS_CMD_NAME_LIST: Retrieve the list of all currently registered
924 * well-known and unique names.
925 * KDBUS_CMD_CONN_INFO: Retrieve credentials and properties of the
926 * initial creator of the connection. The data was
927 * stored at registration time and does not
928 * necessarily represent the connected process or
929 * the actual state of the process.
930 * KDBUS_CMD_CONN_UPDATE: Update the properties of a connection. Used to
931 * update the metadata subscription mask and
933 * KDBUS_CMD_BUS_CREATOR_INFO: Retrieve information of the creator of the bus
934 * a connection is attached to.
935 * KDBUS_CMD_ENDPOINT_UPDATE: Update the properties of a custom enpoint. Used
936 * to update the policy.
937 * KDBUS_CMD_MATCH_ADD: Install a match which broadcast messages should
938 * be delivered to the connection.
939 * KDBUS_CMD_MATCH_REMOVE: Remove a current match for broadcast messages.
941 #define KDBUS_CMD_BUS_MAKE _IOW(KDBUS_IOCTL_MAGIC, 0x00, \
942 struct kdbus_cmd_make)
943 #define KDBUS_CMD_ENDPOINT_MAKE _IOW(KDBUS_IOCTL_MAGIC, 0x10, \
944 struct kdbus_cmd_make)
946 #define KDBUS_CMD_HELLO _IOWR(KDBUS_IOCTL_MAGIC, 0x20, \
947 struct kdbus_cmd_hello)
948 #define KDBUS_CMD_BYEBYE _IO(KDBUS_IOCTL_MAGIC, 0x21) \
950 #define KDBUS_CMD_MSG_SEND _IOWR(KDBUS_IOCTL_MAGIC, 0x30, \
952 #define KDBUS_CMD_MSG_RECV _IOWR(KDBUS_IOCTL_MAGIC, 0x31, \
953 struct kdbus_cmd_recv)
954 #define KDBUS_CMD_MSG_CANCEL _IOW(KDBUS_IOCTL_MAGIC, 0x32, \
955 struct kdbus_cmd_cancel)
956 #define KDBUS_CMD_FREE _IOW(KDBUS_IOCTL_MAGIC, 0x33, \
957 struct kdbus_cmd_free)
959 #define KDBUS_CMD_NAME_ACQUIRE _IOWR(KDBUS_IOCTL_MAGIC, 0x40, \
960 struct kdbus_cmd_name)
961 #define KDBUS_CMD_NAME_RELEASE _IOW(KDBUS_IOCTL_MAGIC, 0x41, \
962 struct kdbus_cmd_name)
963 #define KDBUS_CMD_NAME_LIST _IOWR(KDBUS_IOCTL_MAGIC, 0x42, \
964 struct kdbus_cmd_name_list)
966 #define KDBUS_CMD_CONN_INFO _IOWR(KDBUS_IOCTL_MAGIC, 0x50, \
967 struct kdbus_cmd_info)
968 #define KDBUS_CMD_CONN_UPDATE _IOW(KDBUS_IOCTL_MAGIC, 0x51, \
969 struct kdbus_cmd_update)
970 #define KDBUS_CMD_BUS_CREATOR_INFO _IOWR(KDBUS_IOCTL_MAGIC, 0x52, \
971 struct kdbus_cmd_info)
973 #define KDBUS_CMD_ENDPOINT_UPDATE _IOW(KDBUS_IOCTL_MAGIC, 0x61, \
974 struct kdbus_cmd_update)
976 #define KDBUS_CMD_MATCH_ADD _IOW(KDBUS_IOCTL_MAGIC, 0x70, \
977 struct kdbus_cmd_match)
978 #define KDBUS_CMD_MATCH_REMOVE _IOW(KDBUS_IOCTL_MAGIC, 0x71, \
979 struct kdbus_cmd_match)
981 #endif /* _KDBUS_UAPI_H_ */