clang-tools  14.0.0git
bugprone/ExceptionEscapeCheck.cpp
Go to the documentation of this file.
1 //===--- ExceptionEscapeCheck.cpp - clang-tidy ----------------------------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 
9 #include "ExceptionEscapeCheck.h"
10 
11 #include "clang/AST/ASTContext.h"
12 #include "clang/ASTMatchers/ASTMatchFinder.h"
13 #include "llvm/ADT/SmallSet.h"
14 #include "llvm/ADT/StringSet.h"
15 
16 using namespace clang::ast_matchers;
17 
18 namespace clang {
19 namespace {
20 AST_MATCHER_P(FunctionDecl, isEnabled, llvm::StringSet<>,
21  FunctionsThatShouldNotThrow) {
22  return FunctionsThatShouldNotThrow.count(Node.getNameAsString()) > 0;
23 }
24 } // namespace
25 
26 namespace tidy {
27 namespace bugprone {
28 ExceptionEscapeCheck::ExceptionEscapeCheck(StringRef Name,
29  ClangTidyContext *Context)
30  : ClangTidyCheck(Name, Context), RawFunctionsThatShouldNotThrow(Options.get(
31  "FunctionsThatShouldNotThrow", "")),
32  RawIgnoredExceptions(Options.get("IgnoredExceptions", "")) {
33  llvm::SmallVector<StringRef, 8> FunctionsThatShouldNotThrowVec,
34  IgnoredExceptionsVec;
35  StringRef(RawFunctionsThatShouldNotThrow)
36  .split(FunctionsThatShouldNotThrowVec, ",", -1, false);
37  FunctionsThatShouldNotThrow.insert(FunctionsThatShouldNotThrowVec.begin(),
38  FunctionsThatShouldNotThrowVec.end());
39 
40  llvm::StringSet<> IgnoredExceptions;
41  StringRef(RawIgnoredExceptions).split(IgnoredExceptionsVec, ",", -1, false);
42  IgnoredExceptions.insert(IgnoredExceptionsVec.begin(),
43  IgnoredExceptionsVec.end());
44  Tracer.ignoreExceptions(std::move(IgnoredExceptions));
45  Tracer.ignoreBadAlloc(true);
46 }
47 
49  Options.store(Opts, "FunctionsThatShouldNotThrow",
50  RawFunctionsThatShouldNotThrow);
51  Options.store(Opts, "IgnoredExceptions", RawIgnoredExceptions);
52 }
53 
54 void ExceptionEscapeCheck::registerMatchers(MatchFinder *Finder) {
55  Finder->addMatcher(
56  functionDecl(anyOf(isNoThrow(), cxxDestructorDecl(),
57  cxxConstructorDecl(isMoveConstructor()),
58  cxxMethodDecl(isMoveAssignmentOperator()),
59  hasName("main"), hasName("swap"),
60  isEnabled(FunctionsThatShouldNotThrow)))
61  .bind("thrower"),
62  this);
63 }
64 
65 void ExceptionEscapeCheck::check(const MatchFinder::MatchResult &Result) {
66  const auto *MatchedDecl = Result.Nodes.getNodeAs<FunctionDecl>("thrower");
67 
68  if (!MatchedDecl)
69  return;
70 
71  if (Tracer.analyze(MatchedDecl).getBehaviour() ==
73  // FIXME: We should provide more information about the exact location where
74  // the exception is thrown, maybe the full path the exception escapes
75  diag(MatchedDecl->getLocation(), "an exception may be thrown in function "
76  "%0 which should not throw exceptions")
77  << MatchedDecl;
78 }
79 
80 } // namespace bugprone
81 } // namespace tidy
82 } // namespace clang
clang::tidy::ClangTidyOptions::OptionMap
llvm::StringMap< ClangTidyValue > OptionMap
Definition: ClangTidyOptions.h:115
clang::tidy::bugprone::ExceptionEscapeCheck::storeOptions
void storeOptions(ClangTidyOptions::OptionMap &Opts) override
Should store all options supported by this check with their current values or default values for opti...
Definition: bugprone/ExceptionEscapeCheck.cpp:48
clang::tidy::utils::ExceptionAnalyzer::ignoreBadAlloc
void ignoreBadAlloc(bool ShallIgnore)
Definition: ExceptionAnalyzer.h:126
clang::tidy::utils::ExceptionAnalyzer::ignoreExceptions
void ignoreExceptions(llvm::StringSet<> ExceptionNames)
Definition: ExceptionAnalyzer.h:127
clang::tidy::ClangTidyCheck
Base class for all clang-tidy checks.
Definition: ClangTidyCheck.h:54
clang::ast_matchers
Definition: AbseilMatcher.h:14
clang::tidy::utils::ExceptionAnalyzer::ExceptionInfo::getBehaviour
State getBehaviour() const
Definition: ExceptionAnalyzer.h:61
clang::tidy::bugprone::ExceptionEscapeCheck::check
void check(const ast_matchers::MatchFinder::MatchResult &Result) override
ClangTidyChecks that register ASTMatchers should do the actual work in here.
clang::tidy::ClangTidyCheck::Options
OptionsView Options
Definition: ClangTidyCheck.h:416
clang::tidy::ClangTidyContext
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
Definition: ClangTidyDiagnosticConsumer.h:71
Name
static constexpr llvm::StringLiteral Name
Definition: UppercaseLiteralSuffixCheck.cpp:28
clang::tidy::ClangTidyCheck::diag
DiagnosticBuilder diag(SourceLocation Loc, StringRef Description, DiagnosticIDs::Level Level=DiagnosticIDs::Warning)
Add a diagnostic with the check's name.
Definition: ClangTidyCheck.cpp:25
ExceptionEscapeCheck.h
clang
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Definition: ApplyReplacements.h:27
clang::tidy::utils::ExceptionAnalyzer::State::Throwing
@ Throwing
The function can definitely throw given an AST.
clang::tidy::ClangTidyCheck::OptionsView::store
void store(ClangTidyOptions::OptionMap &Options, StringRef LocalName, StringRef Value) const
Stores an option with the check-local name LocalName with string value Value to Options.
Definition: ClangTidyCheck.cpp:120
clang::tidy::utils::ExceptionAnalyzer::analyze
ExceptionInfo analyze(const FunctionDecl *Func)
Definition: ExceptionAnalyzer.cpp:250
clang::tidy::bugprone::ExceptionEscapeCheck::registerMatchers
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.
clang::tidy::bugprone::AST_MATCHER_P
AST_MATCHER_P(FunctionDecl, parameterCountGE, unsigned, N)
Matches functions that have at least the specified amount of parameters.
Definition: EasilySwappableParametersCheck.cpp:1877