| /* | |
| * Copyright (c) 2020, 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 | |
| * @modules java.base/jdk.internal.foreign | |
| * @run testng/othervm --enable-native-access=ALL-UNNAMED TestIllegalLink | |
| */ | |
| import java.lang.foreign.Arena; | |
| import java.lang.foreign.Linker; | |
| import java.lang.foreign.FunctionDescriptor; | |
| import java.lang.foreign.MemorySegment; | |
| import java.lang.foreign.MemoryLayout; | |
| import java.lang.foreign.ValueLayout; | |
| import java.lang.invoke.MethodHandle; | |
| import java.lang.invoke.MethodHandles; | |
| import java.lang.invoke.MethodType; | |
| import java.nio.ByteOrder; | |
| import java.util.ArrayList; | |
| import java.util.Arrays; | |
| import java.util.List; | |
| import jdk.internal.foreign.CABI; | |
| import org.testng.annotations.DataProvider; | |
| import org.testng.annotations.Test; | |
| import static java.lang.foreign.ValueLayout.*; | |
| import static org.testng.Assert.assertTrue; | |
| import static org.testng.Assert.fail; | |
| public class TestIllegalLink extends NativeTestHelper { | |
| private static final boolean IS_SYSV = CABI.current() == CABI.SYS_V; | |
| private static final boolean IS_LE = ByteOrder.nativeOrder() == ByteOrder.LITTLE_ENDIAN; | |
| private static final MemorySegment DUMMY_TARGET = MemorySegment.ofAddress(1); | |
| private static final MethodHandle DUMMY_TARGET_MH = MethodHandles.empty(MethodType.methodType(void.class)); | |
| private static final Linker ABI = Linker.nativeLinker(); | |
| @Test(dataProvider = "types") | |
| public void testIllegalLayouts(FunctionDescriptor desc, Linker.Option[] options, String expectedExceptionMessage) { | |
| try { | |
| ABI.downcallHandle(DUMMY_TARGET, desc, options); | |
| fail("Expected IllegalArgumentException was not thrown"); | |
| } catch (IllegalArgumentException e) { | |
| assertTrue(e.getMessage().contains(expectedExceptionMessage), | |
| e.getMessage() + " does not contain " + expectedExceptionMessage); | |
| } | |
| } | |
| @Test(dataProvider = "downcallOnlyOptions", | |
| expectedExceptions = IllegalArgumentException.class, | |
| expectedExceptionsMessageRegExp = ".*Not supported for upcall.*") | |
| public void testIllegalUpcallOptions(Linker.Option downcallOnlyOption) { | |
| ABI.upcallStub(DUMMY_TARGET_MH, FunctionDescriptor.ofVoid(), Arena.ofAuto(), downcallOnlyOption); | |
| } | |
| @Test(dataProvider = "illegalCaptureState", | |
| expectedExceptions = IllegalArgumentException.class, | |
| expectedExceptionsMessageRegExp = ".*Unknown name.*") | |
| public void testIllegalCaptureState(String name) { | |
| Linker.Option.captureCallState(name); | |
| } | |
| // where | |
| @DataProvider | |
| public static Object[][] illegalCaptureState() { | |
| if (!IS_WINDOWS) { | |
| return new Object[][]{ | |
| { "GetLastError" }, | |
| { "WSAGetLastError" }, | |
| }; | |
| } | |
| return new Object[][]{}; | |
| } | |
| @DataProvider | |
| public static Object[][] downcallOnlyOptions() { | |
| return new Object[][]{ | |
| { Linker.Option.firstVariadicArg(0) }, | |
| { Linker.Option.captureCallState("errno") }, | |
| { Linker.Option.critical(false) }, | |
| }; | |
| } | |
| @DataProvider | |
| public static Object[][] types() { | |
| Linker.Option[] NO_OPTIONS = new Linker.Option[0]; | |
| List<Object[]> cases = new ArrayList<>(Arrays.asList(new Object[][]{ | |
| { | |
| FunctionDescriptor.of(MemoryLayout.sequenceLayout(2, C_INT)), | |
| NO_OPTIONS, | |
| IS_LE ? "Unsupported layout: [2:i4]" : "Unsupported layout: [2:I4]" | |
| }, | |
| { | |
| FunctionDescriptor.ofVoid(MemoryLayout.sequenceLayout(2, C_INT)), | |
| NO_OPTIONS, | |
| IS_LE ? "Unsupported layout: [2:i4]" : "Unsupported layout: [2:I4]" | |
| }, | |
| { | |
| FunctionDescriptor.ofVoid(C_INT.withByteAlignment(2)), | |
| NO_OPTIONS, | |
| IS_LE ? "Unsupported layout: 2%i4" : "Unsupported layout: 2%I4" | |
| }, | |
| { | |
| FunctionDescriptor.ofVoid(C_POINTER.withByteAlignment(2)), | |
| NO_OPTIONS, | |
| (IS_LE ? "Unsupported layout: 2%a" : "Unsupported layout: 2%A") + ADDRESS.byteSize() | |
| }, | |
| { | |
| FunctionDescriptor.ofVoid(ValueLayout.JAVA_CHAR.withByteAlignment(4)), | |
| NO_OPTIONS, | |
| IS_LE ? "Unsupported layout: 4%c2" : "Unsupported layout: 4%C2" | |
| }, | |
| { | |
| FunctionDescriptor.ofVoid(MemoryLayout.structLayout( | |
| C_CHAR.withName("x").withByteAlignment(1), | |
| C_SHORT.withName("y").withByteAlignment(1), | |
| C_INT.withName("z").withByteAlignment(1) | |
| ).withByteAlignment(1)), | |
| NO_OPTIONS, | |
| IS_LE ? "Unsupported layout: 1%s2" : "Unsupported layout: 1%S2" | |
| }, | |
| { | |
| FunctionDescriptor.ofVoid(MemoryLayout.structLayout( | |
| MemoryLayout.structLayout( | |
| C_CHAR.withName("x").withByteAlignment(1), | |
| C_SHORT.withName("y").withByteAlignment(1), | |
| C_INT.withName("z").withByteAlignment(1) | |
| ))), | |
| NO_OPTIONS, | |
| IS_LE ? "Unsupported layout: 1%s2" : "Unsupported layout: 1%S2" | |
| }, | |
| { | |
| FunctionDescriptor.ofVoid(MemoryLayout.structLayout( | |
| MemoryLayout.sequenceLayout(1, | |
| C_INT.withByteAlignment(1) | |
| ))), | |
| NO_OPTIONS, | |
| IS_LE ? "Unsupported layout: 1%i4" : "Unsupported layout: 1%I4" | |
| }, | |
| { | |
| FunctionDescriptor.ofVoid(MemoryLayout.structLayout( | |
| ValueLayout.JAVA_INT, | |
| MemoryLayout.paddingLayout(4), // no excess padding | |
| ValueLayout.JAVA_INT)), | |
| NO_OPTIONS, | |
| "unexpected offset" | |
| }, | |
| { | |
| FunctionDescriptor.of(C_INT.withOrder(nonNativeOrder())), | |
| NO_OPTIONS, | |
| IS_LE ? "Unsupported layout: I4" : "Unsupported layout: i4" | |
| }, | |
| { | |
| FunctionDescriptor.of(MemoryLayout.structLayout(C_INT.withOrder(nonNativeOrder()))), | |
| NO_OPTIONS, | |
| IS_LE ? "Unsupported layout: I4" : "Unsupported layout: i4" | |
| }, | |
| { | |
| FunctionDescriptor.of(MemoryLayout.structLayout(MemoryLayout.sequenceLayout(1, C_INT.withOrder(nonNativeOrder())))), | |
| NO_OPTIONS, | |
| IS_LE ? "Unsupported layout: I4" : "Unsupported layout: i4" | |
| }, | |
| { | |
| FunctionDescriptor.ofVoid(MemoryLayout.structLayout( | |
| ValueLayout.JAVA_INT, | |
| MemoryLayout.paddingLayout(4))), // too much trailing padding | |
| NO_OPTIONS, | |
| "has unexpected size" | |
| }, | |
| })); | |
| for (ValueLayout illegalLayout : List.of(C_CHAR, ValueLayout.JAVA_CHAR, C_BOOL, C_SHORT, C_FLOAT)) { | |
| cases.add(new Object[]{ | |
| FunctionDescriptor.ofVoid(C_INT, illegalLayout), | |
| new Linker.Option[]{Linker.Option.firstVariadicArg(1)}, | |
| "Invalid variadic argument layout" | |
| }); | |
| } | |
| if (IS_SYSV) { | |
| cases.add(new Object[] { | |
| FunctionDescriptor.ofVoid(MemoryLayout.structLayout( | |
| MemoryLayout.sequenceLayout(Long.MAX_VALUE / C_INT.byteSize(), | |
| C_INT | |
| ))), | |
| NO_OPTIONS, | |
| "GroupLayout is too large" | |
| }); | |
| } | |
| if (ValueLayout.JAVA_LONG.byteAlignment() == 8) { | |
| cases.add(new Object[]{ | |
| FunctionDescriptor.ofVoid(MemoryLayout.structLayout( | |
| ValueLayout.JAVA_LONG, | |
| ValueLayout.JAVA_INT)), // missing trailing padding | |
| NO_OPTIONS, | |
| "has unexpected size" | |
| }); | |
| } | |
| return cases.toArray(Object[][]::new); | |
| } | |
| private static ByteOrder nonNativeOrder() { | |
| return ByteOrder.nativeOrder() == ByteOrder.LITTLE_ENDIAN | |
| ? ByteOrder.BIG_ENDIAN | |
| : ByteOrder.LITTLE_ENDIAN; | |
| } | |
| } |