using Ryujinx.Common; using Ryujinx.Graphics.Shader.StructuredIr; using Ryujinx.Graphics.Shader.Translation; using System; using System.Collections.Generic; using System.Globalization; using System.Linq; using System.Numerics; namespace Ryujinx.Graphics.Shader.CodeGen.Glsl { static class Declarations { public static void Declare(CodeGenContext context, StructuredProgramInfo info) { context.AppendLine(context.Config.Options.TargetApi == TargetApi.Vulkan ? "#version 460 core" : "#version 450 core"); context.AppendLine("#extension GL_ARB_gpu_shader_int64 : enable"); if (context.Config.GpuAccessor.QueryHostSupportsShaderBallot()) { context.AppendLine("#extension GL_ARB_shader_ballot : enable"); } else { context.AppendLine("#extension GL_KHR_shader_subgroup_basic : enable"); context.AppendLine("#extension GL_KHR_shader_subgroup_ballot : enable"); } context.AppendLine("#extension GL_ARB_shader_group_vote : enable"); context.AppendLine("#extension GL_EXT_shader_image_load_formatted : enable"); context.AppendLine("#extension GL_EXT_texture_shadow_lod : enable"); if (context.Config.Stage == ShaderStage.Compute) { context.AppendLine("#extension GL_ARB_compute_shader : enable"); } else if (context.Config.Stage == ShaderStage.Fragment) { if (context.Config.GpuAccessor.QueryHostSupportsFragmentShaderInterlock()) { context.AppendLine("#extension GL_ARB_fragment_shader_interlock : enable"); } else if (context.Config.GpuAccessor.QueryHostSupportsFragmentShaderOrderingIntel()) { context.AppendLine("#extension GL_INTEL_fragment_shader_ordering : enable"); } } else { if (context.Config.Stage == ShaderStage.Vertex) { context.AppendLine("#extension GL_ARB_shader_draw_parameters : enable"); } context.AppendLine("#extension GL_ARB_shader_viewport_layer_array : enable"); } if (context.Config.GpPassthrough && context.Config.GpuAccessor.QueryHostSupportsGeometryShaderPassthrough()) { context.AppendLine("#extension GL_NV_geometry_shader_passthrough : enable"); } if (context.Config.GpuAccessor.QueryHostSupportsViewportMask()) { context.AppendLine("#extension GL_NV_viewport_array2 : enable"); } context.AppendLine("#pragma optionNV(fastmath off)"); context.AppendLine(); context.AppendLine($"const int {DefaultNames.UndefinedName} = 0;"); context.AppendLine(); if (context.Config.Stage == ShaderStage.Compute) { int localMemorySize = BitUtils.DivRoundUp(context.Config.GpuAccessor.QueryComputeLocalMemorySize(), 4); if (localMemorySize != 0) { string localMemorySizeStr = NumberFormatter.FormatInt(localMemorySize); context.AppendLine($"uint {DefaultNames.LocalMemoryName}[{localMemorySizeStr}];"); context.AppendLine(); } int sharedMemorySize = BitUtils.DivRoundUp(context.Config.GpuAccessor.QueryComputeSharedMemorySize(), 4); if (sharedMemorySize != 0) { string sharedMemorySizeStr = NumberFormatter.FormatInt(sharedMemorySize); context.AppendLine($"shared uint {DefaultNames.SharedMemoryName}[{sharedMemorySizeStr}];"); context.AppendLine(); } } else if (context.Config.LocalMemorySize != 0) { int localMemorySize = BitUtils.DivRoundUp(context.Config.LocalMemorySize, 4); string localMemorySizeStr = NumberFormatter.FormatInt(localMemorySize); context.AppendLine($"uint {DefaultNames.LocalMemoryName}[{localMemorySizeStr}];"); context.AppendLine(); } DeclareConstantBuffers(context, context.Config.Properties.ConstantBuffers.Values); DeclareStorageBuffers(context, context.Config.Properties.StorageBuffers.Values); var textureDescriptors = context.Config.GetTextureDescriptors(); if (textureDescriptors.Length != 0) { DeclareSamplers(context, textureDescriptors); context.AppendLine(); } var imageDescriptors = context.Config.GetImageDescriptors(); if (imageDescriptors.Length != 0) { DeclareImages(context, imageDescriptors); context.AppendLine(); } if (context.Config.Stage != ShaderStage.Compute) { if (context.Config.Stage == ShaderStage.Geometry) { InputTopology inputTopology = context.Config.GpuAccessor.QueryPrimitiveTopology(); string inPrimitive = inputTopology.ToGlslString(); context.AppendLine($"layout (invocations = {context.Config.ThreadsPerInputPrimitive}, {inPrimitive}) in;"); if (context.Config.GpPassthrough && context.Config.GpuAccessor.QueryHostSupportsGeometryShaderPassthrough()) { context.AppendLine($"layout (passthrough) in gl_PerVertex"); context.EnterScope(); context.AppendLine("vec4 gl_Position;"); context.AppendLine("float gl_PointSize;"); context.AppendLine("float gl_ClipDistance[];"); context.LeaveScope(";"); } else { string outPrimitive = context.Config.OutputTopology.ToGlslString(); int maxOutputVertices = context.Config.GpPassthrough ? inputTopology.ToInputVertices() : context.Config.MaxOutputVertices; context.AppendLine($"layout ({outPrimitive}, max_vertices = {maxOutputVertices}) out;"); } context.AppendLine(); } else if (context.Config.Stage == ShaderStage.TessellationControl) { int threadsPerInputPrimitive = context.Config.ThreadsPerInputPrimitive; context.AppendLine($"layout (vertices = {threadsPerInputPrimitive}) out;"); context.AppendLine(); } else if (context.Config.Stage == ShaderStage.TessellationEvaluation) { bool tessCw = context.Config.GpuAccessor.QueryTessCw(); if (context.Config.Options.TargetApi == TargetApi.Vulkan) { // We invert the front face on Vulkan backend, so we need to do that here aswell. tessCw = !tessCw; } string patchType = context.Config.GpuAccessor.QueryTessPatchType().ToGlsl(); string spacing = context.Config.GpuAccessor.QueryTessSpacing().ToGlsl(); string windingOrder = tessCw ? "cw" : "ccw"; context.AppendLine($"layout ({patchType}, {spacing}, {windingOrder}) in;"); context.AppendLine(); } if (context.Config.UsedInputAttributes != 0 || context.Config.GpPassthrough) { DeclareInputAttributes(context, info); context.AppendLine(); } if (context.Config.UsedOutputAttributes != 0 || context.Config.Stage != ShaderStage.Fragment) { DeclareOutputAttributes(context, info); context.AppendLine(); } if (context.Config.UsedInputAttributesPerPatch.Count != 0) { DeclareInputAttributesPerPatch(context, context.Config.UsedInputAttributesPerPatch); context.AppendLine(); } if (context.Config.UsedOutputAttributesPerPatch.Count != 0) { DeclareUsedOutputAttributesPerPatch(context, context.Config.UsedOutputAttributesPerPatch); context.AppendLine(); } if (context.Config.TransformFeedbackEnabled && context.Config.LastInVertexPipeline) { var tfOutput = context.Config.GetTransformFeedbackOutput(AttributeConsts.PositionX); if (tfOutput.Valid) { context.AppendLine($"layout (xfb_buffer = {tfOutput.Buffer}, xfb_offset = {tfOutput.Offset}, xfb_stride = {tfOutput.Stride}) out gl_PerVertex"); context.EnterScope(); context.AppendLine("vec4 gl_Position;"); context.LeaveScope(context.Config.Stage == ShaderStage.TessellationControl ? " gl_out[];" : ";"); } } } else { string localSizeX = NumberFormatter.FormatInt(context.Config.GpuAccessor.QueryComputeLocalSizeX()); string localSizeY = NumberFormatter.FormatInt(context.Config.GpuAccessor.QueryComputeLocalSizeY()); string localSizeZ = NumberFormatter.FormatInt(context.Config.GpuAccessor.QueryComputeLocalSizeZ()); context.AppendLine( "layout (" + $"local_size_x = {localSizeX}, " + $"local_size_y = {localSizeY}, " + $"local_size_z = {localSizeZ}) in;"); context.AppendLine(); } if (context.Config.Stage == ShaderStage.Fragment && context.Config.GpuAccessor.QueryEarlyZForce()) { context.AppendLine("layout(early_fragment_tests) in;"); context.AppendLine(); } if ((info.HelperFunctionsMask & HelperFunctionsMask.AtomicMinMaxS32Shared) != 0) { AppendHelperFunction(context, "Ryujinx.Graphics.Shader/CodeGen/Glsl/HelperFunctions/AtomicMinMaxS32Shared.glsl"); } if ((info.HelperFunctionsMask & HelperFunctionsMask.MultiplyHighS32) != 0) { AppendHelperFunction(context, "Ryujinx.Graphics.Shader/CodeGen/Glsl/HelperFunctions/MultiplyHighS32.glsl"); } if ((info.HelperFunctionsMask & HelperFunctionsMask.MultiplyHighU32) != 0) { AppendHelperFunction(context, "Ryujinx.Graphics.Shader/CodeGen/Glsl/HelperFunctions/MultiplyHighU32.glsl"); } if ((info.HelperFunctionsMask & HelperFunctionsMask.Shuffle) != 0) { AppendHelperFunction(context, "Ryujinx.Graphics.Shader/CodeGen/Glsl/HelperFunctions/Shuffle.glsl"); } if ((info.HelperFunctionsMask & HelperFunctionsMask.ShuffleDown) != 0) { AppendHelperFunction(context, "Ryujinx.Graphics.Shader/CodeGen/Glsl/HelperFunctions/ShuffleDown.glsl"); } if ((info.HelperFunctionsMask & HelperFunctionsMask.ShuffleUp) != 0) { AppendHelperFunction(context, "Ryujinx.Graphics.Shader/CodeGen/Glsl/HelperFunctions/ShuffleUp.glsl"); } if ((info.HelperFunctionsMask & HelperFunctionsMask.ShuffleXor) != 0) { AppendHelperFunction(context, "Ryujinx.Graphics.Shader/CodeGen/Glsl/HelperFunctions/ShuffleXor.glsl"); } if ((info.HelperFunctionsMask & HelperFunctionsMask.StoreSharedSmallInt) != 0) { AppendHelperFunction(context, "Ryujinx.Graphics.Shader/CodeGen/Glsl/HelperFunctions/StoreSharedSmallInt.glsl"); } if ((info.HelperFunctionsMask & HelperFunctionsMask.SwizzleAdd) != 0) { AppendHelperFunction(context, "Ryujinx.Graphics.Shader/CodeGen/Glsl/HelperFunctions/SwizzleAdd.glsl"); } } private static string GetTfLayout(TransformFeedbackOutput tfOutput) { if (tfOutput.Valid) { return $"layout (xfb_buffer = {tfOutput.Buffer}, xfb_offset = {tfOutput.Offset}, xfb_stride = {tfOutput.Stride}) "; } return string.Empty; } public static void DeclareLocals(CodeGenContext context, StructuredFunction function) { foreach (AstOperand decl in function.Locals) { string name = context.OperandManager.DeclareLocal(decl); context.AppendLine(GetVarTypeName(context, decl.VarType) + " " + name + ";"); } } public static string GetVarTypeName(CodeGenContext context, AggregateType type, bool precise = true) { if (context.Config.GpuAccessor.QueryHostReducedPrecision()) { precise = false; } return type switch { AggregateType.Void => "void", AggregateType.Bool => "bool", AggregateType.FP32 => precise ? "precise float" : "float", AggregateType.FP64 => "double", AggregateType.S32 => "int", AggregateType.U32 => "uint", AggregateType.Vector2 | AggregateType.Bool => "bvec2", AggregateType.Vector2 | AggregateType.FP32 => precise ? "precise vec2" : "vec2", AggregateType.Vector2 | AggregateType.FP64 => "dvec2", AggregateType.Vector2 | AggregateType.S32 => "ivec2", AggregateType.Vector2 | AggregateType.U32 => "uvec2", AggregateType.Vector3 | AggregateType.Bool => "bvec3", AggregateType.Vector3 | AggregateType.FP32 => precise ? "precise vec3" : "vec3", AggregateType.Vector3 | AggregateType.FP64 => "dvec3", AggregateType.Vector3 | AggregateType.S32 => "ivec3", AggregateType.Vector3 | AggregateType.U32 => "uvec3", AggregateType.Vector4 | AggregateType.Bool => "bvec4", AggregateType.Vector4 | AggregateType.FP32 => precise ? "precise vec4" : "vec4", AggregateType.Vector4 | AggregateType.FP64 => "dvec4", AggregateType.Vector4 | AggregateType.S32 => "ivec4", AggregateType.Vector4 | AggregateType.U32 => "uvec4", _ => throw new ArgumentException($"Invalid variable type \"{type}\".") }; } private static void DeclareConstantBuffers(CodeGenContext context, IEnumerable buffers) { DeclareBuffers(context, buffers, "uniform"); } private static void DeclareStorageBuffers(CodeGenContext context, IEnumerable buffers) { DeclareBuffers(context, buffers, "buffer"); } private static void DeclareBuffers(CodeGenContext context, IEnumerable buffers, string declType) { foreach (BufferDefinition buffer in buffers) { string layout = buffer.Layout switch { BufferLayout.Std140 => "std140", _ => "std430" }; context.AppendLine($"layout (binding = {buffer.Binding}, {layout}) {declType} _{buffer.Name}"); context.EnterScope(); foreach (StructureField field in buffer.Type.Fields) { if (field.Type.HasFlag(AggregateType.Array)) { string typeName = GetVarTypeName(context, field.Type & ~AggregateType.Array); if (field.ArrayLength > 0) { string arraySize = field.ArrayLength.ToString(CultureInfo.InvariantCulture); context.AppendLine($"{typeName} {field.Name}[{arraySize}];"); } else { context.AppendLine($"{typeName} {field.Name}[];"); } } else { string typeName = GetVarTypeName(context, field.Type); context.AppendLine($"{typeName} {field.Name};"); } } context.LeaveScope($" {buffer.Name};"); context.AppendLine(); } } private static void DeclareSamplers(CodeGenContext context, TextureDescriptor[] descriptors) { int arraySize = 0; foreach (var descriptor in descriptors) { if (descriptor.Type.HasFlag(SamplerType.Indexed)) { if (arraySize == 0) { arraySize = ShaderConfig.SamplerArraySize; } else if (--arraySize != 0) { continue; } } string indexExpr = NumberFormatter.FormatInt(arraySize); string samplerName = OperandManager.GetSamplerName( context.Config.Stage, descriptor.CbufSlot, descriptor.HandleIndex, descriptor.Type.HasFlag(SamplerType.Indexed), indexExpr); string samplerTypeName = descriptor.Type.ToGlslSamplerType(); string layout = string.Empty; if (context.Config.Options.TargetApi == TargetApi.Vulkan) { layout = ", set = 2"; } context.AppendLine($"layout (binding = {descriptor.Binding}{layout}) uniform {samplerTypeName} {samplerName};"); } } private static void DeclareImages(CodeGenContext context, TextureDescriptor[] descriptors) { int arraySize = 0; foreach (var descriptor in descriptors) { if (descriptor.Type.HasFlag(SamplerType.Indexed)) { if (arraySize == 0) { arraySize = ShaderConfig.SamplerArraySize; } else if (--arraySize != 0) { continue; } } string indexExpr = NumberFormatter.FormatInt(arraySize); string imageName = OperandManager.GetImageName( context.Config.Stage, descriptor.CbufSlot, descriptor.HandleIndex, descriptor.Format, descriptor.Type.HasFlag(SamplerType.Indexed), indexExpr); string imageTypeName = descriptor.Type.ToGlslImageType(descriptor.Format.GetComponentType()); if (descriptor.Flags.HasFlag(TextureUsageFlags.ImageCoherent)) { imageTypeName = "coherent " + imageTypeName; } string layout = descriptor.Format.ToGlslFormat(); if (!string.IsNullOrEmpty(layout)) { layout = ", " + layout; } if (context.Config.Options.TargetApi == TargetApi.Vulkan) { layout = $", set = 3{layout}"; } context.AppendLine($"layout (binding = {descriptor.Binding}{layout}) uniform {imageTypeName} {imageName};"); } } private static void DeclareInputAttributes(CodeGenContext context, StructuredProgramInfo info) { if (context.Config.UsedFeatures.HasFlag(FeatureFlags.IaIndexing)) { string suffix = context.Config.Stage == ShaderStage.Geometry ? "[]" : string.Empty; context.AppendLine($"layout (location = 0) in vec4 {DefaultNames.IAttributePrefix}{suffix}[{Constants.MaxAttributes}];"); } else { int usedAttributes = context.Config.UsedInputAttributes | context.Config.PassthroughAttributes; while (usedAttributes != 0) { int index = BitOperations.TrailingZeroCount(usedAttributes); DeclareInputAttribute(context, info, index); usedAttributes &= ~(1 << index); } } } private static void DeclareInputAttributesPerPatch(CodeGenContext context, HashSet attrs) { foreach (int attr in attrs.Order()) { DeclareInputAttributePerPatch(context, attr); } } private static void DeclareInputAttribute(CodeGenContext context, StructuredProgramInfo info, int attr) { string suffix = IsArrayAttributeGlsl(context.Config.Stage, isOutAttr: false) ? "[]" : string.Empty; string iq = string.Empty; if (context.Config.Stage == ShaderStage.Fragment) { iq = context.Config.ImapTypes[attr].GetFirstUsedType() switch { PixelImap.Constant => "flat ", PixelImap.ScreenLinear => "noperspective ", _ => string.Empty }; } string name = $"{DefaultNames.IAttributePrefix}{attr}"; if (context.Config.TransformFeedbackEnabled && context.Config.Stage == ShaderStage.Fragment) { int components = context.Config.GetTransformFeedbackOutputComponents(attr, 0); if (components > 1) { string type = components switch { 2 => "vec2", 3 => "vec3", 4 => "vec4", _ => "float" }; context.AppendLine($"layout (location = {attr}) in {type} {name};"); } for (int c = components > 1 ? components : 0; c < 4; c++) { char swzMask = "xyzw"[c]; context.AppendLine($"layout (location = {attr}, component = {c}) {iq}in float {name}_{swzMask}{suffix};"); } } else { bool passthrough = (context.Config.PassthroughAttributes & (1 << attr)) != 0; string pass = passthrough && context.Config.GpuAccessor.QueryHostSupportsGeometryShaderPassthrough() ? "passthrough, " : string.Empty; string type; if (context.Config.Stage == ShaderStage.Vertex) { type = context.Config.GpuAccessor.QueryAttributeType(attr).ToVec4Type(); } else { type = AttributeType.Float.ToVec4Type(); } context.AppendLine($"layout ({pass}location = {attr}) {iq}in {type} {name}{suffix};"); } } private static void DeclareInputAttributePerPatch(CodeGenContext context, int attr) { int location = context.Config.GetPerPatchAttributeLocation(attr); string name = $"{DefaultNames.PerPatchAttributePrefix}{attr}"; context.AppendLine($"layout (location = {location}) patch in vec4 {name};"); } private static void DeclareOutputAttributes(CodeGenContext context, StructuredProgramInfo info) { if (context.Config.UsedFeatures.HasFlag(FeatureFlags.OaIndexing)) { context.AppendLine($"layout (location = 0) out vec4 {DefaultNames.OAttributePrefix}[{Constants.MaxAttributes}];"); } else { int usedAttributes = context.Config.UsedOutputAttributes; if (context.Config.Stage == ShaderStage.Fragment && context.Config.GpuAccessor.QueryDualSourceBlendEnable()) { int firstOutput = BitOperations.TrailingZeroCount(usedAttributes); int mask = 3 << firstOutput; if ((usedAttributes & mask) == mask) { usedAttributes &= ~mask; DeclareOutputDualSourceBlendAttribute(context, firstOutput); } } while (usedAttributes != 0) { int index = BitOperations.TrailingZeroCount(usedAttributes); DeclareOutputAttribute(context, index); usedAttributes &= ~(1 << index); } } } private static void DeclareOutputAttribute(CodeGenContext context, int attr) { string suffix = IsArrayAttributeGlsl(context.Config.Stage, isOutAttr: true) ? "[]" : string.Empty; string name = $"{DefaultNames.OAttributePrefix}{attr}{suffix}"; if (context.Config.TransformFeedbackEnabled && context.Config.LastInVertexPipeline) { int components = context.Config.GetTransformFeedbackOutputComponents(attr, 0); if (components > 1) { string type = components switch { 2 => "vec2", 3 => "vec3", 4 => "vec4", _ => "float" }; string xfb = string.Empty; var tfOutput = context.Config.GetTransformFeedbackOutput(attr, 0); if (tfOutput.Valid) { xfb = $", xfb_buffer = {tfOutput.Buffer}, xfb_offset = {tfOutput.Offset}, xfb_stride = {tfOutput.Stride}"; } context.AppendLine($"layout (location = {attr}{xfb}) out {type} {name};"); } for (int c = components > 1 ? components : 0; c < 4; c++) { char swzMask = "xyzw"[c]; string xfb = string.Empty; var tfOutput = context.Config.GetTransformFeedbackOutput(attr, c); if (tfOutput.Valid) { xfb = $", xfb_buffer = {tfOutput.Buffer}, xfb_offset = {tfOutput.Offset}, xfb_stride = {tfOutput.Stride}"; } context.AppendLine($"layout (location = {attr}, component = {c}{xfb}) out float {name}_{swzMask};"); } } else { string type = context.Config.Stage != ShaderStage.Fragment ? "vec4" : context.Config.GpuAccessor.QueryFragmentOutputType(attr) switch { AttributeType.Sint => "ivec4", AttributeType.Uint => "uvec4", _ => "vec4" }; if (context.Config.GpuAccessor.QueryHostReducedPrecision() && context.Config.Stage == ShaderStage.Vertex && attr == 0) { context.AppendLine($"layout (location = {attr}) invariant out {type} {name};"); } else { context.AppendLine($"layout (location = {attr}) out {type} {name};"); } } } private static void DeclareOutputDualSourceBlendAttribute(CodeGenContext context, int attr) { string name = $"{DefaultNames.OAttributePrefix}{attr}"; string name2 = $"{DefaultNames.OAttributePrefix}{(attr + 1)}"; context.AppendLine($"layout (location = {attr}, index = 0) out vec4 {name};"); context.AppendLine($"layout (location = {attr}, index = 1) out vec4 {name2};"); } private static bool IsArrayAttributeGlsl(ShaderStage stage, bool isOutAttr) { if (isOutAttr) { return stage == ShaderStage.TessellationControl; } else { return stage == ShaderStage.TessellationControl || stage == ShaderStage.TessellationEvaluation || stage == ShaderStage.Geometry; } } private static void DeclareUsedOutputAttributesPerPatch(CodeGenContext context, HashSet attrs) { foreach (int attr in attrs.Order()) { DeclareOutputAttributePerPatch(context, attr); } } private static void DeclareOutputAttributePerPatch(CodeGenContext context, int attr) { int location = context.Config.GetPerPatchAttributeLocation(attr); string name = $"{DefaultNames.PerPatchAttributePrefix}{attr}"; context.AppendLine($"layout (location = {location}) patch out vec4 {name};"); } private static void AppendHelperFunction(CodeGenContext context, string filename) { string code = EmbeddedResources.ReadAllText(filename); code = code.Replace("\t", CodeGenContext.Tab); code = code.Replace("$SHARED_MEM$", DefaultNames.SharedMemoryName); if (context.Config.GpuAccessor.QueryHostSupportsShaderBallot()) { code = code.Replace("$SUBGROUP_INVOCATION$", "gl_SubGroupInvocationARB"); code = code.Replace("$SUBGROUP_BROADCAST$", "readInvocationARB"); } else { code = code.Replace("$SUBGROUP_INVOCATION$", "gl_SubgroupInvocationID"); code = code.Replace("$SUBGROUP_BROADCAST$", "subgroupBroadcast"); } context.AppendLine(code); context.AppendLine(); } } }