Merge pull request #63 from JavaBWAPI/support-jdk9+

JasperGeurtz · web-flow · commit 137254e47ddc · 2020-09-20T09:44:37.000+02:00
Support jdk9+
diff --git a/.gitignore b/.gitignore
@@ -8,3 +8,5 @@ target/
 .classpath
 .project
 
+# logging
+*.log
diff --git a/src/main/java/bwapi/Client.java b/src/main/java/bwapi/Client.java
@@ -29,12 +29,11 @@ of this software and associated documentation files (the "Software"), to deal
 import bwapi.ClientData.GameData;
 import bwapi.ClientData.Shape;
 import com.sun.jna.Native;
+import com.sun.jna.Pointer;
 import com.sun.jna.platform.win32.Kernel32;
 import com.sun.jna.win32.W32APIOptions;
 
 import java.io.RandomAccessFile;
-import java.nio.ByteBuffer;
-import java.nio.ByteOrder;
 
 class Client {
     interface MappingKernel extends Kernel32 {
@@ -51,14 +50,13 @@ public interface EventHandler {
 
     private static final int SUPPORTED_BWAPI_VERSION = 10003;
     static final int MAX_COUNT = 19999;
-    static final int MAX_STRING_SIZE = 1024;
 
     private ClientData clientData;
     private ClientData.GameData gameData;
     private boolean connected = false;
     private RandomAccessFile pipeObjectHandle = null;
-    private ByteBuffer mapFileHandle = null;
-    private ByteBuffer gameTableFileHandle = null;
+    private WrappedBuffer mapFileHandle = null;
+    private WrappedBuffer gameTableFileHandle = null;
 
     private boolean debugConnection = false;
 
@@ -69,7 +67,7 @@ public interface EventHandler {
     /**
      * For test purposes only
      */
-    Client(ByteBuffer buffer) {
+    Client(final WrappedBuffer buffer) {
         clientData = new ClientData(buffer);
         gameData = clientData.new GameData(0);
     }
@@ -86,7 +84,7 @@ boolean isConnected() {
         return connected;
     }
 
-    void reconnect(){
+    void reconnect() {
         while (!connect()) {
             sleep(1000);
         }
@@ -101,11 +99,10 @@ void disconnect() {
             return;
         }
 
-        if (pipeObjectHandle != null ) {
+        if (pipeObjectHandle != null) {
             try {
                 pipeObjectHandle.close();
-            }
-            catch (Exception e) {
+            } catch (Exception e) {
                 e.printStackTrace();
             }
             pipeObjectHandle = null;
@@ -127,21 +124,19 @@ boolean connect() {
         int gameTableIndex = -1;
 
         try {
-            gameTableFileHandle = Kernel32.INSTANCE.MapViewOfFile(
-                    MappingKernel.INSTANCE.OpenFileMapping(READ_WRITE, false, "Local\\bwapi_shared_memory_game_list"), READ_WRITE, 0, 0, GameTable.SIZE)
-                    .getByteBuffer(0, GameTable.SIZE);
-            gameTableFileHandle.order(ByteOrder.LITTLE_ENDIAN);
-        }
-        catch (Exception e) {
+            final Pointer gameTableView = Kernel32.INSTANCE.MapViewOfFile(MappingKernel.INSTANCE
+                            .OpenFileMapping(READ_WRITE, false, "Local\\bwapi_shared_memory_game_list"), READ_WRITE,
+                    0, 0, GameTable.SIZE);
+            gameTableFileHandle = new WrappedBuffer(gameTableView, GameTable.SIZE);
+        } catch (Exception e) {
             System.err.println("Game table mapping not found.");
             return false;
         }
 
         GameTable gameTable;
         try {
             gameTable = new GameTable(gameTableFileHandle);
-        }
-        catch (Exception e) {
+        } catch (Exception e) {
             System.err.println("Unable to map Game table.");
             if (debugConnection) {
                 e.printStackTrace();
@@ -150,11 +145,11 @@ boolean connect() {
         }
 
         int latest = 0;
-        for(int i = 0; i < GameTable.MAX_GAME_INSTANCES; i++) {
+        for (int i = 0; i < GameTable.MAX_GAME_INSTANCES; i++) {
             GameInstance gameInstance = gameTable.gameInstances[i];
             System.out.println(i + " | " + gameInstance.serverProcessID + " | " + (gameInstance.isConnected ? 1 : 0) + " | " + gameInstance.lastKeepAliveTime);
             if (gameInstance.serverProcessID != 0 && !gameInstance.isConnected) {
-                if ( gameTableIndex == -1 || latest == 0 || gameInstance.lastKeepAliveTime < latest ) {
+                if (gameTableIndex == -1 || latest == 0 || gameInstance.lastKeepAliveTime < latest) {
                     latest = gameInstance.lastKeepAliveTime;
                     gameTableIndex = i;
                 }
@@ -173,9 +168,8 @@ boolean connect() {
         final String sharedMemoryName = "Local\\bwapi_shared_memory_" + serverProcID;
         final String communicationPipe = "\\\\.\\pipe\\bwapi_pipe_" + serverProcID;
         try {
-            pipeObjectHandle  = new RandomAccessFile(communicationPipe, "rw");
-        }
-        catch (Exception e) {
+            pipeObjectHandle = new RandomAccessFile(communicationPipe, "rw");
+        } catch (Exception e) {
             System.err.println("Unable to open communications pipe: " + communicationPipe);
             if (debugConnection) {
                 e.printStackTrace();
@@ -186,11 +180,11 @@ boolean connect() {
         System.out.println("Connected");
 
         try {
-            mapFileHandle = Kernel32.INSTANCE.MapViewOfFile(MappingKernel.INSTANCE
+            final Pointer mapFileView = Kernel32.INSTANCE.MapViewOfFile(MappingKernel.INSTANCE
                             .OpenFileMapping(READ_WRITE, false, sharedMemoryName), READ_WRITE,
-                    0, 0, GameData.SIZE).getByteBuffer(0, GameData.SIZE);
-        }
-        catch (Exception e) {
+                    0, 0, GameData.SIZE);
+            mapFileHandle = new WrappedBuffer(mapFileView, GameData.SIZE);
+        } catch (Exception e) {
             System.err.println("Unable to open shared memory mapping: " + sharedMemoryName);
             if (debugConnection) {
                 e.printStackTrace();
@@ -202,8 +196,7 @@ boolean connect() {
         try {
             clientData = new ClientData(mapFileHandle);
             gameData = clientData.new GameData(0);
-        }
-        catch (Exception e) {
+        } catch (Exception e) {
             System.err.println("Unable to map game data.");
             if (debugConnection) {
                 e.printStackTrace();
@@ -223,8 +216,7 @@ boolean connect() {
         while (code != 2) {
             try {
                 code = pipeObjectHandle.readByte();
-            }
-            catch (Exception e) {
+            } catch (Exception e) {
                 System.err.println("Unable to read pipe object.");
                 if (debugConnection) {
                     e.printStackTrace();
@@ -243,8 +235,7 @@ void update(final EventHandler handler) {
         byte code = 1;
         try {
             pipeObjectHandle.writeByte(code);
-        }
-        catch (Exception e) {
+        } catch (Exception e) {
             System.err.println("failed, disconnecting");
             if (debugConnection) {
                 e.printStackTrace();
@@ -255,8 +246,7 @@ void update(final EventHandler handler) {
         while (code != 2) {
             try {
                 code = pipeObjectHandle.readByte();
-            }
-            catch (Exception e) {
+            } catch (Exception e) {
                 System.err.println("failed, disconnecting");
                 if (debugConnection) {
                     e.printStackTrace();
@@ -280,13 +270,8 @@ int addString(final String string) {
             throw new IllegalStateException("Too many strings!");
         }
 
-        //truncate string if its size equals or exceeds 1024
-        final String stringTruncated = string.length() >= MAX_STRING_SIZE
-                ? string.substring(0, MAX_STRING_SIZE - 1)
-                : string;
-
         gameData.setStringCount(stringCount + 1);
-        gameData.setStrings(stringCount, stringTruncated);
+        gameData.setStrings(stringCount, string);
         return stringCount;
     }
 
@@ -318,10 +303,9 @@ ClientData.UnitCommand addUnitCommand() {
     }
 
     private void sleep(final int millis) {
-        try{
+        try {
             Thread.sleep(millis);
-        }
-        catch (Exception ignored) {
+        } catch (Exception ignored) {
         }
     }
 }
diff --git a/src/main/java/bwapi/ClientData.java b/src/main/java/bwapi/ClientData.java
@@ -1,9 +1,10 @@
 package bwapi;
-import java.nio.ByteBuffer;
+
 final class ClientData {
     final WrappedBuffer buffer;
-    ClientData(final ByteBuffer buffer) {
-        this.buffer = new WrappedBuffer(buffer);
+
+    ClientData(final WrappedBuffer buffer) {
+        this.buffer = buffer;
     }
     class UnitCommand {
         static final int SIZE = 24;
diff --git a/src/main/java/bwapi/GameTable.java b/src/main/java/bwapi/GameTable.java
@@ -1,7 +1,5 @@
 package bwapi;
 
-import java.nio.ByteBuffer;
-
 /**
  * https://github.com/bwapi/bwapi/blob/456ad612abc84da4103162ba0bf8ec4f053a4b1d/bwapi/include/BWAPI/Client/GameTable.h
  */
@@ -29,12 +27,12 @@ class GameTable {
 
     final GameInstance[] gameInstances;
 
-    GameTable(final ByteBuffer gameTableFileHandle) {
+    GameTable(final WrappedBuffer gameTableFileHandle) {
         gameInstances = new GameInstance[MAX_GAME_INSTANCES];
 
         for (int i = 0; i < MAX_GAME_INSTANCES; i++) {
             int serverProcessID = gameTableFileHandle.getInt(GameInstance.SIZE * i);
-            boolean isConnected = gameTableFileHandle.get(GameInstance.SIZE * i + 4) != 0;
+            boolean isConnected = gameTableFileHandle.getByte(GameInstance.SIZE * i + 4) != 0;
             int lastKeepAliveTime = gameTableFileHandle.getInt(GameInstance.SIZE * i + 4 + 4);
             gameInstances[i] = new GameInstance(serverProcessID, isConnected, lastKeepAliveTime);
         }
diff --git a/src/main/java/bwapi/WrappedBuffer.java b/src/main/java/bwapi/WrappedBuffer.java
@@ -1,36 +1,42 @@
 package bwapi;
 
+import com.sun.jna.Memory;
+import com.sun.jna.Pointer;
 import sun.misc.Unsafe;
-import sun.nio.ch.DirectBuffer;
 
 import java.lang.reflect.Field;
 import java.nio.ByteBuffer;
 
 /**
- * Wrapper around ByteBuffer that makes use of sun.misc.Unsafe if available.
+ * Wrapper around offheap memory that uses sun.misc.Unsafe for fast access.
  */
 class WrappedBuffer {
     private final ByteBuffer buffer;
     private final long address;
-    private final Unsafe unsafe;
 
-    WrappedBuffer(final ByteBuffer byteBuffer) {
-        unsafe = getTheUnsafe();
-        buffer = byteBuffer;
-        address = ((DirectBuffer) buffer).address();
-    }
+    private static Unsafe unsafe;
 
-    private static Unsafe getTheUnsafe() {
+    static {
         try {
             final Field theUnsafe = Unsafe.class.getDeclaredField("theUnsafe");
             theUnsafe.setAccessible(true);
-            return (Unsafe) theUnsafe.get(null);
+            unsafe = (Unsafe) theUnsafe.get(null);
+
         } catch (final Exception e) {
             e.printStackTrace();
-            return null;
+            System.exit(-1);
         }
     }
 
+    WrappedBuffer(final int size) {
+        this(new Memory(size), size);
+    }
+
+    WrappedBuffer(final Pointer pointer, final int size) {
+        this.buffer = pointer.getByteBuffer(0, size);
+        this.address = Pointer.nativeValue(pointer);
+    }
+
     byte getByte(final int offset) {
         return unsafe.getByte(address + offset);
     }
@@ -64,7 +70,7 @@ void putDouble(final int offset, final double value) {
     }
 
     String getString(final int offset, final int maxLen) {
-        char[] buf = new char[maxLen];
+        final char[] buf = new char[maxLen];
         long pos = offset + address;
         for (int i = 0; i < maxLen; i++) {
             byte b = unsafe.getByte(pos);
@@ -76,11 +82,8 @@ String getString(final int offset, final int maxLen) {
     }
 
     void putString(final int offset, final int maxLen, final String string) {
-        if (string.length() >= maxLen) {
-            throw new StringIndexOutOfBoundsException();
-        }
         long pos = offset + address;
-        for (int i = 0; i < string.length(); i++) {
+        for (int i = 0; i < Math.min(string.length(), maxLen - 1); i++) {
             unsafe.putByte(pos, (byte) string.charAt(i));
             pos++;
         }
diff --git a/src/test/java/DumpToClient.java b/src/test/java/DumpToClient.java
@@ -90,11 +90,12 @@ public static void main(String[] args) throws IOException {
         StringWriter sw = new StringWriter();
         try (PrintWriter out = new PrintWriter(sw)) {
             out.println("package bwapi;");
-            out.println("import java.nio.ByteBuffer;");
+            out.println("");
             out.println("final class ClientData {");
             out.println("    final WrappedBuffer buffer;");
-            out.println("    ClientData(final ByteBuffer buffer) {");
-            out.println("        this.buffer = new WrappedBuffer(buffer);");
+            out.println("");
+            out.println("    ClientData(final WrappedBuffer buffer) {");
+            out.println("        this.buffer = buffer;");
             out.println("    }");
             structs.values().forEach(s -> {
                 out.printf("    class %s {\n", s.name);
diff --git a/src/test/java/bwapi/ClientDataBenchmark.java b/src/test/java/bwapi/ClientDataBenchmark.java
@@ -3,7 +3,6 @@
 import org.openjdk.jmh.annotations.*;
 import org.openjdk.jmh.infra.Blackhole;
 
-import java.nio.ByteBuffer;
 import java.util.SplittableRandom;
 import java.util.stream.Collectors;
 
@@ -19,7 +18,7 @@ public static class EmptyState {
 
         @Setup(Level.Invocation)
         public void setup() {
-            client = new Client(ByteBuffer.allocateDirect(ClientData.GameData.SIZE));
+            client = new Client(new WrappedBuffer(ClientData.GameData.SIZE));
             game = new Game(client);
             strings = buildStrings();
         }
@@ -34,7 +33,7 @@ public static class FilledWithStrings {
 
         @Setup(Level.Invocation)
         public void setup() {
-            client = new Client(ByteBuffer.allocateDirect(ClientData.GameData.SIZE));
+            client = new Client(new WrappedBuffer(ClientData.GameData.SIZE));
             data = client.gameData();
             game = new Game(client);
             String[] strings = buildStrings();
diff --git a/src/test/java/bwapi/GameBuilder.java b/src/test/java/bwapi/GameBuilder.java
@@ -2,8 +2,6 @@
 
 import java.io.ByteArrayOutputStream;
 import java.io.IOException;
-import java.nio.Buffer;
-import java.nio.ByteBuffer;
 import java.nio.file.Files;
 import java.nio.file.Paths;
 import java.util.zip.InflaterOutputStream;
@@ -15,20 +13,20 @@ public static Game createGame() throws IOException {
     }
 
     public static Game createGame(String mapName) throws IOException {
-        final ByteBuffer buffer = binToBuffer("src/test/resources/" + mapName + "_frame0_buffer.bin");
+        final WrappedBuffer buffer = binToBuffer("src/test/resources/" + mapName + "_frame0_buffer.bin");
         return createGame(new Client(buffer));
     }
 
-    public static ByteBuffer binToBuffer(String binLocation) throws IOException {
+    public static WrappedBuffer binToBuffer(String binLocation) throws IOException {
         final byte[] compressedBytes = Files.readAllBytes(Paths.get(binLocation));
         final ByteArrayOutputStream out = new ByteArrayOutputStream();
         final InflaterOutputStream zin = new InflaterOutputStream(out);
         zin.write(compressedBytes);
         zin.flush();
         zin.close();
         final byte[] bytes = out.toByteArray();
-        final ByteBuffer buffer = ByteBuffer.allocateDirect(bytes.length);
-        buffer.put(bytes);
+        final WrappedBuffer buffer = new WrappedBuffer(bytes.length);
+        buffer.getBuffer().put(bytes);
         return buffer;
     }
 
diff --git a/src/test/java/bwapi/GameTest.java b/src/test/java/bwapi/GameTest.java
diff --git a/src/test/java/bwapi/WrappedBufferTest.java b/src/test/java/bwapi/WrappedBufferTest.java
