Move assume/expect to spirv_internal.hpp (#832)

SPV_INTEL_optimization_hints isn't going to be upstreamed to SPIR-V
Headers repository, therefore this patch is needed. Also it serves
a purpose to show, how can extensions be implemented using
spirv_internal.hpp.

Signed-off-by: Dmitry Sidorov <dmitry.sidorov@intel.com>

Author: MrSidims

llvm-spirv/lib/SPIRV/SPIRVReader.cpp

@@ -1804,7 +1804,8 @@ Value *SPIRVToLLVM::transValueWithoutDecoration(SPIRVValue *BV, Function *F,
   }
 
   // Translation of instructions
-  switch (BV->getOpCode()) {
+  int OpCode = BV->getOpCode();
+  switch (OpCode) {
   case OpBranch: {
     auto *BR = static_cast<SPIRVBranch *>(BV);
     auto *BI = BranchInst::Create(
@@ -2416,14 +2417,14 @@ Value *SPIRVToLLVM::transValueWithoutDecoration(SPIRVValue *BV, Function *F,
     return mapValue(BV, Call);
   }
 
-  case OpAssumeTrueINTEL: {
+  case internal::OpAssumeTrueINTEL: {
     IRBuilder<> Builder(BB);
     SPIRVAssumeTrueINTEL *BC = static_cast<SPIRVAssumeTrueINTEL *>(BV);
     Value *Condition = transValue(BC->getCondition(), F, BB);
     return mapValue(BV, Builder.CreateAssumption(Condition));
   }
 
-  case OpExpectINTEL: {
+  case internal::OpExpectINTEL: {
     IRBuilder<> Builder(BB);
     SPIRVExpectINTELInstBase *BC = static_cast<SPIRVExpectINTELInstBase *>(BV);
     Type *RetTy = transType(BC->getType());

llvm-spirv/lib/SPIRV/libSPIRV/SPIRVEntry.cpp

@@ -72,7 +72,10 @@ SPIRVEntry *SPIRVEntry::create(Op OpCode) {
 
   static TableEntry Table[] = {
 #define _SPIRV_OP(x, ...) {Op##x, &SPIRV::create<SPIRV##x>},
+#define _SPIRV_OP_INTERNAL(x, ...) {internal::Op##x, &SPIRV::create<SPIRV##x>},
 #include "SPIRVOpCodeEnum.h"
+#include "SPIRVOpCodeEnumInternal.h"
+#undef _SPIRV_OP_INTERNAL
 #undef _SPIRV_OP
   };
 

llvm-spirv/lib/SPIRV/libSPIRV/SPIRVInstruction.h

@@ -2828,7 +2828,7 @@ _SPIRV_OP(GenericCastToPtrExplicit, true, 5, false, 1)
 
 class SPIRVAssumeTrueINTEL : public SPIRVInstruction {
 public:
-  static const Op OC = OpAssumeTrueINTEL;
+  static const Op OC = internal::OpAssumeTrueINTEL;
   static const SPIRVWord FixedWordCount = 2;
 
   SPIRVAssumeTrueINTEL(SPIRVId TheCondition, SPIRVBasicBlock *BB)
@@ -2845,7 +2845,7 @@ class SPIRVAssumeTrueINTEL : public SPIRVInstruction {
   }
 
   SPIRVCapVec getRequiredCapability() const override {
-    return getVec(CapabilityOptimizationHintsINTEL);
+    return getVec(internal::CapabilityOptimizationHintsINTEL);
   }
 
   llvm::Optional<ExtensionID> getRequiredExtension() const override {
@@ -2866,19 +2866,20 @@ class SPIRVAssumeTrueINTEL : public SPIRVInstruction {
 class SPIRVExpectINTELInstBase : public SPIRVInstTemplateBase {
 protected:
   SPIRVCapVec getRequiredCapability() const override {
-    return getVec(CapabilityOptimizationHintsINTEL);
+    return getVec(internal::CapabilityOptimizationHintsINTEL);
   }
 
   llvm::Optional<ExtensionID> getRequiredExtension() const override {
     return ExtensionID::SPV_INTEL_optimization_hints;
   }
 };
 
-#define _SPIRV_OP(x, ...)                                                      \
-  typedef SPIRVInstTemplate<SPIRVExpectINTELInstBase, Op##x, __VA_ARGS__>      \
+#define _SPIRV_OP_INTERNAL(x, ...)                                             \
+  typedef SPIRVInstTemplate<SPIRVExpectINTELInstBase, internal::Op##x,         \
+                            __VA_ARGS__>                                       \
       SPIRV##x;
-_SPIRV_OP(ExpectINTEL, true, 5)
-#undef _SPIRV_OP
+_SPIRV_OP_INTERNAL(ExpectINTEL, true, 5)
+#undef _SPIRV_OP_INTERNAL
 
 class SPIRVSubgroupShuffleINTELInstBase : public SPIRVInstTemplateBase {
 protected:

llvm-spirv/lib/SPIRV/libSPIRV/SPIRVModule.cpp

@@ -1525,7 +1525,7 @@ SPIRVInstruction *SPIRVModuleImpl::addExpectINTELInst(SPIRVType *ResultTy,
                                                       SPIRVValue *ExpectedValue,
                                                       SPIRVBasicBlock *BB) {
   return addInstruction(SPIRVInstTemplateBase::create(
-                            OpExpectINTEL, ResultTy, getId(),
+                            internal::OpExpectINTEL, ResultTy, getId(),
                             getVec(Value->getId(), ExpectedValue->getId()), BB,
                             this),
                         BB);

llvm-spirv/lib/SPIRV/libSPIRV/SPIRVNameMapEnum.h

@@ -480,7 +480,7 @@ template <> inline void SPIRVMap<Capability, std::string>::init() {
   add(CapabilityAsmINTEL, "AsmINTEL");
   add(CapabilityVectorComputeINTEL, "VectorComputeINTEL");
   add(CapabilityVectorAnyINTEL, "VectorAnyINTEL");
-  add(CapabilityOptimizationHintsINTEL, "OptimizationHintsINTEL");
+  add(internal::CapabilityOptimizationHintsINTEL, "OptimizationHintsINTEL");
   add(CapabilitySubgroupAvcMotionEstimationINTEL,
       "SubgroupAvcMotionEstimationINTEL");
   add(CapabilitySubgroupAvcMotionEstimationIntraINTEL,

llvm-spirv/lib/SPIRV/libSPIRV/SPIRVOpCode.h

@@ -52,7 +52,7 @@ template <> inline void SPIRVMap<Op, std::string>::init() {
 #define _SPIRV_OP(x, ...) add(Op##x, #x);
 #define _SPIRV_OP_INTERNAL(x, ...) add(internal::Op##x, #x);
 #include "SPIRVOpCodeEnum.h"
-  _SPIRV_OP_INTERNAL(Forward, internal::OpForward)
+#include "SPIRVOpCodeEnumInternal.h"
 #undef _SPIRV_OP_INTERNAL
 #undef _SPIRV_OP
 }

llvm-spirv/lib/SPIRV/libSPIRV/SPIRVOpCodeEnum.h

@@ -341,8 +341,6 @@ _SPIRV_OP(FunctionPointerCallINTEL, 5601)
 _SPIRV_OP(AsmTargetINTEL, 5609)
 _SPIRV_OP(AsmINTEL, 5610)
 _SPIRV_OP(AsmCallINTEL, 5611)
-_SPIRV_OP(AssumeTrueINTEL, 5630)
-_SPIRV_OP(ExpectINTEL, 5631)
 _SPIRV_OP(VmeImageINTEL, 5699)
 _SPIRV_OP(TypeVmeImageINTEL, 5700)
 _SPIRV_OP(TypeAvcImePayloadINTEL, 5701)

llvm-spirv/lib/SPIRV/libSPIRV/SPIRVOpCodeEnumInternal.h

@@ -0,0 +1,5 @@
+#include "spirv_internal.hpp"
+
+_SPIRV_OP_INTERNAL(AssumeTrueINTEL, internal::OpAssumeTrueINTEL)
+_SPIRV_OP_INTERNAL(ExpectINTEL, internal::OpExpectINTEL)
+_SPIRV_OP_INTERNAL(Forward, internal::OpForward)

llvm-spirv/lib/SPIRV/libSPIRV/spirv.hpp

@@ -970,7 +970,6 @@ enum Capability {
   CapabilityAsmINTEL = 5606,
   CapabilityVectorComputeINTEL = 5617,
   CapabilityVectorAnyINTEL = 5619,
-  CapabilityOptimizationHintsINTEL = 5629,
   CapabilitySubgroupAvcMotionEstimationINTEL = 5696,
   CapabilitySubgroupAvcMotionEstimationIntraINTEL = 5697,
   CapabilitySubgroupAvcMotionEstimationChromaINTEL = 5698,
@@ -1405,8 +1404,6 @@ enum Op {
   OpAsmTargetINTEL = 5609,
   OpAsmINTEL = 5610,
   OpAsmCallINTEL = 5611,
-  OpAssumeTrueINTEL = 5630,
-  OpExpectINTEL = 5631,
   OpDecorateString = 5632,
   OpDecorateStringGOOGLE = 5632,
   OpMemberDecorateString = 5633,

llvm-spirv/lib/SPIRV/libSPIRV/spirv_internal.hpp

@@ -35,14 +35,25 @@ enum InternalLinkageType {
 };
 
 enum InternalOp {
+  IOpAssumeTrueINTEL = 5630,
+  IOpExpectINTEL = 5631,
   IOpPrev = OpMax - 2,
   IOpForward
 };
 
+enum InternalCapability {
+  ICapOptimizationHintsINTEL = 5629
+};
+
 constexpr LinkageType LinkageTypeInternal =
     static_cast<LinkageType>(ILTInternal);
 
 constexpr Op OpForward = static_cast<Op>(IOpForward);
+constexpr Op OpAssumeTrueINTEL = static_cast<Op>(IOpAssumeTrueINTEL);
+constexpr Op OpExpectINTEL = static_cast<Op>(IOpExpectINTEL);
+
+constexpr Capability CapabilityOptimizationHintsINTEL =
+    static_cast<Capability>(ICapOptimizationHintsINTEL);
 
 } // namespace internal
 } // namespace spv