chiark / gitweb /
bus: add a more comprehensive test for the bloom filter logic
[elogind.git] / src / libsystemd-bus / kdbus.h
index aac7b8435273acfed6438f3fe96bb8927afeb8c3..e10a1547aa8024132926713329c5a39e4ba00725 100644 (file)
@@ -2,6 +2,8 @@
  * 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
 struct kdbus_manager_msg_name_change {
        __u64 old_id;
        __u64 new_id;
-       __u64 flags;            /* 0 or (possibly?) KDBUS_CMD_NAME_IN_QUEUE */
+       __u64 flags;                    /* 0 or (possibly?) KDBUS_NAME_IN_QUEUE */
        char name[0];
 };
 
 struct kdbus_manager_msg_id_change {
        __u64 id;
-       __u64 flags; /* The kernel flags field from KDBUS_CMD_HELLO */
+       __u64 flags;                    /* The kernel flags field from KDBUS_HELLO */
 };
 
 struct kdbus_creds {
@@ -63,18 +65,20 @@ struct kdbus_timestamp {
 #define KDBUS_MATCH_SRC_ID_ANY         (~0ULL)
 #define KDBUS_DST_ID_BROADCAST         (~0ULL)
 
-/* Message Data Types */
+/* Message Item Types */
 enum {
+       _KDBUS_MSG_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_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 */
 
        /* Filled in by kernelspace */
-       KDBUS_MSG_SRC_NAMES     = 0x200,/* NUL separated string list with well-known names of source */
+       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 */
@@ -87,12 +91,11 @@ enum {
        KDBUS_MSG_SRC_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_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_ID_CHANGE,            /* .id_change */
        KDBUS_MSG_REPLY_TIMEOUT,        /* empty, but .reply_cookie in .kdbus_msg is filled in */
        KDBUS_MSG_REPLY_DEAD,           /* dito */
 };
@@ -102,13 +105,18 @@ struct kdbus_vec {
        __u64 size;
 };
 
+struct kdbus_memfd {
+       __u64 size;
+       int fd;
+};
+
 /**
- * struct  kdbus_msg_data - chain of data blocks
+ * struct  kdbus_item - chain of data blocks
  *
  * size: overall data record size
- * type: kdbus_msg_data_type of data
+ * type: kdbus_item type of data
  */
-struct kdbus_msg_data {
+struct kdbus_item {
        __u64 size;
        __u64 type;
        union {
@@ -118,26 +126,32 @@ struct kdbus_msg_data {
                __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;
+
+               /* 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;
        };
 };
 
 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_NULL,
        KDBUS_PAYLOAD_DBUS1     = 0x4442757356657231ULL, /* 'DBusVer1' */
        KDBUS_PAYLOAD_GVARIANT  = 0x4756617269616e74ULL, /* 'GVariant' */
 };
@@ -148,8 +162,7 @@ enum {
  * set by userspace:
  * dst_id: destination id
  * flags: KDBUS_MSG_FLAGS_*
- * data_size: overall message size
- * data: data records
+ * items: data records
  *
  * set by kernel:
  * src_id: who sent the message
@@ -157,32 +170,34 @@ enum {
 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;                   /* connection, 0 == name in data, ~0 broadcast */
+       __u64 src_id;                   /* connection, 0 == kernel */
+       __u64 payload_type;             /* 'DBusVer1', 'GVariant', ... */
+       __u64 cookie;                   /* userspace-supplied cookie */
        union {
                __u64 cookie_reply;     /* cookie we reply to */
                __u64 timeout_ns;       /* timespan to wait for reply */
        };
-       struct kdbus_msg_data items[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 {
@@ -200,53 +215,43 @@ struct kdbus_policy {
 
 struct kdbus_cmd_policy {
        __u64 size;
-       __u8 buffer[0]; /* a series of KDBUS_POLICY_NAME plus one or
-                        * more KDBUS_POLICY_ACCESS each. */
+       __u8 data[0];           /* a series of KDBUS_POLICY_NAME plus one or
+                                * more KDBUS_POLICY_ACCESS each. */
 };
 
+/* 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,
+       KDBUS_HELLO_STARTER             =  1 <<  0,
+       KDBUS_HELLO_ACCEPT_FD           =  1 <<  1,
 
        /* 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,
+       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 kdbus_cmd_bus_make, kdbus_cmd_ep_make and
- * kdbus_cmd_ns_make */
+/* Items to append to struct kdbus_cmd_hello */
 enum {
-       KDBUS_ACCESS_GROUP      =  1,
-       KDBUS_ACCESS_WORLD      =  2,
-       KDBUS_POLICY_OPEN       =  4,
+       _KDBUS_HELLO_NULL,
+       KDBUS_HELLO_POOL,       /* kdbus_vec, userspace supplied pool to
+                                * place received messages */
 };
 
 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_CMD_HELLO */
-
-       /* 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. */
+                                * from KDBUS_HELLO */
 
        /* kernel → userspace */
        __u64 bus_flags;        /* this is .flags copied verbatim from
@@ -254,9 +259,30 @@ struct kdbus_cmd_hello {
                                 * ioctl. It's intended to be useful
                                 * to do negotiation of features of
                                 * the payload that is transfreted. */
-       __u64 id;               /* peer id */
+       __u64 id;               /* id assigned to this connection */
        __u64 bloom_size;       /* The bloom filter size chosen by the
                                 * bus owner */
+       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_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
+                                * client to connect on behalf on. Needs
+                                * privileges */
 };
 
 struct kdbus_cmd_bus_make {
@@ -269,12 +295,9 @@ struct kdbus_cmd_bus_make {
                                 * 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 bloom_size;       /* size of the bloom filter for this bus */
+       struct kdbus_item items[0];
+
 };
 
 struct kdbus_cmd_ep_make {
@@ -285,7 +308,7 @@ struct kdbus_cmd_ep_make {
                                 * same way as for
                                 * KDBUS_CMD_BUS_MAKE. Unused for
                                 * now. */
-       char name[0];
+       struct kdbus_item items[0];
 };
 
 struct kdbus_cmd_ns_make {
@@ -296,17 +319,17 @@ struct kdbus_cmd_ns_make {
                                 * same way as for
                                 * KDBUS_CMD_BUS_MAKE. Unused for
                                 * now. */
-       char name[0];
+       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 {
@@ -323,15 +346,10 @@ struct kdbus_cmd_names {
 };
 
 enum {
-       KDBUS_CMD_NAME_INFO_ITEM_NAME,
-       KDBUS_CMD_NAME_INFO_ITEM_SECLABEL,
-       KDBUS_CMD_NAME_INFO_ITEM_AUDIT,
-};
-
-struct kdbus_cmd_name_info_item {
-       __u64 size;
-       __u64 type;
-       __u8 items[0];
+       _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_name_info {
@@ -339,28 +357,18 @@ struct kdbus_cmd_name_info {
        __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 */
+       struct kdbus_item items[0];     /* list of item records */
 };
 
 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_cmd_match_item {
-       __u64 size;
-       __u64 type;
-       union {
-               __u64 id;
-               __u8 data[0];
-               char str[0];
-       };
+       _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 */
 };
 
 struct kdbus_cmd_match {
@@ -368,12 +376,12 @@ struct kdbus_cmd_match {
        __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];
+       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 */
+       unsigned int enabled;   /* A boolean to enable/disable monitoring */
 };
 
 /* FD states:
@@ -391,16 +399,14 @@ enum kdbus_cmd {
        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 control node commands: require bus owner state */
-       KDBUS_CMD_BUS_POLICY_SET =      _IOWR(KDBUS_IOC_MAGIC, 0x20, struct kdbus_cmd_policy),
-
        /* 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 =             _IOWR(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_RECV =            _IOWR(KDBUS_IOC_MAGIC, 0x41, __u64 *),
+       KDBUS_CMD_MSG_RELEASE =         _IOWR(KDBUS_IOC_MAGIC, 0x42, struct kdbus_msg),
 
        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),
@@ -413,5 +419,12 @@ enum kdbus_cmd {
 
        /* kdbus ep node commands: require ep owner state */
        KDBUS_CMD_EP_POLICY_SET =       _IOWR(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),
 };
 #endif