Coverage Report

Created: 2021-04-13 08:44

/Users/buildslave/jenkins/workspace/coverage/llvm-project/clang/lib/StaticAnalyzer/Checkers/RetainCountChecker/RetainCountDiagnostics.h
Line
Count
Source (jump to first uncovered line)
1
//== RetainCountDiagnostics.h - Checks for leaks and other issues -*- C++ -*--//
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
//  This file defines diagnostics for RetainCountChecker, which implements
10
//  a reference count checker for Core Foundation and Cocoa on (Mac OS X).
11
//
12
//===----------------------------------------------------------------------===//
13
14
#ifndef LLVM_CLANG_LIB_STATICANALYZER_CHECKERS_RETAINCOUNTCHECKER_DIAGNOSTICS_H
15
#define LLVM_CLANG_LIB_STATICANALYZER_CHECKERS_RETAINCOUNTCHECKER_DIAGNOSTICS_H
16
17
#include "clang/Analysis/PathDiagnostic.h"
18
#include "clang/Analysis/RetainSummaryManager.h"
19
#include "clang/StaticAnalyzer/Core/BugReporter/BugType.h"
20
#include "clang/StaticAnalyzer/Core/BugReporter/BugReporterVisitors.h"
21
#include "clang/StaticAnalyzer/Core/PathSensitive/CallEvent.h"
22
23
namespace clang {
24
namespace ento {
25
namespace retaincountchecker {
26
27
class RefCountBug : public BugType {
28
public:
29
  enum RefCountBugKind {
30
    UseAfterRelease,
31
    ReleaseNotOwned,
32
    DeallocNotOwned,
33
    FreeNotOwned,
34
    OverAutorelease,
35
    ReturnNotOwnedForOwned,
36
    LeakWithinFunction,
37
    LeakAtReturn,
38
  };
39
  RefCountBug(CheckerNameRef Checker, RefCountBugKind BT);
40
  StringRef getDescription() const;
41
42
49.6k
  RefCountBugKind getBugType() const { return BT; }
43
44
private:
45
  RefCountBugKind BT;
46
  static StringRef bugTypeToName(RefCountBugKind BT);
47
};
48
49
class RefCountReport : public PathSensitiveBugReport {
50
protected:
51
  SymbolRef Sym;
52
  bool isLeak = false;
53
54
public:
55
  RefCountReport(const RefCountBug &D, const LangOptions &LOpts,
56
              ExplodedNode *n, SymbolRef sym,
57
              bool isLeak=false);
58
59
  RefCountReport(const RefCountBug &D, const LangOptions &LOpts,
60
              ExplodedNode *n, SymbolRef sym,
61
              StringRef endText);
62
63
639
  ArrayRef<SourceRange> getRanges() const override {
64
639
    if (!isLeak)
65
305
      return PathSensitiveBugReport::getRanges();
66
334
    return {};
67
639
  }
68
};
69
70
class RefLeakReport : public RefCountReport {
71
  const MemRegion* AllocBinding;
72
  const Stmt *AllocStmt;
73
  PathDiagnosticLocation Location;
74
75
  // Finds the function declaration where a leak warning for the parameter
76
  // 'sym' should be raised.
77
  void deriveParamLocation(CheckerContext &Ctx, SymbolRef sym);
78
  // Finds the location where a leak warning for 'sym' should be raised.
79
  void deriveAllocLocation(CheckerContext &Ctx, SymbolRef sym);
80
  // Produces description of a leak warning which is printed on the console.
81
  void createDescription(CheckerContext &Ctx);
82
83
public:
84
  RefLeakReport(const RefCountBug &D, const LangOptions &LOpts, ExplodedNode *n,
85
                SymbolRef sym, CheckerContext &Ctx);
86
1.13k
  PathDiagnosticLocation getLocation() const override {
87
1.13k
    assert(Location.isValid());
88
0
    return Location;
89
1.13k
  }
90
91
374
  PathDiagnosticLocation getEndOfPath() const {
92
374
    return PathSensitiveBugReport::getLocation();
93
374
  }
94
};
95
96
} // end namespace retaincountchecker
97
} // end namespace ento
98
} // end namespace clang
99
100
#endif