From 908b6d19a3628e48c1d1a89441d925bd6aaa05f5 Mon Sep 17 00:00:00 2001
From: agra <alex@swipelab.co>
Date: Tue, 19 May 2026 22:36:36 +0300
Subject: [PATCH] ffi 1.22: lock in undef shape for #jni_call(*void)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Last return-type variant in the matrix. JNI's jobject is a pointer
(LocalRef) — sx's `*void` maps to LLVM `ptr` directly. CallObjectMethod
is at vtable slot 34. IR snapshot captures today's `ret ptr undef`.
Next commit adds the `.ptr => Jni.CallObjectMethod` arm.

LocalRef lifetime: the returned jobject is a JNI LocalRef bounded by
the native frame. Chains of calls within one frame consume LocalRefs
inline; calls that need to escape the frame should be promoted via
`NewGlobalRef` (already wired in the slot-interning path). Step 1.22
doesn't introduce automatic cleanup — chess use consumes objects
inline, matching the pattern in sx_android_jni.c.
---
 examples/ffi-jni-call-08-jobject-return.sx    |  26 ++
 .../ffi-jni-call-08-jobject-return.exit       |   1 +
 .../ffi-jni-call-08-jobject-return.ir         | 269 ++++++++++++++++++
 .../ffi-jni-call-08-jobject-return.txt        |   1 +
 4 files changed, 297 insertions(+)
 create mode 100644 examples/ffi-jni-call-08-jobject-return.sx
 create mode 100644 tests/expected/ffi-jni-call-08-jobject-return.exit
 create mode 100644 tests/expected/ffi-jni-call-08-jobject-return.ir
 create mode 100644 tests/expected/ffi-jni-call-08-jobject-return.txt

diff --git a/examples/ffi-jni-call-08-jobject-return.sx b/examples/ffi-jni-call-08-jobject-return.sx
new file mode 100644
index 0000000..673ff74
--- /dev/null
+++ b/examples/ffi-jni-call-08-jobject-return.sx
@@ -0,0 +1,26 @@
+// Phase 1 step 1.22 (PLAN-FFI.md): `#jni_call(*void)` (jobject
+// return). Last return-type variant in the matrix. The returned
+// jobject is a JNI LocalRef — its lifetime is bounded by the native
+// frame, so chains of calls within one frame don't need explicit
+// cleanup, but calls that escape (cached cross-frame) should be
+// promoted via `NewGlobalRef`. For chess Android use the returned
+// jobject is consumed inline by the next `#jni_call`, so no cleanup
+// is needed here.
+//
+// CallObjectMethod lives at vtable slot 34.
+
+#import "modules/std.sx";
+
+g_should_call : bool = false;
+
+get_window :: (env: *void, activity: *void) -> *void {
+    #jni_call(*void)(env, activity, "getWindow", "()Landroid/view/Window;");
+}
+
+main :: () -> s32 {
+    if g_should_call {
+        _ := get_window(null, null);
+    }
+    print("ok\n");
+    0;
+}
diff --git a/tests/expected/ffi-jni-call-08-jobject-return.exit b/tests/expected/ffi-jni-call-08-jobject-return.exit
new file mode 100644
index 0000000..573541a
--- /dev/null
+++ b/tests/expected/ffi-jni-call-08-jobject-return.exit
@@ -0,0 +1 @@
+0
diff --git a/tests/expected/ffi-jni-call-08-jobject-return.ir b/tests/expected/ffi-jni-call-08-jobject-return.ir
new file mode 100644
index 0000000..a116f6f
--- /dev/null
+++ b/tests/expected/ffi-jni-call-08-jobject-return.ir
@@ -0,0 +1,269 @@
+
+@context = internal global { { ptr, ptr, ptr }, ptr } zeroinitializer
+@g_should_call = internal global i1 false
+@str = private unnamed_addr constant [10 x i8] c"getWindow\00", align 1
+@str.1 = private unnamed_addr constant [24 x i8] c"()Landroid/view/Window;\00", align 1
+@str.2 = private unnamed_addr constant [4 x i8] c"ok\0A\00", align 1
+@str.3 = private unnamed_addr constant [1 x i8] zeroinitializer, align 1
+
+; Function Attrs: nounwind
+declare void @out(ptr) #0
+
+declare ptr @malloc(i64)
+
+declare ptr @memcpy(ptr, ptr, i64)
+
+declare ptr @memset(ptr, i32, i64)
+
+declare void @free(ptr)
+
+; Function Attrs: nounwind
+declare void @GPA.create(ptr sret({ ptr, ptr, ptr }), ptr) #0
+
+; Function Attrs: nounwind
+define internal ptr @GPA.alloc(ptr %0, i64 %1) #0 {
+entry:
+  %alloca = alloca ptr, align 8
+  store ptr %0, ptr %alloca, align 8
+  %allocaN = alloca i64, align 8
+  store i64 %1, ptr %allocaN, align 8
+  %load = load ptr, ptr %alloca, align 8
+  %gep = getelementptr inbounds { i64 }, ptr %load, i32 0, i32 0
+  %loadN = load i64, ptr %gep, align 8
+  %add = add i64 %loadN, 1
+  store i64 %add, ptr %gep, align 8
+  %loadN = load i64, ptr %allocaN, align 8
+  %malloc = call ptr @malloc(i64 %loadN)
+  ret ptr %malloc
+}
+
+; Function Attrs: nounwind
+define internal void @GPA.dealloc(ptr %0, ptr %1) #0 {
+entry:
+  %alloca = alloca ptr, align 8
+  store ptr %0, ptr %alloca, align 8
+  %allocaN = alloca ptr, align 8
+  store ptr %1, ptr %allocaN, align 8
+  %load = load ptr, ptr %alloca, align 8
+  %gep = getelementptr inbounds { i64 }, ptr %load, i32 0, i32 0
+  %loadN = load i64, ptr %gep, align 8
+  %sub = sub i64 %loadN, 1
+  store i64 %sub, ptr %gep, align 8
+  %loadN = load ptr, ptr %allocaN, align 8
+  call void @free(ptr %loadN)
+  ret void
+}
+
+; Function Attrs: nounwind
+declare void @Arena.add_chunk(ptr, i64) #0
+
+; Function Attrs: nounwind
+declare void @Arena.create(ptr sret({ ptr, ptr, ptr }), ptr, ptr, i64) #0
+
+; Function Attrs: nounwind
+declare void @Arena.reset(ptr) #0
+
+; Function Attrs: nounwind
+declare void @Arena.deinit(ptr) #0
+
+; Function Attrs: nounwind
+declare ptr @Arena.alloc(ptr, i64) #0
+
+; Function Attrs: nounwind
+declare void @Arena.dealloc(ptr, ptr) #0
+
+; Function Attrs: nounwind
+declare void @BufAlloc.create(ptr sret({ ptr, ptr, ptr }), ptr, ptr, i64) #0
+
+; Function Attrs: nounwind
+declare void @BufAlloc.reset(ptr) #0
+
+; Function Attrs: nounwind
+declare ptr @BufAlloc.alloc(ptr, i64) #0
+
+; Function Attrs: nounwind
+declare void @BufAlloc.dealloc(ptr, ptr) #0
+
+; Function Attrs: nounwind
+define internal { ptr, i64 } @cstring(i64 %0) #0 {
+entry:
+  %alloca = alloca i64, align 8
+  store i64 %0, ptr %alloca, align 8
+  %load = load i64, ptr %alloca, align 8
+  %add = add i64 %load, 1
+  %heap = call ptr @malloc(i64 %add)
+  %allocaN = alloca ptr, align 8
+  store ptr %heap, ptr %allocaN, align 8
+  %loadN = load ptr, ptr %allocaN, align 8
+  %loadN = load i64, ptr %alloca, align 8
+  %addN = add i64 %loadN, 1
+  %1 = call ptr @memset(ptr %loadN, i32 0, i64 %addN)
+  %allocaN = alloca { ptr, i64 }, align 8
+  store { ptr, i64 } undef, ptr %allocaN, align 8
+  %loadN = load ptr, ptr %allocaN, align 8
+  %gep = getelementptr inbounds { ptr, i64 }, ptr %allocaN, i32 0, i32 0
+  %pti = ptrtoint ptr %loadN to i64
+  store i64 %pti, ptr %gep, align 8
+  %loadN = load i64, ptr %alloca, align 8
+  %gepN = getelementptr inbounds { ptr, i64 }, ptr %allocaN, i32 0, i32 1
+  store i64 %loadN, ptr %gepN, align 8
+  %loadN = load { ptr, i64 }, ptr %allocaN, align 8
+  ret { ptr, i64 } %loadN
+}
+
+; Function Attrs: nounwind
+declare ptr @int_to_string(i64) #0
+
+; Function Attrs: nounwind
+declare ptr @bool_to_string(i1) #0
+
+; Function Attrs: nounwind
+declare ptr @float_to_string(double) #0
+
+; Function Attrs: nounwind
+declare void @hex_group(ptr, i64, i64) #0
+
+; Function Attrs: nounwind
+declare ptr @int_to_hex_string(i64) #0
+
+; Function Attrs: nounwind
+define internal { ptr, i64 } @concat({ ptr, i64 } %0, { ptr, i64 } %1) #0 {
+entry:
+  %alloca = alloca { ptr, i64 }, align 8
+  store { ptr, i64 } %0, ptr %alloca, align 8
+  %allocaN = alloca { ptr, i64 }, align 8
+  store { ptr, i64 } %1, ptr %allocaN, align 8
+  %load = load { ptr, i64 }, ptr %alloca, align 8
+  %len = extractvalue { ptr, i64 } %load, 1
+  %allocaN = alloca i64, align 8
+  store i64 %len, ptr %allocaN, align 8
+  %loadN = load { ptr, i64 }, ptr %allocaN, align 8
+  %lenN = extractvalue { ptr, i64 } %loadN, 1
+  %allocaN = alloca i64, align 8
+  store i64 %lenN, ptr %allocaN, align 8
+  %loadN = load i64, ptr %allocaN, align 8
+  %loadN = load i64, ptr %allocaN, align 8
+  %add = add i64 %loadN, %loadN
+  %call = call { ptr, i64 } @cstring(i64 %add)
+  %allocaN = alloca { ptr, i64 }, align 8
+  store { ptr, i64 } %call, ptr %allocaN, align 8
+  %loadN = load { ptr, i64 }, ptr %allocaN, align 8
+  %dptr = extractvalue { ptr, i64 } %loadN, 0
+  %loadN = load { ptr, i64 }, ptr %alloca, align 8
+  %dptrN = extractvalue { ptr, i64 } %loadN, 0
+  %loadN = load i64, ptr %allocaN, align 8
+  %2 = call ptr @memcpy(ptr %dptr, ptr %dptrN, i64 %loadN)
+  %loadN = load i64, ptr %allocaN, align 8
+  %loadN = load { ptr, i64 }, ptr %allocaN, align 8
+  %igp.data = extractvalue { ptr, i64 } %loadN, 0
+  %igp.ptr = getelementptr i8, ptr %igp.data, i64 %loadN
+  %loadN = load { ptr, i64 }, ptr %allocaN, align 8
+  %dptrN = extractvalue { ptr, i64 } %loadN, 0
+  %loadN = load i64, ptr %allocaN, align 8
+  %3 = call ptr @memcpy(ptr %igp.ptr, ptr %dptrN, i64 %loadN)
+  %loadN = load { ptr, i64 }, ptr %allocaN, align 8
+  ret { ptr, i64 } %loadN
+}
+
+; Function Attrs: nounwind
+define internal { ptr, i64 } @substr({ ptr, i64 } %0, i64 %1, i64 %2) #0 {
+entry:
+  %alloca = alloca { ptr, i64 }, align 8
+  store { ptr, i64 } %0, ptr %alloca, align 8
+  %allocaN = alloca i64, align 8
+  store i64 %1, ptr %allocaN, align 8
+  %allocaN = alloca i64, align 8
+  store i64 %2, ptr %allocaN, align 8
+  %load = load i64, ptr %allocaN, align 8
+  %call = call { ptr, i64 } @cstring(i64 %load)
+  %allocaN = alloca { ptr, i64 }, align 8
+  store { ptr, i64 } %call, ptr %allocaN, align 8
+  %loadN = load { ptr, i64 }, ptr %allocaN, align 8
+  %dptr = extractvalue { ptr, i64 } %loadN, 0
+  %loadN = load i64, ptr %allocaN, align 8
+  %loadN = load { ptr, i64 }, ptr %alloca, align 8
+  %igp.data = extractvalue { ptr, i64 } %loadN, 0
+  %igp.ptr = getelementptr i8, ptr %igp.data, i64 %loadN
+  %loadN = load i64, ptr %allocaN, align 8
+  %3 = call ptr @memcpy(ptr %dptr, ptr %igp.ptr, i64 %loadN)
+  %loadN = load { ptr, i64 }, ptr %allocaN, align 8
+  ret { ptr, i64 } %loadN
+}
+
+; Function Attrs: nounwind
+declare ptr @any_to_string([2 x i64]) #0
+
+; Function Attrs: nounwind
+declare ptr @build_format(ptr) #0
+
+; Function Attrs: nounwind
+define internal ptr @get_window(ptr %0, ptr %1) #0 {
+entry:
+  %alloca = alloca ptr, align 8
+  store ptr %0, ptr %alloca, align 8
+  %allocaN = alloca ptr, align 8
+  store ptr %1, ptr %allocaN, align 8
+  %load = load ptr, ptr %alloca, align 8
+  %loadN = load ptr, ptr %allocaN, align 8
+  ret ptr undef
+}
+
+; Function Attrs: nounwind
+define i32 @main() #0 {
+entry:
+  %alloca = alloca { i64 }, align 8
+  store { i64 } zeroinitializer, ptr %alloca, align 8
+  %si = insertvalue { ptr, ptr, ptr } undef, ptr %alloca, 0
+  %siN = insertvalue { ptr, ptr, ptr } %si, ptr @__thunk_GPA_Allocator_alloc, 1
+  %siN = insertvalue { ptr, ptr, ptr } %siN, ptr @__thunk_GPA_Allocator_dealloc, 2
+  %siN = insertvalue { { ptr, ptr, ptr }, ptr } undef, { ptr, ptr, ptr } %siN, 0
+  %siN = insertvalue { { ptr, ptr, ptr }, ptr } %siN, ptr null, 1
+  store { { ptr, ptr, ptr }, ptr } %siN, ptr @context, align 8
+  %gload = load i1, ptr @g_should_call, align 1
+  br i1 %gload, label %if.then.0, label %if.merge.1
+
+if.then.0:                                        ; preds = %entry
+  %call = call ptr @get_window(ptr null, ptr null)
+  %allocaN = alloca ptr, align 8
+  store ptr %call, ptr %allocaN, align 8
+  br label %if.merge.1
+
+if.merge.1:                                       ; preds = %if.then.0, %entry
+  %allocaN = alloca { ptr, i64 }, align 8
+  %gep = getelementptr inbounds { ptr, i64 }, ptr %allocaN, i32 0, i32 0
+  store ptr null, ptr %gep, align 8
+  %gepN = getelementptr inbounds { ptr, i64 }, ptr %allocaN, i32 0, i32 1
+  store i64 0, ptr %gepN, align 8
+  %allocaN = alloca { ptr, i64 }, align 8
+  store { ptr, i64 } { ptr @str.2, i64 3 }, ptr %allocaN, align 8
+  %allocaN = alloca { ptr, i64 }, align 8
+  store { ptr, i64 } { ptr @str.3, i64 0 }, ptr %allocaN, align 8
+  %load = load { ptr, i64 }, ptr %allocaN, align 8
+  %loadN = load { ptr, i64 }, ptr %allocaN, align 8
+  %callN = call { ptr, i64 } @substr({ ptr, i64 } %loadN, i64 0, i64 3)
+  %callN = call { ptr, i64 } @concat({ ptr, i64 } %load, { ptr, i64 } %callN)
+  store { ptr, i64 } %callN, ptr %allocaN, align 8
+  %loadN = load { ptr, i64 }, ptr %allocaN, align 8
+  %str.ptr = extractvalue { ptr, i64 } %loadN, 0
+  %str.len = extractvalue { ptr, i64 } %loadN, 1
+  %0 = call i64 @write(i32 1, ptr %str.ptr, i64 %str.len)
+  ret i32 0
+}
+
+; Function Attrs: nounwind
+define internal ptr @__thunk_GPA_Allocator_alloc(ptr %0, i64 %1) #0 {
+entry:
+  %call = call ptr @GPA.alloc(ptr %0, i64 %1)
+  ret ptr %call
+}
+
+; Function Attrs: nounwind
+define internal void @__thunk_GPA_Allocator_dealloc(ptr %0, ptr %1) #0 {
+entry:
+  call void @GPA.dealloc(ptr %0, ptr %1)
+  ret void
+}
+
+declare i64 @write(i32, ptr, i64)
+
+
diff --git a/tests/expected/ffi-jni-call-08-jobject-return.txt b/tests/expected/ffi-jni-call-08-jobject-return.txt
new file mode 100644
index 0000000..9766475
--- /dev/null
+++ b/tests/expected/ffi-jni-call-08-jobject-return.txt
@@ -0,0 +1 @@
+ok