5.6 Allocation and Finalization

► |  | The Racket Foreign Interface

1 | Overview
2 | Loading Foreign Libraries
3 | C Types
4 | Pointer Functions
5 | Derived Utilities
6 | Miscellaneous Support
7 | Unexported Primitive Functions
| Bibliography
| Index

▼ | 5 | Derived Utilities

5.1 | Safe Homogenous Vectors
5.2 | Safe C Vectors
5.3 | Tagged C Pointer Types
5.4 | Serializable C Struct Types
5.5 | Defining Bindings
5.6 | Allocation and Finalization
5.7 | Custodian Shutdown Registration
5.8 | Atomic Execution
5.9 | Speculatively Atomic Execution
5.10 | Objective-C FFI
5.11 | Cocoa Foundation
5.12 | COM (Common Object Model)
5.13 | File Security-Guard Checks
5.14 | Windows API Helpers

On this page:

allocator
deallocator
releaser
retainer

top ← prev up next →

#### 5.6`` Allocation and Finalization

(require ffi/unsafe/alloc) | package: base

The ffi/unsafe/alloc library provides utilities for ensuring that values allocated through foreign functions are reliably deallocated.

> procedure ((allocator dealloc) alloc) → procedure?
> dealloc : (any/c . -> . any)
> alloc : procedure?

Produces a procedure that behaves like alloc, but the result of alloc is given a finalizer that calls dealloc on a non-#f result if it is not otherwise freed through a deallocator (as designated with deallocator). In addition, alloc is called in atomic mode (see call-as-atomic); its result is received and registered in atomic mode, so that the result is reliably freed as long as no exception is raised.

The dealloc procedure itself need not be specifically designated a deallocator (via deallocator). If a deallocator is called explicitly, it need not be the same as dealloc.

> procedure ((deallocator [get-arg]) dealloc) → procedure?
> get-arg : (list? . -> . any/c) = car
> dealloc : procedure?
> procedure ((releaser [get-arg]) dealloc) → procedure?
> get-arg : (list? . -> . any/c) = car
> dealloc : procedure?

Produces a procedure that behaves like dealloc. The dealloc procedure is called in atomic mode (see call-as-atomic), and the reference count on one of its arguments is decremented; if the reference count reaches zero, no finalizer associated by an allocator- or retainer-wrapped procedure is invoked when the value becomes inaccessible.

The optional get-arg procedure determines which of dealloc’s arguments correspond to the released object; get-arg receives a list of arguments passed to dealloc, so the default car selects the first one.

The releaser procedure is a synonym for deallocator.

> procedure ((retainer release [get-arg]) retain) → procedure?
> release : (any/c . -> . any)
> get-arg : (list? . -> . any/c) = car
> retain : procedure?

Produces a procedure that behaves like retain. The procedure is called in atomic mode (see call-as-atomic), and the reference count on one of its arguments is incremented, with release recorded as the corresponding release procedure to be called by the finalizer on the retained object (unless some deallocator, as wrapped by deallocator, is explicitly called first).

The optional get-arg procedure determines which of retain’s arguments correspond to the retained object; get-arg receives a list of arguments passed to retain, so the default car selects the first one.

The release procedure itself need not be specifically designated a deallocator (via deallocator). If a deallocator is called explicitly, it need not be the same as release.

top ← prev up next →