* [PATCH v3] docs: update xenstore-migration.md
@ 2020-05-29 11:37 Juergen Gross
2020-05-29 11:48 ` Paul Durrant
2020-05-29 12:11 ` Julien Grall
0 siblings, 2 replies; 4+ messages in thread
From: Juergen Gross @ 2020-05-29 11:37 UTC (permalink / raw)
To: xen-devel
Cc: Juergen Gross, Stefano Stabellini, Julien Grall, Wei Liu,
Andrew Cooper, Ian Jackson, George Dunlap, Jan Beulich
Update connection record details:
- make flags common for sockets and domains (makes it easier to have a
C union for conn-spec)
- add pending incoming data (needed for handling partially read
requests when doing live update)
- add partial response length (needed for proper split to individual
responses after live update)
Signed-off-by: Juergen Gross <jgross@suse.com>
---
V2:
- added out-resp-len to connection record
V3:
- better commit message (Julien Grall)
- same sequence for fields and detailed descriptions (Julien Grall)
- some wording corrected (Paul Durrant)
Signed-off-by: Juergen Gross <jgross@suse.com>
---
docs/designs/xenstore-migration.md | 72 +++++++++++++++++-------------
1 file changed, 41 insertions(+), 31 deletions(-)
diff --git a/docs/designs/xenstore-migration.md b/docs/designs/xenstore-migration.md
index 34a2afd17e..2ce2c836f5 100644
--- a/docs/designs/xenstore-migration.md
+++ b/docs/designs/xenstore-migration.md
@@ -147,43 +147,60 @@ the domain being migrated.
```
0 1 2 3 4 5 6 7 octet
+-------+-------+-------+-------+-------+-------+-------+-------+
-| conn-id | conn-type | conn-spec
+| conn-id | conn-type | flags |
++-------------------------------+---------------+---------------+
+| conn-spec
...
-+-------------------------------+-------------------------------+
-| data-len | data
-+-------------------------------+
++---------------+---------------+-------------------------------+
+| in-data-len | out-resp-len | out-data-len |
++---------------+---------------+-------------------------------+
+| data
...
```
-| Field | Description |
-|-------------|-------------------------------------------------|
-| `conn-id` | A non-zero number used to identify this |
-| | connection in subsequent connection-specific |
-| | records |
-| | |
-| `conn-type` | 0x0000: shared ring |
-| | 0x0001: socket |
-| | 0x0002 - 0xFFFF: reserved for future use |
-| | |
-| `conn-spec` | See below |
-| | |
-| `data-len` | The length (in octets) of any pending data not |
-| | yet written to the connection |
-| | |
-| `data` | Pending data (may be empty) |
+| Field | Description |
+|----------------|----------------------------------------------|
+| `conn-id` | A non-zero number used to identify this |
+| | connection in subsequent connection-specific |
+| | records |
+| | |
+| `conn-type` | 0x0000: shared ring |
+| | 0x0001: socket |
+| | 0x0002 - 0xFFFF: reserved for future use |
+| | |
+| `flags` | A bit-wise OR of: |
+| | 0001: read-only |
+| | |
+| `conn-spec` | See below |
+| | |
+| `in-data-len` | The length (in octets) of any data read |
+| | from the connection not yet processed |
+| | |
+| `out-resp-len` | The length (in octets) of a partial response |
+| | not yet written to the connection |
+| | |
+| `out-data-len` | The length (in octets) of any pending data |
+| | not yet written to the connection, including |
+| | a partial response (see `out-resp-len`) |
+| | |
+| `data` | Pending data: first in-data-len octets of |
+| | read data, then out-data-len octets of |
+| | written data (any of both may be empty) |
-The format of `conn-spec` is dependent upon `conn-type`.
+In case of live update the connection record for the connection via which
+the live update command was issued will contain the response for the live
+update command in the pending not yet written data.
\pagebreak
+The format of `conn-spec` is dependent upon `conn-type`.
+
For `shared ring` connections it is as follows:
```
0 1 2 3 4 5 6 7 octet
- +-------+-------+
- | flags |
+---------------+---------------+---------------+---------------+
| domid | tdomid | evtchn |
+-------------------------------+-------------------------------+
@@ -198,8 +215,6 @@ For `shared ring` connections it is as follows:
| | it has been subject to an SET_TARGET |
| | operation [2] or DOMID_INVALID [3] otherwise |
| | |
-| `flags` | Must be zero |
-| | |
| `evtchn` | The port number of the interdomain channel used |
| | by `domid` to communicate with xenstored |
| | |
@@ -211,8 +226,6 @@ For `socket` connections it is as follows:
```
- +-------+-------+
- | flags |
+---------------+---------------+---------------+---------------+
| socket-fd | pad |
+-------------------------------+-------------------------------+
@@ -221,9 +234,6 @@ For `socket` connections it is as follows:
| Field | Description |
|-------------|-------------------------------------------------|
-| `flags` | A bit-wise OR of: |
-| | 0001: read-only |
-| | |
| `socket-fd` | The file descriptor of the connected socket |
This type of connection is only relevant for live update, where the xenstored
@@ -398,4 +408,4 @@ explanation of node permissions.
[3] See https://xenbits.xen.org/gitweb/?p=xen.git;a=blob;f=xen/include/public/xen.h;hb=HEAD#l612
-[4] https://wiki.xen.org/wiki/XenBus
\ No newline at end of file
+[4] https://wiki.xen.org/wiki/XenBus
--
2.26.2
^ permalink raw reply related [flat|nested] 4+ messages in thread
* RE: [PATCH v3] docs: update xenstore-migration.md
2020-05-29 11:37 [PATCH v3] docs: update xenstore-migration.md Juergen Gross
@ 2020-05-29 11:48 ` Paul Durrant
2020-05-29 16:00 ` Ian Jackson
2020-05-29 12:11 ` Julien Grall
1 sibling, 1 reply; 4+ messages in thread
From: Paul Durrant @ 2020-05-29 11:48 UTC (permalink / raw)
To: 'Juergen Gross', xen-devel
Cc: 'Stefano Stabellini', 'Julien Grall',
'Wei Liu', 'Andrew Cooper', 'Ian Jackson',
'George Dunlap', 'Jan Beulich'
> -----Original Message-----
> From: Xen-devel <xen-devel-bounces@lists.xenproject.org> On Behalf Of Juergen Gross
> Sent: 29 May 2020 12:37
> To: xen-devel@lists.xenproject.org
> Cc: Juergen Gross <jgross@suse.com>; Stefano Stabellini <sstabellini@kernel.org>; Julien Grall
> <julien@xen.org>; Wei Liu <wl@xen.org>; Andrew Cooper <andrew.cooper3@citrix.com>; Ian Jackson
> <ian.jackson@eu.citrix.com>; George Dunlap <george.dunlap@citrix.com>; Jan Beulich <jbeulich@suse.com>
> Subject: [PATCH v3] docs: update xenstore-migration.md
>
> Update connection record details:
>
> - make flags common for sockets and domains (makes it easier to have a
> C union for conn-spec)
> - add pending incoming data (needed for handling partially read
> requests when doing live update)
> - add partial response length (needed for proper split to individual
> responses after live update)
>
> Signed-off-by: Juergen Gross <jgross@suse.com>
LGTM
Reviewed-by: Paul Durrant <paul@xen.org>
> ---
> V2:
> - added out-resp-len to connection record
>
> V3:
> - better commit message (Julien Grall)
> - same sequence for fields and detailed descriptions (Julien Grall)
> - some wording corrected (Paul Durrant)
>
> Signed-off-by: Juergen Gross <jgross@suse.com>
> ---
> docs/designs/xenstore-migration.md | 72 +++++++++++++++++-------------
> 1 file changed, 41 insertions(+), 31 deletions(-)
>
> diff --git a/docs/designs/xenstore-migration.md b/docs/designs/xenstore-migration.md
> index 34a2afd17e..2ce2c836f5 100644
> --- a/docs/designs/xenstore-migration.md
> +++ b/docs/designs/xenstore-migration.md
> @@ -147,43 +147,60 @@ the domain being migrated.
> ```
> 0 1 2 3 4 5 6 7 octet
> +-------+-------+-------+-------+-------+-------+-------+-------+
> -| conn-id | conn-type | conn-spec
> +| conn-id | conn-type | flags |
> ++-------------------------------+---------------+---------------+
> +| conn-spec
> ...
> -+-------------------------------+-------------------------------+
> -| data-len | data
> -+-------------------------------+
> ++---------------+---------------+-------------------------------+
> +| in-data-len | out-resp-len | out-data-len |
> ++---------------+---------------+-------------------------------+
> +| data
> ...
> ```
>
>
> -| Field | Description |
> -|-------------|-------------------------------------------------|
> -| `conn-id` | A non-zero number used to identify this |
> -| | connection in subsequent connection-specific |
> -| | records |
> -| | |
> -| `conn-type` | 0x0000: shared ring |
> -| | 0x0001: socket |
> -| | 0x0002 - 0xFFFF: reserved for future use |
> -| | |
> -| `conn-spec` | See below |
> -| | |
> -| `data-len` | The length (in octets) of any pending data not |
> -| | yet written to the connection |
> -| | |
> -| `data` | Pending data (may be empty) |
> +| Field | Description |
> +|----------------|----------------------------------------------|
> +| `conn-id` | A non-zero number used to identify this |
> +| | connection in subsequent connection-specific |
> +| | records |
> +| | |
> +| `conn-type` | 0x0000: shared ring |
> +| | 0x0001: socket |
> +| | 0x0002 - 0xFFFF: reserved for future use |
> +| | |
> +| `flags` | A bit-wise OR of: |
> +| | 0001: read-only |
> +| | |
> +| `conn-spec` | See below |
> +| | |
> +| `in-data-len` | The length (in octets) of any data read |
> +| | from the connection not yet processed |
> +| | |
> +| `out-resp-len` | The length (in octets) of a partial response |
> +| | not yet written to the connection |
> +| | |
> +| `out-data-len` | The length (in octets) of any pending data |
> +| | not yet written to the connection, including |
> +| | a partial response (see `out-resp-len`) |
> +| | |
> +| `data` | Pending data: first in-data-len octets of |
> +| | read data, then out-data-len octets of |
> +| | written data (any of both may be empty) |
>
> -The format of `conn-spec` is dependent upon `conn-type`.
> +In case of live update the connection record for the connection via which
> +the live update command was issued will contain the response for the live
> +update command in the pending not yet written data.
>
> \pagebreak
>
> +The format of `conn-spec` is dependent upon `conn-type`.
> +
> For `shared ring` connections it is as follows:
>
>
> ```
> 0 1 2 3 4 5 6 7 octet
> - +-------+-------+
> - | flags |
> +---------------+---------------+---------------+---------------+
> | domid | tdomid | evtchn |
> +-------------------------------+-------------------------------+
> @@ -198,8 +215,6 @@ For `shared ring` connections it is as follows:
> | | it has been subject to an SET_TARGET |
> | | operation [2] or DOMID_INVALID [3] otherwise |
> | | |
> -| `flags` | Must be zero |
> -| | |
> | `evtchn` | The port number of the interdomain channel used |
> | | by `domid` to communicate with xenstored |
> | | |
> @@ -211,8 +226,6 @@ For `socket` connections it is as follows:
>
>
> ```
> - +-------+-------+
> - | flags |
> +---------------+---------------+---------------+---------------+
> | socket-fd | pad |
> +-------------------------------+-------------------------------+
> @@ -221,9 +234,6 @@ For `socket` connections it is as follows:
>
> | Field | Description |
> |-------------|-------------------------------------------------|
> -| `flags` | A bit-wise OR of: |
> -| | 0001: read-only |
> -| | |
> | `socket-fd` | The file descriptor of the connected socket |
>
> This type of connection is only relevant for live update, where the xenstored
> @@ -398,4 +408,4 @@ explanation of node permissions.
>
> [3] See https://xenbits.xen.org/gitweb/?p=xen.git;a=blob;f=xen/include/public/xen.h;hb=HEAD#l612
>
> -[4] https://wiki.xen.org/wiki/XenBus
> \ No newline at end of file
> +[4] https://wiki.xen.org/wiki/XenBus
> --
> 2.26.2
>
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [PATCH v3] docs: update xenstore-migration.md
2020-05-29 11:37 [PATCH v3] docs: update xenstore-migration.md Juergen Gross
2020-05-29 11:48 ` Paul Durrant
@ 2020-05-29 12:11 ` Julien Grall
1 sibling, 0 replies; 4+ messages in thread
From: Julien Grall @ 2020-05-29 12:11 UTC (permalink / raw)
To: xen-devel
Hi,
On 29/05/2020 12:37, Juergen Gross wrote:
> Update connection record details:
>
> - make flags common for sockets and domains (makes it easier to have a
> C union for conn-spec)
> - add pending incoming data (needed for handling partially read
> requests when doing live update)
> - add partial response length (needed for proper split to individual
> responses after live update)
>
> Signed-off-by: Juergen Gross <jgross@suse.com>
Acked-by: Julien Grall <jgrall@amazon.com>
Cheers,
> ---
> V2:
> - added out-resp-len to connection record
>
> V3:
> - better commit message (Julien Grall)
> - same sequence for fields and detailed descriptions (Julien Grall)
> - some wording corrected (Paul Durrant)
>
> Signed-off-by: Juergen Gross <jgross@suse.com>
> ---
> docs/designs/xenstore-migration.md | 72 +++++++++++++++++-------------
> 1 file changed, 41 insertions(+), 31 deletions(-)
>
> diff --git a/docs/designs/xenstore-migration.md b/docs/designs/xenstore-migration.md
> index 34a2afd17e..2ce2c836f5 100644
> --- a/docs/designs/xenstore-migration.md
> +++ b/docs/designs/xenstore-migration.md
> @@ -147,43 +147,60 @@ the domain being migrated.
> ```
> 0 1 2 3 4 5 6 7 octet
> +-------+-------+-------+-------+-------+-------+-------+-------+
> -| conn-id | conn-type | conn-spec
> +| conn-id | conn-type | flags |
> ++-------------------------------+---------------+---------------+
> +| conn-spec
> ...
> -+-------------------------------+-------------------------------+
> -| data-len | data
> -+-------------------------------+
> ++---------------+---------------+-------------------------------+
> +| in-data-len | out-resp-len | out-data-len |
> ++---------------+---------------+-------------------------------+
> +| data
> ...
> ```
>
>
> -| Field | Description |
> -|-------------|-------------------------------------------------|
> -| `conn-id` | A non-zero number used to identify this |
> -| | connection in subsequent connection-specific |
> -| | records |
> -| | |
> -| `conn-type` | 0x0000: shared ring |
> -| | 0x0001: socket |
> -| | 0x0002 - 0xFFFF: reserved for future use |
> -| | |
> -| `conn-spec` | See below |
> -| | |
> -| `data-len` | The length (in octets) of any pending data not |
> -| | yet written to the connection |
> -| | |
> -| `data` | Pending data (may be empty) |
> +| Field | Description |
> +|----------------|----------------------------------------------|
> +| `conn-id` | A non-zero number used to identify this |
> +| | connection in subsequent connection-specific |
> +| | records |
> +| | |
> +| `conn-type` | 0x0000: shared ring |
> +| | 0x0001: socket |
> +| | 0x0002 - 0xFFFF: reserved for future use |
> +| | |
> +| `flags` | A bit-wise OR of: |
> +| | 0001: read-only |
> +| | |
> +| `conn-spec` | See below |
> +| | |
> +| `in-data-len` | The length (in octets) of any data read |
> +| | from the connection not yet processed |
> +| | |
> +| `out-resp-len` | The length (in octets) of a partial response |
> +| | not yet written to the connection |
> +| | |
> +| `out-data-len` | The length (in octets) of any pending data |
> +| | not yet written to the connection, including |
> +| | a partial response (see `out-resp-len`) |
> +| | |
> +| `data` | Pending data: first in-data-len octets of |
> +| | read data, then out-data-len octets of |
> +| | written data (any of both may be empty) |
>
> -The format of `conn-spec` is dependent upon `conn-type`.
> +In case of live update the connection record for the connection via which
> +the live update command was issued will contain the response for the live
> +update command in the pending not yet written data.
>
> \pagebreak
>
> +The format of `conn-spec` is dependent upon `conn-type`.
> +
> For `shared ring` connections it is as follows:
>
>
> ```
> 0 1 2 3 4 5 6 7 octet
> - +-------+-------+
> - | flags |
> +---------------+---------------+---------------+---------------+
> | domid | tdomid | evtchn |
> +-------------------------------+-------------------------------+
> @@ -198,8 +215,6 @@ For `shared ring` connections it is as follows:
> | | it has been subject to an SET_TARGET |
> | | operation [2] or DOMID_INVALID [3] otherwise |
> | | |
> -| `flags` | Must be zero |
> -| | |
> | `evtchn` | The port number of the interdomain channel used |
> | | by `domid` to communicate with xenstored |
> | | |
> @@ -211,8 +226,6 @@ For `socket` connections it is as follows:
>
>
> ```
> - +-------+-------+
> - | flags |
> +---------------+---------------+---------------+---------------+
> | socket-fd | pad |
> +-------------------------------+-------------------------------+
> @@ -221,9 +234,6 @@ For `socket` connections it is as follows:
>
> | Field | Description |
> |-------------|-------------------------------------------------|
> -| `flags` | A bit-wise OR of: |
> -| | 0001: read-only |
> -| | |
> | `socket-fd` | The file descriptor of the connected socket |
>
> This type of connection is only relevant for live update, where the xenstored
> @@ -398,4 +408,4 @@ explanation of node permissions.
>
> [3] See https://xenbits.xen.org/gitweb/?p=xen.git;a=blob;f=xen/include/public/xen.h;hb=HEAD#l612
>
> -[4] https://wiki.xen.org/wiki/XenBus
> \ No newline at end of file
> +[4] https://wiki.xen.org/wiki/XenBus
>
--
Julien Grall
^ permalink raw reply [flat|nested] 4+ messages in thread
* RE: [PATCH v3] docs: update xenstore-migration.md
2020-05-29 11:48 ` Paul Durrant
@ 2020-05-29 16:00 ` Ian Jackson
0 siblings, 0 replies; 4+ messages in thread
From: Ian Jackson @ 2020-05-29 16:00 UTC (permalink / raw)
To: paul@xen.org
Cc: 'Juergen Gross', 'Stefano Stabellini',
'Julien Grall', 'Wei Liu', Andrew Cooper,
George Dunlap, 'Jan Beulich', Ian Jackson,
xen-devel@lists.xenproject.org
Paul Durrant writes ("RE: [PATCH v3] docs: update xenstore-migration.md"):
> > -----Original Message-----
> > From: Xen-devel <xen-devel-bounces@lists.xenproject.org> On Behalf Of Juergen Gross
> > Sent: 29 May 2020 12:37
> > To: xen-devel@lists.xenproject.org
> > Cc: Juergen Gross <jgross@suse.com>; Stefano Stabellini <sstabellini@kernel.org>; Julien Grall
> > <julien@xen.org>; Wei Liu <wl@xen.org>; Andrew Cooper <andrew.cooper3@citrix.com>; Ian Jackson
> > <ian.jackson@eu.citrix.com>; George Dunlap <george.dunlap@citrix.com>; Jan Beulich <jbeulich@suse.com>
> > Subject: [PATCH v3] docs: update xenstore-migration.md
> >
> > Update connection record details:
> >
> > - make flags common for sockets and domains (makes it easier to have a
> > C union for conn-spec)
> > - add pending incoming data (needed for handling partially read
> > requests when doing live update)
> > - add partial response length (needed for proper split to individual
> > responses after live update)
> >
> > Signed-off-by: Juergen Gross <jgross@suse.com>
>
> LGTM
>
> Reviewed-by: Paul Durrant <paul@xen.org>
Thanks, committed.
Ian.
^ permalink raw reply [flat|nested] 4+ messages in thread
end of thread, other threads:[~2020-05-29 16:01 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2020-05-29 11:37 [PATCH v3] docs: update xenstore-migration.md Juergen Gross
2020-05-29 11:48 ` Paul Durrant
2020-05-29 16:00 ` Ian Jackson
2020-05-29 12:11 ` Julien Grall
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.