Add disk cache for shader compilations

osu.Framework.Tests/Shaders/TestSceneShaderDisposal.cs

@@ -60,13 +60,13 @@ public void TestShadersLoseReferencesOnManagerDisposal()
 
         private class TestGLRenderer : GLRenderer
         {
-            protected override IShader CreateShader(string name, IShaderPart[] parts, IUniformBuffer<GlobalUniformData> globalUniformBuffer)
-                => new TestGLShader(this, name, parts.Cast<GLShaderPart>().ToArray());
+            protected override IShader CreateShader(string name, IShaderPart[] parts, IUniformBuffer<GlobalUniformData> globalUniformBuffer, ShaderCompilationStore compilationStore)
+                => new TestGLShader(this, name, parts.Cast<GLShaderPart>().ToArray(), globalUniformBuffer, compilationStore);
 
             private class TestGLShader : GLShader
             {
-                internal TestGLShader(GLRenderer renderer, string name, GLShaderPart[] parts)
-                    : base(renderer, name, parts, null)
+                internal TestGLShader(GLRenderer renderer, string name, GLShaderPart[] parts, IUniformBuffer<GlobalUniformData> globalUniformBuffer, ShaderCompilationStore compilationStore)
+                    : base(renderer, name, parts, globalUniformBuffer, compilationStore)
                 {
                 }
 

osu.Framework.Tests/Shaders/TestShaderLoading.cs

@@ -40,13 +40,13 @@ public void TestFetchExistentShader()
 
         private class TestGLRenderer : GLRenderer
         {
-            protected override IShader CreateShader(string name, IShaderPart[] parts, IUniformBuffer<GlobalUniformData> globalUniformBuffer)
-                => new TestGLShader(this, name, parts.Cast<GLShaderPart>().ToArray());
+            protected override IShader CreateShader(string name, IShaderPart[] parts, IUniformBuffer<GlobalUniformData> globalUniformBuffer, ShaderCompilationStore compilationStore)
+                => new TestGLShader(this, name, parts.Cast<GLShaderPart>().ToArray(), globalUniformBuffer, compilationStore);
 
             private class TestGLShader : GLShader
             {
-                internal TestGLShader(GLRenderer renderer, string name, GLShaderPart[] parts)
-                    : base(renderer, name, parts, null)
+                internal TestGLShader(GLRenderer renderer, string name, GLShaderPart[] parts, IUniformBuffer<GlobalUniformData> globalUniformBuffer, ShaderCompilationStore compilationStore)
+                    : base(renderer, name, parts, globalUniformBuffer, compilationStore)
                 {
                 }
 

osu.Framework/Graphics/OpenGL/GLRenderer.cs

@@ -376,8 +376,8 @@ protected override IShaderPart CreateShaderPart(IShaderStore store, string name,
             return new GLShaderPart(this, name, rawData, glType, store);
         }
 
-        protected override IShader CreateShader(string name, IShaderPart[] parts, IUniformBuffer<GlobalUniformData> globalUniformBuffer)
-            => new GLShader(this, name, parts.Cast<GLShaderPart>().ToArray(), globalUniformBuffer);
+        protected override IShader CreateShader(string name, IShaderPart[] parts, IUniformBuffer<GlobalUniformData> globalUniformBuffer, ShaderCompilationStore compilationStore)
+            => new GLShader(this, name, parts.Cast<GLShaderPart>().ToArray(), globalUniformBuffer, compilationStore);
 
         public override IFrameBuffer CreateFrameBuffer(RenderBufferFormat[]? renderBufferFormats = null, TextureFilteringMode filteringMode = TextureFilteringMode.Linear)
         {

osu.Framework/Graphics/OpenGL/Shaders/GLShader.cs

@@ -1,12 +1,10 @@
 // Copyright (c) ppy Pty Ltd <[email protected]>. Licensed under the MIT Licence.
 // See the LICENCE file in the repository root for full licence text.
 
-#nullable disable
-
 using System;
 using System.Collections.Generic;
 using System.Linq;
-using System.Text;
+using osu.Framework.Extensions.ObjectExtensions;
 using osu.Framework.Graphics.OpenGL.Buffers;
 using osu.Framework.Graphics.Rendering;
 using osu.Framework.Graphics.Shaders;
@@ -42,14 +40,14 @@ internal class GLShader : IShader
 
         private readonly GLShaderPart vertexPart;
         private readonly GLShaderPart fragmentPart;
-        private readonly VertexFragmentCompilationResult crossCompileResult;
+        private readonly VertexFragmentShaderCompilation compilation;
 
-        internal GLShader(GLRenderer renderer, string name, GLShaderPart[] parts, IUniformBuffer<GlobalUniformData> globalUniformBuffer)
+        internal GLShader(GLRenderer renderer, string name, GLShaderPart[] parts, IUniformBuffer<GlobalUniformData> globalUniformBuffer, ShaderCompilationStore compilationStore)
         {
             this.renderer = renderer;
             this.name = name;
             this.globalUniformBuffer = globalUniformBuffer;
-            this.parts = parts.Where(p => p != null).ToArray();
+            this.parts = parts;
 
             vertexPart = parts.Single(p => p.Type == ShaderType.VertexShader);
             fragmentPart = parts.Single(p => p.Type == ShaderType.FragmentShader);
@@ -59,9 +57,9 @@ internal GLShader(GLRenderer renderer, string name, GLShaderPart[] parts, IUnifo
             try
             {
                 // Shaders are in "Vulkan GLSL" format. They need to be cross-compiled to GLSL.
-                crossCompileResult = SpirvCompilation.CompileVertexFragment(
-                    Encoding.UTF8.GetBytes(vertexPart.GetRawText()),
-                    Encoding.UTF8.GetBytes(fragmentPart.GetRawText()),
+                compilation = compilationStore.CompileVertexFragment(
+                    vertexPart.GetRawText(),
+                    fragmentPart.GetRawText(),
                     renderer.IsEmbedded ? CrossCompileTarget.ESSL : CrossCompileTarget.GLSL);
             }
             catch (Exception e)
@@ -158,8 +156,8 @@ public virtual void BindUniformBlock(string blockName, IUniformBuffer buffer)
 
         private protected virtual bool CompileInternal()
         {
-            vertexPart.Compile(crossCompileResult.VertexShader);
-            fragmentPart.Compile(crossCompileResult.FragmentShader);
+            vertexPart.Compile(compilation.VertexText);
+            fragmentPart.Compile(compilation.FragmentText);
 
             foreach (GLShaderPart p in parts)
                 GL.AttachShader(this, p);
@@ -176,7 +174,7 @@ private protected virtual bool CompileInternal()
             int blockBindingIndex = 0;
             int textureIndex = 0;
 
-            foreach (ResourceLayoutDescription layout in crossCompileResult.Reflection.ResourceLayouts)
+            foreach (ResourceLayoutDescription layout in compilation.Reflection.ResourceLayouts)
             {
                 if (layout.Elements.Length == 0)
                     continue;
@@ -226,15 +224,16 @@ public void Dispose()
 
         protected virtual void Dispose(bool disposing)
         {
-            if (!IsDisposed)
-            {
-                IsDisposed = true;
+            if (IsDisposed)
+                return;
 
-                shaderCompileDelegate?.Cancel();
+            IsDisposed = true;
 
-                if (programID != -1)
-                    DeleteProgram(this);
-            }
+            if (shaderCompileDelegate.IsNotNull())
+                shaderCompileDelegate.Cancel();
+
+            if (programID != -1)
+                DeleteProgram(this);
         }
 
         #endregion

osu.Framework/Graphics/OpenGL/Shaders/GLShaderPart.cs

@@ -1,8 +1,6 @@
 // Copyright (c) ppy Pty Ltd <[email protected]>. Licensed under the MIT Licence.
 // See the LICENCE file in the repository root for full licence text.
 
-#nullable disable
-
 using System;
 using System.Collections.Generic;
 using System.Globalization;
@@ -31,7 +29,7 @@ internal class GLShaderPart : IShaderPart
 
         private int partID = -1;
 
-        public GLShaderPart(IRenderer renderer, string name, byte[] data, ShaderType type, IShaderStore store)
+        public GLShaderPart(IRenderer renderer, string name, byte[]? data, ShaderType type, IShaderStore store)
         {
             this.renderer = renderer;
             this.store = store;
@@ -62,10 +60,10 @@ public GLShaderPart(IRenderer renderer, string name, byte[] data, ShaderType typ
                 shaderCodes[i] = uniform_pattern.Replace(shaderCodes[i], match => $"{match.Groups[1].Value}set = {int.Parse(match.Groups[2].Value, CultureInfo.InvariantCulture) + 1}{match.Groups[3].Value}");
         }
 
-        private string loadFile(byte[] bytes, bool mainFile)
+        private string loadFile(byte[]? bytes, bool mainFile)
         {
             if (bytes == null)
-                return null;
+                return string.Empty;
 
             using (MemoryStream ms = new MemoryStream(bytes))
             using (StreamReader sr = new StreamReader(ms))
@@ -74,7 +72,7 @@ private string loadFile(byte[] bytes, bool mainFile)
 
                 while (sr.Peek() != -1)
                 {
-                    string line = sr.ReadLine();
+                    string? line = sr.ReadLine();
 
                     if (string.IsNullOrEmpty(line))
                     {
@@ -123,10 +121,10 @@ private string loadFile(byte[] bytes, bool mainFile)
 
                         if (!string.IsNullOrEmpty(backbufferCode))
                         {
-                            string realMainName = "real_main_" + Guid.NewGuid().ToString("N");
+                            const string real_main_name = "__internal_real_main";
 
-                            backbufferCode = backbufferCode.Replace("{{ real_main }}", realMainName);
-                            code = Regex.Replace(code, @"void main\((.*)\)", $"void {realMainName}()") + backbufferCode + '\n';
+                            backbufferCode = backbufferCode.Replace("{{ real_main }}", real_main_name);
+                            code = Regex.Replace(code, @"void main\((.*)\)", $"void {real_main_name}()") + backbufferCode + '\n';
                         }
                     }
                 }

osu.Framework/Graphics/Rendering/Dummy/DummyRenderer.cs

@@ -57,6 +57,8 @@ public DummyRenderer()
 
         bool IRenderer.AllowTearing { get; set; }
 
+        Storage? IRenderer.CacheStorage { set { } }
+
         void IRenderer.Initialise(IGraphicsSurface graphicsSurface)
         {
             IsInitialised = true;

osu.Framework/Graphics/Rendering/IRenderer.cs

@@ -51,6 +51,11 @@ public interface IRenderer
 
         protected internal bool AllowTearing { get; set; }
 
+        /// <summary>
+        /// A <see cref="Storage"/> that can be used to cache objects.
+        /// </summary>
+        protected internal Storage? CacheStorage { set; }
+
         /// <summary>
         /// The maximum allowed texture size.
         /// </summary>

osu.Framework/Graphics/Rendering/Renderer.cs

@@ -44,6 +44,11 @@ public abstract class Renderer : IRenderer
         protected internal abstract bool VerticalSync { get; set; }
         protected internal abstract bool AllowTearing { get; set; }
 
+        protected internal Storage? CacheStorage
+        {
+            set => shaderCompilationStore.CacheStorage = value;
+        }
+
         public int MaxTextureSize { get; protected set; } = 4096; // default value is to allow roughly normal flow in cases we don't have graphics context, like headless CI.
 
         public int MaxTexturesUploadedPerFrame { get; set; } = 32;
@@ -94,6 +99,8 @@ public abstract class Renderer : IRenderer
         /// </summary>
         protected IShader? Shader { get; private set; }
 
+        private readonly ShaderCompilationStore shaderCompilationStore = new ShaderCompilationStore();
+
         private readonly GlobalStatistic<int> statExpensiveOperationsQueued;
         private readonly GlobalStatistic<int> statTextureUploadsQueued;
         private readonly GlobalStatistic<int> statTextureUploadsDequeued;
@@ -1036,7 +1043,7 @@ internal void SetUniform<T>(IUniformWithValue<T> uniform)
         protected abstract IShaderPart CreateShaderPart(IShaderStore store, string name, byte[]? rawData, ShaderPartType partType);
 
         /// <inheritdoc cref="IRenderer.CreateShader"/>
-        protected abstract IShader CreateShader(string name, IShaderPart[] parts, IUniformBuffer<GlobalUniformData> globalUniformBuffer);
+        protected abstract IShader CreateShader(string name, IShaderPart[] parts, IUniformBuffer<GlobalUniformData> globalUniformBuffer, ShaderCompilationStore compilationStore);
 
         private IShader? mipmapShader;
 
@@ -1056,7 +1063,7 @@ internal IShader GetMipmapShader()
             {
                 CreateShaderPart(store, "mipmap.vs", store.GetRawData("sh_mipmap.vs"), ShaderPartType.Vertex),
                 CreateShaderPart(store, "mipmap.fs", store.GetRawData("sh_mipmap.fs"), ShaderPartType.Fragment),
-            }, globalUniformBuffer.AsNonNull());
+            }, globalUniformBuffer.AsNonNull(), shaderCompilationStore);
 
             return mipmapShader;
         }
@@ -1128,6 +1135,11 @@ bool IRenderer.AllowTearing
             set => AllowTearing = value;
         }
 
+        Storage? IRenderer.CacheStorage
+        {
+            set => CacheStorage = value;
+        }
+
         IVertexBatch<TexturedVertex2D> IRenderer.DefaultQuadBatch => DefaultQuadBatch;
         void IRenderer.BeginFrame(Vector2 windowSize) => BeginFrame(windowSize);
         void IRenderer.FinishFrame() => FinishFrame();
@@ -1143,7 +1155,7 @@ bool IRenderer.AllowTearing
         void IRenderer.PopQuadBatch() => PopQuadBatch();
         Image<Rgba32> IRenderer.TakeScreenshot() => TakeScreenshot();
         IShaderPart IRenderer.CreateShaderPart(IShaderStore store, string name, byte[]? rawData, ShaderPartType partType) => CreateShaderPart(store, name, rawData, partType);
-        IShader IRenderer.CreateShader(string name, IShaderPart[] parts) => CreateShader(name, parts, globalUniformBuffer!);
+        IShader IRenderer.CreateShader(string name, IShaderPart[] parts) => CreateShader(name, parts, globalUniformBuffer!, shaderCompilationStore);
 
         IVertexBatch<TVertex> IRenderer.CreateLinearBatch<TVertex>(int size, int maxBuffers, PrimitiveTopology topology)
         {

osu.Framework/Graphics/Shaders/ComputeProgramCompilation.cs

@@ -0,0 +1,30 @@
+// Copyright (c) ppy Pty Ltd <[email protected]>. Licensed under the MIT Licence.
+// See the LICENCE file in the repository root for full licence text.
+
+using Veldrid.SPIRV;
+
+namespace osu.Framework.Graphics.Shaders
+{
+    public class ComputeProgramCompilation
+    {
+        /// <summary>
+        /// Whether this compilation was retrieved from cache.
+        /// </summary>
+        public bool WasCached { get; set; }
+
+        /// <summary>
+        /// The SpirV bytes for the program.
+        /// </summary>
+        public byte[] ProgramBytes { get; set; } = null!;
+
+        /// <summary>
+        /// The cross-compiled program text.
+        /// </summary>
+        public string ProgramText { get; set; } = null!;
+
+        /// <summary>
+        /// A reflection of the shader program, describing the layout of resources.
+        /// </summary>
+        public SpirvReflection Reflection { get; set; } = null!;
+    }
+}