1
0
mirror of https://github.com/RPCS3/llvm-mirror.git synced 2024-11-23 11:13:28 +01:00
llvm-mirror/lib/Support
Eric Christopher 359dea2a6b Reorganize the C API headers to improve build times.
Type specific declarations have been moved to Type.h and error handling
routines have been moved to ErrorHandling.h. Both are included in Core.h
so nothing should change for projects directly including the headers,
but transitive dependencies may be affected.

llvm-svn: 255965
2015-12-18 01:46:52 +00:00
..
Unix [SectionMemoryManager] Make better use of virtual memory 2015-12-16 11:13:23 +00:00
Windows
Allocator.cpp
APFloat.cpp
APInt.cpp
APSInt.cpp
ARMBuildAttrs.cpp
ARMWinEH.cpp
Atomic.cpp
BlockFrequency.cpp
BranchProbability.cpp
circular_raw_ostream.cpp
CMakeLists.txt Add a C++11 ThreadPool implementation in LLVM 2015-12-15 00:59:19 +00:00
COM.cpp
CommandLine.cpp
Compression.cpp
ConvertUTF.c
ConvertUTFWrapper.cpp
COPYRIGHT.regex
CrashRecoveryContext.cpp
DAGDeltaAlgorithm.cpp
DataExtractor.cpp
DataStream.cpp
Debug.cpp
DeltaAlgorithm.cpp
Dwarf.cpp
DynamicLibrary.cpp
Errno.cpp
ErrorHandling.cpp Reorganize the C API headers to improve build times. 2015-12-18 01:46:52 +00:00
FileOutputBuffer.cpp
FileUtilities.cpp
FoldingSet.cpp
FormattedStream.cpp
GraphWriter.cpp
Hashing.cpp
Host.cpp [x86] adding PKU feature flag 2015-12-15 13:35:29 +00:00
IntEqClasses.cpp
IntervalMap.cpp
IntrusiveRefCntPtr.cpp
JamCRC.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 Reorganize the C API headers to improve build times. 2015-12-18 01:46:52 +00:00
Process.cpp
Program.cpp
RandomNumberGenerator.cpp
raw_os_ostream.cpp
raw_ostream.cpp Drop an unnecessary use of writev. 2015-12-16 22:59:06 +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
ScaledNumber.cpp
SearchForAddressOfSpecialSymbol.cpp
Signals.cpp
SmallPtrSet.cpp
SmallVector.cpp
SourceMgr.cpp
SpecialCaseList.cpp
Statistic.cpp Simplify memory management with std::unique_ptr. 2015-12-16 22:28:34 +00:00
StreamingMemoryObject.cpp
StringExtras.cpp
StringMap.cpp
StringPool.cpp
StringRef.cpp
StringSaver.cpp
SystemUtils.cpp
TargetParser.cpp Reordering fields to reduce padding in LLVM. NFC 2015-12-14 21:57:05 +00:00
TargetRegistry.cpp
Threading.cpp
ThreadLocal.cpp
ThreadPool.cpp Fix MSVC build with LLVM_ENABLE_THREADS=OFF 2015-12-15 05:53:41 +00:00
Timer.cpp Simplify memory management with std::unique_ptr. 2015-12-16 22:28:34 +00:00
TimeValue.cpp
ToolOutputFile.cpp
Triple.cpp [WebAssembly] Experimental ELF writer support 2015-12-17 01:39:00 +00:00
Twine.cpp
Unicode.cpp
Valgrind.cpp
Watchdog.cpp
YAMLParser.cpp
YAMLTraits.cpp

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