* Copyright (C) 2013 Kay Sievers
* Copyright (C) 2013 Greg Kroah-Hartman <gregkh@linuxfoundation.org>
* Copyright (C) 2013 Linux Foundation
+ * Copyright (C) 2013 Lennart Poettering
+ * Copyright (C) 2013 Daniel Mack <daniel@zonque.org>
*
* 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
#endif
#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_DST_ID_BROADCAST (~0ULL)
+
+/**
+ * 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_manager_msg_name_change {
+/**
+ * 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_CMD_NAME_IN_QUEUE */
+ __u64 flags;
char name[0];
};
-struct kdbus_manager_msg_id_change {
+/**
+ * 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_CMD_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_audit - audit information
+ * @sessionid The audit session ID
+ * @loginuid The audit login uid
+ */
struct kdbus_audit {
__u64 sessionid;
__u64 loginuid;
};
+/**
+ * struct kdbus_timestamp
+ * @monotonic_ns: Monotonic timestamp, in nanoseconds
+ * @realtime_ns: Realtime timestamp, in nanoseconds
+ */
struct kdbus_timestamp {
__u64 monotonic_ns;
__u64 realtime_ns;
};
-#define KDBUS_SRC_ID_KERNEL (0)
-#define KDBUS_DST_ID_WELL_KNOWN_NAME (0)
-#define KDBUS_MATCH_SRC_ID_ANY (~0ULL)
-#define KDBUS_DST_ID_BROADCAST (~0ULL)
+/**
+ * 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
+ */
+struct kdbus_vec {
+ __u64 size;
+ union {
+ __u64 address;
+ __u64 offset;
+ };
+};
+
+/**
+ * struct kdbus_memfd - a kdbus memfd
+ * @size: The memfd's size
+ * @fd: The file descriptor number
+ * @__pad: Padding to make the struct aligned
+ */
+struct kdbus_memfd {
+ __u64 size;
+ int fd;
+ __u32 __pad;
+};
-/* Message Data Types */
+/**
+ * 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 userspace */
- KDBUS_MSG_NULL, /* empty record */
- KDBUS_MSG_PAYLOAD, /* .data */
- KDBUS_MSG_PAYLOAD_VEC, /* .data_vec */
- KDBUS_MSG_UNIX_FDS, /* .data_fds of file descriptors */
- KDBUS_MSG_BLOOM, /* for broadcasts, carries bloom filter blob in .data */
- KDBUS_MSG_DST_NAME, /* destination's well-known name, in .str */
+ _KDBUS_ITEM_USER_BASE = 1,
+ KDBUS_ITEM_PAYLOAD_VEC = 1, /* .data_vec, reference to memory area */
+ KDBUS_ITEM_PAYLOAD_OFF, /* .data_vec, reference to memory area */
+ KDBUS_ITEM_PAYLOAD_MEMFD, /* file descriptor of a special data file */
+ KDBUS_ITEM_FDS, /* .data_fds of file descriptors */
+ KDBUS_ITEM_BLOOM, /* for broadcasts, carries bloom filter blob in .data */
+ KDBUS_ITEM_DST_NAME, /* destination's well-known name, in .str */
+ KDBUS_ITEM_PRIORITY, /* queue priority for message */
/* Filled in by kernelspace */
- KDBUS_MSG_SRC_NAMES = 0x200,/* NUL separated string list with well-known names of source */
- KDBUS_MSG_TIMESTAMP, /* .timestamp */
- KDBUS_MSG_SRC_CREDS, /* .creds */
- KDBUS_MSG_SRC_PID_COMM, /* optional, in .str */
- KDBUS_MSG_SRC_TID_COMM, /* optional, in .str */
- KDBUS_MSG_SRC_EXE, /* optional, in .str */
- KDBUS_MSG_SRC_CMDLINE, /* optional, in .str (a chain of NUL str) */
- KDBUS_MSG_SRC_CGROUP, /* optional, in .str */
- KDBUS_MSG_SRC_CAPS, /* caps data blob, in .data */
- KDBUS_MSG_SRC_SECLABEL, /* NUL terminated string, in .str */
- KDBUS_MSG_SRC_AUDIT, /* .audit */
+ _KDBUS_ITEM_ATTACH_BASE = 0x400,
+ 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 */
+
+ /* when appended to a message, the following items refer to the sender */
+ KDBUS_ITEM_CREDS, /* .creds */
+ KDBUS_ITEM_PID_COMM, /* optional, in .str */
+ KDBUS_ITEM_TID_COMM, /* optional, in .str */
+ KDBUS_ITEM_EXE, /* optional, in .str */
+ KDBUS_ITEM_CMDLINE, /* optional, in .str (a chain of NUL str) */
+ KDBUS_ITEM_CGROUP, /* optional, in .str */
+ KDBUS_ITEM_CAPS, /* caps data blob, in .data */
+ KDBUS_ITEM_SECLABEL, /* NUL terminated string, in .str */
+ KDBUS_ITEM_AUDIT, /* .audit */
/* Special messages from kernel, consisting of one and only one of these data blocks */
- KDBUS_MSG_NAME_ADD = 0x400,/* .name_change */
- KDBUS_MSG_NAME_REMOVE, /* .name_change */
- KDBUS_MSG_NAME_CHANGE, /* .name_change */
- KDBUS_MSG_ID_ADD, /* .id_change */
- KDBUS_MSG_ID_REMOVE, /* .id_change */
- KDBUS_MSG_ID_CHANGE, /* .id_change */
- KDBUS_MSG_REPLY_TIMEOUT, /* empty, but .reply_cookie in .kdbus_msg is filled in */
- KDBUS_MSG_REPLY_DEAD, /* dito */
-};
-
-struct kdbus_vec {
- __u64 address;
- __u64 size;
+ _KDBUS_ITEM_KERNEL_BASE = 0x800,
+ KDBUS_ITEM_NAME_ADD = 0x800,/* .name_change */
+ 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, but .reply_cookie in .kdbus_msg is filled in */
+ KDBUS_ITEM_REPLY_DEAD, /* dito */
};
/**
- * struct kdbus_msg_data - chain of data blocks
- *
- * size: overall data record size
- * type: kdbus_msg_data_type of data
+ * struct kdbus_item - chain of data blocks
+ * @size : overall data record size
+ * @type: kdbus_item type of data
*/
-struct kdbus_msg_data {
- __u64 size;
- __u64 type;
+struct kdbus_item {
+ KDBUS_PART_HEADER;
union {
/* inline data */
__u8 data[0];
+ __u32 data32[0];
+ __u64 data64[0];
char str[0];
+ /* connection */
+ __u64 id;
+
/* data vector */
struct kdbus_vec vec;
- /* specific fields */
- int fds[0]; /* int array of file descriptors */
+ /* process credentials and properties*/
struct kdbus_creds creds;
struct kdbus_audit audit;
struct kdbus_timestamp timestamp;
- struct kdbus_manager_msg_name_change name_change;
- struct kdbus_manager_msg_id_change id_change;
+ struct kdbus_name name;
+
+ /* specific fields */
+ struct kdbus_memfd memfd;
+ int fds[0];
+ struct kdbus_notify_name_change name_change;
+ struct kdbus_notify_id_change id_change;
};
};
enum {
- KDBUS_MSG_FLAGS_EXPECT_REPLY = 1,
- KDBUS_MSG_FLAGS_NO_AUTO_START = 2, /* possibly? */
+ KDBUS_MSG_FLAGS_EXPECT_REPLY = 1 << 0,
+ KDBUS_MSG_FLAGS_NO_AUTO_START = 1 << 1,
};
enum {
- KDBUS_PAYLOAD_NONE = 0,
+ KDBUS_PAYLOAD_KERNEL,
KDBUS_PAYLOAD_DBUS1 = 0x4442757356657231ULL, /* 'DBusVer1' */
KDBUS_PAYLOAD_GVARIANT = 0x4756617269616e74ULL, /* 'GVariant' */
};
/**
- * struct kdbus_msg
- *
- * set by userspace:
- * dst_id: destination id
- * flags: KDBUS_MSG_FLAGS_*
- * data_size: overall message size
- * data: data records
- *
- * set by kernel:
- * src_id: who sent the message
+ * struct kdbus_msg - the representation of a kdbus message
+ * @size: Total size of the message
+ * @flags: Message flags (KDBUS_MSG_FLAGS_*)
+ * @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
+ * @items: A list of kdbus_items containing the message payload
*/
struct kdbus_msg {
__u64 size;
__u64 flags;
- __u64 dst_id; /* connection, 0 == name in data, ~0 broadcast */
- __u64 src_id; /* connection, 0 == kernel */
- __u64 payload_type; /* 'DBusVer1', 'GVariant', ... */
- __u64 cookie; /* userspace-supplied cookie */
+ __u64 dst_id;
+ __u64 src_id;
+ __u64 payload_type;
+ __u64 cookie;
union {
- __u64 cookie_reply; /* cookie we reply to */
- __u64 timeout_ns; /* timespan to wait for reply */
+ __u64 cookie_reply;
+ __u64 timeout_ns;
};
- struct kdbus_msg_data data[0];
+ struct kdbus_item items[0];
};
enum {
+ _KDBUS_POLICY_NULL,
KDBUS_POLICY_NAME,
KDBUS_POLICY_ACCESS,
};
enum {
- KDBUS_POLICY_USER,
- KDBUS_POLICY_GROUP,
- KDBUS_POLICY_WORLD,
+ _KDBUS_POLICY_ACCESS_NULL,
+ KDBUS_POLICY_ACCESS_USER,
+ KDBUS_POLICY_ACCESS_GROUP,
+ KDBUS_POLICY_ACCESS_WORLD,
};
enum {
- KDBUS_POLICY_RECV = 4,
- KDBUS_POLICY_SEND = 2,
- KDBUS_POLICY_OWN = 1,
+ KDBUS_POLICY_RECV = 1 << 2,
+ KDBUS_POLICY_SEND = 1 << 1,
+ KDBUS_POLICY_OWN = 1 << 0,
+};
+
+/**
+ * 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
+ */
+struct kdbus_policy_access {
+ __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
+ */
struct kdbus_policy {
- __u64 size;
- __u64 type; /* NAME or ACCESS */
+ KDBUS_PART_HEADER;
union {
char name[0];
- struct {
- __u32 type; /* USER, GROUP, WORLD */
- __u32 bits; /* RECV, SEND, OWN */
- __u64 id; /* uid, gid, 0 */
- } access;
+ struct kdbus_policy_access access;
};
};
+/**
+ * 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 preceed 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;
- __u8 buffer[0]; /* a series of KDBUS_POLICY_NAME plus one or
- * more KDBUS_POLICY_ACCESS each. */
+ struct kdbus_policy policies[0];
};
+/* Flags for struct kdbus_cmd_hello */
enum {
- KDBUS_CMD_HELLO_STARTER = 1 << 0,
- KDBUS_CMD_HELLO_ACCEPT_FD = 1 << 1,
- KDBUS_CMD_HELLO_ACCEPT_MMAP = 1 << 2,
-
- /* The following have an effect on directed messages only --
- * not for broadcasts */
- KDBUS_CMD_HELLO_ATTACH_COMM = 1 << 10,
- KDBUS_CMD_HELLO_ATTACH_EXE = 1 << 11,
- KDBUS_CMD_HELLO_ATTACH_CMDLINE = 1 << 12,
- KDBUS_CMD_HELLO_ATTACH_CGROUP = 1 << 13,
- KDBUS_CMD_HELLO_ATTACH_CAPS = 1 << 14,
- KDBUS_CMD_HELLO_ATTACH_SECLABEL = 1 << 15,
- KDBUS_CMD_HELLO_ATTACH_AUDIT = 1 << 16,
-};
-
-/* Flags for kdbus_cmd_bus_make, kdbus_cmd_ep_make and
- * kdbus_cmd_ns_make */
+ KDBUS_HELLO_STARTER = 1 << 0,
+ KDBUS_HELLO_ACCEPT_FD = 1 << 1,
+};
+
+/* Flags for message attachments */
enum {
- KDBUS_ACCESS_GROUP = 1,
- KDBUS_ACCESS_WORLD = 2,
- KDBUS_POLICY_OPEN = 4,
+ KDBUS_ATTACH_TIMESTAMP = 1 << 0,
+ KDBUS_ATTACH_CREDS = 1 << 1,
+ KDBUS_ATTACH_NAMES = 1 << 2,
+ KDBUS_ATTACH_COMM = 1 << 3,
+ KDBUS_ATTACH_EXE = 1 << 4,
+ KDBUS_ATTACH_CMDLINE = 1 << 5,
+ KDBUS_ATTACH_CGROUP = 1 << 6,
+ KDBUS_ATTACH_CAPS = 1 << 7,
+ KDBUS_ATTACH_SECLABEL = 1 << 8,
+ KDBUS_ATTACH_AUDIT = 1 << 9,
};
+/**
+ * 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 metdata 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
+ * 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: Maximum size of the pool buffer (kernel → userspace)
+ * @id128: Unique 128-bit ID of the bus (kernel → userspace)
+ * @items; A list of items
+ *
+ * This struct is used with the KDBUS_CMD_HELLO ioctl. See the ioctl
+ * documentation for more information.
+ */
struct kdbus_cmd_hello {
- /* userspace → kernel, kernel → userspace */
- __u64 conn_flags; /* userspace specifies its
- * capabilities and more, kernel
- * returns its capabilites and
- * more. Kernel might refuse client's
- * capabilities by returning an error
- * from KDBUS_CMD_HELLO */
+ __u64 size;
- /* userspace → kernel */
- __u64 pid; /* To allow translator services which
- * connect to the bus on behalf of
- * somebody else, allow specifiying
- * the PID of the client to connect on
- * behalf on. Normal clients should
- * pass this as 0 (i.e. to do things
- * under their own PID). Priviliged
- * clients can pass != 0, to operate
- * on behalf of somebody else. */
+ /* userspace → kernel, kernel → userspace */
+ __u64 conn_flags;
+ __u64 attach_flags;
/* kernel → userspace */
- __u64 bus_flags; /* this is .flags copied verbatim from
- * from original KDBUS_CMD_BUS_MAKE
- * ioctl. It's intended to be useful
- * to do negotiation of features of
- * the payload that is transfreted. */
- __u64 id; /* peer id */
- __u64 bloom_size; /* The bloom filter size chosen by the
- * bus owner */
+ __u64 bus_flags;
+ __u64 id;
+ __u64 bloom_size;
+ __u64 pool_size;
+ __u8 id128[16];
+
+ struct kdbus_item items[0];
+};
+
+/* Flags for KDBUS_CMD_{BUS,EP,NS}_MAKE */
+enum {
+ KDBUS_MAKE_ACCESS_GROUP = 1 << 0,
+ KDBUS_MAKE_ACCESS_WORLD = 1 << 1,
+ KDBUS_MAKE_POLICY_OPEN = 1 << 2,
+};
+
+/* Items to append to KDBUS_CMD_{BUS,EP,NS}_MAKE */
+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:
+ * @bloom_filter: 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.
+ */
struct kdbus_cmd_bus_make {
__u64 size;
- __u64 flags; /* userspace → kernel, kernel → userspace
- * When creating a bus feature
- * kernel negotiation. */
- __u64 bus_flags; /* userspace → kernel
- * When a bus is created this value is
- * copied verbatim into the bus
- * structure and returned from
- * KDBUS_CMD_HELLO, later */
- __u64 cgroup_id; /* the cgroup hierarchy ID for which
- * to attach cgroup membership paths
- * to messages. 0 if no cgroup data
- * shall be attached. */
- __u64 bloom_size; /* Size of the bloom filter for this bus. */
- char name[0];
+ __u64 flags;
+ __u64 bus_flags;
+ __u64 bloom_size;
+ struct kdbus_item items[0];
};
+/**
+ * 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. Refer to the
+ * documentation for more information.
+ */
struct kdbus_cmd_ep_make {
__u64 size;
- __u64 flags; /* userspace → kernel, kernel → userspace
- * When creating an entry point
- * feature kernel negotiation done the
- * same way as for
- * KDBUS_CMD_BUS_MAKE. Unused for
- * now. */
- char name[0];
+ __u64 flags;
+ struct kdbus_item items[0];
};
+/**
+ * struct kdbus_cmd_ns_make - struct to make a namespace
+ * @size: The total size of the struct
+ * @flags: Unused for now
+ * @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.
+ */
struct kdbus_cmd_ns_make {
__u64 size;
- __u64 flags; /* userspace → kernel, kernel → userspace
- * When creating an entry point
- * feature kernel negotiation done the
- * same way as for
- * KDBUS_CMD_BUS_MAKE. Unused for
- * now. */
- char name[0];
+ __u64 flags;
+ struct kdbus_item items[0];
};
enum {
/* userspace → kernel */
- KDBUS_CMD_NAME_REPLACE_EXISTING = 1,
- KDBUS_CMD_NAME_QUEUE = 2,
- KDBUS_CMD_NAME_ALLOW_REPLACEMENT = 4,
+ KDBUS_NAME_REPLACE_EXISTING = 1 << 0,
+ KDBUS_NAME_QUEUE = 1 << 1,
+ KDBUS_NAME_ALLOW_REPLACEMENT = 1 << 2,
/* kernel → userspace */
- KDBUS_CMD_NAME_IN_QUEUE = 0x200,
+ KDBUS_NAME_IN_QUEUE = 1 << 16,
};
+/**
+ * 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
+ * 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;
- __u64 name_flags;
- __u64 id; /* We allow registration/deregestration of names of other peers */
+ __u64 flags;
+ __u64 id;
__u64 conn_flags;
char name[0];
};
-struct kdbus_cmd_names {
- __u64 size;
- struct kdbus_cmd_name names[0];
+enum {
+ KDBUS_NAME_LIST_UNIQUE = 1 << 0,
+ KDBUS_NAME_LIST_NAMES = 1 << 1,
+ KDBUS_NAME_LIST_STARTERS = 1 << 2,
+ KDBUS_NAME_LIST_QUEUED = 1 << 3,
};
-enum {
- KDBUS_CMD_NAME_INFO_ITEM_NAME,
- KDBUS_CMD_NAME_INFO_ITEM_SECLABEL,
- KDBUS_CMD_NAME_INFO_ITEM_AUDIT,
+/**
+ * struct kdbus_cmd_name_list - request a list of name entries
+ * @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.
+ */
+struct kdbus_cmd_name_list {
+ __u64 flags;
+ __u64 offset;
};
-struct kdbus_cmd_name_info_item {
+/**
+ * struct kdbus_name_list - information returned by KDBUS_CMD_NAME_LIST
+ * @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_name_list {
__u64 size;
- __u64 type;
- __u8 data[0];
+ struct kdbus_cmd_name names[0];
};
-struct kdbus_cmd_name_info {
- __u64 size; /* overall size of info */
+/**
+ * struct kdbus_cmd_conn_info - struct used for KDBUS_CMD_CONN_INFO ioctl
+ * @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
+ * result in a struct kdbus_conn_info.
+ */
+struct kdbus_cmd_conn_info {
+ __u64 size;
__u64 flags;
- __u64 id; /* either ID, or 0 and _ITEM_NAME follows */
- struct kdbus_creds creds;
- struct kdbus_cmd_name_info_item item[0]; /* list of item records */
+ __u64 id;
+ __u64 offset;
+ char name[0];
};
-enum {
- KDBUS_CMD_MATCH_BLOOM, /* Matches a mask blob against KDBUS_MSG_BLOOM */
- KDBUS_CMD_MATCH_SRC_NAME, /* Matches a name string against KDBUS_MSG_SRC_NAMES */
- KDBUS_CMD_MATCH_NAME_ADD, /* Matches a name string against KDBUS_MSG_NAME_ADD */
- KDBUS_CMD_MATCH_NAME_REMOVE, /* Matches a name string against KDBUS_MSG_NAME_REMOVE */
- KDBUS_CMD_MATCH_NAME_CHANGE, /* Matches a name string against KDBUS_MSG_NAME_CHANGE */
- KDBUS_CMD_MATCH_ID_ADD, /* Matches an ID against KDBUS_MSG_ID_ADD */
- KDBUS_CMD_MATCH_ID_REMOVE, /* Matches an ID against KDBUS_MSG_ID_REMOVE */
- KDBUS_CMD_MATCH_ID_CHANGE, /* Matches an ID against KDBUS_MSG_ID_CHANGE */
+/**
+ * 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
+ *
+ * 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;
+ struct kdbus_item items[0];
};
-struct kdbus_cmd_match_item {
- __u64 size;
- __u64 type;
- union {
- __u64 id;
- __u8 data[0];
- char str[0];
- };
+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_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
+ *
+ * This structure is used with the KDBUS_CMD_ADD_MATCH and
+ * KDBUS_CMD_REMOVE_MATCH ioctl. Refer to the documentation for more
+ * information.
+ */
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 */
- struct kdbus_cmd_match_item items[0];
+ __u64 id;
+ __u64 cookie;
+ __u64 src_id;
+ struct kdbus_item items[0];
};
-struct kdbus_cmd_monitor {
- __u64 id; /* We allow setting the monitor flag of other peers */
- int enabled; /* A boolean to enable/disable monitoring */
+enum {
+ KDBUS_MONITOR_ENABLE = 1 << 0,
};
-/* FD states:
- * control nodes: unset
- * bus owner (via KDBUS_CMD_BUS_MAKE)
- * ns owner (via KDBUS_CMD_NS_MAKE)
+/**
+ * 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
*
- * ep nodes: unset
- * connected (via KDBUS_CMD_HELLO)
- * starter (via KDBUS_CMD_HELLO with KDBUS_CMD_HELLO_STARTER)
- * ep owner (via KDBUS_CMD_EP_MAKE)
+ * This structure is used with the KDBUS_CMD_MONITOR ioctl.
+ * Refer to the documentation for more information.
*/
-enum kdbus_cmd {
- /* kdbus control node commands: require unset state */
- KDBUS_CMD_BUS_MAKE = _IOWR(KDBUS_IOC_MAGIC, 0x00, struct kdbus_cmd_bus_make),
- KDBUS_CMD_NS_MAKE = _IOWR(KDBUS_IOC_MAGIC, 0x10, struct kdbus_cmd_ns_make),
+struct kdbus_cmd_monitor {
+ __u64 id;
+ __u64 flags;
+};
- /* kdbus control node commands: require bus owner state */
- KDBUS_CMD_BUS_POLICY_SET = _IOWR(KDBUS_IOC_MAGIC, 0x20, struct kdbus_cmd_policy),
+enum {
+ /* kdbus control node commands: require unset state */
+ 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 ep node commands: require unset state */
- KDBUS_CMD_EP_MAKE = _IOWR(KDBUS_IOC_MAGIC, 0x30, struct kdbus_cmd_ep_make),
- KDBUS_CMD_HELLO = _IOWR(KDBUS_IOC_MAGIC, 0x31, struct kdbus_cmd_hello),
+ KDBUS_CMD_EP_MAKE = _IOW(KDBUS_IOC_MAGIC, 0x20, struct kdbus_cmd_ep_make),
+ KDBUS_CMD_HELLO = _IOWR(KDBUS_IOC_MAGIC, 0x30, struct kdbus_cmd_hello),
/* kdbus ep node commands: require connected state */
- KDBUS_CMD_MSG_SEND = _IOWR(KDBUS_IOC_MAGIC, 0x40, struct kdbus_msg),
- KDBUS_CMD_MSG_RECV = _IOWR(KDBUS_IOC_MAGIC, 0x41, struct kdbus_msg),
+ KDBUS_CMD_MSG_SEND = _IOW(KDBUS_IOC_MAGIC, 0x40, struct kdbus_msg),
+ KDBUS_CMD_MSG_RECV = _IOR(KDBUS_IOC_MAGIC, 0x41, __u64 *),
+ KDBUS_CMD_FREE = _IOW(KDBUS_IOC_MAGIC, 0x42, __u64 *),
KDBUS_CMD_NAME_ACQUIRE = _IOWR(KDBUS_IOC_MAGIC, 0x50, struct kdbus_cmd_name),
- KDBUS_CMD_NAME_RELEASE = _IOWR(KDBUS_IOC_MAGIC, 0x51, struct kdbus_cmd_name),
- KDBUS_CMD_NAME_LIST = _IOWR(KDBUS_IOC_MAGIC, 0x52, struct kdbus_cmd_names),
- KDBUS_CMD_NAME_QUERY = _IOWR(KDBUS_IOC_MAGIC, 0x53, struct kdbus_cmd_name_info),
+ 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_MATCH_ADD = _IOWR(KDBUS_IOC_MAGIC, 0x60, struct kdbus_cmd_match),
- KDBUS_CMD_MATCH_REMOVE = _IOWR(KDBUS_IOC_MAGIC, 0x61, struct kdbus_cmd_match),
- KDBUS_CMD_MONITOR = _IOWR(KDBUS_IOC_MAGIC, 0x62, struct kdbus_cmd_monitor),
+ 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_MONITOR = _IOW(KDBUS_IOC_MAGIC, 0x72, struct kdbus_cmd_monitor),
/* kdbus ep node commands: require ep owner state */
- KDBUS_CMD_EP_POLICY_SET = _IOWR(KDBUS_IOC_MAGIC, 0x70, struct kdbus_cmd_policy),
+ KDBUS_CMD_EP_POLICY_SET = _IOW(KDBUS_IOC_MAGIC, 0x80, struct kdbus_cmd_policy),
+
+ /* kdbus memfd commands: */
+ KDBUS_CMD_MEMFD_NEW = _IOR(KDBUS_IOC_MAGIC, 0x90, int *),
+ KDBUS_CMD_MEMFD_SIZE_GET = _IOR(KDBUS_IOC_MAGIC, 0x91, __u64 *),
+ KDBUS_CMD_MEMFD_SIZE_SET = _IOW(KDBUS_IOC_MAGIC, 0x92, __u64 *),
+ KDBUS_CMD_MEMFD_SEAL_GET = _IOR(KDBUS_IOC_MAGIC, 0x93, int *),
+ KDBUS_CMD_MEMFD_SEAL_SET = _IO(KDBUS_IOC_MAGIC, 0x94),
};
#endif