X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=src%2Flibsystemd-bus%2Fkdbus.h;h=838a087853fe9f15638f60520753eb31302d47dc;hp=20b804539b592d4175bc542ea579569a81932576;hb=537220d9102a12aa4a65d5479130ac2cdb323fff;hpb=c8150fa751ac4490583d1b2c8688a73edb7cd76c diff --git a/src/libsystemd-bus/kdbus.h b/src/libsystemd-bus/kdbus.h index 20b804539..838a08785 100644 --- a/src/libsystemd-bus/kdbus.h +++ b/src/libsystemd-bus/kdbus.h @@ -21,17 +21,29 @@ #endif #define KDBUS_IOC_MAGIC 0x95 +#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) + +/* Common first elements in a structure which are used to iterate over + * a list of elements. */ +#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 { __u64 old_id; __u64 new_id; __u64 flags; /* 0 or (possibly?) KDBUS_NAME_IN_QUEUE */ char name[0]; }; -struct kdbus_manager_msg_id_change { +struct kdbus_notify_id_change { __u64 id; __u64 flags; /* The kernel flags field from KDBUS_HELLO */ }; @@ -60,54 +72,60 @@ struct kdbus_timestamp { __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 { + __u64 size; + union { + __u64 address; + __u64 offset; + }; +}; + +struct kdbus_memfd { + __u64 size; + int fd; + __u32 __pad; +}; /* 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_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_NAMES = 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 = 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 */ -}; - -struct kdbus_vec { - __u64 address; - __u64 size; -}; - -struct kdbus_memfd { - __u64 size; - int fd; + _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 */ }; /** @@ -117,8 +135,7 @@ struct kdbus_memfd { * type: kdbus_item type of data */ struct kdbus_item { - __u64 size; - __u64 type; + KDBUS_PART_HEADER; union { /* inline data */ __u8 data[0]; @@ -140,8 +157,8 @@ struct kdbus_item { /* 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; }; }; @@ -151,22 +168,11 @@ enum { }; enum { - KDBUS_PAYLOAD_NULL, + 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_* - * items: data records - * - * set by kernel: - * src_id: who sent the message - */ struct kdbus_msg { __u64 size; __u64 flags; @@ -182,13 +188,13 @@ struct kdbus_msg { }; enum { - KDBUS_POLICY_NULL, + _KDBUS_POLICY_NULL, KDBUS_POLICY_NAME, KDBUS_POLICY_ACCESS, }; enum { - KDBUS_POLICY_ACCESS_NULL, + _KDBUS_POLICY_ACCESS_NULL, KDBUS_POLICY_ACCESS_USER, KDBUS_POLICY_ACCESS_GROUP, KDBUS_POLICY_ACCESS_WORLD, @@ -200,48 +206,47 @@ enum { KDBUS_POLICY_OWN = 1 << 0, }; +struct kdbus_policy_access { + __u64 type; /* USER, GROUP, WORLD */ + __u64 bits; /* RECV, SEND, OWN */ + __u64 id; /* uid, gid, 0 */ +}; + 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; }; }; +/* A series of KDBUS_POLICY_NAME, plus one or more KDBUS_POLICY_ACCESS */ struct kdbus_cmd_policy { __u64 size; - __u8 data[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_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, }; -/* Items to append to struct kdbus_cmd_hello */ +/* Flags for message attachments */ enum { - KDBUS_HELLO_NULL, - KDBUS_HELLO_POOL, /* kdbus_vec, userspace supplied pool to - * place received messages */ -}; - + 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, +}; + +/* KDBUS_CMD_HELLO */ struct kdbus_cmd_hello { __u64 size; @@ -252,6 +257,9 @@ struct kdbus_cmd_hello { * more. Kernel might refuse client's * capabilities by returning an error * from KDBUS_HELLO */ + __u64 attach_flags; /* userspace specifies the metadata + * attachments it wishes to receive with + * every message. */ /* kernel → userspace */ __u64 bus_flags; /* this is .flags copied verbatim from @@ -262,6 +270,9 @@ struct kdbus_cmd_hello { __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 */ + __u8 id128[16]; /* the unique id of the bus */ + struct kdbus_item items[0]; }; @@ -274,13 +285,11 @@ enum { /* Items to append to kdbus_cmd_{bus,ep,ns}_make */ enum { - KDBUS_MAKE_NULL, + _KDBUS_MAKE_NULL, KDBUS_MAKE_NAME, - KDBUS_MAKE_CGROUP, /* the cgroup hierarchy ID for which to attach - * cgroup membership paths * to messages. */ KDBUS_MAKE_CRED, /* allow translator services which connect * to the bus on behalf of somebody else, - * allow specifiying the credentials of the + * allow specifying the credentials of the * client to connect on behalf on. Needs * privileges */ }; @@ -297,7 +306,6 @@ struct kdbus_cmd_bus_make { * KDBUS_CMD_HELLO, later */ __u64 bloom_size; /* size of the bloom filter for this bus */ struct kdbus_item items[0]; - }; struct kdbus_cmd_ep_make { @@ -332,36 +340,49 @@ enum { KDBUS_NAME_IN_QUEUE = 1 << 16, }; +/* KDBUS_CMD_NAME_ACQUIRE */ struct kdbus_cmd_name { __u64 size; - __u64 name_flags; - __u64 id; /* We allow registration/deregestration of names of other peers */ + __u64 flags; + __u64 id; /* we allow (de)registration of names of other peers */ __u64 conn_flags; char name[0]; }; -struct kdbus_cmd_names { +/* KDBUS_CMD_NAME_LIST */ +enum { + KDBUS_NAME_LIST_UNIQUE_NAMES = 1 << 0, +}; + +struct kdbus_cmd_name_list { + __u64 flags; + __u64 offset; /* returned offset in the caller's buffer */ +}; + +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 */ +/* KDBUS_CMD_NAME_INFO */ +struct kdbus_cmd_name_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 */ + char name[0]; }; -struct kdbus_cmd_name_info { - __u64 size; /* overall size of info */ - __u64 flags; - __u64 id; /* either ID, or 0 and _ITEM_NAME follows */ - struct kdbus_creds creds; +struct kdbus_name_info { + __u64 size; + __u64 id; + __u64 flags; /* connection flags */ struct kdbus_item items[0]; /* list of item records */ }; +/* KDBUS_CMD_MATCH_ADD/REMOVE */ enum { - KDBUS_MATCH_NULL, + _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 */ @@ -379,52 +400,47 @@ struct kdbus_cmd_match { struct kdbus_item items[0]; }; +/* KDBUS_CMD_MONITOR */ +enum { + KDBUS_MONITOR_ENABLE = 1 << 0, +}; + struct kdbus_cmd_monitor { __u64 id; /* We allow setting the monitor flag of other peers */ - unsigned int enabled; /* A boolean to enable/disable monitoring */ + __u64 flags; }; -/* FD states: - * control nodes: unset - * bus owner (via KDBUS_CMD_BUS_MAKE) - * ns owner (via KDBUS_CMD_NS_MAKE) - * - * 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) - */ -enum kdbus_cmd { +enum { /* 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), + 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, 0x20, struct kdbus_cmd_ep_make), + 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_RELEASE = _IOWR(KDBUS_IOC_MAGIC, 0x42, 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_NAME_INFO = _IOWR(KDBUS_IOC_MAGIC, 0x53, struct kdbus_cmd_name_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, 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 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, 0x70, struct kdbus_cmd_policy), /* kdbus memfd commands: */ - KDBUS_CMD_MEMFD_NEW = _IOWR(KDBUS_IOC_MAGIC, 0x80, int *), - KDBUS_CMD_MEMFD_SIZE_GET = _IOWR(KDBUS_IOC_MAGIC, 0x81, __u64 *), - KDBUS_CMD_MEMFD_SIZE_SET = _IOWR(KDBUS_IOC_MAGIC, 0x82, __u64 *), - KDBUS_CMD_MEMFD_SEAL_GET = _IOWR(KDBUS_IOC_MAGIC, 0x83, int *), - KDBUS_CMD_MEMFD_SEAL_SET = _IOWR(KDBUS_IOC_MAGIC, 0x84, int), + 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), }; #endif