chiark / gitweb /
Merge commit 'b39a2770ba55637da80e2e389222c59dbea73507'
[elogind.git] / src / libsystemd / sd-bus / kdbus.h
index 6bb6777bf0b34c354f6739730a67a925cd424d91..b060330cb61fdd10c106855f8d2ebc021acec2ea 100644 (file)
@@ -23,7 +23,7 @@
 #include <linux/types.h>
 #endif
 
-#define KDBUS_IOC_MAGIC                        0x95
+#define KDBUS_IOCTL_MAGIC              0x95
 #define KDBUS_SRC_ID_KERNEL            (0)
 #define KDBUS_DST_ID_NAME              (0)
 #define KDBUS_MATCH_ID_ANY             (~0ULL)
@@ -223,6 +223,7 @@ struct kdbus_policy_access {
  * @KDBUS_ITEM_ID:             Connection ID
  * @KDBUS_ITEM_TIMESTAMP:      Timestamp
  * @KDBUS_ITEM_CREDS:          Process credential
+ * @KDBUS_ITEM_AUXGROUPS:      Auxiliary process groups
  * @KDBUS_ITEM_PID_COMM:       Process ID "comm" identifier
  * @KDBUS_ITEM_TID_COMM:       Thread ID "comm" identifier
  * @KDBUS_ITEM_EXE:            The path of the executable
@@ -263,6 +264,7 @@ enum kdbus_item_type {
        KDBUS_ITEM_ID,
        KDBUS_ITEM_TIMESTAMP,
        KDBUS_ITEM_CREDS,
+       KDBUS_ITEM_AUXGROUPS,
        KDBUS_ITEM_PID_COMM,
        KDBUS_ITEM_TID_COMM,
        KDBUS_ITEM_EXE,
@@ -343,15 +345,15 @@ struct kdbus_item {
  *                                     respective reply carries the cookie
  *                                     in cookie_reply
  * @KDBUS_MSG_FLAGS_SYNC_REPLY:                Wait for destination connection to
- *                                     reply to this message. The
- *                                     KDBUS_CMD_MSG_SEND ioctl() will block
- *                                     until the reply is received, and
- *                                     offset_reply in struct kdbus_msg will
- *                                     yield the offset in the sender's pool
- *                                     where the reply can be found.
- *                                     This flag is only valid if
- *                                     @KDBUS_MSG_FLAGS_EXPECT_REPLY is set as
- *                                     well.
+ *                                     reply to this message. The
+ *                                     KDBUS_CMD_MSG_SEND ioctl() will block
+ *                                     until the reply is received, and
+ *                                     offset_reply in struct kdbus_msg will
+ *                                     yield the offset in the sender's pool
+ *                                     where the reply can be found.
+ *                                     This flag is only valid if
+ *                                     @KDBUS_MSG_FLAGS_EXPECT_REPLY is set as
+ *                                     well.
  * @KDBUS_MSG_FLAGS_NO_AUTO_START:     Do not start a service, if the addressed
  *                                     name is not currently active
  */
@@ -388,7 +390,7 @@ enum kdbus_payload_type {
  * @cookie_reply:      A reply to the requesting message with the same
  *                     cookie. The requesting connection can match its
  *                     request and the reply with this value
- * @offset_reply:      If KDBUS_MSG_FLAGS_WAIT_FOR_REPLY, this field will
+ * @offset_reply:      If KDBUS_MSG_FLAGS_EXPECT_REPLY, this field will
  *                     contain the offset in the sender's pool where the
  *                     reply is stored.
  * @items:             A list of kdbus_items containing the message payload
@@ -419,8 +421,8 @@ struct kdbus_msg {
  * @KDBUS_RECV_DROP:           Drop and free the next queued message and all
  *                             its resources without actually receiving it.
  * @KDBUS_RECV_USE_PRIORITY:   Only de-queue messages with the specified or
- *                             higher priority (lowest values); if not set,
- *                             the priority value is ignored.
+ *                             higher priority (lowest values); if not set,
+ *                             the priority value is ignored.
  */
 enum kdbus_recv_flags {
        KDBUS_RECV_PEEK         = 1 <<  0,
@@ -434,8 +436,8 @@ enum kdbus_recv_flags {
  * @priority:          Minimum priority of the messages to de-queue. Lowest
  *                     values have the highest priority.
  * @offset:            Returned offset in the pool where the message is
- *                     stored. The user must use KDBUS_CMD_FREE to free
- *                     the allocated memory.
+ *                     stored. The user must use KDBUS_CMD_FREE to free
+ *                     the allocated memory.
  *
  * This struct is used with the KDBUS_CMD_MSG_RECV ioctl.
  */
@@ -481,9 +483,11 @@ enum kdbus_policy_type {
  *                             a well-know name for a process to be started
  *                             when traffic arrives
  * @KDBUS_HELLO_POLICY_HOLDER: Special-purpose connection which registers
- *                             policy entries for one or multiple names. The
- *                             provided names are not activated, and are not
- *                             registered with the name database
+ *                             policy entries for a name. The provided name
+ *                             is not activated and not registered with the
+ *                             name database, it only allows unprivileged
+ *                             connections to aquire a name, talk or discover
+ *                             a service
  * @KDBUS_HELLO_MONITOR:       Special-purpose connection to monitor
  *                             bus traffic
  */
@@ -498,6 +502,7 @@ enum kdbus_hello_flags {
  * enum kdbus_attach_flags - flags for metadata attachments
  * @KDBUS_ATTACH_TIMESTAMP:    Timestamp
  * @KDBUS_ATTACH_CREDS:                Credentials
+ * @KDBUS_ATTACH_AUXGROUPS:    Auxiliary groups
  * @KDBUS_ATTACH_NAMES:                Well-known names
  * @KDBUS_ATTACH_COMM:         The "comm" process identifier
  * @KDBUS_ATTACH_EXE:          The path of the executable
@@ -507,20 +512,22 @@ enum kdbus_hello_flags {
  * @KDBUS_ATTACH_SECLABEL:     The security label
  * @KDBUS_ATTACH_AUDIT:                The audit IDs
  * @KDBUS_ATTACH_CONN_NAME:    The human-readable connection name
+ * @_KDBUS_ATTACH_ALL:         All of the above
  */
 enum kdbus_attach_flags {
        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_ATTACH_CONN_NAME          =  1 << 10,
-       _KDBUS_ATTACH_ALL               =  (1 << 11) - 1,
+       KDBUS_ATTACH_AUXGROUPS          =  1 <<  2,
+       KDBUS_ATTACH_NAMES              =  1 <<  3,
+       KDBUS_ATTACH_COMM               =  1 <<  4,
+       KDBUS_ATTACH_EXE                =  1 <<  5,
+       KDBUS_ATTACH_CMDLINE            =  1 <<  6,
+       KDBUS_ATTACH_CGROUP             =  1 <<  7,
+       KDBUS_ATTACH_CAPS               =  1 <<  8,
+       KDBUS_ATTACH_SECLABEL           =  1 <<  9,
+       KDBUS_ATTACH_AUDIT              =  1 << 10,
+       KDBUS_ATTACH_CONN_NAME          =  1 << 11,
+       _KDBUS_ATTACH_ALL               =  (1 << 12) - 1,
 };
 
 /**
@@ -601,9 +608,7 @@ enum kdbus_name_flags {
  * 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_*)
- * @owner_id:          The current owner of the name. For requests,
- *                     privileged users may set this field to
- *                     (de)register names on behalf of other connections.
+ * @owner_id:          The current owner of the name.
  * @conn_flags:                The flags of the owning connection (KDBUS_HELLO_*)
  * @name:              The well-known name
  *
@@ -715,8 +720,6 @@ struct kdbus_cmd_update {
 /**
  * struct kdbus_cmd_match - struct to add or remove matches
  * @size:              The total size of the struct
- * @owner_id:          Privileged users may (de)register matches on behalf
- *                     of other peers
  * @cookie:            Userspace supplied cookie. When removing, the cookie
  *                     identifies the match to remove
  * @items:             A list of items for additional information
@@ -726,7 +729,6 @@ struct kdbus_cmd_update {
  */
 struct kdbus_cmd_match {
        __u64 size;
-       __u64 owner_id;
        __u64 cookie;
        struct kdbus_item items[0];
 } __attribute__((aligned(8)));
@@ -756,7 +758,7 @@ struct kdbus_cmd_memfd_make {
  *                             name. The bus is immediately shut down and
  *                             cleaned up when the opened "control" device node
  *                             is closed.
- * @KDBUS_CMD_DOMAIN_MAKE:             Similar to KDBUS_CMD_BUS_MAKE, but it creates a
+ * @KDBUS_CMD_DOMAIN_MAKE:     Similar to KDBUS_CMD_BUS_MAKE, but it creates a
  *                             new kdbus domain.
  * @KDBUS_CMD_EP_MAKE:         Creates a new named special endpoint to talk to
  *                             the bus. Such endpoints usually carry a more
@@ -775,8 +777,8 @@ struct kdbus_cmd_memfd_make {
  * @KDBUS_CMD_MSG_RECV:                Receive a message from the kernel which is
  *                             placed in the receiver's pool.
  * @KDBUS_CMD_MSG_CANCEL:      Cancel a pending request of a message that
- *                             blocks while waiting for a reply. The parameter
- *                             denotes the cookie of the message in flight.
+ *                             blocks while waiting for a reply. The parameter
+ *                             denotes the cookie of the message in flight.
  * @KDBUS_CMD_FREE:            Release the allocated memory in the receiver's
  *                             pool.
  * @KDBUS_CMD_NAME_ACQUIRE:    Request a well-known bus name to associate with
@@ -792,13 +794,13 @@ struct kdbus_cmd_memfd_make {
  *                             necessarily represent the connected process or
  *                             the actual state of the process.
  * @KDBUS_CMD_CONN_UPDATE:     Update the properties of a connection. Used to
- *                             update the metadata subscription.
+ *                             update the metadata subscription mask and
+ *                             policy.
+ * @KDBUS_CMD_EP_UPDATE:       Update the properties of a custom enpoint. Used
+ *                             to update the policy.
  * @KDBUS_CMD_MATCH_ADD:       Install a match which broadcast messages should
  *                             be delivered to the connection.
  * @KDBUS_CMD_MATCH_REMOVE:    Remove a current match for broadcast messages.
- * @KDBUS_CMD_EP_POLICY_SET:   Set the policy of an endpoint. It is used to
- *                             restrict the access for endpoints created with
- *                             KDBUS_CMD_EP_MAKE.
  * @KDBUS_CMD_MEMFD_NEW:       Return a new file descriptor which provides an
  *                             anonymous shared memory file and which can be
  *                             used to pass around larger chunks of data.
@@ -827,35 +829,50 @@ struct kdbus_cmd_memfd_make {
  *                             be changed as long as the file is shared.
  */
 enum kdbus_ioctl_type {
-       KDBUS_CMD_BUS_MAKE =            _IOW (KDBUS_IOC_MAGIC, 0x00, struct kdbus_cmd_make),
-       KDBUS_CMD_DOMAIN_MAKE =         _IOW (KDBUS_IOC_MAGIC, 0x10, struct kdbus_cmd_make),
-       KDBUS_CMD_EP_MAKE =             _IOW (KDBUS_IOC_MAGIC, 0x20, struct kdbus_cmd_make),
-
-       KDBUS_CMD_HELLO =               _IOWR(KDBUS_IOC_MAGIC, 0x30, struct kdbus_cmd_hello),
-       KDBUS_CMD_BYEBYE =              _IO  (KDBUS_IOC_MAGIC, 0x31),
-
-       KDBUS_CMD_MSG_SEND =            _IOWR(KDBUS_IOC_MAGIC, 0x40, struct kdbus_msg),
-       KDBUS_CMD_MSG_RECV =            _IOWR(KDBUS_IOC_MAGIC, 0x41, struct kdbus_cmd_recv),
-       KDBUS_CMD_MSG_CANCEL =          _IOW (KDBUS_IOC_MAGIC, 0x42, __u64 *),
-       KDBUS_CMD_FREE =                _IOW (KDBUS_IOC_MAGIC, 0x43, __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_name_list),
-
-       KDBUS_CMD_CONN_INFO =           _IOWR(KDBUS_IOC_MAGIC, 0x60, struct kdbus_cmd_conn_info),
-       KDBUS_CMD_CONN_UPDATE =         _IOW (KDBUS_IOC_MAGIC, 0x61, struct kdbus_cmd_update),
-
-       KDBUS_CMD_EP_UPDATE =           _IOW (KDBUS_IOC_MAGIC, 0x71, struct kdbus_cmd_update),
-
-       KDBUS_CMD_MATCH_ADD =           _IOW (KDBUS_IOC_MAGIC, 0x80, struct kdbus_cmd_match),
-       KDBUS_CMD_MATCH_REMOVE =        _IOW (KDBUS_IOC_MAGIC, 0x81, struct kdbus_cmd_match),
-
-       KDBUS_CMD_MEMFD_NEW =           _IOWR(KDBUS_IOC_MAGIC, 0xc0, struct kdbus_cmd_memfd_make),
-       KDBUS_CMD_MEMFD_SIZE_GET =      _IOR (KDBUS_IOC_MAGIC, 0xc1, __u64 *),
-       KDBUS_CMD_MEMFD_SIZE_SET =      _IOW (KDBUS_IOC_MAGIC, 0xc2, __u64 *),
-       KDBUS_CMD_MEMFD_SEAL_GET =      _IOR (KDBUS_IOC_MAGIC, 0xc3, int *),
-       KDBUS_CMD_MEMFD_SEAL_SET =      _IO  (KDBUS_IOC_MAGIC, 0xc4),
+       KDBUS_CMD_BUS_MAKE =            _IOW(KDBUS_IOCTL_MAGIC, 0x00,
+                                            struct kdbus_cmd_make),
+       KDBUS_CMD_DOMAIN_MAKE =         _IOW(KDBUS_IOCTL_MAGIC, 0x10,
+                                            struct kdbus_cmd_make),
+       KDBUS_CMD_EP_MAKE =             _IOW(KDBUS_IOCTL_MAGIC, 0x20,
+                                            struct kdbus_cmd_make),
+
+       KDBUS_CMD_HELLO =               _IOWR(KDBUS_IOCTL_MAGIC, 0x30,
+                                             struct kdbus_cmd_hello),
+       KDBUS_CMD_BYEBYE =              _IO(KDBUS_IOCTL_MAGIC, 0x31),
+
+       KDBUS_CMD_MSG_SEND =            _IOWR(KDBUS_IOCTL_MAGIC, 0x40,
+                                             struct kdbus_msg),
+       KDBUS_CMD_MSG_RECV =            _IOWR(KDBUS_IOCTL_MAGIC, 0x41,
+                                             struct kdbus_cmd_recv),
+       KDBUS_CMD_MSG_CANCEL =          _IOW(KDBUS_IOCTL_MAGIC, 0x42, __u64 *),
+       KDBUS_CMD_FREE =                _IOW(KDBUS_IOCTL_MAGIC, 0x43, __u64 *),
+
+       KDBUS_CMD_NAME_ACQUIRE =        _IOWR(KDBUS_IOCTL_MAGIC, 0x50,
+                                             struct kdbus_cmd_name),
+       KDBUS_CMD_NAME_RELEASE =        _IOW(KDBUS_IOCTL_MAGIC, 0x51,
+                                            struct kdbus_cmd_name),
+       KDBUS_CMD_NAME_LIST =           _IOWR(KDBUS_IOCTL_MAGIC, 0x52,
+                                            struct kdbus_cmd_name_list),
+
+       KDBUS_CMD_CONN_INFO =           _IOWR(KDBUS_IOCTL_MAGIC, 0x60,
+                                             struct kdbus_cmd_conn_info),
+       KDBUS_CMD_CONN_UPDATE =         _IOW(KDBUS_IOCTL_MAGIC, 0x61,
+                                            struct kdbus_cmd_update),
+
+       KDBUS_CMD_EP_UPDATE =           _IOW(KDBUS_IOCTL_MAGIC, 0x71,
+                                            struct kdbus_cmd_update),
+
+       KDBUS_CMD_MATCH_ADD =           _IOW(KDBUS_IOCTL_MAGIC, 0x80,
+                                            struct kdbus_cmd_match),
+       KDBUS_CMD_MATCH_REMOVE =        _IOW(KDBUS_IOCTL_MAGIC, 0x81,
+                                            struct kdbus_cmd_match),
+
+       KDBUS_CMD_MEMFD_NEW =           _IOWR(KDBUS_IOCTL_MAGIC, 0xc0,
+                                             struct kdbus_cmd_memfd_make),
+       KDBUS_CMD_MEMFD_SIZE_GET =      _IOR(KDBUS_IOCTL_MAGIC, 0xc1, __u64 *),
+       KDBUS_CMD_MEMFD_SIZE_SET =      _IOW(KDBUS_IOCTL_MAGIC, 0xc2, __u64 *),
+       KDBUS_CMD_MEMFD_SEAL_GET =      _IOR(KDBUS_IOCTL_MAGIC, 0xc3, int *),
+       KDBUS_CMD_MEMFD_SEAL_SET =      _IO(KDBUS_IOCTL_MAGIC, 0xc4),
 };
 
 /*
@@ -886,8 +903,9 @@ enum kdbus_ioctl_type {
  * @EEXIST:            A requested domain, bus or endpoint with the same
  *                     name already exists.  A specific data type, which is
  *                     only expected once, is provided multiple times.
- * @EFAULT:            The supplied memory could not be accessed, or the data
- *                     is not properly aligned.
+ * @EFAULT:            The supplied memory could not be accessed, the data
+ *                     is not properly aligned, or the current task's memory
+ *                     is inaccessible.
  * @EINVAL:            The provided data does not match its type or other
  *                     expectations, like a string which is not NUL terminated,
  *                     or a string length that points behind the first
@@ -906,20 +924,19 @@ enum kdbus_ioctl_type {
  *                     size.
  * @ENOBUFS:           There is no space left for the submitted data to fit
  *                     into the receiver's pool.
- * @ENOENT:            The name to query information about is currently not on
- *                     the bus.
+ * @ENOENT:            The to be cancelled message was not found.
  * @ENOMEM:            Out of memory.
  * @ENOMSG:            The queue is not empty, but no message with a matching
- *                     priority is currently queued.
+ *                     priority is currently queued.
  * @ENOSYS:            The requested functionality is not available.
- * @ENOTSUPP:          The feature negotiation failed, a not supported feature
- *                     was requested, or an unknown item type was received.
  * @ENOTTY:            An unknown ioctl command was received.
  * @ENOTUNIQ:          A specific data type was addressed to a broadcast
  *                     address, but only direct addresses support this kind of
  *                     data.
  * @ENXIO:             A unique address does not exist, or an offset in the
  *                     receiver's pool does not represent a queued message.
+ * @EOPNOTSUPP:                The feature negotiation failed, a not supported feature
+ *                     was requested, or an unknown item type was received.
  * @EPERM:             The policy prevented an operation. The requested
  *                     resource is owned by another entity.
  * @EPIPE:             When sending a message, a synchronous reply from the