blob: 6424feb429ae028d437b760b68b0396f1ee903b3 [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"
Benjamin Kramerb3e8a6d2016-01-27 10:01:28 +000029#include "llvm/MC/MCParser/MCTargetAsmParser.h"
Rafael Espindola20fcda72014-01-22 22:11:14 +000030#include "llvm/MC/MCSection.h"
Evan Cheng91111d22011-07-09 05:47:46 +000031#include "llvm/MC/MCSubtargetInfo.h"
Rafael Espindola1e49a6d2011-03-02 04:14:42 +000032#include "llvm/MC/MCSymbol.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() {}
58
Bill Wendlingfb440502012-03-28 20:46:54 +000059/// isBitcodeFile - Returns 'true' if the file (or memory contents) is LLVM
60/// bitcode.
Peter Collingbourne10039c02014-09-18 21:28:49 +000061bool LTOModule::isBitcodeFile(const void *Mem, size_t Length) {
62 ErrorOr<MemoryBufferRef> BCData = IRObjectFile::findBitcodeInMemBuffer(
63 MemoryBufferRef(StringRef((const char *)Mem, Length), "<mem>"));
64 return bool(BCData);
Nick Kledzik07b4a622008-02-26 20:26:43 +000065}
66
Peter Collingbourne10039c02014-09-18 21:28:49 +000067bool LTOModule::isBitcodeFile(const char *Path) {
68 ErrorOr<std::unique_ptr<MemoryBuffer>> BufferOrErr =
69 MemoryBuffer::getFile(Path);
70 if (!BufferOrErr)
Rafael Espindola71affba2013-06-12 15:13:57 +000071 return false;
Peter Collingbourne10039c02014-09-18 21:28:49 +000072
73 ErrorOr<MemoryBufferRef> BCData = IRObjectFile::findBitcodeInMemBuffer(
74 BufferOrErr.get()->getMemBufferRef());
75 return bool(BCData);
Nick Kledzik07b4a622008-02-26 20:26:43 +000076}
77
Mehdi Amini7c4a1a82016-03-09 01:37:22 +000078bool LTOModule::isThinLTO() {
79 // Right now the detection is only based on the summary presence. We may want
80 // to add a dedicated flag at some point.
81 return hasFunctionSummary(IRFile->getMemoryBufferRef(),
82 [](const DiagnosticInfo &DI) {
83 DiagnosticPrinterRawOStream DP(errs());
84 DI.print(DP);
85 errs() << '\n';
86 return;
87 });
88}
89
Peter Collingbourne10039c02014-09-18 21:28:49 +000090bool LTOModule::isBitcodeForTarget(MemoryBuffer *Buffer,
91 StringRef TriplePrefix) {
92 ErrorOr<MemoryBufferRef> BCOrErr =
93 IRObjectFile::findBitcodeInMemBuffer(Buffer->getMemBufferRef());
94 if (!BCOrErr)
95 return false;
Duncan P. N. Exon Smith97b45872014-11-11 23:08:05 +000096 LLVMContext Context;
97 std::string Triple = getBitcodeTargetTriple(*BCOrErr, Context);
Peter Collingbourne10039c02014-09-18 21:28:49 +000098 return StringRef(Triple).startswith(TriplePrefix);
Daniel Dunbar5657e7b2010-08-10 23:46:39 +000099}
100
Mehdi Amini3383ccc2015-11-09 02:46:41 +0000101std::string LTOModule::getProducerString(MemoryBuffer *Buffer) {
102 ErrorOr<MemoryBufferRef> BCOrErr =
103 IRObjectFile::findBitcodeInMemBuffer(Buffer->getMemBufferRef());
104 if (!BCOrErr)
105 return "";
106 LLVMContext Context;
107 return getBitcodeProducerString(*BCOrErr, Context);
108}
109
Rafael Espindolaa7612b42015-12-04 16:14:31 +0000110ErrorOr<std::unique_ptr<LTOModule>>
111LTOModule::createFromFile(LLVMContext &Context, const char *path,
112 TargetOptions options) {
Rafael Espindolaadf21f22014-07-06 17:43:13 +0000113 ErrorOr<std::unique_ptr<MemoryBuffer>> BufferOrErr =
114 MemoryBuffer::getFile(path);
Petr Pavlueba30392016-01-20 09:03:42 +0000115 if (std::error_code EC = BufferOrErr.getError()) {
116 Context.emitError(EC.message());
Rafael Espindolaa7612b42015-12-04 16:14:31 +0000117 return EC;
Petr Pavlueba30392016-01-20 09:03:42 +0000118 }
Rafael Espindola48af1c22014-08-19 18:44:46 +0000119 std::unique_ptr<MemoryBuffer> Buffer = std::move(BufferOrErr.get());
Petr Pavlu7ad9ec92016-03-01 13:13:49 +0000120 return makeLTOModule(Buffer->getMemBufferRef(), options, Context,
121 /* ShouldBeLazy*/ false);
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000122}
123
Rafael Espindolaa7612b42015-12-04 16:14:31 +0000124ErrorOr<std::unique_ptr<LTOModule>>
125LTOModule::createFromOpenFile(LLVMContext &Context, int fd, const char *path,
126 size_t size, TargetOptions options) {
127 return createFromOpenFileSlice(Context, fd, path, size, 0, options);
Rafael Espindolab39c7c72011-03-17 00:36:11 +0000128}
129
Rafael Espindolaa7612b42015-12-04 16:14:31 +0000130ErrorOr<std::unique_ptr<LTOModule>>
131LTOModule::createFromOpenFileSlice(LLVMContext &Context, int fd,
132 const char *path, size_t map_size,
133 off_t offset, TargetOptions options) {
Rafael Espindolaadf21f22014-07-06 17:43:13 +0000134 ErrorOr<std::unique_ptr<MemoryBuffer>> BufferOrErr =
135 MemoryBuffer::getOpenFileSlice(fd, path, map_size, offset);
Petr Pavlueba30392016-01-20 09:03:42 +0000136 if (std::error_code EC = BufferOrErr.getError()) {
137 Context.emitError(EC.message());
Rafael Espindolaa7612b42015-12-04 16:14:31 +0000138 return EC;
Petr Pavlueba30392016-01-20 09:03:42 +0000139 }
Rafael Espindola48af1c22014-08-19 18:44:46 +0000140 std::unique_ptr<MemoryBuffer> Buffer = std::move(BufferOrErr.get());
Petr Pavlu7ad9ec92016-03-01 13:13:49 +0000141 return makeLTOModule(Buffer->getMemBufferRef(), options, Context,
142 /* ShouldBeLazy */ false);
Rafael Espindola56e41f72011-02-08 22:40:47 +0000143}
144
Rafael Espindolaa7612b42015-12-04 16:14:31 +0000145ErrorOr<std::unique_ptr<LTOModule>>
146LTOModule::createFromBuffer(LLVMContext &Context, const void *mem,
147 size_t length, TargetOptions options,
148 StringRef path) {
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);
Petr Pavlu7ad9ec92016-03-01 13:13:49 +0000151 return makeLTOModule(Buffer, options, Context, /* ShouldBeLazy */ false);
152}
153
154ErrorOr<std::unique_ptr<LTOModule>>
155LTOModule::createInLocalContext(std::unique_ptr<LLVMContext> Context,
156 const void *mem, size_t length,
157 TargetOptions options, StringRef path) {
158 StringRef Data((const char *)mem, length);
159 MemoryBufferRef Buffer(Data, path);
160 // If we own a context, we know this is being used only for symbol extraction,
161 // not linking. Be lazy in that case.
162 ErrorOr<std::unique_ptr<LTOModule>> Ret =
163 makeLTOModule(Buffer, options, *Context, /* ShouldBeLazy */ true);
164 if (Ret)
165 (*Ret)->OwnedContext = std::move(Context);
David Blaikiebcb1c7e2016-03-01 20:41:17 +0000166 return Ret;
Bill Wendlingb8dcda72012-08-06 21:34:54 +0000167}
168
Rafael Espindolaa7612b42015-12-04 16:14:31 +0000169static ErrorOr<std::unique_ptr<Module>>
170parseBitcodeFileImpl(MemoryBufferRef Buffer, LLVMContext &Context,
171 bool ShouldBeLazy) {
Rafael Espindolad0b23be2015-01-10 00:07:30 +0000172
Duncan P. N. Exon Smith140d41b2014-12-17 22:05:42 +0000173 // Find the buffer.
174 ErrorOr<MemoryBufferRef> MBOrErr =
175 IRObjectFile::findBitcodeInMemBuffer(Buffer);
Petr Pavlueba30392016-01-20 09:03:42 +0000176 if (std::error_code EC = MBOrErr.getError()) {
177 Context.emitError(EC.message());
Rafael Espindolaa7612b42015-12-04 16:14:31 +0000178 return EC;
Petr Pavlueba30392016-01-20 09:03:42 +0000179 }
Rafael Espindolad0b23be2015-01-10 00:07:30 +0000180
181 if (!ShouldBeLazy) {
Duncan P. N. Exon Smith140d41b2014-12-17 22:05:42 +0000182 // Parse the full file.
Rafael Espindolaa7612b42015-12-04 16:14:31 +0000183 ErrorOr<std::unique_ptr<Module>> M = parseBitcodeFile(*MBOrErr, Context);
184 if (std::error_code EC = M.getError())
185 return EC;
Rafael Espindoladcd1dca2015-06-16 22:27:55 +0000186 return std::move(*M);
Rafael Espindolad0b23be2015-01-10 00:07:30 +0000187 }
Duncan P. N. Exon Smith140d41b2014-12-17 22:05:42 +0000188
189 // Parse lazily.
190 std::unique_ptr<MemoryBuffer> LightweightBuf =
191 MemoryBuffer::getMemBuffer(*MBOrErr, false);
Rafael Espindola9d2bfc42015-12-14 23:17:03 +0000192 ErrorOr<std::unique_ptr<Module>> M = getLazyBitcodeModule(
193 std::move(LightweightBuf), Context, true /*ShouldLazyLoadMetadata*/);
Rafael Espindolaa7612b42015-12-04 16:14:31 +0000194 if (std::error_code EC = M.getError())
195 return EC;
Rafael Espindoladcd1dca2015-06-16 22:27:55 +0000196 return std::move(*M);
Duncan P. N. Exon Smith140d41b2014-12-17 22:05:42 +0000197}
198
Rafael Espindolaa7612b42015-12-04 16:14:31 +0000199ErrorOr<std::unique_ptr<LTOModule>>
200LTOModule::makeLTOModule(MemoryBufferRef Buffer, TargetOptions options,
Petr Pavlu7ad9ec92016-03-01 13:13:49 +0000201 LLVMContext &Context, bool ShouldBeLazy) {
Rafael Espindolaa7612b42015-12-04 16:14:31 +0000202 ErrorOr<std::unique_ptr<Module>> MOrErr =
Petr Pavlu7ad9ec92016-03-01 13:13:49 +0000203 parseBitcodeFileImpl(Buffer, Context, ShouldBeLazy);
Rafael Espindolaa7612b42015-12-04 16:14:31 +0000204 if (std::error_code EC = MOrErr.getError())
205 return EC;
206 std::unique_ptr<Module> &M = *MOrErr;
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000207
Rafael Espindoladddd1fd2014-07-04 18:40:36 +0000208 std::string TripleStr = M->getTargetTriple();
Bob Wilson3f7e7c02012-10-12 17:39:25 +0000209 if (TripleStr.empty())
210 TripleStr = sys::getDefaultTargetTriple();
211 llvm::Triple Triple(TripleStr);
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000212
213 // find machine architecture for this module
Rafael Espindolaa7612b42015-12-04 16:14:31 +0000214 std::string errMsg;
Bob Wilson3f7e7c02012-10-12 17:39:25 +0000215 const Target *march = TargetRegistry::lookupTarget(TripleStr, errMsg);
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000216 if (!march)
Rafael Espindolaa7612b42015-12-04 16:14:31 +0000217 return std::unique_ptr<LTOModule>(nullptr);
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000218
Nick Lewycky364c04a2011-04-21 01:54:08 +0000219 // construct LTOModule, hand over ownership of module and target
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000220 SubtargetFeatures Features;
Bob Wilson3f7e7c02012-10-12 17:39:25 +0000221 Features.getDefaultSubtargetFeatures(Triple);
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000222 std::string FeatureStr = Features.getString();
Bob Wilson3f7e7c02012-10-12 17:39:25 +0000223 // Set a default CPU for Darwin triples.
Evan Chengfe6e4052011-06-30 01:53:36 +0000224 std::string CPU;
Bob Wilson3f7e7c02012-10-12 17:39:25 +0000225 if (Triple.isOSDarwin()) {
226 if (Triple.getArch() == llvm::Triple::x86_64)
227 CPU = "core2";
228 else if (Triple.getArch() == llvm::Triple::x86)
229 CPU = "yonah";
Tim Northovere19bed72014-07-23 12:32:47 +0000230 else if (Triple.getArch() == llvm::Triple::aarch64)
Tim Northover00ed9962014-03-29 10:18:08 +0000231 CPU = "cyclone";
Bob Wilson3f7e7c02012-10-12 17:39:25 +0000232 }
Rafael Espindola0b385c72013-09-30 16:39:19 +0000233
Bob Wilson3f7e7c02012-10-12 17:39:25 +0000234 TargetMachine *target = march->createTargetMachine(TripleStr, CPU, FeatureStr,
Rafael Espindola0b385c72013-09-30 16:39:19 +0000235 options);
Mehdi Amini26d48132015-07-24 16:04:22 +0000236 M->setDataLayout(target->createDataLayout());
Rafael Espindola282a4702013-10-31 20:51:58 +0000237
Rafael Espindoladddd1fd2014-07-04 18:40:36 +0000238 std::unique_ptr<object::IRObjectFile> IRObj(
Rafael Espindola48af1c22014-08-19 18:44:46 +0000239 new object::IRObjectFile(Buffer, std::move(M)));
Rafael Espindoladaeafb42014-02-19 17:23:20 +0000240
Petr Pavlu7ad9ec92016-03-01 13:13:49 +0000241 std::unique_ptr<LTOModule> Ret(new LTOModule(std::move(IRObj), target));
Rafael Espindolaa06bb162015-12-03 23:56:42 +0000242 Ret->parseSymbols();
Yunzhong Gaoa88d7ab2014-01-21 18:31:27 +0000243 Ret->parseMetadata();
244
Rafael Espindolaa7612b42015-12-04 16:14:31 +0000245 return std::move(Ret);
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000246}
247
Manman Ren03456a12014-02-10 23:26:14 +0000248/// Create a MemoryBuffer from a memory range with an optional name.
Rafael Espindolaa6d0b2f2014-08-17 22:37:39 +0000249std::unique_ptr<MemoryBuffer>
250LTOModule::makeBuffer(const void *mem, size_t length, StringRef name) {
Roman Divackyad06cee2012-09-05 22:26:57 +0000251 const char *startPtr = (const char*)mem;
Rafael Espindola3560ff22014-08-27 20:03:13 +0000252 return MemoryBuffer::getMemBuffer(StringRef(startPtr, length), name, false);
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000253}
254
Bill Wendlingfb440502012-03-28 20:46:54 +0000255/// objcClassNameFromExpression - Get string that the data pointer points to.
Rafael Espindola6ee19d22012-12-11 03:10:43 +0000256bool
257LTOModule::objcClassNameFromExpression(const Constant *c, std::string &name) {
258 if (const ConstantExpr *ce = dyn_cast<ConstantExpr>(c)) {
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000259 Constant *op = ce->getOperand(0);
260 if (GlobalVariable *gvn = dyn_cast<GlobalVariable>(op)) {
261 Constant *cn = gvn->getInitializer();
Chris Lattnercf9e8f62012-02-05 02:29:43 +0000262 if (ConstantDataArray *ca = dyn_cast<ConstantDataArray>(cn)) {
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000263 if (ca->isCString()) {
Yaron Keren075759a2015-03-30 15:42:36 +0000264 name = (".objc_class_name_" + ca->getAsCString()).str();
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000265 return true;
Nick Kledzikb481c202009-06-01 20:33:09 +0000266 }
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000267 }
Nick Kledzikb481c202009-06-01 20:33:09 +0000268 }
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000269 }
270 return false;
271}
272
Bill Wendlingfb440502012-03-28 20:46:54 +0000273/// addObjCClass - Parse i386/ppc ObjC class data structure.
Rafael Espindola6ee19d22012-12-11 03:10:43 +0000274void LTOModule::addObjCClass(const GlobalVariable *clgv) {
275 const ConstantStruct *c = dyn_cast<ConstantStruct>(clgv->getInitializer());
Bill Wendling5f689e72011-11-04 18:48:00 +0000276 if (!c) return;
Nick Kledzikb481c202009-06-01 20:33:09 +0000277
Bill Wendling5f689e72011-11-04 18:48:00 +0000278 // second slot in __OBJC,__class is pointer to superclass name
279 std::string superclassName;
280 if (objcClassNameFromExpression(c->getOperand(1), superclassName)) {
David Blaikie5106ce72014-11-19 05:49:42 +0000281 auto IterBool =
282 _undefines.insert(std::make_pair(superclassName, NameAndAttributes()));
283 if (IterBool.second) {
284 NameAndAttributes &info = IterBool.first->second;
285 info.name = IterBool.first->first().data();
Rafael Espindola477d11f2011-02-20 16:27:25 +0000286 info.attributes = LTO_SYMBOL_DEFINITION_UNDEFINED;
Bill Wendling9ee2d332012-03-29 08:27:32 +0000287 info.isFunction = false;
288 info.symbol = clgv;
Nick Kledzikb481c202009-06-01 20:33:09 +0000289 }
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000290 }
Bill Wendling5f689e72011-11-04 18:48:00 +0000291
292 // third slot in __OBJC,__class is pointer to class name
293 std::string className;
294 if (objcClassNameFromExpression(c->getOperand(2), className)) {
David Blaikie5106ce72014-11-19 05:49:42 +0000295 auto Iter = _defines.insert(className).first;
Bill Wendling9ee2d332012-03-29 08:27:32 +0000296
Bill Wendling5f689e72011-11-04 18:48:00 +0000297 NameAndAttributes info;
David Blaikie5106ce72014-11-19 05:49:42 +0000298 info.name = Iter->first().data();
Bill Wendling9ee2d332012-03-29 08:27:32 +0000299 info.attributes = LTO_SYMBOL_PERMISSIONS_DATA |
300 LTO_SYMBOL_DEFINITION_REGULAR | LTO_SYMBOL_SCOPE_DEFAULT;
301 info.isFunction = false;
302 info.symbol = clgv;
Bill Wendling5f689e72011-11-04 18:48:00 +0000303 _symbols.push_back(info);
304 }
305}
306
Bill Wendlingfb440502012-03-28 20:46:54 +0000307/// addObjCCategory - Parse i386/ppc ObjC category data structure.
Rafael Espindola6ee19d22012-12-11 03:10:43 +0000308void LTOModule::addObjCCategory(const GlobalVariable *clgv) {
309 const ConstantStruct *c = dyn_cast<ConstantStruct>(clgv->getInitializer());
Bill Wendling5f689e72011-11-04 18:48:00 +0000310 if (!c) return;
311
312 // second slot in __OBJC,__category is pointer to target class name
313 std::string targetclassName;
314 if (!objcClassNameFromExpression(c->getOperand(1), targetclassName))
315 return;
316
David Blaikie5106ce72014-11-19 05:49:42 +0000317 auto IterBool =
318 _undefines.insert(std::make_pair(targetclassName, NameAndAttributes()));
Bill Wendling5f689e72011-11-04 18:48:00 +0000319
David Blaikie5106ce72014-11-19 05:49:42 +0000320 if (!IterBool.second)
Bill Wendling5f689e72011-11-04 18:48:00 +0000321 return;
322
David Blaikie5106ce72014-11-19 05:49:42 +0000323 NameAndAttributes &info = IterBool.first->second;
324 info.name = IterBool.first->first().data();
Bill Wendling5f689e72011-11-04 18:48:00 +0000325 info.attributes = LTO_SYMBOL_DEFINITION_UNDEFINED;
Bill Wendling9ee2d332012-03-29 08:27:32 +0000326 info.isFunction = false;
327 info.symbol = clgv;
Nick Kledzikb481c202009-06-01 20:33:09 +0000328}
329
Bill Wendlingfb440502012-03-28 20:46:54 +0000330/// addObjCClassRef - Parse i386/ppc ObjC class list data structure.
Rafael Espindola6ee19d22012-12-11 03:10:43 +0000331void LTOModule::addObjCClassRef(const GlobalVariable *clgv) {
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000332 std::string targetclassName;
Bill Wendling5f689e72011-11-04 18:48:00 +0000333 if (!objcClassNameFromExpression(clgv->getInitializer(), targetclassName))
334 return;
Rafael Espindola477d11f2011-02-20 16:27:25 +0000335
David Blaikie5106ce72014-11-19 05:49:42 +0000336 auto IterBool =
337 _undefines.insert(std::make_pair(targetclassName, NameAndAttributes()));
338
339 if (!IterBool.second)
Bill Wendling5f689e72011-11-04 18:48:00 +0000340 return;
Rafael Espindola477d11f2011-02-20 16:27:25 +0000341
David Blaikie5106ce72014-11-19 05:49:42 +0000342 NameAndAttributes &info = IterBool.first->second;
343 info.name = IterBool.first->first().data();
Bill Wendling5f689e72011-11-04 18:48:00 +0000344 info.attributes = LTO_SYMBOL_DEFINITION_UNDEFINED;
Bill Wendling9ee2d332012-03-29 08:27:32 +0000345 info.isFunction = false;
346 info.symbol = clgv;
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000347}
348
Rafael Espindoladddd1fd2014-07-04 18:40:36 +0000349void LTOModule::addDefinedDataSymbol(const object::BasicSymbolRef &Sym) {
Rafael Espindola0972d412014-07-04 16:37:02 +0000350 SmallString<64> Buffer;
Rafael Espindoladddd1fd2014-07-04 18:40:36 +0000351 {
352 raw_svector_ostream OS(Buffer);
353 Sym.printName(OS);
354 }
355
356 const GlobalValue *V = IRFile->getSymbolGV(Sym.getRawDataRefImpl());
Rafael Espindola0972d412014-07-04 16:37:02 +0000357 addDefinedDataSymbol(Buffer.c_str(), V);
358}
359
360void LTOModule::addDefinedDataSymbol(const char *Name, const GlobalValue *v) {
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000361 // Add to list of defined symbols.
Rafael Espindola0972d412014-07-04 16:37:02 +0000362 addDefinedSymbol(Name, v, false);
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000363
Bill Wendling45f74e32012-08-06 22:52:45 +0000364 if (!v->hasSection() /* || !isTargetDarwin */)
365 return;
366
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000367 // Special case i386/ppc ObjC data structures in magic sections:
368 // The issue is that the old ObjC object format did some strange
369 // contortions to avoid real linker symbols. For instance, the
370 // ObjC class data structure is allocated statically in the executable
371 // that defines that class. That data structures contains a pointer to
372 // its superclass. But instead of just initializing that part of the
373 // struct to the address of its superclass, and letting the static and
374 // dynamic linkers do the rest, the runtime works by having that field
375 // instead point to a C-string that is the name of the superclass.
376 // At runtime the objc initialization updates that pointer and sets
377 // it to point to the actual super class. As far as the linker
378 // knows it is just a pointer to a string. But then someone wanted the
379 // linker to issue errors at build time if the superclass was not found.
380 // So they figured out a way in mach-o object format to use an absolute
381 // symbols (.objc_class_name_Foo = 0) and a floating reference
382 // (.reference .objc_class_name_Bar) to cause the linker into erroring when
383 // a class was missing.
384 // The following synthesizes the implicit .objc_* symbols for the linker
385 // from the ObjC data structures generated by the front end.
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000386
Bill Wendling45f74e32012-08-06 22:52:45 +0000387 // special case if this data blob is an ObjC class definition
Rafael Espindola64c1e182014-06-03 02:41:57 +0000388 std::string Section = v->getSection();
389 if (Section.compare(0, 15, "__OBJC,__class,") == 0) {
Rafael Espindola6ee19d22012-12-11 03:10:43 +0000390 if (const GlobalVariable *gv = dyn_cast<GlobalVariable>(v)) {
Bill Wendling45f74e32012-08-06 22:52:45 +0000391 addObjCClass(gv);
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000392 }
Bill Wendling45f74e32012-08-06 22:52:45 +0000393 }
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000394
Bill Wendling45f74e32012-08-06 22:52:45 +0000395 // special case if this data blob is an ObjC category definition
Rafael Espindola64c1e182014-06-03 02:41:57 +0000396 else if (Section.compare(0, 18, "__OBJC,__category,") == 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 addObjCCategory(gv);
399 }
400 }
401
402 // special case if this data blob is the list of referenced classes
Rafael Espindola64c1e182014-06-03 02:41:57 +0000403 else if (Section.compare(0, 18, "__OBJC,__cls_refs,") == 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 addObjCClassRef(gv);
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000406 }
407 }
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000408}
409
Rafael Espindoladddd1fd2014-07-04 18:40:36 +0000410void LTOModule::addDefinedFunctionSymbol(const object::BasicSymbolRef &Sym) {
Rafael Espindola0972d412014-07-04 16:37:02 +0000411 SmallString<64> Buffer;
Rafael Espindoladddd1fd2014-07-04 18:40:36 +0000412 {
413 raw_svector_ostream OS(Buffer);
414 Sym.printName(OS);
415 }
416
417 const Function *F =
418 cast<Function>(IRFile->getSymbolGV(Sym.getRawDataRefImpl()));
Rafael Espindola0972d412014-07-04 16:37:02 +0000419 addDefinedFunctionSymbol(Buffer.c_str(), F);
420}
421
422void LTOModule::addDefinedFunctionSymbol(const char *Name, const Function *F) {
Bill Wendlingfb440502012-03-28 20:46:54 +0000423 // add to list of defined symbols
Rafael Espindola0972d412014-07-04 16:37:02 +0000424 addDefinedSymbol(Name, F, true);
Bill Wendlingfb440502012-03-28 20:46:54 +0000425}
426
Rafael Espindola0972d412014-07-04 16:37:02 +0000427void LTOModule::addDefinedSymbol(const char *Name, const GlobalValue *def,
428 bool isFunction) {
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000429 // set alignment part log2() can have rounding errors
430 uint32_t align = def->getAlignment();
Rafael Espindola94751172014-05-05 14:18:16 +0000431 uint32_t attr = align ? countTrailingZeros(align) : 0;
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000432
433 // set permissions part
Bill Wendling9ee2d332012-03-29 08:27:32 +0000434 if (isFunction) {
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000435 attr |= LTO_SYMBOL_PERMISSIONS_CODE;
Bill Wendling9ee2d332012-03-29 08:27:32 +0000436 } else {
Rafael Espindola6ee19d22012-12-11 03:10:43 +0000437 const GlobalVariable *gv = dyn_cast<GlobalVariable>(def);
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000438 if (gv && gv->isConstant())
439 attr |= LTO_SYMBOL_PERMISSIONS_RODATA;
440 else
441 attr |= LTO_SYMBOL_PERMISSIONS_DATA;
442 }
443
444 // set definition part
Rafael Espindola2fb5bc32014-03-13 23:18:37 +0000445 if (def->hasWeakLinkage() || def->hasLinkOnceLinkage())
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000446 attr |= LTO_SYMBOL_DEFINITION_WEAK;
Bill Wendlingdcd7c2b2010-09-27 20:17:45 +0000447 else if (def->hasCommonLinkage())
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000448 attr |= LTO_SYMBOL_DEFINITION_TENTATIVE;
Bill Wendlingdcd7c2b2010-09-27 20:17:45 +0000449 else
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000450 attr |= LTO_SYMBOL_DEFINITION_REGULAR;
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000451
452 // set scope part
Duncan P. N. Exon Smith87121f82014-05-07 22:53:14 +0000453 if (def->hasLocalLinkage())
454 // Ignore visibility if linkage is local.
455 attr |= LTO_SYMBOL_SCOPE_INTERNAL;
456 else if (def->hasHiddenVisibility())
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000457 attr |= LTO_SYMBOL_SCOPE_HIDDEN;
458 else if (def->hasProtectedVisibility())
459 attr |= LTO_SYMBOL_SCOPE_PROTECTED;
Rafael Espindolaf21434c2014-07-30 19:42:16 +0000460 else if (canBeOmittedFromSymbolTable(def))
Rafael Espindola282a4702013-10-31 20:51:58 +0000461 attr |= LTO_SYMBOL_SCOPE_DEFAULT_CAN_BE_HIDDEN;
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000462 else
Duncan P. N. Exon Smith87121f82014-05-07 22:53:14 +0000463 attr |= LTO_SYMBOL_SCOPE_DEFAULT;
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000464
Peter Collingbourne485ad482015-06-11 21:41:27 +0000465 if (def->hasComdat())
466 attr |= LTO_SYMBOL_COMDAT;
467
Peter Collingbourne17eff102015-07-04 03:42:35 +0000468 if (isa<GlobalAlias>(def))
469 attr |= LTO_SYMBOL_ALIAS;
470
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
Rafael Espindolaa06bb162015-12-03 23:56:42 +0000578void LTOModule::parseSymbols() {
Rafael Espindoladddd1fd2014-07-04 18:40:36 +0000579 for (auto &Sym : IRFile->symbols()) {
580 const GlobalValue *GV = IRFile->getSymbolGV(Sym.getRawDataRefImpl());
581 uint32_t Flags = Sym.getFlags();
Rafael Espindola089a3172014-07-04 19:31:27 +0000582 if (Flags & object::BasicSymbolRef::SF_FormatSpecific)
583 continue;
584
Rafael Espindoladddd1fd2014-07-04 18:40:36 +0000585 bool IsUndefined = Flags & object::BasicSymbolRef::SF_Undefined;
586
587 if (!GV) {
588 SmallString<64> Buffer;
589 {
590 raw_svector_ostream OS(Buffer);
591 Sym.printName(OS);
592 }
593 const char *Name = Buffer.c_str();
594
595 if (IsUndefined)
596 addAsmGlobalSymbolUndef(Name);
597 else if (Flags & object::BasicSymbolRef::SF_Global)
598 addAsmGlobalSymbol(Name, LTO_SYMBOL_SCOPE_DEFAULT);
599 else
600 addAsmGlobalSymbol(Name, LTO_SYMBOL_SCOPE_INTERNAL);
601 continue;
602 }
603
604 auto *F = dyn_cast<Function>(GV);
605 if (IsUndefined) {
606 addPotentialUndefinedSymbol(Sym, F != nullptr);
607 continue;
608 }
609
610 if (F) {
611 addDefinedFunctionSymbol(Sym);
612 continue;
613 }
614
615 if (isa<GlobalVariable>(GV)) {
616 addDefinedDataSymbol(Sym);
617 continue;
618 }
619
620 assert(isa<GlobalAlias>(GV));
621 addDefinedDataSymbol(Sym);
Daniel Dunbar919660b2010-08-10 23:46:46 +0000622 }
Nick Kledzik07b4a622008-02-26 20:26:43 +0000623
Daniel Dunbar919660b2010-08-10 23:46:46 +0000624 // make symbols for all undefines
Bill Wendling9ee2d332012-03-29 08:27:32 +0000625 for (StringMap<NameAndAttributes>::iterator u =_undefines.begin(),
626 e = _undefines.end(); u != e; ++u) {
627 // If this symbol also has a definition, then don't make an undefine because
628 // it is a tentative definition.
629 if (_defines.count(u->getKey())) continue;
630 NameAndAttributes info = u->getValue();
631 _symbols.push_back(info);
Daniel Dunbar5657e7b2010-08-10 23:46:39 +0000632 }
Nick Kledzik91a6dcf2008-02-27 22:25:36 +0000633}
Yunzhong Gaoa88d7ab2014-01-21 18:31:27 +0000634
635/// parseMetadata - Parse metadata from the module
636void LTOModule::parseMetadata() {
Peter Collingbourneaef36592015-06-29 22:04:09 +0000637 raw_string_ostream OS(LinkerOpts);
638
Yunzhong Gaoa88d7ab2014-01-21 18:31:27 +0000639 // Linker Options
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000640 if (Metadata *Val = getModule().getModuleFlag("Linker Options")) {
Yunzhong Gaoa88d7ab2014-01-21 18:31:27 +0000641 MDNode *LinkerOptions = cast<MDNode>(Val);
642 for (unsigned i = 0, e = LinkerOptions->getNumOperands(); i != e; ++i) {
643 MDNode *MDOptions = cast<MDNode>(LinkerOptions->getOperand(i));
644 for (unsigned ii = 0, ie = MDOptions->getNumOperands(); ii != ie; ++ii) {
645 MDString *MDOption = cast<MDString>(MDOptions->getOperand(ii));
Peter Collingbourneaef36592015-06-29 22:04:09 +0000646 OS << " " << MDOption->getString();
Yunzhong Gaoa88d7ab2014-01-21 18:31:27 +0000647 }
648 }
649 }
650
Peter Collingbourneaef36592015-06-29 22:04:09 +0000651 // Globals
652 Mangler Mang;
653 for (const NameAndAttributes &Sym : _symbols) {
654 if (!Sym.symbol)
655 continue;
656 _target->getObjFileLowering()->emitLinkerFlagsForGlobal(OS, Sym.symbol,
657 Mang);
658 }
659
Yunzhong Gaoa88d7ab2014-01-21 18:31:27 +0000660 // Add other interesting metadata here.
661}