llvm-6502

mirror of https://github.com/c64scene-ar/llvm-6502.git synced 2024-12-15 04:30:12 +00:00

History

Ted Kremenek 41b39e9908 Update CMake build. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@98250 91177308-0d34-0410-b5e6-96231b3b80d8		2010-03-11 07:51:23 +00:00
..
Unix	follow-on to PR6280	2010-02-14 18:20:09 +00:00
Win32	Add llvm::Program::ChangeStderrToBinary().	2010-01-28 06:42:08 +00:00
Alarm.cpp
Atomic.cpp
CMakeLists.txt	Update CMake build.	2010-03-11 07:51:23 +00:00
Disassembler.cpp
DynamicLibrary.cpp	Make clang bootstrap happier on OSX 10.5 by reducing the number of headers	2010-03-11 06:14:32 +00:00
Errno.cpp
Host.cpp	Stubs for getHostCPUFeatures API. This implements part of PR5389.	2010-01-19 21:26:05 +00:00
IncludeFile.cpp
Makefile	mark some libraries that currently require RTTI.	2010-01-24 20:22:08 +00:00
Memory.cpp
Mutex.cpp
Path.cpp	Make Path use StringRef instead of std::string where possible.	2009-12-17 21:02:39 +00:00
Process.cpp
Program.cpp
README.txt
RWMutex.cpp
SearchForAddressOfSpecialSymbol.cpp	Make clang bootstrap happier on OSX 10.5 by reducing the number of headers	2010-03-11 06:14:32 +00:00
Signals.cpp
Threading.cpp
ThreadLocal.cpp
TimeValue.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