2015-07-21 23:38:59 +00:00
|
|
|
// Copyright 2015 Citra Emulator Project
|
|
|
|
// Licensed under GPLv2 or any later version
|
|
|
|
// Refer to the license.txt file included.
|
|
|
|
|
|
|
|
#pragma once
|
|
|
|
|
2016-04-30 15:34:51 +00:00
|
|
|
#include <array>
|
|
|
|
#include <cstddef>
|
2017-07-25 19:30:29 +00:00
|
|
|
#include <functional>
|
2016-04-30 15:34:51 +00:00
|
|
|
#include <type_traits>
|
|
|
|
#include <nihstro/shader_bytecode.h>
|
|
|
|
#include "common/assert.h"
|
2015-07-21 23:38:59 +00:00
|
|
|
#include "common/common_funcs.h"
|
|
|
|
#include "common/common_types.h"
|
2018-04-17 06:47:59 +00:00
|
|
|
#include "common/hash.h"
|
2015-07-21 23:38:59 +00:00
|
|
|
#include "common/vector_math.h"
|
2016-04-30 15:34:51 +00:00
|
|
|
#include "video_core/pica_types.h"
|
2017-01-28 23:12:09 +00:00
|
|
|
#include "video_core/regs_rasterizer.h"
|
|
|
|
#include "video_core/regs_shader.h"
|
2015-07-21 23:38:59 +00:00
|
|
|
|
2018-03-09 17:54:43 +00:00
|
|
|
using nihstro::DestRegister;
|
2015-07-21 23:38:59 +00:00
|
|
|
using nihstro::RegisterType;
|
|
|
|
using nihstro::SourceRegister;
|
|
|
|
|
|
|
|
namespace Pica {
|
|
|
|
|
|
|
|
namespace Shader {
|
|
|
|
|
2017-05-08 21:37:38 +00:00
|
|
|
constexpr unsigned MAX_PROGRAM_CODE_LENGTH = 4096;
|
|
|
|
constexpr unsigned MAX_SWIZZLE_DATA_LENGTH = 4096;
|
|
|
|
|
2016-12-19 00:42:19 +00:00
|
|
|
struct AttributeBuffer {
|
2016-04-28 17:01:47 +00:00
|
|
|
alignas(16) Math::Vec4<float24> attr[16];
|
2015-07-21 23:38:59 +00:00
|
|
|
};
|
|
|
|
|
2017-07-25 19:30:29 +00:00
|
|
|
/// Handler type for receiving vertex outputs from vertex shader or geometry shader
|
|
|
|
using VertexHandler = std::function<void(const AttributeBuffer&)>;
|
|
|
|
|
|
|
|
/// Handler type for signaling to invert the vertex order of the next triangle
|
|
|
|
using WindingSetter = std::function<void()>;
|
|
|
|
|
2015-07-21 23:38:59 +00:00
|
|
|
struct OutputVertex {
|
|
|
|
Math::Vec4<float24> pos;
|
2015-08-16 13:12:43 +00:00
|
|
|
Math::Vec4<float24> quat;
|
2015-07-21 23:38:59 +00:00
|
|
|
Math::Vec4<float24> color;
|
|
|
|
Math::Vec2<float24> tc0;
|
|
|
|
Math::Vec2<float24> tc1;
|
2016-04-18 08:51:13 +00:00
|
|
|
float24 tc0_w;
|
|
|
|
INSERT_PADDING_WORDS(1);
|
2015-09-10 02:39:43 +00:00
|
|
|
Math::Vec3<float24> view;
|
|
|
|
INSERT_PADDING_WORDS(1);
|
2015-07-21 23:38:59 +00:00
|
|
|
Math::Vec2<float24> tc2;
|
|
|
|
|
2018-01-02 23:32:33 +00:00
|
|
|
static void ValidateSemantics(const RasterizerRegs& regs);
|
2017-07-25 21:39:43 +00:00
|
|
|
static OutputVertex FromAttributeBuffer(const RasterizerRegs& regs,
|
|
|
|
const AttributeBuffer& output);
|
2015-07-21 23:38:59 +00:00
|
|
|
};
|
2016-12-19 07:43:37 +00:00
|
|
|
#define ASSERT_POS(var, pos) \
|
|
|
|
static_assert(offsetof(OutputVertex, var) == pos * sizeof(float24), "Semantic at wrong " \
|
|
|
|
"offset.")
|
2017-01-28 04:16:36 +00:00
|
|
|
ASSERT_POS(pos, RasterizerRegs::VSOutputAttributes::POSITION_X);
|
|
|
|
ASSERT_POS(quat, RasterizerRegs::VSOutputAttributes::QUATERNION_X);
|
|
|
|
ASSERT_POS(color, RasterizerRegs::VSOutputAttributes::COLOR_R);
|
|
|
|
ASSERT_POS(tc0, RasterizerRegs::VSOutputAttributes::TEXCOORD0_U);
|
|
|
|
ASSERT_POS(tc1, RasterizerRegs::VSOutputAttributes::TEXCOORD1_U);
|
|
|
|
ASSERT_POS(tc0_w, RasterizerRegs::VSOutputAttributes::TEXCOORD0_W);
|
|
|
|
ASSERT_POS(view, RasterizerRegs::VSOutputAttributes::VIEW_X);
|
|
|
|
ASSERT_POS(tc2, RasterizerRegs::VSOutputAttributes::TEXCOORD2_U);
|
2016-12-19 07:43:37 +00:00
|
|
|
#undef ASSERT_POS
|
2015-07-21 23:38:59 +00:00
|
|
|
static_assert(std::is_pod<OutputVertex>::value, "Structure is not POD");
|
2016-12-19 07:43:37 +00:00
|
|
|
static_assert(sizeof(OutputVertex) == 24 * sizeof(float), "OutputVertex has invalid size");
|
2015-07-21 23:38:59 +00:00
|
|
|
|
2017-07-25 19:30:29 +00:00
|
|
|
/**
|
|
|
|
* This structure contains state information for primitive emitting in geometry shader.
|
|
|
|
*/
|
|
|
|
struct GSEmitter {
|
2017-12-10 04:30:14 +00:00
|
|
|
std::array<AttributeBuffer, 3> buffer;
|
2017-07-25 19:30:29 +00:00
|
|
|
u8 vertex_id;
|
|
|
|
bool prim_emit;
|
|
|
|
bool winding;
|
|
|
|
u32 output_mask;
|
|
|
|
|
|
|
|
// Function objects are hidden behind a raw pointer to make the structure standard layout type,
|
|
|
|
// for JIT to use offsetof to access other members.
|
|
|
|
struct Handlers {
|
|
|
|
VertexHandler vertex_handler;
|
|
|
|
WindingSetter winding_setter;
|
|
|
|
} * handlers;
|
|
|
|
|
|
|
|
GSEmitter();
|
|
|
|
~GSEmitter();
|
2017-12-10 04:30:14 +00:00
|
|
|
void Emit(Math::Vec4<float24> (&output_regs)[16]);
|
2017-07-25 19:30:29 +00:00
|
|
|
};
|
|
|
|
static_assert(std::is_standard_layout<GSEmitter>::value, "GSEmitter is not standard layout type");
|
|
|
|
|
2015-07-21 23:38:59 +00:00
|
|
|
/**
|
|
|
|
* This structure contains the state information that needs to be unique for a shader unit. The 3DS
|
|
|
|
* has four shader units that process shaders in parallel. At the present, Citra only implements a
|
|
|
|
* single shader unit that processes all shaders serially. Putting the state information in a struct
|
|
|
|
* here will make it easier for us to parallelize the shader processing later.
|
|
|
|
*/
|
|
|
|
struct UnitState {
|
2017-07-25 19:30:29 +00:00
|
|
|
explicit UnitState(GSEmitter* emitter = nullptr);
|
2015-08-15 20:51:32 +00:00
|
|
|
struct Registers {
|
|
|
|
// The registers are accessed by the shader JIT using SSE instructions, and are therefore
|
|
|
|
// required to be 16-byte aligned.
|
2016-03-09 06:28:26 +00:00
|
|
|
alignas(16) Math::Vec4<float24> input[16];
|
|
|
|
alignas(16) Math::Vec4<float24> temporary[16];
|
2016-12-17 22:38:03 +00:00
|
|
|
alignas(16) Math::Vec4<float24> output[16];
|
2015-08-15 20:51:32 +00:00
|
|
|
} registers;
|
|
|
|
static_assert(std::is_pod<Registers>::value, "Structure is not POD");
|
2015-07-21 23:38:59 +00:00
|
|
|
|
|
|
|
bool conditional_code[2];
|
|
|
|
|
|
|
|
// Two Address registers and one loop counter
|
|
|
|
// TODO: How many bits do these actually have?
|
|
|
|
s32 address_registers[3];
|
|
|
|
|
2017-07-25 19:30:29 +00:00
|
|
|
GSEmitter* emitter_ptr;
|
|
|
|
|
2018-09-06 20:03:28 +00:00
|
|
|
static std::size_t InputOffset(const SourceRegister& reg) {
|
2015-07-21 23:38:59 +00:00
|
|
|
switch (reg.GetRegisterType()) {
|
|
|
|
case RegisterType::Input:
|
2016-09-18 00:38:01 +00:00
|
|
|
return offsetof(UnitState, registers.input) +
|
|
|
|
reg.GetIndex() * sizeof(Math::Vec4<float24>);
|
2015-07-21 23:38:59 +00:00
|
|
|
|
|
|
|
case RegisterType::Temporary:
|
2016-09-18 00:38:01 +00:00
|
|
|
return offsetof(UnitState, registers.temporary) +
|
|
|
|
reg.GetIndex() * sizeof(Math::Vec4<float24>);
|
2015-07-21 23:38:59 +00:00
|
|
|
|
|
|
|
default:
|
|
|
|
UNREACHABLE();
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2018-09-06 20:03:28 +00:00
|
|
|
static std::size_t OutputOffset(const DestRegister& reg) {
|
2015-07-21 23:38:59 +00:00
|
|
|
switch (reg.GetRegisterType()) {
|
|
|
|
case RegisterType::Output:
|
2016-12-17 22:38:03 +00:00
|
|
|
return offsetof(UnitState, registers.output) +
|
2016-09-18 00:38:01 +00:00
|
|
|
reg.GetIndex() * sizeof(Math::Vec4<float24>);
|
2015-07-21 23:38:59 +00:00
|
|
|
|
|
|
|
case RegisterType::Temporary:
|
2016-09-18 00:38:01 +00:00
|
|
|
return offsetof(UnitState, registers.temporary) +
|
|
|
|
reg.GetIndex() * sizeof(Math::Vec4<float24>);
|
2015-07-21 23:38:59 +00:00
|
|
|
|
|
|
|
default:
|
|
|
|
UNREACHABLE();
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
}
|
2016-12-17 05:41:38 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Loads the unit state with an input vertex.
|
|
|
|
*
|
2016-12-19 01:25:03 +00:00
|
|
|
* @param config Shader configuration registers corresponding to the unit.
|
|
|
|
* @param input Attribute buffer to load into the input registers.
|
2016-12-17 05:41:38 +00:00
|
|
|
*/
|
2017-01-28 21:03:13 +00:00
|
|
|
void LoadInput(const ShaderRegs& config, const AttributeBuffer& input);
|
2016-12-19 01:58:30 +00:00
|
|
|
|
2017-01-28 21:03:13 +00:00
|
|
|
void WriteOutput(const ShaderRegs& config, AttributeBuffer& output);
|
2015-07-21 23:38:59 +00:00
|
|
|
};
|
|
|
|
|
2017-07-25 19:30:29 +00:00
|
|
|
/**
|
|
|
|
* This is an extended shader unit state that represents the special unit that can run both vertex
|
|
|
|
* shader and geometry shader. It contains an additional primitive emitter and utilities for
|
|
|
|
* geometry shader.
|
|
|
|
*/
|
|
|
|
struct GSUnitState : public UnitState {
|
|
|
|
GSUnitState();
|
|
|
|
void SetVertexHandler(VertexHandler vertex_handler, WindingSetter winding_setter);
|
|
|
|
void ConfigOutput(const ShaderRegs& config);
|
|
|
|
|
|
|
|
GSEmitter emitter;
|
|
|
|
};
|
|
|
|
|
2018-04-17 06:35:43 +00:00
|
|
|
struct Uniforms {
|
|
|
|
// The float uniforms are accessed by the shader JIT using SSE instructions, and are
|
|
|
|
// therefore required to be 16-byte aligned.
|
|
|
|
alignas(16) Math::Vec4<float24> f[96];
|
2015-07-23 03:25:30 +00:00
|
|
|
|
2018-04-17 06:35:43 +00:00
|
|
|
std::array<bool, 16> b;
|
|
|
|
std::array<Math::Vec4<u8>, 4> i;
|
2015-07-11 23:57:59 +00:00
|
|
|
|
2018-09-06 20:03:28 +00:00
|
|
|
static std::size_t GetFloatUniformOffset(unsigned index) {
|
2018-04-17 06:35:43 +00:00
|
|
|
return offsetof(Uniforms, f) + index * sizeof(Math::Vec4<float24>);
|
2016-12-16 06:35:34 +00:00
|
|
|
}
|
2016-05-13 06:46:14 +00:00
|
|
|
|
2018-09-06 20:03:28 +00:00
|
|
|
static std::size_t GetBoolUniformOffset(unsigned index) {
|
2018-04-17 06:35:43 +00:00
|
|
|
return offsetof(Uniforms, b) + index * sizeof(bool);
|
2016-12-16 06:35:34 +00:00
|
|
|
}
|
2016-05-13 06:46:14 +00:00
|
|
|
|
2018-09-06 20:03:28 +00:00
|
|
|
static std::size_t GetIntUniformOffset(unsigned index) {
|
2018-04-17 06:35:43 +00:00
|
|
|
return offsetof(Uniforms, i) + index * sizeof(Math::Vec4<u8>);
|
2016-05-13 06:46:14 +00:00
|
|
|
}
|
2018-04-17 06:35:43 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
struct ShaderSetup {
|
|
|
|
Uniforms uniforms;
|
2016-05-13 06:46:14 +00:00
|
|
|
|
2017-05-08 21:37:38 +00:00
|
|
|
std::array<u32, MAX_PROGRAM_CODE_LENGTH> program_code;
|
|
|
|
std::array<u32, MAX_SWIZZLE_DATA_LENGTH> swizzle_data;
|
2016-12-18 00:06:04 +00:00
|
|
|
|
|
|
|
/// Data private to ShaderEngines
|
|
|
|
struct EngineData {
|
2016-12-18 00:16:02 +00:00
|
|
|
unsigned int entry_point;
|
2016-12-18 00:06:04 +00:00
|
|
|
/// Used by the JIT, points to a compiled shader object.
|
|
|
|
const void* cached_shader = nullptr;
|
|
|
|
} engine_data;
|
2018-04-17 06:47:59 +00:00
|
|
|
|
|
|
|
void MarkProgramCodeDirty() {
|
|
|
|
program_code_hash_dirty = true;
|
|
|
|
}
|
|
|
|
|
|
|
|
void MarkSwizzleDataDirty() {
|
|
|
|
swizzle_data_hash_dirty = true;
|
|
|
|
}
|
|
|
|
|
|
|
|
u64 GetProgramCodeHash() {
|
|
|
|
if (program_code_hash_dirty) {
|
|
|
|
program_code_hash = Common::ComputeHash64(&program_code, sizeof(program_code));
|
|
|
|
program_code_hash_dirty = false;
|
|
|
|
}
|
|
|
|
return program_code_hash;
|
|
|
|
}
|
|
|
|
|
|
|
|
u64 GetSwizzleDataHash() {
|
|
|
|
if (swizzle_data_hash_dirty) {
|
|
|
|
swizzle_data_hash = Common::ComputeHash64(&swizzle_data, sizeof(swizzle_data));
|
|
|
|
swizzle_data_hash_dirty = false;
|
|
|
|
}
|
|
|
|
return swizzle_data_hash;
|
|
|
|
}
|
|
|
|
|
|
|
|
private:
|
|
|
|
bool program_code_hash_dirty = true;
|
|
|
|
bool swizzle_data_hash_dirty = true;
|
|
|
|
u64 program_code_hash = 0xDEADC0DE;
|
|
|
|
u64 swizzle_data_hash = 0xDEADC0DE;
|
2016-12-17 07:21:26 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
class ShaderEngine {
|
|
|
|
public:
|
|
|
|
virtual ~ShaderEngine() = default;
|
2016-03-30 00:45:18 +00:00
|
|
|
|
|
|
|
/**
|
2016-09-18 00:38:01 +00:00
|
|
|
* Performs any shader unit setup that only needs to happen once per shader (as opposed to once
|
2016-09-19 01:01:46 +00:00
|
|
|
* per vertex, which would happen within the `Run` function).
|
2016-03-30 00:45:18 +00:00
|
|
|
*/
|
2016-12-18 00:16:02 +00:00
|
|
|
virtual void SetupBatch(ShaderSetup& setup, unsigned int entry_point) = 0;
|
2016-03-30 00:45:18 +00:00
|
|
|
|
|
|
|
/**
|
2016-12-18 00:06:04 +00:00
|
|
|
* Runs the currently setup shader.
|
|
|
|
*
|
|
|
|
* @param setup Shader engine state, must be setup with SetupBatch on each shader change.
|
|
|
|
* @param state Shader unit state, must be setup with input data before each shader invocation.
|
2016-03-30 00:45:18 +00:00
|
|
|
*/
|
2016-12-18 00:16:02 +00:00
|
|
|
virtual void Run(const ShaderSetup& setup, UnitState& state) const = 0;
|
2016-03-30 00:45:18 +00:00
|
|
|
};
|
2015-07-21 23:38:59 +00:00
|
|
|
|
2016-12-17 07:21:26 +00:00
|
|
|
// TODO(yuriks): Remove and make it non-global state somewhere
|
|
|
|
ShaderEngine* GetEngine();
|
2016-12-17 09:21:16 +00:00
|
|
|
void Shutdown();
|
2016-12-17 07:21:26 +00:00
|
|
|
|
2015-07-21 23:38:59 +00:00
|
|
|
} // namespace Shader
|
|
|
|
|
|
|
|
} // namespace Pica
|