nim-ffi/ffi/ffi_context_pool.nim

57 lines
2.2 KiB
Nim

import std/atomics
import results, chronicles
import ./ffi_context
export ffi_context
const MaxFFIContexts* = 32
## Maximum number of concurrently live FFI contexts.
## Fds and threads are only consumed for slots that are actually acquired,
## so this value only affects the upfront memory of the pool array.
type FFIContextPool*[T] = object
## Fixed-size pool of FFI contexts. Avoids dynamic heap allocation per context
## and bounds the total number of file descriptors consumed by ThreadSignalPtrs
## to at most MaxFFIContexts * 2.
slots: array[MaxFFIContexts, FFIContext[T]]
inUse: array[MaxFFIContexts, Atomic[bool]]
proc acquireSlot[T](pool: var FFIContextPool[T]): Result[ptr FFIContext[T], string] =
for i in 0 ..< MaxFFIContexts:
var expected = false
if pool.inUse[i].compareExchange(expected, true):
return ok(pool.slots[i].addr)
return err("FFI context pool exhausted; max: " & $MaxFFIContexts & " contexts)")
proc releaseSlot[T](pool: var FFIContextPool[T], ctx: ptr FFIContext[T]) =
for i in 0 ..< MaxFFIContexts:
if pool.slots[i].addr == ctx:
pool.inUse[i].store(false)
return
proc createFFIContext*[T](
pool: var FFIContextPool[T]
): Result[ptr FFIContext[T], string] =
## Acquires a slot from the fixed pool and initialises it as an FFI context.
## Bounded fd usage: at most MaxFFIContexts * 2 ThreadSignalPtr fds are ever open.
let ctx = pool.acquireSlot().valueOr:
return err("failure calling acquireSlot in createFFIContext: " & $error)
initContextResources(ctx).isOkOr:
pool.releaseSlot(ctx)
return err("failure calling initContextResources in createFFIContext: " & $error)
return ok(ctx)
proc destroyFFIContext*[T](
pool: var FFIContextPool[T], ctx: ptr FFIContext[T]
): Result[void, string] =
## Stops the FFI context and returns its slot to the pool.
defer:
joinFFIThreads(ctx)
ctx.closeResources().isOkOr:
error "failed to close resources in destroyFFIContext", error = error
return err("failure calling closeResources in destroyFFIContext: " & $error)
pool.releaseSlot(ctx)
ctx.signalStop().isOkOr:
return err("failure calling signalStop in destroyFFIContext: " & $error)
return ok()