mirror of
https://github.com/KhronosGroup/SPIRV-Tools
synced 2024-11-24 04:20:13 +00:00
32381e30ef
In DecorationManager::RemoveDecorationsFrom, we do not remove the id from a decoration group if the group has no decorations. This causes problems because KillNamesAndDecorates is suppose to remove all references to the id, but in this case, there is still a reference. This is fixed by adding a special case. Also, there is the possibility of a double free because RemoveDecorationsFrom will delete the instructions defining |id| when |id| is a decoration group. Later, KillInst would later write to memory that has been deleted when trying to turn it into a Nop. To fix this, we will only remove the decorations that use |id| and not its definition in RemoveDecorationsFrom.
376 lines
12 KiB
C++
376 lines
12 KiB
C++
// Copyright (c) 2017 Google Inc.
|
|
//
|
|
// 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 <algorithm>
|
|
#include <memory>
|
|
#include <string>
|
|
#include <utility>
|
|
|
|
#include "gmock/gmock.h"
|
|
#include "gtest/gtest.h"
|
|
#include "source/opt/ir_context.h"
|
|
#include "source/opt/pass.h"
|
|
#include "test/opt/pass_fixture.h"
|
|
#include "test/opt/pass_utils.h"
|
|
|
|
namespace spvtools {
|
|
namespace opt {
|
|
namespace {
|
|
|
|
using Analysis = IRContext::Analysis;
|
|
using ::testing::Each;
|
|
|
|
class DummyPassPreservesNothing : public Pass {
|
|
public:
|
|
DummyPassPreservesNothing(Status s) : Pass(), status_to_return_(s) {}
|
|
|
|
const char* name() const override { return "dummy-pass"; }
|
|
Status Process() override { return status_to_return_; }
|
|
|
|
private:
|
|
Status status_to_return_;
|
|
};
|
|
|
|
class DummyPassPreservesAll : public Pass {
|
|
public:
|
|
DummyPassPreservesAll(Status s) : Pass(), status_to_return_(s) {}
|
|
|
|
const char* name() const override { return "dummy-pass"; }
|
|
Status Process() override { return status_to_return_; }
|
|
|
|
Analysis GetPreservedAnalyses() override {
|
|
return Analysis(IRContext::kAnalysisEnd - 1);
|
|
}
|
|
|
|
private:
|
|
Status status_to_return_;
|
|
};
|
|
|
|
class DummyPassPreservesFirst : public Pass {
|
|
public:
|
|
DummyPassPreservesFirst(Status s) : Pass(), status_to_return_(s) {}
|
|
|
|
const char* name() const override { return "dummy-pass"; }
|
|
Status Process() override { return status_to_return_; }
|
|
|
|
Analysis GetPreservedAnalyses() override { return IRContext::kAnalysisBegin; }
|
|
|
|
private:
|
|
Status status_to_return_;
|
|
};
|
|
|
|
using IRContextTest = PassTest<::testing::Test>;
|
|
|
|
TEST_F(IRContextTest, IndividualValidAfterBuild) {
|
|
std::unique_ptr<Module> module(new Module());
|
|
IRContext localContext(SPV_ENV_UNIVERSAL_1_2, std::move(module),
|
|
spvtools::MessageConsumer());
|
|
|
|
for (Analysis i = IRContext::kAnalysisBegin; i < IRContext::kAnalysisEnd;
|
|
i <<= 1) {
|
|
localContext.BuildInvalidAnalyses(i);
|
|
EXPECT_TRUE(localContext.AreAnalysesValid(i));
|
|
}
|
|
}
|
|
|
|
TEST_F(IRContextTest, AllValidAfterBuild) {
|
|
std::unique_ptr<Module> module = MakeUnique<Module>();
|
|
IRContext localContext(SPV_ENV_UNIVERSAL_1_2, std::move(module),
|
|
spvtools::MessageConsumer());
|
|
|
|
Analysis built_analyses = IRContext::kAnalysisNone;
|
|
for (Analysis i = IRContext::kAnalysisBegin; i < IRContext::kAnalysisEnd;
|
|
i <<= 1) {
|
|
localContext.BuildInvalidAnalyses(i);
|
|
built_analyses |= i;
|
|
}
|
|
EXPECT_TRUE(localContext.AreAnalysesValid(built_analyses));
|
|
}
|
|
|
|
TEST_F(IRContextTest, AllValidAfterPassNoChange) {
|
|
std::unique_ptr<Module> module = MakeUnique<Module>();
|
|
IRContext localContext(SPV_ENV_UNIVERSAL_1_2, std::move(module),
|
|
spvtools::MessageConsumer());
|
|
|
|
Analysis built_analyses = IRContext::kAnalysisNone;
|
|
for (Analysis i = IRContext::kAnalysisBegin; i < IRContext::kAnalysisEnd;
|
|
i <<= 1) {
|
|
localContext.BuildInvalidAnalyses(i);
|
|
built_analyses |= i;
|
|
}
|
|
|
|
DummyPassPreservesNothing pass(Pass::Status::SuccessWithoutChange);
|
|
Pass::Status s = pass.Run(&localContext);
|
|
EXPECT_EQ(s, Pass::Status::SuccessWithoutChange);
|
|
EXPECT_TRUE(localContext.AreAnalysesValid(built_analyses));
|
|
}
|
|
|
|
TEST_F(IRContextTest, NoneValidAfterPassWithChange) {
|
|
std::unique_ptr<Module> module = MakeUnique<Module>();
|
|
IRContext localContext(SPV_ENV_UNIVERSAL_1_2, std::move(module),
|
|
spvtools::MessageConsumer());
|
|
|
|
for (Analysis i = IRContext::kAnalysisBegin; i < IRContext::kAnalysisEnd;
|
|
i <<= 1) {
|
|
localContext.BuildInvalidAnalyses(i);
|
|
}
|
|
|
|
DummyPassPreservesNothing pass(Pass::Status::SuccessWithChange);
|
|
Pass::Status s = pass.Run(&localContext);
|
|
EXPECT_EQ(s, Pass::Status::SuccessWithChange);
|
|
for (Analysis i = IRContext::kAnalysisBegin; i < IRContext::kAnalysisEnd;
|
|
i <<= 1) {
|
|
EXPECT_FALSE(localContext.AreAnalysesValid(i));
|
|
}
|
|
}
|
|
|
|
TEST_F(IRContextTest, AllPreservedAfterPassWithChange) {
|
|
std::unique_ptr<Module> module = MakeUnique<Module>();
|
|
IRContext localContext(SPV_ENV_UNIVERSAL_1_2, std::move(module),
|
|
spvtools::MessageConsumer());
|
|
|
|
for (Analysis i = IRContext::kAnalysisBegin; i < IRContext::kAnalysisEnd;
|
|
i <<= 1) {
|
|
localContext.BuildInvalidAnalyses(i);
|
|
}
|
|
|
|
DummyPassPreservesAll pass(Pass::Status::SuccessWithChange);
|
|
Pass::Status s = pass.Run(&localContext);
|
|
EXPECT_EQ(s, Pass::Status::SuccessWithChange);
|
|
for (Analysis i = IRContext::kAnalysisBegin; i < IRContext::kAnalysisEnd;
|
|
i <<= 1) {
|
|
EXPECT_TRUE(localContext.AreAnalysesValid(i));
|
|
}
|
|
}
|
|
|
|
TEST_F(IRContextTest, PreserveFirstOnlyAfterPassWithChange) {
|
|
std::unique_ptr<Module> module = MakeUnique<Module>();
|
|
IRContext localContext(SPV_ENV_UNIVERSAL_1_2, std::move(module),
|
|
spvtools::MessageConsumer());
|
|
|
|
for (Analysis i = IRContext::kAnalysisBegin; i < IRContext::kAnalysisEnd;
|
|
i <<= 1) {
|
|
localContext.BuildInvalidAnalyses(i);
|
|
}
|
|
|
|
DummyPassPreservesFirst pass(Pass::Status::SuccessWithChange);
|
|
Pass::Status s = pass.Run(&localContext);
|
|
EXPECT_EQ(s, Pass::Status::SuccessWithChange);
|
|
EXPECT_TRUE(localContext.AreAnalysesValid(IRContext::kAnalysisBegin));
|
|
for (Analysis i = IRContext::kAnalysisBegin << 1; i < IRContext::kAnalysisEnd;
|
|
i <<= 1) {
|
|
EXPECT_FALSE(localContext.AreAnalysesValid(i));
|
|
}
|
|
}
|
|
|
|
TEST_F(IRContextTest, KillMemberName) {
|
|
const std::string text = R"(
|
|
OpCapability Shader
|
|
%1 = OpExtInstImport "GLSL.std.450"
|
|
OpMemoryModel Logical GLSL450
|
|
OpEntryPoint Fragment %2 "main"
|
|
OpExecutionMode %2 OriginUpperLeft
|
|
OpSource GLSL 430
|
|
OpName %3 "stuff"
|
|
OpMemberName %3 0 "refZ"
|
|
OpMemberDecorate %3 0 Offset 0
|
|
OpDecorate %3 Block
|
|
%4 = OpTypeFloat 32
|
|
%3 = OpTypeStruct %4
|
|
%5 = OpTypeVoid
|
|
%6 = OpTypeFunction %5
|
|
%2 = OpFunction %5 None %6
|
|
%7 = OpLabel
|
|
OpReturn
|
|
OpFunctionEnd
|
|
)";
|
|
|
|
std::unique_ptr<IRContext> context =
|
|
BuildModule(SPV_ENV_UNIVERSAL_1_2, nullptr, text);
|
|
|
|
// Build the decoration manager.
|
|
context->get_decoration_mgr();
|
|
|
|
// Delete the OpTypeStruct. Should delete the OpName, OpMemberName, and
|
|
// OpMemberDecorate associated with it.
|
|
context->KillDef(3);
|
|
|
|
// Make sure all of the name are removed.
|
|
for (auto& inst : context->debugs2()) {
|
|
EXPECT_EQ(inst.opcode(), SpvOpNop);
|
|
}
|
|
|
|
// Make sure all of the decorations are removed.
|
|
for (auto& inst : context->annotations()) {
|
|
EXPECT_EQ(inst.opcode(), SpvOpNop);
|
|
}
|
|
}
|
|
|
|
TEST_F(IRContextTest, KillGroupDecoration) {
|
|
const std::string text = R"(
|
|
OpCapability Shader
|
|
%1 = OpExtInstImport "GLSL.std.450"
|
|
OpMemoryModel Logical GLSL450
|
|
OpEntryPoint Fragment %2 "main"
|
|
OpExecutionMode %2 OriginUpperLeft
|
|
OpSource GLSL 430
|
|
OpDecorate %3 Restrict
|
|
%3 = OpDecorationGroup
|
|
OpGroupDecorate %3 %4 %5
|
|
%6 = OpTypeFloat 32
|
|
%7 = OpTypePointer Function %6
|
|
%8 = OpTypeStruct %6
|
|
%9 = OpTypeVoid
|
|
%10 = OpTypeFunction %9
|
|
%2 = OpFunction %9 None %10
|
|
%11 = OpLabel
|
|
%4 = OpVariable %7 Function
|
|
%5 = OpVariable %7 Function
|
|
OpReturn
|
|
OpFunctionEnd
|
|
)";
|
|
|
|
std::unique_ptr<IRContext> context =
|
|
BuildModule(SPV_ENV_UNIVERSAL_1_2, nullptr, text);
|
|
|
|
// Build the decoration manager.
|
|
context->get_decoration_mgr();
|
|
|
|
// Delete the second variable.
|
|
context->KillDef(5);
|
|
|
|
// The three decorations instructions should still be there. The first two
|
|
// should be the same, but the third should have %5 removed.
|
|
|
|
// Check the OpDecorate instruction
|
|
auto inst = context->annotation_begin();
|
|
EXPECT_EQ(inst->opcode(), SpvOpDecorate);
|
|
EXPECT_EQ(inst->GetSingleWordInOperand(0), 3);
|
|
|
|
// Check the OpDecorationGroup Instruction
|
|
++inst;
|
|
EXPECT_EQ(inst->opcode(), SpvOpDecorationGroup);
|
|
EXPECT_EQ(inst->result_id(), 3);
|
|
|
|
// Check that %5 is no longer part of the group.
|
|
++inst;
|
|
EXPECT_EQ(inst->opcode(), SpvOpGroupDecorate);
|
|
EXPECT_EQ(inst->NumInOperands(), 2);
|
|
EXPECT_EQ(inst->GetSingleWordInOperand(0), 3);
|
|
EXPECT_EQ(inst->GetSingleWordInOperand(1), 4);
|
|
|
|
// Check that we are at the end.
|
|
++inst;
|
|
EXPECT_EQ(inst, context->annotation_end());
|
|
}
|
|
|
|
TEST_F(IRContextTest, TakeNextUniqueIdIncrementing) {
|
|
const uint32_t NUM_TESTS = 1000;
|
|
IRContext localContext(SPV_ENV_UNIVERSAL_1_2, nullptr);
|
|
for (uint32_t i = 1; i < NUM_TESTS; ++i)
|
|
EXPECT_EQ(i, localContext.TakeNextUniqueId());
|
|
}
|
|
|
|
TEST_F(IRContextTest, KillGroupDecorationWitNoDecorations) {
|
|
const std::string text = R"(
|
|
OpCapability Shader
|
|
%1 = OpExtInstImport "GLSL.std.450"
|
|
OpMemoryModel Logical GLSL450
|
|
OpEntryPoint Fragment %2 "main"
|
|
OpExecutionMode %2 OriginUpperLeft
|
|
OpSource GLSL 430
|
|
%3 = OpDecorationGroup
|
|
OpGroupDecorate %3 %4 %5
|
|
%6 = OpTypeFloat 32
|
|
%7 = OpTypePointer Function %6
|
|
%8 = OpTypeStruct %6
|
|
%9 = OpTypeVoid
|
|
%10 = OpTypeFunction %9
|
|
%2 = OpFunction %9 None %10
|
|
%11 = OpLabel
|
|
%4 = OpVariable %7 Function
|
|
%5 = OpVariable %7 Function
|
|
OpReturn
|
|
OpFunctionEnd
|
|
)";
|
|
|
|
std::unique_ptr<IRContext> context =
|
|
BuildModule(SPV_ENV_UNIVERSAL_1_2, nullptr, text);
|
|
|
|
// Build the decoration manager.
|
|
context->get_decoration_mgr();
|
|
|
|
// Delete the second variable.
|
|
context->KillDef(5);
|
|
|
|
// The two decoration instructions should still be there. The first one
|
|
// should be the same, but the second should have %5 removed.
|
|
|
|
// Check the OpDecorationGroup Instruction
|
|
auto inst = context->annotation_begin();
|
|
EXPECT_EQ(inst->opcode(), SpvOpDecorationGroup);
|
|
EXPECT_EQ(inst->result_id(), 3);
|
|
|
|
// Check that %5 is no longer part of the group.
|
|
++inst;
|
|
EXPECT_EQ(inst->opcode(), SpvOpGroupDecorate);
|
|
EXPECT_EQ(inst->NumInOperands(), 2);
|
|
EXPECT_EQ(inst->GetSingleWordInOperand(0), 3);
|
|
EXPECT_EQ(inst->GetSingleWordInOperand(1), 4);
|
|
|
|
// Check that we are at the end.
|
|
++inst;
|
|
EXPECT_EQ(inst, context->annotation_end());
|
|
}
|
|
|
|
TEST_F(IRContextTest, KillDecorationGroup) {
|
|
const std::string text = R"(
|
|
OpCapability Shader
|
|
%1 = OpExtInstImport "GLSL.std.450"
|
|
OpMemoryModel Logical GLSL450
|
|
OpEntryPoint Fragment %2 "main"
|
|
OpExecutionMode %2 OriginUpperLeft
|
|
OpSource GLSL 430
|
|
%3 = OpDecorationGroup
|
|
OpGroupDecorate %3 %4 %5
|
|
%6 = OpTypeFloat 32
|
|
%7 = OpTypePointer Function %6
|
|
%8 = OpTypeStruct %6
|
|
%9 = OpTypeVoid
|
|
%10 = OpTypeFunction %9
|
|
%2 = OpFunction %9 None %10
|
|
%11 = OpLabel
|
|
%4 = OpVariable %7 Function
|
|
%5 = OpVariable %7 Function
|
|
OpReturn
|
|
OpFunctionEnd
|
|
)";
|
|
|
|
std::unique_ptr<IRContext> context =
|
|
BuildModule(SPV_ENV_UNIVERSAL_1_2, nullptr, text);
|
|
|
|
// Build the decoration manager.
|
|
context->get_decoration_mgr();
|
|
|
|
// Delete the second variable.
|
|
context->KillDef(3);
|
|
|
|
// Check the OpDecorationGroup Instruction is still there.
|
|
EXPECT_TRUE(context->annotations().empty());
|
|
}
|
|
|
|
} // namespace
|
|
} // namespace opt
|
|
} // namespace spvtools
|