feat: generated sync wrappers

Author: gmelodie

.github/workflows/ci.yml

@@ -93,6 +93,9 @@ jobs:
       nimble-version: ${{ needs.versions.outputs.nimble }}
 
   cpp-e2e:
+    # Native-binding e2e across the OS matrix. C++ runs on every OS; the C and
+    # Rust suites (added below) run Linux-only, so the job id stays `cpp-e2e`
+    # for the required-check name even though it now covers all three backends.
     # Codegen output doesn't vary with mm, so we matrix over OS and Nim only.
     # Windows runs MSVC by default and may surface codegen tweaks needed in
     # the generated CMake (e.g. /EHsc, dllexport) — track follow-ups as bugs
@@ -176,6 +179,21 @@ jobs:
         shell: bash
         run: nimble test_c_abi_e2e -y
 
+      # CBOR C bindings: exercises the async callback API and the blocking
+      # `_sync` wrappers. Linux-only (codegen is platform-checked by
+      # check-bindings; one OS is enough for the runtime round-trip).
+      - name: Run C e2e tests
+        if: matrix.label == 'Linux'
+        shell: bash
+        run: nimble test_c_e2e -y
+
+      # Rust bindings: drives the generated blocking + tokio-async wrappers
+      # through the full FFI round-trip. Linux-only for the same reason.
+      - name: Run Rust e2e tests
+        if: matrix.label == 'Linux'
+        shell: bash
+        run: nimble test_rust_e2e -y
+
   check-bindings:
     # Single OS is enough — codegen output is platform-independent; the Nim
     # matrix catches version-sensitive output (the PR #39 drift class).

.github/workflows/tests-sanitized.yml

@@ -102,5 +102,8 @@ jobs:
       - name: Run C++ e2e tests (${{ inputs.sanitizer }})
         run: nimble test_cpp_e2e_sanitized -y
 
+      - name: Run C e2e tests (${{ inputs.sanitizer }})
+        run: nimble test_c_e2e_sanitized -y
+
       - name: Run abi=c C e2e test (${{ inputs.sanitizer }})
         run: nimble test_c_abi_e2e_sanitized -y

.gitignore

@@ -26,6 +26,7 @@ examples/**/cpp_bindings/build/
 
 # Cargo build artifacts (rust clients / harnesses)
 examples/**/rust_client/target/
+tests/e2e/rust/target/
 
 # Development plans (local only — match PLAN.md and any `*-plan.md` notes)
 PLAN.md

examples/echo/c_bindings/CMakeLists.txt

@@ -28,9 +28,9 @@ find_package(Threads REQUIRED)
 add_library(echo_headers INTERFACE)
 target_include_directories(echo_headers INTERFACE "${CMAKE_CURRENT_SOURCE_DIR}")
 target_link_libraries(echo_headers INTERFACE echo tinycbor Threads::Threads)
-# The generated header is async (no blocking helper), but consumer code that
-# waits on a result callback typically uses nanosleep / pthreads, which need a
-# POSIX feature level that strict `-std=c11` hides. Define it for consumers.
+# The generated `_sync` wrappers block on a pthread condvar, and consumer code
+# that polls a result callback typically uses nanosleep — both need a POSIX
+# feature level that strict `-std=c11` hides. Define it for consumers.
 target_compile_definitions(echo_headers INTERFACE _POSIX_C_SOURCE=200809L)
 
 if(EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/main.c")

examples/echo/c_bindings/echo.h

@@ -1,6 +1,7 @@
 #ifndef NIM_FFI_LIB_ECHO_H_INCLUDED
 #define NIM_FFI_LIB_ECHO_H_INCLUDED
 #include "nim_ffi_cbor.h"
+#include "nim_ffi_sync.h"
 
 /* ============================================================ */
 /* Generated types (user-declared + per-proc request envelopes) */
@@ -287,6 +288,67 @@ static inline int echo_ctx_create(const EchoConfig* config, EchoCreateFn on_crea
     return 0;
 }
 
+static inline int echo_ctx_create_sync(const EchoConfig* config, EchoCtx** out, char* err_buf, size_t err_len, uint32_t timeout_ms) {
+    EchoCreateCtorReq ffi_req;
+    memset(&ffi_req, 0, sizeof(ffi_req));
+    ffi_req.config = *config;
+    uint8_t* req_buf = NULL;
+    size_t req_len = 0;
+    char* enc_err = NULL;
+    if (nimffi_encode_to_buf(echo_encv_EchoCreateCtorReq, &ffi_req, &req_buf, &req_len, &enc_err) != 0) {
+        nimffi_copy_err(err_buf, err_len, enc_err ? enc_err : "encode failed");
+        free(enc_err);
+        return -1;
+    }
+    NimFfiSyncState* st = nimffi_sync_state_new();
+    if (!st) {
+        free(req_buf);
+        nimffi_copy_err(err_buf, err_len, "out of memory");
+        return -1;
+    }
+    (void)echo_create(req_buf, req_len, nimffi_sync_cb, st);
+    free(req_buf);
+    if (!nimffi_sync_wait(st, timeout_ms)) {
+        nimffi_copy_err(err_buf, err_len, "FFI create timed out");
+        nimffi_sync_state_release(st);
+        return -1;
+    }
+    if (!st->ok) {
+        nimffi_copy_err(err_buf, err_len, st->err ? st->err : "FFI create failed");
+        int rc = st->ret_code ? st->ret_code : -1;
+        nimffi_sync_state_release(st);
+        return rc;
+    }
+    NimFfiStr addr;
+    memset(&addr, 0, sizeof(addr));
+    char* dec_err = NULL;
+    if (nimffi_decode_from_buf(echo_decv_Str, st->bytes, st->bytes_len, &addr, &dec_err) != 0) {
+        nimffi_copy_err(err_buf, err_len, dec_err ? dec_err : "decode failed");
+        free(dec_err);
+        nimffi_sync_state_release(st);
+        return -1;
+    }
+    char* endp = NULL;
+    unsigned long long a = addr.data ? strtoull(addr.data, &endp, 10) : 0;
+    bool ok = addr.data && addr.len > 0 && endp && *endp == '\0';
+    nimffi_free_str(&addr);
+    if (!ok) {
+        nimffi_copy_err(err_buf, err_len, "FFI create returned non-numeric address");
+        nimffi_sync_state_release(st);
+        return -1;
+    }
+    EchoCtx* c = (EchoCtx*)calloc(1, sizeof(EchoCtx));
+    if (!c) {
+        nimffi_copy_err(err_buf, err_len, "out of memory");
+        nimffi_sync_state_release(st);
+        return -1;
+    }
+    c->ptr = (void*)(uintptr_t)a;
+    *out = c;
+    nimffi_sync_state_release(st);
+    return 0;
+}
+
 static inline void echo_ctx_destroy(EchoCtx* ctx) {
     if (!ctx) return;
     if (ctx->ptr) { echo_destroy(ctx->ptr); ctx->ptr = NULL; }
@@ -353,6 +415,57 @@ static inline int echo_ctx_shout(const EchoCtx* ctx, const ShoutRequest* req, Ec
     return 0;
 }
 
+static inline int echo_ctx_shout_sync(const EchoCtx* ctx, const ShoutRequest* req, ShoutResponse* out, char* err_buf, size_t err_len, uint32_t timeout_ms) {
+    EchoShoutReq ffi_req;
+    memset(&ffi_req, 0, sizeof(ffi_req));
+    ffi_req.req = *req;
+    uint8_t* req_buf = NULL;
+    size_t req_len = 0;
+    char* enc_err = NULL;
+    if (nimffi_encode_to_buf(echo_encv_EchoShoutReq, &ffi_req, &req_buf, &req_len, &enc_err) != 0) {
+        nimffi_copy_err(err_buf, err_len, enc_err ? enc_err : "encode failed");
+        free(enc_err);
+        return -1;
+    }
+    NimFfiSyncState* st = nimffi_sync_state_new();
+    if (!st) {
+        free(req_buf);
+        nimffi_copy_err(err_buf, err_len, "out of memory");
+        return -1;
+    }
+    int ret = echo_shout(ctx->ptr, nimffi_sync_cb, st, req_buf, req_len);
+    free(req_buf);
+    if (ret == NIMFFI_RET_MISSING_CALLBACK) {
+        nimffi_copy_err(err_buf, err_len, "RET_MISSING_CALLBACK (internal error)");
+        nimffi_sync_state_release(st);
+        nimffi_sync_state_release(st);
+        return -1;
+    }
+    if (!nimffi_sync_wait(st, timeout_ms)) {
+        nimffi_copy_err(err_buf, err_len, "FFI call timed out");
+        nimffi_sync_state_release(st);
+        return -1;
+    }
+    if (!st->ok) {
+        nimffi_copy_err(err_buf, err_len, st->err ? st->err : "FFI call failed");
+        int rc = st->ret_code ? st->ret_code : -1;
+        nimffi_sync_state_release(st);
+        return rc;
+    }
+    memset(out, 0, sizeof(*out));
+    char* dec_err = NULL;
+    int dec = nimffi_decode_from_buf(echo_decv_ShoutResponse, st->bytes, st->bytes_len, out, &dec_err);
+    if (dec != 0) {
+        nimffi_copy_err(err_buf, err_len, dec_err ? dec_err : "decode failed");
+        free(dec_err);
+        echo_free_ShoutResponse(out);
+        nimffi_sync_state_release(st);
+        return -1;
+    }
+    nimffi_sync_state_release(st);
+    return 0;
+}
+
 typedef void (*EchoVersionReplyFn)(int err_code, const NimFfiStr* reply, const char* err_msg, void* user_data);
 typedef struct { EchoVersionReplyFn fn; void* user_data; } EchoVersionCallBox;
 static void echo_version_reply_trampoline(int ret, const char* msg, size_t len, void* ud) {
@@ -412,4 +525,54 @@ static inline int echo_ctx_version(const EchoCtx* ctx, EchoVersionReplyFn on_rep
     return 0;
 }
 
+static inline int echo_ctx_version_sync(const EchoCtx* ctx, NimFfiStr* out, char* err_buf, size_t err_len, uint32_t timeout_ms) {
+    EchoVersionReq ffi_req;
+    memset(&ffi_req, 0, sizeof(ffi_req));
+    uint8_t* req_buf = NULL;
+    size_t req_len = 0;
+    char* enc_err = NULL;
+    if (nimffi_encode_to_buf(echo_encv_EchoVersionReq, &ffi_req, &req_buf, &req_len, &enc_err) != 0) {
+        nimffi_copy_err(err_buf, err_len, enc_err ? enc_err : "encode failed");
+        free(enc_err);
+        return -1;
+    }
+    NimFfiSyncState* st = nimffi_sync_state_new();
+    if (!st) {
+        free(req_buf);
+        nimffi_copy_err(err_buf, err_len, "out of memory");
+        return -1;
+    }
+    int ret = echo_version(ctx->ptr, nimffi_sync_cb, st, req_buf, req_len);
+    free(req_buf);
+    if (ret == NIMFFI_RET_MISSING_CALLBACK) {
+        nimffi_copy_err(err_buf, err_len, "RET_MISSING_CALLBACK (internal error)");
+        nimffi_sync_state_release(st);
+        nimffi_sync_state_release(st);
+        return -1;
+    }
+    if (!nimffi_sync_wait(st, timeout_ms)) {
+        nimffi_copy_err(err_buf, err_len, "FFI call timed out");
+        nimffi_sync_state_release(st);
+        return -1;
+    }
+    if (!st->ok) {
+        nimffi_copy_err(err_buf, err_len, st->err ? st->err : "FFI call failed");
+        int rc = st->ret_code ? st->ret_code : -1;
+        nimffi_sync_state_release(st);
+        return rc;
+    }
+    memset(out, 0, sizeof(*out));
+    char* dec_err = NULL;
+    int dec = nimffi_decode_from_buf(echo_decv_Str, st->bytes, st->bytes_len, out, &dec_err);
+    if (dec != 0) {
+        nimffi_copy_err(err_buf, err_len, dec_err ? dec_err : "decode failed");
+        free(dec_err);
+        nimffi_free_str(out);
+        nimffi_sync_state_release(st);
+        return -1;
+    }
+    nimffi_sync_state_release(st);
+    return 0;
+}
+
 #endif /* NIM_FFI_LIB_ECHO_H_INCLUDED */