Chris Lattner | a0d7b08 | 2002-12-23 23:59:41 +0000 | [diff] [blame] | 1 | //===- lli.cpp - LLVM Interpreter / Dynamic compiler ----------------------===// |
Misha Brukman | 650ba8e | 2005-04-22 00:00:37 +0000 | [diff] [blame] | 2 | // |
John Criswell | 09344dc | 2003-10-20 17:47:21 +0000 | [diff] [blame] | 3 | // The LLVM Compiler Infrastructure |
| 4 | // |
Chris Lattner | 345353d | 2007-12-29 20:44:31 +0000 | [diff] [blame] | 5 | // This file is distributed under the University of Illinois Open Source |
| 6 | // License. See LICENSE.TXT for details. |
Misha Brukman | 650ba8e | 2005-04-22 00:00:37 +0000 | [diff] [blame] | 7 | // |
John Criswell | 09344dc | 2003-10-20 17:47:21 +0000 | [diff] [blame] | 8 | //===----------------------------------------------------------------------===// |
Chris Lattner | d7ff578 | 2001-08-23 17:05:04 +0000 | [diff] [blame] | 9 | // |
Chris Lattner | 141ea3a | 2003-12-26 05:07:35 +0000 | [diff] [blame] | 10 | // This utility provides a simple wrapper around the LLVM Execution Engines, |
| 11 | // which allow the direct execution of LLVM programs through a Just-In-Time |
Torok Edwin | f011f28 | 2009-07-03 12:11:32 +0000 | [diff] [blame] | 12 | // compiler, or through an interpreter if no JIT is available for this platform. |
Chris Lattner | d7ff578 | 2001-08-23 17:05:04 +0000 | [diff] [blame] | 13 | // |
| 14 | //===----------------------------------------------------------------------===// |
| 15 | |
Lang Hames | 9528bba | 2015-03-25 12:11:48 +0000 | [diff] [blame] | 16 | #include "OrcLazyJIT.h" |
Lang Hames | 9d7a269 | 2016-01-11 16:35:55 +0000 | [diff] [blame] | 17 | #include "RemoteJITUtils.h" |
NAKAMURA Takumi | cef0a821 | 2016-01-15 02:14:46 +0000 | [diff] [blame] | 18 | #include "llvm/ADT/StringExtras.h" |
Duncan Sands | 3bd97fe | 2010-08-28 01:30:02 +0000 | [diff] [blame] | 19 | #include "llvm/ADT/Triple.h" |
Teresa Johnson | ad17679 | 2016-11-11 05:34:58 +0000 | [diff] [blame] | 20 | #include "llvm/Bitcode/BitcodeReader.h" |
David Blaikie | 4333f97 | 2018-04-11 18:49:37 +0000 | [diff] [blame] | 21 | #include "llvm/CodeGen/CommandFlags.inc" |
Chris Lattner | 5af6a3f | 2006-08-01 22:34:35 +0000 | [diff] [blame] | 22 | #include "llvm/CodeGen/LinkAllCodegenComponents.h" |
Brian Gaeke | e99ca44 | 2003-09-05 19:42:34 +0000 | [diff] [blame] | 23 | #include "llvm/ExecutionEngine/GenericValue.h" |
Jeffrey Yasskin | 0b08f3d | 2009-06-25 02:04:04 +0000 | [diff] [blame] | 24 | #include "llvm/ExecutionEngine/Interpreter.h" |
Jeffrey Yasskin | 0b08f3d | 2009-06-25 02:04:04 +0000 | [diff] [blame] | 25 | #include "llvm/ExecutionEngine/JITEventListener.h" |
Daniel Dunbar | 7e5d8a7 | 2010-11-17 16:06:43 +0000 | [diff] [blame] | 26 | #include "llvm/ExecutionEngine/MCJIT.h" |
Lang Hames | 173c69f | 2014-01-08 04:09:09 +0000 | [diff] [blame] | 27 | #include "llvm/ExecutionEngine/ObjectCache.h" |
Rafael Espindola | 79e238a | 2017-08-03 02:16:21 +0000 | [diff] [blame] | 28 | #include "llvm/ExecutionEngine/Orc/OrcRemoteTargetClient.h" |
Lang Hames | 93de2a1 | 2015-01-23 21:25:00 +0000 | [diff] [blame] | 29 | #include "llvm/ExecutionEngine/OrcMCJITReplacement.h" |
Andrew Kaylor | 58365b9 | 2012-11-27 19:49:00 +0000 | [diff] [blame] | 30 | #include "llvm/ExecutionEngine/SectionMemoryManager.h" |
Andrew Kaylor | 1ca510e | 2013-10-29 01:29:56 +0000 | [diff] [blame] | 31 | #include "llvm/IR/IRBuilder.h" |
Rafael Espindola | 79e238a | 2017-08-03 02:16:21 +0000 | [diff] [blame] | 32 | #include "llvm/IR/LLVMContext.h" |
Chandler Carruth | 9fb823b | 2013-01-02 11:36:10 +0000 | [diff] [blame] | 33 | #include "llvm/IR/Module.h" |
| 34 | #include "llvm/IR/Type.h" |
Andrew Kaylor | 1ca510e | 2013-10-29 01:29:56 +0000 | [diff] [blame] | 35 | #include "llvm/IR/TypeBuilder.h" |
Chandler Carruth | e60e57b | 2013-03-26 02:25:37 +0000 | [diff] [blame] | 36 | #include "llvm/IRReader/IRReader.h" |
Lang Hames | 173c69f | 2014-01-08 04:09:09 +0000 | [diff] [blame] | 37 | #include "llvm/Object/Archive.h" |
| 38 | #include "llvm/Object/ObjectFile.h" |
Reid Spencer | 7c16caa | 2004-09-01 22:55:40 +0000 | [diff] [blame] | 39 | #include "llvm/Support/CommandLine.h" |
Chandler Carruth | 4d88a1c | 2012-12-04 10:44:52 +0000 | [diff] [blame] | 40 | #include "llvm/Support/Debug.h" |
| 41 | #include "llvm/Support/DynamicLibrary.h" |
| 42 | #include "llvm/Support/Format.h" |
Rui Ueyama | 197194b | 2018-04-13 18:26:06 +0000 | [diff] [blame] | 43 | #include "llvm/Support/InitLLVM.h" |
Chris Lattner | 76d4632 | 2006-12-06 01:18:01 +0000 | [diff] [blame] | 44 | #include "llvm/Support/ManagedStatic.h" |
Chandler Carruth | 4d88a1c | 2012-12-04 10:44:52 +0000 | [diff] [blame] | 45 | #include "llvm/Support/MathExtras.h" |
| 46 | #include "llvm/Support/Memory.h" |
Chris Lattner | 2785bdb | 2007-05-06 04:58:26 +0000 | [diff] [blame] | 47 | #include "llvm/Support/MemoryBuffer.h" |
Benjamin Kramer | 16132e6 | 2015-03-23 18:07:13 +0000 | [diff] [blame] | 48 | #include "llvm/Support/Path.h" |
Reid Spencer | 7c16caa | 2004-09-01 22:55:40 +0000 | [diff] [blame] | 49 | #include "llvm/Support/PluginLoader.h" |
Michael J. Spencer | 447762d | 2010-11-29 18:16:10 +0000 | [diff] [blame] | 50 | #include "llvm/Support/Process.h" |
Andrew Kaylor | c2ebf3f | 2013-10-02 17:12:36 +0000 | [diff] [blame] | 51 | #include "llvm/Support/Program.h" |
Chandler Carruth | e60e57b | 2013-03-26 02:25:37 +0000 | [diff] [blame] | 52 | #include "llvm/Support/SourceMgr.h" |
Evan Cheng | 2bb4035 | 2011-08-24 18:08:43 +0000 | [diff] [blame] | 53 | #include "llvm/Support/TargetSelect.h" |
Jonas Devlieghere | 4a2863c | 2018-04-22 08:02:11 +0000 | [diff] [blame] | 54 | #include "llvm/Support/WithColor.h" |
Chandler Carruth | 4d88a1c | 2012-12-04 10:44:52 +0000 | [diff] [blame] | 55 | #include "llvm/Support/raw_ostream.h" |
Daniel Malea | a960c54 | 2013-06-28 19:11:40 +0000 | [diff] [blame] | 56 | #include "llvm/Transforms/Instrumentation.h" |
Chris Lattner | 4c522b9 | 2007-04-27 17:02:33 +0000 | [diff] [blame] | 57 | #include <cerrno> |
NAKAMURA Takumi | 1530487 | 2010-10-22 14:53:59 +0000 | [diff] [blame] | 58 | |
| 59 | #ifdef __CYGWIN__ |
| 60 | #include <cygwin/version.h> |
| 61 | #if defined(CYGWIN_VERSION_DLL_MAJOR) && CYGWIN_VERSION_DLL_MAJOR<1007 |
| 62 | #define DO_NOTHING_ATEXIT 1 |
| 63 | #endif |
| 64 | #endif |
| 65 | |
Brian Gaeke | 960707c | 2003-11-11 22:41:34 +0000 | [diff] [blame] | 66 | using namespace llvm; |
| 67 | |
Chandler Carruth | f98597a | 2014-04-22 03:10:36 +0000 | [diff] [blame] | 68 | #define DEBUG_TYPE "lli" |
| 69 | |
Chris Lattner | a0d7b08 | 2002-12-23 23:59:41 +0000 | [diff] [blame] | 70 | namespace { |
Lang Hames | 9528bba | 2015-03-25 12:11:48 +0000 | [diff] [blame] | 71 | |
| 72 | enum class JITKind { MCJIT, OrcMCJITReplacement, OrcLazy }; |
| 73 | |
Chris Lattner | a0d7b08 | 2002-12-23 23:59:41 +0000 | [diff] [blame] | 74 | cl::opt<std::string> |
Gabor Greif | e16561c | 2007-07-05 17:07:56 +0000 | [diff] [blame] | 75 | InputFile(cl::desc("<input bitcode>"), cl::Positional, cl::init("-")); |
Chris Lattner | f5cad15 | 2002-07-22 02:10:13 +0000 | [diff] [blame] | 76 | |
Chris Lattner | a0d7b08 | 2002-12-23 23:59:41 +0000 | [diff] [blame] | 77 | cl::list<std::string> |
| 78 | InputArgv(cl::ConsumeAfter, cl::desc("<program arguments>...")); |
Chris Lattner | f5cad15 | 2002-07-22 02:10:13 +0000 | [diff] [blame] | 79 | |
Chris Lattner | a0d7b08 | 2002-12-23 23:59:41 +0000 | [diff] [blame] | 80 | cl::opt<bool> ForceInterpreter("force-interpreter", |
Misha Brukman | c2186e3 | 2003-09-25 18:10:34 +0000 | [diff] [blame] | 81 | cl::desc("Force interpretation: disable JIT"), |
| 82 | cl::init(false)); |
Evan Cheng | 06d988e | 2008-08-08 08:12:06 +0000 | [diff] [blame] | 83 | |
Lang Hames | 9528bba | 2015-03-25 12:11:48 +0000 | [diff] [blame] | 84 | cl::opt<JITKind> UseJITKind("jit-kind", |
| 85 | cl::desc("Choose underlying JIT kind."), |
| 86 | cl::init(JITKind::MCJIT), |
| 87 | cl::values( |
| 88 | clEnumValN(JITKind::MCJIT, "mcjit", |
| 89 | "MCJIT"), |
| 90 | clEnumValN(JITKind::OrcMCJITReplacement, |
| 91 | "orc-mcjit", |
| 92 | "Orc-based MCJIT replacement"), |
| 93 | clEnumValN(JITKind::OrcLazy, |
| 94 | "orc-lazy", |
Mehdi Amini | 732afdd | 2016-10-08 19:41:06 +0000 | [diff] [blame] | 95 | "Orc-based lazy JIT."))); |
Lang Hames | 93de2a1 | 2015-01-23 21:25:00 +0000 | [diff] [blame] | 96 | |
Jim Grosbach | 0f435d0 | 2012-09-05 16:50:34 +0000 | [diff] [blame] | 97 | // The MCJIT supports building for a target address space separate from |
| 98 | // the JIT compilation process. Use a forked process and a copying |
| 99 | // memory manager with IPC to execute using this functionality. |
| 100 | cl::opt<bool> RemoteMCJIT("remote-mcjit", |
| 101 | cl::desc("Execute MCJIT'ed code in a separate process."), |
| 102 | cl::init(false)); |
| 103 | |
Andrew Kaylor | c2ebf3f | 2013-10-02 17:12:36 +0000 | [diff] [blame] | 104 | // Manually specify the child process for remote execution. This overrides |
| 105 | // the simulated remote execution that allocates address space for child |
Andrew Kaylor | 8935258 | 2013-10-29 01:33:14 +0000 | [diff] [blame] | 106 | // execution. The child process will be executed and will communicate with |
| 107 | // lli via stdin/stdout pipes. |
Andrew Kaylor | c2ebf3f | 2013-10-02 17:12:36 +0000 | [diff] [blame] | 108 | cl::opt<std::string> |
Alp Toker | a118638 | 2014-01-22 21:52:35 +0000 | [diff] [blame] | 109 | ChildExecPath("mcjit-remote-process", |
| 110 | cl::desc("Specify the filename of the process to launch " |
| 111 | "for remote MCJIT execution. If none is specified," |
| 112 | "\n\tremote execution will be simulated in-process."), |
| 113 | cl::value_desc("filename"), cl::init("")); |
Andrew Kaylor | c2ebf3f | 2013-10-02 17:12:36 +0000 | [diff] [blame] | 114 | |
Evan Cheng | 09bd0b1 | 2009-05-04 23:05:19 +0000 | [diff] [blame] | 115 | // Determine optimization level. |
| 116 | cl::opt<char> |
| 117 | OptLevel("O", |
| 118 | cl::desc("Optimization level. [-O0, -O1, -O2, or -O3] " |
| 119 | "(default = '-O2')"), |
| 120 | cl::Prefix, |
| 121 | cl::ZeroOrMore, |
| 122 | cl::init(' ')); |
Evan Cheng | 06d988e | 2008-08-08 08:12:06 +0000 | [diff] [blame] | 123 | |
Chris Lattner | 76766cb | 2005-12-16 05:00:21 +0000 | [diff] [blame] | 124 | cl::opt<std::string> |
Chris Lattner | 78e9e10 | 2005-12-16 05:19:18 +0000 | [diff] [blame] | 125 | TargetTriple("mtriple", cl::desc("Override target triple for module")); |
Evan Cheng | 6158254 | 2008-11-05 23:21:52 +0000 | [diff] [blame] | 126 | |
| 127 | cl::opt<std::string> |
| 128 | EntryFunc("entry-function", |
| 129 | cl::desc("Specify the entry function (default = 'main') " |
| 130 | "of the executable"), |
| 131 | cl::value_desc("function"), |
| 132 | cl::init("main")); |
Eli Bendersky | 4c64758 | 2012-01-16 08:56:09 +0000 | [diff] [blame] | 133 | |
Andrew Kaylor | 1b2cfb6 | 2013-10-04 00:49:38 +0000 | [diff] [blame] | 134 | cl::list<std::string> |
Andrew Kaylor | 4404eb4 | 2013-10-28 21:58:15 +0000 | [diff] [blame] | 135 | ExtraModules("extra-module", |
Andrew Kaylor | 1b2cfb6 | 2013-10-04 00:49:38 +0000 | [diff] [blame] | 136 | cl::desc("Extra modules to be loaded"), |
Alp Toker | 0a09ebf | 2013-10-28 22:51:25 +0000 | [diff] [blame] | 137 | cl::value_desc("input bitcode")); |
Andrew Kaylor | 1b2cfb6 | 2013-10-04 00:49:38 +0000 | [diff] [blame] | 138 | |
Lang Hames | 173c69f | 2014-01-08 04:09:09 +0000 | [diff] [blame] | 139 | cl::list<std::string> |
| 140 | ExtraObjects("extra-object", |
| 141 | cl::desc("Extra object files to be loaded"), |
| 142 | cl::value_desc("input object")); |
| 143 | |
| 144 | cl::list<std::string> |
| 145 | ExtraArchives("extra-archive", |
| 146 | cl::desc("Extra archive files to be loaded"), |
| 147 | cl::value_desc("input archive")); |
| 148 | |
| 149 | cl::opt<bool> |
| 150 | EnableCacheManager("enable-cache-manager", |
Lang Hames | 1ddecc0 | 2014-01-09 05:24:05 +0000 | [diff] [blame] | 151 | cl::desc("Use cache manager to save/load mdoules"), |
Lang Hames | 173c69f | 2014-01-08 04:09:09 +0000 | [diff] [blame] | 152 | cl::init(false)); |
| 153 | |
Chris Lattner | 5564406 | 2003-10-28 22:51:44 +0000 | [diff] [blame] | 154 | cl::opt<std::string> |
Lang Hames | 1ddecc0 | 2014-01-09 05:24:05 +0000 | [diff] [blame] | 155 | ObjectCacheDir("object-cache-dir", |
| 156 | cl::desc("Directory to store cached object files " |
| 157 | "(must be user writable)"), |
| 158 | cl::init("")); |
| 159 | |
| 160 | cl::opt<std::string> |
Chris Lattner | 5564406 | 2003-10-28 22:51:44 +0000 | [diff] [blame] | 161 | FakeArgv0("fake-argv0", |
| 162 | cl::desc("Override the 'argv[0]' value passed into the executing" |
| 163 | " program"), cl::value_desc("executable")); |
Eli Bendersky | 4c64758 | 2012-01-16 08:56:09 +0000 | [diff] [blame] | 164 | |
Chris Lattner | 3f0ffd3 | 2006-09-14 06:17:09 +0000 | [diff] [blame] | 165 | cl::opt<bool> |
| 166 | DisableCoreFiles("disable-core-files", cl::Hidden, |
| 167 | cl::desc("Disable emission of core files if possible")); |
Evan Cheng | 0422bef | 2008-04-22 06:51:41 +0000 | [diff] [blame] | 168 | |
| 169 | cl::opt<bool> |
Evan Cheng | 16f036c | 2008-05-21 18:20:21 +0000 | [diff] [blame] | 170 | NoLazyCompilation("disable-lazy-compilation", |
Evan Cheng | 0422bef | 2008-04-22 06:51:41 +0000 | [diff] [blame] | 171 | cl::desc("Disable JIT lazy compilation"), |
| 172 | cl::init(false)); |
Evan Cheng | 2129f59 | 2011-07-19 06:37:02 +0000 | [diff] [blame] | 173 | |
Nick Lewycky | b0e9789 | 2012-04-18 08:34:12 +0000 | [diff] [blame] | 174 | cl::opt<bool> |
Tim Northover | d4a2f5b | 2012-10-12 09:55:13 +0000 | [diff] [blame] | 175 | GenerateSoftFloatCalls("soft-float", |
| 176 | cl::desc("Generate software floating point library calls"), |
| 177 | cl::init(false)); |
| 178 | |
Lang Hames | ef5a0ee | 2016-04-25 19:56:45 +0000 | [diff] [blame] | 179 | ExitOnError ExitOnErr; |
Chris Lattner | a0d7b08 | 2002-12-23 23:59:41 +0000 | [diff] [blame] | 180 | } |
Chris Lattner | 009f810 | 2001-10-27 08:43:52 +0000 | [diff] [blame] | 181 | |
Lang Hames | 173c69f | 2014-01-08 04:09:09 +0000 | [diff] [blame] | 182 | //===----------------------------------------------------------------------===// |
| 183 | // Object cache |
| 184 | // |
Lang Hames | 1ddecc0 | 2014-01-09 05:24:05 +0000 | [diff] [blame] | 185 | // This object cache implementation writes cached objects to disk to the |
| 186 | // directory specified by CacheDir, using a filename provided in the module |
| 187 | // descriptor. The cache tries to load a saved object using that path if the |
| 188 | // file exists. CacheDir defaults to "", in which case objects are cached |
NAKAMURA Takumi | f462f9c | 2014-01-10 10:38:28 +0000 | [diff] [blame] | 189 | // alongside their originating bitcodes. |
Lang Hames | 173c69f | 2014-01-08 04:09:09 +0000 | [diff] [blame] | 190 | // |
| 191 | class LLIObjectCache : public ObjectCache { |
| 192 | public: |
Lang Hames | 1ddecc0 | 2014-01-09 05:24:05 +0000 | [diff] [blame] | 193 | LLIObjectCache(const std::string& CacheDir) : CacheDir(CacheDir) { |
| 194 | // Add trailing '/' to cache dir if necessary. |
Lang Hames | f9dd8fd | 2014-01-09 05:29:59 +0000 | [diff] [blame] | 195 | if (!this->CacheDir.empty() && |
| 196 | this->CacheDir[this->CacheDir.size() - 1] != '/') |
NAKAMURA Takumi | f462f9c | 2014-01-10 10:38:28 +0000 | [diff] [blame] | 197 | this->CacheDir += '/'; |
Lang Hames | 1ddecc0 | 2014-01-09 05:24:05 +0000 | [diff] [blame] | 198 | } |
Alexander Kornienko | f817c1c | 2015-04-11 02:11:45 +0000 | [diff] [blame] | 199 | ~LLIObjectCache() override {} |
Lang Hames | 173c69f | 2014-01-08 04:09:09 +0000 | [diff] [blame] | 200 | |
Rafael Espindola | 48af1c2 | 2014-08-19 18:44:46 +0000 | [diff] [blame] | 201 | void notifyObjectCompiled(const Module *M, MemoryBufferRef Obj) override { |
Benjamin Kramer | 46e38f3 | 2016-06-08 10:01:20 +0000 | [diff] [blame] | 202 | const std::string &ModuleID = M->getModuleIdentifier(); |
Lang Hames | 173c69f | 2014-01-08 04:09:09 +0000 | [diff] [blame] | 203 | std::string CacheName; |
| 204 | if (!getCacheFilename(ModuleID, CacheName)) |
| 205 | return; |
NAKAMURA Takumi | 390e060 | 2014-01-10 10:38:34 +0000 | [diff] [blame] | 206 | if (!CacheDir.empty()) { // Create user-defined cache dir. |
Rafael Espindola | f662e00 | 2015-07-15 21:24:07 +0000 | [diff] [blame] | 207 | SmallString<128> dir(sys::path::parent_path(CacheName)); |
NAKAMURA Takumi | 390e060 | 2014-01-10 10:38:34 +0000 | [diff] [blame] | 208 | sys::fs::create_directories(Twine(dir)); |
| 209 | } |
Rafael Espindola | 3fd1e99 | 2014-08-25 18:16:47 +0000 | [diff] [blame] | 210 | std::error_code EC; |
| 211 | raw_fd_ostream outfile(CacheName, EC, sys::fs::F_None); |
Rafael Espindola | 48af1c2 | 2014-08-19 18:44:46 +0000 | [diff] [blame] | 212 | outfile.write(Obj.getBufferStart(), Obj.getBufferSize()); |
Lang Hames | 173c69f | 2014-01-08 04:09:09 +0000 | [diff] [blame] | 213 | outfile.close(); |
| 214 | } |
| 215 | |
Rafael Espindola | 5f2bb7d | 2014-08-13 18:49:01 +0000 | [diff] [blame] | 216 | std::unique_ptr<MemoryBuffer> getObject(const Module* M) override { |
Benjamin Kramer | 46e38f3 | 2016-06-08 10:01:20 +0000 | [diff] [blame] | 217 | const std::string &ModuleID = M->getModuleIdentifier(); |
Lang Hames | 173c69f | 2014-01-08 04:09:09 +0000 | [diff] [blame] | 218 | std::string CacheName; |
| 219 | if (!getCacheFilename(ModuleID, CacheName)) |
Craig Topper | e6cb63e | 2014-04-25 04:24:47 +0000 | [diff] [blame] | 220 | return nullptr; |
Lang Hames | 173c69f | 2014-01-08 04:09:09 +0000 | [diff] [blame] | 221 | // Load the object from the cache filename |
Rafael Espindola | adf21f2 | 2014-07-06 17:43:13 +0000 | [diff] [blame] | 222 | ErrorOr<std::unique_ptr<MemoryBuffer>> IRObjectBuffer = |
Malcolm Parsons | 06ac79c | 2016-11-02 16:43:50 +0000 | [diff] [blame] | 223 | MemoryBuffer::getFile(CacheName, -1, false); |
Lang Hames | 173c69f | 2014-01-08 04:09:09 +0000 | [diff] [blame] | 224 | // If the file isn't there, that's OK. |
| 225 | if (!IRObjectBuffer) |
Craig Topper | e6cb63e | 2014-04-25 04:24:47 +0000 | [diff] [blame] | 226 | return nullptr; |
Lang Hames | 173c69f | 2014-01-08 04:09:09 +0000 | [diff] [blame] | 227 | // MCJIT will want to write into this buffer, and we don't want that |
| 228 | // because the file has probably just been mmapped. Instead we make |
| 229 | // a copy. The filed-based buffer will be released when it goes |
| 230 | // out of scope. |
Rafael Espindola | 3560ff2 | 2014-08-27 20:03:13 +0000 | [diff] [blame] | 231 | return MemoryBuffer::getMemBufferCopy(IRObjectBuffer.get()->getBuffer()); |
Lang Hames | 173c69f | 2014-01-08 04:09:09 +0000 | [diff] [blame] | 232 | } |
| 233 | |
| 234 | private: |
Lang Hames | 1ddecc0 | 2014-01-09 05:24:05 +0000 | [diff] [blame] | 235 | std::string CacheDir; |
| 236 | |
Lang Hames | 173c69f | 2014-01-08 04:09:09 +0000 | [diff] [blame] | 237 | bool getCacheFilename(const std::string &ModID, std::string &CacheName) { |
| 238 | std::string Prefix("file:"); |
| 239 | size_t PrefixLength = Prefix.length(); |
| 240 | if (ModID.substr(0, PrefixLength) != Prefix) |
| 241 | return false; |
NAKAMURA Takumi | d7fd6d9 | 2014-01-10 10:38:40 +0000 | [diff] [blame] | 242 | std::string CacheSubdir = ModID.substr(PrefixLength); |
| 243 | #if defined(_WIN32) |
| 244 | // Transform "X:\foo" => "/X\foo" for convenience. |
| 245 | if (isalpha(CacheSubdir[0]) && CacheSubdir[1] == ':') { |
| 246 | CacheSubdir[1] = CacheSubdir[0]; |
| 247 | CacheSubdir[0] = '/'; |
| 248 | } |
| 249 | #endif |
| 250 | CacheName = CacheDir + CacheSubdir; |
Lang Hames | 173c69f | 2014-01-08 04:09:09 +0000 | [diff] [blame] | 251 | size_t pos = CacheName.rfind('.'); |
| 252 | CacheName.replace(pos, CacheName.length() - pos, ".o"); |
| 253 | return true; |
| 254 | } |
| 255 | }; |
| 256 | |
Andrew Kaylor | 1ca510e | 2013-10-29 01:29:56 +0000 | [diff] [blame] | 257 | // On Mingw and Cygwin, an external symbol named '__main' is called from the |
Simon Pilgrim | dae11f7 | 2016-11-20 13:31:13 +0000 | [diff] [blame] | 258 | // generated 'main' function to allow static initialization. To avoid linking |
Andrew Kaylor | 1ca510e | 2013-10-29 01:29:56 +0000 | [diff] [blame] | 259 | // problems with remote targets (because lli's remote target support does not |
| 260 | // currently handle external linking) we add a secondary module which defines |
| 261 | // an empty '__main' function. |
Mehdi Amini | a7de820 | 2016-04-18 18:52:39 +0000 | [diff] [blame] | 262 | static void addCygMingExtraModule(ExecutionEngine &EE, LLVMContext &Context, |
Andrew Kaylor | 1ca510e | 2013-10-29 01:29:56 +0000 | [diff] [blame] | 263 | StringRef TargetTripleStr) { |
| 264 | IRBuilder<> Builder(Context); |
| 265 | Triple TargetTriple(TargetTripleStr); |
| 266 | |
| 267 | // Create a new module. |
Rafael Espindola | 2a8a279 | 2014-08-19 04:04:25 +0000 | [diff] [blame] | 268 | std::unique_ptr<Module> M = make_unique<Module>("CygMingHelper", Context); |
Andrew Kaylor | 1ca510e | 2013-10-29 01:29:56 +0000 | [diff] [blame] | 269 | M->setTargetTriple(TargetTripleStr); |
| 270 | |
| 271 | // Create an empty function named "__main". |
| 272 | Function *Result; |
| 273 | if (TargetTriple.isArch64Bit()) { |
| 274 | Result = Function::Create( |
| 275 | TypeBuilder<int64_t(void), false>::get(Context), |
Rafael Espindola | 2a8a279 | 2014-08-19 04:04:25 +0000 | [diff] [blame] | 276 | GlobalValue::ExternalLinkage, "__main", M.get()); |
Andrew Kaylor | 1ca510e | 2013-10-29 01:29:56 +0000 | [diff] [blame] | 277 | } else { |
| 278 | Result = Function::Create( |
| 279 | TypeBuilder<int32_t(void), false>::get(Context), |
Rafael Espindola | 2a8a279 | 2014-08-19 04:04:25 +0000 | [diff] [blame] | 280 | GlobalValue::ExternalLinkage, "__main", M.get()); |
Andrew Kaylor | 1ca510e | 2013-10-29 01:29:56 +0000 | [diff] [blame] | 281 | } |
| 282 | BasicBlock *BB = BasicBlock::Create(Context, "__main", Result); |
| 283 | Builder.SetInsertPoint(BB); |
| 284 | Value *ReturnVal; |
| 285 | if (TargetTriple.isArch64Bit()) |
| 286 | ReturnVal = ConstantInt::get(Context, APInt(64, 0)); |
| 287 | else |
| 288 | ReturnVal = ConstantInt::get(Context, APInt(32, 0)); |
| 289 | Builder.CreateRet(ReturnVal); |
| 290 | |
| 291 | // Add this new module to the ExecutionEngine. |
Mehdi Amini | a7de820 | 2016-04-18 18:52:39 +0000 | [diff] [blame] | 292 | EE.addModule(std::move(M)); |
Andrew Kaylor | 1ca510e | 2013-10-29 01:29:56 +0000 | [diff] [blame] | 293 | } |
| 294 | |
Lang Hames | 1899d0c | 2015-06-09 02:43:27 +0000 | [diff] [blame] | 295 | CodeGenOpt::Level getOptLevel() { |
| 296 | switch (OptLevel) { |
| 297 | default: |
Jonas Devlieghere | 4a2863c | 2018-04-22 08:02:11 +0000 | [diff] [blame] | 298 | WithColor::error(errs(), "lli") << "invalid optimization level.\n"; |
Lang Hames | 1899d0c | 2015-06-09 02:43:27 +0000 | [diff] [blame] | 299 | exit(1); |
| 300 | case '0': return CodeGenOpt::None; |
| 301 | case '1': return CodeGenOpt::Less; |
| 302 | case ' ': |
| 303 | case '2': return CodeGenOpt::Default; |
| 304 | case '3': return CodeGenOpt::Aggressive; |
| 305 | } |
| 306 | llvm_unreachable("Unrecognized opt level."); |
| 307 | } |
Andrew Kaylor | 1ca510e | 2013-10-29 01:29:56 +0000 | [diff] [blame] | 308 | |
Davide Italiano | da8e6b2 | 2016-11-17 22:58:13 +0000 | [diff] [blame] | 309 | LLVM_ATTRIBUTE_NORETURN |
| 310 | static void reportError(SMDiagnostic Err, const char *ProgName) { |
| 311 | Err.print(ProgName, errs()); |
| 312 | exit(1); |
| 313 | } |
| 314 | |
Chris Lattner | d7ff578 | 2001-08-23 17:05:04 +0000 | [diff] [blame] | 315 | //===----------------------------------------------------------------------===// |
Chris Lattner | d7ff578 | 2001-08-23 17:05:04 +0000 | [diff] [blame] | 316 | // main Driver function |
| 317 | // |
Misha Brukman | 5b255e5 | 2003-10-14 21:39:53 +0000 | [diff] [blame] | 318 | int main(int argc, char **argv, char * const *envp) { |
Rui Ueyama | 197194b | 2018-04-13 18:26:06 +0000 | [diff] [blame] | 319 | InitLLVM X(argc, argv); |
Daniel Dunbar | 3d92d93 | 2009-07-16 02:04:54 +0000 | [diff] [blame] | 320 | |
Lang Hames | ef5a0ee | 2016-04-25 19:56:45 +0000 | [diff] [blame] | 321 | if (argc > 1) |
| 322 | ExitOnErr.setBanner(std::string(argv[0]) + ": "); |
| 323 | |
Daniel Dunbar | 3d92d93 | 2009-07-16 02:04:54 +0000 | [diff] [blame] | 324 | // If we have a native target, initialize it to ensure it is linked in and |
| 325 | // usable by the JIT. |
| 326 | InitializeNativeTarget(); |
Jim Grosbach | 7b16249 | 2011-03-18 22:48:41 +0000 | [diff] [blame] | 327 | InitializeNativeTargetAsmPrinter(); |
Jim Grosbach | 2cce3f9 | 2012-11-05 19:06:05 +0000 | [diff] [blame] | 328 | InitializeNativeTargetAsmParser(); |
Daniel Dunbar | 3d92d93 | 2009-07-16 02:04:54 +0000 | [diff] [blame] | 329 | |
Chris Lattner | 2785bdb | 2007-05-06 04:58:26 +0000 | [diff] [blame] | 330 | cl::ParseCommandLineOptions(argc, argv, |
Dan Gohman | 2c6a821 | 2007-10-08 15:45:12 +0000 | [diff] [blame] | 331 | "llvm interpreter & dynamic compiler\n"); |
Reid Spencer | 996ec72 | 2004-12-30 05:36:08 +0000 | [diff] [blame] | 332 | |
Chris Lattner | 2785bdb | 2007-05-06 04:58:26 +0000 | [diff] [blame] | 333 | // If the user doesn't want core files, disable them. |
| 334 | if (DisableCoreFiles) |
| 335 | sys::Process::PreventCoreFiles(); |
Eli Bendersky | 4c64758 | 2012-01-16 08:56:09 +0000 | [diff] [blame] | 336 | |
Mehdi Amini | a7de820 | 2016-04-18 18:52:39 +0000 | [diff] [blame] | 337 | LLVMContext Context; |
| 338 | |
Gabor Greif | e16561c | 2007-07-05 17:07:56 +0000 | [diff] [blame] | 339 | // Load the bitcode... |
Daniel Dunbar | 9589bf8 | 2010-11-13 00:28:01 +0000 | [diff] [blame] | 340 | SMDiagnostic Err; |
Rafael Espindola | d233b06 | 2014-08-26 17:29:46 +0000 | [diff] [blame] | 341 | std::unique_ptr<Module> Owner = parseIRFile(InputFile, Err, Context); |
Rafael Espindola | 2a8a279 | 2014-08-19 04:04:25 +0000 | [diff] [blame] | 342 | Module *Mod = Owner.get(); |
Davide Italiano | da8e6b2 | 2016-11-17 22:58:13 +0000 | [diff] [blame] | 343 | if (!Mod) |
| 344 | reportError(Err, argv[0]); |
Chris Lattner | 2785bdb | 2007-05-06 04:58:26 +0000 | [diff] [blame] | 345 | |
Lang Hames | 368c422 | 2016-08-02 21:00:40 +0000 | [diff] [blame] | 346 | if (UseJITKind == JITKind::OrcLazy) { |
| 347 | std::vector<std::unique_ptr<Module>> Ms; |
| 348 | Ms.push_back(std::move(Owner)); |
| 349 | for (auto &ExtraMod : ExtraModules) { |
| 350 | Ms.push_back(parseIRFile(ExtraMod, Err, Context)); |
Davide Italiano | da8e6b2 | 2016-11-17 22:58:13 +0000 | [diff] [blame] | 351 | if (!Ms.back()) |
| 352 | reportError(Err, argv[0]); |
Lang Hames | 368c422 | 2016-08-02 21:00:40 +0000 | [diff] [blame] | 353 | } |
Lang Hames | 1a2e656 | 2016-10-28 16:52:34 +0000 | [diff] [blame] | 354 | std::vector<std::string> Args; |
| 355 | Args.push_back(InputFile); |
| 356 | for (auto &Arg : InputArgv) |
| 357 | Args.push_back(Arg); |
| 358 | return runOrcLazyJIT(std::move(Ms), Args); |
Lang Hames | 368c422 | 2016-08-02 21:00:40 +0000 | [diff] [blame] | 359 | } |
Lang Hames | 9528bba | 2015-03-25 12:11:48 +0000 | [diff] [blame] | 360 | |
Lang Hames | 173c69f | 2014-01-08 04:09:09 +0000 | [diff] [blame] | 361 | if (EnableCacheManager) { |
Eric Christopher | 79cc1e3 | 2014-09-02 22:28:02 +0000 | [diff] [blame] | 362 | std::string CacheName("file:"); |
| 363 | CacheName.append(InputFile); |
| 364 | Mod->setModuleIdentifier(CacheName); |
Lang Hames | 173c69f | 2014-01-08 04:09:09 +0000 | [diff] [blame] | 365 | } |
| 366 | |
Jeffrey Yasskin | 091217b | 2010-01-27 20:34:15 +0000 | [diff] [blame] | 367 | // If not jitting lazily, load the whole bitcode file eagerly too. |
| 368 | if (NoLazyCompilation) { |
Davide Italiano | b0e067b | 2016-11-09 21:30:33 +0000 | [diff] [blame] | 369 | // Use *argv instead of argv[0] to work around a wrong GCC warning. |
| 370 | ExitOnError ExitOnErr(std::string(*argv) + |
Peter Collingbourne | 7f00d0a | 2016-11-09 17:49:19 +0000 | [diff] [blame] | 371 | ": bitcode didn't read correctly: "); |
| 372 | ExitOnErr(Mod->materializeAll()); |
Evan Cheng | 0422bef | 2008-04-22 06:51:41 +0000 | [diff] [blame] | 373 | } |
Chris Lattner | 2785bdb | 2007-05-06 04:58:26 +0000 | [diff] [blame] | 374 | |
Rafael Espindola | e9fab9b | 2014-01-14 23:51:27 +0000 | [diff] [blame] | 375 | std::string ErrorMsg; |
Rafael Espindola | 2a8a279 | 2014-08-19 04:04:25 +0000 | [diff] [blame] | 376 | EngineBuilder builder(std::move(Owner)); |
Jeffrey Yasskin | 31faeff | 2010-02-05 16:19:36 +0000 | [diff] [blame] | 377 | builder.setMArch(MArch); |
Craig Topper | 243f20f | 2018-01-09 18:14:18 +0000 | [diff] [blame] | 378 | builder.setMCPU(getCPUStr()); |
| 379 | builder.setMAttrs(getFeatureList()); |
Rafael Espindola | 8c34dd8 | 2016-05-18 22:04:49 +0000 | [diff] [blame] | 380 | if (RelocModel.getNumOccurrences()) |
| 381 | builder.setRelocationModel(RelocModel); |
Rafael Espindola | 79e238a | 2017-08-03 02:16:21 +0000 | [diff] [blame] | 382 | if (CMModel.getNumOccurrences()) |
| 383 | builder.setCodeModel(CMModel); |
Daniel Dunbar | a78d809 | 2009-07-18 08:07:13 +0000 | [diff] [blame] | 384 | builder.setErrorStr(&ErrorMsg); |
| 385 | builder.setEngineKind(ForceInterpreter |
Reid Kleckner | fc8a2d5 | 2009-07-18 00:42:18 +0000 | [diff] [blame] | 386 | ? EngineKind::Interpreter |
| 387 | : EngineKind::JIT); |
Lang Hames | 9528bba | 2015-03-25 12:11:48 +0000 | [diff] [blame] | 388 | builder.setUseOrcMCJITReplacement(UseJITKind == JITKind::OrcMCJITReplacement); |
Reid Kleckner | fc8a2d5 | 2009-07-18 00:42:18 +0000 | [diff] [blame] | 389 | |
Chris Lattner | 2785bdb | 2007-05-06 04:58:26 +0000 | [diff] [blame] | 390 | // If we are supposed to override the target triple, do so now. |
| 391 | if (!TargetTriple.empty()) |
Duncan Sands | 3bd97fe | 2010-08-28 01:30:02 +0000 | [diff] [blame] | 392 | Mod->setTargetTriple(Triple::normalize(TargetTriple)); |
Evan Cheng | 0422bef | 2008-04-22 06:51:41 +0000 | [diff] [blame] | 393 | |
Eli Bendersky | 4c64758 | 2012-01-16 08:56:09 +0000 | [diff] [blame] | 394 | // Enable MCJIT if desired. |
Craig Topper | e6cb63e | 2014-04-25 04:24:47 +0000 | [diff] [blame] | 395 | RTDyldMemoryManager *RTDyldMM = nullptr; |
Eric Christopher | 79cc1e3 | 2014-09-02 22:28:02 +0000 | [diff] [blame] | 396 | if (!ForceInterpreter) { |
Jim Grosbach | 0f435d0 | 2012-09-05 16:50:34 +0000 | [diff] [blame] | 397 | if (RemoteMCJIT) |
Lang Hames | 9d7a269 | 2016-01-11 16:35:55 +0000 | [diff] [blame] | 398 | RTDyldMM = new ForwardingMemoryManager(); |
Jim Grosbach | 0f435d0 | 2012-09-05 16:50:34 +0000 | [diff] [blame] | 399 | else |
Filip Pizlo | 9bc53e8 | 2013-05-14 19:29:00 +0000 | [diff] [blame] | 400 | RTDyldMM = new SectionMemoryManager(); |
Lang Hames | 4a5697e | 2014-12-03 00:51:19 +0000 | [diff] [blame] | 401 | |
| 402 | // Deliberately construct a temp std::unique_ptr to pass in. Do not null out |
| 403 | // RTDyldMM: We still use it below, even though we don't own it. |
| 404 | builder.setMCJITMemoryManager( |
| 405 | std::unique_ptr<RTDyldMemoryManager>(RTDyldMM)); |
Lang Hames | 0f15490 | 2014-09-23 16:56:02 +0000 | [diff] [blame] | 406 | } else if (RemoteMCJIT) { |
Jonas Devlieghere | 4a2863c | 2018-04-22 08:02:11 +0000 | [diff] [blame] | 407 | WithColor::error(errs(), argv[0]) |
| 408 | << "remote process execution does not work with the interpreter.\n"; |
Lang Hames | 0f15490 | 2014-09-23 16:56:02 +0000 | [diff] [blame] | 409 | exit(1); |
Eli Bendersky | 4c64758 | 2012-01-16 08:56:09 +0000 | [diff] [blame] | 410 | } |
Daniel Dunbar | 70ff8b0 | 2010-11-17 16:06:37 +0000 | [diff] [blame] | 411 | |
Lang Hames | 1899d0c | 2015-06-09 02:43:27 +0000 | [diff] [blame] | 412 | builder.setOptLevel(getOptLevel()); |
Reid Kleckner | fc8a2d5 | 2009-07-18 00:42:18 +0000 | [diff] [blame] | 413 | |
David Blaikie | c14bfec | 2017-11-27 19:43:58 +0000 | [diff] [blame] | 414 | TargetOptions Options = InitTargetOptionsFromCodeGenFlags(); |
Tim Northover | d4a2f5b | 2012-10-12 09:55:13 +0000 | [diff] [blame] | 415 | if (FloatABIForCalls != FloatABI::Default) |
| 416 | Options.FloatABIType = FloatABIForCalls; |
Tim Northover | d4a2f5b | 2012-10-12 09:55:13 +0000 | [diff] [blame] | 417 | |
Tim Northover | d4a2f5b | 2012-10-12 09:55:13 +0000 | [diff] [blame] | 418 | builder.setTargetOptions(Options); |
| 419 | |
Mehdi Amini | a7de820 | 2016-04-18 18:52:39 +0000 | [diff] [blame] | 420 | std::unique_ptr<ExecutionEngine> EE(builder.create()); |
Chris Lattner | f840ed7 | 2009-07-07 18:31:09 +0000 | [diff] [blame] | 421 | if (!EE) { |
| 422 | if (!ErrorMsg.empty()) |
Jonas Devlieghere | 4a2863c | 2018-04-22 08:02:11 +0000 | [diff] [blame] | 423 | WithColor::error(errs(), argv[0]) |
| 424 | << "error creating EE: " << ErrorMsg << "\n"; |
Chris Lattner | f840ed7 | 2009-07-07 18:31:09 +0000 | [diff] [blame] | 425 | else |
Jonas Devlieghere | 4a2863c | 2018-04-22 08:02:11 +0000 | [diff] [blame] | 426 | WithColor::error(errs(), argv[0]) << "unknown error creating EE!\n"; |
Chris Lattner | 2785bdb | 2007-05-06 04:58:26 +0000 | [diff] [blame] | 427 | exit(1); |
| 428 | } |
| 429 | |
Mehdi Amini | a7de820 | 2016-04-18 18:52:39 +0000 | [diff] [blame] | 430 | std::unique_ptr<LLIObjectCache> CacheManager; |
Lang Hames | 173c69f | 2014-01-08 04:09:09 +0000 | [diff] [blame] | 431 | if (EnableCacheManager) { |
Mehdi Amini | a7de820 | 2016-04-18 18:52:39 +0000 | [diff] [blame] | 432 | CacheManager.reset(new LLIObjectCache(ObjectCacheDir)); |
| 433 | EE->setObjectCache(CacheManager.get()); |
Lang Hames | 173c69f | 2014-01-08 04:09:09 +0000 | [diff] [blame] | 434 | } |
| 435 | |
Andrew Kaylor | 1b2cfb6 | 2013-10-04 00:49:38 +0000 | [diff] [blame] | 436 | // Load any additional modules specified on the command line. |
| 437 | for (unsigned i = 0, e = ExtraModules.size(); i != e; ++i) { |
Rafael Espindola | d233b06 | 2014-08-26 17:29:46 +0000 | [diff] [blame] | 438 | std::unique_ptr<Module> XMod = parseIRFile(ExtraModules[i], Err, Context); |
Davide Italiano | da8e6b2 | 2016-11-17 22:58:13 +0000 | [diff] [blame] | 439 | if (!XMod) |
| 440 | reportError(Err, argv[0]); |
Lang Hames | 173c69f | 2014-01-08 04:09:09 +0000 | [diff] [blame] | 441 | if (EnableCacheManager) { |
Eric Christopher | 79cc1e3 | 2014-09-02 22:28:02 +0000 | [diff] [blame] | 442 | std::string CacheName("file:"); |
| 443 | CacheName.append(ExtraModules[i]); |
| 444 | XMod->setModuleIdentifier(CacheName); |
Lang Hames | 173c69f | 2014-01-08 04:09:09 +0000 | [diff] [blame] | 445 | } |
Rafael Espindola | 2a8a279 | 2014-08-19 04:04:25 +0000 | [diff] [blame] | 446 | EE->addModule(std::move(XMod)); |
Andrew Kaylor | 1b2cfb6 | 2013-10-04 00:49:38 +0000 | [diff] [blame] | 447 | } |
| 448 | |
Lang Hames | 173c69f | 2014-01-08 04:09:09 +0000 | [diff] [blame] | 449 | for (unsigned i = 0, e = ExtraObjects.size(); i != e; ++i) { |
Kevin Enderby | 3fcdf6a | 2016-04-06 22:14:09 +0000 | [diff] [blame] | 450 | Expected<object::OwningBinary<object::ObjectFile>> Obj = |
Rafael Espindola | 51cc360 | 2014-01-22 00:14:49 +0000 | [diff] [blame] | 451 | object::ObjectFile::createObjectFile(ExtraObjects[i]); |
Lang Hames | 173c69f | 2014-01-08 04:09:09 +0000 | [diff] [blame] | 452 | if (!Obj) { |
Kevin Enderby | 3fcdf6a | 2016-04-06 22:14:09 +0000 | [diff] [blame] | 453 | // TODO: Actually report errors helpfully. |
| 454 | consumeError(Obj.takeError()); |
Davide Italiano | da8e6b2 | 2016-11-17 22:58:13 +0000 | [diff] [blame] | 455 | reportError(Err, argv[0]); |
Lang Hames | 173c69f | 2014-01-08 04:09:09 +0000 | [diff] [blame] | 456 | } |
Rafael Espindola | 061beab | 2014-08-20 15:19:37 +0000 | [diff] [blame] | 457 | object::OwningBinary<object::ObjectFile> &O = Obj.get(); |
Rafael Espindola | 7271c19 | 2014-08-26 21:04:04 +0000 | [diff] [blame] | 458 | EE->addObjectFile(std::move(O)); |
Lang Hames | 173c69f | 2014-01-08 04:09:09 +0000 | [diff] [blame] | 459 | } |
| 460 | |
| 461 | for (unsigned i = 0, e = ExtraArchives.size(); i != e; ++i) { |
Rafael Espindola | 48af1c2 | 2014-08-19 18:44:46 +0000 | [diff] [blame] | 462 | ErrorOr<std::unique_ptr<MemoryBuffer>> ArBufOrErr = |
Rafael Espindola | adf21f2 | 2014-07-06 17:43:13 +0000 | [diff] [blame] | 463 | MemoryBuffer::getFileOrSTDIN(ExtraArchives[i]); |
Davide Italiano | da8e6b2 | 2016-11-17 22:58:13 +0000 | [diff] [blame] | 464 | if (!ArBufOrErr) |
| 465 | reportError(Err, argv[0]); |
Rafael Espindola | 48af1c2 | 2014-08-19 18:44:46 +0000 | [diff] [blame] | 466 | std::unique_ptr<MemoryBuffer> &ArBuf = ArBufOrErr.get(); |
Rafael Espindola | e192341 | 2014-08-01 18:31:17 +0000 | [diff] [blame] | 467 | |
Kevin Enderby | c60a321 | 2016-06-29 20:35:44 +0000 | [diff] [blame] | 468 | Expected<std::unique_ptr<object::Archive>> ArOrErr = |
Rafael Espindola | 48af1c2 | 2014-08-19 18:44:46 +0000 | [diff] [blame] | 469 | object::Archive::create(ArBuf->getMemBufferRef()); |
Kevin Enderby | c60a321 | 2016-06-29 20:35:44 +0000 | [diff] [blame] | 470 | if (!ArOrErr) { |
| 471 | std::string Buf; |
| 472 | raw_string_ostream OS(Buf); |
| 473 | logAllUnhandledErrors(ArOrErr.takeError(), OS, ""); |
| 474 | OS.flush(); |
| 475 | errs() << Buf; |
Davide Italiano | 8651144 | 2016-11-17 22:59:13 +0000 | [diff] [blame] | 476 | exit(1); |
Lang Hames | 173c69f | 2014-01-08 04:09:09 +0000 | [diff] [blame] | 477 | } |
Rafael Espindola | 48af1c2 | 2014-08-19 18:44:46 +0000 | [diff] [blame] | 478 | std::unique_ptr<object::Archive> &Ar = ArOrErr.get(); |
| 479 | |
| 480 | object::OwningBinary<object::Archive> OB(std::move(Ar), std::move(ArBuf)); |
| 481 | |
| 482 | EE->addArchive(std::move(OB)); |
Lang Hames | 173c69f | 2014-01-08 04:09:09 +0000 | [diff] [blame] | 483 | } |
| 484 | |
Andrew Kaylor | 1ca510e | 2013-10-29 01:29:56 +0000 | [diff] [blame] | 485 | // If the target is Cygwin/MingW and we are generating remote code, we |
| 486 | // need an extra module to help out with linking. |
| 487 | if (RemoteMCJIT && Triple(Mod->getTargetTriple()).isOSCygMing()) { |
Mehdi Amini | a7de820 | 2016-04-18 18:52:39 +0000 | [diff] [blame] | 488 | addCygMingExtraModule(*EE, Context, Mod->getTargetTriple()); |
Andrew Kaylor | 1ca510e | 2013-10-29 01:29:56 +0000 | [diff] [blame] | 489 | } |
| 490 | |
Eli Bendersky | 5262ad2 | 2012-03-13 08:33:15 +0000 | [diff] [blame] | 491 | // The following functions have no effect if their respective profiling |
| 492 | // support wasn't enabled in the build configuration. |
| 493 | EE->RegisterJITEventListener( |
| 494 | JITEventListener::createOProfileJITEventListener()); |
| 495 | EE->RegisterJITEventListener( |
| 496 | JITEventListener::createIntelJITEventListener()); |
Jeffrey Yasskin | 0b08f3d | 2009-06-25 02:04:04 +0000 | [diff] [blame] | 497 | |
Jim Grosbach | 0f435d0 | 2012-09-05 16:50:34 +0000 | [diff] [blame] | 498 | if (!NoLazyCompilation && RemoteMCJIT) { |
Jonas Devlieghere | 4a2863c | 2018-04-22 08:02:11 +0000 | [diff] [blame] | 499 | WithColor::warning(errs(), argv[0]) |
| 500 | << "remote mcjit does not support lazy compilation\n"; |
Jim Grosbach | 0f435d0 | 2012-09-05 16:50:34 +0000 | [diff] [blame] | 501 | NoLazyCompilation = true; |
| 502 | } |
Jeffrey Yasskin | aa8814a | 2009-10-27 22:39:42 +0000 | [diff] [blame] | 503 | EE->DisableLazyCompilation(NoLazyCompilation); |
Evan Cheng | 0422bef | 2008-04-22 06:51:41 +0000 | [diff] [blame] | 504 | |
Chris Lattner | 2785bdb | 2007-05-06 04:58:26 +0000 | [diff] [blame] | 505 | // If the user specifically requested an argv[0] to pass into the program, |
| 506 | // do it now. |
| 507 | if (!FakeArgv0.empty()) { |
Chris Bieneman | e71fb5c | 2015-01-22 01:49:59 +0000 | [diff] [blame] | 508 | InputFile = static_cast<std::string>(FakeArgv0); |
Chris Lattner | 2785bdb | 2007-05-06 04:58:26 +0000 | [diff] [blame] | 509 | } else { |
| 510 | // Otherwise, if there is a .bc suffix on the executable strip it off, it |
| 511 | // might confuse the program. |
Benjamin Kramer | a944a9a | 2010-04-15 11:33:14 +0000 | [diff] [blame] | 512 | if (StringRef(InputFile).endswith(".bc")) |
Chris Lattner | 2785bdb | 2007-05-06 04:58:26 +0000 | [diff] [blame] | 513 | InputFile.erase(InputFile.length() - 3); |
| 514 | } |
| 515 | |
| 516 | // Add the module's name to the start of the vector of arguments to main(). |
| 517 | InputArgv.insert(InputArgv.begin(), InputFile); |
| 518 | |
| 519 | // Call the main function from M as if its signature were: |
| 520 | // int main (int argc, char **argv, const char **envp) |
| 521 | // using the contents of Args to determine argc & argv, and the contents of |
| 522 | // EnvVars to determine envp. |
| 523 | // |
Evan Cheng | 6158254 | 2008-11-05 23:21:52 +0000 | [diff] [blame] | 524 | Function *EntryFn = Mod->getFunction(EntryFunc); |
| 525 | if (!EntryFn) { |
Jonas Devlieghere | 4a2863c | 2018-04-22 08:02:11 +0000 | [diff] [blame] | 526 | WithColor::error(errs(), argv[0]) |
| 527 | << '\'' << EntryFunc << "\' function not found in module.\n"; |
Chris Lattner | 2785bdb | 2007-05-06 04:58:26 +0000 | [diff] [blame] | 528 | return -1; |
| 529 | } |
| 530 | |
Chris Lattner | 2785bdb | 2007-05-06 04:58:26 +0000 | [diff] [blame] | 531 | // Reset errno to zero on entry to main. |
| 532 | errno = 0; |
Eli Bendersky | 4c64758 | 2012-01-16 08:56:09 +0000 | [diff] [blame] | 533 | |
Lang Hames | 3fde652 | 2016-04-18 19:55:43 +0000 | [diff] [blame] | 534 | int Result = -1; |
Andrew Kaylor | c87c347 | 2013-10-02 18:04:40 +0000 | [diff] [blame] | 535 | |
Lang Hames | 9d7a269 | 2016-01-11 16:35:55 +0000 | [diff] [blame] | 536 | // Sanity check use of remote-jit: LLI currently only supports use of the |
| 537 | // remote JIT on Unix platforms. |
Lang Hames | 9d7a269 | 2016-01-11 16:35:55 +0000 | [diff] [blame] | 538 | if (RemoteMCJIT) { |
| 539 | #ifndef LLVM_ON_UNIX |
Jonas Devlieghere | 4a2863c | 2018-04-22 08:02:11 +0000 | [diff] [blame] | 540 | WithColor::warning(errs(), argv[0]) |
Jonas Devlieghere | 7b5fa24 | 2018-04-22 08:35:00 +0000 | [diff] [blame^] | 541 | << "host does not support external remote targets.\n"; |
| 542 | WithColor::note() << "defaulting to local execution\n"; |
Lang Hames | 4b6e021 | 2016-01-11 21:41:34 +0000 | [diff] [blame] | 543 | return -1; |
Lang Hames | 9d7a269 | 2016-01-11 16:35:55 +0000 | [diff] [blame] | 544 | #else |
| 545 | if (ChildExecPath.empty()) { |
Jonas Devlieghere | 4a2863c | 2018-04-22 08:02:11 +0000 | [diff] [blame] | 546 | WithColor::error(errs(), argv[0]) |
| 547 | << "-remote-mcjit requires -mcjit-remote-process.\n"; |
Lang Hames | 9d7a269 | 2016-01-11 16:35:55 +0000 | [diff] [blame] | 548 | exit(1); |
| 549 | } else if (!sys::fs::can_execute(ChildExecPath)) { |
Jonas Devlieghere | 4a2863c | 2018-04-22 08:02:11 +0000 | [diff] [blame] | 550 | WithColor::error(errs(), argv[0]) |
| 551 | << "unable to find usable child executable: '" << ChildExecPath |
| 552 | << "'\n"; |
Lang Hames | 9d7a269 | 2016-01-11 16:35:55 +0000 | [diff] [blame] | 553 | return -1; |
| 554 | } |
| 555 | #endif |
| 556 | } |
| 557 | |
Andrew Kaylor | 58365b9 | 2012-11-27 19:49:00 +0000 | [diff] [blame] | 558 | if (!RemoteMCJIT) { |
Andrew Kaylor | 6587bcf | 2013-10-11 22:47:10 +0000 | [diff] [blame] | 559 | // If the program doesn't explicitly call exit, we will need the Exit |
| 560 | // function later on to make an explicit call, so get the function now. |
| 561 | Constant *Exit = Mod->getOrInsertFunction("exit", Type::getVoidTy(Context), |
Serge Guelton | 59a2d7b | 2017-04-11 15:01:18 +0000 | [diff] [blame] | 562 | Type::getInt32Ty(Context)); |
Andrew Kaylor | 6587bcf | 2013-10-11 22:47:10 +0000 | [diff] [blame] | 563 | |
Andrew Kaylor | c87c347 | 2013-10-02 18:04:40 +0000 | [diff] [blame] | 564 | // Run static constructors. |
Eric Christopher | 79cc1e3 | 2014-09-02 22:28:02 +0000 | [diff] [blame] | 565 | if (!ForceInterpreter) { |
Andrew Kaylor | ea39592 | 2013-10-01 01:47:35 +0000 | [diff] [blame] | 566 | // Give MCJIT a chance to apply relocations and set page permissions. |
| 567 | EE->finalizeObject(); |
| 568 | } |
| 569 | EE->runStaticConstructorsDestructors(false); |
Evan Cheng | 0422bef | 2008-04-22 06:51:41 +0000 | [diff] [blame] | 570 | |
NAKAMURA Takumi | 87e0880 | 2013-12-07 11:21:42 +0000 | [diff] [blame] | 571 | // Trigger compilation separately so code regions that need to be |
Andrew Kaylor | c87c347 | 2013-10-02 18:04:40 +0000 | [diff] [blame] | 572 | // invalidated will be known. |
| 573 | (void)EE->getPointerToFunction(EntryFn); |
| 574 | // Clear instruction cache before code will be executed. |
| 575 | if (RTDyldMM) |
| 576 | static_cast<SectionMemoryManager*>(RTDyldMM)->invalidateInstructionCache(); |
| 577 | |
| 578 | // Run main. |
| 579 | Result = EE->runFunctionAsMain(EntryFn, InputArgv, envp); |
| 580 | |
| 581 | // Run static destructors. |
| 582 | EE->runStaticConstructorsDestructors(true); |
| 583 | |
| 584 | // If the program didn't call exit explicitly, we should call it now. |
| 585 | // This ensures that any atexit handlers get called correctly. |
| 586 | if (Function *ExitF = dyn_cast<Function>(Exit)) { |
| 587 | std::vector<GenericValue> Args; |
| 588 | GenericValue ResultGV; |
| 589 | ResultGV.IntVal = APInt(32, Result); |
| 590 | Args.push_back(ResultGV); |
| 591 | EE->runFunction(ExitF, Args); |
Jonas Devlieghere | 4a2863c | 2018-04-22 08:02:11 +0000 | [diff] [blame] | 592 | WithColor::error(errs(), argv[0]) << "exit(" << Result << ") returned!\n"; |
Andrew Kaylor | c87c347 | 2013-10-02 18:04:40 +0000 | [diff] [blame] | 593 | abort(); |
| 594 | } else { |
Jonas Devlieghere | 4a2863c | 2018-04-22 08:02:11 +0000 | [diff] [blame] | 595 | WithColor::error(errs(), argv[0]) |
| 596 | << "exit defined with wrong prototype!\n"; |
Andrew Kaylor | c87c347 | 2013-10-02 18:04:40 +0000 | [diff] [blame] | 597 | abort(); |
| 598 | } |
| 599 | } else { |
| 600 | // else == "if (RemoteMCJIT)" |
| 601 | |
| 602 | // Remote target MCJIT doesn't (yet) support static constructors. No reason |
Hiroshi Inoue | 0ca79dc | 2017-07-11 06:04:59 +0000 | [diff] [blame] | 603 | // it couldn't. This is a limitation of the LLI implementation, not the |
Andrew Kaylor | c87c347 | 2013-10-02 18:04:40 +0000 | [diff] [blame] | 604 | // MCJIT itself. FIXME. |
Andrew Kaylor | c2ebf3f | 2013-10-02 17:12:36 +0000 | [diff] [blame] | 605 | |
Lang Hames | 9d7a269 | 2016-01-11 16:35:55 +0000 | [diff] [blame] | 606 | // Lanch the remote process and get a channel to it. |
Lang Hames | 1f2bf2d | 2016-11-11 21:42:09 +0000 | [diff] [blame] | 607 | std::unique_ptr<FDRawChannel> C = launchRemote(); |
Lang Hames | 9d7a269 | 2016-01-11 16:35:55 +0000 | [diff] [blame] | 608 | if (!C) { |
Jonas Devlieghere | 4a2863c | 2018-04-22 08:02:11 +0000 | [diff] [blame] | 609 | WithColor::error(errs(), argv[0]) << "failed to launch remote JIT.\n"; |
Lang Hames | 9d7a269 | 2016-01-11 16:35:55 +0000 | [diff] [blame] | 610 | exit(1); |
Andrew Kaylor | c2ebf3f | 2013-10-02 17:12:36 +0000 | [diff] [blame] | 611 | } |
| 612 | |
Lang Hames | 9d7a269 | 2016-01-11 16:35:55 +0000 | [diff] [blame] | 613 | // Create a remote target client running over the channel. |
Lang Hames | 9e68b734 | 2017-09-04 20:54:46 +0000 | [diff] [blame] | 614 | typedef orc::remote::OrcRemoteTargetClient MyRemote; |
| 615 | auto R = ExitOnErr(MyRemote::Create(*C, ExitOnErr)); |
Jim Grosbach | 748b947 | 2012-08-28 23:22:30 +0000 | [diff] [blame] | 616 | |
Lang Hames | 9d7a269 | 2016-01-11 16:35:55 +0000 | [diff] [blame] | 617 | // Create a remote memory manager. |
Lang Hames | 9e68b734 | 2017-09-04 20:54:46 +0000 | [diff] [blame] | 618 | auto RemoteMM = ExitOnErr(R->createRemoteMemoryManager()); |
Lang Hames | 9d7a269 | 2016-01-11 16:35:55 +0000 | [diff] [blame] | 619 | |
| 620 | // Forward MCJIT's memory manager calls to the remote memory manager. |
| 621 | static_cast<ForwardingMemoryManager*>(RTDyldMM)->setMemMgr( |
| 622 | std::move(RemoteMM)); |
| 623 | |
| 624 | // Forward MCJIT's symbol resolution calls to the remote. |
NAKAMURA Takumi | a1e97a7 | 2017-08-28 06:47:47 +0000 | [diff] [blame] | 625 | static_cast<ForwardingMemoryManager *>(RTDyldMM)->setResolver( |
| 626 | orc::createLambdaResolver( |
| 627 | [](const std::string &Name) { return nullptr; }, |
| 628 | [&](const std::string &Name) { |
| 629 | if (auto Addr = ExitOnErr(R->getSymbolAddress(Name))) |
| 630 | return JITSymbol(Addr, JITSymbolFlags::Exported); |
| 631 | return JITSymbol(nullptr); |
| 632 | })); |
Lang Hames | 9d7a269 | 2016-01-11 16:35:55 +0000 | [diff] [blame] | 633 | |
| 634 | // Grab the target address of the JIT'd main function on the remote and call |
| 635 | // it. |
Jim Grosbach | 0f435d0 | 2012-09-05 16:50:34 +0000 | [diff] [blame] | 636 | // FIXME: argv and envp handling. |
Lang Hames | ad4a911 | 2016-08-01 20:49:11 +0000 | [diff] [blame] | 637 | JITTargetAddress Entry = EE->getFunctionAddress(EntryFn->getName().str()); |
Lang Hames | 9d7a269 | 2016-01-11 16:35:55 +0000 | [diff] [blame] | 638 | EE->finalizeObject(); |
Tim Northover | 79ab7f7 | 2013-05-19 09:55:06 +0000 | [diff] [blame] | 639 | DEBUG(dbgs() << "Executing '" << EntryFn->getName() << "' at 0x" |
| 640 | << format("%llx", Entry) << "\n"); |
Lang Hames | 1f2bf2d | 2016-11-11 21:42:09 +0000 | [diff] [blame] | 641 | Result = ExitOnErr(R->callIntVoid(Entry)); |
Jim Grosbach | 0f435d0 | 2012-09-05 16:50:34 +0000 | [diff] [blame] | 642 | |
Andrew Kaylor | c87c347 | 2013-10-02 18:04:40 +0000 | [diff] [blame] | 643 | // Like static constructors, the remote target MCJIT support doesn't handle |
| 644 | // this yet. It could. FIXME. |
| 645 | |
Lang Hames | 9d7a269 | 2016-01-11 16:35:55 +0000 | [diff] [blame] | 646 | // Delete the EE - we need to tear it down *before* we terminate the session |
| 647 | // with the remote, otherwise it'll crash when it tries to release resources |
| 648 | // on a remote that has already been disconnected. |
Mehdi Amini | a7de820 | 2016-04-18 18:52:39 +0000 | [diff] [blame] | 649 | EE.reset(); |
Lang Hames | 9d7a269 | 2016-01-11 16:35:55 +0000 | [diff] [blame] | 650 | |
| 651 | // Signal the remote target that we're done JITing. |
Lang Hames | 1f2bf2d | 2016-11-11 21:42:09 +0000 | [diff] [blame] | 652 | ExitOnErr(R->terminateSession()); |
Chris Lattner | 2785bdb | 2007-05-06 04:58:26 +0000 | [diff] [blame] | 653 | } |
Jim Grosbach | 0f435d0 | 2012-09-05 16:50:34 +0000 | [diff] [blame] | 654 | |
Jim Grosbach | 0f435d0 | 2012-09-05 16:50:34 +0000 | [diff] [blame] | 655 | return Result; |
Chris Lattner | d7ff578 | 2001-08-23 17:05:04 +0000 | [diff] [blame] | 656 | } |
Lang Hames | 9d7a269 | 2016-01-11 16:35:55 +0000 | [diff] [blame] | 657 | |
Lang Hames | 1f2bf2d | 2016-11-11 21:42:09 +0000 | [diff] [blame] | 658 | std::unique_ptr<FDRawChannel> launchRemote() { |
Lang Hames | 9d7a269 | 2016-01-11 16:35:55 +0000 | [diff] [blame] | 659 | #ifndef LLVM_ON_UNIX |
| 660 | llvm_unreachable("launchRemote not supported on non-Unix platforms"); |
| 661 | #else |
| 662 | int PipeFD[2][2]; |
| 663 | pid_t ChildPID; |
| 664 | |
| 665 | // Create two pipes. |
| 666 | if (pipe(PipeFD[0]) != 0 || pipe(PipeFD[1]) != 0) |
| 667 | perror("Error creating pipe: "); |
| 668 | |
| 669 | ChildPID = fork(); |
| 670 | |
| 671 | if (ChildPID == 0) { |
| 672 | // In the child... |
| 673 | |
| 674 | // Close the parent ends of the pipes |
| 675 | close(PipeFD[0][1]); |
| 676 | close(PipeFD[1][0]); |
| 677 | |
| 678 | |
| 679 | // Execute the child process. |
| 680 | std::unique_ptr<char[]> ChildPath, ChildIn, ChildOut; |
| 681 | { |
| 682 | ChildPath.reset(new char[ChildExecPath.size() + 1]); |
| 683 | std::copy(ChildExecPath.begin(), ChildExecPath.end(), &ChildPath[0]); |
| 684 | ChildPath[ChildExecPath.size()] = '\0'; |
NAKAMURA Takumi | cef0a821 | 2016-01-15 02:14:46 +0000 | [diff] [blame] | 685 | std::string ChildInStr = utostr(PipeFD[0][0]); |
Lang Hames | 9d7a269 | 2016-01-11 16:35:55 +0000 | [diff] [blame] | 686 | ChildIn.reset(new char[ChildInStr.size() + 1]); |
| 687 | std::copy(ChildInStr.begin(), ChildInStr.end(), &ChildIn[0]); |
| 688 | ChildIn[ChildInStr.size()] = '\0'; |
NAKAMURA Takumi | cef0a821 | 2016-01-15 02:14:46 +0000 | [diff] [blame] | 689 | std::string ChildOutStr = utostr(PipeFD[1][1]); |
Lang Hames | 9d7a269 | 2016-01-11 16:35:55 +0000 | [diff] [blame] | 690 | ChildOut.reset(new char[ChildOutStr.size() + 1]); |
| 691 | std::copy(ChildOutStr.begin(), ChildOutStr.end(), &ChildOut[0]); |
| 692 | ChildOut[ChildOutStr.size()] = '\0'; |
| 693 | } |
| 694 | |
| 695 | char * const args[] = { &ChildPath[0], &ChildIn[0], &ChildOut[0], nullptr }; |
| 696 | int rc = execv(ChildExecPath.c_str(), args); |
| 697 | if (rc != 0) |
| 698 | perror("Error executing child process: "); |
| 699 | llvm_unreachable("Error executing child process"); |
| 700 | } |
| 701 | // else we're the parent... |
| 702 | |
| 703 | // Close the child ends of the pipes |
| 704 | close(PipeFD[0][0]); |
| 705 | close(PipeFD[1][1]); |
| 706 | |
| 707 | // Return an RPC channel connected to our end of the pipes. |
Lang Hames | 1f2bf2d | 2016-11-11 21:42:09 +0000 | [diff] [blame] | 708 | return llvm::make_unique<FDRawChannel>(PipeFD[1][0], PipeFD[0][1]); |
Lang Hames | 9d7a269 | 2016-01-11 16:35:55 +0000 | [diff] [blame] | 709 | #endif |
| 710 | } |