1//===---- MachO_arm64.h - JIT link functions for MachO/arm64 ----*- 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// jit-link functions for MachO/arm64.
10//
11//===----------------------------------------------------------------------===//
12
13#ifndef LLVM_EXECUTIONENGINE_JITLINK_MACHO_ARM64_H
14#define LLVM_EXECUTIONENGINE_JITLINK_MACHO_ARM64_H
15
16#include "llvm/ExecutionEngine/JITLink/JITLink.h"
17
18namespace llvm {
19namespace jitlink {
20
21namespace MachO_arm64_Edges {
22
23enum MachOARM64RelocationKind : Edge::Kind {
24 Branch26 = Edge::FirstRelocation,
25 Pointer32,
26 Pointer64,
27 Pointer64Anon,
28 Page21,
29 PageOffset12,
30 GOTPage21,
31 GOTPageOffset12,
32 PointerToGOT,
33 PairedAddend,
34 LDRLiteral19,
35 Delta32,
36 Delta64,
37 NegDelta32,
38 NegDelta64,
39};
40
41} // namespace MachO_arm64_Edges
42
43/// Create a LinkGraph from a MachO/arm64 relocatable object.
44///
45/// Note: The graph does not take ownership of the underlying buffer, nor copy
46/// its contents. The caller is responsible for ensuring that the object buffer
47/// outlives the graph.
48Expected<std::unique_ptr<LinkGraph>>
49createLinkGraphFromMachOObject_arm64(MemoryBufferRef ObjectBuffer);
50
51/// jit-link the given object buffer, which must be a MachO arm64 object file.
52///
53/// If PrePrunePasses is empty then a default mark-live pass will be inserted
54/// that will mark all exported atoms live. If PrePrunePasses is not empty, the
55/// caller is responsible for including a pass to mark atoms as live.
56///
57/// If PostPrunePasses is empty then a default GOT-and-stubs insertion pass will
58/// be inserted. If PostPrunePasses is not empty then the caller is responsible
59/// for including a pass to insert GOT and stub edges.
60void link_MachO_arm64(std::unique_ptr<LinkGraph> G,
61 std::unique_ptr<JITLinkContext> Ctx);
62
63/// Return the string name of the given MachO arm64 edge kind.
64const char *getMachOARM64RelocationKindName(Edge::Kind R);
65
66} // end namespace jitlink
67} // end namespace llvm
68
69#endif // LLVM_EXECUTIONENGINE_JITLINK_MACHO_ARM64_H
70