KytyPS5/src/graphics/shader/recompiler/ir/passes/ShaderInfoCollection.cpp

#include "graphics/shader/recompiler/ir/passes/ShaderInfoCollection.h"

#include "graphics/shader/recompiler/ir/ShaderIR.h"

#include <algorithm>
#include <fmt/format.h>

namespace Libs::Graphics::ShaderRecompiler::IR {
namespace {

void AddInput(ShaderInfo& info, StageInputKind kind, uint32_t location, uint32_t components,
              std::string name, bool per_vertex = false) {
	const auto input = std::find_if(info.inputs.begin(), info.inputs.end(), [=](const auto& value) {
		return value.kind == kind && value.location == location;
	});
	if (input == info.inputs.end()) {
		info.inputs.push_back({kind, location, components, std::move(name), per_vertex});
	} else {
		input->component_count = std::max(input->component_count, components);
		input->per_vertex      = input->per_vertex || per_vertex;
	}
}

bool HasOutput(const ShaderInfo& info, StageOutputKind kind, uint32_t index) {
	return std::any_of(info.outputs.begin(), info.outputs.end(), [=](const auto& output) {
		return output.kind == kind && output.index == index;
	});
}

void AddOutput(ShaderInfo& info, StageOutputKind kind, uint32_t index, uint32_t location,
               std::string name) {
	if (!HasOutput(info, kind, index)) {
		info.outputs.push_back({kind, index, location, std::move(name)});
	}
}

bool ValidateOptions(const Program& program, const ShaderInfoOptions& options, std::string* error) {
	auto Fail = [&](const char* message) {
		if (error != nullptr) {
			*error = message;
		}
		return false;
	};
	switch (program.stage) {
		case ShaderType::Vertex:
			if (options.vertex->resources_num < 0 ||
			    options.vertex->resources_num > ShaderVertexInputInfo::RES_MAX) {
				return Fail("vertex resource count is out of range");
			}
			return true;
		case ShaderType::Pixel:
			return options.pixel->input_num <= std::size(options.pixel->interpolator_settings) ||
			       Fail("pixel input count is out of range");
		case ShaderType::Compute:
			return (options.compute->thread_ids_num >= 0 && options.compute->thread_ids_num <= 3) ||
			       Fail("compute thread ID count is out of range");
		default: return Fail("unsupported shader stage for info collection");
	}
}

bool ValidateValueReferences(const Program& program, const ShaderInfoOptions& options,
                             std::string* error) {
	const auto Fail = [&](const char* message) {
		if (error != nullptr) {
			*error = message;
		}
		return false;
	};
	for (const auto* block: program.blocks) {
		for (const auto& inst: *block) {
			switch (inst.GetOpcode()) {
				case ValueOpcode::GetAttribute: {
					if (!inst.Arg(0).IsImmediate() || inst.Arg(0).GetType() != Type::U32 ||
					    !inst.Arg(1).IsImmediate() || inst.Arg(1).GetType() != Type::U32) {
						return Fail("typed attribute reference is not constant");
					}
					if (program.stage == ShaderType::Vertex &&
					    (inst.Arg(1).U32() >= 4u ||
					     inst.Arg(0).U32() >=
					         static_cast<uint32_t>(options.vertex->resources_num))) {
						return Fail("vertex input reference is out of range");
					}
					if (program.stage == ShaderType::Pixel &&
					    (inst.Arg(1).U32() >= 4u ||
					     inst.Arg(0).U32() >= options.pixel->input_num)) {
						return Fail("pixel input reference is out of range");
					}
					break;
				}
				case ValueOpcode::GetInterpolationParameter: {
					if (program.stage != ShaderType::Pixel || !inst.Arg(0).IsImmediate() ||
					    inst.Arg(0).GetType() != Type::U32 || !inst.Arg(1).IsImmediate() ||
					    inst.Arg(1).GetType() != Type::U32 || !inst.Arg(2).IsImmediate() ||
					    inst.Arg(2).GetType() != Type::U32) {
						return Fail("interpolation parameter reference is invalid");
					}
					if (inst.Arg(0).U32() >= options.pixel->input_num || inst.Arg(1).U32() >= 4u ||
					    inst.Arg(2).U32() >= 3u) {
						return Fail("interpolation parameter reference is out of range");
					}
					break;
				}
				case ValueOpcode::GetBuiltin: {
					if (!inst.Arg(0).IsImmediate() || inst.Arg(0).GetType() != Type::U32 ||
					    !inst.Arg(1).IsImmediate() || inst.Arg(1).GetType() != Type::U32) {
						return Fail("typed builtin reference is not constant");
					}
					const auto kind      = static_cast<StageInputKind>(inst.Arg(0).U32());
					const auto component = inst.Arg(1).U32();
					switch (kind) {
						case StageInputKind::VertexIndex:
						case StageInputKind::InstanceIndex:
						case StageInputKind::FrontFacing:
						case StageInputKind::LocalInvocationIndex:
							if (component != 0u) {
								return Fail("typed scalar builtin component is out of range");
							}
							break;
						case StageInputKind::FragCoord:
							if (component >= 4u) {
								return Fail("typed fragment-coordinate component is out of range");
							}
							break;
						case StageInputKind::BaryCoordSmooth:
						case StageInputKind::BaryCoordNoPerspective:
							if (component >= 2u) {
								return Fail("typed barycentric component is out of range");
							}
							break;
						case StageInputKind::WorkgroupId:
						case StageInputKind::LocalInvocationId:
						case StageInputKind::GlobalInvocationId:
							if (component >= 3u) {
								return Fail("typed invocation builtin component is out of range");
							}
							break;
						case StageInputKind::Parameter:
						default: return Fail("typed builtin kind is invalid");
					}
					break;
				}
				case ValueOpcode::SetAttribute:
					if (inst.Flags<ExportFlags>().index >= program.export_info.size()) {
						return Fail("typed export metadata index is out of range");
					}
					break;
				default: break;
			}
		}
	}
	return true;
}

void CollectVertexInputs(const Program& program, const ShaderVertexInputInfo* vertex,
                         ShaderInfo& info) {
	AddInput(info, StageInputKind::VertexIndex, 0, 1, "gl_VertexIndex");
	AddInput(info, StageInputKind::InstanceIndex, 0, 1, "gl_InstanceIndex");
	uint32_t used_components[ShaderVertexInputInfo::RES_MAX] = {};
	for (const auto* block: program.blocks) {
		for (const auto& inst: *block) {
			if (inst.GetOpcode() == ValueOpcode::GetAttribute) {
				const auto attr       = inst.Arg(0).U32();
				const auto chan       = inst.Arg(1).U32();
				used_components[attr] = std::max(used_components[attr], chan + 1u);
			}
		}
	}
	for (uint32_t attr = 0; attr < static_cast<uint32_t>(vertex->resources_num) &&
	                        attr < ShaderVertexInputInfo::RES_MAX;
	     attr++) {
		if (used_components[attr] != 0) {
			AddInput(info, StageInputKind::Parameter, attr, used_components[attr],
			         fmt::format("in_attr_{}", attr));
		}
	}
}

void CollectPixelInputs(const Program& program, const ShaderPixelInputInfo* pixel,
                        ShaderInfo& info) {
	if (pixel->HasPositionInput()) {
		AddInput(info, StageInputKind::FragCoord, 0, 4, "gl_FragCoord");
	}
	if (pixel->ps_front_face) {
		AddInput(info, StageInputKind::FrontFacing, 0, 1, "gl_FrontFacing");
	}
	std::array<bool, 32> per_vertex {};
	std::array<bool, 32> interpolated {};
	for (const auto* block: program.blocks) {
		for (const auto& inst: *block) {
			if (inst.GetOpcode() == ValueOpcode::GetAttribute) {
				interpolated[inst.Arg(0).U32()] = true;
			} else if (inst.GetOpcode() == ValueOpcode::GetInterpolationParameter) {
				const auto input = inst.Arg(0).U32();
				const auto mode  = inst.Arg(2).U32();
				per_vertex[input] =
				    per_vertex[input] || mode < 2u || !ShaderPixelParameterIsFlat(*pixel, input);
			}
		}
	}
	for (uint32_t input = 0; input < pixel->input_num; input++) {
		AddInput(info, StageInputKind::Parameter, input, 4, fmt::format("in_param_{}", input),
		         per_vertex[input]);
	}
	for (uint32_t input = 0; input < pixel->input_num; input++) {
		if (interpolated[input] && per_vertex[input]) {
			const auto kind = pixel->ps_no_perspective ? StageInputKind::BaryCoordNoPerspective
			                                           : StageInputKind::BaryCoordSmooth;
			AddInput(info, kind, 0, 3,
			         pixel->ps_no_perspective ? "gl_BaryCoordNoPerspKHR" : "gl_BaryCoordKHR");
			break;
		}
	}
}

void CollectComputeInputs(const ShaderComputeInputInfo* compute, ShaderInfo& info) {
	if (compute->group_id[0] || compute->group_id[1] || compute->group_id[2]) {
		AddInput(info, StageInputKind::WorkgroupId, 0, 3, "gl_WorkGroupID");
	}
	if (compute->thread_ids_num > 0) {
		AddInput(info, StageInputKind::LocalInvocationId, 0, 3, "gl_LocalInvocationID");
	}
	if (compute->thread_ids_num > 0 || compute->tg_size_en) {
		AddInput(info, StageInputKind::LocalInvocationIndex, 0, 1, "gl_LocalInvocationIndex");
	}
	if (compute->dispatch_thread_dimensions) {
		AddInput(info, StageInputKind::GlobalInvocationId, 0, 3, "gl_GlobalInvocationID");
	}
}

void CollectBuiltinInputs(const Program& program, ShaderInfo& info) {
	for (const auto* block: program.blocks) {
		for (const auto& inst: *block) {
			if (inst.GetOpcode() != ValueOpcode::GetBuiltin) {
				continue;
			}
			const auto kind = static_cast<StageInputKind>(inst.Arg(0).U32());
			switch (kind) {
				case StageInputKind::VertexIndex:
					AddInput(info, kind, 0, 1, "gl_VertexIndex");
					break;
				case StageInputKind::InstanceIndex:
					AddInput(info, kind, 0, 1, "gl_InstanceIndex");
					break;
				case StageInputKind::FragCoord: AddInput(info, kind, 0, 4, "gl_FragCoord"); break;
				case StageInputKind::FrontFacing:
					AddInput(info, kind, 0, 1, "gl_FrontFacing");
					break;
				case StageInputKind::BaryCoordSmooth:
					AddInput(info, kind, 0, 3, "gl_BaryCoordKHR");
					break;
				case StageInputKind::BaryCoordNoPerspective:
					AddInput(info, kind, 0, 3, "gl_BaryCoordNoPerspKHR");
					break;
				case StageInputKind::WorkgroupId:
					AddInput(info, kind, 0, 3, "gl_WorkGroupID");
					break;
				case StageInputKind::LocalInvocationId:
					AddInput(info, kind, 0, 3, "gl_LocalInvocationID");
					break;
				case StageInputKind::LocalInvocationIndex:
					AddInput(info, kind, 0, 1, "gl_LocalInvocationIndex");
					break;
				case StageInputKind::GlobalInvocationId:
					AddInput(info, kind, 0, 3, "gl_GlobalInvocationID");
					break;
				case StageInputKind::Parameter: break;
			}
		}
	}
}

bool CollectOutputs(const Program& program, const ShaderVertexInputInfo* vertex,
	                const ShaderPixelInputInfo* pixel, ShaderInfo& info, std::string* error) {
	auto Fail = [&](std::string message) {
		if (error != nullptr) {
			*error = std::move(message);
		}
		return false;
	};
	for (const auto* block: program.blocks) {
		for (const auto& inst: *block) {
			if (inst.GetOpcode() != ValueOpcode::SetAttribute) {
				continue;
			}
			const auto& export_info = program.export_info[inst.Flags<ExportFlags>().index];
			if (export_info.kind == ExportTargetKind::MrtZ) {
				if (program.stage == ShaderType::Pixel && (export_info.en & 0x1u) != 0 &&
				    pixel->ps_depth_export_enable) {
					AddOutput(info, StageOutputKind::Depth, 0, 0, "gl_FragDepth");
				}
				if (program.stage == ShaderType::Pixel && (export_info.en & 0x4u) != 0 &&
				    pixel->ps_sample_mask_export_enable) {
					AddOutput(info, StageOutputKind::SampleMask, 0, 0, "gl_SampleMask");
				}
				continue;
			}
			if (export_info.en == 0) {
				continue;
			}
			switch (export_info.kind) {
				case ExportTargetKind::Position:
					if (export_info.index == 0) {
						AddOutput(info, StageOutputKind::Position, 0, 0, "out_position");
						break;
					}
					if (export_info.compr) {
						return Fail("compressed auxiliary position export is unsupported");
					}
					for (uint32_t component = 0; component < 4; component++) {
						if ((export_info.en & (1u << component)) == 0) {
							continue;
						}
						const auto output = DecodePositionExportComponent(
						    vertex->pa_cl_vs_out_cntl, export_info.index, component);
						if (!output.valid) {
							return Fail(fmt::format("unsupported POS{} auxiliary/stereo export",
							                        export_info.index));
						}
						if (output.viewport) {
							return Fail("vertex viewport-index export is unsupported");
						}
						if (output.point_size) {
							AddOutput(info, StageOutputKind::PointSize, 0, 0, "gl_PointSize");
						}
						if (output.layer) {
							AddOutput(info, StageOutputKind::Layer, 0, 0, "gl_Layer");
						}
						if (output.clip_distance != UINT32_MAX) {
							AddOutput(info, StageOutputKind::ClipDistance, output.clip_distance, 0,
							          "gl_ClipDistance");
						}
						if (output.cull_distance != UINT32_MAX) {
							AddOutput(info, StageOutputKind::CullDistance, output.cull_distance, 0,
							          "gl_CullDistance");
						}
					}
					break;
				case ExportTargetKind::Parameter:
					AddOutput(info, StageOutputKind::Parameter, export_info.index,
					          export_info.index, fmt::format("out_param_{}", export_info.index));
					break;
				case ExportTargetKind::Mrt:
					AddOutput(info, StageOutputKind::Mrt, export_info.index, export_info.index,
					          fmt::format("out_mrt_{}", export_info.index));
					break;
				default: break;
			}
		}
	}
	return true;
}

} // namespace

bool CollectShaderInfo(Program& program, const ShaderInfoOptions& options, std::string* error) {
	if (!program.resource_tracking_complete || program.shader_info_complete) {
		if (error != nullptr) {
			*error = !program.resource_tracking_complete ? "shader resources were not tracked"
			                                             : "shader info already collected";
		}
		return false;
	}
	if (!ValidateOptions(program, options, error)) {
		return false;
	}
	if (!ValidateValueReferences(program, options, error)) {
		return false;
	}

	auto next = program.info;
	next.inputs.clear();
	next.outputs.clear();
	next.has_bitwise_xor = std::any_of(
	    program.blocks.begin(), program.blocks.end(), [](const auto* block) {
		    return std::any_of(block->begin(), block->end(), [](const auto& inst) {
			    return inst.GetOpcode() == ValueOpcode::BitwiseXor32;
		    });
	    });
	switch (program.stage) {
		case ShaderType::Vertex: CollectVertexInputs(program, options.vertex, next); break;
		case ShaderType::Pixel: CollectPixelInputs(program, options.pixel, next); break;
		case ShaderType::Compute: CollectComputeInputs(options.compute, next); break;
		default: return false;
	}
	CollectBuiltinInputs(program, next);
	if (!CollectOutputs(program, options.vertex, options.pixel, next, error)) {
		return false;
	}
	program.info                 = std::move(next);
	program.shader_info_complete = true;
	return true;
}

} // namespace Libs::Graphics::ShaderRecompiler::IR