1
0
mirror of https://github.com/RPCS3/llvm-mirror.git synced 2024-10-19 19:12:56 +02:00
llvm-mirror/lib/Support
Joel E. Denny edc00dc9b3 [FileCheck] Annotate input dump (5/7)
This patch implements input annotations for diagnostics enabled by -v,
which report good matches for directives.  These annotations mark
match ranges using `^~~`.

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 only match result for a pattern of type T from line L of
           the check file
  - T:L'N  labels the Nth match result for a pattern of type T from line L of
           the check file
  - ^~~    marks good match (reported if -v)
  - !~~    marks bad match, such as:
           - CHECK-NEXT on same line as previous match (error)
           - CHECK-NOT found (error)
  - X~~    marks search range when no match is found, such as:
           - CHECK-NEXT not found (error)
  - ?      marks fuzzy match when no match is found
  - colors success, error, fuzzy match, unmatched input

If you are not seeing color above or in input dumps, try: -color

$ FileCheck -v -dump-input=always check3 < input3 |& sed -n '/^<<<</,$p'
<<<<<<
         1: abc foobar def
check:1     ^~~
not:2           !~~~~~     error: no match expected
check:3                ^~~
>>>>>>

$ cat check3
CHECK:     abc
CHECK-NOT: foobar
CHECK:     def

$ cat input3
abc foobar def
```

-vv enables these annotations for FileCheck's implicit EOF patterns as
well.  For an example where EOF patterns become relevant, see patch 7
in this series.

If colors are enabled, `^~~` is green to suggest success.

-v plus color enables highlighting of input text that has no final
match for any expected pattern.  The highlight uses a cyan background
to suggest a cold section.  This highlighting can make it easier to
spot text that was intended to be matched but that failed to be
matched in a long series of good matches.

CHECK-COUNT-<num> good matches are another case where there can be
multiple match results for the same directive.

Reviewed By: george.karpenkov, probinson

Differential Revision: https://reviews.llvm.org/D53897

llvm-svn: 349422
2018-12-18 00:03:03 +00:00
..
Unix [Support/FileSystem] Add sub-second precision for atime/mtime of sys::fs::file_status on unix platforms 2018-11-26 00:03:39 +00:00
Windows [Support] Fix FileNameLength passed to SetFileInformationByHandle 2018-12-13 00:08:25 +00:00
AArch64TargetParser.cpp [ARM, AArch64] Move ARM/AArch64 target parsers into 2018-11-28 11:38:10 +00:00
Allocator.cpp Recover some overzealously removed includes. 2017-12-13 22:21:02 +00:00
AMDGPUMetadata.cpp Remove \brief commands from doxygen comments. 2018-05-01 15:54:18 +00:00
APFloat.cpp Remove trailing space 2018-07-30 19:41:25 +00:00
APInt.cpp [APInt] Add methods for saturated add and sub 2018-11-20 16:47:59 +00:00
APSInt.cpp
ARMAttributeParser.cpp Test commit 2018-02-26 13:05:18 +00:00
ARMBuildAttrs.cpp
ARMTargetParser.cpp Fix build error due to missing cctype include 2018-11-28 15:12:33 +00:00
ARMWinEH.cpp
Atomic.cpp
BinaryStreamError.cpp [DebugInfo] Common behavior for error types 2018-08-31 17:41:58 +00:00
BinaryStreamReader.cpp
BinaryStreamRef.cpp Remove \brief commands from doxygen comments. 2018-05-01 15:54:18 +00:00
BinaryStreamWriter.cpp [BinaryStream] Support growable streams. 2017-11-27 18:48:37 +00:00
BlockFrequency.cpp Remove redundant includes from lib/Support. 2017-12-13 21:30:58 +00:00
BranchProbability.cpp IWYU for llvm-config.h in llvm, additions. 2018-04-30 14:59:11 +00:00
BuryPointer.cpp Move BuryPointer from Clang to LLVM for use in other LLVM tools 2018-11-17 18:03:47 +00:00
CachePruning.cpp [Support][CachePruning] prune least recently accessed files first 2018-08-22 00:52:16 +00:00
Chrono.cpp IWYU for llvm-config.h in llvm, additions. 2018-04-30 14:59:11 +00:00
circular_raw_ostream.cpp [Support] Remove unused raw_ostream::handle whose anchor role was superseded by anchor() 2018-06-02 06:00:35 +00:00
CMakeLists.txt [ARM, AArch64] Move ARM/AArch64 target parsers into 2018-11-28 11:38:10 +00:00
CodeGenCoverage.cpp [Support] Fix some Wundef warnings 2018-08-23 09:42:58 +00:00
COM.cpp [Support] Fix some Wundef warnings 2018-08-23 09:42:58 +00:00
CommandLine.cpp [FileCheck] Parse command-line options from FILECHECK_OPTS 2018-11-06 22:07:03 +00:00
Compression.cpp Fix buildbot breakage. 2018-08-04 00:23:37 +00:00
ConvertUTF.cpp Remove trailing space 2018-07-30 19:41:25 +00:00
ConvertUTFWrapper.cpp
COPYRIGHT.regex
CrashRecoveryContext.cpp Remove trailing space 2018-07-30 19:41:25 +00:00
DAGDeltaAlgorithm.cpp Remove trailing space 2018-07-30 19:41:25 +00:00
DataExtractor.cpp
Debug.cpp Rename DEBUG macro to LLVM_DEBUG. 2018-05-14 12:53:11 +00:00
DebugCounter.cpp Print out DebugCounter info with -print-debug-counter 2018-10-23 21:51:56 +00:00
DeltaAlgorithm.cpp
DJB.cpp Make llvm::djbHash an inline function. 2018-03-02 22:00:38 +00:00
DynamicLibrary.cpp s/LLVM_ON_WIN32/_WIN32/, llvm 2018-04-29 00:45:03 +00:00
Errno.cpp Remove trailing space 2018-07-30 19:41:25 +00:00
Error.cpp [Support] Make error banner optional in logAllUnhandledErrors 2018-11-11 01:46:03 +00:00
ErrorHandling.cpp s/LLVM_ON_WIN32/_WIN32/, llvm 2018-04-29 00:45:03 +00:00
FileCheck.cpp [FileCheck] Annotate input dump (5/7) 2018-12-18 00:03:03 +00:00
FileOutputBuffer.cpp [Support] Allow discarding a FileOutputBuffer without removing the memory mapping 2018-08-24 18:36:22 +00:00
FileUtilities.cpp
FoldingSet.cpp fix typos 2018-09-14 16:12:14 +00:00
FormattedStream.cpp Remove trailing space 2018-07-30 19:41:25 +00:00
FormatVariadic.cpp Remove unused variables. No functionality change. 2017-10-08 19:11:02 +00:00
GlobPattern.cpp
GraphWriter.cpp Refactor ExecuteAndWait to take StringRefs. 2018-06-12 17:43:52 +00:00
Hashing.cpp Hashing: use 64-bit seed for hashing on all platforms. 2018-08-30 20:28:32 +00:00
Host.cpp [X86] Add cascade lake arch in X86 target. 2018-11-27 18:05:00 +00:00
InitLLVM.cpp Rename sys::Process::GetArgumentVector -> sys::windows::GetCommandLineArguments 2018-04-17 21:09:16 +00:00
IntEqClasses.cpp
IntervalMap.cpp
ItaniumManglingCanonicalizer.cpp Port libcxxabi r344607 into llvm 2018-10-17 18:50:25 +00:00
JamCRC.cpp
JSON.cpp llvm::sort(C.begin(), C.end(), ...) -> llvm::sort(C, ...) 2018-09-27 02:13:45 +00:00
KnownBits.cpp [KnownBits][ValueTracking] Move the math for calculating known bits for add/sub into a static method in KnownBits object 2017-08-08 16:29:35 +00:00
LEB128.cpp
LineIterator.cpp
LLVMBuild.txt
Locale.cpp [Windows] Convert from UTF-8 to UTF-16 when writing to a Windows console 2018-09-05 00:08:56 +00:00
LockFileManager.cpp [Support] Fix some Wundef warnings 2018-08-23 09:42:58 +00:00
LowLevelType.cpp [GlobalISel] Enable legalizing non-power-of-2 sized types. 2017-11-07 10:34:34 +00:00
ManagedStatic.cpp Remove trailing space 2018-07-30 19:41:25 +00:00
MathExtras.cpp
MD5.cpp Remove \brief commands from doxygen comments. 2018-05-01 15:54:18 +00:00
Memory.cpp IWYU for llvm-config.h in llvm, additions. 2018-04-30 14:59:11 +00:00
MemoryBuffer.cpp Remove trailing space 2018-07-30 19:41:25 +00:00
Mutex.cpp Use uniform mechanism for OOM errors handling 2018-06-09 05:19:45 +00:00
NativeFormatting.cpp Support: Add missing #include. 2018-01-18 20:49:33 +00:00
Options.cpp
Parallel.cpp Remove unused SyncExecutor and make it clearer that the whole file is only used if LLVM_ENABLE_THREADS 2018-05-11 15:25:38 +00:00
Path.cpp Use llvm::copy. NFC 2018-11-17 01:44:25 +00:00
PluginLoader.cpp
PrettyStackTrace.cpp Remove trailing space 2018-07-30 19:41:25 +00:00
Process.cpp Make LLVM_ENABLE_CRASH_DUMPS set a variable default 2018-08-23 22:58:56 +00:00
Program.cpp Refactor ExecuteAndWait to take StringRefs. 2018-06-12 17:43:52 +00:00
RandomNumberGenerator.cpp Use llvm::copy. NFC 2018-11-17 01:44:25 +00:00
raw_os_ostream.cpp
raw_ostream.cpp [Windows] Convert from UTF-8 to UTF-16 when writing to a Windows console 2018-09-05 00:08:56 +00:00
README.txt.system
regcomp.c Attempt to heal bots after r328970. 2018-04-02 13:49:35 +00:00
regengine.inc [ADT] Replace std::isprint by llvm::isPrint. 2018-07-26 15:31:41 +00:00
regerror.c
regex2.h Support/reg*.h: Make headers include their dependencies 2017-10-26 20:23:11 +00:00
regex_impl.h Remove trailing space 2018-07-30 19:41:25 +00:00
Regex.cpp Fix compilation on Darwin with expensive checks. 2018-03-12 11:01:05 +00:00
regexec.c
regfree.c
regstrlcpy.c
regutils.h
RWMutex.cpp Fix include of config.h that was incorrectly changed in r331184 2018-05-03 21:59:13 +00:00
ScaledNumber.cpp
ScopedPrinter.cpp Remove redundant includes from lib/Support. 2017-12-13 21:30:58 +00:00
SHA1.cpp Fix header comment on SHA1 code. 2018-03-09 00:23:35 +00:00
Signals.cpp Refactor ExecuteAndWait to take StringRefs. 2018-06-12 17:43:52 +00:00
SmallPtrSet.cpp Use uniform mechanism for OOM errors handling 2018-06-09 05:19:45 +00:00
SmallVector.cpp ADT: Shrink SmallVector size 0 to 16B on 64-bit platforms 2018-07-24 11:32:13 +00:00
SourceMgr.cpp [SourceMgr][FileCheck] Obey -color by extending WithColor 2018-10-24 21:46:42 +00:00
SpecialCaseList.cpp Extend SpecialCaseList to allow users to blame matches on entries in the file. 2017-11-07 21:16:46 +00:00
Statistic.cpp Fix lock order inversion between ManagedStatic and Statistic 2018-04-17 23:37:18 +00:00
StringExtras.cpp [ADT] Replace std::isprint by llvm::isPrint. 2018-07-26 15:31:41 +00:00
StringMap.cpp Use uniform mechanism for OOM errors handling 2018-06-09 05:19:45 +00:00
StringPool.cpp Remove trailing space 2018-07-30 19:41:25 +00:00
StringRef.cpp Remove trailing space 2018-07-30 19:41:25 +00:00
StringSaver.cpp Fix an undefined behavior when storing an empty StringRef. 2018-08-20 13:12:54 +00:00
SymbolRemappingReader.cpp Common infrastructure for reading a profile remapping file and building 2018-09-13 18:51:44 +00:00
SystemUtils.cpp
TargetParser.cpp Fix build error due to missing cctype include 2018-11-28 15:12:33 +00:00
TargetRegistry.cpp Improve incompatible triple error 2018-08-23 03:40:31 +00:00
TarWriter.cpp [FileSystem] Split up the OpenFlags enumeration. 2018-06-07 19:58:58 +00:00
Threading.cpp s/LLVM_ON_WIN32/_WIN32/, llvm 2018-04-29 00:45:03 +00:00
ThreadLocal.cpp IWYU for llvm-config.h in llvm, additions. 2018-04-30 14:59:11 +00:00
ThreadPool.cpp Revert "Enable ThreadPool to queue tasks that return values." 2018-06-13 21:24:19 +00:00
Timer.cpp llvm::sort(C.begin(), C.end(), ...) -> llvm::sort(C, ...) 2018-09-27 02:13:45 +00:00
ToolOutputFile.cpp [Support] Rename tool_output_file to ToolOutputFile, NFC 2017-09-23 01:03:17 +00:00
TrigramIndex.cpp
Triple.cpp Add Hurd target to LLVMSupport (1/2) 2018-11-29 03:23:01 +00:00
Twine.cpp IWYU for llvm-config.h in llvm, additions. 2018-04-30 14:59:11 +00:00
Unicode.cpp
UnicodeCaseFold.cpp Resubmit r325107 (case folding DJB hash) 2018-02-21 22:36:31 +00:00
Valgrind.cpp
VersionTuple.cpp Move VersionTuple from clang/Basic to llvm/Support 2018-06-11 10:28:04 +00:00
VirtualFileSystem.cpp [VFS] Implement RedirectingFileSystem::getRealPath. 2018-11-16 01:15:54 +00:00
Watchdog.cpp IWYU for llvm-config.h in llvm, additions. 2018-04-30 14:59:11 +00:00
WithColor.cpp [SourceMgr][FileCheck] Obey -color by extending WithColor 2018-10-24 21:46:42 +00:00
xxhash.cpp Make ICF log output order deterministic. 2018-07-31 18:04:58 +00:00
YAMLParser.cpp Remove trailing space 2018-07-30 19:41:25 +00:00
YAMLTraits.cpp [Support] Teach YAMLIO about polymorphic types 2018-11-14 19:39:59 +00:00

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