Use a worklist to avoid a sneaky iterator invalidation.
[oota-llvm.git] / lib / Transforms / IPO / Internalize.cpp
index 85a7abd10146e7470a066992cf9ec90ce275d00b..4bfab5b0afbd2c424603a74252d5c08042150319 100644 (file)
 //
 //                     The LLVM Compiler Infrastructure
 //
-// This file was developed by the LLVM research group and is distributed under
-// the University of Illinois Open Source License. See LICENSE.TXT for details.
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
 //
-// This pass loops over all of the functions in the input module, looking for a
-// main function.  If a main function is found, all other functions and all
-// global variables with initializers are marked as internal.
+// This pass loops over all of the functions and variables in the input module.
+// If the function or variable is not in the list of external names given to
+// the pass it is marked as internal.
 //
 //===----------------------------------------------------------------------===//
 
+#define DEBUG_TYPE "internalize"
 #include "llvm/Transforms/IPO.h"
+#include "llvm/ADT/Statistic.h"
+#include "llvm/Analysis/CallGraph.h"
+#include "llvm/IR/Module.h"
 #include "llvm/Pass.h"
-#include "llvm/Module.h"
 #include "llvm/Support/CommandLine.h"
 #include "llvm/Support/Debug.h"
-#include "llvm/ADT/Statistic.h"
+#include "llvm/Support/raw_ostream.h"
 #include <fstream>
 #include <set>
 using namespace llvm;
 
-namespace {
-  Statistic<> NumFunctions("internalize", "Number of functions internalized");
-  Statistic<> NumGlobals  ("internalize", "Number of global vars internalized");
+STATISTIC(NumAliases  , "Number of aliases internalized");
+STATISTIC(NumFunctions, "Number of functions internalized");
+STATISTIC(NumGlobals  , "Number of global vars internalized");
 
-  // APIFile - A file which contains a list of symbols that should not be marked
-  // external.
-  cl::opt<std::string>
-  APIFile("internalize-public-api-file", cl::value_desc("filename"),
-          cl::desc("A file containing list of symbol names to preserve"));
+// APIFile - A file which contains a list of symbols that should not be marked
+// external.
+static cl::opt<std::string>
+APIFile("internalize-public-api-file", cl::value_desc("filename"),
+        cl::desc("A file containing list of symbol names to preserve"));
 
-  // APIList - A list of symbols that should not be marked internal.
-  cl::list<std::string>
-  APIList("internalize-public-api-list", cl::value_desc("list"),
-          cl::desc("A list of symbol names to preserve"),
-          cl::CommaSeparated);
+// APIList - A list of symbols that should not be marked internal.
+static cl::list<std::string>
+APIList("internalize-public-api-list", cl::value_desc("list"),
+        cl::desc("A list of symbol names to preserve"),
+        cl::CommaSeparated);
 
+namespace {
   class InternalizePass : public ModulePass {
     std::set<std::string> ExternalNames;
   public:
-    InternalizePass() {
-      if (!APIFile.empty())           // If a filename is specified, use it
-        LoadFile(APIFile.c_str());
-      else                            // Else, if a list is specified, use it.
-        ExternalNames.insert(APIList.begin(), APIList.end());
+    static char ID; // Pass identification, replacement for typeid
+    explicit InternalizePass();
+    explicit InternalizePass(ArrayRef<const char *> exportList);
+    void LoadFile(const char *Filename);
+    void ClearExportList();
+    void AddToExportList(const std::string &val);
+    virtual bool runOnModule(Module &M);
+
+    virtual void getAnalysisUsage(AnalysisUsage &AU) const {
+      AU.setPreservesCFG();
+      AU.addPreserved<CallGraph>();
+    }
+  };
+} // end anonymous namespace
+
+char InternalizePass::ID = 0;
+INITIALIZE_PASS(InternalizePass, "internalize",
+                "Internalize Global Symbols", false, false)
+
+InternalizePass::InternalizePass()
+  : ModulePass(ID) {
+  initializeInternalizePassPass(*PassRegistry::getPassRegistry());
+  if (!APIFile.empty())           // If a filename is specified, use it.
+    LoadFile(APIFile.c_str());
+  if (!APIList.empty())           // If a list is specified, use it as well.
+    ExternalNames.insert(APIList.begin(), APIList.end());
+}
+
+InternalizePass::InternalizePass(ArrayRef<const char *> exportList)
+  : ModulePass(ID){
+  initializeInternalizePassPass(*PassRegistry::getPassRegistry());
+  for(ArrayRef<const char *>::const_iterator itr = exportList.begin();
+        itr != exportList.end(); itr++) {
+    ExternalNames.insert(*itr);
+  }
+}
+
+void InternalizePass::LoadFile(const char *Filename) {
+  // Load the APIFile...
+  std::ifstream In(Filename);
+  if (!In.good()) {
+    errs() << "WARNING: Internalize couldn't load file '" << Filename
+         << "'! Continuing as if it's empty.\n";
+    return; // Just continue as if the file were empty
+  }
+  while (In) {
+    std::string Symbol;
+    In >> Symbol;
+    if (!Symbol.empty())
+      ExternalNames.insert(Symbol);
+  }
+}
+
+void InternalizePass::ClearExportList() {
+  ExternalNames.clear();
+}
+
+void InternalizePass::AddToExportList(const std::string &val) {
+  ExternalNames.insert(val);
+}
+
+bool InternalizePass::runOnModule(Module &M) {
+  CallGraph *CG = getAnalysisIfAvailable<CallGraph>();
+  CallGraphNode *ExternalNode = CG ? CG->getExternalCallingNode() : 0;
+  bool Changed = false;
+
+  // Never internalize functions which code-gen might insert.
+  // FIXME: We should probably add this (and the __stack_chk_guard) via some
+  // type of call-back in CodeGen.
+  ExternalNames.insert("__stack_chk_fail");
+
+  // Mark all functions not in the api as internal.
+  // FIXME: maybe use private linkage?
+  for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
+    if (!I->isDeclaration() &&         // Function must be defined here
+        // Available externally is really just a "declaration with a body".
+        !I->hasAvailableExternallyLinkage() &&
+        !I->hasLocalLinkage() &&  // Can't already have internal linkage
+        !ExternalNames.count(I->getName())) {// Not marked to keep external?
+      I->setLinkage(GlobalValue::InternalLinkage);
+      // Remove a callgraph edge from the external node to this function.
+      if (ExternalNode) ExternalNode->removeOneAbstractEdgeTo((*CG)[I]);
+      Changed = true;
+      ++NumFunctions;
+      DEBUG(dbgs() << "Internalizing func " << I->getName() << "\n");
     }
 
-    void LoadFile(const char *Filename) {
-      // Load the APIFile...
-      std::ifstream In(Filename);
-      if (!In.good()) {
-        std::cerr << "WARNING: Internalize couldn't load file '" << Filename
-                  << "'!\n";
-        return;   // Do not internalize anything...
-      }
-      while (In) {
-        std::string Symbol;
-        In >> Symbol;
-        if (!Symbol.empty())
-          ExternalNames.insert(Symbol);
-      }
+  // Never internalize the llvm.used symbol.  It is used to implement
+  // attribute((used)).
+  // FIXME: Shouldn't this just filter on llvm.metadata section??
+  ExternalNames.insert("llvm.used");
+  ExternalNames.insert("llvm.compiler.used");
+
+  // Never internalize anchors used by the machine module info, else the info
+  // won't find them.  (see MachineModuleInfo.)
+  ExternalNames.insert("llvm.global_ctors");
+  ExternalNames.insert("llvm.global_dtors");
+  ExternalNames.insert("llvm.global.annotations");
+
+  // Never internalize symbols code-gen inserts.
+  ExternalNames.insert("__stack_chk_guard");
+
+  // Mark all global variables with initializers that are not in the api as
+  // internal as well.
+  // FIXME: maybe use private linkage?
+  for (Module::global_iterator I = M.global_begin(), E = M.global_end();
+       I != E; ++I)
+    if (!I->isDeclaration() && !I->hasLocalLinkage() &&
+        // Available externally is really just a "declaration with a body".
+        !I->hasAvailableExternallyLinkage() &&
+        !ExternalNames.count(I->getName())) {
+      I->setLinkage(GlobalValue::InternalLinkage);
+      Changed = true;
+      ++NumGlobals;
+      DEBUG(dbgs() << "Internalized gvar " << I->getName() << "\n");
     }
 
-    virtual bool runOnModule(Module &M) {
-      // If no list or file of symbols was specified, check to see if there is a
-      // "main" symbol defined in the module.  If so, use it, otherwise do not
-      // internalize the module, it must be a library or something.
-      //
-      if (ExternalNames.empty()) {
-        Function *MainFunc = M.getMainFunction();
-        if (MainFunc == 0 || MainFunc->isExternal())
-          return false;  // No main found, must be a library...
-
-        // Preserve main, internalize all else.
-        ExternalNames.insert(MainFunc->getName());
-      }
-
-      bool Changed = false;
-
-      // Found a main function, mark all functions not named main as internal.
-      for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
-        if (!I->isExternal() &&         // Function must be defined here
-            !I->hasInternalLinkage() &&  // Can't already have internal linkage
-            !ExternalNames.count(I->getName())) {// Not marked to keep external?
-          I->setLinkage(GlobalValue::InternalLinkage);
-          Changed = true;
-          ++NumFunctions;
-          DEBUG(std::cerr << "Internalizing func " << I->getName() << "\n");
-        }
-
-      // Mark all global variables with initializers as internal as well...
-      for (Module::global_iterator I = M.global_begin(), E = M.global_end(); I != E; ++I)
-        if (!I->isExternal() && !I->hasInternalLinkage() &&
-            !ExternalNames.count(I->getName())) {
-          // Special case handling of the global ctor and dtor list.  When we
-          // internalize it, we mark it constant, which allows elimination of
-          // the list if it's empty.
-          //
-          if (I->hasAppendingLinkage() && (I->getName() == "llvm.global_ctors"||
-                                           I->getName() == "llvm.global_dtors"))
-            I->setConstant(true);
-
-          I->setLinkage(GlobalValue::InternalLinkage);
-          Changed = true;
-          ++NumGlobals;
-          DEBUG(std::cerr << "Internalizing gvar " << I->getName() << "\n");
-        }
-
-      return Changed;
+  // Mark all aliases that are not in the api as internal as well.
+  for (Module::alias_iterator I = M.alias_begin(), E = M.alias_end();
+       I != E; ++I)
+    if (!I->isDeclaration() && !I->hasInternalLinkage() &&
+        // Available externally is really just a "declaration with a body".
+        !I->hasAvailableExternallyLinkage() &&
+        !ExternalNames.count(I->getName())) {
+      I->setLinkage(GlobalValue::InternalLinkage);
+      Changed = true;
+      ++NumAliases;
+      DEBUG(dbgs() << "Internalized alias " << I->getName() << "\n");
     }
-  };
 
-  RegisterOpt<InternalizePass> X("internalize", "Internalize Global Symbols");
-} // end anonymous namespace
+  return Changed;
+}
 
 ModulePass *llvm::createInternalizePass() {
   return new InternalizePass();
 }
+
+ModulePass *llvm::createInternalizePass(ArrayRef<const char *> el) {
+  return new InternalizePass(el);
+}