1 //===- Stmt.cpp - Statement AST Node Implementation -----------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file implements the Stmt class and statement subclasses.
12 //===----------------------------------------------------------------------===//
14 #include "clang/AST/Stmt.h"
15 #include "clang/AST/ASTContext.h"
16 #include "clang/AST/ASTDiagnostic.h"
17 #include "clang/AST/Decl.h"
18 #include "clang/AST/DeclGroup.h"
19 #include "clang/AST/Expr.h"
20 #include "clang/AST/ExprCXX.h"
21 #include "clang/AST/ExprObjC.h"
22 #include "clang/AST/ExprOpenMP.h"
23 #include "clang/AST/StmtCXX.h"
24 #include "clang/AST/StmtObjC.h"
25 #include "clang/AST/StmtOpenMP.h"
26 #include "clang/AST/Type.h"
27 #include "clang/Basic/CharInfo.h"
28 #include "clang/Basic/LLVM.h"
29 #include "clang/Basic/SourceLocation.h"
30 #include "clang/Basic/TargetInfo.h"
31 #include "clang/Lex/Token.h"
32 #include "llvm/ADT/SmallVector.h"
33 #include "llvm/ADT/StringExtras.h"
34 #include "llvm/ADT/StringRef.h"
35 #include "llvm/Support/Casting.h"
36 #include "llvm/Support/Compiler.h"
37 #include "llvm/Support/ErrorHandling.h"
38 #include "llvm/Support/MathExtras.h"
39 #include "llvm/Support/raw_ostream.h"
46 using namespace clang;
48 static struct StmtClassNameTable {
52 } StmtClassInfo[Stmt::lastStmtConstant+1];
54 static StmtClassNameTable &getStmtInfoTableEntry(Stmt::StmtClass E) {
55 static bool Initialized = false;
57 return StmtClassInfo[E];
59 // Initialize the table on the first use.
61 #define ABSTRACT_STMT(STMT)
62 #define STMT(CLASS, PARENT) \
63 StmtClassInfo[(unsigned)Stmt::CLASS##Class].Name = #CLASS; \
64 StmtClassInfo[(unsigned)Stmt::CLASS##Class].Size = sizeof(CLASS);
65 #include "clang/AST/StmtNodes.inc"
67 return StmtClassInfo[E];
70 void *Stmt::operator new(size_t bytes, const ASTContext& C,
72 return ::operator new(bytes, C, alignment);
75 const char *Stmt::getStmtClassName() const {
76 return getStmtInfoTableEntry((StmtClass) StmtBits.sClass).Name;
79 // Check that no statement / expression class is polymorphic. LLVM style RTTI
80 // should be used instead. If absolutely needed an exception can still be added
81 // here by defining the appropriate macro (but please don't do this).
82 #define STMT(CLASS, PARENT) \
83 static_assert(!std::is_polymorphic<CLASS>::value, \
84 #CLASS " should not be polymorphic!");
85 #include "clang/AST/StmtNodes.inc"
87 void Stmt::PrintStats() {
88 // Ensure the table is primed.
89 getStmtInfoTableEntry(Stmt::NullStmtClass);
92 llvm::errs() << "\n*** Stmt/Expr Stats:\n";
93 for (int i = 0; i != Stmt::lastStmtConstant+1; i++) {
94 if (StmtClassInfo[i].Name == nullptr) continue;
95 sum += StmtClassInfo[i].Counter;
97 llvm::errs() << " " << sum << " stmts/exprs total.\n";
99 for (int i = 0; i != Stmt::lastStmtConstant+1; i++) {
100 if (StmtClassInfo[i].Name == nullptr) continue;
101 if (StmtClassInfo[i].Counter == 0) continue;
102 llvm::errs() << " " << StmtClassInfo[i].Counter << " "
103 << StmtClassInfo[i].Name << ", " << StmtClassInfo[i].Size
104 << " each (" << StmtClassInfo[i].Counter*StmtClassInfo[i].Size
106 sum += StmtClassInfo[i].Counter*StmtClassInfo[i].Size;
109 llvm::errs() << "Total bytes = " << sum << "\n";
112 void Stmt::addStmtClass(StmtClass s) {
113 ++getStmtInfoTableEntry(s).Counter;
116 bool Stmt::StatisticsEnabled = false;
117 void Stmt::EnableStatistics() {
118 StatisticsEnabled = true;
121 Stmt *Stmt::IgnoreImplicit() {
124 Stmt *lasts = nullptr;
129 if (auto *fe = dyn_cast<FullExpr>(s))
130 s = fe->getSubExpr();
132 if (auto *mte = dyn_cast<MaterializeTemporaryExpr>(s))
133 s = mte->GetTemporaryExpr();
135 if (auto *bte = dyn_cast<CXXBindTemporaryExpr>(s))
136 s = bte->getSubExpr();
138 if (auto *ice = dyn_cast<ImplicitCastExpr>(s))
139 s = ice->getSubExpr();
145 /// Skip no-op (attributed, compound) container stmts and skip captured
146 /// stmt at the top, if \a IgnoreCaptured is true.
147 Stmt *Stmt::IgnoreContainers(bool IgnoreCaptured) {
150 if (auto CapS = dyn_cast_or_null<CapturedStmt>(S))
151 S = CapS->getCapturedStmt();
153 if (auto AS = dyn_cast_or_null<AttributedStmt>(S))
154 S = AS->getSubStmt();
155 else if (auto CS = dyn_cast_or_null<CompoundStmt>(S)) {
165 /// Strip off all label-like statements.
167 /// This will strip off label statements, case statements, attributed
168 /// statements and default statements recursively.
169 const Stmt *Stmt::stripLabelLikeStatements() const {
170 const Stmt *S = this;
172 if (const auto *LS = dyn_cast<LabelStmt>(S))
173 S = LS->getSubStmt();
174 else if (const auto *SC = dyn_cast<SwitchCase>(S))
175 S = SC->getSubStmt();
176 else if (const auto *AS = dyn_cast<AttributedStmt>(S))
177 S = AS->getSubStmt();
188 // These silly little functions have to be static inline to suppress
189 // unused warnings, and they have to be defined to suppress other
191 static good is_good(good) { return good(); }
193 typedef Stmt::child_range children_t();
194 template <class T> good implements_children(children_t T::*) {
197 LLVM_ATTRIBUTE_UNUSED
198 static bad implements_children(children_t Stmt::*) {
202 typedef SourceLocation getBeginLoc_t() const;
203 template <class T> good implements_getBeginLoc(getBeginLoc_t T::*) {
206 LLVM_ATTRIBUTE_UNUSED
207 static bad implements_getBeginLoc(getBeginLoc_t Stmt::*) { return bad(); }
209 typedef SourceLocation getLocEnd_t() const;
210 template <class T> good implements_getEndLoc(getLocEnd_t T::*) {
213 LLVM_ATTRIBUTE_UNUSED
214 static bad implements_getEndLoc(getLocEnd_t Stmt::*) { return bad(); }
216 #define ASSERT_IMPLEMENTS_children(type) \
217 (void) is_good(implements_children(&type::children))
218 #define ASSERT_IMPLEMENTS_getBeginLoc(type) \
219 (void)is_good(implements_getBeginLoc(&type::getBeginLoc))
220 #define ASSERT_IMPLEMENTS_getEndLoc(type) \
221 (void)is_good(implements_getEndLoc(&type::getEndLoc))
225 /// Check whether the various Stmt classes implement their member
227 LLVM_ATTRIBUTE_UNUSED
228 static inline void check_implementations() {
229 #define ABSTRACT_STMT(type)
230 #define STMT(type, base) \
231 ASSERT_IMPLEMENTS_children(type); \
232 ASSERT_IMPLEMENTS_getBeginLoc(type); \
233 ASSERT_IMPLEMENTS_getEndLoc(type);
234 #include "clang/AST/StmtNodes.inc"
237 Stmt::child_range Stmt::children() {
238 switch (getStmtClass()) {
239 case Stmt::NoStmtClass: llvm_unreachable("statement without class");
240 #define ABSTRACT_STMT(type)
241 #define STMT(type, base) \
242 case Stmt::type##Class: \
243 return static_cast<type*>(this)->children();
244 #include "clang/AST/StmtNodes.inc"
246 llvm_unreachable("unknown statement kind!");
249 // Amusing macro metaprogramming hack: check whether a class provides
250 // a more specific implementation of getSourceRange.
252 // See also Expr.cpp:getExprLoc().
255 /// This implementation is used when a class provides a custom
256 /// implementation of getSourceRange.
257 template <class S, class T>
258 SourceRange getSourceRangeImpl(const Stmt *stmt,
259 SourceRange (T::*v)() const) {
260 return static_cast<const S*>(stmt)->getSourceRange();
263 /// This implementation is used when a class doesn't provide a custom
264 /// implementation of getSourceRange. Overload resolution should pick it over
265 /// the implementation above because it's more specialized according to
266 /// function template partial ordering.
268 SourceRange getSourceRangeImpl(const Stmt *stmt,
269 SourceRange (Stmt::*v)() const) {
270 return SourceRange(static_cast<const S *>(stmt)->getBeginLoc(),
271 static_cast<const S *>(stmt)->getEndLoc());
276 SourceRange Stmt::getSourceRange() const {
277 switch (getStmtClass()) {
278 case Stmt::NoStmtClass: llvm_unreachable("statement without class");
279 #define ABSTRACT_STMT(type)
280 #define STMT(type, base) \
281 case Stmt::type##Class: \
282 return getSourceRangeImpl<type>(this, &type::getSourceRange);
283 #include "clang/AST/StmtNodes.inc"
285 llvm_unreachable("unknown statement kind!");
288 SourceLocation Stmt::getBeginLoc() const {
289 // llvm::errs() << "getBeginLoc() for " << getStmtClassName() << "\n";
290 switch (getStmtClass()) {
291 case Stmt::NoStmtClass: llvm_unreachable("statement without class");
292 #define ABSTRACT_STMT(type)
293 #define STMT(type, base) \
294 case Stmt::type##Class: \
295 return static_cast<const type *>(this)->getBeginLoc();
296 #include "clang/AST/StmtNodes.inc"
298 llvm_unreachable("unknown statement kind");
301 SourceLocation Stmt::getEndLoc() const {
302 switch (getStmtClass()) {
303 case Stmt::NoStmtClass: llvm_unreachable("statement without class");
304 #define ABSTRACT_STMT(type)
305 #define STMT(type, base) \
306 case Stmt::type##Class: \
307 return static_cast<const type *>(this)->getEndLoc();
308 #include "clang/AST/StmtNodes.inc"
310 llvm_unreachable("unknown statement kind");
313 int64_t Stmt::getID(const ASTContext &Context) const {
314 return Context.getAllocator().identifyKnownAlignedObject<Stmt>(this);
317 CompoundStmt::CompoundStmt(ArrayRef<Stmt *> Stmts, SourceLocation LB,
319 : Stmt(CompoundStmtClass), RBraceLoc(RB) {
320 CompoundStmtBits.NumStmts = Stmts.size();
322 CompoundStmtBits.LBraceLoc = LB;
325 void CompoundStmt::setStmts(ArrayRef<Stmt *> Stmts) {
326 assert(CompoundStmtBits.NumStmts == Stmts.size() &&
327 "NumStmts doesn't fit in bits of CompoundStmtBits.NumStmts!");
329 std::copy(Stmts.begin(), Stmts.end(), body_begin());
332 CompoundStmt *CompoundStmt::Create(const ASTContext &C, ArrayRef<Stmt *> Stmts,
333 SourceLocation LB, SourceLocation RB) {
335 C.Allocate(totalSizeToAlloc<Stmt *>(Stmts.size()), alignof(CompoundStmt));
336 return new (Mem) CompoundStmt(Stmts, LB, RB);
339 CompoundStmt *CompoundStmt::CreateEmpty(const ASTContext &C,
342 C.Allocate(totalSizeToAlloc<Stmt *>(NumStmts), alignof(CompoundStmt));
343 CompoundStmt *New = new (Mem) CompoundStmt(EmptyShell());
344 New->CompoundStmtBits.NumStmts = NumStmts;
348 const char *LabelStmt::getName() const {
349 return getDecl()->getIdentifier()->getNameStart();
352 AttributedStmt *AttributedStmt::Create(const ASTContext &C, SourceLocation Loc,
353 ArrayRef<const Attr*> Attrs,
355 assert(!Attrs.empty() && "Attrs should not be empty");
356 void *Mem = C.Allocate(totalSizeToAlloc<const Attr *>(Attrs.size()),
357 alignof(AttributedStmt));
358 return new (Mem) AttributedStmt(Loc, Attrs, SubStmt);
361 AttributedStmt *AttributedStmt::CreateEmpty(const ASTContext &C,
363 assert(NumAttrs > 0 && "NumAttrs should be greater than zero");
364 void *Mem = C.Allocate(totalSizeToAlloc<const Attr *>(NumAttrs),
365 alignof(AttributedStmt));
366 return new (Mem) AttributedStmt(EmptyShell(), NumAttrs);
369 std::string AsmStmt::generateAsmString(const ASTContext &C) const {
370 if (const auto *gccAsmStmt = dyn_cast<GCCAsmStmt>(this))
371 return gccAsmStmt->generateAsmString(C);
372 if (const auto *msAsmStmt = dyn_cast<MSAsmStmt>(this))
373 return msAsmStmt->generateAsmString(C);
374 llvm_unreachable("unknown asm statement kind!");
377 StringRef AsmStmt::getOutputConstraint(unsigned i) const {
378 if (const auto *gccAsmStmt = dyn_cast<GCCAsmStmt>(this))
379 return gccAsmStmt->getOutputConstraint(i);
380 if (const auto *msAsmStmt = dyn_cast<MSAsmStmt>(this))
381 return msAsmStmt->getOutputConstraint(i);
382 llvm_unreachable("unknown asm statement kind!");
385 const Expr *AsmStmt::getOutputExpr(unsigned i) const {
386 if (const auto *gccAsmStmt = dyn_cast<GCCAsmStmt>(this))
387 return gccAsmStmt->getOutputExpr(i);
388 if (const auto *msAsmStmt = dyn_cast<MSAsmStmt>(this))
389 return msAsmStmt->getOutputExpr(i);
390 llvm_unreachable("unknown asm statement kind!");
393 StringRef AsmStmt::getInputConstraint(unsigned i) const {
394 if (const auto *gccAsmStmt = dyn_cast<GCCAsmStmt>(this))
395 return gccAsmStmt->getInputConstraint(i);
396 if (const auto *msAsmStmt = dyn_cast<MSAsmStmt>(this))
397 return msAsmStmt->getInputConstraint(i);
398 llvm_unreachable("unknown asm statement kind!");
401 const Expr *AsmStmt::getInputExpr(unsigned i) const {
402 if (const auto *gccAsmStmt = dyn_cast<GCCAsmStmt>(this))
403 return gccAsmStmt->getInputExpr(i);
404 if (const auto *msAsmStmt = dyn_cast<MSAsmStmt>(this))
405 return msAsmStmt->getInputExpr(i);
406 llvm_unreachable("unknown asm statement kind!");
409 StringRef AsmStmt::getClobber(unsigned i) const {
410 if (const auto *gccAsmStmt = dyn_cast<GCCAsmStmt>(this))
411 return gccAsmStmt->getClobber(i);
412 if (const auto *msAsmStmt = dyn_cast<MSAsmStmt>(this))
413 return msAsmStmt->getClobber(i);
414 llvm_unreachable("unknown asm statement kind!");
417 /// getNumPlusOperands - Return the number of output operands that have a "+"
419 unsigned AsmStmt::getNumPlusOperands() const {
421 for (unsigned i = 0, e = getNumOutputs(); i != e; ++i)
422 if (isOutputPlusConstraint(i))
427 char GCCAsmStmt::AsmStringPiece::getModifier() const {
428 assert(isOperand() && "Only Operands can have modifiers.");
429 return isLetter(Str[0]) ? Str[0] : '\0';
432 StringRef GCCAsmStmt::getClobber(unsigned i) const {
433 return getClobberStringLiteral(i)->getString();
436 Expr *GCCAsmStmt::getOutputExpr(unsigned i) {
437 return cast<Expr>(Exprs[i]);
440 /// getOutputConstraint - Return the constraint string for the specified
441 /// output operand. All output constraints are known to be non-empty (either
443 StringRef GCCAsmStmt::getOutputConstraint(unsigned i) const {
444 return getOutputConstraintLiteral(i)->getString();
447 Expr *GCCAsmStmt::getInputExpr(unsigned i) {
448 return cast<Expr>(Exprs[i + NumOutputs]);
451 void GCCAsmStmt::setInputExpr(unsigned i, Expr *E) {
452 Exprs[i + NumOutputs] = E;
455 /// getInputConstraint - Return the specified input constraint. Unlike output
456 /// constraints, these can be empty.
457 StringRef GCCAsmStmt::getInputConstraint(unsigned i) const {
458 return getInputConstraintLiteral(i)->getString();
461 void GCCAsmStmt::setOutputsAndInputsAndClobbers(const ASTContext &C,
462 IdentifierInfo **Names,
463 StringLiteral **Constraints,
467 StringLiteral **Clobbers,
468 unsigned NumClobbers) {
469 this->NumOutputs = NumOutputs;
470 this->NumInputs = NumInputs;
471 this->NumClobbers = NumClobbers;
473 unsigned NumExprs = NumOutputs + NumInputs;
475 C.Deallocate(this->Names);
476 this->Names = new (C) IdentifierInfo*[NumExprs];
477 std::copy(Names, Names + NumExprs, this->Names);
479 C.Deallocate(this->Exprs);
480 this->Exprs = new (C) Stmt*[NumExprs];
481 std::copy(Exprs, Exprs + NumExprs, this->Exprs);
483 C.Deallocate(this->Constraints);
484 this->Constraints = new (C) StringLiteral*[NumExprs];
485 std::copy(Constraints, Constraints + NumExprs, this->Constraints);
487 C.Deallocate(this->Clobbers);
488 this->Clobbers = new (C) StringLiteral*[NumClobbers];
489 std::copy(Clobbers, Clobbers + NumClobbers, this->Clobbers);
492 /// getNamedOperand - Given a symbolic operand reference like %[foo],
493 /// translate this into a numeric value needed to reference the same operand.
494 /// This returns -1 if the operand name is invalid.
495 int GCCAsmStmt::getNamedOperand(StringRef SymbolicName) const {
496 unsigned NumPlusOperands = 0;
498 // Check if this is an output operand.
499 for (unsigned i = 0, e = getNumOutputs(); i != e; ++i) {
500 if (getOutputName(i) == SymbolicName)
504 for (unsigned i = 0, e = getNumInputs(); i != e; ++i)
505 if (getInputName(i) == SymbolicName)
506 return getNumOutputs() + NumPlusOperands + i;
512 /// AnalyzeAsmString - Analyze the asm string of the current asm, decomposing
513 /// it into pieces. If the asm string is erroneous, emit errors and return
514 /// true, otherwise return false.
515 unsigned GCCAsmStmt::AnalyzeAsmString(SmallVectorImpl<AsmStringPiece>&Pieces,
516 const ASTContext &C, unsigned &DiagOffs) const {
517 StringRef Str = getAsmString()->getString();
518 const char *StrStart = Str.begin();
519 const char *StrEnd = Str.end();
520 const char *CurPtr = StrStart;
522 // "Simple" inline asms have no constraints or operands, just convert the asm
523 // string to escape $'s.
526 for (; CurPtr != StrEnd; ++CurPtr) {
536 Pieces.push_back(AsmStringPiece(Result));
540 // CurStringPiece - The current string that we are building up as we scan the
542 std::string CurStringPiece;
544 bool HasVariants = !C.getTargetInfo().hasNoAsmVariants();
546 unsigned LastAsmStringToken = 0;
547 unsigned LastAsmStringOffset = 0;
550 // Done with the string?
551 if (CurPtr == StrEnd) {
552 if (!CurStringPiece.empty())
553 Pieces.push_back(AsmStringPiece(CurStringPiece));
557 char CurChar = *CurPtr++;
559 case '$': CurStringPiece += "$$"; continue;
560 case '{': CurStringPiece += (HasVariants ? "$(" : "{"); continue;
561 case '|': CurStringPiece += (HasVariants ? "$|" : "|"); continue;
562 case '}': CurStringPiece += (HasVariants ? "$)" : "}"); continue;
566 CurStringPiece += CurChar;
570 // Escaped "%" character in asm string.
571 if (CurPtr == StrEnd) {
572 // % at end of string is invalid (no escape).
573 DiagOffs = CurPtr-StrStart-1;
574 return diag::err_asm_invalid_escape;
576 // Handle escaped char and continue looping over the asm string.
577 char EscapedChar = *CurPtr++;
578 switch (EscapedChar) {
584 CurStringPiece += EscapedChar;
586 case '=': // %= -> Generate a unique ID.
587 CurStringPiece += "${:uid}";
591 // Otherwise, we have an operand. If we have accumulated a string so far,
592 // add it to the Pieces list.
593 if (!CurStringPiece.empty()) {
594 Pieces.push_back(AsmStringPiece(CurStringPiece));
595 CurStringPiece.clear();
598 // Handle operands that have asmSymbolicName (e.g., %x[foo]) and those that
599 // don't (e.g., %x4). 'x' following the '%' is the constraint modifier.
601 const char *Begin = CurPtr - 1; // Points to the character following '%'.
602 const char *Percent = Begin - 1; // Points to '%'.
604 if (isLetter(EscapedChar)) {
605 if (CurPtr == StrEnd) { // Premature end.
606 DiagOffs = CurPtr-StrStart-1;
607 return diag::err_asm_invalid_escape;
609 EscapedChar = *CurPtr++;
612 const TargetInfo &TI = C.getTargetInfo();
613 const SourceManager &SM = C.getSourceManager();
614 const LangOptions &LO = C.getLangOpts();
616 // Handle operands that don't have asmSymbolicName (e.g., %x4).
617 if (isDigit(EscapedChar)) {
618 // %n - Assembler operand n
622 while (CurPtr != StrEnd && isDigit(*CurPtr))
623 N = N*10 + ((*CurPtr++)-'0');
625 unsigned NumOperands =
626 getNumOutputs() + getNumPlusOperands() + getNumInputs();
627 if (N >= NumOperands) {
628 DiagOffs = CurPtr-StrStart-1;
629 return diag::err_asm_invalid_operand_number;
632 // Str contains "x4" (Operand without the leading %).
633 std::string Str(Begin, CurPtr - Begin);
635 // (BeginLoc, EndLoc) represents the range of the operand we are currently
636 // processing. Unlike Str, the range includes the leading '%'.
637 SourceLocation BeginLoc = getAsmString()->getLocationOfByte(
638 Percent - StrStart, SM, LO, TI, &LastAsmStringToken,
639 &LastAsmStringOffset);
640 SourceLocation EndLoc = getAsmString()->getLocationOfByte(
641 CurPtr - StrStart, SM, LO, TI, &LastAsmStringToken,
642 &LastAsmStringOffset);
644 Pieces.emplace_back(N, std::move(Str), BeginLoc, EndLoc);
648 // Handle operands that have asmSymbolicName (e.g., %x[foo]).
649 if (EscapedChar == '[') {
650 DiagOffs = CurPtr-StrStart-1;
653 const char *NameEnd = (const char*)memchr(CurPtr, ']', StrEnd-CurPtr);
654 if (NameEnd == nullptr)
655 return diag::err_asm_unterminated_symbolic_operand_name;
656 if (NameEnd == CurPtr)
657 return diag::err_asm_empty_symbolic_operand_name;
659 StringRef SymbolicName(CurPtr, NameEnd - CurPtr);
661 int N = getNamedOperand(SymbolicName);
663 // Verify that an operand with that name exists.
664 DiagOffs = CurPtr-StrStart;
665 return diag::err_asm_unknown_symbolic_operand_name;
668 // Str contains "x[foo]" (Operand without the leading %).
669 std::string Str(Begin, NameEnd + 1 - Begin);
671 // (BeginLoc, EndLoc) represents the range of the operand we are currently
672 // processing. Unlike Str, the range includes the leading '%'.
673 SourceLocation BeginLoc = getAsmString()->getLocationOfByte(
674 Percent - StrStart, SM, LO, TI, &LastAsmStringToken,
675 &LastAsmStringOffset);
676 SourceLocation EndLoc = getAsmString()->getLocationOfByte(
677 NameEnd + 1 - StrStart, SM, LO, TI, &LastAsmStringToken,
678 &LastAsmStringOffset);
680 Pieces.emplace_back(N, std::move(Str), BeginLoc, EndLoc);
686 DiagOffs = CurPtr-StrStart-1;
687 return diag::err_asm_invalid_escape;
691 /// Assemble final IR asm string (GCC-style).
692 std::string GCCAsmStmt::generateAsmString(const ASTContext &C) const {
693 // Analyze the asm string to decompose it into its pieces. We know that Sema
694 // has already done this, so it is guaranteed to be successful.
695 SmallVector<GCCAsmStmt::AsmStringPiece, 4> Pieces;
697 AnalyzeAsmString(Pieces, C, DiagOffs);
699 std::string AsmString;
700 for (const auto &Piece : Pieces) {
701 if (Piece.isString())
702 AsmString += Piece.getString();
703 else if (Piece.getModifier() == '\0')
704 AsmString += '$' + llvm::utostr(Piece.getOperandNo());
706 AsmString += "${" + llvm::utostr(Piece.getOperandNo()) + ':' +
707 Piece.getModifier() + '}';
712 /// Assemble final IR asm string (MS-style).
713 std::string MSAsmStmt::generateAsmString(const ASTContext &C) const {
714 // FIXME: This needs to be translated into the IR string representation.
718 Expr *MSAsmStmt::getOutputExpr(unsigned i) {
719 return cast<Expr>(Exprs[i]);
722 Expr *MSAsmStmt::getInputExpr(unsigned i) {
723 return cast<Expr>(Exprs[i + NumOutputs]);
726 void MSAsmStmt::setInputExpr(unsigned i, Expr *E) {
727 Exprs[i + NumOutputs] = E;
730 //===----------------------------------------------------------------------===//
732 //===----------------------------------------------------------------------===//
734 GCCAsmStmt::GCCAsmStmt(const ASTContext &C, SourceLocation asmloc,
735 bool issimple, bool isvolatile, unsigned numoutputs,
736 unsigned numinputs, IdentifierInfo **names,
737 StringLiteral **constraints, Expr **exprs,
738 StringLiteral *asmstr, unsigned numclobbers,
739 StringLiteral **clobbers, SourceLocation rparenloc)
740 : AsmStmt(GCCAsmStmtClass, asmloc, issimple, isvolatile, numoutputs,
741 numinputs, numclobbers), RParenLoc(rparenloc), AsmStr(asmstr) {
742 unsigned NumExprs = NumOutputs + NumInputs;
744 Names = new (C) IdentifierInfo*[NumExprs];
745 std::copy(names, names + NumExprs, Names);
747 Exprs = new (C) Stmt*[NumExprs];
748 std::copy(exprs, exprs + NumExprs, Exprs);
750 Constraints = new (C) StringLiteral*[NumExprs];
751 std::copy(constraints, constraints + NumExprs, Constraints);
753 Clobbers = new (C) StringLiteral*[NumClobbers];
754 std::copy(clobbers, clobbers + NumClobbers, Clobbers);
757 MSAsmStmt::MSAsmStmt(const ASTContext &C, SourceLocation asmloc,
758 SourceLocation lbraceloc, bool issimple, bool isvolatile,
759 ArrayRef<Token> asmtoks, unsigned numoutputs,
761 ArrayRef<StringRef> constraints, ArrayRef<Expr*> exprs,
762 StringRef asmstr, ArrayRef<StringRef> clobbers,
763 SourceLocation endloc)
764 : AsmStmt(MSAsmStmtClass, asmloc, issimple, isvolatile, numoutputs,
765 numinputs, clobbers.size()), LBraceLoc(lbraceloc),
766 EndLoc(endloc), NumAsmToks(asmtoks.size()) {
767 initialize(C, asmstr, asmtoks, constraints, exprs, clobbers);
770 static StringRef copyIntoContext(const ASTContext &C, StringRef str) {
774 void MSAsmStmt::initialize(const ASTContext &C, StringRef asmstr,
775 ArrayRef<Token> asmtoks,
776 ArrayRef<StringRef> constraints,
777 ArrayRef<Expr*> exprs,
778 ArrayRef<StringRef> clobbers) {
779 assert(NumAsmToks == asmtoks.size());
780 assert(NumClobbers == clobbers.size());
782 assert(exprs.size() == NumOutputs + NumInputs);
783 assert(exprs.size() == constraints.size());
785 AsmStr = copyIntoContext(C, asmstr);
787 Exprs = new (C) Stmt*[exprs.size()];
788 std::copy(exprs.begin(), exprs.end(), Exprs);
790 AsmToks = new (C) Token[asmtoks.size()];
791 std::copy(asmtoks.begin(), asmtoks.end(), AsmToks);
793 Constraints = new (C) StringRef[exprs.size()];
794 std::transform(constraints.begin(), constraints.end(), Constraints,
795 [&](StringRef Constraint) {
796 return copyIntoContext(C, Constraint);
799 Clobbers = new (C) StringRef[NumClobbers];
800 // FIXME: Avoid the allocation/copy if at all possible.
801 std::transform(clobbers.begin(), clobbers.end(), Clobbers,
802 [&](StringRef Clobber) {
803 return copyIntoContext(C, Clobber);
807 IfStmt::IfStmt(const ASTContext &Ctx, SourceLocation IL, bool IsConstexpr,
808 Stmt *Init, VarDecl *Var, Expr *Cond, Stmt *Then,
809 SourceLocation EL, Stmt *Else)
810 : Stmt(IfStmtClass) {
811 bool HasElse = Else != nullptr;
812 bool HasVar = Var != nullptr;
813 bool HasInit = Init != nullptr;
814 IfStmtBits.HasElse = HasElse;
815 IfStmtBits.HasVar = HasVar;
816 IfStmtBits.HasInit = HasInit;
818 setConstexpr(IsConstexpr);
825 setConditionVariable(Ctx, Var);
834 IfStmt::IfStmt(EmptyShell Empty, bool HasElse, bool HasVar, bool HasInit)
835 : Stmt(IfStmtClass, Empty) {
836 IfStmtBits.HasElse = HasElse;
837 IfStmtBits.HasVar = HasVar;
838 IfStmtBits.HasInit = HasInit;
841 IfStmt *IfStmt::Create(const ASTContext &Ctx, SourceLocation IL,
842 bool IsConstexpr, Stmt *Init, VarDecl *Var, Expr *Cond,
843 Stmt *Then, SourceLocation EL, Stmt *Else) {
844 bool HasElse = Else != nullptr;
845 bool HasVar = Var != nullptr;
846 bool HasInit = Init != nullptr;
847 void *Mem = Ctx.Allocate(
848 totalSizeToAlloc<Stmt *, SourceLocation>(
849 NumMandatoryStmtPtr + HasElse + HasVar + HasInit, HasElse),
852 IfStmt(Ctx, IL, IsConstexpr, Init, Var, Cond, Then, EL, Else);
855 IfStmt *IfStmt::CreateEmpty(const ASTContext &Ctx, bool HasElse, bool HasVar,
857 void *Mem = Ctx.Allocate(
858 totalSizeToAlloc<Stmt *, SourceLocation>(
859 NumMandatoryStmtPtr + HasElse + HasVar + HasInit, HasElse),
861 return new (Mem) IfStmt(EmptyShell(), HasElse, HasVar, HasInit);
864 VarDecl *IfStmt::getConditionVariable() {
865 auto *DS = getConditionVariableDeclStmt();
868 return cast<VarDecl>(DS->getSingleDecl());
871 void IfStmt::setConditionVariable(const ASTContext &Ctx, VarDecl *V) {
872 assert(hasVarStorage() &&
873 "This if statement has no storage for a condition variable!");
876 getTrailingObjects<Stmt *>()[varOffset()] = nullptr;
880 SourceRange VarRange = V->getSourceRange();
881 getTrailingObjects<Stmt *>()[varOffset()] = new (Ctx)
882 DeclStmt(DeclGroupRef(V), VarRange.getBegin(), VarRange.getEnd());
885 bool IfStmt::isObjCAvailabilityCheck() const {
886 return isa<ObjCAvailabilityCheckExpr>(getCond());
889 ForStmt::ForStmt(const ASTContext &C, Stmt *Init, Expr *Cond, VarDecl *condVar,
890 Expr *Inc, Stmt *Body, SourceLocation FL, SourceLocation LP,
892 : Stmt(ForStmtClass), LParenLoc(LP), RParenLoc(RP)
894 SubExprs[INIT] = Init;
895 setConditionVariable(C, condVar);
896 SubExprs[COND] = Cond;
898 SubExprs[BODY] = Body;
899 ForStmtBits.ForLoc = FL;
902 VarDecl *ForStmt::getConditionVariable() const {
903 if (!SubExprs[CONDVAR])
906 auto *DS = cast<DeclStmt>(SubExprs[CONDVAR]);
907 return cast<VarDecl>(DS->getSingleDecl());
910 void ForStmt::setConditionVariable(const ASTContext &C, VarDecl *V) {
912 SubExprs[CONDVAR] = nullptr;
916 SourceRange VarRange = V->getSourceRange();
917 SubExprs[CONDVAR] = new (C) DeclStmt(DeclGroupRef(V), VarRange.getBegin(),
921 SwitchStmt::SwitchStmt(const ASTContext &Ctx, Stmt *Init, VarDecl *Var,
923 : Stmt(SwitchStmtClass), FirstCase(nullptr) {
924 bool HasInit = Init != nullptr;
925 bool HasVar = Var != nullptr;
926 SwitchStmtBits.HasInit = HasInit;
927 SwitchStmtBits.HasVar = HasVar;
928 SwitchStmtBits.AllEnumCasesCovered = false;
935 setConditionVariable(Ctx, Var);
937 setSwitchLoc(SourceLocation{});
940 SwitchStmt::SwitchStmt(EmptyShell Empty, bool HasInit, bool HasVar)
941 : Stmt(SwitchStmtClass, Empty) {
942 SwitchStmtBits.HasInit = HasInit;
943 SwitchStmtBits.HasVar = HasVar;
944 SwitchStmtBits.AllEnumCasesCovered = false;
947 SwitchStmt *SwitchStmt::Create(const ASTContext &Ctx, Stmt *Init, VarDecl *Var,
949 bool HasInit = Init != nullptr;
950 bool HasVar = Var != nullptr;
951 void *Mem = Ctx.Allocate(
952 totalSizeToAlloc<Stmt *>(NumMandatoryStmtPtr + HasInit + HasVar),
953 alignof(SwitchStmt));
954 return new (Mem) SwitchStmt(Ctx, Init, Var, Cond);
957 SwitchStmt *SwitchStmt::CreateEmpty(const ASTContext &Ctx, bool HasInit,
959 void *Mem = Ctx.Allocate(
960 totalSizeToAlloc<Stmt *>(NumMandatoryStmtPtr + HasInit + HasVar),
961 alignof(SwitchStmt));
962 return new (Mem) SwitchStmt(EmptyShell(), HasInit, HasVar);
965 VarDecl *SwitchStmt::getConditionVariable() {
966 auto *DS = getConditionVariableDeclStmt();
969 return cast<VarDecl>(DS->getSingleDecl());
972 void SwitchStmt::setConditionVariable(const ASTContext &Ctx, VarDecl *V) {
973 assert(hasVarStorage() &&
974 "This switch statement has no storage for a condition variable!");
977 getTrailingObjects<Stmt *>()[varOffset()] = nullptr;
981 SourceRange VarRange = V->getSourceRange();
982 getTrailingObjects<Stmt *>()[varOffset()] = new (Ctx)
983 DeclStmt(DeclGroupRef(V), VarRange.getBegin(), VarRange.getEnd());
986 WhileStmt::WhileStmt(const ASTContext &Ctx, VarDecl *Var, Expr *Cond,
987 Stmt *Body, SourceLocation WL)
988 : Stmt(WhileStmtClass) {
989 bool HasVar = Var != nullptr;
990 WhileStmtBits.HasVar = HasVar;
995 setConditionVariable(Ctx, Var);
1000 WhileStmt::WhileStmt(EmptyShell Empty, bool HasVar)
1001 : Stmt(WhileStmtClass, Empty) {
1002 WhileStmtBits.HasVar = HasVar;
1005 WhileStmt *WhileStmt::Create(const ASTContext &Ctx, VarDecl *Var, Expr *Cond,
1006 Stmt *Body, SourceLocation WL) {
1007 bool HasVar = Var != nullptr;
1009 Ctx.Allocate(totalSizeToAlloc<Stmt *>(NumMandatoryStmtPtr + HasVar),
1010 alignof(WhileStmt));
1011 return new (Mem) WhileStmt(Ctx, Var, Cond, Body, WL);
1014 WhileStmt *WhileStmt::CreateEmpty(const ASTContext &Ctx, bool HasVar) {
1016 Ctx.Allocate(totalSizeToAlloc<Stmt *>(NumMandatoryStmtPtr + HasVar),
1017 alignof(WhileStmt));
1018 return new (Mem) WhileStmt(EmptyShell(), HasVar);
1021 VarDecl *WhileStmt::getConditionVariable() {
1022 auto *DS = getConditionVariableDeclStmt();
1025 return cast<VarDecl>(DS->getSingleDecl());
1028 void WhileStmt::setConditionVariable(const ASTContext &Ctx, VarDecl *V) {
1029 assert(hasVarStorage() &&
1030 "This while statement has no storage for a condition variable!");
1033 getTrailingObjects<Stmt *>()[varOffset()] = nullptr;
1037 SourceRange VarRange = V->getSourceRange();
1038 getTrailingObjects<Stmt *>()[varOffset()] = new (Ctx)
1039 DeclStmt(DeclGroupRef(V), VarRange.getBegin(), VarRange.getEnd());
1043 LabelDecl *IndirectGotoStmt::getConstantTarget() {
1044 if (auto *E = dyn_cast<AddrLabelExpr>(getTarget()->IgnoreParenImpCasts()))
1045 return E->getLabel();
1050 ReturnStmt::ReturnStmt(SourceLocation RL, Expr *E, const VarDecl *NRVOCandidate)
1051 : Stmt(ReturnStmtClass), RetExpr(E) {
1052 bool HasNRVOCandidate = NRVOCandidate != nullptr;
1053 ReturnStmtBits.HasNRVOCandidate = HasNRVOCandidate;
1054 if (HasNRVOCandidate)
1055 setNRVOCandidate(NRVOCandidate);
1059 ReturnStmt::ReturnStmt(EmptyShell Empty, bool HasNRVOCandidate)
1060 : Stmt(ReturnStmtClass, Empty) {
1061 ReturnStmtBits.HasNRVOCandidate = HasNRVOCandidate;
1064 ReturnStmt *ReturnStmt::Create(const ASTContext &Ctx, SourceLocation RL,
1065 Expr *E, const VarDecl *NRVOCandidate) {
1066 bool HasNRVOCandidate = NRVOCandidate != nullptr;
1067 void *Mem = Ctx.Allocate(totalSizeToAlloc<const VarDecl *>(HasNRVOCandidate),
1068 alignof(ReturnStmt));
1069 return new (Mem) ReturnStmt(RL, E, NRVOCandidate);
1072 ReturnStmt *ReturnStmt::CreateEmpty(const ASTContext &Ctx,
1073 bool HasNRVOCandidate) {
1074 void *Mem = Ctx.Allocate(totalSizeToAlloc<const VarDecl *>(HasNRVOCandidate),
1075 alignof(ReturnStmt));
1076 return new (Mem) ReturnStmt(EmptyShell(), HasNRVOCandidate);
1080 CaseStmt *CaseStmt::Create(const ASTContext &Ctx, Expr *lhs, Expr *rhs,
1081 SourceLocation caseLoc, SourceLocation ellipsisLoc,
1082 SourceLocation colonLoc) {
1083 bool CaseStmtIsGNURange = rhs != nullptr;
1084 void *Mem = Ctx.Allocate(
1085 totalSizeToAlloc<Stmt *, SourceLocation>(
1086 NumMandatoryStmtPtr + CaseStmtIsGNURange, CaseStmtIsGNURange),
1088 return new (Mem) CaseStmt(lhs, rhs, caseLoc, ellipsisLoc, colonLoc);
1091 CaseStmt *CaseStmt::CreateEmpty(const ASTContext &Ctx,
1092 bool CaseStmtIsGNURange) {
1093 void *Mem = Ctx.Allocate(
1094 totalSizeToAlloc<Stmt *, SourceLocation>(
1095 NumMandatoryStmtPtr + CaseStmtIsGNURange, CaseStmtIsGNURange),
1097 return new (Mem) CaseStmt(EmptyShell(), CaseStmtIsGNURange);
1100 SEHTryStmt::SEHTryStmt(bool IsCXXTry, SourceLocation TryLoc, Stmt *TryBlock,
1102 : Stmt(SEHTryStmtClass), IsCXXTry(IsCXXTry), TryLoc(TryLoc) {
1103 Children[TRY] = TryBlock;
1104 Children[HANDLER] = Handler;
1107 SEHTryStmt* SEHTryStmt::Create(const ASTContext &C, bool IsCXXTry,
1108 SourceLocation TryLoc, Stmt *TryBlock,
1110 return new(C) SEHTryStmt(IsCXXTry,TryLoc,TryBlock,Handler);
1113 SEHExceptStmt* SEHTryStmt::getExceptHandler() const {
1114 return dyn_cast<SEHExceptStmt>(getHandler());
1117 SEHFinallyStmt* SEHTryStmt::getFinallyHandler() const {
1118 return dyn_cast<SEHFinallyStmt>(getHandler());
1121 SEHExceptStmt::SEHExceptStmt(SourceLocation Loc, Expr *FilterExpr, Stmt *Block)
1122 : Stmt(SEHExceptStmtClass), Loc(Loc) {
1123 Children[FILTER_EXPR] = FilterExpr;
1124 Children[BLOCK] = Block;
1127 SEHExceptStmt* SEHExceptStmt::Create(const ASTContext &C, SourceLocation Loc,
1128 Expr *FilterExpr, Stmt *Block) {
1129 return new(C) SEHExceptStmt(Loc,FilterExpr,Block);
1132 SEHFinallyStmt::SEHFinallyStmt(SourceLocation Loc, Stmt *Block)
1133 : Stmt(SEHFinallyStmtClass), Loc(Loc), Block(Block) {}
1135 SEHFinallyStmt* SEHFinallyStmt::Create(const ASTContext &C, SourceLocation Loc,
1137 return new(C)SEHFinallyStmt(Loc,Block);
1140 CapturedStmt::Capture::Capture(SourceLocation Loc, VariableCaptureKind Kind,
1142 : VarAndKind(Var, Kind), Loc(Loc) {
1145 assert(!Var && "'this' capture cannot have a variable!");
1148 assert(Var && "capturing by reference must have a variable!");
1151 assert(Var && "capturing by copy must have a variable!");
1153 (Var->getType()->isScalarType() || (Var->getType()->isReferenceType() &&
1155 ->castAs<ReferenceType>()
1157 ->isScalarType())) &&
1158 "captures by copy are expected to have a scalar type!");
1162 "Variable-length array type capture cannot have a variable!");
1167 CapturedStmt::VariableCaptureKind
1168 CapturedStmt::Capture::getCaptureKind() const {
1169 return VarAndKind.getInt();
1172 VarDecl *CapturedStmt::Capture::getCapturedVar() const {
1173 assert((capturesVariable() || capturesVariableByCopy()) &&
1174 "No variable available for 'this' or VAT capture");
1175 return VarAndKind.getPointer();
1178 CapturedStmt::Capture *CapturedStmt::getStoredCaptures() const {
1179 unsigned Size = sizeof(CapturedStmt) + sizeof(Stmt *) * (NumCaptures + 1);
1181 // Offset of the first Capture object.
1182 unsigned FirstCaptureOffset = llvm::alignTo(Size, alignof(Capture));
1184 return reinterpret_cast<Capture *>(
1185 reinterpret_cast<char *>(const_cast<CapturedStmt *>(this))
1186 + FirstCaptureOffset);
1189 CapturedStmt::CapturedStmt(Stmt *S, CapturedRegionKind Kind,
1190 ArrayRef<Capture> Captures,
1191 ArrayRef<Expr *> CaptureInits,
1194 : Stmt(CapturedStmtClass), NumCaptures(Captures.size()),
1195 CapDeclAndKind(CD, Kind), TheRecordDecl(RD) {
1196 assert( S && "null captured statement");
1197 assert(CD && "null captured declaration for captured statement");
1198 assert(RD && "null record declaration for captured statement");
1200 // Copy initialization expressions.
1201 Stmt **Stored = getStoredStmts();
1202 for (unsigned I = 0, N = NumCaptures; I != N; ++I)
1203 *Stored++ = CaptureInits[I];
1205 // Copy the statement being captured.
1208 // Copy all Capture objects.
1209 Capture *Buffer = getStoredCaptures();
1210 std::copy(Captures.begin(), Captures.end(), Buffer);
1213 CapturedStmt::CapturedStmt(EmptyShell Empty, unsigned NumCaptures)
1214 : Stmt(CapturedStmtClass, Empty), NumCaptures(NumCaptures),
1215 CapDeclAndKind(nullptr, CR_Default) {
1216 getStoredStmts()[NumCaptures] = nullptr;
1219 CapturedStmt *CapturedStmt::Create(const ASTContext &Context, Stmt *S,
1220 CapturedRegionKind Kind,
1221 ArrayRef<Capture> Captures,
1222 ArrayRef<Expr *> CaptureInits,
1227 // -----------------------------------------------------------
1228 // | CapturedStmt, Init, ..., Init, S, Capture, ..., Capture |
1229 // ----------------^-------------------^----------------------
1230 // getStoredStmts() getStoredCaptures()
1232 // where S is the statement being captured.
1234 assert(CaptureInits.size() == Captures.size() && "wrong number of arguments");
1236 unsigned Size = sizeof(CapturedStmt) + sizeof(Stmt *) * (Captures.size() + 1);
1237 if (!Captures.empty()) {
1238 // Realign for the following Capture array.
1239 Size = llvm::alignTo(Size, alignof(Capture));
1240 Size += sizeof(Capture) * Captures.size();
1243 void *Mem = Context.Allocate(Size);
1244 return new (Mem) CapturedStmt(S, Kind, Captures, CaptureInits, CD, RD);
1247 CapturedStmt *CapturedStmt::CreateDeserialized(const ASTContext &Context,
1248 unsigned NumCaptures) {
1249 unsigned Size = sizeof(CapturedStmt) + sizeof(Stmt *) * (NumCaptures + 1);
1250 if (NumCaptures > 0) {
1251 // Realign for the following Capture array.
1252 Size = llvm::alignTo(Size, alignof(Capture));
1253 Size += sizeof(Capture) * NumCaptures;
1256 void *Mem = Context.Allocate(Size);
1257 return new (Mem) CapturedStmt(EmptyShell(), NumCaptures);
1260 Stmt::child_range CapturedStmt::children() {
1261 // Children are captured field initializers.
1262 return child_range(getStoredStmts(), getStoredStmts() + NumCaptures);
1265 CapturedDecl *CapturedStmt::getCapturedDecl() {
1266 return CapDeclAndKind.getPointer();
1269 const CapturedDecl *CapturedStmt::getCapturedDecl() const {
1270 return CapDeclAndKind.getPointer();
1273 /// Set the outlined function declaration.
1274 void CapturedStmt::setCapturedDecl(CapturedDecl *D) {
1275 assert(D && "null CapturedDecl");
1276 CapDeclAndKind.setPointer(D);
1279 /// Retrieve the captured region kind.
1280 CapturedRegionKind CapturedStmt::getCapturedRegionKind() const {
1281 return CapDeclAndKind.getInt();
1284 /// Set the captured region kind.
1285 void CapturedStmt::setCapturedRegionKind(CapturedRegionKind Kind) {
1286 CapDeclAndKind.setInt(Kind);
1289 bool CapturedStmt::capturesVariable(const VarDecl *Var) const {
1290 for (const auto &I : captures()) {
1291 if (!I.capturesVariable() && !I.capturesVariableByCopy())
1293 if (I.getCapturedVar()->getCanonicalDecl() == Var->getCanonicalDecl())