llvm-6502/lib/Support
NAKAMURA Takumi 4d3b6d43cc Reformat.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@238126 91177308-0d34-0410-b5e6-96231b3b80d8
2015-05-25 01:43:34 +00:00
..
Unix Use auto instead of the long type name. NFC. 2015-05-07 19:56:23 +00:00
Windows Rangify for loop in Cleanup(), NFC. 2015-05-19 13:32:19 +00:00
Allocator.cpp
APFloat.cpp Fix -Wpessimizing-move warnings by removing std::move calls. 2015-04-30 23:07:00 +00:00
APInt.cpp
APSInt.cpp
ARMBuildAttrs.cpp
ARMWinEH.cpp
Atomic.cpp
BlockFrequency.cpp
BranchProbability.cpp
circular_raw_ostream.cpp
CMakeLists.txt TargetParser: FPU/ARCH/EXT parsing refactory - NFC 2015-05-08 21:04:27 +00:00
COM.cpp Make an RAII com initializer. 2015-04-27 17:19:26 +00:00
CommandLine.cpp
Compression.cpp
ConvertUTF.c
ConvertUTFWrapper.cpp
COPYRIGHT.regex
CrashRecoveryContext.cpp
DAGDeltaAlgorithm.cpp
DataExtractor.cpp
DataStream.cpp
Debug.cpp
DeltaAlgorithm.cpp
Dwarf.cpp [DWARF parser] Add basic support for DWZ DWARF multifile extensions. 2015-05-19 20:29:28 +00:00
DynamicLibrary.cpp
Errno.cpp
ErrorHandling.cpp
FileOutputBuffer.cpp
FileUtilities.cpp
FoldingSet.cpp
FormattedStream.cpp
GraphWriter.cpp
Hashing.cpp
Host.cpp [SystemZ] Add z13 vector facility and MC support 2015-05-05 19:23:40 +00:00
IntEqClasses.cpp
IntervalMap.cpp
IntrusiveRefCntPtr.cpp
LEB128.cpp
LineIterator.cpp
LLVMBuild.txt
Locale.cpp
LockFileManager.cpp
Makefile
ManagedStatic.cpp
MathExtras.cpp
MD5.cpp
Memory.cpp
MemoryBuffer.cpp
MemoryObject.cpp
Mutex.cpp
Options.cpp
Path.cpp
PluginLoader.cpp
PrettyStackTrace.cpp
Process.cpp
Program.cpp
RandomNumberGenerator.cpp
raw_os_ostream.cpp
raw_ostream.cpp
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
SearchForAddressOfSpecialSymbol.cpp
Signals.cpp
SmallPtrSet.cpp
SmallVector.cpp
SourceMgr.cpp
SpecialCaseList.cpp
Statistic.cpp
StreamingMemoryObject.cpp Fix StreamingMemoryObject to respect known object size. 2015-05-21 19:40:19 +00:00
StringExtras.cpp
StringMap.cpp
StringPool.cpp
StringRef.cpp
SystemUtils.cpp
TargetParser.cpp Reinforce ARMTargetParser::getCanonicalArchName validation 2015-05-22 20:43:30 +00:00
TargetRegistry.cpp Readdress r236990, use of static members on a non-static variable. 2015-05-11 22:20:48 +00:00
Threading.cpp
ThreadLocal.cpp
Timer.cpp
TimeValue.cpp
ToolOutputFile.cpp
Triple.cpp Move parseSubArch to ARMTargetParser. NFC 2015-05-24 11:18:44 +00:00
Twine.cpp Reformat. 2015-05-25 01:43:34 +00:00
Unicode.cpp
Valgrind.cpp
Watchdog.cpp
YAMLParser.cpp YAML: Null terminate block scalar's value. 2015-05-21 19:45:02 +00:00
YAMLTraits.cpp Revert r237954, "Resubmit r237708 (MIR Serialization: print and parse LLVM IR using MIR format)." 2015-05-22 07:17:07 +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