blob: 06791db22734879f18913efbb94b8d85ad2c4055 [file] [log] [blame]
/// Copyright 2020 The Tint Authors.
//
// 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 "src/writer/hlsl/generator_impl.h"
#include <limits>
#include <sstream>
#include <utility>
#include <vector>
#include "src/ast/array_accessor_expression.h"
#include "src/ast/assignment_statement.h"
#include "src/ast/binary_expression.h"
#include "src/ast/bitcast_expression.h"
#include "src/ast/bool_literal.h"
#include "src/ast/call_expression.h"
#include "src/ast/call_statement.h"
#include "src/ast/case_statement.h"
#include "src/ast/constant_id_decoration.h"
#include "src/ast/else_statement.h"
#include "src/ast/fallthrough_statement.h"
#include "src/ast/float_literal.h"
#include "src/ast/identifier_expression.h"
#include "src/ast/if_statement.h"
#include "src/ast/loop_statement.h"
#include "src/ast/member_accessor_expression.h"
#include "src/ast/return_statement.h"
#include "src/ast/sint_literal.h"
#include "src/ast/struct.h"
#include "src/ast/switch_statement.h"
#include "src/ast/type/access_control_type.h"
#include "src/ast/type/alias_type.h"
#include "src/ast/type/array_type.h"
#include "src/ast/type/bool_type.h"
#include "src/ast/type/f32_type.h"
#include "src/ast/type/i32_type.h"
#include "src/ast/type/matrix_type.h"
#include "src/ast/type/pointer_type.h"
#include "src/ast/type/sampler_type.h"
#include "src/ast/type/storage_texture_type.h"
#include "src/ast/type/struct_type.h"
#include "src/ast/type/texture_type.h"
#include "src/ast/type/u32_type.h"
#include "src/ast/type/vector_type.h"
#include "src/ast/type/void_type.h"
#include "src/ast/uint_literal.h"
#include "src/ast/unary_op_expression.h"
#include "src/ast/variable.h"
#include "src/ast/variable_decl_statement.h"
#include "src/writer/append_vector.h"
#include "src/writer/float_to_string.h"
namespace tint {
namespace writer {
namespace hlsl {
namespace {
const char kInStructNameSuffix[] = "in";
const char kOutStructNameSuffix[] = "out";
const char kTintStructInVarPrefix[] = "tint_in";
const char kTintStructOutVarPrefix[] = "tint_out";
const char kTempNamePrefix[] = "_tint_tmp";
bool last_is_break_or_fallthrough(const ast::BlockStatement* stmts) {
if (stmts->empty()) {
return false;
}
return stmts->last()->Is<ast::BreakStatement>() ||
stmts->last()->Is<ast::FallthroughStatement>();
}
uint32_t convert_swizzle_to_index(const std::string& swizzle) {
if (swizzle == "r" || swizzle == "x") {
return 0;
}
if (swizzle == "g" || swizzle == "y") {
return 1;
}
if (swizzle == "b" || swizzle == "z") {
return 2;
}
if (swizzle == "a" || swizzle == "w") {
return 3;
}
return 0;
}
const char* image_format_to_rwtexture_type(
ast::type::ImageFormat image_format) {
switch (image_format) {
case ast::type::ImageFormat::kRgba8Unorm:
case ast::type::ImageFormat::kRgba8Snorm:
case ast::type::ImageFormat::kRgba16Float:
case ast::type::ImageFormat::kR32Float:
case ast::type::ImageFormat::kRg32Float:
case ast::type::ImageFormat::kRgba32Float:
return "float4";
case ast::type::ImageFormat::kRgba8Uint:
case ast::type::ImageFormat::kRgba16Uint:
case ast::type::ImageFormat::kR32Uint:
case ast::type::ImageFormat::kRg32Uint:
case ast::type::ImageFormat::kRgba32Uint:
return "uint4";
case ast::type::ImageFormat::kRgba8Sint:
case ast::type::ImageFormat::kRgba16Sint:
case ast::type::ImageFormat::kR32Sint:
case ast::type::ImageFormat::kRg32Sint:
case ast::type::ImageFormat::kRgba32Sint:
return "int4";
default:
return nullptr;
}
}
} // namespace
GeneratorImpl::GeneratorImpl(ast::Module* module) : module_(module) {}
GeneratorImpl::~GeneratorImpl() = default;
void GeneratorImpl::make_indent(std::ostream& out) {
for (size_t i = 0; i < indent_; i++) {
out << " ";
}
}
bool GeneratorImpl::Generate(std::ostream& out) {
for (auto* global : module_->global_variables()) {
register_global(global);
}
for (auto* const ty : module_->constructed_types()) {
if (!EmitConstructedType(out, ty)) {
return false;
}
}
if (!module_->constructed_types().empty()) {
out << std::endl;
}
for (auto* var : module_->global_variables()) {
if (!var->is_const()) {
continue;
}
if (!EmitProgramConstVariable(out, var)) {
return false;
}
}
std::unordered_set<Symbol> emitted_globals;
// Make sure all entry point data is emitted before the entry point functions
for (auto* func : module_->functions()) {
if (!func->IsEntryPoint()) {
continue;
}
if (!EmitEntryPointData(out, func, emitted_globals)) {
return false;
}
}
for (auto* func : module_->functions()) {
if (!EmitFunction(out, func)) {
return false;
}
}
for (auto* func : module_->functions()) {
if (!func->IsEntryPoint()) {
continue;
}
if (!EmitEntryPointFunction(out, func)) {
return false;
}
out << std::endl;
}
return true;
}
void GeneratorImpl::register_global(ast::Variable* global) {
global_variables_.set(global->symbol(), global);
}
std::string GeneratorImpl::generate_name(const std::string& prefix) {
std::string name = prefix;
uint32_t i = 0;
while (namer_.IsMapped(name) || namer_.IsRemapped(name)) {
name = prefix + "_" + std::to_string(i);
++i;
}
namer_.RegisterRemappedName(name);
return name;
}
std::string GeneratorImpl::current_ep_var_name(VarType type) {
std::string name = "";
switch (type) {
case VarType::kIn: {
auto in_it = ep_sym_to_in_data_.find(current_ep_sym_);
if (in_it != ep_sym_to_in_data_.end()) {
name = in_it->second.var_name;
}
break;
}
case VarType::kOut: {
auto outit = ep_sym_to_out_data_.find(current_ep_sym_);
if (outit != ep_sym_to_out_data_.end()) {
name = outit->second.var_name;
}
break;
}
}
return name;
}
bool GeneratorImpl::EmitConstructedType(std::ostream& out,
const ast::type::Type* ty) {
make_indent(out);
if (auto* alias = ty->As<ast::type::Alias>()) {
// HLSL typedef is for intrinsic types only. For an alias'd struct,
// generate a secondary struct with the new name.
if (auto* str = alias->type()->As<ast::type::Struct>()) {
if (!EmitStructType(out, str, module_->SymbolToName(alias->symbol()))) {
return false;
}
return true;
}
out << "typedef ";
if (!EmitType(out, alias->type(), "")) {
return false;
}
out << " " << namer_.NameFor(module_->SymbolToName(alias->symbol())) << ";"
<< std::endl;
} else if (auto* str = ty->As<ast::type::Struct>()) {
if (!EmitStructType(out, str, module_->SymbolToName(str->symbol()))) {
return false;
}
} else {
error_ = "unknown constructed type: " + ty->type_name();
return false;
}
return true;
}
bool GeneratorImpl::EmitArrayAccessor(std::ostream& pre,
std::ostream& out,
ast::ArrayAccessorExpression* expr) {
// Handle writing into a storage buffer array
if (is_storage_buffer_access(expr)) {
return EmitStorageBufferAccessor(pre, out, expr, nullptr);
}
if (!EmitExpression(pre, out, expr->array())) {
return false;
}
out << "[";
if (!EmitExpression(pre, out, expr->idx_expr())) {
return false;
}
out << "]";
return true;
}
bool GeneratorImpl::EmitBitcast(std::ostream& pre,
std::ostream& out,
ast::BitcastExpression* expr) {
if (!expr->type()->is_integer_scalar() && !expr->type()->is_float_scalar()) {
error_ = "Unable to do bitcast to type " + expr->type()->type_name();
return false;
}
out << "as";
if (!EmitType(out, expr->type(), "")) {
return false;
}
out << "(";
if (!EmitExpression(pre, out, expr->expr())) {
return false;
}
out << ")";
return true;
}
bool GeneratorImpl::EmitAssign(std::ostream& out,
ast::AssignmentStatement* stmt) {
make_indent(out);
std::ostringstream pre;
// If the LHS is an accessor into a storage buffer then we have to
// emit a Store operation instead of an ='s.
if (auto* mem = stmt->lhs()->As<ast::MemberAccessorExpression>()) {
if (is_storage_buffer_access(mem)) {
std::ostringstream accessor_out;
if (!EmitStorageBufferAccessor(pre, accessor_out, mem, stmt->rhs())) {
return false;
}
out << pre.str();
out << accessor_out.str() << ";" << std::endl;
return true;
}
} else if (auto* ary = stmt->lhs()->As<ast::ArrayAccessorExpression>()) {
if (is_storage_buffer_access(ary)) {
std::ostringstream accessor_out;
if (!EmitStorageBufferAccessor(pre, accessor_out, ary, stmt->rhs())) {
return false;
}
out << pre.str();
out << accessor_out.str() << ";" << std::endl;
return true;
}
}
std::ostringstream lhs_out;
if (!EmitExpression(pre, lhs_out, stmt->lhs())) {
return false;
}
std::ostringstream rhs_out;
if (!EmitExpression(pre, rhs_out, stmt->rhs())) {
return false;
}
out << pre.str();
out << lhs_out.str() << " = " << rhs_out.str() << ";" << std::endl;
return true;
}
bool GeneratorImpl::EmitBinary(std::ostream& pre,
std::ostream& out,
ast::BinaryExpression* expr) {
if (expr->op() == ast::BinaryOp::kLogicalAnd ||
expr->op() == ast::BinaryOp::kLogicalOr) {
std::ostringstream lhs_out;
if (!EmitExpression(pre, lhs_out, expr->lhs())) {
return false;
}
auto name = generate_name(kTempNamePrefix);
make_indent(pre);
pre << "bool " << name << " = " << lhs_out.str() << ";" << std::endl;
make_indent(pre);
pre << "if (";
if (expr->op() == ast::BinaryOp::kLogicalOr) {
pre << "!";
}
pre << name << ") {" << std::endl;
increment_indent();
std::ostringstream rhs_out;
if (!EmitExpression(pre, rhs_out, expr->rhs())) {
return false;
}
make_indent(pre);
pre << name << " = " << rhs_out.str() << ";" << std::endl;
decrement_indent();
make_indent(pre);
pre << "}" << std::endl;
out << "(" << name << ")";
return true;
}
auto* lhs_type = expr->lhs()->result_type()->UnwrapAll();
auto* rhs_type = expr->rhs()->result_type()->UnwrapAll();
// Multiplying by a matrix requires the use of `mul` in order to get the
// type of multiply we desire.
if (expr->op() == ast::BinaryOp::kMultiply &&
((lhs_type->Is<ast::type::Vector>() &&
rhs_type->Is<ast::type::Matrix>()) ||
(lhs_type->Is<ast::type::Matrix>() &&
rhs_type->Is<ast::type::Vector>()) ||
(lhs_type->Is<ast::type::Matrix>() &&
rhs_type->Is<ast::type::Matrix>()))) {
out << "mul(";
if (!EmitExpression(pre, out, expr->lhs())) {
return false;
}
out << ", ";
if (!EmitExpression(pre, out, expr->rhs())) {
return false;
}
out << ")";
return true;
}
out << "(";
if (!EmitExpression(pre, out, expr->lhs())) {
return false;
}
out << " ";
switch (expr->op()) {
case ast::BinaryOp::kAnd:
out << "&";
break;
case ast::BinaryOp::kOr:
out << "|";
break;
case ast::BinaryOp::kXor:
out << "^";
break;
case ast::BinaryOp::kLogicalAnd:
case ast::BinaryOp::kLogicalOr: {
// These are both handled above.
assert(false);
return false;
}
case ast::BinaryOp::kEqual:
out << "==";
break;
case ast::BinaryOp::kNotEqual:
out << "!=";
break;
case ast::BinaryOp::kLessThan:
out << "<";
break;
case ast::BinaryOp::kGreaterThan:
out << ">";
break;
case ast::BinaryOp::kLessThanEqual:
out << "<=";
break;
case ast::BinaryOp::kGreaterThanEqual:
out << ">=";
break;
case ast::BinaryOp::kShiftLeft:
out << "<<";
break;
case ast::BinaryOp::kShiftRight:
// TODO(dsinclair): MSL is based on C++14, and >> in C++14 has
// implementation-defined behaviour for negative LHS. We may have to
// generate extra code to implement WGSL-specified behaviour for negative
// LHS.
out << R"(>>)";
break;
case ast::BinaryOp::kAdd:
out << "+";
break;
case ast::BinaryOp::kSubtract:
out << "-";
break;
case ast::BinaryOp::kMultiply:
out << "*";
break;
case ast::BinaryOp::kDivide:
out << "/";
break;
case ast::BinaryOp::kModulo:
out << "%";
break;
case ast::BinaryOp::kNone:
error_ = "missing binary operation type";
return false;
}
out << " ";
if (!EmitExpression(pre, out, expr->rhs())) {
return false;
}
out << ")";
return true;
}
bool GeneratorImpl::EmitBlock(std::ostream& out,
const ast::BlockStatement* stmt) {
out << "{" << std::endl;
increment_indent();
for (auto* s : *stmt) {
if (!EmitStatement(out, s)) {
return false;
}
}
decrement_indent();
make_indent(out);
out << "}";
return true;
}
bool GeneratorImpl::EmitBlockAndNewline(std::ostream& out,
const ast::BlockStatement* stmt) {
const bool result = EmitBlock(out, stmt);
if (result) {
out << std::endl;
}
return result;
}
bool GeneratorImpl::EmitIndentedBlockAndNewline(std::ostream& out,
ast::BlockStatement* stmt) {
make_indent(out);
const bool result = EmitBlock(out, stmt);
if (result) {
out << std::endl;
}
return result;
}
bool GeneratorImpl::EmitBreak(std::ostream& out, ast::BreakStatement*) {
make_indent(out);
out << "break;" << std::endl;
return true;
}
std::string GeneratorImpl::generate_intrinsic_name(ast::Intrinsic intrinsic) {
if (intrinsic == ast::Intrinsic::kAny) {
return "any";
}
if (intrinsic == ast::Intrinsic::kAll) {
return "all";
}
if (intrinsic == ast::Intrinsic::kCountOneBits) {
return "countbits";
}
if (intrinsic == ast::Intrinsic::kDot) {
return "dot";
}
if (intrinsic == ast::Intrinsic::kDpdy) {
return "ddy";
}
if (intrinsic == ast::Intrinsic::kDpdyFine) {
return "ddy_fine";
}
if (intrinsic == ast::Intrinsic::kDpdyCoarse) {
return "ddy_coarse";
}
if (intrinsic == ast::Intrinsic::kDpdx) {
return "ddx";
}
if (intrinsic == ast::Intrinsic::kDpdxFine) {
return "ddx_fine";
}
if (intrinsic == ast::Intrinsic::kDpdxCoarse) {
return "ddx_coarse";
}
if (intrinsic == ast::Intrinsic::kFwidth ||
intrinsic == ast::Intrinsic::kFwidthFine ||
intrinsic == ast::Intrinsic::kFwidthCoarse) {
return "fwidth";
}
if (intrinsic == ast::Intrinsic::kIsFinite) {
return "isfinite";
}
if (intrinsic == ast::Intrinsic::kIsInf) {
return "isinf";
}
if (intrinsic == ast::Intrinsic::kIsNan) {
return "isnan";
}
if (intrinsic == ast::Intrinsic::kReverseBits) {
return "reversebits";
}
return "";
}
bool GeneratorImpl::EmitCall(std::ostream& pre,
std::ostream& out,
ast::CallExpression* expr) {
auto* ident = expr->func()->As<ast::IdentifierExpression>();
if (ident == nullptr) {
error_ = "invalid function name";
return 0;
}
if (ident->IsIntrinsic()) {
const auto& params = expr->params();
if (ident->intrinsic() == ast::Intrinsic::kSelect) {
error_ = "select not supported in HLSL backend yet";
return false;
} else if (ident->intrinsic() == ast::Intrinsic::kIsNormal) {
error_ = "is_normal not supported in HLSL backend yet";
return false;
} else {
auto name = generate_intrinsic_name(ident->intrinsic());
if (name.empty()) {
if (ast::intrinsic::IsTextureIntrinsic(ident->intrinsic())) {
return EmitTextureCall(pre, out, expr);
}
name = generate_builtin_name(expr);
if (name.empty()) {
return false;
}
}
make_indent(out);
out << name << "(";
bool first = true;
for (auto* param : params) {
if (!first) {
out << ", ";
}
first = false;
if (!EmitExpression(pre, out, param)) {
return false;
}
}
out << ")";
}
return true;
}
auto name = module_->SymbolToName(ident->symbol());
auto caller_sym = ident->symbol();
auto it = ep_func_name_remapped_.find(current_ep_sym_.to_str() + "_" +
caller_sym.to_str());
if (it != ep_func_name_remapped_.end()) {
name = it->second;
}
auto* func = module_->FindFunctionBySymbol(ident->symbol());
if (func == nullptr) {
error_ =
"Unable to find function: " + module_->SymbolToName(ident->symbol());
return false;
}
out << name << "(";
bool first = true;
if (has_referenced_in_var_needing_struct(func)) {
auto var_name = current_ep_var_name(VarType::kIn);
if (!var_name.empty()) {
out << var_name;
first = false;
}
}
if (has_referenced_out_var_needing_struct(func)) {
auto var_name = current_ep_var_name(VarType::kOut);
if (!var_name.empty()) {
if (!first) {
out << ", ";
}
first = false;
out << var_name;
}
}
const auto& params = expr->params();
for (auto* param : params) {
if (!first) {
out << ", ";
}
first = false;
if (!EmitExpression(pre, out, param)) {
return false;
}
}
out << ")";
return true;
}
bool GeneratorImpl::EmitTextureCall(std::ostream& pre,
std::ostream& out,
ast::CallExpression* expr) {
auto* ident = expr->func()->As<ast::IdentifierExpression>();
auto params = expr->params();
auto* signature = static_cast<const ast::intrinsic::TextureSignature*>(
ident->intrinsic_signature());
auto& pidx = signature->params.idx;
auto const kNotUsed = ast::intrinsic::TextureSignature::Parameters::kNotUsed;
auto* texture = params[pidx.texture];
auto* texture_type =
texture->result_type()->UnwrapAll()->As<ast::type::Texture>();
switch (ident->intrinsic()) {
case ast::Intrinsic::kTextureDimensions:
case ast::Intrinsic::kTextureNumLayers:
case ast::Intrinsic::kTextureNumLevels:
case ast::Intrinsic::kTextureNumSamples: {
// All of these intrinsics use the GetDimensions() method on the texture
int num_dimensions = 0;
const char* swizzle = "";
bool add_mip_level_in = false;
switch (ident->intrinsic()) {
case ast::Intrinsic::kTextureDimensions:
switch (texture_type->dim()) {
case ast::type::TextureDimension::kNone:
error_ = "texture dimension is kNone";
return false;
case ast::type::TextureDimension::k1d:
num_dimensions = 1;
break;
case ast::type::TextureDimension::k1dArray:
num_dimensions = 2;
swizzle = ".x";
break;
case ast::type::TextureDimension::k2d:
num_dimensions = 2;
break;
case ast::type::TextureDimension::k2dArray:
num_dimensions = 3;
swizzle = ".xy";
break;
case ast::type::TextureDimension::k3d:
num_dimensions = 3;
break;
case ast::type::TextureDimension::kCube:
// width == height == depth for cubes
// See https://github.com/gpuweb/gpuweb/issues/1345
num_dimensions = 2;
swizzle = ".xyy"; // [width, height, height]
break;
case ast::type::TextureDimension::kCubeArray:
// width == height == depth for cubes
// See https://github.com/gpuweb/gpuweb/issues/1345
num_dimensions = 3;
swizzle = ".xyy"; // [width, height, height]
break;
}
break;
case ast::Intrinsic::kTextureNumLayers:
switch (texture_type->dim()) {
default:
error_ = "texture dimension is not arrayed";
return false;
case ast::type::TextureDimension::k1dArray:
num_dimensions = 2;
swizzle = ".y";
break;
case ast::type::TextureDimension::k2dArray:
case ast::type::TextureDimension::kCubeArray:
num_dimensions = 3;
swizzle = ".z";
break;
}
break;
case ast::Intrinsic::kTextureNumLevels:
add_mip_level_in = true;
switch (texture_type->dim()) {
default:
error_ = "texture dimension does not support mips";
return false;
case ast::type::TextureDimension::k2d:
case ast::type::TextureDimension::kCube:
num_dimensions = 3;
swizzle = ".z";
break;
case ast::type::TextureDimension::k2dArray:
case ast::type::TextureDimension::k3d:
case ast::type::TextureDimension::kCubeArray:
num_dimensions = 4;
swizzle = ".w";
break;
}
break;
case ast::Intrinsic::kTextureNumSamples:
switch (texture_type->dim()) {
default:
error_ = "texture dimension does not support multisampling";
return false;
case ast::type::TextureDimension::k2d:
num_dimensions = 3;
swizzle = ".z";
break;
case ast::type::TextureDimension::k2dArray:
num_dimensions = 4;
swizzle = ".w";
break;
}
break;
default:
error_ = "unexpected intrinsic";
return false;
}
// Declare a variable to hold the queried texture info
auto dims = generate_name(kTempNamePrefix);
if (num_dimensions == 1) {
pre << "int " << dims << ";\n";
} else {
pre << "int" << num_dimensions << " " << dims << ";\n";
}
if (!EmitExpression(pre, pre, texture)) {
return false;
}
pre << ".GetDimensions(";
if (pidx.level != kNotUsed) {
pre << pidx.level << ", ";
} else if (add_mip_level_in) {
pre << "0, ";
}
if (num_dimensions == 1) {
pre << dims;
} else {
assert(num_dimensions > 0);
assert(num_dimensions <= 4);
static constexpr char xyzw[] = {'x', 'y', 'z', 'w'};
for (int i = 0; i < num_dimensions; i++) {
if (i > 0) {
pre << ", ";
}
pre << dims << "." << xyzw[i];
}
}
pre << ");";
// The out parameters of the GetDimensions() call is now in temporary
// `dims` variable. This may be packed with other data, so the final
// expression may require a swizzle.
out << dims << swizzle;
return true;
}
default:
break;
}
if (!EmitExpression(pre, out, texture))
return false;
bool pack_mip_in_coords = false;
switch (ident->intrinsic()) {
case ast::Intrinsic::kTextureSample:
out << ".Sample(";
break;
case ast::Intrinsic::kTextureSampleBias:
out << ".SampleBias(";
break;
case ast::Intrinsic::kTextureSampleLevel:
out << ".SampleLevel(";
break;
case ast::Intrinsic::kTextureSampleGrad:
out << ".SampleGrad(";
break;
case ast::Intrinsic::kTextureSampleCompare:
out << ".SampleCmp(";
break;
case ast::Intrinsic::kTextureLoad:
out << ".Load(";
if (!texture_type->Is<ast::type::StorageTexture>()) {
pack_mip_in_coords = true;
}
break;
case ast::Intrinsic::kTextureStore:
out << "[";
break;
default:
error_ = "Internal compiler error: Unhandled texture intrinsic '" +
module_->SymbolToName(ident->symbol()) + "'";
return false;
}
if (pidx.sampler != kNotUsed) {
if (!EmitExpression(pre, out, params[pidx.sampler]))
return false;
out << ", ";
}
auto* param_coords = params[pidx.coords];
auto emit_vector_appended_with_i32_zero = [&](tint::ast::Expression* vector) {
auto* i32 = module_->create<ast::type::I32>();
ast::SintLiteral zero_lit(Source{}, i32, 0);
ast::ScalarConstructorExpression zero(Source{}, &zero_lit);
zero.set_result_type(i32);
return AppendVector(vector, &zero,
[&](ast::TypeConstructorExpression* packed) {
return EmitExpression(pre, out, packed);
});
};
if (pidx.array_index != kNotUsed) {
// Array index needs to be appended to the coordinates.
auto* param_array_index = params[pidx.array_index];
if (!AppendVector(param_coords, param_array_index,
[&](ast::TypeConstructorExpression* packed) {
if (pack_mip_in_coords) {
return emit_vector_appended_with_i32_zero(packed);
} else {
return EmitExpression(pre, out, packed);
}
})) {
return false;
}
} else if (pack_mip_in_coords) {
// Mip level needs to be appended to the coordinates, but is always zero.
if (!emit_vector_appended_with_i32_zero(param_coords))
return false;
} else {
if (!EmitExpression(pre, out, param_coords))
return false;
}
for (auto idx : {pidx.depth_ref, pidx.bias, pidx.level, pidx.ddx, pidx.ddy,
pidx.sample_index, pidx.offset}) {
if (idx != kNotUsed) {
out << ", ";
if (!EmitExpression(pre, out, params[idx]))
return false;
}
}
if (ident->intrinsic() == ast::Intrinsic::kTextureStore) {
out << "] = ";
if (!EmitExpression(pre, out, params[pidx.value]))
return false;
} else {
out << ")";
}
return true;
}
std::string GeneratorImpl::generate_builtin_name(ast::CallExpression* expr) {
std::string out;
auto* ident = expr->func()->As<ast::IdentifierExpression>();
switch (ident->intrinsic()) {
case ast::Intrinsic::kAcos:
case ast::Intrinsic::kAsin:
case ast::Intrinsic::kAtan:
case ast::Intrinsic::kAtan2:
case ast::Intrinsic::kCeil:
case ast::Intrinsic::kCos:
case ast::Intrinsic::kCosh:
case ast::Intrinsic::kCross:
case ast::Intrinsic::kDeterminant:
case ast::Intrinsic::kDistance:
case ast::Intrinsic::kExp:
case ast::Intrinsic::kExp2:
case ast::Intrinsic::kFloor:
case ast::Intrinsic::kFma:
case ast::Intrinsic::kLength:
case ast::Intrinsic::kLog:
case ast::Intrinsic::kLog2:
case ast::Intrinsic::kNormalize:
case ast::Intrinsic::kPow:
case ast::Intrinsic::kReflect:
case ast::Intrinsic::kRound:
case ast::Intrinsic::kSin:
case ast::Intrinsic::kSinh:
case ast::Intrinsic::kSqrt:
case ast::Intrinsic::kStep:
case ast::Intrinsic::kTan:
case ast::Intrinsic::kTanh:
case ast::Intrinsic::kTrunc:
case ast::Intrinsic::kMix:
case ast::Intrinsic::kSign:
case ast::Intrinsic::kAbs:
case ast::Intrinsic::kMax:
case ast::Intrinsic::kMin:
case ast::Intrinsic::kClamp:
out = module_->SymbolToName(ident->symbol());
break;
case ast::Intrinsic::kFaceForward:
out = "faceforward";
break;
case ast::Intrinsic::kFract:
out = "frac";
break;
case ast::Intrinsic::kInverseSqrt:
out = "rsqrt";
break;
case ast::Intrinsic::kSmoothStep:
out = "smoothstep";
break;
default:
error_ =
"Unknown builtin method: " + module_->SymbolToName(ident->symbol());
return "";
}
return out;
}
bool GeneratorImpl::EmitCase(std::ostream& out, ast::CaseStatement* stmt) {
make_indent(out);
if (stmt->IsDefault()) {
out << "default:";
} else {
bool first = true;
for (auto* selector : stmt->selectors()) {
if (!first) {
out << std::endl;
make_indent(out);
}
first = false;
out << "case ";
if (!EmitLiteral(out, selector)) {
return false;
}
out << ":";
}
}
out << " {" << std::endl;
increment_indent();
for (auto* s : *stmt->body()) {
if (!EmitStatement(out, s)) {
return false;
}
}
if (!last_is_break_or_fallthrough(stmt->body())) {
make_indent(out);
out << "break;" << std::endl;
}
decrement_indent();
make_indent(out);
out << "}" << std::endl;
return true;
}
bool GeneratorImpl::EmitConstructor(std::ostream& pre,
std::ostream& out,
ast::ConstructorExpression* expr) {
if (auto* scalar = expr->As<ast::ScalarConstructorExpression>()) {
return EmitScalarConstructor(pre, out, scalar);
}
return EmitTypeConstructor(pre, out,
expr->As<ast::TypeConstructorExpression>());
}
bool GeneratorImpl::EmitScalarConstructor(
std::ostream&,
std::ostream& out,
ast::ScalarConstructorExpression* expr) {
return EmitLiteral(out, expr->literal());
}
bool GeneratorImpl::EmitTypeConstructor(std::ostream& pre,
std::ostream& out,
ast::TypeConstructorExpression* expr) {
if (expr->type()->Is<ast::type::Array>()) {
out << "{";
} else {
if (!EmitType(out, expr->type(), "")) {
return false;
}
out << "(";
}
// If the type constructor is empty then we need to construct with the zero
// value for all components.
if (expr->values().empty()) {
if (!EmitZeroValue(out, expr->type())) {
return false;
}
} else {
bool first = true;
for (auto* e : expr->values()) {
if (!first) {
out << ", ";
}
first = false;
if (!EmitExpression(pre, out, e)) {
return false;
}
}
}
if (expr->type()->Is<ast::type::Array>()) {
out << "}";
} else {
out << ")";
}
return true;
}
bool GeneratorImpl::EmitContinue(std::ostream& out, ast::ContinueStatement*) {
make_indent(out);
out << "continue;" << std::endl;
return true;
}
bool GeneratorImpl::EmitDiscard(std::ostream& out, ast::DiscardStatement*) {
make_indent(out);
// TODO(dsinclair): Verify this is correct when the discard semantics are
// defined for WGSL (https://github.com/gpuweb/gpuweb/issues/361)
out << "discard;" << std::endl;
return true;
}
bool GeneratorImpl::EmitExpression(std::ostream& pre,
std::ostream& out,
ast::Expression* expr) {
if (auto* a = expr->As<ast::ArrayAccessorExpression>()) {
return EmitArrayAccessor(pre, out, a);
}
if (auto* b = expr->As<ast::BinaryExpression>()) {
return EmitBinary(pre, out, b);
}
if (auto* b = expr->As<ast::BitcastExpression>()) {
return EmitBitcast(pre, out, b);
}
if (auto* c = expr->As<ast::CallExpression>()) {
return EmitCall(pre, out, c);
}
if (auto* c = expr->As<ast::ConstructorExpression>()) {
return EmitConstructor(pre, out, c);
}
if (auto* i = expr->As<ast::IdentifierExpression>()) {
return EmitIdentifier(pre, out, i);
}
if (auto* m = expr->As<ast::MemberAccessorExpression>()) {
return EmitMemberAccessor(pre, out, m);
}
if (auto* u = expr->As<ast::UnaryOpExpression>()) {
return EmitUnaryOp(pre, out, u);
}
error_ = "unknown expression type: " + expr->str();
return false;
}
bool GeneratorImpl::global_is_in_struct(ast::Variable* var) const {
if (var->HasLocationDecoration() || var->HasBuiltinDecoration()) {
return var->storage_class() == ast::StorageClass::kInput ||
var->storage_class() == ast::StorageClass::kOutput;
}
return false;
}
bool GeneratorImpl::EmitIdentifier(std::ostream&,
std::ostream& out,
ast::IdentifierExpression* expr) {
auto* ident = expr->As<ast::IdentifierExpression>();
ast::Variable* var = nullptr;
if (global_variables_.get(ident->symbol(), &var)) {
if (global_is_in_struct(var)) {
auto var_type = var->storage_class() == ast::StorageClass::kInput
? VarType::kIn
: VarType::kOut;
auto name = current_ep_var_name(var_type);
if (name.empty()) {
error_ = "unable to find entry point data for variable";
return false;
}
out << name << ".";
}
}
out << namer_.NameFor(module_->SymbolToName(ident->symbol()));
return true;
}
bool GeneratorImpl::EmitIf(std::ostream& out, ast::IfStatement* stmt) {
make_indent(out);
std::ostringstream pre;
std::ostringstream cond;
if (!EmitExpression(pre, cond, stmt->condition())) {
return false;
}
std::ostringstream if_out;
if_out << "if (" << cond.str() << ") ";
if (!EmitBlock(if_out, stmt->body())) {
return false;
}
for (auto* e : stmt->else_statements()) {
if (e->HasCondition()) {
if_out << " else {" << std::endl;
increment_indent();
std::ostringstream else_pre;
std::ostringstream else_cond_out;
if (!EmitExpression(else_pre, else_cond_out, e->condition())) {
return false;
}
if_out << else_pre.str();
make_indent(if_out);
if_out << "if (" << else_cond_out.str() << ") ";
} else {
if_out << " else ";
}
if (!EmitBlock(if_out, e->body())) {
return false;
}
}
if_out << std::endl;
for (auto* e : stmt->else_statements()) {
if (!e->HasCondition()) {
continue;
}
decrement_indent();
make_indent(if_out);
if_out << "}" << std::endl;
}
out << pre.str();
out << if_out.str();
return true;
}
bool GeneratorImpl::has_referenced_in_var_needing_struct(ast::Function* func) {
for (auto data : func->referenced_location_variables()) {
auto* var = data.first;
if (var->storage_class() == ast::StorageClass::kInput) {
return true;
}
}
for (auto data : func->referenced_builtin_variables()) {
auto* var = data.first;
if (var->storage_class() == ast::StorageClass::kInput) {
return true;
}
}
return false;
}
bool GeneratorImpl::has_referenced_out_var_needing_struct(ast::Function* func) {
for (auto data : func->referenced_location_variables()) {
auto* var = data.first;
if (var->storage_class() == ast::StorageClass::kOutput) {
return true;
}
}
for (auto data : func->referenced_builtin_variables()) {
auto* var = data.first;
if (var->storage_class() == ast::StorageClass::kOutput) {
return true;
}
}
return false;
}
bool GeneratorImpl::has_referenced_var_needing_struct(ast::Function* func) {
for (auto data : func->referenced_location_variables()) {
auto* var = data.first;
if (var->storage_class() == ast::StorageClass::kOutput ||
var->storage_class() == ast::StorageClass::kInput) {
return true;
}
}
for (auto data : func->referenced_builtin_variables()) {
auto* var = data.first;
if (var->storage_class() == ast::StorageClass::kOutput ||
var->storage_class() == ast::StorageClass::kInput) {
return true;
}
}
return false;
}
bool GeneratorImpl::EmitFunction(std::ostream& out, ast::Function* func) {
make_indent(out);
// Entry points will be emitted later, skip for now.
if (func->IsEntryPoint()) {
return true;
}
// TODO(dsinclair): This could be smarter. If the input/outputs for multiple
// entry points are the same we could generate a single struct and then have
// this determine it's the same struct and just emit once.
bool emit_duplicate_functions = func->ancestor_entry_points().size() > 0 &&
has_referenced_var_needing_struct(func);
if (emit_duplicate_functions) {
for (const auto& ep_sym : func->ancestor_entry_points()) {
if (!EmitFunctionInternal(out, func, emit_duplicate_functions, ep_sym)) {
return false;
}
out << std::endl;
}
} else {
// Emit as non-duplicated
if (!EmitFunctionInternal(out, func, false, Symbol())) {
return false;
}
out << std::endl;
}
return true;
}
bool GeneratorImpl::EmitFunctionInternal(std::ostream& out,
ast::Function* func,
bool emit_duplicate_functions,
Symbol ep_sym) {
auto name = func->symbol().to_str();
if (!EmitType(out, func->return_type(), "")) {
return false;
}
out << " ";
if (emit_duplicate_functions) {
auto func_name = name;
auto ep_name = ep_sym.to_str();
// TODO(dsinclair): The SymbolToName should go away and just use
// to_str() here when the conversion is complete.
name = generate_name(module_->SymbolToName(func->symbol()) + "_" +
module_->SymbolToName(ep_sym));
ep_func_name_remapped_[ep_name + "_" + func_name] = name;
} else {
// TODO(dsinclair): this should be updated to a remapped name
name = namer_.NameFor(module_->SymbolToName(func->symbol()));
}
out << name << "(";
bool first = true;
// If we're emitting duplicate functions that means the function takes
// the stage_in or stage_out value from the entry point, emit them.
//
// We emit both of them if they're there regardless of if they're both used.
if (emit_duplicate_functions) {
auto in_it = ep_sym_to_in_data_.find(ep_sym);
if (in_it != ep_sym_to_in_data_.end()) {
out << "in " << in_it->second.struct_name << " "
<< in_it->second.var_name;
first = false;
}
auto outit = ep_sym_to_out_data_.find(ep_sym);
if (outit != ep_sym_to_out_data_.end()) {
if (!first) {
out << ", ";
}
out << "out " << outit->second.struct_name << " "
<< outit->second.var_name;
first = false;
}
}
for (auto* v : func->params()) {
if (!first) {
out << ", ";
}
first = false;
if (!EmitType(out, v->type(), module_->SymbolToName(v->symbol()))) {
return false;
}
// Array name is output as part of the type
if (!v->type()->Is<ast::type::Array>()) {
out << " " << module_->SymbolToName(v->symbol());
}
}
out << ") ";
current_ep_sym_ = ep_sym;
if (!EmitBlockAndNewline(out, func->body())) {
return false;
}
current_ep_sym_ = Symbol();
return true;
}
bool GeneratorImpl::EmitEntryPointData(
std::ostream& out,
ast::Function* func,
std::unordered_set<Symbol>& emitted_globals) {
std::vector<std::pair<ast::Variable*, ast::VariableDecoration*>> in_variables;
std::vector<std::pair<ast::Variable*, ast::VariableDecoration*>> outvariables;
for (auto data : func->referenced_location_variables()) {
auto* var = data.first;
auto* deco = data.second;
if (var->storage_class() == ast::StorageClass::kInput) {
in_variables.push_back({var, deco});
} else if (var->storage_class() == ast::StorageClass::kOutput) {
outvariables.push_back({var, deco});
}
}
for (auto data : func->referenced_builtin_variables()) {
auto* var = data.first;
auto* deco = data.second;
if (var->storage_class() == ast::StorageClass::kInput) {
in_variables.push_back({var, deco});
} else if (var->storage_class() == ast::StorageClass::kOutput) {
outvariables.push_back({var, deco});
}
}
bool emitted_uniform = false;
for (auto data : func->referenced_uniform_variables()) {
auto* var = data.first;
// TODO(dsinclair): We're using the binding to make up the buffer number but
// we should instead be using a provided mapping that uses both buffer and
// set. https://bugs.chromium.org/p/tint/issues/detail?id=104
auto* binding = data.second.binding;
if (binding == nullptr) {
error_ = "unable to find binding information for uniform: " +
module_->SymbolToName(var->symbol());
return false;
}
// auto* set = data.second.set;
// If the global has already been emitted we skip it, it's been emitted by
// a previous entry point.
if (emitted_globals.count(var->symbol()) != 0) {
continue;
}
emitted_globals.insert(var->symbol());
auto* type = var->type()->UnwrapIfNeeded();
if (auto* strct = type->As<ast::type::Struct>()) {
out << "ConstantBuffer<" << module_->SymbolToName(strct->symbol()) << "> "
<< module_->SymbolToName(var->symbol()) << " : register(b"
<< binding->value() << ");" << std::endl;
} else {
// TODO(dsinclair): There is outstanding spec work to require all uniform
// buffers to be [[block]] decorated, which means structs. This is
// currently not the case, so this code handles the cases where the data
// is not a block.
// Relevant: https://github.com/gpuweb/gpuweb/issues/1004
// https://github.com/gpuweb/gpuweb/issues/1008
auto name = "cbuffer_" + module_->SymbolToName(var->symbol());
out << "cbuffer " << name << " : register(b" << binding->value() << ") {"
<< std::endl;
increment_indent();
make_indent(out);
if (!EmitType(out, type, "")) {
return false;
}
out << " " << module_->SymbolToName(var->symbol()) << ";" << std::endl;
decrement_indent();
out << "};" << std::endl;
}
emitted_uniform = true;
}
if (emitted_uniform) {
out << std::endl;
}
bool emitted_storagebuffer = false;
for (auto data : func->referenced_storagebuffer_variables()) {
auto* var = data.first;
auto* binding = data.second.binding;
// If the global has already been emitted we skip it, it's been emitted by
// a previous entry point.
if (emitted_globals.count(var->symbol()) != 0) {
continue;
}
emitted_globals.insert(var->symbol());
auto* ac = var->type()->As<ast::type::AccessControl>();
if (ac == nullptr) {
error_ = "access control type required for storage buffer";
return false;
}
if (ac->IsReadWrite()) {
out << "RW";
}
out << "ByteAddressBuffer " << module_->SymbolToName(var->symbol())
<< " : register(u" << binding->value() << ");" << std::endl;
emitted_storagebuffer = true;
}
if (emitted_storagebuffer) {
out << std::endl;
}
if (!in_variables.empty()) {
auto in_struct_name = generate_name(module_->SymbolToName(func->symbol()) +
"_" + kInStructNameSuffix);
auto in_var_name = generate_name(kTintStructInVarPrefix);
ep_sym_to_in_data_[func->symbol()] = {in_struct_name, in_var_name};
make_indent(out);
out << "struct " << in_struct_name << " {" << std::endl;
increment_indent();
for (auto& data : in_variables) {
auto* var = data.first;
auto* deco = data.second;
make_indent(out);
if (!EmitType(out, var->type(), module_->SymbolToName(var->symbol()))) {
return false;
}
out << " " << module_->SymbolToName(var->symbol()) << " : ";
if (auto* location = deco->As<ast::LocationDecoration>()) {
if (func->pipeline_stage() == ast::PipelineStage::kCompute) {
error_ = "invalid location variable for pipeline stage";
return false;
}
out << "TEXCOORD" << location->value();
} else if (auto* builtin = deco->As<ast::BuiltinDecoration>()) {
auto attr = builtin_to_attribute(builtin->value());
if (attr.empty()) {
error_ = "unsupported builtin";
return false;
}
out << attr;
} else {
error_ = "unsupported variable decoration for entry point output";
return false;
}
out << ";" << std::endl;
}
decrement_indent();
make_indent(out);
out << "};" << std::endl << std::endl;
}
if (!outvariables.empty()) {
auto outstruct_name = generate_name(module_->SymbolToName(func->symbol()) +
"_" + kOutStructNameSuffix);
auto outvar_name = generate_name(kTintStructOutVarPrefix);
ep_sym_to_out_data_[func->symbol()] = {outstruct_name, outvar_name};
make_indent(out);
out << "struct " << outstruct_name << " {" << std::endl;
increment_indent();
for (auto& data : outvariables) {
auto* var = data.first;
auto* deco = data.second;
make_indent(out);
if (!EmitType(out, var->type(), module_->SymbolToName(var->symbol()))) {
return false;
}
out << " " << module_->SymbolToName(var->symbol()) << " : ";
if (auto* location = deco->As<ast::LocationDecoration>()) {
auto loc = location->value();
if (func->pipeline_stage() == ast::PipelineStage::kVertex) {
out << "TEXCOORD" << loc;
} else if (func->pipeline_stage() == ast::PipelineStage::kFragment) {
out << "SV_Target" << loc << "";
} else {
error_ = "invalid location variable for pipeline stage";
return false;
}
} else if (auto* builtin = deco->As<ast::BuiltinDecoration>()) {
auto attr = builtin_to_attribute(builtin->value());
if (attr.empty()) {
error_ = "unsupported builtin";
return false;
}
out << attr;
} else {
error_ = "unsupported variable decoration for entry point output";
return false;
}
out << ";" << std::endl;
}
decrement_indent();
make_indent(out);
out << "};" << std::endl << std::endl;
}
return true;
}
std::string GeneratorImpl::builtin_to_attribute(ast::Builtin builtin) const {
switch (builtin) {
case ast::Builtin::kPosition:
return "SV_Position";
case ast::Builtin::kVertexIdx:
return "SV_VertexID";
case ast::Builtin::kInstanceIdx:
return "SV_InstanceID";
case ast::Builtin::kFrontFacing:
return "SV_IsFrontFacing";
case ast::Builtin::kFragCoord:
return "SV_Position";
case ast::Builtin::kFragDepth:
return "SV_Depth";
case ast::Builtin::kLocalInvocationId:
return "SV_GroupThreadID";
case ast::Builtin::kLocalInvocationIdx:
return "SV_GroupIndex";
case ast::Builtin::kGlobalInvocationId:
return "SV_DispatchThreadID";
default:
break;
}
return "";
}
bool GeneratorImpl::EmitEntryPointFunction(std::ostream& out,
ast::Function* func) {
make_indent(out);
current_ep_sym_ = func->symbol();
if (func->pipeline_stage() == ast::PipelineStage::kCompute) {
uint32_t x = 0;
uint32_t y = 0;
uint32_t z = 0;
std::tie(x, y, z) = func->workgroup_size();
out << "[numthreads(" << std::to_string(x) << ", " << std::to_string(y)
<< ", " << std::to_string(z) << ")]" << std::endl;
make_indent(out);
}
auto outdata = ep_sym_to_out_data_.find(current_ep_sym_);
bool has_outdata = outdata != ep_sym_to_out_data_.end();
if (has_outdata) {
out << outdata->second.struct_name;
} else {
out << "void";
}
// TODO(dsinclair): This should output the remapped name
out << " " << namer_.NameFor(module_->SymbolToName(current_ep_sym_)) << "(";
auto in_data = ep_sym_to_in_data_.find(current_ep_sym_);
if (in_data != ep_sym_to_in_data_.end()) {
out << in_data->second.struct_name << " " << in_data->second.var_name;
}
out << ") {" << std::endl;
increment_indent();
if (has_outdata) {
make_indent(out);
out << outdata->second.struct_name << " " << outdata->second.var_name << ";"
<< std::endl;
}
generating_entry_point_ = true;
for (auto* s : *func->body()) {
if (!EmitStatement(out, s)) {
return false;
}
}
auto* last_statement = func->get_last_statement();
if (last_statement == nullptr ||
!last_statement->Is<ast::ReturnStatement>()) {
ast::ReturnStatement ret(Source{});
if (!EmitStatement(out, &ret)) {
return false;
}
}
generating_entry_point_ = false;
decrement_indent();
make_indent(out);
out << "}" << std::endl;
current_ep_sym_ = Symbol();
return true;
}
bool GeneratorImpl::EmitLiteral(std::ostream& out, ast::Literal* lit) {
if (auto* l = lit->As<ast::BoolLiteral>()) {
out << (l->IsTrue() ? "true" : "false");
} else if (auto* fl = lit->As<ast::FloatLiteral>()) {
out << FloatToString(fl->value()) << "f";
} else if (auto* sl = lit->As<ast::SintLiteral>()) {
out << sl->value();
} else if (auto* ul = lit->As<ast::UintLiteral>()) {
out << ul->value() << "u";
} else {
error_ = "unknown literal type";
return false;
}
return true;
}
bool GeneratorImpl::EmitZeroValue(std::ostream& out, ast::type::Type* type) {
if (type->Is<ast::type::Bool>()) {
out << "false";
} else if (type->Is<ast::type::F32>()) {
out << "0.0f";
} else if (type->Is<ast::type::I32>()) {
out << "0";
} else if (type->Is<ast::type::U32>()) {
out << "0u";
} else if (auto* vec = type->As<ast::type::Vector>()) {
return EmitZeroValue(out, vec->type());
} else if (auto* mat = type->As<ast::type::Matrix>()) {
for (uint32_t i = 0; i < (mat->rows() * mat->columns()); i++) {
if (i != 0) {
out << ", ";
}
if (!EmitZeroValue(out, mat->type())) {
return false;
}
}
} else {
error_ = "Invalid type for zero emission: " + type->type_name();
return false;
}
return true;
}
bool GeneratorImpl::EmitLoop(std::ostream& out, ast::LoopStatement* stmt) {
loop_emission_counter_++;
std::string guard = namer_.NameFor("tint_hlsl_is_first_" +
std::to_string(loop_emission_counter_));
if (stmt->has_continuing()) {
make_indent(out);
// Continuing variables get their own scope.
out << "{" << std::endl;
increment_indent();
make_indent(out);
out << "bool " << guard << " = true;" << std::endl;
// A continuing block may use variables declared in the method body. As a
// first pass, if we have a continuing, we pull all declarations outside
// the for loop into the continuing scope. Then, the variable declarations
// will be turned into assignments.
for (auto* s : *stmt->body()) {
if (auto* v = s->As<ast::VariableDeclStatement>()) {
if (!EmitVariable(out, v->variable(), true)) {
return false;
}
}
}
}
make_indent(out);
out << "for(;;) {" << std::endl;
increment_indent();
if (stmt->has_continuing()) {
make_indent(out);
out << "if (!" << guard << ") ";
if (!EmitBlockAndNewline(out, stmt->continuing())) {
return false;
}
make_indent(out);
out << guard << " = false;" << std::endl;
out << std::endl;
}
for (auto* s : *(stmt->body())) {
// If we have a continuing block we've already emitted the variable
// declaration before the loop, so treat it as an assignment.
if (auto* decl = s->As<ast::VariableDeclStatement>()) {
if (stmt->has_continuing()) {
make_indent(out);
auto* var = decl->variable();
std::ostringstream pre;
std::ostringstream constructor_out;
if (var->constructor() != nullptr) {
if (!EmitExpression(pre, constructor_out, var->constructor())) {
return false;
}
}
out << pre.str();
out << module_->SymbolToName(var->symbol()) << " = ";
if (var->constructor() != nullptr) {
out << constructor_out.str();
} else {
if (!EmitZeroValue(out, var->type())) {
return false;
}
}
out << ";" << std::endl;
continue;
}
}
if (!EmitStatement(out, s)) {
return false;
}
}
decrement_indent();
make_indent(out);
out << "}" << std::endl;
// Close the scope for any continuing variables.
if (stmt->has_continuing()) {
decrement_indent();
make_indent(out);
out << "}" << std::endl;
}
return true;
}
std::string GeneratorImpl::generate_storage_buffer_index_expression(
std::ostream& pre,
ast::Expression* expr) {
std::ostringstream out;
bool first = true;
for (;;) {
if (expr->Is<ast::IdentifierExpression>()) {
break;
}
if (!first) {
out << " + ";
}
first = false;
if (auto* mem = expr->As<ast::MemberAccessorExpression>()) {
auto* res_type = mem->structure()->result_type()->UnwrapAll();
if (auto* str = res_type->As<ast::type::Struct>()) {
auto* str_type = str->impl();
auto* str_member = str_type->get_member(mem->member()->symbol());
if (!str_member->has_offset_decoration()) {
error_ = "missing offset decoration for struct member";
return "";
}
out << str_member->offset();
} else if (res_type->Is<ast::type::Vector>()) {
// TODO(dsinclair): Swizzle stuff
//
// This must be a single element swizzle if we've got a vector at this
// point.
if (module_->SymbolToName(mem->member()->symbol()).size() != 1) {
error_ =
"Encountered multi-element swizzle when should have only one "
"level";
return "";
}
// TODO(dsinclair): All our types are currently 4 bytes (f32, i32, u32)
// so this is assuming 4. This will need to be fixed when we get f16 or
// f64 types.
out << "(4 * "
<< convert_swizzle_to_index(
module_->SymbolToName(mem->member()->symbol()))
<< ")";
} else {
error_ =
"Invalid result type for member accessor: " + res_type->type_name();
return "";
}
expr = mem->structure();
} else if (auto* ary = expr->As<ast::ArrayAccessorExpression>()) {
auto* ary_type = ary->array()->result_type()->UnwrapAll();
out << "(";
if (auto* arr = ary_type->As<ast::type::Array>()) {
out << arr->array_stride();
} else if (ary_type->Is<ast::type::Vector>()) {
// TODO(dsinclair): This is a hack. Our vectors can only be f32, i32
// or u32 which are all 4 bytes. When we get f16 or other types we'll
// have to ask the type for the byte size.
out << "4";
} else if (auto* mat = ary_type->As<ast::type::Matrix>()) {
if (mat->columns() == 2) {
out << "8";
} else {
out << "16";
}
} else {
error_ = "Invalid array type in storage buffer access";
return "";
}
out << " * ";
if (!EmitExpression(pre, out, ary->idx_expr())) {
return "";
}
out << ")";
expr = ary->array();
} else {
error_ = "error emitting storage buffer access";
return "";
}
}
return out.str();
}
// TODO(dsinclair): This currently only handles loading of 4, 8, 12 or 16 byte
// members. If we need to support larger we'll need to do the loading into
// chunks.
//
// TODO(dsinclair): Need to support loading through a pointer. The pointer is
// just a memory address in the storage buffer, so need to do the correct
// calculation.
bool GeneratorImpl::EmitStorageBufferAccessor(std::ostream& pre,
std::ostream& out,
ast::Expression* expr,
ast::Expression* rhs) {
auto* result_type = expr->result_type()->UnwrapAll();
bool is_store = rhs != nullptr;
std::string access_method = is_store ? "Store" : "Load";
if (auto* vec = result_type->As<ast::type::Vector>()) {
access_method += std::to_string(vec->size());
} else if (auto* mat = result_type->As<ast::type::Matrix>()) {
access_method += std::to_string(mat->rows());
}
// If we aren't storing then we need to put in the outer cast.
if (!is_store) {
if (result_type->is_float_scalar_or_vector() ||
result_type->Is<ast::type::Matrix>()) {
out << "asfloat(";
} else if (result_type->is_signed_scalar_or_vector()) {
out << "asint(";
} else if (result_type->is_unsigned_scalar_or_vector()) {
out << "asuint(";
}
}
auto buffer_name = get_buffer_name(expr);
if (buffer_name.empty()) {
error_ = "error emitting storage buffer access";
return false;
}
auto idx = generate_storage_buffer_index_expression(pre, expr);
if (idx.empty()) {
return false;
}
if (auto* mat = result_type->As<ast::type::Matrix>()) {
// TODO(dsinclair): This is assuming 4 byte elements. Will need to be fixed
// if we get matrixes of f16 or f64.
uint32_t stride = mat->rows() == 2 ? 8 : 16;
if (is_store) {
if (!EmitType(out, mat, "")) {
return false;
}
auto name = generate_name(kTempNamePrefix);
out << " " << name << " = ";
if (!EmitExpression(pre, out, rhs)) {
return false;
}
out << ";" << std::endl;
for (uint32_t i = 0; i < mat->columns(); i++) {
if (i > 0) {
out << ";" << std::endl;
}
make_indent(out);
out << buffer_name << "." << access_method << "(" << idx << " + "
<< (i * stride) << ", asuint(" << name << "[" << i << "]))";
}
return true;
}
out << "uint" << mat->rows() << "x" << mat->columns() << "(";
for (uint32_t i = 0; i < mat->columns(); i++) {
if (i != 0) {
out << ", ";
}
out << buffer_name << "." << access_method << "(" << idx << " + "
<< (i * stride) << ")";
}
// Close the matrix type and outer cast
out << "))";
return true;
}
out << buffer_name << "." << access_method << "(" << idx;
if (is_store) {
out << ", asuint(";
if (!EmitExpression(pre, out, rhs)) {
return false;
}
out << ")";
}
out << ")";
// Close the outer cast.
if (!is_store) {
out << ")";
}
return true;
}
bool GeneratorImpl::is_storage_buffer_access(
ast::ArrayAccessorExpression* expr) {
// We only care about array so we can get to the next part of the expression.
// If it isn't an array or a member accessor we can stop looking as it won't
// be a storage buffer.
auto* ary = expr->array();
if (auto* member = ary->As<ast::MemberAccessorExpression>()) {
return is_storage_buffer_access(member);
} else if (auto* array = ary->As<ast::ArrayAccessorExpression>()) {
return is_storage_buffer_access(array);
}
return false;
}
bool GeneratorImpl::is_storage_buffer_access(
ast::MemberAccessorExpression* expr) {
auto* structure = expr->structure();
auto* data_type = structure->result_type()->UnwrapAll();
// TODO(dsinclair): Swizzle
//
// If the data is a multi-element swizzle then we will not load the swizzle
// portion through the Load command.
if (data_type->Is<ast::type::Vector>() &&
module_->SymbolToName(expr->member()->symbol()).size() > 1) {
return false;
}
// Check if this is a storage buffer variable
if (auto* ident = expr->structure()->As<ast::IdentifierExpression>()) {
ast::Variable* var = nullptr;
if (!global_variables_.get(ident->symbol(), &var)) {
return false;
}
return var->storage_class() == ast::StorageClass::kStorageBuffer;
} else if (auto* member = structure->As<ast::MemberAccessorExpression>()) {
return is_storage_buffer_access(member);
} else if (auto* array = structure->As<ast::ArrayAccessorExpression>()) {
return is_storage_buffer_access(array);
}
// Technically I don't think this is possible, but if we don't have a struct
// or array accessor then we can't have a storage buffer I believe.
return false;
}
bool GeneratorImpl::EmitMemberAccessor(std::ostream& pre,
std::ostream& out,
ast::MemberAccessorExpression* expr) {
// Look for storage buffer accesses as we have to convert them into Load
// expressions. Stores will be identified in the assignment emission and a
// member accessor store of a storage buffer will not get here.
if (is_storage_buffer_access(expr)) {
return EmitStorageBufferAccessor(pre, out, expr, nullptr);
}
if (!EmitExpression(pre, out, expr->structure())) {
return false;
}
out << ".";
return EmitExpression(pre, out, expr->member());
}
bool GeneratorImpl::EmitReturn(std::ostream& out, ast::ReturnStatement* stmt) {
make_indent(out);
if (generating_entry_point_) {
out << "return";
auto outdata = ep_sym_to_out_data_.find(current_ep_sym_);
if (outdata != ep_sym_to_out_data_.end()) {
out << " " << outdata->second.var_name;
}
} else if (stmt->has_value()) {
std::ostringstream pre;
std::ostringstream ret_out;
if (!EmitExpression(pre, ret_out, stmt->value())) {
return false;
}
out << pre.str();
out << "return " << ret_out.str();
} else {
out << "return";
}
out << ";" << std::endl;
return true;
}
bool GeneratorImpl::EmitStatement(std::ostream& out, ast::Statement* stmt) {
if (auto* a = stmt->As<ast::AssignmentStatement>()) {
return EmitAssign(out, a);
}
if (auto* b = stmt->As<ast::BlockStatement>()) {
return EmitIndentedBlockAndNewline(out, b);
}
if (auto* b = stmt->As<ast::BreakStatement>()) {
return EmitBreak(out, b);
}
if (auto* c = stmt->As<ast::CallStatement>()) {
make_indent(out);
std::ostringstream pre;
std::ostringstream call_out;
if (!EmitCall(pre, call_out, c->expr())) {
return false;
}
out << pre.str();
out << call_out.str() << ";" << std::endl;
return true;
}
if (auto* c = stmt->As<ast::ContinueStatement>()) {
return EmitContinue(out, c);
}
if (auto* d = stmt->As<ast::DiscardStatement>()) {
return EmitDiscard(out, d);
}
if (stmt->As<ast::FallthroughStatement>()) {
make_indent(out);
out << "/* fallthrough */" << std::endl;
return true;
}
if (auto* i = stmt->As<ast::IfStatement>()) {
return EmitIf(out, i);
}
if (auto* l = stmt->As<ast::LoopStatement>()) {
return EmitLoop(out, l);
}
if (auto* r = stmt->As<ast::ReturnStatement>()) {
return EmitReturn(out, r);
}
if (auto* s = stmt->As<ast::SwitchStatement>()) {
return EmitSwitch(out, s);
}
if (auto* v = stmt->As<ast::VariableDeclStatement>()) {
return EmitVariable(out, v->variable(), false);
}
error_ = "unknown statement type: " + stmt->str();
return false;
}
bool GeneratorImpl::EmitSwitch(std::ostream& out, ast::SwitchStatement* stmt) {
make_indent(out);
std::ostringstream pre;
std::ostringstream cond;
if (!EmitExpression(pre, cond, stmt->condition())) {
return false;
}
out << pre.str();
out << "switch(" << cond.str() << ") {" << std::endl;
increment_indent();
for (auto* s : stmt->body()) {
if (!EmitCase(out, s)) {
return false;
}
}
decrement_indent();
make_indent(out);
out << "}" << std::endl;
return true;
}
bool GeneratorImpl::EmitType(std::ostream& out,
ast::type::Type* type,
const std::string& name) {
// HLSL doesn't have the read/write only markings so just unwrap the access
// control type.
if (auto* ac = type->As<ast::type::AccessControl>()) {
return EmitType(out, ac->type(), name);
}
if (auto* alias = type->As<ast::type::Alias>()) {
out << namer_.NameFor(module_->SymbolToName(alias->symbol()));
} else if (auto* ary = type->As<ast::type::Array>()) {
ast::type::Type* base_type = ary;
std::vector<uint32_t> sizes;
while (auto* arr = base_type->As<ast::type::Array>()) {
if (arr->IsRuntimeArray()) {
// TODO(dsinclair): Support runtime arrays
// https://bugs.chromium.org/p/tint/issues/detail?id=185
error_ = "runtime array not supported yet.";
return false;
} else {
sizes.push_back(arr->size());
}
base_type = arr->type();
}
if (!EmitType(out, base_type, "")) {
return false;
}
if (!name.empty()) {
out << " " << namer_.NameFor(name);
}
for (uint32_t size : sizes) {
out << "[" << size << "]";
}
} else if (type->Is<ast::type::Bool>()) {
out << "bool";
} else if (type->Is<ast::type::F32>()) {
out << "float";
} else if (type->Is<ast::type::I32>()) {
out << "int";
} else if (auto* mat = type->As<ast::type::Matrix>()) {
if (!EmitType(out, mat->type(), "")) {
return false;
}
out << mat->rows() << "x" << mat->columns();
} else if (type->Is<ast::type::Pointer>()) {
// TODO(dsinclair): What do we do with pointers in HLSL?
// https://bugs.chromium.org/p/tint/issues/detail?id=183
error_ = "pointers not supported in HLSL";
return false;
} else if (auto* sampler = type->As<ast::type::Sampler>()) {
out << "Sampler";
if (sampler->IsComparison()) {
out << "Comparison";
}
out << "State";
} else if (auto* str = type->As<ast::type::Struct>()) {
out << module_->SymbolToName(str->symbol());
} else if (auto* tex = type->As<ast::type::Texture>()) {
if (tex->Is<ast::type::StorageTexture>()) {
out << "RW";
}
out << "Texture";
switch (tex->dim()) {
case ast::type::TextureDimension::k1d:
out << "1D";
break;
case ast::type::TextureDimension::k1dArray:
out << "1DArray";
break;
case ast::type::TextureDimension::k2d:
out << "2D";
break;
case ast::type::TextureDimension::k2dArray:
out << "2DArray";
break;
case ast::type::TextureDimension::k3d:
out << "3D";
break;
case ast::type::TextureDimension::kCube:
out << "Cube";
break;
case ast::type::TextureDimension::kCubeArray:
out << "CubeArray";
break;
default:
error_ = "Invalid texture dimensions";
return false;
}
if (auto* st = tex->As<ast::type::StorageTexture>()) {
auto* component = image_format_to_rwtexture_type(st->image_format());
if (component == nullptr) {
error_ = "Unsupported StorageTexture ImageFormat: " +
std::to_string(static_cast<int>(st->image_format()));
return false;
}
out << "<" << component << ">";
}
} else if (type->Is<ast::type::U32>()) {
out << "uint";
} else if (auto* vec = type->As<ast::type::Vector>()) {
auto size = vec->size();
if (vec->type()->Is<ast::type::F32>() && size >= 1 && size <= 4) {
out << "float" << size;
} else if (vec->type()->Is<ast::type::I32>() && size >= 1 && size <= 4) {
out << "int" << size;
} else if (vec->type()->Is<ast::type::U32>() && size >= 1 && size <= 4) {
out << "uint" << size;
} else {
out << "vector<";
if (!EmitType(out, vec->type(), "")) {
return false;
}
out << ", " << size << ">";
}
} else if (type->Is<ast::type::Void>()) {
out << "void";
} else {
error_ = "unknown type in EmitType";
return false;
}
return true;
}
bool GeneratorImpl::EmitStructType(std::ostream& out,
const ast::type::Struct* str,
const std::string& name) {
// TODO(dsinclair): Block decoration?
// if (str->impl()->decoration() != ast::StructDecoration::kNone) {
// }
out << "struct " << name << " {" << std::endl;
increment_indent();
for (auto* mem : str->impl()->members()) {
make_indent(out);
// TODO(dsinclair): Handle [[offset]] annotation on structs
// https://bugs.chromium.org/p/tint/issues/detail?id=184
if (!EmitType(out, mem->type(), module_->SymbolToName(mem->symbol()))) {
return false;
}
// Array member name will be output with the type
if (!mem->type()->Is<ast::type::Array>()) {
out << " " << namer_.NameFor(module_->SymbolToName(mem->symbol()));
}
out << ";" << std::endl;
}
decrement_indent();
make_indent(out);
out << "};" << std::endl;
return true;
}
bool GeneratorImpl::EmitUnaryOp(std::ostream& pre,
std::ostream& out,
ast::UnaryOpExpression* expr) {
switch (expr->op()) {
case ast::UnaryOp::kNot:
out << "!";
break;
case ast::UnaryOp::kNegation:
out << "-";
break;
}
out << "(";
if (!EmitExpression(pre, out, expr->expr())) {
return false;
}
out << ")";
return true;
}
bool GeneratorImpl::EmitVariable(std::ostream& out,
ast::Variable* var,
bool skip_constructor) {
make_indent(out);
// TODO(dsinclair): Handle variable decorations
if (!var->decorations().empty()) {
error_ = "Variable decorations are not handled yet";
return false;
}
std::ostringstream constructor_out;
if (!skip_constructor && var->constructor() != nullptr) {
constructor_out << " = ";
std::ostringstream pre;
if (!EmitExpression(pre, constructor_out, var->constructor())) {
return false;
}
out << pre.str();
}
if (var->is_const()) {
out << "const ";
}
if (!EmitType(out, var->type(), module_->SymbolToName(var->symbol()))) {
return false;
}
if (!var->type()->Is<ast::type::Array>()) {
out << " " << module_->SymbolToName(var->symbol());
}
out << constructor_out.str() << ";" << std::endl;
return true;
}
bool GeneratorImpl::EmitProgramConstVariable(std::ostream& out,
const ast::Variable* var) {
make_indent(out);
for (auto* d : var->decorations()) {
if (!d->Is<ast::ConstantIdDecoration>()) {
error_ = "Decorated const values not valid";
return false;
}
}
if (!var->is_const()) {
error_ = "Expected a const value";
return false;
}
std::ostringstream constructor_out;
if (var->constructor() != nullptr) {
std::ostringstream pre;
if (!EmitExpression(pre, constructor_out, var->constructor())) {
return false;
}
out << pre.str();
}
if (var->HasConstantIdDecoration()) {
auto const_id = var->constant_id();
out << "#ifndef WGSL_SPEC_CONSTANT_" << const_id << std::endl;
if (var->constructor() != nullptr) {
out << "#define WGSL_SPEC_CONSTANT_" << const_id << " "
<< constructor_out.str() << std::endl;
} else {
out << "#error spec constant required for constant id " << const_id
<< std::endl;
}
out << "#endif" << std::endl;
out << "static const ";
if (!EmitType(out, var->type(), module_->SymbolToName(var->symbol()))) {
return false;
}
out << " " << module_->SymbolToName(var->symbol())
<< " = WGSL_SPEC_CONSTANT_" << const_id << ";" << std::endl;
out << "#undef WGSL_SPEC_CONSTANT_" << const_id << std::endl;
} else {
out << "static const ";
if (!EmitType(out, var->type(), module_->SymbolToName(var->symbol()))) {
return false;
}
if (!var->type()->Is<ast::type::Array>()) {
out << " " << module_->SymbolToName(var->symbol());
}
if (var->constructor() != nullptr) {
out << " = " << constructor_out.str();
}
out << ";" << std::endl;
}
return true;
}
std::string GeneratorImpl::get_buffer_name(ast::Expression* expr) {
for (;;) {
if (auto* ident = expr->As<ast::IdentifierExpression>()) {
return module_->SymbolToName(ident->symbol());
} else if (auto* member = expr->As<ast::MemberAccessorExpression>()) {
expr = member->structure();
} else if (auto* array = expr->As<ast::ArrayAccessorExpression>()) {