chiark / gitweb /
libsystemd-bus: catch up with latest kdbus changes
[elogind.git] / src / libsystemd-bus / kdbus.h
index dfc64ffe2414e84d2ae42eaf4d81ed9a5f1724a1..d419772f52f96d7fb9d0a9917db6dd3e0624e887 100644 (file)
 
 /* 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 */
 };
@@ -73,48 +73,55 @@ struct kdbus_timestamp {
 };
 
 struct kdbus_vec {
-       __u64 address;
        __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_PAYLOAD_VEC,         /* .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_NAMES        = 0x400,/* NUL separated string list with well-known names of source */
+       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 */
+       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 */
 };
 
 /**
@@ -146,8 +153,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;
        };
 };
 
@@ -212,6 +219,7 @@ struct kdbus_policy_access {
        __u64 id;               /* uid, gid, 0 */
 };
 
+//FIXME: convert access to access[]
 struct kdbus_policy {
        KDBUS_PART_HEADER;
        union {
@@ -230,23 +238,20 @@ struct kdbus_cmd_policy {
 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,
 };
 
 struct kdbus_cmd_hello {
@@ -259,6 +264,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
@@ -269,6 +277,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];
 };
 
@@ -283,11 +294,9 @@ enum {
 enum {
        _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 */
 };
@@ -304,7 +313,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 {
@@ -348,8 +356,13 @@ struct kdbus_cmd_name {
        char name[0];
 };
 
+enum {
+       KDBUS_NAME_LIST_UNIQUE_NAMES            = 1 <<  0,
+};
+
 struct kdbus_cmd_names {
        __u64 size;
+       __u64 flags;
        struct kdbus_cmd_name names[0];
 };
 
@@ -362,7 +375,8 @@ enum {
 
 struct kdbus_cmd_name_info {
        __u64 size;                     /* overall size of info */
-       __u64 flags;
+       __u64 flags;                    /* query flags */
+       __u64 attach_flags;             /* which meta data payload to attach */
        __u64 id;                       /* either ID, or 0 and _ITEM_NAME follows */
        struct kdbus_creds creds;
        struct kdbus_item items[0];     /* list of item records */
@@ -390,6 +404,7 @@ struct kdbus_cmd_match {
 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;
 };
 
 /* FD states:
@@ -404,35 +419,35 @@ struct kdbus_cmd_monitor {
  */
 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, __u64 *),
-       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_MSG_RELEASE =         _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_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_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