llvm/lib/Support
Chris Bieneman 4990e83b7b Re-landing changes to use ArrayRef instead of SmallVectorImpl, and new API test.
This contains the changes from r227148 & r227154, and also fixes to the test case to properly clean up the stack options.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@227255 91177308-0d34-0410-b5e6-96231b3b80d8
2015-01-27 22:21:06 +00:00
..
Unix [cleanup] Re-sort all the #include lines in LLVM using 2015-01-14 11:23:27 +00:00
Windows [Support][Windows] Disable error dialog boxes when stack trace printing is enabled. 2015-01-26 17:05:02 +00:00
Allocator.cpp [Allocator] Hoist the external helper function into a namespace scope 2014-04-14 06:42:56 +00:00
APFloat.cpp [APFloat][ADT] Fix sign handling logic for FMA results that truncate to zero. 2015-01-04 01:20:55 +00:00
APInt.cpp APInt: udivrem should use machine instructions for single-word APInts 2014-12-14 09:41:56 +00:00
APSInt.cpp
ARMBuildAttrs.cpp ARM: update build attributes for ABI r2.09 2014-01-19 08:25:35 +00:00
ARMWinEH.cpp Support: add Windows ARM EH data structures 2014-06-02 01:17:49 +00:00
Atomic.cpp Fix .cpp files claiming to be header files 2014-06-20 01:36:00 +00:00
BlockFrequency.cpp blockfreq: Defer to BranchProbability::scale() (again) 2014-04-29 16:31:29 +00:00
BranchProbability.cpp BranchProb: Simplify printing code 2014-04-29 17:07:42 +00:00
circular_raw_ostream.cpp
CMakeLists.txt Merge StreamableMemoryObject into MemoryObject. 2014-11-12 03:55:46 +00:00
CommandLine.cpp Re-landing changes to use ArrayRef instead of SmallVectorImpl, and new API test. 2015-01-27 22:21:06 +00:00
Compression.cpp [msan] Annotate zlib functions for MemorySanitizer. 2014-11-25 15:24:07 +00:00
ConvertUTF.c Support/ConvertUTF: restore compatibility with MSVC, which only implements C89 2014-06-16 11:22:33 +00:00
ConvertUTFWrapper.cpp Have the UTF conversion wrappers append a null terminator. 2015-01-26 22:05:50 +00:00
COPYRIGHT.regex
CrashRecoveryContext.cpp For CrashRecoveryContext::RunSafelyOnThread, propagate Darwin's PRIO_DARWIN_BG to the new thread if it is 2014-06-25 23:54:50 +00:00
DAGDeltaAlgorithm.cpp [Modules] Make Support/Debug.h modular. This requires it to not change 2014-04-21 22:55:11 +00:00
DataExtractor.cpp Using llvm::sys::swapByteOrder() for the common case of byte-swapping a value in place 2014-06-14 13:18:07 +00:00
DataStream.cpp Merge StreamableMemoryObject into MemoryObject. 2014-11-12 03:55:46 +00:00
Debug.cpp [cleanup] Re-sort all the #include lines in LLVM using 2015-01-14 11:23:27 +00:00
DeltaAlgorithm.cpp
Dwarf.cpp Modernize doxygen comments in Support/Dwarf.h 2014-10-23 04:08:38 +00:00
DynamicLibrary.cpp Revert "Limit the symbol search in DynamicLibrary to the module that was opened." 2014-08-27 17:51:43 +00:00
Errno.cpp Silence warning: variable 'buffer' set but not used. 2014-12-04 21:36:38 +00:00
ErrorHandling.cpp [cleanup] Re-sort all the #include lines in LLVM using 2015-01-14 11:23:27 +00:00
FileOutputBuffer.cpp [cleanup] Re-sort all the #include lines in LLVM using 2015-01-14 11:23:27 +00:00
FileUtilities.cpp Remove some calls to std::move. 2014-08-01 14:31:55 +00:00
FoldingSet.cpp [C++11] More 'nullptr' conversion. In some cases just using a boolean check instead of comparing to nullptr. 2014-04-15 06:32:26 +00:00
FormattedStream.cpp [C++11] Make use of 'nullptr' in the Support library. 2014-04-07 04:17:22 +00:00
GraphWriter.cpp Fix style. 2014-11-07 21:30:36 +00:00
Hashing.cpp
Host.cpp Remove a debugging assert. 2014-12-17 03:38:04 +00:00
IntEqClasses.cpp
IntervalMap.cpp [C++11] Make use of 'nullptr' in the Support library. 2014-04-07 04:17:22 +00:00
IntrusiveRefCntPtr.cpp
IsInf.cpp
IsNAN.cpp
LEB128.cpp Don't inline get[S|U]LEB128Size() until they are proved to be hot. 2014-02-22 15:39:39 +00:00
LineIterator.cpp Add CRLF support to LineIterator. 2014-11-03 14:09:47 +00:00
LLVMBuild.txt
Locale.cpp
LockFileManager.cpp Misc cleanups to the FileSytem api. 2014-09-11 20:30:02 +00:00
Makefile Support: Inject LLVM_VERSION_INFO into the Support library 2014-06-17 06:52:47 +00:00
ManagedStatic.cpp Revert 220932. 2014-11-05 04:44:31 +00:00
MathExtras.cpp Fix llvm::huge_valf multiple initializations with Visual C++. 2014-09-27 14:41:29 +00:00
MD5.cpp Make the MD5 result name consistent between functions, header and source. 2014-10-06 13:48:07 +00:00
Memory.cpp
MemoryBuffer.cpp Pass EC by reference to MemoryBufferMMapFile to return error code. 2014-12-12 22:27:53 +00:00
MemoryObject.cpp Make readBytes pure virtual. Every real implementation has it. 2014-11-12 02:30:38 +00:00
Mutex.cpp [C++11] More 'nullptr' conversion. In some cases just using a boolean check instead of comparing to nullptr. 2014-04-15 06:32:26 +00:00
Options.cpp Defining a new API for debug options that doesn't rely on static global cl::opts. 2014-10-15 21:54:35 +00:00
Path.cpp [Object][ELF] Test unknown type. 2015-01-23 21:58:09 +00:00
PluginLoader.cpp
PrettyStackTrace.cpp [C++11] Replace some comparisons with 'nullptr' with simple boolean checks to reduce verbosity. 2014-04-09 04:20:00 +00:00
Process.cpp Remove dead code. NFC. 2014-12-04 16:59:36 +00:00
Program.cpp Fix .cpp files claiming to be header files 2014-06-20 01:36:00 +00:00
RandomNumberGenerator.cpp Random Number Generator Refactoring (removing from Module) 2014-12-17 18:12:10 +00:00
raw_os_ostream.cpp
raw_ostream.cpp Teach raw_ostream to support hex formatting without a prefix '0x'. 2015-01-26 18:21:33 +00:00
README.txt.system
regcclass.h adding re-include guards into lib/Support/reg*.h 2014-06-12 16:07:56 +00:00
regcname.h adding re-include guards into lib/Support/reg*.h 2014-06-12 16:07:56 +00:00
regcomp.c Fix known typos 2014-01-24 17:20:08 +00:00
regengine.inc Clean up language and grammar. 2014-05-20 17:11:11 +00:00
regerror.c
regex2.h adding re-include guards into lib/Support/reg*.h 2014-06-12 16:07:56 +00:00
regex_impl.h
Regex.cpp [C++11] Make use of 'nullptr' in the Support library. 2014-04-07 04:17:22 +00:00
regexec.c
regfree.c
regstrlcpy.c
regutils.h adding re-include guards into lib/Support/reg*.h 2014-06-12 16:07:56 +00:00
RWMutex.cpp [C++11] More 'nullptr' conversion. In some cases just using a boolean check instead of comparing to nullptr. 2014-04-15 06:32:26 +00:00
ScaledNumber.cpp [cleanup] Re-sort all the #include lines in LLVM using 2015-01-14 11:23:27 +00:00
SearchForAddressOfSpecialSymbol.cpp [C++11] Make use of 'nullptr' in the Support library. 2014-04-07 04:17:22 +00:00
Signals.cpp
SmallPtrSet.cpp Update SetVector to rely on the underlying set's insert to return a pair<iterator, bool> 2014-11-19 07:49:26 +00:00
SmallVector.cpp
SourceMgr.cpp Remove unnecessary .c_str() when implicitly converting to Twine 2014-11-06 01:13:27 +00:00
SpecialCaseList.cpp Remove support for undocumented SpecialCaseList entries. 2014-11-20 01:27:19 +00:00
Statistic.cpp Revert "[C++11] Replace LLVM atomics with std::atomic." 2014-03-03 18:02:34 +00:00
StreamingMemoryObject.cpp Fixing -Wtype-limits warnings with the asserts (the expression would always evaluate to true). Also fixing a -Wcast-qual warning, where the cast expression isn't required. 2014-11-13 13:55:13 +00:00
StringExtras.cpp
StringMap.cpp Recommit 211309 (StringMap::insert), reverted in 211328 due to issues with private, but non-deleted, move members. 2014-06-23 18:28:53 +00:00
StringPool.cpp Convert StringMapEntry::Create to use StringRef instead of start/end pointers. Simpliies all in tree call sites. No functional change. 2014-06-11 05:35:56 +00:00
StringRef.cpp Simplify creation of a bunch of ArrayRefs by using None, makeArrayRef or just letting them be implicitly created. 2014-08-27 05:25:25 +00:00
SystemUtils.cpp
TargetRegistry.cpp Remove obsolete function TargetRegistry::getClosestTargetForJIT() 2014-07-01 10:47:13 +00:00
Threading.cpp Revert 220932. 2014-11-05 04:44:31 +00:00
ThreadLocal.cpp ThreadLocal: Move Unix-specific code out of Support/ThreadLocal.cpp 2014-12-15 01:19:53 +00:00
Timer.cpp Modernize raw_fd_ostream's constructor a bit. 2014-08-25 18:16:47 +00:00
TimeValue.cpp Cleaning up static initializers in TimeValue. 2014-08-29 01:05:12 +00:00
ToolOutputFile.cpp Modernize raw_fd_ostream's constructor a bit. 2014-08-25 18:16:47 +00:00
Triple.cpp The canonical CPU variant for ARM according to config.guess uses a 2015-01-26 11:41:48 +00:00
Twine.cpp Remove unnecessary llvm:: qualification. 2014-02-26 23:27:16 +00:00
Unicode.cpp
Valgrind.cpp Don't mark the declarations of the TSan annotation functions as weak. 2014-03-30 11:20:25 +00:00
Watchdog.cpp
YAMLParser.cpp Remove std::move that was preventing return value optimization. 2015-01-17 00:46:44 +00:00
YAMLTraits.cpp Remove trailing whitespace. NFC ® 2015-01-26 18:02:18 +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