1//===-- llvm/BinaryFormat/MachO.cpp - The MachO file format -----*- C++/-*-===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8
9#include "llvm/BinaryFormat/MachO.h"
10#include "llvm/TargetParser/ARMTargetParser.h"
11#include "llvm/TargetParser/Triple.h"
12
13using namespace llvm;
14
15static MachO::CPUSubTypeX86 getX86SubType(const Triple &T) {
16 assert(T.isX86());
17 if (T.isArch32Bit())
18 return MachO::CPU_SUBTYPE_I386_ALL;
19
20 assert(T.isArch64Bit());
21 if (T.getArchName() == "x86_64h")
22 return MachO::CPU_SUBTYPE_X86_64_H;
23 return MachO::CPU_SUBTYPE_X86_64_ALL;
24}
25
26static MachO::CPUSubTypeARM getARMSubType(const Triple &T) {
27 assert(T.isARM() || T.isThumb());
28 StringRef Arch = T.getArchName();
29 ARM::ArchKind AK = ARM::parseArch(Arch);
30 switch (AK) {
31 default:
32 return MachO::CPU_SUBTYPE_ARM_V7;
33 case ARM::ArchKind::ARMV4T:
34 return MachO::CPU_SUBTYPE_ARM_V4T;
35 case ARM::ArchKind::ARMV5T:
36 case ARM::ArchKind::ARMV5TE:
37 case ARM::ArchKind::ARMV5TEJ:
38 return MachO::CPU_SUBTYPE_ARM_V5;
39 case ARM::ArchKind::ARMV6:
40 case ARM::ArchKind::ARMV6K:
41 return MachO::CPU_SUBTYPE_ARM_V6;
42 case ARM::ArchKind::ARMV7A:
43 return MachO::CPU_SUBTYPE_ARM_V7;
44 case ARM::ArchKind::ARMV7S:
45 return MachO::CPU_SUBTYPE_ARM_V7S;
46 case ARM::ArchKind::ARMV7K:
47 return MachO::CPU_SUBTYPE_ARM_V7K;
48 case ARM::ArchKind::ARMV6M:
49 return MachO::CPU_SUBTYPE_ARM_V6M;
50 case ARM::ArchKind::ARMV7M:
51 return MachO::CPU_SUBTYPE_ARM_V7M;
52 case ARM::ArchKind::ARMV7EM:
53 return MachO::CPU_SUBTYPE_ARM_V7EM;
54 case ARM::ArchKind::ARMV8MBaseline:
55 return MachO::CPU_SUBTYPE_ARM_V8M_BASE;
56 case ARM::ArchKind::ARMV8MMainline:
57 return MachO::CPU_SUBTYPE_ARM_V8M_MAIN;
58 case ARM::ArchKind::ARMV8_1MMainline:
59 return MachO::CPU_SUBTYPE_ARM_V8_1M_MAIN;
60 }
61}
62
63static MachO::CPUSubTypeARM64 getARM64SubType(const Triple &T) {
64 assert(T.isAArch64());
65 if (T.isArch32Bit())
66 return (MachO::CPUSubTypeARM64)MachO::CPU_SUBTYPE_ARM64_32_V8;
67 if (T.isArm64e())
68 return MachO::CPU_SUBTYPE_ARM64E;
69
70 return MachO::CPU_SUBTYPE_ARM64_ALL;
71}
72
73static MachO::CPUSubTypePowerPC getPowerPCSubType(const Triple &T) {
74 return MachO::CPU_SUBTYPE_POWERPC_ALL;
75}
76
77static Error unsupported(const char *Str, const Triple &T) {
78 return createStringError(EC: std::errc::invalid_argument,
79 Fmt: "Unsupported triple for mach-o cpu %s: %s", Vals: Str,
80 Vals: T.str().c_str());
81}
82
83static MachO::CPUSubTypeRISCV getRISCVSubType(const Triple &T) {
84 return MachO::CPU_SUBTYPE_RISCV_ALL;
85}
86
87Expected<uint32_t> MachO::getCPUType(const Triple &T) {
88 if (!T.isOSBinFormatMachO())
89 return unsupported(Str: "type", T);
90 if (T.isX86() && T.isArch32Bit())
91 return MachO::CPU_TYPE_X86;
92 if (T.isX86() && T.isArch64Bit())
93 return MachO::CPU_TYPE_X86_64;
94 if (T.isARM() || T.isThumb())
95 return MachO::CPU_TYPE_ARM;
96 if (T.isAArch64())
97 return T.isArch32Bit() ? MachO::CPU_TYPE_ARM64_32 : MachO::CPU_TYPE_ARM64;
98 if (T.getArch() == Triple::ppc)
99 return MachO::CPU_TYPE_POWERPC;
100 if (T.getArch() == Triple::ppc64)
101 return MachO::CPU_TYPE_POWERPC64;
102 if (T.getArch() == Triple::riscv32)
103 return MachO::CPU_TYPE_RISCV;
104 return unsupported(Str: "type", T);
105}
106
107Expected<uint32_t> MachO::getCPUSubType(const Triple &T) {
108 if (!T.isOSBinFormatMachO())
109 return unsupported(Str: "subtype", T);
110 if (T.isX86())
111 return getX86SubType(T);
112 if (T.isARM() || T.isThumb())
113 return getARMSubType(T);
114 if (T.isAArch64() || T.getArch() == Triple::aarch64_32)
115 return getARM64SubType(T);
116 if (T.getArch() == Triple::ppc || T.getArch() == Triple::ppc64)
117 return getPowerPCSubType(T);
118 if (T.getArch() == Triple::riscv32)
119 return getRISCVSubType(T);
120 return unsupported(Str: "subtype", T);
121}
122
123Expected<uint32_t> MachO::getCPUSubType(const Triple &T,
124 unsigned PtrAuthABIVersion,
125 bool PtrAuthKernelABIVersion) {
126 Expected<uint32_t> Result = MachO::getCPUSubType(T);
127 if (!Result)
128 return Result.takeError();
129 if (*Result != MachO::CPU_SUBTYPE_ARM64E)
130 return createStringError(
131 EC: std::errc::invalid_argument,
132 Fmt: "ptrauth ABI version is only supported on arm64e.");
133 if (PtrAuthABIVersion > 0xF)
134 return createStringError(
135 EC: std::errc::invalid_argument,
136 Fmt: "The ptrauth ABI version needs to fit within 4 bits.");
137 return CPU_SUBTYPE_ARM64E_WITH_PTRAUTH_VERSION(PtrAuthABIVersion,
138 PtrAuthKernelABIVersion);
139}
140