1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
|
/*
* Copyright (c) 2022, 2024, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
/*
* @test
* @library ../ /test/lib
* @run testng/othervm --enable-native-access=ALL-UNNAMED TestCaptureCallState
*/
import org.testng.annotations.DataProvider;
import org.testng.annotations.Test;
import java.lang.foreign.Arena;
import java.lang.foreign.FunctionDescriptor;
import java.lang.foreign.Linker;
import java.lang.foreign.MemoryLayout;
import java.lang.foreign.MemorySegment;
import java.lang.foreign.StructLayout;
import java.lang.invoke.MethodHandle;
import java.lang.invoke.VarHandle;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.function.Consumer;
import static java.lang.foreign.MemoryLayout.PathElement.groupElement;
import static java.lang.foreign.ValueLayout.JAVA_DOUBLE;
import static java.lang.foreign.ValueLayout.JAVA_INT;
import static java.lang.foreign.ValueLayout.JAVA_LONG;
import static org.testng.Assert.assertEquals;
import static org.testng.Assert.assertTrue;
public class TestCaptureCallState extends NativeTestHelper {
static {
System.loadLibrary("CaptureCallState");
if (IS_WINDOWS) {
String system32 = System.getenv("SystemRoot") + "\\system32";
System.load(system32 + "\\Kernel32.dll");
System.load(system32 + "\\Ws2_32.dll");
}
}
private record SaveValuesCase(String nativeTarget, FunctionDescriptor nativeDesc, String threadLocalName,
Consumer<Object> resultCheck, boolean critical) {}
@Test(dataProvider = "cases")
public void testSavedThreadLocal(SaveValuesCase testCase) throws Throwable {
List<Linker.Option> options = new ArrayList<>();
options.add(Linker.Option.captureCallState(testCase.threadLocalName()));
if (testCase.critical()) {
options.add(Linker.Option.critical(false));
}
MethodHandle handle = downcallHandle(testCase.nativeTarget(), testCase.nativeDesc(),
options.toArray(Linker.Option[]::new));
StructLayout capturedStateLayout = Linker.Option.captureStateLayout();
VarHandle errnoHandle = capturedStateLayout.varHandle(groupElement(testCase.threadLocalName()));
try (Arena arena = Arena.ofConfined()) {
MemorySegment saveSeg = arena.allocate(capturedStateLayout);
int testValue = 42;
boolean needsAllocator = testCase.nativeDesc().returnLayout().map(StructLayout.class::isInstance).orElse(false);
Object result = needsAllocator
? handle.invoke(arena, saveSeg, testValue)
: handle.invoke(saveSeg, testValue);
testCase.resultCheck().accept(result);
int savedErrno = (int) errnoHandle.get(saveSeg, 0L);
assertEquals(savedErrno, testValue);
}
}
@Test(dataProvider = "invalidCaptureSegmentCases")
public void testInvalidCaptureSegment(MemorySegment captureSegment,
Class<?> expectedExceptionType, String expectedExceptionMessage,
Linker.Option[] extraOptions) {
List<Linker.Option> options = new ArrayList<>();
options.add(Linker.Option.captureCallState("errno"));
for (Linker.Option extra : extraOptions) {
options.add(extra);
}
MethodHandle handle = downcallHandle("set_errno_V", FunctionDescriptor.ofVoid(C_INT), options.toArray(Linker.Option[]::new));
try {
int testValue = 42;
handle.invoke(captureSegment, testValue); // should throw
} catch (Throwable t) {
assertTrue(expectedExceptionType.isInstance(t));
assertTrue(t.getMessage().matches(expectedExceptionMessage));
}
}
@DataProvider
public static Object[][] cases() {
List<SaveValuesCase> cases = new ArrayList<>();
for (boolean critical : new boolean[]{ true, false }) {
cases.add(new SaveValuesCase("set_errno_V", FunctionDescriptor.ofVoid(JAVA_INT),
"errno", o -> {}, critical));
cases.add(new SaveValuesCase("set_errno_I", FunctionDescriptor.of(JAVA_INT, JAVA_INT),
"errno", o -> assertEquals((int) o, 42), critical));
cases.add(new SaveValuesCase("set_errno_D", FunctionDescriptor.of(JAVA_DOUBLE, JAVA_INT),
"errno", o -> assertEquals((double) o, 42.0), critical));
cases.add(structCase("SL", Map.of(JAVA_LONG.withName("x"), 42L), critical));
cases.add(structCase("SLL", Map.of(JAVA_LONG.withName("x"), 42L,
JAVA_LONG.withName("y"), 42L), critical));
cases.add(structCase("SLLL", Map.of(JAVA_LONG.withName("x"), 42L,
JAVA_LONG.withName("y"), 42L,
JAVA_LONG.withName("z"), 42L), critical));
cases.add(structCase("SD", Map.of(JAVA_DOUBLE.withName("x"), 42D), critical));
cases.add(structCase("SDD", Map.of(JAVA_DOUBLE.withName("x"), 42D,
JAVA_DOUBLE.withName("y"), 42D), critical));
cases.add(structCase("SDDD", Map.of(JAVA_DOUBLE.withName("x"), 42D,
JAVA_DOUBLE.withName("y"), 42D,
JAVA_DOUBLE.withName("z"), 42D), critical));
if (IS_WINDOWS) {
cases.add(new SaveValuesCase("SetLastError", FunctionDescriptor.ofVoid(JAVA_INT),
"GetLastError", o -> {}, critical));
cases.add(new SaveValuesCase("WSASetLastError", FunctionDescriptor.ofVoid(JAVA_INT),
"WSAGetLastError", o -> {}, critical));
}
}
return cases.stream().map(tc -> new Object[] {tc}).toArray(Object[][]::new);
}
static SaveValuesCase structCase(String name, Map<MemoryLayout, Object> fields, boolean critical) {
StructLayout layout = MemoryLayout.structLayout(fields.keySet().toArray(MemoryLayout[]::new));
Consumer<Object> check = o -> {};
for (var field : fields.entrySet()) {
MemoryLayout fieldLayout = field.getKey();
VarHandle fieldHandle = layout.varHandle(MemoryLayout.PathElement.groupElement(fieldLayout.name().get()));
Object value = field.getValue();
check = check.andThen(o -> assertEquals(fieldHandle.get(o, 0L), value));
}
return new SaveValuesCase("set_errno_" + name, FunctionDescriptor.of(layout, JAVA_INT),
"errno", check, critical);
}
@DataProvider
public static Object[][] invalidCaptureSegmentCases() {
return new Object[][]{
{Arena.ofAuto().allocate(1), IndexOutOfBoundsException.class, ".*Out of bound access on segment.*", new Linker.Option[0]},
{MemorySegment.NULL, IllegalArgumentException.class, ".*Capture segment is NULL.*", new Linker.Option[0]},
{Arena.ofAuto().allocate(Linker.Option.captureStateLayout().byteSize() + 3).asSlice(3), // misaligned
IllegalArgumentException.class, ".*Target offset incompatible with alignment constraints.*", new Linker.Option[0]},
{MemorySegment.ofArray(new byte[(int) Linker.Option.captureStateLayout().byteSize()]), // misaligned
IllegalArgumentException.class, ".*Target offset incompatible with alignment constraints.*", new Linker.Option[0]},
};
}
}
|
