llvm-project/llvm/lib/Support
Craig Topper 00b47eec0f [APInt] Make use of whichWord and maskBit to simplify some code. NFC
llvm-svn: 299342
2017-04-02 19:35:18 +00:00
..
Unix Remove name space pollution from Signals.cpp 2017-03-31 14:58:52 +00:00
Windows Remove name space pollution from Signals.cpp 2017-03-31 14:58:52 +00:00
APFloat.cpp [APInt] Add a public typedef for the internal type of APInt use it instead of integerPart. Make APINT_BITS_PER_WORD and APINT_WORD_SIZE public. 2017-04-02 19:17:22 +00:00
APInt.cpp [APInt] Make use of whichWord and maskBit to simplify some code. NFC 2017-04-02 19:35:18 +00:00
APSInt.cpp Remove some unneeded headers and replace some headers with forward class declarations (NFC) 2016-04-16 07:51:28 +00:00
ARMAttributeParser.cpp [ARM] Create objdump subtarget from build attrs 2017-01-18 13:52:12 +00:00
ARMBuildAttrs.cpp Use StringRef instead of raw pointers in ARMBuildAttrs (NFC) 2016-10-05 00:15:18 +00:00
ARMWinEH.cpp
Allocator.cpp
Atomic.cpp Remove all of the legacy home-grown atomic operations LLVM provided 2016-06-02 17:11:11 +00:00
BinaryStreamError.cpp [Support] Move Stream library from MSF -> Support. 2017-03-02 20:52:51 +00:00
BinaryStreamReader.cpp [Support] Move Stream library from MSF -> Support. 2017-03-02 20:52:51 +00:00
BinaryStreamWriter.cpp [pdb] Write the module info and symbol record streams. 2017-03-15 22:18:53 +00:00
BlockFrequency.cpp
BranchProbability.cpp Cleanup dump() functions. 2017-01-28 02:02:38 +00:00
CMakeLists.txt Recommit: [globalisel] Change LLT constructor string into an LLT-based object that knows how to generate it. 2017-03-07 23:20:35 +00:00
COM.cpp
COPYRIGHT.regex
CachePruning.cpp Support, LTO: When pruning a directory, ignore files matching a prefix. 2017-03-20 16:41:57 +00:00
Chrono.cpp Make naming in Host.h in line with coding standards. 2017-03-31 13:06:40 +00:00
CommandLine.cpp Correct OptionCategoryCompare() in the command line library. 2017-03-27 13:43:24 +00:00
Compression.cpp Recommit r292214 "[Support/Compression] - Change zlib API to return Error instead of custom status" 2017-01-17 15:45:07 +00:00
ConvertUTF.cpp Move UTF functions into namespace llvm. 2016-09-30 00:38:45 +00:00
ConvertUTFWrapper.cpp [NFC] Header cleanup 2016-04-18 09:17:29 +00:00
CrashRecoveryContext.cpp Revert "Fix Clang-tidy modernize-deprecated-headers warnings in remaining files; other minor fixes." 2016-04-05 20:45:04 +00:00
DAGDeltaAlgorithm.cpp
DataExtractor.cpp
Debug.cpp Attempt to fix build bot after r290597 2016-12-27 10:24:58 +00:00
DebugCounter.cpp DebugCounter: Initialize skip to 0, not -1 2017-03-04 14:08:47 +00:00
DeltaAlgorithm.cpp Missing includes. 2016-09-14 08:55:18 +00:00
Dwarf.cpp [DWARFv5] Emit new unit header format. 2017-02-28 20:24:55 +00:00
DynamicLibrary.cpp Reland r296442 with modifications reverted in r296463. 2017-03-02 17:56:45 +00:00
Errno.cpp Revert "Fix Clang-tidy modernize-deprecated-headers warnings in remaining files; other minor fixes." 2016-04-05 20:45:04 +00:00
Error.cpp Fix a linefeed at eof. 2016-11-29 17:32:43 +00:00
ErrorHandling.cpp [Support] Make all Errors convertible to std::error_code. 2016-03-23 23:57:28 +00:00
FileOutputBuffer.cpp Make FileOutputBuffer fail early if you pass a directory. 2017-03-13 22:19:05 +00:00
FileUtilities.cpp Fix some Clang-tidy modernize-use-using and Include What You Use warnings; other minor fixes. 2016-08-23 17:14:32 +00:00
FoldingSet.cpp PR30711: Fix incorrect profiling of 'long long' in FoldingSet, then use it to 2016-10-16 17:49:09 +00:00
FormatVariadic.cpp [Support] Introduce llvm::formatv() function. 2016-11-11 23:57:40 +00:00
FormattedStream.cpp
GlobPattern.cpp Move GlobPattern class from LLD to llvm/Support. 2016-12-20 23:09:09 +00:00
GraphWriter.cpp
Hashing.cpp
Host.cpp Make naming in Host.h in line with coding standards. 2017-03-31 13:06:40 +00:00
IntEqClasses.cpp Remove uses of builtin comma operator. 2016-02-18 22:09:30 +00:00
IntervalMap.cpp
JamCRC.cpp [NFC] Header cleanup 2016-04-18 09:17:29 +00:00
LEB128.cpp
LLVMBuild.txt Add an c++ itanium demangler to llvm. 2016-09-06 19:16:48 +00:00
LineIterator.cpp
Locale.cpp [NFC] Header cleanup 2016-04-18 09:17:29 +00:00
LockFileManager.cpp [LockFileManager] Reduce lock timeout 2017-03-18 00:32:34 +00:00
LowLevelType.cpp Recommit: [globalisel] Change LLT constructor string into an LLT-based object that knows how to generate it. 2017-03-07 23:20:35 +00:00
MD5.cpp Add a function to MD5 a file's contents. 2017-03-20 23:33:18 +00:00
ManagedStatic.cpp Revamp llvm::once_flag to be closer to std::once_flag 2017-02-05 21:13:06 +00:00
MathExtras.cpp Revert "Fix Clang-tidy modernize-deprecated-headers warnings in remaining files; other minor fixes." 2016-04-05 20:45:04 +00:00
Memory.cpp
MemoryBuffer.cpp [Support] Add a function to check if a file resides locally. 2017-02-21 20:55:47 +00:00
Mutex.cpp Revert "Fix Clang-tidy modernize-deprecated-headers warnings in remaining files; other minor fixes." 2016-04-05 20:45:04 +00:00
NativeFormatting.cpp Remove dead variable Len. 2017-01-04 19:47:10 +00:00
Options.cpp
Path.cpp Add a function to MD5 a file's contents. 2017-03-20 23:33:18 +00:00
PluginLoader.cpp
PrettyStackTrace.cpp Include <cstdarg> in PrettyStackTrace.cpp, fixing the bots. 2016-12-14 19:19:53 +00:00
Process.cpp [Support] Creation of minidump after compiler crash on Windows 2016-05-04 16:56:51 +00:00
Program.cpp
README.txt.system
RWMutex.cpp [Support] Fix some Clang-tidy modernize and Include What You Use warnings; other minor fixes (NFC). 2017-02-15 22:17:02 +00:00
RandomNumberGenerator.cpp [Support] Fix undefined behavior in RandomNumberGenerator. 2016-10-11 18:17:26 +00:00
Regex.cpp [Support] - Fix possible crash in match() of llvm::Regex. 2016-09-02 08:44:46 +00:00
SHA1.cpp Fix builbots. 2016-11-23 03:58:12 +00:00
ScaledNumber.cpp Replace APFloatBase static fltSemantics data members with getter functions 2016-12-14 11:57:17 +00:00
ScopedPrinter.cpp [Support] Improve flexibility of binary blob formatter. 2016-11-10 20:16:45 +00:00
SearchForAddressOfSpecialSymbol.cpp Revert "Fix Clang-tidy modernize-deprecated-headers warnings in remaining files; other minor fixes." 2016-04-05 20:45:04 +00:00
Signals.cpp Remove name space pollution from Signals.cpp 2017-03-31 14:58:52 +00:00
SmallPtrSet.cpp [SmallPtrSet] Introduce a find primitive and rewrite count/erase in terms of it 2016-12-31 02:33:22 +00:00
SmallVector.cpp
SourceMgr.cpp [Support] Fix some Clang-tidy modernize and Include What You Use warnings; other minor fixes (NFC). 2017-02-15 22:17:02 +00:00
SpecialCaseList.cpp Use trigrams to speed up SpecialCaseList. 2016-12-01 02:54:54 +00:00
Statistic.cpp Statistic/Timer: Include timers in PrintStatisticsJSON(). 2016-11-18 19:43:24 +00:00
StringExtras.cpp
StringMap.cpp Fix some Clang-tidy modernize-use-using and Include What You Use warnings; other minor fixes. 2016-08-23 17:14:32 +00:00
StringPool.cpp
StringRef.cpp [Support] Add StringRef::getAsDouble. 2017-02-14 19:06:37 +00:00
StringSaver.cpp Use StringRef in StringSaver API (NFC) 2016-10-05 01:32:41 +00:00
SystemUtils.cpp
TarWriter.cpp TarWriter: Fix a bug in Ustar header. 2017-01-09 22:55:00 +00:00
TargetParser.cpp [AArch64] Add Cavium ThunderX support 2017-02-17 18:34:24 +00:00
TargetRegistry.cpp Revert "Use StringRef instead of raw pointer in TargetRegistry API (NFC)" 2016-10-01 07:08:23 +00:00
ThreadLocal.cpp
ThreadPool.cpp [ThreadPool] Rollback recent changes until I figure out the breakage. 2016-11-28 09:17:12 +00:00
Threading.cpp Try to fix thread name truncation on non-Windows. 2017-03-04 18:53:09 +00:00
Timer.cpp Change default TimerGroup singleton to use magic statics 2017-02-16 20:19:49 +00:00
ToolOutputFile.cpp
TrigramIndex.cpp Support escaping in TrigramIndex. 2016-12-02 23:30:16 +00:00
Triple.cpp Set default CPU for OpenBSD/arm to Cortex-A8 2017-02-28 17:28:35 +00:00
Twine.cpp Cleanup dump() functions. 2017-01-28 02:02:38 +00:00
Unicode.cpp
Valgrind.cpp
Watchdog.cpp
YAMLParser.cpp Improve error handling in YAML parsing 2016-11-28 21:38:52 +00:00
YAMLTraits.cpp [YAML] When outputting, provide the ability to write default values. 2017-03-15 17:47:39 +00:00
circular_raw_ostream.cpp
raw_os_ostream.cpp
raw_ostream.cpp Update comment for r299098 per feedback from James Henderson. 2017-03-31 12:08:45 +00:00
regcclass.h
regcname.h
regcomp.c
regengine.inc
regerror.c
regex2.h
regex_impl.h
regexec.c
regfree.c
regstrlcpy.c
regutils.h
xxhash.cpp Add xxhash to llvm. 2016-09-27 15:45:57 +00:00

README.txt.system

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