Finish implementing logic for wrapping the vkCreateInstance/Device methods

Author: Exanite

.silktouch/d48a9fc4a502f7c6.stout

@@ -177,8 +177,8 @@
         "TransformFunctions",
         "TransformProperties",
         "TransformEnums",
-        "TransformVulkan",
-        "AddVTables"
+        "AddVTables",
+        "TransformVulkan"
       ],
       "ClangScraper": {
         "ClangSharpResponseFiles": [
@@ -209,11 +209,8 @@
       "AddVTables": {
         "VTables": [
           {
-            "Kind": "DllImport",
+            "Kind": "ThisThread",
             "IsDefault": true
-          },
-          {
-            "Kind": "StaticWrapper"
           }
         ]
       },

generator.json

@@ -10,6 +10,24 @@ namespace Silk.NET.SilkTouch.Mods;
 /// </summary>
 public class TransformVulkan : IMod
 {
+    private const string MethodClassName = "Vk";
+
+    private const string InstanceTypeName = "InstanceHandle";
+    private const string InstanceNativeTypeName = "VkInstance";
+    private const string InstanceFieldName = "_currentInstance";
+    private const string InstancePropertyName = "CurrentInstance";
+
+    private const string DeviceTypeName = "DeviceHandle";
+    private const string DeviceNativeTypeName = "VkDevice";
+    private const string DeviceFieldName = "_currentDevice";
+    private const string DevicePropertyName = "CurrentDevice";
+
+    private const string VkCreateInstanceNativeName = "vkCreateInstance";
+    private const string VkCreateDeviceNativeName = "vkCreateDevice";
+
+    private const string VkResultName = "Result";
+    private const string VkResultSuccessName = "Success";
+
     /// <inheritdoc />
     public async Task ExecuteAsync(IModContext ctx, CancellationToken ct = default)
     {
@@ -38,25 +56,47 @@ public async Task ExecuteAsync(IModContext ctx, CancellationToken ct = default)
         ctx.SourceProject = proj;
     }
 
-    private class Rewriter : CSharpSyntaxRewriter
+    /// <summary>
+    /// Used by <see cref="Rewriter"/> to identify methods that call
+    /// the native function pointer through the vtable slots field.
+    /// </summary>
+    private class SlotsMethodIdentifier : CSharpSyntaxWalker
     {
-        private const string MethodClassName = "Vk";
+        public bool IsSlotsMethod { get; private set; }
+
+        private bool isInInvocationExpression = false;
+
+        public override void VisitMethodDeclaration(MethodDeclarationSyntax node)
+        {
+            IsSlotsMethod = false;
+            base.VisitMethodDeclaration(node);
+        }
 
-        private const string InstanceTypeName = "InstanceHandle";
-        private const string InstanceNativeTypeName = "VkInstance";
-        private const string InstanceFieldName = "_currentInstance";
-        private const string InstancePropertyName = "CurrentInstance";
+        public override void VisitInvocationExpression(InvocationExpressionSyntax node)
+        {
+            isInInvocationExpression = true;
+            base.VisitInvocationExpression(node);
+        }
 
-        private const string DeviceTypeName = "DeviceHandle";
-        private const string DeviceNativeTypeName = "VkDevice";
-        private const string DeviceFieldName = "_currentDevice";
-        private const string DevicePropertyName = "CurrentDevice";
+        public override void VisitFunctionPointerType(FunctionPointerTypeSyntax node)
+        {
+            if (isInInvocationExpression)
+            {
+                IsSlotsMethod = true;
+            }
+        }
+    }
 
-        private const string VkCreateInstanceNativeName = "vkCreateInstance";
-        private const string VkCreateDeviceNativeName = "vkCreateDevice";
+    /// <summary>
+    /// This does the following:
+    /// 1. Add the instance/device members.
+    /// 2. Rewrite the vkCreateInstance and vkCreateDevice methods to set those members.
+    /// </summary>
+    private class Rewriter : CSharpSyntaxRewriter
+    {
+        private readonly SlotsMethodIdentifier slotsMethodIdentifier = new();
 
-        private const string VkResultName = "Result";
-        private const string VkResultSuccessName = "Success";
+        private bool hasOutputInstanceDeviceMembers;
 
         public override SyntaxNode? VisitClassDeclaration(ClassDeclarationSyntax node)
         {
@@ -65,28 +105,39 @@ private class Rewriter : CSharpSyntaxRewriter
                 return base.VisitClassDeclaration(node);
             }
 
-            var instanceField = FieldDeclaration(
-                VariableDeclaration(NullableType(IdentifierName(InstanceTypeName)))
-                    .AddVariables(VariableDeclarator(InstanceFieldName))
-            ).AddModifiers(Token(SyntaxKind.PrivateKeyword));
+            // Rewrite members
+            node = node.WithMembers([
+                ..node.Members.SelectMany(RewriteMember)
+            ]);
 
+            // Output instance/device members if needed
+            if (!hasOutputInstanceDeviceMembers)
+            {
+                var instanceField = FieldDeclaration(
+                    VariableDeclaration(NullableType(IdentifierName(InstanceTypeName)))
+                        .AddVariables(VariableDeclarator(InstanceFieldName))
+                ).AddModifiers(Token(SyntaxKind.PrivateKeyword));
 
-            var deviceField = FieldDeclaration(
-                VariableDeclaration(NullableType(IdentifierName(DeviceTypeName)))
-                    .AddVariables(VariableDeclarator(DeviceFieldName))
-            ).AddModifiers(Token(SyntaxKind.PrivateKeyword));
 
-            var instanceProperty = CreateProperty(InstanceTypeName, InstancePropertyName, InstanceFieldName);
+                var deviceField = FieldDeclaration(
+                    VariableDeclaration(NullableType(IdentifierName(DeviceTypeName)))
+                        .AddVariables(VariableDeclarator(DeviceFieldName))
+                ).AddModifiers(Token(SyntaxKind.PrivateKeyword));
 
-            var deviceProperty = CreateProperty(DeviceTypeName, DevicePropertyName, DeviceFieldName);
+                var instanceProperty = CreateProperty(InstanceTypeName, InstancePropertyName, InstanceFieldName);
 
-            node = node.WithMembers([
-                instanceField,
-                deviceField,
-                instanceProperty,
-                deviceProperty,
-                ..node.Members.SelectMany(RewriteMember)
-            ]);
+                var deviceProperty = CreateProperty(DeviceTypeName, DevicePropertyName, DeviceFieldName);
+
+                node = node.WithMembers([
+                    instanceField,
+                    deviceField,
+                    instanceProperty,
+                    deviceProperty,
+                    ..node.Members
+                ]);
+            }
+
+            hasOutputInstanceDeviceMembers = true;
 
             return base.VisitClassDeclaration(node);
         }
@@ -105,13 +156,14 @@ private IEnumerable<MemberDeclarationSyntax> RewriteMember(MemberDeclarationSynt
                 yield break;
             }
 
-            if (!method.Modifiers.Any(modifier => modifier.IsKind(SyntaxKind.ExternKeyword)))
+            if (entryPoint != VkCreateInstanceNativeName && entryPoint != VkCreateDeviceNativeName)
             {
                 yield return member;
                 yield break;
             }
 
-            if (entryPoint != VkCreateInstanceNativeName && entryPoint != VkCreateDeviceNativeName)
+            slotsMethodIdentifier.Visit(member);
+            if (!slotsMethodIdentifier.IsSlotsMethod)
             {
                 yield return member;
                 yield break;
@@ -122,9 +174,9 @@ private IEnumerable<MemberDeclarationSyntax> RewriteMember(MemberDeclarationSynt
 
             // Output the original method, but private
             yield return method
+                .WithExplicitInterfaceSpecifier(null)
                 .WithIdentifier(Identifier(privateMethodName))
                 .WithModifiers([
-                    Token(SyntaxKind.PrivateKeyword),
                     ..member.Modifiers.Where(modifier =>
                         !SyntaxFacts.IsAccessibilityModifier(modifier.Kind()))
                 ]);

sources/SilkTouch/SilkTouch/Mods/TransformVulkan.cs

@@ -12,15 +12,14 @@ namespace Silk.NET.Vulkan;
 
 partial class Vk(INativeContext nativeContext) : IDisposable
 {
-    public partial class DllImport
+    public partial class ThisThread : IVk.Static
     {
-        static DllImport() => LoaderInterface.RegisterHook(Assembly.GetExecutingAssembly());
+        public static ThreadLocal<IVk> Underlying { get; } = new();
+
+        public static void MakeCurrent(IVk ctx) => Underlying.Value = ctx;
     }
 
     private readonly unsafe void*[] _slots = new void*[696];
-    public static IVk Instance { get; } = new StaticWrapper<DllImport>();
-
-    public static IVk Create() => Instance;
 
     public static IVk Create(INativeContext ctx) => new Vk(ctx);
 

sources/Vulkan/Vulkan/Vk.gen.cs

@@ -8449,7 +8449,7 @@ Ref<DescriptorUpdateTemplateHandle> pDescriptorUpdateTemplate
             MinVersion = "1.0"
         )]
         [NativeFunction("vulkan", EntryPoint = "vkCreateDevice")]
-        static abstract Result CreateDeviceInternal(
+        static abstract Result CreateDevice(
             [NativeTypeName("VkPhysicalDevice")] PhysicalDeviceHandle physicalDevice,
             [NativeTypeName("const VkDeviceCreateInfo *")] DeviceCreateInfo* pCreateInfo,
             [NativeTypeName("const VkAllocationCallbacks *")] AllocationCallbacks* pAllocator,
@@ -8934,7 +8934,7 @@ Ref<IndirectExecutionSetEXTHandle> pIndirectExecutionSet
             MinVersion = "1.0"
         )]
         [NativeFunction("vulkan", EntryPoint = "vkCreateInstance")]
-        static abstract Result CreateInstanceInternal(
+        static abstract Result CreateInstance(
             [NativeTypeName("const VkInstanceCreateInfo *")] InstanceCreateInfo* pCreateInfo,
             [NativeTypeName("const VkAllocationCallbacks *")] AllocationCallbacks* pAllocator,
             [NativeTypeName("VkInstance *")] InstanceHandle* pInstance
@@ -26670,7 +26670,7 @@ Ref<DescriptorUpdateTemplateHandle> pDescriptorUpdateTemplate
         MinVersion = "1.0"
     )]
     [NativeFunction("vulkan", EntryPoint = "vkCreateDevice")]
-    Result CreateDeviceInternal(
+    Result CreateDevice(
         [NativeTypeName("VkPhysicalDevice")] PhysicalDeviceHandle physicalDevice,
         [NativeTypeName("const VkDeviceCreateInfo *")] DeviceCreateInfo* pCreateInfo,
         [NativeTypeName("const VkAllocationCallbacks *")] AllocationCallbacks* pAllocator,
@@ -27061,7 +27061,7 @@ Ref<IndirectExecutionSetEXTHandle> pIndirectExecutionSet
         MinVersion = "1.0"
     )]
     [NativeFunction("vulkan", EntryPoint = "vkCreateInstance")]
-    Result CreateInstanceInternal(
+    Result CreateInstance(
         [NativeTypeName("const VkInstanceCreateInfo *")] InstanceCreateInfo* pCreateInfo,
         [NativeTypeName("const VkAllocationCallbacks *")] AllocationCallbacks* pAllocator,
         [NativeTypeName("VkInstance *")] InstanceHandle* pInstance