llvm-6502/lib/Support
Chandler Carruth 1b279144ec [cleanup] Re-sort all the #include lines in LLVM using
utils/sort_includes.py.

I clearly haven't done this in a while, so more changed than usual. This
even uncovered a missing include from the InstrProf library that I've
added. No functionality changed here, just mechanical cleanup of the
include order.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@225974 91177308-0d34-0410-b5e6-96231b3b80d8
2015-01-14 11:23:27 +00:00
..
Unix [cleanup] Re-sort all the #include lines in LLVM using 2015-01-14 11:23:27 +00:00
Windows [cleanup] Re-sort all the #include lines in LLVM using 2015-01-14 11:23:27 +00:00
Allocator.cpp
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
ARMWinEH.cpp
Atomic.cpp
BlockFrequency.cpp
BranchProbability.cpp
circular_raw_ostream.cpp
CMakeLists.txt
CommandLine.cpp Running clang-format on CommandLine.h and CommandLine.cpp. 2015-01-13 19:14:20 +00:00
Compression.cpp [msan] Annotate zlib functions for MemorySanitizer. 2014-11-25 15:24:07 +00:00
ConvertUTF.c
ConvertUTFWrapper.cpp
COPYRIGHT.regex
CrashRecoveryContext.cpp
DAGDeltaAlgorithm.cpp
DataExtractor.cpp
DataStream.cpp
Debug.cpp [cleanup] Re-sort all the #include lines in LLVM using 2015-01-14 11:23:27 +00:00
DeltaAlgorithm.cpp
Dwarf.cpp
DynamicLibrary.cpp
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
FoldingSet.cpp
FormattedStream.cpp
GraphWriter.cpp
Hashing.cpp
Host.cpp Remove a debugging assert. 2014-12-17 03:38:04 +00:00
IntEqClasses.cpp
IntervalMap.cpp
IntrusiveRefCntPtr.cpp
IsInf.cpp
IsNAN.cpp
LEB128.cpp
LineIterator.cpp
LLVMBuild.txt
Locale.cpp
LockFileManager.cpp
Makefile
ManagedStatic.cpp
MathExtras.cpp
MD5.cpp
Memory.cpp
MemoryBuffer.cpp Pass EC by reference to MemoryBufferMMapFile to return error code. 2014-12-12 22:27:53 +00:00
MemoryObject.cpp
Mutex.cpp
Options.cpp
Path.cpp [cleanup] Re-sort all the #include lines in LLVM using 2015-01-14 11:23:27 +00:00
PluginLoader.cpp
PrettyStackTrace.cpp
Process.cpp Remove dead code. NFC. 2014-12-04 16:59:36 +00:00
Program.cpp
RandomNumberGenerator.cpp Random Number Generator Refactoring (removing from Module) 2014-12-17 18:12:10 +00:00
raw_os_ostream.cpp
raw_ostream.cpp Clean up static analyzer warnings. 2014-12-12 21:48:03 +00:00
README.txt.system
regcclass.h
regcname.h
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 [cleanup] Re-sort all the #include lines in LLVM using 2015-01-14 11:23:27 +00:00
SearchForAddressOfSpecialSymbol.cpp
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
SpecialCaseList.cpp Remove support for undocumented SpecialCaseList entries. 2014-11-20 01:27:19 +00:00
Statistic.cpp
StreamingMemoryObject.cpp
StringExtras.cpp
StringMap.cpp
StringPool.cpp
StringRef.cpp
SystemUtils.cpp
TargetRegistry.cpp
Threading.cpp
ThreadLocal.cpp ThreadLocal: Move Unix-specific code out of Support/ThreadLocal.cpp 2014-12-15 01:19:53 +00:00
Timer.cpp
TimeValue.cpp
ToolOutputFile.cpp
Triple.cpp Triple: Add amdgcn triple 2015-01-06 18:00:00 +00:00
Twine.cpp
Unicode.cpp
Valgrind.cpp
Watchdog.cpp
YAMLParser.cpp
YAMLTraits.cpp [cleanup] Re-sort all the #include lines in LLVM using 2015-01-14 11:23:27 +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