Added performance metric for frame duration which includes time to write to shared memory.

dgant · dgant · commit a333f1524a61 · 2020-09-25T17:04:44.000-04:00
diff --git a/src/main/java/bwapi/BWClient.java b/src/main/java/bwapi/BWClient.java
@@ -8,6 +8,7 @@
  * Client class to connect to the game with.
  */
 public class BWClient {
+    private BWClientConfiguration configuration = new BWClientConfiguration();
     private final BWEventListener eventListener;
     private BotWrapper botWrapper;
     private Client client;
@@ -35,6 +36,13 @@ public PerformanceMetrics getPerformanceMetrics() {
         return performanceMetrics;
     }
 
+    /**
+     * @return The current configuration
+     */
+    public BWClientConfiguration getConfiguration() {
+        return configuration;
+    }
+
     /**
      * @return The number of frames between the one exposed to the bot and the most recent received by JBWAPI.
      * This tracks the size of the frame buffer except when the game is paused (which results in multiple frames arriving with the same count).
@@ -73,10 +81,12 @@ public void startGame(boolean autoContinue) {
     /**
      * Start the game.
      *
-     * @param configuration Settings for playing games with this client.
+     * @param gameConfiguration Settings for playing games with this client.
      */
-    public void startGame(BWClientConfiguration configuration) {
-        configuration.validate();
+    public void startGame(BWClientConfiguration gameConfiguration) {
+        gameConfiguration.validate();
+        this.configuration = gameConfiguration;
+        this.performanceMetrics = new PerformanceMetrics(configuration);
         botWrapper = new BotWrapper(configuration, eventListener);
 
         // Use reduced priority to encourage Windows to give priority to StarCraft.exe/BWAPI.
@@ -87,7 +97,7 @@ public void startGame(BWClientConfiguration configuration) {
         }
 
         if (client == null) {
-            client = new Client(configuration);
+            client = new Client(this);
         }
         client.reconnect();
 
@@ -107,7 +117,8 @@ public void startGame(BWClientConfiguration configuration) {
                 boolean timeFrame = liveGameData.getFrameCount() > 0 || ! configuration.unlimitedFrameZero;
 
                 long ticksBefore = Kernel32.INSTANCE.GetTickCount();
-                performanceMetrics.totalFrameDuration.timeIf(
+                performanceMetrics.endToEndFrameDuration.startTiming();
+                performanceMetrics.jbwapiFrameDuration.timeIf(
                     timeFrame,
                     () -> {
                         botWrapper.onFrame();
@@ -116,7 +127,7 @@ public void startGame(BWClientConfiguration configuration) {
                 long ticksAfter = Kernel32.INSTANCE.GetTickCount();
                 if (timeFrame) {
                     long deltaTicks = ticksAfter - ticksBefore;
-                    long deltaMillis = (long) performanceMetrics.totalFrameDuration.runningTotal.last;
+                    long deltaMillis = (long) performanceMetrics.jbwapiFrameDuration.runningTotal.last;
                     long delta = deltaMillis - deltaTicks;
                     if (Math.abs(delta) > 1000) {
                         System.out.println("Got weird tick delta: " + ticksAfter + ", " + ticksBefore + ", " + deltaTicks + ", " + deltaMillis + ", " + delta);
diff --git a/src/main/java/bwapi/Client.java b/src/main/java/bwapi/Client.java
@@ -45,15 +45,14 @@ interface MappingKernel extends Kernel32 {
     private static final int SUPPORTED_BWAPI_VERSION = 10003;
 
     private ClientData clientData;
+    private BWClient bwClient;
     private boolean connected = false;
     private RandomAccessFile pipeObjectHandle = null;
     private ByteBuffer gameTableFileHandle = null;
     private ByteBuffer mapFileHandle = null;
 
-    private BWClientConfiguration configuration = new BWClientConfiguration();
-
-    Client(BWClientConfiguration configuration) {
-        this.configuration = configuration;
+    Client(BWClient bwClient) {
+        this.bwClient = bwClient;
     }
 
     /**
@@ -83,7 +82,7 @@ void reconnect() {
     }
 
     private void disconnect() {
-        if (configuration.debugConnection) {
+        if (bwClient.getConfiguration().debugConnection) {
             System.err.print("Disconnect called by: ");
             System.err.println(Thread.currentThread().getStackTrace()[2]);
         }
@@ -134,7 +133,7 @@ boolean connect() {
         }
         catch (Exception e) {
             System.err.println("Unable to map Game table.");
-            if (configuration.debugConnection) {
+            if (bwClient.getConfiguration().debugConnection) {
                 e.printStackTrace();
             }
             return false;
@@ -168,7 +167,7 @@ boolean connect() {
         }
         catch (Exception e) {
             System.err.println("Unable to open communications pipe: " + communicationPipe);
-            if (configuration.debugConnection) {
+            if (bwClient.getConfiguration().debugConnection) {
                 e.printStackTrace();
             }
             gameTableFileHandle = null;
@@ -184,7 +183,7 @@ boolean connect() {
         }
         catch (Exception e) {
             System.err.println("Unable to open shared memory mapping: " + sharedMemoryName);
-            if (configuration.debugConnection) {
+            if (bwClient.getConfiguration().debugConnection) {
                 e.printStackTrace();
             }
             pipeObjectHandle = null;
@@ -197,7 +196,7 @@ boolean connect() {
         }
         catch (Exception e) {
             System.err.println("Unable to map game data.");
-            if (configuration.debugConnection) {
+            if (bwClient.getConfiguration().debugConnection) {
                 e.printStackTrace();
             }
             return false;
@@ -218,7 +217,7 @@ boolean connect() {
             }
             catch (Exception e) {
                 System.err.println("Unable to read pipe object.");
-                if (configuration.debugConnection) {
+                if (bwClient.getConfiguration().debugConnection) {
                     e.printStackTrace();
                 }
                 disconnect();
@@ -232,18 +231,21 @@ boolean connect() {
     }
 
     void update() {
+        // Indicate that we are done with the current frame
         byte code = 1;
         try {
             pipeObjectHandle.writeByte(code);
+            bwClient.getPerformanceMetrics().endToEndFrameDuration.stopTiming();
         }
         catch (Exception e) {
             System.err.println("failed, disconnecting");
-            if (configuration.debugConnection) {
+            if (bwClient.getConfiguration().debugConnection) {
                 e.printStackTrace();
             }
             disconnect();
             return;
         }
+        // Wait for BWAPI to indicate that a new frame is ready
         while (code != 2) {
             try {
                 code = pipeObjectHandle.readByte();
@@ -257,7 +259,7 @@ void update() {
             }
             catch (Exception e) {
                 System.err.println("failed, disconnecting");
-                if (configuration.debugConnection) {
+                if (bwClient.getConfiguration().debugConnection) {
                     e.printStackTrace();
                 }
                 disconnect();
diff --git a/src/main/java/bwapi/PerformanceMetrics.java b/src/main/java/bwapi/PerformanceMetrics.java
@@ -6,11 +6,20 @@
 public class PerformanceMetrics {
 
     /**
-     * Total duration of the frame from JBWAPI's perspective.
-     * Likely to be at least a little bit of an undercount,
+     * Total duration of the frame from JBWAPI's perspective,
+     * exclusive of time modifying shared memory to indicate frame completion.
+     * Likely to be at least a little bit of an undercount from the perspective of BWAPI,
      * given that the tournament module is timing a superset of JBWAPI's execution time.
      */
-    PerformanceMetric totalFrameDuration;
+    PerformanceMetric jbwapiFrameDuration;
+
+    /**
+     * Total duration of the frame from JBWAPI's perspective,
+     * inclusive of time modifying shared memory to indicate frame completion.
+     * Likely to be at least a little bit of an undercount from the perspective of BWAPI,
+     * given that the tournament module is timing a superset of JBWAPI's execution time.
+     */
+    PerformanceMetric endToEndFrameDuration;
 
     /**
      * Time spent copying game data from system pipe shared memory to a frame buffer.
@@ -92,7 +101,8 @@ public class PerformanceMetrics {
     }
 
     public void reset() {
-        totalFrameDuration = new PerformanceMetric("JBWAPI frame duration", 5, 10, 15, 20, 25, 30, 35, 40, 45, 50, 55, 85);
+        jbwapiFrameDuration = new PerformanceMetric("JBWAPI frame duration", 5, 10, 15, 20, 25, 30, 35, 40, 45, 50, 55, 85);
+        endToEndFrameDuration = new PerformanceMetric("End-to-end frame duration", 5, 10, 15, 20, 25, 30, 35, 40, 45, 50, 55, 85);
         copyingToBuffer = new PerformanceMetric("Time copying to buffer", 5, 10, 15, 20, 25, 30);
         intentionallyBlocking = new PerformanceMetric("Blocking with full buffer", 0);
         frameBufferSize = new PerformanceMetric("Frames buffered", 0, 1);
@@ -111,7 +121,8 @@ public void reset() {
     @Override
     public String toString() {
         return "Performance metrics:"
-            + "\n" + totalFrameDuration.toString()
+            + "\n" + jbwapiFrameDuration.toString()
+            + "\n" + endToEndFrameDuration.toString()
             + "\n" + copyingToBuffer.toString()
             + "\n" + intentionallyBlocking.toString()
             + "\n" + frameBufferSize.toString()

Original file line number	Diff line number	Diff line change
`@@ -45,15 +45,14 @@ interface MappingKernel extends Kernel32 {`
`45`	`45`	`private static final int SUPPORTED_BWAPI_VERSION = 10003;`
`46`	`46`
`47`	`47`	`private ClientData clientData;`
	`48`	`+ private BWClient bwClient;`
`48`	`49`	`private boolean connected = false;`
`49`	`50`	`private RandomAccessFile pipeObjectHandle = null;`
`50`	`51`	`private ByteBuffer gameTableFileHandle = null;`
`51`	`52`	`private ByteBuffer mapFileHandle = null;`
`52`	`53`
`53`		`- private BWClientConfiguration configuration = new BWClientConfiguration();`
`54`		`-`
`55`		`- Client(BWClientConfiguration configuration) {`
`56`		`- this.configuration = configuration;`
	`54`	`+ Client(BWClient bwClient) {`
	`55`	`+ this.bwClient = bwClient;`
`57`	`56`	`}`
`58`	`57`
`59`	`58`	`/**`
`@@ -83,7 +82,7 @@ void reconnect() {`
`83`	`82`	`}`
`84`	`83`
`85`	`84`	`private void disconnect() {`
`86`		`- if (configuration.debugConnection) {`
	`85`	`+ if (bwClient.getConfiguration().debugConnection) {`
`87`	`86`	`System.err.print("Disconnect called by: ");`
`88`	`87`	`System.err.println(Thread.currentThread().getStackTrace()[2]);`
`89`	`88`	`}`
`@@ -134,7 +133,7 @@ boolean connect() {`
`134`	`133`	`}`
`135`	`134`	`catch (Exception e) {`
`136`	`135`	`System.err.println("Unable to map Game table.");`
`137`		`- if (configuration.debugConnection) {`
	`136`	`+ if (bwClient.getConfiguration().debugConnection) {`
`138`	`137`	`e.printStackTrace();`
`139`	`138`	`}`
`140`	`139`	`return false;`
`@@ -168,7 +167,7 @@ boolean connect() {`
`168`	`167`	`}`
`169`	`168`	`catch (Exception e) {`
`170`	`169`	`System.err.println("Unable to open communications pipe: " + communicationPipe);`
`171`		`- if (configuration.debugConnection) {`
	`170`	`+ if (bwClient.getConfiguration().debugConnection) {`
`172`	`171`	`e.printStackTrace();`
`173`	`172`	`}`
`174`	`173`	`gameTableFileHandle = null;`
`@@ -184,7 +183,7 @@ boolean connect() {`
`184`	`183`	`}`
`185`	`184`	`catch (Exception e) {`
`186`	`185`	`System.err.println("Unable to open shared memory mapping: " + sharedMemoryName);`
`187`		`- if (configuration.debugConnection) {`
	`186`	`+ if (bwClient.getConfiguration().debugConnection) {`
`188`	`187`	`e.printStackTrace();`
`189`	`188`	`}`
`190`	`189`	`pipeObjectHandle = null;`
`@@ -197,7 +196,7 @@ boolean connect() {`
`197`	`196`	`}`
`198`	`197`	`catch (Exception e) {`
`199`	`198`	`System.err.println("Unable to map game data.");`
`200`		`- if (configuration.debugConnection) {`
	`199`	`+ if (bwClient.getConfiguration().debugConnection) {`
`201`	`200`	`e.printStackTrace();`
`202`	`201`	`}`
`203`	`202`	`return false;`
`@@ -218,7 +217,7 @@ boolean connect() {`
`218`	`217`	`}`
`219`	`218`	`catch (Exception e) {`
`220`	`219`	`System.err.println("Unable to read pipe object.");`
`221`		`- if (configuration.debugConnection) {`
	`220`	`+ if (bwClient.getConfiguration().debugConnection) {`
`222`	`221`	`e.printStackTrace();`
`223`	`222`	`}`
`224`	`223`	`disconnect();`
`@@ -232,18 +231,21 @@ boolean connect() {`
`232`	`231`	`}`
`233`	`232`
`234`	`233`	`void update() {`
	`234`	`+ // Indicate that we are done with the current frame`
`235`	`235`	`byte code = 1;`
`236`	`236`	`try {`
`237`	`237`	`pipeObjectHandle.writeByte(code);`
	`238`	`+ bwClient.getPerformanceMetrics().endToEndFrameDuration.stopTiming();`
`238`	`239`	`}`
`239`	`240`	`catch (Exception e) {`
`240`	`241`	`System.err.println("failed, disconnecting");`
`241`		`- if (configuration.debugConnection) {`
	`242`	`+ if (bwClient.getConfiguration().debugConnection) {`
`242`	`243`	`e.printStackTrace();`
`243`	`244`	`}`
`244`	`245`	`disconnect();`
`245`	`246`	`return;`
`246`	`247`	`}`
	`248`	`+ // Wait for BWAPI to indicate that a new frame is ready`
`247`	`249`	`while (code != 2) {`
`248`	`250`	`try {`
`249`	`251`	`code = pipeObjectHandle.readByte();`
`@@ -257,7 +259,7 @@ void update() {`
`257`	`259`	`}`
`258`	`260`	`catch (Exception e) {`
`259`	`261`	`System.err.println("failed, disconnecting");`
`260`		`- if (configuration.debugConnection) {`
	`262`	`+ if (bwClient.getConfiguration().debugConnection) {`
`261`	`263`	`e.printStackTrace();`
`262`	`264`	`}`
`263`	`265`	`disconnect();`