[PATCH 1/3] x86: pass in size to early cmdline parsing

[PATCH 1/3] x86: pass in size to early cmdline parsing

[Dave Hansen]

From: Dave Hansen <dave.hansen@linux.intel.com>

We will use this in a few patches to implement tests for early
parsing.

Signed-off-by: Dave Hansen <dave.hansen@linux.intel.com>
Cc: Borislav Petkov <bp@suse.de>
Cc: H. Peter Anvin <hpa@zytor.com>
Cc: linux-kernel@vger.kernel.org
Cc: fenghua.yu@intel.com
Cc: yu-cheng.yu@intel.com
---

 b/arch/x86/lib/cmdline.c |   11 +++++++++--
 1 file changed, 9 insertions(+), 2 deletions(-)

diff -puN arch/x86/lib/cmdline.c~pass-in-cmdline-size arch/x86/lib/cmdline.c
--- a/arch/x86/lib/cmdline.c~pass-in-cmdline-size	2015-12-17 13:54:52.534928192 -0800
+++ b/arch/x86/lib/cmdline.c	2015-12-17 13:54:52.537928328 -0800
@@ -23,7 +23,8 @@ static inline int myisspace(u8 c)
  * Returns the position of that @option (starts counting with 1)
  * or 0 on not found.
  */
-int cmdline_find_option_bool(const char *cmdline, const char *option)
+static int __cmdline_find_option_bool(const char *cmdline,
+		int max_cmdline_size, const char *option)
 {
 	char c;
 	int len, pos = 0, wstart = 0;
@@ -37,7 +38,7 @@ int cmdline_find_option_bool(const char
 	if (!cmdline)
 		return -1;      /* No command line */
 
-	len = min_t(int, strlen(cmdline), COMMAND_LINE_SIZE);
+	len = min_t(int, strlen(cmdline), max_cmdline_size);
 	if (!len)
 		return 0;
 
@@ -82,3 +83,9 @@ int cmdline_find_option_bool(const char
 
 	return 0;	/* Buffer overrun */
 }
+
+int cmdline_find_option_bool(const char *cmdline, const char *option)
+{
+	return __cmdline_find_option_bool(cmdline, COMMAND_LINE_SIZE,
+			option);
+}
_

[PATCH 2/3] x86: test early command-line code

[Dave Hansen]

From: Dave Hansen <dave.hansen@linux.intel.com>

Here are some simple tests for the early command-line code.  It
had way more bugs than it should have, so let's make sure they
never pop up again.

Note, there are a few failures in here now.  We will fix those
up in the next few patches.

This is complete overkill for this code, but I had to do it to
convince myself that I wasn't making it any worse.

Signed-off-by: Dave Hansen <dave.hansen@linux.intel.com>
Cc: Borislav Petkov <bp@suse.de>
Cc: H. Peter Anvin <hpa@zytor.com>
Cc: linux-kernel@vger.kernel.org
Cc: fenghua.yu@intel.com
Cc: yu-cheng.yu@intel.com
---

 b/arch/x86/Kconfig.debug  |    7 ++
 b/arch/x86/kernel/check.c |    4 +
 b/arch/x86/lib/cmdline.c  |  122 ++++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 133 insertions(+)

diff -puN arch/x86/Kconfig.debug~x86-early-command-line-test arch/x86/Kconfig.debug
--- a/arch/x86/Kconfig.debug~x86-early-command-line-test	2015-12-17 13:55:30.619652300 -0800
+++ b/arch/x86/Kconfig.debug	2015-12-17 13:55:30.625652571 -0800
@@ -400,4 +400,11 @@ config PUNIT_ATOM_DEBUG
 	  The current power state can be read from
 	  /sys/kernel/debug/punit_atom/dev_power_state
 
+config X86_TEST_EARLY_CMDLINE
+	bool "Early command line runtime tests"
+	---help---
+	  This creates some test command-lines and tries to parse
+	  a bunch of options from them.  The overhead is small both
+	  at boot and increased text/data sizes.
+
 endmenu
diff -puN arch/x86/kernel/check.c~x86-early-command-line-test arch/x86/kernel/check.c
--- a/arch/x86/kernel/check.c~x86-early-command-line-test	2015-12-17 13:55:30.621652391 -0800
+++ b/arch/x86/kernel/check.c	2015-12-17 13:55:30.626652617 -0800
@@ -165,3 +165,7 @@ static int start_periodic_check_for_corr
 }
 device_initcall(start_periodic_check_for_corruption);
 
+#ifdef CONFIG_X86_TEST_EARLY_CMDLINE
+int test_early_cmdline(void)
+late_initcall(test_early_cmdline);
+#endif /* CONFIG_X86_TEST_EARLY_CMDLINE */
diff -puN arch/x86/lib/cmdline.c~x86-early-command-line-test arch/x86/lib/cmdline.c
--- a/arch/x86/lib/cmdline.c~x86-early-command-line-test	2015-12-17 13:55:30.622652436 -0800
+++ b/arch/x86/lib/cmdline.c	2015-12-17 13:55:30.626652617 -0800
@@ -4,6 +4,7 @@
  *
  * Misc librarized functions for cmdline poking.
  */
+#include <linux/bug.h>
 #include <linux/kernel.h>
 #include <linux/string.h>
 #include <linux/ctype.h>
@@ -89,3 +90,124 @@ int cmdline_find_option_bool(const char
 	return __cmdline_find_option_bool(cmdline, COMMAND_LINE_SIZE,
 			option);
 }
+
+#ifdef CONFIG_X86_TEST_EARLY_CMDLINE
+
+static int __cmdtest(char *cmdline, int str_size, char *option,
+		int expected_result, int do_shrink)
+{
+	int ret;
+	int null_terminate;
+	/* Results are 1-based, so bias back down by 1 */
+	int option_end = expected_result + strlen(option) - 1;
+	int shrink_max = 0;
+
+	if (cmdline && do_shrink)
+		shrink_max = strlen(cmdline);
+	/*
+	 * The option was not found.  If it was not found in the
+	 * *full* command-line, it should never be found in any
+	 * *part* of the command-line.
+	 */
+	for (null_terminate = 0; null_terminate <= 1; null_terminate++) {
+		int shrink_by;
+		for (shrink_by = 0; shrink_by < shrink_max; shrink_by++) {
+			int str_size_tst = str_size - shrink_by;
+			char tmp = cmdline[str_size_tst];
+
+			/*
+			 * Do not run tests that would truncate
+			 * over the expected option
+			 */
+			if (str_size_tst <= option_end)
+				continue;
+
+			if (null_terminate)
+				cmdline[str_size_tst] = '\0';
+			ret = __cmdline_find_option_bool(cmdline, str_size_tst,
+					option);
+			if (null_terminate)
+				cmdline[str_size_tst] = tmp;
+
+			if (ret == expected_result)
+				continue;
+			pr_err("failed cmdline test ('%s', %d, '%s') == %d "
+					"nulld: %d got: %d\n",
+					cmdline, str_size_tst, option,
+					expected_result, null_terminate,
+					ret);
+			return 1;
+		}
+	}
+	return 0;
+}
+
+#define cmdtest(cmdline, option, result)	\
+	WARN_ON(__cmdtest(cmdline, sizeof(cmdline), option, result, 1))
+
+#define cmdtest_noshrink(cmdline, option, result)	\
+	WARN_ON(__cmdtest(cmdline, sizeof(cmdline), option, result, 0))
+
+char cmdline1[] = "CALL me Ishmael  ";
+char cmdline2[] = "Whenever I find myself growing grim about the mouth  ";
+char cmdline3[] = "grow growing  ";
+int test_early_cmdline(void)
+{
+	/* NULL command-line: */
+	WARN_ON(__cmdline_find_option_bool(NULL, 22, "Ishmael") != -1);
+	/* zero-length command-line: */
+	cmdtest("", "Ishmael", 0);
+
+	/* Find words at each of 3 positions: start, middle, end */
+	cmdtest(cmdline1, "CALL", 1);
+	cmdtest(cmdline1, "me", 6);
+	cmdtest(cmdline1, "Ishmael", 9);
+
+	/*
+	 * Fail to find strings that all occur in the cmdline,
+	 * but not as full words
+	 */
+	/*
+	 * If "option" is _present_ in "cmdline" as the start of a
+	 * word, like cmdline="foo bar" and we pass in option="b",
+	 * when we shrink cmdline to "foo b", it will match.  So,
+	 * skip shrink tests for those.
+	 */
+	cmdtest_noshrink(cmdline1, "m", 0);
+	cmdtest(cmdline1, "e", 0);
+	cmdtest(cmdline1, "C", 0);
+	cmdtest(cmdline1, "l", 0);
+	cmdtest_noshrink(cmdline1, "Ishmae", 0);
+	cmdtest(cmdline1, "mael", 0);
+	/*
+	 * Look for strings that do not occur, but match until
+	 * close to the end of cmdline
+	 */
+	cmdtest_noshrink(cmdline1, "Ishmae", 0);
+	cmdtest(cmdline1, "Ishmaels", 0);
+	cmdtest(cmdline1, "maels", 0);
+
+	/*
+	 * Look for full words that do not occur in a different
+	 * cmdline
+	 */
+	cmdtest(cmdline2, "CALL", 0);
+	cmdtest(cmdline2, "me", 0);
+	cmdtest(cmdline2, "Ishmael", 0);
+	/*
+	 * Look for full words which do occur in cmdline2
+	 */
+	cmdtest(cmdline2, "Whenever", 1);
+	cmdtest(cmdline2, "growing", 24);
+	cmdtest(cmdline2, "grim", 32);
+	cmdtest(cmdline2, "mouth", 47);
+
+	/*
+	 * Catch the bug where if we match a partial word and
+	 * then have a space, we do not match the _next_ word.
+	 */
+	cmdtest(cmdline3, "grow", 1);
+	cmdtest(cmdline3, "growing", 6);
+	return 0;
+}
+#endif /* CONFIG_X86_TEST_EARLY_CMDLINE */
_

[PATCH 3/3] x86: fix early command-line parsing when matching at end

[Dave Hansen]

From: Dave Hansen <dave.hansen@linux.intel.com>

The x86 early command line parsing in cmdline_find_option_bool()
is buggy.  If it matches a specified 'option' all the way to
the end of the command-line, it will consider it a match.

For instance,

    	cmdline = "foo";
    	cmdline_find_option_bool(cmdline, "fool");

will return 1.  This is particularly annoying since we have
actual FPU options like "noxsave" and "noxsaves"  So,
command-line "foo bar noxsave" will match *BOTH* a "noxsave" and
"noxsaves". (This turns out not to be an actual problem because
"noxsave" implies "noxsaves", but it's still confusing.)

To fix this, we simplify the code and stop tracking 'len'.  'len'
was trying to indicate either the NULL terminator *OR* the end of
a non-NULL-terminated commandline at 'max_cmdline_size'.  But,
  each of the three states is *already* checking 'cmdline' for a
  NULL terminator.

We _only_ need to check if we have overrun 'max_cmdline_size', and
that we can do without keeping 'len' around.

Also add some commends to clarify what is going on.

Signed-off-by: Dave Hansen <dave.hansen@linux.intel.com>
Cc: Borislav Petkov <bp@suse.de>
Cc: H. Peter Anvin <hpa@zytor.com>
Cc: linux-kernel@vger.kernel.org
Cc: fenghua.yu@intel.com
Cc: yu-cheng.yu@intel.com
---

 b/arch/x86/lib/cmdline.c |   34 ++++++++++++++++++++++++----------
 1 file changed, 24 insertions(+), 10 deletions(-)

diff -puN arch/x86/lib/cmdline.c~x86-broken-end-of-string-command-line-parsing arch/x86/lib/cmdline.c
--- a/arch/x86/lib/cmdline.c~x86-broken-end-of-string-command-line-parsing	2015-12-17 13:54:53.398967308 -0800
+++ b/arch/x86/lib/cmdline.c	2015-12-17 13:54:53.401967444 -0800
@@ -22,13 +22,15 @@ static inline int myisspace(u8 c)
  * @option: option string to look for
  *
  * Returns the position of that @option (starts counting with 1)
- * or 0 on not found.
+ * or 0 on not found.  @option will only be found if it is found
+ * as an entire word in @cmdline.  For instance, if @option="car"
+ * then a cmdline which contains "cart" will not match.
  */
 static int __cmdline_find_option_bool(const char *cmdline,
 		int max_cmdline_size, const char *option)
 {
 	char c;
-	int len, pos = 0, wstart = 0;
+	int pos = 0, wstart = 0;
 	const char *opptr = NULL;
 	enum {
 		st_wordstart = 0,	/* Start of word/after whitespace */
@@ -39,11 +41,14 @@ static int __cmdline_find_option_bool(co
 	if (!cmdline)
 		return -1;      /* No command line */
 
-	len = min_t(int, strlen(cmdline), max_cmdline_size);
-	if (!len)
+	if (!strlen(cmdline))
 		return 0;
 
-	while (len--) {
+	/*
+	 * This 'pos' check ensures we do not overrun
+	 * a non-NULL-terminated 'cmdline'
+	 */
+	while (pos < max_cmdline_size) {
 		c = *(char *)cmdline++;
 		pos++;
 
@@ -60,17 +65,26 @@ static int __cmdline_find_option_bool(co
 			/* fall through */
 
 		case st_wordcmp:
-			if (!*opptr)
+			if (!*opptr) {
+				/*
+				 * We matched all the way to the end of the
+				 * option we were looking for.  If the
+				 * command-line has a space _or_ ends, then
+				 * we matched!
+				 */
 				if (!c || myisspace(c))
 					return wstart;
 				else
 					state = st_wordskip;
-			else if (!c)
+			} else if (!c) {
+				/*
+				 * Hit the NULL terminator on the end of
+				 * cmdline.
+				 */
 				return 0;
-			else if (c != *opptr++)
+			} else if (c != *opptr++) {
 				state = st_wordskip;
-			else if (!len)		/* last word and is matching */
-				return wstart;
+			}
 			break;
 
 		case st_wordskip:
_

Re: [PATCH 1/3] x86: pass in size to early cmdline parsing

[Dave Hansen]

I fat-fingered this and only sent out the first 3 of 5 patches.  I'll
resend the whole set together.  Sorry for the noise.