Propagate sysroot to module loader subinvocation

hjyamauchi · hjyamauchi · commit 47e2c820272a · 2025-03-13T16:25:44.000-07:00
To fix the Android build issue #79839
diff --git a/include/swift/AST/ModuleLoader.h b/include/swift/AST/ModuleLoader.h
@@ -209,6 +209,7 @@ struct InterfaceSubContextDelegate {
   virtual std::error_code runInSubContext(StringRef moduleName,
                                           StringRef interfacePath,
                                           StringRef sdkPath,
+                                          std::optional<StringRef> sysRoot,
                                           StringRef outputPath,
                                           SourceLoc diagLoc,
     llvm::function_ref<std::error_code(ASTContext&, ModuleDecl*,
@@ -217,6 +218,7 @@ struct InterfaceSubContextDelegate {
   virtual std::error_code runInSubCompilerInstance(StringRef moduleName,
                                                    StringRef interfacePath,
                                                    StringRef sdkPath,
+                                                   std::optional<StringRef> sysRoot,
                                                    StringRef outputPath,
                                                    SourceLoc diagLoc,
                                                    bool silenceErrors,
diff --git a/include/swift/Frontend/Frontend.h b/include/swift/Frontend/Frontend.h
@@ -222,6 +222,10 @@ class CompilerInvocation {
     SearchPathOpts.VFSOverlayFiles = Overlays;
   }
 
+  void setSysRoot(StringRef SysRoot) {
+    SearchPathOpts.setSysRoot(SysRoot);
+  }
+
   void setExtraClangArgs(const std::vector<std::string> &Args) {
     ClangImporterOpts.ExtraArgs = Args;
   }
diff --git a/include/swift/Frontend/ModuleInterfaceLoader.h b/include/swift/Frontend/ModuleInterfaceLoader.h
@@ -702,6 +702,7 @@ struct InterfaceSubContextDelegateImpl : InterfaceSubContextDelegate {
   std::error_code runInSubContext(StringRef moduleName,
                                   StringRef interfacePath,
                                   StringRef sdkPath,
+                                  std::optional<StringRef> sysRoot,
                                   StringRef outputPath,
                                   SourceLoc diagLoc,
     llvm::function_ref<std::error_code(ASTContext&, ModuleDecl*,
@@ -710,6 +711,7 @@ struct InterfaceSubContextDelegateImpl : InterfaceSubContextDelegate {
   std::error_code runInSubCompilerInstance(StringRef moduleName,
                                            StringRef interfacePath,
                                            StringRef sdkPath,
+                                           std::optional<StringRef> sysRoot,
                                            StringRef outputPath,
                                            SourceLoc diagLoc,
                                            bool silenceErrors,
diff --git a/lib/Frontend/ModuleInterfaceBuilder.cpp b/lib/Frontend/ModuleInterfaceBuilder.cpp
@@ -356,7 +356,7 @@ bool ImplicitModuleInterfaceBuilder::buildSwiftModuleInternal(
     }
 
     SubError = (bool)subASTDelegate.runInSubCompilerInstance(
-        moduleName, interfacePath, sdkPath, OutPath, diagnosticLoc,
+        moduleName, interfacePath, sdkPath, sysRoot, OutPath, diagnosticLoc,
         silenceInterfaceDiagnostics,
         [&](SubCompilerInstanceInfo &info) {
           auto EBuilder = ExplicitModuleInterfaceBuilder(
diff --git a/lib/Frontend/ModuleInterfaceBuilder.h b/lib/Frontend/ModuleInterfaceBuilder.h
@@ -42,6 +42,7 @@ class ImplicitModuleInterfaceBuilder {
   InterfaceSubContextDelegate &subASTDelegate;
   const StringRef interfacePath;
   const StringRef sdkPath;
+  const std::optional<StringRef> sysRoot;
   const StringRef moduleName;
   const StringRef moduleCachePath;
   const StringRef prebuiltCachePath;
@@ -87,15 +88,17 @@ class ImplicitModuleInterfaceBuilder {
       SourceManager &sourceMgr, DiagnosticEngine *diags,
       InterfaceSubContextDelegate &subASTDelegate,
       StringRef interfacePath, StringRef sdkPath,
-      StringRef moduleName, StringRef moduleCachePath,
-      StringRef backupInterfaceDir, StringRef prebuiltCachePath,
-      StringRef ABIDescriptorPath, bool disableInterfaceFileLock = false,
+      std::optional<StringRef> sysRoot, StringRef moduleName,
+      StringRef moduleCachePath, StringRef backupInterfaceDir,
+      StringRef prebuiltCachePath, StringRef ABIDescriptorPath,
+      bool disableInterfaceFileLock = false,
       bool silenceInterfaceDiagnostics = false,
       SourceLoc diagnosticLoc = SourceLoc(),
       DependencyTracker *tracker = nullptr)
       : sourceMgr(sourceMgr), diags(diags), subASTDelegate(subASTDelegate),
-        interfacePath(interfacePath), sdkPath(sdkPath), moduleName(moduleName),
-        moduleCachePath(moduleCachePath), prebuiltCachePath(prebuiltCachePath),
+        interfacePath(interfacePath), sdkPath(sdkPath), sysRoot(sysRoot),
+        moduleName(moduleName), moduleCachePath(moduleCachePath),
+        prebuiltCachePath(prebuiltCachePath),
         backupInterfaceDir(backupInterfaceDir),
         ABIDescriptorPath(ABIDescriptorPath),
         disableInterfaceFileLock(disableInterfaceFileLock),
diff --git a/lib/Frontend/ModuleInterfaceLoader.cpp b/lib/Frontend/ModuleInterfaceLoader.cpp
@@ -1215,6 +1215,7 @@ class ModuleInterfaceLoaderImpl {
         ctx.SourceMgr, diagsToUse,
         astDelegate, interfacePath,
         ctx.SearchPathOpts.getSDKPath(),
+        ctx.SearchPathOpts.getSysRoot(),
         realName.str(), cacheDir,
         prebuiltCacheDir, backupInterfaceDir, StringRef(),
         Opts.disableInterfaceLock,
@@ -1250,6 +1251,7 @@ class ModuleInterfaceLoaderImpl {
       ImplicitModuleInterfaceBuilder fallbackBuilder(
         ctx.SourceMgr, &ctx.Diags, astDelegate, backupPath,
         ctx.SearchPathOpts.getSDKPath(),
+        ctx.SearchPathOpts.getSysRoot(),
         moduleName, cacheDir,
         prebuiltCacheDir, backupInterfaceDir, StringRef(),
         Opts.disableInterfaceLock,
@@ -1475,6 +1477,7 @@ bool ModuleInterfaceLoader::buildSwiftModuleFromSwiftInterface(
       RequireOSSAModules);
   ImplicitModuleInterfaceBuilder builder(SourceMgr, &Diags, astDelegate, InPath,
                                          SearchPathOpts.getSDKPath(),
+                                         SearchPathOpts.getSysRoot(),
                                          ModuleName, CacheDir, PrebuiltCacheDir,
                                          BackupInterfaceDir, ABIOutputPath,
                                          LoaderOpts.disableInterfaceLock,
@@ -1495,6 +1498,7 @@ bool ModuleInterfaceLoader::buildSwiftModuleFromSwiftInterface(
   assert(!backInPath.empty());
   ImplicitModuleInterfaceBuilder backupBuilder(SourceMgr, &Diags, astDelegate, backInPath,
                                                SearchPathOpts.getSDKPath(),
+                                               SearchPathOpts.getSysRoot(),
                                                ModuleName, CacheDir, PrebuiltCacheDir,
                                                BackupInterfaceDir, ABIOutputPath,
                                                LoaderOpts.disableInterfaceLock,
@@ -2049,12 +2053,13 @@ std::error_code
 InterfaceSubContextDelegateImpl::runInSubContext(StringRef moduleName,
                                                  StringRef interfacePath,
                                                  StringRef sdkPath,
+                                                 std::optional<StringRef> sysRoot,
                                                  StringRef outputPath,
                                                  SourceLoc diagLoc,
     llvm::function_ref<std::error_code(ASTContext&, ModuleDecl*, ArrayRef<StringRef>,
                           StringRef, StringRef)> action) {
-  return runInSubCompilerInstance(moduleName, interfacePath, sdkPath, outputPath,
-                                  diagLoc, /*silenceErrors=*/false,
+  return runInSubCompilerInstance(moduleName, interfacePath, sdkPath, sysRoot,
+                                  outputPath, diagLoc, /*silenceErrors=*/false,
                                   [&](SubCompilerInstanceInfo &info){
     std::string UserModuleVer = info.Instance->getInvocation().getFrontendOptions()
       .UserModuleVersion.getAsString();
@@ -2070,6 +2075,7 @@ std::error_code
 InterfaceSubContextDelegateImpl::runInSubCompilerInstance(StringRef moduleName,
                                                           StringRef interfacePath,
                                                           StringRef sdkPath,
+                                                          std::optional<StringRef> sysRoot,
                                                           StringRef outputPath,
                                                           SourceLoc diagLoc,
                                                           bool silenceErrors,
@@ -2101,6 +2107,9 @@ InterfaceSubContextDelegateImpl::runInSubCompilerInstance(StringRef moduleName,
   subInvocation.setModuleName(moduleName);
   BuildArgs.push_back("-module-name");
   BuildArgs.push_back(moduleName);
+  if (sysRoot) {
+    subInvocation.setSysRoot(sysRoot.value());
+  }
 
   // FIXME: Hack for Darwin.swiftmodule, which cannot be rebuilt with C++
   // interop enabled by the Swift CI because it uses an old host SDK.
diff --git a/lib/Serialization/ScanningLoaders.cpp b/lib/Serialization/ScanningLoaders.cpp
@@ -149,12 +149,13 @@ SwiftModuleScanner::scanInterfaceFile(Twine moduleInterfacePath,
   auto newExt = file_types::getExtension(file_types::TY_SwiftModuleFile);
   auto realModuleName = Ctx.getRealModuleName(moduleName);
   StringRef sdkPath = Ctx.SearchPathOpts.getSDKPath();
+  std::optional<StringRef> sysRoot = Ctx.SearchPathOpts.getSysRoot();
   llvm::SmallString<32> modulePath = realModuleName.str();
   llvm::sys::path::replace_extension(modulePath, newExt);
   auto ScannerPackageName = Ctx.LangOpts.PackageName;
   std::optional<ModuleDependencyInfo> Result;
   std::error_code code = astDelegate.runInSubContext(
-      realModuleName.str(), moduleInterfacePath.str(), sdkPath,
+      realModuleName.str(), moduleInterfacePath.str(), sdkPath, sysRoot,
       StringRef(), SourceLoc(),
       [&](ASTContext &Ctx, ModuleDecl *mainMod, ArrayRef<StringRef> BaseArgs,
           StringRef Hash, StringRef UserModVer) {

Original file line number	Diff line number	Diff line change
`@@ -222,6 +222,10 @@ class CompilerInvocation {`
`222`	`222`	`SearchPathOpts.VFSOverlayFiles = Overlays;`
`223`	`223`	`}`
`224`	`224`
	`225`	`+ void setSysRoot(StringRef SysRoot) {`
	`226`	`+ SearchPathOpts.setSysRoot(SysRoot);`
	`227`	`+ }`
	`228`	`+`
`225`	`229`	`void setExtraClangArgs(const std::vector<std::string> &Args) {`
`226`	`230`	`ClangImporterOpts.ExtraArgs = Args;`
`227`	`231`	`}`
Original file line number	Diff line number	Diff line change
`@@ -356,7 +356,7 @@ bool ImplicitModuleInterfaceBuilder::buildSwiftModuleInternal(`
`356`	`356`	`}`
`357`	`357`
`358`	`358`	`SubError = (bool)subASTDelegate.runInSubCompilerInstance(`
`359`		`- moduleName, interfacePath, sdkPath, OutPath, diagnosticLoc,`
	`359`	`+ moduleName, interfacePath, sdkPath, sysRoot, OutPath, diagnosticLoc,`
`360`	`360`	`silenceInterfaceDiagnostics,`
`361`	`361`	`[&](SubCompilerInstanceInfo &info) {`
`362`	`362`	`auto EBuilder = ExplicitModuleInterfaceBuilder(`