LIT(1)
π lit β LLVM Integrated Tester π
okay bestie, meet lit β the LLVM Integrated Tester. Sheβs the one running your LLVM and Clang style test suites, summarizing the results, and telling you where things went off the rails. π
πΈ NAME πΈ
lit β LLVM Integrated Tester β¨
π¦ SYNOPSIS π¦
lit [options] [tests]
π DESCRIPTION π
So like, lit is a portable tool for executing LLVM and Clang style test suites, summarizing their results, and providing indication of failures. Sheβs designed to be a lightweight testing tool with as simple a user interface as possible. π
lit should be run with one or more tests to run specified on the command line. Tests can be either individual test files or directories to search for tests β see TEST DISCOVERY for the deets. π
Each specified test will be executed (potentially concurrently), and once all tests have been run lit will print summary information on the number of tests which passed or failed β see TEST STATUS RESULTS. The lit program will execute with a non-zero exit code if any tests fail. π
By default lit will use a succinct progress display and will only print summary information for test failures. See OUTPUT OPTIONS for options controlling the lit progress display and output. β¨
lit also includes a number of options for controlling how tests are executed (specific features may depend on the particular test format). See EXECUTION OPTIONS for more information. π¦
Finally, lit also supports additional options for only running a subset of the options specified on the command line β see SELECTION OPTIONS for more information. π
lit parses options from the environment variable LIT_OPTS after parsing options from the command line. LIT_OPTS is primarily useful for supplementing or overriding the command-line options supplied to lit by check targets defined by a projectβs build system. π
lit can also read options from response files which are specified as inputs using the @path/to/file.rsp syntax. Arguments read from a file must be one per line and are treated as if they were in the same place as the original file referencing argument on the command line. A response file can reference other response files. π§
Users interested in the lit architecture or designing a lit testing implementation should see LIT INFRASTRUCTURE. π
π GENERAL OPTIONS π
-h,--helpβ Show thelithelp message and exit. π«Ά--versionβ Showlitβs version number and exit. β-j N,--workers Nβ Run N tests in parallel. By default, this is automatically chosen to match the number of detected available CPUs. π₯--config-prefix NAMEβ Search forNAME.cfgandNAME.site.cfgwhen searching for test suites, instead oflit.cfgandlit.site.cfg. π-D NAME[=VALUE],--param NAME[=VALUE]β Add a user defined parameterNAMEwith the givenVALUE(or the empty string if not given). The meaning and use of these parameters is test suite dependent. π
π OUTPUT OPTIONS π
-q,--quietβ Suppress any output except for test failures. π€«-s,--succinctβ Show less output, for example donβt show information on tests that pass. Also show a progress bar, unless--no-progress-baris specified. β¨-v,--verboseβ Show more information on test failures, for example the entire test output instead of just the test result. π
Each command is printed before it is executed. This can be valuable for debugging test failures, as the last printed command is the one that failed. Moreover, lit inserts 'RUN: at line N' after each command pipeline in the output to help you locate the source line of the failed command. π
-vv,--echo-all-commandsβ Deprecated alias for-v. π-a,--show-allβ Enable-v, but for all tests not just failed tests. πΈ-o PATH,--output PATHβ Write test results to the provided path. π--no-progress-barβ Do not use curses based progress bar. π--min-output-interval INTERVALβ Only output updates to the progress bar and status line at most once perINTERVALseconds. Has no effect if the curses based progress bar is not used. β±οΈ--show-excludedβ Show excluded tests. π«--show-skippedβ Show skipped tests. βοΈ--show-unsupportedβ Show unsupported tests. π¬--show-passβ Show passed tests. β--show-flakypassβ Show passed with retry tests. π’--show-xfailβ Show expectedly failed tests. π
π EXECUTION OPTIONS π
--gtest-shardingβ Enable sharding for GoogleTest format. π§©--no-gtest-shardingβ Disable sharding for GoogleTest format. π§©--path PATHβ Specify an additionalPATHto use when searching for executables in tests. π£οΈ--vgβ Run individual tests under valgrind (using the memcheck tool). The--error-exitcodeargument for valgrind is used so that valgrind failures will cause the program to exit with a non-zero status. β οΈ
When this option is enabled, lit will also automatically provide a "valgrind" feature that can be used to conditionally disable (or expect failure in) certain tests. π
--vg-leakβ When--vgis used, enable memory leak checks. When this option is enabled,litwill also automatically provide a"vg_leak"feature that can be used to conditionally disable (or expect failure in) certain tests. π«§--vg-arg ARGβ When--vgis used, specify an additional argument to pass to valgrind itself. π§°--no-executeβ Donβt execute any tests (assume that they pass). π«₯--xunit-xml-output XUNIT_XML_OUTPUTβ Write XUnit-compatible XML test reports to the specified file. π--report-failures-onlyβ Only include failures (see TEST STATUS RESULTS) in the report. π--resultdb-output RESULTDB_OUTPUTβ Write LuCI ResultDB compatible JSON to the specified file. ποΈ--time-trace-output TIME_TRACE_OUTPUTβ Write Chrome tracing compatible JSON to the specified file. π₯--timeout MAXINDIVIDUALTESTTIMEβ Maximum time to spend running a single test (in seconds).0means no time limit.[Default: 0]β³--timeout Nβ Spend at most N seconds (approximately) running each individual test.0means no time limit, and0is the default. Note that this is not an alias for--max-time; the two are different kinds of maximums. π΅βπ«--max-failures MAX_FAILURESβ Stop execution after the given number of failures. π--max-retries-per-test Nβ Retry running failed tests at most N times. Out of the following options to rerun failed tests the--max-retries-per-testis the only one that doesnβt require a change in the test scripts or the test config: π--max-retries-per-testlitoptionconfig.test_retry_attemptstest suite optionALLOW_RETRIES:annotation in test script
Any option in the list above overrules its predecessor. π
--allow-empty-runsβ Do not fail the run if all tests are filtered out. π«Ά--per-test-coverageβ Emit the necessary test coverage data, divided per test case (involves setting a unique value toLLVM_PROFILE_FILEfor eachRUN). The coverage data files will be emitted in the directory specified byconfig.test_exec_root. π--ignore-failβ Exit with status zero even if some tests fail. π--skip-test-time-recordingβ Do not track elapsed wall time for each test. β±οΈ--time-tests[=N|all]β Track the wall time individual tests take to execute and include the results in the summary output. This is useful for determining which tests in a test suite take the most time to execute. When enabled,litprints a slowest-test list and a histogram over all timed tests. The slowest-test list defaults to the 20 slowest tests, but can be limited with=Nor expanded to every timed test with=all. The headings report how many tests are listed, for exampleSlowest Tests (N of M):andTest Times (M):. πβ¨
β¨ SELECTION OPTIONS β¨
Okay so by default, lit is a whole strategist π
β it runs the failing tests first, then does the rest in descending execution time order so the concurrency stays optimized. Iconic behavior. But if you wanna switch up the order, you use the --order option, no big deal.
The timing data lives in the test_exec_root in a file called .lit_test_times.txt. If that file isn't there, then lit goes and checks the test_source_root for it, so clean builds can optionally get that little speed boost. π
--max-tests Nβ run at mostNtests and then dip. That's it, that's the whole thing.--max-time Nβ spend at mostNseconds (approximately, bestie, approximately) running tests and then terminate. And btw, this is not an alias for--timeoutβ those are two totally different kinds of maximums, don't get it twisted. π--order {lexical,random,smart}β this one defines the order the tests run in. The supported values are:lexicalβ tests run in lexical order according to the test file path. Use this when you want that predictable test order vibe. πrandomβ tests run in random order. Chaos. Love that for you. π²smartβ tests that failed previously run first, then all the remaining tests, everything in descending execution time order. This is the default because it optimizes concurrency. Main character energy fr fr. π
--shuffleβ run the tests in a random order, not failing/slowest first. β οΈ Deprecated β use--orderinstead.-i,--incrementalβ run failed tests first. β οΈ DEPRECATED: use--order=smart.--filter REGEXPβ only run the tests whose name matches the regular expression you gave inREGEXP. You can also use the environment variableLIT_FILTERinstead of this option, which is especially useful in environments where the call tolitis issued indirectly. iykyk.--filter-out REGEXPβ filter out the tests whose name matches the regular expression inREGEXP. The environment variableLIT_FILTER_OUTcan also be used in place of this option, again super useful whenlitgets called indirectly. β¨--filter-failedβ only run tests that previously failed. Newly added tests that haven't been run yet are not included. Sorry, newbies. π«Ά--xfail LISTβ treat the tests whose name is in the semicolon separated listLISTasXFAIL. This is lowkey helpful when you don't wanna modify the test suite. The environment variableLIT_XFAILcan also be used in place of this option, which is especially useful in environments where the call tolitis issued indirectly.
A test name can be specified as a file name relative to the test suite directory. For example:
LIT_XFAIL="affinity/kmp-hw-subset.c;offloading/memory_manager.cpp"
In this case, all of the following tests are treated as XFAIL:
libomp :: affinity/kmp-hw-subset.c
libomptarget :: nvptx64-nvidia-cuda :: offloading/memory_manager.cpp
libomptarget :: x86_64-pc-linux-gnu :: offloading/memory_manager.cpp
Alternatively, a test name can be specified as the full test name reported in LIT output. For example, we can adjust the previous example so we don't treat the nvptx64-nvidia-cuda version of offloading/memory_manager.cpp as XFAIL:
LIT_XFAIL="affinity/kmp-hw-subset.c;libomptarget :: x86_64-pc-linux-gnu :: offloading/memory_manager.cpp"
--xfail-not LISTβ do not treat the specified tests asXFAIL. The environment variableLIT_XFAIL_NOTcan also be used in place of this option. The syntax is the same as for--xfailandLIT_XFAIL. And listen β--xfail-notandLIT_XFAIL_NOTalways override all other XFAIL specifications, including an--xfailthat appears later on the command line. The primary purpose is to suppress anXPASSresult without modifying a test case that uses theXFAILdirective. The way that it just overrides everything? Obsessed. π--unsupported LISTβ treat the tests whose name is in the semicolon separated listLISTasUNSUPPORTED. Helpful when you don't wanna modify the test suite. The environment variableLIT_UNSUPPORTEDcan also be used in place of this option, which is especially useful in environments where the call tolitis issued indirectly.
The syntax for specifying test names is the same as for --xfail and LIT_XFAIL. A test name can be given as a file name relative to the test suite directory, or as the full test name reported in LIT output.
--unsupported-not LISTβ do not treat the specified tests asUNSUPPORTED. The environment variableLIT_UNSUPPORTED_NOTcan also be used in place of this option. The syntax is the same as for--unsupportedandLIT_UNSUPPORTED.--unsupported-notandLIT_UNSUPPORTED_NOTalways override all other UNSUPPORTED specifications, including an--unsupportedappearing later on the command line. Same override energy, different status. π--exclude-xfailβXFAILtests won't be run, unless they're listed in the--xfail-not(orLIT_XFAIL_NOT) lists.--num-shards Mβ divide the set of selected tests intoMequal-sized subsets or "shards", and run only one of them. Must be used with the--run-shard=Noption, which selects which shard to actually run. The environment variableLIT_NUM_SHARDScan also be used in place of this option. These two options give you a coarse mechanism for partitioning large testsuites, for parallel execution on separate machines (say, in a big testing farm). π--run-shard Nβ select which shard to run, assuming the--num-shards=Moption was provided. The two options must be used together, and the value ofNmust be in the range1..M. The environment variableLIT_RUN_SHARDcan also be used in place of this option.
πΈ ADDITIONAL OPTIONS πΈ
--debugβ runlitin debug mode, for debugging configuration issues andlititself. Detective mode. π΅οΈ--show-suitesβ list the discovered test suites and exit.--show-testsβ list all of the discovered tests and exit.--show-used-featuresβ show all features used in the test suite (inXFAIL,UNSUPPORTEDandREQUIRES) and exit.--update-testsβ pass failing tests to functions in thelit_config.test_updaterslist, to check whether any of them know how to update the test and make it pass. Basically "hey, can anyone fix this?" energy. π§
π EXIT STATUS π
lit will exit with an exit code of 1 if there are any failures (peep TEST STATUS RESULTS) and --ignore-fail has not been passed. Otherwise, it exits with status 0. Other exit codes are used for non-test-related failures β like, say, a user error or an internal program error. Not everything's about the tests, bestie. π
π¦ TEST DISCOVERY π¦
The inputs you pass to lit can be individual tests, or entire directories or hierarchies of tests to run. When lit starts up, the very first thing it does is convert those inputs into a complete list of tests to run β that's test discovery, and it's literally step one. β¨
In the lit model, every test must exist inside some test suite. lit resolves the inputs specified on the command line to test suites by searching upwards from the input path until it finds a lit.cfg or lit.site.cfg file. These files are both the marker of test suites and configuration files that lit loads so it understands how to find and run the tests inside that suite.
Once lit has mapped the inputs into test suites, it traverses the list of inputs, adding tests for individual files and recursively searching for tests in directories. π§
This behavior makes it easy to specify a subset of tests to run, while still letting the test suite configuration control exactly how tests are interpreted. Plus, lit always identifies tests by the test suite they're in, and their relative path inside the test suite. For appropriately configured projects, that means lit gives you convenient, flexible support for out-of-tree builds. Slay. π
β TEST STATUS RESULTS β
Each test ultimately produces one of the following eight results:
PASSβ the test succeeded. πFLAKYPASSβ the test succeeded after being re-run more than once. This only applies to tests containing anALLOW_RETRIES:annotation. It's giving "idk what happened but it works now." πXFAILβ the test failed, but that's expected. Used for test formats that allow you to say a test doesn't currently work, but you still wanna leave it in the test suite.XPASSβ the test succeeded, but it was expected to fail. Used for tests that were specified as expected to fail but are now succeeding (generally because the feature they test was broken and has since been fixed). Glow-up moment. πFAILβ the test failed. πUNRESOLVEDβ the test result could not be determined. For example, this happens when the test couldn't be run, the test itself is invalid, or the test was interrupted. πUNSUPPORTEDβ the test isn't supported in this environment. Used by test formats that can report unsupported tests.TIMEOUTβ the test was run, but it timed out before it could complete. β°
Unresolved (UNRESOLVED), timed out (TIMEOUT), failed (FAIL) and unexpectedly passed (XPASS) tests are all considered failures.
Depending on the test format, tests may produce additional information about their status (generally only for failures). Check the OUTPUT OPTIONS section for more on that. π
π LIT INFRASTRUCTURE π
This section describes the lit testing architecture for users who are interested in creating a new lit testing implementation, or extending an existing one. Nerd alert and I mean that as the highest compliment. π«Ά
lit proper is primarily an infrastructure for discovering and running arbitrary tests, and for exposing a single convenient interface to those tests. lit itself doesn't actually know how to run tests β that logic is defined by test suites.
π TEST SUITES π
As described in TEST DISCOVERY, tests are always located inside a test suite. Test suites serve to define the format of the tests they contain, the logic for finding those tests, and any additional information needed to run them.
lit identifies test suites as directories containing lit.cfg or lit.site.cfg files (see also --config-prefix). Test suites are initially discovered by recursively searching up the directory hierarchy for all the input files passed on the command line. You can use --show-suites to display the discovered test suites at startup. β¨
Once a test suite is discovered, its config file is loaded. Config files themselves are Python modules which will be executed. When the config file runs, two important global variables are predefined:
lit_configβ the globallitconfiguration object (aLitConfiginstance), which defines the builtin test formats, global configuration parameters, and other helper routines for implementing test configurations.name[required] β the name of the test suite, bestie. It's what shows up in reports and diagnostics, so likeβ¦ make it cute but make it accurate πtest_format[required] β the test format object that's gonna discover and run the tests in this suite. Lowkey usually this is one of the builtin test formats you can grab from thelit.formatsmodule.test_source_rootβ the filesystem path to the test suite root. For out-of-dir builds, this is the directory that gets scanned for tests πtest_exec_rootβ for out-of-dir builds, the path to the test suite root inside the object directory. This is where tests actually run and where the temporary output files get placed ποΈenvironmentβ a dictionary representing the environment to use when executing tests in the suite π±standalone_testsβ when true, marks a directory whose tests are expected to be run standalone. Test discovery is disabled for that directory. Also,lit.suffixesandlit.excludesmust be empty when this variable is true β no cap, that's a hard requirement π¨suffixesβ for lit test formats that scan directories for tests, this is a list of suffixes used to identify test files. Used by:ShTest.substitutionsβ for lit test formats that substitute variables into a test script, this is the list of substitutions to perform. Used by:ShTest.unsupportedβ marks an unsupported directory, and literally all tests inside it get reported as unsupported. Used by:ShTest.parentβ the parent configuration, i.e. the config object for the directory containing the test suiteβ¦ orNoneif there isn't one π«rootβ the root configuration. That's the top-most lit configuration in the whole project, the main character of the config chain πpipefailβ so normally a test using a shell pipe fails if any of the commands on the pipe fail. If that's not the vibe you want, setting this variable to false makes the test fail only if the last command in the pipe fails πavailable_featuresβ a set of features that can be used inXFAIL,REQUIRES, andUNSUPPORTEDdirectives β¨
β¨ TEST DISCOVERY β¨
okay so once the test suites are located, lit recursively traverses the source directory β following test_source_root btw β looking for tests π΅οΈββοΈ
When lit enters a sub-directory, the first thing it does is check whether a nested test suite is defined in that directory. If yes? It loads that test suite recursively. If no? It instantiates a local test config for the directory instead (peep LOCAL CONFIGURATION FILES below, iykyk) π
Tests are identified by the test suite they're contained within, plus the relative path inside that suite. And here's the tea π΅ β that relative path might not point to an actual file on disk. Some test formats (hi GoogleTest π) define "virtual tests", which have a path containing both the path to the actual test file and a subpath to identify the virtual test. Not me finding that iconic π₯
πΈ LOCAL CONFIGURATION FILES πΈ
When lit loads a subdirectory in a test suite, it instantiates a local test configuration by cloning the configuration for the parent directory β and the root of this whole configuration chain will always be a test suite, periodt π
Once the test configuration is cloned, lit checks for a lit.local.cfg file in the subdirectory. If it's there, that file gets loaded and can be used to specialize the configuration for each individual directory π
This facility is literally perfect for defining subdirectories of optional tests, or for changing other configuration parameters β for example, to change the test format, or the suffixes which identify test files π¦
π SUBSTITUTIONS π
okay so this is the part that makes lit actually useful bestie π
β you can substitute patterns inside RUN commands. and it hands you a whole base set of substitutions for free, all defined in TestRunner.py:
%sβ source path, aka the path to the file you're currently running π%Sβ source dir, aka the directory of the file you're currently running%pβ literally the same thing as%S%{pathsep}β path separator%{fs-src-root}β the root component of file system paths that point to the LLVM checkout%{fs-tmp-root}β the root component of file system paths that point to the test's temporary directory%{fs-sep}β file system path separator%tβ a path unique to the test (and yes you may use it to make files or directories π«Ά)%basename_tβ the last path component of%tbut without the.tmpextension. deprecated, use%{t:stem}instead β οΈ%%β a literal%%/sβ%sbut\is replaced by/%/Sβ%Sbut\is replaced by/%/pβ%pbut\is replaced by/%/tβ%tbut\is replaced by/%{s:basename}β the last path component of%s%{s:stem}β the last path component of%sbut with the last extension removed%{t:stem}β the last path component of%tbut without the.tmpextension (it's an alias for%basename_t)%{s:real}β%safter expanding all symbolic links and substitute drives%{S:real}β%Safter expanding all symbolic links and substitute drives%{p:real}β%pafter expanding all symbolic links and substitute drives%{t:real}β%tafter expanding all symbolic links and substitute drives%{/s:real}β%/safter expanding all symbolic links and substitute drives%{/S:real}β%/Safter expanding all symbolic links and substitute drives%{/p:real}β%/pafter expanding all symbolic links and substitute drives%{/t:real}β%/tafter expanding all symbolic links and substitute drives%{/s:regex_replacement}β%/sbut escaped for use in the replacement of as@@@command insedβ¨%{/S:regex_replacement}β%/Sbut escaped for use in the replacement of as@@@command insed%{/p:regex_replacement}β%/pbut escaped for use in the replacement of as@@@command insed%{/t:regex_replacement}β%/tbut escaped for use in the replacement of as@@@command insed%:sβ on Windows,%/sbut a:is removed if it's the second character. otherwise,%sbut with a single leading/removed%:Sβ on Windows,%/Sbut a:is removed if it's the second character. otherwise,%Sbut with a single leading/removed%:pβ on Windows,%/pbut a:is removed if it's the second character. otherwise,%pbut with a single leading
β¦and that last substitution finishes up with / removed, bestie β don't ask, it just does. π
%:tβ on Windows, this is%/tbut with the:deleted if it happens to be the second character. Otherwise, it's%tbut with a single leading/removed. π©·%{readfile:<filename>}β literally just reads the file you name. π
Other substitutions exist too β they're all variations on this base set, and each test module can define even more substitution patterns of its own. Peep the modules' LOCAL CONFIGURATION FILES. π
Want the deep lore on substitutions? It lives in the LLVM Testing Infrastructure Guide. Go read it, it's giving textbook. π
π TEST RUN OUTPUT FORMAT π
The output lit spits out for a test run conforms to the schema below β in both short and verbose modes (though in short mode, no PASS lines show up, so don't @ me when you don't see them π). This schema was chosen so it's relatively easy for a machine to reliably parse (think buildbot log scraping, bestie), and so other tools can generate it too. β¨
Every test result is expected to show up on a line matching:
<result code>: <test name> (<progress info>)
Where <result-code> is a standard test result like PASS, FAIL, XFAIL, XPASS, UNRESOLVED, or UNSUPPORTED. The performance result codes IMPROVED and REGRESSED are allowed too. π
The <test name> field can be any arbitrary string, as long as it contains no newline. π
The <progress info> field can report progress stuff like (1/300), or it can be empty β but even when it's empty, the parentheses are required. No skipping them, periodt. π
If a test is allowed retries (see the ALLOW_RETRIES: annotation) and it needed more than one attempt to succeed, then <progress info> gets extended with this info:
, <num_attempts_made> of <max_allowed_attempts> attempts
Each test result may also include extra (multiline) log info, formatted like this:
<log delineator> TEST '(<test name>)' <trailing delineator>
... log message ...
<log delineator>
Where <test name> should be the name of a preceding reported test, <log delineator> is a string of * characters at least four characters long (the recommended length is 20), and <trailing delineator> is an arbitrary (unparsed) string. β
Here's an example test run output with four tests β A, B, C, and D β plus a log message for the failing test C: π
PASS: A (1 of 4)
PASS: B (2 of 4)
FAIL: C (3 of 4)
******************** TEST 'C' FAILED ********************
Test 'C' failed as a result of exit code 1.
********************
PASS: D (4 of 4)
πΈ DEFAULT FEATURES πΈ
For convenience, lit automatically adds available_features for some common use cases. So thoughtful of her. π«Ά
lit adds a feature based on the operating system being built on β for example: system-darwin, system-linux, etc. lit also automatically adds a feature based on the current architecture β for example target-x86_64, target-aarch64, etc. π₯οΈ
When you build with sanitizers enabled, lit automatically adds the short name of the sanitizer β for example: asan, tsan, etc. π§Ό
Want the full list of features that can be added? See llvm/utils/lit/lit/llvm/config.py. iykyk. π
π§ͺ LIT EXAMPLE TESTS π§ͺ
The lit distribution ships with several example implementations of test suites in the ExampleTests directory. Go poke at them, they're literally right there. ππ¦
π SEE ALSO π
π AUTHOR π
Maintained by the LLVM Team (https://llvm.org/). π«‘
π COPYRIGHT π
2003-2026, LLVM Project
and that's the whole page, bestie β you ate. πβ¨
This gorgeous thing is lit, version 23, dated 2026-10-06. Go run some tests, slay, and remember: no cap, the parentheses are always required. π
ππ«Ά
π¦ where this page comes from
- centos-stream 9: llvm 23.1.3-1.el9 Β· Apache-2.0 WITH LLVM-exception OR NCSA
- centos-stream 9: llvm 23.1.3-1.el9 Β· Apache-2.0 WITH LLVM-exception OR NCSA
- π girlified by deepseek-ai/DeepSeek-V4.1-Flash-1017 on : a language model's rewrite of the original, under its terms