Ravenbrook / Projects / Memory Pool System / Version 1.111 Product Sources / Design Documents

Memory Pool System Project


            THE DESIGN OF THE POOL AND POOL CLASS MECHANISMS
                            design.mps.pool
                             incomplete doc
                           richard 1996-07-31

- This document must derive the requirements for pool.c etc. from the 
architecture.



.def.outer-structure: The "outer structure" (of a pool) is a C object of type 
PoolXXXStruct or the type struct PoolXXXStruct itself.
.def.generic-structure: The "generic structure" is a C object of type 
PoolStruct (found embedded in the outer-structure) or the type struct 
PoolStruct itself.

.align: When initialised, the pool gets the default alignment (ARCH_ALIGN).

.no: If a pool class doesn't implement a method, and doesn't expect it to be 
called, it should use a non-method (PoolNo*) which will cause an assertion 
failure if they are reached. 

.triv: If a pool class supports a protocol but does not require any more than a 
trivial implementation, it should use a trivial method (PoolTriv*) which will 
do the trivial thing.

.outer-structure.sig: It is good practice to put the signature for the outer 
structure at the end (of the structure).  This is because there's already one 
at the beginning (in the poolStruct) so putting it at the end gives some extra 
fencepost checking.

REQUIREMENTS

[Placeholder]

.req.fix: PoolFix must be fast.


OTHER

Interface in mpm.h
Types in mpmst.h
See also design.mps.poolclass

A. References

B. Document History

2002-06-07 RB Converted from MMInfo database design document.