blob: d3a86362c8894524a60e6afe59a61805252d361a [file] [log] [blame]
Alp Toker1b935a82014-06-08 05:40:04 +00001//===---- ParseStmtAsm.cpp - Assembly Statement Parser --------------------===//
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 parsing for GCC and Microsoft inline assembly.
11//
12//===----------------------------------------------------------------------===//
13
14#include "clang/Parse/Parser.h"
15#include "RAIIObjectsForParser.h"
16#include "clang/AST/ASTContext.h"
17#include "clang/Basic/Diagnostic.h"
18#include "clang/Basic/TargetInfo.h"
19#include "llvm/ADT/SmallString.h"
Marina Yatsina41c45fa2016-02-03 11:32:08 +000020#include "llvm/ADT/StringExtras.h"
Alp Toker1b935a82014-06-08 05:40:04 +000021#include "llvm/MC/MCAsmInfo.h"
22#include "llvm/MC/MCContext.h"
23#include "llvm/MC/MCInstPrinter.h"
24#include "llvm/MC/MCInstrInfo.h"
25#include "llvm/MC/MCObjectFileInfo.h"
26#include "llvm/MC/MCParser/MCAsmParser.h"
Benjamin Kramer5e456302016-01-27 10:01:30 +000027#include "llvm/MC/MCParser/MCTargetAsmParser.h"
Alp Toker1b935a82014-06-08 05:40:04 +000028#include "llvm/MC/MCRegisterInfo.h"
29#include "llvm/MC/MCStreamer.h"
30#include "llvm/MC/MCSubtargetInfo.h"
Alp Toker1b935a82014-06-08 05:40:04 +000031#include "llvm/MC/MCTargetOptions.h"
32#include "llvm/Support/SourceMgr.h"
33#include "llvm/Support/TargetRegistry.h"
34#include "llvm/Support/TargetSelect.h"
35using namespace clang;
36
37namespace {
38class ClangAsmParserCallback : public llvm::MCAsmParserSemaCallback {
39 Parser &TheParser;
40 SourceLocation AsmLoc;
41 StringRef AsmString;
42
43 /// The tokens we streamed into AsmString and handed off to MC.
44 ArrayRef<Token> AsmToks;
45
46 /// The offset of each token in AsmToks within AsmString.
47 ArrayRef<unsigned> AsmTokOffsets;
48
49public:
50 ClangAsmParserCallback(Parser &P, SourceLocation Loc, StringRef AsmString,
51 ArrayRef<Token> Toks, ArrayRef<unsigned> Offsets)
52 : TheParser(P), AsmLoc(Loc), AsmString(AsmString), AsmToks(Toks),
53 AsmTokOffsets(Offsets) {
54 assert(AsmToks.size() == AsmTokOffsets.size());
55 }
56
57 void *LookupInlineAsmIdentifier(StringRef &LineBuf,
58 llvm::InlineAsmIdentifierInfo &Info,
59 bool IsUnevaluatedContext) override {
60 // Collect the desired tokens.
61 SmallVector<Token, 16> LineToks;
62 const Token *FirstOrigToken = nullptr;
63 findTokensForString(LineBuf, LineToks, FirstOrigToken);
64
65 unsigned NumConsumedToks;
66 ExprResult Result = TheParser.ParseMSAsmIdentifier(
67 LineToks, NumConsumedToks, &Info, IsUnevaluatedContext);
68
69 // If we consumed the entire line, tell MC that.
70 // Also do this if we consumed nothing as a way of reporting failure.
71 if (NumConsumedToks == 0 || NumConsumedToks == LineToks.size()) {
72 // By not modifying LineBuf, we're implicitly consuming it all.
73
74 // Otherwise, consume up to the original tokens.
75 } else {
76 assert(FirstOrigToken && "not using original tokens?");
77
78 // Since we're using original tokens, apply that offset.
79 assert(FirstOrigToken[NumConsumedToks].getLocation() ==
80 LineToks[NumConsumedToks].getLocation());
81 unsigned FirstIndex = FirstOrigToken - AsmToks.begin();
82 unsigned LastIndex = FirstIndex + NumConsumedToks - 1;
83
84 // The total length we've consumed is the relative offset
85 // of the last token we consumed plus its length.
86 unsigned TotalOffset =
87 (AsmTokOffsets[LastIndex] + AsmToks[LastIndex].getLength() -
88 AsmTokOffsets[FirstIndex]);
89 LineBuf = LineBuf.substr(0, TotalOffset);
90 }
91
92 // Initialize the "decl" with the lookup result.
93 Info.OpDecl = static_cast<void *>(Result.get());
94 return Info.OpDecl;
95 }
96
Ehsan Akhgari31097582014-09-22 02:21:54 +000097 StringRef LookupInlineAsmLabel(StringRef Identifier, llvm::SourceMgr &LSM,
98 llvm::SMLoc Location,
99 bool Create) override {
100 SourceLocation Loc = translateLocation(LSM, Location);
101 LabelDecl *Label =
102 TheParser.getActions().GetOrCreateMSAsmLabel(Identifier, Loc, Create);
103 return Label->getMSAsmLabel();
104 }
105
Alp Toker1b935a82014-06-08 05:40:04 +0000106 bool LookupInlineAsmField(StringRef Base, StringRef Member,
107 unsigned &Offset) override {
108 return TheParser.getActions().LookupInlineAsmField(Base, Member, Offset,
109 AsmLoc);
110 }
111
112 static void DiagHandlerCallback(const llvm::SMDiagnostic &D, void *Context) {
113 ((ClangAsmParserCallback *)Context)->handleDiagnostic(D);
114 }
115
116private:
117 /// Collect the appropriate tokens for the given string.
118 void findTokensForString(StringRef Str, SmallVectorImpl<Token> &TempToks,
119 const Token *&FirstOrigToken) const {
120 // For now, assert that the string we're working with is a substring
121 // of what we gave to MC. This lets us use the original tokens.
122 assert(!std::less<const char *>()(Str.begin(), AsmString.begin()) &&
123 !std::less<const char *>()(AsmString.end(), Str.end()));
124
125 // Try to find a token whose offset matches the first token.
126 unsigned FirstCharOffset = Str.begin() - AsmString.begin();
127 const unsigned *FirstTokOffset = std::lower_bound(
128 AsmTokOffsets.begin(), AsmTokOffsets.end(), FirstCharOffset);
129
130 // For now, assert that the start of the string exactly
131 // corresponds to the start of a token.
132 assert(*FirstTokOffset == FirstCharOffset);
133
134 // Use all the original tokens for this line. (We assume the
135 // end of the line corresponds cleanly to a token break.)
136 unsigned FirstTokIndex = FirstTokOffset - AsmTokOffsets.begin();
137 FirstOrigToken = &AsmToks[FirstTokIndex];
138 unsigned LastCharOffset = Str.end() - AsmString.begin();
139 for (unsigned i = FirstTokIndex, e = AsmTokOffsets.size(); i != e; ++i) {
140 if (AsmTokOffsets[i] >= LastCharOffset)
141 break;
142 TempToks.push_back(AsmToks[i]);
143 }
144 }
145
Ehsan Akhgari31097582014-09-22 02:21:54 +0000146 SourceLocation translateLocation(const llvm::SourceMgr &LSM, llvm::SMLoc SMLoc) {
Alp Toker1b935a82014-06-08 05:40:04 +0000147 // Compute an offset into the inline asm buffer.
148 // FIXME: This isn't right if .macro is involved (but hopefully, no
149 // real-world code does that).
Alp Toker1b935a82014-06-08 05:40:04 +0000150 const llvm::MemoryBuffer *LBuf =
Ehsan Akhgari31097582014-09-22 02:21:54 +0000151 LSM.getMemoryBuffer(LSM.FindBufferContainingLoc(SMLoc));
152 unsigned Offset = SMLoc.getPointer() - LBuf->getBufferStart();
Alp Toker1b935a82014-06-08 05:40:04 +0000153
154 // Figure out which token that offset points into.
155 const unsigned *TokOffsetPtr =
156 std::lower_bound(AsmTokOffsets.begin(), AsmTokOffsets.end(), Offset);
157 unsigned TokIndex = TokOffsetPtr - AsmTokOffsets.begin();
158 unsigned TokOffset = *TokOffsetPtr;
159
160 // If we come up with an answer which seems sane, use it; otherwise,
161 // just point at the __asm keyword.
162 // FIXME: Assert the answer is sane once we handle .macro correctly.
163 SourceLocation Loc = AsmLoc;
164 if (TokIndex < AsmToks.size()) {
165 const Token &Tok = AsmToks[TokIndex];
166 Loc = Tok.getLocation();
167 Loc = Loc.getLocWithOffset(Offset - TokOffset);
168 }
Ehsan Akhgari31097582014-09-22 02:21:54 +0000169 return Loc;
170 }
171
172 void handleDiagnostic(const llvm::SMDiagnostic &D) {
173 const llvm::SourceMgr &LSM = *D.getSourceMgr();
174 SourceLocation Loc = translateLocation(LSM, D.getLoc());
Alp Toker1b935a82014-06-08 05:40:04 +0000175 TheParser.Diag(Loc, diag::err_inline_ms_asm_parsing) << D.getMessage();
176 }
177};
Alexander Kornienkoab9db512015-06-22 23:07:51 +0000178}
Alp Toker1b935a82014-06-08 05:40:04 +0000179
180/// Parse an identifier in an MS-style inline assembly block.
181///
182/// \param CastInfo - a void* so that we don't have to teach Parser.h
183/// about the actual type.
184ExprResult Parser::ParseMSAsmIdentifier(llvm::SmallVectorImpl<Token> &LineToks,
185 unsigned &NumLineToksConsumed,
186 void *CastInfo,
187 bool IsUnevaluatedContext) {
188 llvm::InlineAsmIdentifierInfo &Info =
189 *(llvm::InlineAsmIdentifierInfo *)CastInfo;
190
191 // Push a fake token on the end so that we don't overrun the token
192 // stream. We use ';' because it expression-parsing should never
193 // overrun it.
194 const tok::TokenKind EndOfStream = tok::semi;
195 Token EndOfStreamTok;
196 EndOfStreamTok.startToken();
197 EndOfStreamTok.setKind(EndOfStream);
198 LineToks.push_back(EndOfStreamTok);
199
200 // Also copy the current token over.
201 LineToks.push_back(Tok);
202
203 PP.EnterTokenStream(LineToks.begin(), LineToks.size(),
204 /*disable macros*/ true,
205 /*owns tokens*/ false);
206
207 // Clear the current token and advance to the first token in LineToks.
208 ConsumeAnyToken();
209
210 // Parse an optional scope-specifier if we're in C++.
211 CXXScopeSpec SS;
212 if (getLangOpts().CPlusPlus) {
David Blaikieefdccaa2016-01-15 23:43:34 +0000213 ParseOptionalCXXScopeSpecifier(SS, nullptr, /*EnteringContext=*/false);
Alp Toker1b935a82014-06-08 05:40:04 +0000214 }
215
216 // Require an identifier here.
217 SourceLocation TemplateKWLoc;
218 UnqualifiedId Id;
Michael Zuckerman229158c2015-12-15 14:04:18 +0000219 bool Invalid = true;
220 ExprResult Result;
221 if (Tok.is(tok::kw_this)) {
222 Result = ParseCXXThis();
223 Invalid = false;
224 } else {
David Blaikieefdccaa2016-01-15 23:43:34 +0000225 Invalid = ParseUnqualifiedId(SS,
226 /*EnteringContext=*/false,
227 /*AllowDestructorName=*/false,
228 /*AllowConstructorName=*/false,
229 /*ObjectType=*/nullptr, TemplateKWLoc, Id);
Michael Zuckerman229158c2015-12-15 14:04:18 +0000230 // Perform the lookup.
231 Result = Actions.LookupInlineAsmIdentifier(SS, TemplateKWLoc, Id, Info,
232 IsUnevaluatedContext);
233 }
Reid Kleckner14e96b42015-08-26 21:57:20 +0000234 // While the next two tokens are 'period' 'identifier', repeatedly parse it as
235 // a field access. We have to avoid consuming assembler directives that look
236 // like '.' 'else'.
237 while (Result.isUsable() && Tok.is(tok::period)) {
238 Token IdTok = PP.LookAhead(0);
239 if (IdTok.isNot(tok::identifier))
240 break;
241 ConsumeToken(); // Consume the period.
242 IdentifierInfo *Id = Tok.getIdentifierInfo();
243 ConsumeToken(); // Consume the identifier.
David Majnemer758e7982016-01-05 00:08:41 +0000244 Result = Actions.LookupInlineAsmVarDeclField(Result.get(), Id->getName(),
245 Info, Tok.getLocation());
Reid Kleckner14e96b42015-08-26 21:57:20 +0000246 }
247
Alp Toker1b935a82014-06-08 05:40:04 +0000248 // Figure out how many tokens we are into LineToks.
249 unsigned LineIndex = 0;
250 if (Tok.is(EndOfStream)) {
251 LineIndex = LineToks.size() - 2;
252 } else {
253 while (LineToks[LineIndex].getLocation() != Tok.getLocation()) {
254 LineIndex++;
255 assert(LineIndex < LineToks.size() - 2); // we added two extra tokens
256 }
257 }
258
259 // If we've run into the poison token we inserted before, or there
260 // was a parsing error, then claim the entire line.
261 if (Invalid || Tok.is(EndOfStream)) {
262 NumLineToksConsumed = LineToks.size() - 2;
263 } else {
264 // Otherwise, claim up to the start of the next token.
265 NumLineToksConsumed = LineIndex;
266 }
267
268 // Finally, restore the old parsing state by consuming all the tokens we
269 // staged before, implicitly killing off the token-lexer we pushed.
270 for (unsigned i = 0, e = LineToks.size() - LineIndex - 2; i != e; ++i) {
271 ConsumeAnyToken();
272 }
273 assert(Tok.is(EndOfStream));
274 ConsumeToken();
275
276 // Leave LineToks in its original state.
277 LineToks.pop_back();
278 LineToks.pop_back();
279
Reid Kleckner14e96b42015-08-26 21:57:20 +0000280 return Result;
Alp Toker1b935a82014-06-08 05:40:04 +0000281}
282
283/// Turn a sequence of our tokens back into a string that we can hand
284/// to the MC asm parser.
285static bool buildMSAsmString(Preprocessor &PP, SourceLocation AsmLoc,
286 ArrayRef<Token> AsmToks,
287 SmallVectorImpl<unsigned> &TokOffsets,
288 SmallString<512> &Asm) {
289 assert(!AsmToks.empty() && "Didn't expect an empty AsmToks!");
290
291 // Is this the start of a new assembly statement?
292 bool isNewStatement = true;
293
294 for (unsigned i = 0, e = AsmToks.size(); i < e; ++i) {
295 const Token &Tok = AsmToks[i];
296
297 // Start each new statement with a newline and a tab.
298 if (!isNewStatement && (Tok.is(tok::kw_asm) || Tok.isAtStartOfLine())) {
299 Asm += "\n\t";
300 isNewStatement = true;
301 }
302
303 // Preserve the existence of leading whitespace except at the
304 // start of a statement.
305 if (!isNewStatement && Tok.hasLeadingSpace())
306 Asm += ' ';
307
308 // Remember the offset of this token.
309 TokOffsets.push_back(Asm.size());
310
311 // Don't actually write '__asm' into the assembly stream.
312 if (Tok.is(tok::kw_asm)) {
313 // Complain about __asm at the end of the stream.
314 if (i + 1 == e) {
315 PP.Diag(AsmLoc, diag::err_asm_empty);
316 return true;
317 }
318
319 continue;
320 }
321
322 // Append the spelling of the token.
323 SmallString<32> SpellingBuffer;
324 bool SpellingInvalid = false;
325 Asm += PP.getSpelling(Tok, SpellingBuffer, &SpellingInvalid);
326 assert(!SpellingInvalid && "spelling was invalid after correct parse?");
327
328 // We are no longer at the start of a statement.
329 isNewStatement = false;
330 }
331
332 // Ensure that the buffer is null-terminated.
333 Asm.push_back('\0');
334 Asm.pop_back();
335
336 assert(TokOffsets.size() == AsmToks.size());
337 return false;
338}
339
340/// ParseMicrosoftAsmStatement. When -fms-extensions/-fasm-blocks is enabled,
341/// this routine is called to collect the tokens for an MS asm statement.
342///
343/// [MS] ms-asm-statement:
344/// ms-asm-block
345/// ms-asm-block ms-asm-statement
346///
347/// [MS] ms-asm-block:
348/// '__asm' ms-asm-line '\n'
349/// '__asm' '{' ms-asm-instruction-block[opt] '}' ';'[opt]
350///
351/// [MS] ms-asm-instruction-block
352/// ms-asm-line
353/// ms-asm-line '\n' ms-asm-instruction-block
354///
355StmtResult Parser::ParseMicrosoftAsmStatement(SourceLocation AsmLoc) {
356 SourceManager &SrcMgr = PP.getSourceManager();
357 SourceLocation EndLoc = AsmLoc;
358 SmallVector<Token, 4> AsmToks;
359
Ehsan Akhgari2f93b442014-07-25 02:27:14 +0000360 bool SingleLineMode = true;
Ehsan Akhgari0f89fac2014-07-06 05:26:54 +0000361 unsigned BraceNesting = 0;
Ehsan Akhgari833ed942014-07-15 02:21:41 +0000362 unsigned short savedBraceCount = BraceCount;
Alp Toker1b935a82014-06-08 05:40:04 +0000363 bool InAsmComment = false;
364 FileID FID;
365 unsigned LineNo = 0;
366 unsigned NumTokensRead = 0;
Ehsan Akhgari0f89fac2014-07-06 05:26:54 +0000367 SmallVector<SourceLocation, 4> LBraceLocs;
368 bool SkippedStartOfLine = false;
Alp Toker1b935a82014-06-08 05:40:04 +0000369
370 if (Tok.is(tok::l_brace)) {
371 // Braced inline asm: consume the opening brace.
Ehsan Akhgari2f93b442014-07-25 02:27:14 +0000372 SingleLineMode = false;
Ehsan Akhgari0f89fac2014-07-06 05:26:54 +0000373 BraceNesting = 1;
Ehsan Akhgari0f89fac2014-07-06 05:26:54 +0000374 EndLoc = ConsumeBrace();
375 LBraceLocs.push_back(EndLoc);
Alp Toker1b935a82014-06-08 05:40:04 +0000376 ++NumTokensRead;
377 } else {
378 // Single-line inline asm; compute which line it is on.
379 std::pair<FileID, unsigned> ExpAsmLoc =
380 SrcMgr.getDecomposedExpansionLoc(EndLoc);
381 FID = ExpAsmLoc.first;
382 LineNo = SrcMgr.getLineNumber(FID, ExpAsmLoc.second);
Ehsan Akhgari0f89fac2014-07-06 05:26:54 +0000383 LBraceLocs.push_back(SourceLocation());
Alp Toker1b935a82014-06-08 05:40:04 +0000384 }
385
386 SourceLocation TokLoc = Tok.getLocation();
387 do {
388 // If we hit EOF, we're done, period.
389 if (isEofOrEom())
390 break;
391
Ehsan Akhgari0f89fac2014-07-06 05:26:54 +0000392 if (!InAsmComment && Tok.is(tok::l_brace)) {
393 // Consume the opening brace.
394 SkippedStartOfLine = Tok.isAtStartOfLine();
395 EndLoc = ConsumeBrace();
396 BraceNesting++;
397 LBraceLocs.push_back(EndLoc);
398 TokLoc = Tok.getLocation();
399 ++NumTokensRead;
400 continue;
401 } else if (!InAsmComment && Tok.is(tok::semi)) {
Alp Toker1b935a82014-06-08 05:40:04 +0000402 // A semicolon in an asm is the start of a comment.
403 InAsmComment = true;
Ehsan Akhgari2f93b442014-07-25 02:27:14 +0000404 if (!SingleLineMode) {
Alp Toker1b935a82014-06-08 05:40:04 +0000405 // Compute which line the comment is on.
406 std::pair<FileID, unsigned> ExpSemiLoc =
407 SrcMgr.getDecomposedExpansionLoc(TokLoc);
408 FID = ExpSemiLoc.first;
409 LineNo = SrcMgr.getLineNumber(FID, ExpSemiLoc.second);
410 }
Ehsan Akhgari2f93b442014-07-25 02:27:14 +0000411 } else if (SingleLineMode || InAsmComment) {
Alp Toker1b935a82014-06-08 05:40:04 +0000412 // If end-of-line is significant, check whether this token is on a
413 // new line.
414 std::pair<FileID, unsigned> ExpLoc =
415 SrcMgr.getDecomposedExpansionLoc(TokLoc);
416 if (ExpLoc.first != FID ||
417 SrcMgr.getLineNumber(ExpLoc.first, ExpLoc.second) != LineNo) {
Ehsan Akhgari2f93b442014-07-25 02:27:14 +0000418 // If this is a single-line __asm, we're done, except if the next
419 // line begins with an __asm too, in which case we finish a comment
420 // if needed and then keep processing the next line as a single
421 // line __asm.
422 bool isAsm = Tok.is(tok::kw_asm);
423 if (SingleLineMode && !isAsm)
Alp Toker1b935a82014-06-08 05:40:04 +0000424 break;
425 // We're no longer in a comment.
426 InAsmComment = false;
Ehsan Akhgari2f93b442014-07-25 02:27:14 +0000427 if (isAsm) {
428 LineNo = SrcMgr.getLineNumber(ExpLoc.first, ExpLoc.second);
429 SkippedStartOfLine = Tok.isAtStartOfLine();
430 }
Alp Toker1b935a82014-06-08 05:40:04 +0000431 } else if (!InAsmComment && Tok.is(tok::r_brace)) {
Ehsan Akhgari2f93b442014-07-25 02:27:14 +0000432 // In MSVC mode, braces only participate in brace matching and
433 // separating the asm statements. This is an intentional
434 // departure from the Apple gcc behavior.
435 if (!BraceNesting)
436 break;
Alp Toker1b935a82014-06-08 05:40:04 +0000437 }
438 }
Ehsan Akhgari0f89fac2014-07-06 05:26:54 +0000439 if (!InAsmComment && BraceNesting && Tok.is(tok::r_brace) &&
440 BraceCount == (savedBraceCount + BraceNesting)) {
441 // Consume the closing brace.
442 SkippedStartOfLine = Tok.isAtStartOfLine();
Alp Toker1b935a82014-06-08 05:40:04 +0000443 EndLoc = ConsumeBrace();
Ehsan Akhgari0f89fac2014-07-06 05:26:54 +0000444 BraceNesting--;
Nico Weber022e5072014-07-17 18:19:30 +0000445 // Finish if all of the opened braces in the inline asm section were
446 // consumed.
Ehsan Akhgari2f93b442014-07-25 02:27:14 +0000447 if (BraceNesting == 0 && !SingleLineMode)
Ehsan Akhgari0f89fac2014-07-06 05:26:54 +0000448 break;
449 else {
450 LBraceLocs.pop_back();
451 TokLoc = Tok.getLocation();
452 ++NumTokensRead;
453 continue;
454 }
Alp Toker1b935a82014-06-08 05:40:04 +0000455 }
456
457 // Consume the next token; make sure we don't modify the brace count etc.
458 // if we are in a comment.
459 EndLoc = TokLoc;
460 if (InAsmComment)
461 PP.Lex(Tok);
462 else {
Ehsan Akhgari0f89fac2014-07-06 05:26:54 +0000463 // Set the token as the start of line if we skipped the original start
464 // of line token in case it was a nested brace.
465 if (SkippedStartOfLine)
466 Tok.setFlag(Token::StartOfLine);
Alp Toker1b935a82014-06-08 05:40:04 +0000467 AsmToks.push_back(Tok);
468 ConsumeAnyToken();
469 }
470 TokLoc = Tok.getLocation();
471 ++NumTokensRead;
Ehsan Akhgari0f89fac2014-07-06 05:26:54 +0000472 SkippedStartOfLine = false;
Alp Toker1b935a82014-06-08 05:40:04 +0000473 } while (1);
474
Ehsan Akhgari0f89fac2014-07-06 05:26:54 +0000475 if (BraceNesting && BraceCount != savedBraceCount) {
Alp Toker1b935a82014-06-08 05:40:04 +0000476 // __asm without closing brace (this can happen at EOF).
Ehsan Akhgari0f89fac2014-07-06 05:26:54 +0000477 for (unsigned i = 0; i < BraceNesting; ++i) {
478 Diag(Tok, diag::err_expected) << tok::r_brace;
479 Diag(LBraceLocs.back(), diag::note_matching) << tok::l_brace;
480 LBraceLocs.pop_back();
481 }
Alp Toker1b935a82014-06-08 05:40:04 +0000482 return StmtError();
483 } else if (NumTokensRead == 0) {
484 // Empty __asm.
485 Diag(Tok, diag::err_expected) << tok::l_brace;
486 return StmtError();
487 }
488
489 // Okay, prepare to use MC to parse the assembly.
490 SmallVector<StringRef, 4> ConstraintRefs;
491 SmallVector<Expr *, 4> Exprs;
492 SmallVector<StringRef, 4> ClobberRefs;
493
494 // We need an actual supported target.
495 const llvm::Triple &TheTriple = Actions.Context.getTargetInfo().getTriple();
496 llvm::Triple::ArchType ArchTy = TheTriple.getArch();
497 const std::string &TT = TheTriple.getTriple();
498 const llvm::Target *TheTarget = nullptr;
499 bool UnsupportedArch =
500 (ArchTy != llvm::Triple::x86 && ArchTy != llvm::Triple::x86_64);
501 if (UnsupportedArch) {
502 Diag(AsmLoc, diag::err_msasm_unsupported_arch) << TheTriple.getArchName();
503 } else {
504 std::string Error;
505 TheTarget = llvm::TargetRegistry::lookupTarget(TT, Error);
506 if (!TheTarget)
507 Diag(AsmLoc, diag::err_msasm_unable_to_create_target) << Error;
508 }
509
Ehsan Akhgari0f89fac2014-07-06 05:26:54 +0000510 assert(!LBraceLocs.empty() && "Should have at least one location here");
511
Alp Toker1b935a82014-06-08 05:40:04 +0000512 // If we don't support assembly, or the assembly is empty, we don't
513 // need to instantiate the AsmParser, etc.
514 if (!TheTarget || AsmToks.empty()) {
Ehsan Akhgari0f89fac2014-07-06 05:26:54 +0000515 return Actions.ActOnMSAsmStmt(AsmLoc, LBraceLocs[0], AsmToks, StringRef(),
Alp Toker1b935a82014-06-08 05:40:04 +0000516 /*NumOutputs*/ 0, /*NumInputs*/ 0,
517 ConstraintRefs, ClobberRefs, Exprs, EndLoc);
518 }
519
520 // Expand the tokens into a string buffer.
521 SmallString<512> AsmString;
522 SmallVector<unsigned, 8> TokOffsets;
523 if (buildMSAsmString(PP, AsmLoc, AsmToks, TokOffsets, AsmString))
524 return StmtError();
525
Marina Yatsina41c45fa2016-02-03 11:32:08 +0000526 TargetOptions TO = Actions.Context.getTargetInfo().getTargetOpts();
527 std::string FeaturesStr =
528 llvm::join(TO.Features.begin(), TO.Features.end(), ",");
529
Alp Toker1b935a82014-06-08 05:40:04 +0000530 std::unique_ptr<llvm::MCRegisterInfo> MRI(TheTarget->createMCRegInfo(TT));
531 std::unique_ptr<llvm::MCAsmInfo> MAI(TheTarget->createMCAsmInfo(*MRI, TT));
532 // Get the instruction descriptor.
533 std::unique_ptr<llvm::MCInstrInfo> MII(TheTarget->createMCInstrInfo());
534 std::unique_ptr<llvm::MCObjectFileInfo> MOFI(new llvm::MCObjectFileInfo());
535 std::unique_ptr<llvm::MCSubtargetInfo> STI(
Marina Yatsina41c45fa2016-02-03 11:32:08 +0000536 TheTarget->createMCSubtargetInfo(TT, TO.CPU, FeaturesStr));
Alp Toker1b935a82014-06-08 05:40:04 +0000537
538 llvm::SourceMgr TempSrcMgr;
539 llvm::MCContext Ctx(MAI.get(), MRI.get(), MOFI.get(), &TempSrcMgr);
Daniel Sanders8d8b13d2015-06-16 12:18:07 +0000540 MOFI->InitMCObjectFileInfo(TheTriple, llvm::Reloc::Default,
541 llvm::CodeModel::Default, Ctx);
Rafael Espindolad87f8d72014-08-27 20:03:29 +0000542 std::unique_ptr<llvm::MemoryBuffer> Buffer =
543 llvm::MemoryBuffer::getMemBuffer(AsmString, "<MS inline asm>");
Alp Toker1b935a82014-06-08 05:40:04 +0000544
545 // Tell SrcMgr about this buffer, which is what the parser will pick up.
David Blaikie9e095d92014-08-21 21:01:00 +0000546 TempSrcMgr.AddNewSourceBuffer(std::move(Buffer), llvm::SMLoc());
Alp Toker1b935a82014-06-08 05:40:04 +0000547
548 std::unique_ptr<llvm::MCStreamer> Str(createNullStreamer(Ctx));
549 std::unique_ptr<llvm::MCAsmParser> Parser(
550 createMCAsmParser(TempSrcMgr, Ctx, *Str.get(), *MAI));
551
552 // FIXME: init MCOptions from sanitizer flags here.
553 llvm::MCTargetOptions MCOptions;
554 std::unique_ptr<llvm::MCTargetAsmParser> TargetParser(
555 TheTarget->createMCAsmParser(*STI, *Parser, *MII, MCOptions));
556
Daniel Sanders50f17232015-09-15 16:17:27 +0000557 std::unique_ptr<llvm::MCInstPrinter> IP(
558 TheTarget->createMCInstPrinter(llvm::Triple(TT), 1, *MAI, *MII, *MRI));
Alp Toker1b935a82014-06-08 05:40:04 +0000559
560 // Change to the Intel dialect.
561 Parser->setAssemblerDialect(1);
562 Parser->setTargetParser(*TargetParser.get());
563 Parser->setParsingInlineAsm(true);
564 TargetParser->setParsingInlineAsm(true);
565
566 ClangAsmParserCallback Callback(*this, AsmLoc, AsmString, AsmToks,
567 TokOffsets);
568 TargetParser->setSemaCallback(&Callback);
569 TempSrcMgr.setDiagHandler(ClangAsmParserCallback::DiagHandlerCallback,
570 &Callback);
571
572 unsigned NumOutputs;
573 unsigned NumInputs;
574 std::string AsmStringIR;
575 SmallVector<std::pair<void *, bool>, 4> OpExprs;
576 SmallVector<std::string, 4> Constraints;
577 SmallVector<std::string, 4> Clobbers;
578 if (Parser->parseMSInlineAsm(AsmLoc.getPtrEncoding(), AsmStringIR, NumOutputs,
579 NumInputs, OpExprs, Constraints, Clobbers,
580 MII.get(), IP.get(), Callback))
581 return StmtError();
582
583 // Filter out "fpsw". Clang doesn't accept it, and it always lists flags and
584 // fpsr as clobbers.
585 auto End = std::remove(Clobbers.begin(), Clobbers.end(), "fpsw");
586 Clobbers.erase(End, Clobbers.end());
587
588 // Build the vector of clobber StringRefs.
David Majnemer05c69862014-06-23 02:16:41 +0000589 ClobberRefs.insert(ClobberRefs.end(), Clobbers.begin(), Clobbers.end());
Alp Toker1b935a82014-06-08 05:40:04 +0000590
591 // Recast the void pointers and build the vector of constraint StringRefs.
592 unsigned NumExprs = NumOutputs + NumInputs;
593 ConstraintRefs.resize(NumExprs);
594 Exprs.resize(NumExprs);
595 for (unsigned i = 0, e = NumExprs; i != e; ++i) {
596 Expr *OpExpr = static_cast<Expr *>(OpExprs[i].first);
597 if (!OpExpr)
598 return StmtError();
599
600 // Need address of variable.
601 if (OpExprs[i].second)
602 OpExpr =
603 Actions.BuildUnaryOp(getCurScope(), AsmLoc, UO_AddrOf, OpExpr).get();
604
605 ConstraintRefs[i] = StringRef(Constraints[i]);
606 Exprs[i] = OpExpr;
607 }
608
609 // FIXME: We should be passing source locations for better diagnostics.
Ehsan Akhgari0f89fac2014-07-06 05:26:54 +0000610 return Actions.ActOnMSAsmStmt(AsmLoc, LBraceLocs[0], AsmToks, AsmStringIR,
Alp Toker1b935a82014-06-08 05:40:04 +0000611 NumOutputs, NumInputs, ConstraintRefs,
612 ClobberRefs, Exprs, EndLoc);
613}
614
615/// ParseAsmStatement - Parse a GNU extended asm statement.
616/// asm-statement:
617/// gnu-asm-statement
618/// ms-asm-statement
619///
620/// [GNU] gnu-asm-statement:
621/// 'asm' type-qualifier[opt] '(' asm-argument ')' ';'
622///
623/// [GNU] asm-argument:
624/// asm-string-literal
625/// asm-string-literal ':' asm-operands[opt]
626/// asm-string-literal ':' asm-operands[opt] ':' asm-operands[opt]
627/// asm-string-literal ':' asm-operands[opt] ':' asm-operands[opt]
628/// ':' asm-clobbers
629///
630/// [GNU] asm-clobbers:
631/// asm-string-literal
632/// asm-clobbers ',' asm-string-literal
633///
634StmtResult Parser::ParseAsmStatement(bool &msAsm) {
635 assert(Tok.is(tok::kw_asm) && "Not an asm stmt");
636 SourceLocation AsmLoc = ConsumeToken();
637
638 if (getLangOpts().AsmBlocks && Tok.isNot(tok::l_paren) &&
639 !isTypeQualifier()) {
640 msAsm = true;
641 return ParseMicrosoftAsmStatement(AsmLoc);
642 }
Steven Wucb0d13f2015-01-16 23:05:28 +0000643
Alp Toker1b935a82014-06-08 05:40:04 +0000644 DeclSpec DS(AttrFactory);
645 SourceLocation Loc = Tok.getLocation();
Aaron Ballman08b06592014-07-22 12:44:22 +0000646 ParseTypeQualifierListOpt(DS, AR_VendorAttributesParsed);
Alp Toker1b935a82014-06-08 05:40:04 +0000647
648 // GNU asms accept, but warn, about type-qualifiers other than volatile.
649 if (DS.getTypeQualifiers() & DeclSpec::TQ_const)
650 Diag(Loc, diag::w_asm_qualifier_ignored) << "const";
651 if (DS.getTypeQualifiers() & DeclSpec::TQ_restrict)
652 Diag(Loc, diag::w_asm_qualifier_ignored) << "restrict";
653 // FIXME: Once GCC supports _Atomic, check whether it permits it here.
654 if (DS.getTypeQualifiers() & DeclSpec::TQ_atomic)
655 Diag(Loc, diag::w_asm_qualifier_ignored) << "_Atomic";
656
657 // Remember if this was a volatile asm.
658 bool isVolatile = DS.getTypeQualifiers() & DeclSpec::TQ_volatile;
659 if (Tok.isNot(tok::l_paren)) {
660 Diag(Tok, diag::err_expected_lparen_after) << "asm";
661 SkipUntil(tok::r_paren, StopAtSemi);
662 return StmtError();
663 }
664 BalancedDelimiterTracker T(*this, tok::l_paren);
665 T.consumeOpen();
666
667 ExprResult AsmString(ParseAsmStringLiteral());
Steven Wu18bbe192015-05-12 00:16:37 +0000668
669 // Check if GNU-style InlineAsm is disabled.
670 // Error on anything other than empty string.
671 if (!(getLangOpts().GNUAsm || AsmString.isInvalid())) {
672 const auto *SL = cast<StringLiteral>(AsmString.get());
673 if (!SL->getString().trim().empty())
674 Diag(Loc, diag::err_gnu_inline_asm_disabled);
675 }
676
Alp Toker1b935a82014-06-08 05:40:04 +0000677 if (AsmString.isInvalid()) {
678 // Consume up to and including the closing paren.
679 T.skipToEnd();
680 return StmtError();
681 }
682
683 SmallVector<IdentifierInfo *, 4> Names;
684 ExprVector Constraints;
685 ExprVector Exprs;
686 ExprVector Clobbers;
687
688 if (Tok.is(tok::r_paren)) {
689 // We have a simple asm expression like 'asm("foo")'.
690 T.consumeClose();
691 return Actions.ActOnGCCAsmStmt(AsmLoc, /*isSimple*/ true, isVolatile,
692 /*NumOutputs*/ 0, /*NumInputs*/ 0, nullptr,
693 Constraints, Exprs, AsmString.get(),
694 Clobbers, T.getCloseLocation());
695 }
696
697 // Parse Outputs, if present.
698 bool AteExtraColon = false;
699 if (Tok.is(tok::colon) || Tok.is(tok::coloncolon)) {
700 // In C++ mode, parse "::" like ": :".
701 AteExtraColon = Tok.is(tok::coloncolon);
702 ConsumeToken();
703
704 if (!AteExtraColon && ParseAsmOperandsOpt(Names, Constraints, Exprs))
705 return StmtError();
706 }
707
708 unsigned NumOutputs = Names.size();
709
710 // Parse Inputs, if present.
711 if (AteExtraColon || Tok.is(tok::colon) || Tok.is(tok::coloncolon)) {
712 // In C++ mode, parse "::" like ": :".
713 if (AteExtraColon)
714 AteExtraColon = false;
715 else {
716 AteExtraColon = Tok.is(tok::coloncolon);
717 ConsumeToken();
718 }
719
720 if (!AteExtraColon && ParseAsmOperandsOpt(Names, Constraints, Exprs))
721 return StmtError();
722 }
723
724 assert(Names.size() == Constraints.size() &&
725 Constraints.size() == Exprs.size() && "Input operand size mismatch!");
726
727 unsigned NumInputs = Names.size() - NumOutputs;
728
729 // Parse the clobbers, if present.
730 if (AteExtraColon || Tok.is(tok::colon)) {
731 if (!AteExtraColon)
732 ConsumeToken();
733
734 // Parse the asm-string list for clobbers if present.
735 if (Tok.isNot(tok::r_paren)) {
736 while (1) {
737 ExprResult Clobber(ParseAsmStringLiteral());
738
739 if (Clobber.isInvalid())
740 break;
741
742 Clobbers.push_back(Clobber.get());
743
744 if (!TryConsumeToken(tok::comma))
745 break;
746 }
747 }
748 }
749
750 T.consumeClose();
751 return Actions.ActOnGCCAsmStmt(
752 AsmLoc, false, isVolatile, NumOutputs, NumInputs, Names.data(),
753 Constraints, Exprs, AsmString.get(), Clobbers, T.getCloseLocation());
754}
755
756/// ParseAsmOperands - Parse the asm-operands production as used by
757/// asm-statement, assuming the leading ':' token was eaten.
758///
759/// [GNU] asm-operands:
760/// asm-operand
761/// asm-operands ',' asm-operand
762///
763/// [GNU] asm-operand:
764/// asm-string-literal '(' expression ')'
765/// '[' identifier ']' asm-string-literal '(' expression ')'
766///
767//
768// FIXME: Avoid unnecessary std::string trashing.
769bool Parser::ParseAsmOperandsOpt(SmallVectorImpl<IdentifierInfo *> &Names,
770 SmallVectorImpl<Expr *> &Constraints,
771 SmallVectorImpl<Expr *> &Exprs) {
772 // 'asm-operands' isn't present?
773 if (!isTokenStringLiteral() && Tok.isNot(tok::l_square))
774 return false;
775
776 while (1) {
777 // Read the [id] if present.
778 if (Tok.is(tok::l_square)) {
779 BalancedDelimiterTracker T(*this, tok::l_square);
780 T.consumeOpen();
781
782 if (Tok.isNot(tok::identifier)) {
783 Diag(Tok, diag::err_expected) << tok::identifier;
784 SkipUntil(tok::r_paren, StopAtSemi);
785 return true;
786 }
787
788 IdentifierInfo *II = Tok.getIdentifierInfo();
789 ConsumeToken();
790
791 Names.push_back(II);
792 T.consumeClose();
793 } else
794 Names.push_back(nullptr);
795
796 ExprResult Constraint(ParseAsmStringLiteral());
797 if (Constraint.isInvalid()) {
798 SkipUntil(tok::r_paren, StopAtSemi);
799 return true;
800 }
801 Constraints.push_back(Constraint.get());
802
803 if (Tok.isNot(tok::l_paren)) {
804 Diag(Tok, diag::err_expected_lparen_after) << "asm operand";
805 SkipUntil(tok::r_paren, StopAtSemi);
806 return true;
807 }
808
809 // Read the parenthesized expression.
810 BalancedDelimiterTracker T(*this, tok::l_paren);
811 T.consumeOpen();
Kaelyn Takata15867822014-11-21 18:48:04 +0000812 ExprResult Res = Actions.CorrectDelayedTyposInExpr(ParseExpression());
Alp Toker1b935a82014-06-08 05:40:04 +0000813 T.consumeClose();
814 if (Res.isInvalid()) {
815 SkipUntil(tok::r_paren, StopAtSemi);
816 return true;
817 }
818 Exprs.push_back(Res.get());
819 // Eat the comma and continue parsing if it exists.
820 if (!TryConsumeToken(tok::comma))
821 return false;
822 }
823}