summaryrefslogtreecommitdiffstats
path: root/build/clang-plugin/tests/TestMustReturnFromCaller.cpp
blob: c935be3cf89383359cc0c68135d058740f7d79a4 (plain)
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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
#include <cstddef>
#include <utility>

#define MOZ_MUST_RETURN_FROM_CALLER_IF_THIS_IS_ARG __attribute__((annotate("moz_must_return_from_caller_if_this_is_arg")))
#define MOZ_MAY_CALL_AFTER_MUST_RETURN __attribute__((annotate("moz_may_call_after_must_return")))

struct Thrower {
  void MOZ_MUST_RETURN_FROM_CALLER_IF_THIS_IS_ARG Throw() {}
};

void DoAnythingElse();
int MakeAnInt();
int MOZ_MAY_CALL_AFTER_MUST_RETURN SafeMakeInt();
bool Condition();

// It might be nicer to #include "mozilla/ScopeExit.h" and use that here -- but
// doing so also will #define the two attribute-macros defined above, running a
// risk of redefinition errors.  Just stick to the normal clang-plugin test
// style and use as little external code as possible.

template<typename Func>
class ScopeExit {
  Func exitFunction;
  bool callOnDestruction;
public:
  explicit ScopeExit(Func&& func)
    : exitFunction(std::move(func))
    , callOnDestruction(true)
  {}

  ~ScopeExit() {
    if (callOnDestruction) {
      exitFunction();
    }
  }

  void release() { callOnDestruction = false; }
};

template<typename ExitFunction>
ScopeExit<ExitFunction>
MakeScopeExit(ExitFunction&& func)
{
  return ScopeExit<ExitFunction>(std::move(func));
}

class Foo {
public:
  __attribute__((annotate("moz_implicit"))) Foo(std::nullptr_t);
  Foo();
};

void a1(Thrower& thrower) {
  thrower.Throw();
}

int a2(Thrower& thrower) {
  thrower.Throw(); // expected-error {{You must immediately return after calling this function}}
  return MakeAnInt();
}

int a3(Thrower& thrower) {
  // RAII operations happening after a must-immediately-return are fine.
  auto atExit = MakeScopeExit([] { DoAnythingElse(); });
  thrower.Throw();
  return 5;
}

int a4(Thrower& thrower) {
  thrower.Throw(); // expected-error {{You must immediately return after calling this function}}
  return Condition() ? MakeAnInt() : MakeAnInt();
}

void a5(Thrower& thrower) {
  thrower.Throw(); // expected-error {{You must immediately return after calling this function}}
  DoAnythingElse();
}

int a6(Thrower& thrower) {
  thrower.Throw(); // expected-error {{You must immediately return after calling this function}}
  DoAnythingElse();
  return MakeAnInt();
}

int a7(Thrower& thrower) {
  thrower.Throw(); // expected-error {{You must immediately return after calling this function}}
  DoAnythingElse();
  return Condition() ? MakeAnInt() : MakeAnInt();
}

int a8(Thrower& thrower) {
  thrower.Throw();
  return SafeMakeInt();
}

int a9(Thrower& thrower) {
  if (Condition()) {
    thrower.Throw();
  }
  return SafeMakeInt();
}

int a10(Thrower& thrower) {
  auto atExit = MakeScopeExit([] { DoAnythingElse(); });

  if (Condition()) {
    thrower.Throw();
    return SafeMakeInt();
  }

  atExit.release();
  DoAnythingElse();
  return 5;
}

void b1(Thrower& thrower) {
  if (Condition()) {
    thrower.Throw();
  }
}

int b2(Thrower& thrower) {
  if (Condition()) {
    thrower.Throw(); // expected-error {{You must immediately return after calling this function}}
  }
  return MakeAnInt();
}

int b3(Thrower& thrower) {
  if (Condition()) {
    thrower.Throw();
  }
  return 5;
}

// Explicit test in orer to also verify the `UnaryOperator` node in the `CFG`
int b3a(Thrower& thrower) {
  if (Condition()) {
    thrower.Throw();
  }
  return -1;
}

float b3b(Thrower& thrower) {
  if (Condition()) {
    thrower.Throw();
  }
  return 1.0f;
}

bool b3c(Thrower& thrower) {
  if (Condition()) {
    thrower.Throw();
  }
  return false;
}

int b4(Thrower& thrower) {
  if (Condition()) {
    thrower.Throw(); // expected-error {{You must immediately return after calling this function}}
  }
  return Condition() ? MakeAnInt() : MakeAnInt();
}

void b5(Thrower& thrower) {
  if (Condition()) {
    thrower.Throw(); // expected-error {{You must immediately return after calling this function}}
  }
  DoAnythingElse();
}

void b6(Thrower& thrower) {
  if (Condition()) {
    thrower.Throw(); // expected-error {{You must immediately return after calling this function}}
    DoAnythingElse();
  }
}

void b7(Thrower& thrower) {
  if (Condition()) {
    thrower.Throw();
    return;
  }
  DoAnythingElse();
}

void b8(Thrower& thrower) {
  if (Condition()) {
    thrower.Throw(); // expected-error {{You must immediately return after calling this function}}
    DoAnythingElse();
    return;
  }
  DoAnythingElse();
}

void b9(Thrower& thrower) {
  while (Condition()) {
    thrower.Throw(); // expected-error {{You must immediately return after calling this function}}
  }
}

void b10(Thrower& thrower) {
  while (Condition()) {
    thrower.Throw();
    return;
  }
}

void b11(Thrower& thrower) {
  thrower.Throw(); // expected-error {{You must immediately return after calling this function}}
  if (Condition()) {
    return;
  } else {
    return;
  }
}

void b12(Thrower& thrower) {
  switch (MakeAnInt()) {
  case 1:
    break;
  default:
    thrower.Throw();
    return;
  }
}

void b13(Thrower& thrower) {
  if (Condition()) {
    thrower.Throw();
  }
  return;
}

Foo b14(Thrower& thrower) {
  if (Condition()) {
    thrower.Throw();
    return nullptr;
  }
  return nullptr;
}

Foo b15(Thrower& thrower) {
  if (Condition()) {
    thrower.Throw();
  }
  return nullptr;
}

Foo b16(Thrower& thrower) {
  if (Condition()) {
    thrower.Throw();
  }
  return Foo();
}

void c1() {
  Thrower thrower;
  thrower.Throw();
  DoAnythingElse(); // Should be allowed, since our thrower is not an arg
}

class TestRet {
  TestRet *b13(Thrower &thrower) {
    if (Condition()) {
      thrower.Throw();
    }
    return this;
  }
};