Merge pull request swiftlang#76823 from swiftlang/egorzhdan/msvc-bit-module

[cxx-interop] Modularize __msvc_bit_utils on Windows

Author: egorzhdan

include/swift/ClangImporter/ClangImporter.h

@@ -718,8 +718,13 @@ ValueDecl *getImportedMemberOperator(const DeclBaseName &name,
 } // namespace importer
 
 struct ClangInvocationFileMapping {
+  /// Mapping from a file name to an existing file path.
   SmallVector<std::pair<std::string, std::string>, 2> redirectedFiles;
+
+  /// Mapping from a file name to a string of characters that represents the
+  /// contents of the file.
   SmallVector<std::pair<std::string, std::string>, 1> overridenFiles;
+
   bool requiresBuiltinHeadersInSystemModules;
 };
 

lib/ClangImporter/ClangIncludePaths.cpp

@@ -439,17 +439,16 @@ GetPlatformAuxiliaryFile(StringRef Platform, StringRef File,
   return "";
 }
 
-SmallVector<std::pair<std::string, std::string>, 2> GetWindowsFileMappings(
-    ASTContext &Context,
+void GetWindowsFileMappings(
+    ClangInvocationFileMapping &fileMapping, ASTContext &Context,
     const llvm::IntrusiveRefCntPtr<llvm::vfs::FileSystem> &driverVFS,
     bool &requiresBuiltinHeadersInSystemModules) {
   const llvm::Triple &Triple = Context.LangOpts.Target;
   const SearchPathOptions &SearchPathOpts = Context.SearchPathOpts;
-  SmallVector<std::pair<std::string, std::string>, 2> Mappings;
   std::string AuxiliaryFile;
 
   if (!Triple.isWindowsMSVCEnvironment())
-    return Mappings;
+    return;
 
   auto [Driver, clangDiagEngine] = ClangImporter::createClangDriver(
       Context.LangOpts, Context.ClangImporterOpts, driverVFS);
@@ -478,7 +477,8 @@ SmallVector<std::pair<std::string, std::string>, 2> GetWindowsFileMappings(
     AuxiliaryFile =
         GetPlatformAuxiliaryFile("windows", "winsdk.modulemap", SearchPathOpts);
     if (!AuxiliaryFile.empty())
-      Mappings.emplace_back(std::string(WinSDKInjection), AuxiliaryFile);
+      fileMapping.redirectedFiles.emplace_back(std::string(WinSDKInjection),
+                                               AuxiliaryFile);
   }
 
   struct {
@@ -506,7 +506,8 @@ SmallVector<std::pair<std::string, std::string>, 2> GetWindowsFileMappings(
       // cycle goes away. Note that -fbuiltin-headers-in-system-modules does
       // nothing to fix the same problem with C++ headers, and is generally
       // fragile.
-      Mappings.emplace_back(std::string(UCRTInjection), AuxiliaryFile);
+      fileMapping.redirectedFiles.emplace_back(std::string(UCRTInjection),
+                                               AuxiliaryFile);
       requiresBuiltinHeadersInSystemModules = true;
     }
   }
@@ -533,18 +534,28 @@ SmallVector<std::pair<std::string, std::string>, 2> GetWindowsFileMappings(
         GetPlatformAuxiliaryFile("windows", "vcruntime.modulemap",
                                  SearchPathOpts);
     if (!AuxiliaryFile.empty())
-      Mappings.emplace_back(std::string(VCToolsInjection), AuxiliaryFile);
+      fileMapping.redirectedFiles.emplace_back(std::string(VCToolsInjection),
+                                               AuxiliaryFile);
 
     llvm::sys::path::remove_filename(VCToolsInjection);
     llvm::sys::path::append(VCToolsInjection, "vcruntime.apinotes");
     AuxiliaryFile =
         GetPlatformAuxiliaryFile("windows", "vcruntime.apinotes",
                                  SearchPathOpts);
     if (!AuxiliaryFile.empty())
-      Mappings.emplace_back(std::string(VCToolsInjection), AuxiliaryFile);
-  }
+      fileMapping.redirectedFiles.emplace_back(std::string(VCToolsInjection),
+                                               AuxiliaryFile);
 
-  return Mappings;
+    // __msvc_bit_utils.hpp was added in a recent VS 2022 version. It has to be
+    // referenced from the modulemap directly to avoid modularization errors.
+    // Older VS versions might not have it. Let's inject an empty header file if
+    // it isn't available.
+    llvm::sys::path::remove_filename(VCToolsInjection);
+    llvm::sys::path::append(VCToolsInjection, "__msvc_bit_utils.hpp");
+    if (!llvm::sys::fs::exists(VCToolsInjection))
+      fileMapping.overridenFiles.emplace_back(std::string(VCToolsInjection),
+                                              "");
+  }
 }
 } // namespace
 
@@ -615,7 +626,7 @@ ClangInvocationFileMapping swift::getClangInvocationFileMapping(
   if (ctx.LangOpts.EnableCXXInterop)
     getLibStdCxxFileMapping(result, ctx, vfs, suppressDiagnostic);
 
-  result.redirectedFiles.append(GetWindowsFileMappings(
-      ctx, vfs, result.requiresBuiltinHeadersInSystemModules));
+  GetWindowsFileMappings(result, ctx, vfs,
+                         result.requiresBuiltinHeadersInSystemModules);
   return result;
 }

stdlib/public/Platform/vcruntime.modulemap

@@ -702,6 +702,11 @@ module std [system] {
   module _Private [system] {
     requires cplusplus
 
+    explicit module __msvc_bit_utils {
+      header "__msvc_bit_utils.hpp"
+      export *
+    }
+
     explicit module xatomic {
       header "xatomic.h"
       export *

test/Interop/Cxx/stdlib/Inputs/module.modulemap

@@ -1,3 +1,9 @@
+module StdNumeric {
+  header "std-numeric.h"
+  requires cplusplus
+  export *
+}
+
 module StdVector {
   header "std-vector.h"
   requires cplusplus

test/Interop/Cxx/stdlib/Inputs/std-numeric.h

@@ -0,0 +1,5 @@
+#include <numeric>
+
+inline int64_t getGCD(int64_t a, int64_t b) {
+  return std::gcd(a, b);
+}

test/Interop/Cxx/stdlib/use-std-numeric-typechecker.swift

@@ -0,0 +1,6 @@
+// RUN: %target-typecheck-verify-swift -I %S/Inputs -cxx-interoperability-mode=upcoming-swift -Xcc -std=c++17
+// RUN: %target-typecheck-verify-swift -I %S/Inputs -cxx-interoperability-mode=upcoming-swift -Xcc -std=c++20
+
+import StdNumeric
+
+let _ = getGCD(12, 15)