Skip to contentSkip to conversation

xen: EXPERT clean-up and introduce UNSUPPORTED

PATCH Superseded Stefano Stabellini 3 participants 5 messages Jan 23, 2021 – Jan 25, 2021

v3 of 5 Superseded Latest is v5 →

lore
Share & tools
lore
#0 lore raw

PATCH v3 1/1 xen: EXPERT clean-up and introduce UNSUPPORTED

A recent thread [1] has exposed a couple of issues with our current way of handling EXPERT.

1) It is not obvious that "Configure standard Xen features (expert users)" is actually the famous EXPERT we keep talking about on xen-devel

2) It is not obvious when we need to enable EXPERT to get a specific feature

In particular if you want to enable ACPI support so that you can boot Xen on an ACPI platform, you have to enable EXPERT first. But searching through the kconfig menu it is really not clear (type '/' and "ACPI"):
nothing in the description tells you that you need to enable EXPERT to get the option.

So this patch makes things easier by doing two things:

- introduce a new kconfig option UNSUPPORTED which is clearly to enable UNSUPPORTED features as defined by SUPPORT.md

- change EXPERT options to UNSUPPORTED where it makes sense: keep depending on EXPERT for features made for experts

- tag unsupported features by adding (UNSUPPORTED) to the one-line description

- clarify the EXPERT one-line description

[1] https://marc.info/?l=xen-devel&m=160333101228981

---
Changes in v3:
- improve UNSUPPORTED text description
- avoid changing XEN_SHSTK and EFI_SET_VIRTUAL_ADDRESS_MAP
- update HVM_FEP to be UNSUPPORTED

Changes in v2:
- introduce UNSUPPORTED
- don't switch all EXPERT options to UNSUPPORTED

See as reference the v2 thread here:
https://marc.info/?l=xen-devel&m=160566066013723

---
 xen/Kconfig              |  9 ++++++++-
 xen/arch/arm/Kconfig     | 10 +++++-----
 xen/arch/x86/Kconfig     |  6 +++---
 xen/common/Kconfig       |  2 +-
 xen/common/sched/Kconfig |  6 +++---
 5 files changed, 20 insertions(+), 13 deletions(-)
xen/Kconfig +8 -1
index 34c318bfa2..4a3d988353 100644
@@ -34,8 +34,15 @@ config DEFCONFIG_LIST
 	option defconfig_list
 	default ARCH_DEFCONFIG
 
+config UNSUPPORTED
+	bool "Configure UNSUPPORTED features"
+	help
+	  This option allows certain unsupported Xen options to be changed,
+	  which includes non-security-supported, experimental, and tech
+	  preview features as defined by SUPPORT.md.
+
 config EXPERT
-	bool "Configure standard Xen features (expert users)"
+	bool "Configure EXPERT features"
 	help
 	  This option allows certain base Xen options and settings
 	  to be disabled or tweaked. This is for specialized environments
xen/arch/arm/Kconfig +5 -5
index c3eb13ea73..cca76040e5 100644
@@ -32,7 +32,7 @@ menu "Architecture Features"
 source "arch/Kconfig"
 
 config ACPI
-	bool "ACPI (Advanced Configuration and Power Interface) Support" if EXPERT
+	bool "ACPI (Advanced Configuration and Power Interface) Support (UNSUPPORTED)" if UNSUPPORTED
 	depends on ARM_64
 	---help---
 
@@ -49,7 +49,7 @@ config GICV3
 	  If unsure, say Y
 
 config HAS_ITS
-        bool "GICv3 ITS MSI controller support" if EXPERT
+        bool "GICv3 ITS MSI controller support (UNSUPPORTED)" if UNSUPPORTED
         depends on GICV3 && !NEW_VGIC
 
 config HVM
@@ -77,7 +77,7 @@ config SBSA_VUART_CONSOLE
 	  SBSA Generic UART implements a subset of ARM PL011 UART.
 
 config ARM_SSBD
-	bool "Speculative Store Bypass Disable" if EXPERT
+	bool "Speculative Store Bypass Disable (UNSUPPORTED)" if UNSUPPORTED
 	depends on HAS_ALTERNATIVE
 	default y
 	help
@@ -87,7 +87,7 @@ config ARM_SSBD
 	  If unsure, say Y.
 
 config HARDEN_BRANCH_PREDICTOR
-	bool "Harden the branch predictor against aliasing attacks" if EXPERT
+	bool "Harden the branch predictor against aliasing attacks (UNSUPPORTED)" if UNSUPPORTED
 	default y
 	help
 	  Speculation attacks against some high-performance processors rely on
@@ -104,7 +104,7 @@ config HARDEN_BRANCH_PREDICTOR
 	  If unsure, say Y.
 
 config TEE
-	bool "Enable TEE mediators support" if EXPERT
+	bool "Enable TEE mediators support (UNSUPPORTED)" if UNSUPPORTED
 	default n
 	help
 	  This option enables generic TEE mediators support. It allows guests
xen/arch/x86/Kconfig +3 -3
index 78f351f94b..302334d3e4 100644
@@ -147,7 +147,7 @@ config BIGMEM
 	  If unsure, say N.
 
 config HVM_FEP
-	bool "HVM Forced Emulation Prefix support" if EXPERT
+	bool "HVM Forced Emulation Prefix support (UNSUPPORTED)" if UNSUPPORTED
 	default DEBUG
 	depends on HVM
 	---help---
@@ -166,7 +166,7 @@ config HVM_FEP
 	  If unsure, say N.
 
 config TBOOT
-	bool "Xen tboot support" if EXPERT
+	bool "Xen tboot support (UNSUPPORTED)" if UNSUPPORTED
 	default y if !PV_SHIM_EXCLUSIVE
 	select CRYPTO
 	---help---
@@ -252,7 +252,7 @@ config HYPERV_GUEST
 endif
 
 config MEM_SHARING
-	bool "Xen memory sharing support" if EXPERT
+	bool "Xen memory sharing support (UNSUPPORTED)" if UNSUPPORTED
 	depends on HVM
 
 endmenu
xen/common/Kconfig +1 -1
index b5c91a1664..39451e8350 100644
@@ -272,7 +272,7 @@ config LATE_HWDOM
 	  If unsure, say N.
 
 config ARGO
-	bool "Argo: hypervisor-mediated interdomain communication" if EXPERT
+	bool "Argo: hypervisor-mediated interdomain communication (UNSUPPORTED)" if UNSUPPORTED
 	---help---
 	  Enables a hypercall for domains to ask the hypervisor to perform
 	  data transfer of messages between domains.
xen/common/sched/Kconfig +3 -3
index 61231aacaa..94c9e20139 100644
@@ -15,7 +15,7 @@ config SCHED_CREDIT2
 	  optimized for lower latency and higher VM density.
 
 config SCHED_RTDS
-	bool "RTDS scheduler support (EXPERIMENTAL)"
+	bool "RTDS scheduler support (UNSUPPORTED)" if UNSUPPORTED
 	default y
 	---help---
 	  The RTDS scheduler is a soft and firm real-time scheduler for
@@ -23,14 +23,14 @@ config SCHED_RTDS
 	  in the cloud, and general low-latency workloads.
 
 config SCHED_ARINC653
-	bool "ARINC653 scheduler support (EXPERIMENTAL)"
+	bool "ARINC653 scheduler support (UNSUPPORTED)" if UNSUPPORTED
 	default DEBUG
 	---help---
 	  The ARINC653 scheduler is a hard real-time scheduler for single
 	  cores, targeted for avionics, drones, and medical devices.
 
 config SCHED_NULL
-	bool "Null scheduler support (EXPERIMENTAL)"
+	bool "Null scheduler support (UNSUPPORTED)" if UNSUPPORTED
 	default y
 	---help---
 	  The null scheduler is a static, zero overhead scheduler,
Signature · 1 line
2.17.1
#1 lore raw

xen/Kconfig config DEFCONFIG_LIST · line 42

Quoted 12 lines · Stefano Stabellini
xen/Kconfig +6 -0
@@ -34,8 +34,15 @@ config DEFCONFIG_LIST
 	option defconfig_list
 	default ARCH_DEFCONFIG
 
+config UNSUPPORTED
+	bool "Configure UNSUPPORTED features"
+	help
+	  This option allows certain unsupported Xen options to be changed,
+	  which includes non-security-supported, experimental, and tech
+	  preview features as defined by SUPPORT.md.

And by implication anything not depending on UNSUPPORTED is supported? I didn't think this was the case (some unsupported code can't even be turned off via Kconfig), so I think this needs clarifying here, so we won't end up with people considering some feature supported which really isn't. That's irrespective of the reference to SUPPORT.md.

xen/Kconfig config DEFCONFIG_LIST · line 48

Quoted 6 lines
xen/Kconfig +1 -1
 config EXPERT
-	bool "Configure standard Xen features (expert users)"
+	bool "Configure EXPERT features"
 	help
 	  This option allows certain base Xen options and settings
 	  to be disabled or tweaked. This is for specialized environments

I'd like to suggest to move UNSUPPORTED past this one, to then have that have "default EXPERT".

Jan

#2 lore raw
Quoted 7 lines · Jan Beulich
Quoted 6 lines · Stefano Stabellini
xen/Kconfig +0 -0
@@ -34,8 +34,15 @@ config DEFCONFIG_LIST
 	option defconfig_list
 	default ARCH_DEFCONFIG
 
Quoted 13 lines

xen/Kconfig config DEFCONFIG_LIST · line 42

Quoted 6 lines
xen/Kconfig +6 -0
+config UNSUPPORTED
+	bool "Configure UNSUPPORTED features"
+	help
+	  This option allows certain unsupported Xen options to be changed,
+	  which includes non-security-supported, experimental, and tech
+	  preview features as defined by SUPPORT.md.

And by implication anything not depending on UNSUPPORTED is supported? I didn't think this was the case (some unsupported code can't even be turned off via Kconfig), so I think this needs clarifying here, so we won't end up with people considering some feature supported which really isn't. That's irrespective of the reference to SUPPORT.md.

I'll clarify.

Quoted 9 lines

xen/Kconfig config DEFCONFIG_LIST · line 48

Quoted 6 lines
xen/Kconfig +1 -1
 config EXPERT
-	bool "Configure standard Xen features (expert users)"
+	bool "Configure EXPERT features"
 	help
 	  This option allows certain base Xen options and settings
 	  to be disabled or tweaked. This is for specialized environments

I'd like to suggest to move UNSUPPORTED past this one, to then have that have "default EXPERT".

Sure, good idea.

#3 lore raw
In reply to Stefano Stabellini

Hi Stefano,

Quoted 17 lines · Stefano Stabellini

A recent thread [1] has exposed a couple of issues with our current way of handling EXPERT.

1) It is not obvious that "Configure standard Xen features (expert users)" is actually the famous EXPERT we keep talking about on xen-devel

2) It is not obvious when we need to enable EXPERT to get a specific feature

In particular if you want to enable ACPI support so that you can boot Xen on an ACPI platform, you have to enable EXPERT first. But searching through the kconfig menu it is really not clear (type '/' and "ACPI"):
nothing in the description tells you that you need to enable EXPERT to get the option.

Quoted 4 lines

So this patch makes things easier by doing two things:

- introduce a new kconfig option UNSUPPORTED which is clearly to enable UNSUPPORTED features as defined by SUPPORT.md

That’s a great change which will improve user experience.

Quoted 7 lines

- change EXPERT options to UNSUPPORTED where it makes sense: keep depending on EXPERT for features made for experts

- tag unsupported features by adding (UNSUPPORTED) to the one-line description

Shouldn’t we add (EXPERT) for expert options in the same way for coherency ?

Cheers
Bertrand

Quoted 181 lines

- clarify the EXPERT one-line description

[1] https://marc.info/?l=xen-devel&m=160333101228981

---
Changes in v3:
- improve UNSUPPORTED text description
- avoid changing XEN_SHSTK and EFI_SET_VIRTUAL_ADDRESS_MAP
- update HVM_FEP to be UNSUPPORTED

Changes in v2:
- introduce UNSUPPORTED
- don't switch all EXPERT options to UNSUPPORTED

See as reference the v2 thread here:
https://marc.info/?l=xen-devel&m=160566066013723
---

xen/Kconfig              |  9 ++++++++-
xen/arch/arm/Kconfig     | 10 +++++-----
xen/arch/x86/Kconfig     |  6 +++---
xen/common/Kconfig       |  2 +-
xen/common/sched/Kconfig |  6 +++---
5 files changed, 20 insertions(+), 13 deletions(-)
xen/Kconfig +7 -0
index 34c318bfa2..4a3d988353 100644
@@ -34,8 +34,15 @@ config DEFCONFIG_LIST
 	option defconfig_list
 	default ARCH_DEFCONFIG
 
+config UNSUPPORTED
+	bool "Configure UNSUPPORTED features"
+	help
+	  This option allows certain unsupported Xen options to be changed,
+	  which includes non-security-supported, experimental, and tech
+	  preview features as defined by SUPPORT.md.
+

config EXPERT

xen/Kconfig +1 -1
-	bool "Configure standard Xen features (expert users)"
+	bool "Configure EXPERT features"

help
This option allows certain base Xen options and settings to be disabled or tweaked. This is for specialized environments

xen/arch/arm/Kconfig +0 -0
index c3eb13ea73..cca76040e5 100644
@@ -32,7 +32,7 @@ menu "Architecture Features"

source "arch/Kconfig"

config ACPI

xen/arch/arm/Kconfig +1 -1
-	bool "ACPI (Advanced Configuration and Power Interface) Support" if EXPERT
+	bool "ACPI (Advanced Configuration and Power Interface) Support (UNSUPPORTED)" if UNSUPPORTED
	depends on ARM_64
	---help---
xen/arch/arm/Kconfig +0 -0
@@ -49,7 +49,7 @@ config GICV3
 	  If unsure, say Y
 

config HAS_ITS

xen/arch/arm/Kconfig +1 -1
-        bool "GICv3 ITS MSI controller support" if EXPERT
+        bool "GICv3 ITS MSI controller support (UNSUPPORTED)" if UNSUPPORTED
        depends on GICV3 && !NEW_VGIC

config HVM

xen/arch/arm/Kconfig +0 -0
@@ -77,7 +77,7 @@ config SBSA_VUART_CONSOLE
 	  SBSA Generic UART implements a subset of ARM PL011 UART.
 

config ARM_SSBD

xen/arch/arm/Kconfig +1 -1
-	bool "Speculative Store Bypass Disable" if EXPERT
+	bool "Speculative Store Bypass Disable (UNSUPPORTED)" if UNSUPPORTED

depends on HAS_ALTERNATIVE
default y
help

xen/arch/arm/Kconfig +0 -0
@@ -87,7 +87,7 @@ config ARM_SSBD
 	  If unsure, say Y.
 

config HARDEN_BRANCH_PREDICTOR

xen/arch/arm/Kconfig +1 -1
-	bool "Harden the branch predictor against aliasing attacks" if EXPERT
+	bool "Harden the branch predictor against aliasing attacks (UNSUPPORTED)" if UNSUPPORTED

default y
help
Speculation attacks against some high-performance processors rely on

xen/arch/arm/Kconfig +0 -0
@@ -104,7 +104,7 @@ config HARDEN_BRANCH_PREDICTOR
 	  If unsure, say Y.
 

config TEE

xen/arch/arm/Kconfig +1 -1
-	bool "Enable TEE mediators support" if EXPERT
+	bool "Enable TEE mediators support (UNSUPPORTED)" if UNSUPPORTED

default n
help
This option enables generic TEE mediators support. It allows guests

xen/arch/x86/Kconfig +0 -0
index 78f351f94b..302334d3e4 100644
@@ -147,7 +147,7 @@ config BIGMEM
 	  If unsure, say N.
 

config HVM_FEP

xen/arch/x86/Kconfig +1 -1
-	bool "HVM Forced Emulation Prefix support" if EXPERT
+	bool "HVM Forced Emulation Prefix support (UNSUPPORTED)" if UNSUPPORTED
	default DEBUG
	depends on HVM
	---help---
xen/arch/x86/Kconfig +0 -0
@@ -166,7 +166,7 @@ config HVM_FEP
 	  If unsure, say N.
 

config TBOOT

xen/arch/x86/Kconfig +1 -1
-	bool "Xen tboot support" if EXPERT
+	bool "Xen tboot support (UNSUPPORTED)" if UNSUPPORTED
	default y if !PV_SHIM_EXCLUSIVE
	select CRYPTO
	---help---
xen/arch/x86/Kconfig +0 -0
@@ -252,7 +252,7 @@ config HYPERV_GUEST

endif

config MEM_SHARING

xen/arch/x86/Kconfig +1 -1
-	bool "Xen memory sharing support" if EXPERT
+	bool "Xen memory sharing support (UNSUPPORTED)" if UNSUPPORTED

depends on HVM

endmenu

xen/common/Kconfig +0 -0
index b5c91a1664..39451e8350 100644
@@ -272,7 +272,7 @@ config LATE_HWDOM
 	  If unsure, say N.
 

config ARGO

xen/common/Kconfig +1 -1
-	bool "Argo: hypervisor-mediated interdomain communication" if EXPERT
+	bool "Argo: hypervisor-mediated interdomain communication (UNSUPPORTED)" if UNSUPPORTED

---help---
Enables a hypercall for domains to ask the hypervisor to perform data transfer of messages between domains.

xen/common/sched/Kconfig +0 -0
index 61231aacaa..94c9e20139 100644
@@ -15,7 +15,7 @@ config SCHED_CREDIT2
 	  optimized for lower latency and higher VM density.
 

config SCHED_RTDS

xen/common/sched/Kconfig +1 -1
-	bool "RTDS scheduler support (EXPERIMENTAL)"
+	bool "RTDS scheduler support (UNSUPPORTED)" if UNSUPPORTED
	default y
	---help---
	  The RTDS scheduler is a soft and firm real-time scheduler for
xen/common/sched/Kconfig +0 -0
@@ -23,14 +23,14 @@ config SCHED_RTDS
 	  in the cloud, and general low-latency workloads.
 

config SCHED_ARINC653

xen/common/sched/Kconfig +1 -1
-	bool "ARINC653 scheduler support (EXPERIMENTAL)"
+	bool "ARINC653 scheduler support (UNSUPPORTED)" if UNSUPPORTED

default DEBUG
---help---
The ARINC653 scheduler is a hard real-time scheduler for single cores, targeted for avionics, drones, and medical devices.

config SCHED_NULL

xen/common/sched/Kconfig +1 -1
-	bool "Null scheduler support (EXPERIMENTAL)"
+	bool "Null scheduler support (UNSUPPORTED)" if UNSUPPORTED
	default y
	---help---
	  The null scheduler is a static, zero overhead scheduler,
Signature · 1 line
2.17.1
#4 lore raw
Quoted 19 lines · Bertrand Marquis

Hi Stefano,

Quoted 17 lines · Stefano Stabellini

A recent thread [1] has exposed a couple of issues with our current way of handling EXPERT.

1) It is not obvious that "Configure standard Xen features (expert users)" is actually the famous EXPERT we keep talking about on xen-devel

2) It is not obvious when we need to enable EXPERT to get a specific feature

In particular if you want to enable ACPI support so that you can boot Xen on an ACPI platform, you have to enable EXPERT first. But searching through the kconfig menu it is really not clear (type '/' and "ACPI"):
nothing in the description tells you that you need to enable EXPERT to get the option.

Quoted 6 lines
Quoted 4 lines

So this patch makes things easier by doing two things:

- introduce a new kconfig option UNSUPPORTED which is clearly to enable UNSUPPORTED features as defined by SUPPORT.md

That’s a great change which will improve user experience.

Thank you!

Quoted 8 lines
Quoted 6 lines

- change EXPERT options to UNSUPPORTED where it makes sense: keep depending on EXPERT for features made for experts

- tag unsupported features by adding (UNSUPPORTED) to the one-line description

Shouldn’t we add (EXPERT) for expert options in the same way for coherency ?

I take you mean add "(EXPERT)" to the one-line description in kconfig. I am OK with that, probably better as a second separate patch. I'll add it.