1
0
mirror of https://github.com/RPCS3/llvm-mirror.git synced 2024-10-30 15:32:52 +01:00
llvm-mirror/lib/System
Reid Spencer aa140d6fef For PR804:
Change the file size field of StatusInfo to be uint64_t instead of size_t
so that we know it is always 64 bits. This prevents some overflow on
systems where size_t is 32 bits when it ought to be 64.

llvm-svn: 28726
2006-06-08 17:00:08 +00:00
..
Unix For PR787: 2006-06-07 23:18:34 +00:00
Win32 For PR804: 2006-06-08 17:00:08 +00:00
Alarm.cpp Implement a generic polled Alarm function. This merely removes the system 2005-12-22 03:23:46 +00:00
DynamicLibrary.cpp Bug noticed, by inspection. Filename can be null. 2006-05-14 19:00:53 +00:00
IncludeFile.cpp For PR780: 2006-06-07 20:00:19 +00:00
LICENSE.TXT License for this library. 2004-08-25 00:48:02 +00:00
ltdl.c Fix the llvm bootstrap 2005-02-13 23:37:09 +00:00
ltdl.h Eliminate tabs and trailing spaces. 2005-07-27 05:53:44 +00:00
Makefile For PR786: 2006-06-01 01:55:21 +00:00
MappedFile.cpp Remove vim settings from source code; people should use llvm/utils/vim/vimrc 2005-05-05 22:33:09 +00:00
Memory.cpp Remove vim settings from source code; people should use llvm/utils/vim/vimrc 2005-05-05 22:33:09 +00:00
Mutex.cpp Add checks for __OpenBSD__. 2006-04-17 17:55:41 +00:00
Path.cpp For PR495: 2005-07-07 23:21:43 +00:00
Process.cpp Remove vim settings from source code; people should use llvm/utils/vim/vimrc 2005-05-05 22:33:09 +00:00
Program.cpp Remove vim settings from source code; people should use llvm/utils/vim/vimrc 2005-05-05 22:33:09 +00:00
README.txt Convert llvm.cs.uiuc.edu -> llvm.org 2006-03-14 05:54:52 +00:00
Signals.cpp Remove vim settings from source code; people should use llvm/utils/vim/vimrc 2005-05-05 22:33:09 +00:00
TimeValue.cpp Remove vim settings from source code; people should use llvm/utils/vim/vimrc 2005-05-05 22:33:09 +00:00

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 throwing std::string *only*.
 7. Library must not throw any exceptions except std::string.
 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