bus: catch up with kdbus changes

[elogind.git] / src / libsystemd-bus / kdbus.h

diff --git a/src/libsystemd-bus/kdbus.h b/src/libsystemd-bus/kdbus.h
index f3159501315c79ba8d4de3af5afbd94f26e505c5..4896c38dfe30d2e07b67c7f60709109e6fd100c3 100644 (file)
--- a/src/libsystemd-bus/kdbus.h
+++ b/src/libsystemd-bus/kdbus.h
@@ -27,44 +27,40 @@
 #define KDBUS_DST_ID_BROADCAST         (~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:
  *
  * 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:
  *
  * 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
  * 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
  *
  * Attached to:
  *   KDBUS_ITEM_PAYLOAD_VEC


@@ -197,17 +194,17 @@ struct kdbus_policy {
 /**
  * enum kdbus_item_type - item types to chain data in a list
  * @KDBUS_ITEM_PAYLOAD_VEC:    Vector to data
 /**
  * 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
  * @KDBUS_ITEM_PAYLOAD_MEMFD:  Data as sealed memfd
  * @KDBUS_ITEM_FDS:            Attached file descriptors
  * @KDBUS_ITEM_BLOOM:          For broadcasts, carries bloom filter

+ * @KDBUS_ITEM_BLOOM_SIZE:     Desired bloom size, used by KDBUS_CMD_BUS_MAKE

  * @KDBUS_ITEM_DST_NAME:       Destination's well-known name
  * @KDBUS_ITEM_PRIORITY:       Queue priority for message
  * @KDBUS_ITEM_MAKE_NAME:      Name of namespace, bus, endpoint
  * @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_DST_NAME:       Destination's well-known name
  * @KDBUS_ITEM_PRIORITY:       Queue priority for message
  * @KDBUS_ITEM_MAKE_NAME:      Name of namespace, bus, endpoint
  * @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_ACTIVATOR_NAME: Well-known name for the activator

  * @KDBUS_ITEM_TIMESTAMP:      Timestamp
  * @KDBUS_ITEM_CREDS:          Process credential
  * @KDBUS_ITEM_PID_COMM:       Process ID "comm" identifier
  * @KDBUS_ITEM_TIMESTAMP:      Timestamp
  * @KDBUS_ITEM_CREDS:          Process credential
  * @KDBUS_ITEM_PID_COMM:       Process ID "comm" identifier


@@ -234,6 +231,7 @@ enum kdbus_item_type {
        KDBUS_ITEM_PAYLOAD_MEMFD,
        KDBUS_ITEM_FDS,
        KDBUS_ITEM_BLOOM,
        KDBUS_ITEM_PAYLOAD_MEMFD,
        KDBUS_ITEM_FDS,
        KDBUS_ITEM_BLOOM,

+       KDBUS_ITEM_BLOOM_SIZE,

        KDBUS_ITEM_DST_NAME,
        KDBUS_ITEM_PRIORITY,
        KDBUS_ITEM_MAKE_NAME,
        KDBUS_ITEM_DST_NAME,
        KDBUS_ITEM_PRIORITY,
        KDBUS_ITEM_MAKE_NAME,


@@ -244,7 +242,6 @@ enum kdbus_item_type {
 
        _KDBUS_ITEM_ATTACH_BASE = 0x600,
        KDBUS_ITEM_NAME         = _KDBUS_ITEM_ATTACH_BASE,
 
        _KDBUS_ITEM_ATTACH_BASE = 0x600,
        KDBUS_ITEM_NAME         = _KDBUS_ITEM_ATTACH_BASE,

-       KDBUS_ITEM_ACTIVATOR_NAME,

        KDBUS_ITEM_TIMESTAMP,
        KDBUS_ITEM_CREDS,
        KDBUS_ITEM_PID_COMM,
        KDBUS_ITEM_TIMESTAMP,
        KDBUS_ITEM_CREDS,
        KDBUS_ITEM_PID_COMM,


@@ -495,46 +492,15 @@ enum kdbus_make_flags {
 };
 
 /**
 };
 
 /**

- * struct kdbus_cmd_bus_make - struct to make a bus
+ * struct kdbus_cmd_make - struct to make a bus, an endpoint or a namespace

  * @size:              The total size of the struct
  * @size:              The total size of the struct

- * @flags:             Properties for the bus to create
- * @bloom_size:                Size of the bloom filter for this bus
- * @items:             Items describing details such as the name of the bus
+ * @flags:             Properties for the bus/ep/ns to create
+ * @items:             Items describing details

  *
  *

- * This structure is used with the KDBUS_CMD_BUS_MAKE ioctl.
+ * This structure is used with the KDBUS_CMD_BUS_MAKE, KDBUS_CMD_EP_MAKE and
+ * KDBUS_CMD_NS_MAKE ioctls.

  */
  */

-struct kdbus_cmd_bus_make {
-       __u64 size;
-       __u64 flags;
-       __u64 bloom_size;
-       struct kdbus_item items[0];
-} __attribute__((aligned(8)));
-
-/**
- * struct kdbus_cmd_ep_make - struct to make an endpoint
- * @size:              The total size of the struct
- * @flags:             Unused for now
- * @items:             Items describing details such as the
- *                     name of the endpoint
- *
- * This structure is used with the KDBUS_CMD_EP_MAKE ioctl.
- */
-struct kdbus_cmd_ep_make {
-       __u64 size;
-       __u64 flags;
-       struct kdbus_item items[0];
-} __attribute__((aligned(8)));
-
-/**
- * struct kdbus_cmd_ns_make - struct to make a namespace
- * @size:              The total size of the struct
- * @flags:             Unused for now
- * @items:             Items describing details such as the
- *                     name of the namespace
- *
- * This structure is used with the KDBUS_CMD_NS_MAKE ioctl.
- */
-struct kdbus_cmd_ns_make {
+struct kdbus_cmd_make {

        __u64 size;
        __u64 flags;
        struct kdbus_item items[0];
        __u64 size;
        __u64 flags;
        struct kdbus_item items[0];


@@ -549,11 +515,11 @@ struct kdbus_cmd_ns_make {
  * @KDBUS_NAME_ACTIVATOR:              Name is owned by a activator connection
  */
 enum kdbus_name_flags {
  * @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,

 };
 
 /**
 };
 
 /**


@@ -595,7 +561,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.
  * @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 {
  * This structure is used with the KDBUS_CMD_NAME_LIST ioctl.
  */
 struct kdbus_cmd_name_list {


@@ -718,12 +684,21 @@ 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_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
  *                             placed in the receiver's pool.
  * @KDBUS_CMD_FREE:            Release the allocated memory in the receiver's
  *                             pool.
  * @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
  *                             placed in the receiver's pool.
  * @KDBUS_CMD_FREE:            Release the allocated memory in the receiver's
  *                             pool.

+ * @KDBUS_CMD_DROP:            Drop and free the next queued message and all
+ *                             its ressources without actually receiveing it.
+ * @KDBUS_CMD_SRC:             Return the sender's connection ID of the next
+ *                             queued message.

  * @KDBUS_CMD_NAME_ACQUIRE:    Request a well-known bus name to associate with
  *                             the connection. Well-known names are used to
  *                             address a peer on the bus.
  * @KDBUS_CMD_NAME_ACQUIRE:    Request a well-known bus name to associate with
  *                             the connection. Well-known names are used to
  *                             address a peer on the bus.


@@ -770,15 +745,18 @@ struct kdbus_cmd_match {
  *                             be changed as long as the file is shared.
  */
 enum kdbus_ioctl_type {
  *                             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_bus_make),
-       KDBUS_CMD_NS_MAKE =             _IOR (KDBUS_IOC_MAGIC, 0x10, struct kdbus_cmd_ns_make),
+       KDBUS_CMD_BUS_MAKE =            _IOW (KDBUS_IOC_MAGIC, 0x00, struct kdbus_cmd_make),
+       KDBUS_CMD_NS_MAKE =             _IOR (KDBUS_IOC_MAGIC, 0x10, struct kdbus_cmd_make),
+       KDBUS_CMD_EP_MAKE =             _IOW (KDBUS_IOC_MAGIC, 0x20, struct kdbus_cmd_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_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 *),
        KDBUS_CMD_FREE =                _IOW (KDBUS_IOC_MAGIC, 0x42, __u64 *),
 
        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_MSG_DROP =            _IO  (KDBUS_IOC_MAGIC, 0x43),
+       KDBUS_CMD_MSG_SRC =             _IOR (KDBUS_IOC_MAGIC, 0x44, __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_ACQUIRE =        _IOWR(KDBUS_IOC_MAGIC, 0x50, struct kdbus_cmd_name),
        KDBUS_CMD_NAME_RELEASE =        _IOW (KDBUS_IOC_MAGIC, 0x51, struct kdbus_cmd_name),


@@ -845,7 +823,8 @@ enum kdbus_ioctl_type {
  * @ENOTUNIQ:          A specific data type was addressed to a broadcast
  *                     address, but only direct addresses support this kind of
  *                     data.
  * @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.
+ * @ENXIO:             A unique address does not exist, or an offset in the
+ *                     receiver's pool does not represent a queued message.

  * @EPERM:             The policy prevented an operation. The requested
  *                     resource is owned by another entity.
  * @ESHUTDOWN:         A namespace or endpoint is currently shutting down;
  * @EPERM:             The policy prevented an operation. The requested
  *                     resource is owned by another entity.
  * @ESHUTDOWN:         A namespace or endpoint is currently shutting down;