6024e5c395
clang 20.0.0 (based on r547379) from build 12806354. Bug: http://b/379133546 Test: N/A Change-Id: I2eb8938af55d809de674be63cb30cf27e801862b Upstream-Commit: ad834e67b1105d15ef907f6255d4c96e8e733f57
81 lines
3.0 KiB
C++
81 lines
3.0 KiB
C++
//===-- UncheckedOptionalAccessModel.h --------------------------*- C++ -*-===//
|
|
//
|
|
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
|
|
// See https://llvm.org/LICENSE.txt for license information.
|
|
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
//
|
|
// This file defines a dataflow analysis that detects unsafe uses of optional
|
|
// values.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef CLANG_ANALYSIS_FLOWSENSITIVE_MODELS_UNCHECKEDOPTIONALACCESSMODEL_H
|
|
#define CLANG_ANALYSIS_FLOWSENSITIVE_MODELS_UNCHECKEDOPTIONALACCESSMODEL_H
|
|
|
|
#include "clang/AST/ASTContext.h"
|
|
#include "clang/Analysis/CFG.h"
|
|
#include "clang/Analysis/FlowSensitive/CFGMatchSwitch.h"
|
|
#include "clang/Analysis/FlowSensitive/DataflowAnalysis.h"
|
|
#include "clang/Analysis/FlowSensitive/DataflowEnvironment.h"
|
|
#include "clang/Analysis/FlowSensitive/NoopLattice.h"
|
|
#include "clang/Basic/SourceLocation.h"
|
|
#include "llvm/ADT/SmallVector.h"
|
|
|
|
namespace clang {
|
|
namespace dataflow {
|
|
|
|
// FIXME: Explore using an allowlist-approach, where constructs supported by the
|
|
// analysis are always enabled and additional constructs are enabled through the
|
|
// `Options`.
|
|
struct UncheckedOptionalAccessModelOptions {
|
|
/// In generating diagnostics, ignore optionals reachable through overloaded
|
|
/// `operator*` or `operator->` (other than those of the optional type
|
|
/// itself). The analysis does not equate the results of such calls, so it
|
|
/// can't identify when their results are used safely (across calls),
|
|
/// resulting in false positives in all such cases. Note: this option does not
|
|
/// cover access through `operator[]`.
|
|
bool IgnoreSmartPointerDereference = false;
|
|
};
|
|
|
|
/// Dataflow analysis that models whether optionals hold values or not.
|
|
///
|
|
/// Models the `std::optional`, `absl::optional`, and `base::Optional` types.
|
|
class UncheckedOptionalAccessModel
|
|
: public DataflowAnalysis<UncheckedOptionalAccessModel, NoopLattice> {
|
|
public:
|
|
UncheckedOptionalAccessModel(ASTContext &Ctx, dataflow::Environment &Env);
|
|
|
|
/// Returns a matcher for the optional classes covered by this model.
|
|
static ast_matchers::DeclarationMatcher optionalClassDecl();
|
|
|
|
static NoopLattice initialElement() { return {}; }
|
|
|
|
void transfer(const CFGElement &Elt, NoopLattice &L, Environment &Env);
|
|
|
|
private:
|
|
CFGMatchSwitch<TransferState<NoopLattice>> TransferMatchSwitch;
|
|
};
|
|
|
|
class UncheckedOptionalAccessDiagnoser {
|
|
public:
|
|
UncheckedOptionalAccessDiagnoser(
|
|
UncheckedOptionalAccessModelOptions Options = {});
|
|
|
|
llvm::SmallVector<SourceLocation>
|
|
operator()(const CFGElement &Elt, ASTContext &Ctx,
|
|
const TransferStateForDiagnostics<NoopLattice> &State) {
|
|
return DiagnoseMatchSwitch(Elt, Ctx, State.Env);
|
|
}
|
|
|
|
private:
|
|
CFGMatchSwitch<const Environment, llvm::SmallVector<SourceLocation>>
|
|
DiagnoseMatchSwitch;
|
|
};
|
|
|
|
} // namespace dataflow
|
|
} // namespace clang
|
|
|
|
#endif // CLANG_ANALYSIS_FLOWSENSITIVE_MODELS_UNCHECKEDOPTIONALACCESSMODEL_H
|