diff mbox series

[3/3] kunit: tool: introduce --qemu_args

Message ID 20220518170124.2849497-4-dlatypov@google.com (mailing list archive)
State Accepted
Commit a9333bd344ad6eaf942221e0497ed65ec3224052
Delegated to: Brendan Higgins
Headers show
Series kunit: add support in kunit.py for --qemu_args | expand

Commit Message

Daniel Latypov May 18, 2022, 5:01 p.m. UTC 
Example usage:
$ ./tools/testing/kunit/kunit.py run --arch=x86_64 \
  --kconfig_add=CONFIG_SMP=y --qemu_args='-smp 8'

Looking in the test.log, one can see
> smp: Bringing up secondary CPUs ...
> .... node  #0, CPUs:      #1 #2 #3 #4 #5 #6 #7
> smp: Brought up 1 node, 8 CPUs

This flag would allow people to make tweaks like this without having to
create custom qemu_config files.

For consistency with --kernel_args, we allow users to repeat this
argument, e.g. you can tack on a --qemu_args='-m 2048', or you could
just append it to the first string ('-smp 8 -m 2048').

Signed-off-by: Daniel Latypov <dlatypov@google.com>
---
 tools/testing/kunit/kunit.py           | 14 +++++++++++++-
 tools/testing/kunit/kunit_kernel.py    | 10 +++++++---
 tools/testing/kunit/kunit_tool_test.py | 20 +++++++++++++++++---
 3 files changed, 37 insertions(+), 7 deletions(-)

Comments

David Gow May 19, 2022, 1:20 p.m. UTC | #1 
On Thu, May 19, 2022 at 1:01 AM Daniel Latypov <dlatypov@google.com> wrote:
>
> Example usage:
> $ ./tools/testing/kunit/kunit.py run --arch=x86_64 \
>   --kconfig_add=CONFIG_SMP=y --qemu_args='-smp 8'
>
> Looking in the test.log, one can see
> > smp: Bringing up secondary CPUs ...
> > .... node  #0, CPUs:      #1 #2 #3 #4 #5 #6 #7
> > smp: Brought up 1 node, 8 CPUs
>
> This flag would allow people to make tweaks like this without having to
> create custom qemu_config files.
>
> For consistency with --kernel_args, we allow users to repeat this
> argument, e.g. you can tack on a --qemu_args='-m 2048', or you could
> just append it to the first string ('-smp 8 -m 2048').
>
> Signed-off-by: Daniel Latypov <dlatypov@google.com>
> ---

I like this -- it's definitely something I've wanted to have in the
past. I was a bit worried about how we'd handle longer strings of
arguments, but the combination of the shlex-based splitting and
repeated arguments seems to work for all the cases I can think of.
(And it's much nicer than, e.g, passing linker flags with -Wl,a,b,c in
my opinion!)

Reviewed-by: David Gow <davidgow@google.com>


-- David

>  tools/testing/kunit/kunit.py           | 14 +++++++++++++-
>  tools/testing/kunit/kunit_kernel.py    | 10 +++++++---
>  tools/testing/kunit/kunit_tool_test.py | 20 +++++++++++++++++---
>  3 files changed, 37 insertions(+), 7 deletions(-)
>
> diff --git a/tools/testing/kunit/kunit.py b/tools/testing/kunit/kunit.py
> index 8a90d80ee66e..e01c7964f744 100755
> --- a/tools/testing/kunit/kunit.py
> +++ b/tools/testing/kunit/kunit.py
> @@ -10,6 +10,7 @@
>  import argparse
>  import os
>  import re
> +import shlex
>  import sys
>  import time
>
> @@ -323,6 +324,10 @@ def add_common_opts(parser) -> None:
>                                   'a QemuArchParams object.'),
>                             type=str, metavar='FILE')
>
> +       parser.add_argument('--qemu_args',
> +                           help='Additional QEMU arguments, e.g. "-smp 8"',
> +                           action='append', metavar='')
> +
>  def add_build_opts(parser) -> None:
>         parser.add_argument('--jobs',
>                             help='As in the make command, "Specifies  the number of '
> @@ -368,12 +373,19 @@ def add_parse_opts(parser) -> None:
>
>  def tree_from_args(cli_args: argparse.Namespace) -> kunit_kernel.LinuxSourceTree:
>         """Returns a LinuxSourceTree based on the user's arguments."""
> +       # Allow users to specify multiple arguments in one string, e.g. '-smp 8'
> +       qemu_args: List[str] = []
> +       if cli_args.qemu_args:
> +               for arg in cli_args.qemu_args:
> +                       qemu_args.extend(shlex.split(arg))
> +
>         return kunit_kernel.LinuxSourceTree(cli_args.build_dir,
>                         kunitconfig_path=cli_args.kunitconfig,
>                         kconfig_add=cli_args.kconfig_add,
>                         arch=cli_args.arch,
>                         cross_compile=cli_args.cross_compile,
> -                       qemu_config_path=cli_args.qemu_config)
> +                       qemu_config_path=cli_args.qemu_config,
> +                       extra_qemu_args=qemu_args)
>
>
>  def main(argv):
> diff --git a/tools/testing/kunit/kunit_kernel.py b/tools/testing/kunit/kunit_kernel.py
> index e93f07ac0af1..a791073d25f9 100644
> --- a/tools/testing/kunit/kunit_kernel.py
> +++ b/tools/testing/kunit/kunit_kernel.py
> @@ -187,6 +187,7 @@ def _default_qemu_config_path(arch: str) -> str:
>         raise ConfigError(arch + ' is not a valid arch, options are ' + str(sorted(options)))
>
>  def _get_qemu_ops(config_path: str,
> +                 extra_qemu_args: Optional[List[str]],
>                   cross_compile: Optional[str]) -> Tuple[str, LinuxSourceTreeOperations]:
>         # The module name/path has very little to do with where the actual file
>         # exists (I learned this through experimentation and could not find it
> @@ -207,6 +208,8 @@ def _get_qemu_ops(config_path: str,
>         if not hasattr(config, 'QEMU_ARCH'):
>                 raise ValueError('qemu_config module missing "QEMU_ARCH": ' + config_path)
>         params: qemu_config.QemuArchParams = config.QEMU_ARCH  # type: ignore
> +       if extra_qemu_args:
> +               params.extra_qemu_params.extend(extra_qemu_args)
>         return params.linux_arch, LinuxSourceTreeOperationsQemu(
>                         params, cross_compile=cross_compile)
>
> @@ -220,17 +223,18 @@ class LinuxSourceTree:
>               kconfig_add: Optional[List[str]]=None,
>               arch=None,
>               cross_compile=None,
> -             qemu_config_path=None) -> None:
> +             qemu_config_path=None,
> +             extra_qemu_args=None) -> None:
>                 signal.signal(signal.SIGINT, self.signal_handler)
>                 if qemu_config_path:
> -                       self._arch, self._ops = _get_qemu_ops(qemu_config_path, cross_compile)
> +                       self._arch, self._ops = _get_qemu_ops(qemu_config_path, extra_qemu_args, cross_compile)
>                 else:
>                         self._arch = 'um' if arch is None else arch
>                         if self._arch == 'um':
>                                 self._ops = LinuxSourceTreeOperationsUml(cross_compile=cross_compile)
>                         else:
>                                 qemu_config_path = _default_qemu_config_path(self._arch)
> -                               _, self._ops = _get_qemu_ops(qemu_config_path, cross_compile)
> +                               _, self._ops = _get_qemu_ops(qemu_config_path, extra_qemu_args, cross_compile)
>
>                 if kunitconfig_path:
>                         if os.path.isdir(kunitconfig_path):
> diff --git a/tools/testing/kunit/kunit_tool_test.py b/tools/testing/kunit/kunit_tool_test.py
> index baee11d96474..7fe5c8b0fb57 100755
> --- a/tools/testing/kunit/kunit_tool_test.py
> +++ b/tools/testing/kunit/kunit_tool_test.py
> @@ -649,7 +649,8 @@ class KUnitMainTest(unittest.TestCase):
>                                                 kconfig_add=None,
>                                                 arch='um',
>                                                 cross_compile=None,
> -                                               qemu_config_path=None)
> +                                               qemu_config_path=None,
> +                                               extra_qemu_args=[])
>
>         def test_config_kunitconfig(self):
>                 kunit.main(['config', '--kunitconfig=mykunitconfig'])
> @@ -659,7 +660,8 @@ class KUnitMainTest(unittest.TestCase):
>                                                 kconfig_add=None,
>                                                 arch='um',
>                                                 cross_compile=None,
> -                                               qemu_config_path=None)
> +                                               qemu_config_path=None,
> +                                               extra_qemu_args=[])
>
>         def test_run_kconfig_add(self):
>                 kunit.main(['run', '--kconfig_add=CONFIG_KASAN=y', '--kconfig_add=CONFIG_KCSAN=y'])
> @@ -669,7 +671,19 @@ class KUnitMainTest(unittest.TestCase):
>                                                 kconfig_add=['CONFIG_KASAN=y', 'CONFIG_KCSAN=y'],
>                                                 arch='um',
>                                                 cross_compile=None,
> -                                               qemu_config_path=None)
> +                                               qemu_config_path=None,
> +                                               extra_qemu_args=[])
> +
> +       def test_run_qemu_args(self):
> +               kunit.main(['run', '--arch=x86_64', '--qemu_args', '-m 2048'])
> +               # Just verify that we parsed and initialized it correctly here.
> +               self.mock_linux_init.assert_called_once_with('.kunit',
> +                                               kunitconfig_path=None,
> +                                               kconfig_add=None,
> +                                               arch='x86_64',
> +                                               cross_compile=None,
> +                                               qemu_config_path=None,
> +                                               extra_qemu_args=['-m', '2048'])
>
>         def test_run_kernel_args(self):
>                 kunit.main(['run', '--kernel_args=a=1', '--kernel_args=b=2'])
> --
> 2.36.1.124.g0e6072fb45-goog
>
Brendan Higgins July 6, 2022, 8:11 p.m. UTC | #2 
On Wed, May 18, 2022 at 1:01 PM Daniel Latypov <dlatypov@google.com> wrote:
>
> Example usage:
> $ ./tools/testing/kunit/kunit.py run --arch=x86_64 \
>   --kconfig_add=CONFIG_SMP=y --qemu_args='-smp 8'
>
> Looking in the test.log, one can see
> > smp: Bringing up secondary CPUs ...
> > .... node  #0, CPUs:      #1 #2 #3 #4 #5 #6 #7
> > smp: Brought up 1 node, 8 CPUs
>
> This flag would allow people to make tweaks like this without having to
> create custom qemu_config files.
>
> For consistency with --kernel_args, we allow users to repeat this
> argument, e.g. you can tack on a --qemu_args='-m 2048', or you could
> just append it to the first string ('-smp 8 -m 2048').
>
> Signed-off-by: Daniel Latypov <dlatypov@google.com>

Reviewed-by: Brendan Higgins <brendanhiggins@google.com>
diff mbox series

Patch

diff --git a/tools/testing/kunit/kunit.py b/tools/testing/kunit/kunit.py
index 8a90d80ee66e..e01c7964f744 100755
--- a/tools/testing/kunit/kunit.py
+++ b/tools/testing/kunit/kunit.py
@@ -10,6 +10,7 @@ 
 import argparse
 import os
 import re
+import shlex
 import sys
 import time
 
@@ -323,6 +324,10 @@  def add_common_opts(parser) -> None:
 				  'a QemuArchParams object.'),
 			    type=str, metavar='FILE')
 
+	parser.add_argument('--qemu_args',
+			    help='Additional QEMU arguments, e.g. "-smp 8"',
+			    action='append', metavar='')
+
 def add_build_opts(parser) -> None:
 	parser.add_argument('--jobs',
 			    help='As in the make command, "Specifies  the number of '
@@ -368,12 +373,19 @@  def add_parse_opts(parser) -> None:
 
 def tree_from_args(cli_args: argparse.Namespace) -> kunit_kernel.LinuxSourceTree:
 	"""Returns a LinuxSourceTree based on the user's arguments."""
+	# Allow users to specify multiple arguments in one string, e.g. '-smp 8'
+	qemu_args: List[str] = []
+	if cli_args.qemu_args:
+		for arg in cli_args.qemu_args:
+			qemu_args.extend(shlex.split(arg))
+
 	return kunit_kernel.LinuxSourceTree(cli_args.build_dir,
 			kunitconfig_path=cli_args.kunitconfig,
 			kconfig_add=cli_args.kconfig_add,
 			arch=cli_args.arch,
 			cross_compile=cli_args.cross_compile,
-			qemu_config_path=cli_args.qemu_config)
+			qemu_config_path=cli_args.qemu_config,
+			extra_qemu_args=qemu_args)
 
 
 def main(argv):
diff --git a/tools/testing/kunit/kunit_kernel.py b/tools/testing/kunit/kunit_kernel.py
index e93f07ac0af1..a791073d25f9 100644
--- a/tools/testing/kunit/kunit_kernel.py
+++ b/tools/testing/kunit/kunit_kernel.py
@@ -187,6 +187,7 @@  def _default_qemu_config_path(arch: str) -> str:
 	raise ConfigError(arch + ' is not a valid arch, options are ' + str(sorted(options)))
 
 def _get_qemu_ops(config_path: str,
+		  extra_qemu_args: Optional[List[str]],
 		  cross_compile: Optional[str]) -> Tuple[str, LinuxSourceTreeOperations]:
 	# The module name/path has very little to do with where the actual file
 	# exists (I learned this through experimentation and could not find it
@@ -207,6 +208,8 @@  def _get_qemu_ops(config_path: str,
 	if not hasattr(config, 'QEMU_ARCH'):
 		raise ValueError('qemu_config module missing "QEMU_ARCH": ' + config_path)
 	params: qemu_config.QemuArchParams = config.QEMU_ARCH  # type: ignore
+	if extra_qemu_args:
+		params.extra_qemu_params.extend(extra_qemu_args)
 	return params.linux_arch, LinuxSourceTreeOperationsQemu(
 			params, cross_compile=cross_compile)
 
@@ -220,17 +223,18 @@  class LinuxSourceTree:
 	      kconfig_add: Optional[List[str]]=None,
 	      arch=None,
 	      cross_compile=None,
-	      qemu_config_path=None) -> None:
+	      qemu_config_path=None,
+	      extra_qemu_args=None) -> None:
 		signal.signal(signal.SIGINT, self.signal_handler)
 		if qemu_config_path:
-			self._arch, self._ops = _get_qemu_ops(qemu_config_path, cross_compile)
+			self._arch, self._ops = _get_qemu_ops(qemu_config_path, extra_qemu_args, cross_compile)
 		else:
 			self._arch = 'um' if arch is None else arch
 			if self._arch == 'um':
 				self._ops = LinuxSourceTreeOperationsUml(cross_compile=cross_compile)
 			else:
 				qemu_config_path = _default_qemu_config_path(self._arch)
-				_, self._ops = _get_qemu_ops(qemu_config_path, cross_compile)
+				_, self._ops = _get_qemu_ops(qemu_config_path, extra_qemu_args, cross_compile)
 
 		if kunitconfig_path:
 			if os.path.isdir(kunitconfig_path):
diff --git a/tools/testing/kunit/kunit_tool_test.py b/tools/testing/kunit/kunit_tool_test.py
index baee11d96474..7fe5c8b0fb57 100755
--- a/tools/testing/kunit/kunit_tool_test.py
+++ b/tools/testing/kunit/kunit_tool_test.py
@@ -649,7 +649,8 @@  class KUnitMainTest(unittest.TestCase):
 						kconfig_add=None,
 						arch='um',
 						cross_compile=None,
-						qemu_config_path=None)
+						qemu_config_path=None,
+						extra_qemu_args=[])
 
 	def test_config_kunitconfig(self):
 		kunit.main(['config', '--kunitconfig=mykunitconfig'])
@@ -659,7 +660,8 @@  class KUnitMainTest(unittest.TestCase):
 						kconfig_add=None,
 						arch='um',
 						cross_compile=None,
-						qemu_config_path=None)
+						qemu_config_path=None,
+						extra_qemu_args=[])
 
 	def test_run_kconfig_add(self):
 		kunit.main(['run', '--kconfig_add=CONFIG_KASAN=y', '--kconfig_add=CONFIG_KCSAN=y'])
@@ -669,7 +671,19 @@  class KUnitMainTest(unittest.TestCase):
 						kconfig_add=['CONFIG_KASAN=y', 'CONFIG_KCSAN=y'],
 						arch='um',
 						cross_compile=None,
-						qemu_config_path=None)
+						qemu_config_path=None,
+						extra_qemu_args=[])
+
+	def test_run_qemu_args(self):
+		kunit.main(['run', '--arch=x86_64', '--qemu_args', '-m 2048'])
+		# Just verify that we parsed and initialized it correctly here.
+		self.mock_linux_init.assert_called_once_with('.kunit',
+						kunitconfig_path=None,
+						kconfig_add=None,
+						arch='x86_64',
+						cross_compile=None,
+						qemu_config_path=None,
+						extra_qemu_args=['-m', '2048'])
 
 	def test_run_kernel_args(self):
 		kunit.main(['run', '--kernel_args=a=1', '--kernel_args=b=2'])