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_NAME (0)
26 #define KDBUS_MATCH_ID_ANY (~0ULL)
27 #define KDBUS_DST_ID_BROADCAST (~0ULL)
30 * struct kdbus_notify_id_change - name registry change message
31 * @id: New or former owner of the name
32 * @flags: flags field from KDBUS_HELLO_*
34 * Sent from kernel to userspace when the owner or activator of
35 * a well-known name changes.
39 * KDBUS_ITEM_ID_REMOVE
41 struct kdbus_notify_id_change {
47 * struct kdbus_notify_name_change - name registry change message
48 * @old: ID and flags of former owner of a name
49 * @new: ID and flags of new owner of a name
50 * @name: Well-known name
52 * Sent from kernel to userspace when the owner or activator of
53 * a well-known name changes.
57 * KDBUS_ITEM_NAME_REMOVE
58 * KDBUS_ITEM_NAME_CHANGE
60 struct kdbus_notify_name_change {
61 struct kdbus_notify_id_change old;
62 struct kdbus_notify_id_change new;
67 * struct kdbus_creds - process credentials
72 * @starttime: Starttime of the process
74 * The starttime of the process PID. This is useful to detect PID overruns
75 * from the client side. i.e. if you use the PID to look something up in
76 * /proc/$PID/ you can afterwards check the starttime field of it, to ensure
77 * you didn't run into a PID overrun.
91 * struct kdbus_audit - audit information
92 * @sessionid: The audit session ID
93 * @loginuid: The audit login uid
104 * struct kdbus_timestamp
105 * @seqnum: Global per-namespace message sequence number
106 * @monotonic_ns: Monotonic timestamp, in nanoseconds
107 * @realtime_ns: Realtime timestamp, in nanoseconds
110 * KDBUS_ITEM_TIMESTAMP
112 struct kdbus_timestamp {
119 * struct kdbus_vec - I/O vector for kdbus payload items
120 * @size: The size of the vector
121 * @address: Memory address for memory addresses
122 * @offset: Offset in the in-message payload memory,
123 * relative to the message head
126 * KDBUS_ITEM_PAYLOAD_VEC
137 * struct kdbus_memfd - a kdbus memfd
138 * @size: The memfd's size
139 * @fd: The file descriptor number
140 * @__pad: Padding to make the struct aligned
143 * KDBUS_ITEM_PAYLOAD_MEMFD
152 * struct kdbus_name - a registered well-known name with its flags
153 * @flags: flags from KDBUS_NAME_*
154 * @name: well-known name
165 * struct kdbus_policy_access - policy access item
166 * @type: One of KDBUS_POLICY_ACCESS_* types
167 * @bits: Access to grant. One of KDBUS_POLICY_*
168 * @id: For KDBUS_POLICY_ACCESS_USER, the uid
169 * For KDBUS_POLICY_ACCESS_GROUP, the gid
172 * struct kdbus_policy
174 struct kdbus_policy_access {
175 __u64 type; /* USER, GROUP, WORLD */
176 __u64 bits; /* RECV, SEND, OWN */
177 __u64 id; /* uid, gid, 0 */
181 * struct kdbus_policy - a policy item
182 * @access: Policy access details
183 * @name: Well-known name to grant access to
186 * KDBUS_POLICY_ACCESS
187 * KDBUS_ITEM_POLICY_NAME
189 struct kdbus_policy {
191 struct kdbus_policy_access access;
197 * enum kdbus_item_type - item types to chain data in a list
198 * @_KDBUS_ITEM_NULL: Uninitialized/invalid
199 * @_KDBUS_ITEM_USER_BASE: Start of user items
200 * @KDBUS_ITEM_PAYLOAD_VEC: Vector to data
201 * @KDBUS_ITEM_PAYLOAD_OFF: Data at returned offset to message head
202 * @KDBUS_ITEM_PAYLOAD_MEMFD: Data as sealed memfd
203 * @KDBUS_ITEM_FDS: Attached file descriptors
204 * @KDBUS_ITEM_BLOOM: For broadcasts, carries bloom filter
205 * @KDBUS_ITEM_BLOOM_SIZE: Desired bloom size, used by KDBUS_CMD_BUS_MAKE
206 * @KDBUS_ITEM_DST_NAME: Destination's well-known name
207 * @KDBUS_ITEM_MAKE_NAME: Name of namespace, bus, endpoint
208 * @_KDBUS_ITEM_POLICY_BASE: Start of policy items
209 * @KDBUS_ITEM_POLICY_NAME: Policy in struct kdbus_policy
210 * @KDBUS_ITEM_POLICY_ACCESS: Policy in struct kdbus_policy
211 * @_KDBUS_ITEM_ATTACH_BASE: Start of metadata attach items
212 * @KDBUS_ITEM_NAME: Well-know name with flags
213 * @KDBUS_ITEM_ID: Connection ID
214 * @KDBUS_ITEM_TIMESTAMP: Timestamp
215 * @KDBUS_ITEM_CREDS: Process credential
216 * @KDBUS_ITEM_PID_COMM: Process ID "comm" identifier
217 * @KDBUS_ITEM_TID_COMM: Thread ID "comm" identifier
218 * @KDBUS_ITEM_EXE: The path of the executable
219 * @KDBUS_ITEM_CMDLINE: The process command line
220 * @KDBUS_ITEM_CGROUP: The croup membership
221 * @KDBUS_ITEM_CAPS: The process capabilities
222 * @KDBUS_ITEM_SECLABEL: The security label
223 * @KDBUS_ITEM_AUDIT: The audit IDs
224 * @_KDBUS_ITEM_KERNEL_BASE: Start of kernel-generated message items
225 * @KDBUS_ITEM_NAME_ADD: Notify in struct kdbus_notify_name_change
226 * @KDBUS_ITEM_NAME_REMOVE: Notify in struct kdbus_notify_name_change
227 * @KDBUS_ITEM_NAME_CHANGE: Notify in struct kdbus_notify_name_change
228 * @KDBUS_ITEM_ID_ADD: Notify in struct kdbus_notify_id_change
229 * @KDBUS_ITEM_ID_REMOVE: Notify in struct kdbus_notify_id_change
230 * @KDBUS_ITEM_REPLY_TIMEOUT: Timeout has been reached
231 * @KDBUS_ITEM_REPLY_DEAD: Destination died
233 enum kdbus_item_type {
235 _KDBUS_ITEM_USER_BASE,
236 KDBUS_ITEM_PAYLOAD_VEC = _KDBUS_ITEM_USER_BASE,
237 KDBUS_ITEM_PAYLOAD_OFF,
238 KDBUS_ITEM_PAYLOAD_MEMFD,
241 KDBUS_ITEM_BLOOM_SIZE,
243 KDBUS_ITEM_MAKE_NAME,
245 _KDBUS_ITEM_POLICY_BASE = 0x400,
246 KDBUS_ITEM_POLICY_NAME = _KDBUS_ITEM_POLICY_BASE,
247 KDBUS_ITEM_POLICY_ACCESS,
249 _KDBUS_ITEM_ATTACH_BASE = 0x600,
250 KDBUS_ITEM_NAME = _KDBUS_ITEM_ATTACH_BASE,
252 KDBUS_ITEM_TIMESTAMP,
263 _KDBUS_ITEM_KERNEL_BASE = 0x800,
264 KDBUS_ITEM_NAME_ADD = _KDBUS_ITEM_KERNEL_BASE,
265 KDBUS_ITEM_NAME_REMOVE,
266 KDBUS_ITEM_NAME_CHANGE,
268 KDBUS_ITEM_ID_REMOVE,
269 KDBUS_ITEM_REPLY_TIMEOUT,
270 KDBUS_ITEM_REPLY_DEAD,
274 * struct kdbus_item - chain of data blocks
275 * @size: Overall data record size
276 * @type: Kdbus_item type of data
277 * @data: Generic bytes
278 * @data32: Generic 32 bit array
279 * @data64: Generic 64 bit array
280 * @str: Generic string
282 * @vec: KDBUS_ITEM_PAYLOAD_VEC
283 * @creds: KDBUS_ITEM_CREDS
284 * @audit: KDBUS_ITEM_AUDIT
285 * @timestamp: KDBUS_ITEM_TIMESTAMP
286 * @name: KDBUS_ITEM_NAME
287 * @memfd: KDBUS_ITEM_PAYLOAD_MEMFD
288 * @name_change: KDBUS_ITEM_NAME_ADD
289 * KDBUS_ITEM_NAME_REMOVE
290 * KDBUS_ITEM_NAME_CHANGE
291 * @id_change: KDBUS_ITEM_ID_ADD
292 * KDBUS_ITEM_ID_REMOVE
293 * @policy: KDBUS_ITEM_POLICY_NAME
294 * KDBUS_ITEM_POLICY_ACCESS
306 struct kdbus_vec vec;
307 struct kdbus_creds creds;
308 struct kdbus_audit audit;
309 struct kdbus_timestamp timestamp;
310 struct kdbus_name name;
311 struct kdbus_memfd memfd;
313 struct kdbus_notify_name_change name_change;
314 struct kdbus_notify_id_change id_change;
315 struct kdbus_policy policy;
320 * enum kdbus_msg_flags - type of message
321 * @KDBUS_MSG_FLAGS_EXPECT_REPLY: Expect a reply message, used for
322 * method calls. The userspace-supplied
323 * cookie identifies the message and the
324 * respective reply carries the cookie
326 * @KDBUS_MSG_FLAGS_NO_AUTO_START: Do not start a service, if the addressed
327 * name is not currently active
329 enum kdbus_msg_flags {
330 KDBUS_MSG_FLAGS_EXPECT_REPLY = 1 << 0,
331 KDBUS_MSG_FLAGS_NO_AUTO_START = 1 << 1,
335 * enum kdbus_payload_type - type of payload carried by message
336 * @KDBUS_PAYLOAD_KERNEL: Kernel-generated simple message
337 * @KDBUS_PAYLOAD_DBUS: D-Bus marshalling "DBusDBus"
339 enum kdbus_payload_type {
340 KDBUS_PAYLOAD_KERNEL,
341 KDBUS_PAYLOAD_DBUS = 0x4442757344427573ULL,
345 * struct kdbus_msg - the representation of a kdbus message
346 * @size: Total size of the message
347 * @flags: Message flags (KDBUS_MSG_FLAGS_*)
348 * @dst_id: 64-bit ID of the destination connection
349 * @src_id: 64-bit ID of the source connection
350 * @payload_type: Payload type (KDBUS_PAYLOAD_*)
351 * @cookie: Userspace-supplied cookie, for the connection
352 * to identify its messages
353 * @cookie_reply: A reply to the requesting message with the same
354 * cookie. The requesting connection can match its
355 * request and the reply with this value
356 * @timeout_ns: The time to wait for a message reply from the peer.
357 * If there is no reply, a kernel-generated message
358 * with an attached KDBUS_ITEM_REPLY_TIMEOUT item
359 * is sent to @src_id.
360 * @items: A list of kdbus_items containing the message payload
373 struct kdbus_item items[0];
374 } __attribute__((aligned(8)));
377 * enum kdbus_policy_access_type - permissions of a policy record
378 * @_KDBUS_POLICY_ACCESS_NULL: Uninitialized/invalid
379 * @KDBUS_POLICY_ACCESS_USER: Grant access to a uid
380 * @KDBUS_POLICY_ACCESS_GROUP: Grant access to gid
381 * @KDBUS_POLICY_ACCESS_WORLD: World-accessible
383 enum kdbus_policy_access_type {
384 _KDBUS_POLICY_ACCESS_NULL,
385 KDBUS_POLICY_ACCESS_USER,
386 KDBUS_POLICY_ACCESS_GROUP,
387 KDBUS_POLICY_ACCESS_WORLD,
391 * enum kdbus_policy_access_flags - mode flags
392 * @KDBUS_POLICY_RECV: Allow receive
393 * @KDBUS_POLICY_SEND: Allow send
394 * @KDBUS_POLICY_OWN: Allow to own a well-known name
396 enum kdbus_policy_type {
397 KDBUS_POLICY_RECV = 1 << 2,
398 KDBUS_POLICY_SEND = 1 << 1,
399 KDBUS_POLICY_OWN = 1 << 0,
403 * struct kdbus_cmd_policy - a series of policies to upload
404 * @size: The total size of the structure
405 * @policies: The policies to upload
407 * A KDBUS_POLICY_NAME must always preceeds a KDBUS_POLICY_ACCESS entry.
408 * A new KDBUS_POLICY_NAME can be added after KDBUS_POLICY_ACCESS for
409 * chaining multiple policies together.
411 struct kdbus_cmd_policy {
413 struct kdbus_item policies[0];
414 } __attribute__((aligned(8)));
417 * enum kdbus_hello_flags - flags for struct kdbus_cmd_hello
418 * @KDBUS_HELLO_ACCEPT_FD: The connection allows the receiving of
419 * any passed file descriptors
420 * @KDBUS_HELLO_ACTIVATOR: Special-purpose connection which registers
421 * a well-know name for a process to be started
422 * when traffic arrives
423 * @KDBUS_HELLO_MONITOR: Special-purpose connection to monitor
426 enum kdbus_hello_flags {
427 KDBUS_HELLO_ACCEPT_FD = 1 << 0,
428 KDBUS_HELLO_ACTIVATOR = 1 << 1,
429 KDBUS_HELLO_MONITOR = 1 << 2,
433 * enum kdbus_attach_flags - flags for metadata attachments
434 * @KDBUS_ATTACH_TIMESTAMP: Timestamp
435 * @KDBUS_ATTACH_CREDS: Credentials
436 * @KDBUS_ATTACH_NAMES: Well-known names
437 * @KDBUS_ATTACH_COMM: The "comm" process identifier
438 * @KDBUS_ATTACH_EXE: The path of the executable
439 * @KDBUS_ATTACH_CMDLINE: The process command line
440 * @KDBUS_ATTACH_CGROUP: The croup membership
441 * @KDBUS_ATTACH_CAPS: The process capabilities
442 * @KDBUS_ATTACH_SECLABEL: The security label
443 * @KDBUS_ATTACH_AUDIT: The audit IDs
445 enum kdbus_attach_flags {
446 KDBUS_ATTACH_TIMESTAMP = 1 << 0,
447 KDBUS_ATTACH_CREDS = 1 << 1,
448 KDBUS_ATTACH_NAMES = 1 << 2,
449 KDBUS_ATTACH_COMM = 1 << 3,
450 KDBUS_ATTACH_EXE = 1 << 4,
451 KDBUS_ATTACH_CMDLINE = 1 << 5,
452 KDBUS_ATTACH_CGROUP = 1 << 6,
453 KDBUS_ATTACH_CAPS = 1 << 7,
454 KDBUS_ATTACH_SECLABEL = 1 << 8,
455 KDBUS_ATTACH_AUDIT = 1 << 9,
459 * struct kdbus_cmd_hello - struct to say hello to kdbus
460 * @size: The total size of the structure
461 * @conn_flags: Connection flags (KDBUS_HELLO_*). The kernel will
462 * return its capabilities in that field.
463 * @attach_flags: Mask of metadata to attach to each message sent
465 * @bus_flags: The flags field copied verbatim from the original
466 * KDBUS_CMD_BUS_MAKE ioctl. It's intended to be useful
467 * to do negotiation of features of the payload that is
468 * transferred (kernel → userspace)
469 * @id: The ID of this connection (kernel → userspace)
470 * @bloom_size: The bloom filter size chosen by the owner
471 * (kernel → userspace)
472 * @pool_size: Size of the connection's buffer where the received
473 * messages are placed
474 * @id128: Unique 128-bit ID of the bus (kernel → userspace)
475 * @items: A list of items
477 * This struct is used with the KDBUS_CMD_HELLO ioctl. See the ioctl
478 * documentation for more information.
480 struct kdbus_cmd_hello {
489 struct kdbus_item items[0];
490 } __attribute__((aligned(8)));
492 /* Flags for KDBUS_CMD_{BUS,EP,NS}_MAKE */
493 enum kdbus_make_flags {
494 KDBUS_MAKE_ACCESS_GROUP = 1 << 0,
495 KDBUS_MAKE_ACCESS_WORLD = 1 << 1,
496 KDBUS_MAKE_POLICY_OPEN = 1 << 2,
500 * struct kdbus_cmd_make - struct to make a bus, an endpoint or a namespace
501 * @size: The total size of the struct
502 * @flags: Properties for the bus/ep/ns to create
503 * @items: Items describing details
505 * This structure is used with the KDBUS_CMD_BUS_MAKE, KDBUS_CMD_EP_MAKE and
506 * KDBUS_CMD_NS_MAKE ioctls.
508 struct kdbus_cmd_make {
511 struct kdbus_item items[0];
512 } __attribute__((aligned(8)));
515 * enum kdbus_name_flags - properties of a well-known name
516 * @KDBUS_NAME_REPLACE_EXISTING: Try to replace name of other connections
517 * @KDBUS_NAME_ALLOW_REPLACEMENT: Allow the replacement of the name
518 * @KDBUS_NAME_QUEUE: Name should be queued if busy
519 * @KDBUS_NAME_IN_QUEUE: Name is queued
520 * @KDBUS_NAME_ACTIVATOR: Name is owned by a activator connection
522 enum kdbus_name_flags {
523 KDBUS_NAME_REPLACE_EXISTING = 1 << 0,
524 KDBUS_NAME_ALLOW_REPLACEMENT = 1 << 1,
525 KDBUS_NAME_QUEUE = 1 << 2,
526 KDBUS_NAME_IN_QUEUE = 1 << 3,
527 KDBUS_NAME_ACTIVATOR = 1 << 4,
531 * struct kdbus_cmd_name - struct to describe a well-known name
532 * @size: The total size of the struct
533 * @flags: Flags for a name entry (KDBUS_NAME_*)
534 * @owner_id: The current owner of the name. For requests,
535 * privileged users may set this field to
536 * (de)register names on behalf of other connections.
537 * @conn_flags: The flags of the owning connection (KDBUS_HELLO_*)
538 * @name: The well-known name
540 * This structure is used with the KDBUS_CMD_NAME_ACQUIRE ioctl.
542 struct kdbus_cmd_name {
548 } __attribute__((aligned(8)));
551 * enum kdbus_name_list_flags - what to include into the returned list
552 * @KDBUS_NAME_LIST_UNIQUE: All active connections
553 * @KDBUS_NAME_LIST_NAMES: All known well-known names
554 * @KDBUS_NAME_LIST_ACTIVATORS: All activator connections
555 * @KDBUS_NAME_LIST_QUEUED: All queued-up names
557 enum kdbus_name_list_flags {
558 KDBUS_NAME_LIST_UNIQUE = 1 << 0,
559 KDBUS_NAME_LIST_NAMES = 1 << 1,
560 KDBUS_NAME_LIST_ACTIVATORS = 1 << 2,
561 KDBUS_NAME_LIST_QUEUED = 1 << 3,
565 * struct kdbus_cmd_name_list - request a list of name entries
566 * @flags: Flags for the query (KDBUS_NAME_LIST_*)
567 * @offset: The returned offset in the caller's pool buffer.
568 * The user must use KDBUS_CMD_FREE to free the
571 * This structure is used with the KDBUS_CMD_NAME_LIST ioctl.
573 struct kdbus_cmd_name_list {
576 } __attribute__((aligned(8)));
579 * struct kdbus_name_list - information returned by KDBUS_CMD_NAME_LIST
580 * @size: The total size of the structure
581 * @names: A list of names
583 * Note that the user is responsible for freeing the allocated memory with
584 * the KDBUS_CMD_FREE ioctl.
586 struct kdbus_name_list {
588 struct kdbus_cmd_name names[0];
592 * struct kdbus_cmd_conn_info - struct used for KDBUS_CMD_CONN_INFO ioctl
593 * @size: The total size of the struct
594 * @flags: KDBUS_ATTACH_* flags
595 * @id: The 64-bit ID of the connection. If set to zero, passing
596 * @name is required. kdbus will look up the name to
597 * determine the ID in this case.
598 * @offset: Returned offset in the caller's pool buffer where the
599 * kdbus_conn_info struct result is stored. The user must
600 * use KDBUS_CMD_FREE to free the allocated memory.
601 * @name: The optional well-known name to look up. Only needed in
604 * On success, the KDBUS_CMD_CONN_INFO ioctl will return 0 and @offset will
605 * tell the user the offset in the connection pool buffer at which to find the
606 * result in a struct kdbus_conn_info.
608 struct kdbus_cmd_conn_info {
614 } __attribute__((aligned(8)));
617 * struct kdbus_conn_info - information returned by KDBUS_CMD_CONN_INFO
618 * @size: The total size of the struct
619 * @id: The connection's 64-bit ID
620 * @flags: The connection's flags
621 * @items: A list of struct kdbus_item
623 * Note that the user is responsible for freeing the allocated memory with
624 * the KDBUS_CMD_FREE ioctl.
626 struct kdbus_conn_info {
630 struct kdbus_item items[0];
634 * struct kdbus_cmd_match - struct to add or remove matches
635 * @size: The total size of the struct
636 * @owner_id: Privileged users may (de)register matches on behalf
638 * @cookie: Userspace supplied cookie. When removing, the cookie
639 * identifies the match to remove
640 * @items: A list of items for additional information
642 * This structure is used with the KDBUS_CMD_ADD_MATCH and
643 * KDBUS_CMD_REMOVE_MATCH ioctl.
645 struct kdbus_cmd_match {
649 struct kdbus_item items[0];
650 } __attribute__((aligned(8)));
653 * enum kdbus_ioctl_type - Ioctl API
654 * @KDBUS_CMD_BUS_MAKE: After opening the "control" device node, this
655 * command creates a new bus with the specified
656 * name. The bus is immediately shut down and
657 * cleaned up when the opened "control" device node
659 * @KDBUS_CMD_NS_MAKE: Similar to KDBUS_CMD_BUS_MAKE, but it creates a
660 * new kdbus namespace.
661 * @KDBUS_CMD_EP_MAKE: Creates a new named special endpoint to talk to
662 * the bus. Such endpoints usually carry a more
663 * restrictive policy and grant restricted access
664 * to specific applications.
665 * @KDBUS_CMD_HELLO: By opening the bus device node a connection is
666 * created. After a HELLO the opened connection
667 * becomes an active peer on the bus.
668 * @KDBUS_CMD_BYEBYE: Disconnect a connection. If the connection's
669 * message list is empty, the calls succeeds, and
670 * the handle is rendered unusable. Otherwise,
671 * -EAGAIN is returned without any further side-
673 * @KDBUS_CMD_MSG_SEND: Send a message and pass data from userspace to
675 * @KDBUS_CMD_MSG_RECV: Receive a message from the kernel which is
676 * placed in the receiver's pool.
677 * @KDBUS_CMD_FREE: Release the allocated memory in the receiver's
679 * @KDBUS_CMD_DROP: Drop and free the next queued message and all
680 * its ressources without actually receiveing it.
681 * @KDBUS_CMD_SRC: Return the sender's connection ID of the next
683 * @KDBUS_CMD_NAME_ACQUIRE: Request a well-known bus name to associate with
684 * the connection. Well-known names are used to
685 * address a peer on the bus.
686 * @KDBUS_CMD_NAME_RELEASE: Release a well-known name the connection
688 * @KDBUS_CMD_NAME_LIST: Retrieve the list of all currently registered
689 * well-known and unique names.
690 * @KDBUS_CMD_CONN_INFO: Retrieve credentials and properties of the
691 * initial creator of the connection. The data was
692 * stored at registration time and does not
693 * necessarily represent the connected process or
694 * the actual state of the process.
695 * @KDBUS_CMD_MATCH_ADD: Install a match which broadcast messages should
696 * be delivered to the connection.
697 * @KDBUS_CMD_MATCH_REMOVE: Remove a current match for broadcast messages.
698 * @KDBUS_CMD_EP_POLICY_SET: Set the policy of an endpoint. It is used to
699 * restrict the access for endpoints created with
701 * @KDBUS_CMD_MEMFD_NEW: Return a new file descriptor which provides an
702 * anonymous shared memory file and which can be
703 * used to pass around larger chunks of data.
704 * Kdbus memfd files can be sealed, which allows
705 * the receiver to trust the data it has received.
706 * Kdbus memfd files expose only very limited
707 * operations, they can be mmap()ed, seek()ed,
708 * (p)read(v)() and (p)write(v)(); most other
709 * common file operations are not implemented.
710 * Special caution needs to be taken with
711 * read(v)()/write(v)() on a shared file; the
712 * underlying file position is always shared
713 * between all users of the file and race against
714 * each other, pread(v)()/pwrite(v)() avoid these
716 * @KDBUS_CMD_MEMFD_SIZE_GET: Return the size of the underlying file, which
717 * changes with write().
718 * @KDBUS_CMD_MEMFD_SIZE_SET: Truncate the underlying file to the specified
720 * @KDBUS_CMD_MEMFD_SEAL_GET: Return the state of the file sealing.
721 * @KDBUS_CMD_MEMFD_SEAL_SET: Seal or break a seal of the file. Only files
722 * which are not shared with other processes and
723 * which are currently not mapped can be sealed.
724 * The current process needs to be the one and
725 * single owner of the file, the sealing cannot
726 * be changed as long as the file is shared.
728 enum kdbus_ioctl_type {
729 KDBUS_CMD_BUS_MAKE = _IOW (KDBUS_IOC_MAGIC, 0x00, struct kdbus_cmd_make),
730 KDBUS_CMD_NS_MAKE = _IOR (KDBUS_IOC_MAGIC, 0x10, struct kdbus_cmd_make),
731 KDBUS_CMD_EP_MAKE = _IOW (KDBUS_IOC_MAGIC, 0x20, struct kdbus_cmd_make),
733 KDBUS_CMD_HELLO = _IOWR(KDBUS_IOC_MAGIC, 0x30, struct kdbus_cmd_hello),
734 KDBUS_CMD_BYEBYE = _IO (KDBUS_IOC_MAGIC, 0x31),
736 KDBUS_CMD_MSG_SEND = _IOW (KDBUS_IOC_MAGIC, 0x40, struct kdbus_msg),
737 KDBUS_CMD_MSG_RECV = _IOR (KDBUS_IOC_MAGIC, 0x41, __u64 *),
738 KDBUS_CMD_FREE = _IOW (KDBUS_IOC_MAGIC, 0x42, __u64 *),
739 KDBUS_CMD_MSG_DROP = _IO (KDBUS_IOC_MAGIC, 0x43),
740 KDBUS_CMD_MSG_SRC = _IOR (KDBUS_IOC_MAGIC, 0x44, __u64 *),
742 KDBUS_CMD_NAME_ACQUIRE = _IOWR(KDBUS_IOC_MAGIC, 0x50, struct kdbus_cmd_name),
743 KDBUS_CMD_NAME_RELEASE = _IOW (KDBUS_IOC_MAGIC, 0x51, struct kdbus_cmd_name),
744 KDBUS_CMD_NAME_LIST = _IOWR(KDBUS_IOC_MAGIC, 0x52, struct kdbus_cmd_name_list),
746 KDBUS_CMD_CONN_INFO = _IOWR(KDBUS_IOC_MAGIC, 0x60, struct kdbus_cmd_conn_info),
748 KDBUS_CMD_MATCH_ADD = _IOW (KDBUS_IOC_MAGIC, 0x70, struct kdbus_cmd_match),
749 KDBUS_CMD_MATCH_REMOVE = _IOW (KDBUS_IOC_MAGIC, 0x71, struct kdbus_cmd_match),
751 KDBUS_CMD_EP_POLICY_SET = _IOW (KDBUS_IOC_MAGIC, 0x80, struct kdbus_cmd_policy),
753 KDBUS_CMD_MEMFD_NEW = _IOR (KDBUS_IOC_MAGIC, 0x90, int *),
754 KDBUS_CMD_MEMFD_SIZE_GET = _IOR (KDBUS_IOC_MAGIC, 0x91, __u64 *),
755 KDBUS_CMD_MEMFD_SIZE_SET = _IOW (KDBUS_IOC_MAGIC, 0x92, __u64 *),
756 KDBUS_CMD_MEMFD_SEAL_GET = _IOR (KDBUS_IOC_MAGIC, 0x93, int *),
757 KDBUS_CMD_MEMFD_SEAL_SET = _IO (KDBUS_IOC_MAGIC, 0x94),
761 * errno - api error codes
762 * @E2BIG: A message contains too many records or items.
763 * @EADDRINUSE: A well-known bus name is already taken by another
765 * @EADDRNOTAVAIL: A message flagged not to activate a service, addressed
766 * a service which is not currently running.
767 * @EAGAIN: No messages are queued at the moment.
768 * @EBADF: File descriptors passed with the message are not valid.
769 * @EBADFD: A bus connection is in a corrupted state.
770 * @EBADMSG: Passed data contains a combination of conflicting or
771 * inconsistent types.
772 * @EBUSY: The user tried to say BYEBYE to a connection, but the
773 * connection had a non-empty message list.
774 * @ECONNRESET: A connection is shut down, no further operations are
776 * @ECOMM: A peer does not accept the file descriptors addressed
778 * @EDESTADDRREQ: The well-known bus name is required but missing.
779 * @EDOM: The size of data does not match the expectations. Used
780 * for the size of the bloom filter bit field.
781 * @EEXIST: A requested namespace, bus or endpoint with the same
782 * name already exists. A specific data type, which is
783 * only expected once, is provided multiple times.
784 * @EFAULT: The supplied memory could not be accessed, or the data
785 * is not properly aligned.
786 * @EINVAL: The provided data does not match its type or other
787 * expectations, like a string which is not NUL terminated,
788 * or a string length that points behind the first
789 * \0-byte in the string.
790 * @EMEDIUMTYPE: A file descriptor which is not a kdbus memfd was
791 * refused to send as KDBUS_MSG_PAYLOAD_MEMFD.
792 * @EMFILE: Too many file descriptors have been supplied with a
794 * @EMLINK: Too many requests from this connection to other peers
795 * are queued and waiting for a reply
796 * @EMSGSIZE: The supplied data is larger than the allowed maximum
798 * @ENAMETOOLONG: The requested name is larger than the allowed maximum
800 * @ENOBUFS: There is no space left for the submitted data to fit
801 * into the receiver's pool.
802 * @ENOENT: The name to query information about is currently not on
804 * @ENOMEM: Out of memory.
805 * @ENOSYS: The requested functionality is not available.
806 * @ENOTSUPP: The feature negotiation failed, a not supported feature
807 * was requested, or an unknown item type was received.
808 * @ENOTTY: An unknown ioctl command was received.
809 * @ENOTUNIQ: A specific data type was addressed to a broadcast
810 * address, but only direct addresses support this kind of
812 * @ENXIO: A unique address does not exist, or an offset in the
813 * receiver's pool does not represent a queued message.
814 * @EPERM: The policy prevented an operation. The requested
815 * resource is owned by another entity.
816 * @ESHUTDOWN: A namespace or endpoint is currently shutting down;
817 * no further operations will be possible.
818 * @ESRCH: A requested well-known bus name is not found.
819 * @ETXTBSY: A kdbus memfd file cannot be sealed or the seal removed,
820 * because it is shared with other processes or still
822 * @EXFULL: The size limits in the pool are reached, no data of
823 * the size tried to submit can be queued.