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
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
|
/*
* Copyright (c) 2023, 2025, 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/native --enable-native-access=ALL-UNNAMED TestCritical
*/
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.SegmentAllocator;
import java.lang.foreign.SequenceLayout;
import java.lang.foreign.StructLayout;
import java.lang.foreign.ValueLayout;
import java.lang.invoke.MethodHandle;
import java.lang.invoke.VarHandle;
import java.util.ArrayList;
import java.util.List;
import java.util.function.IntFunction;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import static org.testng.Assert.assertEquals;
public class TestCritical extends NativeTestHelper {
static final MemoryLayout CAPTURE_STATE_LAYOUT = Linker.Option.captureStateLayout();
static final VarHandle ERRNO_HANDLE = CAPTURE_STATE_LAYOUT.varHandle(MemoryLayout.PathElement.groupElement("errno"));
static {
System.loadLibrary("Critical");
}
@Test
public void testEmpty() throws Throwable {
MethodHandle handle = downcallHandle("empty", FunctionDescriptor.ofVoid(), Linker.Option.critical(false));
handle.invokeExact();
}
@Test
public void testIdentity() throws Throwable {
MethodHandle handle = downcallHandle("identity", FunctionDescriptor.of(C_INT, C_INT), Linker.Option.critical(false));
int result = (int) handle.invokeExact(42);
assertEquals(result, 42);
}
@Test
public void testWithReturnBuffer() throws Throwable {
StructLayout bigLayout = MemoryLayout.structLayout(
C_LONG_LONG.withName("x"),
C_LONG_LONG.withName("y"));
MethodHandle handle = downcallHandle("with_return_buffer", FunctionDescriptor.of(bigLayout), Linker.Option.critical(false));
VarHandle vhX = bigLayout.varHandle(MemoryLayout.PathElement.groupElement("x"));
VarHandle vhY = bigLayout.varHandle(MemoryLayout.PathElement.groupElement("y"));
try (Arena arena = Arena.ofConfined()) {
MemorySegment result = (MemorySegment) handle.invokeExact((SegmentAllocator) arena);
long x = (long) vhX.get(result, 0L);
assertEquals(x, 10);
long y = (long) vhY.get(result, 0L);
assertEquals(y, 11);
}
}
public record AllowHeapCase(IntFunction<MemorySegment> newArraySegment, ValueLayout elementLayout,
String fName, FunctionDescriptor fDesc, boolean readOnly, boolean captureErrno) {}
@Test(dataProvider = "allowHeapCases")
public void testAllowHeap(AllowHeapCase testCase) throws Throwable {
List<Linker.Option> options = new ArrayList<>();
options.add(Linker.Option.critical(true));
if (testCase.captureErrno()) {
options.add(Linker.Option.captureCallState("errno"));
}
MethodHandle handle = downcallHandle(testCase.fName(), testCase.fDesc(), options.toArray(Linker.Option[]::new));
int elementCount = 10;
MemorySegment heapSegment = testCase.newArraySegment().apply(elementCount);
if (testCase.readOnly()) {
heapSegment = heapSegment.asReadOnly();
}
SequenceLayout sequence = MemoryLayout.sequenceLayout(elementCount, testCase.elementLayout());
try (Arena arena = Arena.ofConfined()) {
TestValue[] tvs = genTestArgs(testCase.fDesc(), arena);
List<Object> args = Stream.of(tvs).map(TestValue::value).collect(Collectors.toCollection(ArrayList::new));
MemorySegment captureSegment = testCase.captureErrno()
? MemorySegment.ofArray(new int[((int) CAPTURE_STATE_LAYOUT.byteSize() + 3) / 4])
: null;
// inject our custom last three arguments
args.set(args.size() - 1, (int) sequence.byteSize());
TestValue sourceSegment = genTestValue(sequence, arena);
args.set(args.size() - 2, sourceSegment.value());
args.set(args.size() - 3, heapSegment);
if (testCase.captureErrno()) {
args.add(0, captureSegment);
}
if (handle.type().parameterType(0) == SegmentAllocator.class) {
args.add(0, arena);
}
Object o = handle.invokeWithArguments(args);
if (o != null) {
tvs[0].check(o);
}
// check that writes went through to array
sourceSegment.check(heapSegment);
if (testCase.captureErrno()) {
int errno = (int) ERRNO_HANDLE.get(captureSegment, 0L);
assertEquals(errno, 42);
}
}
}
@DataProvider
public Object[][] allowHeapCases() {
FunctionDescriptor voidDesc = FunctionDescriptor.ofVoid(C_POINTER, C_POINTER, C_INT);
FunctionDescriptor intDesc = voidDesc.changeReturnLayout(C_INT).insertArgumentLayouts(0, C_INT);
StructLayout L2 = MemoryLayout.structLayout(
C_LONG_LONG.withName("x"),
C_LONG_LONG.withName("y")
);
FunctionDescriptor L2Desc = voidDesc.changeReturnLayout(L2).insertArgumentLayouts(0, L2);
StructLayout L3 = MemoryLayout.structLayout(
C_LONG_LONG.withName("x"),
C_LONG_LONG.withName("y"),
C_LONG_LONG.withName("z")
);
FunctionDescriptor L3Desc = voidDesc.changeReturnLayout(L3).insertArgumentLayouts(0, L3);
FunctionDescriptor stackDesc = voidDesc.insertArgumentLayouts(0,
C_LONG_LONG, C_LONG_LONG, C_LONG_LONG, C_LONG_LONG,
C_LONG_LONG, C_LONG_LONG, C_LONG_LONG, C_LONG_LONG,
C_CHAR, C_SHORT, C_INT);
List<AllowHeapCase> cases = new ArrayList<>();
for (boolean doCapture : new boolean[]{ true, false }) {
for (HeapSegmentFactory hsf : HeapSegmentFactory.values()) {
cases.add(new AllowHeapCase(hsf.newArray, hsf.elementLayout, "test_allow_heap_void", voidDesc, false, doCapture));
cases.add(new AllowHeapCase(hsf.newArray, hsf.elementLayout, "test_allow_heap_int", intDesc, false, doCapture));
cases.add(new AllowHeapCase(hsf.newArray, hsf.elementLayout, "test_allow_heap_return_buffer", L2Desc, false, doCapture));
cases.add(new AllowHeapCase(hsf.newArray, hsf.elementLayout, "test_allow_heap_imr", L3Desc, false, doCapture));
cases.add(new AllowHeapCase(hsf.newArray, hsf.elementLayout, "test_allow_heap_void_stack", stackDesc, false, doCapture));
// readOnly
cases.add(new AllowHeapCase(hsf.newArray, hsf.elementLayout, "test_allow_heap_void", voidDesc, true, doCapture));
}
}
return cases.stream().map(e -> new Object[]{ e }).toArray(Object[][]::new);
}
private enum HeapSegmentFactory {
BYTE(i -> MemorySegment.ofArray(new byte[i]), ValueLayout.JAVA_BYTE),
SHORT(i -> MemorySegment.ofArray(new short[i]), ValueLayout.JAVA_SHORT),
CHAR(i -> MemorySegment.ofArray(new char[i]), ValueLayout.JAVA_CHAR),
INT(i -> MemorySegment.ofArray(new int[i]), ValueLayout.JAVA_INT),
LONG(i -> MemorySegment.ofArray(new long[i]), ValueLayout.JAVA_LONG),
FLOAT(i -> MemorySegment.ofArray(new float[i]), ValueLayout.JAVA_FLOAT),
DOUBLE(i -> MemorySegment.ofArray(new double[i]), ValueLayout.JAVA_DOUBLE);
IntFunction<MemorySegment> newArray;
ValueLayout elementLayout;
private HeapSegmentFactory(IntFunction<MemorySegment> newArray, ValueLayout elementLayout) {
this.newArray = newArray;
this.elementLayout = elementLayout;
}
}
}
|
