mesa/src/gallium/frontends/clover/nir/invocation.cpp
Caio Oliveira 6a4156f812 clover: Remove usage of glsl_type C++ helpers
Preparation for removing the C++ helpers from glsl_type.

Reviewed-by: Karol Herbst <kherbst@redhat.com>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/26671>
2023-12-13 19:52:24 +00:00

473 lines
17 KiB
C++

//
// Copyright 2019 Karol Herbst
//
// Permission is hereby granted, free of charge, to any person obtaining a
// copy of this software and associated documentation files (the "Software"),
// to deal in the Software without restriction, including without limitation
// the rights to use, copy, modify, merge, publish, distribute, sublicense,
// and/or sell copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
// OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
// ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
// OTHER DEALINGS IN THE SOFTWARE.
//
#include "invocation.hpp"
#include <tuple>
#include "core/device.hpp"
#include "core/error.hpp"
#include "core/binary.hpp"
#include "pipe/p_state.h"
#include "util/algorithm.hpp"
#include "util/functional.hpp"
#include <compiler/glsl_types.h>
#include <compiler/clc/nir_clc_helpers.h>
#include <compiler/nir/nir_builder.h>
#include <compiler/nir/nir_serialize.h>
#include <compiler/spirv/nir_spirv.h>
#include <util/u_math.h>
#include <util/hex.h>
using namespace clover;
#ifdef HAVE_CLOVER_SPIRV
// Refs and unrefs the glsl_type_singleton.
static class glsl_type_ref {
public:
glsl_type_ref() {
glsl_type_singleton_init_or_ref();
}
~glsl_type_ref() {
glsl_type_singleton_decref();
}
} glsl_type_ref;
static const nir_shader_compiler_options *
dev_get_nir_compiler_options(const device &dev)
{
const void *co = dev.get_compiler_options(PIPE_SHADER_IR_NIR);
return static_cast<const nir_shader_compiler_options*>(co);
}
static void debug_function(void *private_data,
enum nir_spirv_debug_level level, size_t spirv_offset,
const char *message)
{
assert(private_data);
auto r_log = reinterpret_cast<std::string *>(private_data);
*r_log += message;
}
static void
clover_arg_size_align(const glsl_type *type, unsigned *size, unsigned *align)
{
if (glsl_type_is_sampler(type) || glsl_type_is_image(type)) {
*size = 0;
*align = 1;
} else {
*size = glsl_get_cl_size(type);
*align = glsl_get_cl_alignment(type);
}
}
static void
clover_nir_add_image_uniforms(nir_shader *shader)
{
/* Clover expects each image variable to take up a cl_mem worth of space in
* the arguments data. Add uniforms as needed to match this expectation.
*/
nir_foreach_image_variable_safe(var, shader) {
nir_variable *uniform = rzalloc(shader, nir_variable);
uniform->name = ralloc_strdup(uniform, var->name);
uniform->type = glsl_uintN_t_type(sizeof(cl_mem) * 8);
uniform->data.mode = nir_var_uniform;
uniform->data.read_only = true;
uniform->data.location = var->data.location;
exec_node_insert_node_before(&var->node, &uniform->node);
}
}
struct clover_lower_nir_state {
std::vector<binary::argument> &args;
uint32_t global_dims;
nir_variable *constant_var;
nir_variable *printf_buffer;
nir_variable *offset_vars[3];
};
static bool
clover_lower_nir_filter(const nir_instr *instr, const void *)
{
return instr->type == nir_instr_type_intrinsic;
}
static nir_def *
clover_lower_nir_instr(nir_builder *b, nir_instr *instr, void *_state)
{
clover_lower_nir_state *state = reinterpret_cast<clover_lower_nir_state*>(_state);
nir_intrinsic_instr *intrinsic = nir_instr_as_intrinsic(instr);
switch (intrinsic->intrinsic) {
case nir_intrinsic_load_printf_buffer_address: {
if (!state->printf_buffer) {
unsigned location = state->args.size();
state->args.emplace_back(binary::argument::global, sizeof(size_t),
8, 8, binary::argument::zero_ext,
binary::argument::printf_buffer);
const glsl_type *type = glsl_uint64_t_type();
state->printf_buffer = nir_variable_create(b->shader, nir_var_uniform,
type, "global_printf_buffer");
state->printf_buffer->data.location = location;
}
return nir_load_var(b, state->printf_buffer);
}
case nir_intrinsic_load_base_global_invocation_id: {
nir_def *loads[3];
/* create variables if we didn't do so alrady */
if (!state->offset_vars[0]) {
/* TODO: fix for 64 bit */
/* Even though we only place one scalar argument, clover will bind up to
* three 32 bit values
*/
unsigned location = state->args.size();
state->args.emplace_back(binary::argument::scalar, 4, 4, 4,
binary::argument::zero_ext,
binary::argument::grid_offset);
const glsl_type *type = glsl_uint_type();
for (uint32_t i = 0; i < 3; i++) {
state->offset_vars[i] =
nir_variable_create(b->shader, nir_var_uniform, type,
"global_invocation_id_offsets");
state->offset_vars[i]->data.location = location + i;
}
}
for (int i = 0; i < 3; i++) {
nir_variable *var = state->offset_vars[i];
loads[i] = var ? nir_load_var(b, var) : nir_imm_int(b, 0);
}
return nir_u2uN(b, nir_vec(b, loads, state->global_dims),
intrinsic->def.bit_size);
}
case nir_intrinsic_load_constant_base_ptr: {
return nir_load_var(b, state->constant_var);
}
default:
return NULL;
}
}
static bool
clover_lower_nir(nir_shader *nir, std::vector<binary::argument> &args,
uint32_t dims, uint32_t pointer_bit_size)
{
nir_variable *constant_var = NULL;
if (nir->constant_data_size) {
const glsl_type *type = pointer_bit_size == 64 ? glsl_uint64_t_type() : glsl_uint_type();
constant_var = nir_variable_create(nir, nir_var_uniform, type,
"constant_buffer_addr");
constant_var->data.location = args.size();
args.emplace_back(binary::argument::global, sizeof(cl_mem),
pointer_bit_size / 8, pointer_bit_size / 8,
binary::argument::zero_ext,
binary::argument::constant_buffer);
}
clover_lower_nir_state state = { args, dims, constant_var };
return nir_shader_lower_instructions(nir,
clover_lower_nir_filter, clover_lower_nir_instr, &state);
}
static spirv_to_nir_options
create_spirv_options(const device &dev, std::string &r_log)
{
struct spirv_to_nir_options spirv_options = {};
spirv_options.environment = NIR_SPIRV_OPENCL;
if (dev.address_bits() == 32u) {
spirv_options.shared_addr_format = nir_address_format_32bit_offset;
spirv_options.global_addr_format = nir_address_format_32bit_global;
spirv_options.temp_addr_format = nir_address_format_32bit_offset;
spirv_options.constant_addr_format = nir_address_format_32bit_global;
} else {
spirv_options.shared_addr_format = nir_address_format_32bit_offset_as_64bit;
spirv_options.global_addr_format = nir_address_format_64bit_global;
spirv_options.temp_addr_format = nir_address_format_32bit_offset_as_64bit;
spirv_options.constant_addr_format = nir_address_format_64bit_global;
}
spirv_options.caps.address = true;
spirv_options.caps.float64 = true;
spirv_options.caps.int8 = true;
spirv_options.caps.int16 = true;
spirv_options.caps.int64 = true;
spirv_options.caps.kernel = true;
spirv_options.caps.kernel_image = dev.image_support();
spirv_options.caps.int64_atomics = dev.has_int64_atomics();
spirv_options.debug.func = &debug_function;
spirv_options.debug.private_data = &r_log;
spirv_options.caps.printf = true;
return spirv_options;
}
struct disk_cache *clover::nir::create_clc_disk_cache(void)
{
struct mesa_sha1 ctx;
unsigned char sha1[20];
char cache_id[20 * 2 + 1];
_mesa_sha1_init(&ctx);
if (!disk_cache_get_function_identifier((void *)clover::nir::create_clc_disk_cache, &ctx))
return NULL;
_mesa_sha1_final(&ctx, sha1);
mesa_bytes_to_hex(cache_id, sha1, 20);
return disk_cache_create("clover-clc", cache_id, 0);
}
void clover::nir::check_for_libclc(const device &dev)
{
if (!nir_can_find_libclc(dev.address_bits()))
throw error(CL_COMPILER_NOT_AVAILABLE);
}
nir_shader *clover::nir::load_libclc_nir(const device &dev, std::string &r_log)
{
spirv_to_nir_options spirv_options = create_spirv_options(dev, r_log);
auto *compiler_options = dev_get_nir_compiler_options(dev);
return nir_load_libclc_shader(dev.address_bits(), dev.clc_cache,
&spirv_options, compiler_options,
dev.clc_cache != nullptr);
}
static bool
can_remove_var(nir_variable *var, void *data)
{
return !(glsl_type_is_sampler(var->type) ||
glsl_type_is_texture(var->type) ||
glsl_type_is_image(var->type));
}
binary clover::nir::spirv_to_nir(const binary &mod, const device &dev,
std::string &r_log)
{
spirv_to_nir_options spirv_options = create_spirv_options(dev, r_log);
std::shared_ptr<nir_shader> nir = dev.clc_nir;
spirv_options.clc_shader = nir.get();
binary b;
// We only insert one section.
assert(mod.secs.size() == 1);
auto &section = mod.secs[0];
binary::resource_id section_id = 0;
for (const auto &sym : mod.syms) {
assert(sym.section == 0);
const auto *binary =
reinterpret_cast<const pipe_binary_program_header *>(section.data.data());
const uint32_t *data = reinterpret_cast<const uint32_t *>(binary->blob);
const size_t num_words = binary->num_bytes / 4;
const char *name = sym.name.c_str();
auto *compiler_options = dev_get_nir_compiler_options(dev);
nir_shader *nir = spirv_to_nir(data, num_words, nullptr, 0,
MESA_SHADER_KERNEL, name,
&spirv_options, compiler_options);
if (!nir) {
r_log += "Translation from SPIR-V to NIR for kernel \"" + sym.name +
"\" failed.\n";
throw build_error();
}
nir->info.workgroup_size_variable = sym.reqd_work_group_size[0] == 0;
nir->info.workgroup_size[0] = sym.reqd_work_group_size[0];
nir->info.workgroup_size[1] = sym.reqd_work_group_size[1];
nir->info.workgroup_size[2] = sym.reqd_work_group_size[2];
nir_validate_shader(nir, "clover");
// Inline all functions first.
// according to the comment on nir_inline_functions
NIR_PASS_V(nir, nir_lower_variable_initializers, nir_var_function_temp);
NIR_PASS_V(nir, nir_lower_returns);
NIR_PASS_V(nir, nir_link_shader_functions, spirv_options.clc_shader);
NIR_PASS_V(nir, nir_inline_functions);
NIR_PASS_V(nir, nir_copy_prop);
NIR_PASS_V(nir, nir_opt_deref);
// Pick off the single entrypoint that we want.
nir_remove_non_entrypoints(nir);
nir_validate_shader(nir, "clover after function inlining");
NIR_PASS_V(nir, nir_lower_variable_initializers, ~nir_var_function_temp);
struct nir_lower_printf_options printf_options;
printf_options.treat_doubles_as_floats = false;
printf_options.max_buffer_size = dev.max_printf_buffer_size();
NIR_PASS_V(nir, nir_lower_printf, &printf_options);
NIR_PASS_V(nir, nir_remove_dead_variables, nir_var_function_temp, NULL);
// copy propagate to prepare for lower_explicit_io
NIR_PASS_V(nir, nir_split_var_copies);
NIR_PASS_V(nir, nir_opt_copy_prop_vars);
NIR_PASS_V(nir, nir_lower_var_copies);
NIR_PASS_V(nir, nir_lower_vars_to_ssa);
NIR_PASS_V(nir, nir_opt_dce);
NIR_PASS_V(nir, nir_lower_convert_alu_types, NULL);
if (compiler_options->lower_to_scalar) {
NIR_PASS_V(nir, nir_lower_alu_to_scalar,
compiler_options->lower_to_scalar_filter, NULL);
}
NIR_PASS_V(nir, nir_lower_system_values);
nir_lower_compute_system_values_options sysval_options = { 0 };
sysval_options.has_base_global_invocation_id = true;
NIR_PASS_V(nir, nir_lower_compute_system_values, &sysval_options);
// constant fold before lowering mem constants
NIR_PASS_V(nir, nir_opt_constant_folding);
NIR_PASS_V(nir, nir_remove_dead_variables, nir_var_mem_constant, NULL);
NIR_PASS_V(nir, nir_lower_vars_to_explicit_types, nir_var_mem_constant,
glsl_get_cl_type_size_align);
if (nir->constant_data_size > 0) {
assert(nir->constant_data == NULL);
nir->constant_data = rzalloc_size(nir, nir->constant_data_size);
nir_gather_explicit_io_initializers(nir, nir->constant_data,
nir->constant_data_size,
nir_var_mem_constant);
}
NIR_PASS_V(nir, nir_lower_explicit_io, nir_var_mem_constant,
spirv_options.constant_addr_format);
auto args = sym.args;
NIR_PASS_V(nir, clover_lower_nir, args, dev.max_block_size().size(),
dev.address_bits());
NIR_PASS_V(nir, clover_nir_add_image_uniforms);
NIR_PASS_V(nir, nir_lower_vars_to_explicit_types,
nir_var_uniform, clover_arg_size_align);
NIR_PASS_V(nir, nir_lower_vars_to_explicit_types,
nir_var_mem_shared | nir_var_mem_global |
nir_var_function_temp,
glsl_get_cl_type_size_align);
NIR_PASS_V(nir, nir_opt_deref);
NIR_PASS_V(nir, nir_lower_readonly_images_to_tex, false);
NIR_PASS_V(nir, nir_lower_cl_images, true, true);
NIR_PASS_V(nir, nir_lower_memcpy);
/* use offsets for kernel inputs (uniform) */
NIR_PASS_V(nir, nir_lower_explicit_io, nir_var_uniform,
nir->info.cs.ptr_size == 64 ?
nir_address_format_32bit_offset_as_64bit :
nir_address_format_32bit_offset);
NIR_PASS_V(nir, nir_lower_explicit_io, nir_var_mem_constant,
spirv_options.constant_addr_format);
NIR_PASS_V(nir, nir_lower_explicit_io, nir_var_mem_shared,
spirv_options.shared_addr_format);
NIR_PASS_V(nir, nir_lower_explicit_io, nir_var_function_temp,
spirv_options.temp_addr_format);
NIR_PASS_V(nir, nir_lower_explicit_io, nir_var_mem_global,
spirv_options.global_addr_format);
struct nir_remove_dead_variables_options remove_dead_variables_options = {};
remove_dead_variables_options.can_remove_var = can_remove_var;
NIR_PASS_V(nir, nir_remove_dead_variables, nir_var_all, &remove_dead_variables_options);
if (compiler_options->lower_int64_options)
NIR_PASS_V(nir, nir_lower_int64);
NIR_PASS_V(nir, nir_opt_dce);
if (nir->constant_data_size) {
const char *ptr = reinterpret_cast<const char *>(nir->constant_data);
const binary::section constants {
section_id,
binary::section::data_constant,
nir->constant_data_size,
{ ptr, ptr + nir->constant_data_size }
};
nir->constant_data = NULL;
nir->constant_data_size = 0;
b.secs.push_back(constants);
}
void *mem_ctx = ralloc_context(NULL);
unsigned printf_info_count = nir->printf_info_count;
u_printf_info *printf_infos = nir->printf_info;
ralloc_steal(mem_ctx, printf_infos);
struct blob blob;
blob_init(&blob);
nir_serialize(&blob, nir, false);
ralloc_free(nir);
const pipe_binary_program_header header { uint32_t(blob.size) };
binary::section text { section_id, binary::section::text_executable, header.num_bytes, {} };
text.data.insert(text.data.end(), reinterpret_cast<const char *>(&header),
reinterpret_cast<const char *>(&header) + sizeof(header));
text.data.insert(text.data.end(), blob.data, blob.data + blob.size);
free(blob.data);
b.printf_strings_in_buffer = false;
b.printf_infos.reserve(printf_info_count);
for (unsigned i = 0; i < printf_info_count; i++) {
binary::printf_info info;
info.arg_sizes.reserve(printf_infos[i].num_args);
for (unsigned j = 0; j < printf_infos[i].num_args; j++)
info.arg_sizes.push_back(printf_infos[i].arg_sizes[j]);
info.strings.resize(printf_infos[i].string_size);
memcpy(info.strings.data(), printf_infos[i].strings, printf_infos[i].string_size);
b.printf_infos.push_back(info);
}
ralloc_free(mem_ctx);
b.syms.emplace_back(sym.name, sym.attributes,
sym.reqd_work_group_size, section_id, 0, args);
b.secs.push_back(text);
section_id++;
}
return b;
}
#else
binary clover::nir::spirv_to_nir(const binary &mod, const device &dev, std::string &r_log)
{
r_log += "SPIR-V support in clover is not enabled.\n";
throw error(CL_LINKER_NOT_AVAILABLE);
}
#endif