blob: 409b9490233278c6d98c5ca0c340305b7951f67e [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"
Peter Collingbourneaef36592015-06-29 22:04:09 +000022#include "llvm/IR/Mangler.h"
Yunzhong Gaoa88d7ab2014-01-21 18:31:27 +000023#include "llvm/IR/Metadata.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000024#include "llvm/IR/Module.h"
Rafael Espindola1e49a6d2011-03-02 04:14:42 +000025#include "llvm/MC/MCExpr.h"
26#include "llvm/MC/MCInst.h"
Joey Goulydb6144e2013-09-12 12:55:29 +000027#include "llvm/MC/MCInstrInfo.h"
Chandler Carruth4d88a1c2012-12-04 10:44:52 +000028#include "llvm/MC/MCParser/MCAsmParser.h"
Rafael Espindola20fcda72014-01-22 22:11:14 +000029#include "llvm/MC/MCSection.h"
Evan Cheng91111d22011-07-09 05:47:46 +000030#include "llvm/MC/MCSubtargetInfo.h"
Rafael Espindola1e49a6d2011-03-02 04:14:42 +000031#include "llvm/MC/MCSymbol.h"
Evan Cheng11424442011-07-26 00:24:13 +000032#include "llvm/MC/MCTargetAsmParser.h"
Bill Wendling8f6c8a92012-03-30 23:26:06 +000033#include "llvm/MC/SubtargetFeature.h"
Peter Collingbourne10039c02014-09-18 21:28:49 +000034#include "llvm/Object/IRObjectFile.h"
35#include "llvm/Object/ObjectFile.h"
Bill Wendlingb8dcda72012-08-06 21:34:54 +000036#include "llvm/Support/CommandLine.h"
Rafael Espindola46ed3532013-06-11 18:05:26 +000037#include "llvm/Support/FileSystem.h"
Chandler Carruth8a8cd2b2014-01-07 11:48:04 +000038#include "llvm/Support/Host.h"
Bill Wendling8f6c8a92012-03-30 23:26:06 +000039#include "llvm/Support/MemoryBuffer.h"
40#include "llvm/Support/Path.h"
Bill Wendling8f6c8a92012-03-30 23:26:06 +000041#include "llvm/Support/SourceMgr.h"
Bill Wendling8f6c8a92012-03-30 23:26:06 +000042#include "llvm/Support/TargetRegistry.h"
43#include "llvm/Support/TargetSelect.h"
Yunzhong Gaoa88d7ab2014-01-21 18:31:27 +000044#include "llvm/Target/TargetLowering.h"
45#include "llvm/Target/TargetLoweringObjectFile.h"
Chandler Carruth4d88a1c2012-12-04 10:44:52 +000046#include "llvm/Target/TargetRegisterInfo.h"
Eric Christopherd9134482014-08-04 21:25:23 +000047#include "llvm/Target/TargetSubtargetInfo.h"
Rafael Espindola282a4702013-10-31 20:51:58 +000048#include "llvm/Transforms/Utils/GlobalStatus.h"
Rafael Espindolaa6e9c3e2014-06-12 17:38:55 +000049#include <system_error>
Nick Kledzik07b4a622008-02-26 20:26:43 +000050using namespace llvm;
Peter Collingbourne10039c02014-09-18 21:28:49 +000051using namespace llvm::object;
Nick Kledzik07b4a622008-02-26 20:26:43 +000052
Rafael Espindoladddd1fd2014-07-04 18:40:36 +000053LTOModule::LTOModule(std::unique_ptr<object::IRObjectFile> Obj,
54 llvm::TargetMachine *TM)
55 : IRFile(std::move(Obj)), _target(TM) {}
Bill Wendlingfb440502012-03-28 20:46:54 +000056
Duncan P. N. Exon Smith97b45872014-11-11 23:08:05 +000057LTOModule::LTOModule(std::unique_ptr<object::IRObjectFile> Obj,
58 llvm::TargetMachine *TM,
59 std::unique_ptr<LLVMContext> Context)
60 : OwnedContext(std::move(Context)), IRFile(std::move(Obj)), _target(TM) {}
61
62LTOModule::~LTOModule() {}
63
Bill Wendlingfb440502012-03-28 20:46:54 +000064/// isBitcodeFile - Returns 'true' if the file (or memory contents) is LLVM
65/// bitcode.
Peter Collingbourne10039c02014-09-18 21:28:49 +000066bool LTOModule::isBitcodeFile(const void *Mem, size_t Length) {
67 ErrorOr<MemoryBufferRef> BCData = IRObjectFile::findBitcodeInMemBuffer(
68 MemoryBufferRef(StringRef((const char *)Mem, Length), "<mem>"));
69 return bool(BCData);
Nick Kledzik07b4a622008-02-26 20:26:43 +000070}
71
Peter Collingbourne10039c02014-09-18 21:28:49 +000072bool LTOModule::isBitcodeFile(const char *Path) {
73 ErrorOr<std::unique_ptr<MemoryBuffer>> BufferOrErr =
74 MemoryBuffer::getFile(Path);
75 if (!BufferOrErr)
Rafael Espindola71affba2013-06-12 15:13:57 +000076 return false;
Peter Collingbourne10039c02014-09-18 21:28:49 +000077
78 ErrorOr<MemoryBufferRef> BCData = IRObjectFile::findBitcodeInMemBuffer(
79 BufferOrErr.get()->getMemBufferRef());
80 return bool(BCData);
Nick Kledzik07b4a622008-02-26 20:26:43 +000081}
82
Peter Collingbourne10039c02014-09-18 21:28:49 +000083bool LTOModule::isBitcodeForTarget(MemoryBuffer *Buffer,
84 StringRef TriplePrefix) {
85 ErrorOr<MemoryBufferRef> BCOrErr =
86 IRObjectFile::findBitcodeInMemBuffer(Buffer->getMemBufferRef());
87 if (!BCOrErr)
88 return false;
Duncan P. N. Exon Smith97b45872014-11-11 23:08:05 +000089 LLVMContext Context;
90 std::string Triple = getBitcodeTargetTriple(*BCOrErr, Context);
Peter Collingbourne10039c02014-09-18 21:28:49 +000091 return StringRef(Triple).startswith(TriplePrefix);
Daniel Dunbar5657e7b2010-08-10 23:46:39 +000092}
93
Mehdi Amini3383ccc2015-11-09 02:46:41 +000094std::string LTOModule::getProducerString(MemoryBuffer *Buffer) {
95 ErrorOr<MemoryBufferRef> BCOrErr =
96 IRObjectFile::findBitcodeInMemBuffer(Buffer->getMemBufferRef());
97 if (!BCOrErr)
98 return "";
99 LLVMContext Context;
100 return getBitcodeProducerString(*BCOrErr, Context);
101}
102
Rafael Espindolaa7612b42015-12-04 16:14:31 +0000103ErrorOr<std::unique_ptr<LTOModule>>
104LTOModule::createFromFile(LLVMContext &Context, const char *path,
105 TargetOptions options) {
Rafael Espindolaadf21f22014-07-06 17:43:13 +0000106 ErrorOr<std::unique_ptr<MemoryBuffer>> BufferOrErr =
107 MemoryBuffer::getFile(path);
Rafael Espindolaa7612b42015-12-04 16:14:31 +0000108 if (std::error_code EC = BufferOrErr.getError())
109 return EC;
Rafael Espindola48af1c22014-08-19 18:44:46 +0000110 std::unique_ptr<MemoryBuffer> Buffer = std::move(BufferOrErr.get());
Rafael Espindolaa7612b42015-12-04 16:14:31 +0000111 return makeLTOModule(Buffer->getMemBufferRef(), options, &Context);
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000112}
113
Rafael Espindolaa7612b42015-12-04 16:14:31 +0000114ErrorOr<std::unique_ptr<LTOModule>>
115LTOModule::createFromOpenFile(LLVMContext &Context, int fd, const char *path,
116 size_t size, TargetOptions options) {
117 return createFromOpenFileSlice(Context, fd, path, size, 0, options);
Rafael Espindolab39c7c72011-03-17 00:36:11 +0000118}
119
Rafael Espindolaa7612b42015-12-04 16:14:31 +0000120ErrorOr<std::unique_ptr<LTOModule>>
121LTOModule::createFromOpenFileSlice(LLVMContext &Context, int fd,
122 const char *path, size_t map_size,
123 off_t offset, TargetOptions options) {
Rafael Espindolaadf21f22014-07-06 17:43:13 +0000124 ErrorOr<std::unique_ptr<MemoryBuffer>> BufferOrErr =
125 MemoryBuffer::getOpenFileSlice(fd, path, map_size, offset);
Rafael Espindolaa7612b42015-12-04 16:14:31 +0000126 if (std::error_code EC = BufferOrErr.getError())
127 return EC;
Rafael Espindola48af1c22014-08-19 18:44:46 +0000128 std::unique_ptr<MemoryBuffer> Buffer = std::move(BufferOrErr.get());
Rafael Espindolaa7612b42015-12-04 16:14:31 +0000129 return makeLTOModule(Buffer->getMemBufferRef(), options, &Context);
Rafael Espindola56e41f72011-02-08 22:40:47 +0000130}
131
Rafael Espindolaa7612b42015-12-04 16:14:31 +0000132ErrorOr<std::unique_ptr<LTOModule>>
133LTOModule::createFromBuffer(LLVMContext &Context, const void *mem,
134 size_t length, TargetOptions options,
135 StringRef path) {
136 return createInContext(mem, length, options, path, &Context);
Duncan P. N. Exon Smith97b45872014-11-11 23:08:05 +0000137}
138
Rafael Espindolaa7612b42015-12-04 16:14:31 +0000139ErrorOr<std::unique_ptr<LTOModule>>
140LTOModule::createInLocalContext(const void *mem, size_t length,
141 TargetOptions options, StringRef path) {
142 return createInContext(mem, length, options, path, nullptr);
Duncan P. N. Exon Smith97b45872014-11-11 23:08:05 +0000143}
144
Rafael Espindolaa7612b42015-12-04 16:14:31 +0000145ErrorOr<std::unique_ptr<LTOModule>>
146LTOModule::createInContext(const void *mem, size_t length,
147 TargetOptions options, StringRef path,
148 LLVMContext *Context) {
Aaron Ballman47497252014-08-20 12:54:13 +0000149 StringRef Data((const char *)mem, length);
Rafael Espindola48af1c22014-08-19 18:44:46 +0000150 MemoryBufferRef Buffer(Data, path);
Rafael Espindolaa7612b42015-12-04 16:14:31 +0000151 return makeLTOModule(Buffer, options, Context);
Bill Wendlingb8dcda72012-08-06 21:34:54 +0000152}
153
Rafael Espindolaa7612b42015-12-04 16:14:31 +0000154static ErrorOr<std::unique_ptr<Module>>
155parseBitcodeFileImpl(MemoryBufferRef Buffer, LLVMContext &Context,
156 bool ShouldBeLazy) {
Rafael Espindolad0b23be2015-01-10 00:07:30 +0000157
Duncan P. N. Exon Smith140d41b2014-12-17 22:05:42 +0000158 // Find the buffer.
159 ErrorOr<MemoryBufferRef> MBOrErr =
160 IRObjectFile::findBitcodeInMemBuffer(Buffer);
Rafael Espindolaa7612b42015-12-04 16:14:31 +0000161 if (std::error_code EC = MBOrErr.getError())
162 return EC;
Rafael Espindolad0b23be2015-01-10 00:07:30 +0000163
164 if (!ShouldBeLazy) {
Duncan P. N. Exon Smith140d41b2014-12-17 22:05:42 +0000165 // Parse the full file.
Rafael Espindolaa7612b42015-12-04 16:14:31 +0000166 ErrorOr<std::unique_ptr<Module>> M = parseBitcodeFile(*MBOrErr, Context);
167 if (std::error_code EC = M.getError())
168 return EC;
Rafael Espindoladcd1dca2015-06-16 22:27:55 +0000169 return std::move(*M);
Rafael Espindolad0b23be2015-01-10 00:07:30 +0000170 }
Duncan P. N. Exon Smith140d41b2014-12-17 22:05:42 +0000171
172 // Parse lazily.
173 std::unique_ptr<MemoryBuffer> LightweightBuf =
174 MemoryBuffer::getMemBuffer(*MBOrErr, false);
Rafael Espindola9d2bfc42015-12-14 23:17:03 +0000175 ErrorOr<std::unique_ptr<Module>> M = getLazyBitcodeModule(
176 std::move(LightweightBuf), Context, true /*ShouldLazyLoadMetadata*/);
Rafael Espindolaa7612b42015-12-04 16:14:31 +0000177 if (std::error_code EC = M.getError())
178 return EC;
Rafael Espindoladcd1dca2015-06-16 22:27:55 +0000179 return std::move(*M);
Duncan P. N. Exon Smith140d41b2014-12-17 22:05:42 +0000180}
181
Rafael Espindolaa7612b42015-12-04 16:14:31 +0000182ErrorOr<std::unique_ptr<LTOModule>>
183LTOModule::makeLTOModule(MemoryBufferRef Buffer, TargetOptions options,
184 LLVMContext *Context) {
Duncan P. N. Exon Smith97b45872014-11-11 23:08:05 +0000185 std::unique_ptr<LLVMContext> OwnedContext;
186 if (!Context) {
187 OwnedContext = llvm::make_unique<LLVMContext>();
188 Context = OwnedContext.get();
189 }
190
Duncan P. N. Exon Smith140d41b2014-12-17 22:05:42 +0000191 // If we own a context, we know this is being used only for symbol
192 // extraction, not linking. Be lazy in that case.
Rafael Espindolaa7612b42015-12-04 16:14:31 +0000193 ErrorOr<std::unique_ptr<Module>> MOrErr =
194 parseBitcodeFileImpl(Buffer, *Context,
195 /* ShouldBeLazy */ static_cast<bool>(OwnedContext));
196 if (std::error_code EC = MOrErr.getError())
197 return EC;
198 std::unique_ptr<Module> &M = *MOrErr;
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000199
Rafael Espindoladddd1fd2014-07-04 18:40:36 +0000200 std::string TripleStr = M->getTargetTriple();
Bob Wilson3f7e7c02012-10-12 17:39:25 +0000201 if (TripleStr.empty())
202 TripleStr = sys::getDefaultTargetTriple();
203 llvm::Triple Triple(TripleStr);
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000204
205 // find machine architecture for this module
Rafael Espindolaa7612b42015-12-04 16:14:31 +0000206 std::string errMsg;
Bob Wilson3f7e7c02012-10-12 17:39:25 +0000207 const Target *march = TargetRegistry::lookupTarget(TripleStr, errMsg);
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000208 if (!march)
Rafael Espindolaa7612b42015-12-04 16:14:31 +0000209 return std::unique_ptr<LTOModule>(nullptr);
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000210
Nick Lewycky364c04a2011-04-21 01:54:08 +0000211 // construct LTOModule, hand over ownership of module and target
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000212 SubtargetFeatures Features;
Bob Wilson3f7e7c02012-10-12 17:39:25 +0000213 Features.getDefaultSubtargetFeatures(Triple);
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000214 std::string FeatureStr = Features.getString();
Bob Wilson3f7e7c02012-10-12 17:39:25 +0000215 // Set a default CPU for Darwin triples.
Evan Chengfe6e4052011-06-30 01:53:36 +0000216 std::string CPU;
Bob Wilson3f7e7c02012-10-12 17:39:25 +0000217 if (Triple.isOSDarwin()) {
218 if (Triple.getArch() == llvm::Triple::x86_64)
219 CPU = "core2";
220 else if (Triple.getArch() == llvm::Triple::x86)
221 CPU = "yonah";
Tim Northovere19bed72014-07-23 12:32:47 +0000222 else if (Triple.getArch() == llvm::Triple::aarch64)
Tim Northover00ed9962014-03-29 10:18:08 +0000223 CPU = "cyclone";
Bob Wilson3f7e7c02012-10-12 17:39:25 +0000224 }
Rafael Espindola0b385c72013-09-30 16:39:19 +0000225
Bob Wilson3f7e7c02012-10-12 17:39:25 +0000226 TargetMachine *target = march->createTargetMachine(TripleStr, CPU, FeatureStr,
Rafael Espindola0b385c72013-09-30 16:39:19 +0000227 options);
Mehdi Amini26d48132015-07-24 16:04:22 +0000228 M->setDataLayout(target->createDataLayout());
Rafael Espindola282a4702013-10-31 20:51:58 +0000229
Rafael Espindoladddd1fd2014-07-04 18:40:36 +0000230 std::unique_ptr<object::IRObjectFile> IRObj(
Rafael Espindola48af1c22014-08-19 18:44:46 +0000231 new object::IRObjectFile(Buffer, std::move(M)));
Rafael Espindoladaeafb42014-02-19 17:23:20 +0000232
Rafael Espindolaa7612b42015-12-04 16:14:31 +0000233 std::unique_ptr<LTOModule> Ret;
Duncan P. N. Exon Smith97b45872014-11-11 23:08:05 +0000234 if (OwnedContext)
Rafael Espindolaa7612b42015-12-04 16:14:31 +0000235 Ret.reset(new LTOModule(std::move(IRObj), target, std::move(OwnedContext)));
Duncan P. N. Exon Smith97b45872014-11-11 23:08:05 +0000236 else
Rafael Espindolaa7612b42015-12-04 16:14:31 +0000237 Ret.reset(new LTOModule(std::move(IRObj), target));
Rafael Espindoladaeafb42014-02-19 17:23:20 +0000238
Rafael Espindolaa06bb162015-12-03 23:56:42 +0000239 Ret->parseSymbols();
Yunzhong Gaoa88d7ab2014-01-21 18:31:27 +0000240 Ret->parseMetadata();
241
Rafael Espindolaa7612b42015-12-04 16:14:31 +0000242 return std::move(Ret);
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000243}
244
Manman Ren03456a12014-02-10 23:26:14 +0000245/// Create a MemoryBuffer from a memory range with an optional name.
Rafael Espindolaa6d0b2f2014-08-17 22:37:39 +0000246std::unique_ptr<MemoryBuffer>
247LTOModule::makeBuffer(const void *mem, size_t length, StringRef name) {
Roman Divackyad06cee2012-09-05 22:26:57 +0000248 const char *startPtr = (const char*)mem;
Rafael Espindola3560ff22014-08-27 20:03:13 +0000249 return MemoryBuffer::getMemBuffer(StringRef(startPtr, length), name, false);
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000250}
251
Bill Wendlingfb440502012-03-28 20:46:54 +0000252/// objcClassNameFromExpression - Get string that the data pointer points to.
Rafael Espindola6ee19d22012-12-11 03:10:43 +0000253bool
254LTOModule::objcClassNameFromExpression(const Constant *c, std::string &name) {
255 if (const ConstantExpr *ce = dyn_cast<ConstantExpr>(c)) {
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000256 Constant *op = ce->getOperand(0);
257 if (GlobalVariable *gvn = dyn_cast<GlobalVariable>(op)) {
258 Constant *cn = gvn->getInitializer();
Chris Lattnercf9e8f62012-02-05 02:29:43 +0000259 if (ConstantDataArray *ca = dyn_cast<ConstantDataArray>(cn)) {
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000260 if (ca->isCString()) {
Yaron Keren075759a2015-03-30 15:42:36 +0000261 name = (".objc_class_name_" + ca->getAsCString()).str();
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000262 return true;
Nick Kledzikb481c202009-06-01 20:33:09 +0000263 }
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000264 }
Nick Kledzikb481c202009-06-01 20:33:09 +0000265 }
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000266 }
267 return false;
268}
269
Bill Wendlingfb440502012-03-28 20:46:54 +0000270/// addObjCClass - Parse i386/ppc ObjC class data structure.
Rafael Espindola6ee19d22012-12-11 03:10:43 +0000271void LTOModule::addObjCClass(const GlobalVariable *clgv) {
272 const ConstantStruct *c = dyn_cast<ConstantStruct>(clgv->getInitializer());
Bill Wendling5f689e72011-11-04 18:48:00 +0000273 if (!c) return;
Nick Kledzikb481c202009-06-01 20:33:09 +0000274
Bill Wendling5f689e72011-11-04 18:48:00 +0000275 // second slot in __OBJC,__class is pointer to superclass name
276 std::string superclassName;
277 if (objcClassNameFromExpression(c->getOperand(1), superclassName)) {
David Blaikie5106ce72014-11-19 05:49:42 +0000278 auto IterBool =
279 _undefines.insert(std::make_pair(superclassName, NameAndAttributes()));
280 if (IterBool.second) {
281 NameAndAttributes &info = IterBool.first->second;
282 info.name = IterBool.first->first().data();
Rafael Espindola477d11f2011-02-20 16:27:25 +0000283 info.attributes = LTO_SYMBOL_DEFINITION_UNDEFINED;
Bill Wendling9ee2d332012-03-29 08:27:32 +0000284 info.isFunction = false;
285 info.symbol = clgv;
Nick Kledzikb481c202009-06-01 20:33:09 +0000286 }
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000287 }
Bill Wendling5f689e72011-11-04 18:48:00 +0000288
289 // third slot in __OBJC,__class is pointer to class name
290 std::string className;
291 if (objcClassNameFromExpression(c->getOperand(2), className)) {
David Blaikie5106ce72014-11-19 05:49:42 +0000292 auto Iter = _defines.insert(className).first;
Bill Wendling9ee2d332012-03-29 08:27:32 +0000293
Bill Wendling5f689e72011-11-04 18:48:00 +0000294 NameAndAttributes info;
David Blaikie5106ce72014-11-19 05:49:42 +0000295 info.name = Iter->first().data();
Bill Wendling9ee2d332012-03-29 08:27:32 +0000296 info.attributes = LTO_SYMBOL_PERMISSIONS_DATA |
297 LTO_SYMBOL_DEFINITION_REGULAR | LTO_SYMBOL_SCOPE_DEFAULT;
298 info.isFunction = false;
299 info.symbol = clgv;
Bill Wendling5f689e72011-11-04 18:48:00 +0000300 _symbols.push_back(info);
301 }
302}
303
Bill Wendlingfb440502012-03-28 20:46:54 +0000304/// addObjCCategory - Parse i386/ppc ObjC category data structure.
Rafael Espindola6ee19d22012-12-11 03:10:43 +0000305void LTOModule::addObjCCategory(const GlobalVariable *clgv) {
306 const ConstantStruct *c = dyn_cast<ConstantStruct>(clgv->getInitializer());
Bill Wendling5f689e72011-11-04 18:48:00 +0000307 if (!c) return;
308
309 // second slot in __OBJC,__category is pointer to target class name
310 std::string targetclassName;
311 if (!objcClassNameFromExpression(c->getOperand(1), targetclassName))
312 return;
313
David Blaikie5106ce72014-11-19 05:49:42 +0000314 auto IterBool =
315 _undefines.insert(std::make_pair(targetclassName, NameAndAttributes()));
Bill Wendling5f689e72011-11-04 18:48:00 +0000316
David Blaikie5106ce72014-11-19 05:49:42 +0000317 if (!IterBool.second)
Bill Wendling5f689e72011-11-04 18:48:00 +0000318 return;
319
David Blaikie5106ce72014-11-19 05:49:42 +0000320 NameAndAttributes &info = IterBool.first->second;
321 info.name = IterBool.first->first().data();
Bill Wendling5f689e72011-11-04 18:48:00 +0000322 info.attributes = LTO_SYMBOL_DEFINITION_UNDEFINED;
Bill Wendling9ee2d332012-03-29 08:27:32 +0000323 info.isFunction = false;
324 info.symbol = clgv;
Nick Kledzikb481c202009-06-01 20:33:09 +0000325}
326
Bill Wendlingfb440502012-03-28 20:46:54 +0000327/// addObjCClassRef - Parse i386/ppc ObjC class list data structure.
Rafael Espindola6ee19d22012-12-11 03:10:43 +0000328void LTOModule::addObjCClassRef(const GlobalVariable *clgv) {
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000329 std::string targetclassName;
Bill Wendling5f689e72011-11-04 18:48:00 +0000330 if (!objcClassNameFromExpression(clgv->getInitializer(), targetclassName))
331 return;
Rafael Espindola477d11f2011-02-20 16:27:25 +0000332
David Blaikie5106ce72014-11-19 05:49:42 +0000333 auto IterBool =
334 _undefines.insert(std::make_pair(targetclassName, NameAndAttributes()));
335
336 if (!IterBool.second)
Bill Wendling5f689e72011-11-04 18:48:00 +0000337 return;
Rafael Espindola477d11f2011-02-20 16:27:25 +0000338
David Blaikie5106ce72014-11-19 05:49:42 +0000339 NameAndAttributes &info = IterBool.first->second;
340 info.name = IterBool.first->first().data();
Bill Wendling5f689e72011-11-04 18:48:00 +0000341 info.attributes = LTO_SYMBOL_DEFINITION_UNDEFINED;
Bill Wendling9ee2d332012-03-29 08:27:32 +0000342 info.isFunction = false;
343 info.symbol = clgv;
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000344}
345
Rafael Espindoladddd1fd2014-07-04 18:40:36 +0000346void LTOModule::addDefinedDataSymbol(const object::BasicSymbolRef &Sym) {
Rafael Espindola0972d412014-07-04 16:37:02 +0000347 SmallString<64> Buffer;
Rafael Espindoladddd1fd2014-07-04 18:40:36 +0000348 {
349 raw_svector_ostream OS(Buffer);
350 Sym.printName(OS);
351 }
352
353 const GlobalValue *V = IRFile->getSymbolGV(Sym.getRawDataRefImpl());
Rafael Espindola0972d412014-07-04 16:37:02 +0000354 addDefinedDataSymbol(Buffer.c_str(), V);
355}
356
357void LTOModule::addDefinedDataSymbol(const char *Name, const GlobalValue *v) {
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000358 // Add to list of defined symbols.
Rafael Espindola0972d412014-07-04 16:37:02 +0000359 addDefinedSymbol(Name, v, false);
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000360
Bill Wendling45f74e32012-08-06 22:52:45 +0000361 if (!v->hasSection() /* || !isTargetDarwin */)
362 return;
363
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000364 // Special case i386/ppc ObjC data structures in magic sections:
365 // The issue is that the old ObjC object format did some strange
366 // contortions to avoid real linker symbols. For instance, the
367 // ObjC class data structure is allocated statically in the executable
368 // that defines that class. That data structures contains a pointer to
369 // its superclass. But instead of just initializing that part of the
370 // struct to the address of its superclass, and letting the static and
371 // dynamic linkers do the rest, the runtime works by having that field
372 // instead point to a C-string that is the name of the superclass.
373 // At runtime the objc initialization updates that pointer and sets
374 // it to point to the actual super class. As far as the linker
375 // knows it is just a pointer to a string. But then someone wanted the
376 // linker to issue errors at build time if the superclass was not found.
377 // So they figured out a way in mach-o object format to use an absolute
378 // symbols (.objc_class_name_Foo = 0) and a floating reference
379 // (.reference .objc_class_name_Bar) to cause the linker into erroring when
380 // a class was missing.
381 // The following synthesizes the implicit .objc_* symbols for the linker
382 // from the ObjC data structures generated by the front end.
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000383
Bill Wendling45f74e32012-08-06 22:52:45 +0000384 // special case if this data blob is an ObjC class definition
Rafael Espindola64c1e182014-06-03 02:41:57 +0000385 std::string Section = v->getSection();
386 if (Section.compare(0, 15, "__OBJC,__class,") == 0) {
Rafael Espindola6ee19d22012-12-11 03:10:43 +0000387 if (const GlobalVariable *gv = dyn_cast<GlobalVariable>(v)) {
Bill Wendling45f74e32012-08-06 22:52:45 +0000388 addObjCClass(gv);
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000389 }
Bill Wendling45f74e32012-08-06 22:52:45 +0000390 }
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000391
Bill Wendling45f74e32012-08-06 22:52:45 +0000392 // special case if this data blob is an ObjC category definition
Rafael Espindola64c1e182014-06-03 02:41:57 +0000393 else if (Section.compare(0, 18, "__OBJC,__category,") == 0) {
Rafael Espindola6ee19d22012-12-11 03:10:43 +0000394 if (const GlobalVariable *gv = dyn_cast<GlobalVariable>(v)) {
Bill Wendling45f74e32012-08-06 22:52:45 +0000395 addObjCCategory(gv);
396 }
397 }
398
399 // special case if this data blob is the list of referenced classes
Rafael Espindola64c1e182014-06-03 02:41:57 +0000400 else if (Section.compare(0, 18, "__OBJC,__cls_refs,") == 0) {
Rafael Espindola6ee19d22012-12-11 03:10:43 +0000401 if (const GlobalVariable *gv = dyn_cast<GlobalVariable>(v)) {
Bill Wendling45f74e32012-08-06 22:52:45 +0000402 addObjCClassRef(gv);
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000403 }
404 }
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000405}
406
Rafael Espindoladddd1fd2014-07-04 18:40:36 +0000407void LTOModule::addDefinedFunctionSymbol(const object::BasicSymbolRef &Sym) {
Rafael Espindola0972d412014-07-04 16:37:02 +0000408 SmallString<64> Buffer;
Rafael Espindoladddd1fd2014-07-04 18:40:36 +0000409 {
410 raw_svector_ostream OS(Buffer);
411 Sym.printName(OS);
412 }
413
414 const Function *F =
415 cast<Function>(IRFile->getSymbolGV(Sym.getRawDataRefImpl()));
Rafael Espindola0972d412014-07-04 16:37:02 +0000416 addDefinedFunctionSymbol(Buffer.c_str(), F);
417}
418
419void LTOModule::addDefinedFunctionSymbol(const char *Name, const Function *F) {
Bill Wendlingfb440502012-03-28 20:46:54 +0000420 // add to list of defined symbols
Rafael Espindola0972d412014-07-04 16:37:02 +0000421 addDefinedSymbol(Name, F, true);
Bill Wendlingfb440502012-03-28 20:46:54 +0000422}
423
Rafael Espindola0972d412014-07-04 16:37:02 +0000424void LTOModule::addDefinedSymbol(const char *Name, const GlobalValue *def,
425 bool isFunction) {
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000426 // set alignment part log2() can have rounding errors
427 uint32_t align = def->getAlignment();
Rafael Espindola94751172014-05-05 14:18:16 +0000428 uint32_t attr = align ? countTrailingZeros(align) : 0;
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000429
430 // set permissions part
Bill Wendling9ee2d332012-03-29 08:27:32 +0000431 if (isFunction) {
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000432 attr |= LTO_SYMBOL_PERMISSIONS_CODE;
Bill Wendling9ee2d332012-03-29 08:27:32 +0000433 } else {
Rafael Espindola6ee19d22012-12-11 03:10:43 +0000434 const GlobalVariable *gv = dyn_cast<GlobalVariable>(def);
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000435 if (gv && gv->isConstant())
436 attr |= LTO_SYMBOL_PERMISSIONS_RODATA;
437 else
438 attr |= LTO_SYMBOL_PERMISSIONS_DATA;
439 }
440
441 // set definition part
Rafael Espindola2fb5bc32014-03-13 23:18:37 +0000442 if (def->hasWeakLinkage() || def->hasLinkOnceLinkage())
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000443 attr |= LTO_SYMBOL_DEFINITION_WEAK;
Bill Wendlingdcd7c2b2010-09-27 20:17:45 +0000444 else if (def->hasCommonLinkage())
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000445 attr |= LTO_SYMBOL_DEFINITION_TENTATIVE;
Bill Wendlingdcd7c2b2010-09-27 20:17:45 +0000446 else
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000447 attr |= LTO_SYMBOL_DEFINITION_REGULAR;
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000448
449 // set scope part
Duncan P. N. Exon Smith87121f82014-05-07 22:53:14 +0000450 if (def->hasLocalLinkage())
451 // Ignore visibility if linkage is local.
452 attr |= LTO_SYMBOL_SCOPE_INTERNAL;
453 else if (def->hasHiddenVisibility())
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000454 attr |= LTO_SYMBOL_SCOPE_HIDDEN;
455 else if (def->hasProtectedVisibility())
456 attr |= LTO_SYMBOL_SCOPE_PROTECTED;
Rafael Espindolaf21434c2014-07-30 19:42:16 +0000457 else if (canBeOmittedFromSymbolTable(def))
Rafael Espindola282a4702013-10-31 20:51:58 +0000458 attr |= LTO_SYMBOL_SCOPE_DEFAULT_CAN_BE_HIDDEN;
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000459 else
Duncan P. N. Exon Smith87121f82014-05-07 22:53:14 +0000460 attr |= LTO_SYMBOL_SCOPE_DEFAULT;
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000461
Peter Collingbourne485ad482015-06-11 21:41:27 +0000462 if (def->hasComdat())
463 attr |= LTO_SYMBOL_COMDAT;
464
Peter Collingbourne17eff102015-07-04 03:42:35 +0000465 if (isa<GlobalAlias>(def))
466 attr |= LTO_SYMBOL_ALIAS;
467
David Blaikie5106ce72014-11-19 05:49:42 +0000468 auto Iter = _defines.insert(Name).first;
Rafael Espindola477d11f2011-02-20 16:27:25 +0000469
Bill Wendling9ee2d332012-03-29 08:27:32 +0000470 // fill information structure
471 NameAndAttributes info;
David Blaikie5106ce72014-11-19 05:49:42 +0000472 StringRef NameRef = Iter->first();
Rafael Espindola0972d412014-07-04 16:37:02 +0000473 info.name = NameRef.data();
474 assert(info.name[NameRef.size()] == '\0');
Bill Wendling9ee2d332012-03-29 08:27:32 +0000475 info.attributes = attr;
476 info.isFunction = isFunction;
477 info.symbol = def;
478
479 // add to table of symbols
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000480 _symbols.push_back(info);
Nick Kledzik07b4a622008-02-26 20:26:43 +0000481}
482
Bill Wendlingfb440502012-03-28 20:46:54 +0000483/// addAsmGlobalSymbol - Add a global symbol from module-level ASM to the
484/// defined list.
Rafael Espindola1e49a6d2011-03-02 04:14:42 +0000485void LTOModule::addAsmGlobalSymbol(const char *name,
486 lto_symbol_attributes scope) {
David Blaikie5106ce72014-11-19 05:49:42 +0000487 auto IterBool = _defines.insert(name);
Rafael Espindola477d11f2011-02-20 16:27:25 +0000488
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000489 // only add new define if not already defined
David Blaikie5106ce72014-11-19 05:49:42 +0000490 if (!IterBool.second)
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000491 return;
492
David Blaikie5106ce72014-11-19 05:49:42 +0000493 NameAndAttributes &info = _undefines[IterBool.first->first().data()];
Bill Wendling9ee2d332012-03-29 08:27:32 +0000494
Craig Topper2617dcc2014-04-15 06:32:26 +0000495 if (info.symbol == nullptr) {
Bill Wendling71b19bb2012-04-02 10:01:21 +0000496 // FIXME: This is trying to take care of module ASM like this:
497 //
498 // module asm ".zerofill __FOO, __foo, _bar_baz_qux, 0"
499 //
500 // but is gross and its mother dresses it funny. Have the ASM parser give us
501 // more details for this type of situation so that we're not guessing so
502 // much.
503
504 // fill information structure
David Blaikie5106ce72014-11-19 05:49:42 +0000505 info.name = IterBool.first->first().data();
Bill Wendling71b19bb2012-04-02 10:01:21 +0000506 info.attributes =
507 LTO_SYMBOL_PERMISSIONS_DATA | LTO_SYMBOL_DEFINITION_REGULAR | scope;
508 info.isFunction = false;
Craig Topper2617dcc2014-04-15 06:32:26 +0000509 info.symbol = nullptr;
Bill Wendling71b19bb2012-04-02 10:01:21 +0000510
511 // add to table of symbols
512 _symbols.push_back(info);
Bill Wendling3a0bcf02012-04-02 03:33:31 +0000513 return;
514 }
515
Bill Wendling9ee2d332012-03-29 08:27:32 +0000516 if (info.isFunction)
Rafael Espindola0972d412014-07-04 16:37:02 +0000517 addDefinedFunctionSymbol(info.name, cast<Function>(info.symbol));
Bill Wendling9ee2d332012-03-29 08:27:32 +0000518 else
Rafael Espindola0972d412014-07-04 16:37:02 +0000519 addDefinedDataSymbol(info.name, info.symbol);
Bill Wendling8f6c8a92012-03-30 23:26:06 +0000520
521 _symbols.back().attributes &= ~LTO_SYMBOL_SCOPE_MASK;
522 _symbols.back().attributes |= scope;
Devang Patela59fe952008-07-16 18:06:52 +0000523}
Nick Kledzik07b4a622008-02-26 20:26:43 +0000524
Bill Wendlingfb440502012-03-28 20:46:54 +0000525/// addAsmGlobalSymbolUndef - Add a global symbol from module-level ASM to the
526/// undefined list.
Rafael Espindola1e49a6d2011-03-02 04:14:42 +0000527void LTOModule::addAsmGlobalSymbolUndef(const char *name) {
David Blaikie5106ce72014-11-19 05:49:42 +0000528 auto IterBool = _undefines.insert(std::make_pair(name, NameAndAttributes()));
Rafael Espindola1e49a6d2011-03-02 04:14:42 +0000529
David Blaikie5106ce72014-11-19 05:49:42 +0000530 _asm_undefines.push_back(IterBool.first->first().data());
Rafael Espindola1e49a6d2011-03-02 04:14:42 +0000531
532 // we already have the symbol
David Blaikie5106ce72014-11-19 05:49:42 +0000533 if (!IterBool.second)
Rafael Espindola1e49a6d2011-03-02 04:14:42 +0000534 return;
535
Alp Toker98444342014-04-19 23:56:35 +0000536 uint32_t attr = LTO_SYMBOL_DEFINITION_UNDEFINED;
Rafael Espindola1e49a6d2011-03-02 04:14:42 +0000537 attr |= LTO_SYMBOL_SCOPE_DEFAULT;
David Blaikie5106ce72014-11-19 05:49:42 +0000538 NameAndAttributes &info = IterBool.first->second;
539 info.name = IterBool.first->first().data();
Bill Wendling9ee2d332012-03-29 08:27:32 +0000540 info.attributes = attr;
541 info.isFunction = false;
Craig Topper2617dcc2014-04-15 06:32:26 +0000542 info.symbol = nullptr;
Rafael Espindola1e49a6d2011-03-02 04:14:42 +0000543}
544
Rafael Espindoladddd1fd2014-07-04 18:40:36 +0000545/// Add a symbol which isn't defined just yet to a list to be resolved later.
546void LTOModule::addPotentialUndefinedSymbol(const object::BasicSymbolRef &Sym,
547 bool isFunc) {
Rafael Espindola34b59382011-02-11 05:23:09 +0000548 SmallString<64> name;
Rafael Espindoladddd1fd2014-07-04 18:40:36 +0000549 {
550 raw_svector_ostream OS(name);
551 Sym.printName(OS);
552 }
Rafael Espindola56548522009-04-24 16:55:21 +0000553
David Blaikie5106ce72014-11-19 05:49:42 +0000554 auto IterBool = _undefines.insert(std::make_pair(name, NameAndAttributes()));
Rafael Espindola477d11f2011-02-20 16:27:25 +0000555
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000556 // we already have the symbol
David Blaikie5106ce72014-11-19 05:49:42 +0000557 if (!IterBool.second)
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000558 return;
Rafael Espindola56548522009-04-24 16:55:21 +0000559
David Blaikie5106ce72014-11-19 05:49:42 +0000560 NameAndAttributes &info = IterBool.first->second;
Rafael Espindola477d11f2011-02-20 16:27:25 +0000561
David Blaikie5106ce72014-11-19 05:49:42 +0000562 info.name = IterBool.first->first().data();
Bill Wendlingfb440502012-03-28 20:46:54 +0000563
Rafael Espindoladddd1fd2014-07-04 18:40:36 +0000564 const GlobalValue *decl = IRFile->getSymbolGV(Sym.getRawDataRefImpl());
565
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000566 if (decl->hasExternalWeakLinkage())
567 info.attributes = LTO_SYMBOL_DEFINITION_WEAKUNDEF;
568 else
569 info.attributes = LTO_SYMBOL_DEFINITION_UNDEFINED;
Rafael Espindola477d11f2011-02-20 16:27:25 +0000570
Bill Wendling9ee2d332012-03-29 08:27:32 +0000571 info.isFunction = isFunc;
572 info.symbol = decl;
Nick Kledzik07b4a622008-02-26 20:26:43 +0000573}
574
Rafael Espindolaa06bb162015-12-03 23:56:42 +0000575void LTOModule::parseSymbols() {
Rafael Espindoladddd1fd2014-07-04 18:40:36 +0000576 for (auto &Sym : IRFile->symbols()) {
577 const GlobalValue *GV = IRFile->getSymbolGV(Sym.getRawDataRefImpl());
578 uint32_t Flags = Sym.getFlags();
Rafael Espindola089a3172014-07-04 19:31:27 +0000579 if (Flags & object::BasicSymbolRef::SF_FormatSpecific)
580 continue;
581
Rafael Espindoladddd1fd2014-07-04 18:40:36 +0000582 bool IsUndefined = Flags & object::BasicSymbolRef::SF_Undefined;
583
584 if (!GV) {
585 SmallString<64> Buffer;
586 {
587 raw_svector_ostream OS(Buffer);
588 Sym.printName(OS);
589 }
590 const char *Name = Buffer.c_str();
591
592 if (IsUndefined)
593 addAsmGlobalSymbolUndef(Name);
594 else if (Flags & object::BasicSymbolRef::SF_Global)
595 addAsmGlobalSymbol(Name, LTO_SYMBOL_SCOPE_DEFAULT);
596 else
597 addAsmGlobalSymbol(Name, LTO_SYMBOL_SCOPE_INTERNAL);
598 continue;
599 }
600
601 auto *F = dyn_cast<Function>(GV);
602 if (IsUndefined) {
603 addPotentialUndefinedSymbol(Sym, F != nullptr);
604 continue;
605 }
606
607 if (F) {
608 addDefinedFunctionSymbol(Sym);
609 continue;
610 }
611
612 if (isa<GlobalVariable>(GV)) {
613 addDefinedDataSymbol(Sym);
614 continue;
615 }
616
617 assert(isa<GlobalAlias>(GV));
618 addDefinedDataSymbol(Sym);
Daniel Dunbar919660b2010-08-10 23:46:46 +0000619 }
Nick Kledzik07b4a622008-02-26 20:26:43 +0000620
Daniel Dunbar919660b2010-08-10 23:46:46 +0000621 // make symbols for all undefines
Bill Wendling9ee2d332012-03-29 08:27:32 +0000622 for (StringMap<NameAndAttributes>::iterator u =_undefines.begin(),
623 e = _undefines.end(); u != e; ++u) {
624 // If this symbol also has a definition, then don't make an undefine because
625 // it is a tentative definition.
626 if (_defines.count(u->getKey())) continue;
627 NameAndAttributes info = u->getValue();
628 _symbols.push_back(info);
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000629 }
Nick Kledzik91a6dcf2008-02-27 22:25:36 +0000630}
Yunzhong Gaoa88d7ab2014-01-21 18:31:27 +0000631
632/// parseMetadata - Parse metadata from the module
633void LTOModule::parseMetadata() {
Peter Collingbourneaef36592015-06-29 22:04:09 +0000634 raw_string_ostream OS(LinkerOpts);
635
Yunzhong Gaoa88d7ab2014-01-21 18:31:27 +0000636 // Linker Options
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000637 if (Metadata *Val = getModule().getModuleFlag("Linker Options")) {
Yunzhong Gaoa88d7ab2014-01-21 18:31:27 +0000638 MDNode *LinkerOptions = cast<MDNode>(Val);
639 for (unsigned i = 0, e = LinkerOptions->getNumOperands(); i != e; ++i) {
640 MDNode *MDOptions = cast<MDNode>(LinkerOptions->getOperand(i));
641 for (unsigned ii = 0, ie = MDOptions->getNumOperands(); ii != ie; ++ii) {
642 MDString *MDOption = cast<MDString>(MDOptions->getOperand(ii));
Peter Collingbourneaef36592015-06-29 22:04:09 +0000643 OS << " " << MDOption->getString();
Yunzhong Gaoa88d7ab2014-01-21 18:31:27 +0000644 }
645 }
646 }
647
Peter Collingbourneaef36592015-06-29 22:04:09 +0000648 // Globals
649 Mangler Mang;
650 for (const NameAndAttributes &Sym : _symbols) {
651 if (!Sym.symbol)
652 continue;
653 _target->getObjFileLowering()->emitLinkerFlagsForGlobal(OS, Sym.symbol,
654 Mang);
655 }
656
Yunzhong Gaoa88d7ab2014-01-21 18:31:27 +0000657 // Add other interesting metadata here.
658}