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
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
|
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
/**
* This checker implements the "can run script" analysis. The idea is to detect
* functions that can run script that are being passed reference-counted
* arguments (including "this") whose refcount might go to zero as a result of
* the script running. We want to prevent that.
*
* The approach is to attempt to enforce the following invariants on the call
* graph:
*
* 1) Any caller of a MOZ_CAN_RUN_SCRIPT function is itself MOZ_CAN_RUN_SCRIPT.
* 2) If a virtual MOZ_CAN_RUN_SCRIPT method overrides a base class method,
* that base class method is also MOZ_CAN_RUN_SCRIPT.
*
* Invariant 2 ensures that we don't accidentally call a MOZ_CAN_RUN_SCRIPT
* function via a base-class virtual call. Invariant 1 ensures that
* the property of being able to run script propagates up the callstack. There
* is an opt-out for invariant 1: A function (declaration _or_ implementation)
* can be decorated with MOZ_CAN_RUN_SCRIPT_BOUNDARY to indicate that we do not
* require it or any of its callers to be MOZ_CAN_RUN_SCRIPT even if it calls
* MOZ_CAN_RUN_SCRIPT functions.
*
* There are two known holes in invariant 1, apart from the
* MOZ_CAN_RUN_SCRIPT_BOUNDARY opt-out:
*
* - Functions called via function pointers can be MOZ_CAN_RUN_SCRIPT even if
* their caller is not, because we have no way to determine from the function
* pointer what function is being called.
* - MOZ_CAN_RUN_SCRIPT destructors can happen in functions that are not
* MOZ_CAN_RUN_SCRIPT.
* https://bugzilla.mozilla.org/show_bug.cgi?id=1535523 tracks this.
*
* Given those invariants we then require that when calling a MOZ_CAN_RUN_SCRIPT
* function all refcounted arguments (including "this") satisfy one of these
* conditions:
* a) The argument is held via a strong pointer on the stack.
* b) The argument is a const strong pointer member of "this". We know "this"
* is being kept alive, and a const strong pointer member can't drop its ref
* until "this" dies.
* c) The argument is an argument of the caller (and hence held by a strong
* pointer somewhere higher up the callstack).
* d) The argument is explicitly annotated with MOZ_KnownLive, which indicates
* that something is guaranteed to keep it alive (e.g. it's rooted via a JS
* reflector).
* e) The argument is constexpr and therefore cannot disappear.
*/
#include "CanRunScriptChecker.h"
#include "CustomMatchers.h"
#include "clang/Lex/Lexer.h"
void CanRunScriptChecker::registerMatchers(MatchFinder *AstMatcher) {
auto Refcounted = qualType(hasDeclaration(cxxRecordDecl(isRefCounted())));
auto StackSmartPtr = ignoreTrivials(declRefExpr(to(varDecl(
hasAutomaticStorageDuration(), hasType(isSmartPtrToRefCounted())))));
auto ConstMemberOfThisSmartPtr =
memberExpr(hasType(isSmartPtrToRefCounted()), hasType(isConstQualified()),
hasObjectExpression(cxxThisExpr()));
// A smartptr can be known-live for three reasons:
// 1) It's declared on the stack.
// 2) It's a const member of "this". We know "this" is alive (recursively)
// and const members can't change their value hence can't drop their
// reference until "this" gets destroyed.
// 3) It's an immediate temporary being constructed at the point where the
// call is happening.
auto KnownLiveSmartPtr = anyOf(
StackSmartPtr, ConstMemberOfThisSmartPtr,
ignoreTrivials(cxxConstructExpr(hasType(isSmartPtrToRefCounted()))));
auto MozKnownLiveCall =
ignoreTrivials(callExpr(callee(functionDecl(hasName("MOZ_KnownLive")))));
// Params of the calling function are presumed live, because it itself should
// be MOZ_CAN_RUN_SCRIPT. Note that this is subject to
// https://bugzilla.mozilla.org/show_bug.cgi?id=1537656 at the moment.
auto KnownLiveParam = anyOf(
// "this" is OK
cxxThisExpr(),
// A parameter of the calling function is OK.
declRefExpr(to(parmVarDecl())));
auto KnownLiveMemberOfParam =
memberExpr(hasKnownLiveAnnotation(),
hasObjectExpression(anyOf(
ignoreTrivials(KnownLiveParam),
declRefExpr(to(varDecl(hasAutomaticStorageDuration()))))));
// A matcher that matches various things that are known to be live directly,
// without making any assumptions about operators.
auto KnownLiveBaseExceptRef = anyOf(
// Things that are known to be a stack or immutable refptr.
KnownLiveSmartPtr,
// MOZ_KnownLive() calls.
MozKnownLiveCall,
// Params of the caller function.
KnownLiveParam,
// Members of the params that are marked as MOZ_KNOWN_LIVE
KnownLiveMemberOfParam,
// Constexpr things.
declRefExpr(to(varDecl(isConstexpr()))));
// A reference of smart ptr which is initialized with known live thing is OK.
// FIXME: This does not allow nested references.
auto RefToKnownLivePtr = ignoreTrivials(declRefExpr(to(varDecl(
hasAutomaticStorageDuration(), hasType(referenceType()),
hasInitializer(anyOf(
KnownLiveSmartPtr, KnownLiveParam, KnownLiveMemberOfParam,
conditionalOperator(
hasFalseExpression(ignoreTrivials(anyOf(
KnownLiveSmartPtr, KnownLiveParam, KnownLiveMemberOfParam,
declRefExpr(to(varDecl(isConstexpr()))),
// E.g., for RefPtr<T>::operator*()
cxxOperatorCallExpr(
hasOverloadedOperatorName("*"),
hasAnyArgument(
anyOf(KnownLiveBaseExceptRef,
ignoreTrivials(KnownLiveMemberOfParam))),
argumentCountIs(1)),
// E.g., for *T
unaryOperator(unaryDereferenceOperator(),
hasUnaryOperand(
ignoreTrivials(KnownLiveBaseExceptRef)))))),
hasTrueExpression(ignoreTrivials(anyOf(
KnownLiveSmartPtr, KnownLiveParam, KnownLiveMemberOfParam,
declRefExpr(to(varDecl(isConstexpr()))),
// E.g., for RefPtr<T>::operator*()
cxxOperatorCallExpr(
hasOverloadedOperatorName("*"),
hasAnyArgument(
anyOf(KnownLiveBaseExceptRef,
ignoreTrivials(KnownLiveMemberOfParam))),
argumentCountIs(1)),
// E.g., for *T
unaryOperator(unaryDereferenceOperator(),
hasUnaryOperand(ignoreTrivials(
KnownLiveBaseExceptRef)))))))))))));
// A matcher that matches various things that are known to be live directly,
// without making any assumptions about operators.
auto KnownLiveBase =
anyOf(KnownLiveBaseExceptRef,
// Smart pointer refs initialized with known live smart ptrs.
RefToKnownLivePtr);
// A matcher that matches various known-live things that don't involve
// non-unary operators.
auto KnownLiveSimple = anyOf(
// Things that are just known live.
KnownLiveBase,
// Method calls on a live things that are smart ptrs. Note that we don't
// want to allow general method calls on live things, because those can
// return non-live objects (e.g. consider "live_pointer->foo()" as an
// example). For purposes of this analysis we are assuming the method
// calls on smart ptrs all just return the pointer inside,
cxxMemberCallExpr(
on(anyOf(allOf(hasType(isSmartPtrToRefCounted()), KnownLiveBase),
// Allow it if calling a member method which is marked as
// MOZ_KNOWN_LIVE
KnownLiveMemberOfParam))),
// operator* or operator-> on a thing that is already known to be live.
cxxOperatorCallExpr(
hasAnyOverloadedOperatorName("*", "->"),
hasAnyArgument(
anyOf(KnownLiveBase, ignoreTrivials(KnownLiveMemberOfParam))),
argumentCountIs(1)),
// A dereference on a thing that is known to be live. This is _not_
// caught by the "operator* or operator->" clause above, because
// cxxOperatorCallExpr() only catches cases when a class defines
// operator*. The default (built-in) operator* matches unaryOperator()
// instead.),
unaryOperator(
unaryDereferenceOperator(),
hasUnaryOperand(
// If we're doing *someArg, the argument of the dereference is an
// ImplicitCastExpr LValueToRValue which has the DeclRefExpr as an
// argument. We could try to match that explicitly with a custom
// matcher (none of the built-in matchers seem to match on the
// thing being cast for an implicitCastExpr), but it's simpler to
// just use ignoreTrivials to strip off the cast.
ignoreTrivials(KnownLiveBase))),
// Taking a pointer to a live reference. We explicitly want to exclude
// things that are not of type reference-to-refcounted or type refcounted,
// because if someone takes a pointer to a pointer to refcounted or a
// pointer to a smart ptr and passes those in to a callee that definitely
// does not guarantee liveness; in fact the callee could modify those
// things! In practice they would be the wrong type anyway, though, so
// it's hard to add a test for this.
unaryOperator(hasOperatorName("&"),
hasUnaryOperand(allOf(anyOf(hasType(references(Refcounted)),
hasType(Refcounted)),
ignoreTrivials(KnownLiveBase)))));
auto KnownLive = anyOf(
// Anything above, of course.
KnownLiveSimple,
// Conditional operators where both arms are live.
conditionalOperator(hasFalseExpression(ignoreTrivials(KnownLiveSimple)),
hasTrueExpression(ignoreTrivials(KnownLiveSimple)))
// We're not handling cases like a dereference of a conditional operator,
// mostly because handling a dereference in general is so ugly. I
// _really_ wish I could just write a recursive matcher here easily.
);
auto InvalidArg = ignoreTrivialsConditional(
// We want to consider things if there is anything refcounted involved,
// including in any of the trivials that we otherwise strip off.
anyOf(hasType(Refcounted), hasType(pointsTo(Refcounted)),
hasType(references(Refcounted)), hasType(isSmartPtrToRefCounted())),
// We want to find any expression,
expr(
// which is not known live,
unless(KnownLive),
// and which is not a default arg with value nullptr, since those are
// always safe,
unless(cxxDefaultArgExpr(isNullDefaultArg())),
// and which is not a literal nullptr,
unless(cxxNullPtrLiteralExpr()), expr().bind("invalidArg")));
// A matcher which will mark the first invalid argument it finds invalid, but
// will always match, even if it finds no invalid arguments, so it doesn't
// preclude other matchers from running and maybe finding invalid args.
auto OptionalInvalidExplicitArg = anyOf(
// We want to find any argument which is invalid.
hasAnyArgument(InvalidArg),
// This makes this matcher optional.
anything());
// Please note that the hasCanRunScriptAnnotation() matchers are not present
// directly in the cxxMemberCallExpr, callExpr and constructExpr matchers
// because we check that the corresponding functions can run script later in
// the checker code.
AstMatcher->addMatcher(
expr(
anyOf(
// We want to match a method call expression,
cxxMemberCallExpr(
// which optionally has an invalid arg,
OptionalInvalidExplicitArg,
// or which optionally has an invalid this argument,
anyOf(on(InvalidArg), anything()), expr().bind("callExpr")),
// or a regular call expression,
callExpr(
// which optionally has an invalid arg.
OptionalInvalidExplicitArg, expr().bind("callExpr")),
// or a construct expression,
cxxConstructExpr(
// which optionally has an invalid arg.
OptionalInvalidExplicitArg, expr().bind("constructExpr"))),
anyOf(
// We want to match the parent function.
forFunction(functionDecl().bind("nonCanRunScriptParentFunction")),
// ... optionally.
anything())),
this);
}
void CanRunScriptChecker::onStartOfTranslationUnit() {
IsFuncSetBuilt = false;
CanRunScriptFuncs.clear();
}
namespace {
/// This class is a callback used internally to match function declarations with
/// the MOZ_CAN_RUN_SCRIPT annotation, adding these functions to the
/// can-run-script function set and making sure the functions they override (if
/// any) also have the annotation.
class FuncSetCallback : public MatchFinder::MatchCallback {
public:
FuncSetCallback(CanRunScriptChecker &Checker,
std::unordered_set<const FunctionDecl *> &FuncSet)
: CanRunScriptFuncs(FuncSet), Checker(Checker) {}
void run(const MatchFinder::MatchResult &Result) override;
private:
/// This method checks the methods overriden by the given parameter.
void checkOverriddenMethods(const CXXMethodDecl *Method);
std::unordered_set<const FunctionDecl *> &CanRunScriptFuncs;
CanRunScriptChecker &Checker;
};
void FuncSetCallback::run(const MatchFinder::MatchResult &Result) {
const FunctionDecl *Func;
if (auto *Lambda = Result.Nodes.getNodeAs<LambdaExpr>("lambda")) {
Func = Lambda->getCallOperator();
if (!Func || !hasCustomAttribute<moz_can_run_script>(Func))
return;
} else {
Func = Result.Nodes.getNodeAs<FunctionDecl>("canRunScriptFunction");
const char *ErrorAttrInDefinition =
"MOZ_CAN_RUN_SCRIPT must be put in front "
"of the declaration, not the definition";
const char *NoteAttrInDefinition = "The first declaration exists here";
if (!Func->isFirstDecl() &&
!hasCustomAttribute<moz_can_run_script_for_definition>(Func)) {
const FunctionDecl *FirstDecl = Func->getFirstDecl();
if (!hasCustomAttribute<moz_can_run_script>(FirstDecl)) {
Checker.diag(Func->getLocation(), ErrorAttrInDefinition,
DiagnosticIDs::Error);
Checker.diag(FirstDecl->getLocation(), NoteAttrInDefinition,
DiagnosticIDs::Note);
}
}
}
CanRunScriptFuncs.insert(Func);
// If this is a method, we check the methods it overrides.
if (auto *Method = dyn_cast<CXXMethodDecl>(Func)) {
checkOverriddenMethods(Method);
}
}
void FuncSetCallback::checkOverriddenMethods(const CXXMethodDecl *Method) {
for (auto OverriddenMethod : Method->overridden_methods()) {
if (!hasCustomAttribute<moz_can_run_script>(OverriddenMethod)) {
const char *ErrorNonCanRunScriptOverridden =
"functions marked as MOZ_CAN_RUN_SCRIPT cannot override functions "
"that are not marked MOZ_CAN_RUN_SCRIPT";
const char *NoteNonCanRunScriptOverridden =
"overridden function declared here";
Checker.diag(Method->getLocation(), ErrorNonCanRunScriptOverridden,
DiagnosticIDs::Error);
Checker.diag(OverriddenMethod->getLocation(),
NoteNonCanRunScriptOverridden, DiagnosticIDs::Note);
}
}
}
} // namespace
void CanRunScriptChecker::buildFuncSet(ASTContext *Context) {
// We create a match finder.
MatchFinder Finder;
// We create the callback which will be called when we find a function with
// a MOZ_CAN_RUN_SCRIPT annotation.
FuncSetCallback Callback(*this, CanRunScriptFuncs);
// We add the matcher to the finder, linking it to our callback.
Finder.addMatcher(
functionDecl(hasCanRunScriptAnnotation()).bind("canRunScriptFunction"),
&Callback);
Finder.addMatcher(lambdaExpr().bind("lambda"), &Callback);
// We start the analysis, given the ASTContext our main checker is in.
Finder.matchAST(*Context);
}
void CanRunScriptChecker::check(const MatchFinder::MatchResult &Result) {
// If the set of functions which can run script is not yet built, then build
// it.
if (!IsFuncSetBuilt) {
buildFuncSet(Result.Context);
IsFuncSetBuilt = true;
}
const char *ErrorInvalidArg =
"arguments must all be strong refs or caller's parameters when calling a "
"function marked as MOZ_CAN_RUN_SCRIPT (including the implicit object "
"argument). '%0' is neither.";
const char *ErrorNonCanRunScriptParent =
"functions marked as MOZ_CAN_RUN_SCRIPT can only be called from "
"functions also marked as MOZ_CAN_RUN_SCRIPT";
const char *NoteNonCanRunScriptParent = "caller function declared here";
const Expr *InvalidArg;
if (const CXXDefaultArgExpr *defaultArg =
Result.Nodes.getNodeAs<CXXDefaultArgExpr>("invalidArg")) {
InvalidArg = defaultArg->getExpr();
} else {
InvalidArg = Result.Nodes.getNodeAs<Expr>("invalidArg");
}
const CallExpr *Call = Result.Nodes.getNodeAs<CallExpr>("callExpr");
// If we don't find the FunctionDecl linked to this call or if it's not marked
// as can-run-script, consider that we didn't find a match.
if (Call && (!Call->getDirectCallee() ||
!CanRunScriptFuncs.count(Call->getDirectCallee()))) {
Call = nullptr;
}
const CXXConstructExpr *Construct =
Result.Nodes.getNodeAs<CXXConstructExpr>("constructExpr");
// If we don't find the CXXConstructorDecl linked to this construct expression
// or if it's not marked as can-run-script, consider that we didn't find a
// match.
if (Construct && (!Construct->getConstructor() ||
!CanRunScriptFuncs.count(Construct->getConstructor()))) {
Construct = nullptr;
}
const FunctionDecl *ParentFunction =
Result.Nodes.getNodeAs<FunctionDecl>("nonCanRunScriptParentFunction");
// If the parent function can run script, consider that we didn't find a match
// because we only care about parent functions which can't run script.
//
// In addition, If the parent function is annotated as a
// CAN_RUN_SCRIPT_BOUNDARY, we don't want to complain about it calling a
// CAN_RUN_SCRIPT function. This is a mechanism to opt out of the infectious
// nature of CAN_RUN_SCRIPT which is necessary in some tricky code like
// Bindings.
if (ParentFunction &&
(CanRunScriptFuncs.count(ParentFunction) ||
hasCustomAttribute<moz_can_run_script_boundary>(ParentFunction))) {
ParentFunction = nullptr;
}
// Get the call range from either the CallExpr or the ConstructExpr.
SourceRange CallRange;
if (Call) {
CallRange = Call->getSourceRange();
} else if (Construct) {
CallRange = Construct->getSourceRange();
} else {
// If we have neither a Call nor a Construct, we have nothing do to here.
return;
}
// If we have an invalid argument in the call, we emit the diagnostic to
// signal it.
if (InvalidArg) {
const StringRef invalidArgText = Lexer::getSourceText(
CharSourceRange::getTokenRange(InvalidArg->getSourceRange()),
Result.Context->getSourceManager(), Result.Context->getLangOpts());
diag(InvalidArg->getExprLoc(), ErrorInvalidArg, DiagnosticIDs::Error)
<< InvalidArg->getSourceRange() << invalidArgText;
}
// If the parent function is not marked as MOZ_CAN_RUN_SCRIPT, we emit an
// error and a not indicating it.
if (ParentFunction) {
assert(!hasCustomAttribute<moz_can_run_script>(ParentFunction) &&
"Matcher missed something");
diag(CallRange.getBegin(), ErrorNonCanRunScriptParent, DiagnosticIDs::Error)
<< CallRange;
diag(ParentFunction->getCanonicalDecl()->getLocation(),
NoteNonCanRunScriptParent, DiagnosticIDs::Note);
}
}
|