blob: 198655b02e5b9f03b11b4fb5a0b72ac962b2a44d [file] [log] [blame]
// Copyright (c) 2017 Pierre Moreau
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#include "remove_duplicates_pass.h"
#include <cstring>
#include <algorithm>
#include <limits>
#include <unordered_map>
#include <unordered_set>
#include <vector>
#include "decoration_manager.h"
#include "ir_context.h"
#include "opcode.h"
namespace spvtools {
namespace opt {
using ir::Instruction;
using ir::Module;
using ir::Operand;
using opt::analysis::DefUseManager;
using opt::analysis::DecorationManager;
Pass::Status RemoveDuplicatesPass::Process(ir::IRContext* irContext) {
bool modified = RemoveDuplicateCapabilities(irContext);
modified |= RemoveDuplicatesExtInstImports(irContext);
modified |= RemoveDuplicateTypes(irContext);
modified |= RemoveDuplicateDecorations(irContext);
return modified ? Status::SuccessWithChange : Status::SuccessWithoutChange;
}
bool RemoveDuplicatesPass::RemoveDuplicateCapabilities(
ir::IRContext* irContext) const {
bool modified = false;
std::unordered_set<uint32_t> capabilities;
for (auto i = irContext->capability_begin();
i != irContext->capability_end();) {
auto res = capabilities.insert(i->GetSingleWordOperand(0u));
if (res.second) {
// Never seen before, keep it.
++i;
} else {
// It's a duplicate, remove it.
i = i.Erase();
modified = true;
}
}
return modified;
}
bool RemoveDuplicatesPass::RemoveDuplicatesExtInstImports(
ir::IRContext* irContext) const {
bool modified = false;
std::unordered_map<std::string, SpvId> extInstImports;
for (auto i = irContext->ext_inst_import_begin();
i != irContext->ext_inst_import_end();) {
auto res = extInstImports.emplace(
reinterpret_cast<const char*>(i->GetInOperand(0u).words.data()),
i->result_id());
if (res.second) {
// Never seen before, keep it.
++i;
} else {
// It's a duplicate, remove it.
irContext->ReplaceAllUsesWith(i->result_id(), res.first->second);
i = i.Erase();
modified = true;
}
}
return modified;
}
bool RemoveDuplicatesPass::RemoveDuplicateTypes(ir::IRContext* irContext) const {
bool modified = false;
std::vector<Instruction> visitedTypes;
for (auto i = irContext->types_values_begin();
i != irContext->types_values_end();) {
// We only care about types.
if (!spvOpcodeGeneratesType((i->opcode())) &&
i->opcode() != SpvOpTypeForwardPointer) {
++i;
continue;
}
// Is the current type equal to one of the types we have aready visited?
SpvId idToKeep = 0u;
for (auto j : visitedTypes) {
if (AreTypesEqual(*i, j, *irContext->get_def_use_mgr(), *irContext->get_decoration_mgr())) {
idToKeep = j.result_id();
break;
}
}
if (idToKeep == 0u) {
// This is a never seen before type, keep it around.
visitedTypes.emplace_back(*i);
++i;
} else {
// The same type has already been seen before, remove this one.
irContext->ReplaceAllUsesWith(i->result_id(), idToKeep);
modified = true;
i = i.Erase();
}
}
return modified;
}
bool RemoveDuplicatesPass::RemoveDuplicateDecorations(
ir::IRContext* irContext) const {
bool modified = false;
std::unordered_map<SpvId, const Instruction*> constants;
for (const auto& i : irContext->types_values())
if (i.opcode() == SpvOpConstant) constants[i.result_id()] = &i;
for (const auto& i : irContext->types_values())
if (i.opcode() == SpvOpConstant) constants[i.result_id()] = &i;
std::vector<const Instruction*> visitedDecorations;
opt::analysis::DecorationManager decorationManager(irContext->module());
for (auto i = irContext->annotation_begin();
i != irContext->annotation_end();) {
// Is the current decoration equal to one of the decorations we have aready
// visited?
bool alreadyVisited = false;
for (const Instruction* j : visitedDecorations) {
if (decorationManager.AreDecorationsTheSame(&*i, j)) {
alreadyVisited = true;
break;
}
}
if (!alreadyVisited) {
// This is a never seen before decoration, keep it around.
visitedDecorations.emplace_back(&*i);
++i;
} else {
// The same decoration has already been seen before, remove this one.
modified = true;
i = i.Erase();
}
}
return modified;
}
bool RemoveDuplicatesPass::AreTypesEqual(const Instruction& inst1,
const Instruction& inst2,
const DefUseManager& defUseManager,
const DecorationManager& decManager) {
if (inst1.opcode() != inst2.opcode()) return false;
if (!decManager.HaveTheSameDecorations(inst1.result_id(), inst2.result_id()))
return false;
switch (inst1.opcode()) {
case SpvOpTypeVoid:
case SpvOpTypeBool:
case SpvOpTypeSampler:
case SpvOpTypeEvent:
case SpvOpTypeDeviceEvent:
case SpvOpTypeReserveId:
case SpvOpTypeQueue:
case SpvOpTypePipeStorage:
case SpvOpTypeNamedBarrier:
return true;
case SpvOpTypeInt:
return inst1.GetSingleWordInOperand(0u) ==
inst2.GetSingleWordInOperand(0u) &&
inst1.GetSingleWordInOperand(1u) ==
inst2.GetSingleWordInOperand(1u);
case SpvOpTypeFloat:
case SpvOpTypePipe:
case SpvOpTypeForwardPointer:
return inst1.GetSingleWordInOperand(0u) ==
inst2.GetSingleWordInOperand(0u);
case SpvOpTypeVector:
case SpvOpTypeMatrix:
return AreTypesEqual(
*defUseManager.GetDef(inst1.GetSingleWordInOperand(0u)),
*defUseManager.GetDef(inst2.GetSingleWordInOperand(0u)),
defUseManager, decManager) &&
inst1.GetSingleWordInOperand(1u) ==
inst2.GetSingleWordInOperand(1u);
case SpvOpTypeImage:
return AreTypesEqual(
*defUseManager.GetDef(inst1.GetSingleWordInOperand(0u)),
*defUseManager.GetDef(inst2.GetSingleWordInOperand(0u)),
defUseManager, decManager) &&
inst1.GetSingleWordInOperand(1u) ==
inst2.GetSingleWordInOperand(1u) &&
inst1.GetSingleWordInOperand(2u) ==
inst2.GetSingleWordInOperand(2u) &&
inst1.GetSingleWordInOperand(3u) ==
inst2.GetSingleWordInOperand(3u) &&
inst1.GetSingleWordInOperand(4u) ==
inst2.GetSingleWordInOperand(4u) &&
inst1.GetSingleWordInOperand(5u) ==
inst2.GetSingleWordInOperand(5u) &&
inst1.GetSingleWordInOperand(6u) ==
inst2.GetSingleWordInOperand(6u) &&
inst1.NumOperands() == inst2.NumOperands() &&
(inst1.NumInOperands() == 7u ||
inst1.GetSingleWordInOperand(7u) ==
inst2.GetSingleWordInOperand(7u));
case SpvOpTypeSampledImage:
case SpvOpTypeRuntimeArray:
return AreTypesEqual(
*defUseManager.GetDef(inst1.GetSingleWordInOperand(0u)),
*defUseManager.GetDef(inst2.GetSingleWordInOperand(0u)),
defUseManager, decManager);
case SpvOpTypeArray:
return AreTypesEqual(
*defUseManager.GetDef(inst1.GetSingleWordInOperand(0u)),
*defUseManager.GetDef(inst2.GetSingleWordInOperand(0u)),
defUseManager, decManager) &&
AreTypesEqual(
*defUseManager.GetDef(inst1.GetSingleWordInOperand(1u)),
*defUseManager.GetDef(inst2.GetSingleWordInOperand(1u)),
defUseManager, decManager);
case SpvOpTypeStruct:
case SpvOpTypeFunction: {
bool res = inst1.NumInOperands() == inst2.NumInOperands();
for (uint32_t i = 0u; i < inst1.NumInOperands() && res; ++i)
res &= AreTypesEqual(
*defUseManager.GetDef(inst1.GetSingleWordInOperand(i)),
*defUseManager.GetDef(inst2.GetSingleWordInOperand(i)),
defUseManager, decManager);
return res;
}
case SpvOpTypeOpaque:
return std::strcmp(reinterpret_cast<const char*>(
inst1.GetInOperand(0u).words.data()),
reinterpret_cast<const char*>(
inst2.GetInOperand(0u).words.data())) == 0;
case SpvOpTypePointer:
return inst1.GetSingleWordInOperand(0u) ==
inst2.GetSingleWordInOperand(0u) &&
AreTypesEqual(
*defUseManager.GetDef(inst1.GetSingleWordInOperand(1u)),
*defUseManager.GetDef(inst2.GetSingleWordInOperand(1u)),
defUseManager, decManager);
default:
return false;
}
}
} // namespace opt
} // namespace spvtools