llvm-mirror

mirror of https://github.com/RPCS3/llvm-mirror.git synced 2024-11-25 04:02:41 +01:00

History

…
..
Unix
Windows
Allocator.cpp
APFloat.cpp
APInt.cpp
APSInt.cpp
Atomic.cpp
circular_raw_ostream.cpp
CMakeLists.txt
CommandLine.cpp
ConstantRange.cpp
COPYRIGHT.regex
CrashRecoveryContext.cpp
DAGDeltaAlgorithm.cpp
Debug.cpp
DeltaAlgorithm.cpp
Disassembler.cpp
Dwarf.cpp
DynamicLibrary.cpp
Errno.cpp
ErrorHandling.cpp
FileUtilities.cpp
FoldingSet.cpp
FormattedStream.cpp
GraphWriter.cpp
Host.cpp
IncludeFile.cpp
IntEqClasses.cpp
IntervalMap.cpp
IsInf.cpp
IsNAN.cpp
Makefile
ManagedStatic.cpp
Memory.cpp
MemoryBuffer.cpp
MemoryObject.cpp
Mutex.cpp
Path.cpp
PathV2.cpp
PluginLoader.cpp
PrettyStackTrace.cpp
Process.cpp
Program.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
SearchForAddressOfSpecialSymbol.cpp
Signals.cpp
SmallPtrSet.cpp
SmallVector.cpp
SourceMgr.cpp
Statistic.cpp
StringExtras.cpp
StringMap.cpp
StringPool.cpp
StringRef.cpp
system_error.cpp
SystemUtils.cpp
TargetRegistry.cpp
Threading.cpp
ThreadLocal.cpp
Timer.cpp
TimeValue.cpp
ToolOutputFile.cpp
Triple.cpp
Twine.cpp
Valgrind.cpp

README.txt.system

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