Home | History | Annotate | Line # | Download | only in IR 
      1 //===- AutoUpgrade.h - AutoUpgrade Helpers ----------------------*- C++ -*-===//
      2 //
      3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
      4 // See https://llvm.org/LICENSE.txt for license information.
      5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
      6 //
      7 //===----------------------------------------------------------------------===//
      8 //
      9 //  These functions are implemented by lib/IR/AutoUpgrade.cpp.
     10 //
     11 //===----------------------------------------------------------------------===//
     12 
     13 #ifndef LLVM_IR_AUTOUPGRADE_H
     14 #define LLVM_IR_AUTOUPGRADE_H
     15 
     16 #include "llvm/ADT/StringRef.h"
     17 
     18 namespace llvm {
     19   class AttrBuilder;
     20   class CallInst;
     21   class Constant;
     22   class Function;
     23   class Instruction;
     24   class MDNode;
     25   class Module;
     26   class GlobalVariable;
     27   class Type;
     28   class Value;
     29 
     30   /// This is a more granular function that simply checks an intrinsic function
     31   /// for upgrading, and returns true if it requires upgrading. It may return
     32   /// null in NewFn if the all calls to the original intrinsic function
     33   /// should be transformed to non-function-call instructions.
     34   bool UpgradeIntrinsicFunction(Function *F, Function *&NewFn);
     35 
     36   /// This is the complement to the above, replacing a specific call to an
     37   /// intrinsic function with a call to the specified new function.
     38   void UpgradeIntrinsicCall(CallInst *CI, Function *NewFn);
     39 
     40   // This upgrades the comment for objc retain release markers in inline asm
     41   // calls
     42   void UpgradeInlineAsmString(std::string *AsmStr);
     43 
     44   /// This is an auto-upgrade hook for any old intrinsic function syntaxes
     45   /// which need to have both the function updated as well as all calls updated
     46   /// to the new function. This should only be run in a post-processing fashion
     47   /// so that it can update all calls to the old function.
     48   void UpgradeCallsToIntrinsic(Function* F);
     49 
     50   /// This checks for global variables which should be upgraded. It it requires
     51   /// upgrading, returns a pointer to the upgraded variable.
     52   GlobalVariable *UpgradeGlobalVariable(GlobalVariable *GV);
     53 
     54   /// This checks for module flags which should be upgraded. It returns true if
     55   /// module is modified.
     56   bool UpgradeModuleFlags(Module &M);
     57 
     58   /// Convert calls to ARC runtime functions to intrinsic calls and upgrade the
     59   /// old retain release marker to new module flag format.
     60   void UpgradeARCRuntime(Module &M);
     61 
     62   void UpgradeSectionAttributes(Module &M);
     63 
     64   /// Correct any IR that is relying on old function attribute behavior.
     65   void UpgradeFunctionAttributes(Function &F);
     66 
     67   /// If the given TBAA tag uses the scalar TBAA format, create a new node
     68   /// corresponding to the upgrade to the struct-path aware TBAA format.
     69   /// Otherwise return the \p TBAANode itself.
     70   MDNode *UpgradeTBAANode(MDNode &TBAANode);
     71 
     72   /// This is an auto-upgrade for bitcast between pointers with different
     73   /// address spaces: the instruction is replaced by a pair ptrtoint+inttoptr.
     74   Instruction *UpgradeBitCastInst(unsigned Opc, Value *V, Type *DestTy,
     75                                   Instruction *&Temp);
     76 
     77   /// This is an auto-upgrade for bitcast constant expression between pointers
     78   /// with different address spaces: the instruction is replaced by a pair
     79   /// ptrtoint+inttoptr.
     80   Value *UpgradeBitCastExpr(unsigned Opc, Constant *C, Type *DestTy);
     81 
     82   /// Check the debug info version number, if it is out-dated, drop the debug
     83   /// info. Return true if module is modified.
     84   bool UpgradeDebugInfo(Module &M);
     85 
     86   /// Check whether a string looks like an old loop attachment tag.
     87   inline bool mayBeOldLoopAttachmentTag(StringRef Name) {
     88     return Name.startswith("llvm.vectorizer.");
     89   }
     90 
     91   /// Upgrade the loop attachment metadata node.
     92   MDNode *upgradeInstructionLoopAttachment(MDNode &N);
     93 
     94   /// Upgrade the datalayout string by adding a section for address space
     95   /// pointers.
     96   std::string UpgradeDataLayoutString(StringRef DL, StringRef Triple);
     97 
     98   /// Upgrade attributes that changed format or kind.
     99   void UpgradeAttributes(AttrBuilder &B);
    100 
    101 } // End llvm namespace
    102 
    103 #endif
    104