//===- NVPTXRegisterInfo.h - NVPTX Register Information Impl ----*- 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
//
//===----------------------------------------------------------------------===//
//
// This file contains the NVPTX implementation of the TargetRegisterInfo class.
//
//===----------------------------------------------------------------------===//

#ifndef LLVM_LIB_TARGET_NVPTX_NVPTXREGISTERINFO_H
#define LLVM_LIB_TARGET_NVPTX_NVPTXREGISTERINFO_H

#include "llvm/CodeGen/TargetRegisterInfo.h"
#include "llvm/Support/StringSaver.h"
#include <sstream>

#define GET_REGINFO_HEADER
#include "NVPTXGenRegisterInfo.inc"

namespace llvm {
class NVPTXRegisterInfo : public NVPTXGenRegisterInfo {
private:
  // Hold Strings that can be free'd all together with NVPTXRegisterInfo
  BumpPtrAllocator StrAlloc;
  UniqueStringSaver StrPool;
  // State for debug register mapping that can be mutated even through a const
  // pointer so that we can get the proper dwarf register encoding during ASM
  // emission.
  mutable DenseMap<uint64_t, uint64_t> debugRegisterMap;

public:
  NVPTXRegisterInfo();

  //------------------------------------------------------
  // Pure virtual functions from TargetRegisterInfo
  //------------------------------------------------------

  // NVPTX callee saved registers
  const MCPhysReg *getCalleeSavedRegs(const MachineFunction *MF) const override;

  BitVector getReservedRegs(const MachineFunction &MF) const override;

  bool eliminateFrameIndex(MachineBasicBlock::iterator MI, int SPAdj,
                           unsigned FIOperandNum,
                           RegScavenger *RS = nullptr) const override;

  Register getFrameRegister(const MachineFunction &MF) const override;
  Register getFrameLocalRegister(const MachineFunction &MF) const;

  UniqueStringSaver &getStrPool() const {
    return const_cast<UniqueStringSaver &>(StrPool);
  }

  const char *getName(unsigned RegNo) const {
    std::stringstream O;
    O << "reg" << RegNo;
    return getStrPool().save(O.str()).data();
  }

  // Manage the debugRegisterMap.  PTX virtual registers for DebugInfo are
  // encoded using the names used in the emitted text of the PTX assembly. This
  // mapping must be managed during assembly emission.
  //
  // These are marked const because the interfaces used to access this
  // RegisterInfo object are all const, but we need to communicate some state
  // here, because the proper encoding for debug registers is available only
  // temporarily during ASM emission.
  void addToDebugRegisterMap(uint64_t preEncodedVirtualRegister,
                             StringRef RegisterName) const;
  void clearDebugRegisterMap() const;
  int64_t getDwarfRegNum(MCRegister RegNum, bool isEH) const override;
  int64_t getDwarfRegNumForVirtReg(Register RegNum, bool isEH) const override;
};

StringRef getNVPTXRegClassName(const TargetRegisterClass *RC);
StringRef getNVPTXRegClassStr(const TargetRegisterClass *RC);

} // end namespace llvm

#endif