* struct kdbus_notify_name_change - name registry change message
* @old_id: Former owner of a name
* @new_id: New owner of a name
- * @flags: flags from KDBUS_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
*
- * Sent from kernel to userspace when the owner or starter of
+ * Sent from kernel to userspace when the owner or activator of
* a well-known name changes.
*
* Attached to:
struct kdbus_notify_name_change {
__u64 old_id;
__u64 new_id;
- __u64 flags;
+ __u64 old_flags;
+ __u64 new_flags;
char name[0];
};
* @id: New or former owner of the name
* @flags: flags field from KDBUS_HELLO_*
*
- * Sent from kernel to userspace when the owner or starter of
+ * Sent from kernel to userspace when the owner or activator of
* a well-known name changes.
*
* Attached to:
};
};
-/* item types to chain data in lists of items */
+/**
+ * enum kdbus_item_type - item types to chain data in a list
+ * @KDBUS_ITEM_PAYLOAD_VEC: Vector to data
+ * @KDBUS_ITEM_PAYLOAD_OFF: Data at returned offset in the pool
+ * @KDBUS_ITEM_PAYLOAD_MEMFD: Data as sealed memfd
+ * @KDBUS_ITEM_FDS: Attached file descriptors
+ * @KDBUS_ITEM_BLOOM: For broadcasts, carries bloom filter
+ * @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_NAME: Policy in struct kdbus_policy
+ * @KDBUS_ITEM_POLICY_ACCESS: Policy in struct kdbus_policy
+ * @KDBUS_ITEM_NAME: Well-know name with flags
+ * @KDBUS_ITEM_ACTIVATOR_NAME: Well-known name for the activator
+ * @KDBUS_ITEM_TIMESTAMP: Timestamp
+ * @KDBUS_ITEM_CREDS: Process credential
+ * @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_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
+ */
enum kdbus_item_type {
_KDBUS_ITEM_NULL,
_KDBUS_ITEM_USER_BASE,
- KDBUS_ITEM_PAYLOAD_VEC = _KDBUS_ITEM_USER_BASE, /* .data_vec */
- KDBUS_ITEM_PAYLOAD_OFF, /* data at returned offset in the pool */
- KDBUS_ITEM_PAYLOAD_MEMFD, /* data as sealed memfd */
- KDBUS_ITEM_FDS, /* attached file descriptors */
- KDBUS_ITEM_BLOOM, /* for broadcasts, carries bloom filter */
- KDBUS_ITEM_DST_NAME, /* destination's well-known name */
- KDBUS_ITEM_PRIORITY, /* queue priority for message */
+ KDBUS_ITEM_PAYLOAD_VEC = _KDBUS_ITEM_USER_BASE,
+ KDBUS_ITEM_PAYLOAD_OFF,
+ KDBUS_ITEM_PAYLOAD_MEMFD,
+ KDBUS_ITEM_FDS,
+ KDBUS_ITEM_BLOOM,
+ KDBUS_ITEM_DST_NAME,
+ KDBUS_ITEM_PRIORITY,
KDBUS_ITEM_MAKE_NAME,
_KDBUS_ITEM_POLICY_BASE = 0x400,
_KDBUS_ITEM_ATTACH_BASE = 0x600,
KDBUS_ITEM_NAME = _KDBUS_ITEM_ATTACH_BASE,
- KDBUS_ITEM_STARTER_NAME,
+ KDBUS_ITEM_ACTIVATOR_NAME,
KDBUS_ITEM_TIMESTAMP,
KDBUS_ITEM_CREDS,
KDBUS_ITEM_PID_COMM,
KDBUS_ITEM_SECLABEL,
KDBUS_ITEM_AUDIT,
- /* Special messages from kernel */
_KDBUS_ITEM_KERNEL_BASE = 0x800,
KDBUS_ITEM_NAME_ADD = _KDBUS_ITEM_KERNEL_BASE,
- KDBUS_ITEM_NAME_REMOVE, /* .name_change */
- KDBUS_ITEM_NAME_CHANGE, /* .name_change */
- KDBUS_ITEM_ID_ADD, /* .id_change */
- KDBUS_ITEM_ID_REMOVE, /* .id_change */
- KDBUS_ITEM_REPLY_TIMEOUT, /* empty, reply_cookie is filled in */
- KDBUS_ITEM_REPLY_DEAD, /* dito */
+ KDBUS_ITEM_NAME_REMOVE,
+ KDBUS_ITEM_NAME_CHANGE,
+ KDBUS_ITEM_ID_ADD,
+ KDBUS_ITEM_ID_REMOVE,
+ KDBUS_ITEM_REPLY_TIMEOUT,
+ KDBUS_ITEM_REPLY_DEAD,
};
/**
/**
* enum kdbus_payload_type - type of payload carried by message
* @KDBUS_PAYLOAD_KERNEL: Kernel-generated simple message
- * @KDBUS_PAYLOAD_DBUS1: Legacy D-Bus version 1 marshalling
- * @KDBUS_PAYLOAD_GVARIANT: GVariant marshalling
+ * @KDBUS_PAYLOAD_DBUS: D-Bus marshalling
*/
enum kdbus_payload_type {
KDBUS_PAYLOAD_KERNEL,
- KDBUS_PAYLOAD_DBUS1 = 0x4442757356657231ULL, /* 'DBusVer1' */
- KDBUS_PAYLOAD_GVARIANT = 0x4756617269616e74ULL, /* 'GVariant' */
+ KDBUS_PAYLOAD_DBUS = 0x4442757344427573ULL, /* 'DBusDBus' */
};
/**
* @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
+ * 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.
* @items: A list of kdbus_items containing the message payload
*/
struct kdbus_msg {
/**
* enum kdbus_policy_access_type - permissions of a policy record
* @KDBUS_POLICY_ACCESS_USER: Grant access to a uid
- * @KDBUS_POLICY_ACCESS_GROUP: Grant acces to gid
+ * @KDBUS_POLICY_ACCESS_GROUP: Grant access to gid
* @KDBUS_POLICY_ACCESS_WORLD: World-accessible
*/
enum kdbus_policy_access_type {
* @size: The total size of the structure
* @policies: The policies to upload
*
- * A KDBUS_POLICY_NAME must always preceed a KDBUS_POLICY_ACCESS entry.
+ * 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.
*/
/**
* enum kdbus_hello_flags - flags for struct kdbus_cmd_hello
- * @KDBUS_HELLO_STARTER: The connection registers a name for activation
+ * @KDBUS_HELLO_ACTIVATOR: The connection registers a name for activation
* by well-know name
* @KDBUS_HELLO_ACCEPT_FD: The connection allows the receiving of
* any passed file descriptors
*/
enum kdbus_hello_flags {
- KDBUS_HELLO_STARTER = 1 << 0,
+ KDBUS_HELLO_ACTIVATOR = 1 << 0,
KDBUS_HELLO_ACCEPT_FD = 1 << 1,
};
* @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 metdata to attach to each message sent
+ * @attach_flags: Mask of metadata to attach to each message sent
* (KDBUS_ATTACH_*)
* @bus_flags: The flags field copied verbatim from the original
* KDBUS_CMD_BUS_MAKE ioctl. It's intended to be useful
*/
struct kdbus_cmd_hello {
__u64 size;
-
- /* userspace → kernel, kernel → userspace */
__u64 conn_flags;
__u64 attach_flags;
-
- /* kernel → userspace */
__u64 bus_flags;
__u64 id;
__u64 bloom_size;
__u64 pool_size;
__u8 id128[16];
-
struct kdbus_item items[0];
};
* @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. Refer to the
- * documentation for more information.
+ * This structure is used with the KDBUS_CMD_BUS_MAKE ioctl.
*/
struct kdbus_cmd_bus_make {
__u64 size;
* @items: Items describing details such as the
* name of the endpoint
*
- * This structure is used with the KDBUS_CMD_EP_MAKE ioctl. Refer to the
- * documentation for more information.
+ * This structure is used with the KDBUS_CMD_EP_MAKE ioctl.
*/
struct kdbus_cmd_ep_make {
__u64 size;
* @items: Items describing details such as the
* name of the namespace
*
- * This structure is used with the KDBUS_CMD_NS_MAKE ioctl. Refer to the
- * documentation for more information.
+ * This structure is used with the KDBUS_CMD_NS_MAKE ioctl.
*/
struct kdbus_cmd_ns_make {
__u64 size;
struct kdbus_item items[0];
};
+/**
+ * enum kdbus_name_flags - properties of a well-known name
+ * @KDBUS_NAME_REPLACE_EXISTING: Try to replace name of other connections
+ * @KDBUS_NAME_ALLOW_REPLACEMENT: Allow the replacement of the name
+ * @KDBUS_NAME_QUEUE: Name should be queued if busy
+ * @KDBUS_NAME_IN_QUEUE: Name is queued
+ * @KDBUS_NAME_ACTIVATOR: Name is owned by a activator connection
+ */
enum kdbus_name_flags {
- /* userspace → kernel */
KDBUS_NAME_REPLACE_EXISTING = 1 << 0,
- KDBUS_NAME_QUEUE = 1 << 1,
- KDBUS_NAME_ALLOW_REPLACEMENT = 1 << 2,
-
- /* kernel → userspace */
- KDBUS_NAME_IN_QUEUE = 1 << 16,
+ 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: Priviledged users may use this field to (de)register
+ * @id: Privileged users may use this field to (de)register
* names on behalf of other peers.
* @conn_flags: The flags of the owning connection (KDBUS_HELLO_*)
* @name: The well-known name
*
* This structure is used with the KDBUS_CMD_NAME_ACQUIRE ioctl.
- * Refer to the documentation for more information.
*/
struct kdbus_cmd_name {
__u64 size;
char name[0];
};
+/**
+ * enum kdbus_name_list_flags - what to include into the returned list
+ * @KDBUS_NAME_LIST_UNIQUE: All active connections
+ * @KDBUS_NAME_LIST_NAMES: All known well-known names
+ * @KDBUS_NAME_LIST_ACTIVATORS: All activator connections
+ * @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_STARTERS = 1 << 2,
+ KDBUS_NAME_LIST_ACTIVATORS = 1 << 2,
KDBUS_NAME_LIST_QUEUED = 1 << 3,
};
* @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_name_info struct result is stored. The user must
+ * kdbus_conn_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: A list of items for additional information
*
* This structure is used with the KDBUS_CMD_ADD_MATCH and
- * KDBUS_CMD_REMOVE_MATCH ioctl. Refer to the documentation for more
- * information.
+ * KDBUS_CMD_REMOVE_MATCH ioctl.
*/
struct kdbus_cmd_match {
__u64 size;
struct kdbus_item items[0];
};
+/**
+ * enum kdbus_monitor_flags - flags for monitoring
+ * @KDBUS_MONITOR_ENABLE: Enable monitoring
+ */
enum kdbus_monitor_flags {
KDBUS_MONITOR_ENABLE = 1 << 0,
};
/**
* struct kdbus_cmd_monitor - struct to enable or disable eavesdropping
- * @id: Priviledged users may enable or disable the monitor feature
+ * @id: Privileged users may enable or disable the monitor feature
* on behalf of other peers
* @flags: Use KDBUS_MONITOR_ENABLE to enable eavesdropping
*
* This structure is used with the KDBUS_CMD_MONITOR ioctl.
- * Refer to the documentation for more information.
*/
struct kdbus_cmd_monitor {
__u64 id;
* @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
- * neccessarily represent the connected process or
+ * necessarily represent the connected process or
* the actual state of the process.
* @KDBUS_CMD_MATCH_ADD: Install a match which broadcast messages should
* be delivered to the connection.
/*
* 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.
* @EBADFD: A bus connection is in a corrupted state.
* @EBADMSG: Passed data contains a combination of conflicting or
* inconsistent types.
- * @EBUSY: A well-known bus name is already taken by another
- * connection.
+ * @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.
* @ENOSYS: The requested functionality is not available.
* @ENOTCONN: The addressed peer is not an active connection.
* @ENOTSUPP: The feature negotiation failed, a not supported feature
- * was requested.
+ * was requested, or an unknown item type was received.
* @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
* @ENXIO: A unique address does not exist.
* @EPERM: The policy prevented an operation. The requested
* resource is owned by another entity.
- * @ESHUTDOWN: The connection is currently shutting down, no further
- * operations are possible.
+ * @ESHUTDOWN: A namespace or endpoint is currently shutting down;
+ * no further operations will be possible.
* @ESRCH: A requested well-known bus name is not found.
* @ETXTBSY: A kdbus memfd file cannot be sealed or the seal removed,
* because it is shared with other processes or still
~ianmdlvl / elogind.git / blobdiff