jextract: implement Java-side overflow checks using has32bitSwiftInt helper

Author: DPrakashhh

Sources/JExtractSwiftLib/FFM/FFMSwift2JavaGenerator+JavaBindingsPrinting.swift

@@ -2,7 +2,7 @@
 //
 // This source file is part of the Swift.org open source project
 //
-// Copyright (c) 2024 Apple Inc. and the Swift.org project authors
+// Copyright (c) 2026 Apple Inc. and the Swift.org project authors
 // Licensed under Apache License v2.0
 //
 // See LICENSE.txt for license information
@@ -22,7 +22,8 @@
 import static java.lang.foreign.ValueLayout.*;
 
 /**
- * Similar to {@link java.lang.foreign.ValueLayout} however with some Swift specifics.
+ * Similar to {@link java.lang.foreign.ValueLayout} however with some Swift
+ * specifics.
  */
 public class SwiftValueLayout {
 
@@ -50,23 +51,28 @@ public static long addressByteSize() {
     public static final ValueLayout.OfFloat SWIFT_FLOAT = ValueLayout.JAVA_FLOAT;
     public static final ValueLayout.OfDouble SWIFT_DOUBLE = ValueLayout.JAVA_DOUBLE;
 
-    // FIXME: this sequence layout is a workaround, we must properly size pointers when we get them.
+    // FIXME: this sequence layout is a workaround, we must properly size pointers
+    // when we get them.
     public static final AddressLayout SWIFT_POINTER = ValueLayout.ADDRESS
-           .withTargetLayout(MemoryLayout.sequenceLayout(Long.MAX_VALUE, JAVA_BYTE));
+            .withTargetLayout(MemoryLayout.sequenceLayout(Long.MAX_VALUE, JAVA_BYTE));
     public static final SequenceLayout SWIFT_BYTE_ARRAY = MemoryLayout.sequenceLayout(8, ValueLayout.JAVA_BYTE);
 
     /**
-     * The value layout for Swift's {@code Int} type, which is a signed type that follows
+     * The value layout for Swift's {@code Int} type, which is a signed type that
+     * follows
      * the size of a pointer (aka C's {@code ptrdiff_t}).
      */
-    public static ValueLayout SWIFT_INT = (ValueLayout.ADDRESS.byteSize() == 4) ?
-            SWIFT_INT32 : SWIFT_INT64;
+    public static ValueLayout SWIFT_INT = (ValueLayout.ADDRESS.byteSize() == 4) ? SWIFT_INT32 : SWIFT_INT64;
 
     /**
-     * The value layout for Swift's {@code UInt} type, which is an unsigned type that follows
+     * The value layout for Swift's {@code UInt} type, which is an unsigned type
+     * that follows
      * the size of a pointer (aka C's {@code size_t}).
      * <p/>
-     * Java does not have unsigned integer types, so we use the layout for Swift's {@code Int}.
+     * Java does not have unsigned integer types, so we use the layout for Swift's
+     * {@code Int}.
      */
     public static ValueLayout SWIFT_UINT = SWIFT_INT;
+
+    public static final boolean has32bitSwiftInt = (SWIFT_INT == ValueLayout.JAVA_INT);
 }

Sources/JExtractSwiftLib/FFM/FFMSwift2JavaGenerator+JavaTranslation.swift

@@ -2,7 +2,7 @@
 //
 // This source file is part of the Swift.org open source project
 //
-// Copyright (c) 2024 Apple Inc. and the Swift.org project authors
+// Copyright (c) 2026 Apple Inc. and the Swift.org project authors
 // Licensed under Apache License v2.0
 //
 // See LICENSE.txt for license information
@@ -17,60 +17,65 @@ import Testing
 
 final class DataImportTests {
   private static let ifConfigImport = """
-  #if canImport(FoundationEssentials)
-  import FoundationEssentials
-  #else
-  import Foundation
-  #endif
-  """
+    #if canImport(FoundationEssentials)
+    import FoundationEssentials
+    #else
+    import Foundation
+    #endif
+    """
   private static let foundationData_interfaceFile =
     """
     import Foundation
-    
+
     public func receiveData(dat: Data)
     public func returnData() -> Data
     """
 
   private static let foundationDataProtocol_interfaceFile =
     """
     import Foundation
-    
+
     public func receiveDataProtocol<T: DataProtocol>(dat: some DataProtocol, dat2: T?)
     """
 
   private static let essentialsData_interfaceFile =
     """
     import FoundationEssentials
-    
+
     public func receiveData(dat: Data)
     public func returnData() -> Data
     """
 
   private static let essentialsDataProtocol_interfaceFile =
     """
     import FoundationEssentials
-    
+
     public func receiveDataProtocol<T: DataProtocol>(dat: some DataProtocol, dat2: T?)
     """
   private static let ifConfigData_interfaceFile =
     """
     \(ifConfigImport)
-    
+
     public func receiveData(dat: Data)
     public func returnData() -> Data
     """
 
   private static let ifConfigDataProtocol_interfaceFile =
     """
     \(ifConfigImport)
-    
+
     public func receiveDataProtocol<T: DataProtocol>(dat: some DataProtocol, dat2: T?)
     """
 
-  @Test("Import Data: Swift thunks", arguments: zip(
-    [Self.foundationData_interfaceFile, Self.essentialsData_interfaceFile, Self.ifConfigData_interfaceFile],
-    ["import Foundation", "import FoundationEssentials", Self.ifConfigImport]
-  ))
+  @Test(
+    "Import Data: Swift thunks",
+    arguments: zip(
+      [
+        Self.foundationData_interfaceFile, Self.essentialsData_interfaceFile,
+        Self.ifConfigData_interfaceFile,
+      ],
+      ["import Foundation", "import FoundationEssentials", Self.ifConfigImport]
+    ))
   func data_swiftThunk(fileContent: String, expectedImportChunk: String) throws {
 
     try assertOutput(
@@ -123,10 +128,13 @@ final class DataImportTests {
       ]
     )
   }
-  
-  @Test("Import Data: JavaBindings", arguments: [
-    Self.foundationData_interfaceFile, Self.essentialsData_interfaceFile, Self.ifConfigData_interfaceFile
-  ])
+
+  @Test(
+    "Import Data: JavaBindings",
+    arguments: [
+      Self.foundationData_interfaceFile, Self.essentialsData_interfaceFile,
+      Self.ifConfigData_interfaceFile,
+    ])
   func data_javaBindings(fileContent: String) throws {
     try assertOutput(
       input: fileContent, .ffm, .java,
@@ -209,7 +217,6 @@ final class DataImportTests {
         }
         """,
 
-
         """
         /**
          * {@snippet lang=c :
@@ -245,8 +252,13 @@ final class DataImportTests {
          * public init(bytes: UnsafeRawPointer, count: Int)
          * }
          */
-        public static Data init(java.lang.foreign.MemorySegment bytes, long count, AllocatingSwiftArena swiftArena$) {
+        public static Data init(java.lang.foreign.MemorySegment bytes, long count, AllocatingSwiftArena swiftArena$) throws SwiftIntegerOverflowException {
           MemorySegment _result = swiftArena$.allocate(Data.$LAYOUT);
+          if (SwiftValueLayout.has32bitSwiftInt) {
+            if (count < Integer.MIN_VALUE || count > Integer.MAX_VALUE) {
+              throw new SwiftIntegerOverflowException("Parameter 'count' overflow: " + count);
+            }
+          }
           swiftjava_SwiftModule_Data_init_bytes_count.call(bytes, count, _result);
           return Data.wrapMemoryAddressUnsafe(_result, swiftArena$);
         }
@@ -286,9 +298,15 @@ final class DataImportTests {
          * public var count: Int
          * }
          */
-        public long getCount() {
+        public long getCount() throws SwiftIntegerOverflowException {
           $ensureAlive();
-          return swiftjava_SwiftModule_Data_count$get.call(this.$memorySegment());
+          long _result$checked = swiftjava_SwiftModule_Data_count$get.call(this.$memorySegment());
+          if (SwiftValueLayout.has32bitSwiftInt) {
+            if (_result$checked < Integer.MIN_VALUE || _result$checked > Integer.MAX_VALUE) {
+              throw new SwiftIntegerOverflowException("Return value overflow: " + _result$checked);
+            }
+          }
+          return _result$checked;
         }
         """,
 
@@ -352,7 +370,6 @@ final class DataImportTests {
         }
         """,
 
-
         """
         /**
          * Downcall to Swift:
@@ -366,15 +383,20 @@ final class DataImportTests {
             swiftjava_SwiftModule_Data_withUnsafeBytes__.call(withUnsafeBytes.$toUpcallStub(body, arena$), this.$memorySegment());
           }
         }
-        """
+        """,
       ]
     )
   }
 
-  @Test("Import DataProtocol: Swift thunks", arguments: zip(
-    [Self.foundationDataProtocol_interfaceFile, Self.essentialsDataProtocol_interfaceFile, Self.ifConfigDataProtocol_interfaceFile], 
-    ["import Foundation", "import FoundationEssentials", Self.ifConfigImport]
-  ))
+  @Test(
+    "Import DataProtocol: Swift thunks",
+    arguments: zip(
+      [
+        Self.foundationDataProtocol_interfaceFile, Self.essentialsDataProtocol_interfaceFile,
+        Self.ifConfigDataProtocol_interfaceFile,
+      ],
+      ["import Foundation", "import FoundationEssentials", Self.ifConfigImport]
+    ))
   func dataProtocol_swiftThunk(fileContent: String, expectedImportChunk: String) throws {
     try assertOutput(
       input: fileContent, .ffm, .swift,
@@ -390,14 +412,17 @@ final class DataImportTests {
         // Just to make sure 'Data' is imported.
         """
         @_cdecl("swiftjava_getType_SwiftModule_Data")
-        """
+        """,
       ]
     )
   }
 
-  @Test("Import DataProtocol: JavaBindings", arguments: [
-    Self.foundationDataProtocol_interfaceFile, Self.essentialsDataProtocol_interfaceFile, Self.ifConfigDataProtocol_interfaceFile
-  ])
+  @Test(
+    "Import DataProtocol: JavaBindings",
+    arguments: [
+      Self.foundationDataProtocol_interfaceFile, Self.essentialsDataProtocol_interfaceFile,
+      Self.ifConfigDataProtocol_interfaceFile,
+    ])
   func dataProtocol_javaBindings(fileContent: String) throws {
 
     try assertOutput(
@@ -445,9 +470,9 @@ final class DataImportTests {
         // Just to make sure 'Data' is imported.
         """
         public final class Data extends FFMSwiftInstance implements SwiftValue {
-        """
+        """,
       ]
     )
   }
-  
+
 }

SwiftKitFFM/src/main/java/org/swift/swiftkit/ffm/SwiftValueLayout.java

@@ -2,7 +2,7 @@
 //
 // This source file is part of the Swift.org open source project
 //
-// Copyright (c) 2024 Apple Inc. and the Swift.org project authors
+// Copyright (c) 2026 Apple Inc. and the Swift.org project authors
 // Licensed under Apache License v2.0
 //
 // See LICENSE.txt for license information
@@ -39,11 +39,11 @@ final class MethodImportTests {
       l: Int64,
       s: String
     )
-    
+
     public func globalReturnClass() -> MySwiftClass
 
     public func globalReturnAny() -> Any
-    
+
     public func swapRawBufferPointer(buffer: UnsafeRawBufferPointer) -> UnsafeMutableRawBufferPointer
 
     extension MySwiftClass {
@@ -142,7 +142,12 @@ final class MethodImportTests {
          * public func globalTakeInt(i: Int)
          * }
          */
-        public static void globalTakeInt(long i) {
+        public static void globalTakeInt(long i) throws SwiftIntegerOverflowException {
+            if (SwiftValueLayout.has32bitSwiftInt) {
+                if (i < Integer.MIN_VALUE || i > Integer.MAX_VALUE) {
+                    throw new SwiftIntegerOverflowException("Parameter 'i' overflow: " + i);
+                }
+            }
             swiftjava___FakeModule_globalTakeInt_i.call(i);
         }
         """
@@ -362,9 +367,15 @@ final class MethodImportTests {
          * public func makeInt() -> Int
          * }
          */
-        public long makeInt() {
+        public long makeInt() throws SwiftIntegerOverflowException {
             $ensureAlive();
-            return swiftjava___FakeModule_MySwiftClass_makeInt.call(this.$memorySegment());
+            long _result$checked = swiftjava___FakeModule_MySwiftClass_makeInt.call(this.$memorySegment());
+            if (SwiftValueLayout.has32bitSwiftInt) {
+                if (_result$checked < Integer.MIN_VALUE || _result$checked > Integer.MAX_VALUE) {
+                    throw new SwiftIntegerOverflowException("Return value overflow: " + _result$checked);
+                }
+            }
+            return _result$checked;
         }
         """
     )
@@ -405,8 +416,16 @@ final class MethodImportTests {
          * public init(len: Swift.Int, cap: Swift.Int)
          * }
          */
-        public static MySwiftClass init(long len, long cap, AllocatingSwiftArena swiftArena$) {
+        public static MySwiftClass init(long len, long cap, AllocatingSwiftArena swiftArena$) throws SwiftIntegerOverflowException {
             MemorySegment _result = swiftArena$.allocate(MySwiftClass.$LAYOUT);
+            if (SwiftValueLayout.has32bitSwiftInt) {
+                if (len < Integer.MIN_VALUE || len > Integer.MAX_VALUE) {
+                    throw new SwiftIntegerOverflowException("Parameter 'len' overflow: " + len);
+                }
+                if (cap < Integer.MIN_VALUE || cap > Integer.MAX_VALUE) {
+                    throw new SwiftIntegerOverflowException("Parameter 'cap' overflow: " + cap);
+                }
+            }
             swiftjava___FakeModule_MySwiftClass_init_len_cap.call(len, cap, _result)
             return MySwiftClass.wrapMemoryAddressUnsafe(_result, swiftArena$);
         }
@@ -450,8 +469,16 @@ final class MethodImportTests {
          * public init(len: Swift.Int, cap: Swift.Int)
          * }
          */
-        public static MySwiftStruct init(long len, long cap, AllocatingSwiftArena swiftArena$) {
+        public static MySwiftStruct init(long len, long cap, AllocatingSwiftArena swiftArena$) throws SwiftIntegerOverflowException {
             MemorySegment _result = swiftArena$.allocate(MySwiftStruct.$LAYOUT);
+            if (SwiftValueLayout.has32bitSwiftInt) {
+                if (len < Integer.MIN_VALUE || len > Integer.MAX_VALUE) {
+                    throw new SwiftIntegerOverflowException("Parameter 'len' overflow: " + len);
+                }
+                if (cap < Integer.MIN_VALUE || cap > Integer.MAX_VALUE) {
+                    throw new SwiftIntegerOverflowException("Parameter 'cap' overflow: " + cap);
+                }
+            }
             swiftjava___FakeModule_MySwiftStruct_init_len_cap.call(len, cap, _result)
             return MySwiftStruct.wrapMemoryAddressUnsafe(_result, swiftArena$);
         }
@@ -468,8 +495,9 @@ final class MethodImportTests {
 
     try st.analyze(path: "Fake.swift", text: class_interfaceFile)
 
-    #expect(!st.importedGlobalFuncs.contains {
-      $0.name == "globalReturnAny"
-    }, "'Any' return type is not supported yet")
+    #expect(
+      !st.importedGlobalFuncs.contains {
+        $0.name == "globalReturnAny"
+      }, "'Any' return type is not supported yet")
   }
 }