contrib/llvm-project/llvm/include/llvm/IR/AutoUpgrade.h

   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 CallInst;
  20   class Constant;
  21   class Function;
  22   class Instruction;
  23   class MDNode;
  24   class Module;
  25   class GlobalVariable;
  26   class Type;
  27   class Value;
  28
  29   /// This is a more granular function that simply checks an intrinsic function
  30   /// for upgrading, and returns true if it requires upgrading. It may return
  31   /// null in NewFn if the all calls to the original intrinsic function
  32   /// should be transformed to non-function-call instructions.
  33   bool UpgradeIntrinsicFunction(Function *F, Function *&NewFn);
  34
  35   /// This is the complement to the above, replacing a specific call to an
  36   /// intrinsic function with a call to the specified new function.
  37   void UpgradeIntrinsicCall(CallInst *CI, Function *NewFn);
  38
  39   // This upgrades the comment for objc retain release markers in inline asm
  40   // calls
  41   void UpgradeInlineAsmString(std::string *AsmStr);
  42
  43   /// This is an auto-upgrade hook for any old intrinsic function syntaxes
  44   /// which need to have both the function updated as well as all calls updated
  45   /// to the new function. This should only be run in a post-processing fashion
  46   /// so that it can update all calls to the old function.
  47   void UpgradeCallsToIntrinsic(Function* F);
  48
  49   /// This checks for global variables which should be upgraded. It it requires
  50   /// upgrading, returns a pointer to the upgraded variable.
  51   GlobalVariable *UpgradeGlobalVariable(GlobalVariable *GV);
  52
  53   /// This checks for module flags which should be upgraded. It returns true if
  54   /// module is modified.
  55   bool UpgradeModuleFlags(Module &M);
  56
  57   /// This checks for objc retain release marker which should be upgraded. It
  58   /// returns true if module is modified.
  59   bool UpgradeRetainReleaseMarker(Module &M);
  60
  61   void UpgradeSectionAttributes(Module &M);
  62
  63   /// If the given TBAA tag uses the scalar TBAA format, create a new node
  64   /// corresponding to the upgrade to the struct-path aware TBAA format.
  65   /// Otherwise return the \p TBAANode itself.
  66   MDNode *UpgradeTBAANode(MDNode &TBAANode);
  67
  68   /// This is an auto-upgrade for bitcast between pointers with different
  69   /// address spaces: the instruction is replaced by a pair ptrtoint+inttoptr.
  70   Instruction *UpgradeBitCastInst(unsigned Opc, Value *V, Type *DestTy,
  71                                   Instruction *&Temp);
  72
  73   /// This is an auto-upgrade for bitcast constant expression between pointers
  74   /// with different address spaces: the instruction is replaced by a pair
  75   /// ptrtoint+inttoptr.
  76   Value *UpgradeBitCastExpr(unsigned Opc, Constant *C, Type *DestTy);
  77
  78   /// Check the debug info version number, if it is out-dated, drop the debug
  79   /// info. Return true if module is modified.
  80   bool UpgradeDebugInfo(Module &M);
  81
  82   /// Check whether a string looks like an old loop attachment tag.
  83   inline bool mayBeOldLoopAttachmentTag(StringRef Name) {
  84     return Name.startswith("llvm.vectorizer.");
  85   }
  86
  87   /// Upgrade the loop attachment metadata node.
  88   MDNode *upgradeInstructionLoopAttachment(MDNode &N);
  89
  90 } // End llvm namespace
  91
  92 #endif