llvm-mirror/lib/Support
Eric Christopher c2a56d46fc Allow unique_file to take a mode for file permissions, but default
to user only read/write.

Part of rdar://11325849

llvm-svn: 156591
2012-05-11 00:07:44 +00:00
..
Unix Allow unique_file to take a mode for file permissions, but default 2012-05-11 00:07:44 +00:00
Windows Allow unique_file to take a mode for file permissions, but default 2012-05-11 00:07:44 +00:00
Allocator.cpp BumpPtrAllocator: Make sure threshold cannot be initialized with a value smaller than the slab size. 2012-03-01 22:10:16 +00:00
APFloat.cpp Replace the hashing functions on APInt and APFloat with overloads of the 2012-03-04 12:02:57 +00:00
APInt.cpp Move APInt::operator[] inline. 2012-03-14 00:38:15 +00:00
APSInt.cpp
Atomic.cpp drop unneeded config.h includes 2011-12-22 23:04:07 +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
CMakeLists.txt platform support for counting column widths and checking isprint 2012-04-17 20:03:03 +00:00
CommandLine.cpp Don't cast away constant qualifier. 2012-03-12 10:51:06 +00:00
ConstantRange.cpp Convert assert(0) to llvm_unreachable 2012-02-07 05:05:23 +00:00
COPYRIGHT.regex
CrashRecoveryContext.cpp move Signals to .rodata 2012-04-21 14:45:37 +00:00
DAGDeltaAlgorithm.cpp Adding missing anchor to DATDeltaAlgorithm. 2011-12-07 06:44:23 +00:00
DataExtractor.cpp Remove extra semi-colons. 2012-02-22 17:25:00 +00:00
DataStream.cpp Change default error_code ctor to a 'named ctor' so it's more self-documenting. 2012-02-09 19:24:12 +00:00
Debug.cpp
DeltaAlgorithm.cpp
Disassembler.cpp
Dwarf.cpp Lowercase the tag name to match the rest of dwarf. 2012-03-29 21:35:05 +00:00
DynamicLibrary.cpp
Errno.cpp
ErrorHandling.cpp
FileUtilities.cpp Change default error_code ctor to a 'named ctor' so it's more self-documenting. 2012-02-09 19:24:12 +00:00
FoldingSet.cpp FoldingSet: Push the hash through FoldingSetTraits::Equals, so clients can use it. 2012-04-11 14:06:47 +00:00
FormattedStream.cpp
GraphWriter.cpp Silence unused function warning when graphviz is not available. 2012-03-08 22:15:23 +00:00
Hashing.cpp Add the source file with trivial definitions in it that was missing from 2012-03-01 18:58:59 +00:00
Host.cpp Use the cpuid 64 bit flag to pick the default CPU name for an unknown model. 2012-05-09 17:47:03 +00:00
IncludeFile.cpp
IntEqClasses.cpp
IntervalMap.cpp
IntrusiveRefCntPtr.cpp Unweaken vtables as per http://llvm.org/docs/CodingStandards.html#ll_virtual_anch 2011-12-20 02:50:00 +00:00
IsInf.cpp
IsNAN.cpp
LLVMBuild.txt LLVMBuild: Remove trailing newline, which irked me. 2011-12-12 19:48:00 +00:00
Locale.cpp platform support for counting column widths and checking isprint 2012-04-17 20:03:03 +00:00
LocaleGeneric.inc C++ has newlines at the end of files (including include files). 2012-04-17 23:46:51 +00:00
LocaleWindows.inc platform support for counting column widths and checking isprint 2012-04-17 20:03:03 +00:00
LocaleXlocale.inc fix error check in assert 2012-04-18 00:40:23 +00:00
LockFileManager.cpp Move Clang's file-level locking facility over to LLVM's support 2012-01-29 20:15:10 +00:00
Makefile
ManagedStatic.cpp Add support for tsan annotations (thread sanitizer, a valgrind-based tool). 2011-11-14 20:50:16 +00:00
Memory.cpp
MemoryBuffer.cpp In MemoryBuffer::getOpenFile() make sure that the buffer is null-terminated if 2012-04-05 04:23:56 +00:00
MemoryObject.cpp Make MemoryObject accessor members const again 2012-02-29 01:09:06 +00:00
Mutex.cpp Persuade GCC that there is nothing worth warning about here (there isn't). 2012-02-05 14:20:11 +00:00
Path.cpp Support/FileSystem: Add file_magic and move a vew clients over to it. 2011-12-13 23:17:12 +00:00
PathV2.cpp [PathV2]: Fix bug in create_directories which caused infinite recursion on 2012-03-21 23:09:14 +00:00
PluginLoader.cpp
PrettyStackTrace.cpp
Process.cpp Support/Process: Move llvm::sys::Process::GetRandomNumber() from Process.cpp to Unix/Process.inc. 2012-05-06 08:24:18 +00:00
Program.cpp Support/Program: Make Change<stream>ToBinary return error_code. 2011-12-13 23:16:49 +00:00
raw_os_ostream.cpp
raw_ostream.cpp Reapply 'Add reverseColor to raw_ostream'. 2012-04-16 08:56:50 +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 Remove dead code. 2012-01-15 01:09:13 +00:00
SearchForAddressOfSpecialSymbol.cpp
Signals.cpp
SmallPtrSet.cpp SmallPtrSet: Reuse DenseMapInfo's pointer hash function instead of inventing a bad one ourselves. 2012-04-18 10:37:32 +00:00
SmallVector.cpp
SourceMgr.cpp Don't assume size_t is unsigned long long. 2012-05-07 18:12:42 +00:00
Statistic.cpp Silence tsan false-positives (tsan can't track things which are only safe due to 2011-12-05 23:07:05 +00:00
StreamableMemoryObject.cpp Make MemoryObject accessor members const again 2012-02-29 01:09:06 +00:00
StringExtras.cpp Move the implementation of StringRef::split out of StringExtras.cpp 2012-02-21 12:00:25 +00:00
StringMap.cpp Switch StringMap from an array of structures to a structure of arrays. 2011-12-27 20:35:07 +00:00
StringPool.cpp
StringRef.cpp Don't die with an assertion if the Result bitwidth is already correct. This 2012-04-23 00:27:54 +00:00
system_error.cpp
SystemUtils.cpp
TargetRegistry.cpp Fix it so llvm-objdump -arch does accept x86 and x86-64 as valid arch names. 2012-05-08 23:38:45 +00:00
Threading.cpp rename ENABLE_THREADS to LLVM_ENABLE_THREADS 2011-11-28 00:48:58 +00:00
ThreadLocal.cpp rename ENABLE_THREADS to LLVM_ENABLE_THREADS 2011-11-28 00:48:58 +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
ToolOutputFile.cpp
Triple.cpp Set the default iOS version to 3.0. 2012-05-09 18:23:00 +00:00
Twine.cpp
Valgrind.cpp Don't define these unless we plan to use them. 2011-11-28 22:14:02 +00:00
YAMLParser.cpp YAMLParser: get rid of global ctors & dtors. 2012-05-01 10:19:59 +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