xref: /llvm-project/llvm/include/llvm/ExecutionEngine/Orc/ObjectFileInterface.h (revision 3d4e9d5eb0f7b0b2ad412b95239752701a734646)
1*4299d8d0SLang Hames //===-- ObjectFileInterface.h - MU interface utils for objects --*- C++ -*-===//
2*4299d8d0SLang Hames //
3*4299d8d0SLang Hames // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4*4299d8d0SLang Hames // See https://llvm.org/LICENSE.txt for license information.
5*4299d8d0SLang Hames // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6*4299d8d0SLang Hames //
7*4299d8d0SLang Hames //===----------------------------------------------------------------------===//
8*4299d8d0SLang Hames //
9*4299d8d0SLang Hames // Utilities for building MaterializationUnit::Interface objects from
10*4299d8d0SLang Hames // object files.
11*4299d8d0SLang Hames //
12*4299d8d0SLang Hames //===----------------------------------------------------------------------===//
13*4299d8d0SLang Hames 
14*4299d8d0SLang Hames #ifndef LLVM_EXECUTIONENGINE_ORC_OBJECTFILEINTERFACE_H
15*4299d8d0SLang Hames #define LLVM_EXECUTIONENGINE_ORC_OBJECTFILEINTERFACE_H
16*4299d8d0SLang Hames 
17*4299d8d0SLang Hames #include "llvm/ExecutionEngine/Orc/Core.h"
18*4299d8d0SLang Hames #include "llvm/Support/MemoryBuffer.h"
19*4299d8d0SLang Hames 
20*4299d8d0SLang Hames namespace llvm {
21*4299d8d0SLang Hames namespace orc {
22*4299d8d0SLang Hames 
23*4299d8d0SLang Hames /// Adds an initializer symbol to the given MU interface.
24*4299d8d0SLang Hames /// The init symbol's name is guaranteed to be unique within I, and will be of
25*4299d8d0SLang Hames /// the form $.<ObjFileName>.__inits.<N>, where N is some integer.
26*4299d8d0SLang Hames void addInitSymbol(MaterializationUnit::Interface &I, ExecutionSession &ES,
27*4299d8d0SLang Hames                    StringRef ObjFileName);
28*4299d8d0SLang Hames 
29*4299d8d0SLang Hames /// Returns a MaterializationUnit::Interface for the object file contained in
30*4299d8d0SLang Hames /// the given buffer, or an error if the buffer does not contain a valid object
31*4299d8d0SLang Hames /// file.
32*4299d8d0SLang Hames Expected<MaterializationUnit::Interface>
33*4299d8d0SLang Hames getObjectFileInterface(ExecutionSession &ES, MemoryBufferRef ObjBuffer);
34*4299d8d0SLang Hames 
35*4299d8d0SLang Hames } // End namespace orc
36*4299d8d0SLang Hames } // End namespace llvm
37*4299d8d0SLang Hames 
38*4299d8d0SLang Hames #endif // LLVM_EXECUTIONENGINE_ORC_OBJECTFILEINTERFACE_H
39