llvm-mirror/lib/Support
Sam McCall 312ed03a23 [Support] Harded JSON against invalid UTF-8.
Parsing invalid UTF-8 input is now a parse error.
Creating JSON values from invalid UTF-8 now triggers an assertion, and
(in no-assert builds) substitutes the unicode replacement character.
Strings retrieved from json::Value are always valid UTF-8.

llvm-svn: 336657
2018-07-10 11:51:26 +00:00
..
Unix Add OpenBSD support to the Threading code 2018-06-23 22:02:59 +00:00
Windows [ThinLTO] Update ThinLTO cache file atimes when on Windows 2018-07-04 14:17: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 [APFloat] Set losesInfo on no-op convert 2018-05-11 09:45:42 +00:00
APInt.cpp Fix MSVC "not all control paths return a value" warnings. NFCI. 2018-06-26 09:31:18 +00:00
APSInt.cpp
ARMAttributeParser.cpp Test commit 2018-02-26 13:05:18 +00:00
ARMBuildAttrs.cpp
ARMWinEH.cpp
Atomic.cpp
BinaryStreamError.cpp
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
CachePruning.cpp Rename DEBUG macro to LLVM_DEBUG. 2018-05-14 12:53:11 +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 Lift JSON library from clang-tools-extra/clangd to llvm/Support. 2018-07-09 10:05:41 +00:00
CodeGenCoverage.cpp IWYU for llvm-config.h in llvm, additions. 2018-04-30 14:59:11 +00:00
COM.cpp IWYU for llvm-config.h in llvm, additions. 2018-04-30 14:59:11 +00:00
CommandLine.cpp [CommandLine] Error message for incorrect PositionalEatArgs usage 2018-05-14 23:26:06 +00:00
Compression.cpp
ConvertUTF.cpp
ConvertUTFWrapper.cpp
COPYRIGHT.regex
CrashRecoveryContext.cpp Remove \brief commands from doxygen comments. 2018-05-01 15:54:18 +00:00
DAGDeltaAlgorithm.cpp Rename DEBUG macro to LLVM_DEBUG. 2018-05-14 12:53:11 +00:00
DataExtractor.cpp
Debug.cpp Rename DEBUG macro to LLVM_DEBUG. 2018-05-14 12:53:11 +00:00
DebugCounter.cpp [DebugCounter] Make -debug-counter cl::Hidden. 2018-04-01 22:16:52 +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
Error.cpp [Support] Make llvm::Error and Expected faster. 2017-11-09 19:31:52 +00:00
ErrorHandling.cpp s/LLVM_ON_WIN32/_WIN32/, llvm 2018-04-29 00:45:03 +00:00
FileOutputBuffer.cpp Add a flag to FileOutputBuffer that allows modification. 2018-06-28 18:49:09 +00:00
FileUtilities.cpp
FoldingSet.cpp Use uniform mechanism for OOM errors handling 2018-06-09 05:19:45 +00:00
FormattedStream.cpp
FormatVariadic.cpp
GlobPattern.cpp
GraphWriter.cpp Refactor ExecuteAndWait to take StringRefs. 2018-06-12 17:43:52 +00:00
Hashing.cpp
Host.cpp [x86] invpcid LLVM intrinsic 2018-05-25 06:32:05 +00:00
InitLLVM.cpp Rename sys::Process::GetArgumentVector -> sys::windows::GetCommandLineArguments 2018-04-17 21:09:16 +00:00
IntEqClasses.cpp
IntervalMap.cpp
JamCRC.cpp
JSON.cpp [Support] Harded JSON against invalid UTF-8. 2018-07-10 11:51:26 +00:00
KnownBits.cpp
LEB128.cpp
LineIterator.cpp
LLVMBuild.txt
Locale.cpp IWYU for llvm-config.h, removals. Also see r331184. 2018-04-30 15:26:01 +00:00
LockFileManager.cpp LTO: Keep file handles open for memory mapped files. 2018-06-13 18:03:14 +00:00
LowLevelType.cpp [GlobalISel] Enable legalizing non-power-of-2 sized types. 2017-11-07 10:34:34 +00:00
ManagedStatic.cpp [NFC] Remove inaccurate comment 2018-05-12 19:39:34 +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 Fix build errors on some configurations 2018-06-11 13:30:47 +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 Fix typo in lib/Support/Path.cpp to test commit access 2018-07-03 17:26:43 +00:00
PluginLoader.cpp
PrettyStackTrace.cpp Avoid copying PrettyStackTrace messages an extra time on Apple OSs 2018-06-15 16:35:31 +00:00
Process.cpp IWYU for llvm-config.h in llvm, additions. 2018-04-30 14:59:11 +00:00
Program.cpp Refactor ExecuteAndWait to take StringRefs. 2018-06-12 17:43:52 +00:00
RandomNumberGenerator.cpp Rename DEBUG macro to LLVM_DEBUG. 2018-05-14 12:53:11 +00:00
raw_os_ostream.cpp
raw_ostream.cpp [FileSystem] Split up the OpenFlags enumeration. 2018-06-07 19:58:58 +00:00
README.txt.system
regcomp.c Attempt to heal bots after r328970. 2018-04-02 13:49:35 +00:00
regengine.inc
regerror.c
regex2.h Support/reg*.h: Make headers include their dependencies 2017-10-26 20:23:11 +00:00
regex_impl.h
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: Use EBO to shrink SmallVector size 1 2018-06-23 18:39:44 +00:00
SourceMgr.cpp [Support] Change std::sort to llvm::sort in response to r327219 2018-04-08 16:46:22 +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] Make escaping fn conform to coding guidelines 2018-05-31 17:01:42 +00:00
StringMap.cpp Use uniform mechanism for OOM errors handling 2018-06-09 05:19:45 +00:00
StringPool.cpp
StringRef.cpp Fix APFloat from string conversion for Inf 2017-12-19 04:27:39 +00:00
StringSaver.cpp
SystemUtils.cpp
TargetParser.cpp [ARM][AArch64] Armv8.4-A Enablement 2018-06-29 08:43:19 +00:00
TargetRegistry.cpp Add backend name to Target to enable runtime info to be fed back into TableGen 2017-11-15 23:55:44 +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 [Timers] TimerGroup: add constructor from StringMap<TimeRecord> 2018-05-16 18:16:01 +00:00
ToolOutputFile.cpp
TrigramIndex.cpp
Triple.cpp [OpenEmbedded] Add OpenEmbedded vendor 2018-07-05 23:41:17 +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
Watchdog.cpp IWYU for llvm-config.h in llvm, additions. 2018-04-30 14:59:11 +00:00
WithColor.cpp [Support] Move header to WithColor header 2018-05-24 11:47:20 +00:00
xxhash.cpp
YAMLParser.cpp Remove @brief commands from doxygen comments, too. 2018-05-01 16:10:38 +00:00
YAMLTraits.cpp [YAML] Escape non-printable multibyte UTF8 in Output::scalarString. 2018-03-27 19:52:45 +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