Skip to contentSkip to conversation

docs: correct "gnttab=" documented default

PATCH Superseded Jan Beulich 2 participants 4 messages Feb 28, 2022

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 docs: correct "gnttab=" documented default

Defaults differ for Arm and x86, not the least because of v2 not even being security supported on Arm.

Also drop a bogus sentence from gnttab_max_maptrack_frames, which was presumably mistakenly cloned from gnttab_max_frames (albeit even there what is being said is neither very precise nor very useful imo).

docs/misc/xen-command-line.pandoc +2 -3
@@ -1177,7 +1177,8 @@ Specify which console gdbstub should use
 ### gnttab
 > `= List of [ max-ver:<integer>, transitive=<bool>, transfer=<bool> ]`
 
-> Default: `gnttab=max-ver:2,transitive,transfer`
+> Default (Arm): `gnttab=max-ver:1`
+> Default (x86): `gnttab=max-ver:2,transitive,transfer`
 
 Control various aspects of the grant table behaviour available to guests.
 
@@ -1217,8 +1218,6 @@ Specify the maximum number of frames to
 maptrack array. This value is an upper boundary of the per-domain
 value settable via Xen tools.
 
-Dom0 is using this value for sizing its maptrack table.
-
 ### global-pages
     = <boolean>
 
#1 lore raw

Hi Jan,

Quoted 12 lines · Jan Beulich

Defaults differ for Arm and x86, not the least because of v2 not even being security supported on Arm.

Also drop a bogus sentence from gnttab_max_maptrack_frames, which was presumably mistakenly cloned from gnttab_max_frames (albeit even there what is being said is neither very precise nor very useful imo).

docs/misc/xen-command-line.pandoc Specify which console gdbstub should use · line 1181

Quoted 6 lines
docs/misc/xen-command-line.pandoc +2 -1
@@ -1177,7 +1177,8 @@ Specify which console gdbstub should use
  ### gnttab
  > `= List of [ max-ver:<integer>, transitive=<bool>, transfer=<bool> ]`
 
-> Default: `gnttab=max-ver:2,transitive,transfer`
+> Default (Arm): `gnttab=max-ver:1`
+> Default (x86): `gnttab=max-ver:2,transitive,transfer`

AFAICT, the default would not be correct on x86 when CONFIG_PV=n because transfer is not available.

Cheers,

Signature · 1 line
Julien Grall
#2 lore raw
Quoted 16 lines · Julien Grall
Quoted 15 lines · Jan Beulich

Defaults differ for Arm and x86, not the least because of v2 not even being security supported on Arm.

Also drop a bogus sentence from gnttab_max_maptrack_frames, which was presumably mistakenly cloned from gnttab_max_frames (albeit even there what is being said is neither very precise nor very useful imo).

docs/misc/xen-command-line.pandoc +0 -0
@@ -1177,7 +1177,8 @@ Specify which console gdbstub should use
  ### gnttab
  > `= List of [ max-ver:<integer>, transitive=<bool>, transfer=<bool> ]`
 
Quoted 6 lines

docs/misc/xen-command-line.pandoc Specify which console gdbstub should use · line 1181

Quoted 3 lines
docs/misc/xen-command-line.pandoc +2 -1
-> Default: `gnttab=max-ver:2,transitive,transfer`
+> Default (Arm): `gnttab=max-ver:1`
+> Default (x86): `gnttab=max-ver:2,transitive,transfer`

AFAICT, the default would not be correct on x86 when CONFIG_PV=n because transfer is not available.

I can certainly split it in two x86 lines, one for PV and one for HVM. I would not have thought I need to go that far, though.

Jan

Acked-by
#3 lore raw

Hi Jan,

Quoted 24 lines · Jan Beulich
Quoted 16 lines · Julien Grall
Quoted 15 lines · Jan Beulich

Defaults differ for Arm and x86, not the least because of v2 not even being security supported on Arm.

Also drop a bogus sentence from gnttab_max_maptrack_frames, which was presumably mistakenly cloned from gnttab_max_frames (albeit even there what is being said is neither very precise nor very useful imo).

docs/misc/xen-command-line.pandoc +0 -0
@@ -1177,7 +1177,8 @@ Specify which console gdbstub should use
   ### gnttab
   > `= List of [ max-ver:<integer>, transitive=<bool>, transfer=<bool> ]`
 
Quoted 6 lines

docs/misc/xen-command-line.pandoc Specify which console gdbstub should use · line 1181

Quoted 3 lines
docs/misc/xen-command-line.pandoc +2 -1
-> Default: `gnttab=max-ver:2,transitive,transfer`
+> Default (Arm): `gnttab=max-ver:1`
+> Default (x86): `gnttab=max-ver:2,transitive,transfer`

AFAICT, the default would not be correct on x86 when CONFIG_PV=n because transfer is not available.

Quoted 2 lines

I can certainly split it in two x86 lines, one for PV and one for HVM. I would not have thought I need to go that far, though.

I thought I would mention it because to me it feels odd to correct the default on Arm but keep the x86 one potentially inacurrate.

Anyway, I am ok if you prefer to keep it like that. This is already an improvement for Arm:

Cheers,

Signature · 1 line
Julien Grall