Skip to content

Commit 618862c

Browse files
JasperGeurtzJasperGeurtz
authored
Merge pull request #97 from dgant/develop
Make JBWAPI ready to connect as fast as possible
2 parents 0507796 + f8e3abf commit 618862c

5 files changed

Lines changed: 162 additions & 9 deletions

File tree

‎.github/workflows/maven.yml‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,3 +30,25 @@ jobs:
3030
run: mvn -B package --file pom.xml
3131
- name: Test with Maven
3232
run: mvn test
33+
34+
windows-java8-x86:
35+
name: Windows Java 8 x86
36+
runs-on: windows-latest
37+
steps:
38+
- uses: actions/checkout@v5
39+
- name: Set up the primary bot runtime
40+
uses: actions/setup-java@v5
41+
with:
42+
distribution: 'temurin'
43+
java-version: '8'
44+
architecture: 'x86'
45+
- name: Verify 32-bit Java 8
46+
shell: pwsh
47+
run: |
48+
$settings = (& java -XshowSettings:properties -version 2>&1 | Out-String)
49+
if ($settings -notmatch 'sun.arch.data.model\s*=\s*32' -or $settings -notmatch 'java.specification.version\s*=\s*1\.8') {
50+
throw 'Expected a 32-bit Java 8 JVM'
51+
}
52+
java -version
53+
- name: Build and test with Maven
54+
run: mvn -B package --file pom.xml

‎src/main/java/bwapi/BWClient.java‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -87,16 +87,17 @@ public void startGame(boolean autoContinue) {
8787
*/
8888
public void startGame(BWClientConfiguration gameConfiguration) {
8989
this.configuration = gameConfiguration;
90-
this.performanceMetrics = new PerformanceMetrics(configuration);
91-
botWrapper = configuration.getAsync()
92-
? new BotWrapperAsync(configuration, eventListener)
93-
: new BotWrapper(configuration, eventListener);
9490

9591
if (client == null) {
9692
client = new Client(this);
9793
}
9894
client.reconnect();
9995

96+
this.performanceMetrics = new PerformanceMetrics(configuration);
97+
botWrapper = configuration.getAsync()
98+
? new BotWrapperAsync(configuration, eventListener)
99+
: new BotWrapper(configuration, eventListener);
100+
100101
do {
101102
ClientData.GameData liveGameData = client.liveClientData().gameData();
102103
while (!liveGameData.isInGame()) {

‎src/main/java/bwapi/ClientConnectionW32.java‎

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22

33
import com.sun.jna.Native;
44
import com.sun.jna.Pointer;
5-
import com.sun.jna.platform.win32.Kernel32;
5+
import com.sun.jna.platform.win32.WinNT.HANDLE;
6+
import com.sun.jna.win32.StdCallLibrary;
67
import com.sun.jna.win32.W32APIOptions;
78

89
import java.io.FileNotFoundException;
@@ -15,10 +16,19 @@
1516
class ClientConnectionW32 implements ClientConnection {
1617
private static final int READ_WRITE = 0x1 | 0x2 | 0x4;
1718

18-
interface MappingKernel extends Kernel32 {
19-
MappingKernel INSTANCE = Native.load(MappingKernel.class, W32APIOptions.DEFAULT_OPTIONS);
19+
/**
20+
* Opens the BWAPI server's game table and game-state shared-memory mappings.
21+
* Binding only these two kernel32 functions avoids initializing JNA's full
22+
* Kernel32 proxy before the client can discover a server.
23+
* Measured savings: about 7% of startup time on Windows/Java 8 x86
24+
* with JNA 5.18.1 in fresh-JVM startup tests; actual savings depend on the machine.
25+
*/
26+
interface MappingKernel extends StdCallLibrary {
27+
MappingKernel INSTANCE = Native.load("kernel32", MappingKernel.class, W32APIOptions.DEFAULT_OPTIONS);
2028

2129
HANDLE OpenFileMapping(int desiredAccess, boolean inherit, String name);
30+
31+
Pointer MapViewOfFile(HANDLE mapping, int desiredAccess, int offsetHigh, int offsetLow, int bytesToMap);
2232
}
2333

2434

@@ -38,7 +48,7 @@ public void disconnect() {
3848

3949
@Override
4050
public WrappedBuffer getGameTable() {
41-
final Pointer gameTableView = Kernel32.INSTANCE.MapViewOfFile(MappingKernel.INSTANCE
51+
final Pointer gameTableView = MappingKernel.INSTANCE.MapViewOfFile(MappingKernel.INSTANCE
4252
.OpenFileMapping(READ_WRITE, false, "Local\\bwapi_shared_memory_game_list"), READ_WRITE,
4353
0, 0, GameTable.SIZE);
4454
return new WrappedBuffer(gameTableView, GameTable.SIZE);
@@ -48,7 +58,7 @@ public WrappedBuffer getGameTable() {
4858
public WrappedBuffer getSharedMemory(int serverProcID) {
4959
String sharedMemoryName = "Local\\bwapi_shared_memory_" + serverProcID;
5060
try {
51-
final Pointer mapFileView = Kernel32.INSTANCE.MapViewOfFile(MappingKernel.INSTANCE
61+
final Pointer mapFileView = MappingKernel.INSTANCE.MapViewOfFile(MappingKernel.INSTANCE
5262
.OpenFileMapping(READ_WRITE, false, sharedMemoryName), READ_WRITE,
5363
0, 0, ClientData.GameData.SIZE);
5464
return new WrappedBuffer(mapFileView, ClientData.GameData.SIZE);

‎src/test/java/bwapi/BWClientStartupTest.java‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
package bwapi;
2+
3+
import org.junit.Test;
4+
5+
import java.lang.management.BufferPoolMXBean;
6+
import java.lang.management.ManagementFactory;
7+
8+
import static org.junit.Assert.assertNull;
9+
import static org.junit.Assert.assertThrows;
10+
import static org.junit.Assert.assertTrue;
11+
import static org.mockito.Mockito.doAnswer;
12+
import static org.mockito.Mockito.mock;
13+
14+
/**
15+
* Guards the order of startup work: attempt the BWAPI connection before creating
16+
* performance metrics or allocating the large buffers used for asynchronous frames.
17+
* Measures direct-buffer allocation at a mocked connection boundary, so the test
18+
* needs neither a running server nor a machine-dependent elapsed-time threshold.
19+
*/
20+
public class BWClientStartupTest {
21+
// Stops startGame at the mocked connection boundary, before a game loop can run.
22+
private static class StopAfterConnectionAttempt extends RuntimeException {
23+
}
24+
25+
@Test
26+
public void attemptsConnectionBeforeAllocatingFrameBuffersOrMetrics() {
27+
BWClient bwClient = new BWClient(new DefaultBWListener());
28+
Client client = mock(Client.class);
29+
bwClient.setClient(client);
30+
BWClientConfiguration configuration = new BWClientConfiguration.Builder()
31+
.withAsync(true)
32+
.withAsyncFrameBufferCapacity(3)
33+
.build();
34+
BufferPoolMXBean directBuffers = ManagementFactory.getPlatformMXBeans(BufferPoolMXBean.class)
35+
.stream()
36+
.filter(pool -> "direct".equals(pool.getName()))
37+
.findFirst()
38+
.get();
39+
long bytesBeforeStart = directBuffers.getMemoryUsed();
40+
doAnswer(invocation -> {
41+
assertTrue("Connection attempts must precede allocation of even one game-state buffer",
42+
directBuffers.getMemoryUsed() - bytesBeforeStart < ClientData.GameData.SIZE);
43+
assertNull(bwClient.getPerformanceMetrics());
44+
throw new StopAfterConnectionAttempt();
45+
}).when(client).reconnect();
46+
47+
assertThrows(StopAfterConnectionAttempt.class, () -> bwClient.startGame(configuration));
48+
}
49+
}

‎src/test/java/bwapi/MappingKernelTest.java‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
package bwapi;
2+
3+
import com.sun.jna.Pointer;
4+
import com.sun.jna.platform.win32.Kernel32;
5+
import com.sun.jna.platform.win32.WinBase;
6+
import com.sun.jna.platform.win32.WinNT;
7+
import org.junit.Before;
8+
import org.junit.Test;
9+
10+
import static org.junit.Assert.assertEquals;
11+
import static org.junit.Assert.assertNotNull;
12+
import static org.junit.Assert.assertNull;
13+
import static org.junit.Assume.assumeTrue;
14+
15+
/**
16+
* Verifies the Windows mapping binding's JNA signatures against a real shared-memory object.
17+
* The existing JNA Kernel32 binding creates the mapping and its first view;
18+
* MappingKernel opens a second view. Reads and writes must agree in both directions.
19+
* A Unicode name checks Windows string marshalling, and a missing mapping must
20+
* return null. These tests require Windows but do not require a BWAPI server.
21+
*/
22+
public class MappingKernelTest {
23+
@Before
24+
public void requireWindows() {
25+
assumeTrue(System.getProperty("os.name").startsWith("Windows"));
26+
}
27+
28+
@Test
29+
public void opensUnicodeNamedMappingAndSharesWritesBetweenViews() {
30+
// Include Unicode to exercise the same W32API string mapping used by the client.
31+
String name = "Local\\jbwapi-mapping-\u03bb-" + System.nanoTime();
32+
int access = WinNT.SECTION_MAP_READ | WinNT.SECTION_MAP_WRITE;
33+
WinNT.HANDLE created = Kernel32.INSTANCE.CreateFileMapping(
34+
WinBase.INVALID_HANDLE_VALUE, null, WinNT.PAGE_READWRITE, 0, 4, name);
35+
assertNotNull(created);
36+
WinNT.HANDLE opened = null;
37+
Pointer originalView = null;
38+
Pointer clientView = null;
39+
try {
40+
originalView = Kernel32.INSTANCE.MapViewOfFile(created, access, 0, 0, 4);
41+
assertNotNull(originalView);
42+
originalView.setInt(0, 10003);
43+
44+
opened = ClientConnectionW32.MappingKernel.INSTANCE.OpenFileMapping(access, false, name);
45+
assertNotNull(opened);
46+
clientView = ClientConnectionW32.MappingKernel.INSTANCE.MapViewOfFile(opened, access, 0, 0, 4);
47+
assertNotNull(clientView);
48+
assertEquals(10003, clientView.getInt(0));
49+
50+
clientView.setInt(0, 42);
51+
assertEquals(42, originalView.getInt(0));
52+
} finally {
53+
if (clientView != null) {
54+
Kernel32.INSTANCE.UnmapViewOfFile(clientView);
55+
}
56+
if (originalView != null) {
57+
Kernel32.INSTANCE.UnmapViewOfFile(originalView);
58+
}
59+
if (opened != null) {
60+
Kernel32.INSTANCE.CloseHandle(opened);
61+
}
62+
Kernel32.INSTANCE.CloseHandle(created);
63+
}
64+
}
65+
66+
@Test
67+
public void returnsNullForMissingMapping() {
68+
assertNull(ClientConnectionW32.MappingKernel.INSTANCE.OpenFileMapping(
69+
WinNT.SECTION_MAP_READ, false, "Local\\jbwapi-missing-" + System.nanoTime()));
70+
}
71+
}

0 commit comments

Comments
 (0)