llvm/lib/Support
Nick Lewycky e7c1aef2b8 Move WEAK marking to the declaration.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@144603 91177308-0d34-0410-b5e6-96231b3b80d8
2011-11-15 01:23:22 +00:00
..
Unix rename getHostTriple into getDefaultTargetTriple 2011-11-01 21:32:20 +00:00
Windows Return only the least significant 8 bits of the exit status from 2011-11-06 16:45:46 +00:00
Allocator.cpp Add BumpPtrAllocator::getTotalMemory() to allow clients to query how much memory a BumpPtrAllocator allocated. 2011-04-18 22:44:46 +00:00
APFloat.cpp Fix APFloat::getSmallestNormalized so the shift doesn't depend on undefined behavior. Patch from Ahmed Charles. 2011-10-12 21:56:19 +00:00
APInt.cpp Fix APInt::operator*= so that it computes the correct result for large integers where there is unsigned overflow. Fix APFloat::toString so that it doesn't depend on the incorrect behavior in common cases (and computes the correct result in some rare cases). Fixes PR11086. 2011-10-07 23:40:49 +00:00
APSInt.cpp Added FoldingSet style 'profiling' support for APSInt. 2008-01-19 04:31:12 +00:00
Atomic.cpp Rename LLVM_MULTITHREADED define and fix build without threads. 2011-09-19 20:43:23 +00:00
BlockFrequency.cpp BlockFrequency: Use a smarter overflow check. 2011-10-27 16:38:50 +00:00
BranchProbability.cpp Print branch probabilities as percentages. 2011-10-23 11:32:54 +00:00
circular_raw_ostream.cpp clean this up, fix std::min ambiguity on some platforms. 2010-04-09 20:43:54 +00:00
CMakeLists.txt Add the DataExtractor utility class. 2011-09-13 19:42:16 +00:00
CommandLine.cpp rename getHostTriple into getDefaultTargetTriple 2011-11-01 21:32:20 +00:00
ConstantRange.cpp Change: 2011-09-21 03:09:09 +00:00
COPYRIGHT.regex Add regular expression matching support, based on OpenBSD regexec()/regcomp() 2009-08-30 08:24:09 +00:00
CrashRecoveryContext.cpp lib/Support/CrashRecoveryContext.cpp: Add Win32 support to CrashRecoveryContext. Thanks to Aaron Ballman! 2011-08-20 06:35:36 +00:00
DAGDeltaAlgorithm.cpp Use const_iterator where appropriate. 2010-06-08 17:21:57 +00:00
DataExtractor.cpp Add the DataExtractor utility class. 2011-09-13 19:42:16 +00:00
Debug.cpp Merge System into Support. 2010-11-29 18:16:10 +00:00
DeltaAlgorithm.cpp DeltaAlgorithm: Tweak split to split by first/second half instead of even/odd, since adjacent changes are more likely to be related. 2010-06-08 16:21:26 +00:00
Disassembler.cpp Clean up a few references to System/. We still have docs/SystemLibrary.html 2011-10-11 20:02:52 +00:00
Dwarf.cpp Add some more DWARF extensions from: 2011-09-15 05:21:03 +00:00
DynamicLibrary.cpp Make DynamicLibrary thread-safe w/r/t call to dlerror() after dlopen(). PR10718 2011-08-22 19:01:52 +00:00
Errno.cpp lib/Support/Errno.cpp: Check strerror_s() with HAVE_DECL_STRERROR_S in config.h.*. 2011-02-09 04:18:48 +00:00
ErrorHandling.cpp Like the coding standards say, do not use "using namespace std". 2011-04-23 09:06:00 +00:00
FileUtilities.cpp Fix a ton of comment typos found by codespell. Patch by 2011-04-15 05:18:47 +00:00
FoldingSet.cpp Simplify & microoptimize code. No intended functionality change. 2011-07-18 00:00:20 +00:00
FormattedStream.cpp Add missing standard headers. Patch by Joerg Sonnenberger! 2010-12-19 20:43:38 +00:00
GraphWriter.cpp Merge System into Support. 2010-11-29 18:16:10 +00:00
Host.cpp Intel family 6 model 44 is Gulftown/Westmere-EP and doesn't have AVX. 2011-08-25 18:05:56 +00:00
IncludeFile.cpp Clean up a few references to System/. We still have docs/SystemLibrary.html 2011-10-11 20:02:52 +00:00
IntEqClasses.cpp Use IntEqClasses to compute connected components of live intervals. 2010-12-21 00:48:17 +00:00
IntervalMap.cpp Add IntervalMap::iterator::set{Start,Stop,Value} methods that allow limited 2010-12-03 19:02:00 +00:00
IsInf.cpp Remove attribution from file headers, per discussion on llvmdev. 2007-12-29 20:36:04 +00:00
IsNAN.cpp Remove attribution from file headers, per discussion on llvmdev. 2007-12-29 20:36:04 +00:00
LLVMBuild.txt build: Add initial cut at LLVMBuild.txt files. 2011-11-03 18:53:17 +00:00
Makefile Merge System into Support. 2010-11-29 18:16:10 +00:00
ManagedStatic.cpp Add support for tsan annotations (thread sanitizer, a valgrind-based tool). 2011-11-14 20:50:16 +00:00
Memory.cpp The Mips specific function for instruction cache invalidation cannot be 2011-10-10 18:41:02 +00:00
MemoryBuffer.cpp Remove unused include of sys/uio.h in MemoryBuffer.cpp. It was not correctly protected by ifdef either. 2011-10-20 21:57:46 +00:00
MemoryObject.cpp Report failure if there are less bytes than requested in a MemoryObject. 2011-08-27 07:45:46 +00:00
Mutex.cpp Clean up a few references to System/. We still have docs/SystemLibrary.html 2011-10-11 20:02:52 +00:00
Path.cpp Remove a couple unused methods. PR11201. 2011-11-01 05:11:01 +00:00
PathV2.cpp Fix a minor bug in fs::create_directories. Patch by Albert Wong. 2011-09-16 18:36:31 +00:00
PluginLoader.cpp Merge System into Support. 2010-11-29 18:16:10 +00:00
PrettyStackTrace.cpp Add more initializers to quiet a clang warning. 2011-10-05 05:00:26 +00:00
Process.cpp Merge System into Support. 2010-11-29 18:16:10 +00:00
Program.cpp Have Program::Wait return -2 for crashed and timeouts instead of embedding 2011-05-21 00:56:46 +00:00
raw_os_ostream.cpp Make some methods const. The only interesting change here is that 2009-12-19 01:38:42 +00:00
raw_ostream.cpp Avoid undefined behavior in signed integer negation. Patch by Ahmed Charles. 2011-10-13 22:49:56 +00:00
README.txt.system Merge System into Support. 2010-11-29 18:16:10 +00:00
regcclass.h Add regular expression matching support, based on OpenBSD regexec()/regcomp() 2009-08-30 08:24:09 +00:00
regcname.h Add regular expression matching support, based on OpenBSD regexec()/regcomp() 2009-08-30 08:24:09 +00:00
regcomp.c lib/Support/regcomp.c: Fix cygwin warning. 2011-03-08 12:25:29 +00:00
regengine.inc Various MSVC warning fixes about truncated 64 bit shifts and const pointers passed to free. 2010-04-08 15:25:57 +00:00
regerror.c More MSVC warning fixes: 2009-09-06 12:26:28 +00:00
regex2.h Add regular expression matching support, based on OpenBSD regexec()/regcomp() 2009-08-30 08:24:09 +00:00
regex_impl.h Add regular expression matching support, based on OpenBSD regexec()/regcomp() 2009-08-30 08:24:09 +00:00
Regex.cpp regexes are allowed to match empty things, e.g. {{.*}} in filecheck. 2011-04-09 06:29:24 +00:00
regexec.c lib/Support/regexec.c: Let Regex LLP64-aware. 2010-12-16 01:48:15 +00:00
regfree.c Add regular expression matching support, based on OpenBSD regexec()/regcomp() 2009-08-30 08:24:09 +00:00
regstrlcpy.c Add regular expression matching support, based on OpenBSD regexec()/regcomp() 2009-08-30 08:24:09 +00:00
regutils.h More MSVC warning fixes: 2009-09-06 12:26:28 +00:00
RWMutex.cpp Clean up a few references to System/. We still have docs/SystemLibrary.html 2011-10-11 20:02:52 +00:00
SearchForAddressOfSpecialSymbol.cpp These symbols appear to be visible by SearchForAddressOfSymbol and no longer 2011-09-27 20:01:41 +00:00
Signals.cpp Fix a ton of comment typos found by codespell. Patch by 2011-04-15 05:18:47 +00:00
SmallPtrSet.cpp Prevent infinite growth of SmallPtrSet instances. 2011-03-30 18:32:48 +00:00
SmallVector.cpp After some discussion with djg, teach SmallVector to grow from a zero 2010-09-02 21:55:03 +00:00
SourceMgr.cpp remove the dead 'ShowLine' argument from SMDiagnostic. 2011-10-16 05:47:55 +00:00
Statistic.cpp Let printf do the formatting instead aligning strings ourselves. 2011-10-16 16:30:34 +00:00
StringExtras.cpp move tier out of an anonymous namespace, it doesn't make sense 2011-07-21 06:21:31 +00:00
StringMap.cpp Reset StringMap's NumTombstones on clears and rehashes. 2011-03-30 18:32:51 +00:00
StringPool.cpp Don't pass StringRef by reference. 2010-07-14 22:38:02 +00:00
StringRef.cpp Fix a typo. 2011-11-06 20:36:50 +00:00
system_error.cpp Support/MemoryBuffer: Replace all uses of std::string *ErrMsg with error_code &ec. And fix clients. 2010-12-09 17:36:48 +00:00
SystemUtils.cpp Merge System into Support. 2010-11-29 18:16:10 +00:00
TargetRegistry.cpp rename getHostTriple into getDefaultTargetTriple 2011-11-01 21:32:20 +00:00
Threading.cpp Rename LLVM_MULTITHREADED define and fix build without threads. 2011-09-19 20:43:23 +00:00
ThreadLocal.cpp Clean up a few references to System/. We still have docs/SystemLibrary.html 2011-10-11 20:02:52 +00:00
Timer.cpp Add more PRI.64 macros for MSVC and use them throughout the codebase. 2011-11-05 08:57:40 +00:00
TimeValue.cpp Merge System into Support. 2010-11-29 18:16:10 +00:00
ToolOutputFile.cpp Merge System into Support. 2010-11-29 18:16:10 +00:00
Triple.cpp Remove the Alpha backend. 2011-10-27 22:56:32 +00:00
Twine.cpp Add Twine support for characters, and switch twine to use a union internally 2011-07-24 20:44:30 +00:00
Valgrind.cpp Move WEAK marking to the declaration. 2011-11-15 01:23:22 +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