.. highlight:: none


.. index::
   pair: fix function; design

.. _design-fix:


The generic fix function
========================

.. mps:prefix:: design.mps.fix


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

:mps:tag:`intro` Fix is the interface through which the existence of
references are communicated from the MPS client to the MPS. The
interface also allows the value of such references to be changed (this
is necessary in order to implement a moving memory manager).


Was-marked protocol
-------------------

:mps:tag:`was-marked` The :c:type:`ScanState` has a ``Bool wasMarked``
field. This is used for finalization.

:mps:tag:`was-marked.not` If a segment's fix method discovers that the
object referred to by the ref (the one that it is supposed to be
fixing) has not previously been marked (that is, this is the first
reference to this object that has been fixed), and that the object was
white (that is, in condemned space), it should (but need not) set the
``wasMarked`` field to :c:macro:`FALSE` in the passed :c:type:`ScanState`.

:mps:tag:`was-marked.otherwise` Otherwise, the fix method must
leave the ``wasMarked`` field unchanged.

:mps:tag:`was-marked.finalizable` The MRG pool (design.mps.poolmrg_)
uses the value of the ``wasMarked`` field to determine whether an
object is finalizable.

.. _design.mps.poolmrg: poolmrg.html


Implementation
---------------

:mps:tag:`fix.nailed` In a copying collection, a non-ambiguous fix to a
broken heart should be snapped out *even if* there is a ``RankAMBIG``
ref to same object (that is, if the broken heart is nailed); the
``RankAMBIG`` reference must either be stale (no longer in existence)
or bogus.