Was getting memory allocation exceptions when replacing FrameBuffer's direct ByteBuffers on successive games, due either to fragmentation or leaking (or both). Now reusing the FrameBuffer across games so we only have to allocate once, for the first game. Replaced some unnecessary references to ClientData with GameData. Cleaned up BWClient game loop.

dgant · dgant · commit 5c9dc3658c19 · 2020-07-30T16:41:00.000-04:00
diff --git a/src/main/java/bwapi/BWClient.java b/src/main/java/bwapi/BWClient.java
@@ -46,28 +46,28 @@ public void startGame(boolean autoContinue) {
      */
     public void startGame(BWClientConfiguration configuration) {
         configuration.validate();
+        botWrapper = new BotWrapper(configuration, eventListener);
         Client client = new Client(configuration);
         client.reconnect();
 
         do {
-            ClientData liveClientData = client.clientData();
-            ClientData.GameData liveGameData = liveClientData.gameData();
             System.out.println("Client: Beginning game loop");
+            ClientData.GameData liveGameData = client.clientData().gameData();
             while (!liveGameData.isInGame()) {
-                botWrapper = null;
                 if (client.isConnected()) {
                     System.out.println("Client: Not in game; Connected.");
                 } else  {
                     System.out.println("Client: Not in game; Not connected.");
                     return;
                 }
                 client.update();
+                if (liveGameData.isInGame()) {
+                    botWrapper.initialize(client.mapFile());
+                }
             }
             while (liveGameData.isInGame()) {
                 System.out.println("Client: In game on frame " + liveGameData.getFrameCount());
-                if (botWrapper == null) {
-                    botWrapper = new BotWrapper(configuration, eventListener, client.mapFile());
-                }
+
                 botWrapper.step();
 
                 // Proceed immediately once frame buffer is empty
@@ -83,16 +83,14 @@ public void startGame(BWClientConfiguration configuration) {
                 }
 
                 System.out.println("Client: Sending commands on frame " + liveGameData.getFrameCount());
-                getGame().sideEffects.flushTo(liveClientData);
+                getGame().sideEffects.flushTo(liveGameData);
                 client.update();
                 if (!client.isConnected()) {
                     System.out.println("Reconnecting...");
                     client.reconnect();
                 }
             }
-
             // TODO: Before exiting give async bot time to complete onEnd(), maybe via thread.join().
-
         } while (configuration.autoContinue); // lgtm [java/constant-loop-condition]
     }
 }
diff --git a/src/main/java/bwapi/BotWrapper.java b/src/main/java/bwapi/BotWrapper.java
@@ -34,29 +34,38 @@ of this software and associated documentation files (the "Software"), to deal
  * Manages invocation of bot event handlers
  */
 class BotWrapper {
+    private final ClientData liveClientData = new ClientData();
     private final BWClientConfiguration configuration;
     private final BWEventListener eventListener;
-    private final Game game;
-    private FrameBuffer frameBuffer = null;
-    private Thread botThread = null;
+    private final FrameBuffer frameBuffer;
+    private Game game;
+    private Thread botThread;
     private boolean idle = false;
 
     Lock idleLock = new ReentrantLock();
     Condition idleCondition = idleLock.newCondition();
 
-    BotWrapper(BWClientConfiguration configuration, BWEventListener eventListener, ByteBuffer dataSource) {
+    BotWrapper(BWClientConfiguration configuration, BWEventListener eventListener) {
         this.configuration = configuration;
         this.eventListener = eventListener;
+        frameBuffer = configuration.async ? new FrameBuffer(configuration.asyncFrameBufferSize) : null;
+    }
 
-        ClientData currentClientData = new ClientData();
-        currentClientData.setBuffer(dataSource);
-        game = new Game(currentClientData);
-
-        if (configuration.async) {
-            frameBuffer = new FrameBuffer(configuration.asyncFrameBufferSize, dataSource);
-        }
+    /**
+     * Resets the BotWrapper for a new game.
+     */
+    void initialize(ByteBuffer dataSource) {
+        frameBuffer.initialize(dataSource);
+        game = new Game(liveClientData);
+        liveClientData.setBuffer(dataSource);
+        botThread = null;
+        idle = false;
     }
 
+    /**
+     * @return The Game object used by the bot
+     * In asynchronous mode this Game object may point at a copy of a previous frame.
+     */
     Game getGame() {
         return game;
     }
diff --git a/src/main/java/bwapi/FrameBuffer.java b/src/main/java/bwapi/FrameBuffer.java
@@ -49,14 +49,22 @@ class FrameBuffer {
     final Condition conditionFull = lockCapacity.newCondition();
     final Condition conditionEmpty = lockCapacity.newCondition();
 
-    FrameBuffer(int size, ByteBuffer source) {
+    FrameBuffer(int size) {
         this.size = size;
-        this.dataSource = source;
         while(dataBuffer.size() < size) {
             dataBuffer.add(ByteBuffer.allocateDirect(ClientData.GameData.SIZE));
         }
     }
 
+    /**
+     * Resets for a new game
+     */
+    void initialize(ByteBuffer dataSource) {
+        this.dataSource = dataSource;
+        stepGame = 0;
+        stepBot = 0;
+    }
+
     /**
      * @return The number of frames currently buffered ahead of the bot's current frame
      */
diff --git a/src/main/java/bwapi/SideEffect.java b/src/main/java/bwapi/SideEffect.java
@@ -1,26 +1,25 @@
 package bwapi;
 
 import java.util.function.Consumer;
-import java.util.function.Function;
 
 /**
 * A side effect is an interaction that a bot attempts to have with the game.
 * This entails sending a game or unit command, or drawing a shape.
 */
 class SideEffect {
 
-    private Consumer<ClientData> application;
+    private Consumer<ClientData.GameData> application;
 
-    void apply(ClientData clientData) {
-        application.accept(clientData);
+    void apply(ClientData.GameData gameData) {
+        application.accept(gameData);
     }
 
     private SideEffect() {}
 
     static SideEffect addUnitCommand(final int type, final int unit, final int target, final int x, final int y, final int extra) {
         SideEffect output = new SideEffect();
-        output.application = (ClientData clientData) -> {
-            ClientData.UnitCommand unitCommand = GameDataUtils.addUnitCommand(clientData.gameData());
+        output.application = (ClientData.GameData gameData) -> {
+            ClientData.UnitCommand unitCommand = GameDataUtils.addUnitCommand(gameData);
             unitCommand.setTid(type);
             unitCommand.setUnitIndex(unit);
             unitCommand.setTargetIndex(target);
@@ -33,8 +32,8 @@ static SideEffect addUnitCommand(final int type, final int unit, final int targe
 
     static SideEffect addCommand(final CommandType type, final int value1, final int value2) {
         SideEffect output = new SideEffect();
-        output.application = (ClientData clientData) -> {
-            ClientData.Command command = GameDataUtils.addCommand(clientData.gameData());
+        output.application = (ClientData.GameData gameData) -> {
+            ClientData.Command command = GameDataUtils.addCommand(gameData);
             command.setType(type);
             command.setValue1(value1);
             command.setValue2(value2);
@@ -44,19 +43,19 @@ static SideEffect addCommand(final CommandType type, final int value1, final int
 
     static SideEffect addCommand(final CommandType type, final String text, final int value2) {
         SideEffect output = new SideEffect();
-        output.application = (ClientData clientData) -> {
-            ClientData.Command command = GameDataUtils.addCommand(clientData.gameData());
+        output.application = (ClientData.GameData gameData) -> {
+            ClientData.Command command = GameDataUtils.addCommand(gameData);
             command.setType(type);
-            command.setValue1(GameDataUtils.addString(clientData.gameData(), text));
+            command.setValue1(GameDataUtils.addString(gameData, text));
             command.setValue2(value2);
         };
         return output;
     }
 
     static SideEffect addShape(final ShapeType type, final CoordinateType coordType, final int x1, final int y1, final int x2, final int y2, final int extra1, final int extra2, final int color, final boolean isSolid) {
         SideEffect output = new SideEffect();
-        output.application = (ClientData clientData) -> {
-            ClientData.Shape shape = GameDataUtils.addShape(clientData.gameData());
+        output.application = (ClientData.GameData gameData) -> {
+            ClientData.Shape shape = GameDataUtils.addShape(gameData);
             shape.setType(type);
             shape.setCtype(coordType);
             shape.setX1(x1);
@@ -73,15 +72,15 @@ static SideEffect addShape(final ShapeType type, final CoordinateType coordType,
 
     static SideEffect addShape(final ShapeType type, final CoordinateType coordType, final int x1, final int y1, final int x2, final int y2, final String text, final int extra2, final int color, final boolean isSolid) {
         SideEffect output = new SideEffect();
-        output.application = (ClientData clientData) -> {
-            ClientData.Shape shape = GameDataUtils.addShape(clientData.gameData());
+        output.application = (ClientData.GameData gameData) -> {
+            ClientData.Shape shape = GameDataUtils.addShape(gameData);
             shape.setType(type);
             shape.setCtype(coordType);
             shape.setX1(x1);
             shape.setY1(y1);
             shape.setX2(x2);
             shape.setY2(y2);
-            shape.setExtra1(GameDataUtils.addString(clientData.gameData(), text));
+            shape.setExtra1(GameDataUtils.addString(gameData, text));
             shape.setExtra2(extra2);
             shape.setColor(color);
             shape.setIsSolid(isSolid);
diff --git a/src/main/java/bwapi/SideEffectQueue.java b/src/main/java/bwapi/SideEffectQueue.java
@@ -22,11 +22,11 @@ synchronized void enqueue(SideEffect sideEffect) {
     /**
      * Applies all enqueued side effects to the current BWAPI frame.
      *
-     * @param liveClientData
+     * @param liveGameData
      * The live game frame's data, using the BWAPI shared memory.
      */
-    synchronized void flushTo(ClientData liveClientData) {
-        queue.forEach(x -> x.apply(liveClientData));
+    synchronized void flushTo(ClientData.GameData liveGameData) {
+        queue.forEach(x -> x.apply(liveGameData));
         queue.clear();
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -22,11 +22,11 @@ synchronized void enqueue(SideEffect sideEffect) {`
`22`	`22`	`/**`
`23`	`23`	`* Applies all enqueued side effects to the current BWAPI frame.`
`24`	`24`	`*`
`25`		`- * @param liveClientData`
	`25`	`+ * @param liveGameData`
`26`	`26`	`* The live game frame's data, using the BWAPI shared memory.`
`27`	`27`	`*/`
`28`		`- synchronized void flushTo(ClientData liveClientData) {`
`29`		`- queue.forEach(x -> x.apply(liveClientData));`
	`28`	`+ synchronized void flushTo(ClientData.GameData liveGameData) {`
	`29`	`+ queue.forEach(x -> x.apply(liveGameData));`
`30`	`30`	`queue.clear();`
`31`	`31`	`}`
`32`	`32`	`}`