chiark / gitweb /
bus: set cookie_reply and update kdbus.h
[elogind.git] / src / libsystemd-bus / kdbus.h
index e9ffecd54b2db8d003c4fe5315a48e67a4d9463a..8db165c9abd1c1d7508eeddfa9e789c54bac5dc7 100644 (file)
 #define KDBUS_IOC_MAGIC                        0x95
 #define KDBUS_SRC_ID_KERNEL            (0)
 #define KDBUS_DST_ID_NAME              (0)
-#define KDBUS_MATCH_SRC_ID_ANY         (~0ULL)
+#define KDBUS_MATCH_ID_ANY             (~0ULL)
 #define KDBUS_DST_ID_BROADCAST         (~0ULL)
 
 /**
- * struct kdbus_notify_name_change - name registry change message
- * @old_id:            Former owner of a name
- * @new_id:            New owner of a name
- * @old_flags:         flags from KDBUS_NAME_* the name entry used to have
- * @new_flags:         flags from KDBUS_NAME_* the name entry has now
- * @name:              Well-known name
+ * struct kdbus_notify_id_change - name registry change message
+ * @id:                        New or former owner of the name
+ * @flags:             flags field from KDBUS_HELLO_*
  *
  * Sent from kernel to userspace when the owner or activator of
  * a well-known name changes.
  *
  * Attached to:
- *   KDBUS_ITEM_NAME_ADD
- *   KDBUS_ITEM_NAME_REMOVE
- *   KDBUS_ITEM_NAME_CHANGE
+ *   KDBUS_ITEM_ID_ADD
+ *   KDBUS_ITEM_ID_REMOVE
  */
-struct kdbus_notify_name_change {
-       __u64 old_id;
-       __u64 new_id;
-       __u64 old_flags;
-       __u64 new_flags;
-       char name[0];
+struct kdbus_notify_id_change {
+       __u64 id;
+       __u64 flags;
 };
 
 /**
- * struct kdbus_notify_id_change - name registry change message
- * @id:                        New or former owner of the name
- * @flags:             flags field from KDBUS_HELLO_*
+ * struct kdbus_notify_name_change - name registry change message
+ * @old:               ID and flags of former owner of a name
+ * @new:               ID and flags of new owner of a name
+ * @name:              Well-known name
  *
  * Sent from kernel to userspace when the owner or activator of
  * a well-known name changes.
  *
  * Attached to:
- *   KDBUS_ITEM_ID_ADD
- *   KDBUS_ITEM_ID_REMOVE
+ *   KDBUS_ITEM_NAME_ADD
+ *   KDBUS_ITEM_NAME_REMOVE
+ *   KDBUS_ITEM_NAME_CHANGE
  */
-struct kdbus_notify_id_change {
-       __u64 id;
-       __u64 flags;
+struct kdbus_notify_name_change {
+       struct kdbus_notify_id_change old;
+       struct kdbus_notify_id_change new;
+       char name[0];
 };
 
 /**
@@ -121,7 +117,8 @@ struct kdbus_timestamp {
  * 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
+ * @offset:            Offset in the in-message payload memory,
+ *                     relative to the message head
  *
  * Attached to:
  *   KDBUS_ITEM_PAYLOAD_VEC
@@ -197,7 +194,7 @@ struct kdbus_policy {
 /**
  * enum kdbus_item_type - item types to chain data in a list
  * @KDBUS_ITEM_PAYLOAD_VEC:    Vector to data
- * @KDBUS_ITEM_PAYLOAD_OFF:    Data at returned offset in the pool
+ * @KDBUS_ITEM_PAYLOAD_OFF:    Data at returned offset to message head
  * @KDBUS_ITEM_PAYLOAD_MEMFD:  Data as sealed memfd
  * @KDBUS_ITEM_FDS:            Attached file descriptors
  * @KDBUS_ITEM_BLOOM:          For broadcasts, carries bloom filter
@@ -208,6 +205,7 @@ struct kdbus_policy {
  * @KDBUS_ITEM_POLICY_NAME:    Policy in struct kdbus_policy
  * @KDBUS_ITEM_POLICY_ACCESS:  Policy in struct kdbus_policy
  * @KDBUS_ITEM_NAME:           Well-know name with flags
+ * @KDBUS_ITEM_ID:             Connection ID
  * @KDBUS_ITEM_TIMESTAMP:      Timestamp
  * @KDBUS_ITEM_CREDS:          Process credential
  * @KDBUS_ITEM_PID_COMM:       Process ID "comm" identifier
@@ -245,6 +243,7 @@ enum kdbus_item_type {
 
        _KDBUS_ITEM_ATTACH_BASE = 0x600,
        KDBUS_ITEM_NAME         = _KDBUS_ITEM_ATTACH_BASE,
+       KDBUS_ITEM_ID,
        KDBUS_ITEM_TIMESTAMP,
        KDBUS_ITEM_CREDS,
        KDBUS_ITEM_PID_COMM,
@@ -315,8 +314,9 @@ struct kdbus_item {
 /**
  * enum kdbus_msg_flags - type of message
  * @KDBUS_MSG_FLAGS_EXPECT_REPLY:      Expect a reply message, used for method
- *                                     calls. The cookie identifies the
- *                                     message and the respective reply
+ *                                     calls. The userspace-supplied cookie identifies
+ *                                     the message and the respective reply
+ *                                     carries the cookie in cookie_reply
  * @KDBUS_MSG_FLAGS_NO_AUTO_START:     Do not start a service, if the addressed
  *                                     name is not currently active
  */
@@ -342,9 +342,11 @@ enum kdbus_payload_type {
  * @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
+ * @cookie:            Userspace-supplied cookie to uniquely identify a
+ *                     message, unsually all messages carry this
+ * @cookie_reply:      A reply to the message with the same cookie. The
+ *                     reply itself has its own unique cookie, @cookie_reply
+ *                     connects the reply to the request message.
  * @timeout_ns:                For non-kernel-generated messages, this denotes the
  *                     message timeout in nanoseconds. A message has to be
  *                     received with KDBUS_CMD_MSG_RECV by the destination
@@ -366,10 +368,8 @@ struct kdbus_msg {
        __u64 src_id;
        __u64 payload_type;
        __u64 cookie;
-       union {
-               __u64 cookie_reply;
-               __u64 timeout_ns;
-       };
+       __u64 cookie_reply;
+       __u64 timeout_ns;
        struct kdbus_item items[0];
 } __attribute__((aligned(8)));
 
@@ -518,19 +518,20 @@ struct kdbus_cmd_make {
  * @KDBUS_NAME_ACTIVATOR:              Name is owned by a activator connection
  */
 enum kdbus_name_flags {
-       KDBUS_NAME_REPLACE_EXISTING             = 1 <<  0,
-       KDBUS_NAME_ALLOW_REPLACEMENT            = 1 <<  1,
-       KDBUS_NAME_QUEUE                        = 1 <<  2,
-       KDBUS_NAME_IN_QUEUE                     = 1 <<  3,
-       KDBUS_NAME_ACTIVATOR                    = 1 <<  4,
+       KDBUS_NAME_REPLACE_EXISTING     = 1 <<  0,
+       KDBUS_NAME_ALLOW_REPLACEMENT    = 1 <<  1,
+       KDBUS_NAME_QUEUE                = 1 <<  2,
+       KDBUS_NAME_IN_QUEUE             = 1 <<  3,
+       KDBUS_NAME_ACTIVATOR            = 1 <<  4,
 };
 
 /**
  * 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:                        Privileged users may use this field to (de)register
- *                     names on behalf of other peers.
+ * @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.
  * @conn_flags:                The flags of the owning connection (KDBUS_HELLO_*)
  * @name:              The well-known name
  *
@@ -539,7 +540,7 @@ enum kdbus_name_flags {
 struct kdbus_cmd_name {
        __u64 size;
        __u64 flags;
-       __u64 id;
+       __u64 owner_id;
        __u64 conn_flags;
        char name[0];
 } __attribute__((aligned(8)));
@@ -564,7 +565,7 @@ enum kdbus_name_list_flags {
  * @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 {
@@ -627,37 +628,13 @@ struct kdbus_conn_info {
        struct kdbus_item items[0];
 };
 
-/**
- * enum kdbus_match_type - type of match record
- * @KDBUS_MATCH_BLOOM:         Matches against KDBUS_MSG_BLOOM
- * @KDBUS_MATCH_SRC_NAME:      Matches a name string
- * @KDBUS_MATCH_NAME_ADD:      Matches a name string
- * @KDBUS_MATCH_NAME_REMOVE:   Matches a name string
- * @KDBUS_MATCH_NAME_CHANGE:   Matches a name string
- * @KDBUS_MATCH_ID_ADD:                Matches an ID
- * @KDBUS_MATCH_ID_REMOVE:     Matches an ID
- */
-enum kdbus_match_type {
-       _KDBUS_MATCH_NULL,
-       KDBUS_MATCH_BLOOM,
-       KDBUS_MATCH_SRC_NAME,
-       KDBUS_MATCH_NAME_ADD,
-       KDBUS_MATCH_NAME_REMOVE,
-       KDBUS_MATCH_NAME_CHANGE,
-       KDBUS_MATCH_ID_ADD,
-       KDBUS_MATCH_ID_REMOVE,
-};
-
 /**
  * struct kdbus_cmd_match - struct to add or remove matches
  * @size:              The total size of the struct
- * @id:                        Privileged users may (de)register matches on behalf
- *                     of other peers. In other cases, set to 0.
+ * @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.
- * @src_id:            The source ID to match against. Use
- *                     KDBUS_MATCH_SRC_ID_ANY or any other value for a unique
- *                     match.
+ *                     identifies the match to remove
  * @items:             A list of items for additional information
  *
  * This structure is used with the KDBUS_CMD_ADD_MATCH and
@@ -665,9 +642,8 @@ enum kdbus_match_type {
  */
 struct kdbus_cmd_match {
        __u64 size;
-       __u64 id;
+       __u64 owner_id;
        __u64 cookie;
-       __u64 src_id;
        struct kdbus_item items[0];
 } __attribute__((aligned(8)));
 
@@ -687,6 +663,11 @@ struct kdbus_cmd_match {
  * @KDBUS_CMD_HELLO:           By opening the bus device node a connection is
  *                             created. After a HELLO the opened connection
  *                             becomes an active peer on the bus.
+ * @KDBUS_CMD_BYEBYE:          Disconnect a connection. If the connection's
+ *                             message list is empty, the calls succeeds, and
+ *                             the handle is rendered unusable. Otherwise,
+ *                             -EAGAIN is returned without any further side-
+ *                             effects.
  * @KDBUS_CMD_MSG_SEND:                Send a message and pass data from userspace to
  *                             the kernel.
  * @KDBUS_CMD_MSG_RECV:                Receive a message from the kernel which is
@@ -748,6 +729,7 @@ enum kdbus_ioctl_type {
        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 =            _IOW (KDBUS_IOC_MAGIC, 0x40, struct kdbus_msg),
        KDBUS_CMD_MSG_RECV =            _IOR (KDBUS_IOC_MAGIC, 0x41, __u64 *),
@@ -785,6 +767,8 @@ enum kdbus_ioctl_type {
  * @EBADFD:            A bus connection is in a corrupted state.
  * @EBADMSG:           Passed data contains a combination of conflicting or
  *                     inconsistent types.
+ * @EBUSY:             The user tried to say BYEBYE to a connection, but the
+ *                     connection had a non-empty message list.
  * @ECONNRESET:                A connection is shut down, no further operations are
  *                     possible.
  * @ECOMM:             A peer does not accept the file descriptors addressed
@@ -811,6 +795,8 @@ 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.
  * @ENOMEM:            Out of memory.
  * @ENOSYS:            The requested functionality is not available.
  * @ENOTCONN:          The addressed peer is not an active connection.