llvm/lib/Support
Evgeniy Stepanov 9c02a27604 More MSan/ASan annotations.
This change lets us bootstrap LLVM/Clang under ASan and MSan. It contains
fixes for 2 issues:

- X86JIT reads return address from stack, which MSan does not know is
  initialized.
- bugpoint tests run binaries with RLIMIT_AS. This does not work with certain
  Sanitizers.

We are no longer including config.h in Compiler.h with this change.


git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@174306 91177308-0d34-0410-b5e6-96231b3b80d8
2013-02-04 07:03:24 +00:00
..
Unix More MSan/ASan annotations. 2013-02-04 07:03:24 +00:00
Windows Move the internal PrintStackTrace function that is used for llvm::sys::PrintStackTraceOnErrorSignal(), 2013-01-09 19:42:40 +00:00
Allocator.cpp More MSan/ASan annotations. 2013-02-04 07:03:24 +00:00
APFloat.cpp APFloat: Make sure that we get a well-formed x87 NaN when converting from a smaller type. 2013-01-25 17:01:00 +00:00
APInt.cpp Use the new script to sort the includes of every file under lib. 2012-12-03 16:50:05 +00:00
APSInt.cpp
Atomic.cpp XLC supports the same atomic functions as GCC, use them. 2012-11-02 20:54:45 +00:00
BlockFrequency.cpp
BranchProbability.cpp
circular_raw_ostream.cpp
CMakeLists.txt Move UTF conversion routines from clang/lib/Basic to llvm/lib/Support 2013-01-30 12:05:05 +00:00
CommandLine.cpp Use the new script to sort the includes of every file under lib. 2012-12-03 16:50:05 +00:00
ConstantRange.cpp Move all of the header files which are involved in modelling the LLVM IR 2013-01-02 11:36:10 +00:00
ConvertUTF.c Move UTF conversion routines from clang/lib/Basic to llvm/lib/Support 2013-01-30 12:05:05 +00:00
ConvertUTFWrapper.cpp Move UTF conversion routines from clang/lib/Basic to llvm/lib/Support 2013-01-30 12:05:05 +00:00
COPYRIGHT.regex
CrashRecoveryContext.cpp Use the new script to sort the includes of every file under lib. 2012-12-03 16:50:05 +00:00
DAGDeltaAlgorithm.cpp Add LLVM_OVERRIDE to methods that override their base classes. 2012-09-23 02:12:10 +00:00
DataExtractor.cpp DataExtractor: Fix integer truncation issues in LEB128 extraction. 2012-08-20 10:52:11 +00:00
DataStream.cpp Use the new script to sort the includes of every file under lib. 2012-12-03 16:50:05 +00:00
Debug.cpp Use the new script to sort the includes of every file under lib. 2012-12-03 16:50:05 +00:00
DeltaAlgorithm.cpp Revert r171829 "Split changeset_ty using iterators instead of loops" as it breaks the VS2008 build 2013-01-14 14:13:06 +00:00
Disassembler.cpp Use the new script to sort the includes of every file under lib. 2012-12-03 16:50:05 +00:00
Dwarf.cpp Remove the llvm-local DW_TAG_vector_type tag and add a test to 2013-01-08 01:53:52 +00:00
DynamicLibrary.cpp Remove redundant 'llvm::' qualifications 2013-01-13 16:01:15 +00:00
Errno.cpp [Support] Fix StrError on Windows to actually return the error string... 2012-11-01 00:34:09 +00:00
ErrorHandling.cpp Use the new script to sort the includes of every file under lib. 2012-12-03 16:50:05 +00:00
FileOutputBuffer.cpp [Support] Make FileOutputBuffer work on Windows. 2012-12-03 22:09:52 +00:00
FileUtilities.cpp Use the new script to sort the includes of every file under lib. 2012-12-03 16:50:05 +00:00
FoldingSet.cpp Fix whitespace. No functionality change. 2012-12-25 06:13:25 +00:00
FormattedStream.cpp
GraphWriter.cpp ScheduleDAG: colorize the DOT graph and improve formatting. 2013-01-25 07:45:25 +00:00
Hashing.cpp
Host.cpp Introduce llvm::sys::getProcessTriple() function. 2013-01-16 17:27:22 +00:00
IncludeFile.cpp
IntEqClasses.cpp
IntervalMap.cpp
IntrusiveRefCntPtr.cpp
IsInf.cpp
IsNAN.cpp
LLVMBuild.txt
Locale.cpp
LocaleGeneric.inc
LocaleWindows.inc Switch LLVM_USE_RVALUE_REFERENCES to LLVM_HAS_RVALUE_REFERENCES. 2012-11-30 11:45:22 +00:00
LocaleXlocale.inc Use the new script to sort the includes of every file under lib. 2012-12-03 16:50:05 +00:00
LockFileManager.cpp Fix a race condition in the lock-file manager: once the lock file is 2013-01-10 02:01:35 +00:00
Makefile Don't explicitly require RTTI and EH. 2012-10-26 12:15:29 +00:00
ManagedStatic.cpp
Memory.cpp Use the new script to sort the includes of every file under lib. 2012-12-03 16:50:05 +00:00
MemoryBuffer.cpp Go ahead and get rid of the old page size interface and convert all the 2012-12-31 23:31:56 +00:00
MemoryObject.cpp
Mutex.cpp Add support for the OpenBSD for Bitrig. 2012-08-06 20:52:18 +00:00
Path.cpp Remove duplicate includes. 2012-12-21 17:06:44 +00:00
PathV2.cpp Use the new script to sort the includes of every file under lib. 2012-12-03 16:50:05 +00:00
PluginLoader.cpp Use the new script to sort the includes of every file under lib. 2012-12-03 16:50:05 +00:00
PrettyStackTrace.cpp Use the new script to sort the includes of every file under lib. 2012-12-03 16:50:05 +00:00
Process.cpp Add time getters to the process interface for requesting the elapsed 2013-01-04 23:19:55 +00:00
Program.cpp
raw_os_ostream.cpp
raw_ostream.cpp Use the new script to sort the includes of every file under lib. 2012-12-03 16:50:05 +00:00
README.txt.system
regcclass.h
regcname.h
regcomp.c Add backreference matching capabilities to Support/Regex, with 2012-11-28 19:00:02 +00:00
regengine.inc
regerror.c
regex2.h
regex_impl.h
Regex.cpp Use the new script to sort the includes of every file under lib. 2012-12-03 16:50:05 +00:00
regexec.c Fix integer undefined behavior due to signed left shift overflow in LLVM. 2012-08-24 23:29:28 +00:00
regfree.c
regstrlcpy.c
regutils.h
RWMutex.cpp
SearchForAddressOfSpecialSymbol.cpp
Signals.cpp
SmallPtrSet.cpp
SmallVector.cpp Reduce alignment of SmallVector<T> to the required amount, rather than forcing 16-byte alignment. This fixes misaligned SmallVector accesses via ExtractValueInst's SmallVector data member. 2012-08-22 00:11:07 +00:00
SourceMgr.cpp SMDiagnostic: don't emit ranges if there are /any/ multibyte characters. 2013-01-11 02:37:55 +00:00
Statistic.cpp Use the new script to sort the includes of every file under lib. 2012-12-03 16:50:05 +00:00
StreamableMemoryObject.cpp Add LLVM_OVERRIDE to methods that override their base classes. 2012-09-23 02:12:10 +00:00
StringExtras.cpp
StringMap.cpp Add some __builtin_expect magic to StringMap. 2012-08-29 22:57:04 +00:00
StringPool.cpp
StringRef.cpp Use the new script to sort the includes of every file under lib. 2012-12-03 16:50:05 +00:00
system_error.cpp Use the new script to sort the includes of every file under lib. 2012-12-03 16:50:05 +00:00
SystemUtils.cpp
TargetRegistry.cpp
Threading.cpp Use the new script to sort the includes of every file under lib. 2012-12-03 16:50:05 +00:00
ThreadLocal.cpp
Timer.cpp Use the new script to sort the includes of every file under lib. 2012-12-03 16:50:05 +00:00
TimeValue.cpp
ToolOutputFile.cpp
Triple.cpp Add AArch64 as an experimental target. 2013-01-31 12:12:40 +00:00
Twine.cpp
Valgrind.cpp
YAMLParser.cpp Use the new script to sort the includes of every file under lib. 2012-12-03 16:50:05 +00:00
YAMLTraits.cpp Fix memory leak in YAML I/O. 2013-01-08 21:04:44 +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