blob: bbb3b6df30cca8cf31653d7e4b3be8929992c7e1 [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 Espindoladcd1dca2015-06-16 22:27:55 +0000150static std::unique_ptr<Module> parseBitcodeFileImpl(MemoryBufferRef Buffer,
151 LLVMContext &Context,
152 bool ShouldBeLazy,
153 std::string &ErrMsg) {
Rafael Espindolad0b23be2015-01-10 00:07:30 +0000154
Duncan P. N. Exon Smith140d41b2014-12-17 22:05:42 +0000155 // Find the buffer.
156 ErrorOr<MemoryBufferRef> MBOrErr =
157 IRObjectFile::findBitcodeInMemBuffer(Buffer);
Rafael Espindolad0b23be2015-01-10 00:07:30 +0000158 if (std::error_code EC = MBOrErr.getError()) {
159 ErrMsg = EC.message();
160 return nullptr;
161 }
Duncan P. N. Exon Smith140d41b2014-12-17 22:05:42 +0000162
Rafael Espindolad0b23be2015-01-10 00:07:30 +0000163 std::function<void(const DiagnosticInfo &)> DiagnosticHandler =
164 [&ErrMsg](const DiagnosticInfo &DI) {
165 raw_string_ostream Stream(ErrMsg);
166 DiagnosticPrinterRawOStream DP(Stream);
167 DI.print(DP);
168 };
169
170 if (!ShouldBeLazy) {
Duncan P. N. Exon Smith140d41b2014-12-17 22:05:42 +0000171 // Parse the full file.
Rafael Espindoladcd1dca2015-06-16 22:27:55 +0000172 ErrorOr<std::unique_ptr<Module>> M =
Rafael Espindolad0b23be2015-01-10 00:07:30 +0000173 parseBitcodeFile(*MBOrErr, Context, DiagnosticHandler);
174 if (!M)
175 return nullptr;
Rafael Espindoladcd1dca2015-06-16 22:27:55 +0000176 return std::move(*M);
Rafael Espindolad0b23be2015-01-10 00:07:30 +0000177 }
Duncan P. N. Exon Smith140d41b2014-12-17 22:05:42 +0000178
179 // Parse lazily.
180 std::unique_ptr<MemoryBuffer> LightweightBuf =
181 MemoryBuffer::getMemBuffer(*MBOrErr, false);
Rafael Espindoladcd1dca2015-06-16 22:27:55 +0000182 ErrorOr<std::unique_ptr<Module>> M =
183 getLazyBitcodeModule(std::move(LightweightBuf), Context,
184 DiagnosticHandler, true /*ShouldLazyLoadMetadata*/);
Rafael Espindolad0b23be2015-01-10 00:07:30 +0000185 if (!M)
186 return nullptr;
Rafael Espindoladcd1dca2015-06-16 22:27:55 +0000187 return std::move(*M);
Duncan P. N. Exon Smith140d41b2014-12-17 22:05:42 +0000188}
189
Rafael Espindola48af1c22014-08-19 18:44:46 +0000190LTOModule *LTOModule::makeLTOModule(MemoryBufferRef Buffer,
Duncan P. N. Exon Smith97b45872014-11-11 23:08:05 +0000191 TargetOptions options, std::string &errMsg,
192 LLVMContext *Context) {
193 std::unique_ptr<LLVMContext> OwnedContext;
194 if (!Context) {
195 OwnedContext = llvm::make_unique<LLVMContext>();
196 Context = OwnedContext.get();
197 }
198
Duncan P. N. Exon Smith140d41b2014-12-17 22:05:42 +0000199 // If we own a context, we know this is being used only for symbol
200 // extraction, not linking. Be lazy in that case.
Rafael Espindoladcd1dca2015-06-16 22:27:55 +0000201 std::unique_ptr<Module> M = parseBitcodeFileImpl(
Rafael Espindolad0b23be2015-01-10 00:07:30 +0000202 Buffer, *Context,
Rafael Espindoladcd1dca2015-06-16 22:27:55 +0000203 /* ShouldBeLazy */ static_cast<bool>(OwnedContext), errMsg);
Rafael Espindolad0b23be2015-01-10 00:07:30 +0000204 if (!M)
Craig Topper2617dcc2014-04-15 06:32:26 +0000205 return nullptr;
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000206
Rafael Espindoladddd1fd2014-07-04 18:40:36 +0000207 std::string TripleStr = M->getTargetTriple();
Bob Wilson3f7e7c02012-10-12 17:39:25 +0000208 if (TripleStr.empty())
209 TripleStr = sys::getDefaultTargetTriple();
210 llvm::Triple Triple(TripleStr);
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000211
212 // find machine architecture for this module
Bob Wilson3f7e7c02012-10-12 17:39:25 +0000213 const Target *march = TargetRegistry::lookupTarget(TripleStr, errMsg);
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000214 if (!march)
Craig Topper2617dcc2014-04-15 06:32:26 +0000215 return nullptr;
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000216
Nick Lewycky364c04a2011-04-21 01:54:08 +0000217 // construct LTOModule, hand over ownership of module and target
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000218 SubtargetFeatures Features;
Bob Wilson3f7e7c02012-10-12 17:39:25 +0000219 Features.getDefaultSubtargetFeatures(Triple);
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000220 std::string FeatureStr = Features.getString();
Bob Wilson3f7e7c02012-10-12 17:39:25 +0000221 // Set a default CPU for Darwin triples.
Evan Chengfe6e4052011-06-30 01:53:36 +0000222 std::string CPU;
Bob Wilson3f7e7c02012-10-12 17:39:25 +0000223 if (Triple.isOSDarwin()) {
224 if (Triple.getArch() == llvm::Triple::x86_64)
225 CPU = "core2";
226 else if (Triple.getArch() == llvm::Triple::x86)
227 CPU = "yonah";
Tim Northovere19bed72014-07-23 12:32:47 +0000228 else if (Triple.getArch() == llvm::Triple::aarch64)
Tim Northover00ed9962014-03-29 10:18:08 +0000229 CPU = "cyclone";
Bob Wilson3f7e7c02012-10-12 17:39:25 +0000230 }
Rafael Espindola0b385c72013-09-30 16:39:19 +0000231
Bob Wilson3f7e7c02012-10-12 17:39:25 +0000232 TargetMachine *target = march->createTargetMachine(TripleStr, CPU, FeatureStr,
Rafael Espindola0b385c72013-09-30 16:39:19 +0000233 options);
Mehdi Amini46a43552015-03-04 18:43:29 +0000234 M->setDataLayout(*target->getDataLayout());
Rafael Espindola282a4702013-10-31 20:51:58 +0000235
Rafael Espindoladddd1fd2014-07-04 18:40:36 +0000236 std::unique_ptr<object::IRObjectFile> IRObj(
Rafael Espindola48af1c22014-08-19 18:44:46 +0000237 new object::IRObjectFile(Buffer, std::move(M)));
Rafael Espindoladaeafb42014-02-19 17:23:20 +0000238
Duncan P. N. Exon Smith97b45872014-11-11 23:08:05 +0000239 LTOModule *Ret;
240 if (OwnedContext)
241 Ret = new LTOModule(std::move(IRObj), target, std::move(OwnedContext));
242 else
243 Ret = new LTOModule(std::move(IRObj), target);
Rafael Espindoladaeafb42014-02-19 17:23:20 +0000244
Bill Wendling7e58b382012-03-28 23:12:18 +0000245 if (Ret->parseSymbols(errMsg)) {
Rafael Espindola1e49a6d2011-03-02 04:14:42 +0000246 delete Ret;
Craig Topper2617dcc2014-04-15 06:32:26 +0000247 return nullptr;
Rafael Espindola1e49a6d2011-03-02 04:14:42 +0000248 }
Bill Wendling5f689e72011-11-04 18:48:00 +0000249
Yunzhong Gaoa88d7ab2014-01-21 18:31:27 +0000250 Ret->parseMetadata();
251
Rafael Espindola1e49a6d2011-03-02 04:14:42 +0000252 return Ret;
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000253}
254
Manman Ren03456a12014-02-10 23:26:14 +0000255/// Create a MemoryBuffer from a memory range with an optional name.
Rafael Espindolaa6d0b2f2014-08-17 22:37:39 +0000256std::unique_ptr<MemoryBuffer>
257LTOModule::makeBuffer(const void *mem, size_t length, StringRef name) {
Roman Divackyad06cee2012-09-05 22:26:57 +0000258 const char *startPtr = (const char*)mem;
Rafael Espindola3560ff22014-08-27 20:03:13 +0000259 return MemoryBuffer::getMemBuffer(StringRef(startPtr, length), name, false);
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000260}
261
Bill Wendlingfb440502012-03-28 20:46:54 +0000262/// objcClassNameFromExpression - Get string that the data pointer points to.
Rafael Espindola6ee19d22012-12-11 03:10:43 +0000263bool
264LTOModule::objcClassNameFromExpression(const Constant *c, std::string &name) {
265 if (const ConstantExpr *ce = dyn_cast<ConstantExpr>(c)) {
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000266 Constant *op = ce->getOperand(0);
267 if (GlobalVariable *gvn = dyn_cast<GlobalVariable>(op)) {
268 Constant *cn = gvn->getInitializer();
Chris Lattnercf9e8f62012-02-05 02:29:43 +0000269 if (ConstantDataArray *ca = dyn_cast<ConstantDataArray>(cn)) {
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000270 if (ca->isCString()) {
Yaron Keren075759a2015-03-30 15:42:36 +0000271 name = (".objc_class_name_" + ca->getAsCString()).str();
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000272 return true;
Nick Kledzikb481c202009-06-01 20:33:09 +0000273 }
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000274 }
Nick Kledzikb481c202009-06-01 20:33:09 +0000275 }
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000276 }
277 return false;
278}
279
Bill Wendlingfb440502012-03-28 20:46:54 +0000280/// addObjCClass - Parse i386/ppc ObjC class data structure.
Rafael Espindola6ee19d22012-12-11 03:10:43 +0000281void LTOModule::addObjCClass(const GlobalVariable *clgv) {
282 const ConstantStruct *c = dyn_cast<ConstantStruct>(clgv->getInitializer());
Bill Wendling5f689e72011-11-04 18:48:00 +0000283 if (!c) return;
Nick Kledzikb481c202009-06-01 20:33:09 +0000284
Bill Wendling5f689e72011-11-04 18:48:00 +0000285 // second slot in __OBJC,__class is pointer to superclass name
286 std::string superclassName;
287 if (objcClassNameFromExpression(c->getOperand(1), superclassName)) {
David Blaikie5106ce72014-11-19 05:49:42 +0000288 auto IterBool =
289 _undefines.insert(std::make_pair(superclassName, NameAndAttributes()));
290 if (IterBool.second) {
291 NameAndAttributes &info = IterBool.first->second;
292 info.name = IterBool.first->first().data();
Rafael Espindola477d11f2011-02-20 16:27:25 +0000293 info.attributes = LTO_SYMBOL_DEFINITION_UNDEFINED;
Bill Wendling9ee2d332012-03-29 08:27:32 +0000294 info.isFunction = false;
295 info.symbol = clgv;
Nick Kledzikb481c202009-06-01 20:33:09 +0000296 }
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000297 }
Bill Wendling5f689e72011-11-04 18:48:00 +0000298
299 // third slot in __OBJC,__class is pointer to class name
300 std::string className;
301 if (objcClassNameFromExpression(c->getOperand(2), className)) {
David Blaikie5106ce72014-11-19 05:49:42 +0000302 auto Iter = _defines.insert(className).first;
Bill Wendling9ee2d332012-03-29 08:27:32 +0000303
Bill Wendling5f689e72011-11-04 18:48:00 +0000304 NameAndAttributes info;
David Blaikie5106ce72014-11-19 05:49:42 +0000305 info.name = Iter->first().data();
Bill Wendling9ee2d332012-03-29 08:27:32 +0000306 info.attributes = LTO_SYMBOL_PERMISSIONS_DATA |
307 LTO_SYMBOL_DEFINITION_REGULAR | LTO_SYMBOL_SCOPE_DEFAULT;
308 info.isFunction = false;
309 info.symbol = clgv;
Bill Wendling5f689e72011-11-04 18:48:00 +0000310 _symbols.push_back(info);
311 }
312}
313
Bill Wendlingfb440502012-03-28 20:46:54 +0000314/// addObjCCategory - Parse i386/ppc ObjC category data structure.
Rafael Espindola6ee19d22012-12-11 03:10:43 +0000315void LTOModule::addObjCCategory(const GlobalVariable *clgv) {
316 const ConstantStruct *c = dyn_cast<ConstantStruct>(clgv->getInitializer());
Bill Wendling5f689e72011-11-04 18:48:00 +0000317 if (!c) return;
318
319 // second slot in __OBJC,__category is pointer to target class name
320 std::string targetclassName;
321 if (!objcClassNameFromExpression(c->getOperand(1), targetclassName))
322 return;
323
David Blaikie5106ce72014-11-19 05:49:42 +0000324 auto IterBool =
325 _undefines.insert(std::make_pair(targetclassName, NameAndAttributes()));
Bill Wendling5f689e72011-11-04 18:48:00 +0000326
David Blaikie5106ce72014-11-19 05:49:42 +0000327 if (!IterBool.second)
Bill Wendling5f689e72011-11-04 18:48:00 +0000328 return;
329
David Blaikie5106ce72014-11-19 05:49:42 +0000330 NameAndAttributes &info = IterBool.first->second;
331 info.name = IterBool.first->first().data();
Bill Wendling5f689e72011-11-04 18:48:00 +0000332 info.attributes = LTO_SYMBOL_DEFINITION_UNDEFINED;
Bill Wendling9ee2d332012-03-29 08:27:32 +0000333 info.isFunction = false;
334 info.symbol = clgv;
Nick Kledzikb481c202009-06-01 20:33:09 +0000335}
336
Bill Wendlingfb440502012-03-28 20:46:54 +0000337/// addObjCClassRef - Parse i386/ppc ObjC class list data structure.
Rafael Espindola6ee19d22012-12-11 03:10:43 +0000338void LTOModule::addObjCClassRef(const GlobalVariable *clgv) {
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000339 std::string targetclassName;
Bill Wendling5f689e72011-11-04 18:48:00 +0000340 if (!objcClassNameFromExpression(clgv->getInitializer(), targetclassName))
341 return;
Rafael Espindola477d11f2011-02-20 16:27:25 +0000342
David Blaikie5106ce72014-11-19 05:49:42 +0000343 auto IterBool =
344 _undefines.insert(std::make_pair(targetclassName, NameAndAttributes()));
345
346 if (!IterBool.second)
Bill Wendling5f689e72011-11-04 18:48:00 +0000347 return;
Rafael Espindola477d11f2011-02-20 16:27:25 +0000348
David Blaikie5106ce72014-11-19 05:49:42 +0000349 NameAndAttributes &info = IterBool.first->second;
350 info.name = IterBool.first->first().data();
Bill Wendling5f689e72011-11-04 18:48:00 +0000351 info.attributes = LTO_SYMBOL_DEFINITION_UNDEFINED;
Bill Wendling9ee2d332012-03-29 08:27:32 +0000352 info.isFunction = false;
353 info.symbol = clgv;
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000354}
355
Rafael Espindoladddd1fd2014-07-04 18:40:36 +0000356void LTOModule::addDefinedDataSymbol(const object::BasicSymbolRef &Sym) {
Rafael Espindola0972d412014-07-04 16:37:02 +0000357 SmallString<64> Buffer;
Rafael Espindoladddd1fd2014-07-04 18:40:36 +0000358 {
359 raw_svector_ostream OS(Buffer);
360 Sym.printName(OS);
361 }
362
363 const GlobalValue *V = IRFile->getSymbolGV(Sym.getRawDataRefImpl());
Rafael Espindola0972d412014-07-04 16:37:02 +0000364 addDefinedDataSymbol(Buffer.c_str(), V);
365}
366
367void LTOModule::addDefinedDataSymbol(const char *Name, const GlobalValue *v) {
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000368 // Add to list of defined symbols.
Rafael Espindola0972d412014-07-04 16:37:02 +0000369 addDefinedSymbol(Name, v, false);
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000370
Bill Wendling45f74e32012-08-06 22:52:45 +0000371 if (!v->hasSection() /* || !isTargetDarwin */)
372 return;
373
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000374 // Special case i386/ppc ObjC data structures in magic sections:
375 // The issue is that the old ObjC object format did some strange
376 // contortions to avoid real linker symbols. For instance, the
377 // ObjC class data structure is allocated statically in the executable
378 // that defines that class. That data structures contains a pointer to
379 // its superclass. But instead of just initializing that part of the
380 // struct to the address of its superclass, and letting the static and
381 // dynamic linkers do the rest, the runtime works by having that field
382 // instead point to a C-string that is the name of the superclass.
383 // At runtime the objc initialization updates that pointer and sets
384 // it to point to the actual super class. As far as the linker
385 // knows it is just a pointer to a string. But then someone wanted the
386 // linker to issue errors at build time if the superclass was not found.
387 // So they figured out a way in mach-o object format to use an absolute
388 // symbols (.objc_class_name_Foo = 0) and a floating reference
389 // (.reference .objc_class_name_Bar) to cause the linker into erroring when
390 // a class was missing.
391 // The following synthesizes the implicit .objc_* symbols for the linker
392 // from the ObjC data structures generated by the front end.
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000393
Bill Wendling45f74e32012-08-06 22:52:45 +0000394 // special case if this data blob is an ObjC class definition
Rafael Espindola64c1e182014-06-03 02:41:57 +0000395 std::string Section = v->getSection();
396 if (Section.compare(0, 15, "__OBJC,__class,") == 0) {
Rafael Espindola6ee19d22012-12-11 03:10:43 +0000397 if (const GlobalVariable *gv = dyn_cast<GlobalVariable>(v)) {
Bill Wendling45f74e32012-08-06 22:52:45 +0000398 addObjCClass(gv);
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000399 }
Bill Wendling45f74e32012-08-06 22:52:45 +0000400 }
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000401
Bill Wendling45f74e32012-08-06 22:52:45 +0000402 // special case if this data blob is an ObjC category definition
Rafael Espindola64c1e182014-06-03 02:41:57 +0000403 else if (Section.compare(0, 18, "__OBJC,__category,") == 0) {
Rafael Espindola6ee19d22012-12-11 03:10:43 +0000404 if (const GlobalVariable *gv = dyn_cast<GlobalVariable>(v)) {
Bill Wendling45f74e32012-08-06 22:52:45 +0000405 addObjCCategory(gv);
406 }
407 }
408
409 // special case if this data blob is the list of referenced classes
Rafael Espindola64c1e182014-06-03 02:41:57 +0000410 else if (Section.compare(0, 18, "__OBJC,__cls_refs,") == 0) {
Rafael Espindola6ee19d22012-12-11 03:10:43 +0000411 if (const GlobalVariable *gv = dyn_cast<GlobalVariable>(v)) {
Bill Wendling45f74e32012-08-06 22:52:45 +0000412 addObjCClassRef(gv);
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000413 }
414 }
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000415}
416
Rafael Espindoladddd1fd2014-07-04 18:40:36 +0000417void LTOModule::addDefinedFunctionSymbol(const object::BasicSymbolRef &Sym) {
Rafael Espindola0972d412014-07-04 16:37:02 +0000418 SmallString<64> Buffer;
Rafael Espindoladddd1fd2014-07-04 18:40:36 +0000419 {
420 raw_svector_ostream OS(Buffer);
421 Sym.printName(OS);
422 }
423
424 const Function *F =
425 cast<Function>(IRFile->getSymbolGV(Sym.getRawDataRefImpl()));
Rafael Espindola0972d412014-07-04 16:37:02 +0000426 addDefinedFunctionSymbol(Buffer.c_str(), F);
427}
428
429void LTOModule::addDefinedFunctionSymbol(const char *Name, const Function *F) {
Bill Wendlingfb440502012-03-28 20:46:54 +0000430 // add to list of defined symbols
Rafael Espindola0972d412014-07-04 16:37:02 +0000431 addDefinedSymbol(Name, F, true);
Bill Wendlingfb440502012-03-28 20:46:54 +0000432}
433
Rafael Espindola0972d412014-07-04 16:37:02 +0000434void LTOModule::addDefinedSymbol(const char *Name, const GlobalValue *def,
435 bool isFunction) {
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000436 // set alignment part log2() can have rounding errors
437 uint32_t align = def->getAlignment();
Rafael Espindola94751172014-05-05 14:18:16 +0000438 uint32_t attr = align ? countTrailingZeros(align) : 0;
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000439
440 // set permissions part
Bill Wendling9ee2d332012-03-29 08:27:32 +0000441 if (isFunction) {
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000442 attr |= LTO_SYMBOL_PERMISSIONS_CODE;
Bill Wendling9ee2d332012-03-29 08:27:32 +0000443 } else {
Rafael Espindola6ee19d22012-12-11 03:10:43 +0000444 const GlobalVariable *gv = dyn_cast<GlobalVariable>(def);
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000445 if (gv && gv->isConstant())
446 attr |= LTO_SYMBOL_PERMISSIONS_RODATA;
447 else
448 attr |= LTO_SYMBOL_PERMISSIONS_DATA;
449 }
450
451 // set definition part
Rafael Espindola2fb5bc32014-03-13 23:18:37 +0000452 if (def->hasWeakLinkage() || def->hasLinkOnceLinkage())
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000453 attr |= LTO_SYMBOL_DEFINITION_WEAK;
Bill Wendlingdcd7c2b2010-09-27 20:17:45 +0000454 else if (def->hasCommonLinkage())
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000455 attr |= LTO_SYMBOL_DEFINITION_TENTATIVE;
Bill Wendlingdcd7c2b2010-09-27 20:17:45 +0000456 else
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000457 attr |= LTO_SYMBOL_DEFINITION_REGULAR;
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000458
459 // set scope part
Duncan P. N. Exon Smith87121f82014-05-07 22:53:14 +0000460 if (def->hasLocalLinkage())
461 // Ignore visibility if linkage is local.
462 attr |= LTO_SYMBOL_SCOPE_INTERNAL;
463 else if (def->hasHiddenVisibility())
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000464 attr |= LTO_SYMBOL_SCOPE_HIDDEN;
465 else if (def->hasProtectedVisibility())
466 attr |= LTO_SYMBOL_SCOPE_PROTECTED;
Rafael Espindolaf21434c2014-07-30 19:42:16 +0000467 else if (canBeOmittedFromSymbolTable(def))
Rafael Espindola282a4702013-10-31 20:51:58 +0000468 attr |= LTO_SYMBOL_SCOPE_DEFAULT_CAN_BE_HIDDEN;
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000469 else
Duncan P. N. Exon Smith87121f82014-05-07 22:53:14 +0000470 attr |= LTO_SYMBOL_SCOPE_DEFAULT;
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000471
Peter Collingbourne485ad482015-06-11 21:41:27 +0000472 if (def->hasComdat())
473 attr |= LTO_SYMBOL_COMDAT;
474
David Blaikie5106ce72014-11-19 05:49:42 +0000475 auto Iter = _defines.insert(Name).first;
Rafael Espindola477d11f2011-02-20 16:27:25 +0000476
Bill Wendling9ee2d332012-03-29 08:27:32 +0000477 // fill information structure
478 NameAndAttributes info;
David Blaikie5106ce72014-11-19 05:49:42 +0000479 StringRef NameRef = Iter->first();
Rafael Espindola0972d412014-07-04 16:37:02 +0000480 info.name = NameRef.data();
481 assert(info.name[NameRef.size()] == '\0');
Bill Wendling9ee2d332012-03-29 08:27:32 +0000482 info.attributes = attr;
483 info.isFunction = isFunction;
484 info.symbol = def;
485
486 // add to table of symbols
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000487 _symbols.push_back(info);
Nick Kledzik07b4a622008-02-26 20:26:43 +0000488}
489
Bill Wendlingfb440502012-03-28 20:46:54 +0000490/// addAsmGlobalSymbol - Add a global symbol from module-level ASM to the
491/// defined list.
Rafael Espindola1e49a6d2011-03-02 04:14:42 +0000492void LTOModule::addAsmGlobalSymbol(const char *name,
493 lto_symbol_attributes scope) {
David Blaikie5106ce72014-11-19 05:49:42 +0000494 auto IterBool = _defines.insert(name);
Rafael Espindola477d11f2011-02-20 16:27:25 +0000495
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000496 // only add new define if not already defined
David Blaikie5106ce72014-11-19 05:49:42 +0000497 if (!IterBool.second)
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000498 return;
499
David Blaikie5106ce72014-11-19 05:49:42 +0000500 NameAndAttributes &info = _undefines[IterBool.first->first().data()];
Bill Wendling9ee2d332012-03-29 08:27:32 +0000501
Craig Topper2617dcc2014-04-15 06:32:26 +0000502 if (info.symbol == nullptr) {
Bill Wendling71b19bb2012-04-02 10:01:21 +0000503 // FIXME: This is trying to take care of module ASM like this:
504 //
505 // module asm ".zerofill __FOO, __foo, _bar_baz_qux, 0"
506 //
507 // but is gross and its mother dresses it funny. Have the ASM parser give us
508 // more details for this type of situation so that we're not guessing so
509 // much.
510
511 // fill information structure
David Blaikie5106ce72014-11-19 05:49:42 +0000512 info.name = IterBool.first->first().data();
Bill Wendling71b19bb2012-04-02 10:01:21 +0000513 info.attributes =
514 LTO_SYMBOL_PERMISSIONS_DATA | LTO_SYMBOL_DEFINITION_REGULAR | scope;
515 info.isFunction = false;
Craig Topper2617dcc2014-04-15 06:32:26 +0000516 info.symbol = nullptr;
Bill Wendling71b19bb2012-04-02 10:01:21 +0000517
518 // add to table of symbols
519 _symbols.push_back(info);
Bill Wendling3a0bcf02012-04-02 03:33:31 +0000520 return;
521 }
522
Bill Wendling9ee2d332012-03-29 08:27:32 +0000523 if (info.isFunction)
Rafael Espindola0972d412014-07-04 16:37:02 +0000524 addDefinedFunctionSymbol(info.name, cast<Function>(info.symbol));
Bill Wendling9ee2d332012-03-29 08:27:32 +0000525 else
Rafael Espindola0972d412014-07-04 16:37:02 +0000526 addDefinedDataSymbol(info.name, info.symbol);
Bill Wendling8f6c8a92012-03-30 23:26:06 +0000527
528 _symbols.back().attributes &= ~LTO_SYMBOL_SCOPE_MASK;
529 _symbols.back().attributes |= scope;
Devang Patela59fe952008-07-16 18:06:52 +0000530}
Nick Kledzik07b4a622008-02-26 20:26:43 +0000531
Bill Wendlingfb440502012-03-28 20:46:54 +0000532/// addAsmGlobalSymbolUndef - Add a global symbol from module-level ASM to the
533/// undefined list.
Rafael Espindola1e49a6d2011-03-02 04:14:42 +0000534void LTOModule::addAsmGlobalSymbolUndef(const char *name) {
David Blaikie5106ce72014-11-19 05:49:42 +0000535 auto IterBool = _undefines.insert(std::make_pair(name, NameAndAttributes()));
Rafael Espindola1e49a6d2011-03-02 04:14:42 +0000536
David Blaikie5106ce72014-11-19 05:49:42 +0000537 _asm_undefines.push_back(IterBool.first->first().data());
Rafael Espindola1e49a6d2011-03-02 04:14:42 +0000538
539 // we already have the symbol
David Blaikie5106ce72014-11-19 05:49:42 +0000540 if (!IterBool.second)
Rafael Espindola1e49a6d2011-03-02 04:14:42 +0000541 return;
542
Alp Toker98444342014-04-19 23:56:35 +0000543 uint32_t attr = LTO_SYMBOL_DEFINITION_UNDEFINED;
Rafael Espindola1e49a6d2011-03-02 04:14:42 +0000544 attr |= LTO_SYMBOL_SCOPE_DEFAULT;
David Blaikie5106ce72014-11-19 05:49:42 +0000545 NameAndAttributes &info = IterBool.first->second;
546 info.name = IterBool.first->first().data();
Bill Wendling9ee2d332012-03-29 08:27:32 +0000547 info.attributes = attr;
548 info.isFunction = false;
Craig Topper2617dcc2014-04-15 06:32:26 +0000549 info.symbol = nullptr;
Rafael Espindola1e49a6d2011-03-02 04:14:42 +0000550}
551
Rafael Espindoladddd1fd2014-07-04 18:40:36 +0000552/// Add a symbol which isn't defined just yet to a list to be resolved later.
553void LTOModule::addPotentialUndefinedSymbol(const object::BasicSymbolRef &Sym,
554 bool isFunc) {
Rafael Espindola34b59382011-02-11 05:23:09 +0000555 SmallString<64> name;
Rafael Espindoladddd1fd2014-07-04 18:40:36 +0000556 {
557 raw_svector_ostream OS(name);
558 Sym.printName(OS);
559 }
Rafael Espindola56548522009-04-24 16:55:21 +0000560
David Blaikie5106ce72014-11-19 05:49:42 +0000561 auto IterBool = _undefines.insert(std::make_pair(name, NameAndAttributes()));
Rafael Espindola477d11f2011-02-20 16:27:25 +0000562
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000563 // we already have the symbol
David Blaikie5106ce72014-11-19 05:49:42 +0000564 if (!IterBool.second)
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000565 return;
Rafael Espindola56548522009-04-24 16:55:21 +0000566
David Blaikie5106ce72014-11-19 05:49:42 +0000567 NameAndAttributes &info = IterBool.first->second;
Rafael Espindola477d11f2011-02-20 16:27:25 +0000568
David Blaikie5106ce72014-11-19 05:49:42 +0000569 info.name = IterBool.first->first().data();
Bill Wendlingfb440502012-03-28 20:46:54 +0000570
Rafael Espindoladddd1fd2014-07-04 18:40:36 +0000571 const GlobalValue *decl = IRFile->getSymbolGV(Sym.getRawDataRefImpl());
572
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000573 if (decl->hasExternalWeakLinkage())
574 info.attributes = LTO_SYMBOL_DEFINITION_WEAKUNDEF;
575 else
576 info.attributes = LTO_SYMBOL_DEFINITION_UNDEFINED;
Rafael Espindola477d11f2011-02-20 16:27:25 +0000577
Bill Wendling9ee2d332012-03-29 08:27:32 +0000578 info.isFunction = isFunc;
579 info.symbol = decl;
Nick Kledzik07b4a622008-02-26 20:26:43 +0000580}
581
Bill Wendling7e58b382012-03-28 23:12:18 +0000582/// parseSymbols - Parse the symbols from the module and model-level ASM and add
Bill Wendlingfb440502012-03-28 20:46:54 +0000583/// them to either the defined or undefined lists.
Bill Wendling7e58b382012-03-28 23:12:18 +0000584bool LTOModule::parseSymbols(std::string &errMsg) {
Rafael Espindoladddd1fd2014-07-04 18:40:36 +0000585 for (auto &Sym : IRFile->symbols()) {
586 const GlobalValue *GV = IRFile->getSymbolGV(Sym.getRawDataRefImpl());
587 uint32_t Flags = Sym.getFlags();
Rafael Espindola089a3172014-07-04 19:31:27 +0000588 if (Flags & object::BasicSymbolRef::SF_FormatSpecific)
589 continue;
590
Rafael Espindoladddd1fd2014-07-04 18:40:36 +0000591 bool IsUndefined = Flags & object::BasicSymbolRef::SF_Undefined;
592
593 if (!GV) {
594 SmallString<64> Buffer;
595 {
596 raw_svector_ostream OS(Buffer);
597 Sym.printName(OS);
598 }
599 const char *Name = Buffer.c_str();
600
601 if (IsUndefined)
602 addAsmGlobalSymbolUndef(Name);
603 else if (Flags & object::BasicSymbolRef::SF_Global)
604 addAsmGlobalSymbol(Name, LTO_SYMBOL_SCOPE_DEFAULT);
605 else
606 addAsmGlobalSymbol(Name, LTO_SYMBOL_SCOPE_INTERNAL);
607 continue;
608 }
609
610 auto *F = dyn_cast<Function>(GV);
611 if (IsUndefined) {
612 addPotentialUndefinedSymbol(Sym, F != nullptr);
613 continue;
614 }
615
616 if (F) {
617 addDefinedFunctionSymbol(Sym);
618 continue;
619 }
620
621 if (isa<GlobalVariable>(GV)) {
622 addDefinedDataSymbol(Sym);
623 continue;
624 }
625
626 assert(isa<GlobalAlias>(GV));
627 addDefinedDataSymbol(Sym);
Daniel Dunbar919660b2010-08-10 23:46:46 +0000628 }
Nick Kledzik07b4a622008-02-26 20:26:43 +0000629
Daniel Dunbar919660b2010-08-10 23:46:46 +0000630 // make symbols for all undefines
Bill Wendling9ee2d332012-03-29 08:27:32 +0000631 for (StringMap<NameAndAttributes>::iterator u =_undefines.begin(),
632 e = _undefines.end(); u != e; ++u) {
633 // If this symbol also has a definition, then don't make an undefine because
634 // it is a tentative definition.
635 if (_defines.count(u->getKey())) continue;
636 NameAndAttributes info = u->getValue();
637 _symbols.push_back(info);
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000638 }
Bill Wendling9ee2d332012-03-29 08:27:32 +0000639
Rafael Espindola1e49a6d2011-03-02 04:14:42 +0000640 return false;
Nick Kledzik91a6dcf2008-02-27 22:25:36 +0000641}
Yunzhong Gaoa88d7ab2014-01-21 18:31:27 +0000642
643/// parseMetadata - Parse metadata from the module
644void LTOModule::parseMetadata() {
645 // Linker Options
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000646 if (Metadata *Val = getModule().getModuleFlag("Linker Options")) {
Yunzhong Gaoa88d7ab2014-01-21 18:31:27 +0000647 MDNode *LinkerOptions = cast<MDNode>(Val);
648 for (unsigned i = 0, e = LinkerOptions->getNumOperands(); i != e; ++i) {
649 MDNode *MDOptions = cast<MDNode>(LinkerOptions->getOperand(i));
650 for (unsigned ii = 0, ie = MDOptions->getNumOperands(); ii != ie; ++ii) {
651 MDString *MDOption = cast<MDString>(MDOptions->getOperand(ii));
David Blaikie5106ce72014-11-19 05:49:42 +0000652 // FIXME: Make StringSet::insert match Self-Associative Container
653 // requirements, returning <iter,bool> rather than bool, and use that
654 // here.
655 StringRef Op =
656 _linkeropt_strings.insert(MDOption->getString()).first->first();
Eric Christopher36fe0282015-02-03 07:22:52 +0000657 StringRef DepLibName =
658 _target->getObjFileLowering()->getDepLibFromLinkerOpt(Op);
Yunzhong Gaoa88d7ab2014-01-21 18:31:27 +0000659 if (!DepLibName.empty())
660 _deplibs.push_back(DepLibName.data());
661 else if (!Op.empty())
662 _linkeropts.push_back(Op.data());
663 }
664 }
665 }
666
667 // Add other interesting metadata here.
668}