xref: /openbsd-src/gnu/llvm/llvm/lib/Target/BPF/BPFAbstractMemberAccess.cpp (revision d415bd752c734aee168c4ee86ff32e8cc249eb16)
109467b48Spatrick //===------ BPFAbstractMemberAccess.cpp - Abstracting Member Accesses -----===//
209467b48Spatrick //
309467b48Spatrick // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
409467b48Spatrick // See https://llvm.org/LICENSE.txt for license information.
509467b48Spatrick // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
609467b48Spatrick //
709467b48Spatrick //===----------------------------------------------------------------------===//
809467b48Spatrick //
909467b48Spatrick // This pass abstracted struct/union member accesses in order to support
1009467b48Spatrick // compile-once run-everywhere (CO-RE). The CO-RE intends to compile the program
1109467b48Spatrick // which can run on different kernels. In particular, if bpf program tries to
1209467b48Spatrick // access a particular kernel data structure member, the details of the
1309467b48Spatrick // intermediate member access will be remembered so bpf loader can do
1409467b48Spatrick // necessary adjustment right before program loading.
1509467b48Spatrick //
1609467b48Spatrick // For example,
1709467b48Spatrick //
1809467b48Spatrick //   struct s {
1909467b48Spatrick //     int a;
2009467b48Spatrick //     int b;
2109467b48Spatrick //   };
2209467b48Spatrick //   struct t {
2309467b48Spatrick //     struct s c;
2409467b48Spatrick //     int d;
2509467b48Spatrick //   };
2609467b48Spatrick //   struct t e;
2709467b48Spatrick //
2809467b48Spatrick // For the member access e.c.b, the compiler will generate code
2909467b48Spatrick //   &e + 4
3009467b48Spatrick //
3109467b48Spatrick // The compile-once run-everywhere instead generates the following code
3209467b48Spatrick //   r = 4
3309467b48Spatrick //   &e + r
3409467b48Spatrick // The "4" in "r = 4" can be changed based on a particular kernel version.
3509467b48Spatrick // For example, on a particular kernel version, if struct s is changed to
3609467b48Spatrick //
3709467b48Spatrick //   struct s {
3809467b48Spatrick //     int new_field;
3909467b48Spatrick //     int a;
4009467b48Spatrick //     int b;
4109467b48Spatrick //   }
4209467b48Spatrick //
4309467b48Spatrick // By repeating the member access on the host, the bpf loader can
4409467b48Spatrick // adjust "r = 4" as "r = 8".
4509467b48Spatrick //
4609467b48Spatrick // This feature relies on the following three intrinsic calls:
4709467b48Spatrick //   addr = preserve_array_access_index(base, dimension, index)
4809467b48Spatrick //   addr = preserve_union_access_index(base, di_index)
4909467b48Spatrick //          !llvm.preserve.access.index <union_ditype>
5009467b48Spatrick //   addr = preserve_struct_access_index(base, gep_index, di_index)
5109467b48Spatrick //          !llvm.preserve.access.index <struct_ditype>
5209467b48Spatrick //
5309467b48Spatrick // Bitfield member access needs special attention. User cannot take the
5409467b48Spatrick // address of a bitfield acceess. To facilitate kernel verifier
5509467b48Spatrick // for easy bitfield code optimization, a new clang intrinsic is introduced:
5609467b48Spatrick //   uint32_t __builtin_preserve_field_info(member_access, info_kind)
5709467b48Spatrick // In IR, a chain with two (or more) intrinsic calls will be generated:
5809467b48Spatrick //   ...
5909467b48Spatrick //   addr = preserve_struct_access_index(base, 1, 1) !struct s
6009467b48Spatrick //   uint32_t result = bpf_preserve_field_info(addr, info_kind)
6109467b48Spatrick //
6209467b48Spatrick // Suppose the info_kind is FIELD_SIGNEDNESS,
6309467b48Spatrick // The above two IR intrinsics will be replaced with
6409467b48Spatrick // a relocatable insn:
6509467b48Spatrick //   signness = /* signness of member_access */
6609467b48Spatrick // and signness can be changed by bpf loader based on the
6709467b48Spatrick // types on the host.
6809467b48Spatrick //
6909467b48Spatrick // User can also test whether a field exists or not with
7009467b48Spatrick //   uint32_t result = bpf_preserve_field_info(member_access, FIELD_EXISTENCE)
7109467b48Spatrick // The field will be always available (result = 1) during initial
7209467b48Spatrick // compilation, but bpf loader can patch with the correct value
7309467b48Spatrick // on the target host where the member_access may or may not be available
7409467b48Spatrick //
7509467b48Spatrick //===----------------------------------------------------------------------===//
7609467b48Spatrick 
7709467b48Spatrick #include "BPF.h"
7809467b48Spatrick #include "BPFCORE.h"
7909467b48Spatrick #include "BPFTargetMachine.h"
80*d415bd75Srobert #include "llvm/BinaryFormat/Dwarf.h"
8109467b48Spatrick #include "llvm/IR/DebugInfoMetadata.h"
8209467b48Spatrick #include "llvm/IR/GlobalVariable.h"
8309467b48Spatrick #include "llvm/IR/Instruction.h"
8409467b48Spatrick #include "llvm/IR/Instructions.h"
8573471bf0Spatrick #include "llvm/IR/IntrinsicsBPF.h"
8609467b48Spatrick #include "llvm/IR/Module.h"
8773471bf0Spatrick #include "llvm/IR/PassManager.h"
8809467b48Spatrick #include "llvm/IR/Type.h"
8909467b48Spatrick #include "llvm/IR/User.h"
9009467b48Spatrick #include "llvm/IR/Value.h"
9109467b48Spatrick #include "llvm/Pass.h"
9209467b48Spatrick #include "llvm/Transforms/Utils/BasicBlockUtils.h"
9309467b48Spatrick #include <stack>
9409467b48Spatrick 
9509467b48Spatrick #define DEBUG_TYPE "bpf-abstract-member-access"
9609467b48Spatrick 
9709467b48Spatrick namespace llvm {
98097a140dSpatrick constexpr StringRef BPFCoreSharedInfo::AmaAttr;
9973471bf0Spatrick uint32_t BPFCoreSharedInfo::SeqNum;
10073471bf0Spatrick 
insertPassThrough(Module * M,BasicBlock * BB,Instruction * Input,Instruction * Before)10173471bf0Spatrick Instruction *BPFCoreSharedInfo::insertPassThrough(Module *M, BasicBlock *BB,
10273471bf0Spatrick                                                   Instruction *Input,
10373471bf0Spatrick                                                   Instruction *Before) {
10473471bf0Spatrick   Function *Fn = Intrinsic::getDeclaration(
10573471bf0Spatrick       M, Intrinsic::bpf_passthrough, {Input->getType(), Input->getType()});
10673471bf0Spatrick   Constant *SeqNumVal = ConstantInt::get(Type::getInt32Ty(BB->getContext()),
10773471bf0Spatrick                                          BPFCoreSharedInfo::SeqNum++);
10873471bf0Spatrick 
10973471bf0Spatrick   auto *NewInst = CallInst::Create(Fn, {SeqNumVal, Input});
110*d415bd75Srobert   NewInst->insertBefore(Before);
11173471bf0Spatrick   return NewInst;
11273471bf0Spatrick }
11309467b48Spatrick } // namespace llvm
11409467b48Spatrick 
11509467b48Spatrick using namespace llvm;
11609467b48Spatrick 
11709467b48Spatrick namespace {
11873471bf0Spatrick class BPFAbstractMemberAccess final {
11909467b48Spatrick public:
BPFAbstractMemberAccess(BPFTargetMachine * TM)12073471bf0Spatrick   BPFAbstractMemberAccess(BPFTargetMachine *TM) : TM(TM) {}
12173471bf0Spatrick 
12273471bf0Spatrick   bool run(Function &F);
12309467b48Spatrick 
12409467b48Spatrick   struct CallInfo {
12509467b48Spatrick     uint32_t Kind;
12609467b48Spatrick     uint32_t AccessIndex;
127*d415bd75Srobert     MaybeAlign RecordAlignment;
12809467b48Spatrick     MDNode *Metadata;
129*d415bd75Srobert     WeakTrackingVH Base;
13009467b48Spatrick   };
13109467b48Spatrick   typedef std::stack<std::pair<CallInst *, CallInfo>> CallInfoStack;
13209467b48Spatrick 
13309467b48Spatrick private:
13409467b48Spatrick   enum : uint32_t {
13509467b48Spatrick     BPFPreserveArrayAI = 1,
13609467b48Spatrick     BPFPreserveUnionAI = 2,
13709467b48Spatrick     BPFPreserveStructAI = 3,
13809467b48Spatrick     BPFPreserveFieldInfoAI = 4,
13909467b48Spatrick   };
14009467b48Spatrick 
14173471bf0Spatrick   TargetMachine *TM;
14209467b48Spatrick   const DataLayout *DL = nullptr;
14373471bf0Spatrick   Module *M = nullptr;
14409467b48Spatrick 
14573471bf0Spatrick   static std::map<std::string, GlobalVariable *> GEPGlobals;
146*d415bd75Srobert   // A map to link preserve_*_access_index intrinsic calls.
14709467b48Spatrick   std::map<CallInst *, std::pair<CallInst *, CallInfo>> AIChain;
148*d415bd75Srobert   // A map to hold all the base preserve_*_access_index intrinsic calls.
14909467b48Spatrick   // The base call is not an input of any other preserve_*
15009467b48Spatrick   // intrinsics.
15109467b48Spatrick   std::map<CallInst *, CallInfo> BaseAICalls;
152*d415bd75Srobert   // A map to hold <AnonRecord, TypeDef> relationships
153*d415bd75Srobert   std::map<DICompositeType *, DIDerivedType *> AnonRecords;
154*d415bd75Srobert 
155*d415bd75Srobert   void CheckAnonRecordType(DIDerivedType *ParentTy, DIType *Ty);
156*d415bd75Srobert   void CheckCompositeType(DIDerivedType *ParentTy, DICompositeType *CTy);
157*d415bd75Srobert   void CheckDerivedType(DIDerivedType *ParentTy, DIDerivedType *DTy);
158*d415bd75Srobert   void ResetMetadata(struct CallInfo &CInfo);
15909467b48Spatrick 
16073471bf0Spatrick   bool doTransformation(Function &F);
16109467b48Spatrick 
16209467b48Spatrick   void traceAICall(CallInst *Call, CallInfo &ParentInfo);
16309467b48Spatrick   void traceBitCast(BitCastInst *BitCast, CallInst *Parent,
16409467b48Spatrick                     CallInfo &ParentInfo);
16509467b48Spatrick   void traceGEP(GetElementPtrInst *GEP, CallInst *Parent,
16609467b48Spatrick                 CallInfo &ParentInfo);
16773471bf0Spatrick   void collectAICallChains(Function &F);
16809467b48Spatrick 
16909467b48Spatrick   bool IsPreserveDIAccessIndexCall(const CallInst *Call, CallInfo &Cinfo);
17009467b48Spatrick   bool IsValidAIChain(const MDNode *ParentMeta, uint32_t ParentAI,
17109467b48Spatrick                       const MDNode *ChildMeta);
17273471bf0Spatrick   bool removePreserveAccessIndexIntrinsic(Function &F);
17309467b48Spatrick   void replaceWithGEP(std::vector<CallInst *> &CallList,
17409467b48Spatrick                       uint32_t NumOfZerosIndex, uint32_t DIIndex);
17509467b48Spatrick   bool HasPreserveFieldInfoCall(CallInfoStack &CallStack);
176097a140dSpatrick   void GetStorageBitRange(DIDerivedType *MemberTy, Align RecordAlignment,
17709467b48Spatrick                           uint32_t &StartBitOffset, uint32_t &EndBitOffset);
17809467b48Spatrick   uint32_t GetFieldInfo(uint32_t InfoKind, DICompositeType *CTy,
17909467b48Spatrick                         uint32_t AccessIndex, uint32_t PatchImm,
180*d415bd75Srobert                         MaybeAlign RecordAlignment);
18109467b48Spatrick 
18209467b48Spatrick   Value *computeBaseAndAccessKey(CallInst *Call, CallInfo &CInfo,
18309467b48Spatrick                                  std::string &AccessKey, MDNode *&BaseMeta);
18473471bf0Spatrick   MDNode *computeAccessKey(CallInst *Call, CallInfo &CInfo,
18573471bf0Spatrick                            std::string &AccessKey, bool &IsInt32Ret);
18609467b48Spatrick   uint64_t getConstant(const Value *IndexValue);
18773471bf0Spatrick   bool transformGEPChain(CallInst *Call, CallInfo &CInfo);
18809467b48Spatrick };
18909467b48Spatrick 
19073471bf0Spatrick std::map<std::string, GlobalVariable *> BPFAbstractMemberAccess::GEPGlobals;
19109467b48Spatrick 
19273471bf0Spatrick class BPFAbstractMemberAccessLegacyPass final : public FunctionPass {
19373471bf0Spatrick   BPFTargetMachine *TM;
19473471bf0Spatrick 
runOnFunction(Function & F)19573471bf0Spatrick   bool runOnFunction(Function &F) override {
19673471bf0Spatrick     return BPFAbstractMemberAccess(TM).run(F);
19709467b48Spatrick   }
19809467b48Spatrick 
19973471bf0Spatrick public:
20073471bf0Spatrick   static char ID;
20173471bf0Spatrick 
20273471bf0Spatrick   // Add optional BPFTargetMachine parameter so that BPF backend can add the
20373471bf0Spatrick   // phase with target machine to find out the endianness. The default
20473471bf0Spatrick   // constructor (without parameters) is used by the pass manager for managing
20573471bf0Spatrick   // purposes.
BPFAbstractMemberAccessLegacyPass(BPFTargetMachine * TM=nullptr)20673471bf0Spatrick   BPFAbstractMemberAccessLegacyPass(BPFTargetMachine *TM = nullptr)
20773471bf0Spatrick       : FunctionPass(ID), TM(TM) {}
20873471bf0Spatrick };
20973471bf0Spatrick 
21073471bf0Spatrick } // End anonymous namespace
21173471bf0Spatrick 
21273471bf0Spatrick char BPFAbstractMemberAccessLegacyPass::ID = 0;
21373471bf0Spatrick INITIALIZE_PASS(BPFAbstractMemberAccessLegacyPass, DEBUG_TYPE,
21473471bf0Spatrick                 "BPF Abstract Member Access", false, false)
21573471bf0Spatrick 
createBPFAbstractMemberAccess(BPFTargetMachine * TM)21673471bf0Spatrick FunctionPass *llvm::createBPFAbstractMemberAccess(BPFTargetMachine *TM) {
21773471bf0Spatrick   return new BPFAbstractMemberAccessLegacyPass(TM);
21873471bf0Spatrick }
21973471bf0Spatrick 
run(Function & F)22073471bf0Spatrick bool BPFAbstractMemberAccess::run(Function &F) {
22109467b48Spatrick   LLVM_DEBUG(dbgs() << "********** Abstract Member Accesses **********\n");
22209467b48Spatrick 
22373471bf0Spatrick   M = F.getParent();
22473471bf0Spatrick   if (!M)
22509467b48Spatrick     return false;
22609467b48Spatrick 
22773471bf0Spatrick   // Bail out if no debug info.
22873471bf0Spatrick   if (M->debug_compile_units().empty())
22973471bf0Spatrick     return false;
23073471bf0Spatrick 
231*d415bd75Srobert   // For each argument/return/local_variable type, trace the type
232*d415bd75Srobert   // pattern like '[derived_type]* [composite_type]' to check
233*d415bd75Srobert   // and remember (anon record -> typedef) relations where the
234*d415bd75Srobert   // anon record is defined as
235*d415bd75Srobert   //   typedef [const/volatile/restrict]* [anon record]
236*d415bd75Srobert   DISubprogram *SP = F.getSubprogram();
237*d415bd75Srobert   if (SP && SP->isDefinition()) {
238*d415bd75Srobert     for (DIType *Ty: SP->getType()->getTypeArray())
239*d415bd75Srobert       CheckAnonRecordType(nullptr, Ty);
240*d415bd75Srobert     for (const DINode *DN : SP->getRetainedNodes()) {
241*d415bd75Srobert       if (const auto *DV = dyn_cast<DILocalVariable>(DN))
242*d415bd75Srobert         CheckAnonRecordType(nullptr, DV->getType());
243*d415bd75Srobert     }
244*d415bd75Srobert   }
245*d415bd75Srobert 
24673471bf0Spatrick   DL = &M->getDataLayout();
24773471bf0Spatrick   return doTransformation(F);
24809467b48Spatrick }
24909467b48Spatrick 
ResetMetadata(struct CallInfo & CInfo)250*d415bd75Srobert void BPFAbstractMemberAccess::ResetMetadata(struct CallInfo &CInfo) {
251*d415bd75Srobert   if (auto Ty = dyn_cast<DICompositeType>(CInfo.Metadata)) {
252*d415bd75Srobert     if (AnonRecords.find(Ty) != AnonRecords.end()) {
253*d415bd75Srobert       if (AnonRecords[Ty] != nullptr)
254*d415bd75Srobert         CInfo.Metadata = AnonRecords[Ty];
255*d415bd75Srobert     }
256*d415bd75Srobert   }
257*d415bd75Srobert }
258*d415bd75Srobert 
CheckCompositeType(DIDerivedType * ParentTy,DICompositeType * CTy)259*d415bd75Srobert void BPFAbstractMemberAccess::CheckCompositeType(DIDerivedType *ParentTy,
260*d415bd75Srobert                                                  DICompositeType *CTy) {
261*d415bd75Srobert   if (!CTy->getName().empty() || !ParentTy ||
262*d415bd75Srobert       ParentTy->getTag() != dwarf::DW_TAG_typedef)
263*d415bd75Srobert     return;
264*d415bd75Srobert 
265*d415bd75Srobert   if (AnonRecords.find(CTy) == AnonRecords.end()) {
266*d415bd75Srobert     AnonRecords[CTy] = ParentTy;
267*d415bd75Srobert     return;
268*d415bd75Srobert   }
269*d415bd75Srobert 
270*d415bd75Srobert   // Two or more typedef's may point to the same anon record.
271*d415bd75Srobert   // If this is the case, set the typedef DIType to be nullptr
272*d415bd75Srobert   // to indicate the duplication case.
273*d415bd75Srobert   DIDerivedType *CurrTy = AnonRecords[CTy];
274*d415bd75Srobert   if (CurrTy == ParentTy)
275*d415bd75Srobert     return;
276*d415bd75Srobert   AnonRecords[CTy] = nullptr;
277*d415bd75Srobert }
278*d415bd75Srobert 
CheckDerivedType(DIDerivedType * ParentTy,DIDerivedType * DTy)279*d415bd75Srobert void BPFAbstractMemberAccess::CheckDerivedType(DIDerivedType *ParentTy,
280*d415bd75Srobert                                                DIDerivedType *DTy) {
281*d415bd75Srobert   DIType *BaseType = DTy->getBaseType();
282*d415bd75Srobert   if (!BaseType)
283*d415bd75Srobert     return;
284*d415bd75Srobert 
285*d415bd75Srobert   unsigned Tag = DTy->getTag();
286*d415bd75Srobert   if (Tag == dwarf::DW_TAG_pointer_type)
287*d415bd75Srobert     CheckAnonRecordType(nullptr, BaseType);
288*d415bd75Srobert   else if (Tag == dwarf::DW_TAG_typedef)
289*d415bd75Srobert     CheckAnonRecordType(DTy, BaseType);
290*d415bd75Srobert   else
291*d415bd75Srobert     CheckAnonRecordType(ParentTy, BaseType);
292*d415bd75Srobert }
293*d415bd75Srobert 
CheckAnonRecordType(DIDerivedType * ParentTy,DIType * Ty)294*d415bd75Srobert void BPFAbstractMemberAccess::CheckAnonRecordType(DIDerivedType *ParentTy,
295*d415bd75Srobert                                                   DIType *Ty) {
296*d415bd75Srobert   if (!Ty)
297*d415bd75Srobert     return;
298*d415bd75Srobert 
299*d415bd75Srobert   if (auto *CTy = dyn_cast<DICompositeType>(Ty))
300*d415bd75Srobert     return CheckCompositeType(ParentTy, CTy);
301*d415bd75Srobert   else if (auto *DTy = dyn_cast<DIDerivedType>(Ty))
302*d415bd75Srobert     return CheckDerivedType(ParentTy, DTy);
303*d415bd75Srobert }
304*d415bd75Srobert 
SkipDIDerivedTag(unsigned Tag,bool skipTypedef)305097a140dSpatrick static bool SkipDIDerivedTag(unsigned Tag, bool skipTypedef) {
30609467b48Spatrick   if (Tag != dwarf::DW_TAG_typedef && Tag != dwarf::DW_TAG_const_type &&
30709467b48Spatrick       Tag != dwarf::DW_TAG_volatile_type &&
30809467b48Spatrick       Tag != dwarf::DW_TAG_restrict_type &&
30909467b48Spatrick       Tag != dwarf::DW_TAG_member)
31009467b48Spatrick     return false;
311097a140dSpatrick   if (Tag == dwarf::DW_TAG_typedef && !skipTypedef)
312097a140dSpatrick     return false;
31309467b48Spatrick   return true;
31409467b48Spatrick }
31509467b48Spatrick 
stripQualifiers(DIType * Ty,bool skipTypedef=true)316097a140dSpatrick static DIType * stripQualifiers(DIType *Ty, bool skipTypedef = true) {
31709467b48Spatrick   while (auto *DTy = dyn_cast<DIDerivedType>(Ty)) {
318097a140dSpatrick     if (!SkipDIDerivedTag(DTy->getTag(), skipTypedef))
31909467b48Spatrick       break;
32009467b48Spatrick     Ty = DTy->getBaseType();
32109467b48Spatrick   }
32209467b48Spatrick   return Ty;
32309467b48Spatrick }
32409467b48Spatrick 
stripQualifiers(const DIType * Ty)32509467b48Spatrick static const DIType * stripQualifiers(const DIType *Ty) {
32609467b48Spatrick   while (auto *DTy = dyn_cast<DIDerivedType>(Ty)) {
327097a140dSpatrick     if (!SkipDIDerivedTag(DTy->getTag(), true))
32809467b48Spatrick       break;
32909467b48Spatrick     Ty = DTy->getBaseType();
33009467b48Spatrick   }
33109467b48Spatrick   return Ty;
33209467b48Spatrick }
33309467b48Spatrick 
calcArraySize(const DICompositeType * CTy,uint32_t StartDim)33409467b48Spatrick static uint32_t calcArraySize(const DICompositeType *CTy, uint32_t StartDim) {
33509467b48Spatrick   DINodeArray Elements = CTy->getElements();
33609467b48Spatrick   uint32_t DimSize = 1;
33709467b48Spatrick   for (uint32_t I = StartDim; I < Elements.size(); ++I) {
33809467b48Spatrick     if (auto *Element = dyn_cast_or_null<DINode>(Elements[I]))
33909467b48Spatrick       if (Element->getTag() == dwarf::DW_TAG_subrange_type) {
34009467b48Spatrick         const DISubrange *SR = cast<DISubrange>(Element);
34109467b48Spatrick         auto *CI = SR->getCount().dyn_cast<ConstantInt *>();
34209467b48Spatrick         DimSize *= CI->getSExtValue();
34309467b48Spatrick       }
34409467b48Spatrick   }
34509467b48Spatrick 
34609467b48Spatrick   return DimSize;
34709467b48Spatrick }
34809467b48Spatrick 
getBaseElementType(const CallInst * Call)34973471bf0Spatrick static Type *getBaseElementType(const CallInst *Call) {
35073471bf0Spatrick   // Element type is stored in an elementtype() attribute on the first param.
351*d415bd75Srobert   return Call->getParamElementType(0);
35273471bf0Spatrick }
35373471bf0Spatrick 
35409467b48Spatrick /// Check whether a call is a preserve_*_access_index intrinsic call or not.
IsPreserveDIAccessIndexCall(const CallInst * Call,CallInfo & CInfo)35509467b48Spatrick bool BPFAbstractMemberAccess::IsPreserveDIAccessIndexCall(const CallInst *Call,
35609467b48Spatrick                                                           CallInfo &CInfo) {
35709467b48Spatrick   if (!Call)
35809467b48Spatrick     return false;
35909467b48Spatrick 
360097a140dSpatrick   const auto *GV = dyn_cast<GlobalValue>(Call->getCalledOperand());
36109467b48Spatrick   if (!GV)
36209467b48Spatrick     return false;
36309467b48Spatrick   if (GV->getName().startswith("llvm.preserve.array.access.index")) {
36409467b48Spatrick     CInfo.Kind = BPFPreserveArrayAI;
36509467b48Spatrick     CInfo.Metadata = Call->getMetadata(LLVMContext::MD_preserve_access_index);
36609467b48Spatrick     if (!CInfo.Metadata)
36709467b48Spatrick       report_fatal_error("Missing metadata for llvm.preserve.array.access.index intrinsic");
36809467b48Spatrick     CInfo.AccessIndex = getConstant(Call->getArgOperand(2));
36909467b48Spatrick     CInfo.Base = Call->getArgOperand(0);
37073471bf0Spatrick     CInfo.RecordAlignment = DL->getABITypeAlign(getBaseElementType(Call));
37109467b48Spatrick     return true;
37209467b48Spatrick   }
37309467b48Spatrick   if (GV->getName().startswith("llvm.preserve.union.access.index")) {
37409467b48Spatrick     CInfo.Kind = BPFPreserveUnionAI;
37509467b48Spatrick     CInfo.Metadata = Call->getMetadata(LLVMContext::MD_preserve_access_index);
37609467b48Spatrick     if (!CInfo.Metadata)
37709467b48Spatrick       report_fatal_error("Missing metadata for llvm.preserve.union.access.index intrinsic");
378*d415bd75Srobert     ResetMetadata(CInfo);
37909467b48Spatrick     CInfo.AccessIndex = getConstant(Call->getArgOperand(1));
38009467b48Spatrick     CInfo.Base = Call->getArgOperand(0);
38109467b48Spatrick     return true;
38209467b48Spatrick   }
38309467b48Spatrick   if (GV->getName().startswith("llvm.preserve.struct.access.index")) {
38409467b48Spatrick     CInfo.Kind = BPFPreserveStructAI;
38509467b48Spatrick     CInfo.Metadata = Call->getMetadata(LLVMContext::MD_preserve_access_index);
38609467b48Spatrick     if (!CInfo.Metadata)
38709467b48Spatrick       report_fatal_error("Missing metadata for llvm.preserve.struct.access.index intrinsic");
388*d415bd75Srobert     ResetMetadata(CInfo);
38909467b48Spatrick     CInfo.AccessIndex = getConstant(Call->getArgOperand(2));
39009467b48Spatrick     CInfo.Base = Call->getArgOperand(0);
39173471bf0Spatrick     CInfo.RecordAlignment = DL->getABITypeAlign(getBaseElementType(Call));
39209467b48Spatrick     return true;
39309467b48Spatrick   }
39409467b48Spatrick   if (GV->getName().startswith("llvm.bpf.preserve.field.info")) {
39509467b48Spatrick     CInfo.Kind = BPFPreserveFieldInfoAI;
39609467b48Spatrick     CInfo.Metadata = nullptr;
39709467b48Spatrick     // Check validity of info_kind as clang did not check this.
39809467b48Spatrick     uint64_t InfoKind = getConstant(Call->getArgOperand(1));
39909467b48Spatrick     if (InfoKind >= BPFCoreSharedInfo::MAX_FIELD_RELOC_KIND)
40009467b48Spatrick       report_fatal_error("Incorrect info_kind for llvm.bpf.preserve.field.info intrinsic");
40109467b48Spatrick     CInfo.AccessIndex = InfoKind;
40209467b48Spatrick     return true;
40309467b48Spatrick   }
40473471bf0Spatrick   if (GV->getName().startswith("llvm.bpf.preserve.type.info")) {
40573471bf0Spatrick     CInfo.Kind = BPFPreserveFieldInfoAI;
40673471bf0Spatrick     CInfo.Metadata = Call->getMetadata(LLVMContext::MD_preserve_access_index);
40773471bf0Spatrick     if (!CInfo.Metadata)
40873471bf0Spatrick       report_fatal_error("Missing metadata for llvm.preserve.type.info intrinsic");
40973471bf0Spatrick     uint64_t Flag = getConstant(Call->getArgOperand(1));
41073471bf0Spatrick     if (Flag >= BPFCoreSharedInfo::MAX_PRESERVE_TYPE_INFO_FLAG)
41173471bf0Spatrick       report_fatal_error("Incorrect flag for llvm.bpf.preserve.type.info intrinsic");
41273471bf0Spatrick     if (Flag == BPFCoreSharedInfo::PRESERVE_TYPE_INFO_EXISTENCE)
41373471bf0Spatrick       CInfo.AccessIndex = BPFCoreSharedInfo::TYPE_EXISTENCE;
414*d415bd75Srobert     else if (Flag == BPFCoreSharedInfo::PRESERVE_TYPE_INFO_MATCH)
415*d415bd75Srobert       CInfo.AccessIndex = BPFCoreSharedInfo::TYPE_MATCH;
41673471bf0Spatrick     else
41773471bf0Spatrick       CInfo.AccessIndex = BPFCoreSharedInfo::TYPE_SIZE;
41873471bf0Spatrick     return true;
41973471bf0Spatrick   }
42073471bf0Spatrick   if (GV->getName().startswith("llvm.bpf.preserve.enum.value")) {
42173471bf0Spatrick     CInfo.Kind = BPFPreserveFieldInfoAI;
42273471bf0Spatrick     CInfo.Metadata = Call->getMetadata(LLVMContext::MD_preserve_access_index);
42373471bf0Spatrick     if (!CInfo.Metadata)
42473471bf0Spatrick       report_fatal_error("Missing metadata for llvm.preserve.enum.value intrinsic");
42573471bf0Spatrick     uint64_t Flag = getConstant(Call->getArgOperand(2));
42673471bf0Spatrick     if (Flag >= BPFCoreSharedInfo::MAX_PRESERVE_ENUM_VALUE_FLAG)
42773471bf0Spatrick       report_fatal_error("Incorrect flag for llvm.bpf.preserve.enum.value intrinsic");
42873471bf0Spatrick     if (Flag == BPFCoreSharedInfo::PRESERVE_ENUM_VALUE_EXISTENCE)
42973471bf0Spatrick       CInfo.AccessIndex = BPFCoreSharedInfo::ENUM_VALUE_EXISTENCE;
43073471bf0Spatrick     else
43173471bf0Spatrick       CInfo.AccessIndex = BPFCoreSharedInfo::ENUM_VALUE;
43273471bf0Spatrick     return true;
43373471bf0Spatrick   }
43409467b48Spatrick 
43509467b48Spatrick   return false;
43609467b48Spatrick }
43709467b48Spatrick 
replaceWithGEP(std::vector<CallInst * > & CallList,uint32_t DimensionIndex,uint32_t GEPIndex)43809467b48Spatrick void BPFAbstractMemberAccess::replaceWithGEP(std::vector<CallInst *> &CallList,
43909467b48Spatrick                                              uint32_t DimensionIndex,
44009467b48Spatrick                                              uint32_t GEPIndex) {
441*d415bd75Srobert   for (auto *Call : CallList) {
44209467b48Spatrick     uint32_t Dimension = 1;
44309467b48Spatrick     if (DimensionIndex > 0)
44409467b48Spatrick       Dimension = getConstant(Call->getArgOperand(DimensionIndex));
44509467b48Spatrick 
44609467b48Spatrick     Constant *Zero =
44709467b48Spatrick         ConstantInt::get(Type::getInt32Ty(Call->getParent()->getContext()), 0);
44809467b48Spatrick     SmallVector<Value *, 4> IdxList;
44909467b48Spatrick     for (unsigned I = 0; I < Dimension; ++I)
45009467b48Spatrick       IdxList.push_back(Zero);
45109467b48Spatrick     IdxList.push_back(Call->getArgOperand(GEPIndex));
45209467b48Spatrick 
45373471bf0Spatrick     auto *GEP = GetElementPtrInst::CreateInBounds(
45473471bf0Spatrick         getBaseElementType(Call), Call->getArgOperand(0), IdxList, "", Call);
45509467b48Spatrick     Call->replaceAllUsesWith(GEP);
45609467b48Spatrick     Call->eraseFromParent();
45709467b48Spatrick   }
45809467b48Spatrick }
45909467b48Spatrick 
removePreserveAccessIndexIntrinsic(Function & F)46073471bf0Spatrick bool BPFAbstractMemberAccess::removePreserveAccessIndexIntrinsic(Function &F) {
46109467b48Spatrick   std::vector<CallInst *> PreserveArrayIndexCalls;
46209467b48Spatrick   std::vector<CallInst *> PreserveUnionIndexCalls;
46309467b48Spatrick   std::vector<CallInst *> PreserveStructIndexCalls;
46409467b48Spatrick   bool Found = false;
46509467b48Spatrick 
46609467b48Spatrick   for (auto &BB : F)
46709467b48Spatrick     for (auto &I : BB) {
46809467b48Spatrick       auto *Call = dyn_cast<CallInst>(&I);
46909467b48Spatrick       CallInfo CInfo;
47009467b48Spatrick       if (!IsPreserveDIAccessIndexCall(Call, CInfo))
47109467b48Spatrick         continue;
47209467b48Spatrick 
47309467b48Spatrick       Found = true;
47409467b48Spatrick       if (CInfo.Kind == BPFPreserveArrayAI)
47509467b48Spatrick         PreserveArrayIndexCalls.push_back(Call);
47609467b48Spatrick       else if (CInfo.Kind == BPFPreserveUnionAI)
47709467b48Spatrick         PreserveUnionIndexCalls.push_back(Call);
47809467b48Spatrick       else
47909467b48Spatrick         PreserveStructIndexCalls.push_back(Call);
48009467b48Spatrick     }
48109467b48Spatrick 
48209467b48Spatrick   // do the following transformation:
48309467b48Spatrick   // . addr = preserve_array_access_index(base, dimension, index)
48409467b48Spatrick   //   is transformed to
48509467b48Spatrick   //     addr = GEP(base, dimenion's zero's, index)
48609467b48Spatrick   // . addr = preserve_union_access_index(base, di_index)
48709467b48Spatrick   //   is transformed to
48809467b48Spatrick   //     addr = base, i.e., all usages of "addr" are replaced by "base".
48909467b48Spatrick   // . addr = preserve_struct_access_index(base, gep_index, di_index)
49009467b48Spatrick   //   is transformed to
49109467b48Spatrick   //     addr = GEP(base, 0, gep_index)
49209467b48Spatrick   replaceWithGEP(PreserveArrayIndexCalls, 1, 2);
49309467b48Spatrick   replaceWithGEP(PreserveStructIndexCalls, 0, 1);
494*d415bd75Srobert   for (auto *Call : PreserveUnionIndexCalls) {
49509467b48Spatrick     Call->replaceAllUsesWith(Call->getArgOperand(0));
49609467b48Spatrick     Call->eraseFromParent();
49709467b48Spatrick   }
49809467b48Spatrick 
49909467b48Spatrick   return Found;
50009467b48Spatrick }
50109467b48Spatrick 
50209467b48Spatrick /// Check whether the access index chain is valid. We check
50309467b48Spatrick /// here because there may be type casts between two
50409467b48Spatrick /// access indexes. We want to ensure memory access still valid.
IsValidAIChain(const MDNode * ParentType,uint32_t ParentAI,const MDNode * ChildType)50509467b48Spatrick bool BPFAbstractMemberAccess::IsValidAIChain(const MDNode *ParentType,
50609467b48Spatrick                                              uint32_t ParentAI,
50709467b48Spatrick                                              const MDNode *ChildType) {
50809467b48Spatrick   if (!ChildType)
50909467b48Spatrick     return true; // preserve_field_info, no type comparison needed.
51009467b48Spatrick 
51109467b48Spatrick   const DIType *PType = stripQualifiers(cast<DIType>(ParentType));
51209467b48Spatrick   const DIType *CType = stripQualifiers(cast<DIType>(ChildType));
51309467b48Spatrick 
51409467b48Spatrick   // Child is a derived/pointer type, which is due to type casting.
51509467b48Spatrick   // Pointer type cannot be in the middle of chain.
51609467b48Spatrick   if (isa<DIDerivedType>(CType))
51709467b48Spatrick     return false;
51809467b48Spatrick 
51909467b48Spatrick   // Parent is a pointer type.
52009467b48Spatrick   if (const auto *PtrTy = dyn_cast<DIDerivedType>(PType)) {
52109467b48Spatrick     if (PtrTy->getTag() != dwarf::DW_TAG_pointer_type)
52209467b48Spatrick       return false;
52309467b48Spatrick     return stripQualifiers(PtrTy->getBaseType()) == CType;
52409467b48Spatrick   }
52509467b48Spatrick 
52609467b48Spatrick   // Otherwise, struct/union/array types
52709467b48Spatrick   const auto *PTy = dyn_cast<DICompositeType>(PType);
52809467b48Spatrick   const auto *CTy = dyn_cast<DICompositeType>(CType);
52909467b48Spatrick   assert(PTy && CTy && "ParentType or ChildType is null or not composite");
53009467b48Spatrick 
53109467b48Spatrick   uint32_t PTyTag = PTy->getTag();
53209467b48Spatrick   assert(PTyTag == dwarf::DW_TAG_array_type ||
53309467b48Spatrick          PTyTag == dwarf::DW_TAG_structure_type ||
53409467b48Spatrick          PTyTag == dwarf::DW_TAG_union_type);
53509467b48Spatrick 
53609467b48Spatrick   uint32_t CTyTag = CTy->getTag();
53709467b48Spatrick   assert(CTyTag == dwarf::DW_TAG_array_type ||
53809467b48Spatrick          CTyTag == dwarf::DW_TAG_structure_type ||
53909467b48Spatrick          CTyTag == dwarf::DW_TAG_union_type);
54009467b48Spatrick 
54109467b48Spatrick   // Multi dimensional arrays, base element should be the same
54209467b48Spatrick   if (PTyTag == dwarf::DW_TAG_array_type && PTyTag == CTyTag)
54309467b48Spatrick     return PTy->getBaseType() == CTy->getBaseType();
54409467b48Spatrick 
54509467b48Spatrick   DIType *Ty;
54609467b48Spatrick   if (PTyTag == dwarf::DW_TAG_array_type)
54709467b48Spatrick     Ty = PTy->getBaseType();
54809467b48Spatrick   else
54909467b48Spatrick     Ty = dyn_cast<DIType>(PTy->getElements()[ParentAI]);
55009467b48Spatrick 
55109467b48Spatrick   return dyn_cast<DICompositeType>(stripQualifiers(Ty)) == CTy;
55209467b48Spatrick }
55309467b48Spatrick 
traceAICall(CallInst * Call,CallInfo & ParentInfo)55409467b48Spatrick void BPFAbstractMemberAccess::traceAICall(CallInst *Call,
55509467b48Spatrick                                           CallInfo &ParentInfo) {
55609467b48Spatrick   for (User *U : Call->users()) {
55709467b48Spatrick     Instruction *Inst = dyn_cast<Instruction>(U);
55809467b48Spatrick     if (!Inst)
55909467b48Spatrick       continue;
56009467b48Spatrick 
56109467b48Spatrick     if (auto *BI = dyn_cast<BitCastInst>(Inst)) {
56209467b48Spatrick       traceBitCast(BI, Call, ParentInfo);
56309467b48Spatrick     } else if (auto *CI = dyn_cast<CallInst>(Inst)) {
56409467b48Spatrick       CallInfo ChildInfo;
56509467b48Spatrick 
56609467b48Spatrick       if (IsPreserveDIAccessIndexCall(CI, ChildInfo) &&
56709467b48Spatrick           IsValidAIChain(ParentInfo.Metadata, ParentInfo.AccessIndex,
56809467b48Spatrick                          ChildInfo.Metadata)) {
56909467b48Spatrick         AIChain[CI] = std::make_pair(Call, ParentInfo);
57009467b48Spatrick         traceAICall(CI, ChildInfo);
57109467b48Spatrick       } else {
57209467b48Spatrick         BaseAICalls[Call] = ParentInfo;
57309467b48Spatrick       }
57409467b48Spatrick     } else if (auto *GI = dyn_cast<GetElementPtrInst>(Inst)) {
57509467b48Spatrick       if (GI->hasAllZeroIndices())
57609467b48Spatrick         traceGEP(GI, Call, ParentInfo);
57709467b48Spatrick       else
57809467b48Spatrick         BaseAICalls[Call] = ParentInfo;
57909467b48Spatrick     } else {
58009467b48Spatrick       BaseAICalls[Call] = ParentInfo;
58109467b48Spatrick     }
58209467b48Spatrick   }
58309467b48Spatrick }
58409467b48Spatrick 
traceBitCast(BitCastInst * BitCast,CallInst * Parent,CallInfo & ParentInfo)58509467b48Spatrick void BPFAbstractMemberAccess::traceBitCast(BitCastInst *BitCast,
58609467b48Spatrick                                            CallInst *Parent,
58709467b48Spatrick                                            CallInfo &ParentInfo) {
58809467b48Spatrick   for (User *U : BitCast->users()) {
58909467b48Spatrick     Instruction *Inst = dyn_cast<Instruction>(U);
59009467b48Spatrick     if (!Inst)
59109467b48Spatrick       continue;
59209467b48Spatrick 
59309467b48Spatrick     if (auto *BI = dyn_cast<BitCastInst>(Inst)) {
59409467b48Spatrick       traceBitCast(BI, Parent, ParentInfo);
59509467b48Spatrick     } else if (auto *CI = dyn_cast<CallInst>(Inst)) {
59609467b48Spatrick       CallInfo ChildInfo;
59709467b48Spatrick       if (IsPreserveDIAccessIndexCall(CI, ChildInfo) &&
59809467b48Spatrick           IsValidAIChain(ParentInfo.Metadata, ParentInfo.AccessIndex,
59909467b48Spatrick                          ChildInfo.Metadata)) {
60009467b48Spatrick         AIChain[CI] = std::make_pair(Parent, ParentInfo);
60109467b48Spatrick         traceAICall(CI, ChildInfo);
60209467b48Spatrick       } else {
60309467b48Spatrick         BaseAICalls[Parent] = ParentInfo;
60409467b48Spatrick       }
60509467b48Spatrick     } else if (auto *GI = dyn_cast<GetElementPtrInst>(Inst)) {
60609467b48Spatrick       if (GI->hasAllZeroIndices())
60709467b48Spatrick         traceGEP(GI, Parent, ParentInfo);
60809467b48Spatrick       else
60909467b48Spatrick         BaseAICalls[Parent] = ParentInfo;
61009467b48Spatrick     } else {
61109467b48Spatrick       BaseAICalls[Parent] = ParentInfo;
61209467b48Spatrick     }
61309467b48Spatrick   }
61409467b48Spatrick }
61509467b48Spatrick 
traceGEP(GetElementPtrInst * GEP,CallInst * Parent,CallInfo & ParentInfo)61609467b48Spatrick void BPFAbstractMemberAccess::traceGEP(GetElementPtrInst *GEP, CallInst *Parent,
61709467b48Spatrick                                        CallInfo &ParentInfo) {
61809467b48Spatrick   for (User *U : GEP->users()) {
61909467b48Spatrick     Instruction *Inst = dyn_cast<Instruction>(U);
62009467b48Spatrick     if (!Inst)
62109467b48Spatrick       continue;
62209467b48Spatrick 
62309467b48Spatrick     if (auto *BI = dyn_cast<BitCastInst>(Inst)) {
62409467b48Spatrick       traceBitCast(BI, Parent, ParentInfo);
62509467b48Spatrick     } else if (auto *CI = dyn_cast<CallInst>(Inst)) {
62609467b48Spatrick       CallInfo ChildInfo;
62709467b48Spatrick       if (IsPreserveDIAccessIndexCall(CI, ChildInfo) &&
62809467b48Spatrick           IsValidAIChain(ParentInfo.Metadata, ParentInfo.AccessIndex,
62909467b48Spatrick                          ChildInfo.Metadata)) {
63009467b48Spatrick         AIChain[CI] = std::make_pair(Parent, ParentInfo);
63109467b48Spatrick         traceAICall(CI, ChildInfo);
63209467b48Spatrick       } else {
63309467b48Spatrick         BaseAICalls[Parent] = ParentInfo;
63409467b48Spatrick       }
63509467b48Spatrick     } else if (auto *GI = dyn_cast<GetElementPtrInst>(Inst)) {
63609467b48Spatrick       if (GI->hasAllZeroIndices())
63709467b48Spatrick         traceGEP(GI, Parent, ParentInfo);
63809467b48Spatrick       else
63909467b48Spatrick         BaseAICalls[Parent] = ParentInfo;
64009467b48Spatrick     } else {
64109467b48Spatrick       BaseAICalls[Parent] = ParentInfo;
64209467b48Spatrick     }
64309467b48Spatrick   }
64409467b48Spatrick }
64509467b48Spatrick 
collectAICallChains(Function & F)64673471bf0Spatrick void BPFAbstractMemberAccess::collectAICallChains(Function &F) {
64709467b48Spatrick   AIChain.clear();
64809467b48Spatrick   BaseAICalls.clear();
64909467b48Spatrick 
65009467b48Spatrick   for (auto &BB : F)
65109467b48Spatrick     for (auto &I : BB) {
65209467b48Spatrick       CallInfo CInfo;
65309467b48Spatrick       auto *Call = dyn_cast<CallInst>(&I);
65409467b48Spatrick       if (!IsPreserveDIAccessIndexCall(Call, CInfo) ||
65509467b48Spatrick           AIChain.find(Call) != AIChain.end())
65609467b48Spatrick         continue;
65709467b48Spatrick 
65809467b48Spatrick       traceAICall(Call, CInfo);
65909467b48Spatrick     }
66009467b48Spatrick }
66109467b48Spatrick 
getConstant(const Value * IndexValue)66209467b48Spatrick uint64_t BPFAbstractMemberAccess::getConstant(const Value *IndexValue) {
66309467b48Spatrick   const ConstantInt *CV = dyn_cast<ConstantInt>(IndexValue);
66409467b48Spatrick   assert(CV);
66509467b48Spatrick   return CV->getValue().getZExtValue();
66609467b48Spatrick }
66709467b48Spatrick 
66809467b48Spatrick /// Get the start and the end of storage offset for \p MemberTy.
GetStorageBitRange(DIDerivedType * MemberTy,Align RecordAlignment,uint32_t & StartBitOffset,uint32_t & EndBitOffset)66909467b48Spatrick void BPFAbstractMemberAccess::GetStorageBitRange(DIDerivedType *MemberTy,
670097a140dSpatrick                                                  Align RecordAlignment,
67109467b48Spatrick                                                  uint32_t &StartBitOffset,
67209467b48Spatrick                                                  uint32_t &EndBitOffset) {
67309467b48Spatrick   uint32_t MemberBitSize = MemberTy->getSizeInBits();
67409467b48Spatrick   uint32_t MemberBitOffset = MemberTy->getOffsetInBits();
675*d415bd75Srobert 
676*d415bd75Srobert   if (RecordAlignment > 8) {
677*d415bd75Srobert     // If the Bits are within an aligned 8-byte, set the RecordAlignment
678*d415bd75Srobert     // to 8, other report the fatal error.
679*d415bd75Srobert     if (MemberBitOffset / 64 != (MemberBitOffset + MemberBitSize) / 64)
68009467b48Spatrick       report_fatal_error("Unsupported field expression for llvm.bpf.preserve.field.info, "
68109467b48Spatrick                          "requiring too big alignment");
682*d415bd75Srobert     RecordAlignment = Align(8);
683*d415bd75Srobert   }
684*d415bd75Srobert 
685*d415bd75Srobert   uint32_t AlignBits = RecordAlignment.value() * 8;
686*d415bd75Srobert   if (MemberBitSize > AlignBits)
687*d415bd75Srobert     report_fatal_error("Unsupported field expression for llvm.bpf.preserve.field.info, "
688*d415bd75Srobert                        "bitfield size greater than record alignment");
68909467b48Spatrick 
69009467b48Spatrick   StartBitOffset = MemberBitOffset & ~(AlignBits - 1);
69109467b48Spatrick   if ((StartBitOffset + AlignBits) < (MemberBitOffset + MemberBitSize))
69209467b48Spatrick     report_fatal_error("Unsupported field expression for llvm.bpf.preserve.field.info, "
69309467b48Spatrick                        "cross alignment boundary");
69409467b48Spatrick   EndBitOffset = StartBitOffset + AlignBits;
69509467b48Spatrick }
69609467b48Spatrick 
GetFieldInfo(uint32_t InfoKind,DICompositeType * CTy,uint32_t AccessIndex,uint32_t PatchImm,MaybeAlign RecordAlignment)69709467b48Spatrick uint32_t BPFAbstractMemberAccess::GetFieldInfo(uint32_t InfoKind,
69809467b48Spatrick                                                DICompositeType *CTy,
69909467b48Spatrick                                                uint32_t AccessIndex,
70009467b48Spatrick                                                uint32_t PatchImm,
701*d415bd75Srobert                                                MaybeAlign RecordAlignment) {
70209467b48Spatrick   if (InfoKind == BPFCoreSharedInfo::FIELD_EXISTENCE)
70309467b48Spatrick       return 1;
70409467b48Spatrick 
70509467b48Spatrick   uint32_t Tag = CTy->getTag();
70609467b48Spatrick   if (InfoKind == BPFCoreSharedInfo::FIELD_BYTE_OFFSET) {
70709467b48Spatrick     if (Tag == dwarf::DW_TAG_array_type) {
70809467b48Spatrick       auto *EltTy = stripQualifiers(CTy->getBaseType());
70909467b48Spatrick       PatchImm += AccessIndex * calcArraySize(CTy, 1) *
71009467b48Spatrick                   (EltTy->getSizeInBits() >> 3);
71109467b48Spatrick     } else if (Tag == dwarf::DW_TAG_structure_type) {
71209467b48Spatrick       auto *MemberTy = cast<DIDerivedType>(CTy->getElements()[AccessIndex]);
71309467b48Spatrick       if (!MemberTy->isBitField()) {
71409467b48Spatrick         PatchImm += MemberTy->getOffsetInBits() >> 3;
71509467b48Spatrick       } else {
71609467b48Spatrick         unsigned SBitOffset, NextSBitOffset;
717*d415bd75Srobert         GetStorageBitRange(MemberTy, *RecordAlignment, SBitOffset,
71809467b48Spatrick                            NextSBitOffset);
71909467b48Spatrick         PatchImm += SBitOffset >> 3;
72009467b48Spatrick       }
72109467b48Spatrick     }
72209467b48Spatrick     return PatchImm;
72309467b48Spatrick   }
72409467b48Spatrick 
72509467b48Spatrick   if (InfoKind == BPFCoreSharedInfo::FIELD_BYTE_SIZE) {
72609467b48Spatrick     if (Tag == dwarf::DW_TAG_array_type) {
72709467b48Spatrick       auto *EltTy = stripQualifiers(CTy->getBaseType());
72809467b48Spatrick       return calcArraySize(CTy, 1) * (EltTy->getSizeInBits() >> 3);
72909467b48Spatrick     } else {
73009467b48Spatrick       auto *MemberTy = cast<DIDerivedType>(CTy->getElements()[AccessIndex]);
73109467b48Spatrick       uint32_t SizeInBits = MemberTy->getSizeInBits();
73209467b48Spatrick       if (!MemberTy->isBitField())
73309467b48Spatrick         return SizeInBits >> 3;
73409467b48Spatrick 
73509467b48Spatrick       unsigned SBitOffset, NextSBitOffset;
736*d415bd75Srobert       GetStorageBitRange(MemberTy, *RecordAlignment, SBitOffset,
737*d415bd75Srobert                          NextSBitOffset);
73809467b48Spatrick       SizeInBits = NextSBitOffset - SBitOffset;
73909467b48Spatrick       if (SizeInBits & (SizeInBits - 1))
74009467b48Spatrick         report_fatal_error("Unsupported field expression for llvm.bpf.preserve.field.info");
74109467b48Spatrick       return SizeInBits >> 3;
74209467b48Spatrick     }
74309467b48Spatrick   }
74409467b48Spatrick 
74509467b48Spatrick   if (InfoKind == BPFCoreSharedInfo::FIELD_SIGNEDNESS) {
74609467b48Spatrick     const DIType *BaseTy;
74709467b48Spatrick     if (Tag == dwarf::DW_TAG_array_type) {
74809467b48Spatrick       // Signedness only checked when final array elements are accessed.
74909467b48Spatrick       if (CTy->getElements().size() != 1)
75009467b48Spatrick         report_fatal_error("Invalid array expression for llvm.bpf.preserve.field.info");
75109467b48Spatrick       BaseTy = stripQualifiers(CTy->getBaseType());
75209467b48Spatrick     } else {
75309467b48Spatrick       auto *MemberTy = cast<DIDerivedType>(CTy->getElements()[AccessIndex]);
75409467b48Spatrick       BaseTy = stripQualifiers(MemberTy->getBaseType());
75509467b48Spatrick     }
75609467b48Spatrick 
75709467b48Spatrick     // Only basic types and enum types have signedness.
75809467b48Spatrick     const auto *BTy = dyn_cast<DIBasicType>(BaseTy);
75909467b48Spatrick     while (!BTy) {
76009467b48Spatrick       const auto *CompTy = dyn_cast<DICompositeType>(BaseTy);
76109467b48Spatrick       // Report an error if the field expression does not have signedness.
76209467b48Spatrick       if (!CompTy || CompTy->getTag() != dwarf::DW_TAG_enumeration_type)
76309467b48Spatrick         report_fatal_error("Invalid field expression for llvm.bpf.preserve.field.info");
76409467b48Spatrick       BaseTy = stripQualifiers(CompTy->getBaseType());
76509467b48Spatrick       BTy = dyn_cast<DIBasicType>(BaseTy);
76609467b48Spatrick     }
76709467b48Spatrick     uint32_t Encoding = BTy->getEncoding();
76809467b48Spatrick     return (Encoding == dwarf::DW_ATE_signed || Encoding == dwarf::DW_ATE_signed_char);
76909467b48Spatrick   }
77009467b48Spatrick 
77109467b48Spatrick   if (InfoKind == BPFCoreSharedInfo::FIELD_LSHIFT_U64) {
77209467b48Spatrick     // The value is loaded into a value with FIELD_BYTE_SIZE size,
77309467b48Spatrick     // and then zero or sign extended to U64.
77409467b48Spatrick     // FIELD_LSHIFT_U64 and FIELD_RSHIFT_U64 are operations
77509467b48Spatrick     // to extract the original value.
77609467b48Spatrick     const Triple &Triple = TM->getTargetTriple();
77709467b48Spatrick     DIDerivedType *MemberTy = nullptr;
77809467b48Spatrick     bool IsBitField = false;
77909467b48Spatrick     uint32_t SizeInBits;
78009467b48Spatrick 
78109467b48Spatrick     if (Tag == dwarf::DW_TAG_array_type) {
78209467b48Spatrick       auto *EltTy = stripQualifiers(CTy->getBaseType());
78309467b48Spatrick       SizeInBits = calcArraySize(CTy, 1) * EltTy->getSizeInBits();
78409467b48Spatrick     } else {
78509467b48Spatrick       MemberTy = cast<DIDerivedType>(CTy->getElements()[AccessIndex]);
78609467b48Spatrick       SizeInBits = MemberTy->getSizeInBits();
78709467b48Spatrick       IsBitField = MemberTy->isBitField();
78809467b48Spatrick     }
78909467b48Spatrick 
79009467b48Spatrick     if (!IsBitField) {
79109467b48Spatrick       if (SizeInBits > 64)
79209467b48Spatrick         report_fatal_error("too big field size for llvm.bpf.preserve.field.info");
79309467b48Spatrick       return 64 - SizeInBits;
79409467b48Spatrick     }
79509467b48Spatrick 
79609467b48Spatrick     unsigned SBitOffset, NextSBitOffset;
797*d415bd75Srobert     GetStorageBitRange(MemberTy, *RecordAlignment, SBitOffset, NextSBitOffset);
79809467b48Spatrick     if (NextSBitOffset - SBitOffset > 64)
79909467b48Spatrick       report_fatal_error("too big field size for llvm.bpf.preserve.field.info");
80009467b48Spatrick 
80109467b48Spatrick     unsigned OffsetInBits = MemberTy->getOffsetInBits();
80209467b48Spatrick     if (Triple.getArch() == Triple::bpfel)
80309467b48Spatrick       return SBitOffset + 64 - OffsetInBits - SizeInBits;
80409467b48Spatrick     else
80509467b48Spatrick       return OffsetInBits + 64 - NextSBitOffset;
80609467b48Spatrick   }
80709467b48Spatrick 
80809467b48Spatrick   if (InfoKind == BPFCoreSharedInfo::FIELD_RSHIFT_U64) {
80909467b48Spatrick     DIDerivedType *MemberTy = nullptr;
81009467b48Spatrick     bool IsBitField = false;
81109467b48Spatrick     uint32_t SizeInBits;
81209467b48Spatrick     if (Tag == dwarf::DW_TAG_array_type) {
81309467b48Spatrick       auto *EltTy = stripQualifiers(CTy->getBaseType());
81409467b48Spatrick       SizeInBits = calcArraySize(CTy, 1) * EltTy->getSizeInBits();
81509467b48Spatrick     } else {
81609467b48Spatrick       MemberTy = cast<DIDerivedType>(CTy->getElements()[AccessIndex]);
81709467b48Spatrick       SizeInBits = MemberTy->getSizeInBits();
81809467b48Spatrick       IsBitField = MemberTy->isBitField();
81909467b48Spatrick     }
82009467b48Spatrick 
82109467b48Spatrick     if (!IsBitField) {
82209467b48Spatrick       if (SizeInBits > 64)
82309467b48Spatrick         report_fatal_error("too big field size for llvm.bpf.preserve.field.info");
82409467b48Spatrick       return 64 - SizeInBits;
82509467b48Spatrick     }
82609467b48Spatrick 
82709467b48Spatrick     unsigned SBitOffset, NextSBitOffset;
828*d415bd75Srobert     GetStorageBitRange(MemberTy, *RecordAlignment, SBitOffset, NextSBitOffset);
82909467b48Spatrick     if (NextSBitOffset - SBitOffset > 64)
83009467b48Spatrick       report_fatal_error("too big field size for llvm.bpf.preserve.field.info");
83109467b48Spatrick 
83209467b48Spatrick     return 64 - SizeInBits;
83309467b48Spatrick   }
83409467b48Spatrick 
83509467b48Spatrick   llvm_unreachable("Unknown llvm.bpf.preserve.field.info info kind");
83609467b48Spatrick }
83709467b48Spatrick 
HasPreserveFieldInfoCall(CallInfoStack & CallStack)83809467b48Spatrick bool BPFAbstractMemberAccess::HasPreserveFieldInfoCall(CallInfoStack &CallStack) {
83909467b48Spatrick   // This is called in error return path, no need to maintain CallStack.
84009467b48Spatrick   while (CallStack.size()) {
84109467b48Spatrick     auto StackElem = CallStack.top();
84209467b48Spatrick     if (StackElem.second.Kind == BPFPreserveFieldInfoAI)
84309467b48Spatrick       return true;
84409467b48Spatrick     CallStack.pop();
84509467b48Spatrick   }
84609467b48Spatrick   return false;
84709467b48Spatrick }
84809467b48Spatrick 
84909467b48Spatrick /// Compute the base of the whole preserve_* intrinsics chains, i.e., the base
85009467b48Spatrick /// pointer of the first preserve_*_access_index call, and construct the access
85109467b48Spatrick /// string, which will be the name of a global variable.
computeBaseAndAccessKey(CallInst * Call,CallInfo & CInfo,std::string & AccessKey,MDNode * & TypeMeta)85209467b48Spatrick Value *BPFAbstractMemberAccess::computeBaseAndAccessKey(CallInst *Call,
85309467b48Spatrick                                                         CallInfo &CInfo,
85409467b48Spatrick                                                         std::string &AccessKey,
85509467b48Spatrick                                                         MDNode *&TypeMeta) {
85609467b48Spatrick   Value *Base = nullptr;
85709467b48Spatrick   std::string TypeName;
85809467b48Spatrick   CallInfoStack CallStack;
85909467b48Spatrick 
86009467b48Spatrick   // Put the access chain into a stack with the top as the head of the chain.
86109467b48Spatrick   while (Call) {
86209467b48Spatrick     CallStack.push(std::make_pair(Call, CInfo));
86309467b48Spatrick     CInfo = AIChain[Call].second;
86409467b48Spatrick     Call = AIChain[Call].first;
86509467b48Spatrick   }
86609467b48Spatrick 
86709467b48Spatrick   // The access offset from the base of the head of chain is also
86809467b48Spatrick   // calculated here as all debuginfo types are available.
86909467b48Spatrick 
87009467b48Spatrick   // Get type name and calculate the first index.
871097a140dSpatrick   // We only want to get type name from typedef, structure or union.
87209467b48Spatrick   // If user wants a relocation like
87309467b48Spatrick   //    int *p; ... __builtin_preserve_access_index(&p[4]) ...
87409467b48Spatrick   // or
87509467b48Spatrick   //    int a[10][20]; ... __builtin_preserve_access_index(&a[2][3]) ...
87609467b48Spatrick   // we will skip them.
87709467b48Spatrick   uint32_t FirstIndex = 0;
87809467b48Spatrick   uint32_t PatchImm = 0; // AccessOffset or the requested field info
87909467b48Spatrick   uint32_t InfoKind = BPFCoreSharedInfo::FIELD_BYTE_OFFSET;
88009467b48Spatrick   while (CallStack.size()) {
88109467b48Spatrick     auto StackElem = CallStack.top();
88209467b48Spatrick     Call = StackElem.first;
88309467b48Spatrick     CInfo = StackElem.second;
88409467b48Spatrick 
88509467b48Spatrick     if (!Base)
88609467b48Spatrick       Base = CInfo.Base;
88709467b48Spatrick 
888097a140dSpatrick     DIType *PossibleTypeDef = stripQualifiers(cast<DIType>(CInfo.Metadata),
889097a140dSpatrick                                               false);
890097a140dSpatrick     DIType *Ty = stripQualifiers(PossibleTypeDef);
89109467b48Spatrick     if (CInfo.Kind == BPFPreserveUnionAI ||
89209467b48Spatrick         CInfo.Kind == BPFPreserveStructAI) {
893097a140dSpatrick       // struct or union type. If the typedef is in the metadata, always
894097a140dSpatrick       // use the typedef.
895097a140dSpatrick       TypeName = std::string(PossibleTypeDef->getName());
896097a140dSpatrick       TypeMeta = PossibleTypeDef;
89709467b48Spatrick       PatchImm += FirstIndex * (Ty->getSizeInBits() >> 3);
89809467b48Spatrick       break;
89909467b48Spatrick     }
90009467b48Spatrick 
90109467b48Spatrick     assert(CInfo.Kind == BPFPreserveArrayAI);
90209467b48Spatrick 
90309467b48Spatrick     // Array entries will always be consumed for accumulative initial index.
90409467b48Spatrick     CallStack.pop();
90509467b48Spatrick 
90609467b48Spatrick     // BPFPreserveArrayAI
90709467b48Spatrick     uint64_t AccessIndex = CInfo.AccessIndex;
90809467b48Spatrick 
90909467b48Spatrick     DIType *BaseTy = nullptr;
91009467b48Spatrick     bool CheckElemType = false;
91109467b48Spatrick     if (const auto *CTy = dyn_cast<DICompositeType>(Ty)) {
91209467b48Spatrick       // array type
91309467b48Spatrick       assert(CTy->getTag() == dwarf::DW_TAG_array_type);
91409467b48Spatrick 
91509467b48Spatrick 
91609467b48Spatrick       FirstIndex += AccessIndex * calcArraySize(CTy, 1);
91709467b48Spatrick       BaseTy = stripQualifiers(CTy->getBaseType());
91809467b48Spatrick       CheckElemType = CTy->getElements().size() == 1;
91909467b48Spatrick     } else {
92009467b48Spatrick       // pointer type
92109467b48Spatrick       auto *DTy = cast<DIDerivedType>(Ty);
92209467b48Spatrick       assert(DTy->getTag() == dwarf::DW_TAG_pointer_type);
92309467b48Spatrick 
92409467b48Spatrick       BaseTy = stripQualifiers(DTy->getBaseType());
92509467b48Spatrick       CTy = dyn_cast<DICompositeType>(BaseTy);
92609467b48Spatrick       if (!CTy) {
92709467b48Spatrick         CheckElemType = true;
92809467b48Spatrick       } else if (CTy->getTag() != dwarf::DW_TAG_array_type) {
92909467b48Spatrick         FirstIndex += AccessIndex;
93009467b48Spatrick         CheckElemType = true;
93109467b48Spatrick       } else {
93209467b48Spatrick         FirstIndex += AccessIndex * calcArraySize(CTy, 0);
93309467b48Spatrick       }
93409467b48Spatrick     }
93509467b48Spatrick 
93609467b48Spatrick     if (CheckElemType) {
93709467b48Spatrick       auto *CTy = dyn_cast<DICompositeType>(BaseTy);
93809467b48Spatrick       if (!CTy) {
93909467b48Spatrick         if (HasPreserveFieldInfoCall(CallStack))
94009467b48Spatrick           report_fatal_error("Invalid field access for llvm.preserve.field.info intrinsic");
94109467b48Spatrick         return nullptr;
94209467b48Spatrick       }
94309467b48Spatrick 
94409467b48Spatrick       unsigned CTag = CTy->getTag();
94509467b48Spatrick       if (CTag == dwarf::DW_TAG_structure_type || CTag == dwarf::DW_TAG_union_type) {
946097a140dSpatrick         TypeName = std::string(CTy->getName());
94709467b48Spatrick       } else {
94809467b48Spatrick         if (HasPreserveFieldInfoCall(CallStack))
94909467b48Spatrick           report_fatal_error("Invalid field access for llvm.preserve.field.info intrinsic");
95009467b48Spatrick         return nullptr;
95109467b48Spatrick       }
95209467b48Spatrick       TypeMeta = CTy;
95309467b48Spatrick       PatchImm += FirstIndex * (CTy->getSizeInBits() >> 3);
95409467b48Spatrick       break;
95509467b48Spatrick     }
95609467b48Spatrick   }
95709467b48Spatrick   assert(TypeName.size());
95809467b48Spatrick   AccessKey += std::to_string(FirstIndex);
95909467b48Spatrick 
96009467b48Spatrick   // Traverse the rest of access chain to complete offset calculation
96109467b48Spatrick   // and access key construction.
96209467b48Spatrick   while (CallStack.size()) {
96309467b48Spatrick     auto StackElem = CallStack.top();
96409467b48Spatrick     CInfo = StackElem.second;
96509467b48Spatrick     CallStack.pop();
96609467b48Spatrick 
967097a140dSpatrick     if (CInfo.Kind == BPFPreserveFieldInfoAI) {
968097a140dSpatrick       InfoKind = CInfo.AccessIndex;
96973471bf0Spatrick       if (InfoKind == BPFCoreSharedInfo::FIELD_EXISTENCE)
97073471bf0Spatrick         PatchImm = 1;
97109467b48Spatrick       break;
972097a140dSpatrick     }
97309467b48Spatrick 
97409467b48Spatrick     // If the next Call (the top of the stack) is a BPFPreserveFieldInfoAI,
97509467b48Spatrick     // the action will be extracting field info.
97609467b48Spatrick     if (CallStack.size()) {
97709467b48Spatrick       auto StackElem2 = CallStack.top();
97809467b48Spatrick       CallInfo CInfo2 = StackElem2.second;
97909467b48Spatrick       if (CInfo2.Kind == BPFPreserveFieldInfoAI) {
98009467b48Spatrick         InfoKind = CInfo2.AccessIndex;
98109467b48Spatrick         assert(CallStack.size() == 1);
98209467b48Spatrick       }
98309467b48Spatrick     }
98409467b48Spatrick 
98509467b48Spatrick     // Access Index
98609467b48Spatrick     uint64_t AccessIndex = CInfo.AccessIndex;
98709467b48Spatrick     AccessKey += ":" + std::to_string(AccessIndex);
98809467b48Spatrick 
98909467b48Spatrick     MDNode *MDN = CInfo.Metadata;
99009467b48Spatrick     // At this stage, it cannot be pointer type.
99109467b48Spatrick     auto *CTy = cast<DICompositeType>(stripQualifiers(cast<DIType>(MDN)));
99209467b48Spatrick     PatchImm = GetFieldInfo(InfoKind, CTy, AccessIndex, PatchImm,
993097a140dSpatrick                             CInfo.RecordAlignment);
99409467b48Spatrick   }
99509467b48Spatrick 
99609467b48Spatrick   // Access key is the
99709467b48Spatrick   //   "llvm." + type name + ":" + reloc type + ":" + patched imm + "$" +
99809467b48Spatrick   //   access string,
99909467b48Spatrick   // uniquely identifying one relocation.
100009467b48Spatrick   // The prefix "llvm." indicates this is a temporary global, which should
100109467b48Spatrick   // not be emitted to ELF file.
100209467b48Spatrick   AccessKey = "llvm." + TypeName + ":" + std::to_string(InfoKind) + ":" +
100309467b48Spatrick               std::to_string(PatchImm) + "$" + AccessKey;
100409467b48Spatrick 
100509467b48Spatrick   return Base;
100609467b48Spatrick }
100709467b48Spatrick 
computeAccessKey(CallInst * Call,CallInfo & CInfo,std::string & AccessKey,bool & IsInt32Ret)100873471bf0Spatrick MDNode *BPFAbstractMemberAccess::computeAccessKey(CallInst *Call,
100973471bf0Spatrick                                                   CallInfo &CInfo,
101073471bf0Spatrick                                                   std::string &AccessKey,
101173471bf0Spatrick                                                   bool &IsInt32Ret) {
101273471bf0Spatrick   DIType *Ty = stripQualifiers(cast<DIType>(CInfo.Metadata), false);
101373471bf0Spatrick   assert(!Ty->getName().empty());
101473471bf0Spatrick 
101573471bf0Spatrick   int64_t PatchImm;
101673471bf0Spatrick   std::string AccessStr("0");
1017*d415bd75Srobert   if (CInfo.AccessIndex == BPFCoreSharedInfo::TYPE_EXISTENCE ||
1018*d415bd75Srobert       CInfo.AccessIndex == BPFCoreSharedInfo::TYPE_MATCH) {
101973471bf0Spatrick     PatchImm = 1;
102073471bf0Spatrick   } else if (CInfo.AccessIndex == BPFCoreSharedInfo::TYPE_SIZE) {
102173471bf0Spatrick     // typedef debuginfo type has size 0, get the eventual base type.
102273471bf0Spatrick     DIType *BaseTy = stripQualifiers(Ty, true);
102373471bf0Spatrick     PatchImm = BaseTy->getSizeInBits() / 8;
102473471bf0Spatrick   } else {
102573471bf0Spatrick     // ENUM_VALUE_EXISTENCE and ENUM_VALUE
102673471bf0Spatrick     IsInt32Ret = false;
102773471bf0Spatrick 
1028*d415bd75Srobert     // The argument could be a global variable or a getelementptr with base to
1029*d415bd75Srobert     // a global variable depending on whether the clang option `opaque-options`
1030*d415bd75Srobert     // is set or not.
1031*d415bd75Srobert     const GlobalVariable *GV =
1032*d415bd75Srobert         cast<GlobalVariable>(Call->getArgOperand(1)->stripPointerCasts());
103373471bf0Spatrick     assert(GV->hasInitializer());
103473471bf0Spatrick     const ConstantDataArray *DA = cast<ConstantDataArray>(GV->getInitializer());
103573471bf0Spatrick     assert(DA->isString());
103673471bf0Spatrick     StringRef ValueStr = DA->getAsString();
103773471bf0Spatrick 
103873471bf0Spatrick     // ValueStr format: <EnumeratorStr>:<Value>
103973471bf0Spatrick     size_t Separator = ValueStr.find_first_of(':');
104073471bf0Spatrick     StringRef EnumeratorStr = ValueStr.substr(0, Separator);
104173471bf0Spatrick 
104273471bf0Spatrick     // Find enumerator index in the debuginfo
104373471bf0Spatrick     DIType *BaseTy = stripQualifiers(Ty, true);
104473471bf0Spatrick     const auto *CTy = cast<DICompositeType>(BaseTy);
104573471bf0Spatrick     assert(CTy->getTag() == dwarf::DW_TAG_enumeration_type);
104673471bf0Spatrick     int EnumIndex = 0;
104773471bf0Spatrick     for (const auto Element : CTy->getElements()) {
104873471bf0Spatrick       const auto *Enum = cast<DIEnumerator>(Element);
104973471bf0Spatrick       if (Enum->getName() == EnumeratorStr) {
105073471bf0Spatrick         AccessStr = std::to_string(EnumIndex);
105173471bf0Spatrick         break;
105273471bf0Spatrick       }
105373471bf0Spatrick       EnumIndex++;
105473471bf0Spatrick     }
105573471bf0Spatrick 
105673471bf0Spatrick     if (CInfo.AccessIndex == BPFCoreSharedInfo::ENUM_VALUE) {
105773471bf0Spatrick       StringRef EValueStr = ValueStr.substr(Separator + 1);
105873471bf0Spatrick       PatchImm = std::stoll(std::string(EValueStr));
105973471bf0Spatrick     } else {
106073471bf0Spatrick       PatchImm = 1;
106173471bf0Spatrick     }
106273471bf0Spatrick   }
106373471bf0Spatrick 
106473471bf0Spatrick   AccessKey = "llvm." + Ty->getName().str() + ":" +
106573471bf0Spatrick               std::to_string(CInfo.AccessIndex) + std::string(":") +
106673471bf0Spatrick               std::to_string(PatchImm) + std::string("$") + AccessStr;
106773471bf0Spatrick 
106873471bf0Spatrick   return Ty;
106973471bf0Spatrick }
107073471bf0Spatrick 
107109467b48Spatrick /// Call/Kind is the base preserve_*_access_index() call. Attempts to do
107209467b48Spatrick /// transformation to a chain of relocable GEPs.
transformGEPChain(CallInst * Call,CallInfo & CInfo)107373471bf0Spatrick bool BPFAbstractMemberAccess::transformGEPChain(CallInst *Call,
107409467b48Spatrick                                                 CallInfo &CInfo) {
107509467b48Spatrick   std::string AccessKey;
107609467b48Spatrick   MDNode *TypeMeta;
107773471bf0Spatrick   Value *Base = nullptr;
107873471bf0Spatrick   bool IsInt32Ret;
107973471bf0Spatrick 
108073471bf0Spatrick   IsInt32Ret = CInfo.Kind == BPFPreserveFieldInfoAI;
108173471bf0Spatrick   if (CInfo.Kind == BPFPreserveFieldInfoAI && CInfo.Metadata) {
108273471bf0Spatrick     TypeMeta = computeAccessKey(Call, CInfo, AccessKey, IsInt32Ret);
108373471bf0Spatrick   } else {
108473471bf0Spatrick     Base = computeBaseAndAccessKey(Call, CInfo, AccessKey, TypeMeta);
108509467b48Spatrick     if (!Base)
108609467b48Spatrick       return false;
108773471bf0Spatrick   }
108809467b48Spatrick 
108909467b48Spatrick   BasicBlock *BB = Call->getParent();
109009467b48Spatrick   GlobalVariable *GV;
109109467b48Spatrick 
109209467b48Spatrick   if (GEPGlobals.find(AccessKey) == GEPGlobals.end()) {
109309467b48Spatrick     IntegerType *VarType;
109473471bf0Spatrick     if (IsInt32Ret)
109509467b48Spatrick       VarType = Type::getInt32Ty(BB->getContext()); // 32bit return value
109609467b48Spatrick     else
109773471bf0Spatrick       VarType = Type::getInt64Ty(BB->getContext()); // 64bit ptr or enum value
109809467b48Spatrick 
109973471bf0Spatrick     GV = new GlobalVariable(*M, VarType, false, GlobalVariable::ExternalLinkage,
1100*d415bd75Srobert                             nullptr, AccessKey);
110109467b48Spatrick     GV->addAttribute(BPFCoreSharedInfo::AmaAttr);
110209467b48Spatrick     GV->setMetadata(LLVMContext::MD_preserve_access_index, TypeMeta);
110309467b48Spatrick     GEPGlobals[AccessKey] = GV;
110409467b48Spatrick   } else {
110509467b48Spatrick     GV = GEPGlobals[AccessKey];
110609467b48Spatrick   }
110709467b48Spatrick 
110809467b48Spatrick   if (CInfo.Kind == BPFPreserveFieldInfoAI) {
110909467b48Spatrick     // Load the global variable which represents the returned field info.
111073471bf0Spatrick     LoadInst *LDInst;
111173471bf0Spatrick     if (IsInt32Ret)
111273471bf0Spatrick       LDInst = new LoadInst(Type::getInt32Ty(BB->getContext()), GV, "", Call);
111373471bf0Spatrick     else
111473471bf0Spatrick       LDInst = new LoadInst(Type::getInt64Ty(BB->getContext()), GV, "", Call);
111573471bf0Spatrick 
111673471bf0Spatrick     Instruction *PassThroughInst =
111773471bf0Spatrick         BPFCoreSharedInfo::insertPassThrough(M, BB, LDInst, Call);
111873471bf0Spatrick     Call->replaceAllUsesWith(PassThroughInst);
111909467b48Spatrick     Call->eraseFromParent();
112009467b48Spatrick     return true;
112109467b48Spatrick   }
112209467b48Spatrick 
112309467b48Spatrick   // For any original GEP Call and Base %2 like
112409467b48Spatrick   //   %4 = bitcast %struct.net_device** %dev1 to i64*
112509467b48Spatrick   // it is transformed to:
112673471bf0Spatrick   //   %6 = load llvm.sk_buff:0:50$0:0:0:2:0
112709467b48Spatrick   //   %7 = bitcast %struct.sk_buff* %2 to i8*
112809467b48Spatrick   //   %8 = getelementptr i8, i8* %7, %6
112909467b48Spatrick   //   %9 = bitcast i8* %8 to i64*
113009467b48Spatrick   //   using %9 instead of %4
113109467b48Spatrick   // The original Call inst is removed.
113209467b48Spatrick 
113309467b48Spatrick   // Load the global variable.
1134097a140dSpatrick   auto *LDInst = new LoadInst(Type::getInt64Ty(BB->getContext()), GV, "", Call);
113509467b48Spatrick 
113609467b48Spatrick   // Generate a BitCast
113709467b48Spatrick   auto *BCInst = new BitCastInst(Base, Type::getInt8PtrTy(BB->getContext()));
1138*d415bd75Srobert   BCInst->insertBefore(Call);
113909467b48Spatrick 
114009467b48Spatrick   // Generate a GetElementPtr
114109467b48Spatrick   auto *GEP = GetElementPtrInst::Create(Type::getInt8Ty(BB->getContext()),
114209467b48Spatrick                                         BCInst, LDInst);
1143*d415bd75Srobert   GEP->insertBefore(Call);
114409467b48Spatrick 
114509467b48Spatrick   // Generate a BitCast
114609467b48Spatrick   auto *BCInst2 = new BitCastInst(GEP, Call->getType());
1147*d415bd75Srobert   BCInst2->insertBefore(Call);
114809467b48Spatrick 
114973471bf0Spatrick   // For the following code,
115073471bf0Spatrick   //    Block0:
115173471bf0Spatrick   //      ...
115273471bf0Spatrick   //      if (...) goto Block1 else ...
115373471bf0Spatrick   //    Block1:
115473471bf0Spatrick   //      %6 = load llvm.sk_buff:0:50$0:0:0:2:0
115573471bf0Spatrick   //      %7 = bitcast %struct.sk_buff* %2 to i8*
115673471bf0Spatrick   //      %8 = getelementptr i8, i8* %7, %6
115773471bf0Spatrick   //      ...
115873471bf0Spatrick   //      goto CommonExit
115973471bf0Spatrick   //    Block2:
116073471bf0Spatrick   //      ...
116173471bf0Spatrick   //      if (...) goto Block3 else ...
116273471bf0Spatrick   //    Block3:
116373471bf0Spatrick   //      %6 = load llvm.bpf_map:0:40$0:0:0:2:0
116473471bf0Spatrick   //      %7 = bitcast %struct.sk_buff* %2 to i8*
116573471bf0Spatrick   //      %8 = getelementptr i8, i8* %7, %6
116673471bf0Spatrick   //      ...
116773471bf0Spatrick   //      goto CommonExit
116873471bf0Spatrick   //    CommonExit
116973471bf0Spatrick   // SimplifyCFG may generate:
117073471bf0Spatrick   //    Block0:
117173471bf0Spatrick   //      ...
117273471bf0Spatrick   //      if (...) goto Block_Common else ...
117373471bf0Spatrick   //     Block2:
117473471bf0Spatrick   //       ...
117573471bf0Spatrick   //      if (...) goto Block_Common else ...
117673471bf0Spatrick   //    Block_Common:
117773471bf0Spatrick   //      PHI = [llvm.sk_buff:0:50$0:0:0:2:0, llvm.bpf_map:0:40$0:0:0:2:0]
117873471bf0Spatrick   //      %6 = load PHI
117973471bf0Spatrick   //      %7 = bitcast %struct.sk_buff* %2 to i8*
118073471bf0Spatrick   //      %8 = getelementptr i8, i8* %7, %6
118173471bf0Spatrick   //      ...
118273471bf0Spatrick   //      goto CommonExit
118373471bf0Spatrick   //  For the above code, we cannot perform proper relocation since
118473471bf0Spatrick   //  "load PHI" has two possible relocations.
118573471bf0Spatrick   //
118673471bf0Spatrick   // To prevent above tail merging, we use __builtin_bpf_passthrough()
118773471bf0Spatrick   // where one of its parameters is a seq_num. Since two
118873471bf0Spatrick   // __builtin_bpf_passthrough() funcs will always have different seq_num,
118973471bf0Spatrick   // tail merging cannot happen. The __builtin_bpf_passthrough() will be
119073471bf0Spatrick   // removed in the beginning of Target IR passes.
119173471bf0Spatrick   //
119273471bf0Spatrick   // This approach is also used in other places when global var
119373471bf0Spatrick   // representing a relocation is used.
119473471bf0Spatrick   Instruction *PassThroughInst =
119573471bf0Spatrick       BPFCoreSharedInfo::insertPassThrough(M, BB, BCInst2, Call);
119673471bf0Spatrick   Call->replaceAllUsesWith(PassThroughInst);
119709467b48Spatrick   Call->eraseFromParent();
119809467b48Spatrick 
119909467b48Spatrick   return true;
120009467b48Spatrick }
120109467b48Spatrick 
doTransformation(Function & F)120273471bf0Spatrick bool BPFAbstractMemberAccess::doTransformation(Function &F) {
120309467b48Spatrick   bool Transformed = false;
120409467b48Spatrick 
120509467b48Spatrick   // Collect PreserveDIAccessIndex Intrinsic call chains.
120609467b48Spatrick   // The call chains will be used to generate the access
120709467b48Spatrick   // patterns similar to GEP.
120873471bf0Spatrick   collectAICallChains(F);
120909467b48Spatrick 
121009467b48Spatrick   for (auto &C : BaseAICalls)
121173471bf0Spatrick     Transformed = transformGEPChain(C.first, C.second) || Transformed;
121273471bf0Spatrick 
121373471bf0Spatrick   return removePreserveAccessIndexIntrinsic(F) || Transformed;
121409467b48Spatrick }
121509467b48Spatrick 
121673471bf0Spatrick PreservedAnalyses
run(Function & F,FunctionAnalysisManager & AM)121773471bf0Spatrick BPFAbstractMemberAccessPass::run(Function &F, FunctionAnalysisManager &AM) {
121873471bf0Spatrick   return BPFAbstractMemberAccess(TM).run(F) ? PreservedAnalyses::none()
121973471bf0Spatrick                                             : PreservedAnalyses::all();
122009467b48Spatrick }
1221