137ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines//===-- SymbolRewriter.h - Symbol Rewriting Pass ----------------*- C++ -*-===// 237ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines// 337ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines// The LLVM Compiler Infrastructure 437ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines// 537ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines// This file is distributed under the University of Illinois Open Source 637ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines// License. See LICENSE.TXT for details. 737ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines// 837ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines//===----------------------------------------------------------------------===// 937ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines// 1037ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines// This file provides the prototypes and definitions related to the Symbol 1137ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines// Rewriter pass. 1237ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines// 1337ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines// The Symbol Rewriter pass takes a set of rewrite descriptors which define 1437ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines// transformations for symbol names. These can be either single name to name 1537ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines// trnsformation or more broad regular expression based transformations. 1637ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines// 1737ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines// All the functions are re-written at the IR level. The Symbol Rewriter itself 1837ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines// is exposed as a module level pass. All symbols at the module level are 1937ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines// iterated. For any matching symbol, the requested transformation is applied, 2037ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines// updating references to it as well (a la RAUW). The resulting binary will 2137ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines// only contain the rewritten symbols. 2237ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines// 2337ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines// By performing this operation in the compiler, we are able to catch symbols 2437ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines// that would otherwise not be possible to catch (e.g. inlined symbols). 2537ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines// 2637ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines// This makes it possible to cleanly transform symbols without resorting to 2737ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines// overly-complex macro tricks and the pre-processor. An example of where this 2837ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines// is useful is the sanitizers where we would like to intercept a well-defined 2937ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines// set of functions across the module. 3037ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines// 3137ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines//===----------------------------------------------------------------------===// 3237ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines 3337ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines#ifndef LLVM_TRANSFORMS_UTILS_SYMBOL_REWRITER_H 3437ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines#define LLVM_TRANSFORMS_UTILS_SYMBOL_REWRITER_H 3537ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines 3637ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines#include "llvm/ADT/ilist.h" 3737ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines#include "llvm/ADT/ilist_node.h" 3837ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines#include "llvm/IR/Module.h" 3937ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines 4037ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hinesnamespace llvm { 4137ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hinesclass MemoryBuffer; 4237ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines 4337ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hinesnamespace yaml { 4437ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hinesclass KeyValueNode; 4537ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hinesclass MappingNode; 4637ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hinesclass ScalarNode; 4737ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hinesclass Stream; 4837ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines} 4937ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines 5037ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hinesnamespace SymbolRewriter { 5137ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines/// The basic entity representing a rewrite operation. It serves as the base 5237ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines/// class for any rewrite descriptor. It has a certain set of specializations 5337ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines/// which describe a particular rewrite. 5437ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines/// 5537ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines/// The RewriteMapParser can be used to parse a mapping file that provides the 5637ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines/// mapping for rewriting the symbols. The descriptors individually describe 5737ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines/// whether to rewrite a function, global variable, or global alias. Each of 5837ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines/// these can be selected either by explicitly providing a name for the ones to 5937ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines/// be rewritten or providing a (posix compatible) regular expression that will 6037ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines/// select the symbols to rewrite. This descriptor list is passed to the 6137ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines/// SymbolRewriter pass. 6237ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hinesclass RewriteDescriptor : public ilist_node<RewriteDescriptor> { 63ebe69fe11e48d322045d5949c83283927a0d790bStephen Hines RewriteDescriptor(const RewriteDescriptor &) = delete; 6437ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines 6537ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines const RewriteDescriptor & 66ebe69fe11e48d322045d5949c83283927a0d790bStephen Hines operator=(const RewriteDescriptor &) = delete; 6737ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines 6837ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hinespublic: 6937ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines enum class Type { 7037ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines Invalid, /// invalid 7137ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines Function, /// function - descriptor rewrites a function 7237ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines GlobalVariable, /// global variable - descriptor rewrites a global variable 7337ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines NamedAlias, /// named alias - descriptor rewrites a global alias 7437ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines }; 7537ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines 7637ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines virtual ~RewriteDescriptor() {} 7737ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines 7837ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines Type getType() const { return Kind; } 7937ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines 8037ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines virtual bool performOnModule(Module &M) = 0; 8137ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines 8237ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hinesprotected: 8337ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines explicit RewriteDescriptor(Type T) : Kind(T) {} 8437ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines 8537ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hinesprivate: 8637ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines const Type Kind; 8737ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines}; 8837ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines 8937ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hinestypedef iplist<RewriteDescriptor> RewriteDescriptorList; 9037ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines 9137ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hinesclass RewriteMapParser { 9237ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hinespublic: 9337ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines bool parse(const std::string &MapFile, RewriteDescriptorList *Descriptors); 9437ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines 9537ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hinesprivate: 9637ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines bool parse(std::unique_ptr<MemoryBuffer> &MapFile, RewriteDescriptorList *DL); 9737ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines bool parseEntry(yaml::Stream &Stream, yaml::KeyValueNode &Entry, 9837ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines RewriteDescriptorList *DL); 9937ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines bool parseRewriteFunctionDescriptor(yaml::Stream &Stream, 10037ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines yaml::ScalarNode *Key, 10137ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines yaml::MappingNode *Value, 10237ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines RewriteDescriptorList *DL); 10337ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines bool parseRewriteGlobalVariableDescriptor(yaml::Stream &Stream, 10437ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines yaml::ScalarNode *Key, 10537ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines yaml::MappingNode *Value, 10637ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines RewriteDescriptorList *DL); 10737ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines bool parseRewriteGlobalAliasDescriptor(yaml::Stream &YS, yaml::ScalarNode *K, 10837ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines yaml::MappingNode *V, 10937ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines RewriteDescriptorList *DL); 11037ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines}; 11137ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines} 11237ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines 11337ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hinestemplate <> 11437ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hinesstruct ilist_traits<SymbolRewriter::RewriteDescriptor> 11537ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines : public ilist_default_traits<SymbolRewriter::RewriteDescriptor> { 11637ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines mutable ilist_half_node<SymbolRewriter::RewriteDescriptor> Sentinel; 11737ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines 11837ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hinespublic: 11937ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines // createSentinel is used to get a reference to a node marking the end of 12037ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines // the list. Because the sentinel is relative to this instance, use a 12137ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines // non-static method. 12237ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines SymbolRewriter::RewriteDescriptor *createSentinel() const { 12337ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines // since i[p] lists always publicly derive from the corresponding 12437ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines // traits, placing a data member in this class will augment the 12537ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines // i[p]list. Since the NodeTy is expected to publicly derive from 12637ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines // ilist_node<NodeTy>, there is a legal viable downcast from it to 12737ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines // NodeTy. We use this trick to superpose i[p]list with a "ghostly" 12837ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines // NodeTy, which becomes the sentinel. Dereferencing the sentinel is 12937ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines // forbidden (save the ilist_node<NodeTy>) so no one will ever notice 13037ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines // the superposition. 13137ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines return static_cast<SymbolRewriter::RewriteDescriptor *>(&Sentinel); 13237ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines } 13337ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines void destroySentinel(SymbolRewriter::RewriteDescriptor *) {} 13437ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines 13537ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines SymbolRewriter::RewriteDescriptor *provideInitialHead() const { 13637ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines return createSentinel(); 13737ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines } 13837ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines 13937ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines SymbolRewriter::RewriteDescriptor * 14037ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines ensureHead(SymbolRewriter::RewriteDescriptor *&) const { 14137ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines return createSentinel(); 14237ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines } 14337ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines 14437ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines static void noteHead(SymbolRewriter::RewriteDescriptor *, 14537ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines SymbolRewriter::RewriteDescriptor *) {} 14637ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines}; 14737ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines 14837ed9c199ca639565f6ce88105f9e39e898d82d0Stephen HinesModulePass *createRewriteSymbolsPass(); 14937ed9c199ca639565f6ce88105f9e39e898d82d0Stephen HinesModulePass *createRewriteSymbolsPass(SymbolRewriter::RewriteDescriptorList &); 15037ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines} 15137ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines 15237ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines#endif 153