CloneModule.cpp revision dce4a407a24b04eebc6a376f8e62b41aaa7b071f
1c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)//===- CloneModule.cpp - Clone an entire module ---------------------------===// 2c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)// 3c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)// The LLVM Compiler Infrastructure 4c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)// 5c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)// This file is distributed under the University of Illinois Open Source 6c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)// License. See LICENSE.TXT for details. 7c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)// 8c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)//===----------------------------------------------------------------------===// 9c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)// 10c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)// This file implements the CloneModule interface which makes a copy of an 11c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)// entire module. 12c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)// 13c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)//===----------------------------------------------------------------------===// 140529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch 15c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)#include "llvm/Transforms/Utils/Cloning.h" 16c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)#include "llvm/IR/Constant.h" 17c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)#include "llvm/IR/DerivedTypes.h" 18c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)#include "llvm/IR/Module.h" 19c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)#include "llvm/Transforms/Utils/ValueMapper.h" 20c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)using namespace llvm; 21c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) 22c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)/// CloneModule - Return an exact copy of the specified module. This is not as 230529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch/// easy as it might seem because we have to worry about making copies of global 24c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)/// variables and functions, and making their (initializers and references, 25c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)/// respectively) refer to the right globals. 260529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch/// 27c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)Module *llvm::CloneModule(const Module *M) { 28c5cede9ae108bb15f6b7a8aea21c7e1fefa2834cBen Murdoch // Create the value map that maps things from the old module over to the new 29c5cede9ae108bb15f6b7a8aea21c7e1fefa2834cBen Murdoch // module. 30c5cede9ae108bb15f6b7a8aea21c7e1fefa2834cBen Murdoch ValueToValueMapTy VMap; 31c5cede9ae108bb15f6b7a8aea21c7e1fefa2834cBen Murdoch return CloneModule(M, VMap); 32c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)} 330529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch 340529e5d033099cbfc42635f6f6183833b09dff6eBen MurdochModule *llvm::CloneModule(const Module *M, ValueToValueMapTy &VMap) { 35c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // First off, we need to create the new module. 36c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) Module *New = new Module(M->getModuleIdentifier(), M->getContext()); 37c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) New->setDataLayout(M->getDataLayout()); 38c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) New->setTargetTriple(M->getTargetTriple()); 39c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) New->setModuleInlineAsm(M->getModuleInlineAsm()); 40c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) 41c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // Loop over all of the global variables, making corresponding globals in the 42c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // new module. Here we add them to the VMap and to the new Module. We 43c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // don't worry about attributes or initializers, they will come later. 44c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // 45c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) for (Module::const_global_iterator I = M->global_begin(), E = M->global_end(); 46cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) I != E; ++I) { 47c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) GlobalVariable *GV = new GlobalVariable(*New, 48c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) I->getType()->getElementType(), 49c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) I->isConstant(), I->getLinkage(), 50c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) (Constant*) nullptr, I->getName(), 51c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) (GlobalVariable*) nullptr, 520529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch I->getThreadLocalMode(), 530529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch I->getType()->getAddressSpace()); 540529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch GV->copyAttributesFrom(I); 550529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch VMap[I] = GV; 56c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) } 57c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) 58c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // Loop over the functions in the module, making external functions as before 59c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) for (Module::const_iterator I = M->begin(), E = M->end(); I != E; ++I) { 60c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) Function *NF = 61c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) Function::Create(cast<FunctionType>(I->getType()->getElementType()), 62c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) I->getLinkage(), I->getName(), New); 63c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) NF->copyAttributesFrom(I); 64c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) VMap[I] = NF; 65c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) } 66c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) 67c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // Loop over the aliases in the module 68c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) for (Module::const_alias_iterator I = M->alias_begin(), E = M->alias_end(); 69c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) I != E; ++I) { 70c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) auto *PTy = cast<PointerType>(I->getType()); 71c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) auto *GA = 72c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) GlobalAlias::create(PTy->getElementType(), PTy->getAddressSpace(), 73c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) I->getLinkage(), I->getName(), New); 74c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) GA->copyAttributesFrom(I); 75c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) VMap[I] = GA; 76c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) } 77c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) 78c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // Now that all of the things that global variable initializer can refer to 79c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // have been created, loop through and copy the global variable referrers 80c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // over... We also set the attributes on the global now. 81c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // 820529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch for (Module::const_global_iterator I = M->global_begin(), E = M->global_end(); 83c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) I != E; ++I) { 84c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) GlobalVariable *GV = cast<GlobalVariable>(VMap[I]); 850529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch if (I->hasInitializer()) 86c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) GV->setInitializer(MapValue(I->getInitializer(), VMap)); 87c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) } 88c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) 89c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // Similarly, copy over function bodies now... 90c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // 917d4cd473f85ac64c3747c96c277f9e506a0d2246Torne (Richard Coles) for (Module::const_iterator I = M->begin(), E = M->end(); I != E; ++I) { 92c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) Function *F = cast<Function>(VMap[I]); 930529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch if (!I->isDeclaration()) { 94c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) Function::arg_iterator DestI = F->arg_begin(); 95c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) for (Function::const_arg_iterator J = I->arg_begin(); J != I->arg_end(); 960529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch ++J) { 977d4cd473f85ac64c3747c96c277f9e506a0d2246Torne (Richard Coles) DestI->setName(J->getName()); 987d4cd473f85ac64c3747c96c277f9e506a0d2246Torne (Richard Coles) VMap[J] = DestI++; 997d4cd473f85ac64c3747c96c277f9e506a0d2246Torne (Richard Coles) } 100c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) 101c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) SmallVector<ReturnInst*, 8> Returns; // Ignore returns cloned. 102c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) CloneFunctionInto(F, I, VMap, /*ModuleLevelChanges=*/true, Returns); 1030529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch } 104c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) } 105c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) 106c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // And aliases 1070529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch for (Module::const_alias_iterator I = M->alias_begin(), E = M->alias_end(); 108c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) I != E; ++I) { 1090529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch GlobalAlias *GA = cast<GlobalAlias>(VMap[I]); 110c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) if (const GlobalObject *C = I->getAliasee()) 111c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) GA->setAliasee(cast<GlobalObject>(MapValue(C, VMap))); 112c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) } 113c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) 114c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // And named metadata.... 115c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) for (Module::const_named_metadata_iterator I = M->named_metadata_begin(), 1160529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch E = M->named_metadata_end(); I != E; ++I) { 1177d4cd473f85ac64c3747c96c277f9e506a0d2246Torne (Richard Coles) const NamedMDNode &NMD = *I; 118c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) NamedMDNode *NewNMD = New->getOrInsertNamedMetadata(NMD.getName()); 119c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) for (unsigned i = 0, e = NMD.getNumOperands(); i != e; ++i) 1200529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch NewNMD->addOperand(MapValue(NMD.getOperand(i), VMap)); 121c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) } 122c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) 1230529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch return New; 124c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)} 125c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)