2002-04-28 13:43:27 +08:00
|
|
|
//===-- Internalize.cpp - Mark functions internal -------------------------===//
|
2005-04-22 07:48:37 +08:00
|
|
|
//
|
2003-10-21 03:43:21 +08:00
|
|
|
// The LLVM Compiler Infrastructure
|
|
|
|
//
|
2007-12-30 04:36:04 +08:00
|
|
|
// This file is distributed under the University of Illinois Open Source
|
|
|
|
// License. See LICENSE.TXT for details.
|
2005-04-22 07:48:37 +08:00
|
|
|
//
|
2003-10-21 03:43:21 +08:00
|
|
|
//===----------------------------------------------------------------------===//
|
2002-04-28 13:43:27 +08:00
|
|
|
//
|
|
|
|
// This pass loops over all of the functions in the input module, looking for a
|
2002-07-31 03:48:44 +08:00
|
|
|
// main function. If a main function is found, all other functions and all
|
|
|
|
// global variables with initializers are marked as internal.
|
2002-04-28 13:43:27 +08:00
|
|
|
//
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
|
2006-12-20 06:09:18 +08:00
|
|
|
#define DEBUG_TYPE "internalize"
|
2008-10-03 15:36:09 +08:00
|
|
|
#include "llvm/Analysis/CallGraph.h"
|
2002-07-25 01:12:05 +08:00
|
|
|
#include "llvm/Transforms/IPO.h"
|
2002-04-28 13:43:27 +08:00
|
|
|
#include "llvm/Pass.h"
|
|
|
|
#include "llvm/Module.h"
|
2004-09-02 06:55:40 +08:00
|
|
|
#include "llvm/Support/CommandLine.h"
|
|
|
|
#include "llvm/Support/Debug.h"
|
2009-07-25 08:23:56 +08:00
|
|
|
#include "llvm/Support/raw_ostream.h"
|
2004-09-02 06:55:40 +08:00
|
|
|
#include "llvm/ADT/Statistic.h"
|
2003-05-23 03:34:49 +08:00
|
|
|
#include <fstream>
|
|
|
|
#include <set>
|
2003-11-22 05:54:22 +08:00
|
|
|
using namespace llvm;
|
2003-11-12 06:41:34 +08:00
|
|
|
|
2009-01-06 05:24:45 +08:00
|
|
|
STATISTIC(NumAliases , "Number of aliases internalized");
|
2006-12-20 06:09:18 +08:00
|
|
|
STATISTIC(NumFunctions, "Number of functions internalized");
|
|
|
|
STATISTIC(NumGlobals , "Number of global vars internalized");
|
|
|
|
|
2008-05-13 08:00:25 +08:00
|
|
|
// 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"));
|
2003-05-23 03:48:00 +08:00
|
|
|
|
2008-05-13 08:00:25 +08:00
|
|
|
// 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);
|
2005-04-22 07:48:37 +08:00
|
|
|
|
2008-05-13 08:00:25 +08:00
|
|
|
namespace {
|
2009-10-25 14:33:48 +08:00
|
|
|
class InternalizePass : public ModulePass {
|
2003-05-23 03:34:49 +08:00
|
|
|
std::set<std::string> ExternalNames;
|
2008-05-15 04:01:01 +08:00
|
|
|
/// If no api symbols were specified and a main function is defined,
|
|
|
|
/// assume the main function is the only API
|
|
|
|
bool AllButMain;
|
2003-05-23 03:34:49 +08:00
|
|
|
public:
|
2007-05-06 21:37:16 +08:00
|
|
|
static char ID; // Pass identification, replacement for typeid
|
2008-06-24 17:14:10 +08:00
|
|
|
explicit InternalizePass(bool AllButMain = true);
|
2007-08-01 23:32:29 +08:00
|
|
|
explicit InternalizePass(const std::vector <const char *>& exportList);
|
2006-01-04 03:13:17 +08:00
|
|
|
void LoadFile(const char *Filename);
|
|
|
|
virtual bool runOnModule(Module &M);
|
2008-10-01 06:04:30 +08:00
|
|
|
|
|
|
|
virtual void getAnalysisUsage(AnalysisUsage &AU) const {
|
|
|
|
AU.setPreservesCFG();
|
2008-10-03 15:36:09 +08:00
|
|
|
AU.addPreserved<CallGraph>();
|
2008-10-01 06:04:30 +08:00
|
|
|
}
|
2006-01-04 03:13:17 +08:00
|
|
|
};
|
|
|
|
} // end anonymous namespace
|
2002-11-09 04:34:21 +08:00
|
|
|
|
2008-05-13 08:00:25 +08:00
|
|
|
char InternalizePass::ID = 0;
|
2010-07-22 06:09:45 +08:00
|
|
|
INITIALIZE_PASS(InternalizePass, "internalize",
|
|
|
|
"Internalize Global Symbols", false, false);
|
2008-05-13 08:00:25 +08:00
|
|
|
|
2008-05-15 04:01:01 +08:00
|
|
|
InternalizePass::InternalizePass(bool AllButMain)
|
2010-08-06 07:42:04 +08:00
|
|
|
: ModulePass(ID), AllButMain(AllButMain){
|
2008-05-15 04:01:01 +08:00
|
|
|
if (!APIFile.empty()) // If a filename is specified, use it.
|
2006-01-04 03:13:17 +08:00
|
|
|
LoadFile(APIFile.c_str());
|
2008-05-15 04:01:01 +08:00
|
|
|
if (!APIList.empty()) // If a list is specified, use it as well.
|
2006-01-04 03:13:17 +08:00
|
|
|
ExternalNames.insert(APIList.begin(), APIList.end());
|
|
|
|
}
|
2003-05-23 03:34:49 +08:00
|
|
|
|
2009-01-06 04:38:27 +08:00
|
|
|
InternalizePass::InternalizePass(const std::vector<const char *>&exportList)
|
2010-08-06 07:42:04 +08:00
|
|
|
: ModulePass(ID), AllButMain(false){
|
2006-07-21 01:48:05 +08:00
|
|
|
for(std::vector<const char *>::const_iterator itr = exportList.begin();
|
2007-04-17 02:10:23 +08:00
|
|
|
itr != exportList.end(); itr++) {
|
2006-07-21 01:48:05 +08:00
|
|
|
ExternalNames.insert(*itr);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2006-01-04 03:13:17 +08:00
|
|
|
void InternalizePass::LoadFile(const char *Filename) {
|
|
|
|
// Load the APIFile...
|
|
|
|
std::ifstream In(Filename);
|
|
|
|
if (!In.good()) {
|
2009-08-23 15:05:07 +08:00
|
|
|
errs() << "WARNING: Internalize couldn't load file '" << Filename
|
2008-05-15 04:01:01 +08:00
|
|
|
<< "'! Continuing as if it's empty.\n";
|
|
|
|
return; // Just continue as if the file were empty
|
2006-01-04 03:13:17 +08:00
|
|
|
}
|
|
|
|
while (In) {
|
|
|
|
std::string Symbol;
|
|
|
|
In >> Symbol;
|
|
|
|
if (!Symbol.empty())
|
|
|
|
ExternalNames.insert(Symbol);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
bool InternalizePass::runOnModule(Module &M) {
|
2009-01-28 21:14:17 +08:00
|
|
|
CallGraph *CG = getAnalysisIfAvailable<CallGraph>();
|
2008-10-03 15:36:09 +08:00
|
|
|
CallGraphNode *ExternalNode = CG ? CG->getExternalCallingNode() : 0;
|
2009-07-17 02:04:31 +08:00
|
|
|
|
2006-01-04 03:13:17 +08:00
|
|
|
if (ExternalNames.empty()) {
|
2008-05-15 04:01:01 +08:00
|
|
|
// Return if we're not in 'all but main' mode and have no external api
|
|
|
|
if (!AllButMain)
|
2009-01-06 04:38:27 +08:00
|
|
|
return false;
|
2008-05-15 04:01:01 +08:00
|
|
|
// 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.
|
|
|
|
//
|
2007-02-06 05:19:13 +08:00
|
|
|
Function *MainFunc = M.getFunction("main");
|
2007-01-31 04:08:39 +08:00
|
|
|
if (MainFunc == 0 || MainFunc->isDeclaration())
|
2006-01-04 03:13:17 +08:00
|
|
|
return false; // No main found, must be a library...
|
2009-01-06 04:38:27 +08:00
|
|
|
|
2006-01-04 03:13:17 +08:00
|
|
|
// Preserve main, internalize all else.
|
|
|
|
ExternalNames.insert(MainFunc->getName());
|
|
|
|
}
|
2009-01-06 04:38:27 +08:00
|
|
|
|
2006-01-04 03:13:17 +08:00
|
|
|
bool Changed = false;
|
2009-01-06 04:38:27 +08:00
|
|
|
|
2008-05-15 04:01:01 +08:00
|
|
|
// Mark all functions not in the api as internal.
|
2009-01-16 04:18:42 +08:00
|
|
|
// FIXME: maybe use private linkage?
|
2006-01-04 03:13:17 +08:00
|
|
|
for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
|
2007-01-31 04:08:39 +08:00
|
|
|
if (!I->isDeclaration() && // Function must be defined here
|
2009-01-16 04:18:42 +08:00
|
|
|
!I->hasLocalLinkage() && // Can't already have internal linkage
|
2006-01-04 03:13:17 +08:00
|
|
|
!ExternalNames.count(I->getName())) {// Not marked to keep external?
|
|
|
|
I->setLinkage(GlobalValue::InternalLinkage);
|
2008-10-03 15:36:09 +08:00
|
|
|
// Remove a callgraph edge from the external node to this function.
|
|
|
|
if (ExternalNode) ExternalNode->removeOneAbstractEdgeTo((*CG)[I]);
|
2006-01-04 03:13:17 +08:00
|
|
|
Changed = true;
|
|
|
|
++NumFunctions;
|
2010-01-05 09:28:07 +08:00
|
|
|
DEBUG(dbgs() << "Internalizing func " << I->getName() << "\n");
|
2006-01-04 03:13:17 +08:00
|
|
|
}
|
2009-01-06 04:38:27 +08:00
|
|
|
|
2006-01-04 03:13:17 +08:00
|
|
|
// Never internalize the llvm.used symbol. It is used to implement
|
|
|
|
// attribute((used)).
|
2009-07-20 14:14:25 +08:00
|
|
|
// FIXME: Shouldn't this just filter on llvm.metadata section??
|
2006-01-04 03:13:17 +08:00
|
|
|
ExternalNames.insert("llvm.used");
|
2009-07-20 14:14:25 +08:00
|
|
|
ExternalNames.insert("llvm.compiler.used");
|
2009-01-06 04:38:27 +08:00
|
|
|
|
2007-01-27 05:22:28 +08:00
|
|
|
// Never internalize anchors used by the machine module info, else the info
|
|
|
|
// won't find them. (see MachineModuleInfo.)
|
2006-03-08 04:53:47 +08:00
|
|
|
ExternalNames.insert("llvm.dbg.compile_units");
|
|
|
|
ExternalNames.insert("llvm.dbg.global_variables");
|
|
|
|
ExternalNames.insert("llvm.dbg.subprograms");
|
2007-06-07 04:51:41 +08:00
|
|
|
ExternalNames.insert("llvm.global_ctors");
|
|
|
|
ExternalNames.insert("llvm.global_dtors");
|
2007-10-03 11:59:15 +08:00
|
|
|
ExternalNames.insert("llvm.noinline");
|
2007-10-04 01:05:40 +08:00
|
|
|
ExternalNames.insert("llvm.global.annotations");
|
2009-01-06 04:38:27 +08:00
|
|
|
|
2008-05-15 04:01:01 +08:00
|
|
|
// Mark all global variables with initializers that are not in the api as
|
|
|
|
// internal as well.
|
2009-01-16 04:18:42 +08:00
|
|
|
// FIXME: maybe use private linkage?
|
2006-01-04 03:13:17 +08:00
|
|
|
for (Module::global_iterator I = M.global_begin(), E = M.global_end();
|
|
|
|
I != E; ++I)
|
2009-01-16 04:18:42 +08:00
|
|
|
if (!I->isDeclaration() && !I->hasLocalLinkage() &&
|
2010-04-03 13:24:50 +08:00
|
|
|
// Available externally is really just a "declaration with a body".
|
|
|
|
!I->hasAvailableExternallyLinkage() &&
|
2006-01-04 03:13:17 +08:00
|
|
|
!ExternalNames.count(I->getName())) {
|
|
|
|
I->setLinkage(GlobalValue::InternalLinkage);
|
|
|
|
Changed = true;
|
|
|
|
++NumGlobals;
|
2010-01-05 09:28:07 +08:00
|
|
|
DEBUG(dbgs() << "Internalized gvar " << I->getName() << "\n");
|
2002-07-31 03:48:44 +08:00
|
|
|
}
|
2009-01-06 04:38:27 +08:00
|
|
|
|
2009-01-06 05:24:45 +08:00
|
|
|
// 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() &&
|
2010-04-03 13:24:50 +08:00
|
|
|
// Available externally is really just a "declaration with a body".
|
|
|
|
!I->hasAvailableExternallyLinkage() &&
|
2009-01-06 05:24:45 +08:00
|
|
|
!ExternalNames.count(I->getName())) {
|
|
|
|
I->setLinkage(GlobalValue::InternalLinkage);
|
|
|
|
Changed = true;
|
|
|
|
++NumAliases;
|
2010-01-05 09:28:07 +08:00
|
|
|
DEBUG(dbgs() << "Internalized alias " << I->getName() << "\n");
|
2009-01-06 05:24:45 +08:00
|
|
|
}
|
|
|
|
|
2006-01-04 03:13:17 +08:00
|
|
|
return Changed;
|
|
|
|
}
|
2002-07-24 02:06:35 +08:00
|
|
|
|
2008-06-24 17:14:10 +08:00
|
|
|
ModulePass *llvm::createInternalizePass(bool AllButMain) {
|
|
|
|
return new InternalizePass(AllButMain);
|
2002-04-28 13:43:27 +08:00
|
|
|
}
|
2006-07-21 01:48:05 +08:00
|
|
|
|
2006-07-21 02:03:39 +08:00
|
|
|
ModulePass *llvm::createInternalizePass(const std::vector <const char *> &el) {
|
|
|
|
return new InternalizePass(el);
|
2006-07-21 01:48:05 +08:00
|
|
|
}
|