blob: 49aa97d532ec2b007ad42bfbcfc2d1fda8129b92 [file] [log] [blame]
Chris Lattner2eff5052010-03-12 18:44:54 +00001//===-- LTOModule.cpp - LLVM Link Time Optimizer --------------------------===//
Nick Kledzik07b4a622008-02-26 20:26:43 +00002//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Daniel Dunbar5657e7b2010-08-10 23:46:39 +00007//
Nick Kledzik07b4a622008-02-26 20:26:43 +00008//===----------------------------------------------------------------------===//
9//
Daniel Dunbar5657e7b2010-08-10 23:46:39 +000010// This file implements the Link Time Optimization library. This library is
Nick Kledzik07b4a622008-02-26 20:26:43 +000011// intended to be used by linker to optimize code at link time.
12//
13//===----------------------------------------------------------------------===//
14
Peter Collingbourne4ccf0f12013-09-24 23:52:22 +000015#include "llvm/LTO/LTOModule.h"
Chandler Carruth4d88a1c2012-12-04 10:44:52 +000016#include "llvm/ADT/Triple.h"
17#include "llvm/Bitcode/ReaderWriter.h"
Rafael Espindolaf21434c2014-07-30 19:42:16 +000018#include "llvm/CodeGen/Analysis.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000019#include "llvm/IR/Constants.h"
Rafael Espindolad0b23be2015-01-10 00:07:30 +000020#include "llvm/IR/DiagnosticPrinter.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000021#include "llvm/IR/LLVMContext.h"
Yunzhong Gaoa88d7ab2014-01-21 18:31:27 +000022#include "llvm/IR/Metadata.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000023#include "llvm/IR/Module.h"
Rafael Espindola1e49a6d2011-03-02 04:14:42 +000024#include "llvm/MC/MCExpr.h"
25#include "llvm/MC/MCInst.h"
Joey Goulydb6144e2013-09-12 12:55:29 +000026#include "llvm/MC/MCInstrInfo.h"
Chandler Carruth4d88a1c2012-12-04 10:44:52 +000027#include "llvm/MC/MCParser/MCAsmParser.h"
Rafael Espindola20fcda72014-01-22 22:11:14 +000028#include "llvm/MC/MCSection.h"
Evan Cheng91111d22011-07-09 05:47:46 +000029#include "llvm/MC/MCSubtargetInfo.h"
Rafael Espindola1e49a6d2011-03-02 04:14:42 +000030#include "llvm/MC/MCSymbol.h"
Evan Cheng11424442011-07-26 00:24:13 +000031#include "llvm/MC/MCTargetAsmParser.h"
Bill Wendling8f6c8a92012-03-30 23:26:06 +000032#include "llvm/MC/SubtargetFeature.h"
Peter Collingbourne10039c02014-09-18 21:28:49 +000033#include "llvm/Object/IRObjectFile.h"
34#include "llvm/Object/ObjectFile.h"
Bill Wendlingb8dcda72012-08-06 21:34:54 +000035#include "llvm/Support/CommandLine.h"
Rafael Espindola46ed3532013-06-11 18:05:26 +000036#include "llvm/Support/FileSystem.h"
Chandler Carruth8a8cd2b2014-01-07 11:48:04 +000037#include "llvm/Support/Host.h"
Bill Wendling8f6c8a92012-03-30 23:26:06 +000038#include "llvm/Support/MemoryBuffer.h"
39#include "llvm/Support/Path.h"
Bill Wendling8f6c8a92012-03-30 23:26:06 +000040#include "llvm/Support/SourceMgr.h"
Bill Wendling8f6c8a92012-03-30 23:26:06 +000041#include "llvm/Support/TargetRegistry.h"
42#include "llvm/Support/TargetSelect.h"
Yunzhong Gaoa88d7ab2014-01-21 18:31:27 +000043#include "llvm/Target/TargetLowering.h"
44#include "llvm/Target/TargetLoweringObjectFile.h"
Chandler Carruth4d88a1c2012-12-04 10:44:52 +000045#include "llvm/Target/TargetRegisterInfo.h"
Eric Christopherd9134482014-08-04 21:25:23 +000046#include "llvm/Target/TargetSubtargetInfo.h"
Rafael Espindola282a4702013-10-31 20:51:58 +000047#include "llvm/Transforms/Utils/GlobalStatus.h"
Rafael Espindolaa6e9c3e2014-06-12 17:38:55 +000048#include <system_error>
Nick Kledzik07b4a622008-02-26 20:26:43 +000049using namespace llvm;
Peter Collingbourne10039c02014-09-18 21:28:49 +000050using namespace llvm::object;
Nick Kledzik07b4a622008-02-26 20:26:43 +000051
Rafael Espindoladddd1fd2014-07-04 18:40:36 +000052LTOModule::LTOModule(std::unique_ptr<object::IRObjectFile> Obj,
53 llvm::TargetMachine *TM)
54 : IRFile(std::move(Obj)), _target(TM) {}
Bill Wendlingfb440502012-03-28 20:46:54 +000055
Duncan P. N. Exon Smith97b45872014-11-11 23:08:05 +000056LTOModule::LTOModule(std::unique_ptr<object::IRObjectFile> Obj,
57 llvm::TargetMachine *TM,
58 std::unique_ptr<LLVMContext> Context)
59 : OwnedContext(std::move(Context)), IRFile(std::move(Obj)), _target(TM) {}
60
61LTOModule::~LTOModule() {}
62
Bill Wendlingfb440502012-03-28 20:46:54 +000063/// isBitcodeFile - Returns 'true' if the file (or memory contents) is LLVM
64/// bitcode.
Peter Collingbourne10039c02014-09-18 21:28:49 +000065bool LTOModule::isBitcodeFile(const void *Mem, size_t Length) {
66 ErrorOr<MemoryBufferRef> BCData = IRObjectFile::findBitcodeInMemBuffer(
67 MemoryBufferRef(StringRef((const char *)Mem, Length), "<mem>"));
68 return bool(BCData);
Nick Kledzik07b4a622008-02-26 20:26:43 +000069}
70
Peter Collingbourne10039c02014-09-18 21:28:49 +000071bool LTOModule::isBitcodeFile(const char *Path) {
72 ErrorOr<std::unique_ptr<MemoryBuffer>> BufferOrErr =
73 MemoryBuffer::getFile(Path);
74 if (!BufferOrErr)
Rafael Espindola71affba2013-06-12 15:13:57 +000075 return false;
Peter Collingbourne10039c02014-09-18 21:28:49 +000076
77 ErrorOr<MemoryBufferRef> BCData = IRObjectFile::findBitcodeInMemBuffer(
78 BufferOrErr.get()->getMemBufferRef());
79 return bool(BCData);
Nick Kledzik07b4a622008-02-26 20:26:43 +000080}
81
Peter Collingbourne10039c02014-09-18 21:28:49 +000082bool LTOModule::isBitcodeForTarget(MemoryBuffer *Buffer,
83 StringRef TriplePrefix) {
84 ErrorOr<MemoryBufferRef> BCOrErr =
85 IRObjectFile::findBitcodeInMemBuffer(Buffer->getMemBufferRef());
86 if (!BCOrErr)
87 return false;
Duncan P. N. Exon Smith97b45872014-11-11 23:08:05 +000088 LLVMContext Context;
89 std::string Triple = getBitcodeTargetTriple(*BCOrErr, Context);
Peter Collingbourne10039c02014-09-18 21:28:49 +000090 return StringRef(Triple).startswith(TriplePrefix);
Daniel Dunbar5657e7b2010-08-10 23:46:39 +000091}
92
Peter Collingbourne63086fe2014-07-03 23:28:00 +000093LTOModule *LTOModule::createFromFile(const char *path, TargetOptions options,
94 std::string &errMsg) {
Rafael Espindolaadf21f22014-07-06 17:43:13 +000095 ErrorOr<std::unique_ptr<MemoryBuffer>> BufferOrErr =
96 MemoryBuffer::getFile(path);
97 if (std::error_code EC = BufferOrErr.getError()) {
98 errMsg = EC.message();
Craig Topper2617dcc2014-04-15 06:32:26 +000099 return nullptr;
Michael J. Spencerd4227232010-12-09 18:06:07 +0000100 }
Rafael Espindola48af1c22014-08-19 18:44:46 +0000101 std::unique_ptr<MemoryBuffer> Buffer = std::move(BufferOrErr.get());
Duncan P. N. Exon Smith97b45872014-11-11 23:08:05 +0000102 return makeLTOModule(Buffer->getMemBufferRef(), options, errMsg,
103 &getGlobalContext());
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000104}
105
Peter Collingbourne63086fe2014-07-03 23:28:00 +0000106LTOModule *LTOModule::createFromOpenFile(int fd, const char *path, size_t size,
107 TargetOptions options,
108 std::string &errMsg) {
109 return createFromOpenFileSlice(fd, path, size, 0, options, errMsg);
Rafael Espindolab39c7c72011-03-17 00:36:11 +0000110}
111
Peter Collingbourne63086fe2014-07-03 23:28:00 +0000112LTOModule *LTOModule::createFromOpenFileSlice(int fd, const char *path,
113 size_t map_size, off_t offset,
114 TargetOptions options,
115 std::string &errMsg) {
Rafael Espindolaadf21f22014-07-06 17:43:13 +0000116 ErrorOr<std::unique_ptr<MemoryBuffer>> BufferOrErr =
117 MemoryBuffer::getOpenFileSlice(fd, path, map_size, offset);
118 if (std::error_code EC = BufferOrErr.getError()) {
119 errMsg = EC.message();
Craig Topper2617dcc2014-04-15 06:32:26 +0000120 return nullptr;
Rafael Espindola56e41f72011-02-08 22:40:47 +0000121 }
Rafael Espindola48af1c22014-08-19 18:44:46 +0000122 std::unique_ptr<MemoryBuffer> Buffer = std::move(BufferOrErr.get());
Duncan P. N. Exon Smith97b45872014-11-11 23:08:05 +0000123 return makeLTOModule(Buffer->getMemBufferRef(), options, errMsg,
124 &getGlobalContext());
Rafael Espindola56e41f72011-02-08 22:40:47 +0000125}
126
Peter Collingbourne63086fe2014-07-03 23:28:00 +0000127LTOModule *LTOModule::createFromBuffer(const void *mem, size_t length,
128 TargetOptions options,
129 std::string &errMsg, StringRef path) {
Duncan P. N. Exon Smith97b45872014-11-11 23:08:05 +0000130 return createInContext(mem, length, options, errMsg, path,
131 &getGlobalContext());
132}
133
134LTOModule *LTOModule::createInLocalContext(const void *mem, size_t length,
135 TargetOptions options,
136 std::string &errMsg,
137 StringRef path) {
138 return createInContext(mem, length, options, errMsg, path, nullptr);
139}
140
141LTOModule *LTOModule::createInContext(const void *mem, size_t length,
142 TargetOptions options,
143 std::string &errMsg, StringRef path,
144 LLVMContext *Context) {
Aaron Ballman47497252014-08-20 12:54:13 +0000145 StringRef Data((const char *)mem, length);
Rafael Espindola48af1c22014-08-19 18:44:46 +0000146 MemoryBufferRef Buffer(Data, path);
Duncan P. N. Exon Smith97b45872014-11-11 23:08:05 +0000147 return makeLTOModule(Buffer, options, errMsg, Context);
Bill Wendlingb8dcda72012-08-06 21:34:54 +0000148}
149
Rafael Espindolad0b23be2015-01-10 00:07:30 +0000150static Module *parseBitcodeFileImpl(MemoryBufferRef Buffer,
151 LLVMContext &Context, bool ShouldBeLazy,
152 std::string &ErrMsg) {
153
Duncan P. N. Exon Smith140d41b2014-12-17 22:05:42 +0000154 // Find the buffer.
155 ErrorOr<MemoryBufferRef> MBOrErr =
156 IRObjectFile::findBitcodeInMemBuffer(Buffer);
Rafael Espindolad0b23be2015-01-10 00:07:30 +0000157 if (std::error_code EC = MBOrErr.getError()) {
158 ErrMsg = EC.message();
159 return nullptr;
160 }
Duncan P. N. Exon Smith140d41b2014-12-17 22:05:42 +0000161
Rafael Espindolad0b23be2015-01-10 00:07:30 +0000162 std::function<void(const DiagnosticInfo &)> DiagnosticHandler =
163 [&ErrMsg](const DiagnosticInfo &DI) {
164 raw_string_ostream Stream(ErrMsg);
165 DiagnosticPrinterRawOStream DP(Stream);
166 DI.print(DP);
167 };
168
169 if (!ShouldBeLazy) {
Duncan P. N. Exon Smith140d41b2014-12-17 22:05:42 +0000170 // Parse the full file.
Rafael Espindolad0b23be2015-01-10 00:07:30 +0000171 ErrorOr<Module *> M =
172 parseBitcodeFile(*MBOrErr, Context, DiagnosticHandler);
173 if (!M)
174 return nullptr;
175 return *M;
176 }
Duncan P. N. Exon Smith140d41b2014-12-17 22:05:42 +0000177
178 // Parse lazily.
179 std::unique_ptr<MemoryBuffer> LightweightBuf =
180 MemoryBuffer::getMemBuffer(*MBOrErr, false);
Rafael Espindolad0b23be2015-01-10 00:07:30 +0000181 ErrorOr<Module *> M = getLazyBitcodeModule(std::move(LightweightBuf), Context,
Manman Ren4a9b0eb2015-03-13 19:24:30 +0000182 DiagnosticHandler,
183 true/*ShouldLazyLoadMetadata*/);
Rafael Espindolad0b23be2015-01-10 00:07:30 +0000184 if (!M)
185 return nullptr;
186 return *M;
Duncan P. N. Exon Smith140d41b2014-12-17 22:05:42 +0000187}
188
Rafael Espindola48af1c22014-08-19 18:44:46 +0000189LTOModule *LTOModule::makeLTOModule(MemoryBufferRef Buffer,
Duncan P. N. Exon Smith97b45872014-11-11 23:08:05 +0000190 TargetOptions options, std::string &errMsg,
191 LLVMContext *Context) {
192 std::unique_ptr<LLVMContext> OwnedContext;
193 if (!Context) {
194 OwnedContext = llvm::make_unique<LLVMContext>();
195 Context = OwnedContext.get();
196 }
197
Duncan P. N. Exon Smith140d41b2014-12-17 22:05:42 +0000198 // If we own a context, we know this is being used only for symbol
199 // extraction, not linking. Be lazy in that case.
Rafael Espindolad0b23be2015-01-10 00:07:30 +0000200 std::unique_ptr<Module> M(parseBitcodeFileImpl(
201 Buffer, *Context,
202 /* ShouldBeLazy */ static_cast<bool>(OwnedContext), errMsg));
203 if (!M)
Craig Topper2617dcc2014-04-15 06:32:26 +0000204 return nullptr;
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000205
Rafael Espindoladddd1fd2014-07-04 18:40:36 +0000206 std::string TripleStr = M->getTargetTriple();
Bob Wilson3f7e7c02012-10-12 17:39:25 +0000207 if (TripleStr.empty())
208 TripleStr = sys::getDefaultTargetTriple();
209 llvm::Triple Triple(TripleStr);
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000210
211 // find machine architecture for this module
Bob Wilson3f7e7c02012-10-12 17:39:25 +0000212 const Target *march = TargetRegistry::lookupTarget(TripleStr, errMsg);
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000213 if (!march)
Craig Topper2617dcc2014-04-15 06:32:26 +0000214 return nullptr;
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000215
Nick Lewycky364c04a2011-04-21 01:54:08 +0000216 // construct LTOModule, hand over ownership of module and target
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000217 SubtargetFeatures Features;
Bob Wilson3f7e7c02012-10-12 17:39:25 +0000218 Features.getDefaultSubtargetFeatures(Triple);
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000219 std::string FeatureStr = Features.getString();
Bob Wilson3f7e7c02012-10-12 17:39:25 +0000220 // Set a default CPU for Darwin triples.
Evan Chengfe6e4052011-06-30 01:53:36 +0000221 std::string CPU;
Bob Wilson3f7e7c02012-10-12 17:39:25 +0000222 if (Triple.isOSDarwin()) {
223 if (Triple.getArch() == llvm::Triple::x86_64)
224 CPU = "core2";
225 else if (Triple.getArch() == llvm::Triple::x86)
226 CPU = "yonah";
Tim Northovere19bed72014-07-23 12:32:47 +0000227 else if (Triple.getArch() == llvm::Triple::aarch64)
Tim Northover00ed9962014-03-29 10:18:08 +0000228 CPU = "cyclone";
Bob Wilson3f7e7c02012-10-12 17:39:25 +0000229 }
Rafael Espindola0b385c72013-09-30 16:39:19 +0000230
Bob Wilson3f7e7c02012-10-12 17:39:25 +0000231 TargetMachine *target = march->createTargetMachine(TripleStr, CPU, FeatureStr,
Rafael Espindola0b385c72013-09-30 16:39:19 +0000232 options);
Mehdi Amini46a43552015-03-04 18:43:29 +0000233 M->setDataLayout(*target->getDataLayout());
Rafael Espindola282a4702013-10-31 20:51:58 +0000234
Rafael Espindoladddd1fd2014-07-04 18:40:36 +0000235 std::unique_ptr<object::IRObjectFile> IRObj(
Rafael Espindola48af1c22014-08-19 18:44:46 +0000236 new object::IRObjectFile(Buffer, std::move(M)));
Rafael Espindoladaeafb42014-02-19 17:23:20 +0000237
Duncan P. N. Exon Smith97b45872014-11-11 23:08:05 +0000238 LTOModule *Ret;
239 if (OwnedContext)
240 Ret = new LTOModule(std::move(IRObj), target, std::move(OwnedContext));
241 else
242 Ret = new LTOModule(std::move(IRObj), target);
Rafael Espindoladaeafb42014-02-19 17:23:20 +0000243
Bill Wendling7e58b382012-03-28 23:12:18 +0000244 if (Ret->parseSymbols(errMsg)) {
Rafael Espindola1e49a6d2011-03-02 04:14:42 +0000245 delete Ret;
Craig Topper2617dcc2014-04-15 06:32:26 +0000246 return nullptr;
Rafael Espindola1e49a6d2011-03-02 04:14:42 +0000247 }
Bill Wendling5f689e72011-11-04 18:48:00 +0000248
Yunzhong Gaoa88d7ab2014-01-21 18:31:27 +0000249 Ret->parseMetadata();
250
Rafael Espindola1e49a6d2011-03-02 04:14:42 +0000251 return Ret;
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000252}
253
Manman Ren03456a12014-02-10 23:26:14 +0000254/// Create a MemoryBuffer from a memory range with an optional name.
Rafael Espindolaa6d0b2f2014-08-17 22:37:39 +0000255std::unique_ptr<MemoryBuffer>
256LTOModule::makeBuffer(const void *mem, size_t length, StringRef name) {
Roman Divackyad06cee2012-09-05 22:26:57 +0000257 const char *startPtr = (const char*)mem;
Rafael Espindola3560ff22014-08-27 20:03:13 +0000258 return MemoryBuffer::getMemBuffer(StringRef(startPtr, length), name, false);
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000259}
260
Bill Wendlingfb440502012-03-28 20:46:54 +0000261/// objcClassNameFromExpression - Get string that the data pointer points to.
Rafael Espindola6ee19d22012-12-11 03:10:43 +0000262bool
263LTOModule::objcClassNameFromExpression(const Constant *c, std::string &name) {
264 if (const ConstantExpr *ce = dyn_cast<ConstantExpr>(c)) {
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000265 Constant *op = ce->getOperand(0);
266 if (GlobalVariable *gvn = dyn_cast<GlobalVariable>(op)) {
267 Constant *cn = gvn->getInitializer();
Chris Lattnercf9e8f62012-02-05 02:29:43 +0000268 if (ConstantDataArray *ca = dyn_cast<ConstantDataArray>(cn)) {
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000269 if (ca->isCString()) {
Chris Lattnercf9e8f62012-02-05 02:29:43 +0000270 name = ".objc_class_name_" + ca->getAsCString().str();
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000271 return true;
Nick Kledzikb481c202009-06-01 20:33:09 +0000272 }
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000273 }
Nick Kledzikb481c202009-06-01 20:33:09 +0000274 }
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000275 }
276 return false;
277}
278
Bill Wendlingfb440502012-03-28 20:46:54 +0000279/// addObjCClass - Parse i386/ppc ObjC class data structure.
Rafael Espindola6ee19d22012-12-11 03:10:43 +0000280void LTOModule::addObjCClass(const GlobalVariable *clgv) {
281 const ConstantStruct *c = dyn_cast<ConstantStruct>(clgv->getInitializer());
Bill Wendling5f689e72011-11-04 18:48:00 +0000282 if (!c) return;
Nick Kledzikb481c202009-06-01 20:33:09 +0000283
Bill Wendling5f689e72011-11-04 18:48:00 +0000284 // second slot in __OBJC,__class is pointer to superclass name
285 std::string superclassName;
286 if (objcClassNameFromExpression(c->getOperand(1), superclassName)) {
David Blaikie5106ce72014-11-19 05:49:42 +0000287 auto IterBool =
288 _undefines.insert(std::make_pair(superclassName, NameAndAttributes()));
289 if (IterBool.second) {
290 NameAndAttributes &info = IterBool.first->second;
291 info.name = IterBool.first->first().data();
Rafael Espindola477d11f2011-02-20 16:27:25 +0000292 info.attributes = LTO_SYMBOL_DEFINITION_UNDEFINED;
Bill Wendling9ee2d332012-03-29 08:27:32 +0000293 info.isFunction = false;
294 info.symbol = clgv;
Nick Kledzikb481c202009-06-01 20:33:09 +0000295 }
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000296 }
Bill Wendling5f689e72011-11-04 18:48:00 +0000297
298 // third slot in __OBJC,__class is pointer to class name
299 std::string className;
300 if (objcClassNameFromExpression(c->getOperand(2), className)) {
David Blaikie5106ce72014-11-19 05:49:42 +0000301 auto Iter = _defines.insert(className).first;
Bill Wendling9ee2d332012-03-29 08:27:32 +0000302
Bill Wendling5f689e72011-11-04 18:48:00 +0000303 NameAndAttributes info;
David Blaikie5106ce72014-11-19 05:49:42 +0000304 info.name = Iter->first().data();
Bill Wendling9ee2d332012-03-29 08:27:32 +0000305 info.attributes = LTO_SYMBOL_PERMISSIONS_DATA |
306 LTO_SYMBOL_DEFINITION_REGULAR | LTO_SYMBOL_SCOPE_DEFAULT;
307 info.isFunction = false;
308 info.symbol = clgv;
Bill Wendling5f689e72011-11-04 18:48:00 +0000309 _symbols.push_back(info);
310 }
311}
312
Bill Wendlingfb440502012-03-28 20:46:54 +0000313/// addObjCCategory - Parse i386/ppc ObjC category data structure.
Rafael Espindola6ee19d22012-12-11 03:10:43 +0000314void LTOModule::addObjCCategory(const GlobalVariable *clgv) {
315 const ConstantStruct *c = dyn_cast<ConstantStruct>(clgv->getInitializer());
Bill Wendling5f689e72011-11-04 18:48:00 +0000316 if (!c) return;
317
318 // second slot in __OBJC,__category is pointer to target class name
319 std::string targetclassName;
320 if (!objcClassNameFromExpression(c->getOperand(1), targetclassName))
321 return;
322
David Blaikie5106ce72014-11-19 05:49:42 +0000323 auto IterBool =
324 _undefines.insert(std::make_pair(targetclassName, NameAndAttributes()));
Bill Wendling5f689e72011-11-04 18:48:00 +0000325
David Blaikie5106ce72014-11-19 05:49:42 +0000326 if (!IterBool.second)
Bill Wendling5f689e72011-11-04 18:48:00 +0000327 return;
328
David Blaikie5106ce72014-11-19 05:49:42 +0000329 NameAndAttributes &info = IterBool.first->second;
330 info.name = IterBool.first->first().data();
Bill Wendling5f689e72011-11-04 18:48:00 +0000331 info.attributes = LTO_SYMBOL_DEFINITION_UNDEFINED;
Bill Wendling9ee2d332012-03-29 08:27:32 +0000332 info.isFunction = false;
333 info.symbol = clgv;
Nick Kledzikb481c202009-06-01 20:33:09 +0000334}
335
Bill Wendlingfb440502012-03-28 20:46:54 +0000336/// addObjCClassRef - Parse i386/ppc ObjC class list data structure.
Rafael Espindola6ee19d22012-12-11 03:10:43 +0000337void LTOModule::addObjCClassRef(const GlobalVariable *clgv) {
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000338 std::string targetclassName;
Bill Wendling5f689e72011-11-04 18:48:00 +0000339 if (!objcClassNameFromExpression(clgv->getInitializer(), targetclassName))
340 return;
Rafael Espindola477d11f2011-02-20 16:27:25 +0000341
David Blaikie5106ce72014-11-19 05:49:42 +0000342 auto IterBool =
343 _undefines.insert(std::make_pair(targetclassName, NameAndAttributes()));
344
345 if (!IterBool.second)
Bill Wendling5f689e72011-11-04 18:48:00 +0000346 return;
Rafael Espindola477d11f2011-02-20 16:27:25 +0000347
David Blaikie5106ce72014-11-19 05:49:42 +0000348 NameAndAttributes &info = IterBool.first->second;
349 info.name = IterBool.first->first().data();
Bill Wendling5f689e72011-11-04 18:48:00 +0000350 info.attributes = LTO_SYMBOL_DEFINITION_UNDEFINED;
Bill Wendling9ee2d332012-03-29 08:27:32 +0000351 info.isFunction = false;
352 info.symbol = clgv;
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000353}
354
Rafael Espindoladddd1fd2014-07-04 18:40:36 +0000355void LTOModule::addDefinedDataSymbol(const object::BasicSymbolRef &Sym) {
Rafael Espindola0972d412014-07-04 16:37:02 +0000356 SmallString<64> Buffer;
Rafael Espindoladddd1fd2014-07-04 18:40:36 +0000357 {
358 raw_svector_ostream OS(Buffer);
359 Sym.printName(OS);
360 }
361
362 const GlobalValue *V = IRFile->getSymbolGV(Sym.getRawDataRefImpl());
Rafael Espindola0972d412014-07-04 16:37:02 +0000363 addDefinedDataSymbol(Buffer.c_str(), V);
364}
365
366void LTOModule::addDefinedDataSymbol(const char *Name, const GlobalValue *v) {
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000367 // Add to list of defined symbols.
Rafael Espindola0972d412014-07-04 16:37:02 +0000368 addDefinedSymbol(Name, v, false);
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000369
Bill Wendling45f74e32012-08-06 22:52:45 +0000370 if (!v->hasSection() /* || !isTargetDarwin */)
371 return;
372
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000373 // Special case i386/ppc ObjC data structures in magic sections:
374 // The issue is that the old ObjC object format did some strange
375 // contortions to avoid real linker symbols. For instance, the
376 // ObjC class data structure is allocated statically in the executable
377 // that defines that class. That data structures contains a pointer to
378 // its superclass. But instead of just initializing that part of the
379 // struct to the address of its superclass, and letting the static and
380 // dynamic linkers do the rest, the runtime works by having that field
381 // instead point to a C-string that is the name of the superclass.
382 // At runtime the objc initialization updates that pointer and sets
383 // it to point to the actual super class. As far as the linker
384 // knows it is just a pointer to a string. But then someone wanted the
385 // linker to issue errors at build time if the superclass was not found.
386 // So they figured out a way in mach-o object format to use an absolute
387 // symbols (.objc_class_name_Foo = 0) and a floating reference
388 // (.reference .objc_class_name_Bar) to cause the linker into erroring when
389 // a class was missing.
390 // The following synthesizes the implicit .objc_* symbols for the linker
391 // from the ObjC data structures generated by the front end.
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000392
Bill Wendling45f74e32012-08-06 22:52:45 +0000393 // special case if this data blob is an ObjC class definition
Rafael Espindola64c1e182014-06-03 02:41:57 +0000394 std::string Section = v->getSection();
395 if (Section.compare(0, 15, "__OBJC,__class,") == 0) {
Rafael Espindola6ee19d22012-12-11 03:10:43 +0000396 if (const GlobalVariable *gv = dyn_cast<GlobalVariable>(v)) {
Bill Wendling45f74e32012-08-06 22:52:45 +0000397 addObjCClass(gv);
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000398 }
Bill Wendling45f74e32012-08-06 22:52:45 +0000399 }
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000400
Bill Wendling45f74e32012-08-06 22:52:45 +0000401 // special case if this data blob is an ObjC category definition
Rafael Espindola64c1e182014-06-03 02:41:57 +0000402 else if (Section.compare(0, 18, "__OBJC,__category,") == 0) {
Rafael Espindola6ee19d22012-12-11 03:10:43 +0000403 if (const GlobalVariable *gv = dyn_cast<GlobalVariable>(v)) {
Bill Wendling45f74e32012-08-06 22:52:45 +0000404 addObjCCategory(gv);
405 }
406 }
407
408 // special case if this data blob is the list of referenced classes
Rafael Espindola64c1e182014-06-03 02:41:57 +0000409 else if (Section.compare(0, 18, "__OBJC,__cls_refs,") == 0) {
Rafael Espindola6ee19d22012-12-11 03:10:43 +0000410 if (const GlobalVariable *gv = dyn_cast<GlobalVariable>(v)) {
Bill Wendling45f74e32012-08-06 22:52:45 +0000411 addObjCClassRef(gv);
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000412 }
413 }
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000414}
415
Rafael Espindoladddd1fd2014-07-04 18:40:36 +0000416void LTOModule::addDefinedFunctionSymbol(const object::BasicSymbolRef &Sym) {
Rafael Espindola0972d412014-07-04 16:37:02 +0000417 SmallString<64> Buffer;
Rafael Espindoladddd1fd2014-07-04 18:40:36 +0000418 {
419 raw_svector_ostream OS(Buffer);
420 Sym.printName(OS);
421 }
422
423 const Function *F =
424 cast<Function>(IRFile->getSymbolGV(Sym.getRawDataRefImpl()));
Rafael Espindola0972d412014-07-04 16:37:02 +0000425 addDefinedFunctionSymbol(Buffer.c_str(), F);
426}
427
428void LTOModule::addDefinedFunctionSymbol(const char *Name, const Function *F) {
Bill Wendlingfb440502012-03-28 20:46:54 +0000429 // add to list of defined symbols
Rafael Espindola0972d412014-07-04 16:37:02 +0000430 addDefinedSymbol(Name, F, true);
Bill Wendlingfb440502012-03-28 20:46:54 +0000431}
432
Rafael Espindola0972d412014-07-04 16:37:02 +0000433void LTOModule::addDefinedSymbol(const char *Name, const GlobalValue *def,
434 bool isFunction) {
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000435 // set alignment part log2() can have rounding errors
436 uint32_t align = def->getAlignment();
Rafael Espindola94751172014-05-05 14:18:16 +0000437 uint32_t attr = align ? countTrailingZeros(align) : 0;
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000438
439 // set permissions part
Bill Wendling9ee2d332012-03-29 08:27:32 +0000440 if (isFunction) {
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000441 attr |= LTO_SYMBOL_PERMISSIONS_CODE;
Bill Wendling9ee2d332012-03-29 08:27:32 +0000442 } else {
Rafael Espindola6ee19d22012-12-11 03:10:43 +0000443 const GlobalVariable *gv = dyn_cast<GlobalVariable>(def);
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000444 if (gv && gv->isConstant())
445 attr |= LTO_SYMBOL_PERMISSIONS_RODATA;
446 else
447 attr |= LTO_SYMBOL_PERMISSIONS_DATA;
448 }
449
450 // set definition part
Rafael Espindola2fb5bc32014-03-13 23:18:37 +0000451 if (def->hasWeakLinkage() || def->hasLinkOnceLinkage())
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000452 attr |= LTO_SYMBOL_DEFINITION_WEAK;
Bill Wendlingdcd7c2b2010-09-27 20:17:45 +0000453 else if (def->hasCommonLinkage())
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000454 attr |= LTO_SYMBOL_DEFINITION_TENTATIVE;
Bill Wendlingdcd7c2b2010-09-27 20:17:45 +0000455 else
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000456 attr |= LTO_SYMBOL_DEFINITION_REGULAR;
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000457
458 // set scope part
Duncan P. N. Exon Smith87121f82014-05-07 22:53:14 +0000459 if (def->hasLocalLinkage())
460 // Ignore visibility if linkage is local.
461 attr |= LTO_SYMBOL_SCOPE_INTERNAL;
462 else if (def->hasHiddenVisibility())
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000463 attr |= LTO_SYMBOL_SCOPE_HIDDEN;
464 else if (def->hasProtectedVisibility())
465 attr |= LTO_SYMBOL_SCOPE_PROTECTED;
Rafael Espindolaf21434c2014-07-30 19:42:16 +0000466 else if (canBeOmittedFromSymbolTable(def))
Rafael Espindola282a4702013-10-31 20:51:58 +0000467 attr |= LTO_SYMBOL_SCOPE_DEFAULT_CAN_BE_HIDDEN;
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000468 else
Duncan P. N. Exon Smith87121f82014-05-07 22:53:14 +0000469 attr |= LTO_SYMBOL_SCOPE_DEFAULT;
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000470
David Blaikie5106ce72014-11-19 05:49:42 +0000471 auto Iter = _defines.insert(Name).first;
Rafael Espindola477d11f2011-02-20 16:27:25 +0000472
Bill Wendling9ee2d332012-03-29 08:27:32 +0000473 // fill information structure
474 NameAndAttributes info;
David Blaikie5106ce72014-11-19 05:49:42 +0000475 StringRef NameRef = Iter->first();
Rafael Espindola0972d412014-07-04 16:37:02 +0000476 info.name = NameRef.data();
477 assert(info.name[NameRef.size()] == '\0');
Bill Wendling9ee2d332012-03-29 08:27:32 +0000478 info.attributes = attr;
479 info.isFunction = isFunction;
480 info.symbol = def;
481
482 // add to table of symbols
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000483 _symbols.push_back(info);
Nick Kledzik07b4a622008-02-26 20:26:43 +0000484}
485
Bill Wendlingfb440502012-03-28 20:46:54 +0000486/// addAsmGlobalSymbol - Add a global symbol from module-level ASM to the
487/// defined list.
Rafael Espindola1e49a6d2011-03-02 04:14:42 +0000488void LTOModule::addAsmGlobalSymbol(const char *name,
489 lto_symbol_attributes scope) {
David Blaikie5106ce72014-11-19 05:49:42 +0000490 auto IterBool = _defines.insert(name);
Rafael Espindola477d11f2011-02-20 16:27:25 +0000491
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000492 // only add new define if not already defined
David Blaikie5106ce72014-11-19 05:49:42 +0000493 if (!IterBool.second)
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000494 return;
495
David Blaikie5106ce72014-11-19 05:49:42 +0000496 NameAndAttributes &info = _undefines[IterBool.first->first().data()];
Bill Wendling9ee2d332012-03-29 08:27:32 +0000497
Craig Topper2617dcc2014-04-15 06:32:26 +0000498 if (info.symbol == nullptr) {
Bill Wendling71b19bb2012-04-02 10:01:21 +0000499 // FIXME: This is trying to take care of module ASM like this:
500 //
501 // module asm ".zerofill __FOO, __foo, _bar_baz_qux, 0"
502 //
503 // but is gross and its mother dresses it funny. Have the ASM parser give us
504 // more details for this type of situation so that we're not guessing so
505 // much.
506
507 // fill information structure
David Blaikie5106ce72014-11-19 05:49:42 +0000508 info.name = IterBool.first->first().data();
Bill Wendling71b19bb2012-04-02 10:01:21 +0000509 info.attributes =
510 LTO_SYMBOL_PERMISSIONS_DATA | LTO_SYMBOL_DEFINITION_REGULAR | scope;
511 info.isFunction = false;
Craig Topper2617dcc2014-04-15 06:32:26 +0000512 info.symbol = nullptr;
Bill Wendling71b19bb2012-04-02 10:01:21 +0000513
514 // add to table of symbols
515 _symbols.push_back(info);
Bill Wendling3a0bcf02012-04-02 03:33:31 +0000516 return;
517 }
518
Bill Wendling9ee2d332012-03-29 08:27:32 +0000519 if (info.isFunction)
Rafael Espindola0972d412014-07-04 16:37:02 +0000520 addDefinedFunctionSymbol(info.name, cast<Function>(info.symbol));
Bill Wendling9ee2d332012-03-29 08:27:32 +0000521 else
Rafael Espindola0972d412014-07-04 16:37:02 +0000522 addDefinedDataSymbol(info.name, info.symbol);
Bill Wendling8f6c8a92012-03-30 23:26:06 +0000523
524 _symbols.back().attributes &= ~LTO_SYMBOL_SCOPE_MASK;
525 _symbols.back().attributes |= scope;
Devang Patela59fe952008-07-16 18:06:52 +0000526}
Nick Kledzik07b4a622008-02-26 20:26:43 +0000527
Bill Wendlingfb440502012-03-28 20:46:54 +0000528/// addAsmGlobalSymbolUndef - Add a global symbol from module-level ASM to the
529/// undefined list.
Rafael Espindola1e49a6d2011-03-02 04:14:42 +0000530void LTOModule::addAsmGlobalSymbolUndef(const char *name) {
David Blaikie5106ce72014-11-19 05:49:42 +0000531 auto IterBool = _undefines.insert(std::make_pair(name, NameAndAttributes()));
Rafael Espindola1e49a6d2011-03-02 04:14:42 +0000532
David Blaikie5106ce72014-11-19 05:49:42 +0000533 _asm_undefines.push_back(IterBool.first->first().data());
Rafael Espindola1e49a6d2011-03-02 04:14:42 +0000534
535 // we already have the symbol
David Blaikie5106ce72014-11-19 05:49:42 +0000536 if (!IterBool.second)
Rafael Espindola1e49a6d2011-03-02 04:14:42 +0000537 return;
538
Alp Toker98444342014-04-19 23:56:35 +0000539 uint32_t attr = LTO_SYMBOL_DEFINITION_UNDEFINED;
Rafael Espindola1e49a6d2011-03-02 04:14:42 +0000540 attr |= LTO_SYMBOL_SCOPE_DEFAULT;
David Blaikie5106ce72014-11-19 05:49:42 +0000541 NameAndAttributes &info = IterBool.first->second;
542 info.name = IterBool.first->first().data();
Bill Wendling9ee2d332012-03-29 08:27:32 +0000543 info.attributes = attr;
544 info.isFunction = false;
Craig Topper2617dcc2014-04-15 06:32:26 +0000545 info.symbol = nullptr;
Rafael Espindola1e49a6d2011-03-02 04:14:42 +0000546}
547
Rafael Espindoladddd1fd2014-07-04 18:40:36 +0000548/// Add a symbol which isn't defined just yet to a list to be resolved later.
549void LTOModule::addPotentialUndefinedSymbol(const object::BasicSymbolRef &Sym,
550 bool isFunc) {
Rafael Espindola34b59382011-02-11 05:23:09 +0000551 SmallString<64> name;
Rafael Espindoladddd1fd2014-07-04 18:40:36 +0000552 {
553 raw_svector_ostream OS(name);
554 Sym.printName(OS);
555 }
Rafael Espindola56548522009-04-24 16:55:21 +0000556
David Blaikie5106ce72014-11-19 05:49:42 +0000557 auto IterBool = _undefines.insert(std::make_pair(name, NameAndAttributes()));
Rafael Espindola477d11f2011-02-20 16:27:25 +0000558
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000559 // we already have the symbol
David Blaikie5106ce72014-11-19 05:49:42 +0000560 if (!IterBool.second)
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000561 return;
Rafael Espindola56548522009-04-24 16:55:21 +0000562
David Blaikie5106ce72014-11-19 05:49:42 +0000563 NameAndAttributes &info = IterBool.first->second;
Rafael Espindola477d11f2011-02-20 16:27:25 +0000564
David Blaikie5106ce72014-11-19 05:49:42 +0000565 info.name = IterBool.first->first().data();
Bill Wendlingfb440502012-03-28 20:46:54 +0000566
Rafael Espindoladddd1fd2014-07-04 18:40:36 +0000567 const GlobalValue *decl = IRFile->getSymbolGV(Sym.getRawDataRefImpl());
568
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000569 if (decl->hasExternalWeakLinkage())
570 info.attributes = LTO_SYMBOL_DEFINITION_WEAKUNDEF;
571 else
572 info.attributes = LTO_SYMBOL_DEFINITION_UNDEFINED;
Rafael Espindola477d11f2011-02-20 16:27:25 +0000573
Bill Wendling9ee2d332012-03-29 08:27:32 +0000574 info.isFunction = isFunc;
575 info.symbol = decl;
Nick Kledzik07b4a622008-02-26 20:26:43 +0000576}
577
Bill Wendling7e58b382012-03-28 23:12:18 +0000578/// parseSymbols - Parse the symbols from the module and model-level ASM and add
Bill Wendlingfb440502012-03-28 20:46:54 +0000579/// them to either the defined or undefined lists.
Bill Wendling7e58b382012-03-28 23:12:18 +0000580bool LTOModule::parseSymbols(std::string &errMsg) {
Rafael Espindoladddd1fd2014-07-04 18:40:36 +0000581 for (auto &Sym : IRFile->symbols()) {
582 const GlobalValue *GV = IRFile->getSymbolGV(Sym.getRawDataRefImpl());
583 uint32_t Flags = Sym.getFlags();
Rafael Espindola089a3172014-07-04 19:31:27 +0000584 if (Flags & object::BasicSymbolRef::SF_FormatSpecific)
585 continue;
586
Rafael Espindoladddd1fd2014-07-04 18:40:36 +0000587 bool IsUndefined = Flags & object::BasicSymbolRef::SF_Undefined;
588
589 if (!GV) {
590 SmallString<64> Buffer;
591 {
592 raw_svector_ostream OS(Buffer);
593 Sym.printName(OS);
594 }
595 const char *Name = Buffer.c_str();
596
597 if (IsUndefined)
598 addAsmGlobalSymbolUndef(Name);
599 else if (Flags & object::BasicSymbolRef::SF_Global)
600 addAsmGlobalSymbol(Name, LTO_SYMBOL_SCOPE_DEFAULT);
601 else
602 addAsmGlobalSymbol(Name, LTO_SYMBOL_SCOPE_INTERNAL);
603 continue;
604 }
605
606 auto *F = dyn_cast<Function>(GV);
607 if (IsUndefined) {
608 addPotentialUndefinedSymbol(Sym, F != nullptr);
609 continue;
610 }
611
612 if (F) {
613 addDefinedFunctionSymbol(Sym);
614 continue;
615 }
616
617 if (isa<GlobalVariable>(GV)) {
618 addDefinedDataSymbol(Sym);
619 continue;
620 }
621
622 assert(isa<GlobalAlias>(GV));
623 addDefinedDataSymbol(Sym);
Daniel Dunbar919660b2010-08-10 23:46:46 +0000624 }
Nick Kledzik07b4a622008-02-26 20:26:43 +0000625
Daniel Dunbar919660b2010-08-10 23:46:46 +0000626 // make symbols for all undefines
Bill Wendling9ee2d332012-03-29 08:27:32 +0000627 for (StringMap<NameAndAttributes>::iterator u =_undefines.begin(),
628 e = _undefines.end(); u != e; ++u) {
629 // If this symbol also has a definition, then don't make an undefine because
630 // it is a tentative definition.
631 if (_defines.count(u->getKey())) continue;
632 NameAndAttributes info = u->getValue();
633 _symbols.push_back(info);
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000634 }
Bill Wendling9ee2d332012-03-29 08:27:32 +0000635
Rafael Espindola1e49a6d2011-03-02 04:14:42 +0000636 return false;
Nick Kledzik91a6dcf2008-02-27 22:25:36 +0000637}
Yunzhong Gaoa88d7ab2014-01-21 18:31:27 +0000638
639/// parseMetadata - Parse metadata from the module
640void LTOModule::parseMetadata() {
641 // Linker Options
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000642 if (Metadata *Val = getModule().getModuleFlag("Linker Options")) {
Yunzhong Gaoa88d7ab2014-01-21 18:31:27 +0000643 MDNode *LinkerOptions = cast<MDNode>(Val);
644 for (unsigned i = 0, e = LinkerOptions->getNumOperands(); i != e; ++i) {
645 MDNode *MDOptions = cast<MDNode>(LinkerOptions->getOperand(i));
646 for (unsigned ii = 0, ie = MDOptions->getNumOperands(); ii != ie; ++ii) {
647 MDString *MDOption = cast<MDString>(MDOptions->getOperand(ii));
David Blaikie5106ce72014-11-19 05:49:42 +0000648 // FIXME: Make StringSet::insert match Self-Associative Container
649 // requirements, returning <iter,bool> rather than bool, and use that
650 // here.
651 StringRef Op =
652 _linkeropt_strings.insert(MDOption->getString()).first->first();
Eric Christopher36fe0282015-02-03 07:22:52 +0000653 StringRef DepLibName =
654 _target->getObjFileLowering()->getDepLibFromLinkerOpt(Op);
Yunzhong Gaoa88d7ab2014-01-21 18:31:27 +0000655 if (!DepLibName.empty())
656 _deplibs.push_back(DepLibName.data());
657 else if (!Op.empty())
658 _linkeropts.push_back(Op.data());
659 }
660 }
661 }
662
663 // Add other interesting metadata here.
664}