BlinkGCPlugin.cpp revision 5d1f7b1de12d16ceb2c938c56701a3e8bfa558f7
15d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)// Copyright 2014 The Chromium Authors. All rights reserved.
25d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be
35d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)// found in the LICENSE file.
45d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)
55d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)// This clang plugin checks various invariants of the Blink garbage
65d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)// collection infrastructure.
75d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)//
85d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)// Checks that are implemented:
95d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)// [currently none]
105d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)
115d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)#include "Config.h"
125d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)
135d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)#include "clang/AST/AST.h"
145d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)#include "clang/AST/ASTConsumer.h"
155d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)#include "clang/Frontend/CompilerInstance.h"
165d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)#include "clang/Frontend/FrontendPluginRegistry.h"
175d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)
185d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)using namespace clang;
195d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)using std::string;
205d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)
215d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)namespace {
225d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)
235d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)struct BlinkGCPluginOptions {
245d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)  BlinkGCPluginOptions() {
255d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)  }
265d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)};
275d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)
285d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)// Main class containing checks for various invariants of the Blink
295d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)// garbage collection infrastructure.
305d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)class BlinkGCPluginConsumer : public ASTConsumer {
315d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) public:
325d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)  BlinkGCPluginConsumer(CompilerInstance& instance,
335d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)                        const BlinkGCPluginOptions& options) {
345d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)  }
355d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)
365d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)  virtual void HandleTranslationUnit(ASTContext& context) {
375d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)    // FIXME: implement consistency checks.
385d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)  }
395d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)};
405d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)
415d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)
425d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)class BlinkGCPluginAction : public PluginASTAction {
435d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) public:
445d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)  BlinkGCPluginAction() {
455d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)  }
465d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)
475d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) protected:
485d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)  // Overridden from PluginASTAction:
495d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)  virtual ASTConsumer* CreateASTConsumer(CompilerInstance& instance,
505d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)                                         llvm::StringRef ref) {
515d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)    return new BlinkGCPluginConsumer(instance, options_);
525d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)  }
535d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)
545d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)  virtual bool ParseArgs(const CompilerInstance& instance,
555d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)                         const std::vector<string>& args) {
565d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)    bool parsed = true;
575d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)
585d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)    for (size_t i = 0; i < args.size() && parsed; ++i) {
595d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)      if (args[i] == "enable-oilpan") {
605d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)        // TODO: Remove this once all transition types are eliminated.
615d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)        Config::set_oilpan_enabled(true);
625d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)      } else {
635d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)        parsed = false;
645d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)        llvm::errs() << "Unknown blink-gc-plugin argument: " << args[i] << "\n";
655d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)      }
665d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)    }
675d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)
685d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)    return parsed;
695d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)  }
705d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)
715d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) private:
725d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)  BlinkGCPluginOptions options_;
735d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)};
745d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)
755d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)}  // namespace
765d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)
775d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)bool Config::oilpan_enabled_ = false;
785d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)
795d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)static FrontendPluginRegistry::Add<BlinkGCPluginAction>
805d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)X("blink-gc-plugin", "Check Blink GC invariants");
81