Commit ef3ad089 authored by Linus Torvalds's avatar Linus Torvalds
Browse files

Merge tag 'linux-kselftest-4.13-rc1-update' of... 

Merge tag 'linux-kselftest-4.13-rc1-update' of git://git.kernel.org/pub/scm/linux/kernel/git/shuah/linux-kselftest

Pull Kselftest updates from Shuah Khan:
 "This update consists of:

   - TAP13 framework and changes to some tests to convert to TAP13.
     Converting kselftest output to standard format will help identify
     run to run differences and pin point failures easily. TAP13 format
     has been in use for several years and the output is human friendly.

     Please find the specification:
       https://testanything.org/tap-version-13-specification.html

     Credit goes to Tim Bird for recommending TAP13 as a suitable
     format, and to Grag KH for kick starting the work with help from
     Paul Elder and Alice Ferrazzi

     The first phase of the TAp13 conversion is included in this update.
     Future updates will include updates to rest of the tests.

   - Masami Hiramatsu fixed ftrace to run on 4.9 stable kernels.

   - Kselftest documnetation has been converted to ReST format. Document
     now has a new home under Documentation/dev-tools.

   - kselftest_harness.h is now available for general use as a result of
     Mickaël Salaün's work.

   - Several fixes to skip and/or fail tests gracefully on older
     releases"

* tag 'linux-kselftest-4.13-rc1-update' of git://git.kernel.org/pub/scm/linux/kernel/git/shuah/linux-kselftest: (48 commits)
  selftests: membarrier: use ksft_* var arg msg api
  selftests: breakpoints: breakpoint_test_arm64: convert test to use TAP13
  selftests: breakpoints: step_after_suspend_test use ksft_* var arg msg api
  selftests: breakpoint_test: use ksft_* var arg msg api
  kselftest: add ksft_print_msg() function to output general information
  kselftest: make ksft_* output functions variadic
  selftests/capabilities: Fix the test_execve test
  selftests: intel_pstate: add .gitignore
  selftests: fix memory-hotplug test
  selftests: add missing test name in memory-hotplug test
  selftests: check percentage range for memory-hotplug test
  selftests: check hot-pluggagble memory for memory-hotplug test
  selftests: typo correction for memory-hotplug test
  selftests: ftrace: Use md5sum to take less time of checking logs
  tools/testing/selftests/sysctl: Add pre-check to the value of writes_strict
  kselftest.rst: do some adjustments after ReST conversion
  selftest/net/Makefile: Specify output with $(OUTPUT)
  selftest/intel_pstate/aperf: Use LDLIBS instead of LDFLAGS
  selftest/memfd/Makefile: Fix build error
  selftests: lib: Skip tests on missing test modules
  ...
parents 37949075 e67f85fb

Documentation/00-INDEX

+0 −2
Original line number Diff line number Diff line
@@ -242,8 +242,6 @@ kprobes.txt 
	- documents the kernel probes debugging feature.

kref.txt

	- docs on adding reference counters (krefs) to kernel objects.

kselftest.txt

	- small unittests for (some) individual codepaths in the kernel.

laptops/

	- directory with laptop related info and laptop driver documentation.

ldm.txt

Documentation/dev-tools/index.rst

+1 −0
Original line number Diff line number Diff line
@@ -24,6 +24,7 @@ whole; patches welcome! 
   kmemcheck

   gdb-kernel-debugging

   kgdb

   kselftest





.. only::  subproject and html

Documentation/kselftest.txt→Documentation/dev-tools/kselftest.rst

+64 −18
Original line number Diff line number Diff line 
======================

Linux Kernel Selftests

======================



The kernel contains a set of "self tests" under the tools/testing/selftests/

directory. These are intended to be small tests to exercise individual code
@@ -15,28 +17,33 @@ hotplug test is run on 2% of hotplug capable memory instead of 10%. 
Running the selftests (hotplug tests are run in limited mode)

=============================================================



To build the tests:

To build the tests::



  $ make -C tools/testing/selftests



To run the tests::



To run the tests:

  $ make -C tools/testing/selftests run_tests



To build and run the tests with a single command, use:

To build and run the tests with a single command, use::



  $ make kselftest



- note that some tests will require root privileges.

Note that some tests will require root privileges.





Running a subset of selftests

========================================

=============================



You can use the "TARGETS" variable on the make command line to specify

single test to run, or a list of tests to run.



To run only tests targeted for a single subsystem:

To run only tests targeted for a single subsystem::



  $ make -C tools/testing/selftests TARGETS=ptrace run_tests



You can specify multiple tests to build and run:

You can specify multiple tests to build and run::



  $  make TARGETS="size timers" kselftest



See the top-level tools/testing/selftests/Makefile for the list of all
@@ -46,13 +53,15 @@ possible targets. 
Running the full range hotplug selftests

========================================



To build the hotplug tests:

To build the hotplug tests::



  $ make -C tools/testing/selftests hotplug



To run the hotplug tests:

To run the hotplug tests::



  $ make -C tools/testing/selftests run_hotplug



- note that some tests will require root privileges.

Note that some tests will require root privileges.





Install selftests
@@ -62,11 +71,13 @@ You can use kselftest_install.sh tool installs selftests in default 
location which is tools/testing/selftests/kselftest or a user specified

location.



To install selftests in default location:

To install selftests in default location::



   $ cd tools/testing/selftests

   $ ./kselftest_install.sh



To install selftests in a user specified location:

To install selftests in a user specified location::



   $ cd tools/testing/selftests

   $ ./kselftest_install.sh install_dir
@@ -77,10 +88,10 @@ Kselftest install as well as the Kselftest tarball provide a script 
named "run_kselftest.sh" to run the tests.



You can simply do the following to run the installed Kselftests. Please

note some tests will require root privileges.

note some tests will require root privileges::



cd kselftest

./run_kselftest.sh

   $ cd kselftest

   $ ./run_kselftest.sh



Contributing new tests

======================
@@ -97,13 +108,48 @@ In general, the rules for selftests are 
   unconfigured.



Contributing new tests (details)

===============================

================================



 * Use TEST_GEN_XXX if such binaries or files are generated during

   compiling.



   TEST_PROGS, TEST_GEN_PROGS mean it is the excutable tested by

   default.



   TEST_PROGS_EXTENDED, TEST_GEN_PROGS_EXTENDED mean it is the

   executable which is not tested by default.

   TEST_FILES, TEST_GEN_FILES mean it is the file which is used by

   test.



Test Harness

============



The kselftest_harness.h file contains useful helpers to build tests.  The tests

from tools/testing/selftests/seccomp/seccomp_bpf.c can be used as example.



Example

-------



.. kernel-doc:: tools/testing/selftests/kselftest_harness.h

    :doc: example





Helpers

-------



.. kernel-doc:: tools/testing/selftests/kselftest_harness.h

    :functions: TH_LOG TEST TEST_SIGNAL FIXTURE FIXTURE_DATA FIXTURE_SETUP

                FIXTURE_TEARDOWN TEST_F TEST_HARNESS_MAIN



Operators

---------



.. kernel-doc:: tools/testing/selftests/kselftest_harness.h

    :doc: operators



.. kernel-doc:: tools/testing/selftests/kselftest_harness.h

    :functions: ASSERT_EQ ASSERT_NE ASSERT_LT ASSERT_LE ASSERT_GT ASSERT_GE

                ASSERT_NULL ASSERT_TRUE ASSERT_NULL ASSERT_TRUE ASSERT_FALSE

                ASSERT_STREQ ASSERT_STRNE EXPECT_EQ EXPECT_NE EXPECT_LT

                EXPECT_LE EXPECT_GT EXPECT_GE EXPECT_NULL EXPECT_TRUE

                EXPECT_FALSE EXPECT_STREQ EXPECT_STRNE

MAINTAINERS

+4 −2
Original line number Diff line number Diff line
@@ -7337,9 +7337,10 @@ KERNEL SELFTEST FRAMEWORK 
M:	Shuah Khan <shuahkh@osg.samsung.com>

M:	Shuah Khan <shuah@kernel.org>

L:	linux-kselftest@vger.kernel.org

T:	git git://git.kernel.org/pub/scm/shuah/linux-kselftest

T:	git git://git.kernel.org/pub/scm/linux/kernel/git/shuah/linux-kselftest.git

S:	Maintained

F:	tools/testing/selftests

F:	tools/testing/selftests/

F:	Documentation/dev-tools/kselftest*



KERNEL VIRTUAL MACHINE (KVM)

M:	Paolo Bonzini <pbonzini@redhat.com>
@@ -11740,6 +11741,7 @@ F: kernel/seccomp.c 
F:	include/uapi/linux/seccomp.h

F:	include/linux/seccomp.h

F:	tools/testing/selftests/seccomp/*

F:	tools/testing/selftests/kselftest_harness.h

F:	Documentation/userspace-api/seccomp_filter.rst

K:	\bsecure_computing

K:	\bTIF_SECCOMP\b

kernel/trace/trace.c

+2 −1
Original line number Diff line number Diff line
@@ -4564,7 +4564,8 @@ static const char readme_msg[] = 
#endif

#if defined(CONFIG_KPROBE_EVENTS) || defined(CONFIG_UPROBE_EVENTS)

	"\t  accepts: event-definitions (one definition per line)\n"

	"\t   Format: p|r[:[<group>/]<event>] <place> [<args>]\n"

	"\t   Format: p[:[<group>/]<event>] <place> [<args>]\n"

	"\t           r[maxactive][:[<group>/]<event>] <place> [<args>]\n"

	"\t           -:[<group>/]<event>\n"

#ifdef CONFIG_KPROBE_EVENTS

	"\t    place: [<module>:]<symbol>[+<offset>]|<memaddr>\n"

CRA Git | Maintained and supported by SUSTech CRA and CCSE