xref: /freebsd/contrib/llvm-project/llvm/include/llvm/ExecutionEngine/JITLink/COFF_x86_64.h (revision 753f127f3ace09432b2baeffd71a308760641a62)
1 //===--- COFF_x86_64.h - JIT link functions for COFF/x86-64 ---*- 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 COFF/x86-64.
10 //
11 //===----------------------------------------------------------------------===//
12 
13 #ifndef LLVM_EXECUTIONENGINE_JITLINK_COFF_X86_64_H
14 #define LLVM_EXECUTIONENGINE_JITLINK_COFF_X86_64_H
15 
16 #include "llvm/ExecutionEngine/JITLink/JITLink.h"
17 
18 namespace llvm {
19 namespace jitlink {
20 
21 /// Create a LinkGraph from an COFF/x86-64 relocatable object.
22 ///
23 /// Note: The graph does not take ownership of the underlying buffer, nor copy
24 /// its contents. The caller is responsible for ensuring that the object buffer
25 /// outlives the graph.
26 Expected<std::unique_ptr<LinkGraph>>
27 createLinkGraphFromCOFFObject_x86_64(MemoryBufferRef ObjectBuffer);
28 
29 /// jit-link the given object buffer, which must be a COFF x86-64 object file.
30 void link_COFF_x86_64(std::unique_ptr<LinkGraph> G,
31                       std::unique_ptr<JITLinkContext> Ctx);
32 
33 /// Return the string name of the given COFF x86-64 edge kind.
34 const char *getCOFFX86RelocationKindName(Edge::Kind R);
35 } // end namespace jitlink
36 } // end namespace llvm
37 
38 #endif // LLVM_EXECUTIONENGINE_JITLINK_COFF_X86_64_H
39