1 /*
 2  * Copyright (c) 2022, 2023, Oracle and/or its affiliates. All rights reserved.
 3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 4  *
 5  * This code is free software; you can redistribute it and/or modify it
 6  * under the terms of the GNU General Public License version 2 only, as
 7  * published by the Free Software Foundation.
 8  *
 9  * This code is distributed in the hope that it will be useful, but WITHOUT
10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
12  * version 2 for more details (a copy is included in the LICENSE file that
13  * accompanied this code).
14  *
15  * You should have received a copy of the GNU General Public License version
16  * 2 along with this work; if not, write to the Free Software Foundation,
17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18  *
19  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20  * or visit www.oracle.com if you need additional information or have any
21  * questions.
22  */
23 
24 /*
25  * @test
26  * @modules java.base/jdk.internal.foreign
27  * @build NativeTestHelper CallGeneratorHelper TestDowncallBase
28  *
29  * @run testng/othervm -XX:+IgnoreUnrecognizedVMOptions -XX:-VerifyDependencies
30  *   --enable-native-access=ALL-UNNAMED -Dgenerator.sample.factor=17
31  *   TestDowncallStack
32  */
33 
34 import org.testng.annotations.Test;
35 
36 import java.lang.foreign.*;
37 import java.util.ArrayList;
38 import java.util.List;
39 import java.util.function.Consumer;
40 
41 import static org.testng.Assert.assertEquals;
42 
43 public class TestDowncallStack extends TestDowncallBase {
44 
45     static {
46         System.loadLibrary("TestDowncallStack");
47     }
48 
49     @Test(dataProvider="functions", dataProviderClass=CallGeneratorHelper.class)
50     public void testDowncallStack(int count, String fName, CallGeneratorHelper.Ret ret,
51                                   List<CallGeneratorHelper.ParamType> paramTypes,
52                                   List<CallGeneratorHelper.StructFieldType> fields) throws Throwable {
53         List<Consumer<Object>> checks = new ArrayList<>();
54         MemorySegment addr = findNativeOrThrow("s" + fName);
55         FunctionDescriptor descriptor = functionStack(ret, paramTypes, fields);
56         try (Arena arena = Arena.ofShared()) {
57             Object[] args = makeArgsStack(arena, descriptor, checks);
58             boolean needsScope = descriptor.returnLayout().map(GroupLayout.class::isInstance).orElse(false);
59             SegmentAllocator allocator = needsScope ?
60                     arena :
61                     THROWING_ALLOCATOR;
62             Object res = doCall(addr, allocator, descriptor, args);
63             if (ret == CallGeneratorHelper.Ret.NON_VOID) {
64                 checks.forEach(c -> c.accept(res));
65                 if (needsScope) {
66                     // check that return struct has indeed been allocated in the native scope
67                     assertEquals(((MemorySegment)res).scope(), arena.scope());
68                 }
69             }
70         }
71     }
72 
73     static FunctionDescriptor functionStack(Ret ret, List<ParamType> params, List<StructFieldType> fields) {
74         return function(ret, params, fields, STACK_PREFIX_LAYOUTS);
75     }
76 
77     static Object[] makeArgsStack(Arena arena, FunctionDescriptor descriptor, List<Consumer<Object>> checks) {
78         return makeArgs(arena, descriptor, checks, STACK_PREFIX_LAYOUTS.size());
79     }
80 
81 }