HexagonMachineFunctionInfo.h

Go to the documentation of this file.

//=- HexagonMachineFunctionInfo.h - Hexagon machine function info -*- C++ -*-=//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
 
#ifndef LLVM_LIB_TARGET_HEXAGON_HEXAGONMACHINEFUNCTIONINFO_H
#define LLVM_LIB_TARGET_HEXAGON_HEXAGONMACHINEFUNCTIONINFO_H
 
#include "llvm/ADT/DenseMap.h"
#include "llvm/CodeGen/MIRYamlMapping.h"
#include "llvm/CodeGen/MachineFrameInfo.h"
#include "llvm/CodeGen/MachineFunction.h"
#include <map>
 
namespace llvm {
 
namespace yaml {
struct HexagonFunctionInfo;
} // end namespace yaml
 
namespace Hexagon {
 
    const unsigned int StartPacket = 0x1;
    const unsigned int EndPacket = 0x2;
 
} // end namespace Hexagon
 
/// Hexagon target-specific information for each MachineFunction.
class HexagonMachineFunctionInfo : public MachineFunctionInfo {
  // SRetReturnReg - Some subtargets require that sret lowering includes
  // returning the value of the returned struct in a register. This field
  // holds the virtual register into which the sret argument is passed.
  unsigned SRetReturnReg = 0;
  Register StackAlignBaseReg = 0;    // Aligned-stack base register
  int VarArgsFrameIndex;
  int RegSavedAreaStartFrameIndex;
  int FirstNamedArgFrameIndex;
  int LastNamedArgFrameIndex;
  bool HasClobberLR = false;
  bool HasEHReturn = false;
  MachineFrameInfo VTCMFrameInfo{Align(2048), false, false};
  DenseMap<int, int> VTCMMap;
  std::map<const MachineInstr*, unsigned> PacketInfo;
  virtual void anchor();
 
public:
  HexagonMachineFunctionInfo() = default;
 
  HexagonMachineFunctionInfo(const Function &F,
                             const TargetSubtargetInfo *STI) {}
 
  HexagonMachineFunctionInfo(const HexagonMachineFunctionInfo &Other);
 
  MachineFunctionInfo *
  clone(BumpPtrAllocator &Allocator, MachineFunction &DestMF,
        const DenseMap<MachineBasicBlock *, MachineBasicBlock *> &Src2DstMBB)
      const override;
 
  void initializeBaseYamlFields(const yaml::HexagonFunctionInfo &YamlMFI);
 
  unsigned getSRetReturnReg() const { return SRetReturnReg; }
  void setSRetReturnReg(unsigned Reg) { SRetReturnReg = Reg; }
 
  void setVarArgsFrameIndex(int v) { VarArgsFrameIndex = v; }
  int getVarArgsFrameIndex() { return VarArgsFrameIndex; }
 
  void setRegSavedAreaStartFrameIndex(int v) { RegSavedAreaStartFrameIndex = v;}
  int getRegSavedAreaStartFrameIndex() { return RegSavedAreaStartFrameIndex; }
 
  void setFirstNamedArgFrameIndex(int v) { FirstNamedArgFrameIndex = v; }
  int getFirstNamedArgFrameIndex() { return FirstNamedArgFrameIndex; }
 
  void setLastNamedArgFrameIndex(int v) { LastNamedArgFrameIndex = v; }
  int getLastNamedArgFrameIndex() { return LastNamedArgFrameIndex; }
 
  void setStartPacket(MachineInstr* MI) {
    PacketInfo[MI] |= Hexagon::StartPacket;
  }
  void setEndPacket(MachineInstr* MI)   {
    PacketInfo[MI] |= Hexagon::EndPacket;
  }
  bool isStartPacket(const MachineInstr* MI) const {
    auto It = PacketInfo.find(MI);
    return It != PacketInfo.end() && (It->second & Hexagon::StartPacket);
  }
  bool isEndPacket(const MachineInstr* MI) const {
    auto It = PacketInfo.find(MI);
    return It != PacketInfo.end() && (It->second & Hexagon::EndPacket);
  }
  void setHasClobberLR(bool v) { HasClobberLR = v;  }
  bool hasClobberLR() const { return HasClobberLR; }
 
  bool hasEHReturn() const { return HasEHReturn; };
  void setHasEHReturn(bool H = true) { HasEHReturn = H; };
 
  void setStackAlignBaseReg(Register R) { StackAlignBaseReg = R; }
  Register getStackAlignBaseReg() const { return StackAlignBaseReg; }
 
  MachineFrameInfo &getVTCMFrameInfo() { return VTCMFrameInfo; }
  const MachineFrameInfo &getVTCMFrameInfo() const { return VTCMFrameInfo; }
 
  void moveToVTCMStack(int From, int To) { VTCMMap.insert({From, To}); }
  bool isVTCMStackIndex(int ObjectIdx) const {
    return VTCMMap.contains(ObjectIdx);
  }
  int getMappedVTCMObjectIndex(int ObjectIdx) const {
    return VTCMMap.lookup(ObjectIdx);
  }
  int64_t getMappedVTCMObjectOffset(int ObjectIdx) const {
    return VTCMFrameInfo.getObjectOffset(getMappedVTCMObjectIndex(ObjectIdx));
  }
};
 
namespace yaml {
 
/// Hexagon-specific MachineFunction properties for YAML serialization.
struct HexagonFunctionInfo final : public yaml::MachineFunctionInfo {
  StringValue StackAlignBaseReg;
 
  HexagonFunctionInfo() = default;
  HexagonFunctionInfo(const llvm::HexagonMachineFunctionInfo &MFI,
                      const TargetRegisterInfo &TRI);
 
  void mappingImpl(yaml::IO &YamlIO) override;
  ~HexagonFunctionInfo() override = default;
};
 
template <> struct MappingTraits<HexagonFunctionInfo> {
  static void mapping(IO &YamlIO, HexagonFunctionInfo &MFI) {
    YamlIO.mapOptional("stackAlignBaseReg", MFI.StackAlignBaseReg);
  }
};
 
} // end namespace yaml
 
} // end namespace llvm
 
#endif // LLVM_LIB_TARGET_HEXAGON_HEXAGONMACHINEFUNCTIONINFO_H