chiark / gitweb /
rtnl: clean up/add asserts
[elogind.git] / src / libsystemd-bus / kdbus.h
index d53c269573d1e6bb61469ed6f7867c8ab7281a8a..1ab72518a98cea02c02094554ee9468336a975fe 100644 (file)
  * struct kdbus_notify_name_change - name registry change message
  * @old_id:            Former owner of a name
  * @new_id:            New owner of a name
- * @flags:             flags from KDBUS_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
  *
- * Sent from kernel to userspace when the owner or starter of
+ * Sent from kernel to userspace when the owner or activator of
  * a well-known name changes.
  *
  * Attached to:
@@ -44,7 +45,8 @@
 struct kdbus_notify_name_change {
        __u64 old_id;
        __u64 new_id;
-       __u64 flags;
+       __u64 old_flags;
+       __u64 new_flags;
        char name[0];
 };
 
@@ -53,7 +55,7 @@ struct kdbus_notify_name_change {
  * @id:                        New or former owner of the name
  * @flags:             flags field from KDBUS_HELLO_*
  *
- * Sent from kernel to userspace when the owner or starter of
+ * Sent from kernel to userspace when the owner or activator of
  * a well-known name changes.
  *
  * Attached to:
@@ -205,7 +207,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_STARTER_NAME:   Well-known name for the starter
+ * @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
@@ -242,7 +244,7 @@ enum kdbus_item_type {
 
        _KDBUS_ITEM_ATTACH_BASE = 0x600,
        KDBUS_ITEM_NAME         = _KDBUS_ITEM_ATTACH_BASE,
-       KDBUS_ITEM_STARTER_NAME,
+       KDBUS_ITEM_ACTIVATOR_NAME,
        KDBUS_ITEM_TIMESTAMP,
        KDBUS_ITEM_CREDS,
        KDBUS_ITEM_PID_COMM,
@@ -344,7 +346,17 @@ enum kdbus_payload_type {
  * @cookie_reply:      For kernel-generated messages, this is the cookie
  *                     the message is a reply to
  * @timeout_ns:                For non-kernel-generated messages, this denotes the
- *                     message timeout in nanoseconds
+ *                     message timeout in nanoseconds. A message has to be
+ *                     received with KDBUS_CMD_MSG_RECV by the destination
+ *                     connection within this time frame. For messages that
+ *                     have KDBUS_MSG_FLAGS_EXPECT_REPLY set in @flags,
+ *                     this value also denotes the timeout for the reply to
+ *                     this message. If there is no reply, or the message is
+ *                     not received in time by the other side, a
+ *                     kernel-generated message with an attached
+ *                     KDBUS_ITEM_REPLY_TIMEOUT item is sent to @src_id.
+ *                     A 0-value is only valid if KDBUS_MSG_FLAGS_EXPECT_REPLY
+ *                     is unset in @flags.
  * @items:             A list of kdbus_items containing the message payload
  */
 struct kdbus_msg {
@@ -402,14 +414,18 @@ struct kdbus_cmd_policy {
 
 /**
  * enum kdbus_hello_flags - flags for struct kdbus_cmd_hello
- * @KDBUS_HELLO_STARTER:               The connection registers a name for activation
- *                             by well-know name
  * @KDBUS_HELLO_ACCEPT_FD:     The connection allows the receiving of
  *                             any passed file descriptors
+ * @KDBUS_HELLO_ACTIVATOR:     Special-purpose connection which registers
+ *                             a well-know name for a process to be started
+ *                             when traffic arrives
+ * @KDBUS_HELLO_MONITOR:       Special-purpose connection to monitor
+ *                             bus traffic
  */
 enum kdbus_hello_flags {
-       KDBUS_HELLO_STARTER             =  1 <<  0,
-       KDBUS_HELLO_ACCEPT_FD           =  1 <<  1,
+       KDBUS_HELLO_ACCEPT_FD           =  1 <<  0,
+       KDBUS_HELLO_ACTIVATOR           =  1 <<  1,
+       KDBUS_HELLO_MONITOR             =  1 <<  2,
 };
 
 /**
@@ -527,18 +543,17 @@ struct kdbus_cmd_ns_make {
 /**
  * enum kdbus_name_flags - properties of a well-known name
  * @KDBUS_NAME_REPLACE_EXISTING:       Try to replace name of other connections
- * @KDBUS_NAME_QUEUE:                  Name should be queued if busy
  * @KDBUS_NAME_ALLOW_REPLACEMENT:      Allow the replacement of the name
+ * @KDBUS_NAME_QUEUE:                  Name should be queued if busy
  * @KDBUS_NAME_IN_QUEUE:               Name is queued
+ * @KDBUS_NAME_ACTIVATOR:              Name is owned by a activator connection
  */
 enum kdbus_name_flags {
-       /* userspace → kernel */
        KDBUS_NAME_REPLACE_EXISTING             = 1 <<  0,
-       KDBUS_NAME_QUEUE                        = 1 <<  1,
-       KDBUS_NAME_ALLOW_REPLACEMENT            = 1 <<  2,
-
-       /* kernel → userspace */
-       KDBUS_NAME_IN_QUEUE                     = 1 << 16,
+       KDBUS_NAME_ALLOW_REPLACEMENT            = 1 <<  1,
+       KDBUS_NAME_QUEUE                        = 1 <<  2,
+       KDBUS_NAME_IN_QUEUE                     = 1 <<  3,
+       KDBUS_NAME_ACTIVATOR                    = 1 <<  4,
 };
 
 /**
@@ -564,13 +579,13 @@ struct kdbus_cmd_name {
  * enum kdbus_name_list_flags - what to include into the returned list
  * @KDBUS_NAME_LIST_UNIQUE:    All active connections
  * @KDBUS_NAME_LIST_NAMES:     All known well-known names
- * @KDBUS_NAME_LIST_STARTERS:  All connections which are starter connections
+ * @KDBUS_NAME_LIST_ACTIVATORS:        All activator connections
  * @KDBUS_NAME_LIST_QUEUED:    All queued-up names
  */
 enum kdbus_name_list_flags {
        KDBUS_NAME_LIST_UNIQUE          = 1 <<  0,
        KDBUS_NAME_LIST_NAMES           = 1 <<  1,
-       KDBUS_NAME_LIST_STARTERS        = 1 <<  2,
+       KDBUS_NAME_LIST_ACTIVATORS      = 1 <<  2,
        KDBUS_NAME_LIST_QUEUED          = 1 <<  3,
 };
 
@@ -609,7 +624,7 @@ struct kdbus_name_list {
  *                     @name is required. kdbus will look up the name to determine
  *                     the ID in this case.
  * @offset:            Returned offset in the caller's pool buffer where the
- *                     kdbus_name_info struct result is stored. The user must
+ *                     kdbus_conn_info struct result is stored. The user must
  *                     use KDBUS_CMD_FREE to free the allocated memory.
  * @name:              The optional well-known name to look up. Only needed in
  *                     case @id is zero.
@@ -687,27 +702,6 @@ struct kdbus_cmd_match {
        struct kdbus_item items[0];
 };
 
-/**
- * enum kdbus_monitor_flags - flags for monitoring
- * @KDBUS_MONITOR_ENABLE:      Enable monitoring
- */
-enum kdbus_monitor_flags {
-       KDBUS_MONITOR_ENABLE            = 1 <<  0,
-};
-
-/**
- * struct kdbus_cmd_monitor - struct to enable or disable eavesdropping
- * @id:                        Privileged users may enable or disable the monitor feature
- *                     on behalf of other peers
- * @flags:             Use KDBUS_MONITOR_ENABLE to enable eavesdropping
- *
- * This structure is used with the KDBUS_CMD_MONITOR ioctl.
- */
-struct kdbus_cmd_monitor {
-       __u64 id;
-       __u64 flags;
-};
-
 /**
  * enum kdbus_ioctl_type - Ioctl API
  * @KDBUS_CMD_BUS_MAKE:                After opening the "control" device node, this
@@ -745,9 +739,6 @@ struct kdbus_cmd_monitor {
  * @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_MONITOR:         Monitor the bus and receive all transmitted
- *                             messages. Privileges are required for this
- *                             operation.
  * @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.
@@ -797,7 +788,6 @@ enum kdbus_ioctl_type {
 
        KDBUS_CMD_MATCH_ADD =           _IOW (KDBUS_IOC_MAGIC, 0x70, struct kdbus_cmd_match),
        KDBUS_CMD_MATCH_REMOVE =        _IOW (KDBUS_IOC_MAGIC, 0x71, struct kdbus_cmd_match),
-       KDBUS_CMD_MONITOR =             _IOW (KDBUS_IOC_MAGIC, 0x72, struct kdbus_cmd_monitor),
 
        KDBUS_CMD_EP_POLICY_SET =       _IOW (KDBUS_IOC_MAGIC, 0x80, struct kdbus_cmd_policy),
 
@@ -820,6 +810,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.
+ * @ECONNRESET:                A connection is shut down, no further operations are
+ *                     possible.
  * @ECOMM:             A peer does not accept the file descriptors addressed
  *                     to it.
  * @EDESTADDRREQ:      The well-known bus name is required but missing.
@@ -856,8 +848,8 @@ enum kdbus_ioctl_type {
  * @ENXIO:             A unique address does not exist.
  * @EPERM:             The policy prevented an operation. The requested
  *                     resource is owned by another entity.
- * @ESHUTDOWN:         The connection is currently shutting down, no further
- *                     operations are possible.
+ * @ESHUTDOWN:         A namespace or endpoint is currently shutting down;
+ *                     no further operations will be possible.
  * @ESRCH:             A requested well-known bus name is not found.
  * @ETXTBSY:           A kdbus memfd file cannot be sealed or the seal removed,
  *                     because it is shared with other processes or still