This trap frees previously allocated space in a user heap.

No errors are returned by this trap.

• All registers not shown above are not used on entry and are preserved on exit.

• A user heap is an area of memory, maybe in the common heap, set aside for use by a single job. The job can allocate areas of this user heap for its own needs, and deallocate them as required. This stops, or reduces fragmentation of the common heap which is used by every task in the system. See here for more information on heaps.

• If the long word at (A1,A6) is zero, then this trap will create a new user heap at the address in A0.

• If (A1,A6) is not zero, then you are assumed to be releasing a previously allocated chunk of user heap back into the user heap's free space.

• Normally, the sequence of events would be:
  • Allocate some space in the common heap, address in A0;
  • Call MT_LNKFR/SMS_REHP to link the space into a heap with the word at (a6,a1.l) set to zero and the heap space in A0;
  • Repeat as necessary:
    • Allocate space from the heap;
    • Use the space allocated;
    • Return allocations to the heap;
  • End Repeat
  • Return the allocated space back to the common heap.

This example show the use of this, and other, heap manipulation traps.