Initial commit

blktests is heavily inspired by xfstests, with a few important
differences:

- It can run tests on multiple devices at once (serialized for now, but
  this can be changed).
- It has a notion of per-device tests (e.g., for testing specific I/O
  workloads that have been known to cause problems) and no-device tests
  (e.g., for tests that set up pseudo-devices).
- It has documentation.
- It's not ancient, so the framework is much cleaner.

Also included is a set of "meta" tests, i.e., tests that test the
testing framework itself.

Signed-off-by: Omar Sandoval <osandov@fb.com>

diff --git a/.gitignore b/.gitignore
new file mode 100644 (file)
index 0000000..bfcbe4e
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,3 @@
+/config
+/results
+/results.last

diff --git a/Documentation/running-tests.md b/Documentation/running-tests.md
new file mode 100644 (file)
index 0000000..4eef775
--- /dev/null
+++ b/Documentation/running-tests.md
@@ -0,0 +1,92 @@
+# Running Tests
+
+The `./check` script executes tests. Without any arguments, it executes the
+default set of tests. `./check` exits with a zero exit status if all tests
+passed and non-zero otherwise.
+
+## Test Organization
+
+Tests are split up into various categories, which are the subdirectories of the
+`tests` directory. For example, `tests/loop` contains tests for loop devices,
+and `tests/block` contains generic block layer tests.
+
+Tests also belong to one or more groups. Each test category is also a group.
+Additionally, there is a group for common functionality like "discard".
+Finally, there are a couple of basic groups:
+
+- The `auto` group is the default set of tests. These tests are expected to
+  pass reliably.
+- The `quick` group is a subset of `auto` comprising tests that complete
+  "quickly" (i.e., in ~30 seconds or less on reasonable hardware).
+
+`./check` can execute individual tests or test groups, as well as exclude tests
+or test groups. See `./check -h`.
+
+## Configuration
+
+Test configuration goes in the `config` file at the top-level directory of the
+blktests repository.
+
+### Test Devices
+
+The `TEST_DEVS` variable is an array of block devices to test on. Tests will be
+run on all of these devices where applicable. Note that tests are destructive
+and will overwrite any data on these devices.
+
+```sh
+TEST_DEVS=(/dev/nvme0n1 /dev/sdb)
+```
+
+## Test Results
+
+In addition to printing a summary as the tests run, test results are recorded
+in the `results` directory. The layout of that directory looks like this:
+
+```
+results
+|_ nodev
+|  |_ log
+|  \_ loop
+|     |_ 001.full
+|     \_ ...
+|_ nvme0n1
+|  |_ log
+|  \_ block
+|     |_ 001.full
+|     |_ 002.out.bad
+|     |_ 002.full
+|     |_ 003.dmesg
+|     |_ 004.exitstatus
+|     \_ ...
+\_ sdb1
+   |_ log
+   \_ block
+      \_ ...
+```
+
+The `results` directory contains a directory for each device that the tests
+were run on, and a directory named `nodev` for tests that don't run on a
+specific device. Each of those directories has a file, `log`, formatted like
+so:
+
+```
+block/001 pass 1
+block/002 fail out
+block/003 fail dmesg
+block/004 fail exit
+```
+
+I.e., column 1 is the test name and column 2 is the status (`pass` or `fail`) .
+Column 3 depends on the status:
+
+- For `pass`, it is how many seconds the test took to execute.
+- For `fail`, it is the reason the test failed.
+    - If the reason is `out`, the output didn't match the reference output. In
+      this case, `${TEST_NAME}.out.bad` contains the bad output.
+    - If the reason is `exit`, the test exited with a non-zero status. In this
+      case, `${TEST_NAME}.exitstatus` contains the exit status.
+    - If the reason is `dmesg`, there was a warning, oops, etc. in `dmesg`. In
+      this case, the messages will be in `${TEST_NAME}.dmesg`.
+
+Finally, if the test logged any verbose output, it is available in
+`${TEST_NAME}.full`.

diff --git a/Documentation/writing-tests.md b/Documentation/writing-tests.md
new file mode 100644 (file)
index 0000000..7cb8043
--- /dev/null
+++ b/Documentation/writing-tests.md
@@ -0,0 +1,146 @@
+# Writing Tests
+
+The `./new` script creates new test cases and categories from a template. The
+template includes `TODO` comments where the test should be filled in.
+
+## Categories
+
+Each category has a top-level bash script, `category`, which defines the
+requirements for that category.
+
+The `category` script should define a `prepare()` function which returns zero
+if tests in that category can be run and non-zero otherwise, in which case it
+should set the `$SKIP_REASON` variable. Usually, `prepare()` should just call
+any relevant `_have_foo` helpers to check that necessary programs and kernel
+features are available. For example,
+
+```sh
+prepare() {
+       _have_loop && _have_wbt
+}
+```
+
+Additionally, the `category` script should define a `prepare_device()`
+function. `prepare_device()` will be called with the `$TEST_DEV` variable
+defined and should return zero if tests in that category can be run on
+`$TEST_DEV` and non-zero otherwise. Usually, `prepare_device()` should just
+call any relevant `_test_dev_foo` helpers to check, for example, that the
+device is the right kind of hardware.
+
+```sh
+prepare_device() {
+       _test_dev_is_nvme
+}
+```
+
+If the category has no special requirements, `prepare()` and/or
+`prepare_device()` can just `return 0`.
+
+Functions (other than `prepare()` and `prepare_device()`) and variables defined
+in the `category` script will be available in the test cases themselves.
+
+## Test Cases
+
+Tests are bash scripts defining a few functions and variables as described
+below.
+
+Tests are executed with a few basic shell variables defined. The `$TEST_NAME`
+variable is the full name of the test. The `$FULL` variable is a file path in
+the `results` directory where you can log verbose output to. The `$TMPDIR`
+variable is a temporary directory created before the test and removed after it
+runs.
+
+`test()` is the main test function; its output (stdout and stderr) is compared
+to `tests/${TEST_NAME}.out`. If the output does not match, the test is
+considered a failure. Additionally, if `test()` returns non-zero, it is
+considered a failure. You should prefer letting the test fail because of broken
+output over, say, checking the exit status of every command you run.
+
+### Tests Not Requiring a Device
+
+Many tests do not require a configured block device, usually because they set
+up a pseudo-device like null-blk or scsi-debug. These test should define a
+`test()` function. They can also define a `prepare()` function which works the
+same way as it does in the `category` script. The `test()` function will be
+called iff the `prepare()` function returned zero.
+
+### Device Tests
+
+Tests that require a device should define `test_device()` instead of `test()`.
+`test_device()` is called with the `$TEST_DEV` variable defined for each device
+the test should run on. It is not called for any devices for which the
+`category` script's `prepare_device()` returned non-zero. Additionally, the
+test can define its own `prepare()` or `prepare_device()` functions.
+
+### Test Groups
+
+The `GROUPS` array variable defines the groups that the test belongs to. The
+test is automatically added to a group for the test category and the "auto"
+group. If the test shouldn't be run by default (e.g., because it is flaky or
+dangerous to run), remove the "auto" group. If the test runs quickly (i.e., ~30
+seconds or less on reasonable hardware), add the "quick" group.
+
+Add any other groups describing what functionality is exercised by the test,
+like "discard" or "hotplug". Feel free to add new groups if it makes sense.
+
+### Helpers
+
+`common` contains several helper libraries which you can source in your test.
+Functionality shared between tests should be factored out into these helper
+scripts.
+
+In addition to the `_have_foo` and `_test_dev_foo` helpers mentioned, the
+`_filter_foo`-style helpers are commonly used for removing test-specific output
+so it matches the golden output.
+
+### Dmesg
+
+By default, the testing framework checks `dmesg` for warnings, oopses, etc.,
+after a test runs. You can suppress this with
+
+```sh
+CHECK_DMESG=0
+```
+
+If there are specific oopses or warnings you want to suppress, you can define a
+filter:
+
+```sh
+DMESG_FILTER="grep -v sysfs"
+```
+
+### Regression Tests
+
+If the test you are writing is a regression test, make sure you indicate this
+in the test description. For a patch, use the patch title:
+
+``` sh
+# Regression test for patch "blk-stat: fix blk_stat_sum() if all samples are
+# batched".
+```
+
+For a commit, use the first 12 characters of the commit hash and the one-line
+commit summary:
+
+``` sh
+# Regression test for commit efd4b81abbe1 ("blk-stat: fix blk_stat_sum() if all
+# samples are batched").
+```
+
+## Coding Style and General Guidelines
+
+- Indent with tabs.
+- Don't add a space before the parentheses or a newline before the curly brace
+  in function definitions.
+- Variables set and used by the testing framework are in caps with underscores.
+  E.g., `TEST_NAME` and `GROUPS`. Variables local to the test are lowercase
+  with underscores.
+- Functions defined by the testing framework, including helpers, have a leading
+  underscore. E.g., `_have_scsi_debug`. Functions local to the test or category
+  should not have a leading underscore.
+- Use the bash `[[ ]]` form of tests instead of `[ ]`.
+- Always quote variable expansions unless the variable is a number or inside of
+  a `[[ ]]` test.
+- Use the `$()` form of command substitution instead of backticks.
+- Use bash for loops instead of `seq`. E.g., `for ((i = 0; i < 10; i++))`, not
+  `for i in $(seq 0 9)`.

diff --git a/LICENSE b/LICENSE
new file mode 100644 (file)
index 0000000..94a9ed0
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,674 @@
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+  The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works.  By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users.  We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors.  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+  To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights.  Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received.  You must make sure that they, too, receive
+or can get the source code.  And you must show them these terms so they
+know their rights.
+
+  Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+  For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software.  For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+  Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so.  This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software.  The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable.  Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products.  If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+  Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary.  To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                       TERMS AND CONDITIONS
+
+  0. Definitions.
+
+  "This License" refers to version 3 of the GNU General Public License.
+
+  "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+  "The Program" refers to any copyrightable work licensed under this
+License.  Each licensee is addressed as "you".  "Licensees" and
+"recipients" may be individuals or organizations.
+
+  To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy.  The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+  A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+  To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy.  Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+  To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies.  Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+  An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License.  If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+  1. Source Code.
+
+  The "source code" for a work means the preferred form of the work
+for making modifications to it.  "Object code" means any non-source
+form of a work.
+
+  A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+  The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form.  A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+  The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities.  However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work.  For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+  The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+  The Corresponding Source for a work in source code form is that
+same work.
+
+  2. Basic Permissions.
+
+  All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met.  This License explicitly affirms your unlimited
+permission to run the unmodified Program.  The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work.  This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+  You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force.  You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright.  Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+  Conveying under any other circumstances is permitted solely under
+the conditions stated below.  Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+  No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+  When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+  4. Conveying Verbatim Copies.
+
+  You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+  You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+  5. Conveying Modified Source Versions.
+
+  You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+    a) The work must carry prominent notices stating that you modified
+    it, and giving a relevant date.
+
+    b) The work must carry prominent notices stating that it is
+    released under this License and any conditions added under section
+    7.  This requirement modifies the requirement in section 4 to
+    "keep intact all notices".
+
+    c) You must license the entire work, as a whole, under this
+    License to anyone who comes into possession of a copy.  This
+    License will therefore apply, along with any applicable section 7
+    additional terms, to the whole of the work, and all its parts,
+    regardless of how they are packaged.  This License gives no
+    permission to license the work in any other way, but it does not
+    invalidate such permission if you have separately received it.
+
+    d) If the work has interactive user interfaces, each must display
+    Appropriate Legal Notices; however, if the Program has interactive
+    interfaces that do not display Appropriate Legal Notices, your
+    work need not make them do so.
+
+  A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit.  Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+  6. Conveying Non-Source Forms.
+
+  You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+    a) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by the
+    Corresponding Source fixed on a durable physical medium
+    customarily used for software interchange.
+
+    b) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by a
+    written offer, valid for at least three years and valid for as
+    long as you offer spare parts or customer support for that product
+    model, to give anyone who possesses the object code either (1) a
+    copy of the Corresponding Source for all the software in the
+    product that is covered by this License, on a durable physical
+    medium customarily used for software interchange, for a price no
+    more than your reasonable cost of physically performing this
+    conveying of source, or (2) access to copy the
+    Corresponding Source from a network server at no charge.
+
+    c) Convey individual copies of the object code with a copy of the
+    written offer to provide the Corresponding Source.  This
+    alternative is allowed only occasionally and noncommercially, and
+    only if you received the object code with such an offer, in accord
+    with subsection 6b.
+
+    d) Convey the object code by offering access from a designated
+    place (gratis or for a charge), and offer equivalent access to the
+    Corresponding Source in the same way through the same place at no
+    further charge.  You need not require recipients to copy the
+    Corresponding Source along with the object code.  If the place to
+    copy the object code is a network server, the Corresponding Source
+    may be on a different server (operated by you or a third party)
+    that supports equivalent copying facilities, provided you maintain
+    clear directions next to the object code saying where to find the
+    Corresponding Source.  Regardless of what server hosts the
+    Corresponding Source, you remain obligated to ensure that it is
+    available for as long as needed to satisfy these requirements.
+
+    e) Convey the object code using peer-to-peer transmission, provided
+    you inform other peers where the object code and Corresponding
+    Source of the work are being offered to the general public at no
+    charge under subsection 6d.
+
+  A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+  A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling.  In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage.  For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product.  A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+  "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source.  The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+  If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information.  But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+  The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed.  Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+  Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+  7. Additional Terms.
+
+  "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law.  If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+  When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it.  (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.)  You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+  Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+    a) Disclaiming warranty or limiting liability differently from the
+    terms of sections 15 and 16 of this License; or
+
+    b) Requiring preservation of specified reasonable legal notices or
+    author attributions in that material or in the Appropriate Legal
+    Notices displayed by works containing it; or
+
+    c) Prohibiting misrepresentation of the origin of that material, or
+    requiring that modified versions of such material be marked in
+    reasonable ways as different from the original version; or
+
+    d) Limiting the use for publicity purposes of names of licensors or
+    authors of the material; or
+
+    e) Declining to grant rights under trademark law for use of some
+    trade names, trademarks, or service marks; or
+
+    f) Requiring indemnification of licensors and authors of that
+    material by anyone who conveys the material (or modified versions of
+    it) with contractual assumptions of liability to the recipient, for
+    any liability that these contractual assumptions directly impose on
+    those licensors and authors.
+
+  All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10.  If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term.  If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+  If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+  Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+  8. Termination.
+
+  You may not propagate or modify a covered work except as expressly
+provided under this License.  Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+  However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+  Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+  Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License.  If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+  9. Acceptance Not Required for Having Copies.
+
+  You are not required to accept this License in order to receive or
+run a copy of the Program.  Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance.  However,
+nothing other than this License grants you permission to propagate or
+modify any covered work.  These actions infringe copyright if you do
+not accept this License.  Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+  10. Automatic Licensing of Downstream Recipients.
+
+  Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License.  You are not responsible
+for enforcing compliance by third parties with this License.
+
+  An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations.  If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+  You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License.  For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+  11. Patents.
+
+  A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based.  The
+work thus licensed is called the contributor's "contributor version".
+
+  A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version.  For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+  Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+  In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement).  To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+  If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients.  "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+  If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+  A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License.  You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+  Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+  12. No Surrender of Others' Freedom.
+
+  If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all.  For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+  13. Use with the GNU Affero General Public License.
+
+  Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work.  The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+  14. Revised Versions of this License.
+
+  The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+  Each version is given a distinguishing version number.  If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation.  If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+  If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+  Later license versions may give you additional or different
+permissions.  However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+  15. Disclaimer of Warranty.
+
+  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+  16. Limitation of Liability.
+
+  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+  17. Interpretation of Sections 15 and 16.
+
+  If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+  If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+    <program>  Copyright (C) <year>  <name of author>
+    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+  You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+<http://www.gnu.org/licenses/>.
+
+  The GNU General Public License does not permit incorporating your program
+into proprietary programs.  If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.  But first, please read
+<http://www.gnu.org/philosophy/why-not-lgpl.html>.

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..ca36378
--- /dev/null
+++ b/README.md
@@ -0,0 +1,33 @@
+# blktests
+
+blktests is a test framework for the Linux kernel block layer and storage
+stack. It is inspired by the [xfstests](https://git.kernel.org/pub/scm/fs/xfs/xfstests-dev.git/)
+filesystem testing framework.
+
+## Getting Started
+
+The dependencies are minimal, but make sure you have them installed:
+
+- bash
+- GNU coreutils
+- util-linux
+- fio
+
+Add the list of block devices you want to test on in a file named `config`:
+
+```sh
+TEST_DEVS=(/dev/nvme0n1 /dev/sdb)
+```
+
+And as root, run the default set of tests with `./check`.
+
+Note that these tests are destructive, so don't add anything to the `TEST_DEVS`
+array containing data that you want to keep.
+
+[Documentation/running-tests.md] has more detailed information on configuration
+and running tests.
+
+## Adding Tests
+
+The `./new` script creates a new test from a template.
+[Documentation/writing-tests.md] has more information on how to write a test.

diff --git a/check b/check
new file mode 100755 (executable)
index 0000000..49403fa
--- /dev/null
+++ b/check
@@ -0,0 +1,334 @@
+#!/bin/bash
+#
+# Copyright (C) 2017 Omar Sandoval
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+. common/rc
+
+usage () {
+       USAGE_STRING="\
+usage: $0 [-g group] [-x exclude_group] [test...]
+       $0 -h
+
+Test groups:
+  -g group    run tests belonging to this group; may be specified multiple
+              times
+  -x group    don't run tests belonging to this group; takes precedence over
+              -g, may be specified multiple times
+
+Miscellaneous:
+  -h    display this help message and exit
+
+Examples:
+Run the default set of tests, i.e., the \"auto\" group:
+    ./check
+Run all NVMe and SCSI tests except for those that involve discard:
+    ./check -g nvme -g scsi -x discard
+Run two specific tests:
+    ./check block/001 block/002
+Run a specific test in addition to the default set of tests:
+    ./check -g auto block/003"
+
+       case "$1" in
+               out)
+                       echo "$USAGE_STRING"
+                       exit 0
+                       ;;
+               err)
+                       echo "$USAGE_STRING" >&2
+                       exit 1
+                       ;;
+       esac
+}
+
+declare -A INCLUDE_GROUPS
+declare -A EXCLUDE_GROUPS
+declare -A TESTS
+
+while getopts "g:x:h" OPT; do
+       case "$OPT" in
+               g)
+                       INCLUDE_GROUPS["$OPTARG"]=1
+                       ;;
+               x)
+                       EXCLUDE_GROUPS["$OPTARG"]=1
+                       ;;
+               h)
+                       usage out;
+                       ;;
+               *)
+                       usage err;
+                       ;;
+       esac
+done
+
+shift $((OPTIND - 1))
+
+for test in "$@"; do
+       TESTS["$test"]=1
+done
+
+if [[ ${#TESTS[@]} -eq 0 && ${#INCLUDE_GROUPS[@]} -eq 0 ]]; then
+       INCLUDE_GROUPS[auto]=1
+fi
+
+if ! . config; then
+       exit 1
+fi
+
+if [[ ! -v TEST_DEVS ]]; then
+       _error "\$TEST_DEVS not defined in ./config"
+fi
+
+for TEST_DEV in "${TEST_DEVS[@]}"; do
+       if [[ ! -e $TEST_DEV ]]; then
+               _error "${TEST_DEV} does not exist"
+       elif [[ ! -b $TEST_DEV ]]; then
+               _error "${TEST_DEV} is not a block device"
+       fi
+done
+
+_call_test() {
+       local test_func="$1"
+       local seqres="${RESULTS_DIR}/${TEST_NAME}"
+       local fail
+       local elapsed
+       FULL="${seqres}.full"
+
+       mkdir -p "$(dirname "$seqres")"
+
+       if [[ -w /dev/kmsg ]]; then
+               local dmesg_marker="run blktests $TEST_NAME at $(date "+%F %T")"
+               echo "$dmesg_marker" >> /dev/kmsg
+       else
+               CHECK_DMESG=0
+       fi
+
+       TMPDIR="$(mktemp --tmpdir -d "blktests.${category}.${seq}.XXX")"
+       if [[ $? -ne 0 ]]; then
+               retur
+       fi
+
+       TIMEFORMAT="%R"
+       elapsed="$(time ( "$test_func" >"${seqres}.out" 2>&1 ) 2>&1)"
+       local exit_status=$?
+
+       rm -rf "$TMPDIR"
+
+       if ! diff "tests/${TEST_NAME}.out" "${seqres}.out" >/dev/null; then
+               mv "${seqres}.out" "${seqres}.out.bad"
+               printf '[failed]\n'
+               diff -u "tests/${TEST_NAME}.out" "${seqres}.out.bad" | awk "
+               {
+                       if (NR > 10) {
+                               print \"    ...\"
+                               print \"    (Run 'diff -u tests/${TEST_NAME}.out ${seqres}.out.bad' to see the entire diff)\"
+                               exit
+                       }
+                       print \"    \" \$0
+               }"
+               fail=out
+       elif [[ $exit_status -ne 0 ]]; then
+               echo "$exit_status" > "${seqres}.exitstatus"
+               printf '[failed]\n    exited with status %d\n' $exit_status
+               fail=exit
+       elif [[ $CHECK_DMESG -ne 0 ]]; then
+               dmesg | bash -c "$DMESG_FILTER" | grep -A 9999 "$dmesg_marker" >"${seqres}.dmesg"
+               grep -q -e "kernel BUG at" \
+                    -e "WARNING:" \
+                    -e "BUG:" \
+                    -e "Oops:" \
+                    -e "possible recursive locking detected" \
+                    -e "Internal error" \
+                    -e "INFO: suspicious RCU usage" \
+                    -e "INFO: possible circular locking dependency detected" \
+                    -e "general protection fault:" \
+                    "${seqres}.dmesg"
+               if [[ $? -eq 0 ]]; then
+                       printf '[failed]\n    something found in dmesg:\n'
+                       awk "
+                       {
+                               if (NR > 10) {
+                                       print \"    ...\"
+                                       print \"    (See '${seqres}.dmesg' for the entire message)\"
+                                       exit
+                               }
+                               print \"    \" \$0
+                       }" < "${seqres}.dmesg"
+                       fail=dmesg
+               else
+                       rm -f "${seqres}.dmesg"
+               fi
+       fi
+       rm -f "${seqres}.out"
+
+       if [[ -z "$fail" ]]; then
+               printf '%.1fs\n' "$elapsed"
+               echo "${TEST_NAME} pass ${elapsed}" >> "${RESULTS_DIR}/log"
+               return 0
+       else
+               if [[ -e $FULL ]]; then
+                       echo "    (There may be more information in $FULL)"
+               fi
+               echo "${TEST_NAME} fail ${fail}" >> "${RESULTS_DIR}/log"
+               return 1
+       fi
+}
+
+_should_run_test() {
+       local test
+       local group
+       local include_group
+       local exclude_group
+
+       if [[ -n ${TESTS[$TEST_NAME]} ]]; then
+               return 0
+       fi
+
+       local ret=1
+       for group in "${TEST_GROUPS[@]}"; do
+               if [[ -n ${INCLUDE_GROUPS[$group]} ]]; then
+                       ret=0
+                       break
+               fi
+               if [[ -n ${EXCLUDE_GROUPS[$group]} ]]; then
+                       return 1
+               fi
+       done
+
+       return $ret
+}
+
+_run_test() {
+       TEST_NAME="$1"
+       CHECK_DMESG=1
+       DMESG_FILTER=cat
+
+       if ! . "tests/${TEST_NAME}"; then
+               return
+       fi
+
+       if [[ ! -v TEST_GROUPS ]]; then
+               _warning "${TEST_NAME} does not define TEST_GROUPS"
+               return
+       fi
+
+       if declare -fF test >/dev/null && declare -fF test_device >/dev/null; then
+               _warning "${TEST_NAME} defines both test() and test_device()"
+               return
+       fi
+
+       if ! declare -fF test >/dev/null && ! declare -fF test_device >/dev/null; then
+               _warning "${TEST_NAME} does not define test() or test_device()"
+               return
+       fi
+
+       if ! _should_run_test; then
+               return
+       fi
+
+       if declare -fF prepare >/dev/null && ! prepare; then
+               printf '%s [not run]\n    %s\n' "$TEST_NAME" "$SKIP_REASON"
+               return
+       fi
+
+       if declare -fF test >/dev/null; then
+               local last_time="$(grep "^$TEST_NAME pass" results.last/nodev/log 2>/dev/null | cut -d' ' -f3)"
+               if [[ -z $last_time ]]; then
+                       printf '%s ... ' "$TEST_NAME"
+               else
+                       printf '%s %.1fs ... ' "$TEST_NAME" "$last_time"
+               fi
+               RESULTS_DIR="results/nodev"
+               _call_test test
+       else
+               for TEST_DEV in "${CATEGORY_TEST_DEVS[@]}"; do
+                       local test_dev="$(basename "${TEST_DEV}")"
+                       local last_time="$(grep "^$TEST_NAME pass" "results.last/${test_dev}/log" 2>/dev/null | cut -d' ' -f3)"
+                       if [[ -z $last_time ]]; then
+                               printf '%s => %s ... ' "$TEST_NAME" "$test_dev"
+                       else
+                               printf '%s => %s %.1fs ... ' "$TEST_NAME" "$test_dev" "$last_time"
+                       fi
+                       if declare -fF prepare_device >/dev/null && ! prepare_device; then
+                               printf '[not run]\n    %s\n' "$SKIP_REASON"
+                               continue
+                       fi
+                       RESULTS_DIR="results/${test_dev}"
+                       _call_test test_device
+               done
+       fi
+}
+
+_run_category() {
+       local category="$1"
+
+       # Most of this script is written defensively against whitespace in the
+       # test name, but we can't handle it in the test logs.
+       if [[ $category =~ [[:space:]] ]]; then
+               _error "category name \"${category}\" contains whitespace"
+               return
+       fi
+
+       if ! . "tests/${category}/category"; then
+               return
+       fi
+
+       if ! declare -fF prepare >/dev/null; then
+               _warning "${category} does not define prepare()"
+               return
+       fi
+
+       if ! declare -fF prepare_device >/dev/null; then
+               _warning "${category} does not define prepare_device()"
+               return
+       fi
+
+       if ! prepare; then
+               printf '%s/*** [not run]\n    %s\n' "$category" "$SKIP_REASON"
+               return
+       fi
+
+       declare -a CATEGORY_TEST_DEVS
+       for TEST_DEV in "${TEST_DEVS[@]}"; do
+               if prepare_device; then
+                       CATEGORY_TEST_DEVS+=("$TEST_DEV")
+               fi
+       done
+       if [[ ${#CATEGORY_TEST_DEVS} -eq 0 ]]; then
+               printf '%s/*** [not run]\n    %s\n' "$category" "no suitable devices"
+               return
+       fi
+
+       unset prepare prepare_device
+
+       while IFS= read -r -d '' seq; do
+               ( _run_test "${category}/${seq}" )
+       done < <(find "tests/${category}" -mindepth 1 -maxdepth 1 -type f \
+                -not -name '*.out' -not -name category -printf '%P\0' | sort -z)
+}
+
+if [[ $EUID -ne 0 ]]; then
+       _error "must be run as root"
+fi
+
+if [[ -d results ]]; then
+       rm -rf results.last
+       mv results results.last
+fi
+
+while IFS= read -r -d '' category; do
+       ( _run_category "${category}" )
+done < <(find tests -mindepth 1 -maxdepth 1 -type d -printf '%P\0' | sort -z)

diff --git a/common/rc b/common/rc
new file mode 100644 (file)
index 0000000..4df6af1
--- /dev/null
+++ b/common/rc
@@ -0,0 +1,27 @@
+#!/bin/bash
+#
+# Common helper functions.
+#
+# Copyright (C) 2017 Omar Sandoval
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+_warning() {
+       echo "$0: $@" >&2
+}
+
+_error() {
+       echo "$0: $@" >&2
+       exit 1
+}

diff --git a/new b/new
new file mode 100755 (executable)
index 0000000..8cb4b00
--- /dev/null
+++ b/new
@@ -0,0 +1,157 @@
+#!/bin/bash
+#
+# Copyright (C) 2017 Omar Sandoval
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+set -e
+
+. common/rc
+
+prompt_yes_no() {
+       if [[ $2 =~ ^[Yy] ]]; then
+               local default=0
+               local prompt="$1 [Y/n] "
+       else
+               local default=1
+               local prompt="$1 [y/N] "
+       fi
+
+       local yn
+       read -n 1 -p "${prompt}" yn
+       if [[ -n "${yn}" ]]; then
+               echo
+       fi
+       if [[ "${yn}" =~ ^[Yy] ]]; then
+               return 0
+       elif [[ "${yn}" =~ ^[Nn] ]]; then
+               return 1
+       else
+               return $default
+       fi
+}
+
+echo "Available test categories:"
+while IFS= read -r -d '' category; do
+       if [[ $category != meta ]]; then
+               echo "    ${category}"
+       fi
+done < <(find tests -mindepth 1 -maxdepth 1 -type d -printf '%P\0')
+
+read -r -p "Category for new test: " category
+
+if [[ -z $category ]]; then
+       exit 1
+fi
+
+if [[ $category =~ [[:space:]] ]]; then
+       _error "category name must not contain whitespace"
+fi
+
+if [[ ! -e tests/${category} ]]; then
+       if ! prompt_yes_no "Category does not exist; create it?"; then
+               exit 1
+       fi
+       mkdir -p "tests/${category}"
+       cat << EOF > "tests/${category}/category"
+#!/bin/bash
+#
+# TODO: provide a brief description of the category here.
+#
+# Copyright (C) $(date +%Y) TODO YOUR NAME HERE
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+. common/rc
+
+prepare() {
+       # TODO: if this category has any extra requirements, fill this in.
+       return 0
+}
+
+prepare_device() {
+       # TODO: if this category has any requirements for the devices it can
+       # run on, fill this in.
+       return 0
+}
+EOF
+       echo "Created tests/${category}/category"
+fi
+
+for ((i = 1; ; i++)); do
+       seq="$(printf "%03d" $i)"
+       test_name="${category}/${seq}"
+       if [[ ! -e tests/${test_name} ]]; then
+               break
+       fi
+done
+
+cat << EOF > "tests/${test_name}"
+#!/bin/bash
+#
+# TODO: provide a brief description of the test here, i.e., what it tests and
+# how. If this is a regression test, be sure to reference the patch or commit
+# it tests. See Documentation/writing-tests.md for more information.
+#
+# Copyright (C) $(date +%Y) TODO YOUR NAME HERE
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+# TODO: if this test shouldn't be run by default, remove the "auto" group. If
+# this test runs quickly, add it to the "quick" group. Add any other groups
+# describing what functionality this tests.
+TEST_GROUPS=($category auto)
+
+# TODO: if this test has any extra requirements, define prepare(). If this test
+# has specific requirements for the device it runs on, define prepare_device().
+
+# TODO: if this test requires a device, rename this to test_device().
+test() {
+       echo "Running \${TEST_NAME}"
+
+       # TODO: fill in the test case.
+
+       echo "Test complete"
+}
+EOF
+chmod +x "tests/${test_name}"
+echo "Created tests/${test_name}"
+
+cat << EOF > "tests/${test_name}.out"
+Running ${test_name}
+Test complete
+EOF
+echo "Created tests/${test_name}.out"

diff --git a/tests/meta/001 b/tests/meta/001
new file mode 100755 (executable)
index 0000000..e335e5e
--- /dev/null
+++ b/tests/meta/001
@@ -0,0 +1,25 @@
+#!/bin/bash
+#
+# Test a passing test.
+#
+# Copyright (C) 2017 Omar Sandoval
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+TEST_GROUPS=(meta)
+
+test() {
+       echo "Running ${TEST_NAME}"
+       echo "Test complete"
+}

diff --git a/tests/meta/001.out b/tests/meta/001.out
new file mode 100644 (file)
index 0000000..2cca786
--- /dev/null
+++ b/tests/meta/001.out
@@ -0,0 +1,2 @@
+Running meta/001
+Test complete

diff --git a/tests/meta/002 b/tests/meta/002
new file mode 100755 (executable)
index 0000000..b1c356a
--- /dev/null
+++ b/tests/meta/002
@@ -0,0 +1,25 @@
+#!/bin/bash
+#
+# Test a passing device test.
+#
+# Copyright (C) 2017 Omar Sandoval
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+TEST_GROUPS=(meta)
+
+test_device() {
+       echo "Running ${TEST_NAME}"
+       echo "Test complete"
+}

diff --git a/tests/meta/002.out b/tests/meta/002.out
new file mode 100644 (file)
index 0000000..98789d5
--- /dev/null
+++ b/tests/meta/002.out
@@ -0,0 +1,2 @@
+Running meta/002
+Test complete

diff --git a/tests/meta/003 b/tests/meta/003
new file mode 100755 (executable)
index 0000000..4a111d1
--- /dev/null
+++ b/tests/meta/003
@@ -0,0 +1,26 @@
+#!/bin/bash
+#
+# Test a test that fails with a non-zero exit status.
+#
+# Copyright (C) 2017 Omar Sandoval
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+TEST_GROUPS=(meta)
+
+test() {
+       echo "Running ${TEST_NAME}"
+       echo "Test complete"
+       return 1
+}

diff --git a/tests/meta/003.out b/tests/meta/003.out
new file mode 100644 (file)
index 0000000..6b34d7b
--- /dev/null
+++ b/tests/meta/003.out
@@ -0,0 +1,2 @@
+Running meta/003
+Test complete

diff --git a/tests/meta/004 b/tests/meta/004
new file mode 100755 (executable)
index 0000000..08bd423
--- /dev/null
+++ b/tests/meta/004
@@ -0,0 +1,26 @@
+#!/bin/bash
+#
+# Test a device test that fails with a non-zero exit status.
+#
+# Copyright (C) 2017 Omar Sandoval
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+TEST_GROUPS=(meta)
+
+test_device() {
+       echo "Running ${TEST_NAME}"
+       echo "Test complete"
+       return 1
+}

diff --git a/tests/meta/004.out b/tests/meta/004.out
new file mode 100644 (file)
index 0000000..8e4d43b
--- /dev/null
+++ b/tests/meta/004.out
@@ -0,0 +1,2 @@
+Running meta/004
+Test complete

diff --git a/tests/meta/005 b/tests/meta/005
new file mode 100755 (executable)
index 0000000..2a59640
--- /dev/null
+++ b/tests/meta/005
@@ -0,0 +1,24 @@
+#!/bin/bash
+#
+# Test a test that fails with bad output.
+#
+# Copyright (C) 2017 Omar Sandoval
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+TEST_GROUPS=(meta)
+
+test() {
+       echo '¯\_(ツ)_/¯'
+}

diff --git a/tests/meta/005.out b/tests/meta/005.out
new file mode 100644 (file)
index 0000000..c5d5aa3
--- /dev/null
+++ b/tests/meta/005.out
@@ -0,0 +1,2 @@
+Running meta/005
+Test complete

diff --git a/tests/meta/006 b/tests/meta/006
new file mode 100755 (executable)
index 0000000..4c91599
--- /dev/null
+++ b/tests/meta/006
@@ -0,0 +1,26 @@
+#!/bin/bash
+#
+# Test a test that fails with bad output which has a very long diff.
+#
+# Copyright (C) 2017 Omar Sandoval
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+TEST_GROUPS=(meta)
+
+test() {
+       for ((i = 1; i <= 100; i++)); do
+               echo $i '¯\_(ツ)_/¯'
+       done
+}

diff --git a/tests/meta/006.out b/tests/meta/006.out
new file mode 100644 (file)
index 0000000..2517ee2
--- /dev/null
+++ b/tests/meta/006.out
@@ -0,0 +1,2 @@
+Running meta/006
+Test complete

diff --git a/tests/meta/007 b/tests/meta/007
new file mode 100755 (executable)
index 0000000..5da58ec
--- /dev/null
+++ b/tests/meta/007
@@ -0,0 +1,29 @@
+#!/bin/bash
+#
+# Test prepare().
+#
+# Copyright (C) 2017 Omar Sandoval
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+TEST_GROUPS=(meta)
+
+prepare() {
+       SKIP_REASON="(╯°□°）╯︵ ┻━┻"
+       return 1
+}
+
+test() {
+       echo '¯\_(ツ)_/¯'
+}

diff --git a/tests/meta/007.out b/tests/meta/007.out
new file mode 100644 (file)
index 0000000..86e80df
--- /dev/null
+++ b/tests/meta/007.out
@@ -0,0 +1,2 @@
+Running meta/007
+Test complete

diff --git a/tests/meta/008 b/tests/meta/008
new file mode 100755 (executable)
index 0000000..32c28ff
--- /dev/null
+++ b/tests/meta/008
@@ -0,0 +1,29 @@
+#!/bin/bash
+#
+# Test prepare_device().
+#
+# Copyright (C) 2017 Omar Sandoval
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+TEST_GROUPS=(meta)
+
+prepare_device() {
+       SKIP_REASON="(╯°□°）╯︵ $TEST_DEV ┻━┻"
+       return 1
+}
+
+test_device() {
+       echo '¯\_(ツ)_/¯'
+}

diff --git a/tests/meta/008.out b/tests/meta/008.out
new file mode 100644 (file)
index 0000000..c209d00
--- /dev/null
+++ b/tests/meta/008.out
@@ -0,0 +1,2 @@
+Running meta/008
+Test complete

diff --git a/tests/meta/009 b/tests/meta/009
new file mode 100755 (executable)
index 0000000..e211218
--- /dev/null
+++ b/tests/meta/009
@@ -0,0 +1,26 @@
+#!/bin/bash
+#
+# Test checking dmesg.
+#
+# Copyright (C) 2017 Omar Sandoval
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+TEST_GROUPS=(meta)
+
+test() {
+       echo "Running ${TEST_NAME}"
+       fake_bug_on
+       echo "Test complete"
+}

diff --git a/tests/meta/009.out b/tests/meta/009.out
new file mode 100644 (file)
index 0000000..c701303
--- /dev/null
+++ b/tests/meta/009.out
@@ -0,0 +1,2 @@
+Running meta/009
+Test complete

diff --git a/tests/meta/010 b/tests/meta/010
new file mode 100755 (executable)
index 0000000..ddc6b04
--- /dev/null
+++ b/tests/meta/010
@@ -0,0 +1,27 @@
+#!/bin/bash
+#
+# Test suppressing dmesg check.
+#
+# Copyright (C) 2017 Omar Sandoval
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+TEST_GROUPS=(meta)
+CHECK_DMESG=0
+
+test() {
+       echo "Running ${TEST_NAME}"
+       fake_bug_on
+       echo "Test complete"
+}

diff --git a/tests/meta/010.out b/tests/meta/010.out
new file mode 100644 (file)
index 0000000..9625d89
--- /dev/null
+++ b/tests/meta/010.out
@@ -0,0 +1,2 @@
+Running meta/010
+Test complete

diff --git a/tests/meta/011 b/tests/meta/011
new file mode 100755 (executable)
index 0000000..bc6b0e7
--- /dev/null
+++ b/tests/meta/011
@@ -0,0 +1,27 @@
+#!/bin/bash
+#
+# Test filtering dmesg.
+#
+# Copyright (C) 2017 Omar Sandoval
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+TEST_GROUPS=(meta)
+DMESG_FILTER="grep -v BUG"
+
+test() {
+       echo "Running ${TEST_NAME}"
+       fake_bug_on
+       echo "Test complete"
+}

diff --git a/tests/meta/011.out b/tests/meta/011.out
new file mode 100644 (file)
index 0000000..b955f74
--- /dev/null
+++ b/tests/meta/011.out
@@ -0,0 +1,2 @@
+Running meta/011
+Test complete

diff --git a/tests/meta/category b/tests/meta/category
new file mode 100644 (file)
index 0000000..71ebf53
--- /dev/null
+++ b/tests/meta/category
@@ -0,0 +1,76 @@
+#!/bin/bash
+#
+# Testing framework tests.
+#
+# Copyright (C) 2017 Omar Sandoval
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+. common/rc
+
+prepare() {
+       if [[ -v META_PREPARE_SHOULD_FAIL ]]; then
+               SKIP_REASON="META_PREPARE_SHOULD_FAIL"
+               return 1
+       fi
+       return 0
+}
+
+prepare_device() {
+       if [[ -v META_PREPARE_DEVICE_SHOULD_FAIL ]]; then
+               SKIP_REASON="META_PREPARE_DEVICE_SHOULD_FAIL"
+               return 1
+       fi
+       return 0
+}
+
+fake_bug_on() {
+       cat << "EOF" > "$TMPDIR/dmesg"
+------------[ cut here ]------------
+kernel BUG at block/blk-core.c:3490!
+invalid opcode: 0000 [#1] PREEMPT SMP
+Modules linked in:
+CPU: 0 PID: 1 Comm: swapper/0 Not tainted 4.11.0-rc8-dirty #40
+Hardware name: QEMU Standard PC (i440FX + PIIX, 1996), BIOS 1.10.2-20170228_101828-anatol 04/01/2014
+task: ffff88007c864c80 task.stack: ffffc9000031c000
+RIP: 0010:blk_dev_init+0x4/0x6
+RSP: 0000:ffffc9000031fe70 EFLAGS: 00010282
+RAX: ffff88007c9f4000 RBX: 0000000000000000 RCX: ffff88007c9f47f8
+RDX: ffff88007c9f47f8 RSI: 0000000000000000 RDI: ffff88007c9c8b40
+RBP: ffffc9000031fe70 R08: ffff88007c9c8b00 R09: 0000000000000000
+R10: ffff88007c9c8b00 R11: 0000000000000000 R12: 0000000000000078
+R13: 0000000000000000 R14: ffffffff81d318ee R15: 0000000000000000
+FS:  0000000000000000(0000) GS:ffff88007fc00000(0000) knlGS:0000000000000000
+CS:  0010 DS: 0000 ES: 0000 CR0: 0000000080050033
+CR2: 0000000000000000 CR3: 0000000001c09000 CR4: 00000000000006f0
+DR0: 0000000000000000 DR1: 0000000000000000 DR2: 0000000000000000
+DR3: 0000000000000000 DR6: 00000000fffe0ff0 DR7: 0000000000000400
+Call Trace:
+ genhd_device_init+0x4b/0x76
+ ? blk_mq_init+0x4e/0x4e
+ do_one_initcall+0x52/0x1a0
+ ? set_debug_rodata+0x12/0x12
+ kernel_init_freeable+0x176/0x1fe
+ ? rest_init+0x90/0x90
+ kernel_init+0xe/0x100
+ ret_from_fork+0x2c/0x40
+Code: 41 b9 01 00 00 00 41 b8 08 00 00 00 b9 2c 00 00 00 48 c7 c6 97 d1 9e 81 48 89 df e8 81 54 3d ff 5a 48 8b 5d f8 c9 c3 55 48 89 e5 <0f> 0b 48 8b 05 bd ba 19 00 55 48 89 e5 48 ff c8 48 89 05 47 a0
+RIP: blk_dev_init+0x4/0x6 RSP: ffffc9000031fe70
+---[ end trace d9ab35f734a89f58 ]---
+EOF
+
+       cat "$TMPDIR/dmesg" | while IFS= read -r line; do
+               echo "$line" >> /dev/kmsg
+       done
+}