DirectXShaderCompiler/tools/clang/lib/SPIRV/InstBuilderManual.cpp

//===-- InstBuilder.cpp - SPIR-V instruction builder ------------*- C++ -*-===//
//
//                     The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//

#include "clang/SPIRV/InstBuilder.h"
#include "clang/SPIRV/String.h"

#include "llvm/llvm_assert/assert.h"

namespace clang {
namespace spirv {

std::vector<uint32_t> InstBuilder::take() {
  std::vector<uint32_t> result;

  if (TheStatus == Status::Success && Expectation.empty() && !TheInst.empty()) {
    TheInst.front() |= uint32_t(TheInst.size()) << 16;
    result.swap(TheInst);
  }

  return result;
}

InstBuilder &InstBuilder::unaryOp(spv::Op op, uint32_t result_type,
                                  uint32_t result_id, uint32_t operand) {
  if (!TheInst.empty()) {
    TheStatus = Status::NestedInst;
    return *this;
  }

  // TODO: check op range

  TheInst.reserve(4);
  TheInst.emplace_back(static_cast<uint32_t>(op));
  TheInst.emplace_back(result_type);
  TheInst.emplace_back(result_id);
  TheInst.emplace_back(operand);

  return *this;
}

InstBuilder &InstBuilder::binaryOp(spv::Op op, uint32_t result_type,
                                   uint32_t result_id, uint32_t lhs,
                                   uint32_t rhs) {
  if (!TheInst.empty()) {
    TheStatus = Status::NestedInst;
    return *this;
  }

  // TODO: check op range

  TheInst.reserve(5);
  TheInst.emplace_back(static_cast<uint32_t>(op));
  TheInst.emplace_back(result_type);
  TheInst.emplace_back(result_id);
  TheInst.emplace_back(lhs);
  TheInst.emplace_back(rhs);

  return *this;
}

InstBuilder &InstBuilder::specConstantBinaryOp(spv::Op op, uint32_t result_type,
                                               uint32_t result_id, uint32_t lhs,
                                               uint32_t rhs) {
  if (!TheInst.empty()) {
    TheStatus = Status::NestedInst;
    return *this;
  }

  // TODO: check op range

  TheInst.reserve(6);
  TheInst.emplace_back(static_cast<uint32_t>(spv::Op::OpSpecConstantOp));
  TheInst.emplace_back(result_type);
  TheInst.emplace_back(result_id);
  TheInst.emplace_back(static_cast<uint32_t>(op));
  TheInst.emplace_back(lhs);
  TheInst.emplace_back(rhs);
  return *this;
}

InstBuilder &InstBuilder::atomicOp(spv::Op op, uint32_t result_type,
                                   uint32_t result_id, uint32_t pointer,
                                   uint32_t scope, uint32_t semantics,
                                   uint32_t value) {
  if (!TheInst.empty()) {
    TheStatus = Status::NestedInst;
    return *this;
  }
  if (result_type == 0) {
    TheStatus = Status::ZeroResultType;
    return *this;
  }
  if (result_id == 0) {
    TheStatus = Status::ZeroResultId;
    return *this;
  }

  TheInst.reserve(7);
  TheInst.emplace_back(static_cast<uint32_t>(op));
  TheInst.emplace_back(result_type);
  TheInst.emplace_back(result_id);
  TheInst.emplace_back(pointer);
  TheInst.emplace_back(scope);
  TheInst.emplace_back(semantics);
  TheInst.emplace_back(value);

  return *this;
}

InstBuilder &InstBuilder::groupNonUniformOp(spv::Op op, uint32_t result_type,
                                            uint32_t result_id,
                                            uint32_t exec_scope) {
  if (!TheInst.empty()) {
    TheStatus = Status::NestedInst;
    return *this;
  }

  // TODO: check op range

  TheInst.reserve(4);
  TheInst.emplace_back(static_cast<uint32_t>(op));
  TheInst.emplace_back(result_type);
  TheInst.emplace_back(result_id);
  TheInst.emplace_back(exec_scope);

  return *this;
}

InstBuilder &InstBuilder::groupNonUniformUnaryOp(
    spv::Op op, uint32_t result_type, uint32_t result_id, uint32_t exec_scope,
    llvm::Optional<spv::GroupOperation> groupOp, uint32_t operand) {
  if (!TheInst.empty()) {
    TheStatus = Status::NestedInst;
    return *this;
  }

  // TODO: check op range

  TheInst.reserve(5);
  TheInst.emplace_back(static_cast<uint32_t>(op));
  TheInst.emplace_back(result_type);
  TheInst.emplace_back(result_id);
  TheInst.emplace_back(exec_scope);
  if (groupOp.hasValue())
    TheInst.emplace_back(static_cast<uint32_t>(groupOp.getValue()));
  TheInst.emplace_back(operand);

  return *this;
}

InstBuilder &
InstBuilder::groupNonUniformBinaryOp(spv::Op op, uint32_t result_type,
                                     uint32_t result_id, uint32_t exec_scope,
                                     uint32_t operand1, uint32_t operand2) {
  if (!TheInst.empty()) {
    TheStatus = Status::NestedInst;
    return *this;
  }

  // TODO: check op range

  TheInst.reserve(6);
  TheInst.emplace_back(static_cast<uint32_t>(op));
  TheInst.emplace_back(result_type);
  TheInst.emplace_back(result_id);
  TheInst.emplace_back(exec_scope);
  TheInst.emplace_back(operand1);
  TheInst.emplace_back(operand2);

  return *this;
}

InstBuilder &InstBuilder::opConstant(uint32_t resultType, uint32_t resultId,
                                     uint32_t value) {
  if (!TheInst.empty()) {
    TheStatus = Status::NestedInst;
    return *this;
  }

  TheInst.reserve(4);
  TheInst.emplace_back(static_cast<uint32_t>(spv::Op::OpConstant));
  TheInst.emplace_back(resultType);
  TheInst.emplace_back(resultId);
  TheInst.emplace_back(value);

  return *this;
}

InstBuilder &InstBuilder::opImageSample(
    uint32_t result_type, uint32_t result_id, uint32_t sampled_image,
    uint32_t coordinate, uint32_t dref,
    llvm::Optional<spv::ImageOperandsMask> image_operands, bool is_explicit,
    bool is_sparse) {
  spv::Op op = spv::Op::Max;
  if (dref) {
    op = is_explicit ? (is_sparse ? spv::Op::OpImageSparseSampleDrefExplicitLod
                                  : spv::Op::OpImageSampleDrefExplicitLod)
                     : (is_sparse ? spv::Op::OpImageSparseSampleDrefImplicitLod
                                  : spv::Op::OpImageSampleDrefImplicitLod);
  } else {
    op = is_explicit ? (is_sparse ? spv::Op::OpImageSparseSampleExplicitLod
                                  : spv::Op::OpImageSampleExplicitLod)
                     : (is_sparse ? spv::Op::OpImageSparseSampleImplicitLod
                                  : spv::Op::OpImageSampleImplicitLod);
  }

  TheInst.emplace_back(static_cast<uint32_t>(op));
  TheInst.emplace_back(result_type);
  TheInst.emplace_back(result_id);
  TheInst.emplace_back(sampled_image);
  TheInst.emplace_back(coordinate);
  if (dref)
    TheInst.emplace_back(dref);
  if (image_operands.hasValue() &&
      image_operands.getValue() != spv::ImageOperandsMask::MaskNone) {
    const auto &val = image_operands.getValue();
    encodeImageOperands(val);
  }
  return *this;
}

InstBuilder &InstBuilder::opImageFetchRead(
    uint32_t result_type, uint32_t result_id, uint32_t image,
    uint32_t coordinate, llvm::Optional<spv::ImageOperandsMask> image_operands,
    bool is_fetch, bool is_sparse) {
  spv::Op op =
      is_fetch
          ? (is_sparse ? spv::Op::OpImageSparseFetch : spv::Op::OpImageFetch)
          : (is_sparse ? spv::Op::OpImageSparseRead : spv::Op::OpImageRead);

  TheInst.emplace_back(static_cast<uint32_t>(op));
  TheInst.emplace_back(result_type);
  TheInst.emplace_back(result_id);
  TheInst.emplace_back(image);
  TheInst.emplace_back(coordinate);
  if (image_operands.hasValue()) {
    const auto &val = image_operands.getValue();
    encodeImageOperands(val);
  }

  return *this;
}

InstBuilder &InstBuilder::opSpecConstant(uint32_t resultType, uint32_t resultId,
                                         uint32_t value) {
  if (!TheInst.empty()) {
    TheStatus = Status::NestedInst;
    return *this;
  }

  TheInst.reserve(4);
  TheInst.emplace_back(static_cast<uint32_t>(spv::Op::OpSpecConstant));
  TheInst.emplace_back(resultType);
  TheInst.emplace_back(resultId);
  TheInst.emplace_back(value);

  return *this;
}

void InstBuilder::encodeString(llvm::StringRef value) {
  const auto &words = string::encodeSPIRVString(value);
  TheInst.insert(TheInst.end(), words.begin(), words.end());
}

} // end namespace spirv
} // end namespace clang