Skip to contentSkip to conversation

x86/cet: Support cet=<bool> on the command line

PATCH In review Andrew Cooper 3 participants 9 messages Apr 28, 2022 – Apr 29, 2022

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 x86/cet: Support cet=<bool> on the command line

... as a shorthand for setting both suboptions at once.

---
CC: Jan Beulich <[email protected]>
CC: Roger Pau Monné <[email protected]>
CC: Wei Liu <[email protected]>

I think this wants backporting. cet=0 is "so obviously" the way to turn off both that I tried using it to debug a problem. It's absence was an oversight of the original CET logic.

---
 docs/misc/xen-command-line.pandoc |  4 +++-
 xen/arch/x86/setup.c              | 15 ++++++++++++++-
 2 files changed, 17 insertions(+), 2 deletions(-)
docs/misc/xen-command-line.pandoc +3 -1
index 1dc7e1ca0706..1720cb216824 100644
@@ -271,7 +271,7 @@ enough. Setting this to a high value may cause boot failure, particularly if
 the NMI watchdog is also enabled.
 
 ### cet
-    = List of [ shstk=<bool>, ibt=<bool> ]
+    = List of [ <bool>, shstk=<bool>, ibt=<bool> ]
 
     Applicability: x86
 
@@ -283,6 +283,8 @@ CET is incompatible with 32bit PV guests.  If any CET sub-options are active,
 they will override the `pv=32` boolean to `false`.  Backwards compatibility
 can be maintained with the pv-shim mechanism.
 
+*   An unqualified boolean is shorthand for setting all suboptions at once.
+
 *   The `shstk=` boolean controls whether Xen uses Shadow Stacks for its own
     protection.
 
xen/arch/x86/setup.c +14 -1
index 53a73010e029..090abfd71754 100644
@@ -117,7 +117,20 @@ static int __init cf_check parse_cet(const char *s)
         if ( !ss )
             ss = strchr(s, '\0');
 
-        if ( (val = parse_boolean("shstk", s, ss)) >= 0 )
+        if ( (val = parse_bool(s, ss)) >= 0 )
+        {
+#ifdef CONFIG_XEN_SHSTK
+            opt_xen_shstk = val;
+#else
+            no_config_param("XEN_SHSTK", "cet", s, ss);
+#endif
+#ifdef CONFIG_XEN_IBT
+            opt_xen_ibt = val;
+#else
+            no_config_param("XEN_IBT", "cet", s, ss);
+#endif
+        }
+        else if ( (val = parse_boolean("shstk", s, ss)) >= 0 )
         {
 #ifdef CONFIG_XEN_SHSTK
             opt_xen_shstk = val;
Signature · 1 line
2.11.0
#2 lore raw
Quoted 5 lines · Roger Pau Monné
Quoted 3 lines · Andrew Cooper

... as a shorthand for setting both suboptions at once.

Thanks.

Quoted 7 lines

From the implementation below we would support settings like:

cet=true,shstk=false

Which I think it's indented? Have a global default for all options, set some to a different value.

That's how all list options work, and it's also equivalent to

cet=true cet=shstk=false

Options can be given multiple time, and are parsed left to right with the latest setting taking precedence.

~Andrew

#3 lore raw
In reply to Andrew Cooper

docs/misc/xen-command-line.pandoc CET is incompatible with 32bit PV guests. If any CET sub-options are active, · line 286

Quoted 5 lines · Andrew Cooper
docs/misc/xen-command-line.pandoc +1 -0
@@ -283,6 +283,8 @@ CET is incompatible with 32bit PV guests.  If any CET sub-options are active,
 they will override the `pv=32` boolean to `false`.  Backwards compatibility
 can be maintained with the pv-shim mechanism.
 
+*   An unqualified boolean is shorthand for setting all suboptions at once.

You're the native speaker, but I wonder whether there an "a" missing before "shorthand".

Quoted 9 lines
xen/arch/x86/setup.c +2 -1
@@ -117,7 +117,20 @@ static int __init cf_check parse_cet(const char *s)
         if ( !ss )
             ss = strchr(s, '\0');
 
-        if ( (val = parse_boolean("shstk", s, ss)) >= 0 )
+        if ( (val = parse_bool(s, ss)) >= 0 )
+        {

xen/arch/x86/setup.c static int __init cf_check parse_cet(const char *s) · line 131

Quoted 10 lines
xen/arch/x86/setup.c +10 -0
+#ifdef CONFIG_XEN_SHSTK
+            opt_xen_shstk = val;
+#else
+            no_config_param("XEN_SHSTK", "cet", s, ss);
+#endif
+#ifdef CONFIG_XEN_IBT
+            opt_xen_ibt = val;
+#else
+            no_config_param("XEN_IBT", "cet", s, ss);
+#endif

There shouldn't be two invocations of no_config_param() here; imo if either CONFIG_* is defined, use of the option shouldn't produce any warning at all.

xen/arch/x86/setup.c static int __init cf_check parse_cet(const char *s) · line 136

Quoted 5 lines
xen/arch/x86/setup.c +2 -0
+        }
+        else if ( (val = parse_boolean("shstk", s, ss)) >= 0 )
         {
 #ifdef CONFIG_XEN_SHSTK
             opt_xen_shstk = val;

Having seen Roger's reply, I'd like to make explicit that I don't mind us allowing strange option combinations to be used, so long as what we do matches the sequence in which they were provided.

Jan

#4 lore raw
Quoted 25 lines · Jan Beulich

docs/misc/xen-command-line.pandoc CET is incompatible with 32bit PV guests. If any CET sub-options are active, · line 286

Quoted 5 lines · Andrew Cooper
docs/misc/xen-command-line.pandoc +1 -0
@@ -283,6 +283,8 @@ CET is incompatible with 32bit PV guests.  If any CET sub-options are active,
 they will override the `pv=32` boolean to `false`.  Backwards compatibility
 can be maintained with the pv-shim mechanism.
 
+*   An unqualified boolean is shorthand for setting all suboptions at once.

You're the native speaker, but I wonder whether there an "a" missing before "shorthand".

Quoted 15 lines
xen/arch/x86/setup.c +8 -1
@@ -117,7 +117,20 @@ static int __init cf_check parse_cet(const char *s)
         if ( !ss )
             ss = strchr(s, '\0');
 
-        if ( (val = parse_boolean("shstk", s, ss)) >= 0 )
+        if ( (val = parse_bool(s, ss)) >= 0 )
+        {
+#ifdef CONFIG_XEN_SHSTK
+            opt_xen_shstk = val;
+#else
+            no_config_param("XEN_SHSTK", "cet", s, ss);
+#endif
+#ifdef CONFIG_XEN_IBT
Quoted 8 lines

xen/arch/x86/setup.c static int __init cf_check parse_cet(const char *s) · line 131

Quoted 4 lines
xen/arch/x86/setup.c +4 -0
+            opt_xen_ibt = val;
+#else
+            no_config_param("XEN_IBT", "cet", s, ss);
+#endif

There shouldn't be two invocations of no_config_param() here; imo if either CONFIG_* is defined, use of the option shouldn't produce any warning at all.

Hm, I think we would want to warn if someone sets cet=1 but some of the options have not been built in? Or else a not very conscious administrator might believe that all CET options are enabled when some might not be present in the build. This would also assume that all options are positive.

IMO the current approach doesn't seem bad to me, I think it's always better to error on the side of printing too verbose information rather than omitting it, specially when it's related to user input on the command line and security sensitive options.

Thanks, Roger.

#5 lore raw
Quoted 35 lines · Roger Pau Monné
Quoted 25 lines · Jan Beulich

docs/misc/xen-command-line.pandoc CET is incompatible with 32bit PV guests. If any CET sub-options are active, · line 286

Quoted 5 lines · Andrew Cooper
docs/misc/xen-command-line.pandoc +1 -0
@@ -283,6 +283,8 @@ CET is incompatible with 32bit PV guests.  If any CET sub-options are active,
 they will override the `pv=32` boolean to `false`.  Backwards compatibility
 can be maintained with the pv-shim mechanism.
 
+*   An unqualified boolean is shorthand for setting all suboptions at once.

You're the native speaker, but I wonder whether there an "a" missing before "shorthand".

Quoted 15 lines
xen/arch/x86/setup.c +8 -1
@@ -117,7 +117,20 @@ static int __init cf_check parse_cet(const char *s)
         if ( !ss )
             ss = strchr(s, '\0');
 
-        if ( (val = parse_boolean("shstk", s, ss)) >= 0 )
+        if ( (val = parse_bool(s, ss)) >= 0 )
+        {
+#ifdef CONFIG_XEN_SHSTK
+            opt_xen_shstk = val;
+#else
+            no_config_param("XEN_SHSTK", "cet", s, ss);
+#endif
+#ifdef CONFIG_XEN_IBT
Quoted 8 lines

xen/arch/x86/setup.c static int __init cf_check parse_cet(const char *s) · line 131

Quoted 4 lines
xen/arch/x86/setup.c +4 -0
+            opt_xen_ibt = val;
+#else
+            no_config_param("XEN_IBT", "cet", s, ss);
+#endif

There shouldn't be two invocations of no_config_param() here; imo if either CONFIG_* is defined, use of the option shouldn't produce any warning at all.

Quoted 5 lines

Hm, I think we would want to warn if someone sets cet=1 but some of the options have not been built in? Or else a not very conscious administrator might believe that all CET options are enabled when some might not be present in the build. This would also assume that all options are positive.

But the positive options aren't really the interesting ones here, as things are enabled by default anyway. I would expect "cet=0" to be silent unless neither CONFIG_* is enabled in the build - it simply means "disable whatever CET support there is".

I can agree that "cet=1" may indeed be useful to warn, though, but I wonder whether the logic here then wouldn't become unduly complicated.

Quoted 4 lines

IMO the current approach doesn't seem bad to me, I think it's always better to error on the side of printing too verbose information rather than omitting it, specially when it's related to user input on the command line and security sensitive options.

While fundamentally I agree, too verbose output can also raise unnecessary questions or induce unnecessary investigations.

Jan

#6 lore raw
In reply to Jan Beulich
Quoted 8 lines · Jan Beulich

docs/misc/xen-command-line.pandoc CET is incompatible with 32bit PV guests. If any CET sub-options are active, · line 286

Quoted 5 lines · Andrew Cooper
docs/misc/xen-command-line.pandoc +1 -0
@@ -283,6 +283,8 @@ CET is incompatible with 32bit PV guests.  If any CET sub-options are active,
 they will override the `pv=32` boolean to `false`.  Backwards compatibility
 can be maintained with the pv-shim mechanism.
 
+*   An unqualified boolean is shorthand for setting all suboptions at once.

You're the native speaker, but I wonder whether there an "a" missing before "shorthand".

I was going to say it was correct as is, but it turn out both are acceptable.  "shorthand" is both a countable and uncountable quantity, and both "sound" right.

~Andrew

#7 lore raw
In reply to Jan Beulich
Quoted 6 lines · Jan Beulich
Quoted 6 lines
xen/arch/x86/setup.c +0 -0
@@ -117,7 +117,20 @@ static int __init cf_check parse_cet(const char *s)
         if ( !ss )
             ss = strchr(s, '\0');
 
Quoted 16 lines

xen/arch/x86/setup.c static int __init cf_check parse_cet(const char *s) · line 131

Quoted 13 lines
xen/arch/x86/setup.c +12 -1
-        if ( (val = parse_boolean("shstk", s, ss)) >= 0 )
+        if ( (val = parse_bool(s, ss)) >= 0 )
+        {
+#ifdef CONFIG_XEN_SHSTK
+            opt_xen_shstk = val;
+#else
+            no_config_param("XEN_SHSTK", "cet", s, ss);
+#endif
+#ifdef CONFIG_XEN_IBT
+            opt_xen_ibt = val;
+#else
+            no_config_param("XEN_IBT", "cet", s, ss);
+#endif

There shouldn't be two invocations of no_config_param() here; imo if either CONFIG_* is defined, use of the option shouldn't produce any warning at all.

It's this, or:

        if ( (val = parse_bool(s, ss)) >= 0 )
        {
#if !defined(CONFIG_XEN_SHSTK) && !defined(CONFIG_XEN_IBT) no_config_param("XEN_{SHSTK,IBT}", "cet", s, ss); #endif
#ifdef CONFIG_XEN_SHSTK
            opt_xen_shstk = val;
#endif
#ifdef CONFIG_XEN_IBT
            opt_xen_ibt = val;
#endif
        }

I'm not terribly fussed.

~Andrew

Reviewed-by
#8 lore raw
Quoted 39 lines · Andrew Cooper
Quoted 6 lines · Jan Beulich
Quoted 6 lines
xen/arch/x86/setup.c +0 -0
@@ -117,7 +117,20 @@ static int __init cf_check parse_cet(const char *s)
         if ( !ss )
             ss = strchr(s, '\0');
 
Quoted 16 lines

xen/arch/x86/setup.c static int __init cf_check parse_cet(const char *s) · line 131

Quoted 13 lines
xen/arch/x86/setup.c +12 -1
-        if ( (val = parse_boolean("shstk", s, ss)) >= 0 )
+        if ( (val = parse_bool(s, ss)) >= 0 )
+        {
+#ifdef CONFIG_XEN_SHSTK
+            opt_xen_shstk = val;
+#else
+            no_config_param("XEN_SHSTK", "cet", s, ss);
+#endif
+#ifdef CONFIG_XEN_IBT
+            opt_xen_ibt = val;
+#else
+            no_config_param("XEN_IBT", "cet", s, ss);
+#endif

There shouldn't be two invocations of no_config_param() here; imo if either CONFIG_* is defined, use of the option shouldn't produce any warning at all.

It's this, or:

        if ( (val = parse_bool(s, ss)) >= 0 )
        {
#if !defined(CONFIG_XEN_SHSTK) && !defined(CONFIG_XEN_IBT) no_config_param("XEN_{SHSTK,IBT}", "cet", s, ss); #endif
#ifdef CONFIG_XEN_SHSTK
            opt_xen_shstk = val;
#endif
#ifdef CONFIG_XEN_IBT
            opt_xen_ibt = val;
#endif
        }

Quoted 1 line

I'm not terribly fussed.

I'd prefer the alternative variant; hopefully Roger doesn't strongly prefer the other one. And then

Jan