Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[clang-tidy] Improve sizeof(pointer) handling in bugprone-sizeof-expression #94356

Merged
merged 7 commits into from
Jun 11, 2024
Merged

[clang-tidy] Improve sizeof(pointer) handling in bugprone-sizeof-expression #94356

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
c94feff
[clang-tidy] Add WarnOnSizeOfPointer mode to bugprone-sizeof-expression
NagyDonat May 22, 2024
4de254d
Update the documentation and release notes
NagyDonat Jun 6, 2024
b3a7f8b
Use single back-ticks for option name
NagyDonat Jun 6, 2024
ce3a376
Generalize the suppression to all `sizeof(array[0])` expressions
NagyDonat Jun 7, 2024
d8e6228
Merge branch 'SizeofPointer-move-to-tidy' of github_via_443:Ericsson/…
NagyDonat Jun 7, 2024
ae8123a
Satisfy git-clang-format
NagyDonat Jun 7, 2024
59bd1b8
Extend `GenericFunctionTest`, document a class of FPs with a FIXME
NagyDonat Jun 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Extend GenericFunctionTest, document a class of FPs with a FIXME
  • Loading branch information
@NagyDonat
NagyDonat committed Jun 10, 2024
commit 59bd1b83e4fa89b371f4d1a96c51fc7a1b4ad170
15 changes: 13 additions & 2 deletions clang-tools-extra/test/clang-tidy/checkers/bugprone/sizeof-expression-any-pointer.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,8 +180,8 @@ int Test5() {
}

void some_generic_function(const void *arg, int argsize);
int **IntPP;
C **ClassPP;
int *IntP, **IntPP;
C *ClassP, **ClassPP;

void GenericFunctionTest() {
// The `sizeof(pointer)` checks ignore situations where the pointer is
Expand All @@ -190,8 +190,19 @@ void GenericFunctionTest() {
// a generic function which emulates dynamic typing within C.
some_generic_function(IntPP, sizeof(*IntPP));
some_generic_function(ClassPP, sizeof(*ClassPP));
// Using `...[0]` instead of the dereference operator is another common
// variant, which is also widespread in the idiomatic array-size calculation:
// `sizeof(array) / sizeof(array[0])`.
some_generic_function(IntPP, sizeof(IntPP[0]));
some_generic_function(ClassPP, sizeof(ClassPP[0]));
// FIXME: There is a third common pattern where the generic function is
// called with `&Variable` and `sizeof(Variable)`. Right now these are
// reported by the `sizeof(pointer)` checks, but this causes some false
// positives, so it would be good to create an exception for them.
some_generic_function(&IntPP, sizeof(IntP));
// CHECK-MESSAGES: :[[@LINE-1]]:33: warning: suspicious usage of 'sizeof()' on an expression that results in a pointer
some_generic_function(&ClassPP, sizeof(ClassP));
// CHECK-MESSAGES: :[[@LINE-1]]:35: warning: suspicious usage of 'sizeof()' on an expression that results in a pointer
}

int ValidExpressions() {
Expand Down
15 changes: 13 additions & 2 deletions clang-tools-extra/test/clang-tidy/checkers/bugprone/sizeof-expression.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -299,8 +299,8 @@ bool Baz() { return sizeof(A) < N; }
bool Test7() { return Baz<-1>(); }

void some_generic_function(const void *arg, int argsize);
int **IntPP;
C **ClassPP;
int *IntP, **IntPP;
C *ClassP, **ClassPP;

void GenericFunctionTest() {
// The `sizeof(pointer)` checks ignore situations where the pointer is
Expand All @@ -309,8 +309,19 @@ void GenericFunctionTest() {
// a generic function which emulates dynamic typing within C.
some_generic_function(IntPP, sizeof(*IntPP));
some_generic_function(ClassPP, sizeof(*ClassPP));
// Using `...[0]` instead of the dereference operator is another common
// variant, which is also widespread in the idiomatic array-size calculation:
// `sizeof(array) / sizeof(array[0])`.
some_generic_function(IntPP, sizeof(IntPP[0]));
some_generic_function(ClassPP, sizeof(ClassPP[0]));
// FIXME: There is a third common pattern where the generic function is
// called with `&Variable` and `sizeof(Variable)`. Right now these are
// reported by the `sizeof(pointer)` checks, but this causes some false
// positives, so it would be good to create an exception for them.
// NOTE: `sizeof(IntP)` is only reported with `WarnOnSizeOfPointer=true`.
some_generic_function(&IntPP, sizeof(IntP));
some_generic_function(&ClassPP, sizeof(ClassP));
// CHECK-MESSAGES: :[[@LINE-1]]:35: warning: suspicious usage of 'sizeof()' on an expression that results in a pointer
}

int ValidExpressions() {
Expand Down
Loading