1 /*
 2  * Copyright (c) 2021, 2023, Oracle and/or its affiliates. All rights reserved.
 3  * Copyright (c) 2021, Arm Limited. All rights reserved.
 4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 5  *
 6  * This code is free software; you can redistribute it and/or modify it
 7  * under the terms of the GNU General Public License version 2 only, as
 8  * published by the Free Software Foundation.  Oracle designates this
 9  * particular file as subject to the "Classpath" exception as provided
10  * by Oracle in the LICENSE file that accompanied this code.
11  *
12  * This code is distributed in the hope that it will be useful, but WITHOUT
13  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
14  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
15  * version 2 for more details (a copy is included in the LICENSE file that
16  * accompanied this code).
17  *
18  * You should have received a copy of the GNU General Public License version
19  * 2 along with this work; if not, write to the Free Software Foundation,
20  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
21  *
22  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
23  * or visit www.oracle.com if you need additional information or have any
24  * questions.
25  */
26 package jdk.internal.foreign.abi.aarch64.macos;
27 
28 import jdk.internal.foreign.abi.AbstractLinker;
29 import jdk.internal.foreign.abi.LinkerOptions;
30 import jdk.internal.foreign.abi.SharedUtils;
31 import jdk.internal.foreign.abi.aarch64.CallArranger;
32 
33 import java.lang.foreign.FunctionDescriptor;
34 import java.lang.foreign.MemoryLayout;
35 import java.lang.foreign.ValueLayout;
36 import java.lang.invoke.MethodHandle;
37 import java.lang.invoke.MethodType;
38 import java.nio.ByteOrder;
39 import java.util.Map;
40 
41 /**
42  * ABI implementation for macOS on Apple Silicon. Based on AAPCS with
43  * changes to va_list and passing arguments on the stack.
44  */
45 public final class MacOsAArch64Linker extends AbstractLinker {
46 
47     static final Map<String, MemoryLayout> CANONICAL_LAYOUTS =
48             SharedUtils.canonicalLayouts(ValueLayout.JAVA_LONG, ValueLayout.JAVA_LONG, ValueLayout.JAVA_INT);
49 
50     public static MacOsAArch64Linker getInstance() {
51         final class Holder {
52             private static final MacOsAArch64Linker INSTANCE = new MacOsAArch64Linker();
53         }
54 
55         return Holder.INSTANCE;
56     }
57 
58     private MacOsAArch64Linker() {
59         // Ensure there is only one instance
60     }
61 
62     @Override
63     protected MethodHandle arrangeDowncall(MethodType inferredMethodType, FunctionDescriptor function, LinkerOptions options) {
64         return CallArranger.MACOS.arrangeDowncall(inferredMethodType, function, options);
65     }
66 
67     @Override
68     protected UpcallStubFactory arrangeUpcall(MethodType targetType, FunctionDescriptor function, LinkerOptions options) {
69         return CallArranger.MACOS.arrangeUpcall(targetType, function, options);
70     }
71 
72     @Override
73     protected ByteOrder linkerByteOrder() {
74         return ByteOrder.LITTLE_ENDIAN;
75     }
76 
77     @Override
78     public Map<String, MemoryLayout> canonicalLayouts() {
79         return CANONICAL_LAYOUTS;
80     }
81 }