Skip to content

Commit fdc265e

Browse files
committed
[NFC][Static Analyzer] Rename NotNullConstraint & NotNullBufferConstraint
NotNullConstraint is used to check both null and non-null of a pointer. So the name, which was created originally for just checking non-nullness, becomes less suitable. The same reason applies to `NotNullBufferConstraint`.
1 parent dafb566 commit fdc265e

File tree

1 file changed

+19
-19
lines changed

1 file changed

+19
-19
lines changed

clang/lib/StaticAnalyzer/Checkers/StdLibraryFunctionsChecker.cpp

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -367,13 +367,13 @@ class StdLibraryFunctionsChecker
367367
};
368368

369369
/// Check null or non-null-ness of an argument that is of pointer type.
370-
class NotNullConstraint : public ValueConstraint {
370+
class NullnessConstraint : public ValueConstraint {
371371
using ValueConstraint::ValueConstraint;
372372
// This variable has a role when we negate the constraint.
373373
bool CannotBeNull = true;
374374

375375
public:
376-
NotNullConstraint(ArgNo ArgN, bool CannotBeNull = true)
376+
NullnessConstraint(ArgNo ArgN, bool CannotBeNull = true)
377377
: ValueConstraint(ArgN), CannotBeNull(CannotBeNull) {}
378378

379379
ProgramStateRef apply(ProgramStateRef State, const CallEvent &Call,
@@ -389,9 +389,9 @@ class StdLibraryFunctionsChecker
389389
llvm::raw_ostream &Out) const override;
390390

391391
ValueConstraintPtr negate() const override {
392-
NotNullConstraint Tmp(*this);
392+
NullnessConstraint Tmp(*this);
393393
Tmp.CannotBeNull = !this->CannotBeNull;
394-
return std::make_shared<NotNullConstraint>(Tmp);
394+
return std::make_shared<NullnessConstraint>(Tmp);
395395
}
396396

397397
protected:
@@ -407,17 +407,17 @@ class StdLibraryFunctionsChecker
407407
/// The argument is meant to be a buffer that has a size constraint, and it
408408
/// is allowed to have a NULL value if the size is 0. The size can depend on
409409
/// 1 or 2 additional arguments, if one of these is 0 the buffer is allowed to
410-
/// be NULL. This is useful for functions like `fread` which have this special
411-
/// property.
412-
class NotNullBufferConstraint : public ValueConstraint {
410+
/// be NULL. Otherwise, the buffer pointer must be non-null. This is useful
411+
/// for functions like `fread` which have this special property.
412+
class BufferNullnessConstraint : public ValueConstraint {
413413
using ValueConstraint::ValueConstraint;
414414
ArgNo SizeArg1N;
415415
std::optional<ArgNo> SizeArg2N;
416416
// This variable has a role when we negate the constraint.
417417
bool CannotBeNull = true;
418418

419419
public:
420-
NotNullBufferConstraint(ArgNo ArgN, ArgNo SizeArg1N,
420+
BufferNullnessConstraint(ArgNo ArgN, ArgNo SizeArg1N,
421421
std::optional<ArgNo> SizeArg2N,
422422
bool CannotBeNull = true)
423423
: ValueConstraint(ArgN), SizeArg1N(SizeArg1N), SizeArg2N(SizeArg2N),
@@ -436,9 +436,9 @@ class StdLibraryFunctionsChecker
436436
llvm::raw_ostream &Out) const override;
437437

438438
ValueConstraintPtr negate() const override {
439-
NotNullBufferConstraint Tmp(*this);
439+
BufferNullnessConstraint Tmp(*this);
440440
Tmp.CannotBeNull = !this->CannotBeNull;
441-
return std::make_shared<NotNullBufferConstraint>(Tmp);
441+
return std::make_shared<BufferNullnessConstraint>(Tmp);
442442
}
443443

444444
protected:
@@ -1151,7 +1151,7 @@ ProgramStateRef StdLibraryFunctionsChecker::ComparisonConstraint::apply(
11511151
return State;
11521152
}
11531153

1154-
ProgramStateRef StdLibraryFunctionsChecker::NotNullConstraint::apply(
1154+
ProgramStateRef StdLibraryFunctionsChecker::NullnessConstraint::apply(
11551155
ProgramStateRef State, const CallEvent &Call, const Summary &Summary,
11561156
CheckerContext &C) const {
11571157
SVal V = getArgSVal(Call, getArgNo());
@@ -1165,7 +1165,7 @@ ProgramStateRef StdLibraryFunctionsChecker::NotNullConstraint::apply(
11651165
return State->assume(L, CannotBeNull);
11661166
}
11671167

1168-
void StdLibraryFunctionsChecker::NotNullConstraint::describe(
1168+
void StdLibraryFunctionsChecker::NullnessConstraint::describe(
11691169
DescriptionKind DK, const CallEvent &Call, ProgramStateRef State,
11701170
const Summary &Summary, llvm::raw_ostream &Out) const {
11711171
assert(CannotBeNull &&
@@ -1176,15 +1176,15 @@ void StdLibraryFunctionsChecker::NotNullConstraint::describe(
11761176
Out << "is not NULL";
11771177
}
11781178

1179-
bool StdLibraryFunctionsChecker::NotNullConstraint::describeArgumentValue(
1179+
bool StdLibraryFunctionsChecker::NullnessConstraint::describeArgumentValue(
11801180
const CallEvent &Call, ProgramStateRef State, const Summary &Summary,
11811181
llvm::raw_ostream &Out) const {
11821182
assert(!CannotBeNull && "This function is used when the value is NULL");
11831183
Out << "is NULL";
11841184
return true;
11851185
}
11861186

1187-
ProgramStateRef StdLibraryFunctionsChecker::NotNullBufferConstraint::apply(
1187+
ProgramStateRef StdLibraryFunctionsChecker::BufferNullnessConstraint::apply(
11881188
ProgramStateRef State, const CallEvent &Call, const Summary &Summary,
11891189
CheckerContext &C) const {
11901190
SVal V = getArgSVal(Call, getArgNo());
@@ -1213,7 +1213,7 @@ ProgramStateRef StdLibraryFunctionsChecker::NotNullBufferConstraint::apply(
12131213
return State->assume(L, CannotBeNull);
12141214
}
12151215

1216-
void StdLibraryFunctionsChecker::NotNullBufferConstraint::describe(
1216+
void StdLibraryFunctionsChecker::BufferNullnessConstraint::describe(
12171217
DescriptionKind DK, const CallEvent &Call, ProgramStateRef State,
12181218
const Summary &Summary, llvm::raw_ostream &Out) const {
12191219
assert(CannotBeNull &&
@@ -1224,7 +1224,7 @@ void StdLibraryFunctionsChecker::NotNullBufferConstraint::describe(
12241224
Out << "is not NULL";
12251225
}
12261226

1227-
bool StdLibraryFunctionsChecker::NotNullBufferConstraint::describeArgumentValue(
1227+
bool StdLibraryFunctionsChecker::BufferNullnessConstraint::describeArgumentValue(
12281228
const CallEvent &Call, ProgramStateRef State, const Summary &Summary,
12291229
llvm::raw_ostream &Out) const {
12301230
assert(!CannotBeNull && "This function is used when the value is NULL");
@@ -1792,14 +1792,14 @@ void StdLibraryFunctionsChecker::initFunctionSummaries(
17921792
};
17931793
auto LessThanOrEq = BO_LE;
17941794
auto NotNull = [&](ArgNo ArgN) {
1795-
return std::make_shared<NotNullConstraint>(ArgN);
1795+
return std::make_shared<NullnessConstraint>(ArgN);
17961796
};
17971797
auto IsNull = [&](ArgNo ArgN) {
1798-
return std::make_shared<NotNullConstraint>(ArgN, false);
1798+
return std::make_shared<NullnessConstraint>(ArgN, false);
17991799
};
18001800
auto NotNullBuffer = [&](ArgNo ArgN, ArgNo SizeArg1N,
18011801
std::optional<ArgNo> SizeArg2N = std::nullopt) {
1802-
return std::make_shared<NotNullBufferConstraint>(ArgN, SizeArg1N,
1802+
return std::make_shared<BufferNullnessConstraint>(ArgN, SizeArg1N,
18031803
SizeArg2N);
18041804
};
18051805

0 commit comments

Comments
 (0)