blob: d12f70721835938930868f8da794f407831984a2 [file] [log] [blame]
Chris Lattner59907c42007-08-10 20:18:51 +00001//===--- SemaChecking.cpp - Extra Semantic Checking -----------------------===//
2//
3// The LLVM Compiler Infrastructure
4//
Chris Lattner0bc735f2007-12-29 19:59:25 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Chris Lattner59907c42007-08-10 20:18:51 +00007//
8//===----------------------------------------------------------------------===//
9//
Mike Stump1eb44332009-09-09 15:08:12 +000010// This file implements extra semantic analysis beyond what is enforced
Chris Lattner59907c42007-08-10 20:18:51 +000011// by the C type system.
12//
13//===----------------------------------------------------------------------===//
14
John McCall5f8d6042011-08-27 01:09:30 +000015#include "clang/Sema/Initialization.h"
Douglas Gregore737f502010-08-12 20:07:10 +000016#include "clang/Sema/Sema.h"
John McCall2d887082010-08-25 22:03:47 +000017#include "clang/Sema/SemaInternal.h"
Eli Friedman276b0612011-10-11 02:20:01 +000018#include "clang/Sema/Initialization.h"
John McCall781472f2010-08-25 08:40:02 +000019#include "clang/Sema/ScopeInfo.h"
Ted Kremenek826a3452010-07-16 02:11:22 +000020#include "clang/Analysis/Analyses/FormatString.h"
Chris Lattner59907c42007-08-10 20:18:51 +000021#include "clang/AST/ASTContext.h"
Ken Dyck199c3d62010-01-11 17:06:35 +000022#include "clang/AST/CharUnits.h"
John McCall384aff82010-08-25 07:42:41 +000023#include "clang/AST/DeclCXX.h"
Daniel Dunbarc4a1dea2008-08-11 05:35:13 +000024#include "clang/AST/DeclObjC.h"
Ted Kremenek23245122007-08-20 16:18:38 +000025#include "clang/AST/ExprCXX.h"
Ted Kremenek7ff22b22008-06-16 18:00:42 +000026#include "clang/AST/ExprObjC.h"
John McCallf85e1932011-06-15 23:02:42 +000027#include "clang/AST/EvaluatedExprVisitor.h"
Mike Stumpf8c49212010-01-21 03:59:47 +000028#include "clang/AST/DeclObjC.h"
29#include "clang/AST/StmtCXX.h"
30#include "clang/AST/StmtObjC.h"
Chris Lattner59907c42007-08-10 20:18:51 +000031#include "clang/Lex/Preprocessor.h"
Mike Stumpf8c49212010-01-21 03:59:47 +000032#include "llvm/ADT/BitVector.h"
Benjamin Kramer8fe83e12012-02-04 13:45:25 +000033#include "llvm/ADT/SmallString.h"
Mike Stumpf8c49212010-01-21 03:59:47 +000034#include "llvm/ADT/STLExtras.h"
Tom Care3bfc5f42010-06-09 04:11:11 +000035#include "llvm/Support/raw_ostream.h"
Eric Christopher691ebc32010-04-17 02:26:23 +000036#include "clang/Basic/TargetBuiltins.h"
Nate Begeman26a31422010-06-08 02:47:44 +000037#include "clang/Basic/TargetInfo.h"
Fariborz Jahanian7da71022010-09-07 19:38:13 +000038#include "clang/Basic/ConvertUTF.h"
Zhongxing Xua1f3dba2009-05-20 01:55:10 +000039#include <limits>
Chris Lattner59907c42007-08-10 20:18:51 +000040using namespace clang;
John McCall781472f2010-08-25 08:40:02 +000041using namespace sema;
Chris Lattner59907c42007-08-10 20:18:51 +000042
Chris Lattner60800082009-02-18 17:49:48 +000043SourceLocation Sema::getLocationOfStringLiteralByte(const StringLiteral *SL,
44 unsigned ByteNo) const {
Chris Lattner08f92e32010-11-17 07:37:15 +000045 return SL->getLocationOfByte(ByteNo, PP.getSourceManager(),
David Blaikie4e4d0842012-03-11 07:00:24 +000046 PP.getLangOpts(), PP.getTargetInfo());
Chris Lattner60800082009-02-18 17:49:48 +000047}
48
John McCall8e10f3b2011-02-26 05:39:39 +000049/// Checks that a call expression's argument count is the desired number.
50/// This is useful when doing custom type-checking. Returns true on error.
51static bool checkArgCount(Sema &S, CallExpr *call, unsigned desiredArgCount) {
52 unsigned argCount = call->getNumArgs();
53 if (argCount == desiredArgCount) return false;
54
55 if (argCount < desiredArgCount)
56 return S.Diag(call->getLocEnd(), diag::err_typecheck_call_too_few_args)
57 << 0 /*function call*/ << desiredArgCount << argCount
58 << call->getSourceRange();
59
60 // Highlight all the excess arguments.
61 SourceRange range(call->getArg(desiredArgCount)->getLocStart(),
62 call->getArg(argCount - 1)->getLocEnd());
63
64 return S.Diag(range.getBegin(), diag::err_typecheck_call_too_many_args)
65 << 0 /*function call*/ << desiredArgCount << argCount
66 << call->getArg(1)->getSourceRange();
67}
68
Julien Lerougee5939212012-04-28 17:39:16 +000069/// Check that the first argument to __builtin_annotation is an integer
70/// and the second argument is a non-wide string literal.
71static bool SemaBuiltinAnnotation(Sema &S, CallExpr *TheCall) {
72 if (checkArgCount(S, TheCall, 2))
73 return true;
74
75 // First argument should be an integer.
76 Expr *ValArg = TheCall->getArg(0);
77 QualType Ty = ValArg->getType();
78 if (!Ty->isIntegerType()) {
79 S.Diag(ValArg->getLocStart(), diag::err_builtin_annotation_first_arg)
80 << ValArg->getSourceRange();
Julien Lerouge77f68bb2011-09-09 22:41:49 +000081 return true;
82 }
Julien Lerougee5939212012-04-28 17:39:16 +000083
84 // Second argument should be a constant string.
85 Expr *StrArg = TheCall->getArg(1)->IgnoreParenCasts();
86 StringLiteral *Literal = dyn_cast<StringLiteral>(StrArg);
87 if (!Literal || !Literal->isAscii()) {
88 S.Diag(StrArg->getLocStart(), diag::err_builtin_annotation_second_arg)
89 << StrArg->getSourceRange();
90 return true;
91 }
92
93 TheCall->setType(Ty);
Julien Lerouge77f68bb2011-09-09 22:41:49 +000094 return false;
95}
96
John McCall60d7b3a2010-08-24 06:29:42 +000097ExprResult
Anders Carlssond406bf02009-08-16 01:56:34 +000098Sema::CheckBuiltinFunctionCall(unsigned BuiltinID, CallExpr *TheCall) {
John McCall60d7b3a2010-08-24 06:29:42 +000099 ExprResult TheCallResult(Owned(TheCall));
Douglas Gregor2def4832008-11-17 20:34:05 +0000100
Chris Lattner946928f2010-10-01 23:23:24 +0000101 // Find out if any arguments are required to be integer constant expressions.
102 unsigned ICEArguments = 0;
103 ASTContext::GetBuiltinTypeError Error;
104 Context.GetBuiltinType(BuiltinID, Error, &ICEArguments);
105 if (Error != ASTContext::GE_None)
106 ICEArguments = 0; // Don't diagnose previously diagnosed errors.
107
108 // If any arguments are required to be ICE's, check and diagnose.
109 for (unsigned ArgNo = 0; ICEArguments != 0; ++ArgNo) {
110 // Skip arguments not required to be ICE's.
111 if ((ICEArguments & (1 << ArgNo)) == 0) continue;
112
113 llvm::APSInt Result;
114 if (SemaBuiltinConstantArg(TheCall, ArgNo, Result))
115 return true;
116 ICEArguments &= ~(1 << ArgNo);
117 }
118
Anders Carlssond406bf02009-08-16 01:56:34 +0000119 switch (BuiltinID) {
Chris Lattner30ce3442007-12-19 23:59:04 +0000120 case Builtin::BI__builtin___CFStringMakeConstantString:
Chris Lattner925e60d2007-12-28 05:29:59 +0000121 assert(TheCall->getNumArgs() == 1 &&
Chris Lattner1b9a0792007-12-20 00:26:33 +0000122 "Wrong # arguments to builtin CFStringMakeConstantString");
Chris Lattner69039812009-02-18 06:01:06 +0000123 if (CheckObjCString(TheCall->getArg(0)))
Sebastian Redl0eb23302009-01-19 00:08:26 +0000124 return ExprError();
Anders Carlssond406bf02009-08-16 01:56:34 +0000125 break;
Ted Kremenek49ff7a12008-07-09 17:58:53 +0000126 case Builtin::BI__builtin_stdarg_start:
Chris Lattner30ce3442007-12-19 23:59:04 +0000127 case Builtin::BI__builtin_va_start:
Sebastian Redl0eb23302009-01-19 00:08:26 +0000128 if (SemaBuiltinVAStart(TheCall))
129 return ExprError();
Anders Carlssond406bf02009-08-16 01:56:34 +0000130 break;
Chris Lattner1b9a0792007-12-20 00:26:33 +0000131 case Builtin::BI__builtin_isgreater:
132 case Builtin::BI__builtin_isgreaterequal:
133 case Builtin::BI__builtin_isless:
134 case Builtin::BI__builtin_islessequal:
135 case Builtin::BI__builtin_islessgreater:
136 case Builtin::BI__builtin_isunordered:
Sebastian Redl0eb23302009-01-19 00:08:26 +0000137 if (SemaBuiltinUnorderedCompare(TheCall))
138 return ExprError();
Anders Carlssond406bf02009-08-16 01:56:34 +0000139 break;
Benjamin Kramere771a7a2010-02-15 22:42:31 +0000140 case Builtin::BI__builtin_fpclassify:
141 if (SemaBuiltinFPClassification(TheCall, 6))
142 return ExprError();
143 break;
Eli Friedman9ac6f622009-08-31 20:06:00 +0000144 case Builtin::BI__builtin_isfinite:
145 case Builtin::BI__builtin_isinf:
146 case Builtin::BI__builtin_isinf_sign:
147 case Builtin::BI__builtin_isnan:
148 case Builtin::BI__builtin_isnormal:
Benjamin Kramer3b1e26b2010-02-16 10:07:31 +0000149 if (SemaBuiltinFPClassification(TheCall, 1))
Eli Friedman9ac6f622009-08-31 20:06:00 +0000150 return ExprError();
151 break;
Eli Friedmand38617c2008-05-14 19:38:39 +0000152 case Builtin::BI__builtin_shufflevector:
Sebastian Redl0eb23302009-01-19 00:08:26 +0000153 return SemaBuiltinShuffleVector(TheCall);
154 // TheCall will be freed by the smart pointer here, but that's fine, since
155 // SemaBuiltinShuffleVector guts it, but then doesn't release it.
Daniel Dunbar4493f792008-07-21 22:59:13 +0000156 case Builtin::BI__builtin_prefetch:
Sebastian Redl0eb23302009-01-19 00:08:26 +0000157 if (SemaBuiltinPrefetch(TheCall))
158 return ExprError();
Anders Carlssond406bf02009-08-16 01:56:34 +0000159 break;
Daniel Dunbard5f8a4f2008-09-03 21:13:56 +0000160 case Builtin::BI__builtin_object_size:
Sebastian Redl0eb23302009-01-19 00:08:26 +0000161 if (SemaBuiltinObjectSize(TheCall))
162 return ExprError();
Anders Carlssond406bf02009-08-16 01:56:34 +0000163 break;
Eli Friedmand875fed2009-05-03 04:46:36 +0000164 case Builtin::BI__builtin_longjmp:
165 if (SemaBuiltinLongjmp(TheCall))
166 return ExprError();
Anders Carlssond406bf02009-08-16 01:56:34 +0000167 break;
John McCall8e10f3b2011-02-26 05:39:39 +0000168
169 case Builtin::BI__builtin_classify_type:
170 if (checkArgCount(*this, TheCall, 1)) return true;
171 TheCall->setType(Context.IntTy);
172 break;
Chris Lattner75c29a02010-10-12 17:47:42 +0000173 case Builtin::BI__builtin_constant_p:
John McCall8e10f3b2011-02-26 05:39:39 +0000174 if (checkArgCount(*this, TheCall, 1)) return true;
175 TheCall->setType(Context.IntTy);
Chris Lattner75c29a02010-10-12 17:47:42 +0000176 break;
Chris Lattner5caa3702009-05-08 06:58:22 +0000177 case Builtin::BI__sync_fetch_and_add:
Douglas Gregora9766412011-11-28 16:30:08 +0000178 case Builtin::BI__sync_fetch_and_add_1:
179 case Builtin::BI__sync_fetch_and_add_2:
180 case Builtin::BI__sync_fetch_and_add_4:
181 case Builtin::BI__sync_fetch_and_add_8:
182 case Builtin::BI__sync_fetch_and_add_16:
Chris Lattner5caa3702009-05-08 06:58:22 +0000183 case Builtin::BI__sync_fetch_and_sub:
Douglas Gregora9766412011-11-28 16:30:08 +0000184 case Builtin::BI__sync_fetch_and_sub_1:
185 case Builtin::BI__sync_fetch_and_sub_2:
186 case Builtin::BI__sync_fetch_and_sub_4:
187 case Builtin::BI__sync_fetch_and_sub_8:
188 case Builtin::BI__sync_fetch_and_sub_16:
Chris Lattner5caa3702009-05-08 06:58:22 +0000189 case Builtin::BI__sync_fetch_and_or:
Douglas Gregora9766412011-11-28 16:30:08 +0000190 case Builtin::BI__sync_fetch_and_or_1:
191 case Builtin::BI__sync_fetch_and_or_2:
192 case Builtin::BI__sync_fetch_and_or_4:
193 case Builtin::BI__sync_fetch_and_or_8:
194 case Builtin::BI__sync_fetch_and_or_16:
Chris Lattner5caa3702009-05-08 06:58:22 +0000195 case Builtin::BI__sync_fetch_and_and:
Douglas Gregora9766412011-11-28 16:30:08 +0000196 case Builtin::BI__sync_fetch_and_and_1:
197 case Builtin::BI__sync_fetch_and_and_2:
198 case Builtin::BI__sync_fetch_and_and_4:
199 case Builtin::BI__sync_fetch_and_and_8:
200 case Builtin::BI__sync_fetch_and_and_16:
Chris Lattner5caa3702009-05-08 06:58:22 +0000201 case Builtin::BI__sync_fetch_and_xor:
Douglas Gregora9766412011-11-28 16:30:08 +0000202 case Builtin::BI__sync_fetch_and_xor_1:
203 case Builtin::BI__sync_fetch_and_xor_2:
204 case Builtin::BI__sync_fetch_and_xor_4:
205 case Builtin::BI__sync_fetch_and_xor_8:
206 case Builtin::BI__sync_fetch_and_xor_16:
Chris Lattner5caa3702009-05-08 06:58:22 +0000207 case Builtin::BI__sync_add_and_fetch:
Douglas Gregora9766412011-11-28 16:30:08 +0000208 case Builtin::BI__sync_add_and_fetch_1:
209 case Builtin::BI__sync_add_and_fetch_2:
210 case Builtin::BI__sync_add_and_fetch_4:
211 case Builtin::BI__sync_add_and_fetch_8:
212 case Builtin::BI__sync_add_and_fetch_16:
Chris Lattner5caa3702009-05-08 06:58:22 +0000213 case Builtin::BI__sync_sub_and_fetch:
Douglas Gregora9766412011-11-28 16:30:08 +0000214 case Builtin::BI__sync_sub_and_fetch_1:
215 case Builtin::BI__sync_sub_and_fetch_2:
216 case Builtin::BI__sync_sub_and_fetch_4:
217 case Builtin::BI__sync_sub_and_fetch_8:
218 case Builtin::BI__sync_sub_and_fetch_16:
Chris Lattner5caa3702009-05-08 06:58:22 +0000219 case Builtin::BI__sync_and_and_fetch:
Douglas Gregora9766412011-11-28 16:30:08 +0000220 case Builtin::BI__sync_and_and_fetch_1:
221 case Builtin::BI__sync_and_and_fetch_2:
222 case Builtin::BI__sync_and_and_fetch_4:
223 case Builtin::BI__sync_and_and_fetch_8:
224 case Builtin::BI__sync_and_and_fetch_16:
Chris Lattner5caa3702009-05-08 06:58:22 +0000225 case Builtin::BI__sync_or_and_fetch:
Douglas Gregora9766412011-11-28 16:30:08 +0000226 case Builtin::BI__sync_or_and_fetch_1:
227 case Builtin::BI__sync_or_and_fetch_2:
228 case Builtin::BI__sync_or_and_fetch_4:
229 case Builtin::BI__sync_or_and_fetch_8:
230 case Builtin::BI__sync_or_and_fetch_16:
Chris Lattner5caa3702009-05-08 06:58:22 +0000231 case Builtin::BI__sync_xor_and_fetch:
Douglas Gregora9766412011-11-28 16:30:08 +0000232 case Builtin::BI__sync_xor_and_fetch_1:
233 case Builtin::BI__sync_xor_and_fetch_2:
234 case Builtin::BI__sync_xor_and_fetch_4:
235 case Builtin::BI__sync_xor_and_fetch_8:
236 case Builtin::BI__sync_xor_and_fetch_16:
Chris Lattner5caa3702009-05-08 06:58:22 +0000237 case Builtin::BI__sync_val_compare_and_swap:
Douglas Gregora9766412011-11-28 16:30:08 +0000238 case Builtin::BI__sync_val_compare_and_swap_1:
239 case Builtin::BI__sync_val_compare_and_swap_2:
240 case Builtin::BI__sync_val_compare_and_swap_4:
241 case Builtin::BI__sync_val_compare_and_swap_8:
242 case Builtin::BI__sync_val_compare_and_swap_16:
Chris Lattner5caa3702009-05-08 06:58:22 +0000243 case Builtin::BI__sync_bool_compare_and_swap:
Douglas Gregora9766412011-11-28 16:30:08 +0000244 case Builtin::BI__sync_bool_compare_and_swap_1:
245 case Builtin::BI__sync_bool_compare_and_swap_2:
246 case Builtin::BI__sync_bool_compare_and_swap_4:
247 case Builtin::BI__sync_bool_compare_and_swap_8:
248 case Builtin::BI__sync_bool_compare_and_swap_16:
Chris Lattner5caa3702009-05-08 06:58:22 +0000249 case Builtin::BI__sync_lock_test_and_set:
Douglas Gregora9766412011-11-28 16:30:08 +0000250 case Builtin::BI__sync_lock_test_and_set_1:
251 case Builtin::BI__sync_lock_test_and_set_2:
252 case Builtin::BI__sync_lock_test_and_set_4:
253 case Builtin::BI__sync_lock_test_and_set_8:
254 case Builtin::BI__sync_lock_test_and_set_16:
Chris Lattner5caa3702009-05-08 06:58:22 +0000255 case Builtin::BI__sync_lock_release:
Douglas Gregora9766412011-11-28 16:30:08 +0000256 case Builtin::BI__sync_lock_release_1:
257 case Builtin::BI__sync_lock_release_2:
258 case Builtin::BI__sync_lock_release_4:
259 case Builtin::BI__sync_lock_release_8:
260 case Builtin::BI__sync_lock_release_16:
Chris Lattner23aa9c82011-04-09 03:57:26 +0000261 case Builtin::BI__sync_swap:
Douglas Gregora9766412011-11-28 16:30:08 +0000262 case Builtin::BI__sync_swap_1:
263 case Builtin::BI__sync_swap_2:
264 case Builtin::BI__sync_swap_4:
265 case Builtin::BI__sync_swap_8:
266 case Builtin::BI__sync_swap_16:
Chandler Carruthd2014572010-07-09 18:59:35 +0000267 return SemaBuiltinAtomicOverloaded(move(TheCallResult));
Richard Smithff34d402012-04-12 05:08:17 +0000268#define BUILTIN(ID, TYPE, ATTRS)
269#define ATOMIC_BUILTIN(ID, TYPE, ATTRS) \
270 case Builtin::BI##ID: \
271 return SemaAtomicOpsOverloaded(move(TheCallResult), AtomicExpr::AO##ID);
272#include "clang/Basic/Builtins.def"
Julien Lerouge77f68bb2011-09-09 22:41:49 +0000273 case Builtin::BI__builtin_annotation:
Julien Lerougee5939212012-04-28 17:39:16 +0000274 if (SemaBuiltinAnnotation(*this, TheCall))
Julien Lerouge77f68bb2011-09-09 22:41:49 +0000275 return ExprError();
276 break;
Nate Begeman26a31422010-06-08 02:47:44 +0000277 }
278
279 // Since the target specific builtins for each arch overlap, only check those
280 // of the arch we are compiling for.
281 if (BuiltinID >= Builtin::FirstTSBuiltin) {
Douglas Gregorbcfd1f52011-09-02 00:18:52 +0000282 switch (Context.getTargetInfo().getTriple().getArch()) {
Nate Begeman26a31422010-06-08 02:47:44 +0000283 case llvm::Triple::arm:
284 case llvm::Triple::thumb:
285 if (CheckARMBuiltinFunctionCall(BuiltinID, TheCall))
286 return ExprError();
287 break;
Nate Begeman26a31422010-06-08 02:47:44 +0000288 default:
289 break;
290 }
291 }
292
293 return move(TheCallResult);
294}
295
Nate Begeman61eecf52010-06-14 05:21:25 +0000296// Get the valid immediate range for the specified NEON type code.
297static unsigned RFT(unsigned t, bool shift = false) {
Bob Wilsonda95f732011-11-08 01:16:11 +0000298 NeonTypeFlags Type(t);
299 int IsQuad = Type.isQuad();
300 switch (Type.getEltType()) {
301 case NeonTypeFlags::Int8:
302 case NeonTypeFlags::Poly8:
303 return shift ? 7 : (8 << IsQuad) - 1;
304 case NeonTypeFlags::Int16:
305 case NeonTypeFlags::Poly16:
306 return shift ? 15 : (4 << IsQuad) - 1;
307 case NeonTypeFlags::Int32:
308 return shift ? 31 : (2 << IsQuad) - 1;
309 case NeonTypeFlags::Int64:
310 return shift ? 63 : (1 << IsQuad) - 1;
311 case NeonTypeFlags::Float16:
312 assert(!shift && "cannot shift float types!");
313 return (4 << IsQuad) - 1;
314 case NeonTypeFlags::Float32:
315 assert(!shift && "cannot shift float types!");
316 return (2 << IsQuad) - 1;
Nate Begeman61eecf52010-06-14 05:21:25 +0000317 }
David Blaikie7530c032012-01-17 06:56:22 +0000318 llvm_unreachable("Invalid NeonTypeFlag!");
Nate Begeman61eecf52010-06-14 05:21:25 +0000319}
320
Bob Wilson6f9f03e2011-11-08 05:04:11 +0000321/// getNeonEltType - Return the QualType corresponding to the elements of
322/// the vector type specified by the NeonTypeFlags. This is used to check
323/// the pointer arguments for Neon load/store intrinsics.
324static QualType getNeonEltType(NeonTypeFlags Flags, ASTContext &Context) {
325 switch (Flags.getEltType()) {
326 case NeonTypeFlags::Int8:
327 return Flags.isUnsigned() ? Context.UnsignedCharTy : Context.SignedCharTy;
328 case NeonTypeFlags::Int16:
329 return Flags.isUnsigned() ? Context.UnsignedShortTy : Context.ShortTy;
330 case NeonTypeFlags::Int32:
331 return Flags.isUnsigned() ? Context.UnsignedIntTy : Context.IntTy;
332 case NeonTypeFlags::Int64:
333 return Flags.isUnsigned() ? Context.UnsignedLongLongTy : Context.LongLongTy;
334 case NeonTypeFlags::Poly8:
335 return Context.SignedCharTy;
336 case NeonTypeFlags::Poly16:
337 return Context.ShortTy;
338 case NeonTypeFlags::Float16:
339 return Context.UnsignedShortTy;
340 case NeonTypeFlags::Float32:
341 return Context.FloatTy;
342 }
David Blaikie7530c032012-01-17 06:56:22 +0000343 llvm_unreachable("Invalid NeonTypeFlag!");
Bob Wilson6f9f03e2011-11-08 05:04:11 +0000344}
345
Nate Begeman26a31422010-06-08 02:47:44 +0000346bool Sema::CheckARMBuiltinFunctionCall(unsigned BuiltinID, CallExpr *TheCall) {
Nate Begeman1c2a88c2010-06-09 01:10:23 +0000347 llvm::APSInt Result;
348
Nate Begeman0d15c532010-06-13 04:47:52 +0000349 unsigned mask = 0;
Nate Begeman61eecf52010-06-14 05:21:25 +0000350 unsigned TV = 0;
Bob Wilson46482552011-11-16 21:32:23 +0000351 int PtrArgNum = -1;
Bob Wilson6f9f03e2011-11-08 05:04:11 +0000352 bool HasConstPtr = false;
Nate Begeman1c2a88c2010-06-09 01:10:23 +0000353 switch (BuiltinID) {
Nate Begemana23326b2010-06-17 04:17:01 +0000354#define GET_NEON_OVERLOAD_CHECK
355#include "clang/Basic/arm_neon.inc"
356#undef GET_NEON_OVERLOAD_CHECK
Nate Begeman1c2a88c2010-06-09 01:10:23 +0000357 }
358
Nate Begeman0d15c532010-06-13 04:47:52 +0000359 // For NEON intrinsics which are overloaded on vector element type, validate
360 // the immediate which specifies which variant to emit.
Bob Wilson6f9f03e2011-11-08 05:04:11 +0000361 unsigned ImmArg = TheCall->getNumArgs()-1;
Nate Begeman0d15c532010-06-13 04:47:52 +0000362 if (mask) {
Bob Wilson6f9f03e2011-11-08 05:04:11 +0000363 if (SemaBuiltinConstantArg(TheCall, ImmArg, Result))
Nate Begeman0d15c532010-06-13 04:47:52 +0000364 return true;
365
Bob Wilsonda95f732011-11-08 01:16:11 +0000366 TV = Result.getLimitedValue(64);
367 if ((TV > 63) || (mask & (1 << TV)) == 0)
Nate Begeman0d15c532010-06-13 04:47:52 +0000368 return Diag(TheCall->getLocStart(), diag::err_invalid_neon_type_code)
Bob Wilson6f9f03e2011-11-08 05:04:11 +0000369 << TheCall->getArg(ImmArg)->getSourceRange();
370 }
371
Bob Wilson46482552011-11-16 21:32:23 +0000372 if (PtrArgNum >= 0) {
Bob Wilson6f9f03e2011-11-08 05:04:11 +0000373 // Check that pointer arguments have the specified type.
Bob Wilson46482552011-11-16 21:32:23 +0000374 Expr *Arg = TheCall->getArg(PtrArgNum);
375 if (ImplicitCastExpr *ICE = dyn_cast<ImplicitCastExpr>(Arg))
376 Arg = ICE->getSubExpr();
377 ExprResult RHS = DefaultFunctionArrayLvalueConversion(Arg);
378 QualType RHSTy = RHS.get()->getType();
379 QualType EltTy = getNeonEltType(NeonTypeFlags(TV), Context);
380 if (HasConstPtr)
381 EltTy = EltTy.withConst();
382 QualType LHSTy = Context.getPointerType(EltTy);
383 AssignConvertType ConvTy;
384 ConvTy = CheckSingleAssignmentConstraints(LHSTy, RHS);
385 if (RHS.isInvalid())
386 return true;
387 if (DiagnoseAssignmentResult(ConvTy, Arg->getLocStart(), LHSTy, RHSTy,
388 RHS.get(), AA_Assigning))
389 return true;
Nate Begeman0d15c532010-06-13 04:47:52 +0000390 }
Nate Begeman1c2a88c2010-06-09 01:10:23 +0000391
Nate Begeman0d15c532010-06-13 04:47:52 +0000392 // For NEON intrinsics which take an immediate value as part of the
393 // instruction, range check them here.
Nate Begeman61eecf52010-06-14 05:21:25 +0000394 unsigned i = 0, l = 0, u = 0;
Nate Begeman0d15c532010-06-13 04:47:52 +0000395 switch (BuiltinID) {
396 default: return false;
Nate Begemanbb37f502010-07-29 22:48:34 +0000397 case ARM::BI__builtin_arm_ssat: i = 1; l = 1; u = 31; break;
398 case ARM::BI__builtin_arm_usat: i = 1; u = 31; break;
Nate Begeman99c40bb2010-08-03 21:32:34 +0000399 case ARM::BI__builtin_arm_vcvtr_f:
400 case ARM::BI__builtin_arm_vcvtr_d: i = 1; u = 1; break;
Nate Begemana23326b2010-06-17 04:17:01 +0000401#define GET_NEON_IMMEDIATE_CHECK
402#include "clang/Basic/arm_neon.inc"
403#undef GET_NEON_IMMEDIATE_CHECK
Nate Begeman0d15c532010-06-13 04:47:52 +0000404 };
405
Nate Begeman61eecf52010-06-14 05:21:25 +0000406 // Check that the immediate argument is actually a constant.
Nate Begeman0d15c532010-06-13 04:47:52 +0000407 if (SemaBuiltinConstantArg(TheCall, i, Result))
408 return true;
409
Nate Begeman61eecf52010-06-14 05:21:25 +0000410 // Range check against the upper/lower values for this isntruction.
Nate Begeman0d15c532010-06-13 04:47:52 +0000411 unsigned Val = Result.getZExtValue();
Nate Begeman61eecf52010-06-14 05:21:25 +0000412 if (Val < l || Val > (u + l))
Nate Begeman0d15c532010-06-13 04:47:52 +0000413 return Diag(TheCall->getLocStart(), diag::err_argument_invalid_range)
Benjamin Kramer476d8b82010-08-11 14:47:12 +0000414 << l << u+l << TheCall->getArg(i)->getSourceRange();
Nate Begeman0d15c532010-06-13 04:47:52 +0000415
Nate Begeman99c40bb2010-08-03 21:32:34 +0000416 // FIXME: VFP Intrinsics should error if VFP not present.
Nate Begeman26a31422010-06-08 02:47:44 +0000417 return false;
Anders Carlssond406bf02009-08-16 01:56:34 +0000418}
Daniel Dunbarde454282008-10-02 18:44:07 +0000419
Anders Carlssond406bf02009-08-16 01:56:34 +0000420/// CheckFunctionCall - Check a direct function call for various correctness
421/// and safety properties not strictly enforced by the C type system.
422bool Sema::CheckFunctionCall(FunctionDecl *FDecl, CallExpr *TheCall) {
423 // Get the IdentifierInfo* for the called function.
424 IdentifierInfo *FnInfo = FDecl->getIdentifier();
425
426 // None of the checks below are needed for functions that don't have
427 // simple names (e.g., C++ conversion functions).
428 if (!FnInfo)
429 return false;
Mike Stump1eb44332009-09-09 15:08:12 +0000430
Daniel Dunbarde454282008-10-02 18:44:07 +0000431 // FIXME: This mechanism should be abstracted to be less fragile and
432 // more efficient. For example, just map function ids to custom
433 // handlers.
434
Ted Kremenekc82faca2010-09-09 04:33:05 +0000435 // Printf and scanf checking.
436 for (specific_attr_iterator<FormatAttr>
437 i = FDecl->specific_attr_begin<FormatAttr>(),
438 e = FDecl->specific_attr_end<FormatAttr>(); i != e ; ++i) {
Jean-Daniel Dupas29c3f812012-01-17 20:03:31 +0000439 CheckFormatArguments(*i, TheCall);
Chris Lattner59907c42007-08-10 20:18:51 +0000440 }
Mike Stump1eb44332009-09-09 15:08:12 +0000441
Ted Kremenekc82faca2010-09-09 04:33:05 +0000442 for (specific_attr_iterator<NonNullAttr>
443 i = FDecl->specific_attr_begin<NonNullAttr>(),
444 e = FDecl->specific_attr_end<NonNullAttr>(); i != e; ++i) {
Nick Lewycky909a70d2011-03-25 01:44:32 +0000445 CheckNonNullArguments(*i, TheCall->getArgs(),
446 TheCall->getCallee()->getLocStart());
Ted Kremenekc82faca2010-09-09 04:33:05 +0000447 }
Sebastian Redl0eb23302009-01-19 00:08:26 +0000448
Anna Zaks0a151a12012-01-17 00:37:07 +0000449 unsigned CMId = FDecl->getMemoryFunctionKind();
450 if (CMId == 0)
Anna Zaksd9b859a2012-01-13 21:52:01 +0000451 return false;
Ted Kremenekbd5da9d2011-08-18 20:55:45 +0000452
Anna Zaksd9b859a2012-01-13 21:52:01 +0000453 // Handle memory setting and copying functions.
Anna Zaks0a151a12012-01-17 00:37:07 +0000454 if (CMId == Builtin::BIstrlcpy || CMId == Builtin::BIstrlcat)
Ted Kremenekbd5da9d2011-08-18 20:55:45 +0000455 CheckStrlcpycatArguments(TheCall, FnInfo);
Anna Zaksc36bedc2012-02-01 19:08:57 +0000456 else if (CMId == Builtin::BIstrncat)
457 CheckStrncatArguments(TheCall, FnInfo);
Anna Zaksd9b859a2012-01-13 21:52:01 +0000458 else
Anna Zaks0a151a12012-01-17 00:37:07 +0000459 CheckMemaccessArguments(TheCall, CMId, FnInfo);
Chandler Carruth7ccc95b2011-04-27 07:05:31 +0000460
Anders Carlssond406bf02009-08-16 01:56:34 +0000461 return false;
Anders Carlsson71993dd2007-08-17 05:31:46 +0000462}
463
Jean-Daniel Dupas29c3f812012-01-17 20:03:31 +0000464bool Sema::CheckObjCMethodCall(ObjCMethodDecl *Method, SourceLocation lbrac,
465 Expr **Args, unsigned NumArgs) {
466 for (specific_attr_iterator<FormatAttr>
467 i = Method->specific_attr_begin<FormatAttr>(),
468 e = Method->specific_attr_end<FormatAttr>(); i != e ; ++i) {
469
470 CheckFormatArguments(*i, Args, NumArgs, false, lbrac,
471 Method->getSourceRange());
472 }
473
474 // diagnose nonnull arguments.
475 for (specific_attr_iterator<NonNullAttr>
476 i = Method->specific_attr_begin<NonNullAttr>(),
477 e = Method->specific_attr_end<NonNullAttr>(); i != e; ++i) {
478 CheckNonNullArguments(*i, Args, lbrac);
479 }
480
481 return false;
482}
483
Anders Carlssond406bf02009-08-16 01:56:34 +0000484bool Sema::CheckBlockCall(NamedDecl *NDecl, CallExpr *TheCall) {
Fariborz Jahanian725165f2009-05-18 21:05:18 +0000485 const VarDecl *V = dyn_cast<VarDecl>(NDecl);
486 if (!V)
Anders Carlssond406bf02009-08-16 01:56:34 +0000487 return false;
Mike Stump1eb44332009-09-09 15:08:12 +0000488
Fariborz Jahanian725165f2009-05-18 21:05:18 +0000489 QualType Ty = V->getType();
490 if (!Ty->isBlockPointerType())
Anders Carlssond406bf02009-08-16 01:56:34 +0000491 return false;
Mike Stump1eb44332009-09-09 15:08:12 +0000492
Jean-Daniel Dupas43d12512012-01-25 00:55:11 +0000493 // format string checking.
494 for (specific_attr_iterator<FormatAttr>
495 i = NDecl->specific_attr_begin<FormatAttr>(),
496 e = NDecl->specific_attr_end<FormatAttr>(); i != e ; ++i) {
497 CheckFormatArguments(*i, TheCall);
498 }
Anders Carlssond406bf02009-08-16 01:56:34 +0000499
500 return false;
Fariborz Jahanian725165f2009-05-18 21:05:18 +0000501}
502
Richard Smithff34d402012-04-12 05:08:17 +0000503ExprResult Sema::SemaAtomicOpsOverloaded(ExprResult TheCallResult,
504 AtomicExpr::AtomicOp Op) {
Eli Friedman276b0612011-10-11 02:20:01 +0000505 CallExpr *TheCall = cast<CallExpr>(TheCallResult.get());
506 DeclRefExpr *DRE =cast<DeclRefExpr>(TheCall->getCallee()->IgnoreParenCasts());
Eli Friedman276b0612011-10-11 02:20:01 +0000507
Richard Smithff34d402012-04-12 05:08:17 +0000508 // All these operations take one of the following forms:
509 enum {
510 // C __c11_atomic_init(A *, C)
511 Init,
512 // C __c11_atomic_load(A *, int)
513 Load,
514 // void __atomic_load(A *, CP, int)
515 Copy,
516 // C __c11_atomic_add(A *, M, int)
517 Arithmetic,
518 // C __atomic_exchange_n(A *, CP, int)
519 Xchg,
520 // void __atomic_exchange(A *, C *, CP, int)
521 GNUXchg,
522 // bool __c11_atomic_compare_exchange_strong(A *, C *, CP, int, int)
523 C11CmpXchg,
524 // bool __atomic_compare_exchange(A *, C *, CP, bool, int, int)
525 GNUCmpXchg
526 } Form = Init;
527 const unsigned NumArgs[] = { 2, 2, 3, 3, 3, 4, 5, 6 };
528 const unsigned NumVals[] = { 1, 0, 1, 1, 1, 2, 2, 3 };
529 // where:
530 // C is an appropriate type,
531 // A is volatile _Atomic(C) for __c11 builtins and is C for GNU builtins,
532 // CP is C for __c11 builtins and GNU _n builtins and is C * otherwise,
533 // M is C if C is an integer, and ptrdiff_t if C is a pointer, and
534 // the int parameters are for orderings.
Eli Friedman276b0612011-10-11 02:20:01 +0000535
Richard Smithff34d402012-04-12 05:08:17 +0000536 assert(AtomicExpr::AO__c11_atomic_init == 0 &&
537 AtomicExpr::AO__c11_atomic_fetch_xor + 1 == AtomicExpr::AO__atomic_load
538 && "need to update code for modified C11 atomics");
539 bool IsC11 = Op >= AtomicExpr::AO__c11_atomic_init &&
540 Op <= AtomicExpr::AO__c11_atomic_fetch_xor;
541 bool IsN = Op == AtomicExpr::AO__atomic_load_n ||
542 Op == AtomicExpr::AO__atomic_store_n ||
543 Op == AtomicExpr::AO__atomic_exchange_n ||
544 Op == AtomicExpr::AO__atomic_compare_exchange_n;
545 bool IsAddSub = false;
546
547 switch (Op) {
548 case AtomicExpr::AO__c11_atomic_init:
549 Form = Init;
550 break;
551
552 case AtomicExpr::AO__c11_atomic_load:
553 case AtomicExpr::AO__atomic_load_n:
554 Form = Load;
555 break;
556
557 case AtomicExpr::AO__c11_atomic_store:
558 case AtomicExpr::AO__atomic_load:
559 case AtomicExpr::AO__atomic_store:
560 case AtomicExpr::AO__atomic_store_n:
561 Form = Copy;
562 break;
563
564 case AtomicExpr::AO__c11_atomic_fetch_add:
565 case AtomicExpr::AO__c11_atomic_fetch_sub:
566 case AtomicExpr::AO__atomic_fetch_add:
567 case AtomicExpr::AO__atomic_fetch_sub:
568 case AtomicExpr::AO__atomic_add_fetch:
569 case AtomicExpr::AO__atomic_sub_fetch:
570 IsAddSub = true;
571 // Fall through.
572 case AtomicExpr::AO__c11_atomic_fetch_and:
573 case AtomicExpr::AO__c11_atomic_fetch_or:
574 case AtomicExpr::AO__c11_atomic_fetch_xor:
575 case AtomicExpr::AO__atomic_fetch_and:
576 case AtomicExpr::AO__atomic_fetch_or:
577 case AtomicExpr::AO__atomic_fetch_xor:
Richard Smith51b92402012-04-13 06:31:38 +0000578 case AtomicExpr::AO__atomic_fetch_nand:
Richard Smithff34d402012-04-12 05:08:17 +0000579 case AtomicExpr::AO__atomic_and_fetch:
580 case AtomicExpr::AO__atomic_or_fetch:
581 case AtomicExpr::AO__atomic_xor_fetch:
Richard Smith51b92402012-04-13 06:31:38 +0000582 case AtomicExpr::AO__atomic_nand_fetch:
Richard Smithff34d402012-04-12 05:08:17 +0000583 Form = Arithmetic;
584 break;
585
586 case AtomicExpr::AO__c11_atomic_exchange:
587 case AtomicExpr::AO__atomic_exchange_n:
588 Form = Xchg;
589 break;
590
591 case AtomicExpr::AO__atomic_exchange:
592 Form = GNUXchg;
593 break;
594
595 case AtomicExpr::AO__c11_atomic_compare_exchange_strong:
596 case AtomicExpr::AO__c11_atomic_compare_exchange_weak:
597 Form = C11CmpXchg;
598 break;
599
600 case AtomicExpr::AO__atomic_compare_exchange:
601 case AtomicExpr::AO__atomic_compare_exchange_n:
602 Form = GNUCmpXchg;
603 break;
604 }
605
606 // Check we have the right number of arguments.
607 if (TheCall->getNumArgs() < NumArgs[Form]) {
Eli Friedman276b0612011-10-11 02:20:01 +0000608 Diag(TheCall->getLocEnd(), diag::err_typecheck_call_too_few_args)
Richard Smithff34d402012-04-12 05:08:17 +0000609 << 0 << NumArgs[Form] << TheCall->getNumArgs()
Eli Friedman276b0612011-10-11 02:20:01 +0000610 << TheCall->getCallee()->getSourceRange();
611 return ExprError();
Richard Smithff34d402012-04-12 05:08:17 +0000612 } else if (TheCall->getNumArgs() > NumArgs[Form]) {
613 Diag(TheCall->getArg(NumArgs[Form])->getLocStart(),
Eli Friedman276b0612011-10-11 02:20:01 +0000614 diag::err_typecheck_call_too_many_args)
Richard Smithff34d402012-04-12 05:08:17 +0000615 << 0 << NumArgs[Form] << TheCall->getNumArgs()
Eli Friedman276b0612011-10-11 02:20:01 +0000616 << TheCall->getCallee()->getSourceRange();
617 return ExprError();
618 }
619
Richard Smithff34d402012-04-12 05:08:17 +0000620 // Inspect the first argument of the atomic operation.
Eli Friedmandfa64ba2011-10-14 22:48:56 +0000621 Expr *Ptr = TheCall->getArg(0);
Eli Friedman276b0612011-10-11 02:20:01 +0000622 Ptr = DefaultFunctionArrayLvalueConversion(Ptr).get();
623 const PointerType *pointerType = Ptr->getType()->getAs<PointerType>();
624 if (!pointerType) {
Richard Smithff34d402012-04-12 05:08:17 +0000625 Diag(DRE->getLocStart(), diag::err_atomic_builtin_must_be_pointer)
Eli Friedman276b0612011-10-11 02:20:01 +0000626 << Ptr->getType() << Ptr->getSourceRange();
627 return ExprError();
628 }
629
Richard Smithff34d402012-04-12 05:08:17 +0000630 // For a __c11 builtin, this should be a pointer to an _Atomic type.
631 QualType AtomTy = pointerType->getPointeeType(); // 'A'
632 QualType ValType = AtomTy; // 'C'
633 if (IsC11) {
634 if (!AtomTy->isAtomicType()) {
635 Diag(DRE->getLocStart(), diag::err_atomic_op_needs_atomic)
636 << Ptr->getType() << Ptr->getSourceRange();
637 return ExprError();
638 }
639 ValType = AtomTy->getAs<AtomicType>()->getValueType();
Eli Friedman276b0612011-10-11 02:20:01 +0000640 }
Eli Friedman276b0612011-10-11 02:20:01 +0000641
Richard Smithff34d402012-04-12 05:08:17 +0000642 // For an arithmetic operation, the implied arithmetic must be well-formed.
643 if (Form == Arithmetic) {
644 // gcc does not enforce these rules for GNU atomics, but we do so for sanity.
645 if (IsAddSub && !ValType->isIntegerType() && !ValType->isPointerType()) {
646 Diag(DRE->getLocStart(), diag::err_atomic_op_needs_atomic_int_or_ptr)
647 << IsC11 << Ptr->getType() << Ptr->getSourceRange();
648 return ExprError();
649 }
650 if (!IsAddSub && !ValType->isIntegerType()) {
651 Diag(DRE->getLocStart(), diag::err_atomic_op_bitwise_needs_atomic_int)
652 << IsC11 << Ptr->getType() << Ptr->getSourceRange();
653 return ExprError();
654 }
655 } else if (IsN && !ValType->isIntegerType() && !ValType->isPointerType()) {
656 // For __atomic_*_n operations, the value type must be a scalar integral or
657 // pointer type which is 1, 2, 4, 8 or 16 bytes in length.
Eli Friedman276b0612011-10-11 02:20:01 +0000658 Diag(DRE->getLocStart(), diag::err_atomic_op_needs_atomic_int_or_ptr)
Richard Smithff34d402012-04-12 05:08:17 +0000659 << IsC11 << Ptr->getType() << Ptr->getSourceRange();
660 return ExprError();
661 }
662
663 if (!IsC11 && !AtomTy.isTriviallyCopyableType(Context)) {
664 // For GNU atomics, require a trivially-copyable type. This is not part of
665 // the GNU atomics specification, but we enforce it for sanity.
666 Diag(DRE->getLocStart(), diag::err_atomic_op_needs_trivial_copy)
Eli Friedman276b0612011-10-11 02:20:01 +0000667 << Ptr->getType() << Ptr->getSourceRange();
668 return ExprError();
669 }
670
Richard Smithff34d402012-04-12 05:08:17 +0000671 // FIXME: For any builtin other than a load, the ValType must not be
672 // const-qualified.
Eli Friedman276b0612011-10-11 02:20:01 +0000673
674 switch (ValType.getObjCLifetime()) {
675 case Qualifiers::OCL_None:
676 case Qualifiers::OCL_ExplicitNone:
677 // okay
678 break;
679
680 case Qualifiers::OCL_Weak:
681 case Qualifiers::OCL_Strong:
682 case Qualifiers::OCL_Autoreleasing:
Richard Smithff34d402012-04-12 05:08:17 +0000683 // FIXME: Can this happen? By this point, ValType should be known
684 // to be trivially copyable.
Eli Friedman276b0612011-10-11 02:20:01 +0000685 Diag(DRE->getLocStart(), diag::err_arc_atomic_ownership)
686 << ValType << Ptr->getSourceRange();
687 return ExprError();
688 }
689
690 QualType ResultType = ValType;
Richard Smithff34d402012-04-12 05:08:17 +0000691 if (Form == Copy || Form == GNUXchg || Form == Init)
Eli Friedman276b0612011-10-11 02:20:01 +0000692 ResultType = Context.VoidTy;
Richard Smithff34d402012-04-12 05:08:17 +0000693 else if (Form == C11CmpXchg || Form == GNUCmpXchg)
Eli Friedman276b0612011-10-11 02:20:01 +0000694 ResultType = Context.BoolTy;
695
Richard Smithff34d402012-04-12 05:08:17 +0000696 // The type of a parameter passed 'by value'. In the GNU atomics, such
697 // arguments are actually passed as pointers.
698 QualType ByValType = ValType; // 'CP'
699 if (!IsC11 && !IsN)
700 ByValType = Ptr->getType();
701
Eli Friedman276b0612011-10-11 02:20:01 +0000702 // The first argument --- the pointer --- has a fixed type; we
703 // deduce the types of the rest of the arguments accordingly. Walk
704 // the remaining arguments, converting them to the deduced value type.
Richard Smithff34d402012-04-12 05:08:17 +0000705 for (unsigned i = 1; i != NumArgs[Form]; ++i) {
Eli Friedman276b0612011-10-11 02:20:01 +0000706 QualType Ty;
Richard Smithff34d402012-04-12 05:08:17 +0000707 if (i < NumVals[Form] + 1) {
708 switch (i) {
709 case 1:
710 // The second argument is the non-atomic operand. For arithmetic, this
711 // is always passed by value, and for a compare_exchange it is always
712 // passed by address. For the rest, GNU uses by-address and C11 uses
713 // by-value.
714 assert(Form != Load);
715 if (Form == Init || (Form == Arithmetic && ValType->isIntegerType()))
716 Ty = ValType;
717 else if (Form == Copy || Form == Xchg)
718 Ty = ByValType;
719 else if (Form == Arithmetic)
720 Ty = Context.getPointerDiffType();
721 else
722 Ty = Context.getPointerType(ValType.getUnqualifiedType());
723 break;
724 case 2:
725 // The third argument to compare_exchange / GNU exchange is a
726 // (pointer to a) desired value.
727 Ty = ByValType;
728 break;
729 case 3:
730 // The fourth argument to GNU compare_exchange is a 'weak' flag.
731 Ty = Context.BoolTy;
732 break;
733 }
Eli Friedman276b0612011-10-11 02:20:01 +0000734 } else {
735 // The order(s) are always converted to int.
736 Ty = Context.IntTy;
737 }
Richard Smithff34d402012-04-12 05:08:17 +0000738
Eli Friedman276b0612011-10-11 02:20:01 +0000739 InitializedEntity Entity =
740 InitializedEntity::InitializeParameter(Context, Ty, false);
Richard Smithff34d402012-04-12 05:08:17 +0000741 ExprResult Arg = TheCall->getArg(i);
Eli Friedman276b0612011-10-11 02:20:01 +0000742 Arg = PerformCopyInitialization(Entity, SourceLocation(), Arg);
743 if (Arg.isInvalid())
744 return true;
745 TheCall->setArg(i, Arg.get());
746 }
747
Richard Smithff34d402012-04-12 05:08:17 +0000748 // Permute the arguments into a 'consistent' order.
Eli Friedmandfa64ba2011-10-14 22:48:56 +0000749 SmallVector<Expr*, 5> SubExprs;
750 SubExprs.push_back(Ptr);
Richard Smithff34d402012-04-12 05:08:17 +0000751 switch (Form) {
752 case Init:
753 // Note, AtomicExpr::getVal1() has a special case for this atomic.
David Chisnall7a7ee302012-01-16 17:27:18 +0000754 SubExprs.push_back(TheCall->getArg(1)); // Val1
Richard Smithff34d402012-04-12 05:08:17 +0000755 break;
756 case Load:
757 SubExprs.push_back(TheCall->getArg(1)); // Order
758 break;
759 case Copy:
760 case Arithmetic:
761 case Xchg:
Eli Friedmandfa64ba2011-10-14 22:48:56 +0000762 SubExprs.push_back(TheCall->getArg(2)); // Order
763 SubExprs.push_back(TheCall->getArg(1)); // Val1
Richard Smithff34d402012-04-12 05:08:17 +0000764 break;
765 case GNUXchg:
766 // Note, AtomicExpr::getVal2() has a special case for this atomic.
767 SubExprs.push_back(TheCall->getArg(3)); // Order
768 SubExprs.push_back(TheCall->getArg(1)); // Val1
769 SubExprs.push_back(TheCall->getArg(2)); // Val2
770 break;
771 case C11CmpXchg:
Eli Friedmandfa64ba2011-10-14 22:48:56 +0000772 SubExprs.push_back(TheCall->getArg(3)); // Order
773 SubExprs.push_back(TheCall->getArg(1)); // Val1
Eli Friedmandfa64ba2011-10-14 22:48:56 +0000774 SubExprs.push_back(TheCall->getArg(4)); // OrderFail
David Chisnall2ebb98a2012-03-29 17:58:59 +0000775 SubExprs.push_back(TheCall->getArg(2)); // Val2
Richard Smithff34d402012-04-12 05:08:17 +0000776 break;
777 case GNUCmpXchg:
778 SubExprs.push_back(TheCall->getArg(4)); // Order
779 SubExprs.push_back(TheCall->getArg(1)); // Val1
780 SubExprs.push_back(TheCall->getArg(5)); // OrderFail
781 SubExprs.push_back(TheCall->getArg(2)); // Val2
782 SubExprs.push_back(TheCall->getArg(3)); // Weak
783 break;
Eli Friedman276b0612011-10-11 02:20:01 +0000784 }
Eli Friedmandfa64ba2011-10-14 22:48:56 +0000785
786 return Owned(new (Context) AtomicExpr(TheCall->getCallee()->getLocStart(),
787 SubExprs.data(), SubExprs.size(),
788 ResultType, Op,
789 TheCall->getRParenLoc()));
Eli Friedman276b0612011-10-11 02:20:01 +0000790}
791
792
John McCall5f8d6042011-08-27 01:09:30 +0000793/// checkBuiltinArgument - Given a call to a builtin function, perform
794/// normal type-checking on the given argument, updating the call in
795/// place. This is useful when a builtin function requires custom
796/// type-checking for some of its arguments but not necessarily all of
797/// them.
798///
799/// Returns true on error.
800static bool checkBuiltinArgument(Sema &S, CallExpr *E, unsigned ArgIndex) {
801 FunctionDecl *Fn = E->getDirectCallee();
802 assert(Fn && "builtin call without direct callee!");
803
804 ParmVarDecl *Param = Fn->getParamDecl(ArgIndex);
805 InitializedEntity Entity =
806 InitializedEntity::InitializeParameter(S.Context, Param);
807
808 ExprResult Arg = E->getArg(0);
809 Arg = S.PerformCopyInitialization(Entity, SourceLocation(), Arg);
810 if (Arg.isInvalid())
811 return true;
812
813 E->setArg(ArgIndex, Arg.take());
814 return false;
815}
816
Chris Lattner5caa3702009-05-08 06:58:22 +0000817/// SemaBuiltinAtomicOverloaded - We have a call to a function like
818/// __sync_fetch_and_add, which is an overloaded function based on the pointer
819/// type of its first argument. The main ActOnCallExpr routines have already
820/// promoted the types of arguments because all of these calls are prototyped as
821/// void(...).
822///
823/// This function goes through and does final semantic checking for these
824/// builtins,
John McCall60d7b3a2010-08-24 06:29:42 +0000825ExprResult
826Sema::SemaBuiltinAtomicOverloaded(ExprResult TheCallResult) {
Chandler Carruthd2014572010-07-09 18:59:35 +0000827 CallExpr *TheCall = (CallExpr *)TheCallResult.get();
Chris Lattner5caa3702009-05-08 06:58:22 +0000828 DeclRefExpr *DRE =cast<DeclRefExpr>(TheCall->getCallee()->IgnoreParenCasts());
829 FunctionDecl *FDecl = cast<FunctionDecl>(DRE->getDecl());
830
831 // Ensure that we have at least one argument to do type inference from.
Chandler Carruthd2014572010-07-09 18:59:35 +0000832 if (TheCall->getNumArgs() < 1) {
833 Diag(TheCall->getLocEnd(), diag::err_typecheck_call_too_few_args_at_least)
834 << 0 << 1 << TheCall->getNumArgs()
835 << TheCall->getCallee()->getSourceRange();
836 return ExprError();
837 }
Mike Stump1eb44332009-09-09 15:08:12 +0000838
Chris Lattner5caa3702009-05-08 06:58:22 +0000839 // Inspect the first argument of the atomic builtin. This should always be
840 // a pointer type, whose element is an integral scalar or pointer type.
841 // Because it is a pointer type, we don't have to worry about any implicit
842 // casts here.
Chandler Carruthd2014572010-07-09 18:59:35 +0000843 // FIXME: We don't allow floating point scalars as input.
Chris Lattner5caa3702009-05-08 06:58:22 +0000844 Expr *FirstArg = TheCall->getArg(0);
Eli Friedman8c382062012-01-23 02:35:22 +0000845 ExprResult FirstArgResult = DefaultFunctionArrayLvalueConversion(FirstArg);
846 if (FirstArgResult.isInvalid())
847 return ExprError();
848 FirstArg = FirstArgResult.take();
849 TheCall->setArg(0, FirstArg);
850
John McCallf85e1932011-06-15 23:02:42 +0000851 const PointerType *pointerType = FirstArg->getType()->getAs<PointerType>();
852 if (!pointerType) {
Chandler Carruthd2014572010-07-09 18:59:35 +0000853 Diag(DRE->getLocStart(), diag::err_atomic_builtin_must_be_pointer)
854 << FirstArg->getType() << FirstArg->getSourceRange();
855 return ExprError();
856 }
Mike Stump1eb44332009-09-09 15:08:12 +0000857
John McCallf85e1932011-06-15 23:02:42 +0000858 QualType ValType = pointerType->getPointeeType();
Chris Lattnerdd5fa7a2010-09-17 21:12:38 +0000859 if (!ValType->isIntegerType() && !ValType->isAnyPointerType() &&
Chandler Carruthd2014572010-07-09 18:59:35 +0000860 !ValType->isBlockPointerType()) {
861 Diag(DRE->getLocStart(), diag::err_atomic_builtin_must_be_pointer_intptr)
862 << FirstArg->getType() << FirstArg->getSourceRange();
863 return ExprError();
864 }
Chris Lattner5caa3702009-05-08 06:58:22 +0000865
John McCallf85e1932011-06-15 23:02:42 +0000866 switch (ValType.getObjCLifetime()) {
867 case Qualifiers::OCL_None:
868 case Qualifiers::OCL_ExplicitNone:
869 // okay
870 break;
871
872 case Qualifiers::OCL_Weak:
873 case Qualifiers::OCL_Strong:
874 case Qualifiers::OCL_Autoreleasing:
Argyrios Kyrtzidisb8b03132011-06-24 00:08:59 +0000875 Diag(DRE->getLocStart(), diag::err_arc_atomic_ownership)
John McCallf85e1932011-06-15 23:02:42 +0000876 << ValType << FirstArg->getSourceRange();
877 return ExprError();
878 }
879
John McCallb45ae252011-10-05 07:41:44 +0000880 // Strip any qualifiers off ValType.
881 ValType = ValType.getUnqualifiedType();
882
Chandler Carruth8d13d222010-07-18 20:54:12 +0000883 // The majority of builtins return a value, but a few have special return
884 // types, so allow them to override appropriately below.
885 QualType ResultType = ValType;
886
Chris Lattner5caa3702009-05-08 06:58:22 +0000887 // We need to figure out which concrete builtin this maps onto. For example,
888 // __sync_fetch_and_add with a 2 byte object turns into
889 // __sync_fetch_and_add_2.
890#define BUILTIN_ROW(x) \
891 { Builtin::BI##x##_1, Builtin::BI##x##_2, Builtin::BI##x##_4, \
892 Builtin::BI##x##_8, Builtin::BI##x##_16 }
Mike Stump1eb44332009-09-09 15:08:12 +0000893
Chris Lattner5caa3702009-05-08 06:58:22 +0000894 static const unsigned BuiltinIndices[][5] = {
895 BUILTIN_ROW(__sync_fetch_and_add),
896 BUILTIN_ROW(__sync_fetch_and_sub),
897 BUILTIN_ROW(__sync_fetch_and_or),
898 BUILTIN_ROW(__sync_fetch_and_and),
899 BUILTIN_ROW(__sync_fetch_and_xor),
Mike Stump1eb44332009-09-09 15:08:12 +0000900
Chris Lattner5caa3702009-05-08 06:58:22 +0000901 BUILTIN_ROW(__sync_add_and_fetch),
902 BUILTIN_ROW(__sync_sub_and_fetch),
903 BUILTIN_ROW(__sync_and_and_fetch),
904 BUILTIN_ROW(__sync_or_and_fetch),
905 BUILTIN_ROW(__sync_xor_and_fetch),
Mike Stump1eb44332009-09-09 15:08:12 +0000906
Chris Lattner5caa3702009-05-08 06:58:22 +0000907 BUILTIN_ROW(__sync_val_compare_and_swap),
908 BUILTIN_ROW(__sync_bool_compare_and_swap),
909 BUILTIN_ROW(__sync_lock_test_and_set),
Chris Lattner23aa9c82011-04-09 03:57:26 +0000910 BUILTIN_ROW(__sync_lock_release),
911 BUILTIN_ROW(__sync_swap)
Chris Lattner5caa3702009-05-08 06:58:22 +0000912 };
Mike Stump1eb44332009-09-09 15:08:12 +0000913#undef BUILTIN_ROW
914
Chris Lattner5caa3702009-05-08 06:58:22 +0000915 // Determine the index of the size.
916 unsigned SizeIndex;
Ken Dyck199c3d62010-01-11 17:06:35 +0000917 switch (Context.getTypeSizeInChars(ValType).getQuantity()) {
Chris Lattner5caa3702009-05-08 06:58:22 +0000918 case 1: SizeIndex = 0; break;
919 case 2: SizeIndex = 1; break;
920 case 4: SizeIndex = 2; break;
921 case 8: SizeIndex = 3; break;
922 case 16: SizeIndex = 4; break;
923 default:
Chandler Carruthd2014572010-07-09 18:59:35 +0000924 Diag(DRE->getLocStart(), diag::err_atomic_builtin_pointer_size)
925 << FirstArg->getType() << FirstArg->getSourceRange();
926 return ExprError();
Chris Lattner5caa3702009-05-08 06:58:22 +0000927 }
Mike Stump1eb44332009-09-09 15:08:12 +0000928
Chris Lattner5caa3702009-05-08 06:58:22 +0000929 // Each of these builtins has one pointer argument, followed by some number of
930 // values (0, 1 or 2) followed by a potentially empty varags list of stuff
931 // that we ignore. Find out which row of BuiltinIndices to read from as well
932 // as the number of fixed args.
Douglas Gregor7814e6d2009-09-12 00:22:50 +0000933 unsigned BuiltinID = FDecl->getBuiltinID();
Chris Lattner5caa3702009-05-08 06:58:22 +0000934 unsigned BuiltinIndex, NumFixed = 1;
935 switch (BuiltinID) {
David Blaikieb219cfc2011-09-23 05:06:16 +0000936 default: llvm_unreachable("Unknown overloaded atomic builtin!");
Douglas Gregora9766412011-11-28 16:30:08 +0000937 case Builtin::BI__sync_fetch_and_add:
938 case Builtin::BI__sync_fetch_and_add_1:
939 case Builtin::BI__sync_fetch_and_add_2:
940 case Builtin::BI__sync_fetch_and_add_4:
941 case Builtin::BI__sync_fetch_and_add_8:
942 case Builtin::BI__sync_fetch_and_add_16:
943 BuiltinIndex = 0;
944 break;
945
946 case Builtin::BI__sync_fetch_and_sub:
947 case Builtin::BI__sync_fetch_and_sub_1:
948 case Builtin::BI__sync_fetch_and_sub_2:
949 case Builtin::BI__sync_fetch_and_sub_4:
950 case Builtin::BI__sync_fetch_and_sub_8:
951 case Builtin::BI__sync_fetch_and_sub_16:
952 BuiltinIndex = 1;
953 break;
954
955 case Builtin::BI__sync_fetch_and_or:
956 case Builtin::BI__sync_fetch_and_or_1:
957 case Builtin::BI__sync_fetch_and_or_2:
958 case Builtin::BI__sync_fetch_and_or_4:
959 case Builtin::BI__sync_fetch_and_or_8:
960 case Builtin::BI__sync_fetch_and_or_16:
961 BuiltinIndex = 2;
962 break;
963
964 case Builtin::BI__sync_fetch_and_and:
965 case Builtin::BI__sync_fetch_and_and_1:
966 case Builtin::BI__sync_fetch_and_and_2:
967 case Builtin::BI__sync_fetch_and_and_4:
968 case Builtin::BI__sync_fetch_and_and_8:
969 case Builtin::BI__sync_fetch_and_and_16:
970 BuiltinIndex = 3;
971 break;
Mike Stump1eb44332009-09-09 15:08:12 +0000972
Douglas Gregora9766412011-11-28 16:30:08 +0000973 case Builtin::BI__sync_fetch_and_xor:
974 case Builtin::BI__sync_fetch_and_xor_1:
975 case Builtin::BI__sync_fetch_and_xor_2:
976 case Builtin::BI__sync_fetch_and_xor_4:
977 case Builtin::BI__sync_fetch_and_xor_8:
978 case Builtin::BI__sync_fetch_and_xor_16:
979 BuiltinIndex = 4;
980 break;
981
982 case Builtin::BI__sync_add_and_fetch:
983 case Builtin::BI__sync_add_and_fetch_1:
984 case Builtin::BI__sync_add_and_fetch_2:
985 case Builtin::BI__sync_add_and_fetch_4:
986 case Builtin::BI__sync_add_and_fetch_8:
987 case Builtin::BI__sync_add_and_fetch_16:
988 BuiltinIndex = 5;
989 break;
990
991 case Builtin::BI__sync_sub_and_fetch:
992 case Builtin::BI__sync_sub_and_fetch_1:
993 case Builtin::BI__sync_sub_and_fetch_2:
994 case Builtin::BI__sync_sub_and_fetch_4:
995 case Builtin::BI__sync_sub_and_fetch_8:
996 case Builtin::BI__sync_sub_and_fetch_16:
997 BuiltinIndex = 6;
998 break;
999
1000 case Builtin::BI__sync_and_and_fetch:
1001 case Builtin::BI__sync_and_and_fetch_1:
1002 case Builtin::BI__sync_and_and_fetch_2:
1003 case Builtin::BI__sync_and_and_fetch_4:
1004 case Builtin::BI__sync_and_and_fetch_8:
1005 case Builtin::BI__sync_and_and_fetch_16:
1006 BuiltinIndex = 7;
1007 break;
1008
1009 case Builtin::BI__sync_or_and_fetch:
1010 case Builtin::BI__sync_or_and_fetch_1:
1011 case Builtin::BI__sync_or_and_fetch_2:
1012 case Builtin::BI__sync_or_and_fetch_4:
1013 case Builtin::BI__sync_or_and_fetch_8:
1014 case Builtin::BI__sync_or_and_fetch_16:
1015 BuiltinIndex = 8;
1016 break;
1017
1018 case Builtin::BI__sync_xor_and_fetch:
1019 case Builtin::BI__sync_xor_and_fetch_1:
1020 case Builtin::BI__sync_xor_and_fetch_2:
1021 case Builtin::BI__sync_xor_and_fetch_4:
1022 case Builtin::BI__sync_xor_and_fetch_8:
1023 case Builtin::BI__sync_xor_and_fetch_16:
1024 BuiltinIndex = 9;
1025 break;
Mike Stump1eb44332009-09-09 15:08:12 +00001026
Chris Lattner5caa3702009-05-08 06:58:22 +00001027 case Builtin::BI__sync_val_compare_and_swap:
Douglas Gregora9766412011-11-28 16:30:08 +00001028 case Builtin::BI__sync_val_compare_and_swap_1:
1029 case Builtin::BI__sync_val_compare_and_swap_2:
1030 case Builtin::BI__sync_val_compare_and_swap_4:
1031 case Builtin::BI__sync_val_compare_and_swap_8:
1032 case Builtin::BI__sync_val_compare_and_swap_16:
Daniel Dunbar7eff7c42010-03-25 17:13:09 +00001033 BuiltinIndex = 10;
Chris Lattner5caa3702009-05-08 06:58:22 +00001034 NumFixed = 2;
1035 break;
Douglas Gregora9766412011-11-28 16:30:08 +00001036
Chris Lattner5caa3702009-05-08 06:58:22 +00001037 case Builtin::BI__sync_bool_compare_and_swap:
Douglas Gregora9766412011-11-28 16:30:08 +00001038 case Builtin::BI__sync_bool_compare_and_swap_1:
1039 case Builtin::BI__sync_bool_compare_and_swap_2:
1040 case Builtin::BI__sync_bool_compare_and_swap_4:
1041 case Builtin::BI__sync_bool_compare_and_swap_8:
1042 case Builtin::BI__sync_bool_compare_and_swap_16:
Daniel Dunbar7eff7c42010-03-25 17:13:09 +00001043 BuiltinIndex = 11;
Chris Lattner5caa3702009-05-08 06:58:22 +00001044 NumFixed = 2;
Chandler Carruth8d13d222010-07-18 20:54:12 +00001045 ResultType = Context.BoolTy;
Chris Lattner5caa3702009-05-08 06:58:22 +00001046 break;
Douglas Gregora9766412011-11-28 16:30:08 +00001047
1048 case Builtin::BI__sync_lock_test_and_set:
1049 case Builtin::BI__sync_lock_test_and_set_1:
1050 case Builtin::BI__sync_lock_test_and_set_2:
1051 case Builtin::BI__sync_lock_test_and_set_4:
1052 case Builtin::BI__sync_lock_test_and_set_8:
1053 case Builtin::BI__sync_lock_test_and_set_16:
1054 BuiltinIndex = 12;
1055 break;
1056
Chris Lattner5caa3702009-05-08 06:58:22 +00001057 case Builtin::BI__sync_lock_release:
Douglas Gregora9766412011-11-28 16:30:08 +00001058 case Builtin::BI__sync_lock_release_1:
1059 case Builtin::BI__sync_lock_release_2:
1060 case Builtin::BI__sync_lock_release_4:
1061 case Builtin::BI__sync_lock_release_8:
1062 case Builtin::BI__sync_lock_release_16:
Daniel Dunbar7eff7c42010-03-25 17:13:09 +00001063 BuiltinIndex = 13;
Chris Lattner5caa3702009-05-08 06:58:22 +00001064 NumFixed = 0;
Chandler Carruth8d13d222010-07-18 20:54:12 +00001065 ResultType = Context.VoidTy;
Chris Lattner5caa3702009-05-08 06:58:22 +00001066 break;
Douglas Gregora9766412011-11-28 16:30:08 +00001067
1068 case Builtin::BI__sync_swap:
1069 case Builtin::BI__sync_swap_1:
1070 case Builtin::BI__sync_swap_2:
1071 case Builtin::BI__sync_swap_4:
1072 case Builtin::BI__sync_swap_8:
1073 case Builtin::BI__sync_swap_16:
1074 BuiltinIndex = 14;
1075 break;
Chris Lattner5caa3702009-05-08 06:58:22 +00001076 }
Mike Stump1eb44332009-09-09 15:08:12 +00001077
Chris Lattner5caa3702009-05-08 06:58:22 +00001078 // Now that we know how many fixed arguments we expect, first check that we
1079 // have at least that many.
Chandler Carruthd2014572010-07-09 18:59:35 +00001080 if (TheCall->getNumArgs() < 1+NumFixed) {
1081 Diag(TheCall->getLocEnd(), diag::err_typecheck_call_too_few_args_at_least)
1082 << 0 << 1+NumFixed << TheCall->getNumArgs()
1083 << TheCall->getCallee()->getSourceRange();
1084 return ExprError();
1085 }
Mike Stump1eb44332009-09-09 15:08:12 +00001086
Chris Lattnere7ac0a92009-05-08 15:36:58 +00001087 // Get the decl for the concrete builtin from this, we can tell what the
1088 // concrete integer type we should convert to is.
1089 unsigned NewBuiltinID = BuiltinIndices[BuiltinIndex][SizeIndex];
1090 const char *NewBuiltinName = Context.BuiltinInfo.GetName(NewBuiltinID);
1091 IdentifierInfo *NewBuiltinII = PP.getIdentifierInfo(NewBuiltinName);
Mike Stump1eb44332009-09-09 15:08:12 +00001092 FunctionDecl *NewBuiltinDecl =
Chris Lattnere7ac0a92009-05-08 15:36:58 +00001093 cast<FunctionDecl>(LazilyCreateBuiltin(NewBuiltinII, NewBuiltinID,
1094 TUScope, false, DRE->getLocStart()));
Chandler Carruthd2014572010-07-09 18:59:35 +00001095
John McCallf871d0c2010-08-07 06:22:56 +00001096 // The first argument --- the pointer --- has a fixed type; we
1097 // deduce the types of the rest of the arguments accordingly. Walk
1098 // the remaining arguments, converting them to the deduced value type.
Chris Lattner5caa3702009-05-08 06:58:22 +00001099 for (unsigned i = 0; i != NumFixed; ++i) {
John Wiegley429bb272011-04-08 18:41:53 +00001100 ExprResult Arg = TheCall->getArg(i+1);
Mike Stump1eb44332009-09-09 15:08:12 +00001101
Chris Lattner5caa3702009-05-08 06:58:22 +00001102 // GCC does an implicit conversion to the pointer or integer ValType. This
1103 // can fail in some cases (1i -> int**), check for this error case now.
John McCallb45ae252011-10-05 07:41:44 +00001104 // Initialize the argument.
1105 InitializedEntity Entity = InitializedEntity::InitializeParameter(Context,
1106 ValType, /*consume*/ false);
1107 Arg = PerformCopyInitialization(Entity, SourceLocation(), Arg);
John Wiegley429bb272011-04-08 18:41:53 +00001108 if (Arg.isInvalid())
Chandler Carruthd2014572010-07-09 18:59:35 +00001109 return ExprError();
Mike Stump1eb44332009-09-09 15:08:12 +00001110
Chris Lattner5caa3702009-05-08 06:58:22 +00001111 // Okay, we have something that *can* be converted to the right type. Check
1112 // to see if there is a potentially weird extension going on here. This can
1113 // happen when you do an atomic operation on something like an char* and
1114 // pass in 42. The 42 gets converted to char. This is even more strange
1115 // for things like 45.123 -> char, etc.
Mike Stump1eb44332009-09-09 15:08:12 +00001116 // FIXME: Do this check.
John McCallb45ae252011-10-05 07:41:44 +00001117 TheCall->setArg(i+1, Arg.take());
Chris Lattner5caa3702009-05-08 06:58:22 +00001118 }
Mike Stump1eb44332009-09-09 15:08:12 +00001119
Douglas Gregorbbcb7ea2011-09-09 16:51:10 +00001120 ASTContext& Context = this->getASTContext();
1121
1122 // Create a new DeclRefExpr to refer to the new decl.
1123 DeclRefExpr* NewDRE = DeclRefExpr::Create(
1124 Context,
1125 DRE->getQualifierLoc(),
Abramo Bagnarae4b92762012-01-27 09:46:47 +00001126 SourceLocation(),
Douglas Gregorbbcb7ea2011-09-09 16:51:10 +00001127 NewBuiltinDecl,
John McCallf4b88a42012-03-10 09:33:50 +00001128 /*enclosing*/ false,
Douglas Gregorbbcb7ea2011-09-09 16:51:10 +00001129 DRE->getLocation(),
1130 NewBuiltinDecl->getType(),
1131 DRE->getValueKind());
Mike Stump1eb44332009-09-09 15:08:12 +00001132
Chris Lattner5caa3702009-05-08 06:58:22 +00001133 // Set the callee in the CallExpr.
1134 // FIXME: This leaks the original parens and implicit casts.
Douglas Gregorbbcb7ea2011-09-09 16:51:10 +00001135 ExprResult PromotedCall = UsualUnaryConversions(NewDRE);
John Wiegley429bb272011-04-08 18:41:53 +00001136 if (PromotedCall.isInvalid())
1137 return ExprError();
1138 TheCall->setCallee(PromotedCall.take());
Mike Stump1eb44332009-09-09 15:08:12 +00001139
Chandler Carruthdb4325b2010-07-18 07:23:17 +00001140 // Change the result type of the call to match the original value type. This
1141 // is arbitrary, but the codegen for these builtins ins design to handle it
1142 // gracefully.
Chandler Carruth8d13d222010-07-18 20:54:12 +00001143 TheCall->setType(ResultType);
Chandler Carruthd2014572010-07-09 18:59:35 +00001144
1145 return move(TheCallResult);
Chris Lattner5caa3702009-05-08 06:58:22 +00001146}
1147
Chris Lattner69039812009-02-18 06:01:06 +00001148/// CheckObjCString - Checks that the argument to the builtin
Anders Carlsson71993dd2007-08-17 05:31:46 +00001149/// CFString constructor is correct
Steve Narofffd942622009-04-13 20:26:29 +00001150/// Note: It might also make sense to do the UTF-16 conversion here (would
1151/// simplify the backend).
Chris Lattner69039812009-02-18 06:01:06 +00001152bool Sema::CheckObjCString(Expr *Arg) {
Chris Lattner56f34942008-02-13 01:02:39 +00001153 Arg = Arg->IgnoreParenCasts();
Anders Carlsson71993dd2007-08-17 05:31:46 +00001154 StringLiteral *Literal = dyn_cast<StringLiteral>(Arg);
1155
Douglas Gregor5cee1192011-07-27 05:40:30 +00001156 if (!Literal || !Literal->isAscii()) {
Chris Lattnerfa25bbb2008-11-19 05:08:23 +00001157 Diag(Arg->getLocStart(), diag::err_cfstring_literal_not_string_constant)
1158 << Arg->getSourceRange();
Anders Carlsson9cdc4d32007-08-17 15:44:17 +00001159 return true;
Anders Carlsson71993dd2007-08-17 05:31:46 +00001160 }
Mike Stump1eb44332009-09-09 15:08:12 +00001161
Fariborz Jahanian7da71022010-09-07 19:38:13 +00001162 if (Literal->containsNonAsciiOrNull()) {
Chris Lattner5f9e2722011-07-23 10:55:15 +00001163 StringRef String = Literal->getString();
Fariborz Jahanian7da71022010-09-07 19:38:13 +00001164 unsigned NumBytes = String.size();
Chris Lattner5f9e2722011-07-23 10:55:15 +00001165 SmallVector<UTF16, 128> ToBuf(NumBytes);
Fariborz Jahanian7da71022010-09-07 19:38:13 +00001166 const UTF8 *FromPtr = (UTF8 *)String.data();
1167 UTF16 *ToPtr = &ToBuf[0];
1168
1169 ConversionResult Result = ConvertUTF8toUTF16(&FromPtr, FromPtr + NumBytes,
1170 &ToPtr, ToPtr + NumBytes,
1171 strictConversion);
1172 // Check for conversion failure.
1173 if (Result != conversionOK)
1174 Diag(Arg->getLocStart(),
1175 diag::warn_cfstring_truncated) << Arg->getSourceRange();
1176 }
Anders Carlsson9cdc4d32007-08-17 15:44:17 +00001177 return false;
Chris Lattner59907c42007-08-10 20:18:51 +00001178}
1179
Chris Lattnerc27c6652007-12-20 00:05:45 +00001180/// SemaBuiltinVAStart - Check the arguments to __builtin_va_start for validity.
1181/// Emit an error and return true on failure, return false on success.
Chris Lattner925e60d2007-12-28 05:29:59 +00001182bool Sema::SemaBuiltinVAStart(CallExpr *TheCall) {
1183 Expr *Fn = TheCall->getCallee();
1184 if (TheCall->getNumArgs() > 2) {
Chris Lattner2c21a072008-11-21 18:44:24 +00001185 Diag(TheCall->getArg(2)->getLocStart(),
Chris Lattnerfa25bbb2008-11-19 05:08:23 +00001186 diag::err_typecheck_call_too_many_args)
Eric Christopherccfa9632010-04-16 04:56:46 +00001187 << 0 /*function call*/ << 2 << TheCall->getNumArgs()
1188 << Fn->getSourceRange()
Mike Stump1eb44332009-09-09 15:08:12 +00001189 << SourceRange(TheCall->getArg(2)->getLocStart(),
Chris Lattnerfa25bbb2008-11-19 05:08:23 +00001190 (*(TheCall->arg_end()-1))->getLocEnd());
Chris Lattner30ce3442007-12-19 23:59:04 +00001191 return true;
1192 }
Eli Friedman56f20ae2008-12-15 22:05:35 +00001193
1194 if (TheCall->getNumArgs() < 2) {
Eric Christopherd77b9a22010-04-16 04:48:22 +00001195 return Diag(TheCall->getLocEnd(),
1196 diag::err_typecheck_call_too_few_args_at_least)
1197 << 0 /*function call*/ << 2 << TheCall->getNumArgs();
Eli Friedman56f20ae2008-12-15 22:05:35 +00001198 }
1199
John McCall5f8d6042011-08-27 01:09:30 +00001200 // Type-check the first argument normally.
1201 if (checkBuiltinArgument(*this, TheCall, 0))
1202 return true;
1203
Chris Lattnerc27c6652007-12-20 00:05:45 +00001204 // Determine whether the current function is variadic or not.
Douglas Gregor9ea9bdb2010-03-01 23:15:13 +00001205 BlockScopeInfo *CurBlock = getCurBlock();
Chris Lattnerc27c6652007-12-20 00:05:45 +00001206 bool isVariadic;
Steve Naroffcd9c5142009-04-15 19:33:47 +00001207 if (CurBlock)
John McCallc71a4912010-06-04 19:02:56 +00001208 isVariadic = CurBlock->TheDecl->isVariadic();
Ted Kremenek9498d382010-04-29 16:49:01 +00001209 else if (FunctionDecl *FD = getCurFunctionDecl())
1210 isVariadic = FD->isVariadic();
1211 else
Argyrios Kyrtzidis53d0ea52008-06-28 06:07:14 +00001212 isVariadic = getCurMethodDecl()->isVariadic();
Mike Stump1eb44332009-09-09 15:08:12 +00001213
Chris Lattnerc27c6652007-12-20 00:05:45 +00001214 if (!isVariadic) {
Chris Lattner30ce3442007-12-19 23:59:04 +00001215 Diag(Fn->getLocStart(), diag::err_va_start_used_in_non_variadic_function);
1216 return true;
1217 }
Mike Stump1eb44332009-09-09 15:08:12 +00001218
Chris Lattner30ce3442007-12-19 23:59:04 +00001219 // Verify that the second argument to the builtin is the last argument of the
1220 // current function or method.
1221 bool SecondArgIsLastNamedArgument = false;
Anders Carlssone2c14102008-02-13 01:22:59 +00001222 const Expr *Arg = TheCall->getArg(1)->IgnoreParenCasts();
Mike Stump1eb44332009-09-09 15:08:12 +00001223
Anders Carlsson88cf2262008-02-11 04:20:54 +00001224 if (const DeclRefExpr *DR = dyn_cast<DeclRefExpr>(Arg)) {
1225 if (const ParmVarDecl *PV = dyn_cast<ParmVarDecl>(DR->getDecl())) {
Chris Lattner30ce3442007-12-19 23:59:04 +00001226 // FIXME: This isn't correct for methods (results in bogus warning).
1227 // Get the last formal in the current function.
Anders Carlsson88cf2262008-02-11 04:20:54 +00001228 const ParmVarDecl *LastArg;
Steve Naroffcd9c5142009-04-15 19:33:47 +00001229 if (CurBlock)
1230 LastArg = *(CurBlock->TheDecl->param_end()-1);
1231 else if (FunctionDecl *FD = getCurFunctionDecl())
Chris Lattner371f2582008-12-04 23:50:19 +00001232 LastArg = *(FD->param_end()-1);
Chris Lattner30ce3442007-12-19 23:59:04 +00001233 else
Argyrios Kyrtzidis53d0ea52008-06-28 06:07:14 +00001234 LastArg = *(getCurMethodDecl()->param_end()-1);
Chris Lattner30ce3442007-12-19 23:59:04 +00001235 SecondArgIsLastNamedArgument = PV == LastArg;
1236 }
1237 }
Mike Stump1eb44332009-09-09 15:08:12 +00001238
Chris Lattner30ce3442007-12-19 23:59:04 +00001239 if (!SecondArgIsLastNamedArgument)
Mike Stump1eb44332009-09-09 15:08:12 +00001240 Diag(TheCall->getArg(1)->getLocStart(),
Chris Lattner30ce3442007-12-19 23:59:04 +00001241 diag::warn_second_parameter_of_va_start_not_last_named_argument);
1242 return false;
Eli Friedman6cfda232008-05-20 08:23:37 +00001243}
Chris Lattner30ce3442007-12-19 23:59:04 +00001244
Chris Lattner1b9a0792007-12-20 00:26:33 +00001245/// SemaBuiltinUnorderedCompare - Handle functions like __builtin_isgreater and
1246/// friends. This is declared to take (...), so we have to check everything.
Chris Lattner925e60d2007-12-28 05:29:59 +00001247bool Sema::SemaBuiltinUnorderedCompare(CallExpr *TheCall) {
1248 if (TheCall->getNumArgs() < 2)
Chris Lattner2c21a072008-11-21 18:44:24 +00001249 return Diag(TheCall->getLocEnd(), diag::err_typecheck_call_too_few_args)
Eric Christopherd77b9a22010-04-16 04:48:22 +00001250 << 0 << 2 << TheCall->getNumArgs()/*function call*/;
Chris Lattner925e60d2007-12-28 05:29:59 +00001251 if (TheCall->getNumArgs() > 2)
Mike Stump1eb44332009-09-09 15:08:12 +00001252 return Diag(TheCall->getArg(2)->getLocStart(),
Chris Lattnerfa25bbb2008-11-19 05:08:23 +00001253 diag::err_typecheck_call_too_many_args)
Eric Christopherccfa9632010-04-16 04:56:46 +00001254 << 0 /*function call*/ << 2 << TheCall->getNumArgs()
Chris Lattnerfa25bbb2008-11-19 05:08:23 +00001255 << SourceRange(TheCall->getArg(2)->getLocStart(),
1256 (*(TheCall->arg_end()-1))->getLocEnd());
Mike Stump1eb44332009-09-09 15:08:12 +00001257
John Wiegley429bb272011-04-08 18:41:53 +00001258 ExprResult OrigArg0 = TheCall->getArg(0);
1259 ExprResult OrigArg1 = TheCall->getArg(1);
Douglas Gregorcde01732009-05-19 22:10:17 +00001260
Chris Lattner1b9a0792007-12-20 00:26:33 +00001261 // Do standard promotions between the two arguments, returning their common
1262 // type.
Chris Lattner925e60d2007-12-28 05:29:59 +00001263 QualType Res = UsualArithmeticConversions(OrigArg0, OrigArg1, false);
John Wiegley429bb272011-04-08 18:41:53 +00001264 if (OrigArg0.isInvalid() || OrigArg1.isInvalid())
1265 return true;
Daniel Dunbar403bc2b2009-02-19 19:28:43 +00001266
1267 // Make sure any conversions are pushed back into the call; this is
1268 // type safe since unordered compare builtins are declared as "_Bool
1269 // foo(...)".
John Wiegley429bb272011-04-08 18:41:53 +00001270 TheCall->setArg(0, OrigArg0.get());
1271 TheCall->setArg(1, OrigArg1.get());
Mike Stump1eb44332009-09-09 15:08:12 +00001272
John Wiegley429bb272011-04-08 18:41:53 +00001273 if (OrigArg0.get()->isTypeDependent() || OrigArg1.get()->isTypeDependent())
Douglas Gregorcde01732009-05-19 22:10:17 +00001274 return false;
1275
Chris Lattner1b9a0792007-12-20 00:26:33 +00001276 // If the common type isn't a real floating type, then the arguments were
1277 // invalid for this operation.
1278 if (!Res->isRealFloatingType())
John Wiegley429bb272011-04-08 18:41:53 +00001279 return Diag(OrigArg0.get()->getLocStart(),
Chris Lattnerfa25bbb2008-11-19 05:08:23 +00001280 diag::err_typecheck_call_invalid_ordered_compare)
John Wiegley429bb272011-04-08 18:41:53 +00001281 << OrigArg0.get()->getType() << OrigArg1.get()->getType()
1282 << SourceRange(OrigArg0.get()->getLocStart(), OrigArg1.get()->getLocEnd());
Mike Stump1eb44332009-09-09 15:08:12 +00001283
Chris Lattner1b9a0792007-12-20 00:26:33 +00001284 return false;
1285}
1286
Benjamin Kramere771a7a2010-02-15 22:42:31 +00001287/// SemaBuiltinSemaBuiltinFPClassification - Handle functions like
1288/// __builtin_isnan and friends. This is declared to take (...), so we have
Benjamin Kramer3b1e26b2010-02-16 10:07:31 +00001289/// to check everything. We expect the last argument to be a floating point
1290/// value.
1291bool Sema::SemaBuiltinFPClassification(CallExpr *TheCall, unsigned NumArgs) {
1292 if (TheCall->getNumArgs() < NumArgs)
Eli Friedman9ac6f622009-08-31 20:06:00 +00001293 return Diag(TheCall->getLocEnd(), diag::err_typecheck_call_too_few_args)
Eric Christopherd77b9a22010-04-16 04:48:22 +00001294 << 0 << NumArgs << TheCall->getNumArgs()/*function call*/;
Benjamin Kramer3b1e26b2010-02-16 10:07:31 +00001295 if (TheCall->getNumArgs() > NumArgs)
1296 return Diag(TheCall->getArg(NumArgs)->getLocStart(),
Eli Friedman9ac6f622009-08-31 20:06:00 +00001297 diag::err_typecheck_call_too_many_args)
Eric Christopherccfa9632010-04-16 04:56:46 +00001298 << 0 /*function call*/ << NumArgs << TheCall->getNumArgs()
Benjamin Kramer3b1e26b2010-02-16 10:07:31 +00001299 << SourceRange(TheCall->getArg(NumArgs)->getLocStart(),
Eli Friedman9ac6f622009-08-31 20:06:00 +00001300 (*(TheCall->arg_end()-1))->getLocEnd());
1301
Benjamin Kramer3b1e26b2010-02-16 10:07:31 +00001302 Expr *OrigArg = TheCall->getArg(NumArgs-1);
Mike Stump1eb44332009-09-09 15:08:12 +00001303
Eli Friedman9ac6f622009-08-31 20:06:00 +00001304 if (OrigArg->isTypeDependent())
1305 return false;
1306
Chris Lattner81368fb2010-05-06 05:50:07 +00001307 // This operation requires a non-_Complex floating-point number.
Eli Friedman9ac6f622009-08-31 20:06:00 +00001308 if (!OrigArg->getType()->isRealFloatingType())
Mike Stump1eb44332009-09-09 15:08:12 +00001309 return Diag(OrigArg->getLocStart(),
Eli Friedman9ac6f622009-08-31 20:06:00 +00001310 diag::err_typecheck_call_invalid_unary_fp)
1311 << OrigArg->getType() << OrigArg->getSourceRange();
Mike Stump1eb44332009-09-09 15:08:12 +00001312
Chris Lattner81368fb2010-05-06 05:50:07 +00001313 // If this is an implicit conversion from float -> double, remove it.
1314 if (ImplicitCastExpr *Cast = dyn_cast<ImplicitCastExpr>(OrigArg)) {
1315 Expr *CastArg = Cast->getSubExpr();
1316 if (CastArg->getType()->isSpecificBuiltinType(BuiltinType::Float)) {
1317 assert(Cast->getType()->isSpecificBuiltinType(BuiltinType::Double) &&
1318 "promotion from float to double is the only expected cast here");
1319 Cast->setSubExpr(0);
Chris Lattner81368fb2010-05-06 05:50:07 +00001320 TheCall->setArg(NumArgs-1, CastArg);
Chris Lattner81368fb2010-05-06 05:50:07 +00001321 }
1322 }
1323
Eli Friedman9ac6f622009-08-31 20:06:00 +00001324 return false;
1325}
1326
Eli Friedmand38617c2008-05-14 19:38:39 +00001327/// SemaBuiltinShuffleVector - Handle __builtin_shufflevector.
1328// This is declared to take (...), so we have to check everything.
John McCall60d7b3a2010-08-24 06:29:42 +00001329ExprResult Sema::SemaBuiltinShuffleVector(CallExpr *TheCall) {
Nate Begeman37b6a572010-06-08 00:16:34 +00001330 if (TheCall->getNumArgs() < 2)
Sebastian Redl0eb23302009-01-19 00:08:26 +00001331 return ExprError(Diag(TheCall->getLocEnd(),
Eric Christopherd77b9a22010-04-16 04:48:22 +00001332 diag::err_typecheck_call_too_few_args_at_least)
Nate Begeman37b6a572010-06-08 00:16:34 +00001333 << 0 /*function call*/ << 2 << TheCall->getNumArgs()
Eric Christopherd77b9a22010-04-16 04:48:22 +00001334 << TheCall->getSourceRange());
Eli Friedmand38617c2008-05-14 19:38:39 +00001335
Nate Begeman37b6a572010-06-08 00:16:34 +00001336 // Determine which of the following types of shufflevector we're checking:
1337 // 1) unary, vector mask: (lhs, mask)
1338 // 2) binary, vector mask: (lhs, rhs, mask)
1339 // 3) binary, scalar mask: (lhs, rhs, index, ..., index)
1340 QualType resType = TheCall->getArg(0)->getType();
1341 unsigned numElements = 0;
1342
Douglas Gregorcde01732009-05-19 22:10:17 +00001343 if (!TheCall->getArg(0)->isTypeDependent() &&
1344 !TheCall->getArg(1)->isTypeDependent()) {
Nate Begeman37b6a572010-06-08 00:16:34 +00001345 QualType LHSType = TheCall->getArg(0)->getType();
1346 QualType RHSType = TheCall->getArg(1)->getType();
1347
1348 if (!LHSType->isVectorType() || !RHSType->isVectorType()) {
Douglas Gregorcde01732009-05-19 22:10:17 +00001349 Diag(TheCall->getLocStart(), diag::err_shufflevector_non_vector)
Mike Stump1eb44332009-09-09 15:08:12 +00001350 << SourceRange(TheCall->getArg(0)->getLocStart(),
Douglas Gregorcde01732009-05-19 22:10:17 +00001351 TheCall->getArg(1)->getLocEnd());
1352 return ExprError();
1353 }
Nate Begeman37b6a572010-06-08 00:16:34 +00001354
1355 numElements = LHSType->getAs<VectorType>()->getNumElements();
1356 unsigned numResElements = TheCall->getNumArgs() - 2;
Mike Stump1eb44332009-09-09 15:08:12 +00001357
Nate Begeman37b6a572010-06-08 00:16:34 +00001358 // Check to see if we have a call with 2 vector arguments, the unary shuffle
1359 // with mask. If so, verify that RHS is an integer vector type with the
1360 // same number of elts as lhs.
1361 if (TheCall->getNumArgs() == 2) {
Douglas Gregorf6094622010-07-23 15:58:24 +00001362 if (!RHSType->hasIntegerRepresentation() ||
Nate Begeman37b6a572010-06-08 00:16:34 +00001363 RHSType->getAs<VectorType>()->getNumElements() != numElements)
1364 Diag(TheCall->getLocStart(), diag::err_shufflevector_incompatible_vector)
1365 << SourceRange(TheCall->getArg(1)->getLocStart(),
1366 TheCall->getArg(1)->getLocEnd());
1367 numResElements = numElements;
1368 }
1369 else if (!Context.hasSameUnqualifiedType(LHSType, RHSType)) {
Douglas Gregorcde01732009-05-19 22:10:17 +00001370 Diag(TheCall->getLocStart(), diag::err_shufflevector_incompatible_vector)
Mike Stump1eb44332009-09-09 15:08:12 +00001371 << SourceRange(TheCall->getArg(0)->getLocStart(),
Douglas Gregorcde01732009-05-19 22:10:17 +00001372 TheCall->getArg(1)->getLocEnd());
1373 return ExprError();
Nate Begeman37b6a572010-06-08 00:16:34 +00001374 } else if (numElements != numResElements) {
1375 QualType eltType = LHSType->getAs<VectorType>()->getElementType();
Chris Lattner788b0fd2010-06-23 06:00:24 +00001376 resType = Context.getVectorType(eltType, numResElements,
Bob Wilsone86d78c2010-11-10 21:56:12 +00001377 VectorType::GenericVector);
Douglas Gregorcde01732009-05-19 22:10:17 +00001378 }
Eli Friedmand38617c2008-05-14 19:38:39 +00001379 }
1380
1381 for (unsigned i = 2; i < TheCall->getNumArgs(); i++) {
Douglas Gregorcde01732009-05-19 22:10:17 +00001382 if (TheCall->getArg(i)->isTypeDependent() ||
1383 TheCall->getArg(i)->isValueDependent())
1384 continue;
1385
Nate Begeman37b6a572010-06-08 00:16:34 +00001386 llvm::APSInt Result(32);
1387 if (!TheCall->getArg(i)->isIntegerConstantExpr(Result, Context))
1388 return ExprError(Diag(TheCall->getLocStart(),
1389 diag::err_shufflevector_nonconstant_argument)
1390 << TheCall->getArg(i)->getSourceRange());
Sebastian Redl0eb23302009-01-19 00:08:26 +00001391
Chris Lattnerd1a0b6d2008-08-10 02:05:13 +00001392 if (Result.getActiveBits() > 64 || Result.getZExtValue() >= numElements*2)
Sebastian Redl0eb23302009-01-19 00:08:26 +00001393 return ExprError(Diag(TheCall->getLocStart(),
Chris Lattnerfa25bbb2008-11-19 05:08:23 +00001394 diag::err_shufflevector_argument_too_large)
Sebastian Redl0eb23302009-01-19 00:08:26 +00001395 << TheCall->getArg(i)->getSourceRange());
Eli Friedmand38617c2008-05-14 19:38:39 +00001396 }
1397
Chris Lattner5f9e2722011-07-23 10:55:15 +00001398 SmallVector<Expr*, 32> exprs;
Eli Friedmand38617c2008-05-14 19:38:39 +00001399
Chris Lattnerd1a0b6d2008-08-10 02:05:13 +00001400 for (unsigned i = 0, e = TheCall->getNumArgs(); i != e; i++) {
Eli Friedmand38617c2008-05-14 19:38:39 +00001401 exprs.push_back(TheCall->getArg(i));
1402 TheCall->setArg(i, 0);
1403 }
1404
Nate Begemana88dc302009-08-12 02:10:25 +00001405 return Owned(new (Context) ShuffleVectorExpr(Context, exprs.begin(),
Nate Begeman37b6a572010-06-08 00:16:34 +00001406 exprs.size(), resType,
Ted Kremenek8189cde2009-02-07 01:47:29 +00001407 TheCall->getCallee()->getLocStart(),
1408 TheCall->getRParenLoc()));
Eli Friedmand38617c2008-05-14 19:38:39 +00001409}
Chris Lattner30ce3442007-12-19 23:59:04 +00001410
Daniel Dunbar4493f792008-07-21 22:59:13 +00001411/// SemaBuiltinPrefetch - Handle __builtin_prefetch.
1412// This is declared to take (const void*, ...) and can take two
1413// optional constant int args.
1414bool Sema::SemaBuiltinPrefetch(CallExpr *TheCall) {
Chris Lattnerfa25bbb2008-11-19 05:08:23 +00001415 unsigned NumArgs = TheCall->getNumArgs();
Daniel Dunbar4493f792008-07-21 22:59:13 +00001416
Chris Lattnerfa25bbb2008-11-19 05:08:23 +00001417 if (NumArgs > 3)
Eric Christopherccfa9632010-04-16 04:56:46 +00001418 return Diag(TheCall->getLocEnd(),
1419 diag::err_typecheck_call_too_many_args_at_most)
1420 << 0 /*function call*/ << 3 << NumArgs
1421 << TheCall->getSourceRange();
Daniel Dunbar4493f792008-07-21 22:59:13 +00001422
1423 // Argument 0 is checked for us and the remaining arguments must be
1424 // constant integers.
Chris Lattnerfa25bbb2008-11-19 05:08:23 +00001425 for (unsigned i = 1; i != NumArgs; ++i) {
Daniel Dunbar4493f792008-07-21 22:59:13 +00001426 Expr *Arg = TheCall->getArg(i);
Eric Christopher691ebc32010-04-17 02:26:23 +00001427
Eli Friedman9aef7262009-12-04 00:30:06 +00001428 llvm::APSInt Result;
Eric Christopher691ebc32010-04-17 02:26:23 +00001429 if (SemaBuiltinConstantArg(TheCall, i, Result))
1430 return true;
Mike Stump1eb44332009-09-09 15:08:12 +00001431
Daniel Dunbar4493f792008-07-21 22:59:13 +00001432 // FIXME: gcc issues a warning and rewrites these to 0. These
1433 // seems especially odd for the third argument since the default
1434 // is 3.
Chris Lattnerfa25bbb2008-11-19 05:08:23 +00001435 if (i == 1) {
Eli Friedman9aef7262009-12-04 00:30:06 +00001436 if (Result.getLimitedValue() > 1)
Chris Lattnerfa25bbb2008-11-19 05:08:23 +00001437 return Diag(TheCall->getLocStart(), diag::err_argument_invalid_range)
Chris Lattner21fb98e2009-09-23 06:06:36 +00001438 << "0" << "1" << Arg->getSourceRange();
Daniel Dunbar4493f792008-07-21 22:59:13 +00001439 } else {
Eli Friedman9aef7262009-12-04 00:30:06 +00001440 if (Result.getLimitedValue() > 3)
Chris Lattnerfa25bbb2008-11-19 05:08:23 +00001441 return Diag(TheCall->getLocStart(), diag::err_argument_invalid_range)
Chris Lattner21fb98e2009-09-23 06:06:36 +00001442 << "0" << "3" << Arg->getSourceRange();
Daniel Dunbar4493f792008-07-21 22:59:13 +00001443 }
1444 }
1445
Chris Lattnerfa25bbb2008-11-19 05:08:23 +00001446 return false;
Daniel Dunbar4493f792008-07-21 22:59:13 +00001447}
1448
Eric Christopher691ebc32010-04-17 02:26:23 +00001449/// SemaBuiltinConstantArg - Handle a check if argument ArgNum of CallExpr
1450/// TheCall is a constant expression.
1451bool Sema::SemaBuiltinConstantArg(CallExpr *TheCall, int ArgNum,
1452 llvm::APSInt &Result) {
1453 Expr *Arg = TheCall->getArg(ArgNum);
1454 DeclRefExpr *DRE =cast<DeclRefExpr>(TheCall->getCallee()->IgnoreParenCasts());
1455 FunctionDecl *FDecl = cast<FunctionDecl>(DRE->getDecl());
1456
1457 if (Arg->isTypeDependent() || Arg->isValueDependent()) return false;
1458
1459 if (!Arg->isIntegerConstantExpr(Result, Context))
1460 return Diag(TheCall->getLocStart(), diag::err_constant_integer_arg_type)
Eric Christopher5e896552010-04-19 18:23:02 +00001461 << FDecl->getDeclName() << Arg->getSourceRange();
Eric Christopher691ebc32010-04-17 02:26:23 +00001462
Chris Lattner21fb98e2009-09-23 06:06:36 +00001463 return false;
1464}
1465
Daniel Dunbard5f8a4f2008-09-03 21:13:56 +00001466/// SemaBuiltinObjectSize - Handle __builtin_object_size(void *ptr,
1467/// int type). This simply type checks that type is one of the defined
1468/// constants (0-3).
Chris Lattnerfc8f0e12011-04-15 05:22:18 +00001469// For compatibility check 0-3, llvm only handles 0 and 2.
Daniel Dunbard5f8a4f2008-09-03 21:13:56 +00001470bool Sema::SemaBuiltinObjectSize(CallExpr *TheCall) {
Eric Christopher691ebc32010-04-17 02:26:23 +00001471 llvm::APSInt Result;
1472
1473 // Check constant-ness first.
1474 if (SemaBuiltinConstantArg(TheCall, 1, Result))
1475 return true;
1476
Daniel Dunbard5f8a4f2008-09-03 21:13:56 +00001477 Expr *Arg = TheCall->getArg(1);
Daniel Dunbard5f8a4f2008-09-03 21:13:56 +00001478 if (Result.getSExtValue() < 0 || Result.getSExtValue() > 3) {
Chris Lattnerfa25bbb2008-11-19 05:08:23 +00001479 return Diag(TheCall->getLocStart(), diag::err_argument_invalid_range)
1480 << "0" << "3" << SourceRange(Arg->getLocStart(), Arg->getLocEnd());
Daniel Dunbard5f8a4f2008-09-03 21:13:56 +00001481 }
1482
1483 return false;
1484}
1485
Eli Friedman586d6a82009-05-03 06:04:26 +00001486/// SemaBuiltinLongjmp - Handle __builtin_longjmp(void *env[5], int val).
Eli Friedmand875fed2009-05-03 04:46:36 +00001487/// This checks that val is a constant 1.
1488bool Sema::SemaBuiltinLongjmp(CallExpr *TheCall) {
1489 Expr *Arg = TheCall->getArg(1);
Eric Christopher691ebc32010-04-17 02:26:23 +00001490 llvm::APSInt Result;
Douglas Gregorcde01732009-05-19 22:10:17 +00001491
Eric Christopher691ebc32010-04-17 02:26:23 +00001492 // TODO: This is less than ideal. Overload this to take a value.
1493 if (SemaBuiltinConstantArg(TheCall, 1, Result))
1494 return true;
1495
1496 if (Result != 1)
Eli Friedmand875fed2009-05-03 04:46:36 +00001497 return Diag(TheCall->getLocStart(), diag::err_builtin_longjmp_invalid_val)
1498 << SourceRange(Arg->getLocStart(), Arg->getLocEnd());
1499
1500 return false;
1501}
1502
Ted Kremenekb43e8ad2011-02-24 23:03:04 +00001503// Handle i > 1 ? "x" : "y", recursively.
Jean-Daniel Dupas29c3f812012-01-17 20:03:31 +00001504bool Sema::SemaCheckStringLiteral(const Expr *E, Expr **Args,
1505 unsigned NumArgs, bool HasVAListArg,
Ted Kremenek826a3452010-07-16 02:11:22 +00001506 unsigned format_idx, unsigned firstDataArg,
Jean-Daniel Dupas34269df2012-01-30 08:46:47 +00001507 FormatStringType Type, bool inFunctionCall) {
Ted Kremenek4fe64412010-09-09 03:51:39 +00001508 tryAgain:
Douglas Gregorcde01732009-05-19 22:10:17 +00001509 if (E->isTypeDependent() || E->isValueDependent())
1510 return false;
Ted Kremenekd30ef872009-01-12 23:09:09 +00001511
Jean-Daniel Dupas34269df2012-01-30 08:46:47 +00001512 E = E->IgnoreParenCasts();
Peter Collingbournef111d932011-04-15 00:35:48 +00001513
David Blaikiea73cdcb2012-02-10 21:07:25 +00001514 if (E->isNullPointerConstant(Context, Expr::NPC_ValueDependentIsNotNull))
1515 // Technically -Wformat-nonliteral does not warn about this case.
1516 // The behavior of printf and friends in this case is implementation
1517 // dependent. Ideally if the format string cannot be null then
1518 // it should have a 'nonnull' attribute in the function prototype.
1519 return true;
1520
Ted Kremenekd30ef872009-01-12 23:09:09 +00001521 switch (E->getStmtClass()) {
John McCall56ca35d2011-02-17 10:25:35 +00001522 case Stmt::BinaryConditionalOperatorClass:
Ted Kremenekd30ef872009-01-12 23:09:09 +00001523 case Stmt::ConditionalOperatorClass: {
John McCall56ca35d2011-02-17 10:25:35 +00001524 const AbstractConditionalOperator *C = cast<AbstractConditionalOperator>(E);
Jean-Daniel Dupas29c3f812012-01-17 20:03:31 +00001525 return SemaCheckStringLiteral(C->getTrueExpr(), Args, NumArgs, HasVAListArg,
Jean-Daniel Dupas34269df2012-01-30 08:46:47 +00001526 format_idx, firstDataArg, Type,
Richard Trieu55733de2011-10-28 00:41:25 +00001527 inFunctionCall)
Jean-Daniel Dupas34269df2012-01-30 08:46:47 +00001528 && SemaCheckStringLiteral(C->getFalseExpr(), Args, NumArgs, HasVAListArg,
1529 format_idx, firstDataArg, Type,
1530 inFunctionCall);
Ted Kremenekd30ef872009-01-12 23:09:09 +00001531 }
1532
1533 case Stmt::ImplicitCastExprClass: {
Ted Kremenek4fe64412010-09-09 03:51:39 +00001534 E = cast<ImplicitCastExpr>(E)->getSubExpr();
1535 goto tryAgain;
Ted Kremenekd30ef872009-01-12 23:09:09 +00001536 }
1537
John McCall56ca35d2011-02-17 10:25:35 +00001538 case Stmt::OpaqueValueExprClass:
1539 if (const Expr *src = cast<OpaqueValueExpr>(E)->getSourceExpr()) {
1540 E = src;
1541 goto tryAgain;
1542 }
1543 return false;
1544
Ted Kremenekb43e8ad2011-02-24 23:03:04 +00001545 case Stmt::PredefinedExprClass:
1546 // While __func__, etc., are technically not string literals, they
1547 // cannot contain format specifiers and thus are not a security
1548 // liability.
1549 return true;
1550
Ted Kremenek082d9362009-03-20 21:35:28 +00001551 case Stmt::DeclRefExprClass: {
1552 const DeclRefExpr *DR = cast<DeclRefExpr>(E);
Mike Stump1eb44332009-09-09 15:08:12 +00001553
Ted Kremenek082d9362009-03-20 21:35:28 +00001554 // As an exception, do not flag errors for variables binding to
1555 // const string literals.
1556 if (const VarDecl *VD = dyn_cast<VarDecl>(DR->getDecl())) {
1557 bool isConstant = false;
1558 QualType T = DR->getType();
Ted Kremenekd30ef872009-01-12 23:09:09 +00001559
Ted Kremenek082d9362009-03-20 21:35:28 +00001560 if (const ArrayType *AT = Context.getAsArrayType(T)) {
1561 isConstant = AT->getElementType().isConstant(Context);
Mike Stumpac5fc7c2009-08-04 21:02:39 +00001562 } else if (const PointerType *PT = T->getAs<PointerType>()) {
Mike Stump1eb44332009-09-09 15:08:12 +00001563 isConstant = T.isConstant(Context) &&
Ted Kremenek082d9362009-03-20 21:35:28 +00001564 PT->getPointeeType().isConstant(Context);
Jean-Daniel Dupase98e5b52012-01-25 10:35:33 +00001565 } else if (T->isObjCObjectPointerType()) {
1566 // In ObjC, there is usually no "const ObjectPointer" type,
1567 // so don't check if the pointee type is constant.
1568 isConstant = T.isConstant(Context);
Ted Kremenek082d9362009-03-20 21:35:28 +00001569 }
Mike Stump1eb44332009-09-09 15:08:12 +00001570
Ted Kremenek082d9362009-03-20 21:35:28 +00001571 if (isConstant) {
Sebastian Redl31310a22010-02-01 20:16:42 +00001572 if (const Expr *Init = VD->getAnyInitializer())
Jean-Daniel Dupas29c3f812012-01-17 20:03:31 +00001573 return SemaCheckStringLiteral(Init, Args, NumArgs,
Ted Kremenek826a3452010-07-16 02:11:22 +00001574 HasVAListArg, format_idx, firstDataArg,
Jean-Daniel Dupas34269df2012-01-30 08:46:47 +00001575 Type, /*inFunctionCall*/false);
Ted Kremenek082d9362009-03-20 21:35:28 +00001576 }
Mike Stump1eb44332009-09-09 15:08:12 +00001577
Anders Carlssond966a552009-06-28 19:55:58 +00001578 // For vprintf* functions (i.e., HasVAListArg==true), we add a
1579 // special check to see if the format string is a function parameter
1580 // of the function calling the printf function. If the function
1581 // has an attribute indicating it is a printf-like function, then we
1582 // should suppress warnings concerning non-literals being used in a call
1583 // to a vprintf function. For example:
1584 //
1585 // void
1586 // logmessage(char const *fmt __attribute__ (format (printf, 1, 2)), ...){
1587 // va_list ap;
1588 // va_start(ap, fmt);
1589 // vprintf(fmt, ap); // Do NOT emit a warning about "fmt".
1590 // ...
1591 //
Jean-Daniel Dupasf57c4132012-02-21 20:00:53 +00001592 if (HasVAListArg) {
1593 if (const ParmVarDecl *PV = dyn_cast<ParmVarDecl>(VD)) {
1594 if (const NamedDecl *ND = dyn_cast<NamedDecl>(PV->getDeclContext())) {
1595 int PVIndex = PV->getFunctionScopeIndex() + 1;
1596 for (specific_attr_iterator<FormatAttr>
1597 i = ND->specific_attr_begin<FormatAttr>(),
1598 e = ND->specific_attr_end<FormatAttr>(); i != e ; ++i) {
1599 FormatAttr *PVFormat = *i;
1600 // adjust for implicit parameter
1601 if (const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(ND))
1602 if (MD->isInstance())
1603 ++PVIndex;
1604 // We also check if the formats are compatible.
1605 // We can't pass a 'scanf' string to a 'printf' function.
1606 if (PVIndex == PVFormat->getFormatIdx() &&
1607 Type == GetFormatStringType(PVFormat))
1608 return true;
1609 }
1610 }
1611 }
1612 }
Ted Kremenek082d9362009-03-20 21:35:28 +00001613 }
Mike Stump1eb44332009-09-09 15:08:12 +00001614
Ted Kremenek082d9362009-03-20 21:35:28 +00001615 return false;
1616 }
Ted Kremenekd30ef872009-01-12 23:09:09 +00001617
Jean-Daniel Dupas52aabaf2012-02-07 19:01:42 +00001618 case Stmt::CallExprClass:
1619 case Stmt::CXXMemberCallExprClass: {
Anders Carlsson8f031b32009-06-27 04:05:33 +00001620 const CallExpr *CE = cast<CallExpr>(E);
Jean-Daniel Dupas52aabaf2012-02-07 19:01:42 +00001621 if (const NamedDecl *ND = dyn_cast_or_null<NamedDecl>(CE->getCalleeDecl())) {
1622 if (const FormatArgAttr *FA = ND->getAttr<FormatArgAttr>()) {
1623 unsigned ArgIndex = FA->getFormatIdx();
1624 if (const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(ND))
1625 if (MD->isInstance())
1626 --ArgIndex;
1627 const Expr *Arg = CE->getArg(ArgIndex - 1);
Mike Stump1eb44332009-09-09 15:08:12 +00001628
Jean-Daniel Dupas52aabaf2012-02-07 19:01:42 +00001629 return SemaCheckStringLiteral(Arg, Args, NumArgs, HasVAListArg,
1630 format_idx, firstDataArg, Type,
1631 inFunctionCall);
Anders Carlsson8f031b32009-06-27 04:05:33 +00001632 }
1633 }
Mike Stump1eb44332009-09-09 15:08:12 +00001634
Anders Carlsson8f031b32009-06-27 04:05:33 +00001635 return false;
1636 }
Ted Kremenek082d9362009-03-20 21:35:28 +00001637 case Stmt::ObjCStringLiteralClass:
1638 case Stmt::StringLiteralClass: {
1639 const StringLiteral *StrE = NULL;
Mike Stump1eb44332009-09-09 15:08:12 +00001640
Ted Kremenek082d9362009-03-20 21:35:28 +00001641 if (const ObjCStringLiteral *ObjCFExpr = dyn_cast<ObjCStringLiteral>(E))
Ted Kremenekd30ef872009-01-12 23:09:09 +00001642 StrE = ObjCFExpr->getString();
1643 else
Ted Kremenek082d9362009-03-20 21:35:28 +00001644 StrE = cast<StringLiteral>(E);
Mike Stump1eb44332009-09-09 15:08:12 +00001645
Ted Kremenekd30ef872009-01-12 23:09:09 +00001646 if (StrE) {
Jean-Daniel Dupas29c3f812012-01-17 20:03:31 +00001647 CheckFormatString(StrE, E, Args, NumArgs, HasVAListArg, format_idx,
Jean-Daniel Dupas34269df2012-01-30 08:46:47 +00001648 firstDataArg, Type, inFunctionCall);
Ted Kremenekd30ef872009-01-12 23:09:09 +00001649 return true;
1650 }
Mike Stump1eb44332009-09-09 15:08:12 +00001651
Ted Kremenekd30ef872009-01-12 23:09:09 +00001652 return false;
1653 }
Mike Stump1eb44332009-09-09 15:08:12 +00001654
Ted Kremenek082d9362009-03-20 21:35:28 +00001655 default:
1656 return false;
Ted Kremenekd30ef872009-01-12 23:09:09 +00001657 }
1658}
1659
Fariborz Jahaniane898f8a2009-05-21 18:48:51 +00001660void
Mike Stump1eb44332009-09-09 15:08:12 +00001661Sema::CheckNonNullArguments(const NonNullAttr *NonNull,
Nick Lewycky909a70d2011-03-25 01:44:32 +00001662 const Expr * const *ExprArgs,
1663 SourceLocation CallSiteLoc) {
Sean Huntcf807c42010-08-18 23:23:40 +00001664 for (NonNullAttr::args_iterator i = NonNull->args_begin(),
1665 e = NonNull->args_end();
Fariborz Jahaniane898f8a2009-05-21 18:48:51 +00001666 i != e; ++i) {
Nick Lewycky909a70d2011-03-25 01:44:32 +00001667 const Expr *ArgExpr = ExprArgs[*i];
Ted Kremenek4e4b30e2010-02-16 01:46:59 +00001668 if (ArgExpr->isNullPointerConstant(Context,
Douglas Gregorce940492009-09-25 04:25:58 +00001669 Expr::NPC_ValueDependentIsNotNull))
Nick Lewycky909a70d2011-03-25 01:44:32 +00001670 Diag(CallSiteLoc, diag::warn_null_arg) << ArgExpr->getSourceRange();
Fariborz Jahaniane898f8a2009-05-21 18:48:51 +00001671 }
1672}
Ted Kremenekd30ef872009-01-12 23:09:09 +00001673
Jean-Daniel Dupas34269df2012-01-30 08:46:47 +00001674Sema::FormatStringType Sema::GetFormatStringType(const FormatAttr *Format) {
1675 return llvm::StringSwitch<FormatStringType>(Format->getType())
1676 .Case("scanf", FST_Scanf)
1677 .Cases("printf", "printf0", FST_Printf)
1678 .Cases("NSString", "CFString", FST_NSString)
1679 .Case("strftime", FST_Strftime)
1680 .Case("strfmon", FST_Strfmon)
1681 .Cases("kprintf", "cmn_err", "vcmn_err", "zcmn_err", FST_Kprintf)
1682 .Default(FST_Unknown);
1683}
1684
Ted Kremenek826a3452010-07-16 02:11:22 +00001685/// CheckPrintfScanfArguments - Check calls to printf and scanf (and similar
1686/// functions) for correct use of format strings.
Jean-Daniel Dupas29c3f812012-01-17 20:03:31 +00001687void Sema::CheckFormatArguments(const FormatAttr *Format, CallExpr *TheCall) {
1688 bool IsCXXMember = false;
Sebastian Redl4a2614e2009-11-17 18:02:24 +00001689 // The way the format attribute works in GCC, the implicit this argument
1690 // of member functions is counted. However, it doesn't appear in our own
1691 // lists, so decrement format_idx in that case.
Jean-Daniel Dupas52aabaf2012-02-07 19:01:42 +00001692 IsCXXMember = isa<CXXMemberCallExpr>(TheCall);
Jean-Daniel Dupas29c3f812012-01-17 20:03:31 +00001693 CheckFormatArguments(Format, TheCall->getArgs(), TheCall->getNumArgs(),
1694 IsCXXMember, TheCall->getRParenLoc(),
1695 TheCall->getCallee()->getSourceRange());
1696}
1697
1698void Sema::CheckFormatArguments(const FormatAttr *Format, Expr **Args,
1699 unsigned NumArgs, bool IsCXXMember,
1700 SourceLocation Loc, SourceRange Range) {
Jean-Daniel Dupas34269df2012-01-30 08:46:47 +00001701 bool HasVAListArg = Format->getFirstArg() == 0;
1702 unsigned format_idx = Format->getFormatIdx() - 1;
1703 unsigned firstDataArg = HasVAListArg ? 0 : Format->getFirstArg() - 1;
1704 if (IsCXXMember) {
1705 if (format_idx == 0)
1706 return;
1707 --format_idx;
1708 if(firstDataArg != 0)
1709 --firstDataArg;
Sebastian Redl4a2614e2009-11-17 18:02:24 +00001710 }
Jean-Daniel Dupas34269df2012-01-30 08:46:47 +00001711 CheckFormatArguments(Args, NumArgs, HasVAListArg, format_idx,
1712 firstDataArg, GetFormatStringType(Format), Loc, Range);
Jean-Daniel Dupas29c3f812012-01-17 20:03:31 +00001713}
Sebastian Redl4a2614e2009-11-17 18:02:24 +00001714
Jean-Daniel Dupas34269df2012-01-30 08:46:47 +00001715void Sema::CheckFormatArguments(Expr **Args, unsigned NumArgs,
1716 bool HasVAListArg, unsigned format_idx,
1717 unsigned firstDataArg, FormatStringType Type,
1718 SourceLocation Loc, SourceRange Range) {
Ted Kremenek826a3452010-07-16 02:11:22 +00001719 // CHECK: printf/scanf-like function is called with no format string.
Jean-Daniel Dupas29c3f812012-01-17 20:03:31 +00001720 if (format_idx >= NumArgs) {
1721 Diag(Loc, diag::warn_missing_format_string) << Range;
Ted Kremenek71895b92007-08-14 17:39:48 +00001722 return;
1723 }
Mike Stump1eb44332009-09-09 15:08:12 +00001724
Jean-Daniel Dupas29c3f812012-01-17 20:03:31 +00001725 const Expr *OrigFormatExpr = Args[format_idx]->IgnoreParenCasts();
Mike Stump1eb44332009-09-09 15:08:12 +00001726
Chris Lattner59907c42007-08-10 20:18:51 +00001727 // CHECK: format string is not a string literal.
Mike Stump1eb44332009-09-09 15:08:12 +00001728 //
Ted Kremenek71895b92007-08-14 17:39:48 +00001729 // Dynamically generated format strings are difficult to
1730 // automatically vet at compile time. Requiring that format strings
1731 // are string literals: (1) permits the checking of format strings by
1732 // the compiler and thereby (2) can practically remove the source of
1733 // many format string exploits.
Ted Kremenek7ff22b22008-06-16 18:00:42 +00001734
Mike Stump1eb44332009-09-09 15:08:12 +00001735 // Format string can be either ObjC string (e.g. @"%d") or
Ted Kremenek7ff22b22008-06-16 18:00:42 +00001736 // C string (e.g. "%d")
Mike Stump1eb44332009-09-09 15:08:12 +00001737 // ObjC string uses the same format specifiers as C string, so we can use
Ted Kremenek7ff22b22008-06-16 18:00:42 +00001738 // the same format string checking logic for both ObjC and C strings.
Jean-Daniel Dupas29c3f812012-01-17 20:03:31 +00001739 if (SemaCheckStringLiteral(OrigFormatExpr, Args, NumArgs, HasVAListArg,
Jean-Daniel Dupas34269df2012-01-30 08:46:47 +00001740 format_idx, firstDataArg, Type))
Chris Lattner1cd3e1f2009-04-29 04:49:34 +00001741 return; // Literal format string found, check done!
Ted Kremenek7ff22b22008-06-16 18:00:42 +00001742
Jean-Daniel Dupas2837a2f2012-02-07 23:10:53 +00001743 // Strftime is particular as it always uses a single 'time' argument,
1744 // so it is safe to pass a non-literal string.
1745 if (Type == FST_Strftime)
1746 return;
1747
Jean-Daniel Dupasce3aa392012-01-30 19:46:17 +00001748 // Do not emit diag when the string param is a macro expansion and the
1749 // format is either NSString or CFString. This is a hack to prevent
1750 // diag when using the NSLocalizedString and CFCopyLocalizedString macros
1751 // which are usually used in place of NS and CF string literals.
1752 if (Type == FST_NSString && Args[format_idx]->getLocStart().isMacroID())
1753 return;
1754
Chris Lattner655f1412009-04-29 04:59:47 +00001755 // If there are no arguments specified, warn with -Wformat-security, otherwise
1756 // warn only with -Wformat-nonliteral.
Jean-Daniel Dupas29c3f812012-01-17 20:03:31 +00001757 if (NumArgs == format_idx+1)
1758 Diag(Args[format_idx]->getLocStart(),
Ted Kremenek826a3452010-07-16 02:11:22 +00001759 diag::warn_format_nonliteral_noargs)
Chris Lattner655f1412009-04-29 04:59:47 +00001760 << OrigFormatExpr->getSourceRange();
1761 else
Jean-Daniel Dupas29c3f812012-01-17 20:03:31 +00001762 Diag(Args[format_idx]->getLocStart(),
Ted Kremenek826a3452010-07-16 02:11:22 +00001763 diag::warn_format_nonliteral)
Chris Lattner655f1412009-04-29 04:59:47 +00001764 << OrigFormatExpr->getSourceRange();
Ted Kremenekd30ef872009-01-12 23:09:09 +00001765}
Ted Kremenek71895b92007-08-14 17:39:48 +00001766
Ted Kremeneke0e53132010-01-28 23:39:18 +00001767namespace {
Ted Kremenek826a3452010-07-16 02:11:22 +00001768class CheckFormatHandler : public analyze_format_string::FormatStringHandler {
1769protected:
Ted Kremeneke0e53132010-01-28 23:39:18 +00001770 Sema &S;
1771 const StringLiteral *FExpr;
1772 const Expr *OrigFormatExpr;
Ted Kremenek6ee76532010-03-25 03:59:12 +00001773 const unsigned FirstDataArg;
Ted Kremeneke0e53132010-01-28 23:39:18 +00001774 const unsigned NumDataArgs;
1775 const bool IsObjCLiteral;
1776 const char *Beg; // Start of format string.
Ted Kremenek0d277352010-01-29 01:06:55 +00001777 const bool HasVAListArg;
Jean-Daniel Dupas29c3f812012-01-17 20:03:31 +00001778 const Expr * const *Args;
1779 const unsigned NumArgs;
Ted Kremenek0d277352010-01-29 01:06:55 +00001780 unsigned FormatIdx;
Ted Kremenek7f70dc82010-02-26 19:18:41 +00001781 llvm::BitVector CoveredArgs;
Ted Kremenekefaff192010-02-27 01:41:03 +00001782 bool usesPositionalArgs;
1783 bool atFirstArg;
Richard Trieu55733de2011-10-28 00:41:25 +00001784 bool inFunctionCall;
Ted Kremenek4e4b30e2010-02-16 01:46:59 +00001785public:
Ted Kremenek826a3452010-07-16 02:11:22 +00001786 CheckFormatHandler(Sema &s, const StringLiteral *fexpr,
Ted Kremenek6ee76532010-03-25 03:59:12 +00001787 const Expr *origFormatExpr, unsigned firstDataArg,
Ted Kremeneke0e53132010-01-28 23:39:18 +00001788 unsigned numDataArgs, bool isObjCLiteral,
Ted Kremenek0d277352010-01-29 01:06:55 +00001789 const char *beg, bool hasVAListArg,
Jean-Daniel Dupas29c3f812012-01-17 20:03:31 +00001790 Expr **args, unsigned numArgs,
1791 unsigned formatIdx, bool inFunctionCall)
Ted Kremeneke0e53132010-01-28 23:39:18 +00001792 : S(s), FExpr(fexpr), OrigFormatExpr(origFormatExpr),
Ted Kremenek6ee76532010-03-25 03:59:12 +00001793 FirstDataArg(firstDataArg),
Ted Kremenek7f70dc82010-02-26 19:18:41 +00001794 NumDataArgs(numDataArgs),
Ted Kremenek0d277352010-01-29 01:06:55 +00001795 IsObjCLiteral(isObjCLiteral), Beg(beg),
1796 HasVAListArg(hasVAListArg),
Jean-Daniel Dupas29c3f812012-01-17 20:03:31 +00001797 Args(args), NumArgs(numArgs), FormatIdx(formatIdx),
Richard Trieu55733de2011-10-28 00:41:25 +00001798 usesPositionalArgs(false), atFirstArg(true),
1799 inFunctionCall(inFunctionCall) {
Ted Kremenek7f70dc82010-02-26 19:18:41 +00001800 CoveredArgs.resize(numDataArgs);
1801 CoveredArgs.reset();
1802 }
Ted Kremenek4e4b30e2010-02-16 01:46:59 +00001803
Ted Kremenek07d161f2010-01-29 01:50:07 +00001804 void DoneProcessing();
Ted Kremenek4e4b30e2010-02-16 01:46:59 +00001805
Ted Kremenek826a3452010-07-16 02:11:22 +00001806 void HandleIncompleteSpecifier(const char *startSpecifier,
1807 unsigned specifierLen);
Hans Wennborg76517422012-02-22 10:17:01 +00001808
1809 void HandleNonStandardLengthModifier(
1810 const analyze_format_string::LengthModifier &LM,
1811 const char *startSpecifier, unsigned specifierLen);
1812
1813 void HandleNonStandardConversionSpecifier(
1814 const analyze_format_string::ConversionSpecifier &CS,
1815 const char *startSpecifier, unsigned specifierLen);
1816
1817 void HandleNonStandardConversionSpecification(
1818 const analyze_format_string::LengthModifier &LM,
1819 const analyze_format_string::ConversionSpecifier &CS,
1820 const char *startSpecifier, unsigned specifierLen);
1821
Hans Wennborgf8562642012-03-09 10:10:54 +00001822 virtual void HandlePosition(const char *startPos, unsigned posLen);
1823
Ted Kremenekefaff192010-02-27 01:41:03 +00001824 virtual void HandleInvalidPosition(const char *startSpecifier,
1825 unsigned specifierLen,
Ted Kremenek826a3452010-07-16 02:11:22 +00001826 analyze_format_string::PositionContext p);
Ted Kremenekefaff192010-02-27 01:41:03 +00001827
1828 virtual void HandleZeroPosition(const char *startPos, unsigned posLen);
1829
Ted Kremeneke0e53132010-01-28 23:39:18 +00001830 void HandleNullChar(const char *nullCharacter);
Ted Kremenek4e4b30e2010-02-16 01:46:59 +00001831
Richard Trieu55733de2011-10-28 00:41:25 +00001832 template <typename Range>
1833 static void EmitFormatDiagnostic(Sema &S, bool inFunctionCall,
1834 const Expr *ArgumentExpr,
1835 PartialDiagnostic PDiag,
1836 SourceLocation StringLoc,
1837 bool IsStringLocation, Range StringRange,
1838 FixItHint Fixit = FixItHint());
1839
Ted Kremenek826a3452010-07-16 02:11:22 +00001840protected:
Ted Kremenekc09b6a52010-07-19 21:25:57 +00001841 bool HandleInvalidConversionSpecifier(unsigned argIndex, SourceLocation Loc,
1842 const char *startSpec,
1843 unsigned specifierLen,
1844 const char *csStart, unsigned csLen);
Richard Trieu55733de2011-10-28 00:41:25 +00001845
1846 void HandlePositionalNonpositionalArgs(SourceLocation Loc,
1847 const char *startSpec,
1848 unsigned specifierLen);
Ted Kremenekc09b6a52010-07-19 21:25:57 +00001849
Ted Kremenekf88c8e02010-01-29 20:55:36 +00001850 SourceRange getFormatStringRange();
Ted Kremenek826a3452010-07-16 02:11:22 +00001851 CharSourceRange getSpecifierRange(const char *startSpecifier,
1852 unsigned specifierLen);
Ted Kremeneke0e53132010-01-28 23:39:18 +00001853 SourceLocation getLocationOfByte(const char *x);
Ted Kremenek4e4b30e2010-02-16 01:46:59 +00001854
Ted Kremenek0d277352010-01-29 01:06:55 +00001855 const Expr *getDataArg(unsigned i) const;
Ted Kremenek666a1972010-07-26 19:45:42 +00001856
1857 bool CheckNumArgs(const analyze_format_string::FormatSpecifier &FS,
1858 const analyze_format_string::ConversionSpecifier &CS,
1859 const char *startSpecifier, unsigned specifierLen,
1860 unsigned argIndex);
Richard Trieu55733de2011-10-28 00:41:25 +00001861
1862 template <typename Range>
1863 void EmitFormatDiagnostic(PartialDiagnostic PDiag, SourceLocation StringLoc,
1864 bool IsStringLocation, Range StringRange,
1865 FixItHint Fixit = FixItHint());
1866
1867 void CheckPositionalAndNonpositionalArgs(
1868 const analyze_format_string::FormatSpecifier *FS);
Ted Kremeneke0e53132010-01-28 23:39:18 +00001869};
1870}
1871
Ted Kremenek826a3452010-07-16 02:11:22 +00001872SourceRange CheckFormatHandler::getFormatStringRange() {
Ted Kremeneke0e53132010-01-28 23:39:18 +00001873 return OrigFormatExpr->getSourceRange();
1874}
1875
Ted Kremenek826a3452010-07-16 02:11:22 +00001876CharSourceRange CheckFormatHandler::
1877getSpecifierRange(const char *startSpecifier, unsigned specifierLen) {
Tom Care45f9b7e2010-06-21 21:21:01 +00001878 SourceLocation Start = getLocationOfByte(startSpecifier);
1879 SourceLocation End = getLocationOfByte(startSpecifier + specifierLen - 1);
1880
1881 // Advance the end SourceLocation by one due to half-open ranges.
Argyrios Kyrtzidisa64ccef2011-09-19 20:40:19 +00001882 End = End.getLocWithOffset(1);
Tom Care45f9b7e2010-06-21 21:21:01 +00001883
1884 return CharSourceRange::getCharRange(Start, End);
Ted Kremenekf88c8e02010-01-29 20:55:36 +00001885}
1886
Ted Kremenek826a3452010-07-16 02:11:22 +00001887SourceLocation CheckFormatHandler::getLocationOfByte(const char *x) {
Ted Kremenek4e4b30e2010-02-16 01:46:59 +00001888 return S.getLocationOfStringLiteralByte(FExpr, x - Beg);
Ted Kremeneke0e53132010-01-28 23:39:18 +00001889}
1890
Ted Kremenek826a3452010-07-16 02:11:22 +00001891void CheckFormatHandler::HandleIncompleteSpecifier(const char *startSpecifier,
1892 unsigned specifierLen){
Richard Trieu55733de2011-10-28 00:41:25 +00001893 EmitFormatDiagnostic(S.PDiag(diag::warn_printf_incomplete_specifier),
1894 getLocationOfByte(startSpecifier),
1895 /*IsStringLocation*/true,
1896 getSpecifierRange(startSpecifier, specifierLen));
Ted Kremenek808015a2010-01-29 03:16:21 +00001897}
1898
Hans Wennborg76517422012-02-22 10:17:01 +00001899void CheckFormatHandler::HandleNonStandardLengthModifier(
1900 const analyze_format_string::LengthModifier &LM,
1901 const char *startSpecifier, unsigned specifierLen) {
1902 EmitFormatDiagnostic(S.PDiag(diag::warn_format_non_standard) << LM.toString()
Hans Wennborgf8562642012-03-09 10:10:54 +00001903 << 0,
Hans Wennborg76517422012-02-22 10:17:01 +00001904 getLocationOfByte(LM.getStart()),
1905 /*IsStringLocation*/true,
1906 getSpecifierRange(startSpecifier, specifierLen));
1907}
1908
1909void CheckFormatHandler::HandleNonStandardConversionSpecifier(
1910 const analyze_format_string::ConversionSpecifier &CS,
1911 const char *startSpecifier, unsigned specifierLen) {
1912 EmitFormatDiagnostic(S.PDiag(diag::warn_format_non_standard) << CS.toString()
Hans Wennborgf8562642012-03-09 10:10:54 +00001913 << 1,
Hans Wennborg76517422012-02-22 10:17:01 +00001914 getLocationOfByte(CS.getStart()),
1915 /*IsStringLocation*/true,
1916 getSpecifierRange(startSpecifier, specifierLen));
1917}
1918
1919void CheckFormatHandler::HandleNonStandardConversionSpecification(
1920 const analyze_format_string::LengthModifier &LM,
1921 const analyze_format_string::ConversionSpecifier &CS,
1922 const char *startSpecifier, unsigned specifierLen) {
1923 EmitFormatDiagnostic(S.PDiag(diag::warn_format_non_standard_conversion_spec)
1924 << LM.toString() << CS.toString(),
1925 getLocationOfByte(LM.getStart()),
1926 /*IsStringLocation*/true,
1927 getSpecifierRange(startSpecifier, specifierLen));
1928}
1929
Hans Wennborgf8562642012-03-09 10:10:54 +00001930void CheckFormatHandler::HandlePosition(const char *startPos,
1931 unsigned posLen) {
1932 EmitFormatDiagnostic(S.PDiag(diag::warn_format_non_standard_positional_arg),
1933 getLocationOfByte(startPos),
1934 /*IsStringLocation*/true,
1935 getSpecifierRange(startPos, posLen));
1936}
1937
Ted Kremenekefaff192010-02-27 01:41:03 +00001938void
Ted Kremenek826a3452010-07-16 02:11:22 +00001939CheckFormatHandler::HandleInvalidPosition(const char *startPos, unsigned posLen,
1940 analyze_format_string::PositionContext p) {
Richard Trieu55733de2011-10-28 00:41:25 +00001941 EmitFormatDiagnostic(S.PDiag(diag::warn_format_invalid_positional_specifier)
1942 << (unsigned) p,
1943 getLocationOfByte(startPos), /*IsStringLocation*/true,
1944 getSpecifierRange(startPos, posLen));
Ted Kremenekefaff192010-02-27 01:41:03 +00001945}
1946
Ted Kremenek826a3452010-07-16 02:11:22 +00001947void CheckFormatHandler::HandleZeroPosition(const char *startPos,
Ted Kremenekefaff192010-02-27 01:41:03 +00001948 unsigned posLen) {
Richard Trieu55733de2011-10-28 00:41:25 +00001949 EmitFormatDiagnostic(S.PDiag(diag::warn_format_zero_positional_specifier),
1950 getLocationOfByte(startPos),
1951 /*IsStringLocation*/true,
1952 getSpecifierRange(startPos, posLen));
Ted Kremenekefaff192010-02-27 01:41:03 +00001953}
1954
Ted Kremenek826a3452010-07-16 02:11:22 +00001955void CheckFormatHandler::HandleNullChar(const char *nullCharacter) {
Ted Kremenek0c069442011-03-15 21:18:48 +00001956 if (!IsObjCLiteral) {
1957 // The presence of a null character is likely an error.
Richard Trieu55733de2011-10-28 00:41:25 +00001958 EmitFormatDiagnostic(
1959 S.PDiag(diag::warn_printf_format_string_contains_null_char),
1960 getLocationOfByte(nullCharacter), /*IsStringLocation*/true,
1961 getFormatStringRange());
Ted Kremenek0c069442011-03-15 21:18:48 +00001962 }
Ted Kremenek826a3452010-07-16 02:11:22 +00001963}
Ted Kremenek4e4b30e2010-02-16 01:46:59 +00001964
Ted Kremenek826a3452010-07-16 02:11:22 +00001965const Expr *CheckFormatHandler::getDataArg(unsigned i) const {
Jean-Daniel Dupas29c3f812012-01-17 20:03:31 +00001966 return Args[FirstDataArg + i];
Ted Kremenek826a3452010-07-16 02:11:22 +00001967}
1968
1969void CheckFormatHandler::DoneProcessing() {
1970 // Does the number of data arguments exceed the number of
1971 // format conversions in the format string?
1972 if (!HasVAListArg) {
1973 // Find any arguments that weren't covered.
1974 CoveredArgs.flip();
1975 signed notCoveredArg = CoveredArgs.find_first();
1976 if (notCoveredArg >= 0) {
1977 assert((unsigned)notCoveredArg < NumDataArgs);
Richard Trieu55733de2011-10-28 00:41:25 +00001978 EmitFormatDiagnostic(S.PDiag(diag::warn_printf_data_arg_not_used),
1979 getDataArg((unsigned) notCoveredArg)->getLocStart(),
1980 /*IsStringLocation*/false, getFormatStringRange());
Ted Kremenek826a3452010-07-16 02:11:22 +00001981 }
1982 }
1983}
1984
Ted Kremenekc09b6a52010-07-19 21:25:57 +00001985bool
1986CheckFormatHandler::HandleInvalidConversionSpecifier(unsigned argIndex,
1987 SourceLocation Loc,
1988 const char *startSpec,
1989 unsigned specifierLen,
1990 const char *csStart,
1991 unsigned csLen) {
1992
1993 bool keepGoing = true;
1994 if (argIndex < NumDataArgs) {
1995 // Consider the argument coverered, even though the specifier doesn't
1996 // make sense.
1997 CoveredArgs.set(argIndex);
1998 }
1999 else {
2000 // If argIndex exceeds the number of data arguments we
2001 // don't issue a warning because that is just a cascade of warnings (and
2002 // they may have intended '%%' anyway). We don't want to continue processing
2003 // the format string after this point, however, as we will like just get
2004 // gibberish when trying to match arguments.
2005 keepGoing = false;
2006 }
2007
Richard Trieu55733de2011-10-28 00:41:25 +00002008 EmitFormatDiagnostic(S.PDiag(diag::warn_format_invalid_conversion)
2009 << StringRef(csStart, csLen),
2010 Loc, /*IsStringLocation*/true,
2011 getSpecifierRange(startSpec, specifierLen));
Ted Kremenekc09b6a52010-07-19 21:25:57 +00002012
2013 return keepGoing;
2014}
2015
Richard Trieu55733de2011-10-28 00:41:25 +00002016void
2017CheckFormatHandler::HandlePositionalNonpositionalArgs(SourceLocation Loc,
2018 const char *startSpec,
2019 unsigned specifierLen) {
2020 EmitFormatDiagnostic(
2021 S.PDiag(diag::warn_format_mix_positional_nonpositional_args),
2022 Loc, /*isStringLoc*/true, getSpecifierRange(startSpec, specifierLen));
2023}
2024
Ted Kremenek666a1972010-07-26 19:45:42 +00002025bool
2026CheckFormatHandler::CheckNumArgs(
2027 const analyze_format_string::FormatSpecifier &FS,
2028 const analyze_format_string::ConversionSpecifier &CS,
2029 const char *startSpecifier, unsigned specifierLen, unsigned argIndex) {
2030
2031 if (argIndex >= NumDataArgs) {
Richard Trieu55733de2011-10-28 00:41:25 +00002032 PartialDiagnostic PDiag = FS.usesPositionalArg()
2033 ? (S.PDiag(diag::warn_printf_positional_arg_exceeds_data_args)
2034 << (argIndex+1) << NumDataArgs)
2035 : S.PDiag(diag::warn_printf_insufficient_data_args);
2036 EmitFormatDiagnostic(
2037 PDiag, getLocationOfByte(CS.getStart()), /*IsStringLocation*/true,
2038 getSpecifierRange(startSpecifier, specifierLen));
Ted Kremenek666a1972010-07-26 19:45:42 +00002039 return false;
2040 }
2041 return true;
2042}
2043
Richard Trieu55733de2011-10-28 00:41:25 +00002044template<typename Range>
2045void CheckFormatHandler::EmitFormatDiagnostic(PartialDiagnostic PDiag,
2046 SourceLocation Loc,
2047 bool IsStringLocation,
2048 Range StringRange,
2049 FixItHint FixIt) {
Jean-Daniel Dupas29c3f812012-01-17 20:03:31 +00002050 EmitFormatDiagnostic(S, inFunctionCall, Args[FormatIdx], PDiag,
Richard Trieu55733de2011-10-28 00:41:25 +00002051 Loc, IsStringLocation, StringRange, FixIt);
2052}
2053
2054/// \brief If the format string is not within the funcion call, emit a note
2055/// so that the function call and string are in diagnostic messages.
2056///
2057/// \param inFunctionCall if true, the format string is within the function
2058/// call and only one diagnostic message will be produced. Otherwise, an
2059/// extra note will be emitted pointing to location of the format string.
2060///
2061/// \param ArgumentExpr the expression that is passed as the format string
2062/// argument in the function call. Used for getting locations when two
2063/// diagnostics are emitted.
2064///
2065/// \param PDiag the callee should already have provided any strings for the
2066/// diagnostic message. This function only adds locations and fixits
2067/// to diagnostics.
2068///
2069/// \param Loc primary location for diagnostic. If two diagnostics are
2070/// required, one will be at Loc and a new SourceLocation will be created for
2071/// the other one.
2072///
2073/// \param IsStringLocation if true, Loc points to the format string should be
2074/// used for the note. Otherwise, Loc points to the argument list and will
2075/// be used with PDiag.
2076///
2077/// \param StringRange some or all of the string to highlight. This is
2078/// templated so it can accept either a CharSourceRange or a SourceRange.
2079///
2080/// \param Fixit optional fix it hint for the format string.
2081template<typename Range>
2082void CheckFormatHandler::EmitFormatDiagnostic(Sema &S, bool InFunctionCall,
2083 const Expr *ArgumentExpr,
2084 PartialDiagnostic PDiag,
2085 SourceLocation Loc,
2086 bool IsStringLocation,
2087 Range StringRange,
2088 FixItHint FixIt) {
2089 if (InFunctionCall)
2090 S.Diag(Loc, PDiag) << StringRange << FixIt;
2091 else {
2092 S.Diag(IsStringLocation ? ArgumentExpr->getExprLoc() : Loc, PDiag)
2093 << ArgumentExpr->getSourceRange();
2094 S.Diag(IsStringLocation ? Loc : StringRange.getBegin(),
2095 diag::note_format_string_defined)
2096 << StringRange << FixIt;
2097 }
2098}
2099
Ted Kremenek826a3452010-07-16 02:11:22 +00002100//===--- CHECK: Printf format string checking ------------------------------===//
2101
2102namespace {
2103class CheckPrintfHandler : public CheckFormatHandler {
2104public:
2105 CheckPrintfHandler(Sema &s, const StringLiteral *fexpr,
2106 const Expr *origFormatExpr, unsigned firstDataArg,
2107 unsigned numDataArgs, bool isObjCLiteral,
2108 const char *beg, bool hasVAListArg,
Jean-Daniel Dupas29c3f812012-01-17 20:03:31 +00002109 Expr **Args, unsigned NumArgs,
2110 unsigned formatIdx, bool inFunctionCall)
Ted Kremenek826a3452010-07-16 02:11:22 +00002111 : CheckFormatHandler(s, fexpr, origFormatExpr, firstDataArg,
2112 numDataArgs, isObjCLiteral, beg, hasVAListArg,
Jean-Daniel Dupas29c3f812012-01-17 20:03:31 +00002113 Args, NumArgs, formatIdx, inFunctionCall) {}
Ted Kremenek826a3452010-07-16 02:11:22 +00002114
2115
2116 bool HandleInvalidPrintfConversionSpecifier(
2117 const analyze_printf::PrintfSpecifier &FS,
2118 const char *startSpecifier,
2119 unsigned specifierLen);
2120
2121 bool HandlePrintfSpecifier(const analyze_printf::PrintfSpecifier &FS,
2122 const char *startSpecifier,
2123 unsigned specifierLen);
2124
2125 bool HandleAmount(const analyze_format_string::OptionalAmount &Amt, unsigned k,
2126 const char *startSpecifier, unsigned specifierLen);
2127 void HandleInvalidAmount(const analyze_printf::PrintfSpecifier &FS,
2128 const analyze_printf::OptionalAmount &Amt,
2129 unsigned type,
2130 const char *startSpecifier, unsigned specifierLen);
2131 void HandleFlag(const analyze_printf::PrintfSpecifier &FS,
2132 const analyze_printf::OptionalFlag &flag,
2133 const char *startSpecifier, unsigned specifierLen);
2134 void HandleIgnoredFlag(const analyze_printf::PrintfSpecifier &FS,
2135 const analyze_printf::OptionalFlag &ignoredFlag,
2136 const analyze_printf::OptionalFlag &flag,
2137 const char *startSpecifier, unsigned specifierLen);
2138};
2139}
2140
2141bool CheckPrintfHandler::HandleInvalidPrintfConversionSpecifier(
2142 const analyze_printf::PrintfSpecifier &FS,
2143 const char *startSpecifier,
2144 unsigned specifierLen) {
Ted Kremenek6ecb9502010-07-20 20:04:27 +00002145 const analyze_printf::PrintfConversionSpecifier &CS =
Ted Kremenekc09b6a52010-07-19 21:25:57 +00002146 FS.getConversionSpecifier();
Ted Kremenek826a3452010-07-16 02:11:22 +00002147
Ted Kremenekc09b6a52010-07-19 21:25:57 +00002148 return HandleInvalidConversionSpecifier(FS.getArgIndex(),
2149 getLocationOfByte(CS.getStart()),
2150 startSpecifier, specifierLen,
2151 CS.getStart(), CS.getLength());
Ted Kremenek26ac2e02010-01-29 02:40:24 +00002152}
2153
Ted Kremenek826a3452010-07-16 02:11:22 +00002154bool CheckPrintfHandler::HandleAmount(
2155 const analyze_format_string::OptionalAmount &Amt,
2156 unsigned k, const char *startSpecifier,
2157 unsigned specifierLen) {
Ted Kremenek0d277352010-01-29 01:06:55 +00002158
2159 if (Amt.hasDataArgument()) {
Ted Kremenek0d277352010-01-29 01:06:55 +00002160 if (!HasVAListArg) {
Ted Kremenek7f70dc82010-02-26 19:18:41 +00002161 unsigned argIndex = Amt.getArgIndex();
2162 if (argIndex >= NumDataArgs) {
Richard Trieu55733de2011-10-28 00:41:25 +00002163 EmitFormatDiagnostic(S.PDiag(diag::warn_printf_asterisk_missing_arg)
2164 << k,
2165 getLocationOfByte(Amt.getStart()),
2166 /*IsStringLocation*/true,
2167 getSpecifierRange(startSpecifier, specifierLen));
Ted Kremenek0d277352010-01-29 01:06:55 +00002168 // Don't do any more checking. We will just emit
2169 // spurious errors.
2170 return false;
2171 }
Ted Kremenek4e4b30e2010-02-16 01:46:59 +00002172
Ted Kremenek0d277352010-01-29 01:06:55 +00002173 // Type check the data argument. It should be an 'int'.
Ted Kremenek31f8e322010-01-29 23:32:22 +00002174 // Although not in conformance with C99, we also allow the argument to be
2175 // an 'unsigned int' as that is a reasonably safe case. GCC also
2176 // doesn't emit a warning for that case.
Ted Kremenek7f70dc82010-02-26 19:18:41 +00002177 CoveredArgs.set(argIndex);
2178 const Expr *Arg = getDataArg(argIndex);
Ted Kremenek0d277352010-01-29 01:06:55 +00002179 QualType T = Arg->getType();
Ted Kremenek4e4b30e2010-02-16 01:46:59 +00002180
2181 const analyze_printf::ArgTypeResult &ATR = Amt.getArgType(S.Context);
2182 assert(ATR.isValid());
2183
2184 if (!ATR.matchesType(S.Context, T)) {
Richard Trieu55733de2011-10-28 00:41:25 +00002185 EmitFormatDiagnostic(S.PDiag(diag::warn_printf_asterisk_wrong_type)
Hans Wennborga792aff2011-12-07 10:33:11 +00002186 << k << ATR.getRepresentativeTypeName(S.Context)
Richard Trieu55733de2011-10-28 00:41:25 +00002187 << T << Arg->getSourceRange(),
2188 getLocationOfByte(Amt.getStart()),
2189 /*IsStringLocation*/true,
2190 getSpecifierRange(startSpecifier, specifierLen));
Ted Kremenek0d277352010-01-29 01:06:55 +00002191 // Don't do any more checking. We will just emit
2192 // spurious errors.
2193 return false;
2194 }
2195 }
2196 }
2197 return true;
2198}
Ted Kremenek0d277352010-01-29 01:06:55 +00002199
Tom Caree4ee9662010-06-17 19:00:27 +00002200void CheckPrintfHandler::HandleInvalidAmount(
Ted Kremenek826a3452010-07-16 02:11:22 +00002201 const analyze_printf::PrintfSpecifier &FS,
Tom Caree4ee9662010-06-17 19:00:27 +00002202 const analyze_printf::OptionalAmount &Amt,
2203 unsigned type,
2204 const char *startSpecifier,
2205 unsigned specifierLen) {
Ted Kremenek6ecb9502010-07-20 20:04:27 +00002206 const analyze_printf::PrintfConversionSpecifier &CS =
2207 FS.getConversionSpecifier();
Tom Caree4ee9662010-06-17 19:00:27 +00002208
Richard Trieu55733de2011-10-28 00:41:25 +00002209 FixItHint fixit =
2210 Amt.getHowSpecified() == analyze_printf::OptionalAmount::Constant
2211 ? FixItHint::CreateRemoval(getSpecifierRange(Amt.getStart(),
2212 Amt.getConstantLength()))
2213 : FixItHint();
2214
2215 EmitFormatDiagnostic(S.PDiag(diag::warn_printf_nonsensical_optional_amount)
2216 << type << CS.toString(),
2217 getLocationOfByte(Amt.getStart()),
2218 /*IsStringLocation*/true,
2219 getSpecifierRange(startSpecifier, specifierLen),
2220 fixit);
Tom Caree4ee9662010-06-17 19:00:27 +00002221}
2222
Ted Kremenek826a3452010-07-16 02:11:22 +00002223void CheckPrintfHandler::HandleFlag(const analyze_printf::PrintfSpecifier &FS,
Tom Caree4ee9662010-06-17 19:00:27 +00002224 const analyze_printf::OptionalFlag &flag,
2225 const char *startSpecifier,
2226 unsigned specifierLen) {
2227 // Warn about pointless flag with a fixit removal.
Ted Kremenek6ecb9502010-07-20 20:04:27 +00002228 const analyze_printf::PrintfConversionSpecifier &CS =
2229 FS.getConversionSpecifier();
Richard Trieu55733de2011-10-28 00:41:25 +00002230 EmitFormatDiagnostic(S.PDiag(diag::warn_printf_nonsensical_flag)
2231 << flag.toString() << CS.toString(),
2232 getLocationOfByte(flag.getPosition()),
2233 /*IsStringLocation*/true,
2234 getSpecifierRange(startSpecifier, specifierLen),
2235 FixItHint::CreateRemoval(
2236 getSpecifierRange(flag.getPosition(), 1)));
Tom Caree4ee9662010-06-17 19:00:27 +00002237}
2238
2239void CheckPrintfHandler::HandleIgnoredFlag(
Ted Kremenek826a3452010-07-16 02:11:22 +00002240 const analyze_printf::PrintfSpecifier &FS,
Tom Caree4ee9662010-06-17 19:00:27 +00002241 const analyze_printf::OptionalFlag &ignoredFlag,
2242 const analyze_printf::OptionalFlag &flag,
2243 const char *startSpecifier,
2244 unsigned specifierLen) {
2245 // Warn about ignored flag with a fixit removal.
Richard Trieu55733de2011-10-28 00:41:25 +00002246 EmitFormatDiagnostic(S.PDiag(diag::warn_printf_ignored_flag)
2247 << ignoredFlag.toString() << flag.toString(),
2248 getLocationOfByte(ignoredFlag.getPosition()),
2249 /*IsStringLocation*/true,
2250 getSpecifierRange(startSpecifier, specifierLen),
2251 FixItHint::CreateRemoval(
2252 getSpecifierRange(ignoredFlag.getPosition(), 1)));
Tom Caree4ee9662010-06-17 19:00:27 +00002253}
2254
Ted Kremeneke0e53132010-01-28 23:39:18 +00002255bool
Ted Kremenek826a3452010-07-16 02:11:22 +00002256CheckPrintfHandler::HandlePrintfSpecifier(const analyze_printf::PrintfSpecifier
Ted Kremenek5c41ee82010-02-11 09:27:41 +00002257 &FS,
Ted Kremeneke0e53132010-01-28 23:39:18 +00002258 const char *startSpecifier,
2259 unsigned specifierLen) {
2260
Ted Kremenek6ecb9502010-07-20 20:04:27 +00002261 using namespace analyze_format_string;
Ted Kremenekefaff192010-02-27 01:41:03 +00002262 using namespace analyze_printf;
Ted Kremenek6ecb9502010-07-20 20:04:27 +00002263 const PrintfConversionSpecifier &CS = FS.getConversionSpecifier();
Ted Kremeneke0e53132010-01-28 23:39:18 +00002264
Ted Kremenekbaa40062010-07-19 22:01:06 +00002265 if (FS.consumesDataArgument()) {
2266 if (atFirstArg) {
2267 atFirstArg = false;
2268 usesPositionalArgs = FS.usesPositionalArg();
2269 }
2270 else if (usesPositionalArgs != FS.usesPositionalArg()) {
Richard Trieu55733de2011-10-28 00:41:25 +00002271 HandlePositionalNonpositionalArgs(getLocationOfByte(CS.getStart()),
2272 startSpecifier, specifierLen);
Ted Kremenekbaa40062010-07-19 22:01:06 +00002273 return false;
2274 }
Ted Kremenek0d277352010-01-29 01:06:55 +00002275 }
Ted Kremenek4e4b30e2010-02-16 01:46:59 +00002276
Ted Kremenekefaff192010-02-27 01:41:03 +00002277 // First check if the field width, precision, and conversion specifier
2278 // have matching data arguments.
2279 if (!HandleAmount(FS.getFieldWidth(), /* field width */ 0,
2280 startSpecifier, specifierLen)) {
2281 return false;
2282 }
2283
2284 if (!HandleAmount(FS.getPrecision(), /* precision */ 1,
2285 startSpecifier, specifierLen)) {
Ted Kremenek0d277352010-01-29 01:06:55 +00002286 return false;
2287 }
2288
Ted Kremenekf88c8e02010-01-29 20:55:36 +00002289 if (!CS.consumesDataArgument()) {
2290 // FIXME: Technically specifying a precision or field width here
2291 // makes no sense. Worth issuing a warning at some point.
Ted Kremenek0e5675d2010-02-10 02:16:30 +00002292 return true;
Ted Kremenekf88c8e02010-01-29 20:55:36 +00002293 }
Ted Kremenek4e4b30e2010-02-16 01:46:59 +00002294
Ted Kremenek7f70dc82010-02-26 19:18:41 +00002295 // Consume the argument.
2296 unsigned argIndex = FS.getArgIndex();
Ted Kremeneke3fc5472010-02-27 08:34:51 +00002297 if (argIndex < NumDataArgs) {
2298 // The check to see if the argIndex is valid will come later.
2299 // We set the bit here because we may exit early from this
2300 // function if we encounter some other error.
2301 CoveredArgs.set(argIndex);
2302 }
Ted Kremenek7f70dc82010-02-26 19:18:41 +00002303
2304 // Check for using an Objective-C specific conversion specifier
2305 // in a non-ObjC literal.
2306 if (!IsObjCLiteral && CS.isObjCArg()) {
Ted Kremenek826a3452010-07-16 02:11:22 +00002307 return HandleInvalidPrintfConversionSpecifier(FS, startSpecifier,
2308 specifierLen);
Ted Kremenek7f70dc82010-02-26 19:18:41 +00002309 }
Ted Kremenek4e4b30e2010-02-16 01:46:59 +00002310
Tom Caree4ee9662010-06-17 19:00:27 +00002311 // Check for invalid use of field width
2312 if (!FS.hasValidFieldWidth()) {
Tom Care45f9b7e2010-06-21 21:21:01 +00002313 HandleInvalidAmount(FS, FS.getFieldWidth(), /* field width */ 0,
Tom Caree4ee9662010-06-17 19:00:27 +00002314 startSpecifier, specifierLen);
2315 }
2316
2317 // Check for invalid use of precision
2318 if (!FS.hasValidPrecision()) {
2319 HandleInvalidAmount(FS, FS.getPrecision(), /* precision */ 1,
2320 startSpecifier, specifierLen);
2321 }
2322
2323 // Check each flag does not conflict with any other component.
Ted Kremenek65197b42011-01-08 05:28:46 +00002324 if (!FS.hasValidThousandsGroupingPrefix())
2325 HandleFlag(FS, FS.hasThousandsGrouping(), startSpecifier, specifierLen);
Tom Caree4ee9662010-06-17 19:00:27 +00002326 if (!FS.hasValidLeadingZeros())
2327 HandleFlag(FS, FS.hasLeadingZeros(), startSpecifier, specifierLen);
2328 if (!FS.hasValidPlusPrefix())
2329 HandleFlag(FS, FS.hasPlusPrefix(), startSpecifier, specifierLen);
Tom Care45f9b7e2010-06-21 21:21:01 +00002330 if (!FS.hasValidSpacePrefix())
2331 HandleFlag(FS, FS.hasSpacePrefix(), startSpecifier, specifierLen);
Tom Caree4ee9662010-06-17 19:00:27 +00002332 if (!FS.hasValidAlternativeForm())
2333 HandleFlag(FS, FS.hasAlternativeForm(), startSpecifier, specifierLen);
2334 if (!FS.hasValidLeftJustified())
2335 HandleFlag(FS, FS.isLeftJustified(), startSpecifier, specifierLen);
2336
2337 // Check that flags are not ignored by another flag
Tom Care45f9b7e2010-06-21 21:21:01 +00002338 if (FS.hasSpacePrefix() && FS.hasPlusPrefix()) // ' ' ignored by '+'
2339 HandleIgnoredFlag(FS, FS.hasSpacePrefix(), FS.hasPlusPrefix(),
2340 startSpecifier, specifierLen);
Tom Caree4ee9662010-06-17 19:00:27 +00002341 if (FS.hasLeadingZeros() && FS.isLeftJustified()) // '0' ignored by '-'
2342 HandleIgnoredFlag(FS, FS.hasLeadingZeros(), FS.isLeftJustified(),
2343 startSpecifier, specifierLen);
2344
2345 // Check the length modifier is valid with the given conversion specifier.
2346 const LengthModifier &LM = FS.getLengthModifier();
2347 if (!FS.hasValidLengthModifier())
Richard Trieu55733de2011-10-28 00:41:25 +00002348 EmitFormatDiagnostic(S.PDiag(diag::warn_format_nonsensical_length)
2349 << LM.toString() << CS.toString(),
2350 getLocationOfByte(LM.getStart()),
2351 /*IsStringLocation*/true,
2352 getSpecifierRange(startSpecifier, specifierLen),
2353 FixItHint::CreateRemoval(
2354 getSpecifierRange(LM.getStart(),
2355 LM.getLength())));
Hans Wennborg76517422012-02-22 10:17:01 +00002356 if (!FS.hasStandardLengthModifier())
2357 HandleNonStandardLengthModifier(LM, startSpecifier, specifierLen);
David Blaikie4e4d0842012-03-11 07:00:24 +00002358 if (!FS.hasStandardConversionSpecifier(S.getLangOpts()))
Hans Wennborg76517422012-02-22 10:17:01 +00002359 HandleNonStandardConversionSpecifier(CS, startSpecifier, specifierLen);
2360 if (!FS.hasStandardLengthConversionCombination())
2361 HandleNonStandardConversionSpecification(LM, CS, startSpecifier,
2362 specifierLen);
Tom Caree4ee9662010-06-17 19:00:27 +00002363
2364 // Are we using '%n'?
Ted Kremenek35d353b2010-07-20 20:04:10 +00002365 if (CS.getKind() == ConversionSpecifier::nArg) {
Tom Caree4ee9662010-06-17 19:00:27 +00002366 // Issue a warning about this being a possible security issue.
Richard Trieu55733de2011-10-28 00:41:25 +00002367 EmitFormatDiagnostic(S.PDiag(diag::warn_printf_write_back),
2368 getLocationOfByte(CS.getStart()),
2369 /*IsStringLocation*/true,
2370 getSpecifierRange(startSpecifier, specifierLen));
Ted Kremeneke82d8042010-01-29 01:35:25 +00002371 // Continue checking the other format specifiers.
2372 return true;
2373 }
Ted Kremenek5c41ee82010-02-11 09:27:41 +00002374
Ted Kremenekda51f0d2010-01-29 01:43:31 +00002375 // The remaining checks depend on the data arguments.
2376 if (HasVAListArg)
2377 return true;
Ted Kremenek4e4b30e2010-02-16 01:46:59 +00002378
Ted Kremenek666a1972010-07-26 19:45:42 +00002379 if (!CheckNumArgs(FS, CS, startSpecifier, specifierLen, argIndex))
Ted Kremenekda51f0d2010-01-29 01:43:31 +00002380 return false;
Ted Kremenek4e4b30e2010-02-16 01:46:59 +00002381
Michael J. Spencer96827eb2010-07-27 04:46:02 +00002382 // Now type check the data expression that matches the
2383 // format specifier.
2384 const Expr *Ex = getDataArg(argIndex);
Nico Weber339b9072012-01-31 01:43:25 +00002385 const analyze_printf::ArgTypeResult &ATR = FS.getArgType(S.Context,
2386 IsObjCLiteral);
Michael J. Spencer96827eb2010-07-27 04:46:02 +00002387 if (ATR.isValid() && !ATR.matchesType(S.Context, Ex->getType())) {
2388 // Check if we didn't match because of an implicit cast from a 'char'
2389 // or 'short' to an 'int'. This is done because printf is a varargs
2390 // function.
2391 if (const ImplicitCastExpr *ICE = dyn_cast<ImplicitCastExpr>(Ex))
Ted Kremenek4d8ae4d2010-10-21 04:00:58 +00002392 if (ICE->getType() == S.Context.IntTy) {
2393 // All further checking is done on the subexpression.
2394 Ex = ICE->getSubExpr();
2395 if (ATR.matchesType(S.Context, Ex->getType()))
Michael J. Spencer96827eb2010-07-27 04:46:02 +00002396 return true;
Ted Kremenek4d8ae4d2010-10-21 04:00:58 +00002397 }
Michael J. Spencer96827eb2010-07-27 04:46:02 +00002398
2399 // We may be able to offer a FixItHint if it is a supported type.
2400 PrintfSpecifier fixedFS = FS;
David Blaikie4e4d0842012-03-11 07:00:24 +00002401 bool success = fixedFS.fixType(Ex->getType(), S.getLangOpts(),
Hans Wennborgbe6126a2012-02-15 09:59:46 +00002402 S.Context, IsObjCLiteral);
Michael J. Spencer96827eb2010-07-27 04:46:02 +00002403
2404 if (success) {
2405 // Get the fix string from the fixed format specifier
Dylan Noblesmithf7ccbad2012-02-05 02:13:05 +00002406 SmallString<128> buf;
Michael J. Spencer96827eb2010-07-27 04:46:02 +00002407 llvm::raw_svector_ostream os(buf);
2408 fixedFS.toString(os);
2409
Richard Trieu55733de2011-10-28 00:41:25 +00002410 EmitFormatDiagnostic(
2411 S.PDiag(diag::warn_printf_conversion_argument_type_mismatch)
Hans Wennborga792aff2011-12-07 10:33:11 +00002412 << ATR.getRepresentativeTypeName(S.Context) << Ex->getType()
Richard Trieu55733de2011-10-28 00:41:25 +00002413 << Ex->getSourceRange(),
2414 getLocationOfByte(CS.getStart()),
2415 /*IsStringLocation*/true,
2416 getSpecifierRange(startSpecifier, specifierLen),
2417 FixItHint::CreateReplacement(
2418 getSpecifierRange(startSpecifier, specifierLen),
2419 os.str()));
Michael J. Spencer96827eb2010-07-27 04:46:02 +00002420 }
2421 else {
Jean-Daniel Dupas220947b2012-01-31 18:12:08 +00002422 EmitFormatDiagnostic(
2423 S.PDiag(diag::warn_printf_conversion_argument_type_mismatch)
2424 << ATR.getRepresentativeTypeName(S.Context) << Ex->getType()
2425 << getSpecifierRange(startSpecifier, specifierLen)
2426 << Ex->getSourceRange(),
2427 getLocationOfByte(CS.getStart()),
2428 true,
2429 getSpecifierRange(startSpecifier, specifierLen));
Michael J. Spencer96827eb2010-07-27 04:46:02 +00002430 }
2431 }
2432
Ted Kremeneke0e53132010-01-28 23:39:18 +00002433 return true;
2434}
2435
Ted Kremenek826a3452010-07-16 02:11:22 +00002436//===--- CHECK: Scanf format string checking ------------------------------===//
2437
2438namespace {
2439class CheckScanfHandler : public CheckFormatHandler {
2440public:
2441 CheckScanfHandler(Sema &s, const StringLiteral *fexpr,
2442 const Expr *origFormatExpr, unsigned firstDataArg,
2443 unsigned numDataArgs, bool isObjCLiteral,
2444 const char *beg, bool hasVAListArg,
Jean-Daniel Dupas29c3f812012-01-17 20:03:31 +00002445 Expr **Args, unsigned NumArgs,
2446 unsigned formatIdx, bool inFunctionCall)
Ted Kremenek826a3452010-07-16 02:11:22 +00002447 : CheckFormatHandler(s, fexpr, origFormatExpr, firstDataArg,
2448 numDataArgs, isObjCLiteral, beg, hasVAListArg,
Jean-Daniel Dupas29c3f812012-01-17 20:03:31 +00002449 Args, NumArgs, formatIdx, inFunctionCall) {}
Ted Kremenek826a3452010-07-16 02:11:22 +00002450
2451 bool HandleScanfSpecifier(const analyze_scanf::ScanfSpecifier &FS,
2452 const char *startSpecifier,
2453 unsigned specifierLen);
Ted Kremenekc09b6a52010-07-19 21:25:57 +00002454
2455 bool HandleInvalidScanfConversionSpecifier(
2456 const analyze_scanf::ScanfSpecifier &FS,
2457 const char *startSpecifier,
2458 unsigned specifierLen);
Ted Kremenekb7c21012010-07-16 18:28:03 +00002459
2460 void HandleIncompleteScanList(const char *start, const char *end);
Ted Kremenek826a3452010-07-16 02:11:22 +00002461};
Ted Kremenek07d161f2010-01-29 01:50:07 +00002462}
Ted Kremeneke0e53132010-01-28 23:39:18 +00002463
Ted Kremenekb7c21012010-07-16 18:28:03 +00002464void CheckScanfHandler::HandleIncompleteScanList(const char *start,
2465 const char *end) {
Richard Trieu55733de2011-10-28 00:41:25 +00002466 EmitFormatDiagnostic(S.PDiag(diag::warn_scanf_scanlist_incomplete),
2467 getLocationOfByte(end), /*IsStringLocation*/true,
2468 getSpecifierRange(start, end - start));
Ted Kremenekb7c21012010-07-16 18:28:03 +00002469}
2470
Ted Kremenekc09b6a52010-07-19 21:25:57 +00002471bool CheckScanfHandler::HandleInvalidScanfConversionSpecifier(
2472 const analyze_scanf::ScanfSpecifier &FS,
2473 const char *startSpecifier,
2474 unsigned specifierLen) {
2475
Ted Kremenek6ecb9502010-07-20 20:04:27 +00002476 const analyze_scanf::ScanfConversionSpecifier &CS =
Ted Kremenekc09b6a52010-07-19 21:25:57 +00002477 FS.getConversionSpecifier();
2478
2479 return HandleInvalidConversionSpecifier(FS.getArgIndex(),
2480 getLocationOfByte(CS.getStart()),
2481 startSpecifier, specifierLen,
2482 CS.getStart(), CS.getLength());
2483}
2484
Ted Kremenek826a3452010-07-16 02:11:22 +00002485bool CheckScanfHandler::HandleScanfSpecifier(
2486 const analyze_scanf::ScanfSpecifier &FS,
2487 const char *startSpecifier,
2488 unsigned specifierLen) {
2489
2490 using namespace analyze_scanf;
2491 using namespace analyze_format_string;
2492
Ted Kremenek6ecb9502010-07-20 20:04:27 +00002493 const ScanfConversionSpecifier &CS = FS.getConversionSpecifier();
Ted Kremenek826a3452010-07-16 02:11:22 +00002494
Ted Kremenekbaa40062010-07-19 22:01:06 +00002495 // Handle case where '%' and '*' don't consume an argument. These shouldn't
2496 // be used to decide if we are using positional arguments consistently.
2497 if (FS.consumesDataArgument()) {
2498 if (atFirstArg) {
2499 atFirstArg = false;
2500 usesPositionalArgs = FS.usesPositionalArg();
2501 }
2502 else if (usesPositionalArgs != FS.usesPositionalArg()) {
Richard Trieu55733de2011-10-28 00:41:25 +00002503 HandlePositionalNonpositionalArgs(getLocationOfByte(CS.getStart()),
2504 startSpecifier, specifierLen);
Ted Kremenekbaa40062010-07-19 22:01:06 +00002505 return false;
2506 }
Ted Kremenek826a3452010-07-16 02:11:22 +00002507 }
2508
2509 // Check if the field with is non-zero.
2510 const OptionalAmount &Amt = FS.getFieldWidth();
2511 if (Amt.getHowSpecified() == OptionalAmount::Constant) {
2512 if (Amt.getConstantAmount() == 0) {
2513 const CharSourceRange &R = getSpecifierRange(Amt.getStart(),
2514 Amt.getConstantLength());
Richard Trieu55733de2011-10-28 00:41:25 +00002515 EmitFormatDiagnostic(S.PDiag(diag::warn_scanf_nonzero_width),
2516 getLocationOfByte(Amt.getStart()),
2517 /*IsStringLocation*/true, R,
2518 FixItHint::CreateRemoval(R));
Ted Kremenek826a3452010-07-16 02:11:22 +00002519 }
2520 }
2521
2522 if (!FS.consumesDataArgument()) {
2523 // FIXME: Technically specifying a precision or field width here
2524 // makes no sense. Worth issuing a warning at some point.
2525 return true;
2526 }
2527
2528 // Consume the argument.
2529 unsigned argIndex = FS.getArgIndex();
2530 if (argIndex < NumDataArgs) {
2531 // The check to see if the argIndex is valid will come later.
2532 // We set the bit here because we may exit early from this
2533 // function if we encounter some other error.
2534 CoveredArgs.set(argIndex);
2535 }
2536
Ted Kremenek1e51c202010-07-20 20:04:47 +00002537 // Check the length modifier is valid with the given conversion specifier.
2538 const LengthModifier &LM = FS.getLengthModifier();
2539 if (!FS.hasValidLengthModifier()) {
Jean-Daniel Dupas220947b2012-01-31 18:12:08 +00002540 const CharSourceRange &R = getSpecifierRange(LM.getStart(), LM.getLength());
2541 EmitFormatDiagnostic(S.PDiag(diag::warn_format_nonsensical_length)
2542 << LM.toString() << CS.toString()
2543 << getSpecifierRange(startSpecifier, specifierLen),
2544 getLocationOfByte(LM.getStart()),
2545 /*IsStringLocation*/true, R,
2546 FixItHint::CreateRemoval(R));
Ted Kremenek1e51c202010-07-20 20:04:47 +00002547 }
2548
Hans Wennborg76517422012-02-22 10:17:01 +00002549 if (!FS.hasStandardLengthModifier())
2550 HandleNonStandardLengthModifier(LM, startSpecifier, specifierLen);
David Blaikie4e4d0842012-03-11 07:00:24 +00002551 if (!FS.hasStandardConversionSpecifier(S.getLangOpts()))
Hans Wennborg76517422012-02-22 10:17:01 +00002552 HandleNonStandardConversionSpecifier(CS, startSpecifier, specifierLen);
2553 if (!FS.hasStandardLengthConversionCombination())
2554 HandleNonStandardConversionSpecification(LM, CS, startSpecifier,
2555 specifierLen);
2556
Ted Kremenek826a3452010-07-16 02:11:22 +00002557 // The remaining checks depend on the data arguments.
2558 if (HasVAListArg)
2559 return true;
2560
Ted Kremenek666a1972010-07-26 19:45:42 +00002561 if (!CheckNumArgs(FS, CS, startSpecifier, specifierLen, argIndex))
Ted Kremenek826a3452010-07-16 02:11:22 +00002562 return false;
Ted Kremenek826a3452010-07-16 02:11:22 +00002563
Hans Wennborg6fcd9322011-12-10 13:20:11 +00002564 // Check that the argument type matches the format specifier.
2565 const Expr *Ex = getDataArg(argIndex);
2566 const analyze_scanf::ScanfArgTypeResult &ATR = FS.getArgType(S.Context);
2567 if (ATR.isValid() && !ATR.matchesType(S.Context, Ex->getType())) {
2568 ScanfSpecifier fixedFS = FS;
David Blaikie4e4d0842012-03-11 07:00:24 +00002569 bool success = fixedFS.fixType(Ex->getType(), S.getLangOpts(),
Hans Wennborgbe6126a2012-02-15 09:59:46 +00002570 S.Context);
Hans Wennborg6fcd9322011-12-10 13:20:11 +00002571
2572 if (success) {
2573 // Get the fix string from the fixed format specifier.
Dylan Noblesmithf7ccbad2012-02-05 02:13:05 +00002574 SmallString<128> buf;
Hans Wennborg6fcd9322011-12-10 13:20:11 +00002575 llvm::raw_svector_ostream os(buf);
2576 fixedFS.toString(os);
2577
2578 EmitFormatDiagnostic(
2579 S.PDiag(diag::warn_printf_conversion_argument_type_mismatch)
2580 << ATR.getRepresentativeTypeName(S.Context) << Ex->getType()
2581 << Ex->getSourceRange(),
2582 getLocationOfByte(CS.getStart()),
2583 /*IsStringLocation*/true,
2584 getSpecifierRange(startSpecifier, specifierLen),
2585 FixItHint::CreateReplacement(
2586 getSpecifierRange(startSpecifier, specifierLen),
2587 os.str()));
2588 } else {
Jean-Daniel Dupas220947b2012-01-31 18:12:08 +00002589 EmitFormatDiagnostic(
2590 S.PDiag(diag::warn_printf_conversion_argument_type_mismatch)
Hans Wennborg6fcd9322011-12-10 13:20:11 +00002591 << ATR.getRepresentativeTypeName(S.Context) << Ex->getType()
Jean-Daniel Dupas220947b2012-01-31 18:12:08 +00002592 << Ex->getSourceRange(),
2593 getLocationOfByte(CS.getStart()),
2594 /*IsStringLocation*/true,
2595 getSpecifierRange(startSpecifier, specifierLen));
Hans Wennborg6fcd9322011-12-10 13:20:11 +00002596 }
2597 }
2598
Ted Kremenek826a3452010-07-16 02:11:22 +00002599 return true;
2600}
2601
2602void Sema::CheckFormatString(const StringLiteral *FExpr,
Ted Kremenek0e5675d2010-02-10 02:16:30 +00002603 const Expr *OrigFormatExpr,
Jean-Daniel Dupas29c3f812012-01-17 20:03:31 +00002604 Expr **Args, unsigned NumArgs,
2605 bool HasVAListArg, unsigned format_idx,
Jean-Daniel Dupas34269df2012-01-30 08:46:47 +00002606 unsigned firstDataArg, FormatStringType Type,
Jean-Daniel Dupas29c3f812012-01-17 20:03:31 +00002607 bool inFunctionCall) {
Ted Kremenek826a3452010-07-16 02:11:22 +00002608
Ted Kremeneke0e53132010-01-28 23:39:18 +00002609 // CHECK: is the format string a wide literal?
Douglas Gregor5cee1192011-07-27 05:40:30 +00002610 if (!FExpr->isAscii()) {
Richard Trieu55733de2011-10-28 00:41:25 +00002611 CheckFormatHandler::EmitFormatDiagnostic(
Jean-Daniel Dupas29c3f812012-01-17 20:03:31 +00002612 *this, inFunctionCall, Args[format_idx],
Richard Trieu55733de2011-10-28 00:41:25 +00002613 PDiag(diag::warn_format_string_is_wide_literal), FExpr->getLocStart(),
2614 /*IsStringLocation*/true, OrigFormatExpr->getSourceRange());
Ted Kremeneke0e53132010-01-28 23:39:18 +00002615 return;
2616 }
Ted Kremenek826a3452010-07-16 02:11:22 +00002617
Ted Kremeneke0e53132010-01-28 23:39:18 +00002618 // Str - The format string. NOTE: this is NOT null-terminated!
Chris Lattner5f9e2722011-07-23 10:55:15 +00002619 StringRef StrRef = FExpr->getString();
Benjamin Kramer2f4eaef2010-08-17 12:54:38 +00002620 const char *Str = StrRef.data();
2621 unsigned StrLen = StrRef.size();
Jean-Daniel Dupas29c3f812012-01-17 20:03:31 +00002622 const unsigned numDataArgs = NumArgs - firstDataArg;
Ted Kremenek826a3452010-07-16 02:11:22 +00002623
Ted Kremeneke0e53132010-01-28 23:39:18 +00002624 // CHECK: empty format string?
Ted Kremenek4cd57912011-09-29 05:52:16 +00002625 if (StrLen == 0 && numDataArgs > 0) {
Richard Trieu55733de2011-10-28 00:41:25 +00002626 CheckFormatHandler::EmitFormatDiagnostic(
Jean-Daniel Dupas29c3f812012-01-17 20:03:31 +00002627 *this, inFunctionCall, Args[format_idx],
Richard Trieu55733de2011-10-28 00:41:25 +00002628 PDiag(diag::warn_empty_format_string), FExpr->getLocStart(),
2629 /*IsStringLocation*/true, OrigFormatExpr->getSourceRange());
Ted Kremeneke0e53132010-01-28 23:39:18 +00002630 return;
2631 }
Ted Kremenek826a3452010-07-16 02:11:22 +00002632
Jean-Daniel Dupas34269df2012-01-30 08:46:47 +00002633 if (Type == FST_Printf || Type == FST_NSString) {
Ted Kremenek826a3452010-07-16 02:11:22 +00002634 CheckPrintfHandler H(*this, FExpr, OrigFormatExpr, firstDataArg,
Ted Kremenek4cd57912011-09-29 05:52:16 +00002635 numDataArgs, isa<ObjCStringLiteral>(OrigFormatExpr),
Jean-Daniel Dupas29c3f812012-01-17 20:03:31 +00002636 Str, HasVAListArg, Args, NumArgs, format_idx,
Richard Trieu55733de2011-10-28 00:41:25 +00002637 inFunctionCall);
Ted Kremenek826a3452010-07-16 02:11:22 +00002638
Hans Wennborgd02deeb2011-12-15 10:25:47 +00002639 if (!analyze_format_string::ParsePrintfString(H, Str, Str + StrLen,
David Blaikie4e4d0842012-03-11 07:00:24 +00002640 getLangOpts()))
Ted Kremenek826a3452010-07-16 02:11:22 +00002641 H.DoneProcessing();
Jean-Daniel Dupas34269df2012-01-30 08:46:47 +00002642 } else if (Type == FST_Scanf) {
Ted Kremenek826a3452010-07-16 02:11:22 +00002643 CheckScanfHandler H(*this, FExpr, OrigFormatExpr, firstDataArg,
Ted Kremenek4cd57912011-09-29 05:52:16 +00002644 numDataArgs, isa<ObjCStringLiteral>(OrigFormatExpr),
Jean-Daniel Dupas29c3f812012-01-17 20:03:31 +00002645 Str, HasVAListArg, Args, NumArgs, format_idx,
Richard Trieu55733de2011-10-28 00:41:25 +00002646 inFunctionCall);
Ted Kremenek826a3452010-07-16 02:11:22 +00002647
Hans Wennborgd02deeb2011-12-15 10:25:47 +00002648 if (!analyze_format_string::ParseScanfString(H, Str, Str + StrLen,
David Blaikie4e4d0842012-03-11 07:00:24 +00002649 getLangOpts()))
Ted Kremenek826a3452010-07-16 02:11:22 +00002650 H.DoneProcessing();
Jean-Daniel Dupas34269df2012-01-30 08:46:47 +00002651 } // TODO: handle other formats
Ted Kremenekce7024e2010-01-28 01:18:22 +00002652}
2653
Chandler Carruth7ccc95b2011-04-27 07:05:31 +00002654//===--- CHECK: Standard memory functions ---------------------------------===//
2655
Douglas Gregor2a053a32011-05-03 20:05:22 +00002656/// \brief Determine whether the given type is a dynamic class type (e.g.,
2657/// whether it has a vtable).
2658static bool isDynamicClassType(QualType T) {
2659 if (CXXRecordDecl *Record = T->getAsCXXRecordDecl())
2660 if (CXXRecordDecl *Definition = Record->getDefinition())
2661 if (Definition->isDynamicClass())
2662 return true;
2663
2664 return false;
2665}
2666
Chandler Carrutha72a12f2011-06-21 23:04:20 +00002667/// \brief If E is a sizeof expression, returns its argument expression,
Chandler Carruth000d4282011-06-16 09:09:40 +00002668/// otherwise returns NULL.
2669static const Expr *getSizeOfExprArg(const Expr* E) {
Nico Webere4a1c642011-06-14 16:14:58 +00002670 if (const UnaryExprOrTypeTraitExpr *SizeOf =
Chandler Carruth000d4282011-06-16 09:09:40 +00002671 dyn_cast<UnaryExprOrTypeTraitExpr>(E))
2672 if (SizeOf->getKind() == clang::UETT_SizeOf && !SizeOf->isArgumentType())
2673 return SizeOf->getArgumentExpr()->IgnoreParenImpCasts();
Nico Webere4a1c642011-06-14 16:14:58 +00002674
Chandler Carruth000d4282011-06-16 09:09:40 +00002675 return 0;
2676}
2677
Chandler Carrutha72a12f2011-06-21 23:04:20 +00002678/// \brief If E is a sizeof expression, returns its argument type.
Chandler Carruth000d4282011-06-16 09:09:40 +00002679static QualType getSizeOfArgType(const Expr* E) {
2680 if (const UnaryExprOrTypeTraitExpr *SizeOf =
2681 dyn_cast<UnaryExprOrTypeTraitExpr>(E))
2682 if (SizeOf->getKind() == clang::UETT_SizeOf)
2683 return SizeOf->getTypeOfArgument();
2684
2685 return QualType();
Nico Webere4a1c642011-06-14 16:14:58 +00002686}
2687
Chandler Carruth7ccc95b2011-04-27 07:05:31 +00002688/// \brief Check for dangerous or invalid arguments to memset().
2689///
Chandler Carruth929f0132011-06-03 06:23:57 +00002690/// This issues warnings on known problematic, dangerous or unspecified
Matt Beaumont-Gaycc2f30c2011-08-05 00:22:34 +00002691/// arguments to the standard 'memset', 'memcpy', 'memmove', and 'memcmp'
2692/// function calls.
Chandler Carruth7ccc95b2011-04-27 07:05:31 +00002693///
2694/// \param Call The call expression to diagnose.
Matt Beaumont-Gaycc2f30c2011-08-05 00:22:34 +00002695void Sema::CheckMemaccessArguments(const CallExpr *Call,
Anna Zaks0a151a12012-01-17 00:37:07 +00002696 unsigned BId,
Matt Beaumont-Gaycc2f30c2011-08-05 00:22:34 +00002697 IdentifierInfo *FnName) {
Anna Zaks0a151a12012-01-17 00:37:07 +00002698 assert(BId != 0);
2699
Ted Kremenek1d59f7f2011-04-28 01:38:02 +00002700 // It is possible to have a non-standard definition of memset. Validate
Douglas Gregor707a23e2011-06-16 17:56:04 +00002701 // we have enough arguments, and if not, abort further checking.
Anna Zaks0a151a12012-01-17 00:37:07 +00002702 unsigned ExpectedNumArgs = (BId == Builtin::BIstrndup ? 2 : 3);
Nico Webercda57822011-10-13 22:30:23 +00002703 if (Call->getNumArgs() < ExpectedNumArgs)
Ted Kremenek1d59f7f2011-04-28 01:38:02 +00002704 return;
2705
Anna Zaks0a151a12012-01-17 00:37:07 +00002706 unsigned LastArg = (BId == Builtin::BImemset ||
2707 BId == Builtin::BIstrndup ? 1 : 2);
2708 unsigned LenArg = (BId == Builtin::BIstrndup ? 1 : 2);
Nico Webercda57822011-10-13 22:30:23 +00002709 const Expr *LenExpr = Call->getArg(LenArg)->IgnoreParenImpCasts();
Chandler Carruth000d4282011-06-16 09:09:40 +00002710
2711 // We have special checking when the length is a sizeof expression.
2712 QualType SizeOfArgTy = getSizeOfArgType(LenExpr);
2713 const Expr *SizeOfArg = getSizeOfExprArg(LenExpr);
2714 llvm::FoldingSetNodeID SizeOfArgID;
2715
Douglas Gregor06bc9eb2011-05-03 20:37:33 +00002716 for (unsigned ArgIdx = 0; ArgIdx != LastArg; ++ArgIdx) {
2717 const Expr *Dest = Call->getArg(ArgIdx)->IgnoreParenImpCasts();
Nico Webere4a1c642011-06-14 16:14:58 +00002718 SourceRange ArgRange = Call->getArg(ArgIdx)->getSourceRange();
Chandler Carruth7ccc95b2011-04-27 07:05:31 +00002719
Douglas Gregor06bc9eb2011-05-03 20:37:33 +00002720 QualType DestTy = Dest->getType();
2721 if (const PointerType *DestPtrTy = DestTy->getAs<PointerType>()) {
2722 QualType PointeeTy = DestPtrTy->getPointeeType();
John McCallf85e1932011-06-15 23:02:42 +00002723
Chandler Carruth000d4282011-06-16 09:09:40 +00002724 // Never warn about void type pointers. This can be used to suppress
2725 // false positives.
2726 if (PointeeTy->isVoidType())
Douglas Gregor06bc9eb2011-05-03 20:37:33 +00002727 continue;
Chandler Carruth7ccc95b2011-04-27 07:05:31 +00002728
Chandler Carruth000d4282011-06-16 09:09:40 +00002729 // Catch "memset(p, 0, sizeof(p))" -- needs to be sizeof(*p). Do this by
2730 // actually comparing the expressions for equality. Because computing the
2731 // expression IDs can be expensive, we only do this if the diagnostic is
2732 // enabled.
2733 if (SizeOfArg &&
2734 Diags.getDiagnosticLevel(diag::warn_sizeof_pointer_expr_memaccess,
2735 SizeOfArg->getExprLoc())) {
2736 // We only compute IDs for expressions if the warning is enabled, and
2737 // cache the sizeof arg's ID.
2738 if (SizeOfArgID == llvm::FoldingSetNodeID())
2739 SizeOfArg->Profile(SizeOfArgID, Context, true);
2740 llvm::FoldingSetNodeID DestID;
2741 Dest->Profile(DestID, Context, true);
2742 if (DestID == SizeOfArgID) {
Nico Webercda57822011-10-13 22:30:23 +00002743 // TODO: For strncpy() and friends, this could suggest sizeof(dst)
2744 // over sizeof(src) as well.
Chandler Carruth000d4282011-06-16 09:09:40 +00002745 unsigned ActionIdx = 0; // Default is to suggest dereferencing.
2746 if (const UnaryOperator *UnaryOp = dyn_cast<UnaryOperator>(Dest))
2747 if (UnaryOp->getOpcode() == UO_AddrOf)
2748 ActionIdx = 1; // If its an address-of operator, just remove it.
2749 if (Context.getTypeSize(PointeeTy) == Context.getCharWidth())
2750 ActionIdx = 2; // If the pointee's size is sizeof(char),
2751 // suggest an explicit length.
Anna Zaksd9b859a2012-01-13 21:52:01 +00002752 unsigned DestSrcSelect =
Anna Zaks0a151a12012-01-17 00:37:07 +00002753 (BId == Builtin::BIstrndup ? 1 : ArgIdx);
Chandler Carruth000d4282011-06-16 09:09:40 +00002754 DiagRuntimeBehavior(SizeOfArg->getExprLoc(), Dest,
2755 PDiag(diag::warn_sizeof_pointer_expr_memaccess)
Nico Webercda57822011-10-13 22:30:23 +00002756 << FnName << DestSrcSelect << ActionIdx
Chandler Carruth000d4282011-06-16 09:09:40 +00002757 << Dest->getSourceRange()
2758 << SizeOfArg->getSourceRange());
2759 break;
2760 }
2761 }
2762
2763 // Also check for cases where the sizeof argument is the exact same
2764 // type as the memory argument, and where it points to a user-defined
2765 // record type.
2766 if (SizeOfArgTy != QualType()) {
2767 if (PointeeTy->isRecordType() &&
2768 Context.typesAreCompatible(SizeOfArgTy, DestTy)) {
2769 DiagRuntimeBehavior(LenExpr->getExprLoc(), Dest,
2770 PDiag(diag::warn_sizeof_pointer_type_memaccess)
2771 << FnName << SizeOfArgTy << ArgIdx
2772 << PointeeTy << Dest->getSourceRange()
2773 << LenExpr->getSourceRange());
2774 break;
2775 }
Nico Webere4a1c642011-06-14 16:14:58 +00002776 }
2777
Douglas Gregor06bc9eb2011-05-03 20:37:33 +00002778 // Always complain about dynamic classes.
Anna Zaks0a151a12012-01-17 00:37:07 +00002779 if (isDynamicClassType(PointeeTy)) {
2780
2781 unsigned OperationType = 0;
2782 // "overwritten" if we're warning about the destination for any call
2783 // but memcmp; otherwise a verb appropriate to the call.
2784 if (ArgIdx != 0 || BId == Builtin::BImemcmp) {
2785 if (BId == Builtin::BImemcpy)
2786 OperationType = 1;
2787 else if(BId == Builtin::BImemmove)
2788 OperationType = 2;
2789 else if (BId == Builtin::BImemcmp)
2790 OperationType = 3;
2791 }
2792
Matt Beaumont-Gay5c5218e2011-08-19 20:40:18 +00002793 DiagRuntimeBehavior(
2794 Dest->getExprLoc(), Dest,
2795 PDiag(diag::warn_dyn_class_memaccess)
Anna Zaks0a151a12012-01-17 00:37:07 +00002796 << (BId == Builtin::BImemcmp ? ArgIdx + 2 : ArgIdx)
Anna Zaksd9b859a2012-01-13 21:52:01 +00002797 << FnName << PointeeTy
Anna Zaks0a151a12012-01-17 00:37:07 +00002798 << OperationType
Matt Beaumont-Gay5c5218e2011-08-19 20:40:18 +00002799 << Call->getCallee()->getSourceRange());
Anna Zaks0a151a12012-01-17 00:37:07 +00002800 } else if (PointeeTy.hasNonTrivialObjCLifetime() &&
2801 BId != Builtin::BImemset)
Matt Beaumont-Gay5c5218e2011-08-19 20:40:18 +00002802 DiagRuntimeBehavior(
2803 Dest->getExprLoc(), Dest,
2804 PDiag(diag::warn_arc_object_memaccess)
2805 << ArgIdx << FnName << PointeeTy
2806 << Call->getCallee()->getSourceRange());
John McCallf85e1932011-06-15 23:02:42 +00002807 else
Douglas Gregor06bc9eb2011-05-03 20:37:33 +00002808 continue;
John McCallf85e1932011-06-15 23:02:42 +00002809
2810 DiagRuntimeBehavior(
2811 Dest->getExprLoc(), Dest,
Chandler Carruth929f0132011-06-03 06:23:57 +00002812 PDiag(diag::note_bad_memaccess_silence)
Douglas Gregor06bc9eb2011-05-03 20:37:33 +00002813 << FixItHint::CreateInsertion(ArgRange.getBegin(), "(void*)"));
2814 break;
2815 }
Chandler Carruth7ccc95b2011-04-27 07:05:31 +00002816 }
2817}
2818
Ted Kremenekbd5da9d2011-08-18 20:55:45 +00002819// A little helper routine: ignore addition and subtraction of integer literals.
2820// This intentionally does not ignore all integer constant expressions because
2821// we don't want to remove sizeof().
2822static const Expr *ignoreLiteralAdditions(const Expr *Ex, ASTContext &Ctx) {
2823 Ex = Ex->IgnoreParenCasts();
2824
2825 for (;;) {
2826 const BinaryOperator * BO = dyn_cast<BinaryOperator>(Ex);
2827 if (!BO || !BO->isAdditiveOp())
2828 break;
2829
2830 const Expr *RHS = BO->getRHS()->IgnoreParenCasts();
2831 const Expr *LHS = BO->getLHS()->IgnoreParenCasts();
2832
2833 if (isa<IntegerLiteral>(RHS))
2834 Ex = LHS;
2835 else if (isa<IntegerLiteral>(LHS))
2836 Ex = RHS;
2837 else
2838 break;
2839 }
2840
2841 return Ex;
2842}
2843
2844// Warn if the user has made the 'size' argument to strlcpy or strlcat
2845// be the size of the source, instead of the destination.
2846void Sema::CheckStrlcpycatArguments(const CallExpr *Call,
2847 IdentifierInfo *FnName) {
2848
2849 // Don't crash if the user has the wrong number of arguments
2850 if (Call->getNumArgs() != 3)
2851 return;
2852
2853 const Expr *SrcArg = ignoreLiteralAdditions(Call->getArg(1), Context);
2854 const Expr *SizeArg = ignoreLiteralAdditions(Call->getArg(2), Context);
2855 const Expr *CompareWithSrc = NULL;
2856
2857 // Look for 'strlcpy(dst, x, sizeof(x))'
2858 if (const Expr *Ex = getSizeOfExprArg(SizeArg))
2859 CompareWithSrc = Ex;
2860 else {
2861 // Look for 'strlcpy(dst, x, strlen(x))'
2862 if (const CallExpr *SizeCall = dyn_cast<CallExpr>(SizeArg)) {
Richard Smith180f4792011-11-10 06:34:14 +00002863 if (SizeCall->isBuiltinCall() == Builtin::BIstrlen
Ted Kremenekbd5da9d2011-08-18 20:55:45 +00002864 && SizeCall->getNumArgs() == 1)
2865 CompareWithSrc = ignoreLiteralAdditions(SizeCall->getArg(0), Context);
2866 }
2867 }
2868
2869 if (!CompareWithSrc)
2870 return;
2871
2872 // Determine if the argument to sizeof/strlen is equal to the source
2873 // argument. In principle there's all kinds of things you could do
2874 // here, for instance creating an == expression and evaluating it with
2875 // EvaluateAsBooleanCondition, but this uses a more direct technique:
2876 const DeclRefExpr *SrcArgDRE = dyn_cast<DeclRefExpr>(SrcArg);
2877 if (!SrcArgDRE)
2878 return;
2879
2880 const DeclRefExpr *CompareWithSrcDRE = dyn_cast<DeclRefExpr>(CompareWithSrc);
2881 if (!CompareWithSrcDRE ||
2882 SrcArgDRE->getDecl() != CompareWithSrcDRE->getDecl())
2883 return;
2884
2885 const Expr *OriginalSizeArg = Call->getArg(2);
2886 Diag(CompareWithSrcDRE->getLocStart(), diag::warn_strlcpycat_wrong_size)
2887 << OriginalSizeArg->getSourceRange() << FnName;
2888
2889 // Output a FIXIT hint if the destination is an array (rather than a
2890 // pointer to an array). This could be enhanced to handle some
2891 // pointers if we know the actual size, like if DstArg is 'array+2'
2892 // we could say 'sizeof(array)-2'.
2893 const Expr *DstArg = Call->getArg(0)->IgnoreParenImpCasts();
Ted Kremenek8f746222011-08-18 22:48:41 +00002894 QualType DstArgTy = DstArg->getType();
Ted Kremenekbd5da9d2011-08-18 20:55:45 +00002895
Ted Kremenek8f746222011-08-18 22:48:41 +00002896 // Only handle constant-sized or VLAs, but not flexible members.
2897 if (const ConstantArrayType *CAT = Context.getAsConstantArrayType(DstArgTy)) {
2898 // Only issue the FIXIT for arrays of size > 1.
2899 if (CAT->getSize().getSExtValue() <= 1)
2900 return;
2901 } else if (!DstArgTy->isVariableArrayType()) {
2902 return;
Ted Kremenekbd5da9d2011-08-18 20:55:45 +00002903 }
Ted Kremenek8f746222011-08-18 22:48:41 +00002904
Dylan Noblesmithf7ccbad2012-02-05 02:13:05 +00002905 SmallString<128> sizeString;
Ted Kremenek8f746222011-08-18 22:48:41 +00002906 llvm::raw_svector_ostream OS(sizeString);
2907 OS << "sizeof(";
Douglas Gregor8987b232011-09-27 23:30:47 +00002908 DstArg->printPretty(OS, Context, 0, getPrintingPolicy());
Ted Kremenek8f746222011-08-18 22:48:41 +00002909 OS << ")";
2910
2911 Diag(OriginalSizeArg->getLocStart(), diag::note_strlcpycat_wrong_size)
2912 << FixItHint::CreateReplacement(OriginalSizeArg->getSourceRange(),
2913 OS.str());
Ted Kremenekbd5da9d2011-08-18 20:55:45 +00002914}
2915
Anna Zaksc36bedc2012-02-01 19:08:57 +00002916/// Check if two expressions refer to the same declaration.
2917static bool referToTheSameDecl(const Expr *E1, const Expr *E2) {
2918 if (const DeclRefExpr *D1 = dyn_cast_or_null<DeclRefExpr>(E1))
2919 if (const DeclRefExpr *D2 = dyn_cast_or_null<DeclRefExpr>(E2))
2920 return D1->getDecl() == D2->getDecl();
2921 return false;
2922}
2923
2924static const Expr *getStrlenExprArg(const Expr *E) {
2925 if (const CallExpr *CE = dyn_cast<CallExpr>(E)) {
2926 const FunctionDecl *FD = CE->getDirectCallee();
2927 if (!FD || FD->getMemoryFunctionKind() != Builtin::BIstrlen)
2928 return 0;
2929 return CE->getArg(0)->IgnoreParenCasts();
2930 }
2931 return 0;
2932}
2933
2934// Warn on anti-patterns as the 'size' argument to strncat.
2935// The correct size argument should look like following:
2936// strncat(dst, src, sizeof(dst) - strlen(dest) - 1);
2937void Sema::CheckStrncatArguments(const CallExpr *CE,
2938 IdentifierInfo *FnName) {
2939 // Don't crash if the user has the wrong number of arguments.
2940 if (CE->getNumArgs() < 3)
2941 return;
2942 const Expr *DstArg = CE->getArg(0)->IgnoreParenCasts();
2943 const Expr *SrcArg = CE->getArg(1)->IgnoreParenCasts();
2944 const Expr *LenArg = CE->getArg(2)->IgnoreParenCasts();
2945
2946 // Identify common expressions, which are wrongly used as the size argument
2947 // to strncat and may lead to buffer overflows.
2948 unsigned PatternType = 0;
2949 if (const Expr *SizeOfArg = getSizeOfExprArg(LenArg)) {
2950 // - sizeof(dst)
2951 if (referToTheSameDecl(SizeOfArg, DstArg))
2952 PatternType = 1;
2953 // - sizeof(src)
2954 else if (referToTheSameDecl(SizeOfArg, SrcArg))
2955 PatternType = 2;
2956 } else if (const BinaryOperator *BE = dyn_cast<BinaryOperator>(LenArg)) {
2957 if (BE->getOpcode() == BO_Sub) {
2958 const Expr *L = BE->getLHS()->IgnoreParenCasts();
2959 const Expr *R = BE->getRHS()->IgnoreParenCasts();
2960 // - sizeof(dst) - strlen(dst)
2961 if (referToTheSameDecl(DstArg, getSizeOfExprArg(L)) &&
2962 referToTheSameDecl(DstArg, getStrlenExprArg(R)))
2963 PatternType = 1;
2964 // - sizeof(src) - (anything)
2965 else if (referToTheSameDecl(SrcArg, getSizeOfExprArg(L)))
2966 PatternType = 2;
2967 }
2968 }
2969
2970 if (PatternType == 0)
2971 return;
2972
Anna Zaksafdb0412012-02-03 01:27:37 +00002973 // Generate the diagnostic.
2974 SourceLocation SL = LenArg->getLocStart();
2975 SourceRange SR = LenArg->getSourceRange();
2976 SourceManager &SM = PP.getSourceManager();
2977
2978 // If the function is defined as a builtin macro, do not show macro expansion.
2979 if (SM.isMacroArgExpansion(SL)) {
2980 SL = SM.getSpellingLoc(SL);
2981 SR = SourceRange(SM.getSpellingLoc(SR.getBegin()),
2982 SM.getSpellingLoc(SR.getEnd()));
2983 }
2984
Anna Zaksc36bedc2012-02-01 19:08:57 +00002985 if (PatternType == 1)
Anna Zaksafdb0412012-02-03 01:27:37 +00002986 Diag(SL, diag::warn_strncat_large_size) << SR;
Anna Zaksc36bedc2012-02-01 19:08:57 +00002987 else
Anna Zaksafdb0412012-02-03 01:27:37 +00002988 Diag(SL, diag::warn_strncat_src_size) << SR;
Anna Zaksc36bedc2012-02-01 19:08:57 +00002989
2990 // Output a FIXIT hint if the destination is an array (rather than a
2991 // pointer to an array). This could be enhanced to handle some
2992 // pointers if we know the actual size, like if DstArg is 'array+2'
2993 // we could say 'sizeof(array)-2'.
2994 QualType DstArgTy = DstArg->getType();
2995
2996 // Only handle constant-sized or VLAs, but not flexible members.
2997 if (const ConstantArrayType *CAT = Context.getAsConstantArrayType(DstArgTy)) {
2998 // Only issue the FIXIT for arrays of size > 1.
2999 if (CAT->getSize().getSExtValue() <= 1)
3000 return;
3001 } else if (!DstArgTy->isVariableArrayType()) {
3002 return;
3003 }
3004
Dylan Noblesmithf7ccbad2012-02-05 02:13:05 +00003005 SmallString<128> sizeString;
Anna Zaksc36bedc2012-02-01 19:08:57 +00003006 llvm::raw_svector_ostream OS(sizeString);
3007 OS << "sizeof(";
3008 DstArg->printPretty(OS, Context, 0, getPrintingPolicy());
3009 OS << ") - ";
3010 OS << "strlen(";
3011 DstArg->printPretty(OS, Context, 0, getPrintingPolicy());
3012 OS << ") - 1";
3013
Anna Zaksafdb0412012-02-03 01:27:37 +00003014 Diag(SL, diag::note_strncat_wrong_size)
3015 << FixItHint::CreateReplacement(SR, OS.str());
Anna Zaksc36bedc2012-02-01 19:08:57 +00003016}
3017
Ted Kremenek06de2762007-08-17 16:46:58 +00003018//===--- CHECK: Return Address of Stack Variable --------------------------===//
3019
Chris Lattner5f9e2722011-07-23 10:55:15 +00003020static Expr *EvalVal(Expr *E, SmallVectorImpl<DeclRefExpr *> &refVars);
3021static Expr *EvalAddr(Expr* E, SmallVectorImpl<DeclRefExpr *> &refVars);
Ted Kremenek06de2762007-08-17 16:46:58 +00003022
3023/// CheckReturnStackAddr - Check if a return statement returns the address
3024/// of a stack variable.
3025void
3026Sema::CheckReturnStackAddr(Expr *RetValExp, QualType lhsType,
3027 SourceLocation ReturnLoc) {
Mike Stump1eb44332009-09-09 15:08:12 +00003028
Argyrios Kyrtzidis26e10be2010-11-30 22:57:32 +00003029 Expr *stackE = 0;
Chris Lattner5f9e2722011-07-23 10:55:15 +00003030 SmallVector<DeclRefExpr *, 8> refVars;
Argyrios Kyrtzidis26e10be2010-11-30 22:57:32 +00003031
3032 // Perform checking for returned stack addresses, local blocks,
3033 // label addresses or references to temporaries.
John McCallf85e1932011-06-15 23:02:42 +00003034 if (lhsType->isPointerType() ||
David Blaikie4e4d0842012-03-11 07:00:24 +00003035 (!getLangOpts().ObjCAutoRefCount && lhsType->isBlockPointerType())) {
Argyrios Kyrtzidis26e10be2010-11-30 22:57:32 +00003036 stackE = EvalAddr(RetValExp, refVars);
Mike Stumpac5fc7c2009-08-04 21:02:39 +00003037 } else if (lhsType->isReferenceType()) {
Argyrios Kyrtzidis26e10be2010-11-30 22:57:32 +00003038 stackE = EvalVal(RetValExp, refVars);
3039 }
3040
3041 if (stackE == 0)
3042 return; // Nothing suspicious was found.
3043
3044 SourceLocation diagLoc;
3045 SourceRange diagRange;
3046 if (refVars.empty()) {
3047 diagLoc = stackE->getLocStart();
3048 diagRange = stackE->getSourceRange();
3049 } else {
3050 // We followed through a reference variable. 'stackE' contains the
3051 // problematic expression but we will warn at the return statement pointing
3052 // at the reference variable. We will later display the "trail" of
3053 // reference variables using notes.
3054 diagLoc = refVars[0]->getLocStart();
3055 diagRange = refVars[0]->getSourceRange();
3056 }
3057
3058 if (DeclRefExpr *DR = dyn_cast<DeclRefExpr>(stackE)) { //address of local var.
3059 Diag(diagLoc, lhsType->isReferenceType() ? diag::warn_ret_stack_ref
3060 : diag::warn_ret_stack_addr)
3061 << DR->getDecl()->getDeclName() << diagRange;
3062 } else if (isa<BlockExpr>(stackE)) { // local block.
3063 Diag(diagLoc, diag::err_ret_local_block) << diagRange;
3064 } else if (isa<AddrLabelExpr>(stackE)) { // address of label.
3065 Diag(diagLoc, diag::warn_ret_addr_label) << diagRange;
3066 } else { // local temporary.
3067 Diag(diagLoc, lhsType->isReferenceType() ? diag::warn_ret_local_temp_ref
3068 : diag::warn_ret_local_temp_addr)
3069 << diagRange;
3070 }
3071
3072 // Display the "trail" of reference variables that we followed until we
3073 // found the problematic expression using notes.
3074 for (unsigned i = 0, e = refVars.size(); i != e; ++i) {
3075 VarDecl *VD = cast<VarDecl>(refVars[i]->getDecl());
3076 // If this var binds to another reference var, show the range of the next
3077 // var, otherwise the var binds to the problematic expression, in which case
3078 // show the range of the expression.
3079 SourceRange range = (i < e-1) ? refVars[i+1]->getSourceRange()
3080 : stackE->getSourceRange();
3081 Diag(VD->getLocation(), diag::note_ref_var_local_bind)
3082 << VD->getDeclName() << range;
Ted Kremenek06de2762007-08-17 16:46:58 +00003083 }
3084}
3085
3086/// EvalAddr - EvalAddr and EvalVal are mutually recursive functions that
3087/// check if the expression in a return statement evaluates to an address
Argyrios Kyrtzidis26e10be2010-11-30 22:57:32 +00003088/// to a location on the stack, a local block, an address of a label, or a
3089/// reference to local temporary. The recursion is used to traverse the
Ted Kremenek06de2762007-08-17 16:46:58 +00003090/// AST of the return expression, with recursion backtracking when we
Argyrios Kyrtzidis26e10be2010-11-30 22:57:32 +00003091/// encounter a subexpression that (1) clearly does not lead to one of the
3092/// above problematic expressions (2) is something we cannot determine leads to
3093/// a problematic expression based on such local checking.
3094///
3095/// Both EvalAddr and EvalVal follow through reference variables to evaluate
3096/// the expression that they point to. Such variables are added to the
3097/// 'refVars' vector so that we know what the reference variable "trail" was.
Ted Kremenek06de2762007-08-17 16:46:58 +00003098///
Ted Kremeneke8c600f2007-08-28 17:02:55 +00003099/// EvalAddr processes expressions that are pointers that are used as
3100/// references (and not L-values). EvalVal handles all other values.
Argyrios Kyrtzidis26e10be2010-11-30 22:57:32 +00003101/// At the base case of the recursion is a check for the above problematic
3102/// expressions.
Ted Kremenek06de2762007-08-17 16:46:58 +00003103///
3104/// This implementation handles:
3105///
3106/// * pointer-to-pointer casts
3107/// * implicit conversions from array references to pointers
3108/// * taking the address of fields
3109/// * arbitrary interplay between "&" and "*" operators
3110/// * pointer arithmetic from an address of a stack variable
3111/// * taking the address of an array element where the array is on the stack
Chris Lattner5f9e2722011-07-23 10:55:15 +00003112static Expr *EvalAddr(Expr *E, SmallVectorImpl<DeclRefExpr *> &refVars) {
Argyrios Kyrtzidis26e10be2010-11-30 22:57:32 +00003113 if (E->isTypeDependent())
3114 return NULL;
3115
Ted Kremenek06de2762007-08-17 16:46:58 +00003116 // We should only be called for evaluating pointer expressions.
David Chisnall0f436562009-08-17 16:35:33 +00003117 assert((E->getType()->isAnyPointerType() ||
Steve Naroffdd972f22008-09-05 22:11:13 +00003118 E->getType()->isBlockPointerType() ||
Ted Kremeneka526c5c2008-01-07 19:49:32 +00003119 E->getType()->isObjCQualifiedIdType()) &&
Chris Lattnerfae3f1f2007-12-28 05:31:15 +00003120 "EvalAddr only works on pointers");
Mike Stump1eb44332009-09-09 15:08:12 +00003121
Peter Collingbournef111d932011-04-15 00:35:48 +00003122 E = E->IgnoreParens();
3123
Ted Kremenek06de2762007-08-17 16:46:58 +00003124 // Our "symbolic interpreter" is just a dispatch off the currently
3125 // viewed AST node. We then recursively traverse the AST by calling
3126 // EvalAddr and EvalVal appropriately.
3127 switch (E->getStmtClass()) {
Argyrios Kyrtzidis26e10be2010-11-30 22:57:32 +00003128 case Stmt::DeclRefExprClass: {
3129 DeclRefExpr *DR = cast<DeclRefExpr>(E);
3130
3131 if (VarDecl *V = dyn_cast<VarDecl>(DR->getDecl()))
3132 // If this is a reference variable, follow through to the expression that
3133 // it points to.
3134 if (V->hasLocalStorage() &&
3135 V->getType()->isReferenceType() && V->hasInit()) {
3136 // Add the reference variable to the "trail".
3137 refVars.push_back(DR);
3138 return EvalAddr(V->getInit(), refVars);
3139 }
3140
3141 return NULL;
3142 }
Ted Kremenek06de2762007-08-17 16:46:58 +00003143
Chris Lattnerfae3f1f2007-12-28 05:31:15 +00003144 case Stmt::UnaryOperatorClass: {
3145 // The only unary operator that make sense to handle here
3146 // is AddrOf. All others don't make sense as pointers.
3147 UnaryOperator *U = cast<UnaryOperator>(E);
Mike Stump1eb44332009-09-09 15:08:12 +00003148
John McCall2de56d12010-08-25 11:45:40 +00003149 if (U->getOpcode() == UO_AddrOf)
Argyrios Kyrtzidis26e10be2010-11-30 22:57:32 +00003150 return EvalVal(U->getSubExpr(), refVars);
Chris Lattnerfae3f1f2007-12-28 05:31:15 +00003151 else
Ted Kremenek06de2762007-08-17 16:46:58 +00003152 return NULL;
3153 }
Mike Stump1eb44332009-09-09 15:08:12 +00003154
Chris Lattnerfae3f1f2007-12-28 05:31:15 +00003155 case Stmt::BinaryOperatorClass: {
3156 // Handle pointer arithmetic. All other binary operators are not valid
3157 // in this context.
3158 BinaryOperator *B = cast<BinaryOperator>(E);
John McCall2de56d12010-08-25 11:45:40 +00003159 BinaryOperatorKind op = B->getOpcode();
Mike Stump1eb44332009-09-09 15:08:12 +00003160
John McCall2de56d12010-08-25 11:45:40 +00003161 if (op != BO_Add && op != BO_Sub)
Chris Lattnerfae3f1f2007-12-28 05:31:15 +00003162 return NULL;
Mike Stump1eb44332009-09-09 15:08:12 +00003163
Chris Lattnerfae3f1f2007-12-28 05:31:15 +00003164 Expr *Base = B->getLHS();
3165
3166 // Determine which argument is the real pointer base. It could be
3167 // the RHS argument instead of the LHS.
3168 if (!Base->getType()->isPointerType()) Base = B->getRHS();
Mike Stump1eb44332009-09-09 15:08:12 +00003169
Chris Lattnerfae3f1f2007-12-28 05:31:15 +00003170 assert (Base->getType()->isPointerType());
Argyrios Kyrtzidis26e10be2010-11-30 22:57:32 +00003171 return EvalAddr(Base, refVars);
Chris Lattnerfae3f1f2007-12-28 05:31:15 +00003172 }
Steve Naroff61f40a22008-09-10 19:17:48 +00003173
Chris Lattnerfae3f1f2007-12-28 05:31:15 +00003174 // For conditional operators we need to see if either the LHS or RHS are
3175 // valid DeclRefExpr*s. If one of them is valid, we return it.
3176 case Stmt::ConditionalOperatorClass: {
3177 ConditionalOperator *C = cast<ConditionalOperator>(E);
Mike Stump1eb44332009-09-09 15:08:12 +00003178
Chris Lattnerfae3f1f2007-12-28 05:31:15 +00003179 // Handle the GNU extension for missing LHS.
Douglas Gregor9ee5ee82010-10-21 16:21:08 +00003180 if (Expr *lhsExpr = C->getLHS()) {
3181 // In C++, we can have a throw-expression, which has 'void' type.
3182 if (!lhsExpr->getType()->isVoidType())
Argyrios Kyrtzidis26e10be2010-11-30 22:57:32 +00003183 if (Expr* LHS = EvalAddr(lhsExpr, refVars))
Douglas Gregor9ee5ee82010-10-21 16:21:08 +00003184 return LHS;
3185 }
Chris Lattnerfae3f1f2007-12-28 05:31:15 +00003186
Douglas Gregor9ee5ee82010-10-21 16:21:08 +00003187 // In C++, we can have a throw-expression, which has 'void' type.
3188 if (C->getRHS()->getType()->isVoidType())
3189 return NULL;
3190
Argyrios Kyrtzidis26e10be2010-11-30 22:57:32 +00003191 return EvalAddr(C->getRHS(), refVars);
Chris Lattnerfae3f1f2007-12-28 05:31:15 +00003192 }
Argyrios Kyrtzidis26e10be2010-11-30 22:57:32 +00003193
3194 case Stmt::BlockExprClass:
John McCall469a1eb2011-02-02 13:00:07 +00003195 if (cast<BlockExpr>(E)->getBlockDecl()->hasCaptures())
Argyrios Kyrtzidis26e10be2010-11-30 22:57:32 +00003196 return E; // local block.
3197 return NULL;
3198
3199 case Stmt::AddrLabelExprClass:
3200 return E; // address of label.
Mike Stump1eb44332009-09-09 15:08:12 +00003201
John McCall80ee6e82011-11-10 05:35:25 +00003202 case Stmt::ExprWithCleanupsClass:
3203 return EvalAddr(cast<ExprWithCleanups>(E)->getSubExpr(), refVars);
3204
Ted Kremenek54b52742008-08-07 00:49:01 +00003205 // For casts, we need to handle conversions from arrays to
3206 // pointer values, and pointer-to-pointer conversions.
Douglas Gregor49badde2008-10-27 19:41:14 +00003207 case Stmt::ImplicitCastExprClass:
Douglas Gregor6eec8e82008-10-28 15:36:24 +00003208 case Stmt::CStyleCastExprClass:
John McCallf85e1932011-06-15 23:02:42 +00003209 case Stmt::CXXFunctionalCastExprClass:
Eli Friedman8b9414e2012-02-23 23:04:32 +00003210 case Stmt::ObjCBridgedCastExprClass:
Mike Stump1eb44332009-09-09 15:08:12 +00003211 case Stmt::CXXStaticCastExprClass:
3212 case Stmt::CXXDynamicCastExprClass:
Douglas Gregor49badde2008-10-27 19:41:14 +00003213 case Stmt::CXXConstCastExprClass:
3214 case Stmt::CXXReinterpretCastExprClass: {
Eli Friedman8b9414e2012-02-23 23:04:32 +00003215 Expr* SubExpr = cast<CastExpr>(E)->getSubExpr();
3216 switch (cast<CastExpr>(E)->getCastKind()) {
3217 case CK_BitCast:
3218 case CK_LValueToRValue:
3219 case CK_NoOp:
3220 case CK_BaseToDerived:
3221 case CK_DerivedToBase:
3222 case CK_UncheckedDerivedToBase:
3223 case CK_Dynamic:
3224 case CK_CPointerToObjCPointerCast:
3225 case CK_BlockPointerToObjCPointerCast:
3226 case CK_AnyPointerToBlockPointerCast:
3227 return EvalAddr(SubExpr, refVars);
3228
3229 case CK_ArrayToPointerDecay:
3230 return EvalVal(SubExpr, refVars);
3231
3232 default:
3233 return 0;
3234 }
Chris Lattnerfae3f1f2007-12-28 05:31:15 +00003235 }
Mike Stump1eb44332009-09-09 15:08:12 +00003236
Douglas Gregor03e80032011-06-21 17:03:29 +00003237 case Stmt::MaterializeTemporaryExprClass:
3238 if (Expr *Result = EvalAddr(
3239 cast<MaterializeTemporaryExpr>(E)->GetTemporaryExpr(),
3240 refVars))
3241 return Result;
3242
3243 return E;
3244
Chris Lattnerfae3f1f2007-12-28 05:31:15 +00003245 // Everything else: we simply don't reason about them.
3246 default:
3247 return NULL;
3248 }
Ted Kremenek06de2762007-08-17 16:46:58 +00003249}
Mike Stump1eb44332009-09-09 15:08:12 +00003250
Ted Kremenek06de2762007-08-17 16:46:58 +00003251
3252/// EvalVal - This function is complements EvalAddr in the mutual recursion.
3253/// See the comments for EvalAddr for more details.
Chris Lattner5f9e2722011-07-23 10:55:15 +00003254static Expr *EvalVal(Expr *E, SmallVectorImpl<DeclRefExpr *> &refVars) {
Ted Kremenek68957a92010-08-04 20:01:07 +00003255do {
Ted Kremeneke8c600f2007-08-28 17:02:55 +00003256 // We should only be called for evaluating non-pointer expressions, or
3257 // expressions with a pointer type that are not used as references but instead
3258 // are l-values (e.g., DeclRefExpr with a pointer type).
Mike Stump1eb44332009-09-09 15:08:12 +00003259
Ted Kremenek06de2762007-08-17 16:46:58 +00003260 // Our "symbolic interpreter" is just a dispatch off the currently
3261 // viewed AST node. We then recursively traverse the AST by calling
3262 // EvalAddr and EvalVal appropriately.
Peter Collingbournef111d932011-04-15 00:35:48 +00003263
3264 E = E->IgnoreParens();
Ted Kremenek06de2762007-08-17 16:46:58 +00003265 switch (E->getStmtClass()) {
Ted Kremenek68957a92010-08-04 20:01:07 +00003266 case Stmt::ImplicitCastExprClass: {
3267 ImplicitCastExpr *IE = cast<ImplicitCastExpr>(E);
John McCall5baba9d2010-08-25 10:28:54 +00003268 if (IE->getValueKind() == VK_LValue) {
Ted Kremenek68957a92010-08-04 20:01:07 +00003269 E = IE->getSubExpr();
3270 continue;
3271 }
3272 return NULL;
3273 }
3274
John McCall80ee6e82011-11-10 05:35:25 +00003275 case Stmt::ExprWithCleanupsClass:
3276 return EvalVal(cast<ExprWithCleanups>(E)->getSubExpr(), refVars);
3277
Douglas Gregora2813ce2009-10-23 18:54:35 +00003278 case Stmt::DeclRefExprClass: {
Argyrios Kyrtzidis26e10be2010-11-30 22:57:32 +00003279 // When we hit a DeclRefExpr we are looking at code that refers to a
3280 // variable's name. If it's not a reference variable we check if it has
3281 // local storage within the function, and if so, return the expression.
Ted Kremenek06de2762007-08-17 16:46:58 +00003282 DeclRefExpr *DR = cast<DeclRefExpr>(E);
Mike Stump1eb44332009-09-09 15:08:12 +00003283
Ted Kremenek06de2762007-08-17 16:46:58 +00003284 if (VarDecl *V = dyn_cast<VarDecl>(DR->getDecl()))
Argyrios Kyrtzidis26e10be2010-11-30 22:57:32 +00003285 if (V->hasLocalStorage()) {
3286 if (!V->getType()->isReferenceType())
3287 return DR;
3288
3289 // Reference variable, follow through to the expression that
3290 // it points to.
3291 if (V->hasInit()) {
3292 // Add the reference variable to the "trail".
3293 refVars.push_back(DR);
3294 return EvalVal(V->getInit(), refVars);
3295 }
3296 }
Mike Stump1eb44332009-09-09 15:08:12 +00003297
Ted Kremenek06de2762007-08-17 16:46:58 +00003298 return NULL;
3299 }
Mike Stump1eb44332009-09-09 15:08:12 +00003300
Ted Kremenek06de2762007-08-17 16:46:58 +00003301 case Stmt::UnaryOperatorClass: {
3302 // The only unary operator that make sense to handle here
3303 // is Deref. All others don't resolve to a "name." This includes
3304 // handling all sorts of rvalues passed to a unary operator.
3305 UnaryOperator *U = cast<UnaryOperator>(E);
Mike Stump1eb44332009-09-09 15:08:12 +00003306
John McCall2de56d12010-08-25 11:45:40 +00003307 if (U->getOpcode() == UO_Deref)
Argyrios Kyrtzidis26e10be2010-11-30 22:57:32 +00003308 return EvalAddr(U->getSubExpr(), refVars);
Ted Kremenek06de2762007-08-17 16:46:58 +00003309
3310 return NULL;
3311 }
Mike Stump1eb44332009-09-09 15:08:12 +00003312
Ted Kremenek06de2762007-08-17 16:46:58 +00003313 case Stmt::ArraySubscriptExprClass: {
3314 // Array subscripts are potential references to data on the stack. We
3315 // retrieve the DeclRefExpr* for the array variable if it indeed
3316 // has local storage.
Argyrios Kyrtzidis26e10be2010-11-30 22:57:32 +00003317 return EvalAddr(cast<ArraySubscriptExpr>(E)->getBase(), refVars);
Ted Kremenek06de2762007-08-17 16:46:58 +00003318 }
Mike Stump1eb44332009-09-09 15:08:12 +00003319
Ted Kremenek06de2762007-08-17 16:46:58 +00003320 case Stmt::ConditionalOperatorClass: {
3321 // For conditional operators we need to see if either the LHS or RHS are
Argyrios Kyrtzidis26e10be2010-11-30 22:57:32 +00003322 // non-NULL Expr's. If one is non-NULL, we return it.
Ted Kremenek06de2762007-08-17 16:46:58 +00003323 ConditionalOperator *C = cast<ConditionalOperator>(E);
3324
Anders Carlsson39073232007-11-30 19:04:31 +00003325 // Handle the GNU extension for missing LHS.
3326 if (Expr *lhsExpr = C->getLHS())
Argyrios Kyrtzidis26e10be2010-11-30 22:57:32 +00003327 if (Expr *LHS = EvalVal(lhsExpr, refVars))
Anders Carlsson39073232007-11-30 19:04:31 +00003328 return LHS;
3329
Argyrios Kyrtzidis26e10be2010-11-30 22:57:32 +00003330 return EvalVal(C->getRHS(), refVars);
Ted Kremenek06de2762007-08-17 16:46:58 +00003331 }
Mike Stump1eb44332009-09-09 15:08:12 +00003332
Ted Kremenek06de2762007-08-17 16:46:58 +00003333 // Accesses to members are potential references to data on the stack.
Douglas Gregor83f6faf2009-08-31 23:41:50 +00003334 case Stmt::MemberExprClass: {
Ted Kremenek06de2762007-08-17 16:46:58 +00003335 MemberExpr *M = cast<MemberExpr>(E);
Mike Stump1eb44332009-09-09 15:08:12 +00003336
Ted Kremenek06de2762007-08-17 16:46:58 +00003337 // Check for indirect access. We only want direct field accesses.
Ted Kremeneka423e812010-09-02 01:12:13 +00003338 if (M->isArrow())
Ted Kremenek06de2762007-08-17 16:46:58 +00003339 return NULL;
Ted Kremeneka423e812010-09-02 01:12:13 +00003340
3341 // Check whether the member type is itself a reference, in which case
3342 // we're not going to refer to the member, but to what the member refers to.
3343 if (M->getMemberDecl()->getType()->isReferenceType())
3344 return NULL;
3345
Argyrios Kyrtzidis26e10be2010-11-30 22:57:32 +00003346 return EvalVal(M->getBase(), refVars);
Ted Kremenek06de2762007-08-17 16:46:58 +00003347 }
Mike Stump1eb44332009-09-09 15:08:12 +00003348
Douglas Gregor03e80032011-06-21 17:03:29 +00003349 case Stmt::MaterializeTemporaryExprClass:
3350 if (Expr *Result = EvalVal(
3351 cast<MaterializeTemporaryExpr>(E)->GetTemporaryExpr(),
3352 refVars))
3353 return Result;
3354
3355 return E;
3356
Ted Kremenek06de2762007-08-17 16:46:58 +00003357 default:
Argyrios Kyrtzidis26e10be2010-11-30 22:57:32 +00003358 // Check that we don't return or take the address of a reference to a
3359 // temporary. This is only useful in C++.
3360 if (!E->isTypeDependent() && E->isRValue())
3361 return E;
3362
3363 // Everything else: we simply don't reason about them.
Ted Kremenek06de2762007-08-17 16:46:58 +00003364 return NULL;
3365 }
Ted Kremenek68957a92010-08-04 20:01:07 +00003366} while (true);
Ted Kremenek06de2762007-08-17 16:46:58 +00003367}
Ted Kremenek588e5eb2007-11-25 00:58:00 +00003368
3369//===--- CHECK: Floating-Point comparisons (-Wfloat-equal) ---------------===//
3370
3371/// Check for comparisons of floating point operands using != and ==.
3372/// Issue a warning if these are no self-comparisons, as they are not likely
3373/// to do what the programmer intended.
Richard Trieudd225092011-09-15 21:56:47 +00003374void Sema::CheckFloatComparison(SourceLocation Loc, Expr* LHS, Expr *RHS) {
Ted Kremenek588e5eb2007-11-25 00:58:00 +00003375 bool EmitWarning = true;
Mike Stump1eb44332009-09-09 15:08:12 +00003376
Richard Trieudd225092011-09-15 21:56:47 +00003377 Expr* LeftExprSansParen = LHS->IgnoreParenImpCasts();
3378 Expr* RightExprSansParen = RHS->IgnoreParenImpCasts();
Ted Kremenek588e5eb2007-11-25 00:58:00 +00003379
3380 // Special case: check for x == x (which is OK).
3381 // Do not emit warnings for such cases.
3382 if (DeclRefExpr* DRL = dyn_cast<DeclRefExpr>(LeftExprSansParen))
3383 if (DeclRefExpr* DRR = dyn_cast<DeclRefExpr>(RightExprSansParen))
3384 if (DRL->getDecl() == DRR->getDecl())
3385 EmitWarning = false;
Mike Stump1eb44332009-09-09 15:08:12 +00003386
3387
Ted Kremenek1b500bb2007-11-29 00:59:04 +00003388 // Special case: check for comparisons against literals that can be exactly
3389 // represented by APFloat. In such cases, do not emit a warning. This
3390 // is a heuristic: often comparison against such literals are used to
3391 // detect if a value in a variable has not changed. This clearly can
3392 // lead to false negatives.
3393 if (EmitWarning) {
3394 if (FloatingLiteral* FLL = dyn_cast<FloatingLiteral>(LeftExprSansParen)) {
3395 if (FLL->isExact())
3396 EmitWarning = false;
Mike Stumpac5fc7c2009-08-04 21:02:39 +00003397 } else
Ted Kremenek1b500bb2007-11-29 00:59:04 +00003398 if (FloatingLiteral* FLR = dyn_cast<FloatingLiteral>(RightExprSansParen)){
3399 if (FLR->isExact())
3400 EmitWarning = false;
3401 }
3402 }
Mike Stump1eb44332009-09-09 15:08:12 +00003403
Ted Kremenek588e5eb2007-11-25 00:58:00 +00003404 // Check for comparisons with builtin types.
Sebastian Redl0eb23302009-01-19 00:08:26 +00003405 if (EmitWarning)
Ted Kremenek588e5eb2007-11-25 00:58:00 +00003406 if (CallExpr* CL = dyn_cast<CallExpr>(LeftExprSansParen))
Richard Smith180f4792011-11-10 06:34:14 +00003407 if (CL->isBuiltinCall())
Ted Kremenek588e5eb2007-11-25 00:58:00 +00003408 EmitWarning = false;
Mike Stump1eb44332009-09-09 15:08:12 +00003409
Sebastian Redl0eb23302009-01-19 00:08:26 +00003410 if (EmitWarning)
Ted Kremenek588e5eb2007-11-25 00:58:00 +00003411 if (CallExpr* CR = dyn_cast<CallExpr>(RightExprSansParen))
Richard Smith180f4792011-11-10 06:34:14 +00003412 if (CR->isBuiltinCall())
Ted Kremenek588e5eb2007-11-25 00:58:00 +00003413 EmitWarning = false;
Mike Stump1eb44332009-09-09 15:08:12 +00003414
Ted Kremenek588e5eb2007-11-25 00:58:00 +00003415 // Emit the diagnostic.
3416 if (EmitWarning)
Richard Trieudd225092011-09-15 21:56:47 +00003417 Diag(Loc, diag::warn_floatingpoint_eq)
3418 << LHS->getSourceRange() << RHS->getSourceRange();
Ted Kremenek588e5eb2007-11-25 00:58:00 +00003419}
John McCallba26e582010-01-04 23:21:16 +00003420
John McCallf2370c92010-01-06 05:24:50 +00003421//===--- CHECK: Integer mixed-sign comparisons (-Wsign-compare) --------===//
3422//===--- CHECK: Lossy implicit conversions (-Wconversion) --------------===//
John McCallba26e582010-01-04 23:21:16 +00003423
John McCallf2370c92010-01-06 05:24:50 +00003424namespace {
John McCallba26e582010-01-04 23:21:16 +00003425
John McCallf2370c92010-01-06 05:24:50 +00003426/// Structure recording the 'active' range of an integer-valued
3427/// expression.
3428struct IntRange {
3429 /// The number of bits active in the int.
3430 unsigned Width;
John McCallba26e582010-01-04 23:21:16 +00003431
John McCallf2370c92010-01-06 05:24:50 +00003432 /// True if the int is known not to have negative values.
3433 bool NonNegative;
John McCallba26e582010-01-04 23:21:16 +00003434
John McCallf2370c92010-01-06 05:24:50 +00003435 IntRange(unsigned Width, bool NonNegative)
3436 : Width(Width), NonNegative(NonNegative)
3437 {}
John McCallba26e582010-01-04 23:21:16 +00003438
John McCall1844a6e2010-11-10 23:38:19 +00003439 /// Returns the range of the bool type.
John McCallf2370c92010-01-06 05:24:50 +00003440 static IntRange forBoolType() {
3441 return IntRange(1, true);
John McCall51313c32010-01-04 23:31:57 +00003442 }
3443
John McCall1844a6e2010-11-10 23:38:19 +00003444 /// Returns the range of an opaque value of the given integral type.
3445 static IntRange forValueOfType(ASTContext &C, QualType T) {
3446 return forValueOfCanonicalType(C,
3447 T->getCanonicalTypeInternal().getTypePtr());
John McCall51313c32010-01-04 23:31:57 +00003448 }
3449
John McCall1844a6e2010-11-10 23:38:19 +00003450 /// Returns the range of an opaque value of a canonical integral type.
3451 static IntRange forValueOfCanonicalType(ASTContext &C, const Type *T) {
John McCallf2370c92010-01-06 05:24:50 +00003452 assert(T->isCanonicalUnqualified());
3453
3454 if (const VectorType *VT = dyn_cast<VectorType>(T))
3455 T = VT->getElementType().getTypePtr();
3456 if (const ComplexType *CT = dyn_cast<ComplexType>(T))
3457 T = CT->getElementType().getTypePtr();
John McCall323ed742010-05-06 08:58:33 +00003458
John McCall091f23f2010-11-09 22:22:12 +00003459 // For enum types, use the known bit width of the enumerators.
John McCall323ed742010-05-06 08:58:33 +00003460 if (const EnumType *ET = dyn_cast<EnumType>(T)) {
3461 EnumDecl *Enum = ET->getDecl();
John McCall5e1cdac2011-10-07 06:10:15 +00003462 if (!Enum->isCompleteDefinition())
John McCall091f23f2010-11-09 22:22:12 +00003463 return IntRange(C.getIntWidth(QualType(T, 0)), false);
3464
John McCall323ed742010-05-06 08:58:33 +00003465 unsigned NumPositive = Enum->getNumPositiveBits();
3466 unsigned NumNegative = Enum->getNumNegativeBits();
3467
3468 return IntRange(std::max(NumPositive, NumNegative), NumNegative == 0);
3469 }
John McCallf2370c92010-01-06 05:24:50 +00003470
3471 const BuiltinType *BT = cast<BuiltinType>(T);
3472 assert(BT->isInteger());
3473
3474 return IntRange(C.getIntWidth(QualType(T, 0)), BT->isUnsignedInteger());
3475 }
3476
John McCall1844a6e2010-11-10 23:38:19 +00003477 /// Returns the "target" range of a canonical integral type, i.e.
3478 /// the range of values expressible in the type.
3479 ///
3480 /// This matches forValueOfCanonicalType except that enums have the
3481 /// full range of their type, not the range of their enumerators.
3482 static IntRange forTargetOfCanonicalType(ASTContext &C, const Type *T) {
3483 assert(T->isCanonicalUnqualified());
3484
3485 if (const VectorType *VT = dyn_cast<VectorType>(T))
3486 T = VT->getElementType().getTypePtr();
3487 if (const ComplexType *CT = dyn_cast<ComplexType>(T))
3488 T = CT->getElementType().getTypePtr();
3489 if (const EnumType *ET = dyn_cast<EnumType>(T))
Douglas Gregor69ff26b2011-09-08 23:29:05 +00003490 T = C.getCanonicalType(ET->getDecl()->getIntegerType()).getTypePtr();
John McCall1844a6e2010-11-10 23:38:19 +00003491
3492 const BuiltinType *BT = cast<BuiltinType>(T);
3493 assert(BT->isInteger());
3494
3495 return IntRange(C.getIntWidth(QualType(T, 0)), BT->isUnsignedInteger());
3496 }
3497
3498 /// Returns the supremum of two ranges: i.e. their conservative merge.
John McCallc0cd21d2010-02-23 19:22:29 +00003499 static IntRange join(IntRange L, IntRange R) {
John McCallf2370c92010-01-06 05:24:50 +00003500 return IntRange(std::max(L.Width, R.Width),
John McCall60fad452010-01-06 22:07:33 +00003501 L.NonNegative && R.NonNegative);
3502 }
3503
John McCall1844a6e2010-11-10 23:38:19 +00003504 /// Returns the infinum of two ranges: i.e. their aggressive merge.
John McCallc0cd21d2010-02-23 19:22:29 +00003505 static IntRange meet(IntRange L, IntRange R) {
John McCall60fad452010-01-06 22:07:33 +00003506 return IntRange(std::min(L.Width, R.Width),
3507 L.NonNegative || R.NonNegative);
John McCallf2370c92010-01-06 05:24:50 +00003508 }
3509};
3510
Ted Kremenek0692a192012-01-31 05:37:37 +00003511static IntRange GetValueRange(ASTContext &C, llvm::APSInt &value,
3512 unsigned MaxWidth) {
John McCallf2370c92010-01-06 05:24:50 +00003513 if (value.isSigned() && value.isNegative())
3514 return IntRange(value.getMinSignedBits(), false);
3515
3516 if (value.getBitWidth() > MaxWidth)
Jay Foad9f71a8f2010-12-07 08:25:34 +00003517 value = value.trunc(MaxWidth);
John McCallf2370c92010-01-06 05:24:50 +00003518
3519 // isNonNegative() just checks the sign bit without considering
3520 // signedness.
3521 return IntRange(value.getActiveBits(), true);
3522}
3523
Ted Kremenek0692a192012-01-31 05:37:37 +00003524static IntRange GetValueRange(ASTContext &C, APValue &result, QualType Ty,
3525 unsigned MaxWidth) {
John McCallf2370c92010-01-06 05:24:50 +00003526 if (result.isInt())
3527 return GetValueRange(C, result.getInt(), MaxWidth);
3528
3529 if (result.isVector()) {
John McCall0acc3112010-01-06 22:57:21 +00003530 IntRange R = GetValueRange(C, result.getVectorElt(0), Ty, MaxWidth);
3531 for (unsigned i = 1, e = result.getVectorLength(); i != e; ++i) {
3532 IntRange El = GetValueRange(C, result.getVectorElt(i), Ty, MaxWidth);
3533 R = IntRange::join(R, El);
3534 }
John McCallf2370c92010-01-06 05:24:50 +00003535 return R;
3536 }
3537
3538 if (result.isComplexInt()) {
3539 IntRange R = GetValueRange(C, result.getComplexIntReal(), MaxWidth);
3540 IntRange I = GetValueRange(C, result.getComplexIntImag(), MaxWidth);
3541 return IntRange::join(R, I);
John McCall51313c32010-01-04 23:31:57 +00003542 }
3543
3544 // This can happen with lossless casts to intptr_t of "based" lvalues.
3545 // Assume it might use arbitrary bits.
John McCall0acc3112010-01-06 22:57:21 +00003546 // FIXME: The only reason we need to pass the type in here is to get
3547 // the sign right on this one case. It would be nice if APValue
3548 // preserved this.
Eli Friedman65639282012-01-04 23:13:47 +00003549 assert(result.isLValue() || result.isAddrLabelDiff());
Douglas Gregor5e9ebb32011-05-21 16:28:01 +00003550 return IntRange(MaxWidth, Ty->isUnsignedIntegerOrEnumerationType());
John McCall51313c32010-01-04 23:31:57 +00003551}
John McCallf2370c92010-01-06 05:24:50 +00003552
3553/// Pseudo-evaluate the given integer expression, estimating the
3554/// range of values it might take.
3555///
3556/// \param MaxWidth - the width to which the value will be truncated
Ted Kremenek0692a192012-01-31 05:37:37 +00003557static IntRange GetExprRange(ASTContext &C, Expr *E, unsigned MaxWidth) {
John McCallf2370c92010-01-06 05:24:50 +00003558 E = E->IgnoreParens();
3559
3560 // Try a full evaluation first.
3561 Expr::EvalResult result;
Richard Smith51f47082011-10-29 00:50:52 +00003562 if (E->EvaluateAsRValue(result, C))
John McCall0acc3112010-01-06 22:57:21 +00003563 return GetValueRange(C, result.Val, E->getType(), MaxWidth);
John McCallf2370c92010-01-06 05:24:50 +00003564
3565 // I think we only want to look through implicit casts here; if the
3566 // user has an explicit widening cast, we should treat the value as
3567 // being of the new, wider type.
3568 if (ImplicitCastExpr *CE = dyn_cast<ImplicitCastExpr>(E)) {
Eli Friedmanb17ee5b2011-12-15 02:41:52 +00003569 if (CE->getCastKind() == CK_NoOp || CE->getCastKind() == CK_LValueToRValue)
John McCallf2370c92010-01-06 05:24:50 +00003570 return GetExprRange(C, CE->getSubExpr(), MaxWidth);
3571
John McCall1844a6e2010-11-10 23:38:19 +00003572 IntRange OutputTypeRange = IntRange::forValueOfType(C, CE->getType());
John McCallf2370c92010-01-06 05:24:50 +00003573
John McCall2de56d12010-08-25 11:45:40 +00003574 bool isIntegerCast = (CE->getCastKind() == CK_IntegralCast);
John McCall60fad452010-01-06 22:07:33 +00003575
John McCallf2370c92010-01-06 05:24:50 +00003576 // Assume that non-integer casts can span the full range of the type.
John McCall60fad452010-01-06 22:07:33 +00003577 if (!isIntegerCast)
John McCallf2370c92010-01-06 05:24:50 +00003578 return OutputTypeRange;
3579
3580 IntRange SubRange
3581 = GetExprRange(C, CE->getSubExpr(),
3582 std::min(MaxWidth, OutputTypeRange.Width));
3583
3584 // Bail out if the subexpr's range is as wide as the cast type.
3585 if (SubRange.Width >= OutputTypeRange.Width)
3586 return OutputTypeRange;
3587
3588 // Otherwise, we take the smaller width, and we're non-negative if
3589 // either the output type or the subexpr is.
3590 return IntRange(SubRange.Width,
3591 SubRange.NonNegative || OutputTypeRange.NonNegative);
3592 }
3593
3594 if (ConditionalOperator *CO = dyn_cast<ConditionalOperator>(E)) {
3595 // If we can fold the condition, just take that operand.
3596 bool CondResult;
3597 if (CO->getCond()->EvaluateAsBooleanCondition(CondResult, C))
3598 return GetExprRange(C, CondResult ? CO->getTrueExpr()
3599 : CO->getFalseExpr(),
3600 MaxWidth);
3601
3602 // Otherwise, conservatively merge.
3603 IntRange L = GetExprRange(C, CO->getTrueExpr(), MaxWidth);
3604 IntRange R = GetExprRange(C, CO->getFalseExpr(), MaxWidth);
3605 return IntRange::join(L, R);
3606 }
3607
3608 if (BinaryOperator *BO = dyn_cast<BinaryOperator>(E)) {
3609 switch (BO->getOpcode()) {
3610
3611 // Boolean-valued operations are single-bit and positive.
John McCall2de56d12010-08-25 11:45:40 +00003612 case BO_LAnd:
3613 case BO_LOr:
3614 case BO_LT:
3615 case BO_GT:
3616 case BO_LE:
3617 case BO_GE:
3618 case BO_EQ:
3619 case BO_NE:
John McCallf2370c92010-01-06 05:24:50 +00003620 return IntRange::forBoolType();
3621
John McCall862ff872011-07-13 06:35:24 +00003622 // The type of the assignments is the type of the LHS, so the RHS
3623 // is not necessarily the same type.
John McCall2de56d12010-08-25 11:45:40 +00003624 case BO_MulAssign:
3625 case BO_DivAssign:
3626 case BO_RemAssign:
3627 case BO_AddAssign:
3628 case BO_SubAssign:
John McCall862ff872011-07-13 06:35:24 +00003629 case BO_XorAssign:
3630 case BO_OrAssign:
3631 // TODO: bitfields?
John McCall1844a6e2010-11-10 23:38:19 +00003632 return IntRange::forValueOfType(C, E->getType());
John McCallc0cd21d2010-02-23 19:22:29 +00003633
John McCall862ff872011-07-13 06:35:24 +00003634 // Simple assignments just pass through the RHS, which will have
3635 // been coerced to the LHS type.
3636 case BO_Assign:
3637 // TODO: bitfields?
3638 return GetExprRange(C, BO->getRHS(), MaxWidth);
3639
John McCallf2370c92010-01-06 05:24:50 +00003640 // Operations with opaque sources are black-listed.
John McCall2de56d12010-08-25 11:45:40 +00003641 case BO_PtrMemD:
3642 case BO_PtrMemI:
John McCall1844a6e2010-11-10 23:38:19 +00003643 return IntRange::forValueOfType(C, E->getType());
John McCallf2370c92010-01-06 05:24:50 +00003644
John McCall60fad452010-01-06 22:07:33 +00003645 // Bitwise-and uses the *infinum* of the two source ranges.
John McCall2de56d12010-08-25 11:45:40 +00003646 case BO_And:
3647 case BO_AndAssign:
John McCall60fad452010-01-06 22:07:33 +00003648 return IntRange::meet(GetExprRange(C, BO->getLHS(), MaxWidth),
3649 GetExprRange(C, BO->getRHS(), MaxWidth));
3650
John McCallf2370c92010-01-06 05:24:50 +00003651 // Left shift gets black-listed based on a judgement call.
John McCall2de56d12010-08-25 11:45:40 +00003652 case BO_Shl:
John McCall3aae6092010-04-07 01:14:35 +00003653 // ...except that we want to treat '1 << (blah)' as logically
3654 // positive. It's an important idiom.
3655 if (IntegerLiteral *I
3656 = dyn_cast<IntegerLiteral>(BO->getLHS()->IgnoreParenCasts())) {
3657 if (I->getValue() == 1) {
John McCall1844a6e2010-11-10 23:38:19 +00003658 IntRange R = IntRange::forValueOfType(C, E->getType());
John McCall3aae6092010-04-07 01:14:35 +00003659 return IntRange(R.Width, /*NonNegative*/ true);
3660 }
3661 }
3662 // fallthrough
3663
John McCall2de56d12010-08-25 11:45:40 +00003664 case BO_ShlAssign:
John McCall1844a6e2010-11-10 23:38:19 +00003665 return IntRange::forValueOfType(C, E->getType());
John McCallf2370c92010-01-06 05:24:50 +00003666
John McCall60fad452010-01-06 22:07:33 +00003667 // Right shift by a constant can narrow its left argument.
John McCall2de56d12010-08-25 11:45:40 +00003668 case BO_Shr:
3669 case BO_ShrAssign: {
John McCall60fad452010-01-06 22:07:33 +00003670 IntRange L = GetExprRange(C, BO->getLHS(), MaxWidth);
3671
3672 // If the shift amount is a positive constant, drop the width by
3673 // that much.
3674 llvm::APSInt shift;
3675 if (BO->getRHS()->isIntegerConstantExpr(shift, C) &&
3676 shift.isNonNegative()) {
3677 unsigned zext = shift.getZExtValue();
3678 if (zext >= L.Width)
3679 L.Width = (L.NonNegative ? 0 : 1);
3680 else
3681 L.Width -= zext;
3682 }
3683
3684 return L;
3685 }
3686
3687 // Comma acts as its right operand.
John McCall2de56d12010-08-25 11:45:40 +00003688 case BO_Comma:
John McCallf2370c92010-01-06 05:24:50 +00003689 return GetExprRange(C, BO->getRHS(), MaxWidth);
3690
John McCall60fad452010-01-06 22:07:33 +00003691 // Black-list pointer subtractions.
John McCall2de56d12010-08-25 11:45:40 +00003692 case BO_Sub:
John McCallf2370c92010-01-06 05:24:50 +00003693 if (BO->getLHS()->getType()->isPointerType())
John McCall1844a6e2010-11-10 23:38:19 +00003694 return IntRange::forValueOfType(C, E->getType());
John McCall00fe7612011-07-14 22:39:48 +00003695 break;
Ted Kremenek4e4b30e2010-02-16 01:46:59 +00003696
John McCall00fe7612011-07-14 22:39:48 +00003697 // The width of a division result is mostly determined by the size
3698 // of the LHS.
3699 case BO_Div: {
3700 // Don't 'pre-truncate' the operands.
3701 unsigned opWidth = C.getIntWidth(E->getType());
3702 IntRange L = GetExprRange(C, BO->getLHS(), opWidth);
3703
3704 // If the divisor is constant, use that.
3705 llvm::APSInt divisor;
3706 if (BO->getRHS()->isIntegerConstantExpr(divisor, C)) {
3707 unsigned log2 = divisor.logBase2(); // floor(log_2(divisor))
3708 if (log2 >= L.Width)
3709 L.Width = (L.NonNegative ? 0 : 1);
3710 else
3711 L.Width = std::min(L.Width - log2, MaxWidth);
3712 return L;
3713 }
3714
3715 // Otherwise, just use the LHS's width.
3716 IntRange R = GetExprRange(C, BO->getRHS(), opWidth);
3717 return IntRange(L.Width, L.NonNegative && R.NonNegative);
3718 }
3719
3720 // The result of a remainder can't be larger than the result of
3721 // either side.
3722 case BO_Rem: {
3723 // Don't 'pre-truncate' the operands.
3724 unsigned opWidth = C.getIntWidth(E->getType());
3725 IntRange L = GetExprRange(C, BO->getLHS(), opWidth);
3726 IntRange R = GetExprRange(C, BO->getRHS(), opWidth);
3727
3728 IntRange meet = IntRange::meet(L, R);
3729 meet.Width = std::min(meet.Width, MaxWidth);
3730 return meet;
3731 }
3732
3733 // The default behavior is okay for these.
3734 case BO_Mul:
3735 case BO_Add:
3736 case BO_Xor:
3737 case BO_Or:
John McCallf2370c92010-01-06 05:24:50 +00003738 break;
3739 }
3740
John McCall00fe7612011-07-14 22:39:48 +00003741 // The default case is to treat the operation as if it were closed
3742 // on the narrowest type that encompasses both operands.
John McCallf2370c92010-01-06 05:24:50 +00003743 IntRange L = GetExprRange(C, BO->getLHS(), MaxWidth);
3744 IntRange R = GetExprRange(C, BO->getRHS(), MaxWidth);
3745 return IntRange::join(L, R);
3746 }
3747
3748 if (UnaryOperator *UO = dyn_cast<UnaryOperator>(E)) {
3749 switch (UO->getOpcode()) {
3750 // Boolean-valued operations are white-listed.
John McCall2de56d12010-08-25 11:45:40 +00003751 case UO_LNot:
John McCallf2370c92010-01-06 05:24:50 +00003752 return IntRange::forBoolType();
3753
3754 // Operations with opaque sources are black-listed.
John McCall2de56d12010-08-25 11:45:40 +00003755 case UO_Deref:
3756 case UO_AddrOf: // should be impossible
John McCall1844a6e2010-11-10 23:38:19 +00003757 return IntRange::forValueOfType(C, E->getType());
John McCallf2370c92010-01-06 05:24:50 +00003758
3759 default:
3760 return GetExprRange(C, UO->getSubExpr(), MaxWidth);
3761 }
3762 }
Douglas Gregor8ecdb652010-04-28 22:16:22 +00003763
3764 if (dyn_cast<OffsetOfExpr>(E)) {
John McCall1844a6e2010-11-10 23:38:19 +00003765 IntRange::forValueOfType(C, E->getType());
Douglas Gregor8ecdb652010-04-28 22:16:22 +00003766 }
John McCallf2370c92010-01-06 05:24:50 +00003767
Richard Smitha6b8b2c2011-10-10 18:28:20 +00003768 if (FieldDecl *BitField = E->getBitField())
3769 return IntRange(BitField->getBitWidthValue(C),
Douglas Gregor5e9ebb32011-05-21 16:28:01 +00003770 BitField->getType()->isUnsignedIntegerOrEnumerationType());
John McCallf2370c92010-01-06 05:24:50 +00003771
John McCall1844a6e2010-11-10 23:38:19 +00003772 return IntRange::forValueOfType(C, E->getType());
John McCallf2370c92010-01-06 05:24:50 +00003773}
John McCall51313c32010-01-04 23:31:57 +00003774
Ted Kremenek0692a192012-01-31 05:37:37 +00003775static IntRange GetExprRange(ASTContext &C, Expr *E) {
John McCall323ed742010-05-06 08:58:33 +00003776 return GetExprRange(C, E, C.getIntWidth(E->getType()));
3777}
3778
John McCall51313c32010-01-04 23:31:57 +00003779/// Checks whether the given value, which currently has the given
3780/// source semantics, has the same value when coerced through the
3781/// target semantics.
Ted Kremenek0692a192012-01-31 05:37:37 +00003782static bool IsSameFloatAfterCast(const llvm::APFloat &value,
3783 const llvm::fltSemantics &Src,
3784 const llvm::fltSemantics &Tgt) {
John McCall51313c32010-01-04 23:31:57 +00003785 llvm::APFloat truncated = value;
3786
3787 bool ignored;
3788 truncated.convert(Src, llvm::APFloat::rmNearestTiesToEven, &ignored);
3789 truncated.convert(Tgt, llvm::APFloat::rmNearestTiesToEven, &ignored);
3790
3791 return truncated.bitwiseIsEqual(value);
3792}
3793
3794/// Checks whether the given value, which currently has the given
3795/// source semantics, has the same value when coerced through the
3796/// target semantics.
3797///
3798/// The value might be a vector of floats (or a complex number).
Ted Kremenek0692a192012-01-31 05:37:37 +00003799static bool IsSameFloatAfterCast(const APValue &value,
3800 const llvm::fltSemantics &Src,
3801 const llvm::fltSemantics &Tgt) {
John McCall51313c32010-01-04 23:31:57 +00003802 if (value.isFloat())
3803 return IsSameFloatAfterCast(value.getFloat(), Src, Tgt);
3804
3805 if (value.isVector()) {
3806 for (unsigned i = 0, e = value.getVectorLength(); i != e; ++i)
3807 if (!IsSameFloatAfterCast(value.getVectorElt(i), Src, Tgt))
3808 return false;
3809 return true;
3810 }
3811
3812 assert(value.isComplexFloat());
3813 return (IsSameFloatAfterCast(value.getComplexFloatReal(), Src, Tgt) &&
3814 IsSameFloatAfterCast(value.getComplexFloatImag(), Src, Tgt));
3815}
3816
Ted Kremenek0692a192012-01-31 05:37:37 +00003817static void AnalyzeImplicitConversions(Sema &S, Expr *E, SourceLocation CC);
John McCall323ed742010-05-06 08:58:33 +00003818
Ted Kremeneke3b159c2010-09-23 21:43:44 +00003819static bool IsZero(Sema &S, Expr *E) {
3820 // Suppress cases where we are comparing against an enum constant.
3821 if (const DeclRefExpr *DR =
3822 dyn_cast<DeclRefExpr>(E->IgnoreParenImpCasts()))
3823 if (isa<EnumConstantDecl>(DR->getDecl()))
3824 return false;
3825
3826 // Suppress cases where the '0' value is expanded from a macro.
3827 if (E->getLocStart().isMacroID())
3828 return false;
3829
John McCall323ed742010-05-06 08:58:33 +00003830 llvm::APSInt Value;
3831 return E->isIntegerConstantExpr(Value, S.Context) && Value == 0;
3832}
3833
John McCall372e1032010-10-06 00:25:24 +00003834static bool HasEnumType(Expr *E) {
3835 // Strip off implicit integral promotions.
3836 while (ImplicitCastExpr *ICE = dyn_cast<ImplicitCastExpr>(E)) {
Argyrios Kyrtzidis63b57ae2010-10-07 21:52:18 +00003837 if (ICE->getCastKind() != CK_IntegralCast &&
3838 ICE->getCastKind() != CK_NoOp)
John McCall372e1032010-10-06 00:25:24 +00003839 break;
Argyrios Kyrtzidis63b57ae2010-10-07 21:52:18 +00003840 E = ICE->getSubExpr();
John McCall372e1032010-10-06 00:25:24 +00003841 }
3842
3843 return E->getType()->isEnumeralType();
3844}
3845
Ted Kremenek0692a192012-01-31 05:37:37 +00003846static void CheckTrivialUnsignedComparison(Sema &S, BinaryOperator *E) {
John McCall2de56d12010-08-25 11:45:40 +00003847 BinaryOperatorKind op = E->getOpcode();
Douglas Gregor14af91a2010-12-21 07:22:56 +00003848 if (E->isValueDependent())
3849 return;
3850
John McCall2de56d12010-08-25 11:45:40 +00003851 if (op == BO_LT && IsZero(S, E->getRHS())) {
John McCall323ed742010-05-06 08:58:33 +00003852 S.Diag(E->getOperatorLoc(), diag::warn_lunsigned_always_true_comparison)
John McCall372e1032010-10-06 00:25:24 +00003853 << "< 0" << "false" << HasEnumType(E->getLHS())
John McCall323ed742010-05-06 08:58:33 +00003854 << E->getLHS()->getSourceRange() << E->getRHS()->getSourceRange();
John McCall2de56d12010-08-25 11:45:40 +00003855 } else if (op == BO_GE && IsZero(S, E->getRHS())) {
John McCall323ed742010-05-06 08:58:33 +00003856 S.Diag(E->getOperatorLoc(), diag::warn_lunsigned_always_true_comparison)
John McCall372e1032010-10-06 00:25:24 +00003857 << ">= 0" << "true" << HasEnumType(E->getLHS())
John McCall323ed742010-05-06 08:58:33 +00003858 << E->getLHS()->getSourceRange() << E->getRHS()->getSourceRange();
John McCall2de56d12010-08-25 11:45:40 +00003859 } else if (op == BO_GT && IsZero(S, E->getLHS())) {
John McCall323ed742010-05-06 08:58:33 +00003860 S.Diag(E->getOperatorLoc(), diag::warn_runsigned_always_true_comparison)
John McCall372e1032010-10-06 00:25:24 +00003861 << "0 >" << "false" << HasEnumType(E->getRHS())
John McCall323ed742010-05-06 08:58:33 +00003862 << E->getLHS()->getSourceRange() << E->getRHS()->getSourceRange();
John McCall2de56d12010-08-25 11:45:40 +00003863 } else if (op == BO_LE && IsZero(S, E->getLHS())) {
John McCall323ed742010-05-06 08:58:33 +00003864 S.Diag(E->getOperatorLoc(), diag::warn_runsigned_always_true_comparison)
John McCall372e1032010-10-06 00:25:24 +00003865 << "0 <=" << "true" << HasEnumType(E->getRHS())
John McCall323ed742010-05-06 08:58:33 +00003866 << E->getLHS()->getSourceRange() << E->getRHS()->getSourceRange();
3867 }
3868}
3869
3870/// Analyze the operands of the given comparison. Implements the
3871/// fallback case from AnalyzeComparison.
Ted Kremenek0692a192012-01-31 05:37:37 +00003872static void AnalyzeImpConvsInComparison(Sema &S, BinaryOperator *E) {
John McCallb4eb64d2010-10-08 02:01:28 +00003873 AnalyzeImplicitConversions(S, E->getLHS(), E->getOperatorLoc());
3874 AnalyzeImplicitConversions(S, E->getRHS(), E->getOperatorLoc());
John McCall323ed742010-05-06 08:58:33 +00003875}
John McCall51313c32010-01-04 23:31:57 +00003876
John McCallba26e582010-01-04 23:21:16 +00003877/// \brief Implements -Wsign-compare.
3878///
Richard Trieudd225092011-09-15 21:56:47 +00003879/// \param E the binary operator to check for warnings
Ted Kremenek0692a192012-01-31 05:37:37 +00003880static void AnalyzeComparison(Sema &S, BinaryOperator *E) {
John McCall323ed742010-05-06 08:58:33 +00003881 // The type the comparison is being performed in.
3882 QualType T = E->getLHS()->getType();
3883 assert(S.Context.hasSameUnqualifiedType(T, E->getRHS()->getType())
3884 && "comparison with mismatched types");
John McCallba26e582010-01-04 23:21:16 +00003885
John McCall323ed742010-05-06 08:58:33 +00003886 // We don't do anything special if this isn't an unsigned integral
3887 // comparison: we're only interested in integral comparisons, and
3888 // signed comparisons only happen in cases we don't care to warn about.
Douglas Gregor3e026e32011-02-19 22:34:59 +00003889 //
3890 // We also don't care about value-dependent expressions or expressions
3891 // whose result is a constant.
3892 if (!T->hasUnsignedIntegerRepresentation()
3893 || E->isValueDependent() || E->isIntegerConstantExpr(S.Context))
John McCall323ed742010-05-06 08:58:33 +00003894 return AnalyzeImpConvsInComparison(S, E);
John McCallf2370c92010-01-06 05:24:50 +00003895
Richard Trieudd225092011-09-15 21:56:47 +00003896 Expr *LHS = E->getLHS()->IgnoreParenImpCasts();
3897 Expr *RHS = E->getRHS()->IgnoreParenImpCasts();
John McCallba26e582010-01-04 23:21:16 +00003898
John McCall323ed742010-05-06 08:58:33 +00003899 // Check to see if one of the (unmodified) operands is of different
3900 // signedness.
3901 Expr *signedOperand, *unsignedOperand;
Richard Trieudd225092011-09-15 21:56:47 +00003902 if (LHS->getType()->hasSignedIntegerRepresentation()) {
3903 assert(!RHS->getType()->hasSignedIntegerRepresentation() &&
John McCall323ed742010-05-06 08:58:33 +00003904 "unsigned comparison between two signed integer expressions?");
Richard Trieudd225092011-09-15 21:56:47 +00003905 signedOperand = LHS;
3906 unsignedOperand = RHS;
3907 } else if (RHS->getType()->hasSignedIntegerRepresentation()) {
3908 signedOperand = RHS;
3909 unsignedOperand = LHS;
John McCallba26e582010-01-04 23:21:16 +00003910 } else {
John McCall323ed742010-05-06 08:58:33 +00003911 CheckTrivialUnsignedComparison(S, E);
3912 return AnalyzeImpConvsInComparison(S, E);
John McCallba26e582010-01-04 23:21:16 +00003913 }
3914
John McCall323ed742010-05-06 08:58:33 +00003915 // Otherwise, calculate the effective range of the signed operand.
3916 IntRange signedRange = GetExprRange(S.Context, signedOperand);
John McCallf2370c92010-01-06 05:24:50 +00003917
John McCall323ed742010-05-06 08:58:33 +00003918 // Go ahead and analyze implicit conversions in the operands. Note
3919 // that we skip the implicit conversions on both sides.
Richard Trieudd225092011-09-15 21:56:47 +00003920 AnalyzeImplicitConversions(S, LHS, E->getOperatorLoc());
3921 AnalyzeImplicitConversions(S, RHS, E->getOperatorLoc());
John McCallba26e582010-01-04 23:21:16 +00003922
John McCall323ed742010-05-06 08:58:33 +00003923 // If the signed range is non-negative, -Wsign-compare won't fire,
3924 // but we should still check for comparisons which are always true
3925 // or false.
3926 if (signedRange.NonNegative)
3927 return CheckTrivialUnsignedComparison(S, E);
John McCallba26e582010-01-04 23:21:16 +00003928
3929 // For (in)equality comparisons, if the unsigned operand is a
3930 // constant which cannot collide with a overflowed signed operand,
3931 // then reinterpreting the signed operand as unsigned will not
3932 // change the result of the comparison.
John McCall323ed742010-05-06 08:58:33 +00003933 if (E->isEqualityOp()) {
3934 unsigned comparisonWidth = S.Context.getIntWidth(T);
3935 IntRange unsignedRange = GetExprRange(S.Context, unsignedOperand);
John McCallba26e582010-01-04 23:21:16 +00003936
John McCall323ed742010-05-06 08:58:33 +00003937 // We should never be unable to prove that the unsigned operand is
3938 // non-negative.
3939 assert(unsignedRange.NonNegative && "unsigned range includes negative?");
3940
3941 if (unsignedRange.Width < comparisonWidth)
3942 return;
3943 }
3944
3945 S.Diag(E->getOperatorLoc(), diag::warn_mixed_sign_comparison)
Richard Trieudd225092011-09-15 21:56:47 +00003946 << LHS->getType() << RHS->getType()
3947 << LHS->getSourceRange() << RHS->getSourceRange();
John McCallba26e582010-01-04 23:21:16 +00003948}
3949
John McCall15d7d122010-11-11 03:21:53 +00003950/// Analyzes an attempt to assign the given value to a bitfield.
3951///
3952/// Returns true if there was something fishy about the attempt.
Ted Kremenek0692a192012-01-31 05:37:37 +00003953static bool AnalyzeBitFieldAssignment(Sema &S, FieldDecl *Bitfield, Expr *Init,
3954 SourceLocation InitLoc) {
John McCall15d7d122010-11-11 03:21:53 +00003955 assert(Bitfield->isBitField());
3956 if (Bitfield->isInvalidDecl())
3957 return false;
3958
John McCall91b60142010-11-11 05:33:51 +00003959 // White-list bool bitfields.
3960 if (Bitfield->getType()->isBooleanType())
3961 return false;
3962
Douglas Gregor46ff3032011-02-04 13:09:01 +00003963 // Ignore value- or type-dependent expressions.
3964 if (Bitfield->getBitWidth()->isValueDependent() ||
3965 Bitfield->getBitWidth()->isTypeDependent() ||
3966 Init->isValueDependent() ||
3967 Init->isTypeDependent())
3968 return false;
3969
John McCall15d7d122010-11-11 03:21:53 +00003970 Expr *OriginalInit = Init->IgnoreParenImpCasts();
3971
Richard Smith80d4b552011-12-28 19:48:30 +00003972 llvm::APSInt Value;
3973 if (!OriginalInit->EvaluateAsInt(Value, S.Context, Expr::SE_AllowSideEffects))
John McCall15d7d122010-11-11 03:21:53 +00003974 return false;
3975
John McCall15d7d122010-11-11 03:21:53 +00003976 unsigned OriginalWidth = Value.getBitWidth();
Richard Smitha6b8b2c2011-10-10 18:28:20 +00003977 unsigned FieldWidth = Bitfield->getBitWidthValue(S.Context);
John McCall15d7d122010-11-11 03:21:53 +00003978
3979 if (OriginalWidth <= FieldWidth)
3980 return false;
3981
Eli Friedman3a643af2012-01-26 23:11:39 +00003982 // Compute the value which the bitfield will contain.
Jay Foad9f71a8f2010-12-07 08:25:34 +00003983 llvm::APSInt TruncatedValue = Value.trunc(FieldWidth);
Eli Friedman3a643af2012-01-26 23:11:39 +00003984 TruncatedValue.setIsSigned(Bitfield->getType()->isSignedIntegerType());
John McCall15d7d122010-11-11 03:21:53 +00003985
Eli Friedman3a643af2012-01-26 23:11:39 +00003986 // Check whether the stored value is equal to the original value.
3987 TruncatedValue = TruncatedValue.extend(OriginalWidth);
John McCall15d7d122010-11-11 03:21:53 +00003988 if (Value == TruncatedValue)
3989 return false;
3990
Eli Friedman3a643af2012-01-26 23:11:39 +00003991 // Special-case bitfields of width 1: booleans are naturally 0/1, and
Eli Friedman34ff0622012-02-02 00:40:20 +00003992 // therefore don't strictly fit into a signed bitfield of width 1.
3993 if (FieldWidth == 1 && Value == 1)
Eli Friedman3a643af2012-01-26 23:11:39 +00003994 return false;
3995
John McCall15d7d122010-11-11 03:21:53 +00003996 std::string PrettyValue = Value.toString(10);
3997 std::string PrettyTrunc = TruncatedValue.toString(10);
3998
3999 S.Diag(InitLoc, diag::warn_impcast_bitfield_precision_constant)
4000 << PrettyValue << PrettyTrunc << OriginalInit->getType()
4001 << Init->getSourceRange();
4002
4003 return true;
4004}
4005
John McCallbeb22aa2010-11-09 23:24:47 +00004006/// Analyze the given simple or compound assignment for warning-worthy
4007/// operations.
Ted Kremenek0692a192012-01-31 05:37:37 +00004008static void AnalyzeAssignment(Sema &S, BinaryOperator *E) {
John McCallbeb22aa2010-11-09 23:24:47 +00004009 // Just recurse on the LHS.
4010 AnalyzeImplicitConversions(S, E->getLHS(), E->getOperatorLoc());
4011
4012 // We want to recurse on the RHS as normal unless we're assigning to
4013 // a bitfield.
4014 if (FieldDecl *Bitfield = E->getLHS()->getBitField()) {
John McCall15d7d122010-11-11 03:21:53 +00004015 if (AnalyzeBitFieldAssignment(S, Bitfield, E->getRHS(),
4016 E->getOperatorLoc())) {
4017 // Recurse, ignoring any implicit conversions on the RHS.
4018 return AnalyzeImplicitConversions(S, E->getRHS()->IgnoreParenImpCasts(),
4019 E->getOperatorLoc());
John McCallbeb22aa2010-11-09 23:24:47 +00004020 }
4021 }
4022
4023 AnalyzeImplicitConversions(S, E->getRHS(), E->getOperatorLoc());
4024}
4025
John McCall51313c32010-01-04 23:31:57 +00004026/// Diagnose an implicit cast; purely a helper for CheckImplicitConversion.
Ted Kremenek0692a192012-01-31 05:37:37 +00004027static void DiagnoseImpCast(Sema &S, Expr *E, QualType SourceType, QualType T,
Anna Zaksc36bedc2012-02-01 19:08:57 +00004028 SourceLocation CContext, unsigned diag,
4029 bool pruneControlFlow = false) {
4030 if (pruneControlFlow) {
4031 S.DiagRuntimeBehavior(E->getExprLoc(), E,
4032 S.PDiag(diag)
4033 << SourceType << T << E->getSourceRange()
4034 << SourceRange(CContext));
4035 return;
4036 }
Douglas Gregor5a5b38f2011-03-12 00:14:31 +00004037 S.Diag(E->getExprLoc(), diag)
4038 << SourceType << T << E->getSourceRange() << SourceRange(CContext);
4039}
4040
Chandler Carruthe1b02e02011-04-05 06:47:57 +00004041/// Diagnose an implicit cast; purely a helper for CheckImplicitConversion.
Ted Kremenek0692a192012-01-31 05:37:37 +00004042static void DiagnoseImpCast(Sema &S, Expr *E, QualType T,
Anna Zaksc36bedc2012-02-01 19:08:57 +00004043 SourceLocation CContext, unsigned diag,
4044 bool pruneControlFlow = false) {
4045 DiagnoseImpCast(S, E, E->getType(), T, CContext, diag, pruneControlFlow);
Chandler Carruthe1b02e02011-04-05 06:47:57 +00004046}
4047
Matt Beaumont-Gay9ce63772011-10-14 15:36:25 +00004048/// Diagnose an implicit cast from a literal expression. Does not warn when the
4049/// cast wouldn't lose information.
Chandler Carruthf65076e2011-04-10 08:36:24 +00004050void DiagnoseFloatingLiteralImpCast(Sema &S, FloatingLiteral *FL, QualType T,
4051 SourceLocation CContext) {
Matt Beaumont-Gay9ce63772011-10-14 15:36:25 +00004052 // Try to convert the literal exactly to an integer. If we can, don't warn.
Chandler Carruthf65076e2011-04-10 08:36:24 +00004053 bool isExact = false;
Matt Beaumont-Gay9ce63772011-10-14 15:36:25 +00004054 const llvm::APFloat &Value = FL->getValue();
Jeffrey Yasskin3e1ef782011-07-15 17:03:07 +00004055 llvm::APSInt IntegerValue(S.Context.getIntWidth(T),
4056 T->hasUnsignedIntegerRepresentation());
4057 if (Value.convertToInteger(IntegerValue,
Chandler Carruthf65076e2011-04-10 08:36:24 +00004058 llvm::APFloat::rmTowardZero, &isExact)
Matt Beaumont-Gay9ce63772011-10-14 15:36:25 +00004059 == llvm::APFloat::opOK && isExact)
Chandler Carruthf65076e2011-04-10 08:36:24 +00004060 return;
4061
Matt Beaumont-Gay9ce63772011-10-14 15:36:25 +00004062 S.Diag(FL->getExprLoc(), diag::warn_impcast_literal_float_to_integer)
4063 << FL->getType() << T << FL->getSourceRange() << SourceRange(CContext);
Chandler Carruthf65076e2011-04-10 08:36:24 +00004064}
4065
John McCall091f23f2010-11-09 22:22:12 +00004066std::string PrettyPrintInRange(const llvm::APSInt &Value, IntRange Range) {
4067 if (!Range.Width) return "0";
4068
4069 llvm::APSInt ValueInRange = Value;
4070 ValueInRange.setIsSigned(!Range.NonNegative);
Jay Foad9f71a8f2010-12-07 08:25:34 +00004071 ValueInRange = ValueInRange.trunc(Range.Width);
John McCall091f23f2010-11-09 22:22:12 +00004072 return ValueInRange.toString(10);
4073}
4074
John McCall323ed742010-05-06 08:58:33 +00004075void CheckImplicitConversion(Sema &S, Expr *E, QualType T,
John McCallb4eb64d2010-10-08 02:01:28 +00004076 SourceLocation CC, bool *ICContext = 0) {
John McCall323ed742010-05-06 08:58:33 +00004077 if (E->isTypeDependent() || E->isValueDependent()) return;
John McCall51313c32010-01-04 23:31:57 +00004078
John McCall323ed742010-05-06 08:58:33 +00004079 const Type *Source = S.Context.getCanonicalType(E->getType()).getTypePtr();
4080 const Type *Target = S.Context.getCanonicalType(T).getTypePtr();
4081 if (Source == Target) return;
4082 if (Target->isDependentType()) return;
John McCall51313c32010-01-04 23:31:57 +00004083
Chandler Carruth108f7562011-07-26 05:40:03 +00004084 // If the conversion context location is invalid don't complain. We also
4085 // don't want to emit a warning if the issue occurs from the expansion of
4086 // a system macro. The problem is that 'getSpellingLoc()' is slow, so we
4087 // delay this check as long as possible. Once we detect we are in that
4088 // scenario, we just return.
Ted Kremenekef9ff882011-03-10 20:03:42 +00004089 if (CC.isInvalid())
John McCallb4eb64d2010-10-08 02:01:28 +00004090 return;
4091
Richard Trieuf1f8b1a2011-09-23 20:10:00 +00004092 // Diagnose implicit casts to bool.
4093 if (Target->isSpecificBuiltinType(BuiltinType::Bool)) {
4094 if (isa<StringLiteral>(E))
4095 // Warn on string literal to bool. Checks for string literals in logical
4096 // expressions, for instances, assert(0 && "error here"), is prevented
4097 // by a check in AnalyzeImplicitConversions().
4098 return DiagnoseImpCast(S, E, T, CC,
4099 diag::warn_impcast_string_literal_to_bool);
Lang Hamese14ca9f2011-12-05 20:49:50 +00004100 if (Source->isFunctionType()) {
4101 // Warn on function to bool. Checks free functions and static member
4102 // functions. Weakly imported functions are excluded from the check,
4103 // since it's common to test their value to check whether the linker
4104 // found a definition for them.
4105 ValueDecl *D = 0;
4106 if (DeclRefExpr* R = dyn_cast<DeclRefExpr>(E)) {
4107 D = R->getDecl();
4108 } else if (MemberExpr *M = dyn_cast<MemberExpr>(E)) {
4109 D = M->getMemberDecl();
4110 }
4111
4112 if (D && !D->isWeak()) {
Richard Trieu26b45d82011-12-06 04:48:01 +00004113 if (FunctionDecl* F = dyn_cast<FunctionDecl>(D)) {
4114 S.Diag(E->getExprLoc(), diag::warn_impcast_function_to_bool)
4115 << F << E->getSourceRange() << SourceRange(CC);
David Blaikie2def7732011-12-09 21:42:37 +00004116 S.Diag(E->getExprLoc(), diag::note_function_to_bool_silence)
4117 << FixItHint::CreateInsertion(E->getExprLoc(), "&");
4118 QualType ReturnType;
4119 UnresolvedSet<4> NonTemplateOverloads;
4120 S.isExprCallable(*E, ReturnType, NonTemplateOverloads);
4121 if (!ReturnType.isNull()
4122 && ReturnType->isSpecificBuiltinType(BuiltinType::Bool))
4123 S.Diag(E->getExprLoc(), diag::note_function_to_bool_call)
4124 << FixItHint::CreateInsertion(
4125 S.getPreprocessor().getLocForEndOfToken(E->getLocEnd()), "()");
Richard Trieu26b45d82011-12-06 04:48:01 +00004126 return;
4127 }
Lang Hamese14ca9f2011-12-05 20:49:50 +00004128 }
4129 }
David Blaikiee37cdc42011-09-29 04:06:47 +00004130 return; // Other casts to bool are not checked.
Richard Trieuf1f8b1a2011-09-23 20:10:00 +00004131 }
John McCall51313c32010-01-04 23:31:57 +00004132
4133 // Strip vector types.
4134 if (isa<VectorType>(Source)) {
Ted Kremenekef9ff882011-03-10 20:03:42 +00004135 if (!isa<VectorType>(Target)) {
Matt Beaumont-Gayd87a0cd2012-01-06 22:43:58 +00004136 if (S.SourceMgr.isInSystemMacro(CC))
Ted Kremenekef9ff882011-03-10 20:03:42 +00004137 return;
John McCallb4eb64d2010-10-08 02:01:28 +00004138 return DiagnoseImpCast(S, E, T, CC, diag::warn_impcast_vector_scalar);
Ted Kremenekef9ff882011-03-10 20:03:42 +00004139 }
Chris Lattnerb792b302011-06-14 04:51:15 +00004140
4141 // If the vector cast is cast between two vectors of the same size, it is
4142 // a bitcast, not a conversion.
4143 if (S.Context.getTypeSize(Source) == S.Context.getTypeSize(Target))
4144 return;
John McCall51313c32010-01-04 23:31:57 +00004145
4146 Source = cast<VectorType>(Source)->getElementType().getTypePtr();
4147 Target = cast<VectorType>(Target)->getElementType().getTypePtr();
4148 }
4149
4150 // Strip complex types.
4151 if (isa<ComplexType>(Source)) {
Ted Kremenekef9ff882011-03-10 20:03:42 +00004152 if (!isa<ComplexType>(Target)) {
Matt Beaumont-Gayd87a0cd2012-01-06 22:43:58 +00004153 if (S.SourceMgr.isInSystemMacro(CC))
Ted Kremenekef9ff882011-03-10 20:03:42 +00004154 return;
4155
John McCallb4eb64d2010-10-08 02:01:28 +00004156 return DiagnoseImpCast(S, E, T, CC, diag::warn_impcast_complex_scalar);
Ted Kremenekef9ff882011-03-10 20:03:42 +00004157 }
John McCall51313c32010-01-04 23:31:57 +00004158
4159 Source = cast<ComplexType>(Source)->getElementType().getTypePtr();
4160 Target = cast<ComplexType>(Target)->getElementType().getTypePtr();
4161 }
4162
4163 const BuiltinType *SourceBT = dyn_cast<BuiltinType>(Source);
4164 const BuiltinType *TargetBT = dyn_cast<BuiltinType>(Target);
4165
4166 // If the source is floating point...
4167 if (SourceBT && SourceBT->isFloatingPoint()) {
4168 // ...and the target is floating point...
4169 if (TargetBT && TargetBT->isFloatingPoint()) {
4170 // ...then warn if we're dropping FP rank.
4171
4172 // Builtin FP kinds are ordered by increasing FP rank.
4173 if (SourceBT->getKind() > TargetBT->getKind()) {
4174 // Don't warn about float constants that are precisely
4175 // representable in the target type.
4176 Expr::EvalResult result;
Richard Smith51f47082011-10-29 00:50:52 +00004177 if (E->EvaluateAsRValue(result, S.Context)) {
John McCall51313c32010-01-04 23:31:57 +00004178 // Value might be a float, a float vector, or a float complex.
4179 if (IsSameFloatAfterCast(result.Val,
John McCall323ed742010-05-06 08:58:33 +00004180 S.Context.getFloatTypeSemantics(QualType(TargetBT, 0)),
4181 S.Context.getFloatTypeSemantics(QualType(SourceBT, 0))))
John McCall51313c32010-01-04 23:31:57 +00004182 return;
4183 }
4184
Matt Beaumont-Gayd87a0cd2012-01-06 22:43:58 +00004185 if (S.SourceMgr.isInSystemMacro(CC))
Ted Kremenekef9ff882011-03-10 20:03:42 +00004186 return;
4187
John McCallb4eb64d2010-10-08 02:01:28 +00004188 DiagnoseImpCast(S, E, T, CC, diag::warn_impcast_float_precision);
John McCall51313c32010-01-04 23:31:57 +00004189 }
4190 return;
4191 }
4192
Ted Kremenekef9ff882011-03-10 20:03:42 +00004193 // If the target is integral, always warn.
Chandler Carrutha5b93322011-02-17 11:05:49 +00004194 if ((TargetBT && TargetBT->isInteger())) {
Matt Beaumont-Gayd87a0cd2012-01-06 22:43:58 +00004195 if (S.SourceMgr.isInSystemMacro(CC))
Ted Kremenekef9ff882011-03-10 20:03:42 +00004196 return;
4197
Chandler Carrutha5b93322011-02-17 11:05:49 +00004198 Expr *InnerE = E->IgnoreParenImpCasts();
Matt Beaumont-Gay634c8af2011-09-08 22:30:47 +00004199 // We also want to warn on, e.g., "int i = -1.234"
4200 if (UnaryOperator *UOp = dyn_cast<UnaryOperator>(InnerE))
4201 if (UOp->getOpcode() == UO_Minus || UOp->getOpcode() == UO_Plus)
4202 InnerE = UOp->getSubExpr()->IgnoreParenImpCasts();
4203
Chandler Carruthf65076e2011-04-10 08:36:24 +00004204 if (FloatingLiteral *FL = dyn_cast<FloatingLiteral>(InnerE)) {
4205 DiagnoseFloatingLiteralImpCast(S, FL, T, CC);
Chandler Carrutha5b93322011-02-17 11:05:49 +00004206 } else {
4207 DiagnoseImpCast(S, E, T, CC, diag::warn_impcast_float_integer);
4208 }
4209 }
John McCall51313c32010-01-04 23:31:57 +00004210
4211 return;
4212 }
4213
John McCallf2370c92010-01-06 05:24:50 +00004214 if (!Source->isIntegerType() || !Target->isIntegerType())
John McCall51313c32010-01-04 23:31:57 +00004215 return;
4216
Richard Trieu1838ca52011-05-29 19:59:02 +00004217 if ((E->isNullPointerConstant(S.Context, Expr::NPC_ValueDependentIsNotNull)
4218 == Expr::NPCK_GNUNull) && Target->isIntegerType()) {
David Blaikieb1360492012-03-16 20:30:12 +00004219 SourceLocation Loc = E->getSourceRange().getBegin();
4220 if (Loc.isMacroID())
4221 Loc = S.SourceMgr.getImmediateExpansionRange(Loc).first;
4222 S.Diag(Loc, diag::warn_impcast_null_pointer_to_integer)
4223 << T << Loc << clang::SourceRange(CC);
Richard Trieu1838ca52011-05-29 19:59:02 +00004224 return;
4225 }
4226
John McCall323ed742010-05-06 08:58:33 +00004227 IntRange SourceRange = GetExprRange(S.Context, E);
John McCall1844a6e2010-11-10 23:38:19 +00004228 IntRange TargetRange = IntRange::forTargetOfCanonicalType(S.Context, Target);
John McCallf2370c92010-01-06 05:24:50 +00004229
4230 if (SourceRange.Width > TargetRange.Width) {
John McCall091f23f2010-11-09 22:22:12 +00004231 // If the source is a constant, use a default-on diagnostic.
4232 // TODO: this should happen for bitfield stores, too.
4233 llvm::APSInt Value(32);
4234 if (E->isIntegerConstantExpr(Value, S.Context)) {
Matt Beaumont-Gayd87a0cd2012-01-06 22:43:58 +00004235 if (S.SourceMgr.isInSystemMacro(CC))
Ted Kremenekef9ff882011-03-10 20:03:42 +00004236 return;
4237
John McCall091f23f2010-11-09 22:22:12 +00004238 std::string PrettySourceValue = Value.toString(10);
4239 std::string PrettyTargetValue = PrettyPrintInRange(Value, TargetRange);
4240
Ted Kremenek5e745da2011-10-22 02:37:33 +00004241 S.DiagRuntimeBehavior(E->getExprLoc(), E,
4242 S.PDiag(diag::warn_impcast_integer_precision_constant)
4243 << PrettySourceValue << PrettyTargetValue
4244 << E->getType() << T << E->getSourceRange()
4245 << clang::SourceRange(CC));
John McCall091f23f2010-11-09 22:22:12 +00004246 return;
4247 }
4248
Chris Lattnerb792b302011-06-14 04:51:15 +00004249 // People want to build with -Wshorten-64-to-32 and not -Wconversion.
Matt Beaumont-Gayd87a0cd2012-01-06 22:43:58 +00004250 if (S.SourceMgr.isInSystemMacro(CC))
Ted Kremenekef9ff882011-03-10 20:03:42 +00004251 return;
4252
David Blaikie37050842012-04-12 22:40:54 +00004253 if (TargetRange.Width == 32 && S.Context.getIntWidth(E->getType()) == 64)
Anna Zaksc36bedc2012-02-01 19:08:57 +00004254 return DiagnoseImpCast(S, E, T, CC, diag::warn_impcast_integer_64_32,
4255 /* pruneControlFlow */ true);
John McCallb4eb64d2010-10-08 02:01:28 +00004256 return DiagnoseImpCast(S, E, T, CC, diag::warn_impcast_integer_precision);
John McCall323ed742010-05-06 08:58:33 +00004257 }
4258
4259 if ((TargetRange.NonNegative && !SourceRange.NonNegative) ||
4260 (!TargetRange.NonNegative && SourceRange.NonNegative &&
4261 SourceRange.Width == TargetRange.Width)) {
Ted Kremenekef9ff882011-03-10 20:03:42 +00004262
Matt Beaumont-Gayd87a0cd2012-01-06 22:43:58 +00004263 if (S.SourceMgr.isInSystemMacro(CC))
Ted Kremenekef9ff882011-03-10 20:03:42 +00004264 return;
4265
John McCall323ed742010-05-06 08:58:33 +00004266 unsigned DiagID = diag::warn_impcast_integer_sign;
4267
4268 // Traditionally, gcc has warned about this under -Wsign-compare.
4269 // We also want to warn about it in -Wconversion.
4270 // So if -Wconversion is off, use a completely identical diagnostic
4271 // in the sign-compare group.
4272 // The conditional-checking code will
4273 if (ICContext) {
4274 DiagID = diag::warn_impcast_integer_sign_conditional;
4275 *ICContext = true;
4276 }
4277
John McCallb4eb64d2010-10-08 02:01:28 +00004278 return DiagnoseImpCast(S, E, T, CC, DiagID);
John McCall51313c32010-01-04 23:31:57 +00004279 }
4280
Douglas Gregor284cc8d2011-02-22 02:45:07 +00004281 // Diagnose conversions between different enumeration types.
Douglas Gregor5a5b38f2011-03-12 00:14:31 +00004282 // In C, we pretend that the type of an EnumConstantDecl is its enumeration
4283 // type, to give us better diagnostics.
4284 QualType SourceType = E->getType();
David Blaikie4e4d0842012-03-11 07:00:24 +00004285 if (!S.getLangOpts().CPlusPlus) {
Douglas Gregor5a5b38f2011-03-12 00:14:31 +00004286 if (DeclRefExpr *DRE = dyn_cast<DeclRefExpr>(E))
4287 if (EnumConstantDecl *ECD = dyn_cast<EnumConstantDecl>(DRE->getDecl())) {
4288 EnumDecl *Enum = cast<EnumDecl>(ECD->getDeclContext());
4289 SourceType = S.Context.getTypeDeclType(Enum);
4290 Source = S.Context.getCanonicalType(SourceType).getTypePtr();
4291 }
4292 }
4293
Douglas Gregor284cc8d2011-02-22 02:45:07 +00004294 if (const EnumType *SourceEnum = Source->getAs<EnumType>())
4295 if (const EnumType *TargetEnum = Target->getAs<EnumType>())
4296 if ((SourceEnum->getDecl()->getIdentifier() ||
Richard Smith162e1c12011-04-15 14:24:37 +00004297 SourceEnum->getDecl()->getTypedefNameForAnonDecl()) &&
Douglas Gregor284cc8d2011-02-22 02:45:07 +00004298 (TargetEnum->getDecl()->getIdentifier() ||
Richard Smith162e1c12011-04-15 14:24:37 +00004299 TargetEnum->getDecl()->getTypedefNameForAnonDecl()) &&
Ted Kremenekef9ff882011-03-10 20:03:42 +00004300 SourceEnum != TargetEnum) {
Matt Beaumont-Gayd87a0cd2012-01-06 22:43:58 +00004301 if (S.SourceMgr.isInSystemMacro(CC))
Ted Kremenekef9ff882011-03-10 20:03:42 +00004302 return;
4303
Douglas Gregor5a5b38f2011-03-12 00:14:31 +00004304 return DiagnoseImpCast(S, E, SourceType, T, CC,
Douglas Gregor284cc8d2011-02-22 02:45:07 +00004305 diag::warn_impcast_different_enum_types);
Ted Kremenekef9ff882011-03-10 20:03:42 +00004306 }
Douglas Gregor284cc8d2011-02-22 02:45:07 +00004307
John McCall51313c32010-01-04 23:31:57 +00004308 return;
4309}
4310
John McCall323ed742010-05-06 08:58:33 +00004311void CheckConditionalOperator(Sema &S, ConditionalOperator *E, QualType T);
4312
4313void CheckConditionalOperand(Sema &S, Expr *E, QualType T,
John McCallb4eb64d2010-10-08 02:01:28 +00004314 SourceLocation CC, bool &ICContext) {
John McCall323ed742010-05-06 08:58:33 +00004315 E = E->IgnoreParenImpCasts();
4316
4317 if (isa<ConditionalOperator>(E))
4318 return CheckConditionalOperator(S, cast<ConditionalOperator>(E), T);
4319
John McCallb4eb64d2010-10-08 02:01:28 +00004320 AnalyzeImplicitConversions(S, E, CC);
John McCall323ed742010-05-06 08:58:33 +00004321 if (E->getType() != T)
John McCallb4eb64d2010-10-08 02:01:28 +00004322 return CheckImplicitConversion(S, E, T, CC, &ICContext);
John McCall323ed742010-05-06 08:58:33 +00004323 return;
4324}
4325
4326void CheckConditionalOperator(Sema &S, ConditionalOperator *E, QualType T) {
John McCallb4eb64d2010-10-08 02:01:28 +00004327 SourceLocation CC = E->getQuestionLoc();
4328
4329 AnalyzeImplicitConversions(S, E->getCond(), CC);
John McCall323ed742010-05-06 08:58:33 +00004330
4331 bool Suspicious = false;
John McCallb4eb64d2010-10-08 02:01:28 +00004332 CheckConditionalOperand(S, E->getTrueExpr(), T, CC, Suspicious);
4333 CheckConditionalOperand(S, E->getFalseExpr(), T, CC, Suspicious);
John McCall323ed742010-05-06 08:58:33 +00004334
4335 // If -Wconversion would have warned about either of the candidates
4336 // for a signedness conversion to the context type...
4337 if (!Suspicious) return;
4338
4339 // ...but it's currently ignored...
Argyrios Kyrtzidis08274082010-12-15 18:44:22 +00004340 if (S.Diags.getDiagnosticLevel(diag::warn_impcast_integer_sign_conditional,
4341 CC))
John McCall323ed742010-05-06 08:58:33 +00004342 return;
4343
John McCall323ed742010-05-06 08:58:33 +00004344 // ...then check whether it would have warned about either of the
4345 // candidates for a signedness conversion to the condition type.
Richard Trieu52541612011-07-21 02:46:28 +00004346 if (E->getType() == T) return;
4347
4348 Suspicious = false;
4349 CheckImplicitConversion(S, E->getTrueExpr()->IgnoreParenImpCasts(),
4350 E->getType(), CC, &Suspicious);
4351 if (!Suspicious)
4352 CheckImplicitConversion(S, E->getFalseExpr()->IgnoreParenImpCasts(),
John McCallb4eb64d2010-10-08 02:01:28 +00004353 E->getType(), CC, &Suspicious);
John McCall323ed742010-05-06 08:58:33 +00004354}
4355
4356/// AnalyzeImplicitConversions - Find and report any interesting
4357/// implicit conversions in the given expression. There are a couple
4358/// of competing diagnostics here, -Wconversion and -Wsign-compare.
John McCallb4eb64d2010-10-08 02:01:28 +00004359void AnalyzeImplicitConversions(Sema &S, Expr *OrigE, SourceLocation CC) {
John McCall323ed742010-05-06 08:58:33 +00004360 QualType T = OrigE->getType();
4361 Expr *E = OrigE->IgnoreParenImpCasts();
4362
Douglas Gregorf8b6e152011-10-10 17:38:18 +00004363 if (E->isTypeDependent() || E->isValueDependent())
4364 return;
4365
John McCall323ed742010-05-06 08:58:33 +00004366 // For conditional operators, we analyze the arguments as if they
4367 // were being fed directly into the output.
4368 if (isa<ConditionalOperator>(E)) {
4369 ConditionalOperator *CO = cast<ConditionalOperator>(E);
4370 CheckConditionalOperator(S, CO, T);
4371 return;
4372 }
4373
4374 // Go ahead and check any implicit conversions we might have skipped.
4375 // The non-canonical typecheck is just an optimization;
4376 // CheckImplicitConversion will filter out dead implicit conversions.
4377 if (E->getType() != T)
John McCallb4eb64d2010-10-08 02:01:28 +00004378 CheckImplicitConversion(S, E, T, CC);
John McCall323ed742010-05-06 08:58:33 +00004379
4380 // Now continue drilling into this expression.
4381
4382 // Skip past explicit casts.
4383 if (isa<ExplicitCastExpr>(E)) {
4384 E = cast<ExplicitCastExpr>(E)->getSubExpr()->IgnoreParenImpCasts();
John McCallb4eb64d2010-10-08 02:01:28 +00004385 return AnalyzeImplicitConversions(S, E, CC);
John McCall323ed742010-05-06 08:58:33 +00004386 }
4387
John McCallbeb22aa2010-11-09 23:24:47 +00004388 if (BinaryOperator *BO = dyn_cast<BinaryOperator>(E)) {
4389 // Do a somewhat different check with comparison operators.
4390 if (BO->isComparisonOp())
4391 return AnalyzeComparison(S, BO);
4392
Eli Friedman0fa06382012-01-26 23:34:06 +00004393 // And with simple assignments.
4394 if (BO->getOpcode() == BO_Assign)
John McCallbeb22aa2010-11-09 23:24:47 +00004395 return AnalyzeAssignment(S, BO);
4396 }
John McCall323ed742010-05-06 08:58:33 +00004397
4398 // These break the otherwise-useful invariant below. Fortunately,
4399 // we don't really need to recurse into them, because any internal
4400 // expressions should have been analyzed already when they were
4401 // built into statements.
4402 if (isa<StmtExpr>(E)) return;
4403
4404 // Don't descend into unevaluated contexts.
Peter Collingbournef4e3cfb2011-03-11 19:24:49 +00004405 if (isa<UnaryExprOrTypeTraitExpr>(E)) return;
John McCall323ed742010-05-06 08:58:33 +00004406
4407 // Now just recurse over the expression's children.
John McCallb4eb64d2010-10-08 02:01:28 +00004408 CC = E->getExprLoc();
Richard Trieuf1f8b1a2011-09-23 20:10:00 +00004409 BinaryOperator *BO = dyn_cast<BinaryOperator>(E);
4410 bool IsLogicalOperator = BO && BO->isLogicalOp();
4411 for (Stmt::child_range I = E->children(); I; ++I) {
Douglas Gregor54042f12012-02-09 10:18:50 +00004412 Expr *ChildExpr = dyn_cast_or_null<Expr>(*I);
Douglas Gregor503384f2012-02-09 00:47:04 +00004413 if (!ChildExpr)
4414 continue;
4415
Richard Trieuf1f8b1a2011-09-23 20:10:00 +00004416 if (IsLogicalOperator &&
4417 isa<StringLiteral>(ChildExpr->IgnoreParenImpCasts()))
4418 // Ignore checking string literals that are in logical operators.
4419 continue;
4420 AnalyzeImplicitConversions(S, ChildExpr, CC);
4421 }
John McCall323ed742010-05-06 08:58:33 +00004422}
4423
4424} // end anonymous namespace
4425
4426/// Diagnoses "dangerous" implicit conversions within the given
4427/// expression (which is a full expression). Implements -Wconversion
4428/// and -Wsign-compare.
John McCallb4eb64d2010-10-08 02:01:28 +00004429///
4430/// \param CC the "context" location of the implicit conversion, i.e.
4431/// the most location of the syntactic entity requiring the implicit
4432/// conversion
4433void Sema::CheckImplicitConversions(Expr *E, SourceLocation CC) {
John McCall323ed742010-05-06 08:58:33 +00004434 // Don't diagnose in unevaluated contexts.
4435 if (ExprEvalContexts.back().Context == Sema::Unevaluated)
4436 return;
4437
4438 // Don't diagnose for value- or type-dependent expressions.
4439 if (E->isTypeDependent() || E->isValueDependent())
4440 return;
4441
Kaelyn Uhraind6c88652011-08-05 23:18:04 +00004442 // Check for array bounds violations in cases where the check isn't triggered
4443 // elsewhere for other Expr types (like BinaryOperators), e.g. when an
4444 // ArraySubscriptExpr is on the RHS of a variable initialization.
4445 CheckArrayAccess(E);
4446
John McCallb4eb64d2010-10-08 02:01:28 +00004447 // This is not the right CC for (e.g.) a variable initialization.
4448 AnalyzeImplicitConversions(*this, E, CC);
John McCall323ed742010-05-06 08:58:33 +00004449}
4450
John McCall15d7d122010-11-11 03:21:53 +00004451void Sema::CheckBitFieldInitialization(SourceLocation InitLoc,
4452 FieldDecl *BitField,
4453 Expr *Init) {
4454 (void) AnalyzeBitFieldAssignment(*this, BitField, Init, InitLoc);
4455}
4456
Mike Stumpf8c49212010-01-21 03:59:47 +00004457/// CheckParmsForFunctionDef - Check that the parameters of the given
4458/// function are appropriate for the definition of a function. This
4459/// takes care of any checks that cannot be performed on the
4460/// declaration itself, e.g., that the types of each of the function
4461/// parameters are complete.
Douglas Gregor82aa7132010-11-01 18:37:59 +00004462bool Sema::CheckParmsForFunctionDef(ParmVarDecl **P, ParmVarDecl **PEnd,
4463 bool CheckParameterNames) {
Mike Stumpf8c49212010-01-21 03:59:47 +00004464 bool HasInvalidParm = false;
Douglas Gregor82aa7132010-11-01 18:37:59 +00004465 for (; P != PEnd; ++P) {
4466 ParmVarDecl *Param = *P;
4467
Mike Stumpf8c49212010-01-21 03:59:47 +00004468 // C99 6.7.5.3p4: the parameters in a parameter type list in a
4469 // function declarator that is part of a function definition of
4470 // that function shall not have incomplete type.
4471 //
4472 // This is also C++ [dcl.fct]p6.
4473 if (!Param->isInvalidDecl() &&
4474 RequireCompleteType(Param->getLocation(), Param->getType(),
4475 diag::err_typecheck_decl_incomplete_type)) {
4476 Param->setInvalidDecl();
4477 HasInvalidParm = true;
4478 }
4479
4480 // C99 6.9.1p5: If the declarator includes a parameter type list, the
4481 // declaration of each parameter shall include an identifier.
Douglas Gregor82aa7132010-11-01 18:37:59 +00004482 if (CheckParameterNames &&
4483 Param->getIdentifier() == 0 &&
Mike Stumpf8c49212010-01-21 03:59:47 +00004484 !Param->isImplicit() &&
David Blaikie4e4d0842012-03-11 07:00:24 +00004485 !getLangOpts().CPlusPlus)
Mike Stumpf8c49212010-01-21 03:59:47 +00004486 Diag(Param->getLocation(), diag::err_parameter_name_omitted);
Sam Weinigd17e3402010-02-01 05:02:49 +00004487
4488 // C99 6.7.5.3p12:
4489 // If the function declarator is not part of a definition of that
4490 // function, parameters may have incomplete type and may use the [*]
4491 // notation in their sequences of declarator specifiers to specify
4492 // variable length array types.
4493 QualType PType = Param->getOriginalType();
4494 if (const ArrayType *AT = Context.getAsArrayType(PType)) {
4495 if (AT->getSizeModifier() == ArrayType::Star) {
4496 // FIXME: This diagnosic should point the the '[*]' if source-location
4497 // information is added for it.
4498 Diag(Param->getLocation(), diag::err_array_star_in_function_definition);
4499 }
4500 }
Mike Stumpf8c49212010-01-21 03:59:47 +00004501 }
4502
4503 return HasInvalidParm;
4504}
John McCallb7f4ffe2010-08-12 21:44:57 +00004505
4506/// CheckCastAlign - Implements -Wcast-align, which warns when a
4507/// pointer cast increases the alignment requirements.
4508void Sema::CheckCastAlign(Expr *Op, QualType T, SourceRange TRange) {
4509 // This is actually a lot of work to potentially be doing on every
4510 // cast; don't do it if we're ignoring -Wcast_align (as is the default).
Argyrios Kyrtzidis08274082010-12-15 18:44:22 +00004511 if (getDiagnostics().getDiagnosticLevel(diag::warn_cast_align,
4512 TRange.getBegin())
David Blaikied6471f72011-09-25 23:23:43 +00004513 == DiagnosticsEngine::Ignored)
John McCallb7f4ffe2010-08-12 21:44:57 +00004514 return;
4515
4516 // Ignore dependent types.
4517 if (T->isDependentType() || Op->getType()->isDependentType())
4518 return;
4519
4520 // Require that the destination be a pointer type.
4521 const PointerType *DestPtr = T->getAs<PointerType>();
4522 if (!DestPtr) return;
4523
4524 // If the destination has alignment 1, we're done.
4525 QualType DestPointee = DestPtr->getPointeeType();
4526 if (DestPointee->isIncompleteType()) return;
4527 CharUnits DestAlign = Context.getTypeAlignInChars(DestPointee);
4528 if (DestAlign.isOne()) return;
4529
4530 // Require that the source be a pointer type.
4531 const PointerType *SrcPtr = Op->getType()->getAs<PointerType>();
4532 if (!SrcPtr) return;
4533 QualType SrcPointee = SrcPtr->getPointeeType();
4534
4535 // Whitelist casts from cv void*. We already implicitly
4536 // whitelisted casts to cv void*, since they have alignment 1.
4537 // Also whitelist casts involving incomplete types, which implicitly
4538 // includes 'void'.
4539 if (SrcPointee->isIncompleteType()) return;
4540
4541 CharUnits SrcAlign = Context.getTypeAlignInChars(SrcPointee);
4542 if (SrcAlign >= DestAlign) return;
4543
4544 Diag(TRange.getBegin(), diag::warn_cast_align)
4545 << Op->getType() << T
4546 << static_cast<unsigned>(SrcAlign.getQuantity())
4547 << static_cast<unsigned>(DestAlign.getQuantity())
4548 << TRange << Op->getSourceRange();
4549}
4550
Kaelyn Uhraind6c88652011-08-05 23:18:04 +00004551static const Type* getElementType(const Expr *BaseExpr) {
4552 const Type* EltType = BaseExpr->getType().getTypePtr();
4553 if (EltType->isAnyPointerType())
4554 return EltType->getPointeeType().getTypePtr();
4555 else if (EltType->isArrayType())
4556 return EltType->getBaseElementTypeUnsafe();
4557 return EltType;
4558}
4559
Chandler Carruthc2684342011-08-05 09:10:50 +00004560/// \brief Check whether this array fits the idiom of a size-one tail padded
4561/// array member of a struct.
4562///
4563/// We avoid emitting out-of-bounds access warnings for such arrays as they are
4564/// commonly used to emulate flexible arrays in C89 code.
4565static bool IsTailPaddedMemberArray(Sema &S, llvm::APInt Size,
4566 const NamedDecl *ND) {
4567 if (Size != 1 || !ND) return false;
4568
4569 const FieldDecl *FD = dyn_cast<FieldDecl>(ND);
4570 if (!FD) return false;
4571
4572 // Don't consider sizes resulting from macro expansions or template argument
4573 // substitution to form C89 tail-padded arrays.
4574 ConstantArrayTypeLoc TL =
4575 cast<ConstantArrayTypeLoc>(FD->getTypeSourceInfo()->getTypeLoc());
4576 const Expr *SizeExpr = dyn_cast<IntegerLiteral>(TL.getSizeExpr());
4577 if (!SizeExpr || SizeExpr->getExprLoc().isMacroID())
4578 return false;
4579
4580 const RecordDecl *RD = dyn_cast<RecordDecl>(FD->getDeclContext());
Matt Beaumont-Gay381711c2011-11-29 22:43:53 +00004581 if (!RD) return false;
4582 if (RD->isUnion()) return false;
4583 if (const CXXRecordDecl *CRD = dyn_cast<CXXRecordDecl>(RD)) {
4584 if (!CRD->isStandardLayout()) return false;
4585 }
Chandler Carruthc2684342011-08-05 09:10:50 +00004586
Benjamin Kramer22d4fed2011-08-06 03:04:42 +00004587 // See if this is the last field decl in the record.
4588 const Decl *D = FD;
4589 while ((D = D->getNextDeclInContext()))
4590 if (isa<FieldDecl>(D))
4591 return false;
4592 return true;
Chandler Carruthc2684342011-08-05 09:10:50 +00004593}
4594
Kaelyn Uhraind6c88652011-08-05 23:18:04 +00004595void Sema::CheckArrayAccess(const Expr *BaseExpr, const Expr *IndexExpr,
Matt Beaumont-Gay80fb7dd2011-12-14 16:02:15 +00004596 const ArraySubscriptExpr *ASE,
Richard Smith25b009a2011-12-16 19:31:14 +00004597 bool AllowOnePastEnd, bool IndexNegated) {
Eli Friedman92b670e2012-02-27 21:21:40 +00004598 IndexExpr = IndexExpr->IgnoreParenImpCasts();
Matt Beaumont-Gay80fb7dd2011-12-14 16:02:15 +00004599 if (IndexExpr->isValueDependent())
4600 return;
4601
Matt Beaumont-Gay8ef8f432011-12-12 22:35:02 +00004602 const Type *EffectiveType = getElementType(BaseExpr);
Kaelyn Uhraind6c88652011-08-05 23:18:04 +00004603 BaseExpr = BaseExpr->IgnoreParenCasts();
Chandler Carruth34064582011-02-17 20:55:08 +00004604 const ConstantArrayType *ArrayTy =
Kaelyn Uhraind6c88652011-08-05 23:18:04 +00004605 Context.getAsConstantArrayType(BaseExpr->getType());
Chandler Carruth34064582011-02-17 20:55:08 +00004606 if (!ArrayTy)
Ted Kremeneka0125d82011-02-16 01:57:07 +00004607 return;
Chandler Carruth35001ca2011-02-17 21:10:52 +00004608
Chandler Carruth34064582011-02-17 20:55:08 +00004609 llvm::APSInt index;
Matt Beaumont-Gay80fb7dd2011-12-14 16:02:15 +00004610 if (!IndexExpr->EvaluateAsInt(index, Context))
Ted Kremeneka0125d82011-02-16 01:57:07 +00004611 return;
Richard Smith25b009a2011-12-16 19:31:14 +00004612 if (IndexNegated)
4613 index = -index;
Ted Kremenek8fd0a5d2011-02-16 04:01:44 +00004614
Chandler Carruthba447122011-08-05 08:07:29 +00004615 const NamedDecl *ND = NULL;
Chandler Carruthba447122011-08-05 08:07:29 +00004616 if (const DeclRefExpr *DRE = dyn_cast<DeclRefExpr>(BaseExpr))
4617 ND = dyn_cast<NamedDecl>(DRE->getDecl());
Chandler Carruthc2684342011-08-05 09:10:50 +00004618 if (const MemberExpr *ME = dyn_cast<MemberExpr>(BaseExpr))
Chandler Carruthba447122011-08-05 08:07:29 +00004619 ND = dyn_cast<NamedDecl>(ME->getMemberDecl());
Chandler Carruthba447122011-08-05 08:07:29 +00004620
Ted Kremenek9e060ca2011-02-23 23:06:04 +00004621 if (index.isUnsigned() || !index.isNegative()) {
Ted Kremenek25b3b842011-02-18 02:27:00 +00004622 llvm::APInt size = ArrayTy->getSize();
Chandler Carruth35001ca2011-02-17 21:10:52 +00004623 if (!size.isStrictlyPositive())
4624 return;
Kaelyn Uhraind6c88652011-08-05 23:18:04 +00004625
4626 const Type* BaseType = getElementType(BaseExpr);
Nico Weberde5998f2011-09-17 22:59:41 +00004627 if (BaseType != EffectiveType) {
Kaelyn Uhraind6c88652011-08-05 23:18:04 +00004628 // Make sure we're comparing apples to apples when comparing index to size
4629 uint64_t ptrarith_typesize = Context.getTypeSize(EffectiveType);
4630 uint64_t array_typesize = Context.getTypeSize(BaseType);
Kaelyn Uhraind10f4bc2011-08-10 19:47:25 +00004631 // Handle ptrarith_typesize being zero, such as when casting to void*
Kaelyn Uhrain18f16972011-08-10 18:49:28 +00004632 if (!ptrarith_typesize) ptrarith_typesize = 1;
Kaelyn Uhraind6c88652011-08-05 23:18:04 +00004633 if (ptrarith_typesize != array_typesize) {
4634 // There's a cast to a different size type involved
4635 uint64_t ratio = array_typesize / ptrarith_typesize;
4636 // TODO: Be smarter about handling cases where array_typesize is not a
4637 // multiple of ptrarith_typesize
4638 if (ptrarith_typesize * ratio == array_typesize)
4639 size *= llvm::APInt(size.getBitWidth(), ratio);
4640 }
4641 }
4642
Chandler Carruth34064582011-02-17 20:55:08 +00004643 if (size.getBitWidth() > index.getBitWidth())
Eli Friedman92b670e2012-02-27 21:21:40 +00004644 index = index.zext(size.getBitWidth());
Ted Kremenek25b3b842011-02-18 02:27:00 +00004645 else if (size.getBitWidth() < index.getBitWidth())
Eli Friedman92b670e2012-02-27 21:21:40 +00004646 size = size.zext(index.getBitWidth());
Ted Kremenek25b3b842011-02-18 02:27:00 +00004647
Kaelyn Uhraind6c88652011-08-05 23:18:04 +00004648 // For array subscripting the index must be less than size, but for pointer
4649 // arithmetic also allow the index (offset) to be equal to size since
4650 // computing the next address after the end of the array is legal and
4651 // commonly done e.g. in C++ iterators and range-based for loops.
Eli Friedman92b670e2012-02-27 21:21:40 +00004652 if (AllowOnePastEnd ? index.ule(size) : index.ult(size))
Chandler Carruthba447122011-08-05 08:07:29 +00004653 return;
4654
4655 // Also don't warn for arrays of size 1 which are members of some
4656 // structure. These are often used to approximate flexible arrays in C89
4657 // code.
Kaelyn Uhraind6c88652011-08-05 23:18:04 +00004658 if (IsTailPaddedMemberArray(*this, size, ND))
Ted Kremenek8fd0a5d2011-02-16 04:01:44 +00004659 return;
Chandler Carruth34064582011-02-17 20:55:08 +00004660
Matt Beaumont-Gay80fb7dd2011-12-14 16:02:15 +00004661 // Suppress the warning if the subscript expression (as identified by the
4662 // ']' location) and the index expression are both from macro expansions
4663 // within a system header.
4664 if (ASE) {
4665 SourceLocation RBracketLoc = SourceMgr.getSpellingLoc(
4666 ASE->getRBracketLoc());
4667 if (SourceMgr.isInSystemHeader(RBracketLoc)) {
4668 SourceLocation IndexLoc = SourceMgr.getSpellingLoc(
4669 IndexExpr->getLocStart());
4670 if (SourceMgr.isFromSameFile(RBracketLoc, IndexLoc))
4671 return;
4672 }
4673 }
4674
Kaelyn Uhraind6c88652011-08-05 23:18:04 +00004675 unsigned DiagID = diag::warn_ptr_arith_exceeds_bounds;
Matt Beaumont-Gay80fb7dd2011-12-14 16:02:15 +00004676 if (ASE)
Kaelyn Uhraind6c88652011-08-05 23:18:04 +00004677 DiagID = diag::warn_array_index_exceeds_bounds;
4678
4679 DiagRuntimeBehavior(BaseExpr->getLocStart(), BaseExpr,
4680 PDiag(DiagID) << index.toString(10, true)
4681 << size.toString(10, true)
4682 << (unsigned)size.getLimitedValue(~0U)
4683 << IndexExpr->getSourceRange());
Chandler Carruth34064582011-02-17 20:55:08 +00004684 } else {
Kaelyn Uhraind6c88652011-08-05 23:18:04 +00004685 unsigned DiagID = diag::warn_array_index_precedes_bounds;
Matt Beaumont-Gay80fb7dd2011-12-14 16:02:15 +00004686 if (!ASE) {
Kaelyn Uhraind6c88652011-08-05 23:18:04 +00004687 DiagID = diag::warn_ptr_arith_precedes_bounds;
4688 if (index.isNegative()) index = -index;
4689 }
4690
4691 DiagRuntimeBehavior(BaseExpr->getLocStart(), BaseExpr,
4692 PDiag(DiagID) << index.toString(10, true)
4693 << IndexExpr->getSourceRange());
Ted Kremeneka0125d82011-02-16 01:57:07 +00004694 }
Chandler Carruth35001ca2011-02-17 21:10:52 +00004695
Matt Beaumont-Gaycfbc5b52011-11-29 19:27:11 +00004696 if (!ND) {
4697 // Try harder to find a NamedDecl to point at in the note.
4698 while (const ArraySubscriptExpr *ASE =
4699 dyn_cast<ArraySubscriptExpr>(BaseExpr))
4700 BaseExpr = ASE->getBase()->IgnoreParenCasts();
4701 if (const DeclRefExpr *DRE = dyn_cast<DeclRefExpr>(BaseExpr))
4702 ND = dyn_cast<NamedDecl>(DRE->getDecl());
4703 if (const MemberExpr *ME = dyn_cast<MemberExpr>(BaseExpr))
4704 ND = dyn_cast<NamedDecl>(ME->getMemberDecl());
4705 }
4706
Chandler Carruth35001ca2011-02-17 21:10:52 +00004707 if (ND)
Kaelyn Uhraind6c88652011-08-05 23:18:04 +00004708 DiagRuntimeBehavior(ND->getLocStart(), BaseExpr,
4709 PDiag(diag::note_array_index_out_of_bounds)
4710 << ND->getDeclName());
Ted Kremeneka0125d82011-02-16 01:57:07 +00004711}
4712
Ted Kremenek3aea4da2011-03-01 18:41:00 +00004713void Sema::CheckArrayAccess(const Expr *expr) {
Kaelyn Uhraind6c88652011-08-05 23:18:04 +00004714 int AllowOnePastEnd = 0;
4715 while (expr) {
4716 expr = expr->IgnoreParenImpCasts();
Ted Kremenek3aea4da2011-03-01 18:41:00 +00004717 switch (expr->getStmtClass()) {
Kaelyn Uhraind6c88652011-08-05 23:18:04 +00004718 case Stmt::ArraySubscriptExprClass: {
4719 const ArraySubscriptExpr *ASE = cast<ArraySubscriptExpr>(expr);
Matt Beaumont-Gay80fb7dd2011-12-14 16:02:15 +00004720 CheckArrayAccess(ASE->getBase(), ASE->getIdx(), ASE,
Kaelyn Uhraind6c88652011-08-05 23:18:04 +00004721 AllowOnePastEnd > 0);
Ted Kremenek3aea4da2011-03-01 18:41:00 +00004722 return;
Kaelyn Uhraind6c88652011-08-05 23:18:04 +00004723 }
4724 case Stmt::UnaryOperatorClass: {
4725 // Only unwrap the * and & unary operators
4726 const UnaryOperator *UO = cast<UnaryOperator>(expr);
4727 expr = UO->getSubExpr();
4728 switch (UO->getOpcode()) {
4729 case UO_AddrOf:
4730 AllowOnePastEnd++;
4731 break;
4732 case UO_Deref:
4733 AllowOnePastEnd--;
4734 break;
4735 default:
4736 return;
4737 }
4738 break;
4739 }
Ted Kremenek3aea4da2011-03-01 18:41:00 +00004740 case Stmt::ConditionalOperatorClass: {
4741 const ConditionalOperator *cond = cast<ConditionalOperator>(expr);
4742 if (const Expr *lhs = cond->getLHS())
4743 CheckArrayAccess(lhs);
4744 if (const Expr *rhs = cond->getRHS())
4745 CheckArrayAccess(rhs);
4746 return;
4747 }
4748 default:
4749 return;
4750 }
Peter Collingbournef111d932011-04-15 00:35:48 +00004751 }
Ted Kremenek3aea4da2011-03-01 18:41:00 +00004752}
John McCallf85e1932011-06-15 23:02:42 +00004753
4754//===--- CHECK: Objective-C retain cycles ----------------------------------//
4755
4756namespace {
4757 struct RetainCycleOwner {
4758 RetainCycleOwner() : Variable(0), Indirect(false) {}
4759 VarDecl *Variable;
4760 SourceRange Range;
4761 SourceLocation Loc;
4762 bool Indirect;
4763
4764 void setLocsFrom(Expr *e) {
4765 Loc = e->getExprLoc();
4766 Range = e->getSourceRange();
4767 }
4768 };
4769}
4770
4771/// Consider whether capturing the given variable can possibly lead to
4772/// a retain cycle.
4773static bool considerVariable(VarDecl *var, Expr *ref, RetainCycleOwner &owner) {
4774 // In ARC, it's captured strongly iff the variable has __strong
4775 // lifetime. In MRR, it's captured strongly if the variable is
4776 // __block and has an appropriate type.
4777 if (var->getType().getObjCLifetime() != Qualifiers::OCL_Strong)
4778 return false;
4779
4780 owner.Variable = var;
4781 owner.setLocsFrom(ref);
4782 return true;
4783}
4784
Fariborz Jahanian6e6f93a2012-01-10 19:28:26 +00004785static bool findRetainCycleOwner(Sema &S, Expr *e, RetainCycleOwner &owner) {
John McCallf85e1932011-06-15 23:02:42 +00004786 while (true) {
4787 e = e->IgnoreParens();
4788 if (CastExpr *cast = dyn_cast<CastExpr>(e)) {
4789 switch (cast->getCastKind()) {
4790 case CK_BitCast:
4791 case CK_LValueBitCast:
4792 case CK_LValueToRValue:
John McCall33e56f32011-09-10 06:18:15 +00004793 case CK_ARCReclaimReturnedObject:
John McCallf85e1932011-06-15 23:02:42 +00004794 e = cast->getSubExpr();
4795 continue;
4796
John McCallf85e1932011-06-15 23:02:42 +00004797 default:
4798 return false;
4799 }
4800 }
4801
4802 if (ObjCIvarRefExpr *ref = dyn_cast<ObjCIvarRefExpr>(e)) {
4803 ObjCIvarDecl *ivar = ref->getDecl();
4804 if (ivar->getType().getObjCLifetime() != Qualifiers::OCL_Strong)
4805 return false;
4806
4807 // Try to find a retain cycle in the base.
Fariborz Jahanian6e6f93a2012-01-10 19:28:26 +00004808 if (!findRetainCycleOwner(S, ref->getBase(), owner))
John McCallf85e1932011-06-15 23:02:42 +00004809 return false;
4810
4811 if (ref->isFreeIvar()) owner.setLocsFrom(ref);
4812 owner.Indirect = true;
4813 return true;
4814 }
4815
4816 if (DeclRefExpr *ref = dyn_cast<DeclRefExpr>(e)) {
4817 VarDecl *var = dyn_cast<VarDecl>(ref->getDecl());
4818 if (!var) return false;
4819 return considerVariable(var, ref, owner);
4820 }
4821
John McCallf85e1932011-06-15 23:02:42 +00004822 if (MemberExpr *member = dyn_cast<MemberExpr>(e)) {
4823 if (member->isArrow()) return false;
4824
4825 // Don't count this as an indirect ownership.
4826 e = member->getBase();
4827 continue;
4828 }
4829
John McCall4b9c2d22011-11-06 09:01:30 +00004830 if (PseudoObjectExpr *pseudo = dyn_cast<PseudoObjectExpr>(e)) {
4831 // Only pay attention to pseudo-objects on property references.
4832 ObjCPropertyRefExpr *pre
4833 = dyn_cast<ObjCPropertyRefExpr>(pseudo->getSyntacticForm()
4834 ->IgnoreParens());
4835 if (!pre) return false;
4836 if (pre->isImplicitProperty()) return false;
4837 ObjCPropertyDecl *property = pre->getExplicitProperty();
4838 if (!property->isRetaining() &&
4839 !(property->getPropertyIvarDecl() &&
4840 property->getPropertyIvarDecl()->getType()
4841 .getObjCLifetime() == Qualifiers::OCL_Strong))
4842 return false;
4843
4844 owner.Indirect = true;
Fariborz Jahanian6e6f93a2012-01-10 19:28:26 +00004845 if (pre->isSuperReceiver()) {
4846 owner.Variable = S.getCurMethodDecl()->getSelfDecl();
4847 if (!owner.Variable)
4848 return false;
4849 owner.Loc = pre->getLocation();
4850 owner.Range = pre->getSourceRange();
4851 return true;
4852 }
John McCall4b9c2d22011-11-06 09:01:30 +00004853 e = const_cast<Expr*>(cast<OpaqueValueExpr>(pre->getBase())
4854 ->getSourceExpr());
4855 continue;
4856 }
4857
John McCallf85e1932011-06-15 23:02:42 +00004858 // Array ivars?
4859
4860 return false;
4861 }
4862}
4863
4864namespace {
4865 struct FindCaptureVisitor : EvaluatedExprVisitor<FindCaptureVisitor> {
4866 FindCaptureVisitor(ASTContext &Context, VarDecl *variable)
4867 : EvaluatedExprVisitor<FindCaptureVisitor>(Context),
4868 Variable(variable), Capturer(0) {}
4869
4870 VarDecl *Variable;
4871 Expr *Capturer;
4872
4873 void VisitDeclRefExpr(DeclRefExpr *ref) {
4874 if (ref->getDecl() == Variable && !Capturer)
4875 Capturer = ref;
4876 }
4877
John McCallf85e1932011-06-15 23:02:42 +00004878 void VisitObjCIvarRefExpr(ObjCIvarRefExpr *ref) {
4879 if (Capturer) return;
4880 Visit(ref->getBase());
4881 if (Capturer && ref->isFreeIvar())
4882 Capturer = ref;
4883 }
4884
4885 void VisitBlockExpr(BlockExpr *block) {
4886 // Look inside nested blocks
4887 if (block->getBlockDecl()->capturesVariable(Variable))
4888 Visit(block->getBlockDecl()->getBody());
4889 }
4890 };
4891}
4892
4893/// Check whether the given argument is a block which captures a
4894/// variable.
4895static Expr *findCapturingExpr(Sema &S, Expr *e, RetainCycleOwner &owner) {
4896 assert(owner.Variable && owner.Loc.isValid());
4897
4898 e = e->IgnoreParenCasts();
4899 BlockExpr *block = dyn_cast<BlockExpr>(e);
4900 if (!block || !block->getBlockDecl()->capturesVariable(owner.Variable))
4901 return 0;
4902
4903 FindCaptureVisitor visitor(S.Context, owner.Variable);
4904 visitor.Visit(block->getBlockDecl()->getBody());
4905 return visitor.Capturer;
4906}
4907
4908static void diagnoseRetainCycle(Sema &S, Expr *capturer,
4909 RetainCycleOwner &owner) {
4910 assert(capturer);
4911 assert(owner.Variable && owner.Loc.isValid());
4912
4913 S.Diag(capturer->getExprLoc(), diag::warn_arc_retain_cycle)
4914 << owner.Variable << capturer->getSourceRange();
4915 S.Diag(owner.Loc, diag::note_arc_retain_cycle_owner)
4916 << owner.Indirect << owner.Range;
4917}
4918
4919/// Check for a keyword selector that starts with the word 'add' or
4920/// 'set'.
4921static bool isSetterLikeSelector(Selector sel) {
4922 if (sel.isUnarySelector()) return false;
4923
Chris Lattner5f9e2722011-07-23 10:55:15 +00004924 StringRef str = sel.getNameForSlot(0);
John McCallf85e1932011-06-15 23:02:42 +00004925 while (!str.empty() && str.front() == '_') str = str.substr(1);
Ted Kremenek968a0ee2011-12-01 00:59:21 +00004926 if (str.startswith("set"))
John McCallf85e1932011-06-15 23:02:42 +00004927 str = str.substr(3);
Ted Kremenek968a0ee2011-12-01 00:59:21 +00004928 else if (str.startswith("add")) {
4929 // Specially whitelist 'addOperationWithBlock:'.
4930 if (sel.getNumArgs() == 1 && str.startswith("addOperationWithBlock"))
4931 return false;
4932 str = str.substr(3);
4933 }
John McCallf85e1932011-06-15 23:02:42 +00004934 else
4935 return false;
4936
4937 if (str.empty()) return true;
4938 return !islower(str.front());
4939}
4940
4941/// Check a message send to see if it's likely to cause a retain cycle.
4942void Sema::checkRetainCycles(ObjCMessageExpr *msg) {
4943 // Only check instance methods whose selector looks like a setter.
4944 if (!msg->isInstanceMessage() || !isSetterLikeSelector(msg->getSelector()))
4945 return;
4946
4947 // Try to find a variable that the receiver is strongly owned by.
4948 RetainCycleOwner owner;
4949 if (msg->getReceiverKind() == ObjCMessageExpr::Instance) {
Fariborz Jahanian6e6f93a2012-01-10 19:28:26 +00004950 if (!findRetainCycleOwner(*this, msg->getInstanceReceiver(), owner))
John McCallf85e1932011-06-15 23:02:42 +00004951 return;
4952 } else {
4953 assert(msg->getReceiverKind() == ObjCMessageExpr::SuperInstance);
4954 owner.Variable = getCurMethodDecl()->getSelfDecl();
4955 owner.Loc = msg->getSuperLoc();
4956 owner.Range = msg->getSuperLoc();
4957 }
4958
4959 // Check whether the receiver is captured by any of the arguments.
4960 for (unsigned i = 0, e = msg->getNumArgs(); i != e; ++i)
4961 if (Expr *capturer = findCapturingExpr(*this, msg->getArg(i), owner))
4962 return diagnoseRetainCycle(*this, capturer, owner);
4963}
4964
4965/// Check a property assign to see if it's likely to cause a retain cycle.
4966void Sema::checkRetainCycles(Expr *receiver, Expr *argument) {
4967 RetainCycleOwner owner;
Fariborz Jahanian6e6f93a2012-01-10 19:28:26 +00004968 if (!findRetainCycleOwner(*this, receiver, owner))
John McCallf85e1932011-06-15 23:02:42 +00004969 return;
4970
4971 if (Expr *capturer = findCapturingExpr(*this, argument, owner))
4972 diagnoseRetainCycle(*this, capturer, owner);
4973}
4974
Fariborz Jahanian921c1432011-06-24 18:25:34 +00004975bool Sema::checkUnsafeAssigns(SourceLocation Loc,
John McCallf85e1932011-06-15 23:02:42 +00004976 QualType LHS, Expr *RHS) {
4977 Qualifiers::ObjCLifetime LT = LHS.getObjCLifetime();
4978 if (LT != Qualifiers::OCL_Weak && LT != Qualifiers::OCL_ExplicitNone)
Fariborz Jahanian921c1432011-06-24 18:25:34 +00004979 return false;
4980 // strip off any implicit cast added to get to the one arc-specific
4981 while (ImplicitCastExpr *cast = dyn_cast<ImplicitCastExpr>(RHS)) {
John McCall33e56f32011-09-10 06:18:15 +00004982 if (cast->getCastKind() == CK_ARCConsumeObject) {
John McCallf85e1932011-06-15 23:02:42 +00004983 Diag(Loc, diag::warn_arc_retained_assign)
4984 << (LT == Qualifiers::OCL_ExplicitNone)
4985 << RHS->getSourceRange();
Fariborz Jahanian921c1432011-06-24 18:25:34 +00004986 return true;
4987 }
4988 RHS = cast->getSubExpr();
4989 }
4990 return false;
John McCallf85e1932011-06-15 23:02:42 +00004991}
4992
Fariborz Jahanian921c1432011-06-24 18:25:34 +00004993void Sema::checkUnsafeExprAssigns(SourceLocation Loc,
4994 Expr *LHS, Expr *RHS) {
Fariborz Jahanian87eaf722012-01-17 22:58:16 +00004995 QualType LHSType;
4996 // PropertyRef on LHS type need be directly obtained from
4997 // its declaration as it has a PsuedoType.
4998 ObjCPropertyRefExpr *PRE
4999 = dyn_cast<ObjCPropertyRefExpr>(LHS->IgnoreParens());
5000 if (PRE && !PRE->isImplicitProperty()) {
5001 const ObjCPropertyDecl *PD = PRE->getExplicitProperty();
5002 if (PD)
5003 LHSType = PD->getType();
5004 }
5005
5006 if (LHSType.isNull())
5007 LHSType = LHS->getType();
Fariborz Jahanian921c1432011-06-24 18:25:34 +00005008 if (checkUnsafeAssigns(Loc, LHSType, RHS))
5009 return;
5010 Qualifiers::ObjCLifetime LT = LHSType.getObjCLifetime();
5011 // FIXME. Check for other life times.
5012 if (LT != Qualifiers::OCL_None)
5013 return;
5014
Fariborz Jahanian87eaf722012-01-17 22:58:16 +00005015 if (PRE) {
Fariborz Jahanian921c1432011-06-24 18:25:34 +00005016 if (PRE->isImplicitProperty())
5017 return;
5018 const ObjCPropertyDecl *PD = PRE->getExplicitProperty();
5019 if (!PD)
5020 return;
5021
5022 unsigned Attributes = PD->getPropertyAttributes();
Fariborz Jahanian87eaf722012-01-17 22:58:16 +00005023 if (Attributes & ObjCPropertyDecl::OBJC_PR_assign) {
5024 // when 'assign' attribute was not explicitly specified
5025 // by user, ignore it and rely on property type itself
5026 // for lifetime info.
5027 unsigned AsWrittenAttr = PD->getPropertyAttributesAsWritten();
5028 if (!(AsWrittenAttr & ObjCPropertyDecl::OBJC_PR_assign) &&
5029 LHSType->isObjCRetainableType())
5030 return;
5031
Fariborz Jahanian921c1432011-06-24 18:25:34 +00005032 while (ImplicitCastExpr *cast = dyn_cast<ImplicitCastExpr>(RHS)) {
John McCall33e56f32011-09-10 06:18:15 +00005033 if (cast->getCastKind() == CK_ARCConsumeObject) {
Fariborz Jahanian921c1432011-06-24 18:25:34 +00005034 Diag(Loc, diag::warn_arc_retained_property_assign)
5035 << RHS->getSourceRange();
5036 return;
5037 }
5038 RHS = cast->getSubExpr();
5039 }
Fariborz Jahanian87eaf722012-01-17 22:58:16 +00005040 }
Fariborz Jahanian921c1432011-06-24 18:25:34 +00005041 }
5042}
Dmitri Gribenko625bb562012-02-14 22:14:32 +00005043
5044//===--- CHECK: Empty statement body (-Wempty-body) ---------------------===//
5045
5046namespace {
5047bool ShouldDiagnoseEmptyStmtBody(const SourceManager &SourceMgr,
5048 SourceLocation StmtLoc,
5049 const NullStmt *Body) {
5050 // Do not warn if the body is a macro that expands to nothing, e.g:
5051 //
5052 // #define CALL(x)
5053 // if (condition)
5054 // CALL(0);
5055 //
5056 if (Body->hasLeadingEmptyMacro())
5057 return false;
5058
5059 // Get line numbers of statement and body.
5060 bool StmtLineInvalid;
5061 unsigned StmtLine = SourceMgr.getSpellingLineNumber(StmtLoc,
5062 &StmtLineInvalid);
5063 if (StmtLineInvalid)
5064 return false;
5065
5066 bool BodyLineInvalid;
5067 unsigned BodyLine = SourceMgr.getSpellingLineNumber(Body->getSemiLoc(),
5068 &BodyLineInvalid);
5069 if (BodyLineInvalid)
5070 return false;
5071
5072 // Warn if null statement and body are on the same line.
5073 if (StmtLine != BodyLine)
5074 return false;
5075
5076 return true;
5077}
5078} // Unnamed namespace
5079
5080void Sema::DiagnoseEmptyStmtBody(SourceLocation StmtLoc,
5081 const Stmt *Body,
5082 unsigned DiagID) {
5083 // Since this is a syntactic check, don't emit diagnostic for template
5084 // instantiations, this just adds noise.
5085 if (CurrentInstantiationScope)
5086 return;
5087
5088 // The body should be a null statement.
5089 const NullStmt *NBody = dyn_cast<NullStmt>(Body);
5090 if (!NBody)
5091 return;
5092
5093 // Do the usual checks.
5094 if (!ShouldDiagnoseEmptyStmtBody(SourceMgr, StmtLoc, NBody))
5095 return;
5096
5097 Diag(NBody->getSemiLoc(), DiagID);
5098 Diag(NBody->getSemiLoc(), diag::note_empty_body_on_separate_line);
5099}
5100
5101void Sema::DiagnoseEmptyLoopBody(const Stmt *S,
5102 const Stmt *PossibleBody) {
5103 assert(!CurrentInstantiationScope); // Ensured by caller
5104
5105 SourceLocation StmtLoc;
5106 const Stmt *Body;
5107 unsigned DiagID;
5108 if (const ForStmt *FS = dyn_cast<ForStmt>(S)) {
5109 StmtLoc = FS->getRParenLoc();
5110 Body = FS->getBody();
5111 DiagID = diag::warn_empty_for_body;
5112 } else if (const WhileStmt *WS = dyn_cast<WhileStmt>(S)) {
5113 StmtLoc = WS->getCond()->getSourceRange().getEnd();
5114 Body = WS->getBody();
5115 DiagID = diag::warn_empty_while_body;
5116 } else
5117 return; // Neither `for' nor `while'.
5118
5119 // The body should be a null statement.
5120 const NullStmt *NBody = dyn_cast<NullStmt>(Body);
5121 if (!NBody)
5122 return;
5123
5124 // Skip expensive checks if diagnostic is disabled.
5125 if (Diags.getDiagnosticLevel(DiagID, NBody->getSemiLoc()) ==
5126 DiagnosticsEngine::Ignored)
5127 return;
5128
5129 // Do the usual checks.
5130 if (!ShouldDiagnoseEmptyStmtBody(SourceMgr, StmtLoc, NBody))
5131 return;
5132
5133 // `for(...);' and `while(...);' are popular idioms, so in order to keep
5134 // noise level low, emit diagnostics only if for/while is followed by a
5135 // CompoundStmt, e.g.:
5136 // for (int i = 0; i < n; i++);
5137 // {
5138 // a(i);
5139 // }
5140 // or if for/while is followed by a statement with more indentation
5141 // than for/while itself:
5142 // for (int i = 0; i < n; i++);
5143 // a(i);
5144 bool ProbableTypo = isa<CompoundStmt>(PossibleBody);
5145 if (!ProbableTypo) {
5146 bool BodyColInvalid;
5147 unsigned BodyCol = SourceMgr.getPresumedColumnNumber(
5148 PossibleBody->getLocStart(),
5149 &BodyColInvalid);
5150 if (BodyColInvalid)
5151 return;
5152
5153 bool StmtColInvalid;
5154 unsigned StmtCol = SourceMgr.getPresumedColumnNumber(
5155 S->getLocStart(),
5156 &StmtColInvalid);
5157 if (StmtColInvalid)
5158 return;
5159
5160 if (BodyCol > StmtCol)
5161 ProbableTypo = true;
5162 }
5163
5164 if (ProbableTypo) {
5165 Diag(NBody->getSemiLoc(), DiagID);
5166 Diag(NBody->getSemiLoc(), diag::note_empty_body_on_separate_line);
5167 }
5168}