X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=blobdiff_plain;f=src%2Flibsystemd%2Fsd-bus%2Fkdbus.h;h=45598314263f21ed2b23d349c21d0e4aa70470a8;hb=f7c7cd03d1e9a9a4bb6925fb64d8423f4a6a2fdc;hp=fe0bb48728b163a22c957d9e7223e9ef21750b03;hpb=607553f9306286fdccf0b356bc3d1087adfe21c4;p=elogind.git diff --git a/src/libsystemd/sd-bus/kdbus.h b/src/libsystemd/sd-bus/kdbus.h index fe0bb4872..455983142 100644 --- a/src/libsystemd/sd-bus/kdbus.h +++ b/src/libsystemd/sd-bus/kdbus.h @@ -105,7 +105,7 @@ struct kdbus_audit { /** * struct kdbus_timestamp - * @seqnum: Global per-namespace message sequence number + * @seqnum: Global per-domain message sequence number * @monotonic_ns: Monotonic timestamp, in nanoseconds * @realtime_ns: Realtime timestamp, in nanoseconds * @@ -136,6 +136,26 @@ struct kdbus_vec { }; }; +/** + * struct kdbus_bloom_parameter - bus-wide bloom parameters + * @size: Size of the bit field in bytes (m / 8) + * @n_hash: Number of hash functions used (k) + */ +struct kdbus_bloom_parameter { + __u64 size; + __u64 n_hash; +}; + +/** + * struct kdbus_bloom_filter - bloom filter containing n elements + * @generation: Generation of the element set in the filter + * @data: Bit field, multiple of 8 bytes + */ +struct kdbus_bloom_filter { + __u64 generation; + __u64 data[0]; +}; + /** * struct kdbus_memfd - a kdbus memfd * @size: The memfd's size @@ -170,32 +190,13 @@ struct kdbus_name { * @bits: Access to grant. One of KDBUS_POLICY_* * @id: For KDBUS_POLICY_ACCESS_USER, the uid * For KDBUS_POLICY_ACCESS_GROUP, the gid - * - * Embedded in: - * struct kdbus_policy */ struct kdbus_policy_access { __u64 type; /* USER, GROUP, WORLD */ - __u64 bits; /* RECV, SEND, OWN */ + __u64 access; /* OWN, TALK, SEE */ __u64 id; /* uid, gid, 0 */ }; -/** - * struct kdbus_policy - a policy item - * @access: Policy access details - * @name: Well-known name to grant access to - * - * Attached to: - * KDBUS_POLICY_ACCESS - * KDBUS_ITEM_POLICY_NAME - */ -struct kdbus_policy { - union { - struct kdbus_policy_access access; - char name[0]; - }; -}; - /** * enum kdbus_item_type - item types to chain data in a list * @_KDBUS_ITEM_NULL: Uninitialized/invalid @@ -204,14 +205,19 @@ struct kdbus_policy { * @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_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 namespace, bus, endpoint + * @KDBUS_ITEM_MAKE_NAME: Name of domain, bus, endpoint * @KDBUS_ITEM_MEMFD_NAME: The human readable name of a memfd (debugging) - * @_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_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 @@ -226,6 +232,8 @@ struct kdbus_policy { * @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 @@ -242,17 +250,15 @@ enum kdbus_item_type { KDBUS_ITEM_PAYLOAD_OFF, KDBUS_ITEM_PAYLOAD_MEMFD, KDBUS_ITEM_FDS, - KDBUS_ITEM_BLOOM, - KDBUS_ITEM_BLOOM_SIZE, + KDBUS_ITEM_BLOOM_PARAMETER, + KDBUS_ITEM_BLOOM_FILTER, + KDBUS_ITEM_BLOOM_MASK, KDBUS_ITEM_DST_NAME, KDBUS_ITEM_MAKE_NAME, KDBUS_ITEM_MEMFD_NAME, + KDBUS_ITEM_ATTACH_FLAGS, - _KDBUS_ITEM_POLICY_BASE = 0x1000, - KDBUS_ITEM_POLICY_NAME = _KDBUS_ITEM_POLICY_BASE, - KDBUS_ITEM_POLICY_ACCESS, - - _KDBUS_ITEM_ATTACH_BASE = 0x2000, + _KDBUS_ITEM_ATTACH_BASE = 0x1000, KDBUS_ITEM_NAME = _KDBUS_ITEM_ATTACH_BASE, KDBUS_ITEM_ID, KDBUS_ITEM_TIMESTAMP, @@ -267,7 +273,10 @@ enum kdbus_item_type { KDBUS_ITEM_AUDIT, KDBUS_ITEM_CONN_NAME, - _KDBUS_ITEM_KERNEL_BASE = 0x3000, + _KDBUS_ITEM_POLICY_BASE = 0x2000, + KDBUS_ITEM_POLICY_ACCESS = _KDBUS_ITEM_POLICY_BASE, + + _KDBUS_ITEM_KERNEL_BASE = 0x8000, KDBUS_ITEM_NAME_ADD = _KDBUS_ITEM_KERNEL_BASE, KDBUS_ITEM_NAME_REMOVE, KDBUS_ITEM_NAME_CHANGE, @@ -291,14 +300,15 @@ enum kdbus_item_type { * @audit: KDBUS_ITEM_AUDIT * @timestamp: KDBUS_ITEM_TIMESTAMP * @name: KDBUS_ITEM_NAME + * @bloom_parameter: KDBUS_ITEM_BLOOM_PARAMETER + * @bloom_filter: KDBUS_ITEM_BLOOM_FILTER * @memfd: KDBUS_ITEM_PAYLOAD_MEMFD * @name_change: KDBUS_ITEM_NAME_ADD * KDBUS_ITEM_NAME_REMOVE * KDBUS_ITEM_NAME_CHANGE * @id_change: KDBUS_ITEM_ID_ADD * KDBUS_ITEM_ID_REMOVE - * @policy: KDBUS_ITEM_POLICY_NAME - * KDBUS_ITEM_POLICY_ACCESS + * @policy: KDBUS_ITEM_POLICY_ACCESS */ struct kdbus_item { __u64 size; @@ -315,11 +325,13 @@ struct kdbus_item { struct kdbus_audit audit; struct kdbus_timestamp timestamp; struct kdbus_name name; + struct kdbus_bloom_parameter bloom_parameter; + struct kdbus_bloom_filter bloom_filter; struct kdbus_memfd memfd; int fds[0]; struct kdbus_notify_name_change name_change; struct kdbus_notify_id_change id_change; - struct kdbus_policy policy; + struct kdbus_policy_access policy_access; }; }; @@ -449,30 +461,18 @@ enum kdbus_policy_access_type { /** * enum kdbus_policy_access_flags - mode flags - * @KDBUS_POLICY_RECV: Allow receive - * @KDBUS_POLICY_SEND: Allow send * @KDBUS_POLICY_OWN: Allow to own a well-known name + * Implies KDBUS_POLICY_TALK and KDBUS_POLICY_SEE + * @KDBUS_POLICY_TALK: Allow communication to a well-known name + * Implies KDBUS_POLICY_SEE + * @KDBUS_POLICY_SEE: Allow to see a well-known name */ enum kdbus_policy_type { - KDBUS_POLICY_RECV = 1 << 2, - KDBUS_POLICY_SEND = 1 << 1, - KDBUS_POLICY_OWN = 1 << 0, + KDBUS_POLICY_SEE = 0, + KDBUS_POLICY_TALK, + KDBUS_POLICY_OWN, }; -/** - * struct kdbus_cmd_policy - a series of policies to upload - * @size: The total size of the structure - * @policies: The policies to upload - * - * A KDBUS_POLICY_NAME must always preceeds a KDBUS_POLICY_ACCESS entry. - * A new KDBUS_POLICY_NAME can be added after KDBUS_POLICY_ACCESS for - * chaining multiple policies together. - */ -struct kdbus_cmd_policy { - __u64 size; - struct kdbus_item policies[0]; -} __attribute__((aligned(8))); - /** * enum kdbus_hello_flags - flags for struct kdbus_cmd_hello * @KDBUS_HELLO_ACCEPT_FD: The connection allows the receiving of @@ -480,13 +480,18 @@ struct kdbus_cmd_policy { * @KDBUS_HELLO_ACTIVATOR: Special-purpose connection which registers * a well-know name for a process to be started * when traffic arrives + * @KDBUS_HELLO_POLICY_HOLDER: Special-purpose connection which registers + * policy entries for one or multiple names. The + * provided names are not activated, and are not + * registered with the name database * @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_MONITOR = 1 << 2, + KDBUS_HELLO_POLICY_HOLDER = 1 << 2, + KDBUS_HELLO_MONITOR = 1 << 3, }; /** @@ -529,10 +534,10 @@ enum kdbus_attach_flags { * to do negotiation of features of the payload that is * transferred (kernel → userspace) * @id: The ID of this connection (kernel → userspace) - * @bloom_size: The bloom filter size chosen by the owner - * (kernel → userspace) * @pool_size: Size of the connection's buffer where the received * messages are placed + * @bloom: The bloom properties of the bus, specified + * by the bus creator (kernel → userspace) * @id128: Unique 128-bit ID of the bus (kernel → userspace) * @items: A list of items * @@ -544,27 +549,30 @@ struct kdbus_cmd_hello { __u64 attach_flags; __u64 bus_flags; __u64 id; - __u64 bloom_size; __u64 pool_size; + struct kdbus_bloom_parameter bloom; __u8 id128[16]; struct kdbus_item items[0]; } __attribute__((aligned(8))); -/* Flags for KDBUS_CMD_{BUS,EP,NS}_MAKE */ +/** + * 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 + */ enum kdbus_make_flags { KDBUS_MAKE_ACCESS_GROUP = 1 << 0, KDBUS_MAKE_ACCESS_WORLD = 1 << 1, - KDBUS_MAKE_POLICY_OPEN = 1 << 2, }; /** - * struct kdbus_cmd_make - struct to make a bus, an endpoint or a namespace + * 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/ns to create + * @flags: Properties for the bus/ep/domain to create * @items: Items describing details * * This structure is used with the KDBUS_CMD_BUS_MAKE, KDBUS_CMD_EP_MAKE and - * KDBUS_CMD_NS_MAKE ioctls. + * KDBUS_CMD_DOMAIN_MAKE ioctls. */ struct kdbus_cmd_make { __u64 size; @@ -691,6 +699,18 @@ struct kdbus_conn_info { struct kdbus_item items[0]; }; +/** + * struct kdbus_cmd_conn_update - update flags of a connection + * @size: The total size of the struct + * @items: A list of struct kdbus_item + * + * This struct is used with the KDBUS_CMD_CONN_UPDATE ioctl. + */ +struct kdbus_cmd_conn_update { + __u64 size; + struct kdbus_item items[0]; +} __attribute__((aligned(8))); + /** * struct kdbus_cmd_match - struct to add or remove matches * @size: The total size of the struct @@ -735,8 +755,8 @@ struct kdbus_cmd_memfd_make { * name. The bus is immediately shut down and * cleaned up when the opened "control" device node * is closed. - * @KDBUS_CMD_NS_MAKE: Similar to KDBUS_CMD_BUS_MAKE, but it creates a - * new kdbus namespace. + * @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 * the bus. Such endpoints usually carry a more * restrictive policy and grant restricted access @@ -753,6 +773,9 @@ struct kdbus_cmd_memfd_make { * the kernel. * @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 + * 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 * pool. * @KDBUS_CMD_NAME_ACQUIRE: Request a well-known bus name to associate with @@ -767,6 +790,8 @@ struct kdbus_cmd_memfd_make { * 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 + * update the metadata subscription. * @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. @@ -802,27 +827,27 @@ struct kdbus_cmd_memfd_make { */ enum kdbus_ioctl_type { 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_DOMAIN_MAKE = _IOW (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_SEND = _IOWR(KDBUS_IOC_MAGIC, 0x40, struct kdbus_msg), KDBUS_CMD_MSG_RECV = _IOWR(KDBUS_IOC_MAGIC, 0x41, struct kdbus_cmd_recv), - KDBUS_CMD_FREE = _IOW (KDBUS_IOC_MAGIC, 0x42, __u64 *), + KDBUS_CMD_MSG_CANCEL = _IOW (KDBUS_IOC_MAGIC, 0x42, __u64 *), + KDBUS_CMD_FREE = _IOW (KDBUS_IOC_MAGIC, 0x43, __u64 *), KDBUS_CMD_NAME_ACQUIRE = _IOWR(KDBUS_IOC_MAGIC, 0x50, struct kdbus_cmd_name), KDBUS_CMD_NAME_RELEASE = _IOW (KDBUS_IOC_MAGIC, 0x51, struct kdbus_cmd_name), KDBUS_CMD_NAME_LIST = _IOWR(KDBUS_IOC_MAGIC, 0x52, struct kdbus_cmd_name_list), KDBUS_CMD_CONN_INFO = _IOWR(KDBUS_IOC_MAGIC, 0x60, struct kdbus_cmd_conn_info), + KDBUS_CMD_CONN_UPDATE = _IOW (KDBUS_IOC_MAGIC, 0x61, struct kdbus_cmd_conn_update), KDBUS_CMD_MATCH_ADD = _IOW (KDBUS_IOC_MAGIC, 0x70, struct kdbus_cmd_match), KDBUS_CMD_MATCH_REMOVE = _IOW (KDBUS_IOC_MAGIC, 0x71, struct kdbus_cmd_match), - KDBUS_CMD_EP_POLICY_SET = _IOW (KDBUS_IOC_MAGIC, 0x80, struct kdbus_cmd_policy), - KDBUS_CMD_MEMFD_NEW = _IOWR(KDBUS_IOC_MAGIC, 0xc0, struct kdbus_cmd_memfd_make), KDBUS_CMD_MEMFD_SIZE_GET = _IOR (KDBUS_IOC_MAGIC, 0xc1, __u64 *), KDBUS_CMD_MEMFD_SIZE_SET = _IOW (KDBUS_IOC_MAGIC, 0xc2, __u64 *), @@ -838,20 +863,24 @@ enum kdbus_ioctl_type { * @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 the size of the bloom filter bit field. - * @EEXIST: A requested namespace, bus or endpoint with the same + * 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, or the data @@ -864,6 +893,8 @@ enum kdbus_ioctl_type { * 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 @@ -888,9 +919,14 @@ enum kdbus_ioctl_type { * receiver's pool does not represent a queued message. * @EPERM: The policy prevented an operation. The requested * resource is owned by another entity. - * @ESHUTDOWN: A namespace or endpoint is currently shutting down; + * @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.