--- /dev/null
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+
+//
+// This file is part of Lustre, http://www.lustre.org/
+//
+// cc-plugins/FindStatic.cpp
+//
+// Clang plugin to find functions which could be made
+// static.
+//
+// Author: Timothy Day <timday@amazon.com>
+//
+
+#include <clang/AST/AST.h>
+#include <clang/AST/ASTConsumer.h>
+#include <clang/AST/RecursiveASTVisitor.h>
+#include <clang/Frontend/CompilerInstance.h>
+#include <clang/Frontend/FrontendPluginRegistry.h>
+#include <clang/Sema/Sema.h>
+#include <llvm/Support/raw_ostream.h>
+
+using namespace clang;
+
+namespace {
+
+static std::unordered_map<std::string, int> functionMap;
+
+bool isWarnable(FunctionDecl *MethodDecl) {
+ auto isValidDef =
+ MethodDecl->isThisDeclarationADefinition() && MethodDecl->hasBody();
+ auto isNotDeclared =
+ (functionMap.count(MethodDecl->getNameAsString()) == 0);
+ auto isNotStatic = !MethodDecl->isStatic();
+ auto couldBeStatic =
+ MethodDecl->getASTContext().getSourceManager().isInMainFile(
+ MethodDecl->getLocation()) &&
+ !MethodDecl->isMain();
+
+ return isValidDef && isNotDeclared && isNotStatic && couldBeStatic;
+}
+
+class FindStaticDeclVisitor : public RecursiveASTVisitor<FindStaticDeclVisitor> {
+ DiagnosticsEngine &Diags;
+ unsigned WarningFoundStatic;
+
+public:
+ FindStaticDeclVisitor(DiagnosticsEngine &Diags) : Diags(Diags) {
+ WarningFoundStatic = Diags.getCustomDiagID(
+ DiagnosticsEngine::Warning, "Should this function be static?");
+ }
+
+ bool VisitFunctionDecl(FunctionDecl *MethodDecl) {
+ if (isWarnable(MethodDecl)) {
+ Diags.Report(MethodDecl->getLocation(), WarningFoundStatic);
+ }
+
+ return true;
+ }
+};
+
+class ScanDeclVisitor : public RecursiveASTVisitor<ScanDeclVisitor> {
+public:
+ bool VisitFunctionDecl(FunctionDecl *MethodDecl) {
+ if (!isWarnable(MethodDecl)) {
+ functionMap.insert({MethodDecl->getNameAsString(), 1});
+ }
+
+ return true;
+ }
+};
+
+class PrintFunctionsConsumer : public ASTConsumer {
+public:
+ void HandleTranslationUnit(ASTContext &Context) override {
+ ScanDeclVisitor Scanner;
+ Scanner.TraverseDecl(Context.getTranslationUnitDecl());
+
+ FindStaticDeclVisitor Visitor(Context.getDiagnostics());
+ Visitor.TraverseDecl(Context.getTranslationUnitDecl());
+ }
+};
+
+class FindStaticAction : public PluginASTAction {
+ std::set<std::string> ParsedTemplates;
+
+protected:
+ std::unique_ptr<ASTConsumer> CreateASTConsumer(CompilerInstance &CI,
+ llvm::StringRef) override {
+ return std::make_unique<PrintFunctionsConsumer>();
+ }
+
+ /// Consume plugin arguments; the plugin has no args, so always
+ /// succeed.
+ ///
+ /// \returns true when the parsing succeeds
+ bool ParseArgs(const CompilerInstance &CI,
+ const std::vector<std::string> &args) override {
+ return true;
+ }
+
+ /// Determines when to run action, in this case, automatically
+ /// after the main AST action.
+ ///
+ /// \returns when the action should run
+ PluginASTAction::ActionType getActionType() override {
+ return AddAfterMainAction;
+ }
+};
+
+} // namespace
+
+static FrontendPluginRegistry::Add<FindStaticAction>
+ X("find-static", "find potential static functions");
--- /dev/null
+# SPDX-License-Identifier: GPL-2.0
+
+#
+# This file is part of Lustre, http://www.lustre.org/
+#
+# config/lustre-compiler-plugins.m4
+#
+# Configure compliler plugin settings
+#
+
+#
+# LPLUG_ENABLE
+#
+# Simple flag to enable compiler plugins.
+#
+AC_DEFUN([LPLUG_ENABLE], [
+AC_ARG_ENABLE([compiler-plugins],
+ AS_HELP_STRING([--enable-compiler-plugins], [Enable compiler plugins]))
+
+AS_IF([test "x$enable_compiler_plugins" == "xyes"], [
+CFLAGS="$CFLAGS -fplugin=$(pwd)/cc-plugins/.libs/libfindstatic.so"
+], [])
+AM_CONDITIONAL([CC_PLUGINS], [test x$enable_compiler_plugins = xyes])
+]) # LPLUG_ENABLE
+
+#
+# LPLUG_CONFIGURE
+#
+# main configure steps
+#
+AC_DEFUN([LPLUG_CONFIGURE], [
+LPLUG_ENABLE
+]) # LPLUG_CONFIGURE
+
+#
+# LPLUG_CONFIG_FILES
+#
+# files that should be generated with AC_OUTPUT
+#
+AC_DEFUN([LPLUG_CONFIG_FILES], [
+AS_IF([test "x$enable_compiler_plugins" == "xyes"], [
+AC_CONFIG_FILES([
+cc-plugins/Makefile
+])
+], [])
+]) # LPLUG_CONFIG_FILES
git://git.whamcloud.com / fs / lustre-release.git / commitdiff