misc: Rename DirtyHacks to DirtyHack

Rename DirtyHack.ShaderCompilationThreadSleep to ShaderTranslationDelay
Changed EnabledDirtyHack to a struct
rename DirtyHackCollection to DirtyHacks

src/Ryujinx.Common/BitTricks.cs

@@ -1,35 +0,0 @@
-namespace Ryujinx.Common
-{
-    public class BitTricks
-    {
-        // Never actually written bit packing logic before, so I looked it up.
-        // This code is from https://gist.github.com/Alan-FGR/04938e93e2bffdf5802ceb218a37c195
-        
-        public static ulong PackBitFields(uint[] values, byte[] bitFields)
-        {
-            ulong retVal = values[0]; //we set the first value right away
-            for (int f = 1; f < values.Length; f++)
-            {
-                retVal <<= bitFields[f]; // we shift the previous value
-                retVal += values[f];// and add our current value
-            }
-            return retVal;
-        }
-
-        public static uint[] UnpackBitFields(ulong packed, byte[] bitFields)
-        {
-            int fields = bitFields.Length - 1; // number of fields to unpack
-            uint[] retArr = new uint[fields + 1]; // init return array
-            int curPos = 0; // current field bit position (start)
-            int lastEnd; // position where last field ended
-            for (int f = fields; f >= 0; f--) // loop from last
-            {
-                lastEnd = curPos; // we store where the last value ended
-                curPos += bitFields[f]; // we get where the current value starts
-                int leftShift = 64 - curPos; // we figure how much left shift we gotta apply for the other numbers to overflow into oblivion
-                retArr[f] = (uint)((packed << leftShift) >> leftShift + lastEnd); // we do magic
-            }
-            return retArr;
-        }
-    }
-}

src/Ryujinx.Common/Configuration/DirtyHack.cs

@@ -0,0 +1,60 @@
+using Gommon;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+
+namespace Ryujinx.Common.Configuration
+{
+    [Flags]
+    public enum DirtyHack : byte
+    {
+        Xc2MenuSoftlockFix = 1,
+        ShaderTranslationDelay = 2
+    }
+
+    public readonly struct EnabledDirtyHack(DirtyHack hack, int value)
+    {
+        public DirtyHack Hack => hack;
+        public int Value => value;
+        
+        
+        
+        public ulong Pack() => Raw.PackBitFields(PackedFormat);
+
+        public static EnabledDirtyHack Unpack(ulong packedHack)
+        {
+            var unpackedFields = packedHack.UnpackBitFields(PackedFormat);
+            if (unpackedFields is not [var hack, var value])
+                throw new ArgumentException(nameof(packedHack));
+            
+            return new EnabledDirtyHack((DirtyHack)hack, (int)value);
+        }
+        
+        private uint[] Raw => [(uint)Hack, (uint)Value.CoerceAtLeast(0)];
+        
+        public static readonly byte[] PackedFormat = [8, 32];
+    }
+
+    public class DirtyHacks : Dictionary<DirtyHack, int>
+    {
+        public DirtyHacks(IEnumerable<EnabledDirtyHack> hacks) 
+            => hacks.ForEach(edh => Add(edh.Hack, edh.Value));
+
+        public DirtyHacks(ulong[] packedHacks) : this(packedHacks.Select(EnabledDirtyHack.Unpack)) {}
+
+        public ulong[] PackEntries() 
+            => Entries.Select(it => it.Pack()).ToArray();
+        
+        public EnabledDirtyHack[] Entries 
+            => this
+                .Select(it => new EnabledDirtyHack(it.Key, it.Value))
+                .ToArray();
+
+        public static implicit operator DirtyHacks(EnabledDirtyHack[] hacks) => new(hacks);
+        public static implicit operator DirtyHacks(ulong[] packedHacks) => new(packedHacks);
+
+        public new int this[DirtyHack hack] => TryGetValue(hack, out var value) ? value : -1;
+
+        public bool IsEnabled(DirtyHack hack) => ContainsKey(hack);
+    }
+}

src/Ryujinx.Common/Configuration/DirtyHacks.cs

@@ -1,61 +0,0 @@
-using System;
-using System.Collections.Generic;
-using System.Linq;
-
-namespace Ryujinx.Common.Configuration
-{
-    [Flags]
-    public enum DirtyHacks : byte
-    {
-        Xc2MenuSoftlockFix = 1,
-        ShaderCompilationThreadSleep = 2
-    }
-
-    public record EnabledDirtyHack(DirtyHacks Hack, int Value)
-    {
-        public static readonly byte[] PackedFormat = [8, 32];
-        
-        public ulong Pack() => BitTricks.PackBitFields([(uint)Hack, (uint)Value], PackedFormat);
-
-        public static EnabledDirtyHack Unpack(ulong packedHack)
-        {
-            var unpackedFields = BitTricks.UnpackBitFields(packedHack, PackedFormat);
-            if (unpackedFields is not [var hack, var value])
-                throw new ArgumentException(nameof(packedHack));
-            
-            return new EnabledDirtyHack((DirtyHacks)hack, (int)value);
-        }
-    }
-
-    public class DirtyHackCollection : Dictionary<DirtyHacks, int>
-    {
-        public DirtyHackCollection(EnabledDirtyHack[] hacks)
-        {
-            foreach ((DirtyHacks dirtyHacks, int value) in hacks)
-            {
-                Add(dirtyHacks, value);
-            }
-        }
-        
-        public DirtyHackCollection(ulong[] packedHacks)
-        {
-            foreach ((DirtyHacks dirtyHacks, int value) in packedHacks.Select(EnabledDirtyHack.Unpack))
-            {
-                Add(dirtyHacks, value);
-            }
-        }
-
-        public ulong[] PackEntries() =>
-            this
-                .Select(it => 
-                    BitTricks.PackBitFields([(uint)it.Key, (uint)it.Value], EnabledDirtyHack.PackedFormat))
-                .ToArray();
-
-        public static implicit operator DirtyHackCollection(EnabledDirtyHack[] hacks) => new(hacks);
-        public static implicit operator DirtyHackCollection(ulong[] packedHacks) => new(packedHacks);
-
-        public new int this[DirtyHacks hack] => TryGetValue(hack, out var value) ? value : -1;
-
-        public bool IsEnabled(DirtyHacks hack) => ContainsKey(hack);
-    }
-}

src/Ryujinx.Common/Utilities/BitUtils.cs

@@ -40,5 +40,35 @@ namespace Ryujinx.Common
 
             return (value >> 32) | (value << 32);
         }
+        
+        // Never actually written bit packing logic before, so I looked it up.
+        // This code is from https://gist.github.com/Alan-FGR/04938e93e2bffdf5802ceb218a37c195
+        
+        public static ulong PackBitFields(this uint[] values, byte[] bitFields)
+        {
+            ulong retVal = values[0]; //we set the first value right away
+            for (int f = 1; f < values.Length; f++)
+            {
+                retVal <<= bitFields[f]; // we shift the previous value
+                retVal += values[f];// and add our current value
+            }
+            return retVal;
+        }
+
+        public static uint[] UnpackBitFields(this ulong packed, byte[] bitFields)
+        {
+            int fields = bitFields.Length - 1; // number of fields to unpack
+            uint[] retArr = new uint[fields + 1]; // init return array
+            int curPos = 0; // current field bit position (start)
+            int lastEnd; // position where last field ended
+            for (int f = fields; f >= 0; f--) // loop from last
+            {
+                lastEnd = curPos; // we store where the last value ended
+                curPos += bitFields[f]; // we get where the current value starts
+                int leftShift = 64 - curPos; // we figure how much left shift we gotta apply for the other numbers to overflow into oblivion
+                retArr[f] = (uint)((packed << leftShift) >> leftShift + lastEnd); // we do magic
+            }
+            return retArr;
+        }
     }
 }

src/Ryujinx.Graphics.Gpu/GpuContext.cs

@@ -92,7 +92,11 @@ namespace Ryujinx.Graphics.Gpu
         /// </summary>
         internal SupportBufferUpdater SupportBufferUpdater { get; }
         
-        internal DirtyHackCollection DirtyHacks { get; }
+        /// <summary>
+        /// Enabled dirty hacks.
+        /// Used for workarounds to emulator bugs we can't fix/don't know how to fix yet.
+        /// </summary>
+        internal DirtyHacks DirtyHacks { get; }
         
 
         /// <summary>
@@ -117,7 +121,7 @@ namespace Ryujinx.Graphics.Gpu
         /// Creates a new instance of the GPU emulation context.
         /// </summary>
         /// <param name="renderer">Host renderer</param>
-        public GpuContext(IRenderer renderer, DirtyHackCollection hackCollection)
+        public GpuContext(IRenderer renderer, DirtyHacks hacks)
         {
             Renderer = renderer;
 
@@ -140,7 +144,7 @@ namespace Ryujinx.Graphics.Gpu
 
             SupportBufferUpdater = new SupportBufferUpdater(renderer);
 
-            DirtyHacks = hackCollection;
+            DirtyHacks = hacks;
 
             _firstTimestamp = ConvertNanosecondsToTicks((ulong)PerformanceCounter.ElapsedNanoseconds);
         }

src/Ryujinx.Graphics.Gpu/Shader/DiskCache/ParallelDiskCacheLoader.cs

@@ -367,8 +367,8 @@ namespace Ryujinx.Graphics.Gpu.Shader.DiskCache
         {
             try
             {
-                if (_context.DirtyHacks.IsEnabled(DirtyHacks.ShaderCompilationThreadSleep))
-                    Thread.Sleep(_context.DirtyHacks[DirtyHacks.ShaderCompilationThreadSleep]);
+                if (_context.DirtyHacks.IsEnabled(DirtyHack.ShaderTranslationDelay))
+                    Thread.Sleep(_context.DirtyHacks[DirtyHack.ShaderTranslationDelay]);
                 
                 AsyncProgramTranslation asyncTranslation = new(guestShaders, specState, programIndex, isCompute);
                 _asyncTranslationQueue.Add(asyncTranslation, _cancellationToken);

src/Ryujinx.HLE/HOS/Services/Fs/FileSystemProxy/IStorage.cs

@@ -39,7 +39,7 @@ namespace Ryujinx.HLE.HOS.Services.Fs.FileSystemProxy
                 using var region = context.Memory.GetWritableRegion(bufferAddress, (int)bufferLen, true);
                 Result result = _baseStorage.Get.Read((long)offset, new OutBuffer(region.Memory.Span), (long)size);
                 
-                if (context.Device.DirtyHacks.IsEnabled(DirtyHacks.Xc2MenuSoftlockFix) && TitleIDs.CurrentApplication.Value == Xc2TitleId)
+                if (context.Device.DirtyHacks.IsEnabled(DirtyHack.Xc2MenuSoftlockFix) && TitleIDs.CurrentApplication.Value == Xc2TitleId)
                 {
                     // Add a load-bearing sleep to avoid XC2 softlock
                     // https://web.archive.org/web/20240728045136/https://github.com/Ryujinx/Ryujinx/issues/2357

src/Ryujinx.HLE/Switch.cs

@@ -40,7 +40,7 @@ namespace Ryujinx.HLE
 
         public bool IsFrameAvailable => Gpu.Window.IsFrameAvailable;
 
-        public DirtyHackCollection DirtyHacks { get; }
+        public DirtyHacks DirtyHacks { get; }
 
         public Switch(HLEConfiguration configuration)
         {
@@ -57,7 +57,7 @@ namespace Ryujinx.HLE
                 : MemoryAllocationFlags.Reserve | MemoryAllocationFlags.Mirrorable;
 
 #pragma warning disable IDE0055 // Disable formatting
-            DirtyHacks        = new DirtyHackCollection(Configuration.Hacks);
+            DirtyHacks        = new DirtyHacks(Configuration.Hacks);
             AudioDeviceDriver = new CompatLayerHardwareDeviceDriver(Configuration.AudioDeviceDriver);
             Memory            = new MemoryBlock(Configuration.MemoryConfiguration.ToDramSize(), memoryAllocationFlags);
             Gpu               = new GpuContext(Configuration.GpuRenderer, DirtyHacks);

src/Ryujinx/Utilities/Configuration/ConfigurationState.Migration.cs

@@ -1,3 +1,4 @@
+using Gommon;
 using Ryujinx.Ava.Utilities.Configuration.System;
 using Ryujinx.Ava.Utilities.Configuration.UI;
 using Ryujinx.Common.Configuration;
@@ -9,7 +10,6 @@ using Ryujinx.Common.Logging;
 using Ryujinx.HLE;
 using System;
 using System.Collections.Generic;
-using System.Linq;
 
 namespace Ryujinx.Ava.Utilities.Configuration
 {
@@ -752,14 +752,12 @@ namespace Ryujinx.Ava.Utilities.Configuration
             Hacks.ShowDirtyHacks.Value = configurationFileFormat.ShowDirtyHacks;
 
             {
-                EnabledDirtyHack[] hacks = (configurationFileFormat.DirtyHacks ?? []).Select(EnabledDirtyHack.Unpack).ToArray();
-            
-                Hacks.Xc2MenuSoftlockFix.Value = hacks.Any(it => it.Hack == DirtyHacks.Xc2MenuSoftlockFix);
-                
-                var shaderCompilationThreadSleep = hacks.FirstOrDefault(it => 
-                    it.Hack == DirtyHacks.ShaderCompilationThreadSleep);
-                Hacks.EnableShaderTranslationDelay.Value = shaderCompilationThreadSleep != null;
-                Hacks.ShaderTranslationDelay.Value = shaderCompilationThreadSleep?.Value ?? 0;
+                DirtyHacks hacks = new (configurationFileFormat.DirtyHacks ?? []);
+
+                Hacks.Xc2MenuSoftlockFix.Value = hacks.IsEnabled(DirtyHack.Xc2MenuSoftlockFix);
+
+                Hacks.EnableShaderTranslationDelay.Value = hacks.IsEnabled(DirtyHack.ShaderTranslationDelay);
+                Hacks.ShaderTranslationDelay.Value = hacks[DirtyHack.ShaderTranslationDelay].CoerceAtLeast(0);
             }
 
             if (configurationFileUpdated)

src/Ryujinx/Utilities/Configuration/ConfigurationState.Model.cs

@@ -666,14 +666,14 @@ namespace Ryujinx.Ava.Utilities.Configuration
                     List<EnabledDirtyHack> enabledHacks = [];
                     
                     if (Xc2MenuSoftlockFix)
-                        Apply(DirtyHacks.Xc2MenuSoftlockFix);
+                        Apply(DirtyHack.Xc2MenuSoftlockFix);
                     
                     if (EnableShaderTranslationDelay)
-                        Apply(DirtyHacks.ShaderCompilationThreadSleep, ShaderTranslationDelay);
+                        Apply(DirtyHack.ShaderTranslationDelay, ShaderTranslationDelay);
                     
                     return enabledHacks.ToArray();
 
-                    void Apply(DirtyHacks hack, int value = 0)
+                    void Apply(DirtyHack hack, int value = 0)
                     {
                         enabledHacks.Add(new EnabledDirtyHack(hack, value));
                     }