X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=src%2Flibsystemd%2Fsd-bus%2Fkdbus.h;h=65266ee2125d2dfb9d36a2deb8ae6974a7788071;hp=65f76e9cf4b7bc04b2660091d4d6f0ec975d3370;hb=705a415f684f8e9ee19983e5859de00bbb1477cb;hpb=06b643e7f5a3b79005dd57497897ab7255fe3659 diff --git a/src/libsystemd/sd-bus/kdbus.h b/src/libsystemd/sd-bus/kdbus.h index 65f76e9cf..65266ee21 100644 --- a/src/libsystemd/sd-bus/kdbus.h +++ b/src/libsystemd/sd-bus/kdbus.h @@ -1,33 +1,22 @@ /* - * Copyright (C) 2013 Kay Sievers - * Copyright (C) 2013 Greg Kroah-Hartman - * Copyright (C) 2013 Linux Foundation - * Copyright (C) 2013 Lennart Poettering - * Copyright (C) 2013 Daniel Mack - * * kdbus is free software; you can redistribute it and/or modify it under * the terms of the GNU Lesser General Public License as published by the * Free Software Foundation; either version 2.1 of the License, or (at * your option) any later version. - * - * "Everything should be made as simple as possible, but not simpler." - * -- Albert Einstein */ -#ifndef _KDBUS_H_ -#define _KDBUS_H_ +#ifndef _KDBUS_UAPI_H_ +#define _KDBUS_UAPI_H_ -#ifndef __KERNEL__ -#include -#include +#include #include -#endif #define KDBUS_IOCTL_MAGIC 0x95 #define KDBUS_SRC_ID_KERNEL (0) #define KDBUS_DST_ID_NAME (0) #define KDBUS_MATCH_ID_ANY (~0ULL) #define KDBUS_DST_ID_BROADCAST (~0ULL) +#define KDBUS_FLAG_KERNEL (1ULL << 63) /** * struct kdbus_notify_id_change - name registry change message @@ -48,8 +37,8 @@ struct kdbus_notify_id_change { /** * struct kdbus_notify_name_change - name registry change message - * @old: ID and flags of former owner of a name - * @new: ID and flags of new owner of a name + * @old_id: ID and flags of former owner of a name + * @new_id: ID and flags of new owner of a name * @name: Well-known name * * Sent from kernel to userspace when the owner or activator of @@ -61,35 +50,71 @@ struct kdbus_notify_id_change { * KDBUS_ITEM_NAME_CHANGE */ struct kdbus_notify_name_change { - struct kdbus_notify_id_change old; - struct kdbus_notify_id_change new; + struct kdbus_notify_id_change old_id; + struct kdbus_notify_id_change new_id; char name[0]; }; /** * struct kdbus_creds - process credentials * @uid: User ID + * @euid: Effective UID + * @suid: Saved UID + * @fsuid: Filesystem UID * @gid: Group ID - * @pid: Process ID - * @tid: Thread ID - * @starttime: Starttime of the process - * - * The starttime of the process PID. This is useful to detect PID overruns - * from the client side. i.e. if you use the PID to look something up in - * /proc/$PID/ you can afterwards check the starttime field of it, to ensure - * you didn't run into a PID overrun. + * @egid: Effective GID + * @sgid: Saved GID + * @fsgid: Filesystem GID * * Attached to: * KDBUS_ITEM_CREDS */ struct kdbus_creds { __u64 uid; + __u64 euid; + __u64 suid; + __u64 fsuid; __u64 gid; + __u64 egid; + __u64 sgid; + __u64 fsgid; +}; + +/** + * struct kdbus_pids - process identifiers + * @pid: Process ID + * @tid: Thread ID + * @starttime: Starttime of the process + * + * The PID, TID and starttime of a process. The start tmie is useful to detect + * PID overruns from the client side. i.e. if you use the PID to look something + * up in /proc/$PID/ you can afterwards check the starttime field of it, to + * ensure you didn't run into a PID overrun. + * + * Attached to: + * KDBUS_ITEM_PIDS + */ +struct kdbus_pids { __u64 pid; __u64 tid; __u64 starttime; }; +/** + * struct kdbus_caps - process capabilities + * @last_cap: Highest currently known capability bit + * @caps: Variable number of 32-bit capabilities flags + * + * Contains a variable number of 32-bit capabilities flags. + * + * Attached to: + * KDBUS_ITEM_CAPS + */ +struct kdbus_caps { + __u32 last_cap; + __u32 caps[0]; +}; + /** * struct kdbus_audit - audit information * @sessionid: The audit session ID @@ -121,12 +146,12 @@ struct kdbus_timestamp { /** * struct kdbus_vec - I/O vector for kdbus payload items * @size: The size of the vector - * @address: Memory address for memory addresses + * @address: Memory address of data buffer * @offset: Offset in the in-message payload memory, * relative to the message head * * Attached to: - * KDBUS_ITEM_PAYLOAD_VEC + * KDBUS_ITEM_PAYLOAD_VEC, KDBUS_ITEM_PAYLOAD_OFF */ struct kdbus_vec { __u64 size; @@ -160,7 +185,7 @@ struct kdbus_bloom_filter { * struct kdbus_memfd - a kdbus memfd * @size: The memfd's size * @fd: The file descriptor number - * @__pad: Padding to ensure proper alignement and size + * @__pad: Padding to ensure proper alignment and size * * Attached to: * KDBUS_ITEM_PAYLOAD_MEMFD @@ -177,7 +202,7 @@ struct kdbus_memfd { * @name: Well-known name * * Attached to: - * KDBUS_ITEM_NAME + * KDBUS_ITEM_OWNED_NAME */ struct kdbus_name { __u64 flags; @@ -199,50 +224,67 @@ struct kdbus_policy_access { /** * enum kdbus_item_type - item types to chain data in a list - * @_KDBUS_ITEM_NULL: Uninitialized/invalid - * @_KDBUS_ITEM_USER_BASE: Start of user items - * @KDBUS_ITEM_PAYLOAD_VEC: Vector to data - * @KDBUS_ITEM_PAYLOAD_OFF: Data at returned offset to message head - * @KDBUS_ITEM_PAYLOAD_MEMFD: Data as sealed memfd - * @KDBUS_ITEM_FDS: Attached file descriptors - * @KDBUS_ITEM_BLOOM_PARAMETER: Bus-wide bloom parameters, used with - * KDBUS_CMD_BUS_MAKE, carries a - * struct kdbus_bloom_parameter - * @KDBUS_ITEM_BLOOM_FILTER: Bloom filter carried with a message, used to - * match against a bloom mask of a connection, - * carries a struct kdbus_bloom_filter - * @KDBUS_ITEM_BLOOM_MASK: Bloom mask used to match against a message's - * bloom filter - * @KDBUS_ITEM_DST_NAME: Destination's well-known name - * @KDBUS_ITEM_MAKE_NAME: Name of domain, bus, endpoint - * @KDBUS_ITEM_MEMFD_NAME: The human readable name of a memfd (debugging) - * @KDBUS_ITEM_ATTACH_FLAGS: Attach-flags, used for updating which metadata - * a connection subscribes to - * @_KDBUS_ITEM_ATTACH_BASE: Start of metadata attach items - * @KDBUS_ITEM_NAME: Well-know name with flags - * @KDBUS_ITEM_ID: Connection ID - * @KDBUS_ITEM_TIMESTAMP: Timestamp - * @KDBUS_ITEM_CREDS: Process credential - * @KDBUS_ITEM_AUXGROUPS: Auxiliary process groups - * @KDBUS_ITEM_PID_COMM: Process ID "comm" identifier - * @KDBUS_ITEM_TID_COMM: Thread ID "comm" identifier - * @KDBUS_ITEM_EXE: The path of the executable - * @KDBUS_ITEM_CMDLINE: The process command line - * @KDBUS_ITEM_CGROUP: The croup membership - * @KDBUS_ITEM_CAPS: The process capabilities - * @KDBUS_ITEM_SECLABEL: The security label - * @KDBUS_ITEM_AUDIT: The audit IDs - * @KDBUS_ITEM_CONN_NAME: The connection's human-readable name (debugging) - * @_KDBUS_ITEM_POLICY_BASE: Start of policy items - * @KDBUS_ITEM_POLICY_ACCESS: Policy access block - * @_KDBUS_ITEM_KERNEL_BASE: Start of kernel-generated message items - * @KDBUS_ITEM_NAME_ADD: Notify in struct kdbus_notify_name_change - * @KDBUS_ITEM_NAME_REMOVE: Notify in struct kdbus_notify_name_change - * @KDBUS_ITEM_NAME_CHANGE: Notify in struct kdbus_notify_name_change - * @KDBUS_ITEM_ID_ADD: Notify in struct kdbus_notify_id_change - * @KDBUS_ITEM_ID_REMOVE: Notify in struct kdbus_notify_id_change - * @KDBUS_ITEM_REPLY_TIMEOUT: Timeout has been reached - * @KDBUS_ITEM_REPLY_DEAD: Destination died + * @_KDBUS_ITEM_NULL: Uninitialized/invalid + * @_KDBUS_ITEM_USER_BASE: Start of user items + * @KDBUS_ITEM_PAYLOAD_VEC: Vector to data + * @KDBUS_ITEM_PAYLOAD_OFF: Data at returned offset to message head + * @KDBUS_ITEM_PAYLOAD_MEMFD: Data as sealed memfd + * @KDBUS_ITEM_FDS: Attached file descriptors + * @KDBUS_ITEM_BLOOM_PARAMETER: Bus-wide bloom parameters, used with + * KDBUS_CMD_BUS_MAKE, carries a + * struct kdbus_bloom_parameter + * @KDBUS_ITEM_BLOOM_FILTER: Bloom filter carried with a message, + * used to match against a bloom mask of a + * connection, carries a struct + * kdbus_bloom_filter + * @KDBUS_ITEM_BLOOM_MASK: Bloom mask used to match against a + * message'sbloom filter + * @KDBUS_ITEM_DST_NAME: Destination's well-known name + * @KDBUS_ITEM_MAKE_NAME: Name of domain, bus, endpoint + * @KDBUS_ITEM_ATTACH_FLAGS_SEND: Attach-flags, used for updating which + * metadata a connection opts in to send + * @KDBUS_ITEM_ATTACH_FLAGS_RECV: Attach-flags, used for updating which + * metadata a connection requests to + * receive for each reeceived message + * @KDBUS_ITEM_ID: Connection ID + * @KDBUS_ITEM_NAME: Well-know name with flags + * @_KDBUS_ITEM_ATTACH_BASE: Start of metadata attach items + * @KDBUS_ITEM_TIMESTAMP: Timestamp + * @KDBUS_ITEM_CREDS: Process credentials + * @KDBUS_ITEM_PIDS: Process identifiers + * @KDBUS_ITEM_AUXGROUPS: Auxiliary process groups + * @KDBUS_ITEM_OWNED_NAME: A name owned by the associated + * connection + * @KDBUS_ITEM_TID_COMM: Thread ID "comm" identifier + * (Don't trust this, see below.) + * @KDBUS_ITEM_PID_COMM: Process ID "comm" identifier + * (Don't trust this, see below.) + * @KDBUS_ITEM_EXE: The path of the executable + * (Don't trust this, see below.) + * @KDBUS_ITEM_CMDLINE: The process command line + * (Don't trust this, see below.) + * @KDBUS_ITEM_CGROUP: The croup membership + * @KDBUS_ITEM_CAPS: The process capabilities + * @KDBUS_ITEM_SECLABEL: The security label + * @KDBUS_ITEM_AUDIT: The audit IDs + * @KDBUS_ITEM_CONN_DESCRIPTION: The connection's human-readable name + * (debugging) + * @_KDBUS_ITEM_POLICY_BASE: Start of policy items + * @KDBUS_ITEM_POLICY_ACCESS: Policy access block + * @_KDBUS_ITEM_KERNEL_BASE: Start of kernel-generated message items + * @KDBUS_ITEM_NAME_ADD: Notification in kdbus_notify_name_change + * @KDBUS_ITEM_NAME_REMOVE: Notification in kdbus_notify_name_change + * @KDBUS_ITEM_NAME_CHANGE: Notification in kdbus_notify_name_change + * @KDBUS_ITEM_ID_ADD: Notification in kdbus_notify_id_change + * @KDBUS_ITEM_ID_REMOVE: Notification in kdbus_notify_id_change + * @KDBUS_ITEM_REPLY_TIMEOUT: Timeout has been reached + * @KDBUS_ITEM_REPLY_DEAD: Destination died + * + * N.B: The process and thread COMM fields, as well as the CMDLINE and + * EXE fields may be altered by unprivileged processes und should + * hence *not* used for security decisions. Peers should make use of + * these items only for informational purposes, such as generating log + * records. */ enum kdbus_item_type { _KDBUS_ITEM_NULL, @@ -256,24 +298,27 @@ enum kdbus_item_type { KDBUS_ITEM_BLOOM_MASK, KDBUS_ITEM_DST_NAME, KDBUS_ITEM_MAKE_NAME, - KDBUS_ITEM_MEMFD_NAME, - KDBUS_ITEM_ATTACH_FLAGS, + KDBUS_ITEM_ATTACH_FLAGS_SEND, + KDBUS_ITEM_ATTACH_FLAGS_RECV, + KDBUS_ITEM_ID, + KDBUS_ITEM_NAME, + /* keep these item types in sync with KDBUS_ATTACH_* flags */ _KDBUS_ITEM_ATTACH_BASE = 0x1000, - KDBUS_ITEM_NAME = _KDBUS_ITEM_ATTACH_BASE, - KDBUS_ITEM_ID, - KDBUS_ITEM_TIMESTAMP, + KDBUS_ITEM_TIMESTAMP = _KDBUS_ITEM_ATTACH_BASE, KDBUS_ITEM_CREDS, + KDBUS_ITEM_PIDS, KDBUS_ITEM_AUXGROUPS, - KDBUS_ITEM_PID_COMM, + KDBUS_ITEM_OWNED_NAME, KDBUS_ITEM_TID_COMM, + KDBUS_ITEM_PID_COMM, KDBUS_ITEM_EXE, KDBUS_ITEM_CMDLINE, KDBUS_ITEM_CGROUP, KDBUS_ITEM_CAPS, KDBUS_ITEM_SECLABEL, KDBUS_ITEM_AUDIT, - KDBUS_ITEM_CONN_NAME, + KDBUS_ITEM_CONN_DESCRIPTION, _KDBUS_ITEM_POLICY_BASE = 0x2000, KDBUS_ITEM_POLICY_ACCESS = _KDBUS_ITEM_POLICY_BASE, @@ -324,7 +369,9 @@ struct kdbus_item { __u64 id; struct kdbus_vec vec; struct kdbus_creds creds; + struct kdbus_pids pids; struct kdbus_audit audit; + struct kdbus_caps caps; struct kdbus_timestamp timestamp; struct kdbus_name name; struct kdbus_bloom_parameter bloom_parameter; @@ -358,9 +405,9 @@ struct kdbus_item { * name is not currently active */ enum kdbus_msg_flags { - KDBUS_MSG_FLAGS_EXPECT_REPLY = 1 << 0, - KDBUS_MSG_FLAGS_SYNC_REPLY = 1 << 1, - KDBUS_MSG_FLAGS_NO_AUTO_START = 1 << 2, + KDBUS_MSG_FLAGS_EXPECT_REPLY = 1ULL << 0, + KDBUS_MSG_FLAGS_SYNC_REPLY = 1ULL << 1, + KDBUS_MSG_FLAGS_NO_AUTO_START = 1ULL << 2, }; /** @@ -376,7 +423,8 @@ enum kdbus_payload_type { /** * struct kdbus_msg - the representation of a kdbus message * @size: Total size of the message - * @flags: Message flags (KDBUS_MSG_FLAGS_*) + * @flags: Message flags (KDBUS_MSG_FLAGS_*), userspace → kernel + * @kernel_flags: Supported message flags, kernel → userspace * @priority: Message queue priority value * @dst_id: 64-bit ID of the destination connection * @src_id: 64-bit ID of the source connection @@ -386,7 +434,8 @@ enum kdbus_payload_type { * @timeout_ns: The time to wait for a message reply from the peer. * If there is no reply, a kernel-generated message * with an attached KDBUS_ITEM_REPLY_TIMEOUT item - * is sent to @src_id. + * is sent to @src_id. The timeout is expected in + * nanoseconds and as absolute CLOCK_MONOTONIC value. * @cookie_reply: A reply to the requesting message with the same * cookie. The requesting connection can match its * request and the reply with this value @@ -398,6 +447,7 @@ enum kdbus_payload_type { struct kdbus_msg { __u64 size; __u64 flags; + __u64 kernel_flags; __s64 priority; __u64 dst_id; __u64 src_id; @@ -425,26 +475,62 @@ struct kdbus_msg { * the priority value is ignored. */ enum kdbus_recv_flags { - KDBUS_RECV_PEEK = 1 << 0, - KDBUS_RECV_DROP = 1 << 1, - KDBUS_RECV_USE_PRIORITY = 1 << 2, + KDBUS_RECV_PEEK = 1ULL << 0, + KDBUS_RECV_DROP = 1ULL << 1, + KDBUS_RECV_USE_PRIORITY = 1ULL << 2, }; /** * struct kdbus_cmd_recv - struct to de-queue a buffered message - * @flags: KDBUS_RECV_* flags + * @flags: KDBUS_RECV_* flags, userspace → kernel + * @kernel_flags: Supported KDBUS_RECV_* flags, kernel → userspace * @priority: Minimum priority of the messages to de-queue. Lowest * values have the highest priority. * @offset: Returned offset in the pool where the message is * stored. The user must use KDBUS_CMD_FREE to free * the allocated memory. + * @dropped_msgs: In case the KDBUS_CMD_MSG_RECV ioctl returns + * -EOVERFLOW, this field will contain the number of + * broadcast messages that have been lost since the + * last call. * * This struct is used with the KDBUS_CMD_MSG_RECV ioctl. */ struct kdbus_cmd_recv { __u64 flags; + __u64 kernel_flags; __s64 priority; + union { + __u64 offset; + __u64 dropped_msgs; + }; +} __attribute__((aligned(8))); + +/** + * struct kdbus_cmd_cancel - struct to cancel a synchronously pending message + * @cookie: The cookie of the pending message + * @flags: Flags for the free command. Currently unused. + * + * This struct is used with the KDBUS_CMD_CANCEL ioctl. + */ +struct kdbus_cmd_cancel { + __u64 cookie; + __u64 flags; +} __attribute__((aligned(8))); + +/** + * struct kdbus_cmd_free - struct to free a slice of memory in the pool + * @offset: The offset of the memory slice, as returned by other + * ioctls + * @flags: Flags for the free command, userspace → kernel + * @kernel_flags: Supported flags of the free command, userspace → kernel + * + * This struct is used with the KDBUS_CMD_FREE ioctl. + */ +struct kdbus_cmd_free { __u64 offset; + __u64 flags; + __u64 kernel_flags; } __attribute__((aligned(8))); /** @@ -477,7 +563,7 @@ enum kdbus_policy_type { /** * enum kdbus_hello_flags - flags for struct kdbus_cmd_hello - * @KDBUS_HELLO_ACCEPT_FD: The connection allows the receiving of + * @KDBUS_HELLO_ACCEPT_FD: The connection allows the reception of * any passed file descriptors * @KDBUS_HELLO_ACTIVATOR: Special-purpose connection which registers * a well-know name for a process to be started @@ -486,57 +572,66 @@ enum kdbus_policy_type { * policy entries for a name. The provided name * is not activated and not registered with the * name database, it only allows unprivileged - * connections to acquire a name, talk or discover + * connections to aquire a name, talk or discover * a service * @KDBUS_HELLO_MONITOR: Special-purpose connection to monitor * bus traffic */ enum kdbus_hello_flags { - KDBUS_HELLO_ACCEPT_FD = 1 << 0, - KDBUS_HELLO_ACTIVATOR = 1 << 1, - KDBUS_HELLO_POLICY_HOLDER = 1 << 2, - KDBUS_HELLO_MONITOR = 1 << 3, + KDBUS_HELLO_ACCEPT_FD = 1ULL << 0, + KDBUS_HELLO_ACTIVATOR = 1ULL << 1, + KDBUS_HELLO_POLICY_HOLDER = 1ULL << 2, + KDBUS_HELLO_MONITOR = 1ULL << 3, }; /** * enum kdbus_attach_flags - flags for metadata attachments - * @KDBUS_ATTACH_TIMESTAMP: Timestamp - * @KDBUS_ATTACH_CREDS: Credentials - * @KDBUS_ATTACH_AUXGROUPS: Auxiliary groups - * @KDBUS_ATTACH_NAMES: Well-known names - * @KDBUS_ATTACH_COMM: The "comm" process identifier - * @KDBUS_ATTACH_EXE: The path of the executable - * @KDBUS_ATTACH_CMDLINE: The process command line - * @KDBUS_ATTACH_CGROUP: The croup membership - * @KDBUS_ATTACH_CAPS: The process capabilities - * @KDBUS_ATTACH_SECLABEL: The security label - * @KDBUS_ATTACH_AUDIT: The audit IDs - * @KDBUS_ATTACH_CONN_NAME: The human-readable connection name - * @_KDBUS_ATTACH_ALL: All of the above + * @KDBUS_ATTACH_TIMESTAMP: Timestamp + * @KDBUS_ATTACH_CREDS: Credentials + * @KDBUS_ATTACH_PIDS: PIDs + * @KDBUS_ATTACH_AUXGROUPS: Auxiliary groups + * @KDBUS_ATTACH_NAMES: Well-known names + * @KDBUS_ATTACH_TID_COMM: The "comm" process identifier of the TID + * @KDBUS_ATTACH_PID_COMM: The "comm" process identifier of the PID + * @KDBUS_ATTACH_EXE: The path of the executable + * @KDBUS_ATTACH_CMDLINE: The process command line + * @KDBUS_ATTACH_CGROUP: The croup membership + * @KDBUS_ATTACH_CAPS: The process capabilities + * @KDBUS_ATTACH_SECLABEL: The security label + * @KDBUS_ATTACH_AUDIT: The audit IDs + * @KDBUS_ATTACH_CONN_DESCRIPTION: The human-readable connection name + * @_KDBUS_ATTACH_ALL: All of the above + * @_KDBUS_ATTACH_ANY: Wildcard match to enable any kind of + * metatdata. */ enum kdbus_attach_flags { - KDBUS_ATTACH_TIMESTAMP = 1 << 0, - KDBUS_ATTACH_CREDS = 1 << 1, - KDBUS_ATTACH_AUXGROUPS = 1 << 2, - KDBUS_ATTACH_NAMES = 1 << 3, - KDBUS_ATTACH_COMM = 1 << 4, - KDBUS_ATTACH_EXE = 1 << 5, - KDBUS_ATTACH_CMDLINE = 1 << 6, - KDBUS_ATTACH_CGROUP = 1 << 7, - KDBUS_ATTACH_CAPS = 1 << 8, - KDBUS_ATTACH_SECLABEL = 1 << 9, - KDBUS_ATTACH_AUDIT = 1 << 10, - KDBUS_ATTACH_CONN_NAME = 1 << 11, - _KDBUS_ATTACH_ALL = (1 << 12) - 1, + KDBUS_ATTACH_TIMESTAMP = 1ULL << 0, + KDBUS_ATTACH_CREDS = 1ULL << 1, + KDBUS_ATTACH_PIDS = 1ULL << 2, + KDBUS_ATTACH_AUXGROUPS = 1ULL << 3, + KDBUS_ATTACH_NAMES = 1ULL << 4, + KDBUS_ATTACH_TID_COMM = 1ULL << 5, + KDBUS_ATTACH_PID_COMM = 1ULL << 6, + KDBUS_ATTACH_EXE = 1ULL << 7, + KDBUS_ATTACH_CMDLINE = 1ULL << 8, + KDBUS_ATTACH_CGROUP = 1ULL << 9, + KDBUS_ATTACH_CAPS = 1ULL << 10, + KDBUS_ATTACH_SECLABEL = 1ULL << 11, + KDBUS_ATTACH_AUDIT = 1ULL << 12, + KDBUS_ATTACH_CONN_DESCRIPTION = 1ULL << 13, + _KDBUS_ATTACH_ALL = (1ULL << 14) - 1, + _KDBUS_ATTACH_ANY = ~0ULL }; /** * struct kdbus_cmd_hello - struct to say hello to kdbus * @size: The total size of the structure - * @conn_flags: Connection flags (KDBUS_HELLO_*). The kernel will - * return its capabilities in that field. - * @attach_flags: Mask of metadata to attach to each message sent - * (KDBUS_ATTACH_*) + * @flags: Connection flags (KDBUS_HELLO_*), userspace → kernel + * @kernel_flags: Supported connection flags, kernel → userspace + * @attach_flags_send: Mask of metadata to attach to each message sent + * off by this connection (KDBUS_ATTACH_*) + * @attach_flags_recv: Mask of metadata to attach to each message receieved + * by the new connection (KDBUS_ATTACH_*) * @bus_flags: The flags field copied verbatim from the original * KDBUS_CMD_BUS_MAKE ioctl. It's intended to be useful * to do negotiation of features of the payload that is @@ -553,8 +648,10 @@ enum kdbus_attach_flags { */ struct kdbus_cmd_hello { __u64 size; - __u64 conn_flags; - __u64 attach_flags; + __u64 flags; + __u64 kernel_flags; + __u64 attach_flags_send; + __u64 attach_flags_recv; __u64 bus_flags; __u64 id; __u64 pool_size; @@ -565,26 +662,29 @@ struct kdbus_cmd_hello { /** * enum kdbus_make_flags - Flags for KDBUS_CMD_{BUS,EP,NS}_MAKE - * @KDBUS_MAKE_ACCESS_GROUP: Make the device node group-accessible - * @KDBUS_MAKE_ACCESS_WORLD: Make the device node world-accessible + * @KDBUS_MAKE_ACCESS_GROUP: Make the bus or endpoint node group-accessible + * @KDBUS_MAKE_ACCESS_WORLD: Make the bus or endpoint node world-accessible */ enum kdbus_make_flags { - KDBUS_MAKE_ACCESS_GROUP = 1 << 0, - KDBUS_MAKE_ACCESS_WORLD = 1 << 1, + KDBUS_MAKE_ACCESS_GROUP = 1ULL << 0, + KDBUS_MAKE_ACCESS_WORLD = 1ULL << 1, }; /** * struct kdbus_cmd_make - struct to make a bus, an endpoint or a domain * @size: The total size of the struct - * @flags: Properties for the bus/ep/domain to create + * @flags: Properties for the bus/ep/domain to create, + * userspace → kernel + * @kernel_flags: Supported flags for the used command, kernel → userspace * @items: Items describing details * - * This structure is used with the KDBUS_CMD_BUS_MAKE, KDBUS_CMD_EP_MAKE and - * KDBUS_CMD_DOMAIN_MAKE ioctls. + * This structure is used with the KDBUS_CMD_BUS_MAKE and + * KDBUS_CMD_ENDPOINT_MAKE ioctls. */ struct kdbus_cmd_make { __u64 size; __u64 flags; + __u64 kernel_flags; struct kdbus_item items[0]; } __attribute__((aligned(8))); @@ -597,29 +697,46 @@ struct kdbus_cmd_make { * @KDBUS_NAME_ACTIVATOR: Name is owned by a activator connection */ enum kdbus_name_flags { - KDBUS_NAME_REPLACE_EXISTING = 1 << 0, - KDBUS_NAME_ALLOW_REPLACEMENT = 1 << 1, - KDBUS_NAME_QUEUE = 1 << 2, - KDBUS_NAME_IN_QUEUE = 1 << 3, - KDBUS_NAME_ACTIVATOR = 1 << 4, + KDBUS_NAME_REPLACE_EXISTING = 1ULL << 0, + KDBUS_NAME_ALLOW_REPLACEMENT = 1ULL << 1, + KDBUS_NAME_QUEUE = 1ULL << 2, + KDBUS_NAME_IN_QUEUE = 1ULL << 3, + KDBUS_NAME_ACTIVATOR = 1ULL << 4, }; /** * struct kdbus_cmd_name - struct to describe a well-known name * @size: The total size of the struct - * @flags: Flags for a name entry (KDBUS_NAME_*) - * @owner_id: The current owner of the name. - * @conn_flags: The flags of the owning connection (KDBUS_HELLO_*) - * @name: The well-known name + * @flags: Flags for a name entry (KDBUS_NAME_*), + * userspace → kernel, kernel → userspace + * @kernel_flags: Supported flags for a name entry, kernel → userspace + * @items: Item list, containing the well-known name as + * KDBUS_ITEM_NAME * * This structure is used with the KDBUS_CMD_NAME_ACQUIRE ioctl. */ struct kdbus_cmd_name { __u64 size; __u64 flags; - __u64 owner_id; + __u64 kernel_flags; + struct kdbus_item items[0]; +} __attribute__((aligned(8))); + +/** + * struct kdbus_name_info - struct to describe a well-known name + * @size: The total size of the struct + * @conn_flags: The flags of the owning connection (KDBUS_HELLO_*) + * @owner_id: The current owner of the name + * @items: Item list, containing the well-known name as + * KDBUS_ITEM_OWNED_NAME + * + * This structure is used as return struct for the KDBUS_CMD_NAME_LIST ioctl. + */ +struct kdbus_name_info { + __u64 size; __u64 conn_flags; - char name[0]; + __u64 owner_id; + struct kdbus_item items[0]; } __attribute__((aligned(8))); /** @@ -630,15 +747,17 @@ struct kdbus_cmd_name { * @KDBUS_NAME_LIST_QUEUED: All queued-up names */ enum kdbus_name_list_flags { - KDBUS_NAME_LIST_UNIQUE = 1 << 0, - KDBUS_NAME_LIST_NAMES = 1 << 1, - KDBUS_NAME_LIST_ACTIVATORS = 1 << 2, - KDBUS_NAME_LIST_QUEUED = 1 << 3, + KDBUS_NAME_LIST_UNIQUE = 1ULL << 0, + KDBUS_NAME_LIST_NAMES = 1ULL << 1, + KDBUS_NAME_LIST_ACTIVATORS = 1ULL << 2, + KDBUS_NAME_LIST_QUEUED = 1ULL << 3, }; /** * struct kdbus_cmd_name_list - request a list of name entries - * @flags: Flags for the query (KDBUS_NAME_LIST_*) + * @flags: Flags for the query (KDBUS_NAME_LIST_*), + * userspace → kernel + * @kernel_flags: Supported flags for queries, kernel → userspace * @offset: The returned offset in the caller's pool buffer. * The user must use KDBUS_CMD_FREE to free the * allocated memory. @@ -647,6 +766,7 @@ enum kdbus_name_list_flags { */ struct kdbus_cmd_name_list { __u64 flags; + __u64 kernel_flags; __u64 offset; } __attribute__((aligned(8))); @@ -660,45 +780,48 @@ struct kdbus_cmd_name_list { */ struct kdbus_name_list { __u64 size; - struct kdbus_cmd_name names[0]; + struct kdbus_name_info names[0]; }; /** - * struct kdbus_cmd_conn_info - struct used for KDBUS_CMD_CONN_INFO ioctl + * struct kdbus_cmd_info - struct used for KDBUS_CMD_CONN_INFO ioctl * @size: The total size of the struct - * @flags: KDBUS_ATTACH_* flags + * @flags: KDBUS_ATTACH_* flags, userspace → kernel + * @kernel_flags: Supported KDBUS_ATTACH_* flags, kernel → userspace * @id: The 64-bit ID of the connection. If set to zero, passing * @name is required. kdbus will look up the name to * determine the ID in this case. * @offset: Returned offset in the caller's pool buffer where the - * kdbus_conn_info struct result is stored. The user must + * kdbus_info struct result is stored. The user must * use KDBUS_CMD_FREE to free the allocated memory. - * @name: The optional well-known name to look up. Only needed in - * case @id is zero. + * @items: The optional item list, containing the + * well-known name to look up as a KDBUS_ITEM_NAME. + * Only needed in case @id is zero. * * On success, the KDBUS_CMD_CONN_INFO ioctl will return 0 and @offset will * tell the user the offset in the connection pool buffer at which to find the - * result in a struct kdbus_conn_info. + * result in a struct kdbus_info. */ -struct kdbus_cmd_conn_info { +struct kdbus_cmd_info { __u64 size; __u64 flags; + __u64 kernel_flags; __u64 id; __u64 offset; - char name[0]; + struct kdbus_item items[0]; } __attribute__((aligned(8))); /** - * struct kdbus_conn_info - information returned by KDBUS_CMD_CONN_INFO + * struct kdbus_info - information returned by KDBUS_CMD_*_INFO * @size: The total size of the struct - * @id: The connection's 64-bit ID - * @flags: The connection's flags + * @id: The connection's or bus' 64-bit ID + * @flags: The connection's or bus' flags * @items: A list of struct kdbus_item * * Note that the user is responsible for freeing the allocated memory with * the KDBUS_CMD_FREE ioctl. */ -struct kdbus_conn_info { +struct kdbus_info { __u64 size; __u64 id; __u64 flags; @@ -708,198 +831,139 @@ struct kdbus_conn_info { /** * struct kdbus_cmd_update - update flags of a connection * @size: The total size of the struct + * @flags: Flags for the update command, userspace → kernel + * @kernel_flags: Supported flags for this command, kernel → userspace * @items: A list of struct kdbus_item * * This struct is used with the KDBUS_CMD_CONN_UPDATE ioctl. */ struct kdbus_cmd_update { __u64 size; + __u64 flags; + __u64 kernel_flags; struct kdbus_item items[0]; } __attribute__((aligned(8))); +/** + * enum kdbus_cmd_match_flags - flags to control the KDBUS_CMD_MATCH_ADD ioctl + * @KDBUS_MATCH_REPLACE: If entries with the supplied cookie already + * exists, remove them before installing the new + * matches. + */ +enum kdbus_cmd_match_flags { + KDBUS_MATCH_REPLACE = 1ULL << 0, +}; + /** * struct kdbus_cmd_match - struct to add or remove matches * @size: The total size of the struct * @cookie: Userspace supplied cookie. When removing, the cookie * identifies the match to remove + * @flags: Flags for match command (KDBUS_MATCH_*), + * userspace → kernel + * @kernel_flags: Supported flags of the used command, kernel → userspace * @items: A list of items for additional information * - * This structure is used with the KDBUS_CMD_ADD_MATCH and - * KDBUS_CMD_REMOVE_MATCH ioctl. + * This structure is used with the KDBUS_CMD_MATCH_ADD and + * KDBUS_CMD_MATCH_REMOVE ioctl. */ struct kdbus_cmd_match { __u64 size; __u64 cookie; + __u64 flags; + __u64 kernel_flags; struct kdbus_item items[0]; } __attribute__((aligned(8))); /** - * enum kdbus_ioctl_type - Ioctl API - * @KDBUS_CMD_BUS_MAKE: After opening the "control" device node, this - * command creates a new bus with the specified + * Ioctl API + * KDBUS_CMD_BUS_MAKE: After opening the "control" node, this command + * creates a new bus with the specified * name. The bus is immediately shut down and - * cleaned up when the opened "control" device node - * is closed. - * @KDBUS_CMD_DOMAIN_MAKE: Similar to KDBUS_CMD_BUS_MAKE, but it creates a - * new kdbus domain. - * @KDBUS_CMD_EP_MAKE: Creates a new named special endpoint to talk to + * cleaned up when the opened file descriptor is + * closed. + * KDBUS_CMD_ENDPOINT_MAKE: Creates a new named special endpoint to talk to * the bus. Such endpoints usually carry a more * restrictive policy and grant restricted access * to specific applications. - * @KDBUS_CMD_HELLO: By opening the bus device node a connection is + * KDBUS_CMD_HELLO: By opening the bus node, a connection is * created. After a HELLO the opened connection * becomes an active peer on the bus. - * @KDBUS_CMD_BYEBYE: Disconnect a connection. If the connection's - * message list is empty, the calls succeeds, and - * the handle is rendered unusable. Otherwise, - * -EAGAIN is returned without any further side- - * effects. - * @KDBUS_CMD_MSG_SEND: Send a message and pass data from userspace to + * KDBUS_CMD_BYEBYE: Disconnect a connection. If there are no + * messages queued up in the connection's pool, + * the call succeeds, and the handle is rendered + * unusable. Otherwise, -EBUSY is returned without + * any further side-effects. + * KDBUS_CMD_MSG_SEND: Send a message and pass data from userspace to * the kernel. - * @KDBUS_CMD_MSG_RECV: Receive a message from the kernel which is + * KDBUS_CMD_MSG_RECV: Receive a message from the kernel which is * placed in the receiver's pool. - * @KDBUS_CMD_MSG_CANCEL: Cancel a pending request of a message that + * KDBUS_CMD_MSG_CANCEL: Cancel a pending request of a message that * blocks while waiting for a reply. The parameter * denotes the cookie of the message in flight. - * @KDBUS_CMD_FREE: Release the allocated memory in the receiver's + * KDBUS_CMD_FREE: Release the allocated memory in the receiver's * pool. - * @KDBUS_CMD_NAME_ACQUIRE: Request a well-known bus name to associate with + * KDBUS_CMD_NAME_ACQUIRE: Request a well-known bus name to associate with * the connection. Well-known names are used to * address a peer on the bus. - * @KDBUS_CMD_NAME_RELEASE: Release a well-known name the connection + * KDBUS_CMD_NAME_RELEASE: Release a well-known name the connection * currently owns. - * @KDBUS_CMD_NAME_LIST: Retrieve the list of all currently registered + * KDBUS_CMD_NAME_LIST: Retrieve the list of all currently registered * well-known and unique names. - * @KDBUS_CMD_CONN_INFO: Retrieve credentials and properties of the + * KDBUS_CMD_CONN_INFO: Retrieve credentials and properties of the * initial creator of the connection. The data was * stored at registration time and does not * necessarily represent the connected process or * the actual state of the process. - * @KDBUS_CMD_CONN_UPDATE: Update the properties of a connection. Used to + * KDBUS_CMD_CONN_UPDATE: Update the properties of a connection. Used to * update the metadata subscription mask and * policy. - * @KDBUS_CMD_EP_UPDATE: Update the properties of a custom enpoint. Used + * KDBUS_CMD_BUS_CREATOR_INFO: Retrieve information of the creator of the bus + * a connection is attached to. + * KDBUS_CMD_ENDPOINT_UPDATE: Update the properties of a custom enpoint. Used * to update the policy. - * @KDBUS_CMD_MATCH_ADD: Install a match which broadcast messages should + * KDBUS_CMD_MATCH_ADD: Install a match which broadcast messages should * be delivered to the connection. - * @KDBUS_CMD_MATCH_REMOVE: Remove a current match for broadcast messages. - */ -enum kdbus_ioctl_type { - KDBUS_CMD_BUS_MAKE = _IOW(KDBUS_IOCTL_MAGIC, 0x00, - struct kdbus_cmd_make), - KDBUS_CMD_DOMAIN_MAKE = _IOW(KDBUS_IOCTL_MAGIC, 0x10, - struct kdbus_cmd_make), - KDBUS_CMD_EP_MAKE = _IOW(KDBUS_IOCTL_MAGIC, 0x20, - struct kdbus_cmd_make), - - KDBUS_CMD_HELLO = _IOWR(KDBUS_IOCTL_MAGIC, 0x30, - struct kdbus_cmd_hello), - KDBUS_CMD_BYEBYE = _IO(KDBUS_IOCTL_MAGIC, 0x31), - - KDBUS_CMD_MSG_SEND = _IOWR(KDBUS_IOCTL_MAGIC, 0x40, - struct kdbus_msg), - KDBUS_CMD_MSG_RECV = _IOWR(KDBUS_IOCTL_MAGIC, 0x41, - struct kdbus_cmd_recv), - KDBUS_CMD_MSG_CANCEL = _IOW(KDBUS_IOCTL_MAGIC, 0x42, __u64 *), - KDBUS_CMD_FREE = _IOW(KDBUS_IOCTL_MAGIC, 0x43, __u64 *), - - KDBUS_CMD_NAME_ACQUIRE = _IOWR(KDBUS_IOCTL_MAGIC, 0x50, - struct kdbus_cmd_name), - KDBUS_CMD_NAME_RELEASE = _IOW(KDBUS_IOCTL_MAGIC, 0x51, - struct kdbus_cmd_name), - KDBUS_CMD_NAME_LIST = _IOWR(KDBUS_IOCTL_MAGIC, 0x52, - struct kdbus_cmd_name_list), - - KDBUS_CMD_CONN_INFO = _IOWR(KDBUS_IOCTL_MAGIC, 0x60, - struct kdbus_cmd_conn_info), - KDBUS_CMD_CONN_UPDATE = _IOW(KDBUS_IOCTL_MAGIC, 0x61, - struct kdbus_cmd_update), - - KDBUS_CMD_EP_UPDATE = _IOW(KDBUS_IOCTL_MAGIC, 0x71, - struct kdbus_cmd_update), - - KDBUS_CMD_MATCH_ADD = _IOW(KDBUS_IOCTL_MAGIC, 0x80, - struct kdbus_cmd_match), - KDBUS_CMD_MATCH_REMOVE = _IOW(KDBUS_IOCTL_MAGIC, 0x81, - struct kdbus_cmd_match), -}; - -/* - * errno - api error codes - * @E2BIG: A message contains too many records or items. - * @EADDRINUSE: A well-known bus name is already taken by another - * connection. - * @EADDRNOTAVAIL: A message flagged not to activate a service, addressed - * a service which is not currently running. - * @EAGAIN: No messages are queued at the moment. - * @EALREADY: A requested name is already owned by the connection, - * a connection is already disconnected, memfd is already - * sealed or has the requested size. - * @EBADF: File descriptors passed with the message are not valid. - * @EBADFD: A bus connection is in a corrupted state. - * @EBADMSG: Passed data contains a combination of conflicting or - * inconsistent types. - * @EBUSY: The user tried to say BYEBYE to a connection, but the - * connection had a non-empty message list. - * @ECANCELED: A synchronous message sending was cancelled. - * @ECONNRESET: A connection is shut down, no further operations are - * possible. - * @ECOMM: A peer does not accept the file descriptors addressed - * to it. - * @EDESTADDRREQ: The well-known bus name is required but missing. - * @EDOM: The size of data does not match the expectations. Used - * for bloom bit field sizes. - * @EEXIST: A requested domain, bus or endpoint with the same - * name already exists. A specific data type, which is - * only expected once, is provided multiple times. - * @EFAULT: The supplied memory could not be accessed, the data - * is not properly aligned, or the current task's memory - * is inaccessible. - * @EINVAL: The provided data does not match its type or other - * expectations, like a string which is not NUL terminated, - * or a string length that points behind the first - * \0-byte in the string. - * @EMEDIUMTYPE: A file descriptor which is not a kdbus memfd was - * refused to send as KDBUS_MSG_PAYLOAD_MEMFD. - * @EMFILE: Too many file descriptors have been supplied with a - * message. - * Too many connections or buses are created for a given - * user. - * @EMLINK: Too many requests from this connection to other peers - * are queued and waiting for a reply - * @EMSGSIZE: The supplied data is larger than the allowed maximum - * size. - * @ENAMETOOLONG: The requested name is larger than the allowed maximum - * size. - * @ENOBUFS: There is no space left for the submitted data to fit - * into the receiver's pool. - * @ENOENT: The to be cancelled message was not found. - * @ENOMEM: Out of memory. - * @ENOMSG: The queue is not empty, but no message with a matching - * priority is currently queued. - * @ENOSYS: The requested functionality is not available. - * @ENOTTY: An unknown ioctl command was received. - * @ENOTUNIQ: A specific data type was addressed to a broadcast - * address, but only direct addresses support this kind of - * data. - * @ENXIO: A unique address does not exist, or an offset in the - * receiver's pool does not represent a queued message. - * @EOPNOTSUPP: The feature negotiation failed, a not supported feature - * was requested, or an unknown item type was received. - * @EPERM: The policy prevented an operation. The requested - * resource is owned by another entity. - * @EPIPE: When sending a message, a synchronous reply from the - * receiving connection was expected but the connection - * died before answering. - * @ESHUTDOWN: A domain, bus or endpoint is currently shutting down; - * no further operations will be possible. - * @ESRCH: A requested well-known bus name is not found. - * @ETIMEDOUT: A synchronous wait for a message reply did not arrive - * within the specified time frame. - * @ETXTBSY: A kdbus memfd file cannot be sealed or the seal removed, - * because it is shared with other processes or still - * mmap()ed. - * @EXFULL: The size limits in the pool are reached, no data of - * the size tried to submit can be queued. - */ -#endif + * KDBUS_CMD_MATCH_REMOVE: Remove a current match for broadcast messages. + */ +#define KDBUS_CMD_BUS_MAKE _IOW(KDBUS_IOCTL_MAGIC, 0x00, \ + struct kdbus_cmd_make) +#define KDBUS_CMD_ENDPOINT_MAKE _IOW(KDBUS_IOCTL_MAGIC, 0x10, \ + struct kdbus_cmd_make) + +#define KDBUS_CMD_HELLO _IOWR(KDBUS_IOCTL_MAGIC, 0x20, \ + struct kdbus_cmd_hello) +#define KDBUS_CMD_BYEBYE _IO(KDBUS_IOCTL_MAGIC, 0x21) \ + +#define KDBUS_CMD_MSG_SEND _IOWR(KDBUS_IOCTL_MAGIC, 0x30, \ + struct kdbus_msg) +#define KDBUS_CMD_MSG_RECV _IOWR(KDBUS_IOCTL_MAGIC, 0x31, \ + struct kdbus_cmd_recv) +#define KDBUS_CMD_MSG_CANCEL _IOW(KDBUS_IOCTL_MAGIC, 0x32, \ + struct kdbus_cmd_cancel) +#define KDBUS_CMD_FREE _IOW(KDBUS_IOCTL_MAGIC, 0x33, \ + struct kdbus_cmd_free) + +#define KDBUS_CMD_NAME_ACQUIRE _IOWR(KDBUS_IOCTL_MAGIC, 0x40, \ + struct kdbus_cmd_name) +#define KDBUS_CMD_NAME_RELEASE _IOW(KDBUS_IOCTL_MAGIC, 0x41, \ + struct kdbus_cmd_name) +#define KDBUS_CMD_NAME_LIST _IOWR(KDBUS_IOCTL_MAGIC, 0x42, \ + struct kdbus_cmd_name_list) + +#define KDBUS_CMD_CONN_INFO _IOWR(KDBUS_IOCTL_MAGIC, 0x50, \ + struct kdbus_cmd_info) +#define KDBUS_CMD_CONN_UPDATE _IOW(KDBUS_IOCTL_MAGIC, 0x51, \ + struct kdbus_cmd_update) +#define KDBUS_CMD_BUS_CREATOR_INFO _IOWR(KDBUS_IOCTL_MAGIC, 0x52, \ + struct kdbus_cmd_info) + +#define KDBUS_CMD_ENDPOINT_UPDATE _IOW(KDBUS_IOCTL_MAGIC, 0x61, \ + struct kdbus_cmd_update) + +#define KDBUS_CMD_MATCH_ADD _IOW(KDBUS_IOCTL_MAGIC, 0x70, \ + struct kdbus_cmd_match) +#define KDBUS_CMD_MATCH_REMOVE _IOW(KDBUS_IOCTL_MAGIC, 0x71, \ + struct kdbus_cmd_match) + +#endif /* _KDBUS_UAPI_H_ */