docs: retrospectively add XS_DIRECTORY_PART to the xenstore protocol...
PATCH 1/1 docs: retrospectively add XS_DIRECTORY_PART to the xenstore protocol...
... specification.
This was added by commit 0ca64ed8 "xenstore: add support for reading directory with many children" but not added to the specification at that point. A version of xenstored supporting the command was first released in Xen 4.9.
---
Cc: Juergen Gross <[email protected]>
Cc: Andrew Cooper <[email protected]>
Cc: George Dunlap <[email protected]>
Cc: Ian Jackson <[email protected]>
Cc: Jan Beulich <[email protected]>
Cc: Julien Grall <[email protected]>
Cc: Konrad Rzeszutek Wilk <[email protected]>
Cc: Stefano Stabellini <[email protected]>
Cc: Wei Liu <[email protected]>
--- docs/misc/xenstore.txt | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-)
docs/misc/xenstore.txt +11 -2
@@ -125,8 +125,9 @@ Values commonly included in payloads include: -The following are the actual type values, including the request and -reply payloads as applicable: +The following are the actual type values defined in io/xs_wire.h +(omitting the XS_ prefix), including the request and reply payloads +as applicable: ---------- Database read, write and permissions operations ----------
@@ -152,6 +153,14 @@ DIRECTORY <path>| <child-leaf-name>|* leafnames. The resulting children are each named <path>/<child-leaf-name>. +DIRECTORY_PART <path>|<index|> <child-leaf-name>|* + Performs the same function as DIRECTORY, but returns a + sub-list of children starting at <index> in the overall + child list and less than or equal to XENSTORE_PAYLOAD_MAX + octets in length. If <index> is beyond the end of the + overall child list then the returned sub-list will be + empty. + GET_PERMS <path>| <perm-as-string>|+ SET_PERMS <path>|<perm-as-string>|+? <perm-as-string> is one of the following
Signature · 7 lines
2.20.1 _______________________________________________ Xen-devel mailing list [email protected] https://lists.xenproject.org/mailman/listinfo/xen-devel
Quoted 40 lines · Paul Durrant
... specification.
This was added by commit
0ca64ed8"xenstore: add support for reading directory with many children" but not added to the specification at that point. A version of xenstored supporting the command was first released in Xen 4.9.Signed-off-by Paul Durrant <[email protected]>---
Cc: Juergen Gross <[email protected]>
Cc: Andrew Cooper <[email protected]>
Cc: George Dunlap <[email protected]>
Cc: Ian Jackson <[email protected]>
Cc: Jan Beulich <[email protected]>
Cc: Julien Grall <[email protected]>
Cc: Konrad Rzeszutek Wilk <[email protected]>
Cc: Stefano Stabellini <[email protected]>
Cc: Wei Liu <[email protected]>--- docs/misc/xenstore.txt | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-)docs/misc/xenstore.txt +3
-2@@ -125,8 +125,9 @@ Values commonly included in payloads include: -The following are the actual type values, including the request and -reply payloads as applicable: +The following are the actual type values defined in io/xs_wire.h +(omitting the XS_ prefix), including the request and reply payloads +as applicable: ---------- Database read, write and permissions operations ----------@@ -152,6 +153,14 @@ DIRECTORY <path>| <child-leaf-name>|* leafnames. The resulting children are each named
docs/misc/xenstore.txt DIRECTORY <path>| <child-leaf-name>|* · line 163
Quoted 10 lines
docs/misc/xenstore.txt +8
-0<path>/<child-leaf-name>. +DIRECTORY_PART <path>|<index|> <child-leaf-name>|* + Performs the same function as DIRECTORY, but returns a + sub-list of children starting at <index> in the overall + child list and less than or equal to XENSTORE_PAYLOAD_MAX + octets in length. If <index> is beyond the end of the + overall child list then the returned sub-list will be + empty. +
Hmm, not quite.
I did send this some years ago:
https://lists.xen.org/archives/html/xen-devel/2017-05/msg00650.html
Ian wanted to suggest something better, but he never did.
Juergen
_______________________________________________
Xen-devel mailing list
[email protected]
https://lists.xenproject.org/mailman/listinfo/xen-devel
Paul Durrant writes ("[PATCH] docs: retrospectively add XS_DIRECTORY_PART to the xenstore protocol..."):
Quoted 6 lines
... specification.
This was added by commit
0ca64ed8"xenstore: add support for reading directory with many children" but not added to the specification at that point. A version of xenstored supporting the command was first released in Xen 4.9.
Thanks for documenting this. A docs fix like this should be backported if it applies, IMO.
Backport: 4.9+
I will commit it to staging momentarily.
docs/misc/xenstore.txt DIRECTORY <path>| <child-leaf-name>|* · line 162
Quoted 7 lines
docs/misc/xenstore.txt +7
-0+DIRECTORY_PART <path>|<index|> <child-leaf-name>|* + Performs the same function as DIRECTORY, but returns a + sub-list of children starting at <index> in the overall + child list and less than or equal to XENSTORE_PAYLOAD_MAX + octets in length. If <index> is beyond the end of the + overall child list then the returned sub-list will be + empty.
I wonder if it should be somehow made more explicit that `index' is a count of directory entries, not bytes. Maybe this is obvious.
Ian.
_______________________________________________
Xen-devel mailing list
[email protected]
https://lists.xenproject.org/mailman/listinfo/xen-devel
Quoted 16 lines · Ian Jackson
Paul Durrant writes ("[PATCH] docs: retrospectively add
XS_DIRECTORY_PARTto the xenstore protocol..."):Quoted 6 lines
... specification.
This was added by commit
0ca64ed8"xenstore: add support for reading directory with many children" but not added to the specification at that point. A version of xenstored supporting the command was first released in Xen 4.9.Thanks for documenting this. A docs fix like this should be backported if it applies, IMO.
Acked-by Ian Jackson <[email protected]>Backport: 4.9+
I will commit it to staging momentarily.
Quoted 10 lines
docs/misc/xenstore.txt DIRECTORY <path>| <child-leaf-name>|* · line 162
Quoted 7 lines
docs/misc/xenstore.txt +7
-0+DIRECTORY_PART <path>|<index|> <child-leaf-name>|* + Performs the same function as DIRECTORY, but returns a + sub-list of children starting at <index> in the overall + child list and less than or equal to XENSTORE_PAYLOAD_MAX + octets in length. If <index> is beyond the end of the + overall child list then the returned sub-list will be + empty.I wonder if it should be somehow made more explicit that `index' is a count of directory entries, not bytes. Maybe this is obvious.
But this is wrong. It is bytes, and the generation count returned is missing (see my original patch back in 2017).
Juergen
_______________________________________________
Xen-devel mailing list
[email protected]
https://lists.xenproject.org/mailman/listinfo/xen-devel
Jürgen Groß writes ("Re: [PATCH] docs: retrospectively add XS_DIRECTORY_PART to the xenstore protocol..."):
Quoted 28 lines · Ian Jackson
Quoted 16 lines
Paul Durrant writes ("[PATCH] docs: retrospectively add
XS_DIRECTORY_PARTto the xenstore protocol..."):Quoted 6 lines
... specification.
This was added by commit
0ca64ed8"xenstore: add support for reading directory with many children" but not added to the specification at that point. A version of xenstored supporting the command was first released in Xen 4.9.Thanks for documenting this. A docs fix like this should be backported if it applies, IMO.
Acked-by Ian Jackson <[email protected]>Backport: 4.9+
I will commit it to staging momentarily.
Quoted 10 lines
docs/misc/xenstore.txt DIRECTORY <path>| <child-leaf-name>|* · line 162
Quoted 7 lines
docs/misc/xenstore.txt +7
-0+DIRECTORY_PART <path>|<index|> <child-leaf-name>|* + Performs the same function as DIRECTORY, but returns a + sub-list of children starting at <index> in the overall + child list and less than or equal to XENSTORE_PAYLOAD_MAX + octets in length. If <index> is beyond the end of the + overall child list then the returned sub-list will be + empty.I wonder if it should be somehow made more explicit that `index' is a count of directory entries, not bytes. Maybe this is obvious.
Quoted 2 lines
But this is wrong. It is bytes, and the generation count returned is missing (see my original patch back in 2017).
Sorry for being too quick. I have reverted my commit.
Ian.
_______________________________________________
Xen-devel mailing list
[email protected]
https://lists.xenproject.org/mailman/listinfo/xen-devel
Quoted 43 lines
-----Original Message-----
From: Ian Jackson [mailto:[email protected]]
Sent: 27 January 2020 15:49
To: Jürgen Groß <[email protected]>
Cc: Durrant, Paul <[email protected]>; [email protected]; Andrew Cooper <[email protected]>; George Dunlap <[email protected]>; Jan Beulich <[email protected]>; Julien Grall <[email protected]>; Konrad Rzeszutek Wilk <[email protected]>; Stefano Stabellini <[email protected]>; Wei Liu <[email protected]>
Subject: Re: [PATCH] docs: retrospectively addXS_DIRECTORY_PARTto the xenstore protocol...Jürgen Groß writes ("Re: [PATCH] docs: retrospectively add
XS_DIRECTORY_PARTto the xenstore protocol..."):Quoted 2 lines · Ian Jackson
Quoted 1 line
Paul Durrant writes ("[PATCH] docs: retrospectively add
XS_DIRECTORY_PARTto the xenstore protocol..."):Quoted 26 lines
Quoted 25 lines
Quoted 6 lines
... specification.
This was added by commit
0ca64ed8"xenstore: add support for reading directory with many children" but not added to the specification at that point. A version of xenstored supporting the command was first released in Xen 4.9.Thanks for documenting this. A docs fix like this should be backported if it applies, IMO.
Acked-by Ian Jackson <[email protected]>Backport: 4.9+
I will commit it to staging momentarily.
docs/misc/xenstore.txt DIRECTORY <path>| <child-leaf-name>|* · line 162
Quoted 7 lines
docs/misc/xenstore.txt +7
-0+DIRECTORY_PART <path>|<index|> <child-leaf-name>|* + Performs the same function as DIRECTORY, but returns a + sub-list of children starting at <index> in the overall + child list and less than or equal to XENSTORE_PAYLOAD_MAX + octets in length. If <index> is beyond the end of the + overall child list then the returned sub-list will be + empty.I wonder if it should be somehow made more explicit that `index' is a count of directory entries, not bytes. Maybe this is obvious.
Quoted 5 lines
Quoted 2 lines
But this is wrong. It is bytes, and the generation count returned is missing (see my original patch back in 2017).
Sorry for being too quick. I have reverted my commit.
Since I got it wrong, I suggest just taking Juergen's original text (which I was unaware of before). It seems ok to me.
Paul
Quoted 1 line
Ian.
_______________________________________________
Xen-devel mailing list
[email protected]
https://lists.xenproject.org/mailman/listinfo/xen-devel