File: return-value-guaranteed.cpp

package info (click to toggle)
llvm-toolchain-19 1%3A19.1.7-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,998,520 kB
  • sloc: cpp: 6,951,680; ansic: 1,486,157; asm: 913,598; python: 232,024; f90: 80,126; objc: 75,281; lisp: 37,276; pascal: 16,990; sh: 10,009; ml: 5,058; perl: 4,724; awk: 3,523; makefile: 3,167; javascript: 2,504; xml: 892; fortran: 664; cs: 573
file content (91 lines) | stat: -rw-r--r-- 2,449 bytes parent folder | download | duplicates (7)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
// RUN: %clang_analyze_cc1 \
// RUN:  -analyzer-checker=core,apiModeling.llvm.ReturnValue \
// RUN:  -analyzer-output=text -verify %s

struct Foo { int Field; };
bool problem();
void doSomething();

// Test the normal case when the implementation of MCAsmParser::Error() (one of
// the methods modeled by this checker) is opaque.
namespace test_normal {
struct MCAsmParser {
  static bool Error();
};

bool parseFoo(Foo &F) {
  if (problem()) {
    // expected-note@-1 {{Assuming the condition is false}}
    // expected-note@-2 {{Taking false branch}}
    return MCAsmParser::Error();
  }

  F.Field = 0;
  // expected-note@-1 {{The value 0 is assigned to 'F.Field'}}
  return false;
}

bool parseFile() {
  Foo F;
  if (parseFoo(F)) {
    // expected-note@-1 {{Calling 'parseFoo'}}
    // expected-note@-2 {{Returning from 'parseFoo'}}
    // expected-note@-3 {{Taking false branch}}
    return true;
  }

  // The following expression would produce the false positive report
  //    "The left operand of '==' is a garbage value"
  // without the modeling done by apiModeling.llvm.ReturnValue:
  if (F.Field == 0) {
    // expected-note@-1 {{Field 'Field' is equal to 0}}
    // expected-note@-2 {{Taking true branch}}
    doSomething();
  }

  // Trigger a zero division to get path notes:
  (void)(1 / F.Field);
  // expected-warning@-1 {{Division by zero}}
  // expected-note@-2 {{Division by zero}}
  return false;
}
} // namespace test_normal


// Sanity check for the highly unlikely case where the implementation of the
// method breaks the convention.
namespace test_break {
struct MCAsmParser {
  static bool Error() {
    return false;
  }
};

bool parseFoo(Foo &F) {
  if (problem()) {
    // expected-note@-1 {{Assuming the condition is false}}
    // expected-note@-2 {{Taking false branch}}
    return !MCAsmParser::Error();
  }

  F.Field = 0;
  // expected-note@-1 {{The value 0 is assigned to 'F.Field'}}
  return MCAsmParser::Error();
  // expected-note@-1 {{'MCAsmParser::Error' returned false, breaking the convention that it always returns true}}
}

bool parseFile() {
  Foo F;
  if (parseFoo(F)) {
    // expected-note@-1 {{Calling 'parseFoo'}}
    // expected-note@-2 {{Returning from 'parseFoo'}}
    // expected-note@-3 {{Taking false branch}}
    return true;
  }

  (void)(1 / F.Field);
  // expected-warning@-1 {{Division by zero}}
  // expected-note@-2 {{Division by zero}}
  return false;
}
} // namespace test_break