mirror of
https://github.com/KhronosGroup/SPIRV-Tools
synced 2025-01-03 21:51:05 +00:00
9c0830133b
Adds a new (and first) kind of fact to the fact manager, which is that a specific uniform value is guaranteed to be equal to a specific constant. The point of this is that such information (if known to be true by some external source) can be used by spirv-fuzz to transform the module in interesting ways that a static compiler cannot reverse via compile-time analysis. This change introduces protobuf messages for the fact, and adds capabilities to the fact manager to store this kind of fact and provide information about it.
309 lines
12 KiB
C++
309 lines
12 KiB
C++
// Copyright (c) 2019 Google LLC
|
|
//
|
|
// 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 "source/fuzz/fact_manager.h"
|
|
|
|
#include "source/fuzz/uniform_buffer_element_descriptor.h"
|
|
#include "source/opt/ir_context.h"
|
|
|
|
namespace spvtools {
|
|
namespace fuzz {
|
|
|
|
// The purpose of this struct is to group the fields and data used to represent
|
|
// facts about uniform constants.
|
|
struct FactManager::ConstantUniformFacts {
|
|
// See method in FactManager which delegates to this method.
|
|
bool AddFact(const protobufs::FactConstantUniform& fact,
|
|
opt::IRContext* context);
|
|
|
|
// See method in FactManager which delegates to this method.
|
|
std::vector<uint32_t> GetConstantsAvailableFromUniformsForType(
|
|
opt::IRContext* ir_context, uint32_t type_id) const;
|
|
|
|
// See method in FactManager which delegates to this method.
|
|
const std::vector<protobufs::UniformBufferElementDescriptor>
|
|
GetUniformDescriptorsForConstant(opt::IRContext* ir_context,
|
|
uint32_t constant_id) const;
|
|
|
|
// See method in FactManager which delegates to this method.
|
|
uint32_t GetConstantFromUniformDescriptor(
|
|
opt::IRContext* context,
|
|
const protobufs::UniformBufferElementDescriptor& uniform_descriptor)
|
|
const;
|
|
|
|
// See method in FactManager which delegates to this method.
|
|
std::vector<uint32_t> GetTypesForWhichUniformValuesAreKnown() const;
|
|
|
|
// Returns true if and only if the words associated with
|
|
// |constant_instruction| exactly match the words for the constant associated
|
|
// with |constant_uniform_fact|.
|
|
bool DataMatches(
|
|
const opt::Instruction& constant_instruction,
|
|
const protobufs::FactConstantUniform& constant_uniform_fact) const;
|
|
|
|
// Yields the constant words associated with |constant_uniform_fact|.
|
|
std::vector<uint32_t> GetConstantWords(
|
|
const protobufs::FactConstantUniform& constant_uniform_fact) const;
|
|
|
|
// Yields the id of a constant of type |type_id| whose data matches the
|
|
// constant data in |constant_uniform_fact|, or 0 if no such constant is
|
|
// declared.
|
|
uint32_t GetConstantId(
|
|
opt::IRContext* context,
|
|
const protobufs::FactConstantUniform& constant_uniform_fact,
|
|
uint32_t type_id) const;
|
|
|
|
std::vector<std::pair<protobufs::FactConstantUniform, uint32_t>>
|
|
facts_and_type_ids;
|
|
};
|
|
|
|
uint32_t FactManager::ConstantUniformFacts::GetConstantId(
|
|
opt::IRContext* context,
|
|
const protobufs::FactConstantUniform& constant_uniform_fact,
|
|
uint32_t type_id) const {
|
|
auto type = context->get_type_mgr()->GetType(type_id);
|
|
assert(type != nullptr && "Unknown type id.");
|
|
auto constant = context->get_constant_mgr()->GetConstant(
|
|
type, GetConstantWords(constant_uniform_fact));
|
|
return context->get_constant_mgr()->FindDeclaredConstant(constant, type_id);
|
|
}
|
|
|
|
std::vector<uint32_t> FactManager::ConstantUniformFacts::GetConstantWords(
|
|
const protobufs::FactConstantUniform& constant_uniform_fact) const {
|
|
std::vector<uint32_t> result;
|
|
for (auto constant_word : constant_uniform_fact.constant_word()) {
|
|
result.push_back(constant_word);
|
|
}
|
|
return result;
|
|
}
|
|
|
|
bool FactManager::ConstantUniformFacts::DataMatches(
|
|
const opt::Instruction& constant_instruction,
|
|
const protobufs::FactConstantUniform& constant_uniform_fact) const {
|
|
assert(constant_instruction.opcode() == SpvOpConstant);
|
|
std::vector<uint32_t> data_in_constant;
|
|
for (uint32_t i = 0; i < constant_instruction.NumInOperands(); i++) {
|
|
data_in_constant.push_back(constant_instruction.GetSingleWordInOperand(i));
|
|
}
|
|
return data_in_constant == GetConstantWords(constant_uniform_fact);
|
|
}
|
|
|
|
std::vector<uint32_t>
|
|
FactManager::ConstantUniformFacts::GetConstantsAvailableFromUniformsForType(
|
|
opt::IRContext* ir_context, uint32_t type_id) const {
|
|
std::vector<uint32_t> result;
|
|
std::set<uint32_t> already_seen;
|
|
for (auto& fact_and_type_id : facts_and_type_ids) {
|
|
if (fact_and_type_id.second != type_id) {
|
|
continue;
|
|
}
|
|
if (auto constant_id =
|
|
GetConstantId(ir_context, fact_and_type_id.first, type_id)) {
|
|
if (already_seen.find(constant_id) == already_seen.end()) {
|
|
result.push_back(constant_id);
|
|
already_seen.insert(constant_id);
|
|
}
|
|
}
|
|
}
|
|
return result;
|
|
}
|
|
|
|
const std::vector<protobufs::UniformBufferElementDescriptor>
|
|
FactManager::ConstantUniformFacts::GetUniformDescriptorsForConstant(
|
|
opt::IRContext* ir_context, uint32_t constant_id) const {
|
|
std::vector<protobufs::UniformBufferElementDescriptor> result;
|
|
auto constant_inst = ir_context->get_def_use_mgr()->GetDef(constant_id);
|
|
assert(constant_inst->opcode() == SpvOpConstant &&
|
|
"The given id must be that of a constant");
|
|
auto type_id = constant_inst->type_id();
|
|
for (auto& fact_and_type_id : facts_and_type_ids) {
|
|
if (fact_and_type_id.second != type_id) {
|
|
continue;
|
|
}
|
|
if (DataMatches(*constant_inst, fact_and_type_id.first)) {
|
|
result.emplace_back(
|
|
fact_and_type_id.first.uniform_buffer_element_descriptor());
|
|
}
|
|
}
|
|
return result;
|
|
}
|
|
|
|
uint32_t FactManager::ConstantUniformFacts::GetConstantFromUniformDescriptor(
|
|
opt::IRContext* context,
|
|
const protobufs::UniformBufferElementDescriptor& uniform_descriptor) const {
|
|
// Consider each fact.
|
|
for (auto& fact_and_type : facts_and_type_ids) {
|
|
// Check whether the uniform descriptor associated with the fact matches
|
|
// |uniform_descriptor|.
|
|
if (UniformBufferElementDescriptorEquals()(
|
|
&uniform_descriptor,
|
|
&fact_and_type.first.uniform_buffer_element_descriptor())) {
|
|
return GetConstantId(context, fact_and_type.first, fact_and_type.second);
|
|
}
|
|
}
|
|
// No fact associated with the given uniform descriptor was found.
|
|
return 0;
|
|
}
|
|
|
|
std::vector<uint32_t>
|
|
FactManager::ConstantUniformFacts::GetTypesForWhichUniformValuesAreKnown()
|
|
const {
|
|
std::vector<uint32_t> result;
|
|
for (auto& fact_and_type : facts_and_type_ids) {
|
|
if (std::find(result.begin(), result.end(), fact_and_type.second) ==
|
|
result.end()) {
|
|
result.push_back(fact_and_type.second);
|
|
}
|
|
}
|
|
return result;
|
|
}
|
|
|
|
bool FactManager::ConstantUniformFacts::AddFact(
|
|
const protobufs::FactConstantUniform& fact, opt::IRContext* context) {
|
|
auto should_be_uniform_variable = context->get_def_use_mgr()->GetDef(
|
|
fact.uniform_buffer_element_descriptor().uniform_variable_id());
|
|
if (!should_be_uniform_variable) {
|
|
return false;
|
|
}
|
|
if (SpvOpVariable != should_be_uniform_variable->opcode()) {
|
|
return false;
|
|
}
|
|
if (SpvStorageClassUniform !=
|
|
should_be_uniform_variable->GetSingleWordInOperand(0)) {
|
|
return false;
|
|
}
|
|
auto should_be_uniform_pointer_type =
|
|
context->get_type_mgr()->GetType(should_be_uniform_variable->type_id());
|
|
if (!should_be_uniform_pointer_type->AsPointer()) {
|
|
return false;
|
|
}
|
|
if (should_be_uniform_pointer_type->AsPointer()->storage_class() !=
|
|
SpvStorageClassUniform) {
|
|
return false;
|
|
}
|
|
auto should_be_uniform_pointer_instruction =
|
|
context->get_def_use_mgr()->GetDef(should_be_uniform_variable->type_id());
|
|
auto element_type =
|
|
should_be_uniform_pointer_instruction->GetSingleWordInOperand(1);
|
|
|
|
for (auto index : fact.uniform_buffer_element_descriptor().index()) {
|
|
auto should_be_composite_type =
|
|
context->get_def_use_mgr()->GetDef(element_type);
|
|
if (SpvOpTypeStruct == should_be_composite_type->opcode()) {
|
|
if (index >= should_be_composite_type->NumInOperands()) {
|
|
return false;
|
|
}
|
|
element_type = should_be_composite_type->GetSingleWordInOperand(index);
|
|
} else if (SpvOpTypeArray == should_be_composite_type->opcode()) {
|
|
auto array_length_constant =
|
|
context->get_constant_mgr()
|
|
->GetConstantFromInst(context->get_def_use_mgr()->GetDef(
|
|
should_be_composite_type->GetSingleWordInOperand(1)))
|
|
->AsIntConstant();
|
|
if (array_length_constant->words().size() != 1) {
|
|
return false;
|
|
}
|
|
auto array_length = array_length_constant->GetU32();
|
|
if (index >= array_length) {
|
|
return false;
|
|
}
|
|
element_type = should_be_composite_type->GetSingleWordInOperand(0);
|
|
} else if (SpvOpTypeVector == should_be_composite_type->opcode()) {
|
|
auto vector_length = should_be_composite_type->GetSingleWordInOperand(1);
|
|
if (index >= vector_length) {
|
|
return false;
|
|
}
|
|
element_type = should_be_composite_type->GetSingleWordInOperand(0);
|
|
} else {
|
|
return false;
|
|
}
|
|
}
|
|
auto final_element_type = context->get_type_mgr()->GetType(element_type);
|
|
if (!(final_element_type->AsFloat() || final_element_type->AsInteger())) {
|
|
return false;
|
|
}
|
|
auto width = final_element_type->AsFloat()
|
|
? final_element_type->AsFloat()->width()
|
|
: final_element_type->AsInteger()->width();
|
|
auto required_words = (width + 32 - 1) / 32;
|
|
if (static_cast<uint32_t>(fact.constant_word().size()) != required_words) {
|
|
return false;
|
|
}
|
|
facts_and_type_ids.emplace_back(
|
|
std::pair<protobufs::FactConstantUniform, uint32_t>(fact, element_type));
|
|
return true;
|
|
}
|
|
|
|
FactManager::FactManager() {
|
|
uniform_constant_facts_ = MakeUnique<ConstantUniformFacts>();
|
|
}
|
|
|
|
FactManager::~FactManager() = default;
|
|
|
|
bool FactManager::AddFacts(const protobufs::FactSequence& initial_facts,
|
|
opt::IRContext* context) {
|
|
for (auto& fact : initial_facts.fact()) {
|
|
if (!AddFact(fact, context)) {
|
|
// TODO(https://github.com/KhronosGroup/SPIRV-Tools/issues/2621) Provide
|
|
// information about the fact that could not be added.
|
|
return false;
|
|
}
|
|
}
|
|
return true;
|
|
}
|
|
|
|
bool FactManager::AddFact(const spvtools::fuzz::protobufs::Fact& fact,
|
|
spvtools::opt::IRContext* context) {
|
|
assert(fact.fact_case() == protobufs::Fact::kConstantUniformFact &&
|
|
"Right now this is the only fact.");
|
|
if (!uniform_constant_facts_->AddFact(fact.constant_uniform_fact(),
|
|
context)) {
|
|
return false;
|
|
}
|
|
return true;
|
|
}
|
|
|
|
std::vector<uint32_t> FactManager::GetConstantsAvailableFromUniformsForType(
|
|
opt::IRContext* ir_context, uint32_t type_id) const {
|
|
return uniform_constant_facts_->GetConstantsAvailableFromUniformsForType(
|
|
ir_context, type_id);
|
|
}
|
|
|
|
const std::vector<protobufs::UniformBufferElementDescriptor>
|
|
FactManager::GetUniformDescriptorsForConstant(opt::IRContext* ir_context,
|
|
uint32_t constant_id) const {
|
|
return uniform_constant_facts_->GetUniformDescriptorsForConstant(ir_context,
|
|
constant_id);
|
|
}
|
|
|
|
uint32_t FactManager::GetConstantFromUniformDescriptor(
|
|
opt::IRContext* context,
|
|
const protobufs::UniformBufferElementDescriptor& uniform_descriptor) const {
|
|
return uniform_constant_facts_->GetConstantFromUniformDescriptor(
|
|
context, uniform_descriptor);
|
|
}
|
|
|
|
std::vector<uint32_t> FactManager::GetTypesForWhichUniformValuesAreKnown()
|
|
const {
|
|
return uniform_constant_facts_->GetTypesForWhichUniformValuesAreKnown();
|
|
}
|
|
|
|
const std::vector<std::pair<protobufs::FactConstantUniform, uint32_t>>&
|
|
FactManager::GetConstantUniformFactsAndTypes() const {
|
|
return uniform_constant_facts_->facts_and_type_ids;
|
|
}
|
|
|
|
} // namespace fuzz
|
|
} // namespace spvtools
|