X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=blobdiff_plain;f=src%2Flibsystemd-bus%2Fkdbus.h;h=f6423c9d42197f5916edcae7bfb0a9f7f599a412;hb=81efa1da643326f13370dce52d8bf064c1226118;hp=972a02df8d9246ad10f2e663ed69c180120e0666;hpb=613ec4b836c6f322762b4a3e358d22a81b8d6f2c;p=elogind.git diff --git a/src/libsystemd-bus/kdbus.h b/src/libsystemd-bus/kdbus.h index 972a02df8..f6423c9d4 100644 --- a/src/libsystemd-bus/kdbus.h +++ b/src/libsystemd-bus/kdbus.h @@ -23,48 +23,44 @@ #define KDBUS_IOC_MAGIC 0x95 #define KDBUS_SRC_ID_KERNEL (0) #define KDBUS_DST_ID_NAME (0) -#define KDBUS_MATCH_SRC_ID_ANY (~0ULL) +#define KDBUS_MATCH_ID_ANY (~0ULL) #define KDBUS_DST_ID_BROADCAST (~0ULL) /** - * struct kdbus_notify_name_change - name registry change message - * @old_id: Former owner of a name - * @new_id: New owner of a name - * @old_flags: flags from KDBUS_NAME_* the name entry used to have - * @new_flags: flags from KDBUS_NAME_* the name entry has now - * @name: Well-known name + * struct kdbus_notify_id_change - name registry change message + * @id: New or former owner of the name + * @flags: flags field from KDBUS_HELLO_* * * Sent from kernel to userspace when the owner or activator of * a well-known name changes. * * Attached to: - * KDBUS_ITEM_NAME_ADD - * KDBUS_ITEM_NAME_REMOVE - * KDBUS_ITEM_NAME_CHANGE + * KDBUS_ITEM_ID_ADD + * KDBUS_ITEM_ID_REMOVE */ -struct kdbus_notify_name_change { - __u64 old_id; - __u64 new_id; - __u64 old_flags; - __u64 new_flags; - char name[0]; +struct kdbus_notify_id_change { + __u64 id; + __u64 flags; }; /** - * struct kdbus_notify_id_change - name registry change message - * @id: New or former owner of the name - * @flags: flags field from KDBUS_HELLO_* + * 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 + * @name: Well-known name * * Sent from kernel to userspace when the owner or activator of * a well-known name changes. * * Attached to: - * KDBUS_ITEM_ID_ADD - * KDBUS_ITEM_ID_REMOVE + * KDBUS_ITEM_NAME_ADD + * KDBUS_ITEM_NAME_REMOVE + * KDBUS_ITEM_NAME_CHANGE */ -struct kdbus_notify_id_change { - __u64 id; - __u64 flags; +struct kdbus_notify_name_change { + struct kdbus_notify_id_change old; + struct kdbus_notify_id_change new; + char name[0]; }; /** @@ -121,7 +117,8 @@ 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 - * @offset: Offset in the in-message payload memory + * @offset: Offset in the in-message payload memory, + * relative to the message head * * Attached to: * KDBUS_ITEM_PAYLOAD_VEC @@ -196,17 +193,22 @@ struct kdbus_policy { /** * 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 in the pool + * @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: For broadcasts, carries bloom filter + * @KDBUS_ITEM_BLOOM_SIZE: Desired bloom size, used by KDBUS_CMD_BUS_MAKE * @KDBUS_ITEM_DST_NAME: Destination's well-known name - * @KDBUS_ITEM_PRIORITY: Queue priority for message * @KDBUS_ITEM_MAKE_NAME: Name of namespace, bus, endpoint + * @_KDBUS_ITEM_POLICY_BASE: Start of policy items * @KDBUS_ITEM_POLICY_NAME: Policy in struct kdbus_policy * @KDBUS_ITEM_POLICY_ACCESS: Policy in struct kdbus_policy + * @_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_PID_COMM: Process ID "comm" identifier @@ -217,6 +219,7 @@ struct kdbus_policy { * @KDBUS_ITEM_CAPS: The process capabilities * @KDBUS_ITEM_SECLABEL: The security label * @KDBUS_ITEM_AUDIT: The audit IDs + * @_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 @@ -233,8 +236,8 @@ enum kdbus_item_type { KDBUS_ITEM_PAYLOAD_MEMFD, KDBUS_ITEM_FDS, KDBUS_ITEM_BLOOM, + KDBUS_ITEM_BLOOM_SIZE, KDBUS_ITEM_DST_NAME, - KDBUS_ITEM_PRIORITY, KDBUS_ITEM_MAKE_NAME, _KDBUS_ITEM_POLICY_BASE = 0x400, @@ -243,6 +246,7 @@ enum kdbus_item_type { _KDBUS_ITEM_ATTACH_BASE = 0x600, KDBUS_ITEM_NAME = _KDBUS_ITEM_ATTACH_BASE, + KDBUS_ITEM_ID, KDBUS_ITEM_TIMESTAMP, KDBUS_ITEM_CREDS, KDBUS_ITEM_PID_COMM, @@ -312,9 +316,11 @@ struct kdbus_item { /** * enum kdbus_msg_flags - type of message - * @KDBUS_MSG_FLAGS_EXPECT_REPLY: Expect a reply message, used for method - * calls. The cookie identifies the - * message and the respective reply + * @KDBUS_MSG_FLAGS_EXPECT_REPLY: Expect a reply message, used for + * method calls. The userspace-supplied + * cookie identifies the message and the + * respective reply carries the cookie + * in cookie_reply * @KDBUS_MSG_FLAGS_NO_AUTO_START: Do not start a service, if the addressed * name is not currently active */ @@ -326,11 +332,11 @@ enum kdbus_msg_flags { /** * enum kdbus_payload_type - type of payload carried by message * @KDBUS_PAYLOAD_KERNEL: Kernel-generated simple message - * @KDBUS_PAYLOAD_DBUS: D-Bus marshalling + * @KDBUS_PAYLOAD_DBUS: D-Bus marshalling "DBusDBus" */ enum kdbus_payload_type { KDBUS_PAYLOAD_KERNEL, - KDBUS_PAYLOAD_DBUS = 0x4442757344427573ULL, /* 'DBusDBus' */ + KDBUS_PAYLOAD_DBUS = 0x4442757344427573ULL, }; /** @@ -340,21 +346,15 @@ enum kdbus_payload_type { * @dst_id: 64-bit ID of the destination connection * @src_id: 64-bit ID of the source connection * @payload_type: Payload type (KDBUS_PAYLOAD_*) - * @cookie: Userspace-supplied cookie - * @cookie_reply: For kernel-generated messages, this is the cookie - * the message is a reply to - * @timeout_ns: For non-kernel-generated messages, this denotes the - * message timeout in nanoseconds. A message has to be - * received with KDBUS_CMD_MSG_RECV by the destination - * connection within this time frame. For messages that - * have KDBUS_MSG_FLAGS_EXPECT_REPLY set in @flags, - * this value also denotes the timeout for the reply to - * this message. If there is no reply, or the message is - * not received in time by the other side, a - * kernel-generated message with an attached - * KDBUS_ITEM_REPLY_TIMEOUT item is sent to @src_id. - * A 0-value is only valid if KDBUS_MSG_FLAGS_EXPECT_REPLY - * is unset in @flags. + * @cookie: Userspace-supplied cookie, for the connection + * to identify its messages + * @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 + * @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. * @items: A list of kdbus_items containing the message payload */ struct kdbus_msg { @@ -373,6 +373,7 @@ struct kdbus_msg { /** * enum kdbus_policy_access_type - permissions of a policy record + * @_KDBUS_POLICY_ACCESS_NULL: Uninitialized/invalid * @KDBUS_POLICY_ACCESS_USER: Grant access to a uid * @KDBUS_POLICY_ACCESS_GROUP: Grant access to gid * @KDBUS_POLICY_ACCESS_WORLD: World-accessible @@ -493,46 +494,15 @@ enum kdbus_make_flags { }; /** - * struct kdbus_cmd_bus_make - struct to make a bus - * @size: The total size of the struct - * @flags: Properties for the bus to create - * @bloom_size: Size of the bloom filter for this bus - * @items: Items describing details such as the name of the bus - * - * This structure is used with the KDBUS_CMD_BUS_MAKE ioctl. - */ -struct kdbus_cmd_bus_make { - __u64 size; - __u64 flags; - __u64 bloom_size; - struct kdbus_item items[0]; -} __attribute__((aligned(8))); - -/** - * struct kdbus_cmd_ep_make - struct to make an endpoint - * @size: The total size of the struct - * @flags: Unused for now - * @items: Items describing details such as the - * name of the endpoint - * - * This structure is used with the KDBUS_CMD_EP_MAKE ioctl. - */ -struct kdbus_cmd_ep_make { - __u64 size; - __u64 flags; - struct kdbus_item items[0]; -} __attribute__((aligned(8))); - -/** - * struct kdbus_cmd_ns_make - struct to make a namespace + * struct kdbus_cmd_make - struct to make a bus, an endpoint or a namespace * @size: The total size of the struct - * @flags: Unused for now - * @items: Items describing details such as the - * name of the namespace + * @flags: Properties for the bus/ep/ns to create + * @items: Items describing details * - * This structure is used with the KDBUS_CMD_NS_MAKE ioctl. + * This structure is used with the KDBUS_CMD_BUS_MAKE, KDBUS_CMD_EP_MAKE and + * KDBUS_CMD_NS_MAKE ioctls. */ -struct kdbus_cmd_ns_make { +struct kdbus_cmd_make { __u64 size; __u64 flags; struct kdbus_item items[0]; @@ -547,19 +517,20 @@ struct kdbus_cmd_ns_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 = 1 << 0, + KDBUS_NAME_ALLOW_REPLACEMENT = 1 << 1, + KDBUS_NAME_QUEUE = 1 << 2, + KDBUS_NAME_IN_QUEUE = 1 << 3, + KDBUS_NAME_ACTIVATOR = 1 << 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_*) - * @id: Privileged users may use this field to (de)register - * names on behalf of other peers. + * @owner_id: The current owner of the name. For requests, + * privileged users may set this field to + * (de)register names on behalf of other connections. * @conn_flags: The flags of the owning connection (KDBUS_HELLO_*) * @name: The well-known name * @@ -568,7 +539,7 @@ enum kdbus_name_flags { struct kdbus_cmd_name { __u64 size; __u64 flags; - __u64 id; + __u64 owner_id; __u64 conn_flags; char name[0]; } __attribute__((aligned(8))); @@ -593,7 +564,7 @@ enum kdbus_name_list_flags { * @offset: The returned offset in the caller's pool buffer. * The user must use KDBUS_CMD_FREE to free the * allocated memory. - * + * * This structure is used with the KDBUS_CMD_NAME_LIST ioctl. */ struct kdbus_cmd_name_list { @@ -656,37 +627,13 @@ struct kdbus_conn_info { struct kdbus_item items[0]; }; -/** - * enum kdbus_match_type - type of match record - * @KDBUS_MATCH_BLOOM: Matches against KDBUS_MSG_BLOOM - * @KDBUS_MATCH_SRC_NAME: Matches a name string - * @KDBUS_MATCH_NAME_ADD: Matches a name string - * @KDBUS_MATCH_NAME_REMOVE: Matches a name string - * @KDBUS_MATCH_NAME_CHANGE: Matches a name string - * @KDBUS_MATCH_ID_ADD: Matches an ID - * @KDBUS_MATCH_ID_REMOVE: Matches an ID - */ -enum kdbus_match_type { - _KDBUS_MATCH_NULL, - KDBUS_MATCH_BLOOM, - KDBUS_MATCH_SRC_NAME, - KDBUS_MATCH_NAME_ADD, - KDBUS_MATCH_NAME_REMOVE, - KDBUS_MATCH_NAME_CHANGE, - KDBUS_MATCH_ID_ADD, - KDBUS_MATCH_ID_REMOVE, -}; - /** * struct kdbus_cmd_match - struct to add or remove matches * @size: The total size of the struct - * @id: Privileged users may (de)register matches on behalf - * of other peers. In other cases, set to 0. + * @owner_id: Privileged users may (de)register matches on behalf + * of other peers * @cookie: Userspace supplied cookie. When removing, the cookie - * identifies the match to remove. - * @src_id: The source ID to match against. Use - * KDBUS_MATCH_SRC_ID_ANY or any other value for a unique - * match. + * identifies the match to remove * @items: A list of items for additional information * * This structure is used with the KDBUS_CMD_ADD_MATCH and @@ -694,9 +641,8 @@ enum kdbus_match_type { */ struct kdbus_cmd_match { __u64 size; - __u64 id; + __u64 owner_id; __u64 cookie; - __u64 src_id; struct kdbus_item items[0]; } __attribute__((aligned(8))); @@ -716,6 +662,11 @@ struct kdbus_cmd_match { * @KDBUS_CMD_HELLO: By opening the bus device 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 * the kernel. * @KDBUS_CMD_MSG_RECV: Receive a message from the kernel which is @@ -772,11 +723,12 @@ struct kdbus_cmd_match { * be changed as long as the file is shared. */ enum kdbus_ioctl_type { - KDBUS_CMD_BUS_MAKE = _IOW (KDBUS_IOC_MAGIC, 0x00, struct kdbus_cmd_bus_make), - KDBUS_CMD_NS_MAKE = _IOR (KDBUS_IOC_MAGIC, 0x10, struct kdbus_cmd_ns_make), - KDBUS_CMD_EP_MAKE = _IOW (KDBUS_IOC_MAGIC, 0x20, struct kdbus_cmd_ep_make), + KDBUS_CMD_BUS_MAKE = _IOW (KDBUS_IOC_MAGIC, 0x00, struct kdbus_cmd_make), + KDBUS_CMD_NS_MAKE = _IOR (KDBUS_IOC_MAGIC, 0x10, struct kdbus_cmd_make), + KDBUS_CMD_EP_MAKE = _IOW (KDBUS_IOC_MAGIC, 0x20, struct kdbus_cmd_make), KDBUS_CMD_HELLO = _IOWR(KDBUS_IOC_MAGIC, 0x30, struct kdbus_cmd_hello), + KDBUS_CMD_BYEBYE = _IO (KDBUS_IOC_MAGIC, 0x31), KDBUS_CMD_MSG_SEND = _IOW (KDBUS_IOC_MAGIC, 0x40, struct kdbus_msg), KDBUS_CMD_MSG_RECV = _IOR (KDBUS_IOC_MAGIC, 0x41, __u64 *), @@ -814,6 +766,8 @@ enum kdbus_ioctl_type { * @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. * @ECONNRESET: A connection is shut down, no further operations are * possible. * @ECOMM: A peer does not accept the file descriptors addressed @@ -840,6 +794,8 @@ enum kdbus_ioctl_type { * size. * @ENOBUFS: There is no space left for the submitted data to fit * into the receiver's pool. + * @ENOENT: The name to query information about is currently not on + * the bus. * @ENOMEM: Out of memory. * @ENOSYS: The requested functionality is not available. * @ENOTCONN: The addressed peer is not an active connection.