Move EMIT_COMPILER_SOURCE_METADATA to a builtin macro

Author: usama54321

Sources/SWBCore/Settings/BuiltinMacros.swift

@@ -639,6 +639,7 @@ public final class BuiltinMacros {
     public static let EMBEDDED_CONTENT_CONTAINS_SWIFT = BuiltinMacros.declareBooleanMacro("EMBEDDED_CONTENT_CONTAINS_SWIFT")
     public static let EMBEDDED_PROFILE_NAME = BuiltinMacros.declareStringMacro("EMBEDDED_PROFILE_NAME")
     public static let EMBED_PACKAGE_RESOURCE_BUNDLE_NAMES = BuiltinMacros.declareStringListMacro("EMBED_PACKAGE_RESOURCE_BUNDLE_NAMES")
+    public static let EMIT_COMPILER_SOURCE_METADATA = BuiltinMacros.declareBooleanMacro("EMIT_COMPILER_SOURCE_METADATA")
     public static let EMIT_FRONTEND_COMMAND_LINES = BuiltinMacros.declareBooleanMacro("EMIT_FRONTEND_COMMAND_LINES")
     public static let ENABLE_APPINTENTS_DEPLOYMENT_AWARE_PROCESSING = BuiltinMacros.declareBooleanMacro("ENABLE_APPINTENTS_DEPLOYMENT_AWARE_PROCESSING")
     public static let ENABLE_ADDITIONAL_CODESIGN_INPUT_TRACKING = BuiltinMacros.declareBooleanMacro("ENABLE_ADDITIONAL_CODESIGN_INPUT_TRACKING")
@@ -1717,6 +1718,7 @@ public final class BuiltinMacros {
         EMBEDDED_CONTENT_CONTAINS_SWIFT,
         EMBEDDED_PROFILE_NAME,
         EMBED_PACKAGE_RESOURCE_BUNDLE_NAMES,
+        EMIT_COMPILER_SOURCE_METADATA,
         EMIT_FRONTEND_COMMAND_LINES,
         ENABLE_APPINTENTS_DEPLOYMENT_AWARE_PROCESSING,
         ENABLE_ADDRESS_SANITIZER,

Sources/SWBCore/SpecImplementations/Tools/CCompiler.swift

@@ -836,6 +836,7 @@ public class ClangCompilerSpec : CompilerSpec, SpecIdentifierType, GCCCompatible
         "-fmessage-length=",
         "-fmacro-backtrace-limit=",
         "-fbuild-session-timestamp=",
+        "-fdiagnostics-add-output="
     ])
 
     static let outputAgnosticCompilerArgumentsWithValues = Set<ByteString>([
@@ -1220,7 +1221,7 @@ public class ClangCompilerSpec : CompilerSpec, SpecIdentifierType, GCCCompatible
             dependencyData = nil
         }
 
-        let extraOutputs: [any PlannedNode]
+        var extraOutputs: [any PlannedNode]
         let moduleDependenciesContext = cbc.producer.moduleDependenciesContext
         let headerDependenciesContext = cbc.producer.headerDependenciesContext
         let dependencyValidationOutputPath: Path?
@@ -1337,6 +1338,8 @@ public class ClangCompilerSpec : CompilerSpec, SpecIdentifierType, GCCCompatible
             }
         }
 
+        commandLine += addCompilerMetadataFlags(cbc, outputFileDir.join(outputNode.path.str + ".source-metadata.json"),  delegate, &extraOutputs)
+
         // Handle explicit modules build.
         let scanningOutput = delegate.createNode(outputNode.path.dirname.join(outputNode.path.basename + ".scan"))
         let (action, usesExecutionInputs, explicitModulesPayload, explicitModulesSignatureData) = createExplicitModulesActionAndPayload(cbc, delegate, launcher, input, resolvedInputFileType.languageDialect, commandLine: commandLine, scanningOutputPath: scanningOutput.path, isForPCHTask: false, clangInfo: clangInfo)
@@ -1649,6 +1652,22 @@ public class ClangCompilerSpec : CompilerSpec, SpecIdentifierType, GCCCompatible
         }
     }
 
+    func addCompilerMetadataFlags(_ cbc: CommandBuildContext, _ outputPath: Path, _ delegate: any TaskGenerationDelegate, _ taskOutputs: inout [any PlannedNode]) -> [String] {
+        guard cbc.scope.evaluate(BuiltinMacros.EMIT_COMPILER_SOURCE_METADATA) else  {
+            return []
+        }
+
+        guard let metadatatype = cbc.producer.lookupFileType(identifier: "text.json.compiler-metadata.source") else {
+            return []
+        }
+
+        let securityMetadataNode = delegate.createNode(outputPath)
+        let ftb = FileToBuild(absolutePath: securityMetadataNode.path, fileType: metadatatype)
+        taskOutputs.append(securityMetadataNode)
+        delegate.declareOutput(ftb)
+        return ["-fdiagnostics-add-output=sarif:file=" + securityMetadataNode.path.str]
+    }
+
     /// Specialized function that creates a task for precompiling a particular header.
     private func precompile(_ cbc: CommandBuildContext, _ delegate: any TaskGenerationDelegate, headerPath: Path, language: GCCCompatibleLanguageDialect, inputFileType: FileTypeSpec, extraArgs: [String], precompPath: Path, clangInfo: DiscoveredClangToolSpecInfo?) -> ClangPrefixInfo.PCHInfo {
 

Sources/SWBUniversalPlatform/Specs/Clang.xcspec

@@ -109,24 +109,6 @@
                     NO = ();
                 };
             },
-            {
-                Name = "EMIT_COMPILER_SOURCE_METADATA";
-                Type = Boolean;
-                DefaultValue = No;
-            },
-            {
-                Name = "__CLANG_SOURCE_METADATA_PATH";
-                Type = Path;
-                Condition = "$(EMIT_COMPILER_SOURCE_METADATA)";
-                DefaultValue = "$(OutputPath).source-metadata.json";
-                CommandLinePrefixFlag = "-fdiagnostics-add-output=sarif:file=";
-                OutputDependencies = (
-                    {
-                        Path = "$(__CLANG_SOURCE_METADATA_PATH)";
-                        FileType = "text.json.compiler-metadata.source";
-                    },
-                );
-            },
             {
                 Name = "CLANG_MACRO_BACKTRACE_LIMIT";
                 Type = String;

Tests/SWBTaskConstructionTests/TaskConstructionTests.swift

@@ -9543,8 +9543,7 @@ fileprivate struct TaskConstructionTests: CoreBasedTests {
                                 "GENERATE_INFOPLIST_FILE": "YES",
                                 "PRODUCT_NAME": "$(TARGET_NAME)",
                                 "ARCHS": "x86_64 arm64",
-                                "EMIT_COMPILER_SOURCE_METADATA": "YES",
-                                "COMPILER_SOURCE_METADATA_LIST": "/tmp/test.json"
+                                "EMIT_COMPILER_SOURCE_METADATA": "YES"
                             ])
                         ],
                         buildPhases: [