llvm-mirror

mirror of https://github.com/RPCS3/llvm-mirror.git synced 2024-12-23 20:15:35 +00:00

History

Daniel Dunbar c21ab2a74c Add an explicit initialization to work around what appears to be a valgrind false positive, at least on Darwin. I haven't filed this, but you can feel free. llvm-svn: 115242		2010-09-30 23:56:49 +00:00
..
Unix	Add an explicit initialization to work around what appears to be a valgrind	2010-09-30 23:56:49 +00:00
Win32	Revert r114320(move file = copy + delete on Win32). r115040 is a better solution for the Win32 ACCESS_DENIED lit error.	2010-09-30 00:44:58 +00:00
Alarm.cpp
Atomic.cpp
CMakeLists.txt
Disassembler.cpp
DynamicLibrary.cpp	Fix failure of unittests/ExecutionEngine/JIT/MultiJITTest.cpp on	2010-08-17 15:42:43 +00:00
Errno.cpp
Host.cpp	Add one more Core i7 model number.	2010-09-19 17:54:28 +00:00
IncludeFile.cpp
Makefile
Memory.cpp
Mutex.cpp
Path.cpp	System/Path: Add x86-64 COFF to IdentifyFileType.	2010-09-15 23:04:14 +00:00
Process.cpp
Program.cpp
README.txt
RWMutex.cpp	Mark this variable as used.	2010-08-10 10:39:25 +00:00
SearchForAddressOfSpecialSymbol.cpp	System: Don't reexport ___eprintf when building with Clang; this symbol isn't	2010-09-17 04:25:24 +00:00
Signals.cpp
Threading.cpp
ThreadLocal.cpp	Fix --disable-threads build, PR7949.	2010-08-20 20:54:37 +00:00
TimeValue.cpp
Valgrind.cpp

README.txt

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</a></li>
 5. Multiple Implementations</a></li>
 6. Minimize Memory Allocation</a></li>
 7. No Virtual Methods