1 //===--- SemaChecking.cpp - Extra Semantic Checking -----------------------===//
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 extra semantic analysis beyond what is enforced
11 //  by the C type system.
12 //
13 //===----------------------------------------------------------------------===//
14 
15 #include "clang/Sema/SemaInternal.h"
16 #include "clang/AST/ASTContext.h"
17 #include "clang/AST/CharUnits.h"
18 #include "clang/AST/DeclCXX.h"
19 #include "clang/AST/DeclObjC.h"
20 #include "clang/AST/EvaluatedExprVisitor.h"
21 #include "clang/AST/Expr.h"
22 #include "clang/AST/ExprCXX.h"
23 #include "clang/AST/ExprObjC.h"
24 #include "clang/AST/StmtCXX.h"
25 #include "clang/AST/StmtObjC.h"
26 #include "clang/Analysis/Analyses/FormatString.h"
27 #include "clang/Basic/CharInfo.h"
28 #include "clang/Basic/TargetBuiltins.h"
29 #include "clang/Basic/TargetInfo.h"
30 #include "clang/Lex/Lexer.h" // TODO: Extract static functions to fix layering.
31 #include "clang/Sema/Initialization.h"
32 #include "clang/Sema/Lookup.h"
33 #include "clang/Sema/ScopeInfo.h"
34 #include "clang/Sema/Sema.h"
35 #include "llvm/ADT/STLExtras.h"
36 #include "llvm/ADT/SmallBitVector.h"
37 #include "llvm/ADT/SmallString.h"
38 #include "llvm/Support/ConvertUTF.h"
39 #include "llvm/Support/raw_ostream.h"
40 #include <limits>
41 using namespace clang;
42 using namespace sema;
43 
44 SourceLocation Sema::getLocationOfStringLiteralByte(const StringLiteral *SL,
45                                                     unsigned ByteNo) const {
46   return SL->getLocationOfByte(ByteNo, getSourceManager(), LangOpts,
47                                Context.getTargetInfo());
48 }
49 
50 /// Checks that a call expression's argument count is the desired number.
51 /// This is useful when doing custom type-checking.  Returns true on error.
52 static bool checkArgCount(Sema &S, CallExpr *call, unsigned desiredArgCount) {
53   unsigned argCount = call->getNumArgs();
54   if (argCount == desiredArgCount) return false;
55 
56   if (argCount < desiredArgCount)
57     return S.Diag(call->getLocEnd(), diag::err_typecheck_call_too_few_args)
58         << 0 /*function call*/ << desiredArgCount << argCount
59         << call->getSourceRange();
60 
61   // Highlight all the excess arguments.
62   SourceRange range(call->getArg(desiredArgCount)->getLocStart(),
63                     call->getArg(argCount - 1)->getLocEnd());
64 
65   return S.Diag(range.getBegin(), diag::err_typecheck_call_too_many_args)
66     << 0 /*function call*/ << desiredArgCount << argCount
67     << call->getArg(1)->getSourceRange();
68 }
69 
70 /// Check that the first argument to __builtin_annotation is an integer
71 /// and the second argument is a non-wide string literal.
72 static bool SemaBuiltinAnnotation(Sema &S, CallExpr *TheCall) {
73   if (checkArgCount(S, TheCall, 2))
74     return true;
75 
76   // First argument should be an integer.
77   Expr *ValArg = TheCall->getArg(0);
78   QualType Ty = ValArg->getType();
79   if (!Ty->isIntegerType()) {
80     S.Diag(ValArg->getLocStart(), diag::err_builtin_annotation_first_arg)
81       << ValArg->getSourceRange();
82     return true;
83   }
84 
85   // Second argument should be a constant string.
86   Expr *StrArg = TheCall->getArg(1)->IgnoreParenCasts();
87   StringLiteral *Literal = dyn_cast<StringLiteral>(StrArg);
88   if (!Literal || !Literal->isAscii()) {
89     S.Diag(StrArg->getLocStart(), diag::err_builtin_annotation_second_arg)
90       << StrArg->getSourceRange();
91     return true;
92   }
93 
94   TheCall->setType(Ty);
95   return false;
96 }
97 
98 /// Check that the argument to __builtin_addressof is a glvalue, and set the
99 /// result type to the corresponding pointer type.
100 static bool SemaBuiltinAddressof(Sema &S, CallExpr *TheCall) {
101   if (checkArgCount(S, TheCall, 1))
102     return true;
103 
104   ExprResult Arg(TheCall->getArg(0));
105   QualType ResultType = S.CheckAddressOfOperand(Arg, TheCall->getLocStart());
106   if (ResultType.isNull())
107     return true;
108 
109   TheCall->setArg(0, Arg.get());
110   TheCall->setType(ResultType);
111   return false;
112 }
113 
114 static void SemaBuiltinMemChkCall(Sema &S, FunctionDecl *FDecl,
115 		                  CallExpr *TheCall, unsigned SizeIdx,
116                                   unsigned DstSizeIdx) {
117   if (TheCall->getNumArgs() <= SizeIdx ||
118       TheCall->getNumArgs() <= DstSizeIdx)
119     return;
120 
121   const Expr *SizeArg = TheCall->getArg(SizeIdx);
122   const Expr *DstSizeArg = TheCall->getArg(DstSizeIdx);
123 
124   llvm::APSInt Size, DstSize;
125 
126   // find out if both sizes are known at compile time
127   if (!SizeArg->EvaluateAsInt(Size, S.Context) ||
128       !DstSizeArg->EvaluateAsInt(DstSize, S.Context))
129     return;
130 
131   if (Size.ule(DstSize))
132     return;
133 
134   // confirmed overflow so generate the diagnostic.
135   IdentifierInfo *FnName = FDecl->getIdentifier();
136   SourceLocation SL = TheCall->getLocStart();
137   SourceRange SR = TheCall->getSourceRange();
138 
139   S.Diag(SL, diag::warn_memcpy_chk_overflow) << SR << FnName;
140 }
141 
142 ExprResult
143 Sema::CheckBuiltinFunctionCall(FunctionDecl *FDecl, unsigned BuiltinID,
144                                CallExpr *TheCall) {
145   ExprResult TheCallResult(TheCall);
146 
147   // Find out if any arguments are required to be integer constant expressions.
148   unsigned ICEArguments = 0;
149   ASTContext::GetBuiltinTypeError Error;
150   Context.GetBuiltinType(BuiltinID, Error, &ICEArguments);
151   if (Error != ASTContext::GE_None)
152     ICEArguments = 0;  // Don't diagnose previously diagnosed errors.
153 
154   // If any arguments are required to be ICE's, check and diagnose.
155   for (unsigned ArgNo = 0; ICEArguments != 0; ++ArgNo) {
156     // Skip arguments not required to be ICE's.
157     if ((ICEArguments & (1 << ArgNo)) == 0) continue;
158 
159     llvm::APSInt Result;
160     if (SemaBuiltinConstantArg(TheCall, ArgNo, Result))
161       return true;
162     ICEArguments &= ~(1 << ArgNo);
163   }
164 
165   switch (BuiltinID) {
166   case Builtin::BI__builtin___CFStringMakeConstantString:
167     assert(TheCall->getNumArgs() == 1 &&
168            "Wrong # arguments to builtin CFStringMakeConstantString");
169     if (CheckObjCString(TheCall->getArg(0)))
170       return ExprError();
171     break;
172   case Builtin::BI__builtin_stdarg_start:
173   case Builtin::BI__builtin_va_start:
174     if (SemaBuiltinVAStart(TheCall))
175       return ExprError();
176     break;
177   case Builtin::BI__va_start: {
178     switch (Context.getTargetInfo().getTriple().getArch()) {
179     case llvm::Triple::arm:
180     case llvm::Triple::thumb:
181       if (SemaBuiltinVAStartARM(TheCall))
182         return ExprError();
183       break;
184     default:
185       if (SemaBuiltinVAStart(TheCall))
186         return ExprError();
187       break;
188     }
189     break;
190   }
191   case Builtin::BI__builtin_isgreater:
192   case Builtin::BI__builtin_isgreaterequal:
193   case Builtin::BI__builtin_isless:
194   case Builtin::BI__builtin_islessequal:
195   case Builtin::BI__builtin_islessgreater:
196   case Builtin::BI__builtin_isunordered:
197     if (SemaBuiltinUnorderedCompare(TheCall))
198       return ExprError();
199     break;
200   case Builtin::BI__builtin_fpclassify:
201     if (SemaBuiltinFPClassification(TheCall, 6))
202       return ExprError();
203     break;
204   case Builtin::BI__builtin_isfinite:
205   case Builtin::BI__builtin_isinf:
206   case Builtin::BI__builtin_isinf_sign:
207   case Builtin::BI__builtin_isnan:
208   case Builtin::BI__builtin_isnormal:
209     if (SemaBuiltinFPClassification(TheCall, 1))
210       return ExprError();
211     break;
212   case Builtin::BI__builtin_shufflevector:
213     return SemaBuiltinShuffleVector(TheCall);
214     // TheCall will be freed by the smart pointer here, but that's fine, since
215     // SemaBuiltinShuffleVector guts it, but then doesn't release it.
216   case Builtin::BI__builtin_prefetch:
217     if (SemaBuiltinPrefetch(TheCall))
218       return ExprError();
219     break;
220   case Builtin::BI__assume:
221   case Builtin::BI__builtin_assume:
222     if (SemaBuiltinAssume(TheCall))
223       return ExprError();
224     break;
225   case Builtin::BI__builtin_assume_aligned:
226     if (SemaBuiltinAssumeAligned(TheCall))
227       return ExprError();
228     break;
229   case Builtin::BI__builtin_object_size:
230     if (SemaBuiltinConstantArgRange(TheCall, 1, 0, 3))
231       return ExprError();
232     break;
233   case Builtin::BI__builtin_longjmp:
234     if (SemaBuiltinLongjmp(TheCall))
235       return ExprError();
236     break;
237 
238   case Builtin::BI__builtin_classify_type:
239     if (checkArgCount(*this, TheCall, 1)) return true;
240     TheCall->setType(Context.IntTy);
241     break;
242   case Builtin::BI__builtin_constant_p:
243     if (checkArgCount(*this, TheCall, 1)) return true;
244     TheCall->setType(Context.IntTy);
245     break;
246   case Builtin::BI__sync_fetch_and_add:
247   case Builtin::BI__sync_fetch_and_add_1:
248   case Builtin::BI__sync_fetch_and_add_2:
249   case Builtin::BI__sync_fetch_and_add_4:
250   case Builtin::BI__sync_fetch_and_add_8:
251   case Builtin::BI__sync_fetch_and_add_16:
252   case Builtin::BI__sync_fetch_and_sub:
253   case Builtin::BI__sync_fetch_and_sub_1:
254   case Builtin::BI__sync_fetch_and_sub_2:
255   case Builtin::BI__sync_fetch_and_sub_4:
256   case Builtin::BI__sync_fetch_and_sub_8:
257   case Builtin::BI__sync_fetch_and_sub_16:
258   case Builtin::BI__sync_fetch_and_or:
259   case Builtin::BI__sync_fetch_and_or_1:
260   case Builtin::BI__sync_fetch_and_or_2:
261   case Builtin::BI__sync_fetch_and_or_4:
262   case Builtin::BI__sync_fetch_and_or_8:
263   case Builtin::BI__sync_fetch_and_or_16:
264   case Builtin::BI__sync_fetch_and_and:
265   case Builtin::BI__sync_fetch_and_and_1:
266   case Builtin::BI__sync_fetch_and_and_2:
267   case Builtin::BI__sync_fetch_and_and_4:
268   case Builtin::BI__sync_fetch_and_and_8:
269   case Builtin::BI__sync_fetch_and_and_16:
270   case Builtin::BI__sync_fetch_and_xor:
271   case Builtin::BI__sync_fetch_and_xor_1:
272   case Builtin::BI__sync_fetch_and_xor_2:
273   case Builtin::BI__sync_fetch_and_xor_4:
274   case Builtin::BI__sync_fetch_and_xor_8:
275   case Builtin::BI__sync_fetch_and_xor_16:
276   case Builtin::BI__sync_fetch_and_nand:
277   case Builtin::BI__sync_fetch_and_nand_1:
278   case Builtin::BI__sync_fetch_and_nand_2:
279   case Builtin::BI__sync_fetch_and_nand_4:
280   case Builtin::BI__sync_fetch_and_nand_8:
281   case Builtin::BI__sync_fetch_and_nand_16:
282   case Builtin::BI__sync_add_and_fetch:
283   case Builtin::BI__sync_add_and_fetch_1:
284   case Builtin::BI__sync_add_and_fetch_2:
285   case Builtin::BI__sync_add_and_fetch_4:
286   case Builtin::BI__sync_add_and_fetch_8:
287   case Builtin::BI__sync_add_and_fetch_16:
288   case Builtin::BI__sync_sub_and_fetch:
289   case Builtin::BI__sync_sub_and_fetch_1:
290   case Builtin::BI__sync_sub_and_fetch_2:
291   case Builtin::BI__sync_sub_and_fetch_4:
292   case Builtin::BI__sync_sub_and_fetch_8:
293   case Builtin::BI__sync_sub_and_fetch_16:
294   case Builtin::BI__sync_and_and_fetch:
295   case Builtin::BI__sync_and_and_fetch_1:
296   case Builtin::BI__sync_and_and_fetch_2:
297   case Builtin::BI__sync_and_and_fetch_4:
298   case Builtin::BI__sync_and_and_fetch_8:
299   case Builtin::BI__sync_and_and_fetch_16:
300   case Builtin::BI__sync_or_and_fetch:
301   case Builtin::BI__sync_or_and_fetch_1:
302   case Builtin::BI__sync_or_and_fetch_2:
303   case Builtin::BI__sync_or_and_fetch_4:
304   case Builtin::BI__sync_or_and_fetch_8:
305   case Builtin::BI__sync_or_and_fetch_16:
306   case Builtin::BI__sync_xor_and_fetch:
307   case Builtin::BI__sync_xor_and_fetch_1:
308   case Builtin::BI__sync_xor_and_fetch_2:
309   case Builtin::BI__sync_xor_and_fetch_4:
310   case Builtin::BI__sync_xor_and_fetch_8:
311   case Builtin::BI__sync_xor_and_fetch_16:
312   case Builtin::BI__sync_nand_and_fetch:
313   case Builtin::BI__sync_nand_and_fetch_1:
314   case Builtin::BI__sync_nand_and_fetch_2:
315   case Builtin::BI__sync_nand_and_fetch_4:
316   case Builtin::BI__sync_nand_and_fetch_8:
317   case Builtin::BI__sync_nand_and_fetch_16:
318   case Builtin::BI__sync_val_compare_and_swap:
319   case Builtin::BI__sync_val_compare_and_swap_1:
320   case Builtin::BI__sync_val_compare_and_swap_2:
321   case Builtin::BI__sync_val_compare_and_swap_4:
322   case Builtin::BI__sync_val_compare_and_swap_8:
323   case Builtin::BI__sync_val_compare_and_swap_16:
324   case Builtin::BI__sync_bool_compare_and_swap:
325   case Builtin::BI__sync_bool_compare_and_swap_1:
326   case Builtin::BI__sync_bool_compare_and_swap_2:
327   case Builtin::BI__sync_bool_compare_and_swap_4:
328   case Builtin::BI__sync_bool_compare_and_swap_8:
329   case Builtin::BI__sync_bool_compare_and_swap_16:
330   case Builtin::BI__sync_lock_test_and_set:
331   case Builtin::BI__sync_lock_test_and_set_1:
332   case Builtin::BI__sync_lock_test_and_set_2:
333   case Builtin::BI__sync_lock_test_and_set_4:
334   case Builtin::BI__sync_lock_test_and_set_8:
335   case Builtin::BI__sync_lock_test_and_set_16:
336   case Builtin::BI__sync_lock_release:
337   case Builtin::BI__sync_lock_release_1:
338   case Builtin::BI__sync_lock_release_2:
339   case Builtin::BI__sync_lock_release_4:
340   case Builtin::BI__sync_lock_release_8:
341   case Builtin::BI__sync_lock_release_16:
342   case Builtin::BI__sync_swap:
343   case Builtin::BI__sync_swap_1:
344   case Builtin::BI__sync_swap_2:
345   case Builtin::BI__sync_swap_4:
346   case Builtin::BI__sync_swap_8:
347   case Builtin::BI__sync_swap_16:
348     return SemaBuiltinAtomicOverloaded(TheCallResult);
349 #define BUILTIN(ID, TYPE, ATTRS)
350 #define ATOMIC_BUILTIN(ID, TYPE, ATTRS) \
351   case Builtin::BI##ID: \
352     return SemaAtomicOpsOverloaded(TheCallResult, AtomicExpr::AO##ID);
353 #include "clang/Basic/Builtins.def"
354   case Builtin::BI__builtin_annotation:
355     if (SemaBuiltinAnnotation(*this, TheCall))
356       return ExprError();
357     break;
358   case Builtin::BI__builtin_addressof:
359     if (SemaBuiltinAddressof(*this, TheCall))
360       return ExprError();
361     break;
362   case Builtin::BI__builtin_operator_new:
363   case Builtin::BI__builtin_operator_delete:
364     if (!getLangOpts().CPlusPlus) {
365       Diag(TheCall->getExprLoc(), diag::err_builtin_requires_language)
366         << (BuiltinID == Builtin::BI__builtin_operator_new
367                 ? "__builtin_operator_new"
368                 : "__builtin_operator_delete")
369         << "C++";
370       return ExprError();
371     }
372     // CodeGen assumes it can find the global new and delete to call,
373     // so ensure that they are declared.
374     DeclareGlobalNewDelete();
375     break;
376 
377   // check secure string manipulation functions where overflows
378   // are detectable at compile time
379   case Builtin::BI__builtin___memcpy_chk:
380   case Builtin::BI__builtin___memmove_chk:
381   case Builtin::BI__builtin___memset_chk:
382   case Builtin::BI__builtin___strlcat_chk:
383   case Builtin::BI__builtin___strlcpy_chk:
384   case Builtin::BI__builtin___strncat_chk:
385   case Builtin::BI__builtin___strncpy_chk:
386   case Builtin::BI__builtin___stpncpy_chk:
387     SemaBuiltinMemChkCall(*this, FDecl, TheCall, 2, 3);
388     break;
389   case Builtin::BI__builtin___memccpy_chk:
390     SemaBuiltinMemChkCall(*this, FDecl, TheCall, 3, 4);
391     break;
392   case Builtin::BI__builtin___snprintf_chk:
393   case Builtin::BI__builtin___vsnprintf_chk:
394     SemaBuiltinMemChkCall(*this, FDecl, TheCall, 1, 3);
395     break;
396   }
397 
398   // Since the target specific builtins for each arch overlap, only check those
399   // of the arch we are compiling for.
400   if (BuiltinID >= Builtin::FirstTSBuiltin) {
401     switch (Context.getTargetInfo().getTriple().getArch()) {
402       case llvm::Triple::arm:
403       case llvm::Triple::armeb:
404       case llvm::Triple::thumb:
405       case llvm::Triple::thumbeb:
406         if (CheckARMBuiltinFunctionCall(BuiltinID, TheCall))
407           return ExprError();
408         break;
409       case llvm::Triple::aarch64:
410       case llvm::Triple::aarch64_be:
411         if (CheckAArch64BuiltinFunctionCall(BuiltinID, TheCall))
412           return ExprError();
413         break;
414       case llvm::Triple::mips:
415       case llvm::Triple::mipsel:
416       case llvm::Triple::mips64:
417       case llvm::Triple::mips64el:
418         if (CheckMipsBuiltinFunctionCall(BuiltinID, TheCall))
419           return ExprError();
420         break;
421       case llvm::Triple::x86:
422       case llvm::Triple::x86_64:
423         if (CheckX86BuiltinFunctionCall(BuiltinID, TheCall))
424           return ExprError();
425         break;
426       default:
427         break;
428     }
429   }
430 
431   return TheCallResult;
432 }
433 
434 // Get the valid immediate range for the specified NEON type code.
435 static unsigned RFT(unsigned t, bool shift = false, bool ForceQuad = false) {
436   NeonTypeFlags Type(t);
437   int IsQuad = ForceQuad ? true : Type.isQuad();
438   switch (Type.getEltType()) {
439   case NeonTypeFlags::Int8:
440   case NeonTypeFlags::Poly8:
441     return shift ? 7 : (8 << IsQuad) - 1;
442   case NeonTypeFlags::Int16:
443   case NeonTypeFlags::Poly16:
444     return shift ? 15 : (4 << IsQuad) - 1;
445   case NeonTypeFlags::Int32:
446     return shift ? 31 : (2 << IsQuad) - 1;
447   case NeonTypeFlags::Int64:
448   case NeonTypeFlags::Poly64:
449     return shift ? 63 : (1 << IsQuad) - 1;
450   case NeonTypeFlags::Poly128:
451     return shift ? 127 : (1 << IsQuad) - 1;
452   case NeonTypeFlags::Float16:
453     assert(!shift && "cannot shift float types!");
454     return (4 << IsQuad) - 1;
455   case NeonTypeFlags::Float32:
456     assert(!shift && "cannot shift float types!");
457     return (2 << IsQuad) - 1;
458   case NeonTypeFlags::Float64:
459     assert(!shift && "cannot shift float types!");
460     return (1 << IsQuad) - 1;
461   }
462   llvm_unreachable("Invalid NeonTypeFlag!");
463 }
464 
465 /// getNeonEltType - Return the QualType corresponding to the elements of
466 /// the vector type specified by the NeonTypeFlags.  This is used to check
467 /// the pointer arguments for Neon load/store intrinsics.
468 static QualType getNeonEltType(NeonTypeFlags Flags, ASTContext &Context,
469                                bool IsPolyUnsigned, bool IsInt64Long) {
470   switch (Flags.getEltType()) {
471   case NeonTypeFlags::Int8:
472     return Flags.isUnsigned() ? Context.UnsignedCharTy : Context.SignedCharTy;
473   case NeonTypeFlags::Int16:
474     return Flags.isUnsigned() ? Context.UnsignedShortTy : Context.ShortTy;
475   case NeonTypeFlags::Int32:
476     return Flags.isUnsigned() ? Context.UnsignedIntTy : Context.IntTy;
477   case NeonTypeFlags::Int64:
478     if (IsInt64Long)
479       return Flags.isUnsigned() ? Context.UnsignedLongTy : Context.LongTy;
480     else
481       return Flags.isUnsigned() ? Context.UnsignedLongLongTy
482                                 : Context.LongLongTy;
483   case NeonTypeFlags::Poly8:
484     return IsPolyUnsigned ? Context.UnsignedCharTy : Context.SignedCharTy;
485   case NeonTypeFlags::Poly16:
486     return IsPolyUnsigned ? Context.UnsignedShortTy : Context.ShortTy;
487   case NeonTypeFlags::Poly64:
488     return Context.UnsignedLongTy;
489   case NeonTypeFlags::Poly128:
490     break;
491   case NeonTypeFlags::Float16:
492     return Context.HalfTy;
493   case NeonTypeFlags::Float32:
494     return Context.FloatTy;
495   case NeonTypeFlags::Float64:
496     return Context.DoubleTy;
497   }
498   llvm_unreachable("Invalid NeonTypeFlag!");
499 }
500 
501 bool Sema::CheckNeonBuiltinFunctionCall(unsigned BuiltinID, CallExpr *TheCall) {
502   llvm::APSInt Result;
503   uint64_t mask = 0;
504   unsigned TV = 0;
505   int PtrArgNum = -1;
506   bool HasConstPtr = false;
507   switch (BuiltinID) {
508 #define GET_NEON_OVERLOAD_CHECK
509 #include "clang/Basic/arm_neon.inc"
510 #undef GET_NEON_OVERLOAD_CHECK
511   }
512 
513   // For NEON intrinsics which are overloaded on vector element type, validate
514   // the immediate which specifies which variant to emit.
515   unsigned ImmArg = TheCall->getNumArgs()-1;
516   if (mask) {
517     if (SemaBuiltinConstantArg(TheCall, ImmArg, Result))
518       return true;
519 
520     TV = Result.getLimitedValue(64);
521     if ((TV > 63) || (mask & (1ULL << TV)) == 0)
522       return Diag(TheCall->getLocStart(), diag::err_invalid_neon_type_code)
523         << TheCall->getArg(ImmArg)->getSourceRange();
524   }
525 
526   if (PtrArgNum >= 0) {
527     // Check that pointer arguments have the specified type.
528     Expr *Arg = TheCall->getArg(PtrArgNum);
529     if (ImplicitCastExpr *ICE = dyn_cast<ImplicitCastExpr>(Arg))
530       Arg = ICE->getSubExpr();
531     ExprResult RHS = DefaultFunctionArrayLvalueConversion(Arg);
532     QualType RHSTy = RHS.get()->getType();
533 
534     llvm::Triple::ArchType Arch = Context.getTargetInfo().getTriple().getArch();
535     bool IsPolyUnsigned = Arch == llvm::Triple::aarch64;
536     bool IsInt64Long =
537         Context.getTargetInfo().getInt64Type() == TargetInfo::SignedLong;
538     QualType EltTy =
539         getNeonEltType(NeonTypeFlags(TV), Context, IsPolyUnsigned, IsInt64Long);
540     if (HasConstPtr)
541       EltTy = EltTy.withConst();
542     QualType LHSTy = Context.getPointerType(EltTy);
543     AssignConvertType ConvTy;
544     ConvTy = CheckSingleAssignmentConstraints(LHSTy, RHS);
545     if (RHS.isInvalid())
546       return true;
547     if (DiagnoseAssignmentResult(ConvTy, Arg->getLocStart(), LHSTy, RHSTy,
548                                  RHS.get(), AA_Assigning))
549       return true;
550   }
551 
552   // For NEON intrinsics which take an immediate value as part of the
553   // instruction, range check them here.
554   unsigned i = 0, l = 0, u = 0;
555   switch (BuiltinID) {
556   default:
557     return false;
558 #define GET_NEON_IMMEDIATE_CHECK
559 #include "clang/Basic/arm_neon.inc"
560 #undef GET_NEON_IMMEDIATE_CHECK
561   }
562 
563   return SemaBuiltinConstantArgRange(TheCall, i, l, u + l);
564 }
565 
566 bool Sema::CheckARMBuiltinExclusiveCall(unsigned BuiltinID, CallExpr *TheCall,
567                                         unsigned MaxWidth) {
568   assert((BuiltinID == ARM::BI__builtin_arm_ldrex ||
569           BuiltinID == ARM::BI__builtin_arm_ldaex ||
570           BuiltinID == ARM::BI__builtin_arm_strex ||
571           BuiltinID == ARM::BI__builtin_arm_stlex ||
572           BuiltinID == AArch64::BI__builtin_arm_ldrex ||
573           BuiltinID == AArch64::BI__builtin_arm_ldaex ||
574           BuiltinID == AArch64::BI__builtin_arm_strex ||
575           BuiltinID == AArch64::BI__builtin_arm_stlex) &&
576          "unexpected ARM builtin");
577   bool IsLdrex = BuiltinID == ARM::BI__builtin_arm_ldrex ||
578                  BuiltinID == ARM::BI__builtin_arm_ldaex ||
579                  BuiltinID == AArch64::BI__builtin_arm_ldrex ||
580                  BuiltinID == AArch64::BI__builtin_arm_ldaex;
581 
582   DeclRefExpr *DRE =cast<DeclRefExpr>(TheCall->getCallee()->IgnoreParenCasts());
583 
584   // Ensure that we have the proper number of arguments.
585   if (checkArgCount(*this, TheCall, IsLdrex ? 1 : 2))
586     return true;
587 
588   // Inspect the pointer argument of the atomic builtin.  This should always be
589   // a pointer type, whose element is an integral scalar or pointer type.
590   // Because it is a pointer type, we don't have to worry about any implicit
591   // casts here.
592   Expr *PointerArg = TheCall->getArg(IsLdrex ? 0 : 1);
593   ExprResult PointerArgRes = DefaultFunctionArrayLvalueConversion(PointerArg);
594   if (PointerArgRes.isInvalid())
595     return true;
596   PointerArg = PointerArgRes.get();
597 
598   const PointerType *pointerType = PointerArg->getType()->getAs<PointerType>();
599   if (!pointerType) {
600     Diag(DRE->getLocStart(), diag::err_atomic_builtin_must_be_pointer)
601       << PointerArg->getType() << PointerArg->getSourceRange();
602     return true;
603   }
604 
605   // ldrex takes a "const volatile T*" and strex takes a "volatile T*". Our next
606   // task is to insert the appropriate casts into the AST. First work out just
607   // what the appropriate type is.
608   QualType ValType = pointerType->getPointeeType();
609   QualType AddrType = ValType.getUnqualifiedType().withVolatile();
610   if (IsLdrex)
611     AddrType.addConst();
612 
613   // Issue a warning if the cast is dodgy.
614   CastKind CastNeeded = CK_NoOp;
615   if (!AddrType.isAtLeastAsQualifiedAs(ValType)) {
616     CastNeeded = CK_BitCast;
617     Diag(DRE->getLocStart(), diag::ext_typecheck_convert_discards_qualifiers)
618       << PointerArg->getType()
619       << Context.getPointerType(AddrType)
620       << AA_Passing << PointerArg->getSourceRange();
621   }
622 
623   // Finally, do the cast and replace the argument with the corrected version.
624   AddrType = Context.getPointerType(AddrType);
625   PointerArgRes = ImpCastExprToType(PointerArg, AddrType, CastNeeded);
626   if (PointerArgRes.isInvalid())
627     return true;
628   PointerArg = PointerArgRes.get();
629 
630   TheCall->setArg(IsLdrex ? 0 : 1, PointerArg);
631 
632   // In general, we allow ints, floats and pointers to be loaded and stored.
633   if (!ValType->isIntegerType() && !ValType->isAnyPointerType() &&
634       !ValType->isBlockPointerType() && !ValType->isFloatingType()) {
635     Diag(DRE->getLocStart(), diag::err_atomic_builtin_must_be_pointer_intfltptr)
636       << PointerArg->getType() << PointerArg->getSourceRange();
637     return true;
638   }
639 
640   // But ARM doesn't have instructions to deal with 128-bit versions.
641   if (Context.getTypeSize(ValType) > MaxWidth) {
642     assert(MaxWidth == 64 && "Diagnostic unexpectedly inaccurate");
643     Diag(DRE->getLocStart(), diag::err_atomic_exclusive_builtin_pointer_size)
644       << PointerArg->getType() << PointerArg->getSourceRange();
645     return true;
646   }
647 
648   switch (ValType.getObjCLifetime()) {
649   case Qualifiers::OCL_None:
650   case Qualifiers::OCL_ExplicitNone:
651     // okay
652     break;
653 
654   case Qualifiers::OCL_Weak:
655   case Qualifiers::OCL_Strong:
656   case Qualifiers::OCL_Autoreleasing:
657     Diag(DRE->getLocStart(), diag::err_arc_atomic_ownership)
658       << ValType << PointerArg->getSourceRange();
659     return true;
660   }
661 
662 
663   if (IsLdrex) {
664     TheCall->setType(ValType);
665     return false;
666   }
667 
668   // Initialize the argument to be stored.
669   ExprResult ValArg = TheCall->getArg(0);
670   InitializedEntity Entity = InitializedEntity::InitializeParameter(
671       Context, ValType, /*consume*/ false);
672   ValArg = PerformCopyInitialization(Entity, SourceLocation(), ValArg);
673   if (ValArg.isInvalid())
674     return true;
675   TheCall->setArg(0, ValArg.get());
676 
677   // __builtin_arm_strex always returns an int. It's marked as such in the .def,
678   // but the custom checker bypasses all default analysis.
679   TheCall->setType(Context.IntTy);
680   return false;
681 }
682 
683 bool Sema::CheckARMBuiltinFunctionCall(unsigned BuiltinID, CallExpr *TheCall) {
684   llvm::APSInt Result;
685 
686   if (BuiltinID == ARM::BI__builtin_arm_ldrex ||
687       BuiltinID == ARM::BI__builtin_arm_ldaex ||
688       BuiltinID == ARM::BI__builtin_arm_strex ||
689       BuiltinID == ARM::BI__builtin_arm_stlex) {
690     return CheckARMBuiltinExclusiveCall(BuiltinID, TheCall, 64);
691   }
692 
693   if (BuiltinID == ARM::BI__builtin_arm_prefetch) {
694     return SemaBuiltinConstantArgRange(TheCall, 1, 0, 1) ||
695       SemaBuiltinConstantArgRange(TheCall, 2, 0, 1);
696   }
697 
698   if (CheckNeonBuiltinFunctionCall(BuiltinID, TheCall))
699     return true;
700 
701   // For intrinsics which take an immediate value as part of the instruction,
702   // range check them here.
703   unsigned i = 0, l = 0, u = 0;
704   switch (BuiltinID) {
705   default: return false;
706   case ARM::BI__builtin_arm_ssat: i = 1; l = 1; u = 31; break;
707   case ARM::BI__builtin_arm_usat: i = 1; u = 31; break;
708   case ARM::BI__builtin_arm_vcvtr_f:
709   case ARM::BI__builtin_arm_vcvtr_d: i = 1; u = 1; break;
710   case ARM::BI__builtin_arm_dmb:
711   case ARM::BI__builtin_arm_dsb:
712   case ARM::BI__builtin_arm_isb:
713   case ARM::BI__builtin_arm_dbg: l = 0; u = 15; break;
714   }
715 
716   // FIXME: VFP Intrinsics should error if VFP not present.
717   return SemaBuiltinConstantArgRange(TheCall, i, l, u + l);
718 }
719 
720 bool Sema::CheckAArch64BuiltinFunctionCall(unsigned BuiltinID,
721                                          CallExpr *TheCall) {
722   llvm::APSInt Result;
723 
724   if (BuiltinID == AArch64::BI__builtin_arm_ldrex ||
725       BuiltinID == AArch64::BI__builtin_arm_ldaex ||
726       BuiltinID == AArch64::BI__builtin_arm_strex ||
727       BuiltinID == AArch64::BI__builtin_arm_stlex) {
728     return CheckARMBuiltinExclusiveCall(BuiltinID, TheCall, 128);
729   }
730 
731   if (BuiltinID == AArch64::BI__builtin_arm_prefetch) {
732     return SemaBuiltinConstantArgRange(TheCall, 1, 0, 1) ||
733       SemaBuiltinConstantArgRange(TheCall, 2, 0, 2) ||
734       SemaBuiltinConstantArgRange(TheCall, 3, 0, 1) ||
735       SemaBuiltinConstantArgRange(TheCall, 4, 0, 1);
736   }
737 
738   if (CheckNeonBuiltinFunctionCall(BuiltinID, TheCall))
739     return true;
740 
741   // For intrinsics which take an immediate value as part of the instruction,
742   // range check them here.
743   unsigned i = 0, l = 0, u = 0;
744   switch (BuiltinID) {
745   default: return false;
746   case AArch64::BI__builtin_arm_dmb:
747   case AArch64::BI__builtin_arm_dsb:
748   case AArch64::BI__builtin_arm_isb: l = 0; u = 15; break;
749   }
750 
751   return SemaBuiltinConstantArgRange(TheCall, i, l, u + l);
752 }
753 
754 bool Sema::CheckMipsBuiltinFunctionCall(unsigned BuiltinID, CallExpr *TheCall) {
755   unsigned i = 0, l = 0, u = 0;
756   switch (BuiltinID) {
757   default: return false;
758   case Mips::BI__builtin_mips_wrdsp: i = 1; l = 0; u = 63; break;
759   case Mips::BI__builtin_mips_rddsp: i = 0; l = 0; u = 63; break;
760   case Mips::BI__builtin_mips_append: i = 2; l = 0; u = 31; break;
761   case Mips::BI__builtin_mips_balign: i = 2; l = 0; u = 3; break;
762   case Mips::BI__builtin_mips_precr_sra_ph_w: i = 2; l = 0; u = 31; break;
763   case Mips::BI__builtin_mips_precr_sra_r_ph_w: i = 2; l = 0; u = 31; break;
764   case Mips::BI__builtin_mips_prepend: i = 2; l = 0; u = 31; break;
765   }
766 
767   return SemaBuiltinConstantArgRange(TheCall, i, l, u);
768 }
769 
770 bool Sema::CheckX86BuiltinFunctionCall(unsigned BuiltinID, CallExpr *TheCall) {
771   switch (BuiltinID) {
772   case X86::BI_mm_prefetch:
773     // This is declared to take (const char*, int)
774     return SemaBuiltinConstantArgRange(TheCall, 1, 0, 3);
775   }
776   return false;
777 }
778 
779 /// Given a FunctionDecl's FormatAttr, attempts to populate the FomatStringInfo
780 /// parameter with the FormatAttr's correct format_idx and firstDataArg.
781 /// Returns true when the format fits the function and the FormatStringInfo has
782 /// been populated.
783 bool Sema::getFormatStringInfo(const FormatAttr *Format, bool IsCXXMember,
784                                FormatStringInfo *FSI) {
785   FSI->HasVAListArg = Format->getFirstArg() == 0;
786   FSI->FormatIdx = Format->getFormatIdx() - 1;
787   FSI->FirstDataArg = FSI->HasVAListArg ? 0 : Format->getFirstArg() - 1;
788 
789   // The way the format attribute works in GCC, the implicit this argument
790   // of member functions is counted. However, it doesn't appear in our own
791   // lists, so decrement format_idx in that case.
792   if (IsCXXMember) {
793     if(FSI->FormatIdx == 0)
794       return false;
795     --FSI->FormatIdx;
796     if (FSI->FirstDataArg != 0)
797       --FSI->FirstDataArg;
798   }
799   return true;
800 }
801 
802 /// Checks if a the given expression evaluates to null.
803 ///
804 /// \brief Returns true if the value evaluates to null.
805 static bool CheckNonNullExpr(Sema &S,
806                              const Expr *Expr) {
807   // As a special case, transparent unions initialized with zero are
808   // considered null for the purposes of the nonnull attribute.
809   if (const RecordType *UT = Expr->getType()->getAsUnionType()) {
810     if (UT->getDecl()->hasAttr<TransparentUnionAttr>())
811       if (const CompoundLiteralExpr *CLE =
812           dyn_cast<CompoundLiteralExpr>(Expr))
813         if (const InitListExpr *ILE =
814             dyn_cast<InitListExpr>(CLE->getInitializer()))
815           Expr = ILE->getInit(0);
816   }
817 
818   bool Result;
819   return (!Expr->isValueDependent() &&
820           Expr->EvaluateAsBooleanCondition(Result, S.Context) &&
821           !Result);
822 }
823 
824 static void CheckNonNullArgument(Sema &S,
825                                  const Expr *ArgExpr,
826                                  SourceLocation CallSiteLoc) {
827   if (CheckNonNullExpr(S, ArgExpr))
828     S.Diag(CallSiteLoc, diag::warn_null_arg) << ArgExpr->getSourceRange();
829 }
830 
831 bool Sema::GetFormatNSStringIdx(const FormatAttr *Format, unsigned &Idx) {
832   FormatStringInfo FSI;
833   if ((GetFormatStringType(Format) == FST_NSString) &&
834       getFormatStringInfo(Format, false, &FSI)) {
835     Idx = FSI.FormatIdx;
836     return true;
837   }
838   return false;
839 }
840 /// \brief Diagnose use of %s directive in an NSString which is being passed
841 /// as formatting string to formatting method.
842 static void
843 DiagnoseCStringFormatDirectiveInCFAPI(Sema &S,
844                                         const NamedDecl *FDecl,
845                                         Expr **Args,
846                                         unsigned NumArgs) {
847   unsigned Idx = 0;
848   bool Format = false;
849   ObjCStringFormatFamily SFFamily = FDecl->getObjCFStringFormattingFamily();
850   if (SFFamily == ObjCStringFormatFamily::SFF_CFString) {
851     Idx = 2;
852     Format = true;
853   }
854   else
855     for (const auto *I : FDecl->specific_attrs<FormatAttr>()) {
856       if (S.GetFormatNSStringIdx(I, Idx)) {
857         Format = true;
858         break;
859       }
860     }
861   if (!Format || NumArgs <= Idx)
862     return;
863   const Expr *FormatExpr = Args[Idx];
864   if (const CStyleCastExpr *CSCE = dyn_cast<CStyleCastExpr>(FormatExpr))
865     FormatExpr = CSCE->getSubExpr();
866   const StringLiteral *FormatString;
867   if (const ObjCStringLiteral *OSL =
868       dyn_cast<ObjCStringLiteral>(FormatExpr->IgnoreParenImpCasts()))
869     FormatString = OSL->getString();
870   else
871     FormatString = dyn_cast<StringLiteral>(FormatExpr->IgnoreParenImpCasts());
872   if (!FormatString)
873     return;
874   if (S.FormatStringHasSArg(FormatString)) {
875     S.Diag(FormatExpr->getExprLoc(), diag::warn_objc_cdirective_format_string)
876       << "%s" << 1 << 1;
877     S.Diag(FDecl->getLocation(), diag::note_entity_declared_at)
878       << FDecl->getDeclName();
879   }
880 }
881 
882 static void CheckNonNullArguments(Sema &S,
883                                   const NamedDecl *FDecl,
884                                   ArrayRef<const Expr *> Args,
885                                   SourceLocation CallSiteLoc) {
886   // Check the attributes attached to the method/function itself.
887   llvm::SmallBitVector NonNullArgs;
888   for (const auto *NonNull : FDecl->specific_attrs<NonNullAttr>()) {
889     if (!NonNull->args_size()) {
890       // Easy case: all pointer arguments are nonnull.
891       for (const auto *Arg : Args)
892         if (S.isValidPointerAttrType(Arg->getType()))
893           CheckNonNullArgument(S, Arg, CallSiteLoc);
894       return;
895     }
896 
897     for (unsigned Val : NonNull->args()) {
898       if (Val >= Args.size())
899         continue;
900       if (NonNullArgs.empty())
901         NonNullArgs.resize(Args.size());
902       NonNullArgs.set(Val);
903     }
904   }
905 
906   // Check the attributes on the parameters.
907   ArrayRef<ParmVarDecl*> parms;
908   if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(FDecl))
909     parms = FD->parameters();
910   else if (const ObjCMethodDecl *MD = dyn_cast<ObjCMethodDecl>(FDecl))
911     parms = MD->parameters();
912 
913   unsigned ArgIndex = 0;
914   for (ArrayRef<ParmVarDecl*>::iterator I = parms.begin(), E = parms.end();
915        I != E; ++I, ++ArgIndex) {
916     const ParmVarDecl *PVD = *I;
917     if (PVD->hasAttr<NonNullAttr>() ||
918         (ArgIndex < NonNullArgs.size() && NonNullArgs[ArgIndex]))
919       CheckNonNullArgument(S, Args[ArgIndex], CallSiteLoc);
920   }
921 
922   // In case this is a variadic call, check any remaining arguments.
923   for (/**/; ArgIndex < NonNullArgs.size(); ++ArgIndex)
924     if (NonNullArgs[ArgIndex])
925       CheckNonNullArgument(S, Args[ArgIndex], CallSiteLoc);
926 }
927 
928 /// Handles the checks for format strings, non-POD arguments to vararg
929 /// functions, and NULL arguments passed to non-NULL parameters.
930 void Sema::checkCall(NamedDecl *FDecl, ArrayRef<const Expr *> Args,
931                      unsigned NumParams, bool IsMemberFunction,
932                      SourceLocation Loc, SourceRange Range,
933                      VariadicCallType CallType) {
934   // FIXME: We should check as much as we can in the template definition.
935   if (CurContext->isDependentContext())
936     return;
937 
938   // Printf and scanf checking.
939   llvm::SmallBitVector CheckedVarArgs;
940   if (FDecl) {
941     for (const auto *I : FDecl->specific_attrs<FormatAttr>()) {
942       // Only create vector if there are format attributes.
943       CheckedVarArgs.resize(Args.size());
944 
945       CheckFormatArguments(I, Args, IsMemberFunction, CallType, Loc, Range,
946                            CheckedVarArgs);
947     }
948   }
949 
950   // Refuse POD arguments that weren't caught by the format string
951   // checks above.
952   if (CallType != VariadicDoesNotApply) {
953     for (unsigned ArgIdx = NumParams; ArgIdx < Args.size(); ++ArgIdx) {
954       // Args[ArgIdx] can be null in malformed code.
955       if (const Expr *Arg = Args[ArgIdx]) {
956         if (CheckedVarArgs.empty() || !CheckedVarArgs[ArgIdx])
957           checkVariadicArgument(Arg, CallType);
958       }
959     }
960   }
961 
962   if (FDecl) {
963     CheckNonNullArguments(*this, FDecl, Args, Loc);
964 
965     // Type safety checking.
966     for (const auto *I : FDecl->specific_attrs<ArgumentWithTypeTagAttr>())
967       CheckArgumentWithTypeTag(I, Args.data());
968   }
969 }
970 
971 /// CheckConstructorCall - Check a constructor call for correctness and safety
972 /// properties not enforced by the C type system.
973 void Sema::CheckConstructorCall(FunctionDecl *FDecl,
974                                 ArrayRef<const Expr *> Args,
975                                 const FunctionProtoType *Proto,
976                                 SourceLocation Loc) {
977   VariadicCallType CallType =
978     Proto->isVariadic() ? VariadicConstructor : VariadicDoesNotApply;
979   checkCall(FDecl, Args, Proto->getNumParams(),
980             /*IsMemberFunction=*/true, Loc, SourceRange(), CallType);
981 }
982 
983 /// CheckFunctionCall - Check a direct function call for various correctness
984 /// and safety properties not strictly enforced by the C type system.
985 bool Sema::CheckFunctionCall(FunctionDecl *FDecl, CallExpr *TheCall,
986                              const FunctionProtoType *Proto) {
987   bool IsMemberOperatorCall = isa<CXXOperatorCallExpr>(TheCall) &&
988                               isa<CXXMethodDecl>(FDecl);
989   bool IsMemberFunction = isa<CXXMemberCallExpr>(TheCall) ||
990                           IsMemberOperatorCall;
991   VariadicCallType CallType = getVariadicCallType(FDecl, Proto,
992                                                   TheCall->getCallee());
993   unsigned NumParams = Proto ? Proto->getNumParams() : 0;
994   Expr** Args = TheCall->getArgs();
995   unsigned NumArgs = TheCall->getNumArgs();
996   if (IsMemberOperatorCall) {
997     // If this is a call to a member operator, hide the first argument
998     // from checkCall.
999     // FIXME: Our choice of AST representation here is less than ideal.
1000     ++Args;
1001     --NumArgs;
1002   }
1003   checkCall(FDecl, llvm::makeArrayRef(Args, NumArgs), NumParams,
1004             IsMemberFunction, TheCall->getRParenLoc(),
1005             TheCall->getCallee()->getSourceRange(), CallType);
1006 
1007   IdentifierInfo *FnInfo = FDecl->getIdentifier();
1008   // None of the checks below are needed for functions that don't have
1009   // simple names (e.g., C++ conversion functions).
1010   if (!FnInfo)
1011     return false;
1012 
1013   CheckAbsoluteValueFunction(TheCall, FDecl, FnInfo);
1014   if (getLangOpts().ObjC1)
1015     DiagnoseCStringFormatDirectiveInCFAPI(*this, FDecl, Args, NumArgs);
1016 
1017   unsigned CMId = FDecl->getMemoryFunctionKind();
1018   if (CMId == 0)
1019     return false;
1020 
1021   // Handle memory setting and copying functions.
1022   if (CMId == Builtin::BIstrlcpy || CMId == Builtin::BIstrlcat)
1023     CheckStrlcpycatArguments(TheCall, FnInfo);
1024   else if (CMId == Builtin::BIstrncat)
1025     CheckStrncatArguments(TheCall, FnInfo);
1026   else
1027     CheckMemaccessArguments(TheCall, CMId, FnInfo);
1028 
1029   return false;
1030 }
1031 
1032 bool Sema::CheckObjCMethodCall(ObjCMethodDecl *Method, SourceLocation lbrac,
1033                                ArrayRef<const Expr *> Args) {
1034   VariadicCallType CallType =
1035       Method->isVariadic() ? VariadicMethod : VariadicDoesNotApply;
1036 
1037   checkCall(Method, Args, Method->param_size(),
1038             /*IsMemberFunction=*/false,
1039             lbrac, Method->getSourceRange(), CallType);
1040 
1041   return false;
1042 }
1043 
1044 bool Sema::CheckPointerCall(NamedDecl *NDecl, CallExpr *TheCall,
1045                             const FunctionProtoType *Proto) {
1046   const VarDecl *V = dyn_cast<VarDecl>(NDecl);
1047   if (!V)
1048     return false;
1049 
1050   QualType Ty = V->getType();
1051   if (!Ty->isBlockPointerType() && !Ty->isFunctionPointerType())
1052     return false;
1053 
1054   VariadicCallType CallType;
1055   if (!Proto || !Proto->isVariadic()) {
1056     CallType = VariadicDoesNotApply;
1057   } else if (Ty->isBlockPointerType()) {
1058     CallType = VariadicBlock;
1059   } else { // Ty->isFunctionPointerType()
1060     CallType = VariadicFunction;
1061   }
1062   unsigned NumParams = Proto ? Proto->getNumParams() : 0;
1063 
1064   checkCall(NDecl, llvm::makeArrayRef(TheCall->getArgs(),
1065                                       TheCall->getNumArgs()),
1066             NumParams, /*IsMemberFunction=*/false, TheCall->getRParenLoc(),
1067             TheCall->getCallee()->getSourceRange(), CallType);
1068 
1069   return false;
1070 }
1071 
1072 /// Checks function calls when a FunctionDecl or a NamedDecl is not available,
1073 /// such as function pointers returned from functions.
1074 bool Sema::CheckOtherCall(CallExpr *TheCall, const FunctionProtoType *Proto) {
1075   VariadicCallType CallType = getVariadicCallType(/*FDecl=*/nullptr, Proto,
1076                                                   TheCall->getCallee());
1077   unsigned NumParams = Proto ? Proto->getNumParams() : 0;
1078 
1079   checkCall(/*FDecl=*/nullptr,
1080             llvm::makeArrayRef(TheCall->getArgs(), TheCall->getNumArgs()),
1081             NumParams, /*IsMemberFunction=*/false, TheCall->getRParenLoc(),
1082             TheCall->getCallee()->getSourceRange(), CallType);
1083 
1084   return false;
1085 }
1086 
1087 static bool isValidOrderingForOp(int64_t Ordering, AtomicExpr::AtomicOp Op) {
1088   if (Ordering < AtomicExpr::AO_ABI_memory_order_relaxed ||
1089       Ordering > AtomicExpr::AO_ABI_memory_order_seq_cst)
1090     return false;
1091 
1092   switch (Op) {
1093   case AtomicExpr::AO__c11_atomic_init:
1094     llvm_unreachable("There is no ordering argument for an init");
1095 
1096   case AtomicExpr::AO__c11_atomic_load:
1097   case AtomicExpr::AO__atomic_load_n:
1098   case AtomicExpr::AO__atomic_load:
1099     return Ordering != AtomicExpr::AO_ABI_memory_order_release &&
1100            Ordering != AtomicExpr::AO_ABI_memory_order_acq_rel;
1101 
1102   case AtomicExpr::AO__c11_atomic_store:
1103   case AtomicExpr::AO__atomic_store:
1104   case AtomicExpr::AO__atomic_store_n:
1105     return Ordering != AtomicExpr::AO_ABI_memory_order_consume &&
1106            Ordering != AtomicExpr::AO_ABI_memory_order_acquire &&
1107            Ordering != AtomicExpr::AO_ABI_memory_order_acq_rel;
1108 
1109   default:
1110     return true;
1111   }
1112 }
1113 
1114 ExprResult Sema::SemaAtomicOpsOverloaded(ExprResult TheCallResult,
1115                                          AtomicExpr::AtomicOp Op) {
1116   CallExpr *TheCall = cast<CallExpr>(TheCallResult.get());
1117   DeclRefExpr *DRE =cast<DeclRefExpr>(TheCall->getCallee()->IgnoreParenCasts());
1118 
1119   // All these operations take one of the following forms:
1120   enum {
1121     // C    __c11_atomic_init(A *, C)
1122     Init,
1123     // C    __c11_atomic_load(A *, int)
1124     Load,
1125     // void __atomic_load(A *, CP, int)
1126     Copy,
1127     // C    __c11_atomic_add(A *, M, int)
1128     Arithmetic,
1129     // C    __atomic_exchange_n(A *, CP, int)
1130     Xchg,
1131     // void __atomic_exchange(A *, C *, CP, int)
1132     GNUXchg,
1133     // bool __c11_atomic_compare_exchange_strong(A *, C *, CP, int, int)
1134     C11CmpXchg,
1135     // bool __atomic_compare_exchange(A *, C *, CP, bool, int, int)
1136     GNUCmpXchg
1137   } Form = Init;
1138   const unsigned NumArgs[] = { 2, 2, 3, 3, 3, 4, 5, 6 };
1139   const unsigned NumVals[] = { 1, 0, 1, 1, 1, 2, 2, 3 };
1140   // where:
1141   //   C is an appropriate type,
1142   //   A is volatile _Atomic(C) for __c11 builtins and is C for GNU builtins,
1143   //   CP is C for __c11 builtins and GNU _n builtins and is C * otherwise,
1144   //   M is C if C is an integer, and ptrdiff_t if C is a pointer, and
1145   //   the int parameters are for orderings.
1146 
1147   assert(AtomicExpr::AO__c11_atomic_init == 0 &&
1148          AtomicExpr::AO__c11_atomic_fetch_xor + 1 == AtomicExpr::AO__atomic_load
1149          && "need to update code for modified C11 atomics");
1150   bool IsC11 = Op >= AtomicExpr::AO__c11_atomic_init &&
1151                Op <= AtomicExpr::AO__c11_atomic_fetch_xor;
1152   bool IsN = Op == AtomicExpr::AO__atomic_load_n ||
1153              Op == AtomicExpr::AO__atomic_store_n ||
1154              Op == AtomicExpr::AO__atomic_exchange_n ||
1155              Op == AtomicExpr::AO__atomic_compare_exchange_n;
1156   bool IsAddSub = false;
1157 
1158   switch (Op) {
1159   case AtomicExpr::AO__c11_atomic_init:
1160     Form = Init;
1161     break;
1162 
1163   case AtomicExpr::AO__c11_atomic_load:
1164   case AtomicExpr::AO__atomic_load_n:
1165     Form = Load;
1166     break;
1167 
1168   case AtomicExpr::AO__c11_atomic_store:
1169   case AtomicExpr::AO__atomic_load:
1170   case AtomicExpr::AO__atomic_store:
1171   case AtomicExpr::AO__atomic_store_n:
1172     Form = Copy;
1173     break;
1174 
1175   case AtomicExpr::AO__c11_atomic_fetch_add:
1176   case AtomicExpr::AO__c11_atomic_fetch_sub:
1177   case AtomicExpr::AO__atomic_fetch_add:
1178   case AtomicExpr::AO__atomic_fetch_sub:
1179   case AtomicExpr::AO__atomic_add_fetch:
1180   case AtomicExpr::AO__atomic_sub_fetch:
1181     IsAddSub = true;
1182     // Fall through.
1183   case AtomicExpr::AO__c11_atomic_fetch_and:
1184   case AtomicExpr::AO__c11_atomic_fetch_or:
1185   case AtomicExpr::AO__c11_atomic_fetch_xor:
1186   case AtomicExpr::AO__atomic_fetch_and:
1187   case AtomicExpr::AO__atomic_fetch_or:
1188   case AtomicExpr::AO__atomic_fetch_xor:
1189   case AtomicExpr::AO__atomic_fetch_nand:
1190   case AtomicExpr::AO__atomic_and_fetch:
1191   case AtomicExpr::AO__atomic_or_fetch:
1192   case AtomicExpr::AO__atomic_xor_fetch:
1193   case AtomicExpr::AO__atomic_nand_fetch:
1194     Form = Arithmetic;
1195     break;
1196 
1197   case AtomicExpr::AO__c11_atomic_exchange:
1198   case AtomicExpr::AO__atomic_exchange_n:
1199     Form = Xchg;
1200     break;
1201 
1202   case AtomicExpr::AO__atomic_exchange:
1203     Form = GNUXchg;
1204     break;
1205 
1206   case AtomicExpr::AO__c11_atomic_compare_exchange_strong:
1207   case AtomicExpr::AO__c11_atomic_compare_exchange_weak:
1208     Form = C11CmpXchg;
1209     break;
1210 
1211   case AtomicExpr::AO__atomic_compare_exchange:
1212   case AtomicExpr::AO__atomic_compare_exchange_n:
1213     Form = GNUCmpXchg;
1214     break;
1215   }
1216 
1217   // Check we have the right number of arguments.
1218   if (TheCall->getNumArgs() < NumArgs[Form]) {
1219     Diag(TheCall->getLocEnd(), diag::err_typecheck_call_too_few_args)
1220       << 0 << NumArgs[Form] << TheCall->getNumArgs()
1221       << TheCall->getCallee()->getSourceRange();
1222     return ExprError();
1223   } else if (TheCall->getNumArgs() > NumArgs[Form]) {
1224     Diag(TheCall->getArg(NumArgs[Form])->getLocStart(),
1225          diag::err_typecheck_call_too_many_args)
1226       << 0 << NumArgs[Form] << TheCall->getNumArgs()
1227       << TheCall->getCallee()->getSourceRange();
1228     return ExprError();
1229   }
1230 
1231   // Inspect the first argument of the atomic operation.
1232   Expr *Ptr = TheCall->getArg(0);
1233   Ptr = DefaultFunctionArrayLvalueConversion(Ptr).get();
1234   const PointerType *pointerType = Ptr->getType()->getAs<PointerType>();
1235   if (!pointerType) {
1236     Diag(DRE->getLocStart(), diag::err_atomic_builtin_must_be_pointer)
1237       << Ptr->getType() << Ptr->getSourceRange();
1238     return ExprError();
1239   }
1240 
1241   // For a __c11 builtin, this should be a pointer to an _Atomic type.
1242   QualType AtomTy = pointerType->getPointeeType(); // 'A'
1243   QualType ValType = AtomTy; // 'C'
1244   if (IsC11) {
1245     if (!AtomTy->isAtomicType()) {
1246       Diag(DRE->getLocStart(), diag::err_atomic_op_needs_atomic)
1247         << Ptr->getType() << Ptr->getSourceRange();
1248       return ExprError();
1249     }
1250     if (AtomTy.isConstQualified()) {
1251       Diag(DRE->getLocStart(), diag::err_atomic_op_needs_non_const_atomic)
1252         << Ptr->getType() << Ptr->getSourceRange();
1253       return ExprError();
1254     }
1255     ValType = AtomTy->getAs<AtomicType>()->getValueType();
1256   }
1257 
1258   // For an arithmetic operation, the implied arithmetic must be well-formed.
1259   if (Form == Arithmetic) {
1260     // gcc does not enforce these rules for GNU atomics, but we do so for sanity.
1261     if (IsAddSub && !ValType->isIntegerType() && !ValType->isPointerType()) {
1262       Diag(DRE->getLocStart(), diag::err_atomic_op_needs_atomic_int_or_ptr)
1263         << IsC11 << Ptr->getType() << Ptr->getSourceRange();
1264       return ExprError();
1265     }
1266     if (!IsAddSub && !ValType->isIntegerType()) {
1267       Diag(DRE->getLocStart(), diag::err_atomic_op_bitwise_needs_atomic_int)
1268         << IsC11 << Ptr->getType() << Ptr->getSourceRange();
1269       return ExprError();
1270     }
1271   } else if (IsN && !ValType->isIntegerType() && !ValType->isPointerType()) {
1272     // For __atomic_*_n operations, the value type must be a scalar integral or
1273     // pointer type which is 1, 2, 4, 8 or 16 bytes in length.
1274     Diag(DRE->getLocStart(), diag::err_atomic_op_needs_atomic_int_or_ptr)
1275       << IsC11 << Ptr->getType() << Ptr->getSourceRange();
1276     return ExprError();
1277   }
1278 
1279   if (!IsC11 && !AtomTy.isTriviallyCopyableType(Context) &&
1280       !AtomTy->isScalarType()) {
1281     // For GNU atomics, require a trivially-copyable type. This is not part of
1282     // the GNU atomics specification, but we enforce it for sanity.
1283     Diag(DRE->getLocStart(), diag::err_atomic_op_needs_trivial_copy)
1284       << Ptr->getType() << Ptr->getSourceRange();
1285     return ExprError();
1286   }
1287 
1288   // FIXME: For any builtin other than a load, the ValType must not be
1289   // const-qualified.
1290 
1291   switch (ValType.getObjCLifetime()) {
1292   case Qualifiers::OCL_None:
1293   case Qualifiers::OCL_ExplicitNone:
1294     // okay
1295     break;
1296 
1297   case Qualifiers::OCL_Weak:
1298   case Qualifiers::OCL_Strong:
1299   case Qualifiers::OCL_Autoreleasing:
1300     // FIXME: Can this happen? By this point, ValType should be known
1301     // to be trivially copyable.
1302     Diag(DRE->getLocStart(), diag::err_arc_atomic_ownership)
1303       << ValType << Ptr->getSourceRange();
1304     return ExprError();
1305   }
1306 
1307   QualType ResultType = ValType;
1308   if (Form == Copy || Form == GNUXchg || Form == Init)
1309     ResultType = Context.VoidTy;
1310   else if (Form == C11CmpXchg || Form == GNUCmpXchg)
1311     ResultType = Context.BoolTy;
1312 
1313   // The type of a parameter passed 'by value'. In the GNU atomics, such
1314   // arguments are actually passed as pointers.
1315   QualType ByValType = ValType; // 'CP'
1316   if (!IsC11 && !IsN)
1317     ByValType = Ptr->getType();
1318 
1319   // The first argument --- the pointer --- has a fixed type; we
1320   // deduce the types of the rest of the arguments accordingly.  Walk
1321   // the remaining arguments, converting them to the deduced value type.
1322   for (unsigned i = 1; i != NumArgs[Form]; ++i) {
1323     QualType Ty;
1324     if (i < NumVals[Form] + 1) {
1325       switch (i) {
1326       case 1:
1327         // The second argument is the non-atomic operand. For arithmetic, this
1328         // is always passed by value, and for a compare_exchange it is always
1329         // passed by address. For the rest, GNU uses by-address and C11 uses
1330         // by-value.
1331         assert(Form != Load);
1332         if (Form == Init || (Form == Arithmetic && ValType->isIntegerType()))
1333           Ty = ValType;
1334         else if (Form == Copy || Form == Xchg)
1335           Ty = ByValType;
1336         else if (Form == Arithmetic)
1337           Ty = Context.getPointerDiffType();
1338         else
1339           Ty = Context.getPointerType(ValType.getUnqualifiedType());
1340         break;
1341       case 2:
1342         // The third argument to compare_exchange / GNU exchange is a
1343         // (pointer to a) desired value.
1344         Ty = ByValType;
1345         break;
1346       case 3:
1347         // The fourth argument to GNU compare_exchange is a 'weak' flag.
1348         Ty = Context.BoolTy;
1349         break;
1350       }
1351     } else {
1352       // The order(s) are always converted to int.
1353       Ty = Context.IntTy;
1354     }
1355 
1356     InitializedEntity Entity =
1357         InitializedEntity::InitializeParameter(Context, Ty, false);
1358     ExprResult Arg = TheCall->getArg(i);
1359     Arg = PerformCopyInitialization(Entity, SourceLocation(), Arg);
1360     if (Arg.isInvalid())
1361       return true;
1362     TheCall->setArg(i, Arg.get());
1363   }
1364 
1365   // Permute the arguments into a 'consistent' order.
1366   SmallVector<Expr*, 5> SubExprs;
1367   SubExprs.push_back(Ptr);
1368   switch (Form) {
1369   case Init:
1370     // Note, AtomicExpr::getVal1() has a special case for this atomic.
1371     SubExprs.push_back(TheCall->getArg(1)); // Val1
1372     break;
1373   case Load:
1374     SubExprs.push_back(TheCall->getArg(1)); // Order
1375     break;
1376   case Copy:
1377   case Arithmetic:
1378   case Xchg:
1379     SubExprs.push_back(TheCall->getArg(2)); // Order
1380     SubExprs.push_back(TheCall->getArg(1)); // Val1
1381     break;
1382   case GNUXchg:
1383     // Note, AtomicExpr::getVal2() has a special case for this atomic.
1384     SubExprs.push_back(TheCall->getArg(3)); // Order
1385     SubExprs.push_back(TheCall->getArg(1)); // Val1
1386     SubExprs.push_back(TheCall->getArg(2)); // Val2
1387     break;
1388   case C11CmpXchg:
1389     SubExprs.push_back(TheCall->getArg(3)); // Order
1390     SubExprs.push_back(TheCall->getArg(1)); // Val1
1391     SubExprs.push_back(TheCall->getArg(4)); // OrderFail
1392     SubExprs.push_back(TheCall->getArg(2)); // Val2
1393     break;
1394   case GNUCmpXchg:
1395     SubExprs.push_back(TheCall->getArg(4)); // Order
1396     SubExprs.push_back(TheCall->getArg(1)); // Val1
1397     SubExprs.push_back(TheCall->getArg(5)); // OrderFail
1398     SubExprs.push_back(TheCall->getArg(2)); // Val2
1399     SubExprs.push_back(TheCall->getArg(3)); // Weak
1400     break;
1401   }
1402 
1403   if (SubExprs.size() >= 2 && Form != Init) {
1404     llvm::APSInt Result(32);
1405     if (SubExprs[1]->isIntegerConstantExpr(Result, Context) &&
1406         !isValidOrderingForOp(Result.getSExtValue(), Op))
1407       Diag(SubExprs[1]->getLocStart(),
1408            diag::warn_atomic_op_has_invalid_memory_order)
1409           << SubExprs[1]->getSourceRange();
1410   }
1411 
1412   AtomicExpr *AE = new (Context) AtomicExpr(TheCall->getCallee()->getLocStart(),
1413                                             SubExprs, ResultType, Op,
1414                                             TheCall->getRParenLoc());
1415 
1416   if ((Op == AtomicExpr::AO__c11_atomic_load ||
1417        (Op == AtomicExpr::AO__c11_atomic_store)) &&
1418       Context.AtomicUsesUnsupportedLibcall(AE))
1419     Diag(AE->getLocStart(), diag::err_atomic_load_store_uses_lib) <<
1420     ((Op == AtomicExpr::AO__c11_atomic_load) ? 0 : 1);
1421 
1422   return AE;
1423 }
1424 
1425 
1426 /// checkBuiltinArgument - Given a call to a builtin function, perform
1427 /// normal type-checking on the given argument, updating the call in
1428 /// place.  This is useful when a builtin function requires custom
1429 /// type-checking for some of its arguments but not necessarily all of
1430 /// them.
1431 ///
1432 /// Returns true on error.
1433 static bool checkBuiltinArgument(Sema &S, CallExpr *E, unsigned ArgIndex) {
1434   FunctionDecl *Fn = E->getDirectCallee();
1435   assert(Fn && "builtin call without direct callee!");
1436 
1437   ParmVarDecl *Param = Fn->getParamDecl(ArgIndex);
1438   InitializedEntity Entity =
1439     InitializedEntity::InitializeParameter(S.Context, Param);
1440 
1441   ExprResult Arg = E->getArg(0);
1442   Arg = S.PerformCopyInitialization(Entity, SourceLocation(), Arg);
1443   if (Arg.isInvalid())
1444     return true;
1445 
1446   E->setArg(ArgIndex, Arg.get());
1447   return false;
1448 }
1449 
1450 /// SemaBuiltinAtomicOverloaded - We have a call to a function like
1451 /// __sync_fetch_and_add, which is an overloaded function based on the pointer
1452 /// type of its first argument.  The main ActOnCallExpr routines have already
1453 /// promoted the types of arguments because all of these calls are prototyped as
1454 /// void(...).
1455 ///
1456 /// This function goes through and does final semantic checking for these
1457 /// builtins,
1458 ExprResult
1459 Sema::SemaBuiltinAtomicOverloaded(ExprResult TheCallResult) {
1460   CallExpr *TheCall = (CallExpr *)TheCallResult.get();
1461   DeclRefExpr *DRE =cast<DeclRefExpr>(TheCall->getCallee()->IgnoreParenCasts());
1462   FunctionDecl *FDecl = cast<FunctionDecl>(DRE->getDecl());
1463 
1464   // Ensure that we have at least one argument to do type inference from.
1465   if (TheCall->getNumArgs() < 1) {
1466     Diag(TheCall->getLocEnd(), diag::err_typecheck_call_too_few_args_at_least)
1467       << 0 << 1 << TheCall->getNumArgs()
1468       << TheCall->getCallee()->getSourceRange();
1469     return ExprError();
1470   }
1471 
1472   // Inspect the first argument of the atomic builtin.  This should always be
1473   // a pointer type, whose element is an integral scalar or pointer type.
1474   // Because it is a pointer type, we don't have to worry about any implicit
1475   // casts here.
1476   // FIXME: We don't allow floating point scalars as input.
1477   Expr *FirstArg = TheCall->getArg(0);
1478   ExprResult FirstArgResult = DefaultFunctionArrayLvalueConversion(FirstArg);
1479   if (FirstArgResult.isInvalid())
1480     return ExprError();
1481   FirstArg = FirstArgResult.get();
1482   TheCall->setArg(0, FirstArg);
1483 
1484   const PointerType *pointerType = FirstArg->getType()->getAs<PointerType>();
1485   if (!pointerType) {
1486     Diag(DRE->getLocStart(), diag::err_atomic_builtin_must_be_pointer)
1487       << FirstArg->getType() << FirstArg->getSourceRange();
1488     return ExprError();
1489   }
1490 
1491   QualType ValType = pointerType->getPointeeType();
1492   if (!ValType->isIntegerType() && !ValType->isAnyPointerType() &&
1493       !ValType->isBlockPointerType()) {
1494     Diag(DRE->getLocStart(), diag::err_atomic_builtin_must_be_pointer_intptr)
1495       << FirstArg->getType() << FirstArg->getSourceRange();
1496     return ExprError();
1497   }
1498 
1499   switch (ValType.getObjCLifetime()) {
1500   case Qualifiers::OCL_None:
1501   case Qualifiers::OCL_ExplicitNone:
1502     // okay
1503     break;
1504 
1505   case Qualifiers::OCL_Weak:
1506   case Qualifiers::OCL_Strong:
1507   case Qualifiers::OCL_Autoreleasing:
1508     Diag(DRE->getLocStart(), diag::err_arc_atomic_ownership)
1509       << ValType << FirstArg->getSourceRange();
1510     return ExprError();
1511   }
1512 
1513   // Strip any qualifiers off ValType.
1514   ValType = ValType.getUnqualifiedType();
1515 
1516   // The majority of builtins return a value, but a few have special return
1517   // types, so allow them to override appropriately below.
1518   QualType ResultType = ValType;
1519 
1520   // We need to figure out which concrete builtin this maps onto.  For example,
1521   // __sync_fetch_and_add with a 2 byte object turns into
1522   // __sync_fetch_and_add_2.
1523 #define BUILTIN_ROW(x) \
1524   { Builtin::BI##x##_1, Builtin::BI##x##_2, Builtin::BI##x##_4, \
1525     Builtin::BI##x##_8, Builtin::BI##x##_16 }
1526 
1527   static const unsigned BuiltinIndices[][5] = {
1528     BUILTIN_ROW(__sync_fetch_and_add),
1529     BUILTIN_ROW(__sync_fetch_and_sub),
1530     BUILTIN_ROW(__sync_fetch_and_or),
1531     BUILTIN_ROW(__sync_fetch_and_and),
1532     BUILTIN_ROW(__sync_fetch_and_xor),
1533     BUILTIN_ROW(__sync_fetch_and_nand),
1534 
1535     BUILTIN_ROW(__sync_add_and_fetch),
1536     BUILTIN_ROW(__sync_sub_and_fetch),
1537     BUILTIN_ROW(__sync_and_and_fetch),
1538     BUILTIN_ROW(__sync_or_and_fetch),
1539     BUILTIN_ROW(__sync_xor_and_fetch),
1540     BUILTIN_ROW(__sync_nand_and_fetch),
1541 
1542     BUILTIN_ROW(__sync_val_compare_and_swap),
1543     BUILTIN_ROW(__sync_bool_compare_and_swap),
1544     BUILTIN_ROW(__sync_lock_test_and_set),
1545     BUILTIN_ROW(__sync_lock_release),
1546     BUILTIN_ROW(__sync_swap)
1547   };
1548 #undef BUILTIN_ROW
1549 
1550   // Determine the index of the size.
1551   unsigned SizeIndex;
1552   switch (Context.getTypeSizeInChars(ValType).getQuantity()) {
1553   case 1: SizeIndex = 0; break;
1554   case 2: SizeIndex = 1; break;
1555   case 4: SizeIndex = 2; break;
1556   case 8: SizeIndex = 3; break;
1557   case 16: SizeIndex = 4; break;
1558   default:
1559     Diag(DRE->getLocStart(), diag::err_atomic_builtin_pointer_size)
1560       << FirstArg->getType() << FirstArg->getSourceRange();
1561     return ExprError();
1562   }
1563 
1564   // Each of these builtins has one pointer argument, followed by some number of
1565   // values (0, 1 or 2) followed by a potentially empty varags list of stuff
1566   // that we ignore.  Find out which row of BuiltinIndices to read from as well
1567   // as the number of fixed args.
1568   unsigned BuiltinID = FDecl->getBuiltinID();
1569   unsigned BuiltinIndex, NumFixed = 1;
1570   bool WarnAboutSemanticsChange = false;
1571   switch (BuiltinID) {
1572   default: llvm_unreachable("Unknown overloaded atomic builtin!");
1573   case Builtin::BI__sync_fetch_and_add:
1574   case Builtin::BI__sync_fetch_and_add_1:
1575   case Builtin::BI__sync_fetch_and_add_2:
1576   case Builtin::BI__sync_fetch_and_add_4:
1577   case Builtin::BI__sync_fetch_and_add_8:
1578   case Builtin::BI__sync_fetch_and_add_16:
1579     BuiltinIndex = 0;
1580     break;
1581 
1582   case Builtin::BI__sync_fetch_and_sub:
1583   case Builtin::BI__sync_fetch_and_sub_1:
1584   case Builtin::BI__sync_fetch_and_sub_2:
1585   case Builtin::BI__sync_fetch_and_sub_4:
1586   case Builtin::BI__sync_fetch_and_sub_8:
1587   case Builtin::BI__sync_fetch_and_sub_16:
1588     BuiltinIndex = 1;
1589     break;
1590 
1591   case Builtin::BI__sync_fetch_and_or:
1592   case Builtin::BI__sync_fetch_and_or_1:
1593   case Builtin::BI__sync_fetch_and_or_2:
1594   case Builtin::BI__sync_fetch_and_or_4:
1595   case Builtin::BI__sync_fetch_and_or_8:
1596   case Builtin::BI__sync_fetch_and_or_16:
1597     BuiltinIndex = 2;
1598     break;
1599 
1600   case Builtin::BI__sync_fetch_and_and:
1601   case Builtin::BI__sync_fetch_and_and_1:
1602   case Builtin::BI__sync_fetch_and_and_2:
1603   case Builtin::BI__sync_fetch_and_and_4:
1604   case Builtin::BI__sync_fetch_and_and_8:
1605   case Builtin::BI__sync_fetch_and_and_16:
1606     BuiltinIndex = 3;
1607     break;
1608 
1609   case Builtin::BI__sync_fetch_and_xor:
1610   case Builtin::BI__sync_fetch_and_xor_1:
1611   case Builtin::BI__sync_fetch_and_xor_2:
1612   case Builtin::BI__sync_fetch_and_xor_4:
1613   case Builtin::BI__sync_fetch_and_xor_8:
1614   case Builtin::BI__sync_fetch_and_xor_16:
1615     BuiltinIndex = 4;
1616     break;
1617 
1618   case Builtin::BI__sync_fetch_and_nand:
1619   case Builtin::BI__sync_fetch_and_nand_1:
1620   case Builtin::BI__sync_fetch_and_nand_2:
1621   case Builtin::BI__sync_fetch_and_nand_4:
1622   case Builtin::BI__sync_fetch_and_nand_8:
1623   case Builtin::BI__sync_fetch_and_nand_16:
1624     BuiltinIndex = 5;
1625     WarnAboutSemanticsChange = true;
1626     break;
1627 
1628   case Builtin::BI__sync_add_and_fetch:
1629   case Builtin::BI__sync_add_and_fetch_1:
1630   case Builtin::BI__sync_add_and_fetch_2:
1631   case Builtin::BI__sync_add_and_fetch_4:
1632   case Builtin::BI__sync_add_and_fetch_8:
1633   case Builtin::BI__sync_add_and_fetch_16:
1634     BuiltinIndex = 6;
1635     break;
1636 
1637   case Builtin::BI__sync_sub_and_fetch:
1638   case Builtin::BI__sync_sub_and_fetch_1:
1639   case Builtin::BI__sync_sub_and_fetch_2:
1640   case Builtin::BI__sync_sub_and_fetch_4:
1641   case Builtin::BI__sync_sub_and_fetch_8:
1642   case Builtin::BI__sync_sub_and_fetch_16:
1643     BuiltinIndex = 7;
1644     break;
1645 
1646   case Builtin::BI__sync_and_and_fetch:
1647   case Builtin::BI__sync_and_and_fetch_1:
1648   case Builtin::BI__sync_and_and_fetch_2:
1649   case Builtin::BI__sync_and_and_fetch_4:
1650   case Builtin::BI__sync_and_and_fetch_8:
1651   case Builtin::BI__sync_and_and_fetch_16:
1652     BuiltinIndex = 8;
1653     break;
1654 
1655   case Builtin::BI__sync_or_and_fetch:
1656   case Builtin::BI__sync_or_and_fetch_1:
1657   case Builtin::BI__sync_or_and_fetch_2:
1658   case Builtin::BI__sync_or_and_fetch_4:
1659   case Builtin::BI__sync_or_and_fetch_8:
1660   case Builtin::BI__sync_or_and_fetch_16:
1661     BuiltinIndex = 9;
1662     break;
1663 
1664   case Builtin::BI__sync_xor_and_fetch:
1665   case Builtin::BI__sync_xor_and_fetch_1:
1666   case Builtin::BI__sync_xor_and_fetch_2:
1667   case Builtin::BI__sync_xor_and_fetch_4:
1668   case Builtin::BI__sync_xor_and_fetch_8:
1669   case Builtin::BI__sync_xor_and_fetch_16:
1670     BuiltinIndex = 10;
1671     break;
1672 
1673   case Builtin::BI__sync_nand_and_fetch:
1674   case Builtin::BI__sync_nand_and_fetch_1:
1675   case Builtin::BI__sync_nand_and_fetch_2:
1676   case Builtin::BI__sync_nand_and_fetch_4:
1677   case Builtin::BI__sync_nand_and_fetch_8:
1678   case Builtin::BI__sync_nand_and_fetch_16:
1679     BuiltinIndex = 11;
1680     WarnAboutSemanticsChange = true;
1681     break;
1682 
1683   case Builtin::BI__sync_val_compare_and_swap:
1684   case Builtin::BI__sync_val_compare_and_swap_1:
1685   case Builtin::BI__sync_val_compare_and_swap_2:
1686   case Builtin::BI__sync_val_compare_and_swap_4:
1687   case Builtin::BI__sync_val_compare_and_swap_8:
1688   case Builtin::BI__sync_val_compare_and_swap_16:
1689     BuiltinIndex = 12;
1690     NumFixed = 2;
1691     break;
1692 
1693   case Builtin::BI__sync_bool_compare_and_swap:
1694   case Builtin::BI__sync_bool_compare_and_swap_1:
1695   case Builtin::BI__sync_bool_compare_and_swap_2:
1696   case Builtin::BI__sync_bool_compare_and_swap_4:
1697   case Builtin::BI__sync_bool_compare_and_swap_8:
1698   case Builtin::BI__sync_bool_compare_and_swap_16:
1699     BuiltinIndex = 13;
1700     NumFixed = 2;
1701     ResultType = Context.BoolTy;
1702     break;
1703 
1704   case Builtin::BI__sync_lock_test_and_set:
1705   case Builtin::BI__sync_lock_test_and_set_1:
1706   case Builtin::BI__sync_lock_test_and_set_2:
1707   case Builtin::BI__sync_lock_test_and_set_4:
1708   case Builtin::BI__sync_lock_test_and_set_8:
1709   case Builtin::BI__sync_lock_test_and_set_16:
1710     BuiltinIndex = 14;
1711     break;
1712 
1713   case Builtin::BI__sync_lock_release:
1714   case Builtin::BI__sync_lock_release_1:
1715   case Builtin::BI__sync_lock_release_2:
1716   case Builtin::BI__sync_lock_release_4:
1717   case Builtin::BI__sync_lock_release_8:
1718   case Builtin::BI__sync_lock_release_16:
1719     BuiltinIndex = 15;
1720     NumFixed = 0;
1721     ResultType = Context.VoidTy;
1722     break;
1723 
1724   case Builtin::BI__sync_swap:
1725   case Builtin::BI__sync_swap_1:
1726   case Builtin::BI__sync_swap_2:
1727   case Builtin::BI__sync_swap_4:
1728   case Builtin::BI__sync_swap_8:
1729   case Builtin::BI__sync_swap_16:
1730     BuiltinIndex = 16;
1731     break;
1732   }
1733 
1734   // Now that we know how many fixed arguments we expect, first check that we
1735   // have at least that many.
1736   if (TheCall->getNumArgs() < 1+NumFixed) {
1737     Diag(TheCall->getLocEnd(), diag::err_typecheck_call_too_few_args_at_least)
1738       << 0 << 1+NumFixed << TheCall->getNumArgs()
1739       << TheCall->getCallee()->getSourceRange();
1740     return ExprError();
1741   }
1742 
1743   if (WarnAboutSemanticsChange) {
1744     Diag(TheCall->getLocEnd(), diag::warn_sync_fetch_and_nand_semantics_change)
1745       << TheCall->getCallee()->getSourceRange();
1746   }
1747 
1748   // Get the decl for the concrete builtin from this, we can tell what the
1749   // concrete integer type we should convert to is.
1750   unsigned NewBuiltinID = BuiltinIndices[BuiltinIndex][SizeIndex];
1751   const char *NewBuiltinName = Context.BuiltinInfo.GetName(NewBuiltinID);
1752   FunctionDecl *NewBuiltinDecl;
1753   if (NewBuiltinID == BuiltinID)
1754     NewBuiltinDecl = FDecl;
1755   else {
1756     // Perform builtin lookup to avoid redeclaring it.
1757     DeclarationName DN(&Context.Idents.get(NewBuiltinName));
1758     LookupResult Res(*this, DN, DRE->getLocStart(), LookupOrdinaryName);
1759     LookupName(Res, TUScope, /*AllowBuiltinCreation=*/true);
1760     assert(Res.getFoundDecl());
1761     NewBuiltinDecl = dyn_cast<FunctionDecl>(Res.getFoundDecl());
1762     if (!NewBuiltinDecl)
1763       return ExprError();
1764   }
1765 
1766   // The first argument --- the pointer --- has a fixed type; we
1767   // deduce the types of the rest of the arguments accordingly.  Walk
1768   // the remaining arguments, converting them to the deduced value type.
1769   for (unsigned i = 0; i != NumFixed; ++i) {
1770     ExprResult Arg = TheCall->getArg(i+1);
1771 
1772     // GCC does an implicit conversion to the pointer or integer ValType.  This
1773     // can fail in some cases (1i -> int**), check for this error case now.
1774     // Initialize the argument.
1775     InitializedEntity Entity = InitializedEntity::InitializeParameter(Context,
1776                                                    ValType, /*consume*/ false);
1777     Arg = PerformCopyInitialization(Entity, SourceLocation(), Arg);
1778     if (Arg.isInvalid())
1779       return ExprError();
1780 
1781     // Okay, we have something that *can* be converted to the right type.  Check
1782     // to see if there is a potentially weird extension going on here.  This can
1783     // happen when you do an atomic operation on something like an char* and
1784     // pass in 42.  The 42 gets converted to char.  This is even more strange
1785     // for things like 45.123 -> char, etc.
1786     // FIXME: Do this check.
1787     TheCall->setArg(i+1, Arg.get());
1788   }
1789 
1790   ASTContext& Context = this->getASTContext();
1791 
1792   // Create a new DeclRefExpr to refer to the new decl.
1793   DeclRefExpr* NewDRE = DeclRefExpr::Create(
1794       Context,
1795       DRE->getQualifierLoc(),
1796       SourceLocation(),
1797       NewBuiltinDecl,
1798       /*enclosing*/ false,
1799       DRE->getLocation(),
1800       Context.BuiltinFnTy,
1801       DRE->getValueKind());
1802 
1803   // Set the callee in the CallExpr.
1804   // FIXME: This loses syntactic information.
1805   QualType CalleePtrTy = Context.getPointerType(NewBuiltinDecl->getType());
1806   ExprResult PromotedCall = ImpCastExprToType(NewDRE, CalleePtrTy,
1807                                               CK_BuiltinFnToFnPtr);
1808   TheCall->setCallee(PromotedCall.get());
1809 
1810   // Change the result type of the call to match the original value type. This
1811   // is arbitrary, but the codegen for these builtins ins design to handle it
1812   // gracefully.
1813   TheCall->setType(ResultType);
1814 
1815   return TheCallResult;
1816 }
1817 
1818 /// CheckObjCString - Checks that the argument to the builtin
1819 /// CFString constructor is correct
1820 /// Note: It might also make sense to do the UTF-16 conversion here (would
1821 /// simplify the backend).
1822 bool Sema::CheckObjCString(Expr *Arg) {
1823   Arg = Arg->IgnoreParenCasts();
1824   StringLiteral *Literal = dyn_cast<StringLiteral>(Arg);
1825 
1826   if (!Literal || !Literal->isAscii()) {
1827     Diag(Arg->getLocStart(), diag::err_cfstring_literal_not_string_constant)
1828       << Arg->getSourceRange();
1829     return true;
1830   }
1831 
1832   if (Literal->containsNonAsciiOrNull()) {
1833     StringRef String = Literal->getString();
1834     unsigned NumBytes = String.size();
1835     SmallVector<UTF16, 128> ToBuf(NumBytes);
1836     const UTF8 *FromPtr = (const UTF8 *)String.data();
1837     UTF16 *ToPtr = &ToBuf[0];
1838 
1839     ConversionResult Result = ConvertUTF8toUTF16(&FromPtr, FromPtr + NumBytes,
1840                                                  &ToPtr, ToPtr + NumBytes,
1841                                                  strictConversion);
1842     // Check for conversion failure.
1843     if (Result != conversionOK)
1844       Diag(Arg->getLocStart(),
1845            diag::warn_cfstring_truncated) << Arg->getSourceRange();
1846   }
1847   return false;
1848 }
1849 
1850 /// SemaBuiltinVAStart - Check the arguments to __builtin_va_start for validity.
1851 /// Emit an error and return true on failure, return false on success.
1852 bool Sema::SemaBuiltinVAStart(CallExpr *TheCall) {
1853   Expr *Fn = TheCall->getCallee();
1854   if (TheCall->getNumArgs() > 2) {
1855     Diag(TheCall->getArg(2)->getLocStart(),
1856          diag::err_typecheck_call_too_many_args)
1857       << 0 /*function call*/ << 2 << TheCall->getNumArgs()
1858       << Fn->getSourceRange()
1859       << SourceRange(TheCall->getArg(2)->getLocStart(),
1860                      (*(TheCall->arg_end()-1))->getLocEnd());
1861     return true;
1862   }
1863 
1864   if (TheCall->getNumArgs() < 2) {
1865     return Diag(TheCall->getLocEnd(),
1866       diag::err_typecheck_call_too_few_args_at_least)
1867       << 0 /*function call*/ << 2 << TheCall->getNumArgs();
1868   }
1869 
1870   // Type-check the first argument normally.
1871   if (checkBuiltinArgument(*this, TheCall, 0))
1872     return true;
1873 
1874   // Determine whether the current function is variadic or not.
1875   BlockScopeInfo *CurBlock = getCurBlock();
1876   bool isVariadic;
1877   if (CurBlock)
1878     isVariadic = CurBlock->TheDecl->isVariadic();
1879   else if (FunctionDecl *FD = getCurFunctionDecl())
1880     isVariadic = FD->isVariadic();
1881   else
1882     isVariadic = getCurMethodDecl()->isVariadic();
1883 
1884   if (!isVariadic) {
1885     Diag(Fn->getLocStart(), diag::err_va_start_used_in_non_variadic_function);
1886     return true;
1887   }
1888 
1889   // Verify that the second argument to the builtin is the last argument of the
1890   // current function or method.
1891   bool SecondArgIsLastNamedArgument = false;
1892   const Expr *Arg = TheCall->getArg(1)->IgnoreParenCasts();
1893 
1894   // These are valid if SecondArgIsLastNamedArgument is false after the next
1895   // block.
1896   QualType Type;
1897   SourceLocation ParamLoc;
1898 
1899   if (const DeclRefExpr *DR = dyn_cast<DeclRefExpr>(Arg)) {
1900     if (const ParmVarDecl *PV = dyn_cast<ParmVarDecl>(DR->getDecl())) {
1901       // FIXME: This isn't correct for methods (results in bogus warning).
1902       // Get the last formal in the current function.
1903       const ParmVarDecl *LastArg;
1904       if (CurBlock)
1905         LastArg = *(CurBlock->TheDecl->param_end()-1);
1906       else if (FunctionDecl *FD = getCurFunctionDecl())
1907         LastArg = *(FD->param_end()-1);
1908       else
1909         LastArg = *(getCurMethodDecl()->param_end()-1);
1910       SecondArgIsLastNamedArgument = PV == LastArg;
1911 
1912       Type = PV->getType();
1913       ParamLoc = PV->getLocation();
1914     }
1915   }
1916 
1917   if (!SecondArgIsLastNamedArgument)
1918     Diag(TheCall->getArg(1)->getLocStart(),
1919          diag::warn_second_parameter_of_va_start_not_last_named_argument);
1920   else if (Type->isReferenceType()) {
1921     Diag(Arg->getLocStart(),
1922          diag::warn_va_start_of_reference_type_is_undefined);
1923     Diag(ParamLoc, diag::note_parameter_type) << Type;
1924   }
1925 
1926   TheCall->setType(Context.VoidTy);
1927   return false;
1928 }
1929 
1930 bool Sema::SemaBuiltinVAStartARM(CallExpr *Call) {
1931   // void __va_start(va_list *ap, const char *named_addr, size_t slot_size,
1932   //                 const char *named_addr);
1933 
1934   Expr *Func = Call->getCallee();
1935 
1936   if (Call->getNumArgs() < 3)
1937     return Diag(Call->getLocEnd(),
1938                 diag::err_typecheck_call_too_few_args_at_least)
1939            << 0 /*function call*/ << 3 << Call->getNumArgs();
1940 
1941   // Determine whether the current function is variadic or not.
1942   bool IsVariadic;
1943   if (BlockScopeInfo *CurBlock = getCurBlock())
1944     IsVariadic = CurBlock->TheDecl->isVariadic();
1945   else if (FunctionDecl *FD = getCurFunctionDecl())
1946     IsVariadic = FD->isVariadic();
1947   else if (ObjCMethodDecl *MD = getCurMethodDecl())
1948     IsVariadic = MD->isVariadic();
1949   else
1950     llvm_unreachable("unexpected statement type");
1951 
1952   if (!IsVariadic) {
1953     Diag(Func->getLocStart(), diag::err_va_start_used_in_non_variadic_function);
1954     return true;
1955   }
1956 
1957   // Type-check the first argument normally.
1958   if (checkBuiltinArgument(*this, Call, 0))
1959     return true;
1960 
1961   static const struct {
1962     unsigned ArgNo;
1963     QualType Type;
1964   } ArgumentTypes[] = {
1965     { 1, Context.getPointerType(Context.CharTy.withConst()) },
1966     { 2, Context.getSizeType() },
1967   };
1968 
1969   for (const auto &AT : ArgumentTypes) {
1970     const Expr *Arg = Call->getArg(AT.ArgNo)->IgnoreParens();
1971     if (Arg->getType().getCanonicalType() == AT.Type.getCanonicalType())
1972       continue;
1973     Diag(Arg->getLocStart(), diag::err_typecheck_convert_incompatible)
1974       << Arg->getType() << AT.Type << 1 /* different class */
1975       << 0 /* qualifier difference */ << 3 /* parameter mismatch */
1976       << AT.ArgNo + 1 << Arg->getType() << AT.Type;
1977   }
1978 
1979   return false;
1980 }
1981 
1982 /// SemaBuiltinUnorderedCompare - Handle functions like __builtin_isgreater and
1983 /// friends.  This is declared to take (...), so we have to check everything.
1984 bool Sema::SemaBuiltinUnorderedCompare(CallExpr *TheCall) {
1985   if (TheCall->getNumArgs() < 2)
1986     return Diag(TheCall->getLocEnd(), diag::err_typecheck_call_too_few_args)
1987       << 0 << 2 << TheCall->getNumArgs()/*function call*/;
1988   if (TheCall->getNumArgs() > 2)
1989     return Diag(TheCall->getArg(2)->getLocStart(),
1990                 diag::err_typecheck_call_too_many_args)
1991       << 0 /*function call*/ << 2 << TheCall->getNumArgs()
1992       << SourceRange(TheCall->getArg(2)->getLocStart(),
1993                      (*(TheCall->arg_end()-1))->getLocEnd());
1994 
1995   ExprResult OrigArg0 = TheCall->getArg(0);
1996   ExprResult OrigArg1 = TheCall->getArg(1);
1997 
1998   // Do standard promotions between the two arguments, returning their common
1999   // type.
2000   QualType Res = UsualArithmeticConversions(OrigArg0, OrigArg1, false);
2001   if (OrigArg0.isInvalid() || OrigArg1.isInvalid())
2002     return true;
2003 
2004   // Make sure any conversions are pushed back into the call; this is
2005   // type safe since unordered compare builtins are declared as "_Bool
2006   // foo(...)".
2007   TheCall->setArg(0, OrigArg0.get());
2008   TheCall->setArg(1, OrigArg1.get());
2009 
2010   if (OrigArg0.get()->isTypeDependent() || OrigArg1.get()->isTypeDependent())
2011     return false;
2012 
2013   // If the common type isn't a real floating type, then the arguments were
2014   // invalid for this operation.
2015   if (Res.isNull() || !Res->isRealFloatingType())
2016     return Diag(OrigArg0.get()->getLocStart(),
2017                 diag::err_typecheck_call_invalid_ordered_compare)
2018       << OrigArg0.get()->getType() << OrigArg1.get()->getType()
2019       << SourceRange(OrigArg0.get()->getLocStart(), OrigArg1.get()->getLocEnd());
2020 
2021   return false;
2022 }
2023 
2024 /// SemaBuiltinSemaBuiltinFPClassification - Handle functions like
2025 /// __builtin_isnan and friends.  This is declared to take (...), so we have
2026 /// to check everything. We expect the last argument to be a floating point
2027 /// value.
2028 bool Sema::SemaBuiltinFPClassification(CallExpr *TheCall, unsigned NumArgs) {
2029   if (TheCall->getNumArgs() < NumArgs)
2030     return Diag(TheCall->getLocEnd(), diag::err_typecheck_call_too_few_args)
2031       << 0 << NumArgs << TheCall->getNumArgs()/*function call*/;
2032   if (TheCall->getNumArgs() > NumArgs)
2033     return Diag(TheCall->getArg(NumArgs)->getLocStart(),
2034                 diag::err_typecheck_call_too_many_args)
2035       << 0 /*function call*/ << NumArgs << TheCall->getNumArgs()
2036       << SourceRange(TheCall->getArg(NumArgs)->getLocStart(),
2037                      (*(TheCall->arg_end()-1))->getLocEnd());
2038 
2039   Expr *OrigArg = TheCall->getArg(NumArgs-1);
2040 
2041   if (OrigArg->isTypeDependent())
2042     return false;
2043 
2044   // This operation requires a non-_Complex floating-point number.
2045   if (!OrigArg->getType()->isRealFloatingType())
2046     return Diag(OrigArg->getLocStart(),
2047                 diag::err_typecheck_call_invalid_unary_fp)
2048       << OrigArg->getType() << OrigArg->getSourceRange();
2049 
2050   // If this is an implicit conversion from float -> double, remove it.
2051   if (ImplicitCastExpr *Cast = dyn_cast<ImplicitCastExpr>(OrigArg)) {
2052     Expr *CastArg = Cast->getSubExpr();
2053     if (CastArg->getType()->isSpecificBuiltinType(BuiltinType::Float)) {
2054       assert(Cast->getType()->isSpecificBuiltinType(BuiltinType::Double) &&
2055              "promotion from float to double is the only expected cast here");
2056       Cast->setSubExpr(nullptr);
2057       TheCall->setArg(NumArgs-1, CastArg);
2058     }
2059   }
2060 
2061   return false;
2062 }
2063 
2064 /// SemaBuiltinShuffleVector - Handle __builtin_shufflevector.
2065 // This is declared to take (...), so we have to check everything.
2066 ExprResult Sema::SemaBuiltinShuffleVector(CallExpr *TheCall) {
2067   if (TheCall->getNumArgs() < 2)
2068     return ExprError(Diag(TheCall->getLocEnd(),
2069                           diag::err_typecheck_call_too_few_args_at_least)
2070                      << 0 /*function call*/ << 2 << TheCall->getNumArgs()
2071                      << TheCall->getSourceRange());
2072 
2073   // Determine which of the following types of shufflevector we're checking:
2074   // 1) unary, vector mask: (lhs, mask)
2075   // 2) binary, vector mask: (lhs, rhs, mask)
2076   // 3) binary, scalar mask: (lhs, rhs, index, ..., index)
2077   QualType resType = TheCall->getArg(0)->getType();
2078   unsigned numElements = 0;
2079 
2080   if (!TheCall->getArg(0)->isTypeDependent() &&
2081       !TheCall->getArg(1)->isTypeDependent()) {
2082     QualType LHSType = TheCall->getArg(0)->getType();
2083     QualType RHSType = TheCall->getArg(1)->getType();
2084 
2085     if (!LHSType->isVectorType() || !RHSType->isVectorType())
2086       return ExprError(Diag(TheCall->getLocStart(),
2087                             diag::err_shufflevector_non_vector)
2088                        << SourceRange(TheCall->getArg(0)->getLocStart(),
2089                                       TheCall->getArg(1)->getLocEnd()));
2090 
2091     numElements = LHSType->getAs<VectorType>()->getNumElements();
2092     unsigned numResElements = TheCall->getNumArgs() - 2;
2093 
2094     // Check to see if we have a call with 2 vector arguments, the unary shuffle
2095     // with mask.  If so, verify that RHS is an integer vector type with the
2096     // same number of elts as lhs.
2097     if (TheCall->getNumArgs() == 2) {
2098       if (!RHSType->hasIntegerRepresentation() ||
2099           RHSType->getAs<VectorType>()->getNumElements() != numElements)
2100         return ExprError(Diag(TheCall->getLocStart(),
2101                               diag::err_shufflevector_incompatible_vector)
2102                          << SourceRange(TheCall->getArg(1)->getLocStart(),
2103                                         TheCall->getArg(1)->getLocEnd()));
2104     } else if (!Context.hasSameUnqualifiedType(LHSType, RHSType)) {
2105       return ExprError(Diag(TheCall->getLocStart(),
2106                             diag::err_shufflevector_incompatible_vector)
2107                        << SourceRange(TheCall->getArg(0)->getLocStart(),
2108                                       TheCall->getArg(1)->getLocEnd()));
2109     } else if (numElements != numResElements) {
2110       QualType eltType = LHSType->getAs<VectorType>()->getElementType();
2111       resType = Context.getVectorType(eltType, numResElements,
2112                                       VectorType::GenericVector);
2113     }
2114   }
2115 
2116   for (unsigned i = 2; i < TheCall->getNumArgs(); i++) {
2117     if (TheCall->getArg(i)->isTypeDependent() ||
2118         TheCall->getArg(i)->isValueDependent())
2119       continue;
2120 
2121     llvm::APSInt Result(32);
2122     if (!TheCall->getArg(i)->isIntegerConstantExpr(Result, Context))
2123       return ExprError(Diag(TheCall->getLocStart(),
2124                             diag::err_shufflevector_nonconstant_argument)
2125                        << TheCall->getArg(i)->getSourceRange());
2126 
2127     // Allow -1 which will be translated to undef in the IR.
2128     if (Result.isSigned() && Result.isAllOnesValue())
2129       continue;
2130 
2131     if (Result.getActiveBits() > 64 || Result.getZExtValue() >= numElements*2)
2132       return ExprError(Diag(TheCall->getLocStart(),
2133                             diag::err_shufflevector_argument_too_large)
2134                        << TheCall->getArg(i)->getSourceRange());
2135   }
2136 
2137   SmallVector<Expr*, 32> exprs;
2138 
2139   for (unsigned i = 0, e = TheCall->getNumArgs(); i != e; i++) {
2140     exprs.push_back(TheCall->getArg(i));
2141     TheCall->setArg(i, nullptr);
2142   }
2143 
2144   return new (Context) ShuffleVectorExpr(Context, exprs, resType,
2145                                          TheCall->getCallee()->getLocStart(),
2146                                          TheCall->getRParenLoc());
2147 }
2148 
2149 /// SemaConvertVectorExpr - Handle __builtin_convertvector
2150 ExprResult Sema::SemaConvertVectorExpr(Expr *E, TypeSourceInfo *TInfo,
2151                                        SourceLocation BuiltinLoc,
2152                                        SourceLocation RParenLoc) {
2153   ExprValueKind VK = VK_RValue;
2154   ExprObjectKind OK = OK_Ordinary;
2155   QualType DstTy = TInfo->getType();
2156   QualType SrcTy = E->getType();
2157 
2158   if (!SrcTy->isVectorType() && !SrcTy->isDependentType())
2159     return ExprError(Diag(BuiltinLoc,
2160                           diag::err_convertvector_non_vector)
2161                      << E->getSourceRange());
2162   if (!DstTy->isVectorType() && !DstTy->isDependentType())
2163     return ExprError(Diag(BuiltinLoc,
2164                           diag::err_convertvector_non_vector_type));
2165 
2166   if (!SrcTy->isDependentType() && !DstTy->isDependentType()) {
2167     unsigned SrcElts = SrcTy->getAs<VectorType>()->getNumElements();
2168     unsigned DstElts = DstTy->getAs<VectorType>()->getNumElements();
2169     if (SrcElts != DstElts)
2170       return ExprError(Diag(BuiltinLoc,
2171                             diag::err_convertvector_incompatible_vector)
2172                        << E->getSourceRange());
2173   }
2174 
2175   return new (Context)
2176       ConvertVectorExpr(E, TInfo, DstTy, VK, OK, BuiltinLoc, RParenLoc);
2177 }
2178 
2179 /// SemaBuiltinPrefetch - Handle __builtin_prefetch.
2180 // This is declared to take (const void*, ...) and can take two
2181 // optional constant int args.
2182 bool Sema::SemaBuiltinPrefetch(CallExpr *TheCall) {
2183   unsigned NumArgs = TheCall->getNumArgs();
2184 
2185   if (NumArgs > 3)
2186     return Diag(TheCall->getLocEnd(),
2187              diag::err_typecheck_call_too_many_args_at_most)
2188              << 0 /*function call*/ << 3 << NumArgs
2189              << TheCall->getSourceRange();
2190 
2191   // Argument 0 is checked for us and the remaining arguments must be
2192   // constant integers.
2193   for (unsigned i = 1; i != NumArgs; ++i)
2194     if (SemaBuiltinConstantArgRange(TheCall, i, 0, i == 1 ? 1 : 3))
2195       return true;
2196 
2197   return false;
2198 }
2199 
2200 /// SemaBuiltinAssume - Handle __assume (MS Extension).
2201 // __assume does not evaluate its arguments, and should warn if its argument
2202 // has side effects.
2203 bool Sema::SemaBuiltinAssume(CallExpr *TheCall) {
2204   Expr *Arg = TheCall->getArg(0);
2205   if (Arg->isInstantiationDependent()) return false;
2206 
2207   if (Arg->HasSideEffects(Context))
2208     return Diag(Arg->getLocStart(), diag::warn_assume_side_effects)
2209       << Arg->getSourceRange()
2210       << cast<FunctionDecl>(TheCall->getCalleeDecl())->getIdentifier();
2211 
2212   return false;
2213 }
2214 
2215 /// Handle __builtin_assume_aligned. This is declared
2216 /// as (const void*, size_t, ...) and can take one optional constant int arg.
2217 bool Sema::SemaBuiltinAssumeAligned(CallExpr *TheCall) {
2218   unsigned NumArgs = TheCall->getNumArgs();
2219 
2220   if (NumArgs > 3)
2221     return Diag(TheCall->getLocEnd(),
2222              diag::err_typecheck_call_too_many_args_at_most)
2223              << 0 /*function call*/ << 3 << NumArgs
2224              << TheCall->getSourceRange();
2225 
2226   // The alignment must be a constant integer.
2227   Expr *Arg = TheCall->getArg(1);
2228 
2229   // We can't check the value of a dependent argument.
2230   if (!Arg->isTypeDependent() && !Arg->isValueDependent()) {
2231     llvm::APSInt Result;
2232     if (SemaBuiltinConstantArg(TheCall, 1, Result))
2233       return true;
2234 
2235     if (!Result.isPowerOf2())
2236       return Diag(TheCall->getLocStart(),
2237                   diag::err_alignment_not_power_of_two)
2238            << Arg->getSourceRange();
2239   }
2240 
2241   if (NumArgs > 2) {
2242     ExprResult Arg(TheCall->getArg(2));
2243     InitializedEntity Entity = InitializedEntity::InitializeParameter(Context,
2244       Context.getSizeType(), false);
2245     Arg = PerformCopyInitialization(Entity, SourceLocation(), Arg);
2246     if (Arg.isInvalid()) return true;
2247     TheCall->setArg(2, Arg.get());
2248   }
2249 
2250   return false;
2251 }
2252 
2253 /// SemaBuiltinConstantArg - Handle a check if argument ArgNum of CallExpr
2254 /// TheCall is a constant expression.
2255 bool Sema::SemaBuiltinConstantArg(CallExpr *TheCall, int ArgNum,
2256                                   llvm::APSInt &Result) {
2257   Expr *Arg = TheCall->getArg(ArgNum);
2258   DeclRefExpr *DRE =cast<DeclRefExpr>(TheCall->getCallee()->IgnoreParenCasts());
2259   FunctionDecl *FDecl = cast<FunctionDecl>(DRE->getDecl());
2260 
2261   if (Arg->isTypeDependent() || Arg->isValueDependent()) return false;
2262 
2263   if (!Arg->isIntegerConstantExpr(Result, Context))
2264     return Diag(TheCall->getLocStart(), diag::err_constant_integer_arg_type)
2265                 << FDecl->getDeclName() <<  Arg->getSourceRange();
2266 
2267   return false;
2268 }
2269 
2270 /// SemaBuiltinConstantArgRange - Handle a check if argument ArgNum of CallExpr
2271 /// TheCall is a constant expression in the range [Low, High].
2272 bool Sema::SemaBuiltinConstantArgRange(CallExpr *TheCall, int ArgNum,
2273                                        int Low, int High) {
2274   llvm::APSInt Result;
2275 
2276   // We can't check the value of a dependent argument.
2277   Expr *Arg = TheCall->getArg(ArgNum);
2278   if (Arg->isTypeDependent() || Arg->isValueDependent())
2279     return false;
2280 
2281   // Check constant-ness first.
2282   if (SemaBuiltinConstantArg(TheCall, ArgNum, Result))
2283     return true;
2284 
2285   if (Result.getSExtValue() < Low || Result.getSExtValue() > High)
2286     return Diag(TheCall->getLocStart(), diag::err_argument_invalid_range)
2287       << Low << High << Arg->getSourceRange();
2288 
2289   return false;
2290 }
2291 
2292 /// SemaBuiltinLongjmp - Handle __builtin_longjmp(void *env[5], int val).
2293 /// This checks that val is a constant 1.
2294 bool Sema::SemaBuiltinLongjmp(CallExpr *TheCall) {
2295   Expr *Arg = TheCall->getArg(1);
2296   llvm::APSInt Result;
2297 
2298   // TODO: This is less than ideal. Overload this to take a value.
2299   if (SemaBuiltinConstantArg(TheCall, 1, Result))
2300     return true;
2301 
2302   if (Result != 1)
2303     return Diag(TheCall->getLocStart(), diag::err_builtin_longjmp_invalid_val)
2304              << SourceRange(Arg->getLocStart(), Arg->getLocEnd());
2305 
2306   return false;
2307 }
2308 
2309 namespace {
2310 enum StringLiteralCheckType {
2311   SLCT_NotALiteral,
2312   SLCT_UncheckedLiteral,
2313   SLCT_CheckedLiteral
2314 };
2315 }
2316 
2317 // Determine if an expression is a string literal or constant string.
2318 // If this function returns false on the arguments to a function expecting a
2319 // format string, we will usually need to emit a warning.
2320 // True string literals are then checked by CheckFormatString.
2321 static StringLiteralCheckType
2322 checkFormatStringExpr(Sema &S, const Expr *E, ArrayRef<const Expr *> Args,
2323                       bool HasVAListArg, unsigned format_idx,
2324                       unsigned firstDataArg, Sema::FormatStringType Type,
2325                       Sema::VariadicCallType CallType, bool InFunctionCall,
2326                       llvm::SmallBitVector &CheckedVarArgs) {
2327  tryAgain:
2328   if (E->isTypeDependent() || E->isValueDependent())
2329     return SLCT_NotALiteral;
2330 
2331   E = E->IgnoreParenCasts();
2332 
2333   if (E->isNullPointerConstant(S.Context, Expr::NPC_ValueDependentIsNotNull))
2334     // Technically -Wformat-nonliteral does not warn about this case.
2335     // The behavior of printf and friends in this case is implementation
2336     // dependent.  Ideally if the format string cannot be null then
2337     // it should have a 'nonnull' attribute in the function prototype.
2338     return SLCT_UncheckedLiteral;
2339 
2340   switch (E->getStmtClass()) {
2341   case Stmt::BinaryConditionalOperatorClass:
2342   case Stmt::ConditionalOperatorClass: {
2343     // The expression is a literal if both sub-expressions were, and it was
2344     // completely checked only if both sub-expressions were checked.
2345     const AbstractConditionalOperator *C =
2346         cast<AbstractConditionalOperator>(E);
2347     StringLiteralCheckType Left =
2348         checkFormatStringExpr(S, C->getTrueExpr(), Args,
2349                               HasVAListArg, format_idx, firstDataArg,
2350                               Type, CallType, InFunctionCall, CheckedVarArgs);
2351     if (Left == SLCT_NotALiteral)
2352       return SLCT_NotALiteral;
2353     StringLiteralCheckType Right =
2354         checkFormatStringExpr(S, C->getFalseExpr(), Args,
2355                               HasVAListArg, format_idx, firstDataArg,
2356                               Type, CallType, InFunctionCall, CheckedVarArgs);
2357     return Left < Right ? Left : Right;
2358   }
2359 
2360   case Stmt::ImplicitCastExprClass: {
2361     E = cast<ImplicitCastExpr>(E)->getSubExpr();
2362     goto tryAgain;
2363   }
2364 
2365   case Stmt::OpaqueValueExprClass:
2366     if (const Expr *src = cast<OpaqueValueExpr>(E)->getSourceExpr()) {
2367       E = src;
2368       goto tryAgain;
2369     }
2370     return SLCT_NotALiteral;
2371 
2372   case Stmt::PredefinedExprClass:
2373     // While __func__, etc., are technically not string literals, they
2374     // cannot contain format specifiers and thus are not a security
2375     // liability.
2376     return SLCT_UncheckedLiteral;
2377 
2378   case Stmt::DeclRefExprClass: {
2379     const DeclRefExpr *DR = cast<DeclRefExpr>(E);
2380 
2381     // As an exception, do not flag errors for variables binding to
2382     // const string literals.
2383     if (const VarDecl *VD = dyn_cast<VarDecl>(DR->getDecl())) {
2384       bool isConstant = false;
2385       QualType T = DR->getType();
2386 
2387       if (const ArrayType *AT = S.Context.getAsArrayType(T)) {
2388         isConstant = AT->getElementType().isConstant(S.Context);
2389       } else if (const PointerType *PT = T->getAs<PointerType>()) {
2390         isConstant = T.isConstant(S.Context) &&
2391                      PT->getPointeeType().isConstant(S.Context);
2392       } else if (T->isObjCObjectPointerType()) {
2393         // In ObjC, there is usually no "const ObjectPointer" type,
2394         // so don't check if the pointee type is constant.
2395         isConstant = T.isConstant(S.Context);
2396       }
2397 
2398       if (isConstant) {
2399         if (const Expr *Init = VD->getAnyInitializer()) {
2400           // Look through initializers like const char c[] = { "foo" }
2401           if (const InitListExpr *InitList = dyn_cast<InitListExpr>(Init)) {
2402             if (InitList->isStringLiteralInit())
2403               Init = InitList->getInit(0)->IgnoreParenImpCasts();
2404           }
2405           return checkFormatStringExpr(S, Init, Args,
2406                                        HasVAListArg, format_idx,
2407                                        firstDataArg, Type, CallType,
2408                                        /*InFunctionCall*/false, CheckedVarArgs);
2409         }
2410       }
2411 
2412       // For vprintf* functions (i.e., HasVAListArg==true), we add a
2413       // special check to see if the format string is a function parameter
2414       // of the function calling the printf function.  If the function
2415       // has an attribute indicating it is a printf-like function, then we
2416       // should suppress warnings concerning non-literals being used in a call
2417       // to a vprintf function.  For example:
2418       //
2419       // void
2420       // logmessage(char const *fmt __attribute__ (format (printf, 1, 2)), ...){
2421       //      va_list ap;
2422       //      va_start(ap, fmt);
2423       //      vprintf(fmt, ap);  // Do NOT emit a warning about "fmt".
2424       //      ...
2425       // }
2426       if (HasVAListArg) {
2427         if (const ParmVarDecl *PV = dyn_cast<ParmVarDecl>(VD)) {
2428           if (const NamedDecl *ND = dyn_cast<NamedDecl>(PV->getDeclContext())) {
2429             int PVIndex = PV->getFunctionScopeIndex() + 1;
2430             for (const auto *PVFormat : ND->specific_attrs<FormatAttr>()) {
2431               // adjust for implicit parameter
2432               if (const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(ND))
2433                 if (MD->isInstance())
2434                   ++PVIndex;
2435               // We also check if the formats are compatible.
2436               // We can't pass a 'scanf' string to a 'printf' function.
2437               if (PVIndex == PVFormat->getFormatIdx() &&
2438                   Type == S.GetFormatStringType(PVFormat))
2439                 return SLCT_UncheckedLiteral;
2440             }
2441           }
2442         }
2443       }
2444     }
2445 
2446     return SLCT_NotALiteral;
2447   }
2448 
2449   case Stmt::CallExprClass:
2450   case Stmt::CXXMemberCallExprClass: {
2451     const CallExpr *CE = cast<CallExpr>(E);
2452     if (const NamedDecl *ND = dyn_cast_or_null<NamedDecl>(CE->getCalleeDecl())) {
2453       if (const FormatArgAttr *FA = ND->getAttr<FormatArgAttr>()) {
2454         unsigned ArgIndex = FA->getFormatIdx();
2455         if (const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(ND))
2456           if (MD->isInstance())
2457             --ArgIndex;
2458         const Expr *Arg = CE->getArg(ArgIndex - 1);
2459 
2460         return checkFormatStringExpr(S, Arg, Args,
2461                                      HasVAListArg, format_idx, firstDataArg,
2462                                      Type, CallType, InFunctionCall,
2463                                      CheckedVarArgs);
2464       } else if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(ND)) {
2465         unsigned BuiltinID = FD->getBuiltinID();
2466         if (BuiltinID == Builtin::BI__builtin___CFStringMakeConstantString ||
2467             BuiltinID == Builtin::BI__builtin___NSStringMakeConstantString) {
2468           const Expr *Arg = CE->getArg(0);
2469           return checkFormatStringExpr(S, Arg, Args,
2470                                        HasVAListArg, format_idx,
2471                                        firstDataArg, Type, CallType,
2472                                        InFunctionCall, CheckedVarArgs);
2473         }
2474       }
2475     }
2476 
2477     return SLCT_NotALiteral;
2478   }
2479   case Stmt::ObjCStringLiteralClass:
2480   case Stmt::StringLiteralClass: {
2481     const StringLiteral *StrE = nullptr;
2482 
2483     if (const ObjCStringLiteral *ObjCFExpr = dyn_cast<ObjCStringLiteral>(E))
2484       StrE = ObjCFExpr->getString();
2485     else
2486       StrE = cast<StringLiteral>(E);
2487 
2488     if (StrE) {
2489       S.CheckFormatString(StrE, E, Args, HasVAListArg, format_idx, firstDataArg,
2490                           Type, InFunctionCall, CallType, CheckedVarArgs);
2491       return SLCT_CheckedLiteral;
2492     }
2493 
2494     return SLCT_NotALiteral;
2495   }
2496 
2497   default:
2498     return SLCT_NotALiteral;
2499   }
2500 }
2501 
2502 Sema::FormatStringType Sema::GetFormatStringType(const FormatAttr *Format) {
2503   return llvm::StringSwitch<FormatStringType>(Format->getType()->getName())
2504   .Case("scanf", FST_Scanf)
2505   .Cases("printf", "printf0", FST_Printf)
2506   .Cases("NSString", "CFString", FST_NSString)
2507   .Case("strftime", FST_Strftime)
2508   .Case("strfmon", FST_Strfmon)
2509   .Cases("kprintf", "cmn_err", "vcmn_err", "zcmn_err", FST_Kprintf)
2510   .Default(FST_Unknown);
2511 }
2512 
2513 /// CheckFormatArguments - Check calls to printf and scanf (and similar
2514 /// functions) for correct use of format strings.
2515 /// Returns true if a format string has been fully checked.
2516 bool Sema::CheckFormatArguments(const FormatAttr *Format,
2517                                 ArrayRef<const Expr *> Args,
2518                                 bool IsCXXMember,
2519                                 VariadicCallType CallType,
2520                                 SourceLocation Loc, SourceRange Range,
2521                                 llvm::SmallBitVector &CheckedVarArgs) {
2522   FormatStringInfo FSI;
2523   if (getFormatStringInfo(Format, IsCXXMember, &FSI))
2524     return CheckFormatArguments(Args, FSI.HasVAListArg, FSI.FormatIdx,
2525                                 FSI.FirstDataArg, GetFormatStringType(Format),
2526                                 CallType, Loc, Range, CheckedVarArgs);
2527   return false;
2528 }
2529 
2530 bool Sema::CheckFormatArguments(ArrayRef<const Expr *> Args,
2531                                 bool HasVAListArg, unsigned format_idx,
2532                                 unsigned firstDataArg, FormatStringType Type,
2533                                 VariadicCallType CallType,
2534                                 SourceLocation Loc, SourceRange Range,
2535                                 llvm::SmallBitVector &CheckedVarArgs) {
2536   // CHECK: printf/scanf-like function is called with no format string.
2537   if (format_idx >= Args.size()) {
2538     Diag(Loc, diag::warn_missing_format_string) << Range;
2539     return false;
2540   }
2541 
2542   const Expr *OrigFormatExpr = Args[format_idx]->IgnoreParenCasts();
2543 
2544   // CHECK: format string is not a string literal.
2545   //
2546   // Dynamically generated format strings are difficult to
2547   // automatically vet at compile time.  Requiring that format strings
2548   // are string literals: (1) permits the checking of format strings by
2549   // the compiler and thereby (2) can practically remove the source of
2550   // many format string exploits.
2551 
2552   // Format string can be either ObjC string (e.g. @"%d") or
2553   // C string (e.g. "%d")
2554   // ObjC string uses the same format specifiers as C string, so we can use
2555   // the same format string checking logic for both ObjC and C strings.
2556   StringLiteralCheckType CT =
2557       checkFormatStringExpr(*this, OrigFormatExpr, Args, HasVAListArg,
2558                             format_idx, firstDataArg, Type, CallType,
2559                             /*IsFunctionCall*/true, CheckedVarArgs);
2560   if (CT != SLCT_NotALiteral)
2561     // Literal format string found, check done!
2562     return CT == SLCT_CheckedLiteral;
2563 
2564   // Strftime is particular as it always uses a single 'time' argument,
2565   // so it is safe to pass a non-literal string.
2566   if (Type == FST_Strftime)
2567     return false;
2568 
2569   // Do not emit diag when the string param is a macro expansion and the
2570   // format is either NSString or CFString. This is a hack to prevent
2571   // diag when using the NSLocalizedString and CFCopyLocalizedString macros
2572   // which are usually used in place of NS and CF string literals.
2573   if (Type == FST_NSString &&
2574       SourceMgr.isInSystemMacro(Args[format_idx]->getLocStart()))
2575     return false;
2576 
2577   // If there are no arguments specified, warn with -Wformat-security, otherwise
2578   // warn only with -Wformat-nonliteral.
2579   if (Args.size() == firstDataArg)
2580     Diag(Args[format_idx]->getLocStart(),
2581          diag::warn_format_nonliteral_noargs)
2582       << OrigFormatExpr->getSourceRange();
2583   else
2584     Diag(Args[format_idx]->getLocStart(),
2585          diag::warn_format_nonliteral)
2586            << OrigFormatExpr->getSourceRange();
2587   return false;
2588 }
2589 
2590 namespace {
2591 class CheckFormatHandler : public analyze_format_string::FormatStringHandler {
2592 protected:
2593   Sema &S;
2594   const StringLiteral *FExpr;
2595   const Expr *OrigFormatExpr;
2596   const unsigned FirstDataArg;
2597   const unsigned NumDataArgs;
2598   const char *Beg; // Start of format string.
2599   const bool HasVAListArg;
2600   ArrayRef<const Expr *> Args;
2601   unsigned FormatIdx;
2602   llvm::SmallBitVector CoveredArgs;
2603   bool usesPositionalArgs;
2604   bool atFirstArg;
2605   bool inFunctionCall;
2606   Sema::VariadicCallType CallType;
2607   llvm::SmallBitVector &CheckedVarArgs;
2608 public:
2609   CheckFormatHandler(Sema &s, const StringLiteral *fexpr,
2610                      const Expr *origFormatExpr, unsigned firstDataArg,
2611                      unsigned numDataArgs, const char *beg, bool hasVAListArg,
2612                      ArrayRef<const Expr *> Args,
2613                      unsigned formatIdx, bool inFunctionCall,
2614                      Sema::VariadicCallType callType,
2615                      llvm::SmallBitVector &CheckedVarArgs)
2616     : S(s), FExpr(fexpr), OrigFormatExpr(origFormatExpr),
2617       FirstDataArg(firstDataArg), NumDataArgs(numDataArgs),
2618       Beg(beg), HasVAListArg(hasVAListArg),
2619       Args(Args), FormatIdx(formatIdx),
2620       usesPositionalArgs(false), atFirstArg(true),
2621       inFunctionCall(inFunctionCall), CallType(callType),
2622       CheckedVarArgs(CheckedVarArgs) {
2623     CoveredArgs.resize(numDataArgs);
2624     CoveredArgs.reset();
2625   }
2626 
2627   void DoneProcessing();
2628 
2629   void HandleIncompleteSpecifier(const char *startSpecifier,
2630                                  unsigned specifierLen) override;
2631 
2632   void HandleInvalidLengthModifier(
2633                            const analyze_format_string::FormatSpecifier &FS,
2634                            const analyze_format_string::ConversionSpecifier &CS,
2635                            const char *startSpecifier, unsigned specifierLen,
2636                            unsigned DiagID);
2637 
2638   void HandleNonStandardLengthModifier(
2639                     const analyze_format_string::FormatSpecifier &FS,
2640                     const char *startSpecifier, unsigned specifierLen);
2641 
2642   void HandleNonStandardConversionSpecifier(
2643                     const analyze_format_string::ConversionSpecifier &CS,
2644                     const char *startSpecifier, unsigned specifierLen);
2645 
2646   void HandlePosition(const char *startPos, unsigned posLen) override;
2647 
2648   void HandleInvalidPosition(const char *startSpecifier,
2649                              unsigned specifierLen,
2650                              analyze_format_string::PositionContext p) override;
2651 
2652   void HandleZeroPosition(const char *startPos, unsigned posLen) override;
2653 
2654   void HandleNullChar(const char *nullCharacter) override;
2655 
2656   template <typename Range>
2657   static void EmitFormatDiagnostic(Sema &S, bool inFunctionCall,
2658                                    const Expr *ArgumentExpr,
2659                                    PartialDiagnostic PDiag,
2660                                    SourceLocation StringLoc,
2661                                    bool IsStringLocation, Range StringRange,
2662                                    ArrayRef<FixItHint> Fixit = None);
2663 
2664 protected:
2665   bool HandleInvalidConversionSpecifier(unsigned argIndex, SourceLocation Loc,
2666                                         const char *startSpec,
2667                                         unsigned specifierLen,
2668                                         const char *csStart, unsigned csLen);
2669 
2670   void HandlePositionalNonpositionalArgs(SourceLocation Loc,
2671                                          const char *startSpec,
2672                                          unsigned specifierLen);
2673 
2674   SourceRange getFormatStringRange();
2675   CharSourceRange getSpecifierRange(const char *startSpecifier,
2676                                     unsigned specifierLen);
2677   SourceLocation getLocationOfByte(const char *x);
2678 
2679   const Expr *getDataArg(unsigned i) const;
2680 
2681   bool CheckNumArgs(const analyze_format_string::FormatSpecifier &FS,
2682                     const analyze_format_string::ConversionSpecifier &CS,
2683                     const char *startSpecifier, unsigned specifierLen,
2684                     unsigned argIndex);
2685 
2686   template <typename Range>
2687   void EmitFormatDiagnostic(PartialDiagnostic PDiag, SourceLocation StringLoc,
2688                             bool IsStringLocation, Range StringRange,
2689                             ArrayRef<FixItHint> Fixit = None);
2690 };
2691 }
2692 
2693 SourceRange CheckFormatHandler::getFormatStringRange() {
2694   return OrigFormatExpr->getSourceRange();
2695 }
2696 
2697 CharSourceRange CheckFormatHandler::
2698 getSpecifierRange(const char *startSpecifier, unsigned specifierLen) {
2699   SourceLocation Start = getLocationOfByte(startSpecifier);
2700   SourceLocation End   = getLocationOfByte(startSpecifier + specifierLen - 1);
2701 
2702   // Advance the end SourceLocation by one due to half-open ranges.
2703   End = End.getLocWithOffset(1);
2704 
2705   return CharSourceRange::getCharRange(Start, End);
2706 }
2707 
2708 SourceLocation CheckFormatHandler::getLocationOfByte(const char *x) {
2709   return S.getLocationOfStringLiteralByte(FExpr, x - Beg);
2710 }
2711 
2712 void CheckFormatHandler::HandleIncompleteSpecifier(const char *startSpecifier,
2713                                                    unsigned specifierLen){
2714   EmitFormatDiagnostic(S.PDiag(diag::warn_printf_incomplete_specifier),
2715                        getLocationOfByte(startSpecifier),
2716                        /*IsStringLocation*/true,
2717                        getSpecifierRange(startSpecifier, specifierLen));
2718 }
2719 
2720 void CheckFormatHandler::HandleInvalidLengthModifier(
2721     const analyze_format_string::FormatSpecifier &FS,
2722     const analyze_format_string::ConversionSpecifier &CS,
2723     const char *startSpecifier, unsigned specifierLen, unsigned DiagID) {
2724   using namespace analyze_format_string;
2725 
2726   const LengthModifier &LM = FS.getLengthModifier();
2727   CharSourceRange LMRange = getSpecifierRange(LM.getStart(), LM.getLength());
2728 
2729   // See if we know how to fix this length modifier.
2730   Optional<LengthModifier> FixedLM = FS.getCorrectedLengthModifier();
2731   if (FixedLM) {
2732     EmitFormatDiagnostic(S.PDiag(DiagID) << LM.toString() << CS.toString(),
2733                          getLocationOfByte(LM.getStart()),
2734                          /*IsStringLocation*/true,
2735                          getSpecifierRange(startSpecifier, specifierLen));
2736 
2737     S.Diag(getLocationOfByte(LM.getStart()), diag::note_format_fix_specifier)
2738       << FixedLM->toString()
2739       << FixItHint::CreateReplacement(LMRange, FixedLM->toString());
2740 
2741   } else {
2742     FixItHint Hint;
2743     if (DiagID == diag::warn_format_nonsensical_length)
2744       Hint = FixItHint::CreateRemoval(LMRange);
2745 
2746     EmitFormatDiagnostic(S.PDiag(DiagID) << LM.toString() << CS.toString(),
2747                          getLocationOfByte(LM.getStart()),
2748                          /*IsStringLocation*/true,
2749                          getSpecifierRange(startSpecifier, specifierLen),
2750                          Hint);
2751   }
2752 }
2753 
2754 void CheckFormatHandler::HandleNonStandardLengthModifier(
2755     const analyze_format_string::FormatSpecifier &FS,
2756     const char *startSpecifier, unsigned specifierLen) {
2757   using namespace analyze_format_string;
2758 
2759   const LengthModifier &LM = FS.getLengthModifier();
2760   CharSourceRange LMRange = getSpecifierRange(LM.getStart(), LM.getLength());
2761 
2762   // See if we know how to fix this length modifier.
2763   Optional<LengthModifier> FixedLM = FS.getCorrectedLengthModifier();
2764   if (FixedLM) {
2765     EmitFormatDiagnostic(S.PDiag(diag::warn_format_non_standard)
2766                            << LM.toString() << 0,
2767                          getLocationOfByte(LM.getStart()),
2768                          /*IsStringLocation*/true,
2769                          getSpecifierRange(startSpecifier, specifierLen));
2770 
2771     S.Diag(getLocationOfByte(LM.getStart()), diag::note_format_fix_specifier)
2772       << FixedLM->toString()
2773       << FixItHint::CreateReplacement(LMRange, FixedLM->toString());
2774 
2775   } else {
2776     EmitFormatDiagnostic(S.PDiag(diag::warn_format_non_standard)
2777                            << LM.toString() << 0,
2778                          getLocationOfByte(LM.getStart()),
2779                          /*IsStringLocation*/true,
2780                          getSpecifierRange(startSpecifier, specifierLen));
2781   }
2782 }
2783 
2784 void CheckFormatHandler::HandleNonStandardConversionSpecifier(
2785     const analyze_format_string::ConversionSpecifier &CS,
2786     const char *startSpecifier, unsigned specifierLen) {
2787   using namespace analyze_format_string;
2788 
2789   // See if we know how to fix this conversion specifier.
2790   Optional<ConversionSpecifier> FixedCS = CS.getStandardSpecifier();
2791   if (FixedCS) {
2792     EmitFormatDiagnostic(S.PDiag(diag::warn_format_non_standard)
2793                           << CS.toString() << /*conversion specifier*/1,
2794                          getLocationOfByte(CS.getStart()),
2795                          /*IsStringLocation*/true,
2796                          getSpecifierRange(startSpecifier, specifierLen));
2797 
2798     CharSourceRange CSRange = getSpecifierRange(CS.getStart(), CS.getLength());
2799     S.Diag(getLocationOfByte(CS.getStart()), diag::note_format_fix_specifier)
2800       << FixedCS->toString()
2801       << FixItHint::CreateReplacement(CSRange, FixedCS->toString());
2802   } else {
2803     EmitFormatDiagnostic(S.PDiag(diag::warn_format_non_standard)
2804                           << CS.toString() << /*conversion specifier*/1,
2805                          getLocationOfByte(CS.getStart()),
2806                          /*IsStringLocation*/true,
2807                          getSpecifierRange(startSpecifier, specifierLen));
2808   }
2809 }
2810 
2811 void CheckFormatHandler::HandlePosition(const char *startPos,
2812                                         unsigned posLen) {
2813   EmitFormatDiagnostic(S.PDiag(diag::warn_format_non_standard_positional_arg),
2814                                getLocationOfByte(startPos),
2815                                /*IsStringLocation*/true,
2816                                getSpecifierRange(startPos, posLen));
2817 }
2818 
2819 void
2820 CheckFormatHandler::HandleInvalidPosition(const char *startPos, unsigned posLen,
2821                                      analyze_format_string::PositionContext p) {
2822   EmitFormatDiagnostic(S.PDiag(diag::warn_format_invalid_positional_specifier)
2823                          << (unsigned) p,
2824                        getLocationOfByte(startPos), /*IsStringLocation*/true,
2825                        getSpecifierRange(startPos, posLen));
2826 }
2827 
2828 void CheckFormatHandler::HandleZeroPosition(const char *startPos,
2829                                             unsigned posLen) {
2830   EmitFormatDiagnostic(S.PDiag(diag::warn_format_zero_positional_specifier),
2831                                getLocationOfByte(startPos),
2832                                /*IsStringLocation*/true,
2833                                getSpecifierRange(startPos, posLen));
2834 }
2835 
2836 void CheckFormatHandler::HandleNullChar(const char *nullCharacter) {
2837   if (!isa<ObjCStringLiteral>(OrigFormatExpr)) {
2838     // The presence of a null character is likely an error.
2839     EmitFormatDiagnostic(
2840       S.PDiag(diag::warn_printf_format_string_contains_null_char),
2841       getLocationOfByte(nullCharacter), /*IsStringLocation*/true,
2842       getFormatStringRange());
2843   }
2844 }
2845 
2846 // Note that this may return NULL if there was an error parsing or building
2847 // one of the argument expressions.
2848 const Expr *CheckFormatHandler::getDataArg(unsigned i) const {
2849   return Args[FirstDataArg + i];
2850 }
2851 
2852 void CheckFormatHandler::DoneProcessing() {
2853     // Does the number of data arguments exceed the number of
2854     // format conversions in the format string?
2855   if (!HasVAListArg) {
2856       // Find any arguments that weren't covered.
2857     CoveredArgs.flip();
2858     signed notCoveredArg = CoveredArgs.find_first();
2859     if (notCoveredArg >= 0) {
2860       assert((unsigned)notCoveredArg < NumDataArgs);
2861       if (const Expr *E = getDataArg((unsigned) notCoveredArg)) {
2862         SourceLocation Loc = E->getLocStart();
2863         if (!S.getSourceManager().isInSystemMacro(Loc)) {
2864           EmitFormatDiagnostic(S.PDiag(diag::warn_printf_data_arg_not_used),
2865                                Loc, /*IsStringLocation*/false,
2866                                getFormatStringRange());
2867         }
2868       }
2869     }
2870   }
2871 }
2872 
2873 bool
2874 CheckFormatHandler::HandleInvalidConversionSpecifier(unsigned argIndex,
2875                                                      SourceLocation Loc,
2876                                                      const char *startSpec,
2877                                                      unsigned specifierLen,
2878                                                      const char *csStart,
2879                                                      unsigned csLen) {
2880 
2881   bool keepGoing = true;
2882   if (argIndex < NumDataArgs) {
2883     // Consider the argument coverered, even though the specifier doesn't
2884     // make sense.
2885     CoveredArgs.set(argIndex);
2886   }
2887   else {
2888     // If argIndex exceeds the number of data arguments we
2889     // don't issue a warning because that is just a cascade of warnings (and
2890     // they may have intended '%%' anyway). We don't want to continue processing
2891     // the format string after this point, however, as we will like just get
2892     // gibberish when trying to match arguments.
2893     keepGoing = false;
2894   }
2895 
2896   EmitFormatDiagnostic(S.PDiag(diag::warn_format_invalid_conversion)
2897                          << StringRef(csStart, csLen),
2898                        Loc, /*IsStringLocation*/true,
2899                        getSpecifierRange(startSpec, specifierLen));
2900 
2901   return keepGoing;
2902 }
2903 
2904 void
2905 CheckFormatHandler::HandlePositionalNonpositionalArgs(SourceLocation Loc,
2906                                                       const char *startSpec,
2907                                                       unsigned specifierLen) {
2908   EmitFormatDiagnostic(
2909     S.PDiag(diag::warn_format_mix_positional_nonpositional_args),
2910     Loc, /*isStringLoc*/true, getSpecifierRange(startSpec, specifierLen));
2911 }
2912 
2913 bool
2914 CheckFormatHandler::CheckNumArgs(
2915   const analyze_format_string::FormatSpecifier &FS,
2916   const analyze_format_string::ConversionSpecifier &CS,
2917   const char *startSpecifier, unsigned specifierLen, unsigned argIndex) {
2918 
2919   if (argIndex >= NumDataArgs) {
2920     PartialDiagnostic PDiag = FS.usesPositionalArg()
2921       ? (S.PDiag(diag::warn_printf_positional_arg_exceeds_data_args)
2922            << (argIndex+1) << NumDataArgs)
2923       : S.PDiag(diag::warn_printf_insufficient_data_args);
2924     EmitFormatDiagnostic(
2925       PDiag, getLocationOfByte(CS.getStart()), /*IsStringLocation*/true,
2926       getSpecifierRange(startSpecifier, specifierLen));
2927     return false;
2928   }
2929   return true;
2930 }
2931 
2932 template<typename Range>
2933 void CheckFormatHandler::EmitFormatDiagnostic(PartialDiagnostic PDiag,
2934                                               SourceLocation Loc,
2935                                               bool IsStringLocation,
2936                                               Range StringRange,
2937                                               ArrayRef<FixItHint> FixIt) {
2938   EmitFormatDiagnostic(S, inFunctionCall, Args[FormatIdx], PDiag,
2939                        Loc, IsStringLocation, StringRange, FixIt);
2940 }
2941 
2942 /// \brief If the format string is not within the funcion call, emit a note
2943 /// so that the function call and string are in diagnostic messages.
2944 ///
2945 /// \param InFunctionCall if true, the format string is within the function
2946 /// call and only one diagnostic message will be produced.  Otherwise, an
2947 /// extra note will be emitted pointing to location of the format string.
2948 ///
2949 /// \param ArgumentExpr the expression that is passed as the format string
2950 /// argument in the function call.  Used for getting locations when two
2951 /// diagnostics are emitted.
2952 ///
2953 /// \param PDiag the callee should already have provided any strings for the
2954 /// diagnostic message.  This function only adds locations and fixits
2955 /// to diagnostics.
2956 ///
2957 /// \param Loc primary location for diagnostic.  If two diagnostics are
2958 /// required, one will be at Loc and a new SourceLocation will be created for
2959 /// the other one.
2960 ///
2961 /// \param IsStringLocation if true, Loc points to the format string should be
2962 /// used for the note.  Otherwise, Loc points to the argument list and will
2963 /// be used with PDiag.
2964 ///
2965 /// \param StringRange some or all of the string to highlight.  This is
2966 /// templated so it can accept either a CharSourceRange or a SourceRange.
2967 ///
2968 /// \param FixIt optional fix it hint for the format string.
2969 template<typename Range>
2970 void CheckFormatHandler::EmitFormatDiagnostic(Sema &S, bool InFunctionCall,
2971                                               const Expr *ArgumentExpr,
2972                                               PartialDiagnostic PDiag,
2973                                               SourceLocation Loc,
2974                                               bool IsStringLocation,
2975                                               Range StringRange,
2976                                               ArrayRef<FixItHint> FixIt) {
2977   if (InFunctionCall) {
2978     const Sema::SemaDiagnosticBuilder &D = S.Diag(Loc, PDiag);
2979     D << StringRange;
2980     for (ArrayRef<FixItHint>::iterator I = FixIt.begin(), E = FixIt.end();
2981          I != E; ++I) {
2982       D << *I;
2983     }
2984   } else {
2985     S.Diag(IsStringLocation ? ArgumentExpr->getExprLoc() : Loc, PDiag)
2986       << ArgumentExpr->getSourceRange();
2987 
2988     const Sema::SemaDiagnosticBuilder &Note =
2989       S.Diag(IsStringLocation ? Loc : StringRange.getBegin(),
2990              diag::note_format_string_defined);
2991 
2992     Note << StringRange;
2993     for (ArrayRef<FixItHint>::iterator I = FixIt.begin(), E = FixIt.end();
2994          I != E; ++I) {
2995       Note << *I;
2996     }
2997   }
2998 }
2999 
3000 //===--- CHECK: Printf format string checking ------------------------------===//
3001 
3002 namespace {
3003 class CheckPrintfHandler : public CheckFormatHandler {
3004   bool ObjCContext;
3005 public:
3006   CheckPrintfHandler(Sema &s, const StringLiteral *fexpr,
3007                      const Expr *origFormatExpr, unsigned firstDataArg,
3008                      unsigned numDataArgs, bool isObjC,
3009                      const char *beg, bool hasVAListArg,
3010                      ArrayRef<const Expr *> Args,
3011                      unsigned formatIdx, bool inFunctionCall,
3012                      Sema::VariadicCallType CallType,
3013                      llvm::SmallBitVector &CheckedVarArgs)
3014     : CheckFormatHandler(s, fexpr, origFormatExpr, firstDataArg,
3015                          numDataArgs, beg, hasVAListArg, Args,
3016                          formatIdx, inFunctionCall, CallType, CheckedVarArgs),
3017       ObjCContext(isObjC)
3018   {}
3019 
3020 
3021   bool HandleInvalidPrintfConversionSpecifier(
3022                                       const analyze_printf::PrintfSpecifier &FS,
3023                                       const char *startSpecifier,
3024                                       unsigned specifierLen) override;
3025 
3026   bool HandlePrintfSpecifier(const analyze_printf::PrintfSpecifier &FS,
3027                              const char *startSpecifier,
3028                              unsigned specifierLen) override;
3029   bool checkFormatExpr(const analyze_printf::PrintfSpecifier &FS,
3030                        const char *StartSpecifier,
3031                        unsigned SpecifierLen,
3032                        const Expr *E);
3033 
3034   bool HandleAmount(const analyze_format_string::OptionalAmount &Amt, unsigned k,
3035                     const char *startSpecifier, unsigned specifierLen);
3036   void HandleInvalidAmount(const analyze_printf::PrintfSpecifier &FS,
3037                            const analyze_printf::OptionalAmount &Amt,
3038                            unsigned type,
3039                            const char *startSpecifier, unsigned specifierLen);
3040   void HandleFlag(const analyze_printf::PrintfSpecifier &FS,
3041                   const analyze_printf::OptionalFlag &flag,
3042                   const char *startSpecifier, unsigned specifierLen);
3043   void HandleIgnoredFlag(const analyze_printf::PrintfSpecifier &FS,
3044                          const analyze_printf::OptionalFlag &ignoredFlag,
3045                          const analyze_printf::OptionalFlag &flag,
3046                          const char *startSpecifier, unsigned specifierLen);
3047   bool checkForCStrMembers(const analyze_printf::ArgType &AT,
3048                            const Expr *E);
3049 
3050 };
3051 }
3052 
3053 bool CheckPrintfHandler::HandleInvalidPrintfConversionSpecifier(
3054                                       const analyze_printf::PrintfSpecifier &FS,
3055                                       const char *startSpecifier,
3056                                       unsigned specifierLen) {
3057   const analyze_printf::PrintfConversionSpecifier &CS =
3058     FS.getConversionSpecifier();
3059 
3060   return HandleInvalidConversionSpecifier(FS.getArgIndex(),
3061                                           getLocationOfByte(CS.getStart()),
3062                                           startSpecifier, specifierLen,
3063                                           CS.getStart(), CS.getLength());
3064 }
3065 
3066 bool CheckPrintfHandler::HandleAmount(
3067                                const analyze_format_string::OptionalAmount &Amt,
3068                                unsigned k, const char *startSpecifier,
3069                                unsigned specifierLen) {
3070 
3071   if (Amt.hasDataArgument()) {
3072     if (!HasVAListArg) {
3073       unsigned argIndex = Amt.getArgIndex();
3074       if (argIndex >= NumDataArgs) {
3075         EmitFormatDiagnostic(S.PDiag(diag::warn_printf_asterisk_missing_arg)
3076                                << k,
3077                              getLocationOfByte(Amt.getStart()),
3078                              /*IsStringLocation*/true,
3079                              getSpecifierRange(startSpecifier, specifierLen));
3080         // Don't do any more checking.  We will just emit
3081         // spurious errors.
3082         return false;
3083       }
3084 
3085       // Type check the data argument.  It should be an 'int'.
3086       // Although not in conformance with C99, we also allow the argument to be
3087       // an 'unsigned int' as that is a reasonably safe case.  GCC also
3088       // doesn't emit a warning for that case.
3089       CoveredArgs.set(argIndex);
3090       const Expr *Arg = getDataArg(argIndex);
3091       if (!Arg)
3092         return false;
3093 
3094       QualType T = Arg->getType();
3095 
3096       const analyze_printf::ArgType &AT = Amt.getArgType(S.Context);
3097       assert(AT.isValid());
3098 
3099       if (!AT.matchesType(S.Context, T)) {
3100         EmitFormatDiagnostic(S.PDiag(diag::warn_printf_asterisk_wrong_type)
3101                                << k << AT.getRepresentativeTypeName(S.Context)
3102                                << T << Arg->getSourceRange(),
3103                              getLocationOfByte(Amt.getStart()),
3104                              /*IsStringLocation*/true,
3105                              getSpecifierRange(startSpecifier, specifierLen));
3106         // Don't do any more checking.  We will just emit
3107         // spurious errors.
3108         return false;
3109       }
3110     }
3111   }
3112   return true;
3113 }
3114 
3115 void CheckPrintfHandler::HandleInvalidAmount(
3116                                       const analyze_printf::PrintfSpecifier &FS,
3117                                       const analyze_printf::OptionalAmount &Amt,
3118                                       unsigned type,
3119                                       const char *startSpecifier,
3120                                       unsigned specifierLen) {
3121   const analyze_printf::PrintfConversionSpecifier &CS =
3122     FS.getConversionSpecifier();
3123 
3124   FixItHint fixit =
3125     Amt.getHowSpecified() == analyze_printf::OptionalAmount::Constant
3126       ? FixItHint::CreateRemoval(getSpecifierRange(Amt.getStart(),
3127                                  Amt.getConstantLength()))
3128       : FixItHint();
3129 
3130   EmitFormatDiagnostic(S.PDiag(diag::warn_printf_nonsensical_optional_amount)
3131                          << type << CS.toString(),
3132                        getLocationOfByte(Amt.getStart()),
3133                        /*IsStringLocation*/true,
3134                        getSpecifierRange(startSpecifier, specifierLen),
3135                        fixit);
3136 }
3137 
3138 void CheckPrintfHandler::HandleFlag(const analyze_printf::PrintfSpecifier &FS,
3139                                     const analyze_printf::OptionalFlag &flag,
3140                                     const char *startSpecifier,
3141                                     unsigned specifierLen) {
3142   // Warn about pointless flag with a fixit removal.
3143   const analyze_printf::PrintfConversionSpecifier &CS =
3144     FS.getConversionSpecifier();
3145   EmitFormatDiagnostic(S.PDiag(diag::warn_printf_nonsensical_flag)
3146                          << flag.toString() << CS.toString(),
3147                        getLocationOfByte(flag.getPosition()),
3148                        /*IsStringLocation*/true,
3149                        getSpecifierRange(startSpecifier, specifierLen),
3150                        FixItHint::CreateRemoval(
3151                          getSpecifierRange(flag.getPosition(), 1)));
3152 }
3153 
3154 void CheckPrintfHandler::HandleIgnoredFlag(
3155                                 const analyze_printf::PrintfSpecifier &FS,
3156                                 const analyze_printf::OptionalFlag &ignoredFlag,
3157                                 const analyze_printf::OptionalFlag &flag,
3158                                 const char *startSpecifier,
3159                                 unsigned specifierLen) {
3160   // Warn about ignored flag with a fixit removal.
3161   EmitFormatDiagnostic(S.PDiag(diag::warn_printf_ignored_flag)
3162                          << ignoredFlag.toString() << flag.toString(),
3163                        getLocationOfByte(ignoredFlag.getPosition()),
3164                        /*IsStringLocation*/true,
3165                        getSpecifierRange(startSpecifier, specifierLen),
3166                        FixItHint::CreateRemoval(
3167                          getSpecifierRange(ignoredFlag.getPosition(), 1)));
3168 }
3169 
3170 // Determines if the specified is a C++ class or struct containing
3171 // a member with the specified name and kind (e.g. a CXXMethodDecl named
3172 // "c_str()").
3173 template<typename MemberKind>
3174 static llvm::SmallPtrSet<MemberKind*, 1>
3175 CXXRecordMembersNamed(StringRef Name, Sema &S, QualType Ty) {
3176   const RecordType *RT = Ty->getAs<RecordType>();
3177   llvm::SmallPtrSet<MemberKind*, 1> Results;
3178 
3179   if (!RT)
3180     return Results;
3181   const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(RT->getDecl());
3182   if (!RD || !RD->getDefinition())
3183     return Results;
3184 
3185   LookupResult R(S, &S.Context.Idents.get(Name), SourceLocation(),
3186                  Sema::LookupMemberName);
3187   R.suppressDiagnostics();
3188 
3189   // We just need to include all members of the right kind turned up by the
3190   // filter, at this point.
3191   if (S.LookupQualifiedName(R, RT->getDecl()))
3192     for (LookupResult::iterator I = R.begin(), E = R.end(); I != E; ++I) {
3193       NamedDecl *decl = (*I)->getUnderlyingDecl();
3194       if (MemberKind *FK = dyn_cast<MemberKind>(decl))
3195         Results.insert(FK);
3196     }
3197   return Results;
3198 }
3199 
3200 /// Check if we could call '.c_str()' on an object.
3201 ///
3202 /// FIXME: This returns the wrong results in some cases (if cv-qualifiers don't
3203 /// allow the call, or if it would be ambiguous).
3204 bool Sema::hasCStrMethod(const Expr *E) {
3205   typedef llvm::SmallPtrSet<CXXMethodDecl*, 1> MethodSet;
3206   MethodSet Results =
3207       CXXRecordMembersNamed<CXXMethodDecl>("c_str", *this, E->getType());
3208   for (MethodSet::iterator MI = Results.begin(), ME = Results.end();
3209        MI != ME; ++MI)
3210     if ((*MI)->getMinRequiredArguments() == 0)
3211       return true;
3212   return false;
3213 }
3214 
3215 // Check if a (w)string was passed when a (w)char* was needed, and offer a
3216 // better diagnostic if so. AT is assumed to be valid.
3217 // Returns true when a c_str() conversion method is found.
3218 bool CheckPrintfHandler::checkForCStrMembers(
3219     const analyze_printf::ArgType &AT, const Expr *E) {
3220   typedef llvm::SmallPtrSet<CXXMethodDecl*, 1> MethodSet;
3221 
3222   MethodSet Results =
3223       CXXRecordMembersNamed<CXXMethodDecl>("c_str", S, E->getType());
3224 
3225   for (MethodSet::iterator MI = Results.begin(), ME = Results.end();
3226        MI != ME; ++MI) {
3227     const CXXMethodDecl *Method = *MI;
3228     if (Method->getMinRequiredArguments() == 0 &&
3229         AT.matchesType(S.Context, Method->getReturnType())) {
3230       // FIXME: Suggest parens if the expression needs them.
3231       SourceLocation EndLoc = S.getLocForEndOfToken(E->getLocEnd());
3232       S.Diag(E->getLocStart(), diag::note_printf_c_str)
3233           << "c_str()"
3234           << FixItHint::CreateInsertion(EndLoc, ".c_str()");
3235       return true;
3236     }
3237   }
3238 
3239   return false;
3240 }
3241 
3242 bool
3243 CheckPrintfHandler::HandlePrintfSpecifier(const analyze_printf::PrintfSpecifier
3244                                             &FS,
3245                                           const char *startSpecifier,
3246                                           unsigned specifierLen) {
3247 
3248   using namespace analyze_format_string;
3249   using namespace analyze_printf;
3250   const PrintfConversionSpecifier &CS = FS.getConversionSpecifier();
3251 
3252   if (FS.consumesDataArgument()) {
3253     if (atFirstArg) {
3254         atFirstArg = false;
3255         usesPositionalArgs = FS.usesPositionalArg();
3256     }
3257     else if (usesPositionalArgs != FS.usesPositionalArg()) {
3258       HandlePositionalNonpositionalArgs(getLocationOfByte(CS.getStart()),
3259                                         startSpecifier, specifierLen);
3260       return false;
3261     }
3262   }
3263 
3264   // First check if the field width, precision, and conversion specifier
3265   // have matching data arguments.
3266   if (!HandleAmount(FS.getFieldWidth(), /* field width */ 0,
3267                     startSpecifier, specifierLen)) {
3268     return false;
3269   }
3270 
3271   if (!HandleAmount(FS.getPrecision(), /* precision */ 1,
3272                     startSpecifier, specifierLen)) {
3273     return false;
3274   }
3275 
3276   if (!CS.consumesDataArgument()) {
3277     // FIXME: Technically specifying a precision or field width here
3278     // makes no sense.  Worth issuing a warning at some point.
3279     return true;
3280   }
3281 
3282   // Consume the argument.
3283   unsigned argIndex = FS.getArgIndex();
3284   if (argIndex < NumDataArgs) {
3285     // The check to see if the argIndex is valid will come later.
3286     // We set the bit here because we may exit early from this
3287     // function if we encounter some other error.
3288     CoveredArgs.set(argIndex);
3289   }
3290 
3291   // Check for using an Objective-C specific conversion specifier
3292   // in a non-ObjC literal.
3293   if (!ObjCContext && CS.isObjCArg()) {
3294     return HandleInvalidPrintfConversionSpecifier(FS, startSpecifier,
3295                                                   specifierLen);
3296   }
3297 
3298   // Check for invalid use of field width
3299   if (!FS.hasValidFieldWidth()) {
3300     HandleInvalidAmount(FS, FS.getFieldWidth(), /* field width */ 0,
3301         startSpecifier, specifierLen);
3302   }
3303 
3304   // Check for invalid use of precision
3305   if (!FS.hasValidPrecision()) {
3306     HandleInvalidAmount(FS, FS.getPrecision(), /* precision */ 1,
3307         startSpecifier, specifierLen);
3308   }
3309 
3310   // Check each flag does not conflict with any other component.
3311   if (!FS.hasValidThousandsGroupingPrefix())
3312     HandleFlag(FS, FS.hasThousandsGrouping(), startSpecifier, specifierLen);
3313   if (!FS.hasValidLeadingZeros())
3314     HandleFlag(FS, FS.hasLeadingZeros(), startSpecifier, specifierLen);
3315   if (!FS.hasValidPlusPrefix())
3316     HandleFlag(FS, FS.hasPlusPrefix(), startSpecifier, specifierLen);
3317   if (!FS.hasValidSpacePrefix())
3318     HandleFlag(FS, FS.hasSpacePrefix(), startSpecifier, specifierLen);
3319   if (!FS.hasValidAlternativeForm())
3320     HandleFlag(FS, FS.hasAlternativeForm(), startSpecifier, specifierLen);
3321   if (!FS.hasValidLeftJustified())
3322     HandleFlag(FS, FS.isLeftJustified(), startSpecifier, specifierLen);
3323 
3324   // Check that flags are not ignored by another flag
3325   if (FS.hasSpacePrefix() && FS.hasPlusPrefix()) // ' ' ignored by '+'
3326     HandleIgnoredFlag(FS, FS.hasSpacePrefix(), FS.hasPlusPrefix(),
3327         startSpecifier, specifierLen);
3328   if (FS.hasLeadingZeros() && FS.isLeftJustified()) // '0' ignored by '-'
3329     HandleIgnoredFlag(FS, FS.hasLeadingZeros(), FS.isLeftJustified(),
3330             startSpecifier, specifierLen);
3331 
3332   // Check the length modifier is valid with the given conversion specifier.
3333   if (!FS.hasValidLengthModifier(S.getASTContext().getTargetInfo()))
3334     HandleInvalidLengthModifier(FS, CS, startSpecifier, specifierLen,
3335                                 diag::warn_format_nonsensical_length);
3336   else if (!FS.hasStandardLengthModifier())
3337     HandleNonStandardLengthModifier(FS, startSpecifier, specifierLen);
3338   else if (!FS.hasStandardLengthConversionCombination())
3339     HandleInvalidLengthModifier(FS, CS, startSpecifier, specifierLen,
3340                                 diag::warn_format_non_standard_conversion_spec);
3341 
3342   if (!FS.hasStandardConversionSpecifier(S.getLangOpts()))
3343     HandleNonStandardConversionSpecifier(CS, startSpecifier, specifierLen);
3344 
3345   // The remaining checks depend on the data arguments.
3346   if (HasVAListArg)
3347     return true;
3348 
3349   if (!CheckNumArgs(FS, CS, startSpecifier, specifierLen, argIndex))
3350     return false;
3351 
3352   const Expr *Arg = getDataArg(argIndex);
3353   if (!Arg)
3354     return true;
3355 
3356   return checkFormatExpr(FS, startSpecifier, specifierLen, Arg);
3357 }
3358 
3359 static bool requiresParensToAddCast(const Expr *E) {
3360   // FIXME: We should have a general way to reason about operator
3361   // precedence and whether parens are actually needed here.
3362   // Take care of a few common cases where they aren't.
3363   const Expr *Inside = E->IgnoreImpCasts();
3364   if (const PseudoObjectExpr *POE = dyn_cast<PseudoObjectExpr>(Inside))
3365     Inside = POE->getSyntacticForm()->IgnoreImpCasts();
3366 
3367   switch (Inside->getStmtClass()) {
3368   case Stmt::ArraySubscriptExprClass:
3369   case Stmt::CallExprClass:
3370   case Stmt::CharacterLiteralClass:
3371   case Stmt::CXXBoolLiteralExprClass:
3372   case Stmt::DeclRefExprClass:
3373   case Stmt::FloatingLiteralClass:
3374   case Stmt::IntegerLiteralClass:
3375   case Stmt::MemberExprClass:
3376   case Stmt::ObjCArrayLiteralClass:
3377   case Stmt::ObjCBoolLiteralExprClass:
3378   case Stmt::ObjCBoxedExprClass:
3379   case Stmt::ObjCDictionaryLiteralClass:
3380   case Stmt::ObjCEncodeExprClass:
3381   case Stmt::ObjCIvarRefExprClass:
3382   case Stmt::ObjCMessageExprClass:
3383   case Stmt::ObjCPropertyRefExprClass:
3384   case Stmt::ObjCStringLiteralClass:
3385   case Stmt::ObjCSubscriptRefExprClass:
3386   case Stmt::ParenExprClass:
3387   case Stmt::StringLiteralClass:
3388   case Stmt::UnaryOperatorClass:
3389     return false;
3390   default:
3391     return true;
3392   }
3393 }
3394 
3395 static std::pair<QualType, StringRef>
3396 shouldNotPrintDirectly(const ASTContext &Context,
3397                        QualType IntendedTy,
3398                        const Expr *E) {
3399   // Use a 'while' to peel off layers of typedefs.
3400   QualType TyTy = IntendedTy;
3401   while (const TypedefType *UserTy = TyTy->getAs<TypedefType>()) {
3402     StringRef Name = UserTy->getDecl()->getName();
3403     QualType CastTy = llvm::StringSwitch<QualType>(Name)
3404       .Case("NSInteger", Context.LongTy)
3405       .Case("NSUInteger", Context.UnsignedLongTy)
3406       .Case("SInt32", Context.IntTy)
3407       .Case("UInt32", Context.UnsignedIntTy)
3408       .Default(QualType());
3409 
3410     if (!CastTy.isNull())
3411       return std::make_pair(CastTy, Name);
3412 
3413     TyTy = UserTy->desugar();
3414   }
3415 
3416   // Strip parens if necessary.
3417   if (const ParenExpr *PE = dyn_cast<ParenExpr>(E))
3418     return shouldNotPrintDirectly(Context,
3419                                   PE->getSubExpr()->getType(),
3420                                   PE->getSubExpr());
3421 
3422   // If this is a conditional expression, then its result type is constructed
3423   // via usual arithmetic conversions and thus there might be no necessary
3424   // typedef sugar there.  Recurse to operands to check for NSInteger &
3425   // Co. usage condition.
3426   if (const ConditionalOperator *CO = dyn_cast<ConditionalOperator>(E)) {
3427     QualType TrueTy, FalseTy;
3428     StringRef TrueName, FalseName;
3429 
3430     std::tie(TrueTy, TrueName) =
3431       shouldNotPrintDirectly(Context,
3432                              CO->getTrueExpr()->getType(),
3433                              CO->getTrueExpr());
3434     std::tie(FalseTy, FalseName) =
3435       shouldNotPrintDirectly(Context,
3436                              CO->getFalseExpr()->getType(),
3437                              CO->getFalseExpr());
3438 
3439     if (TrueTy == FalseTy)
3440       return std::make_pair(TrueTy, TrueName);
3441     else if (TrueTy.isNull())
3442       return std::make_pair(FalseTy, FalseName);
3443     else if (FalseTy.isNull())
3444       return std::make_pair(TrueTy, TrueName);
3445   }
3446 
3447   return std::make_pair(QualType(), StringRef());
3448 }
3449 
3450 bool
3451 CheckPrintfHandler::checkFormatExpr(const analyze_printf::PrintfSpecifier &FS,
3452                                     const char *StartSpecifier,
3453                                     unsigned SpecifierLen,
3454                                     const Expr *E) {
3455   using namespace analyze_format_string;
3456   using namespace analyze_printf;
3457   // Now type check the data expression that matches the
3458   // format specifier.
3459   const analyze_printf::ArgType &AT = FS.getArgType(S.Context,
3460                                                     ObjCContext);
3461   if (!AT.isValid())
3462     return true;
3463 
3464   QualType ExprTy = E->getType();
3465   while (const TypeOfExprType *TET = dyn_cast<TypeOfExprType>(ExprTy)) {
3466     ExprTy = TET->getUnderlyingExpr()->getType();
3467   }
3468 
3469   if (AT.matchesType(S.Context, ExprTy))
3470     return true;
3471 
3472   // Look through argument promotions for our error message's reported type.
3473   // This includes the integral and floating promotions, but excludes array
3474   // and function pointer decay; seeing that an argument intended to be a
3475   // string has type 'char [6]' is probably more confusing than 'char *'.
3476   if (const ImplicitCastExpr *ICE = dyn_cast<ImplicitCastExpr>(E)) {
3477     if (ICE->getCastKind() == CK_IntegralCast ||
3478         ICE->getCastKind() == CK_FloatingCast) {
3479       E = ICE->getSubExpr();
3480       ExprTy = E->getType();
3481 
3482       // Check if we didn't match because of an implicit cast from a 'char'
3483       // or 'short' to an 'int'.  This is done because printf is a varargs
3484       // function.
3485       if (ICE->getType() == S.Context.IntTy ||
3486           ICE->getType() == S.Context.UnsignedIntTy) {
3487         // All further checking is done on the subexpression.
3488         if (AT.matchesType(S.Context, ExprTy))
3489           return true;
3490       }
3491     }
3492   } else if (const CharacterLiteral *CL = dyn_cast<CharacterLiteral>(E)) {
3493     // Special case for 'a', which has type 'int' in C.
3494     // Note, however, that we do /not/ want to treat multibyte constants like
3495     // 'MooV' as characters! This form is deprecated but still exists.
3496     if (ExprTy == S.Context.IntTy)
3497       if (llvm::isUIntN(S.Context.getCharWidth(), CL->getValue()))
3498         ExprTy = S.Context.CharTy;
3499   }
3500 
3501   // Look through enums to their underlying type.
3502   bool IsEnum = false;
3503   if (auto EnumTy = ExprTy->getAs<EnumType>()) {
3504     ExprTy = EnumTy->getDecl()->getIntegerType();
3505     IsEnum = true;
3506   }
3507 
3508   // %C in an Objective-C context prints a unichar, not a wchar_t.
3509   // If the argument is an integer of some kind, believe the %C and suggest
3510   // a cast instead of changing the conversion specifier.
3511   QualType IntendedTy = ExprTy;
3512   if (ObjCContext &&
3513       FS.getConversionSpecifier().getKind() == ConversionSpecifier::CArg) {
3514     if (ExprTy->isIntegralOrUnscopedEnumerationType() &&
3515         !ExprTy->isCharType()) {
3516       // 'unichar' is defined as a typedef of unsigned short, but we should
3517       // prefer using the typedef if it is visible.
3518       IntendedTy = S.Context.UnsignedShortTy;
3519 
3520       // While we are here, check if the value is an IntegerLiteral that happens
3521       // to be within the valid range.
3522       if (const IntegerLiteral *IL = dyn_cast<IntegerLiteral>(E)) {
3523         const llvm::APInt &V = IL->getValue();
3524         if (V.getActiveBits() <= S.Context.getTypeSize(IntendedTy))
3525           return true;
3526       }
3527 
3528       LookupResult Result(S, &S.Context.Idents.get("unichar"), E->getLocStart(),
3529                           Sema::LookupOrdinaryName);
3530       if (S.LookupName(Result, S.getCurScope())) {
3531         NamedDecl *ND = Result.getFoundDecl();
3532         if (TypedefNameDecl *TD = dyn_cast<TypedefNameDecl>(ND))
3533           if (TD->getUnderlyingType() == IntendedTy)
3534             IntendedTy = S.Context.getTypedefType(TD);
3535       }
3536     }
3537   }
3538 
3539   // Special-case some of Darwin's platform-independence types by suggesting
3540   // casts to primitive types that are known to be large enough.
3541   bool ShouldNotPrintDirectly = false; StringRef CastTyName;
3542   if (S.Context.getTargetInfo().getTriple().isOSDarwin()) {
3543     QualType CastTy;
3544     std::tie(CastTy, CastTyName) = shouldNotPrintDirectly(S.Context, IntendedTy, E);
3545     if (!CastTy.isNull()) {
3546       IntendedTy = CastTy;
3547       ShouldNotPrintDirectly = true;
3548     }
3549   }
3550 
3551   // We may be able to offer a FixItHint if it is a supported type.
3552   PrintfSpecifier fixedFS = FS;
3553   bool success = fixedFS.fixType(IntendedTy, S.getLangOpts(),
3554                                  S.Context, ObjCContext);
3555 
3556   if (success) {
3557     // Get the fix string from the fixed format specifier
3558     SmallString<16> buf;
3559     llvm::raw_svector_ostream os(buf);
3560     fixedFS.toString(os);
3561 
3562     CharSourceRange SpecRange = getSpecifierRange(StartSpecifier, SpecifierLen);
3563 
3564     if (IntendedTy == ExprTy && !ShouldNotPrintDirectly) {
3565       // In this case, the specifier is wrong and should be changed to match
3566       // the argument.
3567       EmitFormatDiagnostic(
3568         S.PDiag(diag::warn_format_conversion_argument_type_mismatch)
3569           << AT.getRepresentativeTypeName(S.Context) << IntendedTy << IsEnum
3570           << E->getSourceRange(),
3571         E->getLocStart(),
3572         /*IsStringLocation*/false,
3573         SpecRange,
3574         FixItHint::CreateReplacement(SpecRange, os.str()));
3575 
3576     } else {
3577       // The canonical type for formatting this value is different from the
3578       // actual type of the expression. (This occurs, for example, with Darwin's
3579       // NSInteger on 32-bit platforms, where it is typedef'd as 'int', but
3580       // should be printed as 'long' for 64-bit compatibility.)
3581       // Rather than emitting a normal format/argument mismatch, we want to
3582       // add a cast to the recommended type (and correct the format string
3583       // if necessary).
3584       SmallString<16> CastBuf;
3585       llvm::raw_svector_ostream CastFix(CastBuf);
3586       CastFix << "(";
3587       IntendedTy.print(CastFix, S.Context.getPrintingPolicy());
3588       CastFix << ")";
3589 
3590       SmallVector<FixItHint,4> Hints;
3591       if (!AT.matchesType(S.Context, IntendedTy))
3592         Hints.push_back(FixItHint::CreateReplacement(SpecRange, os.str()));
3593 
3594       if (const CStyleCastExpr *CCast = dyn_cast<CStyleCastExpr>(E)) {
3595         // If there's already a cast present, just replace it.
3596         SourceRange CastRange(CCast->getLParenLoc(), CCast->getRParenLoc());
3597         Hints.push_back(FixItHint::CreateReplacement(CastRange, CastFix.str()));
3598 
3599       } else if (!requiresParensToAddCast(E)) {
3600         // If the expression has high enough precedence,
3601         // just write the C-style cast.
3602         Hints.push_back(FixItHint::CreateInsertion(E->getLocStart(),
3603                                                    CastFix.str()));
3604       } else {
3605         // Otherwise, add parens around the expression as well as the cast.
3606         CastFix << "(";
3607         Hints.push_back(FixItHint::CreateInsertion(E->getLocStart(),
3608                                                    CastFix.str()));
3609 
3610         SourceLocation After = S.getLocForEndOfToken(E->getLocEnd());
3611         Hints.push_back(FixItHint::CreateInsertion(After, ")"));
3612       }
3613 
3614       if (ShouldNotPrintDirectly) {
3615         // The expression has a type that should not be printed directly.
3616         // We extract the name from the typedef because we don't want to show
3617         // the underlying type in the diagnostic.
3618         StringRef Name;
3619         if (const TypedefType *TypedefTy = dyn_cast<TypedefType>(ExprTy))
3620           Name = TypedefTy->getDecl()->getName();
3621         else
3622           Name = CastTyName;
3623         EmitFormatDiagnostic(S.PDiag(diag::warn_format_argument_needs_cast)
3624                                << Name << IntendedTy << IsEnum
3625                                << E->getSourceRange(),
3626                              E->getLocStart(), /*IsStringLocation=*/false,
3627                              SpecRange, Hints);
3628       } else {
3629         // In this case, the expression could be printed using a different
3630         // specifier, but we've decided that the specifier is probably correct
3631         // and we should cast instead. Just use the normal warning message.
3632         EmitFormatDiagnostic(
3633           S.PDiag(diag::warn_format_conversion_argument_type_mismatch)
3634             << AT.getRepresentativeTypeName(S.Context) << ExprTy << IsEnum
3635             << E->getSourceRange(),
3636           E->getLocStart(), /*IsStringLocation*/false,
3637           SpecRange, Hints);
3638       }
3639     }
3640   } else {
3641     const CharSourceRange &CSR = getSpecifierRange(StartSpecifier,
3642                                                    SpecifierLen);
3643     // Since the warning for passing non-POD types to variadic functions
3644     // was deferred until now, we emit a warning for non-POD
3645     // arguments here.
3646     switch (S.isValidVarArgType(ExprTy)) {
3647     case Sema::VAK_Valid:
3648     case Sema::VAK_ValidInCXX11:
3649       EmitFormatDiagnostic(
3650         S.PDiag(diag::warn_format_conversion_argument_type_mismatch)
3651           << AT.getRepresentativeTypeName(S.Context) << ExprTy << IsEnum
3652           << CSR
3653           << E->getSourceRange(),
3654         E->getLocStart(), /*IsStringLocation*/false, CSR);
3655       break;
3656 
3657     case Sema::VAK_Undefined:
3658     case Sema::VAK_MSVCUndefined:
3659       EmitFormatDiagnostic(
3660         S.PDiag(diag::warn_non_pod_vararg_with_format_string)
3661           << S.getLangOpts().CPlusPlus11
3662           << ExprTy
3663           << CallType
3664           << AT.getRepresentativeTypeName(S.Context)
3665           << CSR
3666           << E->getSourceRange(),
3667         E->getLocStart(), /*IsStringLocation*/false, CSR);
3668       checkForCStrMembers(AT, E);
3669       break;
3670 
3671     case Sema::VAK_Invalid:
3672       if (ExprTy->isObjCObjectType())
3673         EmitFormatDiagnostic(
3674           S.PDiag(diag::err_cannot_pass_objc_interface_to_vararg_format)
3675             << S.getLangOpts().CPlusPlus11
3676             << ExprTy
3677             << CallType
3678             << AT.getRepresentativeTypeName(S.Context)
3679             << CSR
3680             << E->getSourceRange(),
3681           E->getLocStart(), /*IsStringLocation*/false, CSR);
3682       else
3683         // FIXME: If this is an initializer list, suggest removing the braces
3684         // or inserting a cast to the target type.
3685         S.Diag(E->getLocStart(), diag::err_cannot_pass_to_vararg_format)
3686           << isa<InitListExpr>(E) << ExprTy << CallType
3687           << AT.getRepresentativeTypeName(S.Context)
3688           << E->getSourceRange();
3689       break;
3690     }
3691 
3692     assert(FirstDataArg + FS.getArgIndex() < CheckedVarArgs.size() &&
3693            "format string specifier index out of range");
3694     CheckedVarArgs[FirstDataArg + FS.getArgIndex()] = true;
3695   }
3696 
3697   return true;
3698 }
3699 
3700 //===--- CHECK: Scanf format string checking ------------------------------===//
3701 
3702 namespace {
3703 class CheckScanfHandler : public CheckFormatHandler {
3704 public:
3705   CheckScanfHandler(Sema &s, const StringLiteral *fexpr,
3706                     const Expr *origFormatExpr, unsigned firstDataArg,
3707                     unsigned numDataArgs, const char *beg, bool hasVAListArg,
3708                     ArrayRef<const Expr *> Args,
3709                     unsigned formatIdx, bool inFunctionCall,
3710                     Sema::VariadicCallType CallType,
3711                     llvm::SmallBitVector &CheckedVarArgs)
3712     : CheckFormatHandler(s, fexpr, origFormatExpr, firstDataArg,
3713                          numDataArgs, beg, hasVAListArg,
3714                          Args, formatIdx, inFunctionCall, CallType,
3715                          CheckedVarArgs)
3716   {}
3717 
3718   bool HandleScanfSpecifier(const analyze_scanf::ScanfSpecifier &FS,
3719                             const char *startSpecifier,
3720                             unsigned specifierLen) override;
3721 
3722   bool HandleInvalidScanfConversionSpecifier(
3723           const analyze_scanf::ScanfSpecifier &FS,
3724           const char *startSpecifier,
3725           unsigned specifierLen) override;
3726 
3727   void HandleIncompleteScanList(const char *start, const char *end) override;
3728 };
3729 }
3730 
3731 void CheckScanfHandler::HandleIncompleteScanList(const char *start,
3732                                                  const char *end) {
3733   EmitFormatDiagnostic(S.PDiag(diag::warn_scanf_scanlist_incomplete),
3734                        getLocationOfByte(end), /*IsStringLocation*/true,
3735                        getSpecifierRange(start, end - start));
3736 }
3737 
3738 bool CheckScanfHandler::HandleInvalidScanfConversionSpecifier(
3739                                         const analyze_scanf::ScanfSpecifier &FS,
3740                                         const char *startSpecifier,
3741                                         unsigned specifierLen) {
3742 
3743   const analyze_scanf::ScanfConversionSpecifier &CS =
3744     FS.getConversionSpecifier();
3745 
3746   return HandleInvalidConversionSpecifier(FS.getArgIndex(),
3747                                           getLocationOfByte(CS.getStart()),
3748                                           startSpecifier, specifierLen,
3749                                           CS.getStart(), CS.getLength());
3750 }
3751 
3752 bool CheckScanfHandler::HandleScanfSpecifier(
3753                                        const analyze_scanf::ScanfSpecifier &FS,
3754                                        const char *startSpecifier,
3755                                        unsigned specifierLen) {
3756 
3757   using namespace analyze_scanf;
3758   using namespace analyze_format_string;
3759 
3760   const ScanfConversionSpecifier &CS = FS.getConversionSpecifier();
3761 
3762   // Handle case where '%' and '*' don't consume an argument.  These shouldn't
3763   // be used to decide if we are using positional arguments consistently.
3764   if (FS.consumesDataArgument()) {
3765     if (atFirstArg) {
3766       atFirstArg = false;
3767       usesPositionalArgs = FS.usesPositionalArg();
3768     }
3769     else if (usesPositionalArgs != FS.usesPositionalArg()) {
3770       HandlePositionalNonpositionalArgs(getLocationOfByte(CS.getStart()),
3771                                         startSpecifier, specifierLen);
3772       return false;
3773     }
3774   }
3775 
3776   // Check if the field with is non-zero.
3777   const OptionalAmount &Amt = FS.getFieldWidth();
3778   if (Amt.getHowSpecified() == OptionalAmount::Constant) {
3779     if (Amt.getConstantAmount() == 0) {
3780       const CharSourceRange &R = getSpecifierRange(Amt.getStart(),
3781                                                    Amt.getConstantLength());
3782       EmitFormatDiagnostic(S.PDiag(diag::warn_scanf_nonzero_width),
3783                            getLocationOfByte(Amt.getStart()),
3784                            /*IsStringLocation*/true, R,
3785                            FixItHint::CreateRemoval(R));
3786     }
3787   }
3788 
3789   if (!FS.consumesDataArgument()) {
3790     // FIXME: Technically specifying a precision or field width here
3791     // makes no sense.  Worth issuing a warning at some point.
3792     return true;
3793   }
3794 
3795   // Consume the argument.
3796   unsigned argIndex = FS.getArgIndex();
3797   if (argIndex < NumDataArgs) {
3798       // The check to see if the argIndex is valid will come later.
3799       // We set the bit here because we may exit early from this
3800       // function if we encounter some other error.
3801     CoveredArgs.set(argIndex);
3802   }
3803 
3804   // Check the length modifier is valid with the given conversion specifier.
3805   if (!FS.hasValidLengthModifier(S.getASTContext().getTargetInfo()))
3806     HandleInvalidLengthModifier(FS, CS, startSpecifier, specifierLen,
3807                                 diag::warn_format_nonsensical_length);
3808   else if (!FS.hasStandardLengthModifier())
3809     HandleNonStandardLengthModifier(FS, startSpecifier, specifierLen);
3810   else if (!FS.hasStandardLengthConversionCombination())
3811     HandleInvalidLengthModifier(FS, CS, startSpecifier, specifierLen,
3812                                 diag::warn_format_non_standard_conversion_spec);
3813 
3814   if (!FS.hasStandardConversionSpecifier(S.getLangOpts()))
3815     HandleNonStandardConversionSpecifier(CS, startSpecifier, specifierLen);
3816 
3817   // The remaining checks depend on the data arguments.
3818   if (HasVAListArg)
3819     return true;
3820 
3821   if (!CheckNumArgs(FS, CS, startSpecifier, specifierLen, argIndex))
3822     return false;
3823 
3824   // Check that the argument type matches the format specifier.
3825   const Expr *Ex = getDataArg(argIndex);
3826   if (!Ex)
3827     return true;
3828 
3829   const analyze_format_string::ArgType &AT = FS.getArgType(S.Context);
3830   if (AT.isValid() && !AT.matchesType(S.Context, Ex->getType())) {
3831     ScanfSpecifier fixedFS = FS;
3832     bool success = fixedFS.fixType(Ex->getType(),
3833                                    Ex->IgnoreImpCasts()->getType(),
3834                                    S.getLangOpts(), S.Context);
3835 
3836     if (success) {
3837       // Get the fix string from the fixed format specifier.
3838       SmallString<128> buf;
3839       llvm::raw_svector_ostream os(buf);
3840       fixedFS.toString(os);
3841 
3842       EmitFormatDiagnostic(
3843         S.PDiag(diag::warn_format_conversion_argument_type_mismatch)
3844           << AT.getRepresentativeTypeName(S.Context) << Ex->getType() << false
3845           << Ex->getSourceRange(),
3846         Ex->getLocStart(),
3847         /*IsStringLocation*/false,
3848         getSpecifierRange(startSpecifier, specifierLen),
3849         FixItHint::CreateReplacement(
3850           getSpecifierRange(startSpecifier, specifierLen),
3851           os.str()));
3852     } else {
3853       EmitFormatDiagnostic(
3854         S.PDiag(diag::warn_format_conversion_argument_type_mismatch)
3855           << AT.getRepresentativeTypeName(S.Context) << Ex->getType() << false
3856           << Ex->getSourceRange(),
3857         Ex->getLocStart(),
3858         /*IsStringLocation*/false,
3859         getSpecifierRange(startSpecifier, specifierLen));
3860     }
3861   }
3862 
3863   return true;
3864 }
3865 
3866 void Sema::CheckFormatString(const StringLiteral *FExpr,
3867                              const Expr *OrigFormatExpr,
3868                              ArrayRef<const Expr *> Args,
3869                              bool HasVAListArg, unsigned format_idx,
3870                              unsigned firstDataArg, FormatStringType Type,
3871                              bool inFunctionCall, VariadicCallType CallType,
3872                              llvm::SmallBitVector &CheckedVarArgs) {
3873 
3874   // CHECK: is the format string a wide literal?
3875   if (!FExpr->isAscii() && !FExpr->isUTF8()) {
3876     CheckFormatHandler::EmitFormatDiagnostic(
3877       *this, inFunctionCall, Args[format_idx],
3878       PDiag(diag::warn_format_string_is_wide_literal), FExpr->getLocStart(),
3879       /*IsStringLocation*/true, OrigFormatExpr->getSourceRange());
3880     return;
3881   }
3882 
3883   // Str - The format string.  NOTE: this is NOT null-terminated!
3884   StringRef StrRef = FExpr->getString();
3885   const char *Str = StrRef.data();
3886   // Account for cases where the string literal is truncated in a declaration.
3887   const ConstantArrayType *T = Context.getAsConstantArrayType(FExpr->getType());
3888   assert(T && "String literal not of constant array type!");
3889   size_t TypeSize = T->getSize().getZExtValue();
3890   size_t StrLen = std::min(std::max(TypeSize, size_t(1)) - 1, StrRef.size());
3891   const unsigned numDataArgs = Args.size() - firstDataArg;
3892 
3893   // Emit a warning if the string literal is truncated and does not contain an
3894   // embedded null character.
3895   if (TypeSize <= StrRef.size() &&
3896       StrRef.substr(0, TypeSize).find('\0') == StringRef::npos) {
3897     CheckFormatHandler::EmitFormatDiagnostic(
3898         *this, inFunctionCall, Args[format_idx],
3899         PDiag(diag::warn_printf_format_string_not_null_terminated),
3900         FExpr->getLocStart(),
3901         /*IsStringLocation=*/true, OrigFormatExpr->getSourceRange());
3902     return;
3903   }
3904 
3905   // CHECK: empty format string?
3906   if (StrLen == 0 && numDataArgs > 0) {
3907     CheckFormatHandler::EmitFormatDiagnostic(
3908       *this, inFunctionCall, Args[format_idx],
3909       PDiag(diag::warn_empty_format_string), FExpr->getLocStart(),
3910       /*IsStringLocation*/true, OrigFormatExpr->getSourceRange());
3911     return;
3912   }
3913 
3914   if (Type == FST_Printf || Type == FST_NSString) {
3915     CheckPrintfHandler H(*this, FExpr, OrigFormatExpr, firstDataArg,
3916                          numDataArgs, (Type == FST_NSString),
3917                          Str, HasVAListArg, Args, format_idx,
3918                          inFunctionCall, CallType, CheckedVarArgs);
3919 
3920     if (!analyze_format_string::ParsePrintfString(H, Str, Str + StrLen,
3921                                                   getLangOpts(),
3922                                                   Context.getTargetInfo()))
3923       H.DoneProcessing();
3924   } else if (Type == FST_Scanf) {
3925     CheckScanfHandler H(*this, FExpr, OrigFormatExpr, firstDataArg, numDataArgs,
3926                         Str, HasVAListArg, Args, format_idx,
3927                         inFunctionCall, CallType, CheckedVarArgs);
3928 
3929     if (!analyze_format_string::ParseScanfString(H, Str, Str + StrLen,
3930                                                  getLangOpts(),
3931                                                  Context.getTargetInfo()))
3932       H.DoneProcessing();
3933   } // TODO: handle other formats
3934 }
3935 
3936 bool Sema::FormatStringHasSArg(const StringLiteral *FExpr) {
3937   // Str - The format string.  NOTE: this is NOT null-terminated!
3938   StringRef StrRef = FExpr->getString();
3939   const char *Str = StrRef.data();
3940   // Account for cases where the string literal is truncated in a declaration.
3941   const ConstantArrayType *T = Context.getAsConstantArrayType(FExpr->getType());
3942   assert(T && "String literal not of constant array type!");
3943   size_t TypeSize = T->getSize().getZExtValue();
3944   size_t StrLen = std::min(std::max(TypeSize, size_t(1)) - 1, StrRef.size());
3945   return analyze_format_string::ParseFormatStringHasSArg(Str, Str + StrLen,
3946                                                          getLangOpts(),
3947                                                          Context.getTargetInfo());
3948 }
3949 
3950 //===--- CHECK: Warn on use of wrong absolute value function. -------------===//
3951 
3952 // Returns the related absolute value function that is larger, of 0 if one
3953 // does not exist.
3954 static unsigned getLargerAbsoluteValueFunction(unsigned AbsFunction) {
3955   switch (AbsFunction) {
3956   default:
3957     return 0;
3958 
3959   case Builtin::BI__builtin_abs:
3960     return Builtin::BI__builtin_labs;
3961   case Builtin::BI__builtin_labs:
3962     return Builtin::BI__builtin_llabs;
3963   case Builtin::BI__builtin_llabs:
3964     return 0;
3965 
3966   case Builtin::BI__builtin_fabsf:
3967     return Builtin::BI__builtin_fabs;
3968   case Builtin::BI__builtin_fabs:
3969     return Builtin::BI__builtin_fabsl;
3970   case Builtin::BI__builtin_fabsl:
3971     return 0;
3972 
3973   case Builtin::BI__builtin_cabsf:
3974     return Builtin::BI__builtin_cabs;
3975   case Builtin::BI__builtin_cabs:
3976     return Builtin::BI__builtin_cabsl;
3977   case Builtin::BI__builtin_cabsl:
3978     return 0;
3979 
3980   case Builtin::BIabs:
3981     return Builtin::BIlabs;
3982   case Builtin::BIlabs:
3983     return Builtin::BIllabs;
3984   case Builtin::BIllabs:
3985     return 0;
3986 
3987   case Builtin::BIfabsf:
3988     return Builtin::BIfabs;
3989   case Builtin::BIfabs:
3990     return Builtin::BIfabsl;
3991   case Builtin::BIfabsl:
3992     return 0;
3993 
3994   case Builtin::BIcabsf:
3995    return Builtin::BIcabs;
3996   case Builtin::BIcabs:
3997     return Builtin::BIcabsl;
3998   case Builtin::BIcabsl:
3999     return 0;
4000   }
4001 }
4002 
4003 // Returns the argument type of the absolute value function.
4004 static QualType getAbsoluteValueArgumentType(ASTContext &Context,
4005                                              unsigned AbsType) {
4006   if (AbsType == 0)
4007     return QualType();
4008 
4009   ASTContext::GetBuiltinTypeError Error = ASTContext::GE_None;
4010   QualType BuiltinType = Context.GetBuiltinType(AbsType, Error);
4011   if (Error != ASTContext::GE_None)
4012     return QualType();
4013 
4014   const FunctionProtoType *FT = BuiltinType->getAs<FunctionProtoType>();
4015   if (!FT)
4016     return QualType();
4017 
4018   if (FT->getNumParams() != 1)
4019     return QualType();
4020 
4021   return FT->getParamType(0);
4022 }
4023 
4024 // Returns the best absolute value function, or zero, based on type and
4025 // current absolute value function.
4026 static unsigned getBestAbsFunction(ASTContext &Context, QualType ArgType,
4027                                    unsigned AbsFunctionKind) {
4028   unsigned BestKind = 0;
4029   uint64_t ArgSize = Context.getTypeSize(ArgType);
4030   for (unsigned Kind = AbsFunctionKind; Kind != 0;
4031        Kind = getLargerAbsoluteValueFunction(Kind)) {
4032     QualType ParamType = getAbsoluteValueArgumentType(Context, Kind);
4033     if (Context.getTypeSize(ParamType) >= ArgSize) {
4034       if (BestKind == 0)
4035         BestKind = Kind;
4036       else if (Context.hasSameType(ParamType, ArgType)) {
4037         BestKind = Kind;
4038         break;
4039       }
4040     }
4041   }
4042   return BestKind;
4043 }
4044 
4045 enum AbsoluteValueKind {
4046   AVK_Integer,
4047   AVK_Floating,
4048   AVK_Complex
4049 };
4050 
4051 static AbsoluteValueKind getAbsoluteValueKind(QualType T) {
4052   if (T->isIntegralOrEnumerationType())
4053     return AVK_Integer;
4054   if (T->isRealFloatingType())
4055     return AVK_Floating;
4056   if (T->isAnyComplexType())
4057     return AVK_Complex;
4058 
4059   llvm_unreachable("Type not integer, floating, or complex");
4060 }
4061 
4062 // Changes the absolute value function to a different type.  Preserves whether
4063 // the function is a builtin.
4064 static unsigned changeAbsFunction(unsigned AbsKind,
4065                                   AbsoluteValueKind ValueKind) {
4066   switch (ValueKind) {
4067   case AVK_Integer:
4068     switch (AbsKind) {
4069     default:
4070       return 0;
4071     case Builtin::BI__builtin_fabsf:
4072     case Builtin::BI__builtin_fabs:
4073     case Builtin::BI__builtin_fabsl:
4074     case Builtin::BI__builtin_cabsf:
4075     case Builtin::BI__builtin_cabs:
4076     case Builtin::BI__builtin_cabsl:
4077       return Builtin::BI__builtin_abs;
4078     case Builtin::BIfabsf:
4079     case Builtin::BIfabs:
4080     case Builtin::BIfabsl:
4081     case Builtin::BIcabsf:
4082     case Builtin::BIcabs:
4083     case Builtin::BIcabsl:
4084       return Builtin::BIabs;
4085     }
4086   case AVK_Floating:
4087     switch (AbsKind) {
4088     default:
4089       return 0;
4090     case Builtin::BI__builtin_abs:
4091     case Builtin::BI__builtin_labs:
4092     case Builtin::BI__builtin_llabs:
4093     case Builtin::BI__builtin_cabsf:
4094     case Builtin::BI__builtin_cabs:
4095     case Builtin::BI__builtin_cabsl:
4096       return Builtin::BI__builtin_fabsf;
4097     case Builtin::BIabs:
4098     case Builtin::BIlabs:
4099     case Builtin::BIllabs:
4100     case Builtin::BIcabsf:
4101     case Builtin::BIcabs:
4102     case Builtin::BIcabsl:
4103       return Builtin::BIfabsf;
4104     }
4105   case AVK_Complex:
4106     switch (AbsKind) {
4107     default:
4108       return 0;
4109     case Builtin::BI__builtin_abs:
4110     case Builtin::BI__builtin_labs:
4111     case Builtin::BI__builtin_llabs:
4112     case Builtin::BI__builtin_fabsf:
4113     case Builtin::BI__builtin_fabs:
4114     case Builtin::BI__builtin_fabsl:
4115       return Builtin::BI__builtin_cabsf;
4116     case Builtin::BIabs:
4117     case Builtin::BIlabs:
4118     case Builtin::BIllabs:
4119     case Builtin::BIfabsf:
4120     case Builtin::BIfabs:
4121     case Builtin::BIfabsl:
4122       return Builtin::BIcabsf;
4123     }
4124   }
4125   llvm_unreachable("Unable to convert function");
4126 }
4127 
4128 static unsigned getAbsoluteValueFunctionKind(const FunctionDecl *FDecl) {
4129   const IdentifierInfo *FnInfo = FDecl->getIdentifier();
4130   if (!FnInfo)
4131     return 0;
4132 
4133   switch (FDecl->getBuiltinID()) {
4134   default:
4135     return 0;
4136   case Builtin::BI__builtin_abs:
4137   case Builtin::BI__builtin_fabs:
4138   case Builtin::BI__builtin_fabsf:
4139   case Builtin::BI__builtin_fabsl:
4140   case Builtin::BI__builtin_labs:
4141   case Builtin::BI__builtin_llabs:
4142   case Builtin::BI__builtin_cabs:
4143   case Builtin::BI__builtin_cabsf:
4144   case Builtin::BI__builtin_cabsl:
4145   case Builtin::BIabs:
4146   case Builtin::BIlabs:
4147   case Builtin::BIllabs:
4148   case Builtin::BIfabs:
4149   case Builtin::BIfabsf:
4150   case Builtin::BIfabsl:
4151   case Builtin::BIcabs:
4152   case Builtin::BIcabsf:
4153   case Builtin::BIcabsl:
4154     return FDecl->getBuiltinID();
4155   }
4156   llvm_unreachable("Unknown Builtin type");
4157 }
4158 
4159 // If the replacement is valid, emit a note with replacement function.
4160 // Additionally, suggest including the proper header if not already included.
4161 static void emitReplacement(Sema &S, SourceLocation Loc, SourceRange Range,
4162                             unsigned AbsKind, QualType ArgType) {
4163   bool EmitHeaderHint = true;
4164   const char *HeaderName = nullptr;
4165   const char *FunctionName = nullptr;
4166   if (S.getLangOpts().CPlusPlus && !ArgType->isAnyComplexType()) {
4167     FunctionName = "std::abs";
4168     if (ArgType->isIntegralOrEnumerationType()) {
4169       HeaderName = "cstdlib";
4170     } else if (ArgType->isRealFloatingType()) {
4171       HeaderName = "cmath";
4172     } else {
4173       llvm_unreachable("Invalid Type");
4174     }
4175 
4176     // Lookup all std::abs
4177     if (NamespaceDecl *Std = S.getStdNamespace()) {
4178       LookupResult R(S, &S.Context.Idents.get("abs"), Loc, Sema::LookupAnyName);
4179       R.suppressDiagnostics();
4180       S.LookupQualifiedName(R, Std);
4181 
4182       for (const auto *I : R) {
4183         const FunctionDecl *FDecl = nullptr;
4184         if (const UsingShadowDecl *UsingD = dyn_cast<UsingShadowDecl>(I)) {
4185           FDecl = dyn_cast<FunctionDecl>(UsingD->getTargetDecl());
4186         } else {
4187           FDecl = dyn_cast<FunctionDecl>(I);
4188         }
4189         if (!FDecl)
4190           continue;
4191 
4192         // Found std::abs(), check that they are the right ones.
4193         if (FDecl->getNumParams() != 1)
4194           continue;
4195 
4196         // Check that the parameter type can handle the argument.
4197         QualType ParamType = FDecl->getParamDecl(0)->getType();
4198         if (getAbsoluteValueKind(ArgType) == getAbsoluteValueKind(ParamType) &&
4199             S.Context.getTypeSize(ArgType) <=
4200                 S.Context.getTypeSize(ParamType)) {
4201           // Found a function, don't need the header hint.
4202           EmitHeaderHint = false;
4203           break;
4204         }
4205       }
4206     }
4207   } else {
4208     FunctionName = S.Context.BuiltinInfo.GetName(AbsKind);
4209     HeaderName = S.Context.BuiltinInfo.getHeaderName(AbsKind);
4210 
4211     if (HeaderName) {
4212       DeclarationName DN(&S.Context.Idents.get(FunctionName));
4213       LookupResult R(S, DN, Loc, Sema::LookupAnyName);
4214       R.suppressDiagnostics();
4215       S.LookupName(R, S.getCurScope());
4216 
4217       if (R.isSingleResult()) {
4218         FunctionDecl *FD = dyn_cast<FunctionDecl>(R.getFoundDecl());
4219         if (FD && FD->getBuiltinID() == AbsKind) {
4220           EmitHeaderHint = false;
4221         } else {
4222           return;
4223         }
4224       } else if (!R.empty()) {
4225         return;
4226       }
4227     }
4228   }
4229 
4230   S.Diag(Loc, diag::note_replace_abs_function)
4231       << FunctionName << FixItHint::CreateReplacement(Range, FunctionName);
4232 
4233   if (!HeaderName)
4234     return;
4235 
4236   if (!EmitHeaderHint)
4237     return;
4238 
4239   S.Diag(Loc, diag::note_include_header_or_declare) << HeaderName
4240                                                     << FunctionName;
4241 }
4242 
4243 static bool IsFunctionStdAbs(const FunctionDecl *FDecl) {
4244   if (!FDecl)
4245     return false;
4246 
4247   if (!FDecl->getIdentifier() || !FDecl->getIdentifier()->isStr("abs"))
4248     return false;
4249 
4250   const NamespaceDecl *ND = dyn_cast<NamespaceDecl>(FDecl->getDeclContext());
4251 
4252   while (ND && ND->isInlineNamespace()) {
4253     ND = dyn_cast<NamespaceDecl>(ND->getDeclContext());
4254   }
4255 
4256   if (!ND || !ND->getIdentifier() || !ND->getIdentifier()->isStr("std"))
4257     return false;
4258 
4259   if (!isa<TranslationUnitDecl>(ND->getDeclContext()))
4260     return false;
4261 
4262   return true;
4263 }
4264 
4265 // Warn when using the wrong abs() function.
4266 void Sema::CheckAbsoluteValueFunction(const CallExpr *Call,
4267                                       const FunctionDecl *FDecl,
4268                                       IdentifierInfo *FnInfo) {
4269   if (Call->getNumArgs() != 1)
4270     return;
4271 
4272   unsigned AbsKind = getAbsoluteValueFunctionKind(FDecl);
4273   bool IsStdAbs = IsFunctionStdAbs(FDecl);
4274   if (AbsKind == 0 && !IsStdAbs)
4275     return;
4276 
4277   QualType ArgType = Call->getArg(0)->IgnoreParenImpCasts()->getType();
4278   QualType ParamType = Call->getArg(0)->getType();
4279 
4280   // Unsigned types cannot be negative.  Suggest removing the absolute value
4281   // function call.
4282   if (ArgType->isUnsignedIntegerType()) {
4283     const char *FunctionName =
4284         IsStdAbs ? "std::abs" : Context.BuiltinInfo.GetName(AbsKind);
4285     Diag(Call->getExprLoc(), diag::warn_unsigned_abs) << ArgType << ParamType;
4286     Diag(Call->getExprLoc(), diag::note_remove_abs)
4287         << FunctionName
4288         << FixItHint::CreateRemoval(Call->getCallee()->getSourceRange());
4289     return;
4290   }
4291 
4292   // std::abs has overloads which prevent most of the absolute value problems
4293   // from occurring.
4294   if (IsStdAbs)
4295     return;
4296 
4297   AbsoluteValueKind ArgValueKind = getAbsoluteValueKind(ArgType);
4298   AbsoluteValueKind ParamValueKind = getAbsoluteValueKind(ParamType);
4299 
4300   // The argument and parameter are the same kind.  Check if they are the right
4301   // size.
4302   if (ArgValueKind == ParamValueKind) {
4303     if (Context.getTypeSize(ArgType) <= Context.getTypeSize(ParamType))
4304       return;
4305 
4306     unsigned NewAbsKind = getBestAbsFunction(Context, ArgType, AbsKind);
4307     Diag(Call->getExprLoc(), diag::warn_abs_too_small)
4308         << FDecl << ArgType << ParamType;
4309 
4310     if (NewAbsKind == 0)
4311       return;
4312 
4313     emitReplacement(*this, Call->getExprLoc(),
4314                     Call->getCallee()->getSourceRange(), NewAbsKind, ArgType);
4315     return;
4316   }
4317 
4318   // ArgValueKind != ParamValueKind
4319   // The wrong type of absolute value function was used.  Attempt to find the
4320   // proper one.
4321   unsigned NewAbsKind = changeAbsFunction(AbsKind, ArgValueKind);
4322   NewAbsKind = getBestAbsFunction(Context, ArgType, NewAbsKind);
4323   if (NewAbsKind == 0)
4324     return;
4325 
4326   Diag(Call->getExprLoc(), diag::warn_wrong_absolute_value_type)
4327       << FDecl << ParamValueKind << ArgValueKind;
4328 
4329   emitReplacement(*this, Call->getExprLoc(),
4330                   Call->getCallee()->getSourceRange(), NewAbsKind, ArgType);
4331   return;
4332 }
4333 
4334 //===--- CHECK: Standard memory functions ---------------------------------===//
4335 
4336 /// \brief Takes the expression passed to the size_t parameter of functions
4337 /// such as memcmp, strncat, etc and warns if it's a comparison.
4338 ///
4339 /// This is to catch typos like `if (memcmp(&a, &b, sizeof(a) > 0))`.
4340 static bool CheckMemorySizeofForComparison(Sema &S, const Expr *E,
4341                                            IdentifierInfo *FnName,
4342                                            SourceLocation FnLoc,
4343                                            SourceLocation RParenLoc) {
4344   const BinaryOperator *Size = dyn_cast<BinaryOperator>(E);
4345   if (!Size)
4346     return false;
4347 
4348   // if E is binop and op is >, <, >=, <=, ==, &&, ||:
4349   if (!Size->isComparisonOp() && !Size->isEqualityOp() && !Size->isLogicalOp())
4350     return false;
4351 
4352   SourceRange SizeRange = Size->getSourceRange();
4353   S.Diag(Size->getOperatorLoc(), diag::warn_memsize_comparison)
4354       << SizeRange << FnName;
4355   S.Diag(FnLoc, diag::note_memsize_comparison_paren)
4356       << FnName << FixItHint::CreateInsertion(
4357                        S.getLocForEndOfToken(Size->getLHS()->getLocEnd()), ")")
4358       << FixItHint::CreateRemoval(RParenLoc);
4359   S.Diag(SizeRange.getBegin(), diag::note_memsize_comparison_cast_silence)
4360       << FixItHint::CreateInsertion(SizeRange.getBegin(), "(size_t)(")
4361       << FixItHint::CreateInsertion(S.getLocForEndOfToken(SizeRange.getEnd()),
4362                                     ")");
4363 
4364   return true;
4365 }
4366 
4367 /// \brief Determine whether the given type is or contains a dynamic class type
4368 /// (e.g., whether it has a vtable).
4369 static const CXXRecordDecl *getContainedDynamicClass(QualType T,
4370                                                      bool &IsContained) {
4371   // Look through array types while ignoring qualifiers.
4372   const Type *Ty = T->getBaseElementTypeUnsafe();
4373   IsContained = false;
4374 
4375   const CXXRecordDecl *RD = Ty->getAsCXXRecordDecl();
4376   RD = RD ? RD->getDefinition() : nullptr;
4377   if (!RD)
4378     return nullptr;
4379 
4380   if (RD->isDynamicClass())
4381     return RD;
4382 
4383   // Check all the fields.  If any bases were dynamic, the class is dynamic.
4384   // It's impossible for a class to transitively contain itself by value, so
4385   // infinite recursion is impossible.
4386   for (auto *FD : RD->fields()) {
4387     bool SubContained;
4388     if (const CXXRecordDecl *ContainedRD =
4389             getContainedDynamicClass(FD->getType(), SubContained)) {
4390       IsContained = true;
4391       return ContainedRD;
4392     }
4393   }
4394 
4395   return nullptr;
4396 }
4397 
4398 /// \brief If E is a sizeof expression, returns its argument expression,
4399 /// otherwise returns NULL.
4400 static const Expr *getSizeOfExprArg(const Expr* E) {
4401   if (const UnaryExprOrTypeTraitExpr *SizeOf =
4402       dyn_cast<UnaryExprOrTypeTraitExpr>(E))
4403     if (SizeOf->getKind() == clang::UETT_SizeOf && !SizeOf->isArgumentType())
4404       return SizeOf->getArgumentExpr()->IgnoreParenImpCasts();
4405 
4406   return nullptr;
4407 }
4408 
4409 /// \brief If E is a sizeof expression, returns its argument type.
4410 static QualType getSizeOfArgType(const Expr* E) {
4411   if (const UnaryExprOrTypeTraitExpr *SizeOf =
4412       dyn_cast<UnaryExprOrTypeTraitExpr>(E))
4413     if (SizeOf->getKind() == clang::UETT_SizeOf)
4414       return SizeOf->getTypeOfArgument();
4415 
4416   return QualType();
4417 }
4418 
4419 /// \brief Check for dangerous or invalid arguments to memset().
4420 ///
4421 /// This issues warnings on known problematic, dangerous or unspecified
4422 /// arguments to the standard 'memset', 'memcpy', 'memmove', and 'memcmp'
4423 /// function calls.
4424 ///
4425 /// \param Call The call expression to diagnose.
4426 void Sema::CheckMemaccessArguments(const CallExpr *Call,
4427                                    unsigned BId,
4428                                    IdentifierInfo *FnName) {
4429   assert(BId != 0);
4430 
4431   // It is possible to have a non-standard definition of memset.  Validate
4432   // we have enough arguments, and if not, abort further checking.
4433   unsigned ExpectedNumArgs = (BId == Builtin::BIstrndup ? 2 : 3);
4434   if (Call->getNumArgs() < ExpectedNumArgs)
4435     return;
4436 
4437   unsigned LastArg = (BId == Builtin::BImemset ||
4438                       BId == Builtin::BIstrndup ? 1 : 2);
4439   unsigned LenArg = (BId == Builtin::BIstrndup ? 1 : 2);
4440   const Expr *LenExpr = Call->getArg(LenArg)->IgnoreParenImpCasts();
4441 
4442   if (CheckMemorySizeofForComparison(*this, LenExpr, FnName,
4443                                      Call->getLocStart(), Call->getRParenLoc()))
4444     return;
4445 
4446   // We have special checking when the length is a sizeof expression.
4447   QualType SizeOfArgTy = getSizeOfArgType(LenExpr);
4448   const Expr *SizeOfArg = getSizeOfExprArg(LenExpr);
4449   llvm::FoldingSetNodeID SizeOfArgID;
4450 
4451   for (unsigned ArgIdx = 0; ArgIdx != LastArg; ++ArgIdx) {
4452     const Expr *Dest = Call->getArg(ArgIdx)->IgnoreParenImpCasts();
4453     SourceRange ArgRange = Call->getArg(ArgIdx)->getSourceRange();
4454 
4455     QualType DestTy = Dest->getType();
4456     if (const PointerType *DestPtrTy = DestTy->getAs<PointerType>()) {
4457       QualType PointeeTy = DestPtrTy->getPointeeType();
4458 
4459       // Never warn about void type pointers. This can be used to suppress
4460       // false positives.
4461       if (PointeeTy->isVoidType())
4462         continue;
4463 
4464       // Catch "memset(p, 0, sizeof(p))" -- needs to be sizeof(*p). Do this by
4465       // actually comparing the expressions for equality. Because computing the
4466       // expression IDs can be expensive, we only do this if the diagnostic is
4467       // enabled.
4468       if (SizeOfArg &&
4469           !Diags.isIgnored(diag::warn_sizeof_pointer_expr_memaccess,
4470                            SizeOfArg->getExprLoc())) {
4471         // We only compute IDs for expressions if the warning is enabled, and
4472         // cache the sizeof arg's ID.
4473         if (SizeOfArgID == llvm::FoldingSetNodeID())
4474           SizeOfArg->Profile(SizeOfArgID, Context, true);
4475         llvm::FoldingSetNodeID DestID;
4476         Dest->Profile(DestID, Context, true);
4477         if (DestID == SizeOfArgID) {
4478           // TODO: For strncpy() and friends, this could suggest sizeof(dst)
4479           //       over sizeof(src) as well.
4480           unsigned ActionIdx = 0; // Default is to suggest dereferencing.
4481           StringRef ReadableName = FnName->getName();
4482 
4483           if (const UnaryOperator *UnaryOp = dyn_cast<UnaryOperator>(Dest))
4484             if (UnaryOp->getOpcode() == UO_AddrOf)
4485               ActionIdx = 1; // If its an address-of operator, just remove it.
4486           if (!PointeeTy->isIncompleteType() &&
4487               (Context.getTypeSize(PointeeTy) == Context.getCharWidth()))
4488             ActionIdx = 2; // If the pointee's size is sizeof(char),
4489                            // suggest an explicit length.
4490 
4491           // If the function is defined as a builtin macro, do not show macro
4492           // expansion.
4493           SourceLocation SL = SizeOfArg->getExprLoc();
4494           SourceRange DSR = Dest->getSourceRange();
4495           SourceRange SSR = SizeOfArg->getSourceRange();
4496           SourceManager &SM = getSourceManager();
4497 
4498           if (SM.isMacroArgExpansion(SL)) {
4499             ReadableName = Lexer::getImmediateMacroName(SL, SM, LangOpts);
4500             SL = SM.getSpellingLoc(SL);
4501             DSR = SourceRange(SM.getSpellingLoc(DSR.getBegin()),
4502                              SM.getSpellingLoc(DSR.getEnd()));
4503             SSR = SourceRange(SM.getSpellingLoc(SSR.getBegin()),
4504                              SM.getSpellingLoc(SSR.getEnd()));
4505           }
4506 
4507           DiagRuntimeBehavior(SL, SizeOfArg,
4508                               PDiag(diag::warn_sizeof_pointer_expr_memaccess)
4509                                 << ReadableName
4510                                 << PointeeTy
4511                                 << DestTy
4512                                 << DSR
4513                                 << SSR);
4514           DiagRuntimeBehavior(SL, SizeOfArg,
4515                          PDiag(diag::warn_sizeof_pointer_expr_memaccess_note)
4516                                 << ActionIdx
4517                                 << SSR);
4518 
4519           break;
4520         }
4521       }
4522 
4523       // Also check for cases where the sizeof argument is the exact same
4524       // type as the memory argument, and where it points to a user-defined
4525       // record type.
4526       if (SizeOfArgTy != QualType()) {
4527         if (PointeeTy->isRecordType() &&
4528             Context.typesAreCompatible(SizeOfArgTy, DestTy)) {
4529           DiagRuntimeBehavior(LenExpr->getExprLoc(), Dest,
4530                               PDiag(diag::warn_sizeof_pointer_type_memaccess)
4531                                 << FnName << SizeOfArgTy << ArgIdx
4532                                 << PointeeTy << Dest->getSourceRange()
4533                                 << LenExpr->getSourceRange());
4534           break;
4535         }
4536       }
4537 
4538       // Always complain about dynamic classes.
4539       bool IsContained;
4540       if (const CXXRecordDecl *ContainedRD =
4541               getContainedDynamicClass(PointeeTy, IsContained)) {
4542 
4543         unsigned OperationType = 0;
4544         // "overwritten" if we're warning about the destination for any call
4545         // but memcmp; otherwise a verb appropriate to the call.
4546         if (ArgIdx != 0 || BId == Builtin::BImemcmp) {
4547           if (BId == Builtin::BImemcpy)
4548             OperationType = 1;
4549           else if(BId == Builtin::BImemmove)
4550             OperationType = 2;
4551           else if (BId == Builtin::BImemcmp)
4552             OperationType = 3;
4553         }
4554 
4555         DiagRuntimeBehavior(
4556           Dest->getExprLoc(), Dest,
4557           PDiag(diag::warn_dyn_class_memaccess)
4558             << (BId == Builtin::BImemcmp ? ArgIdx + 2 : ArgIdx)
4559             << FnName << IsContained << ContainedRD << OperationType
4560             << Call->getCallee()->getSourceRange());
4561       } else if (PointeeTy.hasNonTrivialObjCLifetime() &&
4562                BId != Builtin::BImemset)
4563         DiagRuntimeBehavior(
4564           Dest->getExprLoc(), Dest,
4565           PDiag(diag::warn_arc_object_memaccess)
4566             << ArgIdx << FnName << PointeeTy
4567             << Call->getCallee()->getSourceRange());
4568       else
4569         continue;
4570 
4571       DiagRuntimeBehavior(
4572         Dest->getExprLoc(), Dest,
4573         PDiag(diag::note_bad_memaccess_silence)
4574           << FixItHint::CreateInsertion(ArgRange.getBegin(), "(void*)"));
4575       break;
4576     }
4577   }
4578 }
4579 
4580 // A little helper routine: ignore addition and subtraction of integer literals.
4581 // This intentionally does not ignore all integer constant expressions because
4582 // we don't want to remove sizeof().
4583 static const Expr *ignoreLiteralAdditions(const Expr *Ex, ASTContext &Ctx) {
4584   Ex = Ex->IgnoreParenCasts();
4585 
4586   for (;;) {
4587     const BinaryOperator * BO = dyn_cast<BinaryOperator>(Ex);
4588     if (!BO || !BO->isAdditiveOp())
4589       break;
4590 
4591     const Expr *RHS = BO->getRHS()->IgnoreParenCasts();
4592     const Expr *LHS = BO->getLHS()->IgnoreParenCasts();
4593 
4594     if (isa<IntegerLiteral>(RHS))
4595       Ex = LHS;
4596     else if (isa<IntegerLiteral>(LHS))
4597       Ex = RHS;
4598     else
4599       break;
4600   }
4601 
4602   return Ex;
4603 }
4604 
4605 static bool isConstantSizeArrayWithMoreThanOneElement(QualType Ty,
4606                                                       ASTContext &Context) {
4607   // Only handle constant-sized or VLAs, but not flexible members.
4608   if (const ConstantArrayType *CAT = Context.getAsConstantArrayType(Ty)) {
4609     // Only issue the FIXIT for arrays of size > 1.
4610     if (CAT->getSize().getSExtValue() <= 1)
4611       return false;
4612   } else if (!Ty->isVariableArrayType()) {
4613     return false;
4614   }
4615   return true;
4616 }
4617 
4618 // Warn if the user has made the 'size' argument to strlcpy or strlcat
4619 // be the size of the source, instead of the destination.
4620 void Sema::CheckStrlcpycatArguments(const CallExpr *Call,
4621                                     IdentifierInfo *FnName) {
4622 
4623   // Don't crash if the user has the wrong number of arguments
4624   unsigned NumArgs = Call->getNumArgs();
4625   if ((NumArgs != 3) && (NumArgs != 4))
4626     return;
4627 
4628   const Expr *SrcArg = ignoreLiteralAdditions(Call->getArg(1), Context);
4629   const Expr *SizeArg = ignoreLiteralAdditions(Call->getArg(2), Context);
4630   const Expr *CompareWithSrc = nullptr;
4631 
4632   if (CheckMemorySizeofForComparison(*this, SizeArg, FnName,
4633                                      Call->getLocStart(), Call->getRParenLoc()))
4634     return;
4635 
4636   // Look for 'strlcpy(dst, x, sizeof(x))'
4637   if (const Expr *Ex = getSizeOfExprArg(SizeArg))
4638     CompareWithSrc = Ex;
4639   else {
4640     // Look for 'strlcpy(dst, x, strlen(x))'
4641     if (const CallExpr *SizeCall = dyn_cast<CallExpr>(SizeArg)) {
4642       if (SizeCall->getBuiltinCallee() == Builtin::BIstrlen &&
4643           SizeCall->getNumArgs() == 1)
4644         CompareWithSrc = ignoreLiteralAdditions(SizeCall->getArg(0), Context);
4645     }
4646   }
4647 
4648   if (!CompareWithSrc)
4649     return;
4650 
4651   // Determine if the argument to sizeof/strlen is equal to the source
4652   // argument.  In principle there's all kinds of things you could do
4653   // here, for instance creating an == expression and evaluating it with
4654   // EvaluateAsBooleanCondition, but this uses a more direct technique:
4655   const DeclRefExpr *SrcArgDRE = dyn_cast<DeclRefExpr>(SrcArg);
4656   if (!SrcArgDRE)
4657     return;
4658 
4659   const DeclRefExpr *CompareWithSrcDRE = dyn_cast<DeclRefExpr>(CompareWithSrc);
4660   if (!CompareWithSrcDRE ||
4661       SrcArgDRE->getDecl() != CompareWithSrcDRE->getDecl())
4662     return;
4663 
4664   const Expr *OriginalSizeArg = Call->getArg(2);
4665   Diag(CompareWithSrcDRE->getLocStart(), diag::warn_strlcpycat_wrong_size)
4666     << OriginalSizeArg->getSourceRange() << FnName;
4667 
4668   // Output a FIXIT hint if the destination is an array (rather than a
4669   // pointer to an array).  This could be enhanced to handle some
4670   // pointers if we know the actual size, like if DstArg is 'array+2'
4671   // we could say 'sizeof(array)-2'.
4672   const Expr *DstArg = Call->getArg(0)->IgnoreParenImpCasts();
4673   if (!isConstantSizeArrayWithMoreThanOneElement(DstArg->getType(), Context))
4674     return;
4675 
4676   SmallString<128> sizeString;
4677   llvm::raw_svector_ostream OS(sizeString);
4678   OS << "sizeof(";
4679   DstArg->printPretty(OS, nullptr, getPrintingPolicy());
4680   OS << ")";
4681 
4682   Diag(OriginalSizeArg->getLocStart(), diag::note_strlcpycat_wrong_size)
4683     << FixItHint::CreateReplacement(OriginalSizeArg->getSourceRange(),
4684                                     OS.str());
4685 }
4686 
4687 /// Check if two expressions refer to the same declaration.
4688 static bool referToTheSameDecl(const Expr *E1, const Expr *E2) {
4689   if (const DeclRefExpr *D1 = dyn_cast_or_null<DeclRefExpr>(E1))
4690     if (const DeclRefExpr *D2 = dyn_cast_or_null<DeclRefExpr>(E2))
4691       return D1->getDecl() == D2->getDecl();
4692   return false;
4693 }
4694 
4695 static const Expr *getStrlenExprArg(const Expr *E) {
4696   if (const CallExpr *CE = dyn_cast<CallExpr>(E)) {
4697     const FunctionDecl *FD = CE->getDirectCallee();
4698     if (!FD || FD->getMemoryFunctionKind() != Builtin::BIstrlen)
4699       return nullptr;
4700     return CE->getArg(0)->IgnoreParenCasts();
4701   }
4702   return nullptr;
4703 }
4704 
4705 // Warn on anti-patterns as the 'size' argument to strncat.
4706 // The correct size argument should look like following:
4707 //   strncat(dst, src, sizeof(dst) - strlen(dest) - 1);
4708 void Sema::CheckStrncatArguments(const CallExpr *CE,
4709                                  IdentifierInfo *FnName) {
4710   // Don't crash if the user has the wrong number of arguments.
4711   if (CE->getNumArgs() < 3)
4712     return;
4713   const Expr *DstArg = CE->getArg(0)->IgnoreParenCasts();
4714   const Expr *SrcArg = CE->getArg(1)->IgnoreParenCasts();
4715   const Expr *LenArg = CE->getArg(2)->IgnoreParenCasts();
4716 
4717   if (CheckMemorySizeofForComparison(*this, LenArg, FnName, CE->getLocStart(),
4718                                      CE->getRParenLoc()))
4719     return;
4720 
4721   // Identify common expressions, which are wrongly used as the size argument
4722   // to strncat and may lead to buffer overflows.
4723   unsigned PatternType = 0;
4724   if (const Expr *SizeOfArg = getSizeOfExprArg(LenArg)) {
4725     // - sizeof(dst)
4726     if (referToTheSameDecl(SizeOfArg, DstArg))
4727       PatternType = 1;
4728     // - sizeof(src)
4729     else if (referToTheSameDecl(SizeOfArg, SrcArg))
4730       PatternType = 2;
4731   } else if (const BinaryOperator *BE = dyn_cast<BinaryOperator>(LenArg)) {
4732     if (BE->getOpcode() == BO_Sub) {
4733       const Expr *L = BE->getLHS()->IgnoreParenCasts();
4734       const Expr *R = BE->getRHS()->IgnoreParenCasts();
4735       // - sizeof(dst) - strlen(dst)
4736       if (referToTheSameDecl(DstArg, getSizeOfExprArg(L)) &&
4737           referToTheSameDecl(DstArg, getStrlenExprArg(R)))
4738         PatternType = 1;
4739       // - sizeof(src) - (anything)
4740       else if (referToTheSameDecl(SrcArg, getSizeOfExprArg(L)))
4741         PatternType = 2;
4742     }
4743   }
4744 
4745   if (PatternType == 0)
4746     return;
4747 
4748   // Generate the diagnostic.
4749   SourceLocation SL = LenArg->getLocStart();
4750   SourceRange SR = LenArg->getSourceRange();
4751   SourceManager &SM = getSourceManager();
4752 
4753   // If the function is defined as a builtin macro, do not show macro expansion.
4754   if (SM.isMacroArgExpansion(SL)) {
4755     SL = SM.getSpellingLoc(SL);
4756     SR = SourceRange(SM.getSpellingLoc(SR.getBegin()),
4757                      SM.getSpellingLoc(SR.getEnd()));
4758   }
4759 
4760   // Check if the destination is an array (rather than a pointer to an array).
4761   QualType DstTy = DstArg->getType();
4762   bool isKnownSizeArray = isConstantSizeArrayWithMoreThanOneElement(DstTy,
4763                                                                     Context);
4764   if (!isKnownSizeArray) {
4765     if (PatternType == 1)
4766       Diag(SL, diag::warn_strncat_wrong_size) << SR;
4767     else
4768       Diag(SL, diag::warn_strncat_src_size) << SR;
4769     return;
4770   }
4771 
4772   if (PatternType == 1)
4773     Diag(SL, diag::warn_strncat_large_size) << SR;
4774   else
4775     Diag(SL, diag::warn_strncat_src_size) << SR;
4776 
4777   SmallString<128> sizeString;
4778   llvm::raw_svector_ostream OS(sizeString);
4779   OS << "sizeof(";
4780   DstArg->printPretty(OS, nullptr, getPrintingPolicy());
4781   OS << ") - ";
4782   OS << "strlen(";
4783   DstArg->printPretty(OS, nullptr, getPrintingPolicy());
4784   OS << ") - 1";
4785 
4786   Diag(SL, diag::note_strncat_wrong_size)
4787     << FixItHint::CreateReplacement(SR, OS.str());
4788 }
4789 
4790 //===--- CHECK: Return Address of Stack Variable --------------------------===//
4791 
4792 static Expr *EvalVal(Expr *E, SmallVectorImpl<DeclRefExpr *> &refVars,
4793                      Decl *ParentDecl);
4794 static Expr *EvalAddr(Expr* E, SmallVectorImpl<DeclRefExpr *> &refVars,
4795                       Decl *ParentDecl);
4796 
4797 /// CheckReturnStackAddr - Check if a return statement returns the address
4798 ///   of a stack variable.
4799 static void
4800 CheckReturnStackAddr(Sema &S, Expr *RetValExp, QualType lhsType,
4801                      SourceLocation ReturnLoc) {
4802 
4803   Expr *stackE = nullptr;
4804   SmallVector<DeclRefExpr *, 8> refVars;
4805 
4806   // Perform checking for returned stack addresses, local blocks,
4807   // label addresses or references to temporaries.
4808   if (lhsType->isPointerType() ||
4809       (!S.getLangOpts().ObjCAutoRefCount && lhsType->isBlockPointerType())) {
4810     stackE = EvalAddr(RetValExp, refVars, /*ParentDecl=*/nullptr);
4811   } else if (lhsType->isReferenceType()) {
4812     stackE = EvalVal(RetValExp, refVars, /*ParentDecl=*/nullptr);
4813   }
4814 
4815   if (!stackE)
4816     return; // Nothing suspicious was found.
4817 
4818   SourceLocation diagLoc;
4819   SourceRange diagRange;
4820   if (refVars.empty()) {
4821     diagLoc = stackE->getLocStart();
4822     diagRange = stackE->getSourceRange();
4823   } else {
4824     // We followed through a reference variable. 'stackE' contains the
4825     // problematic expression but we will warn at the return statement pointing
4826     // at the reference variable. We will later display the "trail" of
4827     // reference variables using notes.
4828     diagLoc = refVars[0]->getLocStart();
4829     diagRange = refVars[0]->getSourceRange();
4830   }
4831 
4832   if (DeclRefExpr *DR = dyn_cast<DeclRefExpr>(stackE)) { //address of local var.
4833     S.Diag(diagLoc, lhsType->isReferenceType() ? diag::warn_ret_stack_ref
4834                                              : diag::warn_ret_stack_addr)
4835      << DR->getDecl()->getDeclName() << diagRange;
4836   } else if (isa<BlockExpr>(stackE)) { // local block.
4837     S.Diag(diagLoc, diag::err_ret_local_block) << diagRange;
4838   } else if (isa<AddrLabelExpr>(stackE)) { // address of label.
4839     S.Diag(diagLoc, diag::warn_ret_addr_label) << diagRange;
4840   } else { // local temporary.
4841     S.Diag(diagLoc, lhsType->isReferenceType() ? diag::warn_ret_local_temp_ref
4842                                                : diag::warn_ret_local_temp_addr)
4843      << diagRange;
4844   }
4845 
4846   // Display the "trail" of reference variables that we followed until we
4847   // found the problematic expression using notes.
4848   for (unsigned i = 0, e = refVars.size(); i != e; ++i) {
4849     VarDecl *VD = cast<VarDecl>(refVars[i]->getDecl());
4850     // If this var binds to another reference var, show the range of the next
4851     // var, otherwise the var binds to the problematic expression, in which case
4852     // show the range of the expression.
4853     SourceRange range = (i < e-1) ? refVars[i+1]->getSourceRange()
4854                                   : stackE->getSourceRange();
4855     S.Diag(VD->getLocation(), diag::note_ref_var_local_bind)
4856         << VD->getDeclName() << range;
4857   }
4858 }
4859 
4860 /// EvalAddr - EvalAddr and EvalVal are mutually recursive functions that
4861 ///  check if the expression in a return statement evaluates to an address
4862 ///  to a location on the stack, a local block, an address of a label, or a
4863 ///  reference to local temporary. The recursion is used to traverse the
4864 ///  AST of the return expression, with recursion backtracking when we
4865 ///  encounter a subexpression that (1) clearly does not lead to one of the
4866 ///  above problematic expressions (2) is something we cannot determine leads to
4867 ///  a problematic expression based on such local checking.
4868 ///
4869 ///  Both EvalAddr and EvalVal follow through reference variables to evaluate
4870 ///  the expression that they point to. Such variables are added to the
4871 ///  'refVars' vector so that we know what the reference variable "trail" was.
4872 ///
4873 ///  EvalAddr processes expressions that are pointers that are used as
4874 ///  references (and not L-values).  EvalVal handles all other values.
4875 ///  At the base case of the recursion is a check for the above problematic
4876 ///  expressions.
4877 ///
4878 ///  This implementation handles:
4879 ///
4880 ///   * pointer-to-pointer casts
4881 ///   * implicit conversions from array references to pointers
4882 ///   * taking the address of fields
4883 ///   * arbitrary interplay between "&" and "*" operators
4884 ///   * pointer arithmetic from an address of a stack variable
4885 ///   * taking the address of an array element where the array is on the stack
4886 static Expr *EvalAddr(Expr *E, SmallVectorImpl<DeclRefExpr *> &refVars,
4887                       Decl *ParentDecl) {
4888   if (E->isTypeDependent())
4889     return nullptr;
4890 
4891   // We should only be called for evaluating pointer expressions.
4892   assert((E->getType()->isAnyPointerType() ||
4893           E->getType()->isBlockPointerType() ||
4894           E->getType()->isObjCQualifiedIdType()) &&
4895          "EvalAddr only works on pointers");
4896 
4897   E = E->IgnoreParens();
4898 
4899   // Our "symbolic interpreter" is just a dispatch off the currently
4900   // viewed AST node.  We then recursively traverse the AST by calling
4901   // EvalAddr and EvalVal appropriately.
4902   switch (E->getStmtClass()) {
4903   case Stmt::DeclRefExprClass: {
4904     DeclRefExpr *DR = cast<DeclRefExpr>(E);
4905 
4906     // If we leave the immediate function, the lifetime isn't about to end.
4907     if (DR->refersToEnclosingLocal())
4908       return nullptr;
4909 
4910     if (VarDecl *V = dyn_cast<VarDecl>(DR->getDecl()))
4911       // If this is a reference variable, follow through to the expression that
4912       // it points to.
4913       if (V->hasLocalStorage() &&
4914           V->getType()->isReferenceType() && V->hasInit()) {
4915         // Add the reference variable to the "trail".
4916         refVars.push_back(DR);
4917         return EvalAddr(V->getInit(), refVars, ParentDecl);
4918       }
4919 
4920     return nullptr;
4921   }
4922 
4923   case Stmt::UnaryOperatorClass: {
4924     // The only unary operator that make sense to handle here
4925     // is AddrOf.  All others don't make sense as pointers.
4926     UnaryOperator *U = cast<UnaryOperator>(E);
4927 
4928     if (U->getOpcode() == UO_AddrOf)
4929       return EvalVal(U->getSubExpr(), refVars, ParentDecl);
4930     else
4931       return nullptr;
4932   }
4933 
4934   case Stmt::BinaryOperatorClass: {
4935     // Handle pointer arithmetic.  All other binary operators are not valid
4936     // in this context.
4937     BinaryOperator *B = cast<BinaryOperator>(E);
4938     BinaryOperatorKind op = B->getOpcode();
4939 
4940     if (op != BO_Add && op != BO_Sub)
4941       return nullptr;
4942 
4943     Expr *Base = B->getLHS();
4944 
4945     // Determine which argument is the real pointer base.  It could be
4946     // the RHS argument instead of the LHS.
4947     if (!Base->getType()->isPointerType()) Base = B->getRHS();
4948 
4949     assert (Base->getType()->isPointerType());
4950     return EvalAddr(Base, refVars, ParentDecl);
4951   }
4952 
4953   // For conditional operators we need to see if either the LHS or RHS are
4954   // valid DeclRefExpr*s.  If one of them is valid, we return it.
4955   case Stmt::ConditionalOperatorClass: {
4956     ConditionalOperator *C = cast<ConditionalOperator>(E);
4957 
4958     // Handle the GNU extension for missing LHS.
4959     // FIXME: That isn't a ConditionalOperator, so doesn't get here.
4960     if (Expr *LHSExpr = C->getLHS()) {
4961       // In C++, we can have a throw-expression, which has 'void' type.
4962       if (!LHSExpr->getType()->isVoidType())
4963         if (Expr *LHS = EvalAddr(LHSExpr, refVars, ParentDecl))
4964           return LHS;
4965     }
4966 
4967     // In C++, we can have a throw-expression, which has 'void' type.
4968     if (C->getRHS()->getType()->isVoidType())
4969       return nullptr;
4970 
4971     return EvalAddr(C->getRHS(), refVars, ParentDecl);
4972   }
4973 
4974   case Stmt::BlockExprClass:
4975     if (cast<BlockExpr>(E)->getBlockDecl()->hasCaptures())
4976       return E; // local block.
4977     return nullptr;
4978 
4979   case Stmt::AddrLabelExprClass:
4980     return E; // address of label.
4981 
4982   case Stmt::ExprWithCleanupsClass:
4983     return EvalAddr(cast<ExprWithCleanups>(E)->getSubExpr(), refVars,
4984                     ParentDecl);
4985 
4986   // For casts, we need to handle conversions from arrays to
4987   // pointer values, and pointer-to-pointer conversions.
4988   case Stmt::ImplicitCastExprClass:
4989   case Stmt::CStyleCastExprClass:
4990   case Stmt::CXXFunctionalCastExprClass:
4991   case Stmt::ObjCBridgedCastExprClass:
4992   case Stmt::CXXStaticCastExprClass:
4993   case Stmt::CXXDynamicCastExprClass:
4994   case Stmt::CXXConstCastExprClass:
4995   case Stmt::CXXReinterpretCastExprClass: {
4996     Expr* SubExpr = cast<CastExpr>(E)->getSubExpr();
4997     switch (cast<CastExpr>(E)->getCastKind()) {
4998     case CK_LValueToRValue:
4999     case CK_NoOp:
5000     case CK_BaseToDerived:
5001     case CK_DerivedToBase:
5002     case CK_UncheckedDerivedToBase:
5003     case CK_Dynamic:
5004     case CK_CPointerToObjCPointerCast:
5005     case CK_BlockPointerToObjCPointerCast:
5006     case CK_AnyPointerToBlockPointerCast:
5007       return EvalAddr(SubExpr, refVars, ParentDecl);
5008 
5009     case CK_ArrayToPointerDecay:
5010       return EvalVal(SubExpr, refVars, ParentDecl);
5011 
5012     case CK_BitCast:
5013       if (SubExpr->getType()->isAnyPointerType() ||
5014           SubExpr->getType()->isBlockPointerType() ||
5015           SubExpr->getType()->isObjCQualifiedIdType())
5016         return EvalAddr(SubExpr, refVars, ParentDecl);
5017       else
5018         return nullptr;
5019 
5020     default:
5021       return nullptr;
5022     }
5023   }
5024 
5025   case Stmt::MaterializeTemporaryExprClass:
5026     if (Expr *Result = EvalAddr(
5027                          cast<MaterializeTemporaryExpr>(E)->GetTemporaryExpr(),
5028                                 refVars, ParentDecl))
5029       return Result;
5030 
5031     return E;
5032 
5033   // Everything else: we simply don't reason about them.
5034   default:
5035     return nullptr;
5036   }
5037 }
5038 
5039 
5040 ///  EvalVal - This function is complements EvalAddr in the mutual recursion.
5041 ///   See the comments for EvalAddr for more details.
5042 static Expr *EvalVal(Expr *E, SmallVectorImpl<DeclRefExpr *> &refVars,
5043                      Decl *ParentDecl) {
5044 do {
5045   // We should only be called for evaluating non-pointer expressions, or
5046   // expressions with a pointer type that are not used as references but instead
5047   // are l-values (e.g., DeclRefExpr with a pointer type).
5048 
5049   // Our "symbolic interpreter" is just a dispatch off the currently
5050   // viewed AST node.  We then recursively traverse the AST by calling
5051   // EvalAddr and EvalVal appropriately.
5052 
5053   E = E->IgnoreParens();
5054   switch (E->getStmtClass()) {
5055   case Stmt::ImplicitCastExprClass: {
5056     ImplicitCastExpr *IE = cast<ImplicitCastExpr>(E);
5057     if (IE->getValueKind() == VK_LValue) {
5058       E = IE->getSubExpr();
5059       continue;
5060     }
5061     return nullptr;
5062   }
5063 
5064   case Stmt::ExprWithCleanupsClass:
5065     return EvalVal(cast<ExprWithCleanups>(E)->getSubExpr(), refVars,ParentDecl);
5066 
5067   case Stmt::DeclRefExprClass: {
5068     // When we hit a DeclRefExpr we are looking at code that refers to a
5069     // variable's name. If it's not a reference variable we check if it has
5070     // local storage within the function, and if so, return the expression.
5071     DeclRefExpr *DR = cast<DeclRefExpr>(E);
5072 
5073     // If we leave the immediate function, the lifetime isn't about to end.
5074     if (DR->refersToEnclosingLocal())
5075       return nullptr;
5076 
5077     if (VarDecl *V = dyn_cast<VarDecl>(DR->getDecl())) {
5078       // Check if it refers to itself, e.g. "int& i = i;".
5079       if (V == ParentDecl)
5080         return DR;
5081 
5082       if (V->hasLocalStorage()) {
5083         if (!V->getType()->isReferenceType())
5084           return DR;
5085 
5086         // Reference variable, follow through to the expression that
5087         // it points to.
5088         if (V->hasInit()) {
5089           // Add the reference variable to the "trail".
5090           refVars.push_back(DR);
5091           return EvalVal(V->getInit(), refVars, V);
5092         }
5093       }
5094     }
5095 
5096     return nullptr;
5097   }
5098 
5099   case Stmt::UnaryOperatorClass: {
5100     // The only unary operator that make sense to handle here
5101     // is Deref.  All others don't resolve to a "name."  This includes
5102     // handling all sorts of rvalues passed to a unary operator.
5103     UnaryOperator *U = cast<UnaryOperator>(E);
5104 
5105     if (U->getOpcode() == UO_Deref)
5106       return EvalAddr(U->getSubExpr(), refVars, ParentDecl);
5107 
5108     return nullptr;
5109   }
5110 
5111   case Stmt::ArraySubscriptExprClass: {
5112     // Array subscripts are potential references to data on the stack.  We
5113     // retrieve the DeclRefExpr* for the array variable if it indeed
5114     // has local storage.
5115     return EvalAddr(cast<ArraySubscriptExpr>(E)->getBase(), refVars,ParentDecl);
5116   }
5117 
5118   case Stmt::ConditionalOperatorClass: {
5119     // For conditional operators we need to see if either the LHS or RHS are
5120     // non-NULL Expr's.  If one is non-NULL, we return it.
5121     ConditionalOperator *C = cast<ConditionalOperator>(E);
5122 
5123     // Handle the GNU extension for missing LHS.
5124     if (Expr *LHSExpr = C->getLHS()) {
5125       // In C++, we can have a throw-expression, which has 'void' type.
5126       if (!LHSExpr->getType()->isVoidType())
5127         if (Expr *LHS = EvalVal(LHSExpr, refVars, ParentDecl))
5128           return LHS;
5129     }
5130 
5131     // In C++, we can have a throw-expression, which has 'void' type.
5132     if (C->getRHS()->getType()->isVoidType())
5133       return nullptr;
5134 
5135     return EvalVal(C->getRHS(), refVars, ParentDecl);
5136   }
5137 
5138   // Accesses to members are potential references to data on the stack.
5139   case Stmt::MemberExprClass: {
5140     MemberExpr *M = cast<MemberExpr>(E);
5141 
5142     // Check for indirect access.  We only want direct field accesses.
5143     if (M->isArrow())
5144       return nullptr;
5145 
5146     // Check whether the member type is itself a reference, in which case
5147     // we're not going to refer to the member, but to what the member refers to.
5148     if (M->getMemberDecl()->getType()->isReferenceType())
5149       return nullptr;
5150 
5151     return EvalVal(M->getBase(), refVars, ParentDecl);
5152   }
5153 
5154   case Stmt::MaterializeTemporaryExprClass:
5155     if (Expr *Result = EvalVal(
5156                           cast<MaterializeTemporaryExpr>(E)->GetTemporaryExpr(),
5157                                refVars, ParentDecl))
5158       return Result;
5159 
5160     return E;
5161 
5162   default:
5163     // Check that we don't return or take the address of a reference to a
5164     // temporary. This is only useful in C++.
5165     if (!E->isTypeDependent() && E->isRValue())
5166       return E;
5167 
5168     // Everything else: we simply don't reason about them.
5169     return nullptr;
5170   }
5171 } while (true);
5172 }
5173 
5174 void
5175 Sema::CheckReturnValExpr(Expr *RetValExp, QualType lhsType,
5176                          SourceLocation ReturnLoc,
5177                          bool isObjCMethod,
5178                          const AttrVec *Attrs,
5179                          const FunctionDecl *FD) {
5180   CheckReturnStackAddr(*this, RetValExp, lhsType, ReturnLoc);
5181 
5182   // Check if the return value is null but should not be.
5183   if (Attrs && hasSpecificAttr<ReturnsNonNullAttr>(*Attrs) &&
5184       CheckNonNullExpr(*this, RetValExp))
5185     Diag(ReturnLoc, diag::warn_null_ret)
5186       << (isObjCMethod ? 1 : 0) << RetValExp->getSourceRange();
5187 
5188   // C++11 [basic.stc.dynamic.allocation]p4:
5189   //   If an allocation function declared with a non-throwing
5190   //   exception-specification fails to allocate storage, it shall return
5191   //   a null pointer. Any other allocation function that fails to allocate
5192   //   storage shall indicate failure only by throwing an exception [...]
5193   if (FD) {
5194     OverloadedOperatorKind Op = FD->getOverloadedOperator();
5195     if (Op == OO_New || Op == OO_Array_New) {
5196       const FunctionProtoType *Proto
5197         = FD->getType()->castAs<FunctionProtoType>();
5198       if (!Proto->isNothrow(Context, /*ResultIfDependent*/true) &&
5199           CheckNonNullExpr(*this, RetValExp))
5200         Diag(ReturnLoc, diag::warn_operator_new_returns_null)
5201           << FD << getLangOpts().CPlusPlus11;
5202     }
5203   }
5204 }
5205 
5206 //===--- CHECK: Floating-Point comparisons (-Wfloat-equal) ---------------===//
5207 
5208 /// Check for comparisons of floating point operands using != and ==.
5209 /// Issue a warning if these are no self-comparisons, as they are not likely
5210 /// to do what the programmer intended.
5211 void Sema::CheckFloatComparison(SourceLocation Loc, Expr* LHS, Expr *RHS) {
5212   Expr* LeftExprSansParen = LHS->IgnoreParenImpCasts();
5213   Expr* RightExprSansParen = RHS->IgnoreParenImpCasts();
5214 
5215   // Special case: check for x == x (which is OK).
5216   // Do not emit warnings for such cases.
5217   if (DeclRefExpr* DRL = dyn_cast<DeclRefExpr>(LeftExprSansParen))
5218     if (DeclRefExpr* DRR = dyn_cast<DeclRefExpr>(RightExprSansParen))
5219       if (DRL->getDecl() == DRR->getDecl())
5220         return;
5221 
5222 
5223   // Special case: check for comparisons against literals that can be exactly
5224   //  represented by APFloat.  In such cases, do not emit a warning.  This
5225   //  is a heuristic: often comparison against such literals are used to
5226   //  detect if a value in a variable has not changed.  This clearly can
5227   //  lead to false negatives.
5228   if (FloatingLiteral* FLL = dyn_cast<FloatingLiteral>(LeftExprSansParen)) {
5229     if (FLL->isExact())
5230       return;
5231   } else
5232     if (FloatingLiteral* FLR = dyn_cast<FloatingLiteral>(RightExprSansParen))
5233       if (FLR->isExact())
5234         return;
5235 
5236   // Check for comparisons with builtin types.
5237   if (CallExpr* CL = dyn_cast<CallExpr>(LeftExprSansParen))
5238     if (CL->getBuiltinCallee())
5239       return;
5240 
5241   if (CallExpr* CR = dyn_cast<CallExpr>(RightExprSansParen))
5242     if (CR->getBuiltinCallee())
5243       return;
5244 
5245   // Emit the diagnostic.
5246   Diag(Loc, diag::warn_floatingpoint_eq)
5247     << LHS->getSourceRange() << RHS->getSourceRange();
5248 }
5249 
5250 //===--- CHECK: Integer mixed-sign comparisons (-Wsign-compare) --------===//
5251 //===--- CHECK: Lossy implicit conversions (-Wconversion) --------------===//
5252 
5253 namespace {
5254 
5255 /// Structure recording the 'active' range of an integer-valued
5256 /// expression.
5257 struct IntRange {
5258   /// The number of bits active in the int.
5259   unsigned Width;
5260 
5261   /// True if the int is known not to have negative values.
5262   bool NonNegative;
5263 
5264   IntRange(unsigned Width, bool NonNegative)
5265     : Width(Width), NonNegative(NonNegative)
5266   {}
5267 
5268   /// Returns the range of the bool type.
5269   static IntRange forBoolType() {
5270     return IntRange(1, true);
5271   }
5272 
5273   /// Returns the range of an opaque value of the given integral type.
5274   static IntRange forValueOfType(ASTContext &C, QualType T) {
5275     return forValueOfCanonicalType(C,
5276                           T->getCanonicalTypeInternal().getTypePtr());
5277   }
5278 
5279   /// Returns the range of an opaque value of a canonical integral type.
5280   static IntRange forValueOfCanonicalType(ASTContext &C, const Type *T) {
5281     assert(T->isCanonicalUnqualified());
5282 
5283     if (const VectorType *VT = dyn_cast<VectorType>(T))
5284       T = VT->getElementType().getTypePtr();
5285     if (const ComplexType *CT = dyn_cast<ComplexType>(T))
5286       T = CT->getElementType().getTypePtr();
5287     if (const AtomicType *AT = dyn_cast<AtomicType>(T))
5288       T = AT->getValueType().getTypePtr();
5289 
5290     // For enum types, use the known bit width of the enumerators.
5291     if (const EnumType *ET = dyn_cast<EnumType>(T)) {
5292       EnumDecl *Enum = ET->getDecl();
5293       if (!Enum->isCompleteDefinition())
5294         return IntRange(C.getIntWidth(QualType(T, 0)), false);
5295 
5296       unsigned NumPositive = Enum->getNumPositiveBits();
5297       unsigned NumNegative = Enum->getNumNegativeBits();
5298 
5299       if (NumNegative == 0)
5300         return IntRange(NumPositive, true/*NonNegative*/);
5301       else
5302         return IntRange(std::max(NumPositive + 1, NumNegative),
5303                         false/*NonNegative*/);
5304     }
5305 
5306     const BuiltinType *BT = cast<BuiltinType>(T);
5307     assert(BT->isInteger());
5308 
5309     return IntRange(C.getIntWidth(QualType(T, 0)), BT->isUnsignedInteger());
5310   }
5311 
5312   /// Returns the "target" range of a canonical integral type, i.e.
5313   /// the range of values expressible in the type.
5314   ///
5315   /// This matches forValueOfCanonicalType except that enums have the
5316   /// full range of their type, not the range of their enumerators.
5317   static IntRange forTargetOfCanonicalType(ASTContext &C, const Type *T) {
5318     assert(T->isCanonicalUnqualified());
5319 
5320     if (const VectorType *VT = dyn_cast<VectorType>(T))
5321       T = VT->getElementType().getTypePtr();
5322     if (const ComplexType *CT = dyn_cast<ComplexType>(T))
5323       T = CT->getElementType().getTypePtr();
5324     if (const AtomicType *AT = dyn_cast<AtomicType>(T))
5325       T = AT->getValueType().getTypePtr();
5326     if (const EnumType *ET = dyn_cast<EnumType>(T))
5327       T = C.getCanonicalType(ET->getDecl()->getIntegerType()).getTypePtr();
5328 
5329     const BuiltinType *BT = cast<BuiltinType>(T);
5330     assert(BT->isInteger());
5331 
5332     return IntRange(C.getIntWidth(QualType(T, 0)), BT->isUnsignedInteger());
5333   }
5334 
5335   /// Returns the supremum of two ranges: i.e. their conservative merge.
5336   static IntRange join(IntRange L, IntRange R) {
5337     return IntRange(std::max(L.Width, R.Width),
5338                     L.NonNegative && R.NonNegative);
5339   }
5340 
5341   /// Returns the infinum of two ranges: i.e. their aggressive merge.
5342   static IntRange meet(IntRange L, IntRange R) {
5343     return IntRange(std::min(L.Width, R.Width),
5344                     L.NonNegative || R.NonNegative);
5345   }
5346 };
5347 
5348 static IntRange GetValueRange(ASTContext &C, llvm::APSInt &value,
5349                               unsigned MaxWidth) {
5350   if (value.isSigned() && value.isNegative())
5351     return IntRange(value.getMinSignedBits(), false);
5352 
5353   if (value.getBitWidth() > MaxWidth)
5354     value = value.trunc(MaxWidth);
5355 
5356   // isNonNegative() just checks the sign bit without considering
5357   // signedness.
5358   return IntRange(value.getActiveBits(), true);
5359 }
5360 
5361 static IntRange GetValueRange(ASTContext &C, APValue &result, QualType Ty,
5362                               unsigned MaxWidth) {
5363   if (result.isInt())
5364     return GetValueRange(C, result.getInt(), MaxWidth);
5365 
5366   if (result.isVector()) {
5367     IntRange R = GetValueRange(C, result.getVectorElt(0), Ty, MaxWidth);
5368     for (unsigned i = 1, e = result.getVectorLength(); i != e; ++i) {
5369       IntRange El = GetValueRange(C, result.getVectorElt(i), Ty, MaxWidth);
5370       R = IntRange::join(R, El);
5371     }
5372     return R;
5373   }
5374 
5375   if (result.isComplexInt()) {
5376     IntRange R = GetValueRange(C, result.getComplexIntReal(), MaxWidth);
5377     IntRange I = GetValueRange(C, result.getComplexIntImag(), MaxWidth);
5378     return IntRange::join(R, I);
5379   }
5380 
5381   // This can happen with lossless casts to intptr_t of "based" lvalues.
5382   // Assume it might use arbitrary bits.
5383   // FIXME: The only reason we need to pass the type in here is to get
5384   // the sign right on this one case.  It would be nice if APValue
5385   // preserved this.
5386   assert(result.isLValue() || result.isAddrLabelDiff());
5387   return IntRange(MaxWidth, Ty->isUnsignedIntegerOrEnumerationType());
5388 }
5389 
5390 static QualType GetExprType(Expr *E) {
5391   QualType Ty = E->getType();
5392   if (const AtomicType *AtomicRHS = Ty->getAs<AtomicType>())
5393     Ty = AtomicRHS->getValueType();
5394   return Ty;
5395 }
5396 
5397 /// Pseudo-evaluate the given integer expression, estimating the
5398 /// range of values it might take.
5399 ///
5400 /// \param MaxWidth - the width to which the value will be truncated
5401 static IntRange GetExprRange(ASTContext &C, Expr *E, unsigned MaxWidth) {
5402   E = E->IgnoreParens();
5403 
5404   // Try a full evaluation first.
5405   Expr::EvalResult result;
5406   if (E->EvaluateAsRValue(result, C))
5407     return GetValueRange(C, result.Val, GetExprType(E), MaxWidth);
5408 
5409   // I think we only want to look through implicit casts here; if the
5410   // user has an explicit widening cast, we should treat the value as
5411   // being of the new, wider type.
5412   if (ImplicitCastExpr *CE = dyn_cast<ImplicitCastExpr>(E)) {
5413     if (CE->getCastKind() == CK_NoOp || CE->getCastKind() == CK_LValueToRValue)
5414       return GetExprRange(C, CE->getSubExpr(), MaxWidth);
5415 
5416     IntRange OutputTypeRange = IntRange::forValueOfType(C, GetExprType(CE));
5417 
5418     bool isIntegerCast = (CE->getCastKind() == CK_IntegralCast);
5419 
5420     // Assume that non-integer casts can span the full range of the type.
5421     if (!isIntegerCast)
5422       return OutputTypeRange;
5423 
5424     IntRange SubRange
5425       = GetExprRange(C, CE->getSubExpr(),
5426                      std::min(MaxWidth, OutputTypeRange.Width));
5427 
5428     // Bail out if the subexpr's range is as wide as the cast type.
5429     if (SubRange.Width >= OutputTypeRange.Width)
5430       return OutputTypeRange;
5431 
5432     // Otherwise, we take the smaller width, and we're non-negative if
5433     // either the output type or the subexpr is.
5434     return IntRange(SubRange.Width,
5435                     SubRange.NonNegative || OutputTypeRange.NonNegative);
5436   }
5437 
5438   if (ConditionalOperator *CO = dyn_cast<ConditionalOperator>(E)) {
5439     // If we can fold the condition, just take that operand.
5440     bool CondResult;
5441     if (CO->getCond()->EvaluateAsBooleanCondition(CondResult, C))
5442       return GetExprRange(C, CondResult ? CO->getTrueExpr()
5443                                         : CO->getFalseExpr(),
5444                           MaxWidth);
5445 
5446     // Otherwise, conservatively merge.
5447     IntRange L = GetExprRange(C, CO->getTrueExpr(), MaxWidth);
5448     IntRange R = GetExprRange(C, CO->getFalseExpr(), MaxWidth);
5449     return IntRange::join(L, R);
5450   }
5451 
5452   if (BinaryOperator *BO = dyn_cast<BinaryOperator>(E)) {
5453     switch (BO->getOpcode()) {
5454 
5455     // Boolean-valued operations are single-bit and positive.
5456     case BO_LAnd:
5457     case BO_LOr:
5458     case BO_LT:
5459     case BO_GT:
5460     case BO_LE:
5461     case BO_GE:
5462     case BO_EQ:
5463     case BO_NE:
5464       return IntRange::forBoolType();
5465 
5466     // The type of the assignments is the type of the LHS, so the RHS
5467     // is not necessarily the same type.
5468     case BO_MulAssign:
5469     case BO_DivAssign:
5470     case BO_RemAssign:
5471     case BO_AddAssign:
5472     case BO_SubAssign:
5473     case BO_XorAssign:
5474     case BO_OrAssign:
5475       // TODO: bitfields?
5476       return IntRange::forValueOfType(C, GetExprType(E));
5477 
5478     // Simple assignments just pass through the RHS, which will have
5479     // been coerced to the LHS type.
5480     case BO_Assign:
5481       // TODO: bitfields?
5482       return GetExprRange(C, BO->getRHS(), MaxWidth);
5483 
5484     // Operations with opaque sources are black-listed.
5485     case BO_PtrMemD:
5486     case BO_PtrMemI:
5487       return IntRange::forValueOfType(C, GetExprType(E));
5488 
5489     // Bitwise-and uses the *infinum* of the two source ranges.
5490     case BO_And:
5491     case BO_AndAssign:
5492       return IntRange::meet(GetExprRange(C, BO->getLHS(), MaxWidth),
5493                             GetExprRange(C, BO->getRHS(), MaxWidth));
5494 
5495     // Left shift gets black-listed based on a judgement call.
5496     case BO_Shl:
5497       // ...except that we want to treat '1 << (blah)' as logically
5498       // positive.  It's an important idiom.
5499       if (IntegerLiteral *I
5500             = dyn_cast<IntegerLiteral>(BO->getLHS()->IgnoreParenCasts())) {
5501         if (I->getValue() == 1) {
5502           IntRange R = IntRange::forValueOfType(C, GetExprType(E));
5503           return IntRange(R.Width, /*NonNegative*/ true);
5504         }
5505       }
5506       // fallthrough
5507 
5508     case BO_ShlAssign:
5509       return IntRange::forValueOfType(C, GetExprType(E));
5510 
5511     // Right shift by a constant can narrow its left argument.
5512     case BO_Shr:
5513     case BO_ShrAssign: {
5514       IntRange L = GetExprRange(C, BO->getLHS(), MaxWidth);
5515 
5516       // If the shift amount is a positive constant, drop the width by
5517       // that much.
5518       llvm::APSInt shift;
5519       if (BO->getRHS()->isIntegerConstantExpr(shift, C) &&
5520           shift.isNonNegative()) {
5521         unsigned zext = shift.getZExtValue();
5522         if (zext >= L.Width)
5523           L.Width = (L.NonNegative ? 0 : 1);
5524         else
5525           L.Width -= zext;
5526       }
5527 
5528       return L;
5529     }
5530 
5531     // Comma acts as its right operand.
5532     case BO_Comma:
5533       return GetExprRange(C, BO->getRHS(), MaxWidth);
5534 
5535     // Black-list pointer subtractions.
5536     case BO_Sub:
5537       if (BO->getLHS()->getType()->isPointerType())
5538         return IntRange::forValueOfType(C, GetExprType(E));
5539       break;
5540 
5541     // The width of a division result is mostly determined by the size
5542     // of the LHS.
5543     case BO_Div: {
5544       // Don't 'pre-truncate' the operands.
5545       unsigned opWidth = C.getIntWidth(GetExprType(E));
5546       IntRange L = GetExprRange(C, BO->getLHS(), opWidth);
5547 
5548       // If the divisor is constant, use that.
5549       llvm::APSInt divisor;
5550       if (BO->getRHS()->isIntegerConstantExpr(divisor, C)) {
5551         unsigned log2 = divisor.logBase2(); // floor(log_2(divisor))
5552         if (log2 >= L.Width)
5553           L.Width = (L.NonNegative ? 0 : 1);
5554         else
5555           L.Width = std::min(L.Width - log2, MaxWidth);
5556         return L;
5557       }
5558 
5559       // Otherwise, just use the LHS's width.
5560       IntRange R = GetExprRange(C, BO->getRHS(), opWidth);
5561       return IntRange(L.Width, L.NonNegative && R.NonNegative);
5562     }
5563 
5564     // The result of a remainder can't be larger than the result of
5565     // either side.
5566     case BO_Rem: {
5567       // Don't 'pre-truncate' the operands.
5568       unsigned opWidth = C.getIntWidth(GetExprType(E));
5569       IntRange L = GetExprRange(C, BO->getLHS(), opWidth);
5570       IntRange R = GetExprRange(C, BO->getRHS(), opWidth);
5571 
5572       IntRange meet = IntRange::meet(L, R);
5573       meet.Width = std::min(meet.Width, MaxWidth);
5574       return meet;
5575     }
5576 
5577     // The default behavior is okay for these.
5578     case BO_Mul:
5579     case BO_Add:
5580     case BO_Xor:
5581     case BO_Or:
5582       break;
5583     }
5584 
5585     // The default case is to treat the operation as if it were closed
5586     // on the narrowest type that encompasses both operands.
5587     IntRange L = GetExprRange(C, BO->getLHS(), MaxWidth);
5588     IntRange R = GetExprRange(C, BO->getRHS(), MaxWidth);
5589     return IntRange::join(L, R);
5590   }
5591 
5592   if (UnaryOperator *UO = dyn_cast<UnaryOperator>(E)) {
5593     switch (UO->getOpcode()) {
5594     // Boolean-valued operations are white-listed.
5595     case UO_LNot:
5596       return IntRange::forBoolType();
5597 
5598     // Operations with opaque sources are black-listed.
5599     case UO_Deref:
5600     case UO_AddrOf: // should be impossible
5601       return IntRange::forValueOfType(C, GetExprType(E));
5602 
5603     default:
5604       return GetExprRange(C, UO->getSubExpr(), MaxWidth);
5605     }
5606   }
5607 
5608   if (OpaqueValueExpr *OVE = dyn_cast<OpaqueValueExpr>(E))
5609     return GetExprRange(C, OVE->getSourceExpr(), MaxWidth);
5610 
5611   if (FieldDecl *BitField = E->getSourceBitField())
5612     return IntRange(BitField->getBitWidthValue(C),
5613                     BitField->getType()->isUnsignedIntegerOrEnumerationType());
5614 
5615   return IntRange::forValueOfType(C, GetExprType(E));
5616 }
5617 
5618 static IntRange GetExprRange(ASTContext &C, Expr *E) {
5619   return GetExprRange(C, E, C.getIntWidth(GetExprType(E)));
5620 }
5621 
5622 /// Checks whether the given value, which currently has the given
5623 /// source semantics, has the same value when coerced through the
5624 /// target semantics.
5625 static bool IsSameFloatAfterCast(const llvm::APFloat &value,
5626                                  const llvm::fltSemantics &Src,
5627                                  const llvm::fltSemantics &Tgt) {
5628   llvm::APFloat truncated = value;
5629 
5630   bool ignored;
5631   truncated.convert(Src, llvm::APFloat::rmNearestTiesToEven, &ignored);
5632   truncated.convert(Tgt, llvm::APFloat::rmNearestTiesToEven, &ignored);
5633 
5634   return truncated.bitwiseIsEqual(value);
5635 }
5636 
5637 /// Checks whether the given value, which currently has the given
5638 /// source semantics, has the same value when coerced through the
5639 /// target semantics.
5640 ///
5641 /// The value might be a vector of floats (or a complex number).
5642 static bool IsSameFloatAfterCast(const APValue &value,
5643                                  const llvm::fltSemantics &Src,
5644                                  const llvm::fltSemantics &Tgt) {
5645   if (value.isFloat())
5646     return IsSameFloatAfterCast(value.getFloat(), Src, Tgt);
5647 
5648   if (value.isVector()) {
5649     for (unsigned i = 0, e = value.getVectorLength(); i != e; ++i)
5650       if (!IsSameFloatAfterCast(value.getVectorElt(i), Src, Tgt))
5651         return false;
5652     return true;
5653   }
5654 
5655   assert(value.isComplexFloat());
5656   return (IsSameFloatAfterCast(value.getComplexFloatReal(), Src, Tgt) &&
5657           IsSameFloatAfterCast(value.getComplexFloatImag(), Src, Tgt));
5658 }
5659 
5660 static void AnalyzeImplicitConversions(Sema &S, Expr *E, SourceLocation CC);
5661 
5662 static bool IsZero(Sema &S, Expr *E) {
5663   // Suppress cases where we are comparing against an enum constant.
5664   if (const DeclRefExpr *DR =
5665       dyn_cast<DeclRefExpr>(E->IgnoreParenImpCasts()))
5666     if (isa<EnumConstantDecl>(DR->getDecl()))
5667       return false;
5668 
5669   // Suppress cases where the '0' value is expanded from a macro.
5670   if (E->getLocStart().isMacroID())
5671     return false;
5672 
5673   llvm::APSInt Value;
5674   return E->isIntegerConstantExpr(Value, S.Context) && Value == 0;
5675 }
5676 
5677 static bool HasEnumType(Expr *E) {
5678   // Strip off implicit integral promotions.
5679   while (ImplicitCastExpr *ICE = dyn_cast<ImplicitCastExpr>(E)) {
5680     if (ICE->getCastKind() != CK_IntegralCast &&
5681         ICE->getCastKind() != CK_NoOp)
5682       break;
5683     E = ICE->getSubExpr();
5684   }
5685 
5686   return E->getType()->isEnumeralType();
5687 }
5688 
5689 static void CheckTrivialUnsignedComparison(Sema &S, BinaryOperator *E) {
5690   // Disable warning in template instantiations.
5691   if (!S.ActiveTemplateInstantiations.empty())
5692     return;
5693 
5694   BinaryOperatorKind op = E->getOpcode();
5695   if (E->isValueDependent())
5696     return;
5697 
5698   if (op == BO_LT && IsZero(S, E->getRHS())) {
5699     S.Diag(E->getOperatorLoc(), diag::warn_lunsigned_always_true_comparison)
5700       << "< 0" << "false" << HasEnumType(E->getLHS())
5701       << E->getLHS()->getSourceRange() << E->getRHS()->getSourceRange();
5702   } else if (op == BO_GE && IsZero(S, E->getRHS())) {
5703     S.Diag(E->getOperatorLoc(), diag::warn_lunsigned_always_true_comparison)
5704       << ">= 0" << "true" << HasEnumType(E->getLHS())
5705       << E->getLHS()->getSourceRange() << E->getRHS()->getSourceRange();
5706   } else if (op == BO_GT && IsZero(S, E->getLHS())) {
5707     S.Diag(E->getOperatorLoc(), diag::warn_runsigned_always_true_comparison)
5708       << "0 >" << "false" << HasEnumType(E->getRHS())
5709       << E->getLHS()->getSourceRange() << E->getRHS()->getSourceRange();
5710   } else if (op == BO_LE && IsZero(S, E->getLHS())) {
5711     S.Diag(E->getOperatorLoc(), diag::warn_runsigned_always_true_comparison)
5712       << "0 <=" << "true" << HasEnumType(E->getRHS())
5713       << E->getLHS()->getSourceRange() << E->getRHS()->getSourceRange();
5714   }
5715 }
5716 
5717 static void DiagnoseOutOfRangeComparison(Sema &S, BinaryOperator *E,
5718                                          Expr *Constant, Expr *Other,
5719                                          llvm::APSInt Value,
5720                                          bool RhsConstant) {
5721   // Disable warning in template instantiations.
5722   if (!S.ActiveTemplateInstantiations.empty())
5723     return;
5724 
5725   // TODO: Investigate using GetExprRange() to get tighter bounds
5726   // on the bit ranges.
5727   QualType OtherT = Other->getType();
5728   if (const AtomicType *AT = dyn_cast<AtomicType>(OtherT))
5729     OtherT = AT->getValueType();
5730   IntRange OtherRange = IntRange::forValueOfType(S.Context, OtherT);
5731   unsigned OtherWidth = OtherRange.Width;
5732 
5733   bool OtherIsBooleanType = Other->isKnownToHaveBooleanValue();
5734 
5735   // 0 values are handled later by CheckTrivialUnsignedComparison().
5736   if ((Value == 0) && (!OtherIsBooleanType))
5737     return;
5738 
5739   BinaryOperatorKind op = E->getOpcode();
5740   bool IsTrue = true;
5741 
5742   // Used for diagnostic printout.
5743   enum {
5744     LiteralConstant = 0,
5745     CXXBoolLiteralTrue,
5746     CXXBoolLiteralFalse
5747   } LiteralOrBoolConstant = LiteralConstant;
5748 
5749   if (!OtherIsBooleanType) {
5750     QualType ConstantT = Constant->getType();
5751     QualType CommonT = E->getLHS()->getType();
5752 
5753     if (S.Context.hasSameUnqualifiedType(OtherT, ConstantT))
5754       return;
5755     assert((OtherT->isIntegerType() && ConstantT->isIntegerType()) &&
5756            "comparison with non-integer type");
5757 
5758     bool ConstantSigned = ConstantT->isSignedIntegerType();
5759     bool CommonSigned = CommonT->isSignedIntegerType();
5760 
5761     bool EqualityOnly = false;
5762 
5763     if (CommonSigned) {
5764       // The common type is signed, therefore no signed to unsigned conversion.
5765       if (!OtherRange.NonNegative) {
5766         // Check that the constant is representable in type OtherT.
5767         if (ConstantSigned) {
5768           if (OtherWidth >= Value.getMinSignedBits())
5769             return;
5770         } else { // !ConstantSigned
5771           if (OtherWidth >= Value.getActiveBits() + 1)
5772             return;
5773         }
5774       } else { // !OtherSigned
5775                // Check that the constant is representable in type OtherT.
5776         // Negative values are out of range.
5777         if (ConstantSigned) {
5778           if (Value.isNonNegative() && OtherWidth >= Value.getActiveBits())
5779             return;
5780         } else { // !ConstantSigned
5781           if (OtherWidth >= Value.getActiveBits())
5782             return;
5783         }
5784       }
5785     } else { // !CommonSigned
5786       if (OtherRange.NonNegative) {
5787         if (OtherWidth >= Value.getActiveBits())
5788           return;
5789       } else { // OtherSigned
5790         assert(!ConstantSigned &&
5791                "Two signed types converted to unsigned types.");
5792         // Check to see if the constant is representable in OtherT.
5793         if (OtherWidth > Value.getActiveBits())
5794           return;
5795         // Check to see if the constant is equivalent to a negative value
5796         // cast to CommonT.
5797         if (S.Context.getIntWidth(ConstantT) ==
5798                 S.Context.getIntWidth(CommonT) &&
5799             Value.isNegative() && Value.getMinSignedBits() <= OtherWidth)
5800           return;
5801         // The constant value rests between values that OtherT can represent
5802         // after conversion.  Relational comparison still works, but equality
5803         // comparisons will be tautological.
5804         EqualityOnly = true;
5805       }
5806     }
5807 
5808     bool PositiveConstant = !ConstantSigned || Value.isNonNegative();
5809 
5810     if (op == BO_EQ || op == BO_NE) {
5811       IsTrue = op == BO_NE;
5812     } else if (EqualityOnly) {
5813       return;
5814     } else if (RhsConstant) {
5815       if (op == BO_GT || op == BO_GE)
5816         IsTrue = !PositiveConstant;
5817       else // op == BO_LT || op == BO_LE
5818         IsTrue = PositiveConstant;
5819     } else {
5820       if (op == BO_LT || op == BO_LE)
5821         IsTrue = !PositiveConstant;
5822       else // op == BO_GT || op == BO_GE
5823         IsTrue = PositiveConstant;
5824     }
5825   } else {
5826     // Other isKnownToHaveBooleanValue
5827     enum CompareBoolWithConstantResult { AFals, ATrue, Unkwn };
5828     enum ConstantValue { LT_Zero, Zero, One, GT_One, SizeOfConstVal };
5829     enum ConstantSide { Lhs, Rhs, SizeOfConstSides };
5830 
5831     static const struct LinkedConditions {
5832       CompareBoolWithConstantResult BO_LT_OP[SizeOfConstSides][SizeOfConstVal];
5833       CompareBoolWithConstantResult BO_GT_OP[SizeOfConstSides][SizeOfConstVal];
5834       CompareBoolWithConstantResult BO_LE_OP[SizeOfConstSides][SizeOfConstVal];
5835       CompareBoolWithConstantResult BO_GE_OP[SizeOfConstSides][SizeOfConstVal];
5836       CompareBoolWithConstantResult BO_EQ_OP[SizeOfConstSides][SizeOfConstVal];
5837       CompareBoolWithConstantResult BO_NE_OP[SizeOfConstSides][SizeOfConstVal];
5838 
5839     } TruthTable = {
5840         // Constant on LHS.              | Constant on RHS.              |
5841         // LT_Zero| Zero  | One   |GT_One| LT_Zero| Zero  | One   |GT_One|
5842         { { ATrue, Unkwn, AFals, AFals }, { AFals, AFals, Unkwn, ATrue } },
5843         { { AFals, AFals, Unkwn, ATrue }, { ATrue, Unkwn, AFals, AFals } },
5844         { { ATrue, ATrue, Unkwn, AFals }, { AFals, Unkwn, ATrue, ATrue } },
5845         { { AFals, Unkwn, ATrue, ATrue }, { ATrue, ATrue, Unkwn, AFals } },
5846         { { AFals, Unkwn, Unkwn, AFals }, { AFals, Unkwn, Unkwn, AFals } },
5847         { { ATrue, Unkwn, Unkwn, ATrue }, { ATrue, Unkwn, Unkwn, ATrue } }
5848       };
5849 
5850     bool ConstantIsBoolLiteral = isa<CXXBoolLiteralExpr>(Constant);
5851 
5852     enum ConstantValue ConstVal = Zero;
5853     if (Value.isUnsigned() || Value.isNonNegative()) {
5854       if (Value == 0) {
5855         LiteralOrBoolConstant =
5856             ConstantIsBoolLiteral ? CXXBoolLiteralFalse : LiteralConstant;
5857         ConstVal = Zero;
5858       } else if (Value == 1) {
5859         LiteralOrBoolConstant =
5860             ConstantIsBoolLiteral ? CXXBoolLiteralTrue : LiteralConstant;
5861         ConstVal = One;
5862       } else {
5863         LiteralOrBoolConstant = LiteralConstant;
5864         ConstVal = GT_One;
5865       }
5866     } else {
5867       ConstVal = LT_Zero;
5868     }
5869 
5870     CompareBoolWithConstantResult CmpRes;
5871 
5872     switch (op) {
5873     case BO_LT:
5874       CmpRes = TruthTable.BO_LT_OP[RhsConstant][ConstVal];
5875       break;
5876     case BO_GT:
5877       CmpRes = TruthTable.BO_GT_OP[RhsConstant][ConstVal];
5878       break;
5879     case BO_LE:
5880       CmpRes = TruthTable.BO_LE_OP[RhsConstant][ConstVal];
5881       break;
5882     case BO_GE:
5883       CmpRes = TruthTable.BO_GE_OP[RhsConstant][ConstVal];
5884       break;
5885     case BO_EQ:
5886       CmpRes = TruthTable.BO_EQ_OP[RhsConstant][ConstVal];
5887       break;
5888     case BO_NE:
5889       CmpRes = TruthTable.BO_NE_OP[RhsConstant][ConstVal];
5890       break;
5891     default:
5892       CmpRes = Unkwn;
5893       break;
5894     }
5895 
5896     if (CmpRes == AFals) {
5897       IsTrue = false;
5898     } else if (CmpRes == ATrue) {
5899       IsTrue = true;
5900     } else {
5901       return;
5902     }
5903   }
5904 
5905   // If this is a comparison to an enum constant, include that
5906   // constant in the diagnostic.
5907   const EnumConstantDecl *ED = nullptr;
5908   if (const DeclRefExpr *DR = dyn_cast<DeclRefExpr>(Constant))
5909     ED = dyn_cast<EnumConstantDecl>(DR->getDecl());
5910 
5911   SmallString<64> PrettySourceValue;
5912   llvm::raw_svector_ostream OS(PrettySourceValue);
5913   if (ED)
5914     OS << '\'' << *ED << "' (" << Value << ")";
5915   else
5916     OS << Value;
5917 
5918   S.DiagRuntimeBehavior(
5919     E->getOperatorLoc(), E,
5920     S.PDiag(diag::warn_out_of_range_compare)
5921         << OS.str() << LiteralOrBoolConstant
5922         << OtherT << (OtherIsBooleanType && !OtherT->isBooleanType()) << IsTrue
5923         << E->getLHS()->getSourceRange() << E->getRHS()->getSourceRange());
5924 }
5925 
5926 /// Analyze the operands of the given comparison.  Implements the
5927 /// fallback case from AnalyzeComparison.
5928 static void AnalyzeImpConvsInComparison(Sema &S, BinaryOperator *E) {
5929   AnalyzeImplicitConversions(S, E->getLHS(), E->getOperatorLoc());
5930   AnalyzeImplicitConversions(S, E->getRHS(), E->getOperatorLoc());
5931 }
5932 
5933 /// \brief Implements -Wsign-compare.
5934 ///
5935 /// \param E the binary operator to check for warnings
5936 static void AnalyzeComparison(Sema &S, BinaryOperator *E) {
5937   // The type the comparison is being performed in.
5938   QualType T = E->getLHS()->getType();
5939 
5940   // Only analyze comparison operators where both sides have been converted to
5941   // the same type.
5942   if (!S.Context.hasSameUnqualifiedType(T, E->getRHS()->getType()))
5943     return AnalyzeImpConvsInComparison(S, E);
5944 
5945   // Don't analyze value-dependent comparisons directly.
5946   if (E->isValueDependent())
5947     return AnalyzeImpConvsInComparison(S, E);
5948 
5949   Expr *LHS = E->getLHS()->IgnoreParenImpCasts();
5950   Expr *RHS = E->getRHS()->IgnoreParenImpCasts();
5951 
5952   bool IsComparisonConstant = false;
5953 
5954   // Check whether an integer constant comparison results in a value
5955   // of 'true' or 'false'.
5956   if (T->isIntegralType(S.Context)) {
5957     llvm::APSInt RHSValue;
5958     bool IsRHSIntegralLiteral =
5959       RHS->isIntegerConstantExpr(RHSValue, S.Context);
5960     llvm::APSInt LHSValue;
5961     bool IsLHSIntegralLiteral =
5962       LHS->isIntegerConstantExpr(LHSValue, S.Context);
5963     if (IsRHSIntegralLiteral && !IsLHSIntegralLiteral)
5964         DiagnoseOutOfRangeComparison(S, E, RHS, LHS, RHSValue, true);
5965     else if (!IsRHSIntegralLiteral && IsLHSIntegralLiteral)
5966       DiagnoseOutOfRangeComparison(S, E, LHS, RHS, LHSValue, false);
5967     else
5968       IsComparisonConstant =
5969         (IsRHSIntegralLiteral && IsLHSIntegralLiteral);
5970   } else if (!T->hasUnsignedIntegerRepresentation())
5971       IsComparisonConstant = E->isIntegerConstantExpr(S.Context);
5972 
5973   // We don't do anything special if this isn't an unsigned integral
5974   // comparison:  we're only interested in integral comparisons, and
5975   // signed comparisons only happen in cases we don't care to warn about.
5976   //
5977   // We also don't care about value-dependent expressions or expressions
5978   // whose result is a constant.
5979   if (!T->hasUnsignedIntegerRepresentation() || IsComparisonConstant)
5980     return AnalyzeImpConvsInComparison(S, E);
5981 
5982   // Check to see if one of the (unmodified) operands is of different
5983   // signedness.
5984   Expr *signedOperand, *unsignedOperand;
5985   if (LHS->getType()->hasSignedIntegerRepresentation()) {
5986     assert(!RHS->getType()->hasSignedIntegerRepresentation() &&
5987            "unsigned comparison between two signed integer expressions?");
5988     signedOperand = LHS;
5989     unsignedOperand = RHS;
5990   } else if (RHS->getType()->hasSignedIntegerRepresentation()) {
5991     signedOperand = RHS;
5992     unsignedOperand = LHS;
5993   } else {
5994     CheckTrivialUnsignedComparison(S, E);
5995     return AnalyzeImpConvsInComparison(S, E);
5996   }
5997 
5998   // Otherwise, calculate the effective range of the signed operand.
5999   IntRange signedRange = GetExprRange(S.Context, signedOperand);
6000 
6001   // Go ahead and analyze implicit conversions in the operands.  Note
6002   // that we skip the implicit conversions on both sides.
6003   AnalyzeImplicitConversions(S, LHS, E->getOperatorLoc());
6004   AnalyzeImplicitConversions(S, RHS, E->getOperatorLoc());
6005 
6006   // If the signed range is non-negative, -Wsign-compare won't fire,
6007   // but we should still check for comparisons which are always true
6008   // or false.
6009   if (signedRange.NonNegative)
6010     return CheckTrivialUnsignedComparison(S, E);
6011 
6012   // For (in)equality comparisons, if the unsigned operand is a
6013   // constant which cannot collide with a overflowed signed operand,
6014   // then reinterpreting the signed operand as unsigned will not
6015   // change the result of the comparison.
6016   if (E->isEqualityOp()) {
6017     unsigned comparisonWidth = S.Context.getIntWidth(T);
6018     IntRange unsignedRange = GetExprRange(S.Context, unsignedOperand);
6019 
6020     // We should never be unable to prove that the unsigned operand is
6021     // non-negative.
6022     assert(unsignedRange.NonNegative && "unsigned range includes negative?");
6023 
6024     if (unsignedRange.Width < comparisonWidth)
6025       return;
6026   }
6027 
6028   S.DiagRuntimeBehavior(E->getOperatorLoc(), E,
6029     S.PDiag(diag::warn_mixed_sign_comparison)
6030       << LHS->getType() << RHS->getType()
6031       << LHS->getSourceRange() << RHS->getSourceRange());
6032 }
6033 
6034 /// Analyzes an attempt to assign the given value to a bitfield.
6035 ///
6036 /// Returns true if there was something fishy about the attempt.
6037 static bool AnalyzeBitFieldAssignment(Sema &S, FieldDecl *Bitfield, Expr *Init,
6038                                       SourceLocation InitLoc) {
6039   assert(Bitfield->isBitField());
6040   if (Bitfield->isInvalidDecl())
6041     return false;
6042 
6043   // White-list bool bitfields.
6044   if (Bitfield->getType()->isBooleanType())
6045     return false;
6046 
6047   // Ignore value- or type-dependent expressions.
6048   if (Bitfield->getBitWidth()->isValueDependent() ||
6049       Bitfield->getBitWidth()->isTypeDependent() ||
6050       Init->isValueDependent() ||
6051       Init->isTypeDependent())
6052     return false;
6053 
6054   Expr *OriginalInit = Init->IgnoreParenImpCasts();
6055 
6056   llvm::APSInt Value;
6057   if (!OriginalInit->EvaluateAsInt(Value, S.Context, Expr::SE_AllowSideEffects))
6058     return false;
6059 
6060   unsigned OriginalWidth = Value.getBitWidth();
6061   unsigned FieldWidth = Bitfield->getBitWidthValue(S.Context);
6062 
6063   if (OriginalWidth <= FieldWidth)
6064     return false;
6065 
6066   // Compute the value which the bitfield will contain.
6067   llvm::APSInt TruncatedValue = Value.trunc(FieldWidth);
6068   TruncatedValue.setIsSigned(Bitfield->getType()->isSignedIntegerType());
6069 
6070   // Check whether the stored value is equal to the original value.
6071   TruncatedValue = TruncatedValue.extend(OriginalWidth);
6072   if (llvm::APSInt::isSameValue(Value, TruncatedValue))
6073     return false;
6074 
6075   // Special-case bitfields of width 1: booleans are naturally 0/1, and
6076   // therefore don't strictly fit into a signed bitfield of width 1.
6077   if (FieldWidth == 1 && Value == 1)
6078     return false;
6079 
6080   std::string PrettyValue = Value.toString(10);
6081   std::string PrettyTrunc = TruncatedValue.toString(10);
6082 
6083   S.Diag(InitLoc, diag::warn_impcast_bitfield_precision_constant)
6084     << PrettyValue << PrettyTrunc << OriginalInit->getType()
6085     << Init->getSourceRange();
6086 
6087   return true;
6088 }
6089 
6090 /// Analyze the given simple or compound assignment for warning-worthy
6091 /// operations.
6092 static void AnalyzeAssignment(Sema &S, BinaryOperator *E) {
6093   // Just recurse on the LHS.
6094   AnalyzeImplicitConversions(S, E->getLHS(), E->getOperatorLoc());
6095 
6096   // We want to recurse on the RHS as normal unless we're assigning to
6097   // a bitfield.
6098   if (FieldDecl *Bitfield = E->getLHS()->getSourceBitField()) {
6099     if (AnalyzeBitFieldAssignment(S, Bitfield, E->getRHS(),
6100                                   E->getOperatorLoc())) {
6101       // Recurse, ignoring any implicit conversions on the RHS.
6102       return AnalyzeImplicitConversions(S, E->getRHS()->IgnoreParenImpCasts(),
6103                                         E->getOperatorLoc());
6104     }
6105   }
6106 
6107   AnalyzeImplicitConversions(S, E->getRHS(), E->getOperatorLoc());
6108 }
6109 
6110 /// Diagnose an implicit cast;  purely a helper for CheckImplicitConversion.
6111 static void DiagnoseImpCast(Sema &S, Expr *E, QualType SourceType, QualType T,
6112                             SourceLocation CContext, unsigned diag,
6113                             bool pruneControlFlow = false) {
6114   if (pruneControlFlow) {
6115     S.DiagRuntimeBehavior(E->getExprLoc(), E,
6116                           S.PDiag(diag)
6117                             << SourceType << T << E->getSourceRange()
6118                             << SourceRange(CContext));
6119     return;
6120   }
6121   S.Diag(E->getExprLoc(), diag)
6122     << SourceType << T << E->getSourceRange() << SourceRange(CContext);
6123 }
6124 
6125 /// Diagnose an implicit cast;  purely a helper for CheckImplicitConversion.
6126 static void DiagnoseImpCast(Sema &S, Expr *E, QualType T,
6127                             SourceLocation CContext, unsigned diag,
6128                             bool pruneControlFlow = false) {
6129   DiagnoseImpCast(S, E, E->getType(), T, CContext, diag, pruneControlFlow);
6130 }
6131 
6132 /// Diagnose an implicit cast from a literal expression. Does not warn when the
6133 /// cast wouldn't lose information.
6134 void DiagnoseFloatingLiteralImpCast(Sema &S, FloatingLiteral *FL, QualType T,
6135                                     SourceLocation CContext) {
6136   // Try to convert the literal exactly to an integer. If we can, don't warn.
6137   bool isExact = false;
6138   const llvm::APFloat &Value = FL->getValue();
6139   llvm::APSInt IntegerValue(S.Context.getIntWidth(T),
6140                             T->hasUnsignedIntegerRepresentation());
6141   if (Value.convertToInteger(IntegerValue,
6142                              llvm::APFloat::rmTowardZero, &isExact)
6143       == llvm::APFloat::opOK && isExact)
6144     return;
6145 
6146   // FIXME: Force the precision of the source value down so we don't print
6147   // digits which are usually useless (we don't really care here if we
6148   // truncate a digit by accident in edge cases).  Ideally, APFloat::toString
6149   // would automatically print the shortest representation, but it's a bit
6150   // tricky to implement.
6151   SmallString<16> PrettySourceValue;
6152   unsigned precision = llvm::APFloat::semanticsPrecision(Value.getSemantics());
6153   precision = (precision * 59 + 195) / 196;
6154   Value.toString(PrettySourceValue, precision);
6155 
6156   SmallString<16> PrettyTargetValue;
6157   if (T->isSpecificBuiltinType(BuiltinType::Bool))
6158     PrettyTargetValue = IntegerValue == 0 ? "false" : "true";
6159   else
6160     IntegerValue.toString(PrettyTargetValue);
6161 
6162   S.Diag(FL->getExprLoc(), diag::warn_impcast_literal_float_to_integer)
6163     << FL->getType() << T.getUnqualifiedType() << PrettySourceValue
6164     << PrettyTargetValue << FL->getSourceRange() << SourceRange(CContext);
6165 }
6166 
6167 std::string PrettyPrintInRange(const llvm::APSInt &Value, IntRange Range) {
6168   if (!Range.Width) return "0";
6169 
6170   llvm::APSInt ValueInRange = Value;
6171   ValueInRange.setIsSigned(!Range.NonNegative);
6172   ValueInRange = ValueInRange.trunc(Range.Width);
6173   return ValueInRange.toString(10);
6174 }
6175 
6176 static bool IsImplicitBoolFloatConversion(Sema &S, Expr *Ex, bool ToBool) {
6177   if (!isa<ImplicitCastExpr>(Ex))
6178     return false;
6179 
6180   Expr *InnerE = Ex->IgnoreParenImpCasts();
6181   const Type *Target = S.Context.getCanonicalType(Ex->getType()).getTypePtr();
6182   const Type *Source =
6183     S.Context.getCanonicalType(InnerE->getType()).getTypePtr();
6184   if (Target->isDependentType())
6185     return false;
6186 
6187   const BuiltinType *FloatCandidateBT =
6188     dyn_cast<BuiltinType>(ToBool ? Source : Target);
6189   const Type *BoolCandidateType = ToBool ? Target : Source;
6190 
6191   return (BoolCandidateType->isSpecificBuiltinType(BuiltinType::Bool) &&
6192           FloatCandidateBT && (FloatCandidateBT->isFloatingPoint()));
6193 }
6194 
6195 void CheckImplicitArgumentConversions(Sema &S, CallExpr *TheCall,
6196                                       SourceLocation CC) {
6197   unsigned NumArgs = TheCall->getNumArgs();
6198   for (unsigned i = 0; i < NumArgs; ++i) {
6199     Expr *CurrA = TheCall->getArg(i);
6200     if (!IsImplicitBoolFloatConversion(S, CurrA, true))
6201       continue;
6202 
6203     bool IsSwapped = ((i > 0) &&
6204         IsImplicitBoolFloatConversion(S, TheCall->getArg(i - 1), false));
6205     IsSwapped |= ((i < (NumArgs - 1)) &&
6206         IsImplicitBoolFloatConversion(S, TheCall->getArg(i + 1), false));
6207     if (IsSwapped) {
6208       // Warn on this floating-point to bool conversion.
6209       DiagnoseImpCast(S, CurrA->IgnoreParenImpCasts(),
6210                       CurrA->getType(), CC,
6211                       diag::warn_impcast_floating_point_to_bool);
6212     }
6213   }
6214 }
6215 
6216 static void DiagnoseNullConversion(Sema &S, Expr *E, QualType T,
6217                                    SourceLocation CC) {
6218   if (S.Diags.isIgnored(diag::warn_impcast_null_pointer_to_integer,
6219                         E->getExprLoc()))
6220     return;
6221 
6222   // Check for NULL (GNUNull) or nullptr (CXX11_nullptr).
6223   const Expr::NullPointerConstantKind NullKind =
6224       E->isNullPointerConstant(S.Context, Expr::NPC_ValueDependentIsNotNull);
6225   if (NullKind != Expr::NPCK_GNUNull && NullKind != Expr::NPCK_CXX11_nullptr)
6226     return;
6227 
6228   // Return if target type is a safe conversion.
6229   if (T->isAnyPointerType() || T->isBlockPointerType() ||
6230       T->isMemberPointerType() || !T->isScalarType() || T->isNullPtrType())
6231     return;
6232 
6233   SourceLocation Loc = E->getSourceRange().getBegin();
6234 
6235   // __null is usually wrapped in a macro.  Go up a macro if that is the case.
6236   if (NullKind == Expr::NPCK_GNUNull) {
6237     if (Loc.isMacroID())
6238       Loc = S.SourceMgr.getImmediateExpansionRange(Loc).first;
6239   }
6240 
6241   // Only warn if the null and context location are in the same macro expansion.
6242   if (S.SourceMgr.getFileID(Loc) != S.SourceMgr.getFileID(CC))
6243     return;
6244 
6245   S.Diag(Loc, diag::warn_impcast_null_pointer_to_integer)
6246       << (NullKind == Expr::NPCK_CXX11_nullptr) << T << clang::SourceRange(CC)
6247       << FixItHint::CreateReplacement(Loc,
6248                                       S.getFixItZeroLiteralForType(T, Loc));
6249 }
6250 
6251 void CheckImplicitConversion(Sema &S, Expr *E, QualType T,
6252                              SourceLocation CC, bool *ICContext = nullptr) {
6253   if (E->isTypeDependent() || E->isValueDependent()) return;
6254 
6255   const Type *Source = S.Context.getCanonicalType(E->getType()).getTypePtr();
6256   const Type *Target = S.Context.getCanonicalType(T).getTypePtr();
6257   if (Source == Target) return;
6258   if (Target->isDependentType()) return;
6259 
6260   // If the conversion context location is invalid don't complain. We also
6261   // don't want to emit a warning if the issue occurs from the expansion of
6262   // a system macro. The problem is that 'getSpellingLoc()' is slow, so we
6263   // delay this check as long as possible. Once we detect we are in that
6264   // scenario, we just return.
6265   if (CC.isInvalid())
6266     return;
6267 
6268   // Diagnose implicit casts to bool.
6269   if (Target->isSpecificBuiltinType(BuiltinType::Bool)) {
6270     if (isa<StringLiteral>(E))
6271       // Warn on string literal to bool.  Checks for string literals in logical
6272       // and expressions, for instance, assert(0 && "error here"), are
6273       // prevented by a check in AnalyzeImplicitConversions().
6274       return DiagnoseImpCast(S, E, T, CC,
6275                              diag::warn_impcast_string_literal_to_bool);
6276     if (isa<ObjCStringLiteral>(E) || isa<ObjCArrayLiteral>(E) ||
6277         isa<ObjCDictionaryLiteral>(E) || isa<ObjCBoxedExpr>(E)) {
6278       // This covers the literal expressions that evaluate to Objective-C
6279       // objects.
6280       return DiagnoseImpCast(S, E, T, CC,
6281                              diag::warn_impcast_objective_c_literal_to_bool);
6282     }
6283     if (Source->isPointerType() || Source->canDecayToPointerType()) {
6284       // Warn on pointer to bool conversion that is always true.
6285       S.DiagnoseAlwaysNonNullPointer(E, Expr::NPCK_NotNull, /*IsEqual*/ false,
6286                                      SourceRange(CC));
6287     }
6288   }
6289 
6290   // Strip vector types.
6291   if (isa<VectorType>(Source)) {
6292     if (!isa<VectorType>(Target)) {
6293       if (S.SourceMgr.isInSystemMacro(CC))
6294         return;
6295       return DiagnoseImpCast(S, E, T, CC, diag::warn_impcast_vector_scalar);
6296     }
6297 
6298     // If the vector cast is cast between two vectors of the same size, it is
6299     // a bitcast, not a conversion.
6300     if (S.Context.getTypeSize(Source) == S.Context.getTypeSize(Target))
6301       return;
6302 
6303     Source = cast<VectorType>(Source)->getElementType().getTypePtr();
6304     Target = cast<VectorType>(Target)->getElementType().getTypePtr();
6305   }
6306   if (auto VecTy = dyn_cast<VectorType>(Target))
6307     Target = VecTy->getElementType().getTypePtr();
6308 
6309   // Strip complex types.
6310   if (isa<ComplexType>(Source)) {
6311     if (!isa<ComplexType>(Target)) {
6312       if (S.SourceMgr.isInSystemMacro(CC))
6313         return;
6314 
6315       return DiagnoseImpCast(S, E, T, CC, diag::warn_impcast_complex_scalar);
6316     }
6317 
6318     Source = cast<ComplexType>(Source)->getElementType().getTypePtr();
6319     Target = cast<ComplexType>(Target)->getElementType().getTypePtr();
6320   }
6321 
6322   const BuiltinType *SourceBT = dyn_cast<BuiltinType>(Source);
6323   const BuiltinType *TargetBT = dyn_cast<BuiltinType>(Target);
6324 
6325   // If the source is floating point...
6326   if (SourceBT && SourceBT->isFloatingPoint()) {
6327     // ...and the target is floating point...
6328     if (TargetBT && TargetBT->isFloatingPoint()) {
6329       // ...then warn if we're dropping FP rank.
6330 
6331       // Builtin FP kinds are ordered by increasing FP rank.
6332       if (SourceBT->getKind() > TargetBT->getKind()) {
6333         // Don't warn about float constants that are precisely
6334         // representable in the target type.
6335         Expr::EvalResult result;
6336         if (E->EvaluateAsRValue(result, S.Context)) {
6337           // Value might be a float, a float vector, or a float complex.
6338           if (IsSameFloatAfterCast(result.Val,
6339                    S.Context.getFloatTypeSemantics(QualType(TargetBT, 0)),
6340                    S.Context.getFloatTypeSemantics(QualType(SourceBT, 0))))
6341             return;
6342         }
6343 
6344         if (S.SourceMgr.isInSystemMacro(CC))
6345           return;
6346 
6347         DiagnoseImpCast(S, E, T, CC, diag::warn_impcast_float_precision);
6348       }
6349       return;
6350     }
6351 
6352     // If the target is integral, always warn.
6353     if (TargetBT && TargetBT->isInteger()) {
6354       if (S.SourceMgr.isInSystemMacro(CC))
6355         return;
6356 
6357       Expr *InnerE = E->IgnoreParenImpCasts();
6358       // We also want to warn on, e.g., "int i = -1.234"
6359       if (UnaryOperator *UOp = dyn_cast<UnaryOperator>(InnerE))
6360         if (UOp->getOpcode() == UO_Minus || UOp->getOpcode() == UO_Plus)
6361           InnerE = UOp->getSubExpr()->IgnoreParenImpCasts();
6362 
6363       if (FloatingLiteral *FL = dyn_cast<FloatingLiteral>(InnerE)) {
6364         DiagnoseFloatingLiteralImpCast(S, FL, T, CC);
6365       } else {
6366         DiagnoseImpCast(S, E, T, CC, diag::warn_impcast_float_integer);
6367       }
6368     }
6369 
6370     // If the target is bool, warn if expr is a function or method call.
6371     if (Target->isSpecificBuiltinType(BuiltinType::Bool) &&
6372         isa<CallExpr>(E)) {
6373       // Check last argument of function call to see if it is an
6374       // implicit cast from a type matching the type the result
6375       // is being cast to.
6376       CallExpr *CEx = cast<CallExpr>(E);
6377       unsigned NumArgs = CEx->getNumArgs();
6378       if (NumArgs > 0) {
6379         Expr *LastA = CEx->getArg(NumArgs - 1);
6380         Expr *InnerE = LastA->IgnoreParenImpCasts();
6381         const Type *InnerType =
6382           S.Context.getCanonicalType(InnerE->getType()).getTypePtr();
6383         if (isa<ImplicitCastExpr>(LastA) && (InnerType == Target)) {
6384           // Warn on this floating-point to bool conversion
6385           DiagnoseImpCast(S, E, T, CC,
6386                           diag::warn_impcast_floating_point_to_bool);
6387         }
6388       }
6389     }
6390     return;
6391   }
6392 
6393   DiagnoseNullConversion(S, E, T, CC);
6394 
6395   if (!Source->isIntegerType() || !Target->isIntegerType())
6396     return;
6397 
6398   // TODO: remove this early return once the false positives for constant->bool
6399   // in templates, macros, etc, are reduced or removed.
6400   if (Target->isSpecificBuiltinType(BuiltinType::Bool))
6401     return;
6402 
6403   IntRange SourceRange = GetExprRange(S.Context, E);
6404   IntRange TargetRange = IntRange::forTargetOfCanonicalType(S.Context, Target);
6405 
6406   if (SourceRange.Width > TargetRange.Width) {
6407     // If the source is a constant, use a default-on diagnostic.
6408     // TODO: this should happen for bitfield stores, too.
6409     llvm::APSInt Value(32);
6410     if (E->isIntegerConstantExpr(Value, S.Context)) {
6411       if (S.SourceMgr.isInSystemMacro(CC))
6412         return;
6413 
6414       std::string PrettySourceValue = Value.toString(10);
6415       std::string PrettyTargetValue = PrettyPrintInRange(Value, TargetRange);
6416 
6417       S.DiagRuntimeBehavior(E->getExprLoc(), E,
6418         S.PDiag(diag::warn_impcast_integer_precision_constant)
6419             << PrettySourceValue << PrettyTargetValue
6420             << E->getType() << T << E->getSourceRange()
6421             << clang::SourceRange(CC));
6422       return;
6423     }
6424 
6425     // People want to build with -Wshorten-64-to-32 and not -Wconversion.
6426     if (S.SourceMgr.isInSystemMacro(CC))
6427       return;
6428 
6429     if (TargetRange.Width == 32 && S.Context.getIntWidth(E->getType()) == 64)
6430       return DiagnoseImpCast(S, E, T, CC, diag::warn_impcast_integer_64_32,
6431                              /* pruneControlFlow */ true);
6432     return DiagnoseImpCast(S, E, T, CC, diag::warn_impcast_integer_precision);
6433   }
6434 
6435   if ((TargetRange.NonNegative && !SourceRange.NonNegative) ||
6436       (!TargetRange.NonNegative && SourceRange.NonNegative &&
6437        SourceRange.Width == TargetRange.Width)) {
6438 
6439     if (S.SourceMgr.isInSystemMacro(CC))
6440       return;
6441 
6442     unsigned DiagID = diag::warn_impcast_integer_sign;
6443 
6444     // Traditionally, gcc has warned about this under -Wsign-compare.
6445     // We also want to warn about it in -Wconversion.
6446     // So if -Wconversion is off, use a completely identical diagnostic
6447     // in the sign-compare group.
6448     // The conditional-checking code will
6449     if (ICContext) {
6450       DiagID = diag::warn_impcast_integer_sign_conditional;
6451       *ICContext = true;
6452     }
6453 
6454     return DiagnoseImpCast(S, E, T, CC, DiagID);
6455   }
6456 
6457   // Diagnose conversions between different enumeration types.
6458   // In C, we pretend that the type of an EnumConstantDecl is its enumeration
6459   // type, to give us better diagnostics.
6460   QualType SourceType = E->getType();
6461   if (!S.getLangOpts().CPlusPlus) {
6462     if (DeclRefExpr *DRE = dyn_cast<DeclRefExpr>(E))
6463       if (EnumConstantDecl *ECD = dyn_cast<EnumConstantDecl>(DRE->getDecl())) {
6464         EnumDecl *Enum = cast<EnumDecl>(ECD->getDeclContext());
6465         SourceType = S.Context.getTypeDeclType(Enum);
6466         Source = S.Context.getCanonicalType(SourceType).getTypePtr();
6467       }
6468   }
6469 
6470   if (const EnumType *SourceEnum = Source->getAs<EnumType>())
6471     if (const EnumType *TargetEnum = Target->getAs<EnumType>())
6472       if (SourceEnum->getDecl()->hasNameForLinkage() &&
6473           TargetEnum->getDecl()->hasNameForLinkage() &&
6474           SourceEnum != TargetEnum) {
6475         if (S.SourceMgr.isInSystemMacro(CC))
6476           return;
6477 
6478         return DiagnoseImpCast(S, E, SourceType, T, CC,
6479                                diag::warn_impcast_different_enum_types);
6480       }
6481 
6482   return;
6483 }
6484 
6485 void CheckConditionalOperator(Sema &S, ConditionalOperator *E,
6486                               SourceLocation CC, QualType T);
6487 
6488 void CheckConditionalOperand(Sema &S, Expr *E, QualType T,
6489                              SourceLocation CC, bool &ICContext) {
6490   E = E->IgnoreParenImpCasts();
6491 
6492   if (isa<ConditionalOperator>(E))
6493     return CheckConditionalOperator(S, cast<ConditionalOperator>(E), CC, T);
6494 
6495   AnalyzeImplicitConversions(S, E, CC);
6496   if (E->getType() != T)
6497     return CheckImplicitConversion(S, E, T, CC, &ICContext);
6498   return;
6499 }
6500 
6501 void CheckConditionalOperator(Sema &S, ConditionalOperator *E,
6502                               SourceLocation CC, QualType T) {
6503   AnalyzeImplicitConversions(S, E->getCond(), E->getQuestionLoc());
6504 
6505   bool Suspicious = false;
6506   CheckConditionalOperand(S, E->getTrueExpr(), T, CC, Suspicious);
6507   CheckConditionalOperand(S, E->getFalseExpr(), T, CC, Suspicious);
6508 
6509   // If -Wconversion would have warned about either of the candidates
6510   // for a signedness conversion to the context type...
6511   if (!Suspicious) return;
6512 
6513   // ...but it's currently ignored...
6514   if (!S.Diags.isIgnored(diag::warn_impcast_integer_sign_conditional, CC))
6515     return;
6516 
6517   // ...then check whether it would have warned about either of the
6518   // candidates for a signedness conversion to the condition type.
6519   if (E->getType() == T) return;
6520 
6521   Suspicious = false;
6522   CheckImplicitConversion(S, E->getTrueExpr()->IgnoreParenImpCasts(),
6523                           E->getType(), CC, &Suspicious);
6524   if (!Suspicious)
6525     CheckImplicitConversion(S, E->getFalseExpr()->IgnoreParenImpCasts(),
6526                             E->getType(), CC, &Suspicious);
6527 }
6528 
6529 /// CheckBoolLikeConversion - Check conversion of given expression to boolean.
6530 /// Input argument E is a logical expression.
6531 static void CheckBoolLikeConversion(Sema &S, Expr *E, SourceLocation CC) {
6532   if (S.getLangOpts().Bool)
6533     return;
6534   CheckImplicitConversion(S, E->IgnoreParenImpCasts(), S.Context.BoolTy, CC);
6535 }
6536 
6537 /// AnalyzeImplicitConversions - Find and report any interesting
6538 /// implicit conversions in the given expression.  There are a couple
6539 /// of competing diagnostics here, -Wconversion and -Wsign-compare.
6540 void AnalyzeImplicitConversions(Sema &S, Expr *OrigE, SourceLocation CC) {
6541   QualType T = OrigE->getType();
6542   Expr *E = OrigE->IgnoreParenImpCasts();
6543 
6544   if (E->isTypeDependent() || E->isValueDependent())
6545     return;
6546 
6547   // For conditional operators, we analyze the arguments as if they
6548   // were being fed directly into the output.
6549   if (isa<ConditionalOperator>(E)) {
6550     ConditionalOperator *CO = cast<ConditionalOperator>(E);
6551     CheckConditionalOperator(S, CO, CC, T);
6552     return;
6553   }
6554 
6555   // Check implicit argument conversions for function calls.
6556   if (CallExpr *Call = dyn_cast<CallExpr>(E))
6557     CheckImplicitArgumentConversions(S, Call, CC);
6558 
6559   // Go ahead and check any implicit conversions we might have skipped.
6560   // The non-canonical typecheck is just an optimization;
6561   // CheckImplicitConversion will filter out dead implicit conversions.
6562   if (E->getType() != T)
6563     CheckImplicitConversion(S, E, T, CC);
6564 
6565   // Now continue drilling into this expression.
6566 
6567   if (PseudoObjectExpr * POE = dyn_cast<PseudoObjectExpr>(E)) {
6568     if (POE->getResultExpr())
6569       E = POE->getResultExpr();
6570   }
6571 
6572   if (const OpaqueValueExpr *OVE = dyn_cast<OpaqueValueExpr>(E))
6573     return AnalyzeImplicitConversions(S, OVE->getSourceExpr(), CC);
6574 
6575   // Skip past explicit casts.
6576   if (isa<ExplicitCastExpr>(E)) {
6577     E = cast<ExplicitCastExpr>(E)->getSubExpr()->IgnoreParenImpCasts();
6578     return AnalyzeImplicitConversions(S, E, CC);
6579   }
6580 
6581   if (BinaryOperator *BO = dyn_cast<BinaryOperator>(E)) {
6582     // Do a somewhat different check with comparison operators.
6583     if (BO->isComparisonOp())
6584       return AnalyzeComparison(S, BO);
6585 
6586     // And with simple assignments.
6587     if (BO->getOpcode() == BO_Assign)
6588       return AnalyzeAssignment(S, BO);
6589   }
6590 
6591   // These break the otherwise-useful invariant below.  Fortunately,
6592   // we don't really need to recurse into them, because any internal
6593   // expressions should have been analyzed already when they were
6594   // built into statements.
6595   if (isa<StmtExpr>(E)) return;
6596 
6597   // Don't descend into unevaluated contexts.
6598   if (isa<UnaryExprOrTypeTraitExpr>(E)) return;
6599 
6600   // Now just recurse over the expression's children.
6601   CC = E->getExprLoc();
6602   BinaryOperator *BO = dyn_cast<BinaryOperator>(E);
6603   bool IsLogicalAndOperator = BO && BO->getOpcode() == BO_LAnd;
6604   for (Stmt::child_range I = E->children(); I; ++I) {
6605     Expr *ChildExpr = dyn_cast_or_null<Expr>(*I);
6606     if (!ChildExpr)
6607       continue;
6608 
6609     if (IsLogicalAndOperator &&
6610         isa<StringLiteral>(ChildExpr->IgnoreParenImpCasts()))
6611       // Ignore checking string literals that are in logical and operators.
6612       // This is a common pattern for asserts.
6613       continue;
6614     AnalyzeImplicitConversions(S, ChildExpr, CC);
6615   }
6616 
6617   if (BO && BO->isLogicalOp()) {
6618     Expr *SubExpr = BO->getLHS()->IgnoreParenImpCasts();
6619     if (!IsLogicalAndOperator || !isa<StringLiteral>(SubExpr))
6620       ::CheckBoolLikeConversion(S, SubExpr, SubExpr->getExprLoc());
6621 
6622     SubExpr = BO->getRHS()->IgnoreParenImpCasts();
6623     if (!IsLogicalAndOperator || !isa<StringLiteral>(SubExpr))
6624       ::CheckBoolLikeConversion(S, SubExpr, SubExpr->getExprLoc());
6625   }
6626 
6627   if (const UnaryOperator *U = dyn_cast<UnaryOperator>(E))
6628     if (U->getOpcode() == UO_LNot)
6629       ::CheckBoolLikeConversion(S, U->getSubExpr(), CC);
6630 }
6631 
6632 } // end anonymous namespace
6633 
6634 enum {
6635   AddressOf,
6636   FunctionPointer,
6637   ArrayPointer
6638 };
6639 
6640 // Helper function for Sema::DiagnoseAlwaysNonNullPointer.
6641 // Returns true when emitting a warning about taking the address of a reference.
6642 static bool CheckForReference(Sema &SemaRef, const Expr *E,
6643                               PartialDiagnostic PD) {
6644   E = E->IgnoreParenImpCasts();
6645 
6646   const FunctionDecl *FD = nullptr;
6647 
6648   if (const DeclRefExpr *DRE = dyn_cast<DeclRefExpr>(E)) {
6649     if (!DRE->getDecl()->getType()->isReferenceType())
6650       return false;
6651   } else if (const MemberExpr *M = dyn_cast<MemberExpr>(E)) {
6652     if (!M->getMemberDecl()->getType()->isReferenceType())
6653       return false;
6654   } else if (const CallExpr *Call = dyn_cast<CallExpr>(E)) {
6655     if (!Call->getCallReturnType()->isReferenceType())
6656       return false;
6657     FD = Call->getDirectCallee();
6658   } else {
6659     return false;
6660   }
6661 
6662   SemaRef.Diag(E->getExprLoc(), PD);
6663 
6664   // If possible, point to location of function.
6665   if (FD) {
6666     SemaRef.Diag(FD->getLocation(), diag::note_reference_is_return_value) << FD;
6667   }
6668 
6669   return true;
6670 }
6671 
6672 // Returns true if the SourceLocation is expanded from any macro body.
6673 // Returns false if the SourceLocation is invalid, is from not in a macro
6674 // expansion, or is from expanded from a top-level macro argument.
6675 static bool IsInAnyMacroBody(const SourceManager &SM, SourceLocation Loc) {
6676   if (Loc.isInvalid())
6677     return false;
6678 
6679   while (Loc.isMacroID()) {
6680     if (SM.isMacroBodyExpansion(Loc))
6681       return true;
6682     Loc = SM.getImmediateMacroCallerLoc(Loc);
6683   }
6684 
6685   return false;
6686 }
6687 
6688 /// \brief Diagnose pointers that are always non-null.
6689 /// \param E the expression containing the pointer
6690 /// \param NullKind NPCK_NotNull if E is a cast to bool, otherwise, E is
6691 /// compared to a null pointer
6692 /// \param IsEqual True when the comparison is equal to a null pointer
6693 /// \param Range Extra SourceRange to highlight in the diagnostic
6694 void Sema::DiagnoseAlwaysNonNullPointer(Expr *E,
6695                                         Expr::NullPointerConstantKind NullKind,
6696                                         bool IsEqual, SourceRange Range) {
6697   if (!E)
6698     return;
6699 
6700   // Don't warn inside macros.
6701   if (E->getExprLoc().isMacroID()) {
6702     const SourceManager &SM = getSourceManager();
6703     if (IsInAnyMacroBody(SM, E->getExprLoc()) ||
6704         IsInAnyMacroBody(SM, Range.getBegin()))
6705       return;
6706   }
6707   E = E->IgnoreImpCasts();
6708 
6709   const bool IsCompare = NullKind != Expr::NPCK_NotNull;
6710 
6711   if (isa<CXXThisExpr>(E)) {
6712     unsigned DiagID = IsCompare ? diag::warn_this_null_compare
6713                                 : diag::warn_this_bool_conversion;
6714     Diag(E->getExprLoc(), DiagID) << E->getSourceRange() << Range << IsEqual;
6715     return;
6716   }
6717 
6718   bool IsAddressOf = false;
6719 
6720   if (UnaryOperator *UO = dyn_cast<UnaryOperator>(E)) {
6721     if (UO->getOpcode() != UO_AddrOf)
6722       return;
6723     IsAddressOf = true;
6724     E = UO->getSubExpr();
6725   }
6726 
6727   if (IsAddressOf) {
6728     unsigned DiagID = IsCompare
6729                           ? diag::warn_address_of_reference_null_compare
6730                           : diag::warn_address_of_reference_bool_conversion;
6731     PartialDiagnostic PD = PDiag(DiagID) << E->getSourceRange() << Range
6732                                          << IsEqual;
6733     if (CheckForReference(*this, E, PD)) {
6734       return;
6735     }
6736   }
6737 
6738   // Expect to find a single Decl.  Skip anything more complicated.
6739   ValueDecl *D = nullptr;
6740   if (DeclRefExpr *R = dyn_cast<DeclRefExpr>(E)) {
6741     D = R->getDecl();
6742   } else if (MemberExpr *M = dyn_cast<MemberExpr>(E)) {
6743     D = M->getMemberDecl();
6744   }
6745 
6746   // Weak Decls can be null.
6747   if (!D || D->isWeak())
6748     return;
6749 
6750   // Check for parameter decl with nonnull attribute
6751   if (const ParmVarDecl* PV = dyn_cast<ParmVarDecl>(D)) {
6752     if (getCurFunction() && !getCurFunction()->ModifiedNonNullParams.count(PV))
6753       if (const FunctionDecl* FD = dyn_cast<FunctionDecl>(PV->getDeclContext())) {
6754         unsigned NumArgs = FD->getNumParams();
6755         llvm::SmallBitVector AttrNonNull(NumArgs);
6756         for (const auto *NonNull : FD->specific_attrs<NonNullAttr>()) {
6757           if (!NonNull->args_size()) {
6758             AttrNonNull.set(0, NumArgs);
6759             break;
6760           }
6761           for (unsigned Val : NonNull->args()) {
6762             if (Val >= NumArgs)
6763               continue;
6764             AttrNonNull.set(Val);
6765           }
6766         }
6767         if (!AttrNonNull.empty())
6768           for (unsigned i = 0; i < NumArgs; ++i)
6769             if (FD->getParamDecl(i) == PV && AttrNonNull[i]) {
6770               std::string Str;
6771               llvm::raw_string_ostream S(Str);
6772               E->printPretty(S, nullptr, getPrintingPolicy());
6773               unsigned DiagID = IsCompare ? diag::warn_nonnull_parameter_compare
6774                                           : diag::warn_cast_nonnull_to_bool;
6775               Diag(E->getExprLoc(), DiagID) << S.str() << E->getSourceRange()
6776                 << Range << IsEqual;
6777               return;
6778             }
6779       }
6780     }
6781 
6782   QualType T = D->getType();
6783   const bool IsArray = T->isArrayType();
6784   const bool IsFunction = T->isFunctionType();
6785 
6786   // Address of function is used to silence the function warning.
6787   if (IsAddressOf && IsFunction) {
6788     return;
6789   }
6790 
6791   // Found nothing.
6792   if (!IsAddressOf && !IsFunction && !IsArray)
6793     return;
6794 
6795   // Pretty print the expression for the diagnostic.
6796   std::string Str;
6797   llvm::raw_string_ostream S(Str);
6798   E->printPretty(S, nullptr, getPrintingPolicy());
6799 
6800   unsigned DiagID = IsCompare ? diag::warn_null_pointer_compare
6801                               : diag::warn_impcast_pointer_to_bool;
6802   unsigned DiagType;
6803   if (IsAddressOf)
6804     DiagType = AddressOf;
6805   else if (IsFunction)
6806     DiagType = FunctionPointer;
6807   else if (IsArray)
6808     DiagType = ArrayPointer;
6809   else
6810     llvm_unreachable("Could not determine diagnostic.");
6811   Diag(E->getExprLoc(), DiagID) << DiagType << S.str() << E->getSourceRange()
6812                                 << Range << IsEqual;
6813 
6814   if (!IsFunction)
6815     return;
6816 
6817   // Suggest '&' to silence the function warning.
6818   Diag(E->getExprLoc(), diag::note_function_warning_silence)
6819       << FixItHint::CreateInsertion(E->getLocStart(), "&");
6820 
6821   // Check to see if '()' fixit should be emitted.
6822   QualType ReturnType;
6823   UnresolvedSet<4> NonTemplateOverloads;
6824   tryExprAsCall(*E, ReturnType, NonTemplateOverloads);
6825   if (ReturnType.isNull())
6826     return;
6827 
6828   if (IsCompare) {
6829     // There are two cases here.  If there is null constant, the only suggest
6830     // for a pointer return type.  If the null is 0, then suggest if the return
6831     // type is a pointer or an integer type.
6832     if (!ReturnType->isPointerType()) {
6833       if (NullKind == Expr::NPCK_ZeroExpression ||
6834           NullKind == Expr::NPCK_ZeroLiteral) {
6835         if (!ReturnType->isIntegerType())
6836           return;
6837       } else {
6838         return;
6839       }
6840     }
6841   } else { // !IsCompare
6842     // For function to bool, only suggest if the function pointer has bool
6843     // return type.
6844     if (!ReturnType->isSpecificBuiltinType(BuiltinType::Bool))
6845       return;
6846   }
6847   Diag(E->getExprLoc(), diag::note_function_to_function_call)
6848       << FixItHint::CreateInsertion(getLocForEndOfToken(E->getLocEnd()), "()");
6849 }
6850 
6851 
6852 /// Diagnoses "dangerous" implicit conversions within the given
6853 /// expression (which is a full expression).  Implements -Wconversion
6854 /// and -Wsign-compare.
6855 ///
6856 /// \param CC the "context" location of the implicit conversion, i.e.
6857 ///   the most location of the syntactic entity requiring the implicit
6858 ///   conversion
6859 void Sema::CheckImplicitConversions(Expr *E, SourceLocation CC) {
6860   // Don't diagnose in unevaluated contexts.
6861   if (isUnevaluatedContext())
6862     return;
6863 
6864   // Don't diagnose for value- or type-dependent expressions.
6865   if (E->isTypeDependent() || E->isValueDependent())
6866     return;
6867 
6868   // Check for array bounds violations in cases where the check isn't triggered
6869   // elsewhere for other Expr types (like BinaryOperators), e.g. when an
6870   // ArraySubscriptExpr is on the RHS of a variable initialization.
6871   CheckArrayAccess(E);
6872 
6873   // This is not the right CC for (e.g.) a variable initialization.
6874   AnalyzeImplicitConversions(*this, E, CC);
6875 }
6876 
6877 /// CheckBoolLikeConversion - Check conversion of given expression to boolean.
6878 /// Input argument E is a logical expression.
6879 void Sema::CheckBoolLikeConversion(Expr *E, SourceLocation CC) {
6880   ::CheckBoolLikeConversion(*this, E, CC);
6881 }
6882 
6883 /// Diagnose when expression is an integer constant expression and its evaluation
6884 /// results in integer overflow
6885 void Sema::CheckForIntOverflow (Expr *E) {
6886   if (isa<BinaryOperator>(E->IgnoreParenCasts()))
6887     E->IgnoreParenCasts()->EvaluateForOverflow(Context);
6888 }
6889 
6890 namespace {
6891 /// \brief Visitor for expressions which looks for unsequenced operations on the
6892 /// same object.
6893 class SequenceChecker : public EvaluatedExprVisitor<SequenceChecker> {
6894   typedef EvaluatedExprVisitor<SequenceChecker> Base;
6895 
6896   /// \brief A tree of sequenced regions within an expression. Two regions are
6897   /// unsequenced if one is an ancestor or a descendent of the other. When we
6898   /// finish processing an expression with sequencing, such as a comma
6899   /// expression, we fold its tree nodes into its parent, since they are
6900   /// unsequenced with respect to nodes we will visit later.
6901   class SequenceTree {
6902     struct Value {
6903       explicit Value(unsigned Parent) : Parent(Parent), Merged(false) {}
6904       unsigned Parent : 31;
6905       bool Merged : 1;
6906     };
6907     SmallVector<Value, 8> Values;
6908 
6909   public:
6910     /// \brief A region within an expression which may be sequenced with respect
6911     /// to some other region.
6912     class Seq {
6913       explicit Seq(unsigned N) : Index(N) {}
6914       unsigned Index;
6915       friend class SequenceTree;
6916     public:
6917       Seq() : Index(0) {}
6918     };
6919 
6920     SequenceTree() { Values.push_back(Value(0)); }
6921     Seq root() const { return Seq(0); }
6922 
6923     /// \brief Create a new sequence of operations, which is an unsequenced
6924     /// subset of \p Parent. This sequence of operations is sequenced with
6925     /// respect to other children of \p Parent.
6926     Seq allocate(Seq Parent) {
6927       Values.push_back(Value(Parent.Index));
6928       return Seq(Values.size() - 1);
6929     }
6930 
6931     /// \brief Merge a sequence of operations into its parent.
6932     void merge(Seq S) {
6933       Values[S.Index].Merged = true;
6934     }
6935 
6936     /// \brief Determine whether two operations are unsequenced. This operation
6937     /// is asymmetric: \p Cur should be the more recent sequence, and \p Old
6938     /// should have been merged into its parent as appropriate.
6939     bool isUnsequenced(Seq Cur, Seq Old) {
6940       unsigned C = representative(Cur.Index);
6941       unsigned Target = representative(Old.Index);
6942       while (C >= Target) {
6943         if (C == Target)
6944           return true;
6945         C = Values[C].Parent;
6946       }
6947       return false;
6948     }
6949 
6950   private:
6951     /// \brief Pick a representative for a sequence.
6952     unsigned representative(unsigned K) {
6953       if (Values[K].Merged)
6954         // Perform path compression as we go.
6955         return Values[K].Parent = representative(Values[K].Parent);
6956       return K;
6957     }
6958   };
6959 
6960   /// An object for which we can track unsequenced uses.
6961   typedef NamedDecl *Object;
6962 
6963   /// Different flavors of object usage which we track. We only track the
6964   /// least-sequenced usage of each kind.
6965   enum UsageKind {
6966     /// A read of an object. Multiple unsequenced reads are OK.
6967     UK_Use,
6968     /// A modification of an object which is sequenced before the value
6969     /// computation of the expression, such as ++n in C++.
6970     UK_ModAsValue,
6971     /// A modification of an object which is not sequenced before the value
6972     /// computation of the expression, such as n++.
6973     UK_ModAsSideEffect,
6974 
6975     UK_Count = UK_ModAsSideEffect + 1
6976   };
6977 
6978   struct Usage {
6979     Usage() : Use(nullptr), Seq() {}
6980     Expr *Use;
6981     SequenceTree::Seq Seq;
6982   };
6983 
6984   struct UsageInfo {
6985     UsageInfo() : Diagnosed(false) {}
6986     Usage Uses[UK_Count];
6987     /// Have we issued a diagnostic for this variable already?
6988     bool Diagnosed;
6989   };
6990   typedef llvm::SmallDenseMap<Object, UsageInfo, 16> UsageInfoMap;
6991 
6992   Sema &SemaRef;
6993   /// Sequenced regions within the expression.
6994   SequenceTree Tree;
6995   /// Declaration modifications and references which we have seen.
6996   UsageInfoMap UsageMap;
6997   /// The region we are currently within.
6998   SequenceTree::Seq Region;
6999   /// Filled in with declarations which were modified as a side-effect
7000   /// (that is, post-increment operations).
7001   SmallVectorImpl<std::pair<Object, Usage> > *ModAsSideEffect;
7002   /// Expressions to check later. We defer checking these to reduce
7003   /// stack usage.
7004   SmallVectorImpl<Expr *> &WorkList;
7005 
7006   /// RAII object wrapping the visitation of a sequenced subexpression of an
7007   /// expression. At the end of this process, the side-effects of the evaluation
7008   /// become sequenced with respect to the value computation of the result, so
7009   /// we downgrade any UK_ModAsSideEffect within the evaluation to
7010   /// UK_ModAsValue.
7011   struct SequencedSubexpression {
7012     SequencedSubexpression(SequenceChecker &Self)
7013       : Self(Self), OldModAsSideEffect(Self.ModAsSideEffect) {
7014       Self.ModAsSideEffect = &ModAsSideEffect;
7015     }
7016     ~SequencedSubexpression() {
7017       for (auto MI = ModAsSideEffect.rbegin(), ME = ModAsSideEffect.rend();
7018            MI != ME; ++MI) {
7019         UsageInfo &U = Self.UsageMap[MI->first];
7020         auto &SideEffectUsage = U.Uses[UK_ModAsSideEffect];
7021         Self.addUsage(U, MI->first, SideEffectUsage.Use, UK_ModAsValue);
7022         SideEffectUsage = MI->second;
7023       }
7024       Self.ModAsSideEffect = OldModAsSideEffect;
7025     }
7026 
7027     SequenceChecker &Self;
7028     SmallVector<std::pair<Object, Usage>, 4> ModAsSideEffect;
7029     SmallVectorImpl<std::pair<Object, Usage> > *OldModAsSideEffect;
7030   };
7031 
7032   /// RAII object wrapping the visitation of a subexpression which we might
7033   /// choose to evaluate as a constant. If any subexpression is evaluated and
7034   /// found to be non-constant, this allows us to suppress the evaluation of
7035   /// the outer expression.
7036   class EvaluationTracker {
7037   public:
7038     EvaluationTracker(SequenceChecker &Self)
7039         : Self(Self), Prev(Self.EvalTracker), EvalOK(true) {
7040       Self.EvalTracker = this;
7041     }
7042     ~EvaluationTracker() {
7043       Self.EvalTracker = Prev;
7044       if (Prev)
7045         Prev->EvalOK &= EvalOK;
7046     }
7047 
7048     bool evaluate(const Expr *E, bool &Result) {
7049       if (!EvalOK || E->isValueDependent())
7050         return false;
7051       EvalOK = E->EvaluateAsBooleanCondition(Result, Self.SemaRef.Context);
7052       return EvalOK;
7053     }
7054 
7055   private:
7056     SequenceChecker &Self;
7057     EvaluationTracker *Prev;
7058     bool EvalOK;
7059   } *EvalTracker;
7060 
7061   /// \brief Find the object which is produced by the specified expression,
7062   /// if any.
7063   Object getObject(Expr *E, bool Mod) const {
7064     E = E->IgnoreParenCasts();
7065     if (UnaryOperator *UO = dyn_cast<UnaryOperator>(E)) {
7066       if (Mod && (UO->getOpcode() == UO_PreInc || UO->getOpcode() == UO_PreDec))
7067         return getObject(UO->getSubExpr(), Mod);
7068     } else if (BinaryOperator *BO = dyn_cast<BinaryOperator>(E)) {
7069       if (BO->getOpcode() == BO_Comma)
7070         return getObject(BO->getRHS(), Mod);
7071       if (Mod && BO->isAssignmentOp())
7072         return getObject(BO->getLHS(), Mod);
7073     } else if (MemberExpr *ME = dyn_cast<MemberExpr>(E)) {
7074       // FIXME: Check for more interesting cases, like "x.n = ++x.n".
7075       if (isa<CXXThisExpr>(ME->getBase()->IgnoreParenCasts()))
7076         return ME->getMemberDecl();
7077     } else if (DeclRefExpr *DRE = dyn_cast<DeclRefExpr>(E))
7078       // FIXME: If this is a reference, map through to its value.
7079       return DRE->getDecl();
7080     return nullptr;
7081   }
7082 
7083   /// \brief Note that an object was modified or used by an expression.
7084   void addUsage(UsageInfo &UI, Object O, Expr *Ref, UsageKind UK) {
7085     Usage &U = UI.Uses[UK];
7086     if (!U.Use || !Tree.isUnsequenced(Region, U.Seq)) {
7087       if (UK == UK_ModAsSideEffect && ModAsSideEffect)
7088         ModAsSideEffect->push_back(std::make_pair(O, U));
7089       U.Use = Ref;
7090       U.Seq = Region;
7091     }
7092   }
7093   /// \brief Check whether a modification or use conflicts with a prior usage.
7094   void checkUsage(Object O, UsageInfo &UI, Expr *Ref, UsageKind OtherKind,
7095                   bool IsModMod) {
7096     if (UI.Diagnosed)
7097       return;
7098 
7099     const Usage &U = UI.Uses[OtherKind];
7100     if (!U.Use || !Tree.isUnsequenced(Region, U.Seq))
7101       return;
7102 
7103     Expr *Mod = U.Use;
7104     Expr *ModOrUse = Ref;
7105     if (OtherKind == UK_Use)
7106       std::swap(Mod, ModOrUse);
7107 
7108     SemaRef.Diag(Mod->getExprLoc(),
7109                  IsModMod ? diag::warn_unsequenced_mod_mod
7110                           : diag::warn_unsequenced_mod_use)
7111       << O << SourceRange(ModOrUse->getExprLoc());
7112     UI.Diagnosed = true;
7113   }
7114 
7115   void notePreUse(Object O, Expr *Use) {
7116     UsageInfo &U = UsageMap[O];
7117     // Uses conflict with other modifications.
7118     checkUsage(O, U, Use, UK_ModAsValue, false);
7119   }
7120   void notePostUse(Object O, Expr *Use) {
7121     UsageInfo &U = UsageMap[O];
7122     checkUsage(O, U, Use, UK_ModAsSideEffect, false);
7123     addUsage(U, O, Use, UK_Use);
7124   }
7125 
7126   void notePreMod(Object O, Expr *Mod) {
7127     UsageInfo &U = UsageMap[O];
7128     // Modifications conflict with other modifications and with uses.
7129     checkUsage(O, U, Mod, UK_ModAsValue, true);
7130     checkUsage(O, U, Mod, UK_Use, false);
7131   }
7132   void notePostMod(Object O, Expr *Use, UsageKind UK) {
7133     UsageInfo &U = UsageMap[O];
7134     checkUsage(O, U, Use, UK_ModAsSideEffect, true);
7135     addUsage(U, O, Use, UK);
7136   }
7137 
7138 public:
7139   SequenceChecker(Sema &S, Expr *E, SmallVectorImpl<Expr *> &WorkList)
7140       : Base(S.Context), SemaRef(S), Region(Tree.root()),
7141         ModAsSideEffect(nullptr), WorkList(WorkList), EvalTracker(nullptr) {
7142     Visit(E);
7143   }
7144 
7145   void VisitStmt(Stmt *S) {
7146     // Skip all statements which aren't expressions for now.
7147   }
7148 
7149   void VisitExpr(Expr *E) {
7150     // By default, just recurse to evaluated subexpressions.
7151     Base::VisitStmt(E);
7152   }
7153 
7154   void VisitCastExpr(CastExpr *E) {
7155     Object O = Object();
7156     if (E->getCastKind() == CK_LValueToRValue)
7157       O = getObject(E->getSubExpr(), false);
7158 
7159     if (O)
7160       notePreUse(O, E);
7161     VisitExpr(E);
7162     if (O)
7163       notePostUse(O, E);
7164   }
7165 
7166   void VisitBinComma(BinaryOperator *BO) {
7167     // C++11 [expr.comma]p1:
7168     //   Every value computation and side effect associated with the left
7169     //   expression is sequenced before every value computation and side
7170     //   effect associated with the right expression.
7171     SequenceTree::Seq LHS = Tree.allocate(Region);
7172     SequenceTree::Seq RHS = Tree.allocate(Region);
7173     SequenceTree::Seq OldRegion = Region;
7174 
7175     {
7176       SequencedSubexpression SeqLHS(*this);
7177       Region = LHS;
7178       Visit(BO->getLHS());
7179     }
7180 
7181     Region = RHS;
7182     Visit(BO->getRHS());
7183 
7184     Region = OldRegion;
7185 
7186     // Forget that LHS and RHS are sequenced. They are both unsequenced
7187     // with respect to other stuff.
7188     Tree.merge(LHS);
7189     Tree.merge(RHS);
7190   }
7191 
7192   void VisitBinAssign(BinaryOperator *BO) {
7193     // The modification is sequenced after the value computation of the LHS
7194     // and RHS, so check it before inspecting the operands and update the
7195     // map afterwards.
7196     Object O = getObject(BO->getLHS(), true);
7197     if (!O)
7198       return VisitExpr(BO);
7199 
7200     notePreMod(O, BO);
7201 
7202     // C++11 [expr.ass]p7:
7203     //   E1 op= E2 is equivalent to E1 = E1 op E2, except that E1 is evaluated
7204     //   only once.
7205     //
7206     // Therefore, for a compound assignment operator, O is considered used
7207     // everywhere except within the evaluation of E1 itself.
7208     if (isa<CompoundAssignOperator>(BO))
7209       notePreUse(O, BO);
7210 
7211     Visit(BO->getLHS());
7212 
7213     if (isa<CompoundAssignOperator>(BO))
7214       notePostUse(O, BO);
7215 
7216     Visit(BO->getRHS());
7217 
7218     // C++11 [expr.ass]p1:
7219     //   the assignment is sequenced [...] before the value computation of the
7220     //   assignment expression.
7221     // C11 6.5.16/3 has no such rule.
7222     notePostMod(O, BO, SemaRef.getLangOpts().CPlusPlus ? UK_ModAsValue
7223                                                        : UK_ModAsSideEffect);
7224   }
7225   void VisitCompoundAssignOperator(CompoundAssignOperator *CAO) {
7226     VisitBinAssign(CAO);
7227   }
7228 
7229   void VisitUnaryPreInc(UnaryOperator *UO) { VisitUnaryPreIncDec(UO); }
7230   void VisitUnaryPreDec(UnaryOperator *UO) { VisitUnaryPreIncDec(UO); }
7231   void VisitUnaryPreIncDec(UnaryOperator *UO) {
7232     Object O = getObject(UO->getSubExpr(), true);
7233     if (!O)
7234       return VisitExpr(UO);
7235 
7236     notePreMod(O, UO);
7237     Visit(UO->getSubExpr());
7238     // C++11 [expr.pre.incr]p1:
7239     //   the expression ++x is equivalent to x+=1
7240     notePostMod(O, UO, SemaRef.getLangOpts().CPlusPlus ? UK_ModAsValue
7241                                                        : UK_ModAsSideEffect);
7242   }
7243 
7244   void VisitUnaryPostInc(UnaryOperator *UO) { VisitUnaryPostIncDec(UO); }
7245   void VisitUnaryPostDec(UnaryOperator *UO) { VisitUnaryPostIncDec(UO); }
7246   void VisitUnaryPostIncDec(UnaryOperator *UO) {
7247     Object O = getObject(UO->getSubExpr(), true);
7248     if (!O)
7249       return VisitExpr(UO);
7250 
7251     notePreMod(O, UO);
7252     Visit(UO->getSubExpr());
7253     notePostMod(O, UO, UK_ModAsSideEffect);
7254   }
7255 
7256   /// Don't visit the RHS of '&&' or '||' if it might not be evaluated.
7257   void VisitBinLOr(BinaryOperator *BO) {
7258     // The side-effects of the LHS of an '&&' are sequenced before the
7259     // value computation of the RHS, and hence before the value computation
7260     // of the '&&' itself, unless the LHS evaluates to zero. We treat them
7261     // as if they were unconditionally sequenced.
7262     EvaluationTracker Eval(*this);
7263     {
7264       SequencedSubexpression Sequenced(*this);
7265       Visit(BO->getLHS());
7266     }
7267 
7268     bool Result;
7269     if (Eval.evaluate(BO->getLHS(), Result)) {
7270       if (!Result)
7271         Visit(BO->getRHS());
7272     } else {
7273       // Check for unsequenced operations in the RHS, treating it as an
7274       // entirely separate evaluation.
7275       //
7276       // FIXME: If there are operations in the RHS which are unsequenced
7277       // with respect to operations outside the RHS, and those operations
7278       // are unconditionally evaluated, diagnose them.
7279       WorkList.push_back(BO->getRHS());
7280     }
7281   }
7282   void VisitBinLAnd(BinaryOperator *BO) {
7283     EvaluationTracker Eval(*this);
7284     {
7285       SequencedSubexpression Sequenced(*this);
7286       Visit(BO->getLHS());
7287     }
7288 
7289     bool Result;
7290     if (Eval.evaluate(BO->getLHS(), Result)) {
7291       if (Result)
7292         Visit(BO->getRHS());
7293     } else {
7294       WorkList.push_back(BO->getRHS());
7295     }
7296   }
7297 
7298   // Only visit the condition, unless we can be sure which subexpression will
7299   // be chosen.
7300   void VisitAbstractConditionalOperator(AbstractConditionalOperator *CO) {
7301     EvaluationTracker Eval(*this);
7302     {
7303       SequencedSubexpression Sequenced(*this);
7304       Visit(CO->getCond());
7305     }
7306 
7307     bool Result;
7308     if (Eval.evaluate(CO->getCond(), Result))
7309       Visit(Result ? CO->getTrueExpr() : CO->getFalseExpr());
7310     else {
7311       WorkList.push_back(CO->getTrueExpr());
7312       WorkList.push_back(CO->getFalseExpr());
7313     }
7314   }
7315 
7316   void VisitCallExpr(CallExpr *CE) {
7317     // C++11 [intro.execution]p15:
7318     //   When calling a function [...], every value computation and side effect
7319     //   associated with any argument expression, or with the postfix expression
7320     //   designating the called function, is sequenced before execution of every
7321     //   expression or statement in the body of the function [and thus before
7322     //   the value computation of its result].
7323     SequencedSubexpression Sequenced(*this);
7324     Base::VisitCallExpr(CE);
7325 
7326     // FIXME: CXXNewExpr and CXXDeleteExpr implicitly call functions.
7327   }
7328 
7329   void VisitCXXConstructExpr(CXXConstructExpr *CCE) {
7330     // This is a call, so all subexpressions are sequenced before the result.
7331     SequencedSubexpression Sequenced(*this);
7332 
7333     if (!CCE->isListInitialization())
7334       return VisitExpr(CCE);
7335 
7336     // In C++11, list initializations are sequenced.
7337     SmallVector<SequenceTree::Seq, 32> Elts;
7338     SequenceTree::Seq Parent = Region;
7339     for (CXXConstructExpr::arg_iterator I = CCE->arg_begin(),
7340                                         E = CCE->arg_end();
7341          I != E; ++I) {
7342       Region = Tree.allocate(Parent);
7343       Elts.push_back(Region);
7344       Visit(*I);
7345     }
7346 
7347     // Forget that the initializers are sequenced.
7348     Region = Parent;
7349     for (unsigned I = 0; I < Elts.size(); ++I)
7350       Tree.merge(Elts[I]);
7351   }
7352 
7353   void VisitInitListExpr(InitListExpr *ILE) {
7354     if (!SemaRef.getLangOpts().CPlusPlus11)
7355       return VisitExpr(ILE);
7356 
7357     // In C++11, list initializations are sequenced.
7358     SmallVector<SequenceTree::Seq, 32> Elts;
7359     SequenceTree::Seq Parent = Region;
7360     for (unsigned I = 0; I < ILE->getNumInits(); ++I) {
7361       Expr *E = ILE->getInit(I);
7362       if (!E) continue;
7363       Region = Tree.allocate(Parent);
7364       Elts.push_back(Region);
7365       Visit(E);
7366     }
7367 
7368     // Forget that the initializers are sequenced.
7369     Region = Parent;
7370     for (unsigned I = 0; I < Elts.size(); ++I)
7371       Tree.merge(Elts[I]);
7372   }
7373 };
7374 }
7375 
7376 void Sema::CheckUnsequencedOperations(Expr *E) {
7377   SmallVector<Expr *, 8> WorkList;
7378   WorkList.push_back(E);
7379   while (!WorkList.empty()) {
7380     Expr *Item = WorkList.pop_back_val();
7381     SequenceChecker(*this, Item, WorkList);
7382   }
7383 }
7384 
7385 void Sema::CheckCompletedExpr(Expr *E, SourceLocation CheckLoc,
7386                               bool IsConstexpr) {
7387   CheckImplicitConversions(E, CheckLoc);
7388   CheckUnsequencedOperations(E);
7389   if (!IsConstexpr && !E->isValueDependent())
7390     CheckForIntOverflow(E);
7391 }
7392 
7393 void Sema::CheckBitFieldInitialization(SourceLocation InitLoc,
7394                                        FieldDecl *BitField,
7395                                        Expr *Init) {
7396   (void) AnalyzeBitFieldAssignment(*this, BitField, Init, InitLoc);
7397 }
7398 
7399 /// CheckParmsForFunctionDef - Check that the parameters of the given
7400 /// function are appropriate for the definition of a function. This
7401 /// takes care of any checks that cannot be performed on the
7402 /// declaration itself, e.g., that the types of each of the function
7403 /// parameters are complete.
7404 bool Sema::CheckParmsForFunctionDef(ParmVarDecl *const *P,
7405                                     ParmVarDecl *const *PEnd,
7406                                     bool CheckParameterNames) {
7407   bool HasInvalidParm = false;
7408   for (; P != PEnd; ++P) {
7409     ParmVarDecl *Param = *P;
7410 
7411     // C99 6.7.5.3p4: the parameters in a parameter type list in a
7412     // function declarator that is part of a function definition of
7413     // that function shall not have incomplete type.
7414     //
7415     // This is also C++ [dcl.fct]p6.
7416     if (!Param->isInvalidDecl() &&
7417         RequireCompleteType(Param->getLocation(), Param->getType(),
7418                             diag::err_typecheck_decl_incomplete_type)) {
7419       Param->setInvalidDecl();
7420       HasInvalidParm = true;
7421     }
7422 
7423     // C99 6.9.1p5: If the declarator includes a parameter type list, the
7424     // declaration of each parameter shall include an identifier.
7425     if (CheckParameterNames &&
7426         Param->getIdentifier() == nullptr &&
7427         !Param->isImplicit() &&
7428         !getLangOpts().CPlusPlus)
7429       Diag(Param->getLocation(), diag::err_parameter_name_omitted);
7430 
7431     // C99 6.7.5.3p12:
7432     //   If the function declarator is not part of a definition of that
7433     //   function, parameters may have incomplete type and may use the [*]
7434     //   notation in their sequences of declarator specifiers to specify
7435     //   variable length array types.
7436     QualType PType = Param->getOriginalType();
7437     while (const ArrayType *AT = Context.getAsArrayType(PType)) {
7438       if (AT->getSizeModifier() == ArrayType::Star) {
7439         // FIXME: This diagnostic should point the '[*]' if source-location
7440         // information is added for it.
7441         Diag(Param->getLocation(), diag::err_array_star_in_function_definition);
7442         break;
7443       }
7444       PType= AT->getElementType();
7445     }
7446 
7447     // MSVC destroys objects passed by value in the callee.  Therefore a
7448     // function definition which takes such a parameter must be able to call the
7449     // object's destructor.  However, we don't perform any direct access check
7450     // on the dtor.
7451     if (getLangOpts().CPlusPlus && Context.getTargetInfo()
7452                                        .getCXXABI()
7453                                        .areArgsDestroyedLeftToRightInCallee()) {
7454       if (!Param->isInvalidDecl()) {
7455         if (const RecordType *RT = Param->getType()->getAs<RecordType>()) {
7456           CXXRecordDecl *ClassDecl = cast<CXXRecordDecl>(RT->getDecl());
7457           if (!ClassDecl->isInvalidDecl() &&
7458               !ClassDecl->hasIrrelevantDestructor() &&
7459               !ClassDecl->isDependentContext()) {
7460             CXXDestructorDecl *Destructor = LookupDestructor(ClassDecl);
7461             MarkFunctionReferenced(Param->getLocation(), Destructor);
7462             DiagnoseUseOfDecl(Destructor, Param->getLocation());
7463           }
7464         }
7465       }
7466     }
7467   }
7468 
7469   return HasInvalidParm;
7470 }
7471 
7472 /// CheckCastAlign - Implements -Wcast-align, which warns when a
7473 /// pointer cast increases the alignment requirements.
7474 void Sema::CheckCastAlign(Expr *Op, QualType T, SourceRange TRange) {
7475   // This is actually a lot of work to potentially be doing on every
7476   // cast; don't do it if we're ignoring -Wcast_align (as is the default).
7477   if (getDiagnostics().isIgnored(diag::warn_cast_align, TRange.getBegin()))
7478     return;
7479 
7480   // Ignore dependent types.
7481   if (T->isDependentType() || Op->getType()->isDependentType())
7482     return;
7483 
7484   // Require that the destination be a pointer type.
7485   const PointerType *DestPtr = T->getAs<PointerType>();
7486   if (!DestPtr) return;
7487 
7488   // If the destination has alignment 1, we're done.
7489   QualType DestPointee = DestPtr->getPointeeType();
7490   if (DestPointee->isIncompleteType()) return;
7491   CharUnits DestAlign = Context.getTypeAlignInChars(DestPointee);
7492   if (DestAlign.isOne()) return;
7493 
7494   // Require that the source be a pointer type.
7495   const PointerType *SrcPtr = Op->getType()->getAs<PointerType>();
7496   if (!SrcPtr) return;
7497   QualType SrcPointee = SrcPtr->getPointeeType();
7498 
7499   // Whitelist casts from cv void*.  We already implicitly
7500   // whitelisted casts to cv void*, since they have alignment 1.
7501   // Also whitelist casts involving incomplete types, which implicitly
7502   // includes 'void'.
7503   if (SrcPointee->isIncompleteType()) return;
7504 
7505   CharUnits SrcAlign = Context.getTypeAlignInChars(SrcPointee);
7506   if (SrcAlign >= DestAlign) return;
7507 
7508   Diag(TRange.getBegin(), diag::warn_cast_align)
7509     << Op->getType() << T
7510     << static_cast<unsigned>(SrcAlign.getQuantity())
7511     << static_cast<unsigned>(DestAlign.getQuantity())
7512     << TRange << Op->getSourceRange();
7513 }
7514 
7515 static const Type* getElementType(const Expr *BaseExpr) {
7516   const Type* EltType = BaseExpr->getType().getTypePtr();
7517   if (EltType->isAnyPointerType())
7518     return EltType->getPointeeType().getTypePtr();
7519   else if (EltType->isArrayType())
7520     return EltType->getBaseElementTypeUnsafe();
7521   return EltType;
7522 }
7523 
7524 /// \brief Check whether this array fits the idiom of a size-one tail padded
7525 /// array member of a struct.
7526 ///
7527 /// We avoid emitting out-of-bounds access warnings for such arrays as they are
7528 /// commonly used to emulate flexible arrays in C89 code.
7529 static bool IsTailPaddedMemberArray(Sema &S, llvm::APInt Size,
7530                                     const NamedDecl *ND) {
7531   if (Size != 1 || !ND) return false;
7532 
7533   const FieldDecl *FD = dyn_cast<FieldDecl>(ND);
7534   if (!FD) return false;
7535 
7536   // Don't consider sizes resulting from macro expansions or template argument
7537   // substitution to form C89 tail-padded arrays.
7538 
7539   TypeSourceInfo *TInfo = FD->getTypeSourceInfo();
7540   while (TInfo) {
7541     TypeLoc TL = TInfo->getTypeLoc();
7542     // Look through typedefs.
7543     if (TypedefTypeLoc TTL = TL.getAs<TypedefTypeLoc>()) {
7544       const TypedefNameDecl *TDL = TTL.getTypedefNameDecl();
7545       TInfo = TDL->getTypeSourceInfo();
7546       continue;
7547     }
7548     if (ConstantArrayTypeLoc CTL = TL.getAs<ConstantArrayTypeLoc>()) {
7549       const Expr *SizeExpr = dyn_cast<IntegerLiteral>(CTL.getSizeExpr());
7550       if (!SizeExpr || SizeExpr->getExprLoc().isMacroID())
7551         return false;
7552     }
7553     break;
7554   }
7555 
7556   const RecordDecl *RD = dyn_cast<RecordDecl>(FD->getDeclContext());
7557   if (!RD) return false;
7558   if (RD->isUnion()) return false;
7559   if (const CXXRecordDecl *CRD = dyn_cast<CXXRecordDecl>(RD)) {
7560     if (!CRD->isStandardLayout()) return false;
7561   }
7562 
7563   // See if this is the last field decl in the record.
7564   const Decl *D = FD;
7565   while ((D = D->getNextDeclInContext()))
7566     if (isa<FieldDecl>(D))
7567       return false;
7568   return true;
7569 }
7570 
7571 void Sema::CheckArrayAccess(const Expr *BaseExpr, const Expr *IndexExpr,
7572                             const ArraySubscriptExpr *ASE,
7573                             bool AllowOnePastEnd, bool IndexNegated) {
7574   IndexExpr = IndexExpr->IgnoreParenImpCasts();
7575   if (IndexExpr->isValueDependent())
7576     return;
7577 
7578   const Type *EffectiveType = getElementType(BaseExpr);
7579   BaseExpr = BaseExpr->IgnoreParenCasts();
7580   const ConstantArrayType *ArrayTy =
7581     Context.getAsConstantArrayType(BaseExpr->getType());
7582   if (!ArrayTy)
7583     return;
7584 
7585   llvm::APSInt index;
7586   if (!IndexExpr->EvaluateAsInt(index, Context))
7587     return;
7588   if (IndexNegated)
7589     index = -index;
7590 
7591   const NamedDecl *ND = nullptr;
7592   if (const DeclRefExpr *DRE = dyn_cast<DeclRefExpr>(BaseExpr))
7593     ND = dyn_cast<NamedDecl>(DRE->getDecl());
7594   if (const MemberExpr *ME = dyn_cast<MemberExpr>(BaseExpr))
7595     ND = dyn_cast<NamedDecl>(ME->getMemberDecl());
7596 
7597   if (index.isUnsigned() || !index.isNegative()) {
7598     llvm::APInt size = ArrayTy->getSize();
7599     if (!size.isStrictlyPositive())
7600       return;
7601 
7602     const Type* BaseType = getElementType(BaseExpr);
7603     if (BaseType != EffectiveType) {
7604       // Make sure we're comparing apples to apples when comparing index to size
7605       uint64_t ptrarith_typesize = Context.getTypeSize(EffectiveType);
7606       uint64_t array_typesize = Context.getTypeSize(BaseType);
7607       // Handle ptrarith_typesize being zero, such as when casting to void*
7608       if (!ptrarith_typesize) ptrarith_typesize = 1;
7609       if (ptrarith_typesize != array_typesize) {
7610         // There's a cast to a different size type involved
7611         uint64_t ratio = array_typesize / ptrarith_typesize;
7612         // TODO: Be smarter about handling cases where array_typesize is not a
7613         // multiple of ptrarith_typesize
7614         if (ptrarith_typesize * ratio == array_typesize)
7615           size *= llvm::APInt(size.getBitWidth(), ratio);
7616       }
7617     }
7618 
7619     if (size.getBitWidth() > index.getBitWidth())
7620       index = index.zext(size.getBitWidth());
7621     else if (size.getBitWidth() < index.getBitWidth())
7622       size = size.zext(index.getBitWidth());
7623 
7624     // For array subscripting the index must be less than size, but for pointer
7625     // arithmetic also allow the index (offset) to be equal to size since
7626     // computing the next address after the end of the array is legal and
7627     // commonly done e.g. in C++ iterators and range-based for loops.
7628     if (AllowOnePastEnd ? index.ule(size) : index.ult(size))
7629       return;
7630 
7631     // Also don't warn for arrays of size 1 which are members of some
7632     // structure. These are often used to approximate flexible arrays in C89
7633     // code.
7634     if (IsTailPaddedMemberArray(*this, size, ND))
7635       return;
7636 
7637     // Suppress the warning if the subscript expression (as identified by the
7638     // ']' location) and the index expression are both from macro expansions
7639     // within a system header.
7640     if (ASE) {
7641       SourceLocation RBracketLoc = SourceMgr.getSpellingLoc(
7642           ASE->getRBracketLoc());
7643       if (SourceMgr.isInSystemHeader(RBracketLoc)) {
7644         SourceLocation IndexLoc = SourceMgr.getSpellingLoc(
7645             IndexExpr->getLocStart());
7646         if (SourceMgr.isWrittenInSameFile(RBracketLoc, IndexLoc))
7647           return;
7648       }
7649     }
7650 
7651     unsigned DiagID = diag::warn_ptr_arith_exceeds_bounds;
7652     if (ASE)
7653       DiagID = diag::warn_array_index_exceeds_bounds;
7654 
7655     DiagRuntimeBehavior(BaseExpr->getLocStart(), BaseExpr,
7656                         PDiag(DiagID) << index.toString(10, true)
7657                           << size.toString(10, true)
7658                           << (unsigned)size.getLimitedValue(~0U)
7659                           << IndexExpr->getSourceRange());
7660   } else {
7661     unsigned DiagID = diag::warn_array_index_precedes_bounds;
7662     if (!ASE) {
7663       DiagID = diag::warn_ptr_arith_precedes_bounds;
7664       if (index.isNegative()) index = -index;
7665     }
7666 
7667     DiagRuntimeBehavior(BaseExpr->getLocStart(), BaseExpr,
7668                         PDiag(DiagID) << index.toString(10, true)
7669                           << IndexExpr->getSourceRange());
7670   }
7671 
7672   if (!ND) {
7673     // Try harder to find a NamedDecl to point at in the note.
7674     while (const ArraySubscriptExpr *ASE =
7675            dyn_cast<ArraySubscriptExpr>(BaseExpr))
7676       BaseExpr = ASE->getBase()->IgnoreParenCasts();
7677     if (const DeclRefExpr *DRE = dyn_cast<DeclRefExpr>(BaseExpr))
7678       ND = dyn_cast<NamedDecl>(DRE->getDecl());
7679     if (const MemberExpr *ME = dyn_cast<MemberExpr>(BaseExpr))
7680       ND = dyn_cast<NamedDecl>(ME->getMemberDecl());
7681   }
7682 
7683   if (ND)
7684     DiagRuntimeBehavior(ND->getLocStart(), BaseExpr,
7685                         PDiag(diag::note_array_index_out_of_bounds)
7686                           << ND->getDeclName());
7687 }
7688 
7689 void Sema::CheckArrayAccess(const Expr *expr) {
7690   int AllowOnePastEnd = 0;
7691   while (expr) {
7692     expr = expr->IgnoreParenImpCasts();
7693     switch (expr->getStmtClass()) {
7694       case Stmt::ArraySubscriptExprClass: {
7695         const ArraySubscriptExpr *ASE = cast<ArraySubscriptExpr>(expr);
7696         CheckArrayAccess(ASE->getBase(), ASE->getIdx(), ASE,
7697                          AllowOnePastEnd > 0);
7698         return;
7699       }
7700       case Stmt::UnaryOperatorClass: {
7701         // Only unwrap the * and & unary operators
7702         const UnaryOperator *UO = cast<UnaryOperator>(expr);
7703         expr = UO->getSubExpr();
7704         switch (UO->getOpcode()) {
7705           case UO_AddrOf:
7706             AllowOnePastEnd++;
7707             break;
7708           case UO_Deref:
7709             AllowOnePastEnd--;
7710             break;
7711           default:
7712             return;
7713         }
7714         break;
7715       }
7716       case Stmt::ConditionalOperatorClass: {
7717         const ConditionalOperator *cond = cast<ConditionalOperator>(expr);
7718         if (const Expr *lhs = cond->getLHS())
7719           CheckArrayAccess(lhs);
7720         if (const Expr *rhs = cond->getRHS())
7721           CheckArrayAccess(rhs);
7722         return;
7723       }
7724       default:
7725         return;
7726     }
7727   }
7728 }
7729 
7730 //===--- CHECK: Objective-C retain cycles ----------------------------------//
7731 
7732 namespace {
7733   struct RetainCycleOwner {
7734     RetainCycleOwner() : Variable(nullptr), Indirect(false) {}
7735     VarDecl *Variable;
7736     SourceRange Range;
7737     SourceLocation Loc;
7738     bool Indirect;
7739 
7740     void setLocsFrom(Expr *e) {
7741       Loc = e->getExprLoc();
7742       Range = e->getSourceRange();
7743     }
7744   };
7745 }
7746 
7747 /// Consider whether capturing the given variable can possibly lead to
7748 /// a retain cycle.
7749 static bool considerVariable(VarDecl *var, Expr *ref, RetainCycleOwner &owner) {
7750   // In ARC, it's captured strongly iff the variable has __strong
7751   // lifetime.  In MRR, it's captured strongly if the variable is
7752   // __block and has an appropriate type.
7753   if (var->getType().getObjCLifetime() != Qualifiers::OCL_Strong)
7754     return false;
7755 
7756   owner.Variable = var;
7757   if (ref)
7758     owner.setLocsFrom(ref);
7759   return true;
7760 }
7761 
7762 static bool findRetainCycleOwner(Sema &S, Expr *e, RetainCycleOwner &owner) {
7763   while (true) {
7764     e = e->IgnoreParens();
7765     if (CastExpr *cast = dyn_cast<CastExpr>(e)) {
7766       switch (cast->getCastKind()) {
7767       case CK_BitCast:
7768       case CK_LValueBitCast:
7769       case CK_LValueToRValue:
7770       case CK_ARCReclaimReturnedObject:
7771         e = cast->getSubExpr();
7772         continue;
7773 
7774       default:
7775         return false;
7776       }
7777     }
7778 
7779     if (ObjCIvarRefExpr *ref = dyn_cast<ObjCIvarRefExpr>(e)) {
7780       ObjCIvarDecl *ivar = ref->getDecl();
7781       if (ivar->getType().getObjCLifetime() != Qualifiers::OCL_Strong)
7782         return false;
7783 
7784       // Try to find a retain cycle in the base.
7785       if (!findRetainCycleOwner(S, ref->getBase(), owner))
7786         return false;
7787 
7788       if (ref->isFreeIvar()) owner.setLocsFrom(ref);
7789       owner.Indirect = true;
7790       return true;
7791     }
7792 
7793     if (DeclRefExpr *ref = dyn_cast<DeclRefExpr>(e)) {
7794       VarDecl *var = dyn_cast<VarDecl>(ref->getDecl());
7795       if (!var) return false;
7796       return considerVariable(var, ref, owner);
7797     }
7798 
7799     if (MemberExpr *member = dyn_cast<MemberExpr>(e)) {
7800       if (member->isArrow()) return false;
7801 
7802       // Don't count this as an indirect ownership.
7803       e = member->getBase();
7804       continue;
7805     }
7806 
7807     if (PseudoObjectExpr *pseudo = dyn_cast<PseudoObjectExpr>(e)) {
7808       // Only pay attention to pseudo-objects on property references.
7809       ObjCPropertyRefExpr *pre
7810         = dyn_cast<ObjCPropertyRefExpr>(pseudo->getSyntacticForm()
7811                                               ->IgnoreParens());
7812       if (!pre) return false;
7813       if (pre->isImplicitProperty()) return false;
7814       ObjCPropertyDecl *property = pre->getExplicitProperty();
7815       if (!property->isRetaining() &&
7816           !(property->getPropertyIvarDecl() &&
7817             property->getPropertyIvarDecl()->getType()
7818               .getObjCLifetime() == Qualifiers::OCL_Strong))
7819           return false;
7820 
7821       owner.Indirect = true;
7822       if (pre->isSuperReceiver()) {
7823         owner.Variable = S.getCurMethodDecl()->getSelfDecl();
7824         if (!owner.Variable)
7825           return false;
7826         owner.Loc = pre->getLocation();
7827         owner.Range = pre->getSourceRange();
7828         return true;
7829       }
7830       e = const_cast<Expr*>(cast<OpaqueValueExpr>(pre->getBase())
7831                               ->getSourceExpr());
7832       continue;
7833     }
7834 
7835     // Array ivars?
7836 
7837     return false;
7838   }
7839 }
7840 
7841 namespace {
7842   struct FindCaptureVisitor : EvaluatedExprVisitor<FindCaptureVisitor> {
7843     FindCaptureVisitor(ASTContext &Context, VarDecl *variable)
7844       : EvaluatedExprVisitor<FindCaptureVisitor>(Context),
7845         Context(Context), Variable(variable), Capturer(nullptr),
7846         VarWillBeReased(false) {}
7847     ASTContext &Context;
7848     VarDecl *Variable;
7849     Expr *Capturer;
7850     bool VarWillBeReased;
7851 
7852     void VisitDeclRefExpr(DeclRefExpr *ref) {
7853       if (ref->getDecl() == Variable && !Capturer)
7854         Capturer = ref;
7855     }
7856 
7857     void VisitObjCIvarRefExpr(ObjCIvarRefExpr *ref) {
7858       if (Capturer) return;
7859       Visit(ref->getBase());
7860       if (Capturer && ref->isFreeIvar())
7861         Capturer = ref;
7862     }
7863 
7864     void VisitBlockExpr(BlockExpr *block) {
7865       // Look inside nested blocks
7866       if (block->getBlockDecl()->capturesVariable(Variable))
7867         Visit(block->getBlockDecl()->getBody());
7868     }
7869 
7870     void VisitOpaqueValueExpr(OpaqueValueExpr *OVE) {
7871       if (Capturer) return;
7872       if (OVE->getSourceExpr())
7873         Visit(OVE->getSourceExpr());
7874     }
7875     void VisitBinaryOperator(BinaryOperator *BinOp) {
7876       if (!Variable || VarWillBeReased || BinOp->getOpcode() != BO_Assign)
7877         return;
7878       Expr *LHS = BinOp->getLHS();
7879       if (const DeclRefExpr *DRE = dyn_cast_or_null<DeclRefExpr>(LHS)) {
7880         if (DRE->getDecl() != Variable)
7881           return;
7882         if (Expr *RHS = BinOp->getRHS()) {
7883           RHS = RHS->IgnoreParenCasts();
7884           llvm::APSInt Value;
7885           VarWillBeReased =
7886             (RHS && RHS->isIntegerConstantExpr(Value, Context) && Value == 0);
7887         }
7888       }
7889     }
7890   };
7891 }
7892 
7893 /// Check whether the given argument is a block which captures a
7894 /// variable.
7895 static Expr *findCapturingExpr(Sema &S, Expr *e, RetainCycleOwner &owner) {
7896   assert(owner.Variable && owner.Loc.isValid());
7897 
7898   e = e->IgnoreParenCasts();
7899 
7900   // Look through [^{...} copy] and Block_copy(^{...}).
7901   if (ObjCMessageExpr *ME = dyn_cast<ObjCMessageExpr>(e)) {
7902     Selector Cmd = ME->getSelector();
7903     if (Cmd.isUnarySelector() && Cmd.getNameForSlot(0) == "copy") {
7904       e = ME->getInstanceReceiver();
7905       if (!e)
7906         return nullptr;
7907       e = e->IgnoreParenCasts();
7908     }
7909   } else if (CallExpr *CE = dyn_cast<CallExpr>(e)) {
7910     if (CE->getNumArgs() == 1) {
7911       FunctionDecl *Fn = dyn_cast_or_null<FunctionDecl>(CE->getCalleeDecl());
7912       if (Fn) {
7913         const IdentifierInfo *FnI = Fn->getIdentifier();
7914         if (FnI && FnI->isStr("_Block_copy")) {
7915           e = CE->getArg(0)->IgnoreParenCasts();
7916         }
7917       }
7918     }
7919   }
7920 
7921   BlockExpr *block = dyn_cast<BlockExpr>(e);
7922   if (!block || !block->getBlockDecl()->capturesVariable(owner.Variable))
7923     return nullptr;
7924 
7925   FindCaptureVisitor visitor(S.Context, owner.Variable);
7926   visitor.Visit(block->getBlockDecl()->getBody());
7927   return visitor.VarWillBeReased ? nullptr : visitor.Capturer;
7928 }
7929 
7930 static void diagnoseRetainCycle(Sema &S, Expr *capturer,
7931                                 RetainCycleOwner &owner) {
7932   assert(capturer);
7933   assert(owner.Variable && owner.Loc.isValid());
7934 
7935   S.Diag(capturer->getExprLoc(), diag::warn_arc_retain_cycle)
7936     << owner.Variable << capturer->getSourceRange();
7937   S.Diag(owner.Loc, diag::note_arc_retain_cycle_owner)
7938     << owner.Indirect << owner.Range;
7939 }
7940 
7941 /// Check for a keyword selector that starts with the word 'add' or
7942 /// 'set'.
7943 static bool isSetterLikeSelector(Selector sel) {
7944   if (sel.isUnarySelector()) return false;
7945 
7946   StringRef str = sel.getNameForSlot(0);
7947   while (!str.empty() && str.front() == '_') str = str.substr(1);
7948   if (str.startswith("set"))
7949     str = str.substr(3);
7950   else if (str.startswith("add")) {
7951     // Specially whitelist 'addOperationWithBlock:'.
7952     if (sel.getNumArgs() == 1 && str.startswith("addOperationWithBlock"))
7953       return false;
7954     str = str.substr(3);
7955   }
7956   else
7957     return false;
7958 
7959   if (str.empty()) return true;
7960   return !isLowercase(str.front());
7961 }
7962 
7963 /// Check a message send to see if it's likely to cause a retain cycle.
7964 void Sema::checkRetainCycles(ObjCMessageExpr *msg) {
7965   // Only check instance methods whose selector looks like a setter.
7966   if (!msg->isInstanceMessage() || !isSetterLikeSelector(msg->getSelector()))
7967     return;
7968 
7969   // Try to find a variable that the receiver is strongly owned by.
7970   RetainCycleOwner owner;
7971   if (msg->getReceiverKind() == ObjCMessageExpr::Instance) {
7972     if (!findRetainCycleOwner(*this, msg->getInstanceReceiver(), owner))
7973       return;
7974   } else {
7975     assert(msg->getReceiverKind() == ObjCMessageExpr::SuperInstance);
7976     owner.Variable = getCurMethodDecl()->getSelfDecl();
7977     owner.Loc = msg->getSuperLoc();
7978     owner.Range = msg->getSuperLoc();
7979   }
7980 
7981   // Check whether the receiver is captured by any of the arguments.
7982   for (unsigned i = 0, e = msg->getNumArgs(); i != e; ++i)
7983     if (Expr *capturer = findCapturingExpr(*this, msg->getArg(i), owner))
7984       return diagnoseRetainCycle(*this, capturer, owner);
7985 }
7986 
7987 /// Check a property assign to see if it's likely to cause a retain cycle.
7988 void Sema::checkRetainCycles(Expr *receiver, Expr *argument) {
7989   RetainCycleOwner owner;
7990   if (!findRetainCycleOwner(*this, receiver, owner))
7991     return;
7992 
7993   if (Expr *capturer = findCapturingExpr(*this, argument, owner))
7994     diagnoseRetainCycle(*this, capturer, owner);
7995 }
7996 
7997 void Sema::checkRetainCycles(VarDecl *Var, Expr *Init) {
7998   RetainCycleOwner Owner;
7999   if (!considerVariable(Var, /*DeclRefExpr=*/nullptr, Owner))
8000     return;
8001 
8002   // Because we don't have an expression for the variable, we have to set the
8003   // location explicitly here.
8004   Owner.Loc = Var->getLocation();
8005   Owner.Range = Var->getSourceRange();
8006 
8007   if (Expr *Capturer = findCapturingExpr(*this, Init, Owner))
8008     diagnoseRetainCycle(*this, Capturer, Owner);
8009 }
8010 
8011 static bool checkUnsafeAssignLiteral(Sema &S, SourceLocation Loc,
8012                                      Expr *RHS, bool isProperty) {
8013   // Check if RHS is an Objective-C object literal, which also can get
8014   // immediately zapped in a weak reference.  Note that we explicitly
8015   // allow ObjCStringLiterals, since those are designed to never really die.
8016   RHS = RHS->IgnoreParenImpCasts();
8017 
8018   // This enum needs to match with the 'select' in
8019   // warn_objc_arc_literal_assign (off-by-1).
8020   Sema::ObjCLiteralKind Kind = S.CheckLiteralKind(RHS);
8021   if (Kind == Sema::LK_String || Kind == Sema::LK_None)
8022     return false;
8023 
8024   S.Diag(Loc, diag::warn_arc_literal_assign)
8025     << (unsigned) Kind
8026     << (isProperty ? 0 : 1)
8027     << RHS->getSourceRange();
8028 
8029   return true;
8030 }
8031 
8032 static bool checkUnsafeAssignObject(Sema &S, SourceLocation Loc,
8033                                     Qualifiers::ObjCLifetime LT,
8034                                     Expr *RHS, bool isProperty) {
8035   // Strip off any implicit cast added to get to the one ARC-specific.
8036   while (ImplicitCastExpr *cast = dyn_cast<ImplicitCastExpr>(RHS)) {
8037     if (cast->getCastKind() == CK_ARCConsumeObject) {
8038       S.Diag(Loc, diag::warn_arc_retained_assign)
8039         << (LT == Qualifiers::OCL_ExplicitNone)
8040         << (isProperty ? 0 : 1)
8041         << RHS->getSourceRange();
8042       return true;
8043     }
8044     RHS = cast->getSubExpr();
8045   }
8046 
8047   if (LT == Qualifiers::OCL_Weak &&
8048       checkUnsafeAssignLiteral(S, Loc, RHS, isProperty))
8049     return true;
8050 
8051   return false;
8052 }
8053 
8054 bool Sema::checkUnsafeAssigns(SourceLocation Loc,
8055                               QualType LHS, Expr *RHS) {
8056   Qualifiers::ObjCLifetime LT = LHS.getObjCLifetime();
8057 
8058   if (LT != Qualifiers::OCL_Weak && LT != Qualifiers::OCL_ExplicitNone)
8059     return false;
8060 
8061   if (checkUnsafeAssignObject(*this, Loc, LT, RHS, false))
8062     return true;
8063 
8064   return false;
8065 }
8066 
8067 void Sema::checkUnsafeExprAssigns(SourceLocation Loc,
8068                               Expr *LHS, Expr *RHS) {
8069   QualType LHSType;
8070   // PropertyRef on LHS type need be directly obtained from
8071   // its declaration as it has a PseudoType.
8072   ObjCPropertyRefExpr *PRE
8073     = dyn_cast<ObjCPropertyRefExpr>(LHS->IgnoreParens());
8074   if (PRE && !PRE->isImplicitProperty()) {
8075     const ObjCPropertyDecl *PD = PRE->getExplicitProperty();
8076     if (PD)
8077       LHSType = PD->getType();
8078   }
8079 
8080   if (LHSType.isNull())
8081     LHSType = LHS->getType();
8082 
8083   Qualifiers::ObjCLifetime LT = LHSType.getObjCLifetime();
8084 
8085   if (LT == Qualifiers::OCL_Weak) {
8086     if (!Diags.isIgnored(diag::warn_arc_repeated_use_of_weak, Loc))
8087       getCurFunction()->markSafeWeakUse(LHS);
8088   }
8089 
8090   if (checkUnsafeAssigns(Loc, LHSType, RHS))
8091     return;
8092 
8093   // FIXME. Check for other life times.
8094   if (LT != Qualifiers::OCL_None)
8095     return;
8096 
8097   if (PRE) {
8098     if (PRE->isImplicitProperty())
8099       return;
8100     const ObjCPropertyDecl *PD = PRE->getExplicitProperty();
8101     if (!PD)
8102       return;
8103 
8104     unsigned Attributes = PD->getPropertyAttributes();
8105     if (Attributes & ObjCPropertyDecl::OBJC_PR_assign) {
8106       // when 'assign' attribute was not explicitly specified
8107       // by user, ignore it and rely on property type itself
8108       // for lifetime info.
8109       unsigned AsWrittenAttr = PD->getPropertyAttributesAsWritten();
8110       if (!(AsWrittenAttr & ObjCPropertyDecl::OBJC_PR_assign) &&
8111           LHSType->isObjCRetainableType())
8112         return;
8113 
8114       while (ImplicitCastExpr *cast = dyn_cast<ImplicitCastExpr>(RHS)) {
8115         if (cast->getCastKind() == CK_ARCConsumeObject) {
8116           Diag(Loc, diag::warn_arc_retained_property_assign)
8117           << RHS->getSourceRange();
8118           return;
8119         }
8120         RHS = cast->getSubExpr();
8121       }
8122     }
8123     else if (Attributes & ObjCPropertyDecl::OBJC_PR_weak) {
8124       if (checkUnsafeAssignObject(*this, Loc, Qualifiers::OCL_Weak, RHS, true))
8125         return;
8126     }
8127   }
8128 }
8129 
8130 //===--- CHECK: Empty statement body (-Wempty-body) ---------------------===//
8131 
8132 namespace {
8133 bool ShouldDiagnoseEmptyStmtBody(const SourceManager &SourceMgr,
8134                                  SourceLocation StmtLoc,
8135                                  const NullStmt *Body) {
8136   // Do not warn if the body is a macro that expands to nothing, e.g:
8137   //
8138   // #define CALL(x)
8139   // if (condition)
8140   //   CALL(0);
8141   //
8142   if (Body->hasLeadingEmptyMacro())
8143     return false;
8144 
8145   // Get line numbers of statement and body.
8146   bool StmtLineInvalid;
8147   unsigned StmtLine = SourceMgr.getSpellingLineNumber(StmtLoc,
8148                                                       &StmtLineInvalid);
8149   if (StmtLineInvalid)
8150     return false;
8151 
8152   bool BodyLineInvalid;
8153   unsigned BodyLine = SourceMgr.getSpellingLineNumber(Body->getSemiLoc(),
8154                                                       &BodyLineInvalid);
8155   if (BodyLineInvalid)
8156     return false;
8157 
8158   // Warn if null statement and body are on the same line.
8159   if (StmtLine != BodyLine)
8160     return false;
8161 
8162   return true;
8163 }
8164 } // Unnamed namespace
8165 
8166 void Sema::DiagnoseEmptyStmtBody(SourceLocation StmtLoc,
8167                                  const Stmt *Body,
8168                                  unsigned DiagID) {
8169   // Since this is a syntactic check, don't emit diagnostic for template
8170   // instantiations, this just adds noise.
8171   if (CurrentInstantiationScope)
8172     return;
8173 
8174   // The body should be a null statement.
8175   const NullStmt *NBody = dyn_cast<NullStmt>(Body);
8176   if (!NBody)
8177     return;
8178 
8179   // Do the usual checks.
8180   if (!ShouldDiagnoseEmptyStmtBody(SourceMgr, StmtLoc, NBody))
8181     return;
8182 
8183   Diag(NBody->getSemiLoc(), DiagID);
8184   Diag(NBody->getSemiLoc(), diag::note_empty_body_on_separate_line);
8185 }
8186 
8187 void Sema::DiagnoseEmptyLoopBody(const Stmt *S,
8188                                  const Stmt *PossibleBody) {
8189   assert(!CurrentInstantiationScope); // Ensured by caller
8190 
8191   SourceLocation StmtLoc;
8192   const Stmt *Body;
8193   unsigned DiagID;
8194   if (const ForStmt *FS = dyn_cast<ForStmt>(S)) {
8195     StmtLoc = FS->getRParenLoc();
8196     Body = FS->getBody();
8197     DiagID = diag::warn_empty_for_body;
8198   } else if (const WhileStmt *WS = dyn_cast<WhileStmt>(S)) {
8199     StmtLoc = WS->getCond()->getSourceRange().getEnd();
8200     Body = WS->getBody();
8201     DiagID = diag::warn_empty_while_body;
8202   } else
8203     return; // Neither `for' nor `while'.
8204 
8205   // The body should be a null statement.
8206   const NullStmt *NBody = dyn_cast<NullStmt>(Body);
8207   if (!NBody)
8208     return;
8209 
8210   // Skip expensive checks if diagnostic is disabled.
8211   if (Diags.isIgnored(DiagID, NBody->getSemiLoc()))
8212     return;
8213 
8214   // Do the usual checks.
8215   if (!ShouldDiagnoseEmptyStmtBody(SourceMgr, StmtLoc, NBody))
8216     return;
8217 
8218   // `for(...);' and `while(...);' are popular idioms, so in order to keep
8219   // noise level low, emit diagnostics only if for/while is followed by a
8220   // CompoundStmt, e.g.:
8221   //    for (int i = 0; i < n; i++);
8222   //    {
8223   //      a(i);
8224   //    }
8225   // or if for/while is followed by a statement with more indentation
8226   // than for/while itself:
8227   //    for (int i = 0; i < n; i++);
8228   //      a(i);
8229   bool ProbableTypo = isa<CompoundStmt>(PossibleBody);
8230   if (!ProbableTypo) {
8231     bool BodyColInvalid;
8232     unsigned BodyCol = SourceMgr.getPresumedColumnNumber(
8233                              PossibleBody->getLocStart(),
8234                              &BodyColInvalid);
8235     if (BodyColInvalid)
8236       return;
8237 
8238     bool StmtColInvalid;
8239     unsigned StmtCol = SourceMgr.getPresumedColumnNumber(
8240                              S->getLocStart(),
8241                              &StmtColInvalid);
8242     if (StmtColInvalid)
8243       return;
8244 
8245     if (BodyCol > StmtCol)
8246       ProbableTypo = true;
8247   }
8248 
8249   if (ProbableTypo) {
8250     Diag(NBody->getSemiLoc(), DiagID);
8251     Diag(NBody->getSemiLoc(), diag::note_empty_body_on_separate_line);
8252   }
8253 }
8254 
8255 //===--- Layout compatibility ----------------------------------------------//
8256 
8257 namespace {
8258 
8259 bool isLayoutCompatible(ASTContext &C, QualType T1, QualType T2);
8260 
8261 /// \brief Check if two enumeration types are layout-compatible.
8262 bool isLayoutCompatible(ASTContext &C, EnumDecl *ED1, EnumDecl *ED2) {
8263   // C++11 [dcl.enum] p8:
8264   // Two enumeration types are layout-compatible if they have the same
8265   // underlying type.
8266   return ED1->isComplete() && ED2->isComplete() &&
8267          C.hasSameType(ED1->getIntegerType(), ED2->getIntegerType());
8268 }
8269 
8270 /// \brief Check if two fields are layout-compatible.
8271 bool isLayoutCompatible(ASTContext &C, FieldDecl *Field1, FieldDecl *Field2) {
8272   if (!isLayoutCompatible(C, Field1->getType(), Field2->getType()))
8273     return false;
8274 
8275   if (Field1->isBitField() != Field2->isBitField())
8276     return false;
8277 
8278   if (Field1->isBitField()) {
8279     // Make sure that the bit-fields are the same length.
8280     unsigned Bits1 = Field1->getBitWidthValue(C);
8281     unsigned Bits2 = Field2->getBitWidthValue(C);
8282 
8283     if (Bits1 != Bits2)
8284       return false;
8285   }
8286 
8287   return true;
8288 }
8289 
8290 /// \brief Check if two standard-layout structs are layout-compatible.
8291 /// (C++11 [class.mem] p17)
8292 bool isLayoutCompatibleStruct(ASTContext &C,
8293                               RecordDecl *RD1,
8294                               RecordDecl *RD2) {
8295   // If both records are C++ classes, check that base classes match.
8296   if (const CXXRecordDecl *D1CXX = dyn_cast<CXXRecordDecl>(RD1)) {
8297     // If one of records is a CXXRecordDecl we are in C++ mode,
8298     // thus the other one is a CXXRecordDecl, too.
8299     const CXXRecordDecl *D2CXX = cast<CXXRecordDecl>(RD2);
8300     // Check number of base classes.
8301     if (D1CXX->getNumBases() != D2CXX->getNumBases())
8302       return false;
8303 
8304     // Check the base classes.
8305     for (CXXRecordDecl::base_class_const_iterator
8306                Base1 = D1CXX->bases_begin(),
8307            BaseEnd1 = D1CXX->bases_end(),
8308               Base2 = D2CXX->bases_begin();
8309          Base1 != BaseEnd1;
8310          ++Base1, ++Base2) {
8311       if (!isLayoutCompatible(C, Base1->getType(), Base2->getType()))
8312         return false;
8313     }
8314   } else if (const CXXRecordDecl *D2CXX = dyn_cast<CXXRecordDecl>(RD2)) {
8315     // If only RD2 is a C++ class, it should have zero base classes.
8316     if (D2CXX->getNumBases() > 0)
8317       return false;
8318   }
8319 
8320   // Check the fields.
8321   RecordDecl::field_iterator Field2 = RD2->field_begin(),
8322                              Field2End = RD2->field_end(),
8323                              Field1 = RD1->field_begin(),
8324                              Field1End = RD1->field_end();
8325   for ( ; Field1 != Field1End && Field2 != Field2End; ++Field1, ++Field2) {
8326     if (!isLayoutCompatible(C, *Field1, *Field2))
8327       return false;
8328   }
8329   if (Field1 != Field1End || Field2 != Field2End)
8330     return false;
8331 
8332   return true;
8333 }
8334 
8335 /// \brief Check if two standard-layout unions are layout-compatible.
8336 /// (C++11 [class.mem] p18)
8337 bool isLayoutCompatibleUnion(ASTContext &C,
8338                              RecordDecl *RD1,
8339                              RecordDecl *RD2) {
8340   llvm::SmallPtrSet<FieldDecl *, 8> UnmatchedFields;
8341   for (auto *Field2 : RD2->fields())
8342     UnmatchedFields.insert(Field2);
8343 
8344   for (auto *Field1 : RD1->fields()) {
8345     llvm::SmallPtrSet<FieldDecl *, 8>::iterator
8346         I = UnmatchedFields.begin(),
8347         E = UnmatchedFields.end();
8348 
8349     for ( ; I != E; ++I) {
8350       if (isLayoutCompatible(C, Field1, *I)) {
8351         bool Result = UnmatchedFields.erase(*I);
8352         (void) Result;
8353         assert(Result);
8354         break;
8355       }
8356     }
8357     if (I == E)
8358       return false;
8359   }
8360 
8361   return UnmatchedFields.empty();
8362 }
8363 
8364 bool isLayoutCompatible(ASTContext &C, RecordDecl *RD1, RecordDecl *RD2) {
8365   if (RD1->isUnion() != RD2->isUnion())
8366     return false;
8367 
8368   if (RD1->isUnion())
8369     return isLayoutCompatibleUnion(C, RD1, RD2);
8370   else
8371     return isLayoutCompatibleStruct(C, RD1, RD2);
8372 }
8373 
8374 /// \brief Check if two types are layout-compatible in C++11 sense.
8375 bool isLayoutCompatible(ASTContext &C, QualType T1, QualType T2) {
8376   if (T1.isNull() || T2.isNull())
8377     return false;
8378 
8379   // C++11 [basic.types] p11:
8380   // If two types T1 and T2 are the same type, then T1 and T2 are
8381   // layout-compatible types.
8382   if (C.hasSameType(T1, T2))
8383     return true;
8384 
8385   T1 = T1.getCanonicalType().getUnqualifiedType();
8386   T2 = T2.getCanonicalType().getUnqualifiedType();
8387 
8388   const Type::TypeClass TC1 = T1->getTypeClass();
8389   const Type::TypeClass TC2 = T2->getTypeClass();
8390 
8391   if (TC1 != TC2)
8392     return false;
8393 
8394   if (TC1 == Type::Enum) {
8395     return isLayoutCompatible(C,
8396                               cast<EnumType>(T1)->getDecl(),
8397                               cast<EnumType>(T2)->getDecl());
8398   } else if (TC1 == Type::Record) {
8399     if (!T1->isStandardLayoutType() || !T2->isStandardLayoutType())
8400       return false;
8401 
8402     return isLayoutCompatible(C,
8403                               cast<RecordType>(T1)->getDecl(),
8404                               cast<RecordType>(T2)->getDecl());
8405   }
8406 
8407   return false;
8408 }
8409 }
8410 
8411 //===--- CHECK: pointer_with_type_tag attribute: datatypes should match ----//
8412 
8413 namespace {
8414 /// \brief Given a type tag expression find the type tag itself.
8415 ///
8416 /// \param TypeExpr Type tag expression, as it appears in user's code.
8417 ///
8418 /// \param VD Declaration of an identifier that appears in a type tag.
8419 ///
8420 /// \param MagicValue Type tag magic value.
8421 bool FindTypeTagExpr(const Expr *TypeExpr, const ASTContext &Ctx,
8422                      const ValueDecl **VD, uint64_t *MagicValue) {
8423   while(true) {
8424     if (!TypeExpr)
8425       return false;
8426 
8427     TypeExpr = TypeExpr->IgnoreParenImpCasts()->IgnoreParenCasts();
8428 
8429     switch (TypeExpr->getStmtClass()) {
8430     case Stmt::UnaryOperatorClass: {
8431       const UnaryOperator *UO = cast<UnaryOperator>(TypeExpr);
8432       if (UO->getOpcode() == UO_AddrOf || UO->getOpcode() == UO_Deref) {
8433         TypeExpr = UO->getSubExpr();
8434         continue;
8435       }
8436       return false;
8437     }
8438 
8439     case Stmt::DeclRefExprClass: {
8440       const DeclRefExpr *DRE = cast<DeclRefExpr>(TypeExpr);
8441       *VD = DRE->getDecl();
8442       return true;
8443     }
8444 
8445     case Stmt::IntegerLiteralClass: {
8446       const IntegerLiteral *IL = cast<IntegerLiteral>(TypeExpr);
8447       llvm::APInt MagicValueAPInt = IL->getValue();
8448       if (MagicValueAPInt.getActiveBits() <= 64) {
8449         *MagicValue = MagicValueAPInt.getZExtValue();
8450         return true;
8451       } else
8452         return false;
8453     }
8454 
8455     case Stmt::BinaryConditionalOperatorClass:
8456     case Stmt::ConditionalOperatorClass: {
8457       const AbstractConditionalOperator *ACO =
8458           cast<AbstractConditionalOperator>(TypeExpr);
8459       bool Result;
8460       if (ACO->getCond()->EvaluateAsBooleanCondition(Result, Ctx)) {
8461         if (Result)
8462           TypeExpr = ACO->getTrueExpr();
8463         else
8464           TypeExpr = ACO->getFalseExpr();
8465         continue;
8466       }
8467       return false;
8468     }
8469 
8470     case Stmt::BinaryOperatorClass: {
8471       const BinaryOperator *BO = cast<BinaryOperator>(TypeExpr);
8472       if (BO->getOpcode() == BO_Comma) {
8473         TypeExpr = BO->getRHS();
8474         continue;
8475       }
8476       return false;
8477     }
8478 
8479     default:
8480       return false;
8481     }
8482   }
8483 }
8484 
8485 /// \brief Retrieve the C type corresponding to type tag TypeExpr.
8486 ///
8487 /// \param TypeExpr Expression that specifies a type tag.
8488 ///
8489 /// \param MagicValues Registered magic values.
8490 ///
8491 /// \param FoundWrongKind Set to true if a type tag was found, but of a wrong
8492 ///        kind.
8493 ///
8494 /// \param TypeInfo Information about the corresponding C type.
8495 ///
8496 /// \returns true if the corresponding C type was found.
8497 bool GetMatchingCType(
8498         const IdentifierInfo *ArgumentKind,
8499         const Expr *TypeExpr, const ASTContext &Ctx,
8500         const llvm::DenseMap<Sema::TypeTagMagicValue,
8501                              Sema::TypeTagData> *MagicValues,
8502         bool &FoundWrongKind,
8503         Sema::TypeTagData &TypeInfo) {
8504   FoundWrongKind = false;
8505 
8506   // Variable declaration that has type_tag_for_datatype attribute.
8507   const ValueDecl *VD = nullptr;
8508 
8509   uint64_t MagicValue;
8510 
8511   if (!FindTypeTagExpr(TypeExpr, Ctx, &VD, &MagicValue))
8512     return false;
8513 
8514   if (VD) {
8515     if (TypeTagForDatatypeAttr *I = VD->getAttr<TypeTagForDatatypeAttr>()) {
8516       if (I->getArgumentKind() != ArgumentKind) {
8517         FoundWrongKind = true;
8518         return false;
8519       }
8520       TypeInfo.Type = I->getMatchingCType();
8521       TypeInfo.LayoutCompatible = I->getLayoutCompatible();
8522       TypeInfo.MustBeNull = I->getMustBeNull();
8523       return true;
8524     }
8525     return false;
8526   }
8527 
8528   if (!MagicValues)
8529     return false;
8530 
8531   llvm::DenseMap<Sema::TypeTagMagicValue,
8532                  Sema::TypeTagData>::const_iterator I =
8533       MagicValues->find(std::make_pair(ArgumentKind, MagicValue));
8534   if (I == MagicValues->end())
8535     return false;
8536 
8537   TypeInfo = I->second;
8538   return true;
8539 }
8540 } // unnamed namespace
8541 
8542 void Sema::RegisterTypeTagForDatatype(const IdentifierInfo *ArgumentKind,
8543                                       uint64_t MagicValue, QualType Type,
8544                                       bool LayoutCompatible,
8545                                       bool MustBeNull) {
8546   if (!TypeTagForDatatypeMagicValues)
8547     TypeTagForDatatypeMagicValues.reset(
8548         new llvm::DenseMap<TypeTagMagicValue, TypeTagData>);
8549 
8550   TypeTagMagicValue Magic(ArgumentKind, MagicValue);
8551   (*TypeTagForDatatypeMagicValues)[Magic] =
8552       TypeTagData(Type, LayoutCompatible, MustBeNull);
8553 }
8554 
8555 namespace {
8556 bool IsSameCharType(QualType T1, QualType T2) {
8557   const BuiltinType *BT1 = T1->getAs<BuiltinType>();
8558   if (!BT1)
8559     return false;
8560 
8561   const BuiltinType *BT2 = T2->getAs<BuiltinType>();
8562   if (!BT2)
8563     return false;
8564 
8565   BuiltinType::Kind T1Kind = BT1->getKind();
8566   BuiltinType::Kind T2Kind = BT2->getKind();
8567 
8568   return (T1Kind == BuiltinType::SChar  && T2Kind == BuiltinType::Char_S) ||
8569          (T1Kind == BuiltinType::UChar  && T2Kind == BuiltinType::Char_U) ||
8570          (T1Kind == BuiltinType::Char_U && T2Kind == BuiltinType::UChar) ||
8571          (T1Kind == BuiltinType::Char_S && T2Kind == BuiltinType::SChar);
8572 }
8573 } // unnamed namespace
8574 
8575 void Sema::CheckArgumentWithTypeTag(const ArgumentWithTypeTagAttr *Attr,
8576                                     const Expr * const *ExprArgs) {
8577   const IdentifierInfo *ArgumentKind = Attr->getArgumentKind();
8578   bool IsPointerAttr = Attr->getIsPointer();
8579 
8580   const Expr *TypeTagExpr = ExprArgs[Attr->getTypeTagIdx()];
8581   bool FoundWrongKind;
8582   TypeTagData TypeInfo;
8583   if (!GetMatchingCType(ArgumentKind, TypeTagExpr, Context,
8584                         TypeTagForDatatypeMagicValues.get(),
8585                         FoundWrongKind, TypeInfo)) {
8586     if (FoundWrongKind)
8587       Diag(TypeTagExpr->getExprLoc(),
8588            diag::warn_type_tag_for_datatype_wrong_kind)
8589         << TypeTagExpr->getSourceRange();
8590     return;
8591   }
8592 
8593   const Expr *ArgumentExpr = ExprArgs[Attr->getArgumentIdx()];
8594   if (IsPointerAttr) {
8595     // Skip implicit cast of pointer to `void *' (as a function argument).
8596     if (const ImplicitCastExpr *ICE = dyn_cast<ImplicitCastExpr>(ArgumentExpr))
8597       if (ICE->getType()->isVoidPointerType() &&
8598           ICE->getCastKind() == CK_BitCast)
8599         ArgumentExpr = ICE->getSubExpr();
8600   }
8601   QualType ArgumentType = ArgumentExpr->getType();
8602 
8603   // Passing a `void*' pointer shouldn't trigger a warning.
8604   if (IsPointerAttr && ArgumentType->isVoidPointerType())
8605     return;
8606 
8607   if (TypeInfo.MustBeNull) {
8608     // Type tag with matching void type requires a null pointer.
8609     if (!ArgumentExpr->isNullPointerConstant(Context,
8610                                              Expr::NPC_ValueDependentIsNotNull)) {
8611       Diag(ArgumentExpr->getExprLoc(),
8612            diag::warn_type_safety_null_pointer_required)
8613           << ArgumentKind->getName()
8614           << ArgumentExpr->getSourceRange()
8615           << TypeTagExpr->getSourceRange();
8616     }
8617     return;
8618   }
8619 
8620   QualType RequiredType = TypeInfo.Type;
8621   if (IsPointerAttr)
8622     RequiredType = Context.getPointerType(RequiredType);
8623 
8624   bool mismatch = false;
8625   if (!TypeInfo.LayoutCompatible) {
8626     mismatch = !Context.hasSameType(ArgumentType, RequiredType);
8627 
8628     // C++11 [basic.fundamental] p1:
8629     // Plain char, signed char, and unsigned char are three distinct types.
8630     //
8631     // But we treat plain `char' as equivalent to `signed char' or `unsigned
8632     // char' depending on the current char signedness mode.
8633     if (mismatch)
8634       if ((IsPointerAttr && IsSameCharType(ArgumentType->getPointeeType(),
8635                                            RequiredType->getPointeeType())) ||
8636           (!IsPointerAttr && IsSameCharType(ArgumentType, RequiredType)))
8637         mismatch = false;
8638   } else
8639     if (IsPointerAttr)
8640       mismatch = !isLayoutCompatible(Context,
8641                                      ArgumentType->getPointeeType(),
8642                                      RequiredType->getPointeeType());
8643     else
8644       mismatch = !isLayoutCompatible(Context, ArgumentType, RequiredType);
8645 
8646   if (mismatch)
8647     Diag(ArgumentExpr->getExprLoc(), diag::warn_type_safety_type_mismatch)
8648         << ArgumentType << ArgumentKind
8649         << TypeInfo.LayoutCompatible << RequiredType
8650         << ArgumentExpr->getSourceRange()
8651         << TypeTagExpr->getSourceRange();
8652 }
8653 
8654