Added Logging to ClangScraper

Author: curin

sources/SilkTouch/SilkTouch/Clang/ClangScraper.cs

@@ -97,11 +97,13 @@ public record Configuration
     /// Runs ClangSharp to obtain the raw bindings for the given response file.
     /// </summary>
     /// <param name="config">The ClangSharp configuration.</param>
+    /// <param name="rspIndex">the index of the current rsp for logging</param>
+    /// <param name="rspCount">the total number of rsps</param>
     private (
         IEnumerable<KeyValuePair<string, Stream>> Sources,
         IEnumerable<KeyValuePair<string, Stream>> Tests,
         bool HasErrors
-    ) ScrapeRawBindings(ResponseFile config)
+    ) ScrapeRawBindings(ResponseFile config, int rspIndex, int rspCount)
     {
         var files = new Dictionary<string, Stream>();
 
@@ -121,8 +123,11 @@ Stream OutputStreamFactory(string fileName)
             OutputStreamFactory
         );
         var hasErrors = false;
+        int index = 0;
+        int count = config.Files.Count;
         foreach (var file in config.Files)
         {
+            index++;
             var filePath = Path.Combine(config.FileDirectory, file);
             var fileName = Path.GetFileName(file);
             logger.LogTrace(
@@ -190,19 +195,28 @@ out var handle
                 using var translationUnit = TranslationUnit.GetOrCreate(handle);
                 Debug.Assert(translationUnit is not null);
 
-                logger.LogInformation("Generating raw bindings for '{0}'", fileName);
+                logger.LogInformation("Generating raw bindings for '{0}' ({1}/{2}) ({3}/{4})", fileName, index, count, rspIndex, rspCount);
                 pinvokeGenerator.GenerateBindings(
                     translationUnit,
                     filePath,
                     config.ClangCommandLineArgs,
                     config.TranslationFlags
                 );
                 pinvokeGenerator.Close();
-                logger.LogDebug(
+
+                if (files.Count == 0)
+                {
+                    logger.LogWarning("No files generated for {0}",
+                    filePath);
+                }
+                else
+                {
+                    logger.LogDebug(
                     "Completed generation for {0}, file count: {1}",
                     filePath,
                     files.Count
-                );
+                    );
+                }
             }
             catch (Exception e)
             {
@@ -266,6 +280,8 @@ private async Task ScrapeBindingsAsync(
         // Generate all the sources and tests.
         var aggregatedSources = new ConcurrentDictionary<string, SyntaxTree>();
         var aggregatedTests = new ConcurrentDictionary<string, SyntaxTree>();
+        int rspIndex = 0;
+        int rspCount = rsps.Count;
         try
         {
             await Parallel.ForEachAsync(
@@ -279,8 +295,9 @@ await Parallel.ForEachAsync(
                     await Task.Run(
                         async () =>
                         {
+                            int index = Interlocked.Increment(ref rspIndex);
                             // Generate the raw bindings.
-                            var (sources, tests, hasErrors) = ScrapeRawBindings(rsp);
+                            var (sources, tests, hasErrors) = ScrapeRawBindings(rsp, index, rspCount);
 
                             static MemoryStream Reopen(MemoryStream ms) =>
                                 ms.TryGetBuffer(out var buff) && buff.Array is not null
@@ -450,6 +467,17 @@ public async Task ExecuteAsync(IModContext ctx, CancellationToken ct = default)
             .ReadResponseFiles(ctx.ConfigurationDirectory, cfg.ClangSharpResponseFiles)
             .ToList();
 
+        if (rsps.Count == 0)
+        {
+            logger.LogWarning("No Response files found for {}", ctx.JobKey);
+        }
+
+        var missingIncludes = rsps.SelectMany<ResponseFile, string>(rsp => rsp.ClangCommandLineArgs.Where(arg => arg.StartsWith("--include-directory=") && !Directory.Exists(arg.Substring(20)))).Select(arg => arg.Substring(20)).Distinct();
+        if (missingIncludes.Count() > 0)
+        {
+            logger.LogWarning("The following includes are missing and may cause erroneous generation: \n" + string.Join("\n", missingIncludes));
+        }
+
         // Apply modifications. This is done before the cache key as modifications to the rsps result in different
         // outputs.
         foreach (var mod in responseFileMods?.SelectMany(x => x.Get(ctx.JobKey)) ?? [])