llvm-mirror

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

History

Owen Anderson cea4068700 Use thread-safe statics to avoid a static constructor here. This isn't thread-safe on MSVC, but we don't support threaded LLVM there anyways. llvm-svn: 119718		2010-11-18 18:49:05 +00:00
..
Unix	This is the first step in adding sane error handling support to LLVMSystem.	2010-11-16 18:31:52 +00:00
Win32	This is the first step in adding sane error handling support to LLVMSystem.	2010-11-16 18:31:52 +00:00
Alarm.cpp
Atomic.cpp	Fixes the Atomic implementation if compiled by MSVC compiler.	2009-12-07 05:29:59 +00:00
CMakeLists.txt	This is the first step in adding sane error handling support to LLVMSystem.	2010-11-16 18:31:52 +00:00
Disassembler.cpp	Avoid "variable 'bits' set but not used [-Wunused-but-set-variable]"	2010-06-10 16:23:15 +00:00
DynamicLibrary.cpp	Use thread-safe statics to avoid a static constructor here. This isn't thread-safe on MSVC, but we don't	2010-11-18 18:49:05 +00:00
Errno.cpp
Host.cpp	Add one more Core i7 model number.	2010-09-19 17:54:28 +00:00
IncludeFile.cpp
Makefile	Remove try/catch(...) from Win32/Signals.inc.	2010-10-27 09:09:04 +00:00
Memory.cpp	Tell Valgrind when we modify already-executed machine code so it knows	2010-03-15 04:57:55 +00:00
Mutex.cpp
Path.cpp	Fix typo: Exectuable -> Executable	2010-11-17 00:43:43 +00:00
Process.cpp
Program.cpp	Make Program::Wait differentiate execution failure due to the file	2010-10-29 16:54:25 +00:00
README.txt
RWMutex.cpp	Remove remaining uses of ATTRIBUTE_UNUSED on variables, and delete three	2010-10-20 08:27:02 +00:00
SearchForAddressOfSpecialSymbol.cpp	Change explicit search Apple specific code to only reference __eprintf on x86.	2010-10-11 21:34:24 +00:00
Signals.cpp
system_error.cpp	This is the first step in adding sane error handling support to LLVMSystem.	2010-11-16 18:31:52 +00:00
Threading.cpp	System: Add llvm_execute_on_thread, which does what it says.	2010-11-04 01:26:25 +00:00
ThreadLocal.cpp	Fix --disable-threads build, PR7949.	2010-08-20 20:54:37 +00:00
TimeValue.cpp
Valgrind.cpp	Tell Valgrind when we modify already-executed machine code so it knows	2010-03-15 04:57:55 +00:00

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