llvm-6502

mirror of https://github.com/c64scene-ar/llvm-6502.git synced 2024-11-02 22:04:55 +00:00

History

Dan Gohman 86759acf01 Apply a patch from Kees van Reeuwijk to add support for Minix. Minix apparently doesn't like double-slash separators, and there's no apparent need for them here. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@112844 91177308-0d34-0410-b5e6-96231b3b80d8		2010-09-02 18:24:46 +00:00
..
Unix	Apply a patch from Kees van Reeuwijk to add support for Minix.	2010-09-02 18:24:46 +00:00
Win32	Add an interface for unregistering a file from the FilesToRemove list.	2010-09-01 14:17:34 +00:00
Alarm.cpp
Atomic.cpp
CMakeLists.txt	Tell Valgrind when we modify already-executed machine code so it knows	2010-03-15 04:57:55 +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	Fix failure of unittests/ExecutionEngine/JIT/MultiJITTest.cpp on	2010-08-17 15:42:43 +00:00
Errno.cpp
Host.cpp
IncludeFile.cpp
Makefile
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	Cleanup Whitespace.	2010-08-31 06:36:46 +00:00
Process.cpp
Program.cpp	unnest from namespace.	2010-04-18 03:33:55 +00:00
README.txt
RWMutex.cpp	Mark this variable as used.	2010-08-10 10:39:25 +00:00
SearchForAddressOfSpecialSymbol.cpp
Signals.cpp
Threading.cpp
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