llvm-6502/lib/Support
Eli Bendersky f659c0de6c Make NaCl naming consistent. The triple OSType is called NaCl and is represented
textually as NativeClient. Also added a link to the native client project for
readers unfamiliar with it.

A Clang patch will follow shortly.



git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@169291 91177308-0d34-0410-b5e6-96231b3b80d8
2012-12-04 18:37:26 +00:00
..
Unix Sort includes for all of the .h files under the 'lib' tree. These were 2012-12-04 07:12:27 +00:00
Windows Add a comment about the requirement that the Windows.h header be last. 2012-12-04 07:04:57 +00:00
Allocator.cpp Use the new script to sort the includes of every file under lib. 2012-12-03 16:50:05 +00:00
APFloat.cpp Use the new script to sort the includes of every file under lib. 2012-12-03 16:50:05 +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 Don't explicitly require RTTI and EH. 2012-10-26 12:15:29 +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
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
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
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 Add support for fission attributes/forms/operations -> string. 2012-11-30 23:20:43 +00:00
DynamicLibrary.cpp Use the new script to sort the includes of every file under lib. 2012-12-03 16:50:05 +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 Use the new script to sort the includes of every file under lib. 2012-12-03 16:50:05 +00:00
FormattedStream.cpp
GraphWriter.cpp Use the new script to sort the includes of every file under lib. 2012-12-03 16:50:05 +00:00
Hashing.cpp
Host.cpp Use the new script to sort the includes of every file under lib. 2012-12-03 16:50:05 +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 Use the new script to sort the includes of every file under lib. 2012-12-03 16:50:05 +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 Use the new script to sort the includes of every file under lib. 2012-12-03 16:50:05 +00:00
MemoryObject.cpp
Mutex.cpp
Path.cpp Use the new script to sort the includes of every file under lib. 2012-12-03 16:50:05 +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
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
SourceMgr.cpp Use the new script to sort the includes of every file under lib. 2012-12-03 16:50:05 +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 Make NaCl naming consistent. The triple OSType is called NaCl and is represented 2012-12-04 18:37:26 +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

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