#define KDBUS_MATCH_SRC_ID_ANY (~0ULL)
#define KDBUS_DST_ID_BROADCAST (~0ULL)
-/* Common first elements in a structure which are used to iterate over
- * a list of elements. */
+/**
+ * struct KDBUS_PART_HEADER - anonymous struct used as header
+ * @size: Size of element, excluding padding bytes
+ * @type Type of element
+ *
+ * Common first elements in a structure, used to specify the type
+ * and size of the data.
+ * */
#define KDBUS_PART_HEADER \
struct { \
__u64 size; \
__u64 type; \
}
-/* Message sent from kernel to userspace, when the owner or starter of
- * a well-known name changes */
+/**
+ * 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_*
+ * @name Well-known name
+ *
+ * Data attached to:
+ * KDBUS_ITEM_NAME_ADD
+ * KDBUS_ITEM_NAME_REMOVE
+ * KDBUS_ITEM_NAME_CHANGE
+ *
+ * Sent from kernel to userspace when the owner or starter of
+ * a well-known name changes.
+ */
struct kdbus_notify_name_change {
__u64 old_id;
__u64 new_id;
- __u64 flags; /* 0 or (possibly?) KDBUS_NAME_IN_QUEUE */
+ __u64 flags;
char name[0];
};
+/**
+ * struct kdbus_notify_id_change - name registry change message
+ * @id New or former owner of the name
+ * @flags flags field from KDBUS_HELLO_*
+ *
+ * Data attached to:
+ * KDBUS_ITEM_ID_ADD
+ * KDBUS_ITEM_ID_REMOVE
+ *
+ * Sent from kernel to userspace when the owner or starter of
+ * a well-known name changes.
+ */
struct kdbus_notify_id_change {
__u64 id;
- __u64 flags; /* The kernel flags field from KDBUS_HELLO */
+ __u64 flags;
};
+/**
+ * struct kdbus_creds - process credentials
+ * @uid User ID
+ * @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.
+ */
struct kdbus_creds {
__u64 uid;
__u64 gid;
__u64 pid;
__u64 tid;
-
- /* 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
- ovretun. */
__u64 starttime;
};
/**
* 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
+ * @size: The size of the vector
+ * @address Memory address for memory addresses
+ * @offset Offset in the in-message payload memory
*/
struct kdbus_vec {
__u64 size;
/**
* struct kdbus_memfd - a kdbus memfd
- * @size: The memfd's size
- * @fd: The file descriptor number
- * @__pad: Padding to make the struct aligned
+ * @size: The memfd's size
+ * @fd: The file descriptor number
+ * @__pad: Padding to make the struct aligned
*/
struct kdbus_memfd {
__u64 size;
__u32 __pad;
};
+/**
+ * struct kdbus_name - a registered well-known name with its flags
+ * @flags flags from KDBUS_NAME_*
+ * @name well-known name
+ */
+struct kdbus_name {
+ __u64 flags;
+ char name[0];
+};
+
/* Message Item Types */
enum {
_KDBUS_ITEM_NULL,
/* Filled in by kernelspace */
_KDBUS_ITEM_ATTACH_BASE = 0x400,
- KDBUS_ITEM_NAMES = 0x400,/* NUL separated string list with well-known names of source */
+ KDBUS_ITEM_NAME = 0x400,/* NUL separated string list with well-known names of source */
KDBUS_ITEM_STARTER_NAME, /* Only used in HELLO for starter connection */
KDBUS_ITEM_TIMESTAMP, /* .timestamp */
/**
* struct kdbus_item - chain of data blocks
- * @size: overall data record size
- * @type: kdbus_item type of data
+ * @size : overall data record size
+ * @type: kdbus_item type of data
*/
struct kdbus_item {
KDBUS_PART_HEADER;
struct kdbus_creds creds;
struct kdbus_audit audit;
struct kdbus_timestamp timestamp;
+ struct kdbus_name name;
/* specific fields */
struct kdbus_memfd memfd;
/**
* struct kdbus_policy_access - policy access item
- * @type: One of KDBUS_POLICY_ACCESS_* types
- * @bits: Access to grant. One of KDBUS_POLICY_*
- * @id: For KDBUS_POLICY_ACCESS_USER, the uid
- * For KDBUS_POLICY_ACCESS_GROUP, the gid
+ * @type: One of KDBUS_POLICY_ACCESS_* types
+ * @bits: Access to grant. One of KDBUS_POLICY_*
+ * @id: For KDBUS_POLICY_ACCESS_USER, the uid
+ * For KDBUS_POLICY_ACCESS_GROUP, the gid
*/
struct kdbus_policy_access {
- __u64 type; /* USER, GROUP, WORLD */
- __u64 bits; /* RECV, SEND, OWN */
- __u64 id; /* uid, gid, 0 */
+ __u64 type; /* USER, GROUP, WORLD */
+ __u64 bits; /* RECV, SEND, OWN */
+ __u64 id; /* uid, gid, 0 */
};
/**
* struct kdbus_policy - a policy to upload
- * @size: The total size of the structure
- * @type: KDBUS_POLICY_NAME or KDBUS_POLICY_ACCESS
- * @name: The well-known name to grant access to,
- * if @type is KDBUS_POLICY_NAME
- * @access: The policy access details,
- * if @type is KDBUS_POLICY_ACCESS
+ * @size: The total size of the structure
+ * @type: KDBUS_POLICY_NAME or KDBUS_POLICY_ACCESS
+ * @name: The well-known name to grant access to,
+ * if @type is KDBUS_POLICY_NAME
+ * @access: The policy access details,
+ * if @type is KDBUS_POLICY_ACCESS
*/
struct kdbus_policy {
KDBUS_PART_HEADER;
/**
* struct kdbus_cmd_policy - a series of policies to upload
- * @size: The total size of the structure
- * @policies: The policies to upload
+ * @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 new KDBUS_POLICY_NAME can be added after KDBUS_POLICY_ACCESS for
* KDBUS_CMD_BUS_MAKE ioctl. It's intended to be useful
* to do negotiation of features of the payload that is
* transferred (kernel → userspace)
- * @id: The id of this connection (kernel → userspace)
+ * @id: The ID of this connection (kernel → userspace)
* @bloom_size: The bloom filter size chosen by the owner
* (kernel → userspace)
* @pool_size: Maximum size of the pool buffer (kernel → userspace)
enum {
_KDBUS_MAKE_NULL,
KDBUS_MAKE_NAME,
- KDBUS_MAKE_CRED, /* allow translator services which connect
- * to the bus on behalf of somebody else,
- * allow specifying the credentials of the
- * client to connect on behalf on. Needs
- * privileges */
};
/**
* struct kdbus_cmd_bus_make - struct to make a bus
* @size: The total size of the struct
- * @flags: FIXME
- * @bus_flags:
+ * @flags: Properties for the bus to create
* @bloom_filter: Size of the bloom filter for this bus
* @items: Items describing details such as the name of the bus
*
struct kdbus_cmd_bus_make {
__u64 size;
__u64 flags;
- __u64 bus_flags;
__u64 bloom_size;
struct kdbus_item items[0];
};
* @flags: Flags for a name entry (KDBUS_NAME_*)
* @id: Priviledged users may use this field to (de)register
* names on behalf of other peers.
- * @conn_flags: The flags of the owning connection
+ * @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.
char name[0];
};
-/* KDBUS_CMD_NAME_LIST */
enum {
KDBUS_NAME_LIST_UNIQUE = 1 << 0,
KDBUS_NAME_LIST_NAMES = 1 << 1,
/**
* struct kdbus_cmd_name_list - request a list of name entries
- * @size Total size of the struct
- * @flags: Flags for the query (KDBUS_NAME_LIST_*)
- * @offset: The returned offset in the caller's pool buffer.
- * The user must use KDBUS_CMD_FREE to free the
- * allocated memory.
- * @name If KDBUS_NAME_LIST_QUEUED_OWNERS is set in @flags,
- * a name must be provided.
+ * @flags: Flags for the query (KDBUS_NAME_LIST_*)
+ * @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.
- * Refer to the documentation for more information.
*/
struct kdbus_cmd_name_list {
- __u64 size;
__u64 flags;
__u64 offset;
- char name[0];
};
/**
* struct kdbus_name_list - information returned by KDBUS_CMD_NAME_LIST
- * @size: The total size of the structure
- * @names: A list of names
+ * @size: The total size of the structure
+ * @names: A list of names
*
* Note that the user is responsible for freeing the allocated memory with
* the KDBUS_CMD_FREE ioctl.
struct kdbus_cmd_name names[0];
};
-/* KDBUS_CMD_CONN_INFO */
-
/**
* struct kdbus_cmd_conn_info - struct used for KDBUS_CMD_CONN_INFO ioctl
- * @size: The total size of the struct
- * @flags: Query flags, currently unused
- * @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_name_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 @if is zero.
+ * @size: The total size of the struct
+ * @flags: KDBUS_ATTACH_* flags
+ * @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_name_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.
*
* 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
*/
struct kdbus_cmd_conn_info {
__u64 size;
- __u64 flags; /* query flags */
- __u64 id; /* either ID, or 0 and name follows */
- __u64 offset; /* returned offset in the caller's buffer */
+ __u64 flags;
+ __u64 id;
+ __u64 offset;
char name[0];
};
/**
* struct kdbus_conn_info - information returned by KDBUS_CMD_CONN_INFO
- * @size: The total size of the struct
- * @id: The connection's 64-bit ID
- * @flags: The connection's flags
- * @items: A list of struct kdbus_item
+ * @size: The total size of the struct
+ * @id: The connection's 64-bit ID
+ * @flags: The connection's 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 {
__u64 size;
__u64 id;
- __u64 flags; /* connection flags */
- struct kdbus_item items[0]; /* list of item records */
+ __u64 flags;
+ struct kdbus_item items[0];
};
-/* KDBUS_CMD_MATCH_ADD/REMOVE */
enum {
_KDBUS_MATCH_NULL,
KDBUS_MATCH_BLOOM, /* Matches a mask blob against KDBUS_MSG_BLOOM */
- KDBUS_MATCH_SRC_NAME, /* Matches a name string against KDBUS_MSG_SRC_NAMES */
- KDBUS_MATCH_NAME_ADD, /* Matches a name string against KDBUS_MSG_NAME_ADD */
- KDBUS_MATCH_NAME_REMOVE, /* Matches a name string against KDBUS_MSG_NAME_REMOVE */
- KDBUS_MATCH_NAME_CHANGE, /* Matches a name string against KDBUS_MSG_NAME_CHANGE */
+ KDBUS_MATCH_SRC_NAME, /* Matches a name string against KDBUS_ITEM_NAME */
+ KDBUS_MATCH_NAME_ADD, /* Matches a name string against KDBUS_ITEM_NAME_ADD */
+ KDBUS_MATCH_NAME_REMOVE, /* Matches a name string against KDBUS_ITEM_NAME_REMOVE */
+ KDBUS_MATCH_NAME_CHANGE, /* Matches a name string against KDBUS_ITEM_NAME_CHANGE */
KDBUS_MATCH_ID_ADD, /* Matches an ID against KDBUS_MSG_ID_ADD */
KDBUS_MATCH_ID_REMOVE, /* Matches an ID against KDBUS_MSG_ID_REMOVE */
};
/**
* struct kdbus_cmd_match - struct to add or remove matches
- * @size: The total size of the struct
- * @id: Priviledged users may (de)register matches on behalf
- * of other peers.
- * In other cases, set to 0.
- * @cookie: Userspace supplied cookie. When removing, the cookie is
- * suffices as information
- * @src_id: The source ID to match against. Use KDBUS_MATCH_SRC_ID_ANY or
- * any other value for a unique match.
- * @items: A list of items for additional information
+ * @size: The total size of the struct
+ * @id: Priviledged users may (de)register matches on behalf
+ * of other peers.
+ * In other cases, set to 0.
+ * @cookie: Userspace supplied cookie. When removing, the cookie is
+ * suffices as information
+ * @src_id: The source ID to match against. Use KDBUS_MATCH_SRC_ID_ANY or
+ * any other value for a unique match.
+ * @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
*/
struct kdbus_cmd_match {
__u64 size;
- __u64 id; /* We allow registration/deregestration of matches for other peers */
- __u64 cookie; /* userspace supplied cookie; when removing; kernel deletes everything with same cookie */
- __u64 src_id; /* ~0: any. other: exact unique match */
+ __u64 id;
+ __u64 cookie;
+ __u64 src_id;
struct kdbus_item items[0];
};
-/* KDBUS_CMD_MONITOR */
enum {
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
- * on behalf of other peers
- * @flags: Use KDBUS_MONITOR_ENABLE to enable eavesdropping
+ * @id: Priviledged 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.
~ianmdlvl / elogind.git / blobdiff