SPIRVTypeInst.h

Go to the documentation of this file.

//===-- SPIRVTypeInst.h - SPIR-V Type Instruction ---------------*- 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
//
//===----------------------------------------------------------------------===//
//
// SPIRVTypeInst is used to represent a SPIR-V type instruction.
//
//===----------------------------------------------------------------------===//
 
#ifndef LLVM_LIB_TARGET_SPIRV_SPIRVTYPEINST_H
#define LLVM_LIB_TARGET_SPIRV_SPIRVTYPEINST_H
 
#include "llvm/ADT/DenseMapInfo.h"
 
namespace llvm {
class MachineInstr;
class MachineRegisterInfo;
 
class SPIRVTypeInst {
  const MachineInstr *MI;
 
  // Used by DenseMapInfo to bypass the assertion. The thombstone and empty keys
  // are not null. They are -1 and -2 aligned to the appropiate pointer size.
  struct UncheckedConstructor {};
  SPIRVTypeInst(const MachineInstr *MI, UncheckedConstructor) : MI(MI) {};
 
public:
  SPIRVTypeInst(const MachineInstr &MI) : SPIRVTypeInst(&MI) {}
  SPIRVTypeInst(const MachineInstr *MI = nullptr);
 
  // No need to verify the register since it's already verified by the copied
  // object.
  SPIRVTypeInst(const SPIRVTypeInst &Other) = default;
  SPIRVTypeInst &operator=(const SPIRVTypeInst &Other) = default;
 
  const MachineInstr &operator*() const { return *MI; }
  const MachineInstr *operator->() const { return MI; }
  operator const MachineInstr *() const { return MI; }
 
  bool operator==(const SPIRVTypeInst &Other) const { return MI == Other.MI; }
  bool operator!=(const SPIRVTypeInst &Other) const { return MI != Other.MI; }
 
  operator bool() const { return MI; }
 
  // Returns true if this is an OpTypeInt instruction.
  // If N is non-zero, also checks that the bit width matches N.
  bool isTypeIntN(unsigned N = 0) const;
  // Returns true if this is an OpTypeFloat instruction.
  bool isAnyTypeFloat() const;
  // Returns true if this is an OpTypeInt or OpTypeFloat instruction.
  bool isTypeIntOrFloat() const { return isTypeIntN() || isAnyTypeFloat(); }
  // Returns true if this is an OpTypePointer or OpTypeUntypedPointerKHR
  // instruction.
  bool isPointer() const;
  // Returns true if this is an OpTypePointer instruction.
  bool isTypePtr() const;
  // Returns true if this is an OpTypeUntypedPointerKHR instruction.
  bool isTypeUntypedPtr() const;
 
  friend struct DenseMapInfo<SPIRVTypeInst>;
};
 
template <> struct DenseMapInfo<SPIRVTypeInst> {
  using MIInfo = DenseMapInfo<MachineInstr *>;
  static unsigned getHashValue(SPIRVTypeInst Ty) {
    return MIInfo::getHashValue(Ty.MI);
  }
  static bool isEqual(SPIRVTypeInst Ty1, SPIRVTypeInst Ty2) {
    return Ty1 == Ty2;
  }
};
 
} // namespace llvm
#endif // LLVM_LIB_TARGET_SPIRV_SPIRVTYPEINST_H