Check the type of Objective-C++ instance variables in WebKit member variable checkers. #127570
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ariable checkers. Like a C++ member variable, every Objective-C++ instance variable must be a RefPtr, Ref CheckedPtr, or CheckedRef to an object, not a raw pointer or reference.
llvmbot
added
clang
|
@llvm/pr-subscribers-clang-static-analyzer-1 Author: Ryosuke Niwa (rniwa) ChangesLike a C++ member variable, every Objective-C++ instance variable must be a RefPtr, Ref CheckedPtr, or CheckedRef to an object, not a raw pointer or reference. Full diff: https://github.com/llvm/llvm-project/pull/127570.diff 3 Files Affected:
diff --git a/clang/lib/StaticAnalyzer/Checkers/WebKit/RawPtrRefMemberChecker.cpp b/clang/lib/StaticAnalyzer/Checkers/WebKit/RawPtrRefMemberChecker.cpp
index 79f88553feb95..963f59831c8ed 100644
--- a/clang/lib/StaticAnalyzer/Checkers/WebKit/RawPtrRefMemberChecker.cpp
+++ b/clang/lib/StaticAnalyzer/Checkers/WebKit/RawPtrRefMemberChecker.cpp
@@ -61,6 +61,11 @@ class RawPtrRefMemberChecker
Checker->visitRecordDecl(RD);
return true;
}
+
+ bool VisitObjCContainerDecl(const ObjCContainerDecl *CD) override {
+ Checker->visitObjCDecl(CD);
+ return true;
+ }
};
LocalVisitor visitor(this);
@@ -87,6 +92,31 @@ class RawPtrRefMemberChecker
}
}
+ void visitObjCDecl(const ObjCContainerDecl *CD) const {
+ if (auto *ID = dyn_cast<ObjCInterfaceDecl>(CD)) {
+ for (auto *Ivar : ID->ivars())
+ visitIvarDecl(CD, Ivar);
+ return;
+ }
+ if (auto *ID = dyn_cast<ObjCImplementationDecl>(CD)) {
+ for (auto *Ivar : ID->ivars())
+ visitIvarDecl(CD, Ivar);
+ return;
+ }
+ }
+
+ void visitIvarDecl(const ObjCContainerDecl *CD,
+ const ObjCIvarDecl *Ivar) const {
+ const Type *IvarType = Ivar->getType().getTypePtrOrNull();
+ if (!IvarType)
+ return;
+ if (auto *IvarCXXRD = IvarType->getPointeeCXXRecordDecl()) {
+ std::optional<bool> IsCompatible = isPtrCompatible(IvarCXXRD);
+ if (IsCompatible && *IsCompatible)
+ reportBug(Ivar, IvarType, IvarCXXRD, CD);
+ }
+ }
+
bool shouldSkipDecl(const RecordDecl *RD) const {
if (!RD->isThisDeclarationADefinition())
return true;
@@ -121,9 +151,10 @@ class RawPtrRefMemberChecker
return false;
}
- void reportBug(const FieldDecl *Member, const Type *MemberType,
+ template <typename DeclType, typename ParentDeclType>
+ void reportBug(const DeclType *Member, const Type *MemberType,
const CXXRecordDecl *MemberCXXRD,
- const RecordDecl *ClassCXXRD) const {
+ const ParentDeclType *ClassCXXRD) const {
assert(Member);
assert(MemberType);
assert(MemberCXXRD);
@@ -131,7 +162,10 @@ class RawPtrRefMemberChecker
SmallString<100> Buf;
llvm::raw_svector_ostream Os(Buf);
- Os << "Member variable ";
+ if (isa<ObjCContainerDecl>(ClassCXXRD))
+ Os << "Instance variable ";
+ else
+ Os << "Member variable ";
printQuotedName(Os, Member);
Os << " in ";
printQuotedQualifiedName(Os, ClassCXXRD);
diff --git a/clang/test/Analysis/Checkers/WebKit/unchecked-members-objc.mm b/clang/test/Analysis/Checkers/WebKit/unchecked-members-objc.mm
new file mode 100644
index 0000000000000..a9a9a367fb9f4
--- /dev/null
+++ b/clang/test/Analysis/Checkers/WebKit/unchecked-members-objc.mm
@@ -0,0 +1,35 @@
+// RUN: %clang_analyze_cc1 -analyzer-checker=alpha.webkit.NoUncheckedPtrMemberChecker -verify %s
+
+#include "mock-types.h"
+
+__attribute__((objc_root_class))
+@interface NSObject
++ (instancetype) alloc;
+- (instancetype) init;
+- (instancetype)retain;
+- (void)release;
+@end
+
+void doSomeWork();
+
+@interface SomeObjC : NSObject {
+ CheckedObj* _unchecked1;
+// expected-warning@-1{{Instance variable '_unchecked1' in 'SomeObjC' is a raw pointer to CheckedPtr capable type 'CheckedObj'}}
+ CheckedPtr<CheckedObj> _counted1;
+ [[clang::suppress]] CheckedObj* _unchecked2;
+}
+- (void)doWork;
+@end
+
+@implementation SomeObjC {
+ CheckedObj* _unchecked3;
+// expected-warning@-1{{Instance variable '_unchecked3' in 'SomeObjC' is a raw pointer to CheckedPtr capable type 'CheckedObj'}}
+ CheckedPtr<CheckedObj> _counted2;
+ [[clang::suppress]] CheckedObj* _unchecked4;
+}
+
+- (void)doWork {
+ doSomeWork();
+}
+
+@end
diff --git a/clang/test/Analysis/Checkers/WebKit/uncounted-members-objc.mm b/clang/test/Analysis/Checkers/WebKit/uncounted-members-objc.mm
new file mode 100644
index 0000000000000..83b08a6841d26
--- /dev/null
+++ b/clang/test/Analysis/Checkers/WebKit/uncounted-members-objc.mm
@@ -0,0 +1,35 @@
+// RUN: %clang_analyze_cc1 -analyzer-checker=webkit.NoUncountedMemberChecker -verify %s
+
+#include "mock-types.h"
+
+__attribute__((objc_root_class))
+@interface NSObject
++ (instancetype) alloc;
+- (instancetype) init;
+- (instancetype)retain;
+- (void)release;
+@end
+
+void doSomeWork();
+
+@interface SomeObjC : NSObject {
+ RefCountable* _uncounted1;
+// expected-warning@-1{{Instance variable '_uncounted1' in 'SomeObjC' is a raw pointer to ref-countable type 'RefCountable'}}
+ RefPtr<RefCountable> _counted1;
+ [[clang::suppress]] RefCountable* _uncounted2;
+}
+- (void)doWork;
+@end
+
+@implementation SomeObjC {
+ RefCountable* _uncounted3;
+// expected-warning@-1{{Instance variable '_uncounted3' in 'SomeObjC' is a raw pointer to ref-countable type 'RefCountable'}}
+ RefPtr<RefCountable> _counted2;
+ [[clang::suppress]] RefCountable* _uncounted4;
+}
+
+- (void)doWork {
+ doSomeWork();
+}
+
+@end
|
|
@llvm/pr-subscribers-clang Author: Ryosuke Niwa (rniwa) ChangesLike a C++ member variable, every Objective-C++ instance variable must be a RefPtr, Ref CheckedPtr, or CheckedRef to an object, not a raw pointer or reference. Full diff: https://github.com/llvm/llvm-project/pull/127570.diff 3 Files Affected:
diff --git a/clang/lib/StaticAnalyzer/Checkers/WebKit/RawPtrRefMemberChecker.cpp b/clang/lib/StaticAnalyzer/Checkers/WebKit/RawPtrRefMemberChecker.cpp
index 79f88553feb95..963f59831c8ed 100644
--- a/clang/lib/StaticAnalyzer/Checkers/WebKit/RawPtrRefMemberChecker.cpp
+++ b/clang/lib/StaticAnalyzer/Checkers/WebKit/RawPtrRefMemberChecker.cpp
@@ -61,6 +61,11 @@ class RawPtrRefMemberChecker
Checker->visitRecordDecl(RD);
return true;
}
+
+ bool VisitObjCContainerDecl(const ObjCContainerDecl *CD) override {
+ Checker->visitObjCDecl(CD);
+ return true;
+ }
};
LocalVisitor visitor(this);
@@ -87,6 +92,31 @@ class RawPtrRefMemberChecker
}
}
+ void visitObjCDecl(const ObjCContainerDecl *CD) const {
+ if (auto *ID = dyn_cast<ObjCInterfaceDecl>(CD)) {
+ for (auto *Ivar : ID->ivars())
+ visitIvarDecl(CD, Ivar);
+ return;
+ }
+ if (auto *ID = dyn_cast<ObjCImplementationDecl>(CD)) {
+ for (auto *Ivar : ID->ivars())
+ visitIvarDecl(CD, Ivar);
+ return;
+ }
+ }
+
+ void visitIvarDecl(const ObjCContainerDecl *CD,
+ const ObjCIvarDecl *Ivar) const {
+ const Type *IvarType = Ivar->getType().getTypePtrOrNull();
+ if (!IvarType)
+ return;
+ if (auto *IvarCXXRD = IvarType->getPointeeCXXRecordDecl()) {
+ std::optional<bool> IsCompatible = isPtrCompatible(IvarCXXRD);
+ if (IsCompatible && *IsCompatible)
+ reportBug(Ivar, IvarType, IvarCXXRD, CD);
+ }
+ }
+
bool shouldSkipDecl(const RecordDecl *RD) const {
if (!RD->isThisDeclarationADefinition())
return true;
@@ -121,9 +151,10 @@ class RawPtrRefMemberChecker
return false;
}
- void reportBug(const FieldDecl *Member, const Type *MemberType,
+ template <typename DeclType, typename ParentDeclType>
+ void reportBug(const DeclType *Member, const Type *MemberType,
const CXXRecordDecl *MemberCXXRD,
- const RecordDecl *ClassCXXRD) const {
+ const ParentDeclType *ClassCXXRD) const {
assert(Member);
assert(MemberType);
assert(MemberCXXRD);
@@ -131,7 +162,10 @@ class RawPtrRefMemberChecker
SmallString<100> Buf;
llvm::raw_svector_ostream Os(Buf);
- Os << "Member variable ";
+ if (isa<ObjCContainerDecl>(ClassCXXRD))
+ Os << "Instance variable ";
+ else
+ Os << "Member variable ";
printQuotedName(Os, Member);
Os << " in ";
printQuotedQualifiedName(Os, ClassCXXRD);
diff --git a/clang/test/Analysis/Checkers/WebKit/unchecked-members-objc.mm b/clang/test/Analysis/Checkers/WebKit/unchecked-members-objc.mm
new file mode 100644
index 0000000000000..a9a9a367fb9f4
--- /dev/null
+++ b/clang/test/Analysis/Checkers/WebKit/unchecked-members-objc.mm
@@ -0,0 +1,35 @@
+// RUN: %clang_analyze_cc1 -analyzer-checker=alpha.webkit.NoUncheckedPtrMemberChecker -verify %s
+
+#include "mock-types.h"
+
+__attribute__((objc_root_class))
+@interface NSObject
++ (instancetype) alloc;
+- (instancetype) init;
+- (instancetype)retain;
+- (void)release;
+@end
+
+void doSomeWork();
+
+@interface SomeObjC : NSObject {
+ CheckedObj* _unchecked1;
+// expected-warning@-1{{Instance variable '_unchecked1' in 'SomeObjC' is a raw pointer to CheckedPtr capable type 'CheckedObj'}}
+ CheckedPtr<CheckedObj> _counted1;
+ [[clang::suppress]] CheckedObj* _unchecked2;
+}
+- (void)doWork;
+@end
+
+@implementation SomeObjC {
+ CheckedObj* _unchecked3;
+// expected-warning@-1{{Instance variable '_unchecked3' in 'SomeObjC' is a raw pointer to CheckedPtr capable type 'CheckedObj'}}
+ CheckedPtr<CheckedObj> _counted2;
+ [[clang::suppress]] CheckedObj* _unchecked4;
+}
+
+- (void)doWork {
+ doSomeWork();
+}
+
+@end
diff --git a/clang/test/Analysis/Checkers/WebKit/uncounted-members-objc.mm b/clang/test/Analysis/Checkers/WebKit/uncounted-members-objc.mm
new file mode 100644
index 0000000000000..83b08a6841d26
--- /dev/null
+++ b/clang/test/Analysis/Checkers/WebKit/uncounted-members-objc.mm
@@ -0,0 +1,35 @@
+// RUN: %clang_analyze_cc1 -analyzer-checker=webkit.NoUncountedMemberChecker -verify %s
+
+#include "mock-types.h"
+
+__attribute__((objc_root_class))
+@interface NSObject
++ (instancetype) alloc;
+- (instancetype) init;
+- (instancetype)retain;
+- (void)release;
+@end
+
+void doSomeWork();
+
+@interface SomeObjC : NSObject {
+ RefCountable* _uncounted1;
+// expected-warning@-1{{Instance variable '_uncounted1' in 'SomeObjC' is a raw pointer to ref-countable type 'RefCountable'}}
+ RefPtr<RefCountable> _counted1;
+ [[clang::suppress]] RefCountable* _uncounted2;
+}
+- (void)doWork;
+@end
+
+@implementation SomeObjC {
+ RefCountable* _uncounted3;
+// expected-warning@-1{{Instance variable '_uncounted3' in 'SomeObjC' is a raw pointer to ref-countable type 'RefCountable'}}
+ RefPtr<RefCountable> _counted2;
+ [[clang::suppress]] RefCountable* _uncounted4;
+}
+
+- (void)doWork {
+ doSomeWork();
+}
+
+@end
|
t-rasmud
reviewed
Feb 19, 2025
| @@ -87,6 +92,31 @@ class RawPtrRefMemberChecker | |||
| } | |||
| } | |||
|
|
|||
| void visitObjCDecl(const ObjCContainerDecl *CD) const { | |||
| if (auto *ID = dyn_cast<ObjCInterfaceDecl>(CD)) { | |||
There was a problem hiding this comment.
Is ID always guaranteed to be non-null?
There was a problem hiding this comment.
I don't think so. ObjCContainerDecl could be ObjCCategoryDecl or ObjCProtocolDecl as well.
Or are you saying CD could be null?
There was a problem hiding this comment.
Ah ok. I was wondering if we should check for nullness before dereferencing ID in the next line ID->ivars()
There was a problem hiding this comment.
oh, but this if statement does that already, right? as in, this if will only evaluate to true if ID wasn't nullptr so I think we have a null check here already in that regard.
There was a problem hiding this comment.
Ah yes, of course! I wasn't reading right.
| const Type *IvarType = Ivar->getType().getTypePtrOrNull(); | ||
| if (!IvarType) | ||
| return; | ||
| if (auto *IvarCXXRD = IvarType->getPointeeCXXRecordDecl()) { |
There was a problem hiding this comment.
I think so. If IvarType isn't a pointer to a C++ type, getPointeeCXXRecordDecl can return nullptr. e.g. Objective-C interface type.
There was a problem hiding this comment.
But again, we're doing a nullptr check here with if statement so I think we're good :)
t-rasmud
approved these changes
Feb 19, 2025
| @@ -87,6 +92,31 @@ class RawPtrRefMemberChecker | |||
| } | |||
| } | |||
|
|
|||
| void visitObjCDecl(const ObjCContainerDecl *CD) const { | |||
| if (auto *ID = dyn_cast<ObjCInterfaceDecl>(CD)) { | |||
There was a problem hiding this comment.
Ah yes, of course! I wasn't reading right.
rniwa
added a commit
to rniwa/llvm-project
that referenced
this pull request
Feb 19, 2025
…ariable checkers. (llvm#127570) Like a C++ member variable, every Objective-C++ instance variable must be a RefPtr, Ref CheckedPtr, or CheckedRef to an object, not a raw pointer or reference.
rniwa
added a commit
to rniwa/llvm-project
that referenced
this pull request
Feb 19, 2025
…ariable checkers. (llvm#127570) Like a C++ member variable, every Objective-C++ instance variable must be a RefPtr, Ref CheckedPtr, or CheckedRef to an object, not a raw pointer or reference.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Like a C++ member variable, every Objective-C++ instance variable must be a RefPtr, Ref CheckedPtr, or CheckedRef to an object, not a raw pointer or reference.