X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=blobdiff_plain;f=src%2Flibsystemd-bus%2Fkdbus.h;h=168d08a3ec1d20c220898df3dbbe705633880925;hb=d78bf250b0e31b42eb8b86ebe3ee775b247bfcf8;hp=1138c010be6823b58fbe7c4edbaee26744c3f41a;hpb=4ccbc1461566f97445241524be379b94855608fa;p=elogind.git

diff --git a/src/libsystemd-bus/kdbus.h b/src/libsystemd-bus/kdbus.h
index 1138c010b..168d08a3e 100644
--- a/src/libsystemd-bus/kdbus.h
+++ b/src/libsystemd-bus/kdbus.h
@@ -30,7 +30,8 @@
  * 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
@@ -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];
 };
 
@@ -194,7 +196,7 @@ struct kdbus_policy {
 
 /**
  * enum kdbus_item_type - item types to chain data in a list
- * @KDBUS_ITEM_PAYLOAD_VEC:	Vevtor to data
+ * @KDBUS_ITEM_PAYLOAD_VEC:	Vector to data
  * @KDBUS_ITEM_PAYLOAD_OFF:	Data at returned offset in the pool
  * @KDBUS_ITEM_PAYLOAD_MEMFD:	Data as sealed memfd
  * @KDBUS_ITEM_FDS:		Attached file descriptors
@@ -222,7 +224,7 @@ struct kdbus_policy {
  * @KDBUS_ITEM_ID_ADD:		Notify in struct kdbus_notify_id_change
  * @KDBUS_ITEM_ID_REMOVE:	Notify in struct kdbus_notify_id_change
  * @KDBUS_ITEM_REPLY_TIMEOUT:	Timeout has been reached
- * @KDBUS_ITEM_REPLY_DEAD:	Destiantion died
+ * @KDBUS_ITEM_REPLY_DEAD:	Destination died
  */
 enum kdbus_item_type {
 	_KDBUS_ITEM_NULL,
@@ -326,13 +328,11 @@ enum kdbus_msg_flags {
 /**
  * enum kdbus_payload_type - type of payload carried by message
  * @KDBUS_PAYLOAD_KERNEL:	Kernel-generated simple message
- * @KDBUS_PAYLOAD_DBUS1:	Legacy D-Bus version 1 marshalling
- * @KDBUS_PAYLOAD_GVARIANT:	GVariant marshalling
+ * @KDBUS_PAYLOAD_DBUS:	        D-Bus marshalling
  */
 enum kdbus_payload_type {
 	KDBUS_PAYLOAD_KERNEL,
-	KDBUS_PAYLOAD_DBUS1	= 0x4442757356657231ULL, /* 'DBusVer1' */
-	KDBUS_PAYLOAD_GVARIANT	= 0x4756617269616e74ULL, /* 'GVariant' */
+	KDBUS_PAYLOAD_DBUS	= 0x4442757344427573ULL, /* 'DBusDBus' */
 };
 
 /**
@@ -366,7 +366,7 @@ struct kdbus_msg {
 /**
  * enum kdbus_policy_access_type - permissions of a policy record
  * @KDBUS_POLICY_ACCESS_USER:	Grant access to a uid
- * @KDBUS_POLICY_ACCESS_GROUP:	Grant acces to gid
+ * @KDBUS_POLICY_ACCESS_GROUP:	Grant access to gid
  * @KDBUS_POLICY_ACCESS_WORLD:	World-accessible
  */
 enum kdbus_policy_access_type {
@@ -393,7 +393,7 @@ enum kdbus_policy_type {
  * @size:		The total size of the structure
  * @policies:		The policies to upload
  *
- * A KDBUS_POLICY_NAME must always preceed a KDBUS_POLICY_ACCESS entry.
+ * A KDBUS_POLICY_NAME must always preceeds a KDBUS_POLICY_ACCESS entry.
  * A new KDBUS_POLICY_NAME can be added after KDBUS_POLICY_ACCESS for
  * chaining multiple policies together.
  */
@@ -445,7 +445,7 @@ enum kdbus_attach_flags {
  * @size:		The total size of the structure
  * @conn_flags:		Connection flags (KDBUS_HELLO_*). The kernel will
  * 			return its capabilities in that field.
- * @attach_flags:	Mask of metdata to attach to each message sent
+ * @attach_flags:	Mask of metadata to attach to each message sent
  * 			(KDBUS_ATTACH_*)
  * @bus_flags:		The flags field copied verbatim from the original
  * 			KDBUS_CMD_BUS_MAKE ioctl. It's intended to be useful
@@ -463,18 +463,13 @@ enum kdbus_attach_flags {
  */
 struct kdbus_cmd_hello {
 	__u64 size;
-
-	/* userspace → kernel, kernel → userspace */
 	__u64 conn_flags;
 	__u64 attach_flags;
-
-	/* kernel → userspace */
 	__u64 bus_flags;
 	__u64 id;
 	__u64 bloom_size;
 	__u64 pool_size;
 	__u8 id128[16];
-
 	struct kdbus_item items[0];
 };
 
@@ -492,8 +487,7 @@ enum kdbus_make_flags {
  * @bloom_size:		Size of the bloom filter for this bus
  * @items:		Items describing details such as the name of the bus
  *
- * This structure is used with the KDBUS_CMD_BUS_MAKE ioctl. Refer to the
- * documentation for more information.
+ * This structure is used with the KDBUS_CMD_BUS_MAKE ioctl.
  */
 struct kdbus_cmd_bus_make {
 	__u64 size;
@@ -509,8 +503,7 @@ struct kdbus_cmd_bus_make {
  * @items:		Items describing details such as the
  * 			name of the endpoint
  *
- * This structure is used with the KDBUS_CMD_EP_MAKE ioctl. Refer to the
- * documentation for more information.
+ * This structure is used with the KDBUS_CMD_EP_MAKE ioctl.
  */
 struct kdbus_cmd_ep_make {
 	__u64 size;
@@ -525,8 +518,7 @@ struct kdbus_cmd_ep_make {
  * @items:		Items describing details such as the
  * 			name of the namespace
  *
- * This structure is used with the KDBUS_CMD_NS_MAKE ioctl. Refer to the
- * documentation for more information.
+ * This structure is used with the KDBUS_CMD_NS_MAKE ioctl.
  */
 struct kdbus_cmd_ns_make {
 	__u64 size;
@@ -537,31 +529,29 @@ 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_STARTER:			Name is owned by a starter 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_STARTER			= 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:			Priviledged users may use this field to (de)register
+ * @id:			Privileged users may use this field to (de)register
  * 			names on behalf of other peers.
  * @conn_flags:		The flags of the owning connection (KDBUS_HELLO_*)
  * @name:		The well-known name
  *
  * This structure is used with the KDBUS_CMD_NAME_ACQUIRE ioctl.
- * Refer to the documentation for more information.
  */
 struct kdbus_cmd_name {
 	__u64 size;
@@ -620,7 +610,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.
@@ -688,8 +678,7 @@ enum kdbus_match_type {
  * @items:		A list of items for additional information
  *
  * This structure is used with the KDBUS_CMD_ADD_MATCH and
- * KDBUS_CMD_REMOVE_MATCH ioctl. Refer to the documentation for more
- * information.
+ * KDBUS_CMD_REMOVE_MATCH ioctl.
  */
 struct kdbus_cmd_match {
 	__u64 size;
@@ -709,12 +698,11 @@ enum kdbus_monitor_flags {
 
 /**
  * struct kdbus_cmd_monitor - struct to enable or disable eavesdropping
- * @id:			Priviledged users may enable or disable the monitor feature
+ * @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.
- * Refer to the documentation for more information.
  */
 struct kdbus_cmd_monitor {
 	__u64 id;
@@ -753,7 +741,7 @@ struct kdbus_cmd_monitor {
  * @KDBUS_CMD_CONN_INFO:	Retrieve credentials and properties of the
  * 				initial creator of the connection. The data was
  * 				stored at registration time and does not
- * 				neccessarily represent the connected process or
+ * 				necessarily represent the connected process or
  * 				the actual state of the process.
  * @KDBUS_CMD_MATCH_ADD:	Install a match which broadcast messages should
  * 				be delivered to the connection.
@@ -824,6 +812,8 @@ enum kdbus_ioctl_type {
 /*
  * errno - api error codes
  * @E2BIG:		A message contains too many records or items.
+ * @EADDRINUSE:		A well-known bus name is already taken by another
+ * 			connection.
  * @EADDRNOTAVAIL:	A message flagged not to activate a service, addressed
  * 			a service which is not currently running.
  * @EAGAIN:		No messages are queued at the moment.
@@ -831,8 +821,6 @@ 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:		A well-known bus name is already taken by another
- * 			connection.
  * @ECOMM:		A peer does not accept the file descriptors addressed
  * 			to it.
  * @EDESTADDRREQ:	The well-known bus name is required but missing.
@@ -861,7 +849,7 @@ enum kdbus_ioctl_type {
  * @ENOSYS:		The requested functionality is not available.
  * @ENOTCONN:		The addressed peer is not an active connection.
  * @ENOTSUPP:		The feature negotiation failed, a not supported feature
- * 			was requested.
+ * 			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