SPIRVBasicBlock.cpp

//===- SPIRVBasicBlock.cpp - SPIR-V Basic Block -----------------*- C++ -*-===//
//
//                     The LLVM/SPIRV Translator
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
// Copyright (c) 2014 Advanced Micro Devices, Inc. All rights reserved.
//
// Permission is hereby granted, free of charge, to any person obtaining a
// copy of this software and associated documentation files (the "Software"),
// to deal with the Software without restriction, including without limitation
// the rights to use, copy, modify, merge, publish, distribute, sublicense,
// and/or sell copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following conditions:
//
// Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimers.
// Redistributions in binary form must reproduce the above copyright notice,
// this list of conditions and the following disclaimers in the documentation
// and/or other materials provided with the distribution.
// Neither the names of Advanced Micro Devices, Inc., nor the names of its
// contributors may be used to endorse or promote products derived from this
// Software without specific prior written permission.
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS WITH
// THE SOFTWARE.
//
//===----------------------------------------------------------------------===//
/// \file
///
/// This file implements SPIRV basic block.
///
//===----------------------------------------------------------------------===//

#include "SPIRVBasicBlock.h"
#include "SPIRVEntry.h"
#include "SPIRVFunction.h"
#include "SPIRVInstruction.h"
#include "SPIRVStream.h"
#include "SPIRVValue.h"

#include <iostream>

using namespace SPIRV;

SPIRVBasicBlock::SPIRVBasicBlock(SPIRVId TheId, SPIRVFunction *Func)
    : SPIRVValue(Func->getModule(), 2, OpLabel, TheId), ParentF(Func) {
  setAttr();
  validate();
}

SPIRVDecoder SPIRVBasicBlock::getDecoder(std::istream &IS) {
  return SPIRVDecoder(IS, *this);
}

/// Assume I contains valid Id.
SPIRVInstruction *
SPIRVBasicBlock::addInstruction(SPIRVInstruction *I,
                                const SPIRVInstruction *InsertBefore) {
  assert(I && "Invalid instruction");
  Module->add(I);
  I->setParent(this);
  if (InsertBefore) {
    auto Pos = find(InsertBefore);
    // If insertion of a new instruction before the one passed to the function
    // is illegal, insertion before the returned instruction is guaranteed
    // to retain correct instruction order in a block
    if (Pos != InstVec.begin() && (isa<OpLoopMerge>(*std::prev(Pos)) ||
                                   isa<OpLoopControlINTEL>(*std::prev(Pos))))
      --Pos;
    InstVec.insert(Pos, I);
  } else
    InstVec.push_back(I);
  return I;
}

void SPIRVBasicBlock::encodeChildren(spv_ostream &O) const {
  O << SPIRVNL();
  for (size_t I = 0, E = InstVec.size(); I != E; ++I)
    O << *InstVec[I];
}

_SPIRV_IMP_ENCDEC1(SPIRVBasicBlock, Id)

SPIRVInstruction *SPIRVBasicBlock::getVariableInsertionPoint() const {
  auto IP =
      std::find_if(InstVec.begin(), InstVec.end(), [](SPIRVInstruction *Inst) {
        if (isa<OpVariable>(Inst) || isa<OpLine>(Inst) || isa<OpNoLine>(Inst) ||
            // Note: OpVariable and OpPhi instructions do not belong to the
            // same block in a valid SPIR-V module.
            isa<OpPhi>(Inst) || isa<OpUntypedVariableKHR>(Inst)) {
          return false;
        }
        // There are debug instructions that could describe OpVariable - they
        // can be in the first block in the function as well.
        if (Inst->isExtInst()) {
          const SPIRVExtInst *EI = static_cast<const SPIRVExtInst *>(Inst);
          auto ExtSetKind = EI->getExtSetKind();
          auto ExtOp = EI->getExtOp();
          if ((ExtSetKind == SPIRVEIS_Debug ||
               ExtSetKind == SPIRVEIS_OpenCL_DebugInfo_100 ||
               ExtSetKind == SPIRVEIS_NonSemantic_Shader_DebugInfo_100 ||
               ExtSetKind == SPIRVEIS_NonSemantic_Shader_DebugInfo_200) &&
              (ExtOp == SPIRVDebug::Declare || ExtOp == SPIRVDebug::Value ||
               ExtOp == SPIRVDebug::Scope || ExtOp == SPIRVDebug::NoScope ||
               ExtOp == SPIRVDebug::DebugLine ||
               ExtOp == SPIRVDebug::DebugNoLine)) {
            return false;
          }
        }
        return true;
      });

  if (IP == InstVec.end())
    return nullptr;
  return *IP;
}

void SPIRVBasicBlock::setScope(SPIRVEntry *Scope) {
  assert(Scope && Scope->getOpCode() == OpFunction && "Invalid scope");
  setParent(static_cast<SPIRVFunction *>(Scope));
}