mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-10-19 16:25:38 +00:00
acd0e7d09c
Creates a NoNewThreadsChecker plugin that looks for the function and checks to see if it's allowed. -Creates two allowlists - `ThreadAllows.txt` is for thread names, while `ThreadFileAllows.txt` checks for entire files where instances of `NS_NewNamedThread` should be ignored. -If an instance of `NS_NewNamedThread` is not listed in either list, then the checker throws an error with an additional note containing a more descriptive explanation of the failure. Differential Revision: https://phabricator.services.mozilla.com/D62635 --HG-- extra : moz-landing-system : lando
37 lines
1.4 KiB
C++
37 lines
1.4 KiB
C++
/* 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/. */
|
|
|
|
#include "NoNewThreadsChecker.h"
|
|
#include "CustomMatchers.h"
|
|
|
|
void NoNewThreadsChecker::registerMatchers(MatchFinder *AstMatcher) {
|
|
// The checker looks for:
|
|
// -Instances of NS_NewNamedThread that aren't in allowed files
|
|
// -Instances of NS_NewNamedThread that use names that aren't recognized
|
|
AstMatcher->addMatcher(
|
|
callExpr(allOf(isFirstParty(),
|
|
callee(functionDecl(hasName("NS_NewNamedThread"))),
|
|
unless(isInAllowlistForThreads())))
|
|
.bind("funcCall"),
|
|
this);
|
|
}
|
|
|
|
void NoNewThreadsChecker::check(const MatchFinder::MatchResult &Result) {
|
|
const CallExpr *FuncCall = Result.Nodes.getNodeAs<CallExpr>("funcCall");
|
|
|
|
if (FuncCall) {
|
|
diag(FuncCall->getBeginLoc(),
|
|
"Thread name not recognized. Please use the background thread pool.",
|
|
DiagnosticIDs::Error)
|
|
<< FuncCall->getDirectCallee()->getName();
|
|
diag(
|
|
FuncCall->getBeginLoc(),
|
|
"NS_NewNamedThread has been deprecated in favor of background "
|
|
"task dispatch via NS_DispatchBackgroundTask and "
|
|
"NS_CreateBackgroundTaskQueue. If you must create a new ad-hoc thread, "
|
|
"have your thread name added to ThreadAllows.txt.",
|
|
DiagnosticIDs::Note);
|
|
}
|
|
}
|