Macaulay2 » Documentation
Packages » ForeignFunctions » ForeignObject » registerFinalizer(ForeignObject,Function)
next | previous | forward | backward | up | index | toc

registerFinalizer(ForeignObject,Function) -- register a finalizer for a foreign object

Description

If a foreign pointer object corresponds to memory that was not allocated by the GC garbage collector, then a function to properly deallocate this memory when the Pointer object that stores this pointer is garbage collected should be called. The function should take a single argument, a foreign object, typically of type voidstar, which corresponds to the memory to deallocate.

i1 : malloc = foreignFunction("malloc", voidstar, ulong)

o1 = malloc

o1 : ForeignFunction
 
i2 : free = foreignFunction("free", void, voidstar)

o2 = free

o2 : ForeignFunction
 
i3 : finalizer = x -> (print("freeing memory at " | net x); free x)

o3 = finalizer

o3 : FunctionClosure
 
i4 : for i to 9 do (x := malloc 8; registerFinalizer(x, finalizer))
 
i5 : collectGarbage()
freeing memory at 0x3ff38006fa0
freeing memory at 0x3ff38070b80
freeing memory at 0x3ff3806f1a0
freeing memory at 0x3ff38070fb0
freeing memory at 0x3ff38071890
freeing memory at 0x3ff380712c0
freeing memory at 0x3ff38070fd0
freeing memory at 0x3ff38071260
freeing memory at 0x3ff38071280

See also

Ways to use this method:

The source of this document is in ForeignFunctions.m2:1806:0.