}\
#define MSG_ITEM_BUILD_VEC(data, datasize) \
- item->type = KDBUS_MSG_PAYLOAD_VEC; \
+ item->type = KDBUS_ITEM_PAYLOAD_VEC; \
item->size = KDBUS_PART_HEADER_SIZE + sizeof(struct kdbus_vec); \
item->vec.address = (unsigned long) data; \
item->vec.size = datasize;
// determine destination and destination id
if(destination)
{
- dst_id = KDBUS_DST_ID_WELL_KNOWN_NAME;
+ dst_id = KDBUS_DST_ID_NAME;
if((destination[0] == ':') && (destination[1] == '1') && (destination[2] == '.')) /* if name starts with ":1." it is a unique name and should be send as number */
{
dst_id = strtoull(&destination[3], NULL, 10);
goto out;
}
- item->type = KDBUS_MSG_PAYLOAD_MEMFD;
+ item->type = KDBUS_ITEM_PAYLOAD_MEMFD;
item->size = KDBUS_PART_HEADER_SIZE + sizeof(struct kdbus_memfd);
item->memfd.size = ret_size;
item->memfd.fd = transport->memfd;
if(fds_count)
{
item = KDBUS_PART_NEXT(item);
- item->type = KDBUS_MSG_FDS;
+ item->type = KDBUS_ITEM_FDS;
item->size = KDBUS_PART_HEADER_SIZE + (sizeof(int) * fds_count);
memcpy(item->fds, unix_fds, sizeof(int) * fds_count);
}
if (destination)
{
item = KDBUS_PART_NEXT(item);
- item->type = KDBUS_MSG_DST_NAME;
+ item->type = KDBUS_ITEM_DST_NAME;
item->size = KDBUS_PART_HEADER_SIZE + strlen(destination) + 1;
memcpy(item->str, destination, item->size - KDBUS_PART_HEADER_SIZE);
}
else if (dst_id == KDBUS_DST_ID_BROADCAST)
{
item = KDBUS_PART_NEXT(item);
- item->type = KDBUS_MSG_BLOOM;
+ item->type = KDBUS_ITEM_BLOOM;
item->size = KDBUS_PART_HEADER_SIZE + transport->bloom_size;
strncpy(item->data, dbus_message_get_interface(message), transport->bloom_size);
}
}
const char *enum_MSG(long long id);
TABLE(MSG) = {
- ENUM(_KDBUS_MSG_NULL),
- ENUM(KDBUS_MSG_PAYLOAD_VEC),
- ENUM(KDBUS_MSG_PAYLOAD_OFF),
- ENUM(KDBUS_MSG_PAYLOAD_MEMFD),
- ENUM(KDBUS_MSG_FDS),
- ENUM(KDBUS_MSG_BLOOM),
- ENUM(KDBUS_MSG_DST_NAME),
- ENUM(KDBUS_MSG_SRC_CREDS),
- ENUM(KDBUS_MSG_SRC_PID_COMM),
- ENUM(KDBUS_MSG_SRC_TID_COMM),
- ENUM(KDBUS_MSG_SRC_EXE),
- ENUM(KDBUS_MSG_SRC_CMDLINE),
- ENUM(KDBUS_MSG_SRC_CGROUP),
- ENUM(KDBUS_MSG_SRC_CAPS),
- ENUM(KDBUS_MSG_SRC_SECLABEL),
- ENUM(KDBUS_MSG_SRC_AUDIT),
- ENUM(KDBUS_MSG_SRC_NAMES),
- ENUM(KDBUS_MSG_TIMESTAMP),
- ENUM(KDBUS_MSG_NAME_ADD),
- ENUM(KDBUS_MSG_NAME_REMOVE),
- ENUM(KDBUS_MSG_NAME_CHANGE),
- ENUM(KDBUS_MSG_ID_ADD),
- ENUM(KDBUS_MSG_ID_REMOVE),
- ENUM(KDBUS_MSG_REPLY_TIMEOUT),
- ENUM(KDBUS_MSG_REPLY_DEAD),
+ ENUM(_KDBUS_ITEM_NULL),
+ ENUM(KDBUS_ITEM_PAYLOAD_VEC),
+ ENUM(KDBUS_ITEM_PAYLOAD_OFF),
+ ENUM(KDBUS_ITEM_PAYLOAD_MEMFD),
+ ENUM(KDBUS_ITEM_FDS),
+ ENUM(KDBUS_ITEM_BLOOM),
+ ENUM(KDBUS_ITEM_DST_NAME),
+ ENUM(KDBUS_ITEM_CREDS),
+ ENUM(KDBUS_ITEM_PID_COMM),
+ ENUM(KDBUS_ITEM_TID_COMM),
+ ENUM(KDBUS_ITEM_EXE),
+ ENUM(KDBUS_ITEM_CMDLINE),
+ ENUM(KDBUS_ITEM_CGROUP),
+ ENUM(KDBUS_ITEM_CAPS),
+ ENUM(KDBUS_ITEM_SECLABEL),
+ ENUM(KDBUS_ITEM_AUDIT),
+ ENUM(KDBUS_ITEM_NAME),
+ ENUM(KDBUS_ITEM_TIMESTAMP),
+ ENUM(KDBUS_ITEM_NAME_ADD),
+ ENUM(KDBUS_ITEM_NAME_REMOVE),
+ ENUM(KDBUS_ITEM_NAME_CHANGE),
+ ENUM(KDBUS_ITEM_ID_ADD),
+ ENUM(KDBUS_ITEM_ID_REMOVE),
+ ENUM(KDBUS_ITEM_REPLY_TIMEOUT),
+ ENUM(KDBUS_ITEM_REPLY_DEAD),
};
LOOKUP(MSG);
const char *enum_PAYLOAD(long long id);
}
switch (item->type)
{
- case KDBUS_MSG_PAYLOAD_OFF:
+ case KDBUS_ITEM_PAYLOAD_OFF:
ret_size += item->vec.size;
break;
- case KDBUS_MSG_PAYLOAD_MEMFD:
+ case KDBUS_ITEM_PAYLOAD_MEMFD:
ret_size += item->memfd.size;
break;
default:
switch (item->type)
{
- case KDBUS_MSG_PAYLOAD_OFF:
+ case KDBUS_ITEM_PAYLOAD_OFF:
memcpy(data, (char *)kdbus_transport->kdbus_mmap_ptr + item->vec.offset, item->vec.size);
data += item->vec.size;
ret_size += item->vec.size;
(unsigned long long)item->vec.size);
break;
- case KDBUS_MSG_PAYLOAD_MEMFD:
+ case KDBUS_ITEM_PAYLOAD_MEMFD:
{
char *buf;
uint64_t size;
break;
}
- case KDBUS_MSG_FDS:
+ case KDBUS_ITEM_FDS:
{
int i;
}
#if KDBUS_MSG_DECODE_DEBUG == 1
- case KDBUS_MSG_SRC_CREDS:
+ case KDBUS_ITEM_CREDS:
_dbus_verbose(" +%s (%llu bytes) uid=%lld, gid=%lld, pid=%lld, tid=%lld, starttime=%lld\n",
enum_MSG(item->type), item->size,
item->creds.uid, item->creds.gid,
item->creds.starttime);
break;
- case KDBUS_MSG_SRC_PID_COMM:
- case KDBUS_MSG_SRC_TID_COMM:
- case KDBUS_MSG_SRC_EXE:
- case KDBUS_MSG_SRC_CGROUP:
- case KDBUS_MSG_SRC_SECLABEL:
- case KDBUS_MSG_DST_NAME:
+ case KDBUS_ITEM_PID_COMM:
+ case KDBUS_ITEM_TID_COMM:
+ case KDBUS_ITEM_EXE:
+ case KDBUS_ITEM_CGROUP:
+ case KDBUS_ITEM_SECLABEL:
+ case KDBUS_ITEM_DST_NAME:
_dbus_verbose(" +%s (%llu bytes) '%s' (%zu)\n",
enum_MSG(item->type), item->size, item->str, strlen(item->str));
break;
- case KDBUS_MSG_SRC_CMDLINE:
- case KDBUS_MSG_SRC_NAMES: {
+ case KDBUS_ITEM_CMDLINE:
+ case KDBUS_ITEM_NAME: {
__u64 size = item->size - KDBUS_PART_HEADER_SIZE;
const char *str = item->str;
int count = 0;
break;
}
- case KDBUS_MSG_SRC_AUDIT:
+ case KDBUS_ITEM_AUDIT:
_dbus_verbose(" +%s (%llu bytes) loginuid=%llu sessionid=%llu\n",
enum_MSG(item->type), item->size,
(unsigned long long)item->data64[0],
(unsigned long long)item->data64[1]);
break;
- case KDBUS_MSG_SRC_CAPS: {
+ case KDBUS_ITEM_CAPS: {
int n;
const uint32_t *cap;
int i;
break;
}
- case KDBUS_MSG_TIMESTAMP:
+ case KDBUS_ITEM_TIMESTAMP:
_dbus_verbose(" +%s (%llu bytes) realtime=%lluns monotonic=%lluns\n",
enum_MSG(item->type), item->size,
(unsigned long long)item->timestamp.realtime_ns,
break;
#endif
- case KDBUS_MSG_REPLY_TIMEOUT:
+ case KDBUS_ITEM_REPLY_TIMEOUT:
_dbus_verbose(" +%s (%llu bytes) cookie=%llu\n",
enum_MSG(item->type), item->size, msg->cookie_reply);
ret_size = put_message_into_data(message, data);
break;
- case KDBUS_MSG_REPLY_DEAD:
+ case KDBUS_ITEM_REPLY_DEAD:
_dbus_verbose(" +%s (%llu bytes) cookie=%llu\n",
enum_MSG(item->type), item->size, msg->cookie_reply);
ret_size = put_message_into_data(message, data);
break;
- case KDBUS_MSG_NAME_ADD:
+ case KDBUS_ITEM_NAME_ADD:
_dbus_verbose(" +%s (%llu bytes) '%s', old id=%lld, new id=%lld, flags=0x%llx\n",
enum_MSG(item->type), (unsigned long long) item->size,
item->name_change.name, item->name_change.old_id,
ret_size = put_message_into_data(message, data);
break;
- case KDBUS_MSG_NAME_REMOVE:
+ case KDBUS_ITEM_NAME_REMOVE:
_dbus_verbose(" +%s (%llu bytes) '%s', old id=%lld, new id=%lld, flags=0x%llx\n",
enum_MSG(item->type), (unsigned long long) item->size,
item->name_change.name, item->name_change.old_id,
ret_size = put_message_into_data(message, data);
break;
- case KDBUS_MSG_NAME_CHANGE:
+ case KDBUS_ITEM_NAME_CHANGE:
_dbus_verbose(" +%s (%llu bytes) '%s', old id=%lld, new id=%lld, flags=0x%llx\n",
enum_MSG(item->type), (unsigned long long) item->size,
item->name_change.name, item->name_change.old_id,
ret_size = put_message_into_data(message, data);
break;
- case KDBUS_MSG_ID_ADD:
+ case KDBUS_ITEM_ID_ADD:
_dbus_verbose(" +%s (%llu bytes) id=%llu flags=%llu\n",
enum_MSG(item->type), (unsigned long long) item->size,
(unsigned long long) item->id_change.id,
ret_size = put_message_into_data(message, data);
break;
- case KDBUS_MSG_ID_REMOVE:
+ case KDBUS_ITEM_ID_REMOVE:
_dbus_verbose(" +%s (%llu bytes) id=%llu flags=%llu\n",
enum_MSG(item->type), (unsigned long long) item->size,
(unsigned long long) item->id_change.id,
}
again2:
- if (ioctl(kdbus_transport->fd, KDBUS_CMD_MSG_RELEASE, &offset) < 0)
+ if (ioctl(kdbus_transport->fd, KDBUS_CMD_FREE, &offset) < 0)
{
if(errno == EINTR)
goto again2;
* Copyright (C) 2013 Linux Foundation
* Copyright (C) 2013 Lennart Poettering
* Copyright (C) 2013 Daniel Mack <daniel@zonque.org>
- * Copyright (C) 2013 Samsung Electronics
*
* 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
#include <linux/types.h>
#endif
-/* todo #define KDBUS_MSG_MAX_PAYLOAD_VEC_SIZE SZ_8M - maximum size of message header and items
- * taken from internal.h of kdbus
- * finally it should be placed higher - e.g. kdbus.h of kdbus kernel module
- */
-#define KDBUS_MSG_MAX_PAYLOAD_VEC_SIZE 0x00800000 /* maximum size of message header and items */
-
#define KDBUS_IOC_MAGIC 0x95
#define KDBUS_SRC_ID_KERNEL (0)
-#define KDBUS_DST_ID_WELL_KNOWN_NAME (0)
+#define KDBUS_DST_ID_NAME (0)
#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; \
}
-#define KDBUS_PART_HEADER_SIZE offsetof(struct kdbus_item, data)
-
-/* 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_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_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;
};
+/**
+ * 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 {
};
};
+/**
+ * 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;
};
+/**
+ * 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_MSG_NULL,
+ _KDBUS_ITEM_NULL,
/* Filled in by userspace */
- KDBUS_MSG_PAYLOAD_VEC, /* .data_vec, reference to memory area */
- KDBUS_MSG_PAYLOAD_OFF, /* .data_vec, reference to memory area */
- KDBUS_MSG_PAYLOAD_MEMFD, /* file descriptor of a special data file */
- KDBUS_MSG_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_MSG_PRIORITY, /* queue priority for message */
+ _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 = 0x400,/* 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 */
#ifdef KDBUS_FOR_SBB
KDBUS_MSG_SBB_DST_NAME, /* destination name for sbb agent purpose */
#endif
/* Special messages from kernel, consisting of one and only one of these data blocks */
- KDBUS_MSG_NAME_ADD = 0x800,/* .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_REPLY_TIMEOUT, /* empty, but .reply_cookie in .kdbus_msg is filled in */
- KDBUS_MSG_REPLY_DEAD, /* dito */
+ _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_item - chain of data blocks
- *
- * size: overall data record size
- * type: kdbus_item type of data
+ * struct kdbus_item - chain of data blocks
+ * @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;
int fds[0];
- struct kdbus_manager_msg_name_change name_change;
- struct kdbus_manager_msg_id_change id_change;
+ struct kdbus_notify_name_change name_change;
+ struct kdbus_notify_id_change id_change;
};
};
};
/**
- * struct kdbus_msg
- *
- * set by userspace:
- * dst_id: destination id
- * flags: KDBUS_MSG_FLAGS_*
- * items: 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_item items[0];
};
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 */
+ __u64 type; /* USER, GROUP, WORLD */
+ __u64 bits; /* RECV, SEND, OWN */
+ __u64 id; /* uid, gid, 0 */
};
-//FIXME: convert access to access[]
+/**
+ * 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 {
KDBUS_PART_HEADER;
union {
};
};
-/* A series of KDBUS_POLICY_NAME, plus one or more KDBUS_POLICY_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;
struct kdbus_policy policies[0];
enum {
KDBUS_HELLO_STARTER = 1 << 0,
KDBUS_HELLO_ACCEPT_FD = 1 << 1,
+};
- /* The following have an effect on directed messages only --
- * not for broadcasts */
- KDBUS_HELLO_ATTACH_COMM = 1 << 10,
- KDBUS_HELLO_ATTACH_EXE = 1 << 11,
- KDBUS_HELLO_ATTACH_CMDLINE = 1 << 12,
- KDBUS_HELLO_ATTACH_CGROUP = 1 << 13,
- KDBUS_HELLO_ATTACH_CAPS = 1 << 14,
- KDBUS_HELLO_ATTACH_SECLABEL = 1 << 15,
- KDBUS_HELLO_ATTACH_AUDIT = 1 << 16,
+/* Flags for message attachments */
+enum {
+ 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,
#ifdef KDBUS_FOR_SBB
/*Flags for SBB*/
- KDBUS_HELLO_IAMAGENT = 1 << 30,
+ KDBUS_HELLO_IAMAGENT = 1 << 30,
#endif
+
};
+/**
+ * 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 {
__u64 size;
/* 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_HELLO */
+ __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; /* id assigned to this connection */
- __u64 bloom_size; /* The bloom filter size chosen by the
- * bus owner */
- __u64 pool_size; /* maximum size of pool buffer */
+ __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 */
+/* Flags for KDBUS_CMD_{BUS,EP,NS}_MAKE */
enum {
KDBUS_MAKE_ACCESS_GROUP = 1 << 0,
KDBUS_MAKE_ACCESS_WORLD = 1 << 1,
#endif
};
-/* Items to append to kdbus_cmd_{bus,ep,ns}_make */
+/* 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 specifiying the credentials of the
- * client to connect on behalf on. Needs
- * privileges */
+ 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 bloom_size; /* size of the bloom filter for this bus */
+ __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. */
+ __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. */
+ __u64 flags;
struct kdbus_item items[0];
};
KDBUS_NAME_QUEUE = 1 << 1,
KDBUS_NAME_ALLOW_REPLACEMENT = 1 << 2,
- KDBUS_NAME_STARTER = 1 << 7,
-
+ KDBUS_NAME_STARTER = 1 << 7,
/* kernel → userspace */
KDBUS_NAME_IN_QUEUE = 1 << 16,
};
-/* We allow (de)regestration of names of other peers */
+/**
+ * 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 flags;
char name[0];
};
-struct kdbus_cmd_names {
+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,
+};
+
+/**
+ * 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_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;
struct kdbus_cmd_name names[0];
};
-enum {
- _KDBUS_NAME_INFO_ITEM_NULL,
- KDBUS_NAME_INFO_ITEM_NAME, /* userspace → kernel */
- KDBUS_NAME_INFO_ITEM_SECLABEL, /* kernel → userspace */
- KDBUS_NAME_INFO_ITEM_AUDIT, /* kernel → userspace */
+/**
+ * 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;
+ __u64 offset;
+ char name[0];
};
-struct kdbus_cmd_name_info {
- __u64 size; /* overall size of info */
+/**
+ * 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;
- __u64 id; /* either ID, or 0 and _ITEM_NAME follows */
- struct kdbus_creds creds;
- struct kdbus_item items[0]; /* list of item records */
+ struct kdbus_item items[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_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_ID_ADD, /* Matches an ID against KDBUS_MSG_ID_ADD */
- KDBUS_MATCH_ID_REMOVE, /* Matches an ID against KDBUS_MSG_ID_REMOVE */
+ KDBUS_MATCH_BLOOM, /* Matches a mask blob against KDBUS_ITEM_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_ITEM_ID_ADD */
+ KDBUS_MATCH_ID_REMOVE, /* Matches an ID against KDBUS_ITEM_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 */
+ __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 */
- unsigned int enable; /* A boolean to enable/disable monitoring */
- __u32 __pad;
+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.
*/
+struct kdbus_cmd_monitor {
+ __u64 id;
+ __u64 flags;
+};
+
enum {
/* kdbus control node commands: require unset state */
KDBUS_CMD_BUS_MAKE = _IOW(KDBUS_IOC_MAGIC, 0x00, struct kdbus_cmd_bus_make),
/* kdbus ep node commands: require connected state */
KDBUS_CMD_MSG_SEND = _IOW(KDBUS_IOC_MAGIC, 0x40, struct kdbus_msg),
KDBUS_CMD_MSG_RECV = _IOR(KDBUS_IOC_MAGIC, 0x41, __u64 *),
- KDBUS_CMD_MSG_RELEASE = _IOW(KDBUS_IOC_MAGIC, 0x42, __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 = _IOW(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_LIST_QUEUED = _IOWR(KDBUS_IOC_MAGIC, 0x54, struct kdbus_cmd_names),
+ 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 = _IOW(KDBUS_IOC_MAGIC, 0x60, struct kdbus_cmd_match),
- KDBUS_CMD_MATCH_REMOVE = _IOW(KDBUS_IOC_MAGIC, 0x61, struct kdbus_cmd_match),
- KDBUS_CMD_MONITOR = _IOW(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 = _IOW(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, 0x80, int *),
- KDBUS_CMD_MEMFD_SIZE_GET = _IOR(KDBUS_IOC_MAGIC, 0x81, __u64 *),
- KDBUS_CMD_MEMFD_SIZE_SET = _IOW(KDBUS_IOC_MAGIC, 0x82, __u64 *),
- KDBUS_CMD_MEMFD_SEAL_GET = _IOR(KDBUS_IOC_MAGIC, 0x83, int *),
- KDBUS_CMD_MEMFD_SEAL_SET = _IO(KDBUS_IOC_MAGIC, 0x84),
+ 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),
};
#ifdef KDBUS_FOR_SBB
projects / platform / upstream / dbus.git / commitdiff