.. mode: -*- rst -*-

Allocation frame protocol
=========================

:Tag: design.mps.alloc-frame
:Author: Tony Mann
:Date: 1998-10-02
:Status: incomplete document
:Revision: $Id: //info.ravenbrook.com/project/mps/version/1.113/design/alloc-frame.txt#1 $
:Copyright: See `Copyright and License`_.
:Index terms: pair: allocation frames; design


Introduction
------------

_`.intro`: This document explains the design of the support for
allocation frames in MPS.

_`.readership`: This document is intended for any MM developer.

_`.overview`: Allocation frames are used for implementing stack pools;
each stack frame corresponds to an allocation frame. Allocation frames
may also be suitable for implementing other sub-pool groupings, such
as generations and ramp allocation patterns.

_`.overview.ambition`: We now believe this to be a design that loses
too many advantages of stack allocation for questionable gains. The
requirements are almost entirely based on unanalysed anecdote, instead
of actual clients.

.. note::

    We plan to supersede this with a stack pool design at some point
    in the future. Pekka P. Pirinen, 2000-03-09.


Definitions
-----------

_`.def.alloc-frame`: An allocation frame is a generic name for a
device which groups objects together with other objects at allocation
time, and which may have a parent/child relationship with other
allocation frames.


Purpose
-------

_`.purpose.stack-allocation`: The allocation frame protocol is
intended to support efficient memory management for stack allocation,
that is, the allocation of objects which have dynamic extent.

_`.purpose.general`: The allocation frame protocol is intended to be
sufficiently general that it will be useful in supporting other types
of nested allocation patterns too. For example, it could be used to
for EPVM-style save and restore, ramp allocation patterns or
generations.


Requirements
------------

Known requirements
..................

_`.req.stack-alloc`: Provide a interface for clients to describe a
stack allocation pattern, as an alternative to using the control
stack.

_`.req.efficient`: Permit an implementation which is comparable in
efficiency to allocating on the control stack.

_`.req.ap`: Support allocation via allocation points (APs).

_`.req.format`: Support the allocation of formatted objects.

_`.req.scan`: Ensure that objects in allocation frames can participate
in garbage collection by being scanned.

_`.req.fix`: Ensure that objects in allocation frames can participate
in garbage collection by accepting Fix requests.

_`.req.condemn`: Ensure that objects in allocation frames can
participate in garbage collection by being condemned.

_`.attr.locking`: Minimize the synchronization cost for the creation
and destruction of frames.


Proto-requirements
..................

_`.proto-req`: The following are possible requirements that might be
important in the future. The design does not necessarily meet all
these requirements, but it does consider them all. Each requirement
either has direct support in the framework, or could be supported with
future additions to the framework.

_`.req.parallels`: The allocation frame protocol should provide a
framework for exploiting the parallels between stack extents,
generations and "ramps".

_`.req.pool-destroy`: It should be possible to use allocation frames
to free all objects in a pool without destroying the pool.

_`.req.epvm`: It should be possible to implement EPVM-style save and
restore operations by creating and destroying allocation frames.

_`.req.subst`: It should be possible to substitute a stack pool with a
GC-ed pool so that erroneous use of a stack pool can be detected.

_`.req.format-extensions`: It should be possible for stack pools to
utilize the same format as any other pool, including debugging formats
that include fenceposting, etc.

_`.req.mis-nest`: Should ensure "mis-nested" stacks are safe.

_`.req.non-top-level`: Should support allocation in the non-top stack
extent.

_`.req.copy-if-necessary`: Should ensure that stack pools can support
"copy-if-necessary" (so that low-level system code can heapify stack
objects.)

_`.req.preserve`: When an object is in an allocation frame which is
being destroyed, it should be possible to preserve that object in the
parent frame.

_`.req.contained`: Should allow clients to ask if an object is
"contained" in a frame. The object is contained in a frame if it is
affected when the frame is ended.

_`.req.alloc-with-other`: Should allow clients to allocate an object
in the same frame as another object.


Overview
--------

_`.frame-classes`: The protocol supports different types of allocation
frames, which are represented as "frame classes". It's up to pools to
determine which classes of allocation frames they support. Pools which
support more than one frame class rely on the client to indicate which
class is currently of interest. The client indicates this by means of
an operation which stores the class in the buffer to which the
allocation point is attached.

_`.frame-handles`: Allocation frames are described via abstract "frame
handles". Pools may choose what the representation of a frame handle
should be. Frame handles are static, and the client need not store
them in a GC root.

_`.lightweight-frames`: The design includes an extension to the
allocation point protocol, which permits the creation and destruction
of allocation frames without the necessity for claiming the arena
lock. Such frames are called "lightweight frames".


Operations
----------

_`.op.intro`: Each operation has both an external (client) interface
and an internal (MPS) interface. The external function takes an
allocation point as a parameter, determines which buffer and pool it
belongs to, and calls the internal function with the buffer and pool
as parameters.

_`.op.obligatory`: The following operations are supported on any
allocation point which supports allocation frames:-

_`.operation.push`: The ``PushFrame()`` operation creates a new
allocation frame of the currently chosen frame class, makes this new
frame the current frame, and returns a handle for the frame.

_`.operation.pop`: The ``PopFrame()`` operation takes a frame handle
as a parameter. Some pool classes might insist or assume that this is
the handle for the current frame. It finds the parent of that frame
and makes it the current frame. The operation indicates that all
children of the new current frame contain objects which are likely to
be dead. The reclaim policy is up to the pool; some classes might
insist or assume that the objects must be dead, and eagerly free them.
Note that this might introduce the possibility of leaving dangling
pointers elsewhere in the arena. If so, it's up to the pool to decide
what to do about this.

_`.op.optional`: The following operations are supported for some
allocation frames, but not all. Pools may choose to support some or
all of these operations for certain frame classes. An unsupported
operation will return a failure value:-

_`.operation.select`: The ``SelectFrame()`` operation takes a frame
handle as a parameter and makes that frame the current frame. It does
not indicate that any children of the current frame contain objects
which are likely to be dead.

_`.operation.select-addr`: The ``SelectFrameOfAddr()`` operation takes
an address as a parameter and makes the frame of that address the
current frame. It does not indicate that any children of the current
frame contain objects which are likely to be dead.

_`.operation.in-frame`: The ``AddrInFrame()`` operation determines
whether the supplied address is the address of an object allocated in
the supplied frame, or any child of that frame.

_`.operation.set`: The ``SetFrameClass()`` operation takes a frame
class and an allocation point as parameters, and makes that the
current frame class for the allocation point. The next ``PushFrame()``
operation will create a new frame of that class.


Interface
---------

External types
..............

_`.type.client.frame-handle`: Frame handles are defined as the abstract
type ``mps_frame_t``.

``typedef struct mps_frame_class_s *mps_frame_class_t``

_`.type.client.frame-class`: Frame classes are defined as an abstract
type.

_`.type.client.frame-class.access`: Clients access frame classes by
means of dedicated functions for each frame class.

External functions
..................

_`.fn.client.push`: ``mps_ap_frame_push()`` is used by clients to
invoke the ``PushFrame()`` operation. For lightweight frames, this
might not invoke the corresponding internal function.

_`.fn.client.pop`: ``mps_ap_frame_pop()`` is used by clients to invoke
the ``PopFrame()`` operation. For lightweight frames, this might not
invoke the corresponding internal function.
       
``mps_res_t mps_ap_frame_select(mps_ap_t buf, mps_frame_t frame)``

_`.fn.client.select`: This following function is used by clients to
invoke the ``SelectFrame()`` operation.

``mps_res_t mps_ap_frame_select_from_addr(mps_ap_t buf, mps_addr_t addr)``

_`.fn.client.select-addr`: This function is used by clients to invoke
the ``SelectFrameOfAddr()`` operation.

``mps_res_t mps_ap_addr_in_frame(mps_bool_t *inframe_o, mps_ap_t buf, mps_addr_t *addrref, mps_frame_t frame)``

_`.fn.client.in-frame`: This function is used by clients to invoke the
``AddrInFrame()`` operation.

``mps_res_t mps_ap_set_frame_class(mps_ap_t buf, mps_frame_class_t class)``

_`.fn.client.set`: This function is used by clients to invoke the 
``SetFrameClass()`` operation.

``mps_frame_class_t mps_alloc_frame_class_stack(void)``

_`.fn.client.stack-frame-class`: This function is used by clients to
access the frame class used for simple stack allocation.


Internal types
..............

``typedef struct AllocFrameStruct *AllocFrame``

_`.type.frame-handle`: Frame handles are defined as an abstract type.

``typedef struct AllocFrameClassStruct *AllocFrameClass``

_`.type.frame-class`: Frame classes are defined as an abstract type.

``typedef Res (*PoolFramePushMethod)(AllocFrame *frameReturn, Pool pool, Buffer buf)``

_`.fn.push`: A pool method of this type is called (if needed) to
invoke the ``PushFrame()`` operation.

``typedef Res (*PoolFramePopMethod)(Pool pool, Buffer buf, AllocFrame frame)``

_`.fn.pop`: A pool method of this type is called (if needed)
to invoke the PopFrame operation:

``typedef Res (*PoolFrameSelectMethod)(Pool pool, Buffer buf, AllocFrame frame)``

_`.fn.select`: A pool method of this type is called to invoke the
``SelectFrame()`` operation.

``typedef Res (*PoolFrameSelectFromAddrMethod)(Pool pool, Buffer buf, Addr addr)``

_`.fn.select-addr`: A pool method of this type is called to invoke the
``SelectFrameOfAddr()`` operation.

``typedef Res (*PoolAddrInFrameMethod)(Bool *inframeReturn, Pool pool, Seg seg, Addr *addrref, AllocFrame frame)``

_`.fn.in-frame`: A pool method of this type is called to invoke the 
``AddrInFrame()`` operation.

``typedef Res (*PoolSetFrameClassMethod)(Pool pool, Buffer buf, AllocFrameClass class)``

_`.fn.set`: A pool method of this type is called to invoke the 
``SetFrameClass()`` operation.


Lightweight frames 
-------------------

Overview
........

_`.lw-frame.overview`: Allocation points provide direct support for
lightweight frames, and are designed to permit PushFrame and PopFrame
operations without the need for locking and delegation to the pool
method. Pools can disable this mechanism for any allocation point, so
that the pool method is always called. The pool method will be called
whenever synchronization is required for other reasons (e.g. the
buffer is tripped).

_`.lw-frame.model`: Lightweight frames offer direct support for a
particular model of allocation frame use, whereby the PushFrame
operation returns the current allocation pointer as a frame handle,
and the PopFrame operation causes the allocation pointer to be reset
to the address of the frame handle. This model should be suitable for
simple stack frames, where more advanced operations like SelectFrame
are not supported. It may also be suitable for more advanced
allocation frame models when they are being used simply. The use of a
complex operation always involves synchronization via locking, and the
pool may disable lightweight synchronization temporarily at this time.

State
.....

_`.lw-frame.states`: Allocation points supporting lightweight frames
will be in one of the following states:

============ ================================================================
Valid        Indicates that ``PushFrame()`` can be a lightweight
             operation and need not be synchronized.
PopPending   Indicates that there has been a ``PopFrame()`` operation
             that the pool must respond to.
Disabled     Indicates that the pool has disabled support for lightweight 
             operations for this AP.
============ ================================================================

These states are in addition to the state normally held by an AP for
allocation purposes. An AP will be in the Disabled state at creation.

_`.lw-frame.transitions`: State transitions happen under the following
circumstances:

======================= ====================================================
Valid → PopPending      As a result of a client ``PopFrame()``
                        operation.
Valid → Disabled        At the choice of the pool (for example, when
                        responding to a ``SelectFrame()`` operation).
PopPending → Valid      At the choice of the pool, when processing a
                        ``PopFrame()``.
PopPending → Disabled   At the choice of the pool, when processing a 
                        ``PopFrame()``.
Disabled → Valid        At the choice of the pool.
Disabled → Popframe     Illegal.
======================= ====================================================

_`.lw-frame.state-impl`: Each AP contains 3 additional fields to hold this state::

    mps_addr_t frameptr; 
    mps_bool_t enabled; 
    mps_bool_t lwPopPending;

_`.lw-frame.enabled`: The ``enabled`` slot holds the following values for
each state:

========== ==========
Valid      ``TRUE``
PopPending ``TRUE``
Disabled   ``FALSE``
========== ==========

_`.lw-frame.frameptr`: The ``frameptr`` slot holds the following values
for each state:

========== ============================================
Valid      ``NULL``
PopPending Frame handle for most recently popped frame.
Disabled   ``NULL``
========== ============================================

_`.lw-frame.lwPopPending`: The ``lwPopPending`` slot holds the
following values for each state:

========== =========
Valid      ``FALSE``
PopPending ``TRUE``
Disabled   ``FALSE``
========== =========

_`.lw-frame.state-for-gc`: It is not necessary for the tracer, format
code, pool, or any other part of the GC support in MPS to read either
of the two additional AP fields in order to scan a segment which
supports a lightweight allocation frame.


Synchronization
...............

_`.lw-frame.sync`: The purpose of the design is that mutator may
access the state of an AP without locking with MPS (via the external
functions). The design assumes the normal MPS restriction that an
operation on an AP may only be performed by a single mutator thread at
a time. Each of the operations on allocation frames counts as an
operation on an AP.

_`.lw-frame.sync.pool`: Pools are permitted to read or modify the
lightweight frame state of an AP only in response to an operation on
that AP.

_`.lw-frame.sync.external`: The external functions
``mps_ap_frame_push()`` and ``mps_ap_frame_pop()`` are permitted to
read the values of the ``enabled`` and ``frameptr`` fields for the
supplied AP without claiming the arena lock. They are permitted to
modify the ``frameptr`` field if and only if ``enabled == FALSE``.

_`.lw-frame.sync.trip`: When a buffer trip happens, and the trap
wasn't set by MPS itself (that is, it wasn't because of a flip or for
logging), then the buffer code must check whether the AP has state
PopPending. If it does, the buffer code must call the Pool.


Implementation
..............

_`.lw-frame.push`: The external ``PushFrame()`` operation
(``mps_ap_frame_push()``) performs the following operations::

    IF (!APIsTrapped(ap) && StateOfFrame(ap) == Valid && ap->init == ap->alloc)
       *frame_o = ap->init;
    ELSE
      WITH_ARENA_LOCK
        PerformInternalPushFrameOperation(...)
      END
    END

_`.lw-frame.pop`: The external ``PopFrame()`` operation
(``mps_ap_frame_pop()``) performs the following operations::

    IF (StateOfFrame(ap) != Disabled)
      TrapAP(ap);  /* ensure next allocation or push involves the pool */
      ap->frameptr = frame;
      ap->lwpopPending = TRUE;
    ELSE
      WITH_ARENA_LOCK
        PerformInternalPopFrameOperation(...)
      END
    END


Document History
----------------
- 1998-10-02 Tony Mann. Incomplete document.

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

- 2013-05-23 GDR_ Converted to reStructuredText.

.. _RB: http://www.ravenbrook.com/consultants/rb/
.. _GDR: http://www.ravenbrook.com/consultants/gdr/


Copyright and License
---------------------

Copyright © 2013-2014 Ravenbrook Limited. All rights reserved.
<http://www.ravenbrook.com/>. 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:

#. Redistributions of source code must retain the above copyright
   notice, this list of conditions and the following disclaimer.

#. 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.

#. Redistributions in any form must be accompanied by information on how
   to obtain complete source code for 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.**
