2023-07-31 07:52:04 +00:00
|
|
|
{.pragma: exported, exportc, cdecl, raises: [].}
|
|
|
|
{.pragma: callback, cdecl, raises: [], gcsafe.}
|
|
|
|
{.passc: "-fPIC".}
|
|
|
|
|
2024-05-18 13:04:04 +00:00
|
|
|
import std/[options, atomics, os, net]
|
2023-07-31 07:52:04 +00:00
|
|
|
import
|
2024-05-18 13:04:04 +00:00
|
|
|
chronicles, chronos, chronos/threadsync, taskpools/channels_spsc_single, stew/results
|
2023-07-31 07:52:04 +00:00
|
|
|
import
|
2024-05-03 12:07:15 +00:00
|
|
|
../../../waku/factory/waku,
|
2023-09-18 07:21:50 +00:00
|
|
|
./inter_thread_communication/waku_thread_request,
|
|
|
|
./inter_thread_communication/waku_thread_response
|
2023-07-31 07:52:04 +00:00
|
|
|
|
2024-03-15 23:08:47 +00:00
|
|
|
type Context* = object
|
|
|
|
thread: Thread[(ptr Context)]
|
|
|
|
reqChannel: ChannelSPSCSingle[ptr InterThreadRequest]
|
|
|
|
reqSignal: ThreadSignalPtr
|
|
|
|
respChannel: ChannelSPSCSingle[ptr InterThreadResponse]
|
|
|
|
respSignal: ThreadSignalPtr
|
|
|
|
userData*: pointer
|
|
|
|
eventCallback*: pointer
|
|
|
|
eventUserdata*: pointer
|
2023-07-31 07:52:04 +00:00
|
|
|
|
2024-05-13 15:45:48 +00:00
|
|
|
const git_version* {.strdefine.} = "n/a"
|
|
|
|
const versionString = "version / git commit hash: " & waku.git_version
|
|
|
|
|
2023-07-31 07:52:04 +00:00
|
|
|
# To control when the thread is running
|
|
|
|
var running: Atomic[bool]
|
|
|
|
|
|
|
|
# Every Nim library must have this function called - the name is derived from
|
|
|
|
# the `--nimMainPrefix` command line option
|
|
|
|
proc NimMain() {.importc.}
|
|
|
|
var initialized: Atomic[bool]
|
|
|
|
|
|
|
|
proc waku_init() =
|
|
|
|
if not initialized.exchange(true):
|
|
|
|
NimMain() # Every Nim library needs to call `NimMain` once exactly
|
2024-03-15 23:08:47 +00:00
|
|
|
when declared(setupForeignThreadGc):
|
|
|
|
setupForeignThreadGc()
|
2023-07-31 07:52:04 +00:00
|
|
|
when declared(nimGC_setStackBottom):
|
|
|
|
var locals {.volatile, noinit.}: pointer
|
|
|
|
locals = addr(locals)
|
|
|
|
nimGC_setStackBottom(locals)
|
|
|
|
|
|
|
|
proc run(ctx: ptr Context) {.thread.} =
|
|
|
|
## This is the worker thread body. This thread runs the Waku node
|
|
|
|
## and attends library user requests (stop, connect_to, etc.)
|
2024-05-13 15:45:48 +00:00
|
|
|
info "Starting Waku", version = versionString
|
2023-07-31 07:52:04 +00:00
|
|
|
|
2024-05-03 12:07:15 +00:00
|
|
|
var waku: Waku
|
2023-09-01 06:37:02 +00:00
|
|
|
|
2023-07-31 07:52:04 +00:00
|
|
|
while running.load == true:
|
|
|
|
## Trying to get a request from the libwaku main thread
|
|
|
|
|
2023-09-18 07:21:50 +00:00
|
|
|
var request: ptr InterThreadRequest
|
2023-09-22 14:36:31 +00:00
|
|
|
waitFor ctx.reqSignal.wait()
|
2023-09-18 07:21:50 +00:00
|
|
|
let recvOk = ctx.reqChannel.tryRecv(request)
|
|
|
|
if recvOk == true:
|
2024-05-03 12:07:15 +00:00
|
|
|
let resultResponse = waitFor InterThreadRequest.process(request, addr waku)
|
2023-09-18 07:21:50 +00:00
|
|
|
|
|
|
|
## Converting a `Result` into a thread-safe transferable response type
|
|
|
|
let threadSafeResp = InterThreadResponse.createShared(resultResponse)
|
|
|
|
|
|
|
|
## The error-handling is performed in the main thread
|
2023-09-22 14:36:31 +00:00
|
|
|
discard ctx.respChannel.trySend(threadSafeResp)
|
|
|
|
discard ctx.respSignal.fireSync()
|
2023-07-31 07:52:04 +00:00
|
|
|
|
|
|
|
tearDownForeignThreadGc()
|
|
|
|
|
2023-10-23 06:37:28 +00:00
|
|
|
proc createWakuThread*(): Result[ptr Context, string] =
|
2023-07-31 07:52:04 +00:00
|
|
|
## This proc is called from the main thread and it creates
|
|
|
|
## the Waku working thread.
|
|
|
|
|
|
|
|
waku_init()
|
|
|
|
|
2023-10-23 06:37:28 +00:00
|
|
|
var ctx = createShared(Context, 1)
|
2023-09-22 14:36:31 +00:00
|
|
|
ctx.reqSignal = ThreadSignalPtr.new().valueOr:
|
|
|
|
return err("couldn't create reqSignal ThreadSignalPtr")
|
|
|
|
ctx.respSignal = ThreadSignalPtr.new().valueOr:
|
|
|
|
return err("couldn't create respSignal ThreadSignalPtr")
|
2023-07-31 07:52:04 +00:00
|
|
|
|
|
|
|
running.store(true)
|
|
|
|
|
|
|
|
try:
|
|
|
|
createThread(ctx.thread, run, ctx)
|
2023-09-01 06:37:02 +00:00
|
|
|
except ValueError, ResourceExhaustedError:
|
2023-07-31 07:52:04 +00:00
|
|
|
# and freeShared for typed allocations!
|
|
|
|
freeShared(ctx)
|
|
|
|
|
2023-09-01 06:37:02 +00:00
|
|
|
return err("failed to create the Waku thread: " & getCurrentExceptionMsg())
|
2023-07-31 07:52:04 +00:00
|
|
|
|
2023-10-23 06:37:28 +00:00
|
|
|
return ok(ctx)
|
2023-07-31 07:52:04 +00:00
|
|
|
|
2024-03-07 17:53:03 +00:00
|
|
|
proc stopWakuThread*(ctx: ptr Context): Result[void, string] =
|
2023-07-31 07:52:04 +00:00
|
|
|
running.store(false)
|
2024-03-07 17:53:03 +00:00
|
|
|
let fireRes = ctx.reqSignal.fireSync()
|
|
|
|
if fireRes.isErr():
|
|
|
|
return err("error in stopWakuThread: " & $fireRes.error)
|
2023-07-31 07:52:04 +00:00
|
|
|
joinThread(ctx.thread)
|
2023-09-22 14:36:31 +00:00
|
|
|
discard ctx.reqSignal.close()
|
|
|
|
discard ctx.respSignal.close()
|
2023-07-31 07:52:04 +00:00
|
|
|
freeShared(ctx)
|
2024-03-07 17:53:03 +00:00
|
|
|
return ok()
|
2023-07-31 07:52:04 +00:00
|
|
|
|
2024-03-15 23:08:47 +00:00
|
|
|
proc sendRequestToWakuThread*(
|
|
|
|
ctx: ptr Context, reqType: RequestType, reqContent: pointer
|
|
|
|
): Result[string, string] =
|
2023-09-18 07:21:50 +00:00
|
|
|
let req = InterThreadRequest.createShared(reqType, reqContent)
|
2023-07-31 07:52:04 +00:00
|
|
|
|
2023-09-18 07:21:50 +00:00
|
|
|
## Sending the request
|
|
|
|
let sentOk = ctx.reqChannel.trySend(req)
|
|
|
|
if not sentOk:
|
|
|
|
return err("Couldn't send a request to the waku thread: " & $req[])
|
2023-07-31 07:52:04 +00:00
|
|
|
|
2023-09-22 14:36:31 +00:00
|
|
|
let fireSyncRes = ctx.reqSignal.fireSync()
|
|
|
|
if fireSyncRes.isErr():
|
|
|
|
return err("failed fireSync: " & $fireSyncRes.error)
|
|
|
|
|
|
|
|
if fireSyncRes.get() == false:
|
|
|
|
return err("Couldn't fireSync in time")
|
|
|
|
|
2023-09-18 07:21:50 +00:00
|
|
|
## Waiting for the response
|
2023-09-22 14:36:31 +00:00
|
|
|
waitFor ctx.respSignal.wait()
|
|
|
|
|
2023-09-18 07:21:50 +00:00
|
|
|
var response: ptr InterThreadResponse
|
|
|
|
var recvOk = ctx.respChannel.tryRecv(response)
|
2023-09-22 14:36:31 +00:00
|
|
|
if recvOk == false:
|
|
|
|
return err("Couldn't receive response from the waku thread: " & $req[])
|
2023-07-31 07:52:04 +00:00
|
|
|
|
2023-09-18 07:21:50 +00:00
|
|
|
## Converting the thread-safe response into a managed/CG'ed `Result`
|
|
|
|
return InterThreadResponse.process(response)
|