| 1 |
//===--- RedundantExpressionCheck.cpp - clang-tidy-------------------------===// |
| 2 |
// |
| 3 |
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. |
| 4 |
// See https://llvm.org/LICENSE.txt for license information. |
| 5 |
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception |
| 6 |
// |
| 7 |
//===----------------------------------------------------------------------===// |
| 8 |
|
| 9 |
#include "RedundantExpressionCheck.h" |
| 10 |
#include "../utils/Matchers.h" |
| 11 |
#include "../utils/OptionsUtils.h" |
| 12 |
#include "clang/AST/ASTContext.h" |
| 13 |
#include "clang/AST/ExprConcepts.h" |
| 14 |
#include "clang/ASTMatchers/ASTMatchFinder.h" |
| 15 |
#include "clang/Basic/LLVM.h" |
| 16 |
#include "clang/Basic/SourceLocation.h" |
| 17 |
#include "clang/Basic/SourceManager.h" |
| 18 |
#include "clang/Lex/Lexer.h" |
| 19 |
#include "llvm/ADT/APInt.h" |
| 20 |
#include "llvm/ADT/APSInt.h" |
| 21 |
#include "llvm/ADT/FoldingSet.h" |
| 22 |
#include "llvm/ADT/SmallBitVector.h" |
| 23 |
#include "llvm/Support/Casting.h" |
| 24 |
#include "llvm/Support/FormatVariadic.h" |
| 25 |
#include <algorithm> |
| 26 |
#include <cassert> |
| 27 |
#include <cstdint> |
| 28 |
#include <optional> |
| 29 |
#include <string> |
| 30 |
#include <vector> |
| 31 |
|
| 32 |
using namespace clang::ast_matchers; |
| 33 |
using namespace clang::tidy::matchers; |
| 34 |
|
| 35 |
namespace clang::tidy::misc { |
| 36 |
namespace { |
| 37 |
using llvm::APSInt; |
| 38 |
|
| 39 |
static constexpr llvm::StringLiteral KnownBannedMacroNames[] = { |
| 40 |
"EAGAIN", |
| 41 |
"EWOULDBLOCK", |
| 42 |
"SIGCLD", |
| 43 |
"SIGCHLD", |
| 44 |
}; |
| 45 |
|
| 46 |
static bool incrementWithoutOverflow(const APSInt &Value, APSInt &Result) { |
| 47 |
Result = Value; |
| 48 |
++Result; |
| 49 |
return Value < Result; |
| 50 |
} |
| 51 |
|
| 52 |
static bool areEquivalentNameSpecifier(const NestedNameSpecifier *Left, |
| 53 |
const NestedNameSpecifier *Right) { |
| 54 |
llvm::FoldingSetNodeID LeftID, RightID; |
| 55 |
Left->Profile(LeftID); |
| 56 |
Right->Profile(RightID); |
| 57 |
return LeftID == RightID; |
| 58 |
} |
| 59 |
|
| 60 |
static bool areEquivalentExpr(const Expr *Left, const Expr *Right) { |
| 61 |
if (!Left || !Right) |
| 62 |
return !Left && !Right; |
| 63 |
|
| 64 |
Left = Left->IgnoreParens(); |
| 65 |
Right = Right->IgnoreParens(); |
| 66 |
|
| 67 |
// Compare classes. |
| 68 |
if (Left->getStmtClass() != Right->getStmtClass()) |
| 69 |
return false; |
| 70 |
|
| 71 |
// Compare children. |
| 72 |
Expr::const_child_iterator LeftIter = Left->child_begin(); |
| 73 |
Expr::const_child_iterator RightIter = Right->child_begin(); |
| 74 |
while (LeftIter != Left->child_end() && RightIter != Right->child_end()) { |
| 75 |
if (!areEquivalentExpr(dyn_cast_or_null<Expr>(*LeftIter), |
| 76 |
dyn_cast_or_null<Expr>(*RightIter))) |
| 77 |
return false; |
| 78 |
++LeftIter; |
| 79 |
++RightIter; |
| 80 |
} |
| 81 |
if (LeftIter != Left->child_end() || RightIter != Right->child_end()) |
| 82 |
return false; |
| 83 |
|
| 84 |
// Perform extra checks. |
| 85 |
switch (Left->getStmtClass()) { |
| 86 |
default: |
| 87 |
return false; |
| 88 |
|
| 89 |
case Stmt::CharacterLiteralClass: |
| 90 |
return cast<CharacterLiteral>(Left)->getValue() == |
| 91 |
cast<CharacterLiteral>(Right)->getValue(); |
| 92 |
case Stmt::IntegerLiteralClass: { |
| 93 |
llvm::APInt LeftLit = cast<IntegerLiteral>(Left)->getValue(); |
| 94 |
llvm::APInt RightLit = cast<IntegerLiteral>(Right)->getValue(); |
| 95 |
return LeftLit.getBitWidth() == RightLit.getBitWidth() && |
| 96 |
LeftLit == RightLit; |
| 97 |
} |
| 98 |
case Stmt::FloatingLiteralClass: |
| 99 |
return cast<FloatingLiteral>(Left)->getValue().bitwiseIsEqual( |
| 100 |
cast<FloatingLiteral>(Right)->getValue()); |
| 101 |
case Stmt::StringLiteralClass: |
| 102 |
return cast<StringLiteral>(Left)->getBytes() == |
| 103 |
cast<StringLiteral>(Right)->getBytes(); |
| 104 |
case Stmt::CXXOperatorCallExprClass: |
| 105 |
return cast<CXXOperatorCallExpr>(Left)->getOperator() == |
| 106 |
cast<CXXOperatorCallExpr>(Right)->getOperator(); |
| 107 |
case Stmt::DependentScopeDeclRefExprClass: |
| 108 |
if (cast<DependentScopeDeclRefExpr>(Left)->getDeclName() != |
| 109 |
cast<DependentScopeDeclRefExpr>(Right)->getDeclName()) |
| 110 |
return false; |
| 111 |
return areEquivalentNameSpecifier( |
| 112 |
cast<DependentScopeDeclRefExpr>(Left)->getQualifier(), |
| 113 |
cast<DependentScopeDeclRefExpr>(Right)->getQualifier()); |
| 114 |
case Stmt::DeclRefExprClass: |
| 115 |
return cast<DeclRefExpr>(Left)->getDecl() == |
| 116 |
cast<DeclRefExpr>(Right)->getDecl(); |
| 117 |
case Stmt::MemberExprClass: |
| 118 |
return cast<MemberExpr>(Left)->getMemberDecl() == |
| 119 |
cast<MemberExpr>(Right)->getMemberDecl(); |
| 120 |
case Stmt::CXXFoldExprClass: |
| 121 |
return cast<CXXFoldExpr>(Left)->getOperator() == |
| 122 |
cast<CXXFoldExpr>(Right)->getOperator(); |
| 123 |
case Stmt::CXXFunctionalCastExprClass: |
| 124 |
case Stmt::CStyleCastExprClass: |
| 125 |
return cast<ExplicitCastExpr>(Left)->getTypeAsWritten() == |
| 126 |
cast<ExplicitCastExpr>(Right)->getTypeAsWritten(); |
| 127 |
case Stmt::CallExprClass: |
| 128 |
case Stmt::ImplicitCastExprClass: |
| 129 |
case Stmt::ArraySubscriptExprClass: |
| 130 |
return true; |
| 131 |
case Stmt::UnaryOperatorClass: |
| 132 |
if (cast<UnaryOperator>(Left)->isIncrementDecrementOp()) |
| 133 |
return false; |
| 134 |
return cast<UnaryOperator>(Left)->getOpcode() == |
| 135 |
cast<UnaryOperator>(Right)->getOpcode(); |
| 136 |
case Stmt::BinaryOperatorClass: |
| 137 |
if (cast<BinaryOperator>(Left)->isAssignmentOp()) |
| 138 |
return false; |
| 139 |
return cast<BinaryOperator>(Left)->getOpcode() == |
| 140 |
cast<BinaryOperator>(Right)->getOpcode(); |
| 141 |
case Stmt::UnaryExprOrTypeTraitExprClass: |
| 142 |
const auto *LeftUnaryExpr = |
| 143 |
cast<UnaryExprOrTypeTraitExpr>(Left); |
| 144 |
const auto *RightUnaryExpr = |
| 145 |
cast<UnaryExprOrTypeTraitExpr>(Right); |
| 146 |
if (LeftUnaryExpr->isArgumentType() && RightUnaryExpr->isArgumentType()) |
| 147 |
return LeftUnaryExpr->getKind() == RightUnaryExpr->getKind() && |
| 148 |
LeftUnaryExpr->getArgumentType() == |
| 149 |
RightUnaryExpr->getArgumentType(); |
| 150 |
if (!LeftUnaryExpr->isArgumentType() && !RightUnaryExpr->isArgumentType()) |
| 151 |
return areEquivalentExpr(LeftUnaryExpr->getArgumentExpr(), |
| 152 |
RightUnaryExpr->getArgumentExpr()); |
| 153 |
|
| 154 |
return false; |
| 155 |
} |
| 156 |
} |
| 157 |
|
| 158 |
// For a given expression 'x', returns whether the ranges covered by the |
| 159 |
// relational operators are equivalent (i.e. x <= 4 is equivalent to x < 5). |
| 160 |
static bool areEquivalentRanges(BinaryOperatorKind OpcodeLHS, |
| 161 |
const APSInt &ValueLHS, |
| 162 |
BinaryOperatorKind OpcodeRHS, |
| 163 |
const APSInt &ValueRHS) { |
| 164 |
assert(APSInt::compareValues(ValueLHS, ValueRHS) <= 0 && |
| 165 |
"Values must be ordered"); |
| 166 |
// Handle the case where constants are the same: x <= 4 <==> x <= 4. |
| 167 |
if (APSInt::compareValues(ValueLHS, ValueRHS) == 0) |
| 168 |
return OpcodeLHS == OpcodeRHS; |
| 169 |
|
| 170 |
// Handle the case where constants are off by one: x <= 4 <==> x < 5. |
| 171 |
APSInt ValueLhsPlus1; |
| 172 |
return ((OpcodeLHS == BO_LE && OpcodeRHS == BO_LT) || |
| 173 |
(OpcodeLHS == BO_GT && OpcodeRHS == BO_GE)) && |
| 174 |
incrementWithoutOverflow(ValueLHS, ValueLhsPlus1) && |
| 175 |
APSInt::compareValues(ValueLhsPlus1, ValueRHS) == 0; |
| 176 |
} |
| 177 |
|
| 178 |
// For a given expression 'x', returns whether the ranges covered by the |
| 179 |
// relational operators are fully disjoint (i.e. x < 4 and x > 7). |
| 180 |
static bool areExclusiveRanges(BinaryOperatorKind OpcodeLHS, |
| 181 |
const APSInt &ValueLHS, |
| 182 |
BinaryOperatorKind OpcodeRHS, |
| 183 |
const APSInt &ValueRHS) { |
| 184 |
assert(APSInt::compareValues(ValueLHS, ValueRHS) <= 0 && |
| 185 |
"Values must be ordered"); |
| 186 |
|
| 187 |
// Handle cases where the constants are the same. |
| 188 |
if (APSInt::compareValues(ValueLHS, ValueRHS) == 0) { |
| 189 |
switch (OpcodeLHS) { |
| 190 |
case BO_EQ: |
| 191 |
return OpcodeRHS == BO_NE || OpcodeRHS == BO_GT || OpcodeRHS == BO_LT; |
| 192 |
case BO_NE: |
| 193 |
return OpcodeRHS == BO_EQ; |
| 194 |
case BO_LE: |
| 195 |
return OpcodeRHS == BO_GT; |
| 196 |
case BO_GE: |
| 197 |
return OpcodeRHS == BO_LT; |
| 198 |
case BO_LT: |
| 199 |
return OpcodeRHS == BO_EQ || OpcodeRHS == BO_GT || OpcodeRHS == BO_GE; |
| 200 |
case BO_GT: |
| 201 |
return OpcodeRHS == BO_EQ || OpcodeRHS == BO_LT || OpcodeRHS == BO_LE; |
| 202 |
default: |
| 203 |
return false; |
| 204 |
} |
| 205 |
} |
| 206 |
|
| 207 |
// Handle cases where the constants are different. |
| 208 |
if ((OpcodeLHS == BO_EQ || OpcodeLHS == BO_LT || OpcodeLHS == BO_LE) && |
| 209 |
(OpcodeRHS == BO_EQ || OpcodeRHS == BO_GT || OpcodeRHS == BO_GE)) |
| 210 |
return true; |
| 211 |
|
| 212 |
// Handle the case where constants are off by one: x > 5 && x < 6. |
| 213 |
APSInt ValueLhsPlus1; |
| 214 |
if (OpcodeLHS == BO_GT && OpcodeRHS == BO_LT && |
| 215 |
incrementWithoutOverflow(ValueLHS, ValueLhsPlus1) && |
| 216 |
APSInt::compareValues(ValueLhsPlus1, ValueRHS) == 0) |
| 217 |
return true; |
| 218 |
|
| 219 |
return false; |
| 220 |
} |
| 221 |
|
| 222 |
// Returns whether the ranges covered by the union of both relational |
| 223 |
// expressions cover the whole domain (i.e. x < 10 and x > 0). |
| 224 |
static bool rangesFullyCoverDomain(BinaryOperatorKind OpcodeLHS, |
| 225 |
const APSInt &ValueLHS, |
| 226 |
BinaryOperatorKind OpcodeRHS, |
| 227 |
const APSInt &ValueRHS) { |
| 228 |
assert(APSInt::compareValues(ValueLHS, ValueRHS) <= 0 && |
| 229 |
"Values must be ordered"); |
| 230 |
|
| 231 |
// Handle cases where the constants are the same: x < 5 || x >= 5. |
| 232 |
if (APSInt::compareValues(ValueLHS, ValueRHS) == 0) { |
| 233 |
switch (OpcodeLHS) { |
| 234 |
case BO_EQ: |
| 235 |
return OpcodeRHS == BO_NE; |
| 236 |
case BO_NE: |
| 237 |
return OpcodeRHS == BO_EQ; |
| 238 |
case BO_LE: |
| 239 |
return OpcodeRHS == BO_GT || OpcodeRHS == BO_GE; |
| 240 |
case BO_LT: |
| 241 |
return OpcodeRHS == BO_GE; |
| 242 |
case BO_GE: |
| 243 |
return OpcodeRHS == BO_LT || OpcodeRHS == BO_LE; |
| 244 |
case BO_GT: |
| 245 |
return OpcodeRHS == BO_LE; |
| 246 |
default: |
| 247 |
return false; |
| 248 |
} |
| 249 |
} |
| 250 |
|
| 251 |
// Handle the case where constants are off by one: x <= 4 || x >= 5. |
| 252 |
APSInt ValueLhsPlus1; |
| 253 |
if (OpcodeLHS == BO_LE && OpcodeRHS == BO_GE && |
| 254 |
incrementWithoutOverflow(ValueLHS, ValueLhsPlus1) && |
| 255 |
APSInt::compareValues(ValueLhsPlus1, ValueRHS) == 0) |
| 256 |
return true; |
| 257 |
|
| 258 |
// Handle cases where the constants are different: x > 4 || x <= 7. |
| 259 |
if ((OpcodeLHS == BO_GT || OpcodeLHS == BO_GE) && |
| 260 |
(OpcodeRHS == BO_LT || OpcodeRHS == BO_LE)) |
| 261 |
return true; |
| 262 |
|
| 263 |
// Handle cases where constants are different but both ops are !=, like: |
| 264 |
// x != 5 || x != 10 |
| 265 |
if (OpcodeLHS == BO_NE && OpcodeRHS == BO_NE) |
| 266 |
return true; |
| 267 |
|
| 268 |
return false; |
| 269 |
} |
| 270 |
|
| 271 |
static bool rangeSubsumesRange(BinaryOperatorKind OpcodeLHS, |
| 272 |
const APSInt &ValueLHS, |
| 273 |
BinaryOperatorKind OpcodeRHS, |
| 274 |
const APSInt &ValueRHS) { |
| 275 |
int Comparison = APSInt::compareValues(ValueLHS, ValueRHS); |
| 276 |
switch (OpcodeLHS) { |
| 277 |
case BO_EQ: |
| 278 |
return OpcodeRHS == BO_EQ && Comparison == 0; |
| 279 |
case BO_NE: |
| 280 |
return (OpcodeRHS == BO_NE && Comparison == 0) || |
| 281 |
(OpcodeRHS == BO_EQ && Comparison != 0) || |
| 282 |
(OpcodeRHS == BO_LT && Comparison >= 0) || |
| 283 |
(OpcodeRHS == BO_LE && Comparison > 0) || |
| 284 |
(OpcodeRHS == BO_GT && Comparison <= 0) || |
| 285 |
(OpcodeRHS == BO_GE && Comparison < 0); |
| 286 |
|
| 287 |
case BO_LT: |
| 288 |
return ((OpcodeRHS == BO_LT && Comparison >= 0) || |
| 289 |
(OpcodeRHS == BO_LE && Comparison > 0) || |
| 290 |
(OpcodeRHS == BO_EQ && Comparison > 0)); |
| 291 |
case BO_GT: |
| 292 |
return ((OpcodeRHS == BO_GT && Comparison <= 0) || |
| 293 |
(OpcodeRHS == BO_GE && Comparison < 0) || |
| 294 |
(OpcodeRHS == BO_EQ && Comparison < 0)); |
| 295 |
case BO_LE: |
| 296 |
return (OpcodeRHS == BO_LT || OpcodeRHS == BO_LE || OpcodeRHS == BO_EQ) && |
| 297 |
Comparison >= 0; |
| 298 |
case BO_GE: |
| 299 |
return (OpcodeRHS == BO_GT || OpcodeRHS == BO_GE || OpcodeRHS == BO_EQ) && |
| 300 |
Comparison <= 0; |
| 301 |
default: |
| 302 |
return false; |
| 303 |
} |
| 304 |
} |
| 305 |
|
| 306 |
static void transformSubToCanonicalAddExpr(BinaryOperatorKind &Opcode, |
| 307 |
APSInt &Value) { |
| 308 |
if (Opcode == BO_Sub) { |
| 309 |
Opcode = BO_Add; |
| 310 |
Value = -Value; |
| 311 |
} |
| 312 |
} |
| 313 |
|
| 314 |
// to use in the template below |
| 315 |
static OverloadedOperatorKind getOp(const BinaryOperator *Op) { |
| 316 |
return BinaryOperator::getOverloadedOperator(Op->getOpcode()); |
| 317 |
} |
| 318 |
|
| 319 |
static OverloadedOperatorKind getOp(const CXXOperatorCallExpr *Op) { |
| 320 |
if (Op->getNumArgs() != 2) |
| 321 |
return OO_None; |
| 322 |
return Op->getOperator(); |
| 323 |
} |
| 324 |
|
| 325 |
static std::pair<const Expr *, const Expr *> |
| 326 |
getOperands(const BinaryOperator *Op) { |
| 327 |
return {Op->getLHS()->IgnoreParenImpCasts(), |
| 328 |
Op->getRHS()->IgnoreParenImpCasts()}; |
| 329 |
} |
| 330 |
|
| 331 |
static std::pair<const Expr *, const Expr *> |
| 332 |
getOperands(const CXXOperatorCallExpr *Op) { |
| 333 |
return {Op->getArg(0)->IgnoreParenImpCasts(), |
| 334 |
Op->getArg(1)->IgnoreParenImpCasts()}; |
| 335 |
} |
| 336 |
|
| 337 |
template <typename TExpr> |
| 338 |
static const TExpr *checkOpKind(const Expr *TheExpr, |
| 339 |
OverloadedOperatorKind OpKind) { |
| 340 |
const auto *AsTExpr = dyn_cast_or_null<TExpr>(TheExpr); |
| 341 |
if (AsTExpr && getOp(AsTExpr) == OpKind) |
| 342 |
return AsTExpr; |
| 343 |
|
| 344 |
return nullptr; |
| 345 |
} |
| 346 |
|
| 347 |
// returns true if a subexpression has two directly equivalent operands and |
| 348 |
// is already handled by operands/parametersAreEquivalent |
| 349 |
template <typename TExpr, unsigned N> |
| 350 |
static bool collectOperands(const Expr *Part, |
| 351 |
SmallVector<const Expr *, N> &AllOperands, |
| 352 |
OverloadedOperatorKind OpKind) { |
| 353 |
if (const auto *BinOp = checkOpKind<TExpr>(Part, OpKind)) { |
| 354 |
const std::pair<const Expr *, const Expr *> Operands = getOperands(BinOp); |
| 355 |
if (areEquivalentExpr(Operands.first, Operands.second)) |
| 356 |
return true; |
| 357 |
return collectOperands<TExpr>(Operands.first, AllOperands, OpKind) || |
| 358 |
collectOperands<TExpr>(Operands.second, AllOperands, OpKind); |
| 359 |
} |
| 360 |
|
| 361 |
AllOperands.push_back(Part); |
| 362 |
return false; |
| 363 |
} |
| 364 |
|
| 365 |
template <typename TExpr> |
| 366 |
static bool hasSameOperatorParent(const Expr *TheExpr, |
| 367 |
OverloadedOperatorKind OpKind, |
| 368 |
ASTContext &Context) { |
| 369 |
// IgnoreParenImpCasts logic in reverse: skip surrounding uninteresting nodes |
| 370 |
const DynTypedNodeList Parents = Context.getParents(*TheExpr); |
| 371 |
for (DynTypedNode DynParent : Parents) { |
| 372 |
if (const auto *Parent = DynParent.get<Expr>()) { |
| 373 |
bool Skip = isa<ParenExpr>(Parent) || isa<ImplicitCastExpr>(Parent) || |
| 374 |
isa<FullExpr>(Parent) || |
| 375 |
isa<MaterializeTemporaryExpr>(Parent); |
| 376 |
if (Skip && hasSameOperatorParent<TExpr>(Parent, OpKind, Context)) |
| 377 |
return true; |
| 378 |
if (checkOpKind<TExpr>(Parent, OpKind)) |
| 379 |
return true; |
| 380 |
} |
| 381 |
} |
| 382 |
|
| 383 |
return false; |
| 384 |
} |
| 385 |
|
| 386 |
template <typename TExpr> |
| 387 |
static bool |
| 388 |
markDuplicateOperands(const TExpr *TheExpr, |
| 389 |
ast_matchers::internal::BoundNodesTreeBuilder *Builder, |
| 390 |
ASTContext &Context) { |
| 391 |
const OverloadedOperatorKind OpKind = getOp(TheExpr); |
| 392 |
if (OpKind == OO_None) |
| 393 |
return false; |
| 394 |
// if there are no nested operators of the same kind, it's handled by |
| 395 |
// operands/parametersAreEquivalent |
| 396 |
const std::pair<const Expr *, const Expr *> Operands = getOperands(TheExpr); |
| 397 |
if (!(checkOpKind<TExpr>(Operands.first, OpKind) || |
| 398 |
checkOpKind<TExpr>(Operands.second, OpKind))) |
| 399 |
return false; |
| 400 |
|
| 401 |
// if parent is the same kind of operator, it's handled by a previous call to |
| 402 |
// markDuplicateOperands |
| 403 |
if (hasSameOperatorParent<TExpr>(TheExpr, OpKind, Context)) |
| 404 |
return false; |
| 405 |
|
| 406 |
SmallVector<const Expr *, 4> AllOperands; |
| 407 |
if (collectOperands<TExpr>(Operands.first, AllOperands, OpKind)) |
| 408 |
return false; |
| 409 |
if (collectOperands<TExpr>(Operands.second, AllOperands, OpKind)) |
| 410 |
return false; |
| 411 |
size_t NumOperands = AllOperands.size(); |
| 412 |
llvm::SmallBitVector Duplicates(NumOperands); |
| 413 |
for (size_t I = 0; I < NumOperands; I++) { |
| 414 |
if (Duplicates[I]) |
| 415 |
continue; |
| 416 |
bool FoundDuplicates = false; |
| 417 |
|
| 418 |
for (size_t J = I + 1; J < NumOperands; J++) { |
| 419 |
if (AllOperands[J]->HasSideEffects(Context)) |
| 420 |
break; |
| 421 |
|
| 422 |
if (areEquivalentExpr(AllOperands[I], AllOperands[J])) { |
| 423 |
FoundDuplicates = true; |
| 424 |
Duplicates.set(J); |
| 425 |
Builder->setBinding(SmallString<11>(llvm::formatv("duplicate{0}", J)), |
| 426 |
DynTypedNode::create(*AllOperands[J])); |
| 427 |
} |
| 428 |
} |
| 429 |
|
| 430 |
if (FoundDuplicates) |
| 431 |
Builder->setBinding(SmallString<11>(llvm::formatv("duplicate{0}", I)), |
| 432 |
DynTypedNode::create(*AllOperands[I])); |
| 433 |
} |
| 434 |
|
| 435 |
return Duplicates.any(); |
| 436 |
} |
| 437 |
|
| 438 |
AST_MATCHER(Expr, isIntegerConstantExpr) { |
| 439 |
if (Node.isInstantiationDependent()) |
| 440 |
return false; |
| 441 |
return Node.isIntegerConstantExpr(Finder->getASTContext()); |
| 442 |
} |
| 443 |
|
| 444 |
AST_MATCHER(BinaryOperator, operandsAreEquivalent) { |
| 445 |
return areEquivalentExpr(Node.getLHS(), Node.getRHS()); |
| 446 |
} |
| 447 |
|
| 448 |
AST_MATCHER(BinaryOperator, nestedOperandsAreEquivalent) { |
| 449 |
return markDuplicateOperands(&Node, Builder, Finder->getASTContext()); |
| 450 |
} |
| 451 |
|
| 452 |
AST_MATCHER(ConditionalOperator, expressionsAreEquivalent) { |
| 453 |
return areEquivalentExpr(Node.getTrueExpr(), Node.getFalseExpr()); |
| 454 |
} |
| 455 |
|
| 456 |
AST_MATCHER(CallExpr, parametersAreEquivalent) { |
| 457 |
return Node.getNumArgs() == 2 && |
| 458 |
areEquivalentExpr(Node.getArg(0), Node.getArg(1)); |
| 459 |
} |
| 460 |
|
| 461 |
AST_MATCHER(CXXOperatorCallExpr, nestedParametersAreEquivalent) { |
| 462 |
return markDuplicateOperands(&Node, Builder, Finder->getASTContext()); |
| 463 |
} |
| 464 |
|
| 465 |
AST_MATCHER(BinaryOperator, binaryOperatorIsInMacro) { |
| 466 |
return Node.getOperatorLoc().isMacroID(); |
| 467 |
} |
| 468 |
|
| 469 |
AST_MATCHER(ConditionalOperator, conditionalOperatorIsInMacro) { |
| 470 |
return Node.getQuestionLoc().isMacroID() || Node.getColonLoc().isMacroID(); |
| 471 |
} |
| 472 |
|
| 473 |
AST_MATCHER(Expr, isMacro) { return Node.getExprLoc().isMacroID(); } |
| 474 |
|
| 475 |
AST_MATCHER_P(Expr, expandedByMacro, ArrayRef<llvm::StringLiteral>, Names) { |
| 476 |
const SourceManager &SM = Finder->getASTContext().getSourceManager(); |
| 477 |
const LangOptions &LO = Finder->getASTContext().getLangOpts(); |
| 478 |
SourceLocation Loc = Node.getExprLoc(); |
| 479 |
while (Loc.isMacroID()) { |
| 480 |
StringRef MacroName = Lexer::getImmediateMacroName(Loc, SM, LO); |
| 481 |
if (llvm::is_contained(Names, MacroName)) |
| 482 |
return true; |
| 483 |
Loc = SM.getImmediateMacroCallerLoc(Loc); |
| 484 |
} |
| 485 |
return false; |
| 486 |
} |
| 487 |
|
| 488 |
// Returns a matcher for integer constant expressions. |
| 489 |
static ast_matchers::internal::Matcher<Expr> |
| 490 |
matchIntegerConstantExpr(StringRef Id) { |
| 491 |
std::string CstId = (Id + "-const").str(); |
| 492 |
return expr(isIntegerConstantExpr()).bind(CstId); |
| 493 |
} |
| 494 |
|
| 495 |
// Retrieves the integer expression matched by 'matchIntegerConstantExpr' with |
| 496 |
// name 'Id' and stores it into 'ConstExpr', the value of the expression is |
| 497 |
// stored into `Value`. |
| 498 |
static bool retrieveIntegerConstantExpr(const MatchFinder::MatchResult &Result, |
| 499 |
StringRef Id, APSInt &Value, |
| 500 |
const Expr *&ConstExpr) { |
| 501 |
std::string CstId = (Id + "-const").str(); |
| 502 |
ConstExpr = Result.Nodes.getNodeAs<Expr>(CstId); |
| 503 |
if (!ConstExpr) |
| 504 |
return false; |
| 505 |
std::optional<llvm::APSInt> R = |
| 506 |
ConstExpr->getIntegerConstantExpr(*Result.Context); |
| 507 |
if (!R) |
| 508 |
return false; |
| 509 |
Value = *R; |
| 510 |
return true; |
| 511 |
} |
| 512 |
|
| 513 |
// Overloaded `retrieveIntegerConstantExpr` for compatibility. |
| 514 |
static bool retrieveIntegerConstantExpr(const MatchFinder::MatchResult &Result, |
| 515 |
StringRef Id, APSInt &Value) { |
| 516 |
const Expr *ConstExpr = nullptr; |
| 517 |
return retrieveIntegerConstantExpr(Result, Id, Value, ConstExpr); |
| 518 |
} |
| 519 |
|
| 520 |
// Returns a matcher for symbolic expressions (matches every expression except |
| 521 |
// ingeter constant expressions). |
| 522 |
static ast_matchers::internal::Matcher<Expr> matchSymbolicExpr(StringRef Id) { |
| 523 |
std::string SymId = (Id + "-sym").str(); |
| 524 |
return ignoringParenImpCasts( |
| 525 |
expr(unless(isIntegerConstantExpr())).bind(SymId)); |
| 526 |
} |
| 527 |
|
| 528 |
// Retrieves the expression matched by 'matchSymbolicExpr' with name 'Id' and |
| 529 |
// stores it into 'SymExpr'. |
| 530 |
static bool retrieveSymbolicExpr(const MatchFinder::MatchResult &Result, |
| 531 |
StringRef Id, const Expr *&SymExpr) { |
| 532 |
std::string SymId = (Id + "-sym").str(); |
| 533 |
if (const auto *Node = Result.Nodes.getNodeAs<Expr>(SymId)) { |
| 534 |
SymExpr = Node; |
| 535 |
return true; |
| 536 |
} |
| 537 |
return false; |
| 538 |
} |
| 539 |
|
| 540 |
// Match a binary operator between a symbolic expression and an integer constant |
| 541 |
// expression. |
| 542 |
static ast_matchers::internal::Matcher<Expr> |
| 543 |
matchBinOpIntegerConstantExpr(StringRef Id) { |
| 544 |
const auto BinOpCstExpr = |
| 545 |
expr(anyOf(binaryOperator(hasAnyOperatorName("+", "|", "&"), |
| 546 |
hasOperands(matchSymbolicExpr(Id), |
| 547 |
matchIntegerConstantExpr(Id))), |
| 548 |
binaryOperator(hasOperatorName("-"), |
| 549 |
hasLHS(matchSymbolicExpr(Id)), |
| 550 |
hasRHS(matchIntegerConstantExpr(Id))))) |
| 551 |
.bind(Id); |
| 552 |
return ignoringParenImpCasts(BinOpCstExpr); |
| 553 |
} |
| 554 |
|
| 555 |
// Retrieves sub-expressions matched by 'matchBinOpIntegerConstantExpr' with |
| 556 |
// name 'Id'. |
| 557 |
static bool |
| 558 |
retrieveBinOpIntegerConstantExpr(const MatchFinder::MatchResult &Result, |
| 559 |
StringRef Id, BinaryOperatorKind &Opcode, |
| 560 |
const Expr *&Symbol, APSInt &Value) { |
| 561 |
if (const auto *BinExpr = Result.Nodes.getNodeAs<BinaryOperator>(Id)) { |
| 562 |
Opcode = BinExpr->getOpcode(); |
| 563 |
return retrieveSymbolicExpr(Result, Id, Symbol) && |
| 564 |
retrieveIntegerConstantExpr(Result, Id, Value); |
| 565 |
} |
| 566 |
return false; |
| 567 |
} |
| 568 |
|
| 569 |
// Matches relational expressions: 'Expr <op> k' (i.e. x < 2, x != 3, 12 <= x). |
| 570 |
static ast_matchers::internal::Matcher<Expr> |
| 571 |
matchRelationalIntegerConstantExpr(StringRef Id) { |
| 572 |
std::string CastId = (Id + "-cast").str(); |
| 573 |
std::string SwapId = (Id + "-swap").str(); |
| 574 |
std::string NegateId = (Id + "-negate").str(); |
| 575 |
std::string OverloadId = (Id + "-overload").str(); |
| 576 |
std::string ConstId = (Id + "-const").str(); |
| 577 |
|
| 578 |
const auto RelationalExpr = ignoringParenImpCasts(binaryOperator( |
| 579 |
isComparisonOperator(), expr().bind(Id), |
| 580 |
anyOf(allOf(hasLHS(matchSymbolicExpr(Id)), |
| 581 |
hasRHS(matchIntegerConstantExpr(Id))), |
| 582 |
allOf(hasLHS(matchIntegerConstantExpr(Id)), |
| 583 |
hasRHS(matchSymbolicExpr(Id)), expr().bind(SwapId))))); |
| 584 |
|
| 585 |
// A cast can be matched as a comparator to zero. (i.e. if (x) is equivalent |
| 586 |
// to if (x != 0)). |
| 587 |
const auto CastExpr = |
| 588 |
implicitCastExpr(hasCastKind(CK_IntegralToBoolean), |
| 589 |
hasSourceExpression(matchSymbolicExpr(Id))) |
| 590 |
.bind(CastId); |
| 591 |
|
| 592 |
const auto NegateRelationalExpr = |
| 593 |
unaryOperator(hasOperatorName("!"), |
| 594 |
hasUnaryOperand(anyOf(CastExpr, RelationalExpr))) |
| 595 |
.bind(NegateId); |
| 596 |
|
| 597 |
// Do not bind to double negation. |
| 598 |
const auto NegateNegateRelationalExpr = |
| 599 |
unaryOperator(hasOperatorName("!"), |
| 600 |
hasUnaryOperand(unaryOperator( |
| 601 |
hasOperatorName("!"), |
| 602 |
hasUnaryOperand(anyOf(CastExpr, RelationalExpr))))); |
| 603 |
|
| 604 |
const auto OverloadedOperatorExpr = |
| 605 |
cxxOperatorCallExpr( |
| 606 |
hasAnyOverloadedOperatorName("==", "!=", "<", "<=", ">", ">="), |
| 607 |
// Filter noisy false positives. |
| 608 |
unless(isMacro()), unless(isInTemplateInstantiation()), |
| 609 |
anyOf(hasLHS(ignoringParenImpCasts(integerLiteral().bind(ConstId))), |
| 610 |
hasRHS(ignoringParenImpCasts(integerLiteral().bind(ConstId))))) |
| 611 |
.bind(OverloadId); |
| 612 |
|
| 613 |
return anyOf(RelationalExpr, CastExpr, NegateRelationalExpr, |
| 614 |
NegateNegateRelationalExpr, OverloadedOperatorExpr); |
| 615 |
} |
| 616 |
|
| 617 |
// Checks whether a function param is non constant reference type, and may |
| 618 |
// be modified in the function. |
| 619 |
static bool isNonConstReferenceType(QualType ParamType) { |
| 620 |
return ParamType->isReferenceType() && |
| 621 |
!ParamType.getNonReferenceType().isConstQualified(); |
| 622 |
} |
| 623 |
|
| 624 |
// Checks whether the arguments of an overloaded operator can be modified in the |
| 625 |
// function. |
| 626 |
// For operators that take an instance and a constant as arguments, only the |
| 627 |
// first argument (the instance) needs to be checked, since the constant itself |
| 628 |
// is a temporary expression. Whether the second parameter is checked is |
| 629 |
// controlled by the parameter `ParamsToCheckCount`. |
| 630 |
static bool |
| 631 |
canOverloadedOperatorArgsBeModified(const CXXOperatorCallExpr *OperatorCall, |
| 632 |
bool CheckSecondParam) { |
| 633 |
const auto *OperatorDecl = |
| 634 |
dyn_cast_or_null<FunctionDecl>(OperatorCall->getCalleeDecl()); |
| 635 |
// if we can't find the declaration, conservatively assume it can modify |
| 636 |
// arguments |
| 637 |
if (!OperatorDecl) |
| 638 |
return true; |
| 639 |
|
| 640 |
unsigned ParamCount = OperatorDecl->getNumParams(); |
| 641 |
|
| 642 |
// Overloaded operators declared inside a class have only one param. |
| 643 |
// These functions must be declared const in order to not be able to modify |
| 644 |
// the instance of the class they are called through. |
| 645 |
if (ParamCount == 1 && |
| 646 |
!OperatorDecl->getType()->castAs<FunctionType>()->isConst()) |
| 647 |
return true; |
| 648 |
|
| 649 |
if (isNonConstReferenceType(OperatorDecl->getParamDecl(0)->getType())) |
| 650 |
return true; |
| 651 |
|
| 652 |
return CheckSecondParam && ParamCount == 2 && |
| 653 |
isNonConstReferenceType(OperatorDecl->getParamDecl(1)->getType()); |
| 654 |
} |
| 655 |
|
| 656 |
// Retrieves sub-expressions matched by 'matchRelationalIntegerConstantExpr' |
| 657 |
// with name 'Id'. |
| 658 |
static bool retrieveRelationalIntegerConstantExpr( |
| 659 |
const MatchFinder::MatchResult &Result, StringRef Id, |
| 660 |
const Expr *&OperandExpr, BinaryOperatorKind &Opcode, const Expr *&Symbol, |
| 661 |
APSInt &Value, const Expr *&ConstExpr) { |
| 662 |
std::string CastId = (Id + "-cast").str(); |
| 663 |
std::string SwapId = (Id + "-swap").str(); |
| 664 |
std::string NegateId = (Id + "-negate").str(); |
| 665 |
std::string OverloadId = (Id + "-overload").str(); |
| 666 |
|
| 667 |
if (const auto *Bin = Result.Nodes.getNodeAs<BinaryOperator>(Id)) { |
| 668 |
// Operand received with explicit comparator. |
| 669 |
Opcode = Bin->getOpcode(); |
| 670 |
OperandExpr = Bin; |
| 671 |
|
| 672 |
if (!retrieveIntegerConstantExpr(Result, Id, Value, ConstExpr)) |
| 673 |
return false; |
| 674 |
} else if (const auto *Cast = Result.Nodes.getNodeAs<CastExpr>(CastId)) { |
| 675 |
// Operand received with implicit comparator (cast). |
| 676 |
Opcode = BO_NE; |
| 677 |
OperandExpr = Cast; |
| 678 |
Value = APSInt(32, false); |
| 679 |
} else if (const auto *OverloadedOperatorExpr = |
| 680 |
Result.Nodes.getNodeAs<CXXOperatorCallExpr>(OverloadId)) { |
| 681 |
if (canOverloadedOperatorArgsBeModified(OverloadedOperatorExpr, false)) |
| 682 |
return false; |
| 683 |
|
| 684 |
bool IntegerConstantIsFirstArg = false; |
| 685 |
|
| 686 |
if (const auto *Arg = OverloadedOperatorExpr->getArg(1)) { |
| 687 |
if (!Arg->isValueDependent() && |
| 688 |
!Arg->isIntegerConstantExpr(*Result.Context)) { |
| 689 |
IntegerConstantIsFirstArg = true; |
| 690 |
if (const auto *Arg = OverloadedOperatorExpr->getArg(0)) { |
| 691 |
if (!Arg->isValueDependent() && |
| 692 |
!Arg->isIntegerConstantExpr(*Result.Context)) |
| 693 |
return false; |
| 694 |
} else |
| 695 |
return false; |
| 696 |
} |
| 697 |
} else |
| 698 |
return false; |
| 699 |
|
| 700 |
Symbol = OverloadedOperatorExpr->getArg(IntegerConstantIsFirstArg ? 1 : 0); |
| 701 |
OperandExpr = OverloadedOperatorExpr; |
| 702 |
Opcode = BinaryOperator::getOverloadedOpcode(OverloadedOperatorExpr->getOperator()); |
| 703 |
|
| 704 |
if (!retrieveIntegerConstantExpr(Result, Id, Value, ConstExpr)) |
| 705 |
return false; |
| 706 |
|
| 707 |
if (!BinaryOperator::isComparisonOp(Opcode)) |
| 708 |
return false; |
| 709 |
|
| 710 |
// The call site of this function expects the constant on the RHS, |
| 711 |
// so change the opcode accordingly. |
| 712 |
if (IntegerConstantIsFirstArg) |
| 713 |
Opcode = BinaryOperator::reverseComparisonOp(Opcode); |
| 714 |
|
| 715 |
return true; |
| 716 |
} else { |
| 717 |
return false; |
| 718 |
} |
| 719 |
|
| 720 |
if (!retrieveSymbolicExpr(Result, Id, Symbol)) |
| 721 |
return false; |
| 722 |
|
| 723 |
if (Result.Nodes.getNodeAs<Expr>(SwapId)) |
| 724 |
Opcode = BinaryOperator::reverseComparisonOp(Opcode); |
| 725 |
if (Result.Nodes.getNodeAs<Expr>(NegateId)) |
| 726 |
Opcode = BinaryOperator::negateComparisonOp(Opcode); |
| 727 |
return true; |
| 728 |
} |
| 729 |
|
| 730 |
// Checks for expressions like (X == 4) && (Y != 9) |
| 731 |
static bool areSidesBinaryConstExpressions(const BinaryOperator *&BinOp, const ASTContext *AstCtx) { |
| 732 |
const auto *LhsBinOp = dyn_cast<BinaryOperator>(BinOp->getLHS()); |
| 733 |
const auto *RhsBinOp = dyn_cast<BinaryOperator>(BinOp->getRHS()); |
| 734 |
|
| 735 |
if (!LhsBinOp || !RhsBinOp) |
| 736 |
return false; |
| 737 |
|
| 738 |
auto IsIntegerConstantExpr = [AstCtx](const Expr *E) { |
| 739 |
return !E->isValueDependent() && E->isIntegerConstantExpr(*AstCtx); |
| 740 |
}; |
| 741 |
|
| 742 |
if ((IsIntegerConstantExpr(LhsBinOp->getLHS()) || |
| 743 |
IsIntegerConstantExpr(LhsBinOp->getRHS())) && |
| 744 |
(IsIntegerConstantExpr(RhsBinOp->getLHS()) || |
| 745 |
IsIntegerConstantExpr(RhsBinOp->getRHS()))) |
| 746 |
return true; |
| 747 |
return false; |
| 748 |
} |
| 749 |
|
| 750 |
// Retrieves integer constant subexpressions from binary operator expressions |
| 751 |
// that have two equivalent sides. |
| 752 |
// E.g.: from (X == 5) && (X == 5) retrieves 5 and 5. |
| 753 |
static bool retrieveConstExprFromBothSides(const BinaryOperator *&BinOp, |
| 754 |
BinaryOperatorKind &MainOpcode, |
| 755 |
BinaryOperatorKind &SideOpcode, |
| 756 |
const Expr *&LhsConst, |
| 757 |
const Expr *&RhsConst, |
| 758 |
const ASTContext *AstCtx) { |
| 759 |
assert(areSidesBinaryConstExpressions(BinOp, AstCtx) && |
| 760 |
"Both sides of binary operator must be constant expressions!"); |
| 761 |
|
| 762 |
MainOpcode = BinOp->getOpcode(); |
| 763 |
|
| 764 |
const auto *BinOpLhs = cast<BinaryOperator>(BinOp->getLHS()); |
| 765 |
const auto *BinOpRhs = cast<BinaryOperator>(BinOp->getRHS()); |
| 766 |
|
| 767 |
auto IsIntegerConstantExpr = [AstCtx](const Expr *E) { |
| 768 |
return !E->isValueDependent() && E->isIntegerConstantExpr(*AstCtx); |
| 769 |
}; |
| 770 |
|
| 771 |
LhsConst = IsIntegerConstantExpr(BinOpLhs->getLHS()) ? BinOpLhs->getLHS() |
| 772 |
: BinOpLhs->getRHS(); |
| 773 |
RhsConst = IsIntegerConstantExpr(BinOpRhs->getLHS()) ? BinOpRhs->getLHS() |
| 774 |
: BinOpRhs->getRHS(); |
| 775 |
|
| 776 |
if (!LhsConst || !RhsConst) |
| 777 |
return false; |
| 778 |
|
| 779 |
assert(BinOpLhs->getOpcode() == BinOpRhs->getOpcode() && |
| 780 |
"Sides of the binary operator must be equivalent expressions!"); |
| 781 |
|
| 782 |
SideOpcode = BinOpLhs->getOpcode(); |
| 783 |
|
| 784 |
return true; |
| 785 |
} |
| 786 |
|
| 787 |
static bool isSameRawIdentifierToken(const Token &T1, const Token &T2, |
| 788 |
const SourceManager &SM) { |
| 789 |
if (T1.getKind() != T2.getKind()) |
| 790 |
return false; |
| 791 |
if (T1.isNot(tok::raw_identifier)) |
| 792 |
return true; |
| 793 |
if (T1.getLength() != T2.getLength()) |
| 794 |
return false; |
| 795 |
return StringRef(SM.getCharacterData(T1.getLocation()), T1.getLength()) == |
| 796 |
StringRef(SM.getCharacterData(T2.getLocation()), T2.getLength()); |
| 797 |
} |
| 798 |
|
| 799 |
bool isTokAtEndOfExpr(SourceRange ExprSR, Token T, const SourceManager &SM) { |
| 800 |
return SM.getExpansionLoc(ExprSR.getEnd()) == T.getLocation(); |
| 801 |
} |
| 802 |
|
| 803 |
/// Returns true if both LhsExpr and RhsExpr are |
| 804 |
/// macro expressions and they are expanded |
| 805 |
/// from different macros. |
| 806 |
static bool areExprsFromDifferentMacros(const Expr *LhsExpr, |
| 807 |
const Expr *RhsExpr, |
| 808 |
const ASTContext *AstCtx) { |
| 809 |
if (!LhsExpr || !RhsExpr) |
| 810 |
return false; |
| 811 |
SourceRange Lsr = LhsExpr->getSourceRange(); |
| 812 |
SourceRange Rsr = RhsExpr->getSourceRange(); |
| 813 |
if (!Lsr.getBegin().isMacroID() || !Rsr.getBegin().isMacroID()) |
| 814 |
return false; |
| 815 |
|
| 816 |
const SourceManager &SM = AstCtx->getSourceManager(); |
| 817 |
const LangOptions &LO = AstCtx->getLangOpts(); |
| 818 |
|
| 819 |
std::pair<FileID, unsigned> LsrLocInfo = |
| 820 |
SM.getDecomposedLoc(SM.getExpansionLoc(Lsr.getBegin())); |
| 821 |
std::pair<FileID, unsigned> RsrLocInfo = |
| 822 |
SM.getDecomposedLoc(SM.getExpansionLoc(Rsr.getBegin())); |
| 823 |
llvm::MemoryBufferRef MB = SM.getBufferOrFake(LsrLocInfo.first); |
| 824 |
|
| 825 |
const char *LTokenPos = MB.getBufferStart() + LsrLocInfo.second; |
| 826 |
const char *RTokenPos = MB.getBufferStart() + RsrLocInfo.second; |
| 827 |
Lexer LRawLex(SM.getLocForStartOfFile(LsrLocInfo.first), LO, |
| 828 |
MB.getBufferStart(), LTokenPos, MB.getBufferEnd()); |
| 829 |
Lexer RRawLex(SM.getLocForStartOfFile(RsrLocInfo.first), LO, |
| 830 |
MB.getBufferStart(), RTokenPos, MB.getBufferEnd()); |
| 831 |
|
| 832 |
Token LTok, RTok; |
| 833 |
do { // Compare the expressions token-by-token. |
| 834 |
LRawLex.LexFromRawLexer(LTok); |
| 835 |
RRawLex.LexFromRawLexer(RTok); |
| 836 |
} while (!LTok.is(tok::eof) && !RTok.is(tok::eof) && |
| 837 |
isSameRawIdentifierToken(LTok, RTok, SM) && |
| 838 |
!isTokAtEndOfExpr(Lsr, LTok, SM) && |
| 839 |
!isTokAtEndOfExpr(Rsr, RTok, SM)); |
| 840 |
return (!isTokAtEndOfExpr(Lsr, LTok, SM) || |
| 841 |
!isTokAtEndOfExpr(Rsr, RTok, SM)) || |
| 842 |
!isSameRawIdentifierToken(LTok, RTok, SM); |
| 843 |
} |
| 844 |
|
| 845 |
static bool areExprsMacroAndNonMacro(const Expr *&LhsExpr, |
| 846 |
const Expr *&RhsExpr) { |
| 847 |
if (!LhsExpr || !RhsExpr) |
| 848 |
return false; |
| 849 |
|
| 850 |
SourceLocation LhsLoc = LhsExpr->getExprLoc(); |
| 851 |
SourceLocation RhsLoc = RhsExpr->getExprLoc(); |
| 852 |
|
| 853 |
return LhsLoc.isMacroID() != RhsLoc.isMacroID(); |
| 854 |
} |
| 855 |
} // namespace |
| 856 |
|
| 857 |
void RedundantExpressionCheck::registerMatchers(MatchFinder *Finder) { |
| 858 |
const auto AnyLiteralExpr = ignoringParenImpCasts( |
| 859 |
anyOf(cxxBoolLiteral(), characterLiteral(), integerLiteral())); |
| 860 |
|
| 861 |
const auto BannedIntegerLiteral = |
| 862 |
integerLiteral(expandedByMacro(KnownBannedMacroNames)); |
| 863 |
const auto IsInUnevaluatedContext = expr(anyOf( |
| 864 |
hasAncestor(expr(hasUnevaluatedContext())), hasAncestor(typeLoc()))); |
| 865 |
|
| 866 |
// Binary with equivalent operands, like (X != 2 && X != 2). |
| 867 |
Finder->addMatcher( |
| 868 |
traverse(TK_AsIs, |
| 869 |
binaryOperator( |
| 870 |
anyOf(isComparisonOperator(), |
| 871 |
hasAnyOperatorName("-", "/", "%", "|", "&", "^", "&&", |
| 872 |
"||", "=")), |
| 873 |
operandsAreEquivalent(), |
| 874 |
// Filter noisy false positives. |
| 875 |
unless(isInTemplateInstantiation()), |
| 876 |
unless(binaryOperatorIsInMacro()), |
| 877 |
unless(hasType(realFloatingPointType())), |
| 878 |
unless(hasEitherOperand(hasType(realFloatingPointType()))), |
| 879 |
unless(hasLHS(AnyLiteralExpr)), |
| 880 |
unless(hasDescendant(BannedIntegerLiteral)), |
| 881 |
unless(IsInUnevaluatedContext)) |
| 882 |
.bind("binary")), |
| 883 |
this); |
| 884 |
|
| 885 |
// Logical or bitwise operator with equivalent nested operands, like (X && Y |
| 886 |
// && X) or (X && (Y && X)) |
| 887 |
Finder->addMatcher( |
| 888 |
binaryOperator(hasAnyOperatorName("|", "&", "||", "&&", "^"), |
| 889 |
nestedOperandsAreEquivalent(), |
| 890 |
// Filter noisy false positives. |
| 891 |
unless(isInTemplateInstantiation()), |
| 892 |
unless(binaryOperatorIsInMacro()), |
| 893 |
// TODO: if the banned macros are themselves duplicated |
| 894 |
unless(hasDescendant(BannedIntegerLiteral)), |
| 895 |
unless(IsInUnevaluatedContext)) |
| 896 |
.bind("nested-duplicates"), |
| 897 |
this); |
| 898 |
|
| 899 |
// Conditional (ternary) operator with equivalent operands, like (Y ? X : X). |
| 900 |
Finder->addMatcher( |
| 901 |
traverse(TK_AsIs, |
| 902 |
conditionalOperator(expressionsAreEquivalent(), |
| 903 |
// Filter noisy false positives. |
| 904 |
unless(conditionalOperatorIsInMacro()), |
| 905 |
unless(isInTemplateInstantiation()), |
| 906 |
unless(IsInUnevaluatedContext)) |
| 907 |
.bind("cond")), |
| 908 |
this); |
| 909 |
|
| 910 |
// Overloaded operators with equivalent operands. |
| 911 |
Finder->addMatcher( |
| 912 |
traverse(TK_AsIs, |
| 913 |
cxxOperatorCallExpr( |
| 914 |
hasAnyOverloadedOperatorName("-", "/", "%", "|", "&", "^", |
| 915 |
"==", "!=", "<", "<=", ">", |
| 916 |
">=", "&&", "||", "="), |
| 917 |
parametersAreEquivalent(), |
| 918 |
// Filter noisy false positives. |
| 919 |
unless(isMacro()), unless(isInTemplateInstantiation()), |
| 920 |
unless(IsInUnevaluatedContext)) |
| 921 |
.bind("call")), |
| 922 |
this); |
| 923 |
|
| 924 |
// Overloaded operators with equivalent operands. |
| 925 |
Finder->addMatcher( |
| 926 |
cxxOperatorCallExpr( |
| 927 |
hasAnyOverloadedOperatorName("|", "&", "||", "&&", "^"), |
| 928 |
nestedParametersAreEquivalent(), argumentCountIs(2), |
| 929 |
// Filter noisy false positives. |
| 930 |
unless(isMacro()), unless(isInTemplateInstantiation()), |
| 931 |
unless(IsInUnevaluatedContext)) |
| 932 |
.bind("nested-duplicates"), |
| 933 |
this); |
| 934 |
|
| 935 |
// Match expressions like: !(1 | 2 | 3) |
| 936 |
Finder->addMatcher( |
| 937 |
traverse(TK_AsIs, |
| 938 |
implicitCastExpr( |
| 939 |
hasImplicitDestinationType(isInteger()), |
| 940 |
has(unaryOperator( |
| 941 |
hasOperatorName("!"), |
| 942 |
hasUnaryOperand(ignoringParenImpCasts(binaryOperator( |
| 943 |
hasAnyOperatorName("|", "&"), |
| 944 |
hasLHS(anyOf( |
| 945 |
binaryOperator(hasAnyOperatorName("|", "&")), |
| 946 |
integerLiteral())), |
| 947 |
hasRHS(integerLiteral()))))) |
| 948 |
.bind("logical-bitwise-confusion")), |
| 949 |
unless(IsInUnevaluatedContext))), |
| 950 |
this); |
| 951 |
|
| 952 |
// Match expressions like: (X << 8) & 0xFF |
| 953 |
Finder->addMatcher( |
| 954 |
traverse(TK_AsIs, |
| 955 |
binaryOperator( |
| 956 |
hasOperatorName("&"), |
| 957 |
hasOperands(ignoringParenImpCasts(binaryOperator( |
| 958 |
hasOperatorName("<<"), |
| 959 |
hasRHS(ignoringParenImpCasts( |
| 960 |
integerLiteral().bind("shift-const"))))), |
| 961 |
ignoringParenImpCasts( |
| 962 |
integerLiteral().bind("and-const"))), |
| 963 |
unless(IsInUnevaluatedContext)) |
| 964 |
.bind("left-right-shift-confusion")), |
| 965 |
this); |
| 966 |
|
| 967 |
// Match common expressions and apply more checks to find redundant |
| 968 |
// sub-expressions. |
| 969 |
// a) Expr <op> K1 == K2 |
| 970 |
// b) Expr <op> K1 == Expr |
| 971 |
// c) Expr <op> K1 == Expr <op> K2 |
| 972 |
// see: 'checkArithmeticExpr' and 'checkBitwiseExpr' |
| 973 |
const auto BinOpCstLeft = matchBinOpIntegerConstantExpr("lhs"); |
| 974 |
const auto BinOpCstRight = matchBinOpIntegerConstantExpr("rhs"); |
| 975 |
const auto CstRight = matchIntegerConstantExpr("rhs"); |
| 976 |
const auto SymRight = matchSymbolicExpr("rhs"); |
| 977 |
|
| 978 |
// Match expressions like: x <op> 0xFF == 0xF00. |
| 979 |
Finder->addMatcher( |
| 980 |
traverse(TK_AsIs, binaryOperator(isComparisonOperator(), |
| 981 |
hasOperands(BinOpCstLeft, CstRight), |
| 982 |
unless(IsInUnevaluatedContext)) |
| 983 |
.bind("binop-const-compare-to-const")), |
| 984 |
this); |
| 985 |
|
| 986 |
// Match expressions like: x <op> 0xFF == x. |
| 987 |
Finder->addMatcher( |
| 988 |
traverse( |
| 989 |
TK_AsIs, |
| 990 |
binaryOperator(isComparisonOperator(), |
| 991 |
anyOf(allOf(hasLHS(BinOpCstLeft), hasRHS(SymRight)), |
| 992 |
allOf(hasLHS(SymRight), hasRHS(BinOpCstLeft))), |
| 993 |
unless(IsInUnevaluatedContext)) |
| 994 |
.bind("binop-const-compare-to-sym")), |
| 995 |
this); |
| 996 |
|
| 997 |
// Match expressions like: x <op> 10 == x <op> 12. |
| 998 |
Finder->addMatcher( |
| 999 |
traverse(TK_AsIs, |
| 1000 |
binaryOperator(isComparisonOperator(), hasLHS(BinOpCstLeft), |
| 1001 |
hasRHS(BinOpCstRight), |
| 1002 |
// Already reported as redundant. |
| 1003 |
unless(operandsAreEquivalent()), |
| 1004 |
unless(IsInUnevaluatedContext)) |
| 1005 |
.bind("binop-const-compare-to-binop-const")), |
| 1006 |
this); |
| 1007 |
|
| 1008 |
// Match relational expressions combined with logical operators and find |
| 1009 |
// redundant sub-expressions. |
| 1010 |
// see: 'checkRelationalExpr' |
| 1011 |
|
| 1012 |
// Match expressions like: x < 2 && x > 2. |
| 1013 |
const auto ComparisonLeft = matchRelationalIntegerConstantExpr("lhs"); |
| 1014 |
const auto ComparisonRight = matchRelationalIntegerConstantExpr("rhs"); |
| 1015 |
Finder->addMatcher( |
| 1016 |
traverse(TK_AsIs, |
| 1017 |
binaryOperator(hasAnyOperatorName("||", "&&"), |
| 1018 |
hasLHS(ComparisonLeft), hasRHS(ComparisonRight), |
| 1019 |
// Already reported as redundant. |
| 1020 |
unless(operandsAreEquivalent()), |
| 1021 |
unless(IsInUnevaluatedContext)) |
| 1022 |
.bind("comparisons-of-symbol-and-const")), |
| 1023 |
this); |
| 1024 |
} |
| 1025 |
|
| 1026 |
void RedundantExpressionCheck::checkArithmeticExpr( |
| 1027 |
const MatchFinder::MatchResult &Result) { |
| 1028 |
APSInt LhsValue, RhsValue; |
| 1029 |
const Expr *LhsSymbol = nullptr, *RhsSymbol = nullptr; |
| 1030 |
BinaryOperatorKind LhsOpcode{}, RhsOpcode{}; |
| 1031 |
|
| 1032 |
if (const auto *ComparisonOperator = Result.Nodes.getNodeAs<BinaryOperator>( |
| 1033 |
"binop-const-compare-to-sym")) { |
| 1034 |
BinaryOperatorKind Opcode = ComparisonOperator->getOpcode(); |
| 1035 |
if (!retrieveBinOpIntegerConstantExpr(Result, "lhs", LhsOpcode, LhsSymbol, |
| 1036 |
LhsValue) || |
| 1037 |
!retrieveSymbolicExpr(Result, "rhs", RhsSymbol) || |
| 1038 |
!areEquivalentExpr(LhsSymbol, RhsSymbol)) |
| 1039 |
return; |
| 1040 |
|
| 1041 |
// Check expressions: x + k == x or x - k == x. |
| 1042 |
if (LhsOpcode == BO_Add || LhsOpcode == BO_Sub) { |
| 1043 |
if ((LhsValue != 0 && Opcode == BO_EQ) || |
| 1044 |
(LhsValue == 0 && Opcode == BO_NE)) |
| 1045 |
diag(ComparisonOperator->getOperatorLoc(), |
| 1046 |
"logical expression is always false"); |
| 1047 |
else if ((LhsValue == 0 && Opcode == BO_EQ) || |
| 1048 |
(LhsValue != 0 && Opcode == BO_NE)) |
| 1049 |
diag(ComparisonOperator->getOperatorLoc(), |
| 1050 |
"logical expression is always true"); |
| 1051 |
} |
| 1052 |
} else if (const auto *ComparisonOperator = |
| 1053 |
Result.Nodes.getNodeAs<BinaryOperator>( |
| 1054 |
"binop-const-compare-to-binop-const")) { |
| 1055 |
BinaryOperatorKind Opcode = ComparisonOperator->getOpcode(); |
| 1056 |
|
| 1057 |
if (!retrieveBinOpIntegerConstantExpr(Result, "lhs", LhsOpcode, LhsSymbol, |
| 1058 |
LhsValue) || |
| 1059 |
!retrieveBinOpIntegerConstantExpr(Result, "rhs", RhsOpcode, RhsSymbol, |
| 1060 |
RhsValue) || |
| 1061 |
!areEquivalentExpr(LhsSymbol, RhsSymbol)) |
| 1062 |
return; |
| 1063 |
|
| 1064 |
transformSubToCanonicalAddExpr(LhsOpcode, LhsValue); |
| 1065 |
transformSubToCanonicalAddExpr(RhsOpcode, RhsValue); |
| 1066 |
|
| 1067 |
// Check expressions: x + 1 == x + 2 or x + 1 != x + 2. |
| 1068 |
if (LhsOpcode == BO_Add && RhsOpcode == BO_Add) { |
| 1069 |
if ((Opcode == BO_EQ && APSInt::compareValues(LhsValue, RhsValue) == 0) || |
| 1070 |
(Opcode == BO_NE && APSInt::compareValues(LhsValue, RhsValue) != 0)) { |
| 1071 |
diag(ComparisonOperator->getOperatorLoc(), |
| 1072 |
"logical expression is always true"); |
| 1073 |
} else if ((Opcode == BO_EQ && |
| 1074 |
APSInt::compareValues(LhsValue, RhsValue) != 0) || |
| 1075 |
(Opcode == BO_NE && |
| 1076 |
APSInt::compareValues(LhsValue, RhsValue) == 0)) { |
| 1077 |
diag(ComparisonOperator->getOperatorLoc(), |
| 1078 |
"logical expression is always false"); |
| 1079 |
} |
| 1080 |
} |
| 1081 |
} |
| 1082 |
} |
| 1083 |
|
| 1084 |
static bool exprEvaluatesToZero(BinaryOperatorKind Opcode, APSInt Value) { |
| 1085 |
return (Opcode == BO_And || Opcode == BO_AndAssign) && Value == 0; |
| 1086 |
} |
| 1087 |
|
| 1088 |
static bool exprEvaluatesToBitwiseNegatedZero(BinaryOperatorKind Opcode, |
| 1089 |
APSInt Value) { |
| 1090 |
return (Opcode == BO_Or || Opcode == BO_OrAssign) && ~Value == 0; |
| 1091 |
} |
| 1092 |
|
| 1093 |
static bool exprEvaluatesToSymbolic(BinaryOperatorKind Opcode, APSInt Value) { |
| 1094 |
return ((Opcode == BO_Or || Opcode == BO_OrAssign) && Value == 0) || |
| 1095 |
((Opcode == BO_And || Opcode == BO_AndAssign) && ~Value == 0); |
| 1096 |
} |
| 1097 |
|
| 1098 |
|
| 1099 |
void RedundantExpressionCheck::checkBitwiseExpr( |
| 1100 |
const MatchFinder::MatchResult &Result) { |
| 1101 |
if (const auto *ComparisonOperator = Result.Nodes.getNodeAs<BinaryOperator>( |
| 1102 |
"binop-const-compare-to-const")) { |
| 1103 |
BinaryOperatorKind Opcode = ComparisonOperator->getOpcode(); |
| 1104 |
|
| 1105 |
APSInt LhsValue, RhsValue; |
| 1106 |
const Expr *LhsSymbol = nullptr; |
| 1107 |
BinaryOperatorKind LhsOpcode{}; |
| 1108 |
if (!retrieveBinOpIntegerConstantExpr(Result, "lhs", LhsOpcode, LhsSymbol, |
| 1109 |
LhsValue) || |
| 1110 |
!retrieveIntegerConstantExpr(Result, "rhs", RhsValue)) |
| 1111 |
return; |
| 1112 |
|
| 1113 |
uint64_t LhsConstant = LhsValue.getZExtValue(); |
| 1114 |
uint64_t RhsConstant = RhsValue.getZExtValue(); |
| 1115 |
SourceLocation Loc = ComparisonOperator->getOperatorLoc(); |
| 1116 |
|
| 1117 |
// Check expression: x & k1 == k2 (i.e. x & 0xFF == 0xF00) |
| 1118 |
if (LhsOpcode == BO_And && (LhsConstant & RhsConstant) != RhsConstant) { |
| 1119 |
if (Opcode == BO_EQ) |
| 1120 |
diag(Loc, "logical expression is always false"); |
| 1121 |
else if (Opcode == BO_NE) |
| 1122 |
diag(Loc, "logical expression is always true"); |
| 1123 |
} |
| 1124 |
|
| 1125 |
// Check expression: x | k1 == k2 (i.e. x | 0xFF == 0xF00) |
| 1126 |
if (LhsOpcode == BO_Or && (LhsConstant | RhsConstant) != RhsConstant) { |
| 1127 |
if (Opcode == BO_EQ) |
| 1128 |
diag(Loc, "logical expression is always false"); |
| 1129 |
else if (Opcode == BO_NE) |
| 1130 |
diag(Loc, "logical expression is always true"); |
| 1131 |
} |
| 1132 |
} else if (const auto *IneffectiveOperator = |
| 1133 |
Result.Nodes.getNodeAs<BinaryOperator>( |
| 1134 |
"ineffective-bitwise")) { |
| 1135 |
APSInt Value; |
| 1136 |
const Expr *Sym = nullptr, *ConstExpr = nullptr; |
| 1137 |
|
| 1138 |
if (!retrieveSymbolicExpr(Result, "ineffective-bitwise", Sym) || |
| 1139 |
!retrieveIntegerConstantExpr(Result, "ineffective-bitwise", Value, |
| 1140 |
ConstExpr)) |
| 1141 |
return; |
| 1142 |
|
| 1143 |
if((Value != 0 && ~Value != 0) || Sym->getExprLoc().isMacroID()) |
| 1144 |
return; |
| 1145 |
|
| 1146 |
SourceLocation Loc = IneffectiveOperator->getOperatorLoc(); |
| 1147 |
|
| 1148 |
BinaryOperatorKind Opcode = IneffectiveOperator->getOpcode(); |
| 1149 |
if (exprEvaluatesToZero(Opcode, Value)) { |
| 1150 |
diag(Loc, "expression always evaluates to 0"); |
| 1151 |
} else if (exprEvaluatesToBitwiseNegatedZero(Opcode, Value)) { |
| 1152 |
SourceRange ConstExprRange(ConstExpr->getBeginLoc(), |
| 1153 |
ConstExpr->getEndLoc()); |
| 1154 |
StringRef ConstExprText = Lexer::getSourceText( |
| 1155 |
CharSourceRange::getTokenRange(ConstExprRange), *Result.SourceManager, |
| 1156 |
Result.Context->getLangOpts()); |
| 1157 |
|
| 1158 |
diag(Loc, "expression always evaluates to '%0'") << ConstExprText; |
| 1159 |
|
| 1160 |
} else if (exprEvaluatesToSymbolic(Opcode, Value)) { |
| 1161 |
SourceRange SymExprRange(Sym->getBeginLoc(), Sym->getEndLoc()); |
| 1162 |
|
| 1163 |
StringRef ExprText = Lexer::getSourceText( |
| 1164 |
CharSourceRange::getTokenRange(SymExprRange), *Result.SourceManager, |
| 1165 |
Result.Context->getLangOpts()); |
| 1166 |
|
| 1167 |
diag(Loc, "expression always evaluates to '%0'") << ExprText; |
| 1168 |
} |
| 1169 |
} |
| 1170 |
} |
| 1171 |
|
| 1172 |
void RedundantExpressionCheck::checkRelationalExpr( |
| 1173 |
const MatchFinder::MatchResult &Result) { |
| 1174 |
if (const auto *ComparisonOperator = Result.Nodes.getNodeAs<BinaryOperator>( |
| 1175 |
"comparisons-of-symbol-and-const")) { |
| 1176 |
// Matched expressions are: (x <op> k1) <REL> (x <op> k2). |
| 1177 |
// E.g.: (X < 2) && (X > 4) |
| 1178 |
BinaryOperatorKind Opcode = ComparisonOperator->getOpcode(); |
| 1179 |
|
| 1180 |
const Expr *LhsExpr = nullptr, *RhsExpr = nullptr; |
| 1181 |
const Expr *LhsSymbol = nullptr, *RhsSymbol = nullptr; |
| 1182 |
const Expr *LhsConst = nullptr, *RhsConst = nullptr; |
| 1183 |
BinaryOperatorKind LhsOpcode{}, RhsOpcode{}; |
| 1184 |
APSInt LhsValue, RhsValue; |
| 1185 |
|
| 1186 |
if (!retrieveRelationalIntegerConstantExpr( |
| 1187 |
Result, "lhs", LhsExpr, LhsOpcode, LhsSymbol, LhsValue, LhsConst) || |
| 1188 |
!retrieveRelationalIntegerConstantExpr( |
| 1189 |
Result, "rhs", RhsExpr, RhsOpcode, RhsSymbol, RhsValue, RhsConst) || |
| 1190 |
!areEquivalentExpr(LhsSymbol, RhsSymbol)) |
| 1191 |
return; |
| 1192 |
|
| 1193 |
// Bring expr to a canonical form: smallest constant must be on the left. |
| 1194 |
if (APSInt::compareValues(LhsValue, RhsValue) > 0) { |
| 1195 |
std::swap(LhsExpr, RhsExpr); |
| 1196 |
std::swap(LhsValue, RhsValue); |
| 1197 |
std::swap(LhsSymbol, RhsSymbol); |
| 1198 |
std::swap(LhsOpcode, RhsOpcode); |
| 1199 |
} |
| 1200 |
|
| 1201 |
// Constants come from two different macros, or one of them is a macro. |
| 1202 |
if (areExprsFromDifferentMacros(LhsConst, RhsConst, Result.Context) || |
| 1203 |
areExprsMacroAndNonMacro(LhsConst, RhsConst)) |
| 1204 |
return; |
| 1205 |
|
| 1206 |
if ((Opcode == BO_LAnd || Opcode == BO_LOr) && |
| 1207 |
areEquivalentRanges(LhsOpcode, LhsValue, RhsOpcode, RhsValue)) { |
| 1208 |
diag(ComparisonOperator->getOperatorLoc(), |
| 1209 |
"equivalent expression on both sides of logical operator"); |
| 1210 |
return; |
| 1211 |
} |
| 1212 |
|
| 1213 |
if (Opcode == BO_LAnd) { |
| 1214 |
if (areExclusiveRanges(LhsOpcode, LhsValue, RhsOpcode, RhsValue)) { |
| 1215 |
diag(ComparisonOperator->getOperatorLoc(), |
| 1216 |
"logical expression is always false"); |
| 1217 |
} else if (rangeSubsumesRange(LhsOpcode, LhsValue, RhsOpcode, RhsValue)) { |
| 1218 |
diag(LhsExpr->getExprLoc(), "expression is redundant"); |
| 1219 |
} else if (rangeSubsumesRange(RhsOpcode, RhsValue, LhsOpcode, LhsValue)) { |
| 1220 |
diag(RhsExpr->getExprLoc(), "expression is redundant"); |
| 1221 |
} |
| 1222 |
} |
| 1223 |
|
| 1224 |
if (Opcode == BO_LOr) { |
| 1225 |
if (rangesFullyCoverDomain(LhsOpcode, LhsValue, RhsOpcode, RhsValue)) { |
| 1226 |
diag(ComparisonOperator->getOperatorLoc(), |
| 1227 |
"logical expression is always true"); |
| 1228 |
} else if (rangeSubsumesRange(LhsOpcode, LhsValue, RhsOpcode, RhsValue)) { |
| 1229 |
diag(RhsExpr->getExprLoc(), "expression is redundant"); |
| 1230 |
} else if (rangeSubsumesRange(RhsOpcode, RhsValue, LhsOpcode, LhsValue)) { |
| 1231 |
diag(LhsExpr->getExprLoc(), "expression is redundant"); |
| 1232 |
} |
| 1233 |
} |
| 1234 |
} |
| 1235 |
} |
| 1236 |
|
| 1237 |
void RedundantExpressionCheck::check(const MatchFinder::MatchResult &Result) { |
| 1238 |
if (const auto *BinOp = Result.Nodes.getNodeAs<BinaryOperator>("binary")) { |
| 1239 |
// If the expression's constants are macros, check whether they are |
| 1240 |
// intentional. |
| 1241 |
if (areSidesBinaryConstExpressions(BinOp, Result.Context)) { |
| 1242 |
const Expr *LhsConst = nullptr, *RhsConst = nullptr; |
| 1243 |
BinaryOperatorKind MainOpcode{}, SideOpcode{}; |
| 1244 |
|
| 1245 |
if (!retrieveConstExprFromBothSides(BinOp, MainOpcode, SideOpcode, |
| 1246 |
LhsConst, RhsConst, Result.Context)) |
| 1247 |
return; |
| 1248 |
|
| 1249 |
if (areExprsFromDifferentMacros(LhsConst, RhsConst, Result.Context) || |
| 1250 |
areExprsMacroAndNonMacro(LhsConst, RhsConst)) |
| 1251 |
return; |
| 1252 |
} |
| 1253 |
|
| 1254 |
diag(BinOp->getOperatorLoc(), "both sides of operator are equivalent"); |
| 1255 |
} |
| 1256 |
|
| 1257 |
if (const auto *CondOp = |
| 1258 |
Result.Nodes.getNodeAs<ConditionalOperator>("cond")) { |
| 1259 |
const Expr *TrueExpr = CondOp->getTrueExpr(); |
| 1260 |
const Expr *FalseExpr = CondOp->getFalseExpr(); |
| 1261 |
|
| 1262 |
if (areExprsFromDifferentMacros(TrueExpr, FalseExpr, Result.Context) || |
| 1263 |
areExprsMacroAndNonMacro(TrueExpr, FalseExpr)) |
| 1264 |
return; |
| 1265 |
diag(CondOp->getColonLoc(), |
| 1266 |
"'true' and 'false' expressions are equivalent"); |
| 1267 |
} |
| 1268 |
|
| 1269 |
if (const auto *Call = Result.Nodes.getNodeAs<CXXOperatorCallExpr>("call")) { |
| 1270 |
if (canOverloadedOperatorArgsBeModified(Call, true)) |
| 1271 |
return; |
| 1272 |
|
| 1273 |
diag(Call->getOperatorLoc(), |
| 1274 |
"both sides of overloaded operator are equivalent"); |
| 1275 |
} |
| 1276 |
|
| 1277 |
if (const auto *Op = Result.Nodes.getNodeAs<Expr>("nested-duplicates")) { |
| 1278 |
const auto *Call = dyn_cast<CXXOperatorCallExpr>(Op); |
| 1279 |
if (Call && canOverloadedOperatorArgsBeModified(Call, true)) |
| 1280 |
return; |
| 1281 |
|
| 1282 |
StringRef Message = |
| 1283 |
Call ? "overloaded operator has equivalent nested operands" |
| 1284 |
: "operator has equivalent nested operands"; |
| 1285 |
|
| 1286 |
const auto Diag = diag(Op->getExprLoc(), Message); |
| 1287 |
for (const auto &KeyValue : Result.Nodes.getMap()) { |
| 1288 |
if (StringRef(KeyValue.first).starts_with("duplicate")) |
| 1289 |
Diag << KeyValue.second.getSourceRange(); |
| 1290 |
} |
| 1291 |
} |
| 1292 |
|
| 1293 |
if (const auto *NegateOperator = |
| 1294 |
Result.Nodes.getNodeAs<UnaryOperator>("logical-bitwise-confusion")) { |
| 1295 |
SourceLocation OperatorLoc = NegateOperator->getOperatorLoc(); |
| 1296 |
|
| 1297 |
auto Diag = |
| 1298 |
diag(OperatorLoc, |
| 1299 |
"ineffective logical negation operator used; did you mean '~'?"); |
| 1300 |
SourceLocation LogicalNotLocation = OperatorLoc.getLocWithOffset(1); |
| 1301 |
|
| 1302 |
if (!LogicalNotLocation.isMacroID()) |
| 1303 |
Diag << FixItHint::CreateReplacement( |
| 1304 |
CharSourceRange::getCharRange(OperatorLoc, LogicalNotLocation), "~"); |
| 1305 |
} |
| 1306 |
|
| 1307 |
if (const auto *BinaryAndExpr = Result.Nodes.getNodeAs<BinaryOperator>( |
| 1308 |
"left-right-shift-confusion")) { |
| 1309 |
const auto *ShiftingConst = Result.Nodes.getNodeAs<Expr>("shift-const"); |
| 1310 |
assert(ShiftingConst && "Expr* 'ShiftingConst' is nullptr!"); |
| 1311 |
std::optional<llvm::APSInt> ShiftingValue = |
| 1312 |
ShiftingConst->getIntegerConstantExpr(*Result.Context); |
| 1313 |
|
| 1314 |
if (!ShiftingValue) |
| 1315 |
return; |
| 1316 |
|
| 1317 |
const auto *AndConst = Result.Nodes.getNodeAs<Expr>("and-const"); |
| 1318 |
assert(AndConst && "Expr* 'AndCont' is nullptr!"); |
| 1319 |
std::optional<llvm::APSInt> AndValue = |
| 1320 |
AndConst->getIntegerConstantExpr(*Result.Context); |
| 1321 |
if (!AndValue) |
| 1322 |
return; |
| 1323 |
|
| 1324 |
// If ShiftingConst is shifted left with more bits than the position of the |
| 1325 |
// leftmost 1 in the bit representation of AndValue, AndConstant is |
| 1326 |
// ineffective. |
| 1327 |
if (AndValue->getActiveBits() > *ShiftingValue) |
| 1328 |
return; |
| 1329 |
|
| 1330 |
auto Diag = diag(BinaryAndExpr->getOperatorLoc(), |
| 1331 |
"ineffective bitwise and operation"); |
| 1332 |
} |
| 1333 |
|
| 1334 |
// Check for the following bound expressions: |
| 1335 |
// - "binop-const-compare-to-sym", |
| 1336 |
// - "binop-const-compare-to-binop-const", |
| 1337 |
// Produced message: |
| 1338 |
// -> "logical expression is always false/true" |
| 1339 |
checkArithmeticExpr(Result); |
| 1340 |
|
| 1341 |
// Check for the following bound expression: |
| 1342 |
// - "binop-const-compare-to-const", |
| 1343 |
// - "ineffective-bitwise" |
| 1344 |
// Produced message: |
| 1345 |
// -> "logical expression is always false/true" |
| 1346 |
// -> "expression always evaluates to ..." |
| 1347 |
checkBitwiseExpr(Result); |
| 1348 |
|
| 1349 |
// Check for te following bound expression: |
| 1350 |
// - "comparisons-of-symbol-and-const", |
| 1351 |
// Produced messages: |
| 1352 |
// -> "equivalent expression on both sides of logical operator", |
| 1353 |
// -> "logical expression is always false/true" |
| 1354 |
// -> "expression is redundant" |
| 1355 |
checkRelationalExpr(Result); |
| 1356 |
} |
| 1357 |
|
| 1358 |
} // namespace clang::tidy::misc |