llvm-project/clang/unittests/Analysis/UnsafeBufferUsageTest.cpp
Jan Svoboda 9e306ad460
[clang] Remove intrusive reference count from DiagnosticOptions (#139584)
The `DiagnosticOptions` class is currently intrusively
reference-counted, which makes reasoning about its lifetime very
difficult in some cases. For example, `CompilerInvocation` owns the
`DiagnosticOptions` instance (wrapped in `llvm::IntrusiveRefCntPtr`) and
only exposes an accessor returning `DiagnosticOptions &`. One would
think this gives `CompilerInvocation` exclusive ownership of the object,
but that's not the case:

```c++
void shareOwnership(CompilerInvocation &CI) {
  llvm::IntrusiveRefCntPtr<DiagnosticOptions> CoOwner = &CI.getDiagnosticOptions();
  // ...
}
```

This is a perfectly valid pattern that is being actually used in the
codebase.

I would like to ensure the ownership of `DiagnosticOptions` by
`CompilerInvocation` is guaranteed to be exclusive. This can be
leveraged for a copy-on-write optimization later on. This PR changes
usages of `DiagnosticOptions` across `clang`, `clang-tools-extra` and
`lldb` to not be intrusively reference-counted.
2025-05-22 12:33:52 -07:00

61 lines
2.1 KiB
C++

#include "gtest/gtest.h"
#include "clang/Basic/SourceLocation.h"
#include "clang/Basic/SourceManager.h"
#include "clang/Basic/Diagnostic.h"
#include "clang/Basic/FileManager.h"
#include "clang/Analysis/Analyses/UnsafeBufferUsage.h"
using namespace clang;
namespace {
// The test fixture.
class UnsafeBufferUsageTest : public ::testing::Test {
protected:
UnsafeBufferUsageTest()
: FileMgr(FileMgrOpts), DiagID(new DiagnosticIDs()),
Diags(DiagID, DiagOpts, new IgnoringDiagConsumer()),
SourceMgr(Diags, FileMgr) {}
FileSystemOptions FileMgrOpts;
FileManager FileMgr;
IntrusiveRefCntPtr<DiagnosticIDs> DiagID;
DiagnosticOptions DiagOpts;
DiagnosticsEngine Diags;
SourceManager SourceMgr;
};
} // namespace
TEST_F(UnsafeBufferUsageTest, FixItHintsConflict) {
FileEntryRef DummyFile = FileMgr.getVirtualFileRef("<virtual>", 100, 0);
FileID DummyFileID = SourceMgr.getOrCreateFileID(DummyFile, SrcMgr::C_User);
SourceLocation StartLoc = SourceMgr.getLocForStartOfFile(DummyFileID);
#define MkDummyHint(Begin, End) \
FixItHint::CreateReplacement(SourceRange(StartLoc.getLocWithOffset((Begin)), \
StartLoc.getLocWithOffset((End))), \
"dummy")
FixItHint H1 = MkDummyHint(0, 5);
FixItHint H2 = MkDummyHint(6, 10);
FixItHint H3 = MkDummyHint(20, 25);
llvm::SmallVector<FixItHint> Fixes;
// Test non-overlapping fix-its:
Fixes = {H1, H2, H3};
EXPECT_FALSE(internal::anyConflict(Fixes, SourceMgr));
Fixes = {H3, H2, H1}; // re-order
EXPECT_FALSE(internal::anyConflict(Fixes, SourceMgr));
// Test overlapping fix-its:
Fixes = {H1, H2, H3, MkDummyHint(0, 4) /* included in H1 */};
EXPECT_TRUE(internal::anyConflict(Fixes, SourceMgr));
Fixes = {H1, H2, H3, MkDummyHint(10, 15) /* overlaps H2 */};
EXPECT_TRUE(internal::anyConflict(Fixes, SourceMgr));
Fixes = {H1, H2, H3, MkDummyHint(7, 23) /* overlaps H2, H3 */};
EXPECT_TRUE(internal::anyConflict(Fixes, SourceMgr));
Fixes = {H1, H2, H3, MkDummyHint(2, 23) /* overlaps H1, H2, and H3 */};
EXPECT_TRUE(internal::anyConflict(Fixes, SourceMgr));
}