mirror of
https://github.com/RPCS3/llvm-mirror.git
synced 2024-11-25 20:23:11 +01:00
12285ee434
Extend FileCheck to dump its input annotated with FileCheck's
diagnostics: errors, good matches if -v, and additional information if
-vv. The goal is to make it easier to visualize FileCheck's matching
behavior when debugging.
Each patch in this series implements input annotations for a
particular category of FileCheck diagnostics. While the first few
patches alone are somewhat useful, the annotations become much more
useful as later patches implement annotations for -v and -vv
diagnostics, which show the matching behavior leading up to the error.
This first patch implements boilerplate plus input annotations for
error diagnostics reporting that no matches were found for a
directive. These annotations mark the search ranges of the failed
directives. Instead of using the usual `^~~`, which is used by later
patches for good matches, these annotations use `X~~` so that this
category of errors is visually distinct.
For example:
```
$ FileCheck -dump-input=help
The following description was requested by -dump-input=help to
explain the input annotations printed by -dump-input=always and
-dump-input=fail:
- L: labels line number L of the input file
- T:L labels the match result for a pattern of type T from line L of
the check file
- X~~ marks search range when no match is found
- colors error
If you are not seeing color above or in input dumps, try: -color
$ FileCheck -v -dump-input=always check1 < input1 |& sed -n '/^Input file/,$p'
Input file: <stdin>
Check file: check1
-dump-input=help describes the format of the following dump.
Full input was:
<<<<<<
1: ; abc def
2: ; ghI jkl
next:3 X~~~~~~~~ error: no match found
>>>>>>
$ cat check1
CHECK: abc
CHECK-SAME: def
CHECK-NEXT: ghi
CHECK-SAME: jkl
$ cat input1
; abc def
; ghI jkl
```
Some additional details related to the boilerplate:
* Enabling: The annotated input dump is enabled by `-dump-input`,
which can also be set via the `FILECHECK_OPTS` environment variable.
Accepted values are `help`, `always`, `fail`, or `never`. As shown
above, `help` describes the format of the dump. `always` is helpful
when you want to investigate a successful FileCheck run, perhaps for
an unexpected pass. `-dump-input-on-failure` and
`FILECHECK_DUMP_INPUT_ON_FAILURE` remain as a deprecated alias for
`-dump-input=fail`.
* Diagnostics: The usual diagnostics are not suppressed in this mode
and are printed first. For brevity in the example above, I've
omitted them using a sed command. Sometimes they're perfectly
sufficient, and then they make debugging quicker than if you were
forced to hunt through a dump of long input looking for the error.
If you think they'll get in the way sometimes, keep in mind that
it's pretty easy to grep for the start of the input dump, which is
`<<<`.
* Colored Annotations: The annotated input is colored if colors are
enabled (enabling colors can be forced using -color). For example,
errors are red. However, as in the above example, colors are not
vital to reading the annotations.
I don't know how to test color in the output, so any hints here would
be appreciated.
Reviewed By: george.karpenkov, zturner, probinson
Differential Revision: https://reviews.llvm.org/D52999
llvm-svn: 349418
|
||
|---|---|---|
| .. | ||
| Unix | ||
| Windows | ||
| AArch64TargetParser.cpp | ||
| Allocator.cpp | ||
| AMDGPUMetadata.cpp | ||
| APFloat.cpp | ||
| APInt.cpp | ||
| APSInt.cpp | ||
| ARMAttributeParser.cpp | ||
| ARMBuildAttrs.cpp | ||
| ARMTargetParser.cpp | ||
| ARMWinEH.cpp | ||
| Atomic.cpp | ||
| BinaryStreamError.cpp | ||
| BinaryStreamReader.cpp | ||
| BinaryStreamRef.cpp | ||
| BinaryStreamWriter.cpp | ||
| BlockFrequency.cpp | ||
| BranchProbability.cpp | ||
| BuryPointer.cpp | ||
| CachePruning.cpp | ||
| Chrono.cpp | ||
| circular_raw_ostream.cpp | ||
| CMakeLists.txt | ||
| CodeGenCoverage.cpp | ||
| COM.cpp | ||
| CommandLine.cpp | ||
| Compression.cpp | ||
| ConvertUTF.cpp | ||
| ConvertUTFWrapper.cpp | ||
| COPYRIGHT.regex | ||
| CrashRecoveryContext.cpp | ||
| DAGDeltaAlgorithm.cpp | ||
| DataExtractor.cpp | ||
| Debug.cpp | ||
| DebugCounter.cpp | ||
| DeltaAlgorithm.cpp | ||
| DJB.cpp | ||
| DynamicLibrary.cpp | ||
| Errno.cpp | ||
| Error.cpp | ||
| ErrorHandling.cpp | ||
| FileCheck.cpp | ||
| FileOutputBuffer.cpp | ||
| FileUtilities.cpp | ||
| FoldingSet.cpp | ||
| FormattedStream.cpp | ||
| FormatVariadic.cpp | ||
| GlobPattern.cpp | ||
| GraphWriter.cpp | ||
| Hashing.cpp | ||
| Host.cpp | ||
| InitLLVM.cpp | ||
| IntEqClasses.cpp | ||
| IntervalMap.cpp | ||
| ItaniumManglingCanonicalizer.cpp | ||
| JamCRC.cpp | ||
| JSON.cpp | ||
| KnownBits.cpp | ||
| LEB128.cpp | ||
| LineIterator.cpp | ||
| LLVMBuild.txt | ||
| Locale.cpp | ||
| LockFileManager.cpp | ||
| LowLevelType.cpp | ||
| ManagedStatic.cpp | ||
| MathExtras.cpp | ||
| MD5.cpp | ||
| Memory.cpp | ||
| MemoryBuffer.cpp | ||
| Mutex.cpp | ||
| NativeFormatting.cpp | ||
| Options.cpp | ||
| Parallel.cpp | ||
| Path.cpp | ||
| PluginLoader.cpp | ||
| PrettyStackTrace.cpp | ||
| Process.cpp | ||
| Program.cpp | ||
| RandomNumberGenerator.cpp | ||
| raw_os_ostream.cpp | ||
| raw_ostream.cpp | ||
| README.txt.system | ||
| regcomp.c | ||
| regengine.inc | ||
| regerror.c | ||
| regex2.h | ||
| regex_impl.h | ||
| Regex.cpp | ||
| regexec.c | ||
| regfree.c | ||
| regstrlcpy.c | ||
| regutils.h | ||
| RWMutex.cpp | ||
| ScaledNumber.cpp | ||
| ScopedPrinter.cpp | ||
| SHA1.cpp | ||
| Signals.cpp | ||
| SmallPtrSet.cpp | ||
| SmallVector.cpp | ||
| SourceMgr.cpp | ||
| SpecialCaseList.cpp | ||
| Statistic.cpp | ||
| StringExtras.cpp | ||
| StringMap.cpp | ||
| StringPool.cpp | ||
| StringRef.cpp | ||
| StringSaver.cpp | ||
| SymbolRemappingReader.cpp | ||
| SystemUtils.cpp | ||
| TargetParser.cpp | ||
| TargetRegistry.cpp | ||
| TarWriter.cpp | ||
| Threading.cpp | ||
| ThreadLocal.cpp | ||
| ThreadPool.cpp | ||
| Timer.cpp | ||
| ToolOutputFile.cpp | ||
| TrigramIndex.cpp | ||
| Triple.cpp | ||
| Twine.cpp | ||
| Unicode.cpp | ||
| UnicodeCaseFold.cpp | ||
| Valgrind.cpp | ||
| VersionTuple.cpp | ||
| VirtualFileSystem.cpp | ||
| Watchdog.cpp | ||
| WithColor.cpp | ||
| xxhash.cpp | ||
| YAMLParser.cpp | ||
| YAMLTraits.cpp | ||
Design Of lib/System
====================
The software in this directory is designed to completely shield LLVM from any
and all operating system specific functionality. It is not intended to be a
complete operating system wrapper (such as ACE), but only to provide the
functionality necessary to support LLVM.
The software located here, of necessity, has very specific and stringent design
rules. Violation of these rules means that cracks in the shield could form and
the primary goal of the library is defeated. By consistently using this library,
LLVM becomes more easily ported to new platforms since the only thing requiring
porting is this library.
Complete documentation for the library can be found in the file:
llvm/docs/SystemLibrary.html
or at this URL:
http://llvm.org/docs/SystemLibrary.html
While we recommend that you read the more detailed documentation, for the
impatient, here's a high level summary of the library's requirements.
1. No system header files are to be exposed through the interface.
2. Std C++ and Std C header files are okay to be exposed through the interface.
3. No exposed system-specific functions.
4. No exposed system-specific data.
5. Data in lib/System classes must use only simple C++ intrinsic types.
6. Errors are handled by returning "true" and setting an optional std::string
7. Library must not throw any exceptions, period.
8. Interface functions must not have throw() specifications.
9. No duplicate function impementations are permitted within an operating
system class.
To accomplish these requirements, the library has numerous design criteria that
must be satisfied. Here's a high level summary of the library's design criteria:
1. No unused functionality (only what LLVM needs)
2. High-Level Interfaces
3. Use Opaque Classes
4. Common Implementations
5. Multiple Implementations
6. Minimize Memory Allocation
7. No Virtual Methods