Stephen Hines | c6ca60f | 2023-05-09 02:19:22 -0700 | [diff] [blame^] | 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 | #include <vector> |
| 18 | |
| 19 | namespace llvm { |
| 20 | class AttrBuilder; |
| 21 | class CallBase; |
| 22 | class Constant; |
| 23 | class Function; |
| 24 | class Instruction; |
| 25 | class GlobalVariable; |
| 26 | class MDNode; |
| 27 | class Module; |
| 28 | class StringRef; |
| 29 | class Type; |
| 30 | class Value; |
| 31 | |
| 32 | template <typename T> class OperandBundleDefT; |
| 33 | using OperandBundleDef = OperandBundleDefT<Value *>; |
| 34 | |
| 35 | /// This is a more granular function that simply checks an intrinsic function |
| 36 | /// for upgrading, and returns true if it requires upgrading. It may return |
| 37 | /// null in NewFn if the all calls to the original intrinsic function |
| 38 | /// should be transformed to non-function-call instructions. |
| 39 | bool UpgradeIntrinsicFunction(Function *F, Function *&NewFn); |
| 40 | |
| 41 | /// This is the complement to the above, replacing a specific call to an |
| 42 | /// intrinsic function with a call to the specified new function. |
| 43 | void UpgradeIntrinsicCall(CallBase *CB, Function *NewFn); |
| 44 | |
| 45 | // This upgrades the comment for objc retain release markers in inline asm |
| 46 | // calls |
| 47 | void UpgradeInlineAsmString(std::string *AsmStr); |
| 48 | |
| 49 | /// This is an auto-upgrade hook for any old intrinsic function syntaxes |
| 50 | /// which need to have both the function updated as well as all calls updated |
| 51 | /// to the new function. This should only be run in a post-processing fashion |
| 52 | /// so that it can update all calls to the old function. |
| 53 | void UpgradeCallsToIntrinsic(Function* F); |
| 54 | |
| 55 | /// This checks for global variables which should be upgraded. It it requires |
| 56 | /// upgrading, returns a pointer to the upgraded variable. |
| 57 | GlobalVariable *UpgradeGlobalVariable(GlobalVariable *GV); |
| 58 | |
| 59 | /// This checks for module flags which should be upgraded. It returns true if |
| 60 | /// module is modified. |
| 61 | bool UpgradeModuleFlags(Module &M); |
| 62 | |
| 63 | /// Convert calls to ARC runtime functions to intrinsic calls and upgrade the |
| 64 | /// old retain release marker to new module flag format. |
| 65 | void UpgradeARCRuntime(Module &M); |
| 66 | |
| 67 | void UpgradeSectionAttributes(Module &M); |
| 68 | |
| 69 | /// Correct any IR that is relying on old function attribute behavior. |
| 70 | void UpgradeFunctionAttributes(Function &F); |
| 71 | |
| 72 | /// If the given TBAA tag uses the scalar TBAA format, create a new node |
| 73 | /// corresponding to the upgrade to the struct-path aware TBAA format. |
| 74 | /// Otherwise return the \p TBAANode itself. |
| 75 | MDNode *UpgradeTBAANode(MDNode &TBAANode); |
| 76 | |
| 77 | /// This is an auto-upgrade for bitcast between pointers with different |
| 78 | /// address spaces: the instruction is replaced by a pair ptrtoint+inttoptr. |
| 79 | Instruction *UpgradeBitCastInst(unsigned Opc, Value *V, Type *DestTy, |
| 80 | Instruction *&Temp); |
| 81 | |
| 82 | /// This is an auto-upgrade for bitcast constant expression between pointers |
| 83 | /// with different address spaces: the instruction is replaced by a pair |
| 84 | /// ptrtoint+inttoptr. |
| 85 | Constant *UpgradeBitCastExpr(unsigned Opc, Constant *C, Type *DestTy); |
| 86 | |
| 87 | /// Check the debug info version number, if it is out-dated, drop the debug |
| 88 | /// info. Return true if module is modified. |
| 89 | bool UpgradeDebugInfo(Module &M); |
| 90 | |
| 91 | /// Check whether a string looks like an old loop attachment tag. |
| 92 | inline bool mayBeOldLoopAttachmentTag(StringRef Name) { |
| 93 | return Name.startswith("llvm.vectorizer."); |
| 94 | } |
| 95 | |
| 96 | /// Upgrade the loop attachment metadata node. |
| 97 | MDNode *upgradeInstructionLoopAttachment(MDNode &N); |
| 98 | |
| 99 | /// Upgrade the datalayout string by adding a section for address space |
| 100 | /// pointers. |
| 101 | std::string UpgradeDataLayoutString(StringRef DL, StringRef Triple); |
| 102 | |
| 103 | /// Upgrade attributes that changed format or kind. |
| 104 | void UpgradeAttributes(AttrBuilder &B); |
| 105 | |
| 106 | /// Upgrade operand bundles (without knowing about their user instruction). |
| 107 | void UpgradeOperandBundles(std::vector<OperandBundleDef> &OperandBundles); |
| 108 | |
| 109 | } // End llvm namespace |
| 110 | |
| 111 | #endif |