-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathffi_macro.nim
More file actions
1664 lines (1428 loc) · 56.2 KB
/
Copy pathffi_macro.nim
File metadata and controls
1664 lines (1428 loc) · 56.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import std/[macros, tables, strutils]
import chronos
import ../ffi_types
import ../codegen/meta
when defined(ffiGenBindings):
import ../codegen/rust
import ../codegen/cpp
# ---------------------------------------------------------------------------
# String helpers used by multiple macros
# ---------------------------------------------------------------------------
proc nimNameToCExport(s: string): string =
## Converts a camelCase Nim proc name to a snake_case C export name.
## Leaves already-snake_case names unchanged.
## e.g. "nimtimerCreate" → "nimtimer_create", "nimtimer_echo" → "nimtimer_echo"
for i, c in s:
if c.isUpperAscii() and i > 0:
result.add('_')
result.add(c.toLowerAscii())
proc registerFfiTypeInfo(typeDef: NimNode): NimNode {.compileTime.} =
## Registers the type in ffiTypeRegistry for binding generation and returns
## the clean typeDef. Serialization is handled by the generic overloads in serial.nim.
let typeName =
if typeDef[0].kind == nnkPostfix: typeDef[0][1] else: typeDef[0]
let typeNameStr = $typeName
var fieldMetas: seq[FFIFieldMeta] = @[]
let objTy = typeDef[2]
if objTy.kind == nnkObjectTy and objTy.len >= 3:
let recList = objTy[2]
if recList.kind == nnkRecList:
for identDef in recList:
if identDef.kind == nnkIdentDefs:
let fieldType = identDef[^2]
let fieldTypeName =
if fieldType.kind == nnkIdent: $fieldType
elif fieldType.kind == nnkPtrTy: "ptr " & $fieldType[0]
else: fieldType.repr
for i in 0 ..< identDef.len - 2:
fieldMetas.add(FFIFieldMeta(name: $identDef[i], typeName: fieldTypeName))
ffiTypeRegistry.add(FFITypeMeta(name: typeNameStr, fields: fieldMetas))
result = typeDef
proc cParamName(paramName: string, paramType: NimNode): string =
## C export parameter name. string params are passed as-is from C and need
## no Json suffix; other types carry Json to signal they require JSON encoding.
if paramType.kind == nnkIdent and $paramType == "string":
paramName
else:
paramName & "Json"
proc capitalizeFirstLetter(s: string): string =
## Returns `s` with the first character uppercased.
if s.len == 0:
return s
result = s
result[0] = s[0].toUpperAscii()
proc toCamelCase(s: string): string =
## Converts snake_case or mixed identifiers to CamelCase for type names.
## e.g. "testlib_create" -> "TestlibCreate"
var parts = s.split('_')
result = ""
for p in parts:
result.add capitalizeFirstLetter(p)
proc bodyHasAwait(n: NimNode): bool =
## Returns true if the AST node `n` contains any `await` or `waitFor` call.
if n.kind in {nnkCall, nnkCommand}:
let callee = n[0]
if callee.kind == nnkIdent and callee.strVal in ["await", "waitFor"]:
return true
for child in n:
if bodyHasAwait(child):
return true
false
proc extractFieldsFromLambda(body: NimNode): seq[NimNode] =
## Extracts the fields (params) from the given lambda body, when using the registerReqFFI macro.
## e.g., for:
## registerReqFFI(CreateNodeRequest, ctx: ptr FFIContext[Waku]):
## proc(
## configJson: cstring, appCallbacks: AppCallbacks
## ): Future[Result[string, string]] {.async.} =
## ...
## The extracted fields will be:
## - configJson: cstring
## - appCallbacks: AppCallbacks
##
var procNode = body
if procNode.kind == nnkStmtList and procNode.len == 1:
procNode = procNode[0]
if procNode.kind != nnkLambda and procNode.kind != nnkProcDef:
error "registerReqFFI expects a lambda proc, found: " & $procNode.kind
let params = procNode[3] # parameters list
result = @[]
for p in params[1 .. ^1]: # skip return type
result.add newIdentDefs(p[0], p[1])
when defined(ffiDumpMacros):
echo result.repr
proc buildRequestType(reqTypeName: NimNode, body: NimNode): NimNode =
## Builds:
## type <reqTypeName>* = object
## <lambdaParam1Name>: <lambdaParam1Type>
## ...
## e.g.:
## type CreateNodeRequest* = object
## configJson: cstring
## appCallbacks: AppCallbacks
##
var procNode = body
if procNode.kind == nnkStmtList and procNode.len == 1:
procNode = procNode[0]
if procNode.kind != nnkLambda and procNode.kind != nnkProcDef:
error "registerReqFFI expects a lambda proc, found: " & $procNode.kind
let params = procNode[3] # formal params of the lambda
var fields: seq[NimNode] = @[]
for p in params[1 .. ^1]: # skip return type at index 0
let name = p[0]
let typ = p[1]
# Field must be nnkIdentDefs(name, type, defaultExpr)
fields.add newTree(nnkIdentDefs, name, typ, newEmptyNode())
# Wrap fields in a rec list
let recList = newTree(nnkRecList, fields)
# object type node: object [of?] [] [pragma?] recList
let objTy = newTree(nnkObjectTy, newEmptyNode(), newEmptyNode(), recList)
# Export the type (CreateNodeRequest*)
let typeName =
if reqTypeName.kind == nnkPostfix:
reqTypeName
else:
postfix(reqTypeName, "*")
result =
newNimNode(nnkTypeSection).add(newTree(nnkTypeDef, typeName, newEmptyNode(), objTy))
when defined(ffiDumpMacros):
echo result.repr
proc buildFfiNewReqProc(reqTypeName, body: NimNode): NimNode =
## Builds the ffiNewProc in charge of creating the FFIThreadRequest in shared memory.
## Then, a pointer to this request will be sent to the FFI thread for processing.
## e.g.:
## proc ffiNewReq*(T: typedesc[CreateNodeRequest]; callback: FFICallBack;
## userData: pointer; configJson: cstring;
## appCallbacks: AppCallbacks): ptr FFIThreadRequest =
## var reqObj = createShared(T)
## reqObj[].configJson = configJson.alloc()
## reqObj[].appCallbacks = appCallbacks
## let typeStr`gensym2866 = $T
## var ret`gensym2866 = FFIThreadRequest.init(callback, userData,
## typeStr`gensym2866.cstring, reqObj)
## return ret`gensym2866
##
## This should be invoked by the ffi consumer thread (generally, main thread.)
## Notice that the shared memory allocated by the main thread is freed by the FFI thread
## after processing the request.
var formalParams = newSeq[NimNode]()
var procNode: NimNode
if body.kind == nnkStmtList and body.len == 1:
procNode = body[0] # unwrap single statement
else:
procNode = body
if procNode.kind != nnkLambda and procNode.kind != nnkProcDef:
error "registerReqFFI expects a lambda definition. Found: " & $procNode.kind
# T: typedesc[CreateNodeRequest]
let typedescParam = newIdentDefs(
ident("T"), # param name
nnkBracketExpr.newTree(ident("typedesc"), reqTypeName), # typedesc[T]
)
formalParams.add(typedescParam)
# Other fixed FFI params
formalParams.add(newIdentDefs(ident("callback"), ident("FFICallBack")))
formalParams.add(newIdentDefs(ident("userData"), ident("pointer")))
# Add original lambda params
let procParams = procNode[3]
for p in procParams[1 .. ^1]:
formalParams.add(p)
# Build `ptr FFIThreadRequest`
let retType = newNimNode(nnkPtrTy)
retType.add(ident("FFIThreadRequest"))
formalParams = @[retType] & formalParams
# Build body
let reqObjIdent = ident("reqObj")
var newBody = newStmtList()
newBody.add(
quote do:
var `reqObjIdent` = createShared(T)
)
for p in procParams[1 .. ^1]:
let fieldNameIdent = ident($p[0])
let fieldTypeNode = p[1]
# Extract type name as string
var typeStr: string
if fieldTypeNode.kind == nnkIdent:
typeStr = $fieldTypeNode
elif fieldTypeNode.kind == nnkBracketExpr:
typeStr = $fieldTypeNode[0] # e.g., `ptr` in `ptr[Waku]`
else:
typeStr = "" # fallback
# Apply .alloc() only to cstrings
if typeStr == "cstring":
newBody.add(
quote do:
`reqObjIdent`[].`fieldNameIdent` = `fieldNameIdent`.alloc()
)
else:
newBody.add(
quote do:
`reqObjIdent`[].`fieldNameIdent` = `fieldNameIdent`
)
# FFIThreadRequest.init using fnv1aHash32
newBody.add(
quote do:
let typeStr = $T
var ret =
FFIThreadRequest.init(callback, userData, typeStr.cstring, `reqObjIdent`)
proc destroyContent(content: pointer) {.nimcall.} =
ffiDeleteReq(cast[ptr `reqTypeName`](content))
ret[].deleteReqContent = destroyContent
return ret
)
# Build the proc node
result = newProc(
name = postfix(ident("ffiNewReq"), "*"),
params = formalParams,
body = newBody,
pragmas = newEmptyNode(),
)
when defined(ffiDumpMacros):
echo result.repr
proc buildFfiDeleteReqProc(reqTypeName: NimNode, fields: seq[NimNode]): NimNode =
## Generates:
## proc ffiDeleteReq(self: ptr <reqTypeName>) =
## deallocShared(self[].<cstringField>)
## deallocShared(self)
# Build the body
var body = newStmtList()
for f in fields:
if $f[1] == "cstring": # only dealloc cstring fields
body.add newCall(
ident("deallocShared"),
newDotExpr(newTree(nnkDerefExpr, ident("self")), ident($f[0])),
)
# Always free the whole object at the end
body.add newCall(ident("deallocShared"), ident("self"))
# Build the parameter: (self: ptr <reqTypeName>)
let selfParam = newIdentDefs(ident("self"), newTree(nnkPtrTy, reqTypeName))
# Build the proc definition
result = newProc(
name = postfix(ident("ffiDeleteReq"), "*"),
params = @[newEmptyNode()] & @[selfParam], # ✅ properly wrapped in a sequence
body = body,
)
when defined(ffiDumpMacros):
echo result.repr
proc buildProcessFFIRequestProc(reqTypeName, reqHandler, body: NimNode): NimNode =
## Builds, f.e.:
## proc processFFIRequest(T: typedesc[CreateNodeRequest];
## configJson: cstring;
## appCallbacks: AppCallbacks;
## ctx: ptr FFIContext[Waku]) ...
if reqHandler.kind != nnkExprColonExpr:
error(
"Second argument must be a typed parameter, e.g., waku: ptr Waku. Found: " &
$reqHandler.kind
)
let rhs = reqHandler[1]
if rhs.kind != nnkPtrTy:
error("Second argument must be a pointer type, e.g., waku: ptr Waku")
var procNode = body
if procNode.kind == nnkStmtList and procNode.len == 1:
procNode = procNode[0]
if procNode.kind != nnkLambda and procNode.kind != nnkProcDef:
error "registerReqFFI expects a lambda definition. Found: " & $procNode.kind
let typedescParam =
newIdentDefs(ident("T"), nnkBracketExpr.newTree(ident("typedesc"), reqTypeName))
# Build formal params: (returnType, request: pointer, waku: ptr Waku)
let procParams = procNode[3]
var formalParams: seq[NimNode] = @[]
formalParams.add(procParams[0]) # return type
formalParams.add(typedescParam)
formalParams.add(newIdentDefs(ident("request"), ident("pointer")))
formalParams.add(newIdentDefs(reqHandler[0], rhs)) # e.g. waku: ptr Waku
# Inject cast/unpack/defer into the body
let bodyNode =
if procNode.body.kind == nnkStmtList:
procNode.body
else:
newStmtList(procNode.body)
let newBody = newStmtList()
let reqIdent = genSym(nskLet, "req")
newBody.add quote do:
let `reqIdent`: ptr `reqTypeName` = cast[ptr `reqTypeName`](request)
# automatically unpack fields into locals
for p in procParams[1 ..^ 1]:
let fieldName = p[0] # Ident
newBody.add quote do:
let `fieldName` = `reqIdent`[].`fieldName`
# Append user's lambda body
newBody.add(bodyNode)
result = newProc(
name = postfix(ident("processFFIRequest"), "*"),
params = formalParams,
body = newBody,
procType = nnkProcDef,
pragmas =
if procNode.len >= 5:
procNode[4]
else:
newEmptyNode(),
)
when defined(ffiDumpMacros):
echo result.repr
proc addNewRequestToRegistry(reqTypeName, reqHandler: NimNode): NimNode =
## Adds a new request to the registeredRequests table.
## The key is a representation of the request, e.g. "CreateNodeReq".
## The value is a proc definition in charge of handling the request from FFI thread.
# Build: request[].reqContent
let reqContent =
newDotExpr(newTree(nnkDerefExpr, ident("request")), ident("reqContent"))
# Build Future[Result[string, string]] return type
let returnType = nnkBracketExpr.newTree(
ident("Future"),
nnkBracketExpr.newTree(ident("Result"), ident("string"), ident("string")),
)
# Extract the type from reqHandler (generic: ptr Waku, ptr Foo, ptr Bar, etc.)
let rhsType =
if reqHandler.kind == nnkExprColonExpr:
reqHandler[1] # Use the explicit type
else:
error "Second argument must be a typed parameter, e.g. waku: ptr Waku"
# Build: cast[ptr Waku](reqHandler) or cast[ptr Foo](reqHandler) dynamically
let castedHandler = newTree(
nnkCast,
rhsType, # The type, e.g. ptr Waku
ident("reqHandler"), # The expression to cast
)
let callExpr = newCall(
newDotExpr(reqTypeName, ident("processFFIRequest")), ident("request"), castedHandler
)
var newBody = newStmtList()
newBody.add(
quote do:
return await `callExpr`
)
# Build:
# proc(request: pointer, reqHandler: pointer):
# Future[Result[string, string]] {.async.} =
# CreateNodeRequest.processFFIRequest(request, reqHandler)
let asyncProc = newProc(
name = newEmptyNode(), # anonymous proc
params = @[
returnType,
newIdentDefs(ident("request"), ident("pointer")),
newIdentDefs(ident("reqHandler"), ident("pointer")),
],
body = newBody,
pragmas = nnkPragma.newTree(ident("async")),
)
let reqTypeNameStr = $reqTypeName
let key = newLit($reqTypeName)
# Generate: registeredRequests["CreateNodeRequest"] = <generated proc>
result =
newAssignment(newTree(nnkBracketExpr, ident("registeredRequests"), key), asyncProc)
when defined(ffiDumpMacros):
echo result.repr
macro registerReqFFI*(reqTypeName, reqHandler, body: untyped): untyped =
## Registers a request that will be handled by the FFI/working thread.
## The request should be sent from the ffi consumer thread.
##
## e.g.:
## In this example, we register a CreateNodeRequest that will be handled by a proc that contains
## the provided lambda body and parameters, by the FFI/working thread.
##
## The lambda passed to this macro must:
## - only have no-GC'ed types.
## - Return Future[Result[string, string]] and be annotated with {.async.}
## And notice that the returned values will be sent back to the ffi consumer thread.
##
## registerReqFFI(CreateNodeRequest, ctx: ptr FFIContext[Waku]):
## proc(
## configJson: cstring, appCallbacks: AppCallbacks
## ): Future[Result[string, string]] {.async.} =
## ctx.myLib[] = (await createWaku(configJson, cast[AppCallbacks](appCallbacks))).valueOr:
## return err($error)
## return ok("")
##
## On the other hand, the created FFI request should be dispatched from the ffi consumer thread
## (generally, the main thread) following something like:
##
## ffi.sendRequestToFFIThread(
## ctx, CreateNodeRequest.ffiNewReq(callback, userData, configJson, appCallbacks)
## ).isOkOr:
## ...
## ...
##
# Extract lambda params to generate fields
let fields = extractFieldsFromLambda(body)
let typeDef = buildRequestType(reqTypeName, body)
let ffiNewReqProc = buildFfiNewReqProc(reqTypeName, body)
let processProc = buildProcessFFIRequestProc(reqTypeName, reqHandler, body)
let addNewReqToReg = addNewRequestToRegistry(reqTypeName, reqHandler)
let deleteProc = buildFfiDeleteReqProc(reqTypeName, fields)
result = newStmtList(typeDef, deleteProc, ffiNewReqProc, processProc, addNewReqToReg)
when defined(ffiDumpMacros):
echo result.repr
macro processReq*(
reqType, ctx, callback, userData: untyped, args: varargs[untyped]
): untyped =
## Expands T.processReq(ctx, callback, userData, a, b, ...)
## e.g.:
## waku_dial_peerReq.processReq(ctx, callback, userData, peerMultiAddr, protocol, timeoutMs)
##
var callArgs = @[reqType, callback, userData]
for a in args:
callArgs.add a
let newReqCall = newCall(ident("ffiNewReq"), callArgs)
let sendCall = newCall(
newDotExpr(ident("ffi_context"), ident("sendRequestToFFIThread")), ctx, newReqCall
)
result = quote:
block:
let res = `sendCall`
if res.isErr():
let msg = "error in sendRequestToFFIThread: " & res.error
`callback`(RET_ERR, unsafeAddr msg[0], cast[csize_t](msg.len), `userData`)
return RET_ERR
return RET_OK
when defined(ffiDumpMacros):
echo result.repr
macro ffiRaw*(prc: untyped): untyped =
## Defines an FFI-exported proc that registers a request handler to be executed
## asynchronously in the FFI thread.
##
## This is the "raw" / legacy form of the macro where the developer writes
## the ctx, callback, and userData parameters explicitly.
##
## {.ffiRaw.} implicitly implies: ...Return[Future[Result[string, string]] {.async.}
##
## When using {.ffiRaw.}, the first three parameters must be:
## - ctx: ptr FFIContext[T] <-- T is the type that handles the FFI requests
## - callback: FFICallBack
## - userData: pointer
## Then, additional parameters may be defined as needed, after these first three, always
## considering that only no-GC'ed (or C-like) types are allowed.
##
## e.g.:
## proc waku_version(
## ctx: ptr FFIContext[Waku], callback: FFICallBack, userData: pointer
## ) {.ffiRaw.} =
## return ok(WakuNodeVersionString)
##
let procName = prc[0]
let formalParams = prc[3]
let bodyNode = prc[^1]
if formalParams.len < 2:
error("`.ffiRaw.` procs require at least 1 parameter")
let firstParam = formalParams[1]
let paramIdent = firstParam[0]
let paramType = firstParam[1]
let reqName = ident($procName & "Req")
let returnType = ident("cint")
# Build parameter list (skip return type)
var newParams = newSeq[NimNode]()
newParams.add(returnType)
for i in 1 ..< formalParams.len:
newParams.add(newIdentDefs(formalParams[i][0], formalParams[i][1]))
# Build Future[Result[string, string]] return type
let futReturnType = quote:
Future[Result[string, string]]
var userParams = newSeq[NimNode]()
userParams.add(futReturnType)
if formalParams.len > 3:
for i in 4 ..< formalParams.len:
userParams.add(newIdentDefs(formalParams[i][0], formalParams[i][1]))
# Build argument list for processReq
var argsList = newSeq[NimNode]()
for i in 1 ..< formalParams.len:
argsList.add(formalParams[i][0])
# 1. Build the dot expression. e.g.: waku_is_onlineReq.processReq
let dotExpr = newTree(nnkDotExpr, reqName, ident"processReq")
# 2. Build the call node with dotExpr as callee
let callNode = newTree(nnkCall, dotExpr)
for arg in argsList:
callNode.add(arg)
# Proc body
let ffiBody = newStmtList(
quote do:
initializeLibrary()
if not isValidCtx(cast[pointer](ctx)):
return RET_ERR
ctx[].userData = userData
if isNil(callback):
return RET_MISSING_CALLBACK
)
ffiBody.add(callNode)
let ffiProc = newProc(
name = procName,
params = newParams,
body = ffiBody,
pragmas = newTree(nnkPragma, ident "dynlib", ident "exportc", ident "cdecl"),
)
var anonymousProcNode = newProc(
name = newEmptyNode(), # anonymous proc
params = userParams,
body = newStmtList(bodyNode),
pragmas = newTree(nnkPragma, ident"async"),
)
# registerReqFFI wrapper
let registerReq = quote:
registerReqFFI(`reqName`, `paramIdent`: `paramType`):
`anonymousProcNode`
result = newStmtList(registerReq, ffiProc)
when defined(ffiDumpMacros):
echo result.repr
macro ffi*(prc: untyped): untyped =
## Simplified FFI macro — applies to procs or types.
##
## On a type: `type Foo {.ffi.} = object` registers Foo for binding generation
## and generates ffiSerialize/ffiDeserialize overloads.
##
## On a proc: the annotated proc must have a first parameter of the library type,
## optionally additional Nim-typed parameters, and return Future[Result[RetType, string]].
## It must NOT include ctx, callback, or userData in its signature.
##
## Example (type):
## type EchoRequest {.ffi.} = object
## message: string
## delayMs: int
##
## Example (proc):
## proc mylib_send*(w: MyLib, cfg: SendConfig): Future[Result[string, string]] {.ffi.} =
## return ok("done")
if prc.kind == nnkTypeDef:
var cleanTypeDef = prc.copyNimTree()
if cleanTypeDef[0].kind == nnkPragmaExpr:
cleanTypeDef[0] = cleanTypeDef[0][0]
return registerFfiTypeInfo(cleanTypeDef)
let procName = prc[0]
let formalParams = prc[3]
let bodyNode = prc[^1]
# Need at least the library param
if formalParams.len < 2:
error("`.ffi.` procs require at least 1 parameter (the library type)")
# Extract LibType from the first parameter
let firstParam = formalParams[1]
let libParamName = firstParam[0] # e.g. `w`
let libTypeName = firstParam[1] # e.g. `Waku`
# Extract the return type: Future[Result[RetType, string]]
# RetType is used in the body helper proc signature
let retTypeNode = formalParams[0]
if retTypeNode.kind == nnkEmpty:
error(
"`.ffi.` proc must have an explicit return type Future[Result[RetType, string]]"
)
if retTypeNode.kind != nnkBracketExpr or $retTypeNode[0] != "Future":
error(
"`.ffi.` return type must be Future[Result[RetType, string]], got: " &
retTypeNode.repr
)
let resultInner = retTypeNode[1] # Result[RetType, string]
if resultInner.kind != nnkBracketExpr or $resultInner[0] != "Result":
error(
"`.ffi.` return type must be Future[Result[RetType, string]], got: " &
retTypeNode.repr
)
# Collect additional param names and types (everything after the first param)
var extraParamNames: seq[string] = @[]
var extraParamTypes: seq[NimNode] = @[]
for i in 2 ..< formalParams.len:
let p = formalParams[i]
for j in 0 ..< p.len - 2:
extraParamNames.add($p[j])
extraParamTypes.add(p[^2])
# Generate type/proc names from proc name
let procNameStr = block:
let raw = $procName
if raw.endsWith("*"):
raw[0 ..^ 2]
else:
raw
let cExportName = nimNameToCExport(procNameStr)
let camelName = toCamelCase(procNameStr)
# Names of generated things
let reqTypeName = ident(camelName & "Req")
let helperProcName = ident(camelName & "Body")
# Determine whether the body uses async operations
let isAsync = bodyHasAwait(bodyNode)
# Strip the * from the exported proc name (needed for both branches)
let exportedProcName =
if procName.kind == nnkPostfix:
procName[1]
else:
procName
# Common exported params (needed for both branches)
let ctxType =
nnkPtrTy.newTree(nnkBracketExpr.newTree(ident("FFIContext"), libTypeName))
if isAsync:
# -------------------------------------------------------------------------
# ASYNC PATH — existing behavior
# -------------------------------------------------------------------------
# -------------------------------------------------------------------------
# 1. Named async helper proc containing the user body
# -------------------------------------------------------------------------
# proc MyLibSendBody*(w: Waku, cfg: SendConfig): Future[Result[RetType, string]] {.async.} =
# <user body>
var helperParams = newSeq[NimNode]()
helperParams.add(retTypeNode)
# First param: w: LibType (by value, not pointer)
helperParams.add(newIdentDefs(libParamName, libTypeName))
for i in 0 ..< extraParamNames.len:
helperParams.add(newIdentDefs(ident(extraParamNames[i]), extraParamTypes[i]))
let helperProc = newProc(
name = postfix(helperProcName, "*"),
params = helperParams,
body = newStmtList(bodyNode),
pragmas = newTree(nnkPragma, ident("async")),
)
# -------------------------------------------------------------------------
# 2. registerReqFFI call
# -------------------------------------------------------------------------
let futStrStr = nnkBracketExpr.newTree(
ident("Future"),
nnkBracketExpr.newTree(ident("Result"), ident("string"), ident("string")),
)
let ctxHandlerName = ident("ffiCtxHandler")
let ptrFfiCtx =
nnkPtrTy.newTree(nnkBracketExpr.newTree(ident("FFIContext"), libTypeName))
var lambdaParams = newSeq[NimNode]()
lambdaParams.add(futStrStr)
for i in 0 ..< extraParamNames.len:
lambdaParams.add(
newIdentDefs(ident(cParamName(extraParamNames[i], extraParamTypes[i])), ident("cstring"))
)
let lambdaBody = newStmtList()
for i in 0 ..< extraParamNames.len:
let cIdent = ident(cParamName(extraParamNames[i], extraParamTypes[i]))
let paramIdent = ident(extraParamNames[i])
let ptype = extraParamTypes[i]
if $cIdent != $paramIdent:
# Non-string param: cIdent has a Json suffix. Deserialize into paramIdent.
# buildProcessFFIRequestProc unpacks cIdent from the req struct, so no name clash.
lambdaBody.add quote do:
let `paramIdent` = ffiDeserialize(`cIdent`, `ptype`).valueOr:
return err($error)
# String params (cIdent == paramIdent): buildProcessFFIRequestProc already
# unpacks the cstring under the same name; we convert inline in the helperCall below.
let ctxMyLib = newDotExpr(newTree(nnkDerefExpr, ctxHandlerName), ident("myLib"))
let libValDeref = newTree(nnkDerefExpr, ctxMyLib)
let helperCall = newTree(nnkCall, helperProcName, libValDeref)
for i in 0 ..< extraParamNames.len:
let cIdent = ident(cParamName(extraParamNames[i], extraParamTypes[i]))
let paramIdent = ident(extraParamNames[i])
if $cIdent == $paramIdent:
# String param: cIdent/paramIdent is the cstring from the req unpack;
# convert to string with $ (ffiDeserialize for string is just ok($s)).
helperCall.add(newCall(ident("$"), paramIdent))
else:
helperCall.add(paramIdent)
let retValIdent = ident("retVal")
lambdaBody.add quote do:
let `retValIdent` = (await `helperCall`).valueOr:
return err($error)
lambdaBody.add quote do:
return ok(ffiSerialize(`retValIdent`))
let lambdaNode = newProc(
name = newEmptyNode(),
params = lambdaParams,
body = lambdaBody,
pragmas = newTree(nnkPragma, ident("async")),
)
let registerReq = quote:
registerReqFFI(`reqTypeName`, `ctxHandlerName`: `ptrFfiCtx`):
`lambdaNode`
# -------------------------------------------------------------------------
# 3. C-exported proc (async path)
# -------------------------------------------------------------------------
var exportedParams = newSeq[NimNode]()
exportedParams.add(ident("cint"))
exportedParams.add(newIdentDefs(ident("ctx"), ctxType))
exportedParams.add(newIdentDefs(ident("callback"), ident("FFICallBack")))
exportedParams.add(newIdentDefs(ident("userData"), ident("pointer")))
for i in 0 ..< extraParamNames.len:
exportedParams.add(
newIdentDefs(ident(cParamName(extraParamNames[i], extraParamTypes[i])), ident("cstring"))
)
let ffiBody = newStmtList()
ffiBody.add quote do:
if callback.isNil:
return RET_MISSING_CALLBACK
ffiBody.add quote do:
if ctx.isNil or ctx[].myLib.isNil:
let errStr = "context not initialized"
callback(RET_ERR, unsafeAddr errStr[0], cast[csize_t](errStr.len), userData)
return RET_ERR
let newReqCall = newTree(nnkCall, ident("ffiNewReq"))
newReqCall.add(reqTypeName)
newReqCall.add(ident("callback"))
newReqCall.add(ident("userData"))
for i in 0 ..< extraParamNames.len:
newReqCall.add(ident(cParamName(extraParamNames[i], extraParamTypes[i])))
let sendCall = newCall(
newDotExpr(ident("ffi_context"), ident("sendRequestToFFIThread")),
ident("ctx"),
newReqCall,
)
let sendResIdent = genSym(nskLet, "sendRes")
ffiBody.add quote do:
let `sendResIdent` =
try:
`sendCall`
except Exception as exc:
Result[void, string].err("sendRequestToFFIThread exception: " & exc.msg)
if `sendResIdent`.isErr():
let errStr = "error in sendRequestToFFIThread: " & `sendResIdent`.error
callback(RET_ERR, unsafeAddr errStr[0], cast[csize_t](errStr.len), userData)
return RET_ERR
return RET_OK
let ffiProc = newProc(
name = exportedProcName,
params = exportedParams,
body = ffiBody,
pragmas = newTree(
nnkPragma,
ident("dynlib"),
newTree(nnkExprColonExpr, ident("exportc"), newStrLitNode(cExportName)),
ident("cdecl"),
newTree(nnkExprColonExpr, ident("raises"), newTree(nnkBracket)),
),
)
# Register proc metadata for binding generation
block:
var ffiExtraParams: seq[FFIParamMeta] = @[]
for i in 0 ..< extraParamNames.len:
let ptype = extraParamTypes[i]
var isPtr = false
var tn = ""
if ptype.kind == nnkPtrTy:
isPtr = true
tn = $ptype[0]
else:
tn = $ptype
ffiExtraParams.add(
FFIParamMeta(name: extraParamNames[i], typeName: tn, isPtr: isPtr)
)
let retTypeInner = resultInner[1] # RetType from Result[RetType, string]
var retIsPtr = false
var retTn = ""
if retTypeInner.kind == nnkPtrTy:
retIsPtr = true
retTn = $retTypeInner[0]
else:
retTn = $retTypeInner
ffiProcRegistry.add(
FFIProcMeta(
procName: cExportName,
libName: currentLibName,
kind: ffiFfiKind,
libTypeName: $libTypeName,
extraParams: ffiExtraParams,
returnTypeName: retTn,
returnIsPtr: retIsPtr,
isAsync: true,
)
)
result = newStmtList(helperProc, registerReq, ffiProc)
else:
# -------------------------------------------------------------------------
# SYNC PATH — no await/waitFor in body; bypass thread-channel machinery
# -------------------------------------------------------------------------
# -------------------------------------------------------------------------
# 1. Named sync helper proc (no {.async.}) with Result[RetType, string] return
# -------------------------------------------------------------------------
# proc MyLibVersionBody*(w: LibType): Result[RetType, string] =
# <user body>
let syncRetType = resultInner # Result[RetType, string]
var syncHelperParams = newSeq[NimNode]()
syncHelperParams.add(syncRetType)
syncHelperParams.add(newIdentDefs(libParamName, libTypeName))
for i in 0 ..< extraParamNames.len:
syncHelperParams.add(newIdentDefs(ident(extraParamNames[i]), extraParamTypes[i]))
let syncHelperProc = newProc(
name = postfix(helperProcName, "*"),
params = syncHelperParams,
body = newStmtList(bodyNode),
pragmas = newEmptyNode(),
)
# -------------------------------------------------------------------------
# 2. C-exported proc (sync path) — calls helper inline, fires callback inline
# -------------------------------------------------------------------------
var syncExportedParams = newSeq[NimNode]()
syncExportedParams.add(ident("cint"))
syncExportedParams.add(newIdentDefs(ident("ctx"), ctxType))
syncExportedParams.add(newIdentDefs(ident("callback"), ident("FFICallBack")))
syncExportedParams.add(newIdentDefs(ident("userData"), ident("pointer")))
for i in 0 ..< extraParamNames.len:
syncExportedParams.add(
newIdentDefs(ident(cParamName(extraParamNames[i], extraParamTypes[i])), ident("cstring"))
)
let syncFfiBody = newStmtList()
syncFfiBody.add quote do:
if callback.isNil:
return RET_MISSING_CALLBACK
syncFfiBody.add quote do:
if ctx.isNil or ctx[].myLib.isNil:
let errStr = "context not initialized"
callback(RET_ERR, unsafeAddr errStr[0], cast[csize_t](errStr.len), userData)
return RET_ERR
# Inline deserialization of each extra param
for i in 0 ..< extraParamNames.len:
let cIdent = ident(cParamName(extraParamNames[i], extraParamTypes[i]))
let paramIdent = ident(extraParamNames[i])
let ptype = extraParamTypes[i]
syncFfiBody.add quote do:
let `paramIdent` = ffiDeserialize(`cIdent`, `ptype`).valueOr:
let errStr = "deserialization failed: " & $error
callback(RET_ERR, unsafeAddr errStr[0], cast[csize_t](errStr.len), userData)
return RET_ERR
# Build the call to the sync helper: helperProcName(ctx[].myLib[], extraParam, ...)
let syncCtxMyLib = newDotExpr(newTree(nnkDerefExpr, ident("ctx")), ident("myLib"))
let syncLibValDeref = newTree(nnkDerefExpr, syncCtxMyLib)
let syncHelperCall = newTree(nnkCall, helperProcName, syncLibValDeref)
for name in extraParamNames:
syncHelperCall.add(ident(name))
let retValOrErrIdent = ident("retValOrErr")
syncFfiBody.add quote do:
let `retValOrErrIdent` = `syncHelperCall`
if `retValOrErrIdent`.isErr():
let errStr = `retValOrErrIdent`.error
callback(
RET_ERR, cast[ptr cchar](errStr.cstring), cast[csize_t](errStr.len), userData
)
return RET_ERR
let serialized = ffiSerialize(`retValOrErrIdent`.value)
callback(
RET_OK, cast[ptr cchar](serialized.cstring), cast[csize_t](serialized.len), userData
)
return RET_OK
let syncFfiProc = newProc(
name = exportedProcName,
params = syncExportedParams,
body = syncFfiBody,
pragmas = newTree(
nnkPragma,
ident("dynlib"),
newTree(nnkExprColonExpr, ident("exportc"), newStrLitNode(cExportName)),
ident("cdecl"),
newTree(nnkExprColonExpr, ident("raises"), newTree(nnkBracket)),
),
)
# Register proc metadata for binding generation (sync path)
block:
var ffiExtraParamsSync: seq[FFIParamMeta] = @[]
for i in 0 ..< extraParamNames.len:
let ptype = extraParamTypes[i]
var isPtr = false
var tn = ""
if ptype.kind == nnkPtrTy:
isPtr = true
tn = $ptype[0]
else:
tn = $ptype
ffiExtraParamsSync.add(
FFIParamMeta(name: extraParamNames[i], typeName: tn, isPtr: isPtr)
)
let retTypeInnerSync = resultInner[1]