Hardened memory allocator for jme (#2639)

* safer allocator

* Update jme3-saferallocator/src/main/java/com/jme3/util/SaferBufferAllocator.java

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

* fixes

* Update jme3-saferallocator/src/main/java/com/jme3/util/SaferAllocMemoryGuard.java

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

* fix

* fix dep mismatch

* make sure saferalloc library is always loaded (fix for SaferAllocNative.* calls that do not check automatically)

---------

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

Author: riccardobl

jme3-android/src/main/java/com/jme3/system/android/OGLESContext.java

@@ -69,6 +69,7 @@
 public class OGLESContext implements JmeContext, GLSurfaceView.Renderer, SoftTextDialogInput {
 
     private static final Logger logger = Logger.getLogger(OGLESContext.class.getName());
+    private static final String SAFER_BUFFER_ALLOCATOR_CLASS = "com.jme3.util.SaferBufferAllocator";
     protected final AtomicBoolean created = new AtomicBoolean(false);
     protected final AtomicBoolean renderable = new AtomicBoolean(false);
     protected final AtomicBoolean needClose = new AtomicBoolean(false);
@@ -86,7 +87,20 @@ public class OGLESContext implements JmeContext, GLSurfaceView.Renderer, SoftTex
         final String implementation = BufferAllocatorFactory.PROPERTY_BUFFER_ALLOCATOR_IMPLEMENTATION;
 
         if (System.getProperty(implementation) == null) {
-            System.setProperty(implementation, PrimitiveAllocator.class.getName());
+            if (isClassPresent(SAFER_BUFFER_ALLOCATOR_CLASS)) {
+                System.setProperty(implementation, SAFER_BUFFER_ALLOCATOR_CLASS);
+            } else {
+                System.setProperty(implementation, PrimitiveAllocator.class.getName());
+            }
+        }
+    }
+
+    private static boolean isClassPresent(String className) {
+        try {
+            Class.forName(className, false, OGLESContext.class.getClassLoader());
+            return true;
+        } catch (Throwable ignored) {
+            return false;
         }
     }
 

jme3-examples/build.gradle

@@ -21,6 +21,7 @@ dependencies {
     implementation project(':jme3-jogg')
     // implementation project(':jme3-lwjgl')
     implementation project(':jme3-lwjgl3')
+    implementation project(':jme3-saferallocator')
     implementation project(':jme3-networking')
     implementation project(':jme3-niftygui')
     implementation project(':jme3-plugins')

jme3-lwjgl3/src/main/java/com/jme3/system/lwjgl/LwjglContext.java

@@ -58,6 +58,8 @@
 import com.jme3.util.BufferAllocatorFactory;
 import com.jme3.util.LWJGLBufferAllocator;
 import com.jme3.util.LWJGLBufferAllocator.ConcurrentLWJGLBufferAllocator;
+import com.jme3.util.LWJGLSaferAllocMemoryAllocator;
+
 import static com.jme3.util.LWJGLBufferAllocator.PROPERTY_CONCURRENT_BUFFER_ALLOCATOR;
 import java.nio.IntBuffer;
 import java.util.*;
@@ -79,6 +81,7 @@
 import static org.lwjgl.opengl.GL.createCapabilities;
 import static org.lwjgl.opengl.GL11.glGetInteger;
 import org.lwjgl.opengl.GLCapabilities;
+import org.lwjgl.system.Configuration;
 import org.lwjgl.system.MemoryStack;
 import org.lwjgl.system.Platform;
 
@@ -90,10 +93,16 @@ public abstract class LwjglContext implements JmeContext {
     private static final Logger logger = Logger.getLogger(LwjglContext.class.getName());
 
     static {
-
         final String implementation = BufferAllocatorFactory.PROPERTY_BUFFER_ALLOCATOR_IMPLEMENTATION;
+        final String configuredImplementation = System.getProperty(implementation);
 
-        if (System.getProperty(implementation) == null) {
+        if (LWJGLSaferAllocMemoryAllocator.isAvailable()) {
+            Configuration.MEMORY_ALLOCATOR.set(new LWJGLSaferAllocMemoryAllocator());
+            if (configuredImplementation == null) {
+                System.setProperty(implementation,
+                        LWJGLSaferAllocMemoryAllocator.SAFER_BUFFER_ALLOCATOR_CLASS);
+            }
+        } else if (configuredImplementation == null) {
             if (Boolean.parseBoolean(System.getProperty(PROPERTY_CONCURRENT_BUFFER_ALLOCATOR, "true"))) {
                 System.setProperty(implementation, ConcurrentLWJGLBufferAllocator.class.getName());
             } else {

jme3-lwjgl3/src/main/java/com/jme3/util/LWJGLSaferAllocMemoryAllocator.java

@@ -0,0 +1,272 @@
+package com.jme3.util;
+
+import java.lang.invoke.MethodHandle;
+import java.lang.invoke.MethodHandles;
+import java.lang.invoke.MethodType;
+import java.util.logging.Logger;
+
+import org.lwjgl.system.MemoryUtil;
+
+public final class LWJGLSaferAllocMemoryAllocator implements MemoryUtil.MemoryAllocator {
+    private static final Logger logger = Logger.getLogger(LWJGLSaferAllocMemoryAllocator.class.getName());
+
+    public static final String SAFER_BUFFER_ALLOCATOR_CLASS = "com.jme3.util.SaferBufferAllocator";
+
+    private static final Bindings BINDINGS = Bindings.create();
+
+    private final long fnMalloc;
+    private final long fnCalloc;
+    private final long fnRealloc;
+    private final long fnFree;
+    private final long fnAlignedAlloc;
+    private final long fnAlignedFree;
+
+    public static boolean isAvailable() {
+        return BINDINGS != null;
+    }
+
+    public LWJGLSaferAllocMemoryAllocator() {
+        if (BINDINGS == null) {
+            throw new IllegalStateException(SAFER_BUFFER_ALLOCATOR_CLASS + " is not available on classpath.");
+        }
+        logger.info(getClass().getSimpleName() + " enabled!");
+        this.fnMalloc = BINDINGS.getMallocFunctionPointer();
+        this.fnCalloc = BINDINGS.getCallocFunctionPointer();
+        this.fnRealloc = BINDINGS.getReallocFunctionPointer();
+        this.fnFree = BINDINGS.getFreeFunctionPointer();
+        this.fnAlignedAlloc = BINDINGS.getAlignedAllocFunctionPointer();
+        this.fnAlignedFree = BINDINGS.getAlignedFreeFunctionPointer();
+    }
+
+    @Override
+    public long getMalloc() {
+        return fnMalloc;
+    }
+
+    @Override
+    public long getCalloc() {
+        return fnCalloc;
+    }
+
+    @Override
+    public long getRealloc() {
+        return fnRealloc;
+    }
+
+    @Override
+    public long getFree() {
+        return fnFree;
+    }
+
+    @Override
+    public long getAlignedAlloc() {
+        return fnAlignedAlloc;
+    }
+
+    @Override
+    public long getAlignedFree() {
+        return fnAlignedFree;
+    }
+
+    @Override
+    public long malloc(long size) {
+        return BINDINGS.malloc(size);
+    }
+
+    @Override
+    public long calloc(long num, long size) {
+        return BINDINGS.calloc(num, size);
+    }
+
+    @Override
+    public long realloc(long ptr, long size) {
+        return BINDINGS.realloc(ptr, size);
+    }
+
+    @Override
+    public void free(long ptr) {
+        BINDINGS.free(ptr);
+    }
+
+    @Override
+    public long aligned_alloc(long alignment, long size) {
+        return BINDINGS.alignedAlloc(alignment, size);
+    }
+
+    @Override
+    public void aligned_free(long ptr) {
+        BINDINGS.alignedFree(ptr);
+    }
+
+    private static final class Bindings {
+        private final MethodHandle mallocFnPtr;
+        private final MethodHandle callocFnPtr;
+        private final MethodHandle reallocFnPtr;
+        private final MethodHandle freeFnPtr;
+        private final MethodHandle alignedAllocFnPtr;
+        private final MethodHandle alignedFreeFnPtr;
+        private final MethodHandle malloc;
+        private final MethodHandle calloc;
+        private final MethodHandle realloc;
+        private final MethodHandle free;
+        private final MethodHandle alignedAlloc;
+        private final MethodHandle alignedFree;
+
+        private Bindings(
+                MethodHandle mallocFnPtr,
+                MethodHandle callocFnPtr,
+                MethodHandle reallocFnPtr,
+                MethodHandle freeFnPtr,
+                MethodHandle alignedAllocFnPtr,
+                MethodHandle alignedFreeFnPtr,
+                MethodHandle malloc,
+                MethodHandle calloc,
+                MethodHandle realloc,
+                MethodHandle free,
+                MethodHandle alignedAlloc,
+                MethodHandle alignedFree) {
+            this.mallocFnPtr = mallocFnPtr;
+            this.callocFnPtr = callocFnPtr;
+            this.reallocFnPtr = reallocFnPtr;
+            this.freeFnPtr = freeFnPtr;
+            this.alignedAllocFnPtr = alignedAllocFnPtr;
+            this.alignedFreeFnPtr = alignedFreeFnPtr;
+            this.malloc = malloc;
+            this.calloc = calloc;
+            this.realloc = realloc;
+            this.free = free;
+            this.alignedAlloc = alignedAlloc;
+            this.alignedFree = alignedFree;
+        }
+
+        static Bindings create() {
+            try {
+                Class<?> clazz = Class.forName(SAFER_BUFFER_ALLOCATOR_CLASS, true,
+                        LWJGLSaferAllocMemoryAllocator.class.getClassLoader());
+                MethodHandles.Lookup lookup = MethodHandles.publicLookup();
+                return new Bindings(
+                        lookup.findStatic(clazz, "getMallocFunctionPointer", MethodType.methodType(long.class)),
+                        lookup.findStatic(clazz, "getCallocFunctionPointer", MethodType.methodType(long.class)),
+                        lookup.findStatic(clazz, "getReallocFunctionPointer", MethodType.methodType(long.class)),
+                        lookup.findStatic(clazz, "getFreeFunctionPointer", MethodType.methodType(long.class)),
+                        lookup.findStatic(clazz, "getAlignedAllocFunctionPointer", MethodType.methodType(long.class)),
+                        lookup.findStatic(clazz, "getAlignedFreeFunctionPointer", MethodType.methodType(long.class)),
+                        lookup.findStatic(clazz, "malloc", MethodType.methodType(long.class, long.class)),
+                        lookup.findStatic(clazz, "calloc", MethodType.methodType(long.class, long.class, long.class)),
+                        lookup.findStatic(clazz, "realloc", MethodType.methodType(long.class, long.class, long.class)),
+                        lookup.findStatic(clazz, "free", MethodType.methodType(void.class, long.class)),
+                        lookup.findStatic(clazz, "alignedAlloc",
+                                MethodType.methodType(long.class, long.class, long.class)),
+                        lookup.findStatic(clazz, "alignedFree", MethodType.methodType(void.class, long.class)));
+            } catch (ReflectiveOperationException | LinkageError e) {
+                return null;
+            }
+        }
+
+        long getMallocFunctionPointer() {
+            try {
+                return (long) mallocFnPtr.invokeExact();
+            } catch (Throwable t) {
+                throw unchecked(t);
+            }
+        }
+
+        long getCallocFunctionPointer() {
+            try {
+                return (long) callocFnPtr.invokeExact();
+            } catch (Throwable t) {
+                throw unchecked(t);
+            }
+        }
+
+        long getReallocFunctionPointer() {
+            try {
+                return (long) reallocFnPtr.invokeExact();
+            } catch (Throwable t) {
+                throw unchecked(t);
+            }
+        }
+
+        long getFreeFunctionPointer() {
+            try {
+                return (long) freeFnPtr.invokeExact();
+            } catch (Throwable t) {
+                throw unchecked(t);
+            }
+        }
+
+        long getAlignedAllocFunctionPointer() {
+            try {
+                return (long) alignedAllocFnPtr.invokeExact();
+            } catch (Throwable t) {
+                throw unchecked(t);
+            }
+        }
+
+        long getAlignedFreeFunctionPointer() {
+            try {
+                return (long) alignedFreeFnPtr.invokeExact();
+            } catch (Throwable t) {
+                throw unchecked(t);
+            }
+        }
+
+        long malloc(long size) {
+            try {
+                return (long) malloc.invokeExact(size);
+            } catch (Throwable t) {
+                throw unchecked(t);
+            }
+        }
+
+        long calloc(long num, long size) {
+            try {
+                return (long) calloc.invokeExact(num, size);
+            } catch (Throwable t) {
+                throw unchecked(t);
+            }
+        }
+
+        long realloc(long ptr, long size) {
+            try {
+                return (long) realloc.invokeExact(ptr, size);
+            } catch (Throwable t) {
+                throw unchecked(t);
+            }
+        }
+
+        void free(long ptr) {
+            try {
+                free.invokeExact(ptr);
+            } catch (Throwable t) {
+                throw unchecked(t);
+            }
+        }
+
+        long alignedAlloc(long alignment, long size) {
+            try {
+                return (long) alignedAlloc.invokeExact(alignment, size);
+            } catch (Throwable t) {
+                throw unchecked(t);
+            }
+        }
+
+        void alignedFree(long ptr) {
+            try {
+                alignedFree.invokeExact(ptr);
+            } catch (Throwable t) {
+                throw unchecked(t);
+            }
+        }
+
+        private RuntimeException unchecked(Throwable t) {
+            if (t instanceof RuntimeException) {
+                return (RuntimeException) t;
+            }
+            if (t instanceof Error) {
+                throw (Error) t;
+            }
+            return new RuntimeException(t);
+        }
+    }
+}

jme3-saferallocator/build.gradle

@@ -0,0 +1,17 @@
+dependencies {
+    api project(':jme3-core')
+
+    implementation 'org.ngengine:saferalloc:0.0.7'
+    implementation 'org.ngengine:saferalloc-natives-linux-x86_64:0.0.7'
+    implementation 'org.ngengine:saferalloc-natives-linux-aarch64:0.0.7'
+    implementation 'org.ngengine:saferalloc-natives-windows-x86_64:0.0.7'
+    implementation 'org.ngengine:saferalloc-natives-macos-x86_64:0.0.7'
+    implementation 'org.ngengine:saferalloc-natives-macos-aarch64:0.0.7'
+    implementation 'org.ngengine:saferalloc-natives-android:0.0.7'
+}
+javadoc {
+    // Disable doclint for JDK8+.
+    if (JavaVersion.current().isJava8Compatible()){
+        options.addStringOption('Xdoclint:none', '-quiet')
+    }
+}