jdk-24/test/jdk/java/foreign/TestScopedOperations.java
Maurizio Cimadamore e1f140d270 8287206: Use WrongThreadException for confinement errors
Reviewed-by: alanb, darcy, mchung
2022-05-25 09:50:55 +00:00

262 lines
12 KiB
Java

/*
* Copyright (c) 2021, 2022, 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
* @enablePreview
* @requires ((os.arch == "amd64" | os.arch == "x86_64") & sun.arch.data.model == "64") | os.arch == "aarch64"
* @run testng/othervm --enable-native-access=ALL-UNNAMED TestScopedOperations
*/
import java.lang.foreign.MemoryAddress;
import java.lang.foreign.MemoryLayout;
import java.lang.foreign.MemorySegment;
import java.lang.foreign.MemorySession;
import java.lang.foreign.SegmentAllocator;
import java.lang.foreign.VaList;
import java.lang.foreign.ValueLayout;
import org.testng.annotations.DataProvider;
import org.testng.annotations.Test;
import java.io.File;
import java.io.IOException;
import java.nio.channels.FileChannel;
import java.nio.file.Path;
import java.nio.file.StandardOpenOption;
import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.atomic.AtomicReference;
import java.util.function.Consumer;
import java.util.function.Function;
import static java.lang.foreign.ValueLayout.JAVA_BYTE;
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.assertNotNull;
import static org.testng.Assert.assertTrue;
import static org.testng.Assert.fail;
public class TestScopedOperations {
static Path tempPath;
static {
try {
File file = File.createTempFile("scopedBuffer", "txt");
file.deleteOnExit();
tempPath = file.toPath();
} catch (IOException ex) {
throw new ExceptionInInitializerError(ex);
}
}
@Test(dataProvider = "scopedOperations")
public <Z> void testOpAfterClose(String name, ScopedOperation<Z> scopedOperation) {
MemorySession session = MemorySession.openConfined();
Z obj = scopedOperation.apply(session);
session.close();
try {
scopedOperation.accept(obj);
fail();
} catch (IllegalStateException ex) {
assertTrue(ex.getMessage().contains("closed"));
}
}
@Test(dataProvider = "scopedOperations")
public <Z> void testOpOutsideConfinement(String name, ScopedOperation<Z> scopedOperation) {
try (MemorySession session = MemorySession.openConfined()) {
Z obj = scopedOperation.apply(session);
AtomicReference<Throwable> failed = new AtomicReference<>();
Thread t = new Thread(() -> {
try {
scopedOperation.accept(obj);
} catch (Throwable ex) {
failed.set(ex);
}
});
t.start();
t.join();
assertNotNull(failed.get());
assertEquals(failed.get().getClass(), WrongThreadException.class);
assertTrue(failed.get().getMessage().contains("outside"));
} catch (InterruptedException ex) {
throw new AssertionError(ex);
}
}
static List<ScopedOperation> scopedOperations = new ArrayList<>();
static {
// session operations
ScopedOperation.ofScope(session -> session.addCloseAction(() -> {
}), "MemorySession::addCloseAction");
ScopedOperation.ofScope(session -> MemorySegment.allocateNative(100, session), "MemorySegment::allocateNative");
ScopedOperation.ofScope(session -> {
try (FileChannel fileChannel = FileChannel.open(tempPath, StandardOpenOption.READ, StandardOpenOption.WRITE)) {
fileChannel.map(FileChannel.MapMode.READ_WRITE, 0L, 10L, session);
} catch (IOException ex) {
fail();
}
}, "FileChannel::map");
ScopedOperation.ofScope(session -> VaList.make(b -> b.addVarg(JAVA_INT, 42), session), "VaList::make");
ScopedOperation.ofScope(session -> VaList.ofAddress(MemoryAddress.ofLong(42), session), "VaList::make");
ScopedOperation.ofScope(SegmentAllocator::newNativeArena, "SegmentAllocator::arenaAllocator");
// segment operations
ScopedOperation.ofSegment(s -> s.toArray(JAVA_BYTE), "MemorySegment::toArray(BYTE)");
ScopedOperation.ofSegment(MemorySegment::address, "MemorySegment::address");
ScopedOperation.ofSegment(s -> s.copyFrom(s), "MemorySegment::copyFrom");
ScopedOperation.ofSegment(s -> s.mismatch(s), "MemorySegment::mismatch");
ScopedOperation.ofSegment(s -> s.fill((byte) 0), "MemorySegment::fill");
// valist operations
ScopedOperation.ofVaList(VaList::address, "VaList::address");
ScopedOperation.ofVaList(VaList::copy, "VaList::copy");
ScopedOperation.ofVaList(list -> list.nextVarg(ValueLayout.ADDRESS), "VaList::nextVarg/address");
ScopedOperation.ofVaList(list -> list.nextVarg(ValueLayout.JAVA_INT), "VaList::nextVarg/int");
ScopedOperation.ofVaList(list -> list.nextVarg(ValueLayout.JAVA_LONG), "VaList::nextVarg/long");
ScopedOperation.ofVaList(list -> list.nextVarg(ValueLayout.JAVA_DOUBLE), "VaList::nextVarg/double");
ScopedOperation.ofVaList(VaList::skip, "VaList::skip");
ScopedOperation.ofVaList(list -> list.nextVarg(MemoryLayout.structLayout(ValueLayout.JAVA_INT),
SegmentAllocator.prefixAllocator(MemorySegment.ofArray(new byte[4]))), "VaList::nextVargs/segment");
// allocator operations
ScopedOperation.ofAllocator(a -> a.allocate(1), "NativeAllocator::allocate/size");
ScopedOperation.ofAllocator(a -> a.allocate(1, 1), "NativeAllocator::allocate/size/align");
ScopedOperation.ofAllocator(a -> a.allocate(JAVA_BYTE), "NativeAllocator::allocate/layout");
ScopedOperation.ofAllocator(a -> a.allocate(JAVA_BYTE, (byte) 0), "NativeAllocator::allocate/byte");
ScopedOperation.ofAllocator(a -> a.allocate(ValueLayout.JAVA_CHAR, (char) 0), "NativeAllocator::allocate/char");
ScopedOperation.ofAllocator(a -> a.allocate(ValueLayout.JAVA_SHORT, (short) 0), "NativeAllocator::allocate/short");
ScopedOperation.ofAllocator(a -> a.allocate(ValueLayout.JAVA_INT, 0), "NativeAllocator::allocate/int");
ScopedOperation.ofAllocator(a -> a.allocate(ValueLayout.JAVA_FLOAT, 0f), "NativeAllocator::allocate/float");
ScopedOperation.ofAllocator(a -> a.allocate(ValueLayout.JAVA_LONG, 0L), "NativeAllocator::allocate/long");
ScopedOperation.ofAllocator(a -> a.allocate(ValueLayout.JAVA_DOUBLE, 0d), "NativeAllocator::allocate/double");
ScopedOperation.ofAllocator(a -> a.allocateArray(JAVA_BYTE, 1L), "NativeAllocator::allocateArray/size");
ScopedOperation.ofAllocator(a -> a.allocateArray(JAVA_BYTE, new byte[]{0}), "NativeAllocator::allocateArray/byte");
ScopedOperation.ofAllocator(a -> a.allocateArray(ValueLayout.JAVA_CHAR, new char[]{0}), "NativeAllocator::allocateArray/char");
ScopedOperation.ofAllocator(a -> a.allocateArray(ValueLayout.JAVA_SHORT, new short[]{0}), "NativeAllocator::allocateArray/short");
ScopedOperation.ofAllocator(a -> a.allocateArray(ValueLayout.JAVA_INT, new int[]{0}), "NativeAllocator::allocateArray/int");
ScopedOperation.ofAllocator(a -> a.allocateArray(ValueLayout.JAVA_FLOAT, new float[]{0}), "NativeAllocator::allocateArray/float");
ScopedOperation.ofAllocator(a -> a.allocateArray(ValueLayout.JAVA_LONG, new long[]{0}), "NativeAllocator::allocateArray/long");
ScopedOperation.ofAllocator(a -> a.allocateArray(ValueLayout.JAVA_DOUBLE, new double[]{0}), "NativeAllocator::allocateArray/double");
};
@DataProvider(name = "scopedOperations")
static Object[][] scopedOperations() {
return scopedOperations.stream().map(op -> new Object[] { op.name, op }).toArray(Object[][]::new);
}
static class ScopedOperation<X> implements Consumer<X>, Function<MemorySession, X> {
final Function<MemorySession, X> factory;
final Consumer<X> operation;
final String name;
private ScopedOperation(Function<MemorySession, X> factory, Consumer<X> operation, String name) {
this.factory = factory;
this.operation = operation;
this.name = name;
}
@Override
public void accept(X obj) {
operation.accept(obj);
}
@Override
public X apply(MemorySession session) {
return factory.apply(session);
}
static <Z> void of(Function<MemorySession, Z> factory, Consumer<Z> consumer, String name) {
scopedOperations.add(new ScopedOperation<>(factory, consumer, name));
}
static void ofScope(Consumer<MemorySession> scopeConsumer, String name) {
scopedOperations.add(new ScopedOperation<>(Function.identity(), scopeConsumer, name));
}
static void ofVaList(Consumer<VaList> vaListConsumer, String name) {
scopedOperations.add(new ScopedOperation<>(session -> VaList.make(builder -> builder.addVarg(JAVA_LONG, 42), session),
vaListConsumer, name));
}
static void ofSegment(Consumer<MemorySegment> segmentConsumer, String name) {
for (SegmentFactory segmentFactory : SegmentFactory.values()) {
scopedOperations.add(new ScopedOperation<>(
segmentFactory.segmentFactory,
segmentConsumer,
segmentFactory.name() + "/" + name));
}
}
static void ofAllocator(Consumer<SegmentAllocator> allocatorConsumer, String name) {
for (AllocatorFactory allocatorFactory : AllocatorFactory.values()) {
scopedOperations.add(new ScopedOperation<>(
allocatorFactory.allocatorFactory,
allocatorConsumer,
allocatorFactory.name() + "/" + name));
}
}
enum SegmentFactory {
NATIVE(session -> MemorySegment.allocateNative(10, session)),
MAPPED(session -> {
try (FileChannel fileChannel = FileChannel.open(Path.of("foo.txt"), StandardOpenOption.READ, StandardOpenOption.WRITE)) {
return fileChannel.map(FileChannel.MapMode.READ_WRITE, 0L, 10L, session);
} catch (IOException ex) {
throw new AssertionError(ex);
}
}),
UNSAFE(session -> MemorySegment.ofAddress(MemoryAddress.NULL, 10, session));
static {
try {
File f = new File("foo.txt");
f.createNewFile();
f.deleteOnExit();
} catch (IOException ex) {
throw new ExceptionInInitializerError(ex);
}
}
final Function<MemorySession, MemorySegment> segmentFactory;
SegmentFactory(Function<MemorySession, MemorySegment> segmentFactory) {
this.segmentFactory = segmentFactory;
}
}
enum AllocatorFactory {
ARENA_BOUNDED(session -> SegmentAllocator.newNativeArena(1000, session)),
ARENA_UNBOUNDED(SegmentAllocator::newNativeArena);
final Function<MemorySession, SegmentAllocator> allocatorFactory;
AllocatorFactory(Function<MemorySession, SegmentAllocator> allocatorFactory) {
this.allocatorFactory = allocatorFactory;
}
}
}
}