13.11.2 Unchecked Storage Deallocation

1. Unchecked storage deallocation of an object designated by a value of an access type is achieved by a call to an instance of the generic procedure Unchecked_Deallocation.
   Static Semantics
   
2. The following language-defined generic library procedure exists:

3. generic
      type Object(<>) is limited private;
      type Name   is access  Object;
   procedure Ada.Unchecked_Deallocation(X : in out Name);
   pragma Convention(Intrinsic, Ada.Unchecked_Deallocation);
   pragma Preelaborate(Ada.Unchecked_Deallocation);
   

   Dynamic Semantics
   
4. Given an instance of Unchecked_Deallocation declared as follows:

5. procedure Free is
       new Ada.Unchecked_Deallocation
         (object_subtype_name, access_to_variable_subtype_name);
   

6. Procedure Free has the following effect:
   1. After executing Free(X), the value of X is null.
   2. Free(X), when X is already equal to null, has no effect.
   3. Free(X), when X is not equal to null first performs finalization, as described in See section 7.6 User-Defined Assignment and Finalization. It then deallocates the storage occupied by the object designated by X. If the storage pool is a user-defined object, then the storage is deallocated by calling Deallocate, passing access_to_variable_subtype_name'Storage_Pool as the Pool parameter. Storage_Address is the value returned in the Storage_Address parameter of the corresponding Allocate call. Size_In_Storage_Elements and Alignment are the same values passed to the corresponding Allocate call. There is one exception: if the object being freed contains tasks, the object might not be deallocated.

1. After Free(X), the object designated by X, and any subcomponents thereof, no longer exist; their storage can be reused for other purposes.
   Bounded (Run-Time) Errors
   
2. It is a bounded error to free a discriminated, unterminated task object. The possible consequences are:
   1. No exception is raised.
   2. Program_Error or Tasking_Error is raised at the point of the deallocation.
   3. Program_Error or Tasking_Error is raised in the task the next time it references any of the discriminants.

1. In the first two cases, the storage for the discriminants (and for any enclosing object if it is designated by an access discriminant of the task) is not reclaimed prior to task termination.
   Erroneous Execution
   
2. Evaluating a name that denotes a nonexistent object is erroneous. The execution of a call to an instance of Unchecked_Deallocation is erroneous if the object was created other than by an allocator for an access type whose pool is Name'Storage_Pool.
   Implementation Advice
   
3. For a standard storage pool, Free should actually reclaim the storage.
   

   NOTES
   

4. (26) The rules here that refer to Free apply to any instance of Unchecked_Deallocation.
5. (27) Unchecked_Deallocation cannot be instantiated for an access-to-constant type. This is implied by the rules of 12.5.4.

Go to the first, previous, next, last section, table of contents.