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 * @monotonic_ns: Monotonic timestamp, in nanoseconds
106 * @realtime_ns: Realtime timestamp, in nanoseconds
109 * KDBUS_ITEM_TIMESTAMP
111 struct kdbus_timestamp {
117 * struct kdbus_vec - I/O vector for kdbus payload items
118 * @size: The size of the vector
119 * @address: Memory address for memory addresses
120 * @offset: Offset in the in-message payload memory,
121 * relative to the message head
124 * KDBUS_ITEM_PAYLOAD_VEC
135 * struct kdbus_memfd - a kdbus memfd
136 * @size: The memfd's size
137 * @fd: The file descriptor number
138 * @__pad: Padding to make the struct aligned
141 * KDBUS_ITEM_PAYLOAD_MEMFD
150 * struct kdbus_name - a registered well-known name with its flags
151 * @flags: flags from KDBUS_NAME_*
152 * @name: well-known name
163 * struct kdbus_policy_access - policy access item
164 * @type: One of KDBUS_POLICY_ACCESS_* types
165 * @bits: Access to grant. One of KDBUS_POLICY_*
166 * @id: For KDBUS_POLICY_ACCESS_USER, the uid
167 * For KDBUS_POLICY_ACCESS_GROUP, the gid
170 * struct kdbus_policy
172 struct kdbus_policy_access {
173 __u64 type; /* USER, GROUP, WORLD */
174 __u64 bits; /* RECV, SEND, OWN */
175 __u64 id; /* uid, gid, 0 */
179 * struct kdbus_policy - a policy item
180 * @access: Policy access details
181 * @name: Well-known name to grant access to
184 * KDBUS_POLICY_ACCESS
185 * KDBUS_ITEM_POLICY_NAME
187 struct kdbus_policy {
189 struct kdbus_policy_access access;
195 * enum kdbus_item_type - item types to chain data in a list
196 * @KDBUS_ITEM_PAYLOAD_VEC: Vector to data
197 * @KDBUS_ITEM_PAYLOAD_OFF: Data at returned offset to message head
198 * @KDBUS_ITEM_PAYLOAD_MEMFD: Data as sealed memfd
199 * @KDBUS_ITEM_FDS: Attached file descriptors
200 * @KDBUS_ITEM_BLOOM: For broadcasts, carries bloom filter
201 * @KDBUS_ITEM_BLOOM_SIZE: Desired bloom size, used by KDBUS_CMD_BUS_MAKE
202 * @KDBUS_ITEM_DST_NAME: Destination's well-known name
203 * @KDBUS_ITEM_PRIORITY: Queue priority for message
204 * @KDBUS_ITEM_MAKE_NAME: Name of namespace, bus, endpoint
205 * @KDBUS_ITEM_POLICY_NAME: Policy in struct kdbus_policy
206 * @KDBUS_ITEM_POLICY_ACCESS: Policy in struct kdbus_policy
207 * @KDBUS_ITEM_NAME: Well-know name with flags
208 * @KDBUS_ITEM_ID: Connection ID
209 * @KDBUS_ITEM_TIMESTAMP: Timestamp
210 * @KDBUS_ITEM_CREDS: Process credential
211 * @KDBUS_ITEM_PID_COMM: Process ID "comm" identifier
212 * @KDBUS_ITEM_TID_COMM: Thread ID "comm" identifier
213 * @KDBUS_ITEM_EXE: The path of the executable
214 * @KDBUS_ITEM_CMDLINE: The process command line
215 * @KDBUS_ITEM_CGROUP: The croup membership
216 * @KDBUS_ITEM_CAPS: The process capabilities
217 * @KDBUS_ITEM_SECLABEL: The security label
218 * @KDBUS_ITEM_AUDIT: The audit IDs
219 * @KDBUS_ITEM_NAME_ADD: Notify in struct kdbus_notify_name_change
220 * @KDBUS_ITEM_NAME_REMOVE: Notify in struct kdbus_notify_name_change
221 * @KDBUS_ITEM_NAME_CHANGE: Notify in struct kdbus_notify_name_change
222 * @KDBUS_ITEM_ID_ADD: Notify in struct kdbus_notify_id_change
223 * @KDBUS_ITEM_ID_REMOVE: Notify in struct kdbus_notify_id_change
224 * @KDBUS_ITEM_REPLY_TIMEOUT: Timeout has been reached
225 * @KDBUS_ITEM_REPLY_DEAD: Destination died
227 enum kdbus_item_type {
229 _KDBUS_ITEM_USER_BASE,
230 KDBUS_ITEM_PAYLOAD_VEC = _KDBUS_ITEM_USER_BASE,
231 KDBUS_ITEM_PAYLOAD_OFF,
232 KDBUS_ITEM_PAYLOAD_MEMFD,
235 KDBUS_ITEM_BLOOM_SIZE,
238 KDBUS_ITEM_MAKE_NAME,
240 _KDBUS_ITEM_POLICY_BASE = 0x400,
241 KDBUS_ITEM_POLICY_NAME = _KDBUS_ITEM_POLICY_BASE,
242 KDBUS_ITEM_POLICY_ACCESS,
244 _KDBUS_ITEM_ATTACH_BASE = 0x600,
245 KDBUS_ITEM_NAME = _KDBUS_ITEM_ATTACH_BASE,
247 KDBUS_ITEM_TIMESTAMP,
258 _KDBUS_ITEM_KERNEL_BASE = 0x800,
259 KDBUS_ITEM_NAME_ADD = _KDBUS_ITEM_KERNEL_BASE,
260 KDBUS_ITEM_NAME_REMOVE,
261 KDBUS_ITEM_NAME_CHANGE,
263 KDBUS_ITEM_ID_REMOVE,
264 KDBUS_ITEM_REPLY_TIMEOUT,
265 KDBUS_ITEM_REPLY_DEAD,
269 * struct kdbus_item - chain of data blocks
270 * @size: Overall data record size
271 * @type: Kdbus_item type of data
272 * @data: Generic bytes
273 * @data32: Generic 32 bit array
274 * @data64: Generic 64 bit array
275 * @str: Generic string
277 * @vec: KDBUS_ITEM_PAYLOAD_VEC
278 * @creds: KDBUS_ITEM_CREDS
279 * @audit: KDBUS_ITEM_AUDIT
280 * @timestamp: KDBUS_ITEM_TIMESTAMP
281 * @name: KDBUS_ITEM_NAME
282 * @memfd: KDBUS_ITEM_PAYLOAD_MEMFD
283 * @name_change: KDBUS_ITEM_NAME_ADD
284 * KDBUS_ITEM_NAME_REMOVE
285 * KDBUS_ITEM_NAME_CHANGE
286 * @id_change: KDBUS_ITEM_ID_ADD
287 * KDBUS_ITEM_ID_REMOVE
288 * @policy: KDBUS_ITEM_POLICY_NAME
289 * KDBUS_ITEM_POLICY_ACCESS
301 struct kdbus_vec vec;
302 struct kdbus_creds creds;
303 struct kdbus_audit audit;
304 struct kdbus_timestamp timestamp;
305 struct kdbus_name name;
306 struct kdbus_memfd memfd;
308 struct kdbus_notify_name_change name_change;
309 struct kdbus_notify_id_change id_change;
310 struct kdbus_policy policy;
315 * enum kdbus_msg_flags - type of message
316 * @KDBUS_MSG_FLAGS_EXPECT_REPLY: Expect a reply message, used for
317 * method calls. The userspace-supplied
318 * cookie identifies the message and the
319 * respective reply carries the cookie
321 * @KDBUS_MSG_FLAGS_NO_AUTO_START: Do not start a service, if the addressed
322 * name is not currently active
324 enum kdbus_msg_flags {
325 KDBUS_MSG_FLAGS_EXPECT_REPLY = 1 << 0,
326 KDBUS_MSG_FLAGS_NO_AUTO_START = 1 << 1,
330 * enum kdbus_payload_type - type of payload carried by message
331 * @KDBUS_PAYLOAD_KERNEL: Kernel-generated simple message
332 * @KDBUS_PAYLOAD_DBUS: D-Bus marshalling
334 enum kdbus_payload_type {
335 KDBUS_PAYLOAD_KERNEL,
336 KDBUS_PAYLOAD_DBUS = 0x4442757344427573ULL, /* 'DBusDBus' */
340 * struct kdbus_msg - the representation of a kdbus message
341 * @size: Total size of the message
342 * @flags: Message flags (KDBUS_MSG_FLAGS_*)
343 * @dst_id: 64-bit ID of the destination connection
344 * @src_id: 64-bit ID of the source connection
345 * @payload_type: Payload type (KDBUS_PAYLOAD_*)
346 * @cookie: Userspace-supplied cookie, for the connection
347 * to identify its messages
348 * @cookie_reply: A reply to the message with the same cookie. The
349 * reply itself has its own cookie, @cookie_reply
350 * corresponds to the cookie of the request message
351 * @timeout_ns: For non-kernel-generated messages, this denotes the
352 * message timeout in nanoseconds. A message has to be
353 * received with KDBUS_CMD_MSG_RECV by the destination
354 * connection within this time frame. For messages that
355 * have KDBUS_MSG_FLAGS_EXPECT_REPLY set in @flags,
356 * this value also denotes the timeout for the reply to
357 * this message. If there is no reply, or the message is
358 * not received in time by the other side, a
359 * kernel-generated message with an attached
360 * KDBUS_ITEM_REPLY_TIMEOUT item is sent to @src_id.
361 * A 0-value is only valid if KDBUS_MSG_FLAGS_EXPECT_REPLY
362 * is unset in @flags.
363 * @items: A list of kdbus_items containing the message payload
374 struct kdbus_item items[0];
375 } __attribute__((aligned(8)));
378 * enum kdbus_policy_access_type - permissions of a policy record
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: Maximum size of the pool buffer (kernel → userspace)
473 * @id128: Unique 128-bit ID of the bus (kernel → userspace)
474 * @items: A list of items
476 * This struct is used with the KDBUS_CMD_HELLO ioctl. See the ioctl
477 * documentation for more information.
479 struct kdbus_cmd_hello {
488 struct kdbus_item items[0];
489 } __attribute__((aligned(8)));
491 /* Flags for KDBUS_CMD_{BUS,EP,NS}_MAKE */
492 enum kdbus_make_flags {
493 KDBUS_MAKE_ACCESS_GROUP = 1 << 0,
494 KDBUS_MAKE_ACCESS_WORLD = 1 << 1,
495 KDBUS_MAKE_POLICY_OPEN = 1 << 2,
499 * struct kdbus_cmd_make - struct to make a bus, an endpoint or a namespace
500 * @size: The total size of the struct
501 * @flags: Properties for the bus/ep/ns to create
502 * @items: Items describing details
504 * This structure is used with the KDBUS_CMD_BUS_MAKE, KDBUS_CMD_EP_MAKE and
505 * KDBUS_CMD_NS_MAKE ioctls.
507 struct kdbus_cmd_make {
510 struct kdbus_item items[0];
511 } __attribute__((aligned(8)));
514 * enum kdbus_name_flags - properties of a well-known name
515 * @KDBUS_NAME_REPLACE_EXISTING: Try to replace name of other connections
516 * @KDBUS_NAME_ALLOW_REPLACEMENT: Allow the replacement of the name
517 * @KDBUS_NAME_QUEUE: Name should be queued if busy
518 * @KDBUS_NAME_IN_QUEUE: Name is queued
519 * @KDBUS_NAME_ACTIVATOR: Name is owned by a activator connection
521 enum kdbus_name_flags {
522 KDBUS_NAME_REPLACE_EXISTING = 1 << 0,
523 KDBUS_NAME_ALLOW_REPLACEMENT = 1 << 1,
524 KDBUS_NAME_QUEUE = 1 << 2,
525 KDBUS_NAME_IN_QUEUE = 1 << 3,
526 KDBUS_NAME_ACTIVATOR = 1 << 4,
530 * struct kdbus_cmd_name - struct to describe a well-known name
531 * @size: The total size of the struct
532 * @flags: Flags for a name entry (KDBUS_NAME_*)
533 * @owner_id: The current owner of the name. For requests,
534 * privileged users may set this field to
535 * (de)register names on behalf of other connections.
536 * @conn_flags: The flags of the owning connection (KDBUS_HELLO_*)
537 * @name: The well-known name
539 * This structure is used with the KDBUS_CMD_NAME_ACQUIRE ioctl.
541 struct kdbus_cmd_name {
547 } __attribute__((aligned(8)));
550 * enum kdbus_name_list_flags - what to include into the returned list
551 * @KDBUS_NAME_LIST_UNIQUE: All active connections
552 * @KDBUS_NAME_LIST_NAMES: All known well-known names
553 * @KDBUS_NAME_LIST_ACTIVATORS: All activator connections
554 * @KDBUS_NAME_LIST_QUEUED: All queued-up names
556 enum kdbus_name_list_flags {
557 KDBUS_NAME_LIST_UNIQUE = 1 << 0,
558 KDBUS_NAME_LIST_NAMES = 1 << 1,
559 KDBUS_NAME_LIST_ACTIVATORS = 1 << 2,
560 KDBUS_NAME_LIST_QUEUED = 1 << 3,
564 * struct kdbus_cmd_name_list - request a list of name entries
565 * @flags: Flags for the query (KDBUS_NAME_LIST_*)
566 * @offset: The returned offset in the caller's pool buffer.
567 * The user must use KDBUS_CMD_FREE to free the
570 * This structure is used with the KDBUS_CMD_NAME_LIST ioctl.
572 struct kdbus_cmd_name_list {
575 } __attribute__((aligned(8)));
578 * struct kdbus_name_list - information returned by KDBUS_CMD_NAME_LIST
579 * @size: The total size of the structure
580 * @names: A list of names
582 * Note that the user is responsible for freeing the allocated memory with
583 * the KDBUS_CMD_FREE ioctl.
585 struct kdbus_name_list {
587 struct kdbus_cmd_name names[0];
591 * struct kdbus_cmd_conn_info - struct used for KDBUS_CMD_CONN_INFO ioctl
592 * @size: The total size of the struct
593 * @flags: KDBUS_ATTACH_* flags
594 * @id: The 64-bit ID of the connection. If set to zero, passing
595 * @name is required. kdbus will look up the name to determine
596 * the ID in this case.
597 * @offset: Returned offset in the caller's pool buffer where the
598 * kdbus_conn_info struct result is stored. The user must
599 * use KDBUS_CMD_FREE to free the allocated memory.
600 * @name: The optional well-known name to look up. Only needed in
603 * On success, the KDBUS_CMD_CONN_INFO ioctl will return 0 and @offset will
604 * tell the user the offset in the connection pool buffer at which to find the
605 * result in a struct kdbus_conn_info.
607 struct kdbus_cmd_conn_info {
613 } __attribute__((aligned(8)));
616 * struct kdbus_conn_info - information returned by KDBUS_CMD_CONN_INFO
617 * @size: The total size of the struct
618 * @id: The connection's 64-bit ID
619 * @flags: The connection's flags
620 * @items: A list of struct kdbus_item
622 * Note that the user is responsible for freeing the allocated memory with
623 * the KDBUS_CMD_FREE ioctl.
625 struct kdbus_conn_info {
629 struct kdbus_item items[0];
633 * struct kdbus_cmd_match - struct to add or remove matches
634 * @size: The total size of the struct
635 * @owner_id: Privileged users may (de)register matches on behalf
637 * @cookie: Userspace supplied cookie. When removing, the cookie
638 * identifies the match to remove
639 * @items: A list of items for additional information
641 * This structure is used with the KDBUS_CMD_ADD_MATCH and
642 * KDBUS_CMD_REMOVE_MATCH ioctl.
644 struct kdbus_cmd_match {
648 struct kdbus_item items[0];
649 } __attribute__((aligned(8)));
652 * enum kdbus_ioctl_type - Ioctl API
653 * @KDBUS_CMD_BUS_MAKE: After opening the "control" device node, this
654 * command creates a new bus with the specified
655 * name. The bus is immediately shut down and
656 * cleaned up when the opened "control" device node
658 * @KDBUS_CMD_NS_MAKE: Similar to KDBUS_CMD_BUS_MAKE, but it creates a
659 * new kdbus namespace.
660 * @KDBUS_CMD_EP_MAKE: Creates a new named special endpoint to talk to
661 * the bus. Such endpoints usually carry a more
662 * restrictive policy and grant restricted access
663 * to specific applications.
664 * @KDBUS_CMD_HELLO: By opening the bus device node a connection is
665 * created. After a HELLO the opened connection
666 * becomes an active peer on the bus.
667 * @KDBUS_CMD_BYEBYE: Disconnect a connection. If the connection's
668 * message list is empty, the calls succeeds, and
669 * the handle is rendered unusable. Otherwise,
670 * -EAGAIN is returned without any further side-
672 * @KDBUS_CMD_MSG_SEND: Send a message and pass data from userspace to
674 * @KDBUS_CMD_MSG_RECV: Receive a message from the kernel which is
675 * placed in the receiver's pool.
676 * @KDBUS_CMD_FREE: Release the allocated memory in the receiver's
678 * @KDBUS_CMD_DROP: Drop and free the next queued message and all
679 * its ressources without actually receiveing it.
680 * @KDBUS_CMD_SRC: Return the sender's connection ID of the next
682 * @KDBUS_CMD_NAME_ACQUIRE: Request a well-known bus name to associate with
683 * the connection. Well-known names are used to
684 * address a peer on the bus.
685 * @KDBUS_CMD_NAME_RELEASE: Release a well-known name the connection
687 * @KDBUS_CMD_NAME_LIST: Retrieve the list of all currently registered
688 * well-known and unique names.
689 * @KDBUS_CMD_CONN_INFO: Retrieve credentials and properties of the
690 * initial creator of the connection. The data was
691 * stored at registration time and does not
692 * necessarily represent the connected process or
693 * the actual state of the process.
694 * @KDBUS_CMD_MATCH_ADD: Install a match which broadcast messages should
695 * be delivered to the connection.
696 * @KDBUS_CMD_MATCH_REMOVE: Remove a current match for broadcast messages.
697 * @KDBUS_CMD_EP_POLICY_SET: Set the policy of an endpoint. It is used to
698 * restrict the access for endpoints created with
700 * @KDBUS_CMD_MEMFD_NEW: Return a new file descriptor which provides an
701 * anonymous shared memory file and which can be
702 * used to pass around larger chunks of data.
703 * Kdbus memfd files can be sealed, which allows
704 * the receiver to trust the data it has received.
705 * Kdbus memfd files expose only very limited
706 * operations, they can be mmap()ed, seek()ed,
707 * (p)read(v)() and (p)write(v)(); most other
708 * common file operations are not implemented.
709 * Special caution needs to be taken with
710 * read(v)()/write(v)() on a shared file; the
711 * underlying file position is always shared
712 * between all users of the file and race against
713 * each other, pread(v)()/pwrite(v)() avoid these
715 * @KDBUS_CMD_MEMFD_SIZE_GET: Return the size of the underlying file, which
716 * changes with write().
717 * @KDBUS_CMD_MEMFD_SIZE_SET: Truncate the underlying file to the specified
719 * @KDBUS_CMD_MEMFD_SEAL_GET: Return the state of the file sealing.
720 * @KDBUS_CMD_MEMFD_SEAL_SET: Seal or break a seal of the file. Only files
721 * which are not shared with other processes and
722 * which are currently not mapped can be sealed.
723 * The current process needs to be the one and
724 * single owner of the file, the sealing cannot
725 * be changed as long as the file is shared.
727 enum kdbus_ioctl_type {
728 KDBUS_CMD_BUS_MAKE = _IOW (KDBUS_IOC_MAGIC, 0x00, struct kdbus_cmd_make),
729 KDBUS_CMD_NS_MAKE = _IOR (KDBUS_IOC_MAGIC, 0x10, struct kdbus_cmd_make),
730 KDBUS_CMD_EP_MAKE = _IOW (KDBUS_IOC_MAGIC, 0x20, struct kdbus_cmd_make),
732 KDBUS_CMD_HELLO = _IOWR(KDBUS_IOC_MAGIC, 0x30, struct kdbus_cmd_hello),
733 KDBUS_CMD_BYEBYE = _IO (KDBUS_IOC_MAGIC, 0x31),
735 KDBUS_CMD_MSG_SEND = _IOW (KDBUS_IOC_MAGIC, 0x40, struct kdbus_msg),
736 KDBUS_CMD_MSG_RECV = _IOR (KDBUS_IOC_MAGIC, 0x41, __u64 *),
737 KDBUS_CMD_FREE = _IOW (KDBUS_IOC_MAGIC, 0x42, __u64 *),
738 KDBUS_CMD_MSG_DROP = _IO (KDBUS_IOC_MAGIC, 0x43),
739 KDBUS_CMD_MSG_SRC = _IOR (KDBUS_IOC_MAGIC, 0x44, __u64 *),
741 KDBUS_CMD_NAME_ACQUIRE = _IOWR(KDBUS_IOC_MAGIC, 0x50, struct kdbus_cmd_name),
742 KDBUS_CMD_NAME_RELEASE = _IOW (KDBUS_IOC_MAGIC, 0x51, struct kdbus_cmd_name),
743 KDBUS_CMD_NAME_LIST = _IOWR(KDBUS_IOC_MAGIC, 0x52, struct kdbus_cmd_name_list),
745 KDBUS_CMD_CONN_INFO = _IOWR(KDBUS_IOC_MAGIC, 0x60, struct kdbus_cmd_conn_info),
747 KDBUS_CMD_MATCH_ADD = _IOW (KDBUS_IOC_MAGIC, 0x70, struct kdbus_cmd_match),
748 KDBUS_CMD_MATCH_REMOVE = _IOW (KDBUS_IOC_MAGIC, 0x71, struct kdbus_cmd_match),
750 KDBUS_CMD_EP_POLICY_SET = _IOW (KDBUS_IOC_MAGIC, 0x80, struct kdbus_cmd_policy),
752 KDBUS_CMD_MEMFD_NEW = _IOR (KDBUS_IOC_MAGIC, 0x90, int *),
753 KDBUS_CMD_MEMFD_SIZE_GET = _IOR (KDBUS_IOC_MAGIC, 0x91, __u64 *),
754 KDBUS_CMD_MEMFD_SIZE_SET = _IOW (KDBUS_IOC_MAGIC, 0x92, __u64 *),
755 KDBUS_CMD_MEMFD_SEAL_GET = _IOR (KDBUS_IOC_MAGIC, 0x93, int *),
756 KDBUS_CMD_MEMFD_SEAL_SET = _IO (KDBUS_IOC_MAGIC, 0x94),
760 * errno - api error codes
761 * @E2BIG: A message contains too many records or items.
762 * @EADDRINUSE: A well-known bus name is already taken by another
764 * @EADDRNOTAVAIL: A message flagged not to activate a service, addressed
765 * a service which is not currently running.
766 * @EAGAIN: No messages are queued at the moment.
767 * @EBADF: File descriptors passed with the message are not valid.
768 * @EBADFD: A bus connection is in a corrupted state.
769 * @EBADMSG: Passed data contains a combination of conflicting or
770 * inconsistent types.
771 * @EBUSY: The user tried to say BYEBYE to a connection, but the
772 * connection had a non-empty message list.
773 * @ECONNRESET: A connection is shut down, no further operations are
775 * @ECOMM: A peer does not accept the file descriptors addressed
777 * @EDESTADDRREQ: The well-known bus name is required but missing.
778 * @EDOM: The size of data does not match the expectations. Used
779 * for the size of the bloom filter bit field.
780 * @EEXIST: A requested namespace, bus or endpoint with the same
781 * name already exists. A specific data type, which is
782 * only expected once, is provided multiple times.
783 * @EFAULT: The supplied memory could not be accessed, or the data
784 * is not properly aligned.
785 * @EINVAL: The provided data does not match its type or other
786 * expectations, like a string which is not NUL terminated,
787 * or a string length that points behind the first
788 * \0-byte in the string.
789 * @EMEDIUMTYPE: A file descriptor which is not a kdbus memfd was
790 * refused to send as KDBUS_MSG_PAYLOAD_MEMFD.
791 * @EMFILE: Too many file descriptors have been supplied with a
793 * @EMSGSIZE: The supplied data is larger than the allowed maximum
795 * @ENAMETOOLONG: The requested name is larger than the allowed maximum
797 * @ENOBUFS: There is no space left for the submitted data to fit
798 * into the receiver's pool.
799 * @ENOENT: The name to query information about is currently not on
801 * @ENOMEM: Out of memory.
802 * @ENOSYS: The requested functionality is not available.
803 * @ENOTCONN: The addressed peer is not an active connection.
804 * @ENOTSUPP: The feature negotiation failed, a not supported feature
805 * was requested, or an unknown item type was received.
806 * @ENOTTY: An unknown ioctl command was received.
807 * @ENOTUNIQ: A specific data type was addressed to a broadcast
808 * address, but only direct addresses support this kind of
810 * @ENXIO: A unique address does not exist, or an offset in the
811 * receiver's pool does not represent a queued message.
812 * @EPERM: The policy prevented an operation. The requested
813 * resource is owned by another entity.
814 * @ESHUTDOWN: A namespace or endpoint is currently shutting down;
815 * no further operations will be possible.
816 * @ESRCH: A requested well-known bus name is not found.
817 * @ETXTBSY: A kdbus memfd file cannot be sealed or the seal removed,
818 * because it is shared with other processes or still
820 * @EXFULL: The size limits in the pool are reached, no data of
821 * the size tried to submit can be queued.