llvm/lib/Support
2015-06-06 01:41:35 +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 Purge unused includes throughout libSupport. 2015-03-23 18:07:13 +00:00
APFloat.cpp Fix -Wpessimizing-move warnings by removing std::move calls. 2015-04-30 23:07:00 +00:00
APInt.cpp Fix APInt long division algorithm 2015-04-24 07:38:39 +00:00
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 Use 'override/final' instead of 'virtual' for overridden methods 2015-04-11 02:11:45 +00:00
Compression.cpp Purge unused includes throughout libSupport. 2015-03-23 18:07:13 +00:00
ConvertUTF.c
ConvertUTFWrapper.cpp
COPYRIGHT.regex
CrashRecoveryContext.cpp Purge unused includes throughout libSupport. 2015-03-23 18:07:13 +00:00
DAGDeltaAlgorithm.cpp Fix uses of reserved identifiers starting with an underscore followed by an uppercase letter 2015-03-16 18:06:57 +00:00
DataExtractor.cpp
DataStream.cpp Use 'override/final' instead of 'virtual' for overridden methods 2015-04-11 02:11:45 +00:00
Debug.cpp Avoid creating and destroying a std::string on every iteration. 2015-05-27 18:11:07 +00:00
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 Purge unused includes throughout libSupport. 2015-03-23 18:07:13 +00:00
FileUtilities.cpp
FoldingSet.cpp fix typos; NFC 2015-04-06 16:21:12 +00:00
FormattedStream.cpp Re-sort includes with sort-includes.py and insert raw_ostream.h where it's used. 2015-03-23 19:32:43 +00:00
GraphWriter.cpp [GraphWriter] Attempt to open .dot files with xdg-open/open first 2015-04-03 17:22:36 +00:00
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 Purge unused includes throughout libSupport. 2015-03-23 18:07:13 +00:00
Makefile
ManagedStatic.cpp
MathExtras.cpp
MD5.cpp
Memory.cpp
MemoryBuffer.cpp Purge unused includes throughout libSupport. 2015-03-23 18:07:13 +00:00
MemoryObject.cpp
Mutex.cpp
Options.cpp
Path.cpp Purge unused includes throughout libSupport. 2015-03-23 18:07:13 +00:00
PluginLoader.cpp
PrettyStackTrace.cpp
Process.cpp Assert that Process::FindInEnvPath() is passed a relative path. 2015-04-24 22:18:46 +00:00
Program.cpp Purge unused includes throughout libSupport. 2015-03-23 18:07:13 +00:00
RandomNumberGenerator.cpp Add missing include that MSVC complains about. 2015-03-23 18:19:41 +00:00
raw_os_ostream.cpp
raw_ostream.cpp Fix indentation. NFC. 2015-05-30 07:35:21 +00:00
README.txt.system
regcclass.h
regcname.h
regcomp.c Use wider type for overflow check on LLP64 platforms like Win64, found by clang-cl -Wtautological 2015-02-26 21:07:30 +00:00
regengine.inc
regerror.c
regex2.h
regex_impl.h
Regex.cpp Remove more superfluous .str() and replace std::string concatenation with Twine. 2015-03-30 15:42:36 +00:00
regexec.c
regfree.c
regstrlcpy.c
regutils.h
RWMutex.cpp
ScaledNumber.cpp Purge unused includes throughout libSupport. 2015-03-23 18:07:13 +00:00
SearchForAddressOfSpecialSymbol.cpp
Signals.cpp
SmallPtrSet.cpp
SmallVector.cpp
SourceMgr.cpp Purge unused includes throughout libSupport. 2015-03-23 18:07:13 +00:00
SpecialCaseList.cpp Purge unused includes throughout libSupport. 2015-03-23 18:07:13 +00:00
Statistic.cpp
StreamingMemoryObject.cpp Fix StreamingMemoryObject to respect known object size. 2015-05-21 19:40:19 +00:00
StringExtras.cpp Purge unused includes throughout libSupport. 2015-03-23 18:07:13 +00:00
StringMap.cpp
StringPool.cpp
StringRef.cpp
SystemUtils.cpp Purge unused includes throughout libSupport. 2015-03-23 18:07:13 +00:00
TargetParser.cpp TargetParser: Fix comments in enum(s) introduced in r239150. [-Wdocumentation] 2015-06-06 01:41:35 +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 Purge unused includes throughout libSupport. 2015-03-23 18:07:13 +00:00
TimeValue.cpp
ToolOutputFile.cpp
Triple.cpp [bpf] rename triple names bpf_be -> bpfeb 2015-06-05 16:11:14 +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 [YAMLIO] Make line-wrapping configurable and test it. 2015-05-29 17:56:28 +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