blob: f733d633357f4100288882ff8c0121c8afa5f047 [file] [log] [blame]
Alex Lorenz2bdb4e12015-05-27 18:02:19 +00001//===- MIRParser.cpp - MIR serialization format parser implementation -----===//
2//
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.
7//
8//===----------------------------------------------------------------------===//
9//
10// This file implements the class that parses the optional LLVM IR and machine
11// functions that are stored in MIR files.
12//
13//===----------------------------------------------------------------------===//
14
15#include "llvm/CodeGen/MIRParser/MIRParser.h"
Alex Lorenz8e0a1b42015-06-22 17:02:30 +000016#include "MIParser.h"
Alex Lorenz33f0aef2015-06-26 16:46:11 +000017#include "llvm/ADT/DenseMap.h"
Alex Lorenz2bdb4e12015-05-27 18:02:19 +000018#include "llvm/ADT/StringRef.h"
Alex Lorenz735c47e2015-06-15 20:30:22 +000019#include "llvm/ADT/StringMap.h"
Alex Lorenz2bdb4e12015-05-27 18:02:19 +000020#include "llvm/ADT/STLExtras.h"
21#include "llvm/AsmParser/Parser.h"
Alex Lorenz5d6108e2015-06-26 22:56:48 +000022#include "llvm/AsmParser/SlotMapping.h"
Alex Lorenzab980492015-07-20 20:51:18 +000023#include "llvm/CodeGen/MachineConstantPool.h"
Alex Lorenz735c47e2015-06-15 20:30:22 +000024#include "llvm/CodeGen/MachineFunction.h"
Alex Lorenz60541c12015-07-09 19:55:27 +000025#include "llvm/CodeGen/MachineFrameInfo.h"
Alex Lorenz54565cf2015-06-24 19:56:10 +000026#include "llvm/CodeGen/MachineRegisterInfo.h"
Alex Lorenz78d78312015-05-28 22:41:12 +000027#include "llvm/CodeGen/MIRYamlMapping.h"
Alex Lorenz4f093bf2015-06-19 17:43:07 +000028#include "llvm/IR/BasicBlock.h"
Alex Lorenz735c47e2015-06-15 20:30:22 +000029#include "llvm/IR/DiagnosticInfo.h"
Alex Lorenz8e7a58d72015-06-15 23:07:38 +000030#include "llvm/IR/Instructions.h"
Alex Lorenz735c47e2015-06-15 20:30:22 +000031#include "llvm/IR/LLVMContext.h"
Alex Lorenz2bdb4e12015-05-27 18:02:19 +000032#include "llvm/IR/Module.h"
Alex Lorenz4f093bf2015-06-19 17:43:07 +000033#include "llvm/IR/ValueSymbolTable.h"
Alex Lorenz09b832c2015-05-29 17:05:41 +000034#include "llvm/Support/LineIterator.h"
Alex Lorenz2bdb4e12015-05-27 18:02:19 +000035#include "llvm/Support/SMLoc.h"
36#include "llvm/Support/SourceMgr.h"
37#include "llvm/Support/MemoryBuffer.h"
38#include "llvm/Support/YAMLTraits.h"
39#include <memory>
40
41using namespace llvm;
42
Alex Lorenz735c47e2015-06-15 20:30:22 +000043namespace llvm {
Alex Lorenz2bdb4e12015-05-27 18:02:19 +000044
45/// This class implements the parsing of LLVM IR that's embedded inside a MIR
46/// file.
47class MIRParserImpl {
48 SourceMgr SM;
49 StringRef Filename;
50 LLVMContext &Context;
Alex Lorenz735c47e2015-06-15 20:30:22 +000051 StringMap<std::unique_ptr<yaml::MachineFunction>> Functions;
Alex Lorenz5d6108e2015-06-26 22:56:48 +000052 SlotMapping IRSlots;
Alex Lorenz28148ba2015-07-09 22:23:13 +000053 /// Maps from register class names to register classes.
54 StringMap<const TargetRegisterClass *> Names2RegClasses;
Alex Lorenz2bdb4e12015-05-27 18:02:19 +000055
56public:
57 MIRParserImpl(std::unique_ptr<MemoryBuffer> Contents, StringRef Filename,
58 LLVMContext &Context);
59
Alex Lorenz735c47e2015-06-15 20:30:22 +000060 void reportDiagnostic(const SMDiagnostic &Diag);
61
62 /// Report an error with the given message at unknown location.
63 ///
64 /// Always returns true.
65 bool error(const Twine &Message);
66
Alex Lorenzb1f9ce82015-07-08 20:22:20 +000067 /// Report an error with the given message at the given location.
68 ///
69 /// Always returns true.
70 bool error(SMLoc Loc, const Twine &Message);
71
Alex Lorenz0fd7c622015-06-30 17:55:00 +000072 /// Report a given error with the location translated from the location in an
73 /// embedded string literal to a location in the MIR file.
74 ///
75 /// Always returns true.
76 bool error(const SMDiagnostic &Error, SMRange SourceRange);
77
Alex Lorenz78d78312015-05-28 22:41:12 +000078 /// Try to parse the optional LLVM module and the machine functions in the MIR
79 /// file.
Alex Lorenz2bdb4e12015-05-27 18:02:19 +000080 ///
Alex Lorenz78d78312015-05-28 22:41:12 +000081 /// Return null if an error occurred.
Alex Lorenz735c47e2015-06-15 20:30:22 +000082 std::unique_ptr<Module> parse();
Alex Lorenz78d78312015-05-28 22:41:12 +000083
84 /// Parse the machine function in the current YAML document.
85 ///
Alex Lorenz8e7a58d72015-06-15 23:07:38 +000086 /// \param NoLLVMIR - set to true when the MIR file doesn't have LLVM IR.
87 /// A dummy IR function is created and inserted into the given module when
88 /// this parameter is true.
89 ///
Alex Lorenz78d78312015-05-28 22:41:12 +000090 /// Return true if an error occurred.
Alex Lorenz8e7a58d72015-06-15 23:07:38 +000091 bool parseMachineFunction(yaml::Input &In, Module &M, bool NoLLVMIR);
Alex Lorenz09b832c2015-05-29 17:05:41 +000092
Alex Lorenz735c47e2015-06-15 20:30:22 +000093 /// Initialize the machine function to the state that's described in the MIR
94 /// file.
95 ///
96 /// Return true if error occurred.
97 bool initializeMachineFunction(MachineFunction &MF);
98
Alex Lorenz4f093bf2015-06-19 17:43:07 +000099 /// Initialize the machine basic block using it's YAML representation.
100 ///
101 /// Return true if an error occurred.
Alex Lorenz7a503fa2015-07-07 17:46:43 +0000102 bool initializeMachineBasicBlock(MachineFunction &MF, MachineBasicBlock &MBB,
103 const yaml::MachineBasicBlock &YamlMBB,
104 const PerFunctionMIParsingState &PFS);
Alex Lorenz4f093bf2015-06-19 17:43:07 +0000105
Alex Lorenzab4cbcf2015-07-24 20:35:40 +0000106 bool initializeRegisterInfo(MachineFunction &MF, MachineRegisterInfo &RegInfo,
107 const yaml::MachineFunction &YamlMF,
108 PerFunctionMIParsingState &PFS);
Alex Lorenz54565cf2015-06-24 19:56:10 +0000109
Alex Lorenz1bb48de2015-07-24 22:22:50 +0000110 bool initializeFrameInfo(MachineFunction &MF, MachineFrameInfo &MFI,
Alex Lorenz7feaf7c2015-07-16 23:37:45 +0000111 const yaml::MachineFunction &YamlMF,
Alex Lorenz1bb48de2015-07-24 22:22:50 +0000112 PerFunctionMIParsingState &PFS);
113
114 bool parseCalleeSavedRegister(MachineFunction &MF,
115 PerFunctionMIParsingState &PFS,
116 std::vector<CalleeSavedInfo> &CSIInfo,
117 const yaml::StringValue &RegisterSource,
118 int FrameIdx);
Alex Lorenz60541c12015-07-09 19:55:27 +0000119
Alex Lorenzab980492015-07-20 20:51:18 +0000120 bool initializeConstantPool(MachineConstantPool &ConstantPool,
121 const yaml::MachineFunction &YamlMF,
122 const MachineFunction &MF,
123 DenseMap<unsigned, unsigned> &ConstantPoolSlots);
124
Alex Lorenz6799e9b2015-07-15 23:31:07 +0000125 bool initializeJumpTableInfo(MachineFunction &MF,
126 const yaml::MachineJumpTable &YamlJTI,
Alex Lorenz31d70682015-07-15 23:38:35 +0000127 PerFunctionMIParsingState &PFS);
Alex Lorenz6799e9b2015-07-15 23:31:07 +0000128
Alex Lorenz09b832c2015-05-29 17:05:41 +0000129private:
Alex Lorenz51af1602015-06-23 22:39:23 +0000130 /// Return a MIR diagnostic converted from an MI string diagnostic.
131 SMDiagnostic diagFromMIStringDiag(const SMDiagnostic &Error,
132 SMRange SourceRange);
133
Alex Lorenz09b832c2015-05-29 17:05:41 +0000134 /// Return a MIR diagnostic converted from an LLVM assembly diagnostic.
135 SMDiagnostic diagFromLLVMAssemblyDiag(const SMDiagnostic &Error,
136 SMRange SourceRange);
Alex Lorenz8e7a58d72015-06-15 23:07:38 +0000137
138 /// Create an empty function with the given name.
139 void createDummyFunction(StringRef Name, Module &M);
Alex Lorenz28148ba2015-07-09 22:23:13 +0000140
141 void initNames2RegClasses(const MachineFunction &MF);
142
143 /// Check if the given identifier is a name of a register class.
144 ///
145 /// Return null if the name isn't a register class.
146 const TargetRegisterClass *getRegClass(const MachineFunction &MF,
147 StringRef Name);
Alex Lorenz2bdb4e12015-05-27 18:02:19 +0000148};
149
Alex Lorenz735c47e2015-06-15 20:30:22 +0000150} // end namespace llvm
Alex Lorenz2bdb4e12015-05-27 18:02:19 +0000151
152MIRParserImpl::MIRParserImpl(std::unique_ptr<MemoryBuffer> Contents,
153 StringRef Filename, LLVMContext &Context)
154 : SM(), Filename(Filename), Context(Context) {
155 SM.AddNewSourceBuffer(std::move(Contents), SMLoc());
156}
157
Alex Lorenz735c47e2015-06-15 20:30:22 +0000158bool MIRParserImpl::error(const Twine &Message) {
159 Context.diagnose(DiagnosticInfoMIRParser(
160 DS_Error, SMDiagnostic(Filename, SourceMgr::DK_Error, Message.str())));
161 return true;
Alex Lorenz78d78312015-05-28 22:41:12 +0000162}
Alex Lorenz2bdb4e12015-05-27 18:02:19 +0000163
Alex Lorenzb1f9ce82015-07-08 20:22:20 +0000164bool MIRParserImpl::error(SMLoc Loc, const Twine &Message) {
165 Context.diagnose(DiagnosticInfoMIRParser(
166 DS_Error, SM.GetMessage(Loc, SourceMgr::DK_Error, Message)));
167 return true;
168}
169
Alex Lorenz0fd7c622015-06-30 17:55:00 +0000170bool MIRParserImpl::error(const SMDiagnostic &Error, SMRange SourceRange) {
171 assert(Error.getKind() == SourceMgr::DK_Error && "Expected an error");
172 reportDiagnostic(diagFromMIStringDiag(Error, SourceRange));
173 return true;
174}
175
Alex Lorenz735c47e2015-06-15 20:30:22 +0000176void MIRParserImpl::reportDiagnostic(const SMDiagnostic &Diag) {
177 DiagnosticSeverity Kind;
178 switch (Diag.getKind()) {
179 case SourceMgr::DK_Error:
180 Kind = DS_Error;
181 break;
182 case SourceMgr::DK_Warning:
183 Kind = DS_Warning;
184 break;
185 case SourceMgr::DK_Note:
186 Kind = DS_Note;
187 break;
188 }
189 Context.diagnose(DiagnosticInfoMIRParser(Kind, Diag));
190}
191
192static void handleYAMLDiag(const SMDiagnostic &Diag, void *Context) {
193 reinterpret_cast<MIRParserImpl *>(Context)->reportDiagnostic(Diag);
194}
195
196std::unique_ptr<Module> MIRParserImpl::parse() {
Alex Lorenz78d78312015-05-28 22:41:12 +0000197 yaml::Input In(SM.getMemoryBuffer(SM.getMainFileID())->getBuffer(),
Alex Lorenz735c47e2015-06-15 20:30:22 +0000198 /*Ctxt=*/nullptr, handleYAMLDiag, this);
Alex Lorenz51af1602015-06-23 22:39:23 +0000199 In.setContext(&In);
Alex Lorenz78d78312015-05-28 22:41:12 +0000200
201 if (!In.setCurrentDocument()) {
Alex Lorenz735c47e2015-06-15 20:30:22 +0000202 if (In.error())
Alex Lorenz78d78312015-05-28 22:41:12 +0000203 return nullptr;
204 // Create an empty module when the MIR file is empty.
205 return llvm::make_unique<Module>(Filename, Context);
Alex Lorenz2bdb4e12015-05-27 18:02:19 +0000206 }
207
Alex Lorenz78d78312015-05-28 22:41:12 +0000208 std::unique_ptr<Module> M;
Alex Lorenz8e7a58d72015-06-15 23:07:38 +0000209 bool NoLLVMIR = false;
Alex Lorenz78d78312015-05-28 22:41:12 +0000210 // Parse the block scalar manually so that we can return unique pointer
211 // without having to go trough YAML traits.
212 if (const auto *BSN =
213 dyn_cast_or_null<yaml::BlockScalarNode>(In.getCurrentNode())) {
Alex Lorenz735c47e2015-06-15 20:30:22 +0000214 SMDiagnostic Error;
Alex Lorenz78d78312015-05-28 22:41:12 +0000215 M = parseAssembly(MemoryBufferRef(BSN->getValue(), Filename), Error,
Alex Lorenz5d6108e2015-06-26 22:56:48 +0000216 Context, &IRSlots);
Alex Lorenz09b832c2015-05-29 17:05:41 +0000217 if (!M) {
Alex Lorenz735c47e2015-06-15 20:30:22 +0000218 reportDiagnostic(diagFromLLVMAssemblyDiag(Error, BSN->getSourceRange()));
Alex Lorenz78d78312015-05-28 22:41:12 +0000219 return M;
Alex Lorenz09b832c2015-05-29 17:05:41 +0000220 }
Alex Lorenz78d78312015-05-28 22:41:12 +0000221 In.nextDocument();
222 if (!In.setCurrentDocument())
223 return M;
224 } else {
225 // Create an new, empty module.
226 M = llvm::make_unique<Module>(Filename, Context);
Alex Lorenz8e7a58d72015-06-15 23:07:38 +0000227 NoLLVMIR = true;
Alex Lorenz78d78312015-05-28 22:41:12 +0000228 }
229
230 // Parse the machine functions.
231 do {
Alex Lorenz8e7a58d72015-06-15 23:07:38 +0000232 if (parseMachineFunction(In, *M, NoLLVMIR))
Alex Lorenz78d78312015-05-28 22:41:12 +0000233 return nullptr;
234 In.nextDocument();
235 } while (In.setCurrentDocument());
236
237 return M;
238}
239
Alex Lorenz8e7a58d72015-06-15 23:07:38 +0000240bool MIRParserImpl::parseMachineFunction(yaml::Input &In, Module &M,
241 bool NoLLVMIR) {
Alex Lorenz735c47e2015-06-15 20:30:22 +0000242 auto MF = llvm::make_unique<yaml::MachineFunction>();
243 yaml::yamlize(In, *MF, false);
Alex Lorenz78d78312015-05-28 22:41:12 +0000244 if (In.error())
245 return true;
Alex Lorenz735c47e2015-06-15 20:30:22 +0000246 auto FunctionName = MF->Name;
Alex Lorenzfe2aa972015-06-15 22:23:23 +0000247 if (Functions.find(FunctionName) != Functions.end())
248 return error(Twine("redefinition of machine function '") + FunctionName +
249 "'");
Alex Lorenz735c47e2015-06-15 20:30:22 +0000250 Functions.insert(std::make_pair(FunctionName, std::move(MF)));
Alex Lorenz8e7a58d72015-06-15 23:07:38 +0000251 if (NoLLVMIR)
252 createDummyFunction(FunctionName, M);
Alex Lorenz5ef16b82015-06-16 17:06:29 +0000253 else if (!M.getFunction(FunctionName))
254 return error(Twine("function '") + FunctionName +
255 "' isn't defined in the provided LLVM IR");
Alex Lorenz735c47e2015-06-15 20:30:22 +0000256 return false;
257}
258
Alex Lorenz8e7a58d72015-06-15 23:07:38 +0000259void MIRParserImpl::createDummyFunction(StringRef Name, Module &M) {
260 auto &Context = M.getContext();
261 Function *F = cast<Function>(M.getOrInsertFunction(
262 Name, FunctionType::get(Type::getVoidTy(Context), false)));
263 BasicBlock *BB = BasicBlock::Create(Context, "entry", F);
264 new UnreachableInst(Context, BB);
265}
266
Alex Lorenz735c47e2015-06-15 20:30:22 +0000267bool MIRParserImpl::initializeMachineFunction(MachineFunction &MF) {
268 auto It = Functions.find(MF.getName());
269 if (It == Functions.end())
270 return error(Twine("no machine function information for function '") +
271 MF.getName() + "' in the MIR file");
272 // TODO: Recreate the machine function.
Alex Lorenz5b5f9752015-06-16 00:10:47 +0000273 const yaml::MachineFunction &YamlMF = *It->getValue();
274 if (YamlMF.Alignment)
275 MF.setAlignment(YamlMF.Alignment);
276 MF.setExposesReturnsTwice(YamlMF.ExposesReturnsTwice);
277 MF.setHasInlineAsm(YamlMF.HasInlineAsm);
Alex Lorenz53464512015-07-10 22:51:20 +0000278 PerFunctionMIParsingState PFS;
Alex Lorenzab4cbcf2015-07-24 20:35:40 +0000279 if (initializeRegisterInfo(MF, MF.getRegInfo(), YamlMF, PFS))
Alex Lorenz54565cf2015-06-24 19:56:10 +0000280 return true;
Alex Lorenz1bb48de2015-07-24 22:22:50 +0000281 if (initializeFrameInfo(MF, *MF.getFrameInfo(), YamlMF, PFS))
Alex Lorenz60541c12015-07-09 19:55:27 +0000282 return true;
Alex Lorenzab980492015-07-20 20:51:18 +0000283 if (!YamlMF.Constants.empty()) {
284 auto *ConstantPool = MF.getConstantPool();
285 assert(ConstantPool && "Constant pool must be created");
286 if (initializeConstantPool(*ConstantPool, YamlMF, MF,
287 PFS.ConstantPoolSlots))
288 return true;
289 }
Alex Lorenz54565cf2015-06-24 19:56:10 +0000290
Alex Lorenz4f093bf2015-06-19 17:43:07 +0000291 const auto &F = *MF.getFunction();
292 for (const auto &YamlMBB : YamlMF.BasicBlocks) {
293 const BasicBlock *BB = nullptr;
Alex Lorenzb1f9ce82015-07-08 20:22:20 +0000294 const yaml::StringValue &Name = YamlMBB.Name;
Alex Lorenz8a1915b2015-07-27 22:42:41 +0000295 const yaml::StringValue &IRBlock = YamlMBB.IRBlock;
Alex Lorenzb1f9ce82015-07-08 20:22:20 +0000296 if (!Name.Value.empty()) {
Alex Lorenz4f093bf2015-06-19 17:43:07 +0000297 BB = dyn_cast_or_null<BasicBlock>(
Alex Lorenzb1f9ce82015-07-08 20:22:20 +0000298 F.getValueSymbolTable().lookup(Name.Value));
Alex Lorenz00302df2015-06-19 20:12:03 +0000299 if (!BB)
Alex Lorenzb1f9ce82015-07-08 20:22:20 +0000300 return error(Name.SourceRange.Start,
301 Twine("basic block '") + Name.Value +
302 "' is not defined in the function '" + MF.getName() +
303 "'");
Alex Lorenz4f093bf2015-06-19 17:43:07 +0000304 }
Alex Lorenz8a1915b2015-07-27 22:42:41 +0000305 if (!IRBlock.Value.empty()) {
306 // TODO: Report an error when both name and ir block are specified.
307 SMDiagnostic Error;
308 if (parseIRBlockReference(BB, SM, MF, IRBlock.Value, PFS, IRSlots, Error))
309 return error(Error, IRBlock.SourceRange);
310 }
Alex Lorenz4f093bf2015-06-19 17:43:07 +0000311 auto *MBB = MF.CreateMachineBasicBlock(BB);
312 MF.insert(MF.end(), MBB);
Alex Lorenz7a503fa2015-07-07 17:46:43 +0000313 bool WasInserted =
314 PFS.MBBSlots.insert(std::make_pair(YamlMBB.ID, MBB)).second;
Alex Lorenz33f0aef2015-06-26 16:46:11 +0000315 if (!WasInserted)
316 return error(Twine("redefinition of machine basic block with id #") +
317 Twine(YamlMBB.ID));
318 }
319
Alex Lorenzc8704b02015-07-09 21:21:33 +0000320 if (YamlMF.BasicBlocks.empty())
321 return error(Twine("machine function '") + Twine(MF.getName()) +
322 "' requires at least one machine basic block in its body");
Alex Lorenz6799e9b2015-07-15 23:31:07 +0000323 // Initialize the jump table after creating all the MBBs so that the MBB
324 // references can be resolved.
325 if (!YamlMF.JumpTableInfo.Entries.empty() &&
326 initializeJumpTableInfo(MF, YamlMF.JumpTableInfo, PFS))
327 return true;
Alex Lorenz33f0aef2015-06-26 16:46:11 +0000328 // Initialize the machine basic blocks after creating them all so that the
329 // machine instructions parser can resolve the MBB references.
330 unsigned I = 0;
331 for (const auto &YamlMBB : YamlMF.BasicBlocks) {
332 if (initializeMachineBasicBlock(MF, *MF.getBlockNumbered(I++), YamlMBB,
Alex Lorenz7a503fa2015-07-07 17:46:43 +0000333 PFS))
Alex Lorenz4f093bf2015-06-19 17:43:07 +0000334 return true;
335 }
Alex Lorenzc7bf2042015-07-24 17:44:49 +0000336 // FIXME: This is a temporary workaround until the reserved registers can be
337 // serialized.
338 MF.getRegInfo().freezeReservedRegs(MF);
339 MF.verify();
Alex Lorenz4f093bf2015-06-19 17:43:07 +0000340 return false;
341}
342
343bool MIRParserImpl::initializeMachineBasicBlock(
Alex Lorenz8e0a1b42015-06-22 17:02:30 +0000344 MachineFunction &MF, MachineBasicBlock &MBB,
Alex Lorenz33f0aef2015-06-26 16:46:11 +0000345 const yaml::MachineBasicBlock &YamlMBB,
Alex Lorenz7a503fa2015-07-07 17:46:43 +0000346 const PerFunctionMIParsingState &PFS) {
Alex Lorenz4f093bf2015-06-19 17:43:07 +0000347 MBB.setAlignment(YamlMBB.Alignment);
348 if (YamlMBB.AddressTaken)
349 MBB.setHasAddressTaken();
350 MBB.setIsLandingPad(YamlMBB.IsLandingPad);
Alex Lorenzf09df002015-06-30 18:16:42 +0000351 SMDiagnostic Error;
352 // Parse the successors.
353 for (const auto &MBBSource : YamlMBB.Successors) {
354 MachineBasicBlock *SuccMBB = nullptr;
Alex Lorenz7a503fa2015-07-07 17:46:43 +0000355 if (parseMBBReference(SuccMBB, SM, MF, MBBSource.Value, PFS, IRSlots,
Alex Lorenzf09df002015-06-30 18:16:42 +0000356 Error))
357 return error(Error, MBBSource.SourceRange);
358 // TODO: Report an error when adding the same successor more than once.
359 MBB.addSuccessor(SuccMBB);
360 }
Alex Lorenz9fab3702015-07-14 21:24:41 +0000361 // Parse the liveins.
362 for (const auto &LiveInSource : YamlMBB.LiveIns) {
363 unsigned Reg = 0;
364 if (parseNamedRegisterReference(Reg, SM, MF, LiveInSource.Value, PFS,
365 IRSlots, Error))
366 return error(Error, LiveInSource.SourceRange);
367 MBB.addLiveIn(Reg);
368 }
Alex Lorenz8e0a1b42015-06-22 17:02:30 +0000369 // Parse the instructions.
370 for (const auto &MISource : YamlMBB.Instructions) {
Alex Lorenz3708a642015-06-30 17:47:50 +0000371 MachineInstr *MI = nullptr;
Alex Lorenz7a503fa2015-07-07 17:46:43 +0000372 if (parseMachineInstr(MI, SM, MF, MISource.Value, PFS, IRSlots, Error))
Alex Lorenz0fd7c622015-06-30 17:55:00 +0000373 return error(Error, MISource.SourceRange);
Alex Lorenz3708a642015-06-30 17:47:50 +0000374 MBB.insert(MBB.end(), MI);
Alex Lorenz8e0a1b42015-06-22 17:02:30 +0000375 }
Alex Lorenz78d78312015-05-28 22:41:12 +0000376 return false;
Alex Lorenz2bdb4e12015-05-27 18:02:19 +0000377}
378
Alex Lorenzab4cbcf2015-07-24 20:35:40 +0000379bool MIRParserImpl::initializeRegisterInfo(MachineFunction &MF,
380 MachineRegisterInfo &RegInfo,
381 const yaml::MachineFunction &YamlMF,
382 PerFunctionMIParsingState &PFS) {
Alex Lorenz54565cf2015-06-24 19:56:10 +0000383 assert(RegInfo.isSSA());
384 if (!YamlMF.IsSSA)
385 RegInfo.leaveSSA();
386 assert(RegInfo.tracksLiveness());
387 if (!YamlMF.TracksRegLiveness)
388 RegInfo.invalidateLiveness();
389 RegInfo.enableSubRegLiveness(YamlMF.TracksSubRegLiveness);
Alex Lorenz28148ba2015-07-09 22:23:13 +0000390
Alex Lorenzab4cbcf2015-07-24 20:35:40 +0000391 SMDiagnostic Error;
Alex Lorenz28148ba2015-07-09 22:23:13 +0000392 // Parse the virtual register information.
393 for (const auto &VReg : YamlMF.VirtualRegisters) {
394 const auto *RC = getRegClass(MF, VReg.Class.Value);
395 if (!RC)
396 return error(VReg.Class.SourceRange.Start,
397 Twine("use of undefined register class '") +
398 VReg.Class.Value + "'");
Alex Lorenz53464512015-07-10 22:51:20 +0000399 unsigned Reg = RegInfo.createVirtualRegister(RC);
400 // TODO: Report an error when the same virtual register with the same ID is
401 // redefined.
Alex Lorenzab4cbcf2015-07-24 20:35:40 +0000402 PFS.VirtualRegisterSlots.insert(std::make_pair(VReg.ID, Reg));
403 if (!VReg.PreferredRegister.Value.empty()) {
404 unsigned PreferredReg = 0;
405 if (parseNamedRegisterReference(PreferredReg, SM, MF,
406 VReg.PreferredRegister.Value, PFS,
407 IRSlots, Error))
408 return error(Error, VReg.PreferredRegister.SourceRange);
409 RegInfo.setSimpleHint(Reg, PreferredReg);
410 }
Alex Lorenz28148ba2015-07-09 22:23:13 +0000411 }
Alex Lorenz12045a42015-07-27 17:42:45 +0000412
413 // Parse the liveins.
414 for (const auto &LiveIn : YamlMF.LiveIns) {
415 unsigned Reg = 0;
416 if (parseNamedRegisterReference(Reg, SM, MF, LiveIn.Register.Value, PFS,
417 IRSlots, Error))
418 return error(Error, LiveIn.Register.SourceRange);
419 unsigned VReg = 0;
420 if (!LiveIn.VirtualRegister.Value.empty()) {
421 if (parseVirtualRegisterReference(
422 VReg, SM, MF, LiveIn.VirtualRegister.Value, PFS, IRSlots, Error))
423 return error(Error, LiveIn.VirtualRegister.SourceRange);
424 }
425 RegInfo.addLiveIn(Reg, VReg);
426 }
Alex Lorenz54565cf2015-06-24 19:56:10 +0000427 return false;
428}
429
Alex Lorenz1bb48de2015-07-24 22:22:50 +0000430bool MIRParserImpl::initializeFrameInfo(MachineFunction &MF,
431 MachineFrameInfo &MFI,
432 const yaml::MachineFunction &YamlMF,
433 PerFunctionMIParsingState &PFS) {
434 const Function &F = *MF.getFunction();
Alex Lorenzf6bc8662015-07-10 18:13:57 +0000435 const yaml::MachineFrameInfo &YamlMFI = YamlMF.FrameInfo;
Alex Lorenz60541c12015-07-09 19:55:27 +0000436 MFI.setFrameAddressIsTaken(YamlMFI.IsFrameAddressTaken);
437 MFI.setReturnAddressIsTaken(YamlMFI.IsReturnAddressTaken);
438 MFI.setHasStackMap(YamlMFI.HasStackMap);
439 MFI.setHasPatchPoint(YamlMFI.HasPatchPoint);
440 MFI.setStackSize(YamlMFI.StackSize);
441 MFI.setOffsetAdjustment(YamlMFI.OffsetAdjustment);
442 if (YamlMFI.MaxAlignment)
443 MFI.ensureMaxAlignment(YamlMFI.MaxAlignment);
444 MFI.setAdjustsStack(YamlMFI.AdjustsStack);
445 MFI.setHasCalls(YamlMFI.HasCalls);
446 MFI.setMaxCallFrameSize(YamlMFI.MaxCallFrameSize);
447 MFI.setHasOpaqueSPAdjustment(YamlMFI.HasOpaqueSPAdjustment);
448 MFI.setHasVAStart(YamlMFI.HasVAStart);
449 MFI.setHasMustTailInVarArgFunc(YamlMFI.HasMustTailInVarArgFunc);
Alex Lorenzf6bc8662015-07-10 18:13:57 +0000450
Alex Lorenz1bb48de2015-07-24 22:22:50 +0000451 std::vector<CalleeSavedInfo> CSIInfo;
Alex Lorenzde491f02015-07-13 18:07:26 +0000452 // Initialize the fixed frame objects.
453 for (const auto &Object : YamlMF.FixedStackObjects) {
454 int ObjectIdx;
455 if (Object.Type != yaml::FixedMachineStackObject::SpillSlot)
456 ObjectIdx = MFI.CreateFixedObject(Object.Size, Object.Offset,
457 Object.IsImmutable, Object.IsAliased);
458 else
459 ObjectIdx = MFI.CreateFixedSpillStackObject(Object.Size, Object.Offset);
460 MFI.setObjectAlignment(ObjectIdx, Object.Alignment);
Alex Lorenz7feaf7c2015-07-16 23:37:45 +0000461 // TODO: Report an error when objects are redefined.
Alex Lorenz1bb48de2015-07-24 22:22:50 +0000462 PFS.FixedStackObjectSlots.insert(std::make_pair(Object.ID, ObjectIdx));
463 if (parseCalleeSavedRegister(MF, PFS, CSIInfo, Object.CalleeSavedRegister,
464 ObjectIdx))
465 return true;
Alex Lorenzde491f02015-07-13 18:07:26 +0000466 }
467
468 // Initialize the ordinary frame objects.
Alex Lorenzf6bc8662015-07-10 18:13:57 +0000469 for (const auto &Object : YamlMF.StackObjects) {
Alex Lorenz418f3ec2015-07-14 00:26:26 +0000470 int ObjectIdx;
Alex Lorenz37643a02015-07-15 22:14:49 +0000471 const AllocaInst *Alloca = nullptr;
472 const yaml::StringValue &Name = Object.Name;
473 if (!Name.Value.empty()) {
474 Alloca = dyn_cast_or_null<AllocaInst>(
475 F.getValueSymbolTable().lookup(Name.Value));
476 if (!Alloca)
477 return error(Name.SourceRange.Start,
478 "alloca instruction named '" + Name.Value +
479 "' isn't defined in the function '" + F.getName() +
480 "'");
481 }
Alex Lorenz418f3ec2015-07-14 00:26:26 +0000482 if (Object.Type == yaml::MachineStackObject::VariableSized)
Alex Lorenz37643a02015-07-15 22:14:49 +0000483 ObjectIdx = MFI.CreateVariableSizedObject(Object.Alignment, Alloca);
Alex Lorenz418f3ec2015-07-14 00:26:26 +0000484 else
485 ObjectIdx = MFI.CreateStackObject(
486 Object.Size, Object.Alignment,
Alex Lorenz37643a02015-07-15 22:14:49 +0000487 Object.Type == yaml::MachineStackObject::SpillSlot, Alloca);
Alex Lorenzf6bc8662015-07-10 18:13:57 +0000488 MFI.setObjectOffset(ObjectIdx, Object.Offset);
Alex Lorenz7feaf7c2015-07-16 23:37:45 +0000489 // TODO: Report an error when objects are redefined.
Alex Lorenz1bb48de2015-07-24 22:22:50 +0000490 PFS.StackObjectSlots.insert(std::make_pair(Object.ID, ObjectIdx));
491 if (parseCalleeSavedRegister(MF, PFS, CSIInfo, Object.CalleeSavedRegister,
492 ObjectIdx))
493 return true;
Alex Lorenzf6bc8662015-07-10 18:13:57 +0000494 }
Alex Lorenz1bb48de2015-07-24 22:22:50 +0000495 MFI.setCalleeSavedInfo(CSIInfo);
496 if (!CSIInfo.empty())
497 MFI.setCalleeSavedInfoValid(true);
498 return false;
499}
500
501bool MIRParserImpl::parseCalleeSavedRegister(
502 MachineFunction &MF, PerFunctionMIParsingState &PFS,
503 std::vector<CalleeSavedInfo> &CSIInfo,
504 const yaml::StringValue &RegisterSource, int FrameIdx) {
505 if (RegisterSource.Value.empty())
506 return false;
507 unsigned Reg = 0;
508 SMDiagnostic Error;
509 if (parseNamedRegisterReference(Reg, SM, MF, RegisterSource.Value, PFS,
510 IRSlots, Error))
511 return error(Error, RegisterSource.SourceRange);
512 CSIInfo.push_back(CalleeSavedInfo(Reg, FrameIdx));
Alex Lorenz60541c12015-07-09 19:55:27 +0000513 return false;
514}
515
Alex Lorenzab980492015-07-20 20:51:18 +0000516bool MIRParserImpl::initializeConstantPool(
517 MachineConstantPool &ConstantPool, const yaml::MachineFunction &YamlMF,
518 const MachineFunction &MF,
519 DenseMap<unsigned, unsigned> &ConstantPoolSlots) {
520 const auto &M = *MF.getFunction()->getParent();
521 SMDiagnostic Error;
522 for (const auto &YamlConstant : YamlMF.Constants) {
523 const Constant *Value = dyn_cast_or_null<Constant>(
524 parseConstantValue(YamlConstant.Value.Value, Error, M));
525 if (!Value)
526 return error(Error, YamlConstant.Value.SourceRange);
527 unsigned Alignment =
528 YamlConstant.Alignment
529 ? YamlConstant.Alignment
530 : M.getDataLayout().getPrefTypeAlignment(Value->getType());
531 // TODO: Report an error when the same constant pool value ID is redefined.
532 ConstantPoolSlots.insert(std::make_pair(
533 YamlConstant.ID, ConstantPool.getConstantPoolIndex(Value, Alignment)));
534 }
535 return false;
536}
537
Alex Lorenz6799e9b2015-07-15 23:31:07 +0000538bool MIRParserImpl::initializeJumpTableInfo(
539 MachineFunction &MF, const yaml::MachineJumpTable &YamlJTI,
Alex Lorenz31d70682015-07-15 23:38:35 +0000540 PerFunctionMIParsingState &PFS) {
Alex Lorenz6799e9b2015-07-15 23:31:07 +0000541 MachineJumpTableInfo *JTI = MF.getOrCreateJumpTableInfo(YamlJTI.Kind);
542 SMDiagnostic Error;
543 for (const auto &Entry : YamlJTI.Entries) {
544 std::vector<MachineBasicBlock *> Blocks;
545 for (const auto &MBBSource : Entry.Blocks) {
546 MachineBasicBlock *MBB = nullptr;
547 if (parseMBBReference(MBB, SM, MF, MBBSource.Value, PFS, IRSlots, Error))
548 return error(Error, MBBSource.SourceRange);
549 Blocks.push_back(MBB);
550 }
Alex Lorenz31d70682015-07-15 23:38:35 +0000551 unsigned Index = JTI->createJumpTableIndex(Blocks);
552 // TODO: Report an error when the same jump table slot ID is redefined.
553 PFS.JumpTableSlots.insert(std::make_pair(Entry.ID, Index));
Alex Lorenz6799e9b2015-07-15 23:31:07 +0000554 }
555 return false;
556}
557
Alex Lorenz51af1602015-06-23 22:39:23 +0000558SMDiagnostic MIRParserImpl::diagFromMIStringDiag(const SMDiagnostic &Error,
559 SMRange SourceRange) {
560 assert(SourceRange.isValid() && "Invalid source range");
561 SMLoc Loc = SourceRange.Start;
562 bool HasQuote = Loc.getPointer() < SourceRange.End.getPointer() &&
563 *Loc.getPointer() == '\'';
564 // Translate the location of the error from the location in the MI string to
565 // the corresponding location in the MIR file.
566 Loc = Loc.getFromPointer(Loc.getPointer() + Error.getColumnNo() +
567 (HasQuote ? 1 : 0));
568
569 // TODO: Translate any source ranges as well.
570 return SM.GetMessage(Loc, Error.getKind(), Error.getMessage(), None,
571 Error.getFixIts());
572}
573
Alex Lorenz09b832c2015-05-29 17:05:41 +0000574SMDiagnostic MIRParserImpl::diagFromLLVMAssemblyDiag(const SMDiagnostic &Error,
575 SMRange SourceRange) {
576 assert(SourceRange.isValid());
577
578 // Translate the location of the error from the location in the llvm IR string
579 // to the corresponding location in the MIR file.
580 auto LineAndColumn = SM.getLineAndColumn(SourceRange.Start);
581 unsigned Line = LineAndColumn.first + Error.getLineNo() - 1;
582 unsigned Column = Error.getColumnNo();
583 StringRef LineStr = Error.getLineContents();
584 SMLoc Loc = Error.getLoc();
585
586 // Get the full line and adjust the column number by taking the indentation of
587 // LLVM IR into account.
588 for (line_iterator L(*SM.getMemoryBuffer(SM.getMainFileID()), false), E;
589 L != E; ++L) {
590 if (L.line_number() == Line) {
591 LineStr = *L;
592 Loc = SMLoc::getFromPointer(LineStr.data());
593 auto Indent = LineStr.find(Error.getLineContents());
594 if (Indent != StringRef::npos)
595 Column += Indent;
596 break;
597 }
598 }
599
600 return SMDiagnostic(SM, Loc, Filename, Line, Column, Error.getKind(),
601 Error.getMessage(), LineStr, Error.getRanges(),
602 Error.getFixIts());
603}
604
Alex Lorenz28148ba2015-07-09 22:23:13 +0000605void MIRParserImpl::initNames2RegClasses(const MachineFunction &MF) {
606 if (!Names2RegClasses.empty())
607 return;
608 const TargetRegisterInfo *TRI = MF.getSubtarget().getRegisterInfo();
609 for (unsigned I = 0, E = TRI->getNumRegClasses(); I < E; ++I) {
610 const auto *RC = TRI->getRegClass(I);
611 Names2RegClasses.insert(
612 std::make_pair(StringRef(TRI->getRegClassName(RC)).lower(), RC));
613 }
614}
615
616const TargetRegisterClass *MIRParserImpl::getRegClass(const MachineFunction &MF,
617 StringRef Name) {
618 initNames2RegClasses(MF);
619 auto RegClassInfo = Names2RegClasses.find(Name);
620 if (RegClassInfo == Names2RegClasses.end())
621 return nullptr;
622 return RegClassInfo->getValue();
623}
624
Alex Lorenz735c47e2015-06-15 20:30:22 +0000625MIRParser::MIRParser(std::unique_ptr<MIRParserImpl> Impl)
626 : Impl(std::move(Impl)) {}
627
628MIRParser::~MIRParser() {}
629
630std::unique_ptr<Module> MIRParser::parseLLVMModule() { return Impl->parse(); }
631
632bool MIRParser::initializeMachineFunction(MachineFunction &MF) {
633 return Impl->initializeMachineFunction(MF);
634}
635
636std::unique_ptr<MIRParser> llvm::createMIRParserFromFile(StringRef Filename,
637 SMDiagnostic &Error,
638 LLVMContext &Context) {
Alex Lorenz2bdb4e12015-05-27 18:02:19 +0000639 auto FileOrErr = MemoryBuffer::getFile(Filename);
640 if (std::error_code EC = FileOrErr.getError()) {
641 Error = SMDiagnostic(Filename, SourceMgr::DK_Error,
642 "Could not open input file: " + EC.message());
Alex Lorenz735c47e2015-06-15 20:30:22 +0000643 return nullptr;
Alex Lorenz2bdb4e12015-05-27 18:02:19 +0000644 }
Alex Lorenz735c47e2015-06-15 20:30:22 +0000645 return createMIRParser(std::move(FileOrErr.get()), Context);
Alex Lorenz2bdb4e12015-05-27 18:02:19 +0000646}
647
Alex Lorenz735c47e2015-06-15 20:30:22 +0000648std::unique_ptr<MIRParser>
649llvm::createMIRParser(std::unique_ptr<MemoryBuffer> Contents,
650 LLVMContext &Context) {
Alex Lorenz2bdb4e12015-05-27 18:02:19 +0000651 auto Filename = Contents->getBufferIdentifier();
Alex Lorenz735c47e2015-06-15 20:30:22 +0000652 return llvm::make_unique<MIRParser>(
653 llvm::make_unique<MIRParserImpl>(std::move(Contents), Filename, Context));
Alex Lorenz2bdb4e12015-05-27 18:02:19 +0000654}