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.

## C. Copyright and License

This document is copyright © 1995-2002 Ravenbrook Limited. All rights reserved. This is an open source license. Contact Ravenbrook for commercial licensing options.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
3. Redistributions in any form must be accompanied by information on how to obtain complete source code for the this software and any accompanying software that uses this software. The source code must either be included in the distribution or be available for no more than the cost of distribution plus a nominal fee, and must be freely redistributable under reasonable conditions. For an executable file, complete source code means the source code for all modules it contains. It does not include source code for modules or files that typically accompany the major components of the operating system on which the executable file runs.

This software is provided by the copyright holders and contributors "as is" and any express or implied warranties, including, but not limited to, the implied warranties of merchantability, fitness for a particular purpose, or non-infringement, are disclaimed. In no event shall the copyright holders and contributors be liable for any direct, indirect, incidental, special, exemplary, or consequential damages (including, but not limited to, procurement of substitute goods or services; loss of use, data, or profits; or business interruption) however caused and on any theory of liability, whether in contract, strict liability, or tort (including negligence or otherwise) arising in any way out of the use of this software, even if advised of the possibility of such damage.

`$Id: //info.ravenbrook.com/project/mps/version/1.111/design/pool/index.html#2 $`

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