Merge pull request #62093 from DougGregor/compiler-plugin-support-layout

DougGregor · web-flow · commit 8c36500df21b · 2022-11-16T00:25:24.000-08:00
diff --git a/cmake/modules/AddSwift.cmake b/cmake/modules/AddSwift.cmake
@@ -911,6 +911,12 @@ function(add_swift_host_tool executable)
     endif()
   endif()
 
+  if(SWIFT_SWIFT_PARSER)
+    set_property(
+      TARGET ${executable}
+      APPEND PROPERTY INSTALL_RPATH "@executable_path/../lib")
+  endif()
+
   if(ASHT_THINLTO_LD64_ADD_FLTO_CODEGEN_ONLY)
     string(CONCAT lto_codegen_only_link_options
       "$<"
diff --git a/lib/ASTGen/CMakeLists.txt b/lib/ASTGen/CMakeLists.txt
@@ -68,6 +68,7 @@ if (SWIFT_SWIFT_PARSER)
     $<TARGET_OBJECTS:SwiftSyntax::SwiftCompilerSupport>
 
     swiftAST
+    swift_CompilerPluginSupport
   )
 
   target_include_directories(swiftASTGen PUBLIC
diff --git a/lib/CMakeLists.txt b/lib/CMakeLists.txt
@@ -17,6 +17,7 @@ list(APPEND LLVM_COMMON_DEPENDS swift-syntax-generated-headers)
 list(APPEND LLVM_COMMON_DEPENDS swift-ast-generated-headers)
 list(APPEND LLVM_COMMON_DEPENDS swift-parse-syntax-generated-headers)
 
+add_subdirectory(CompilerPluginSupport)
 add_subdirectory(APIDigester)
 add_subdirectory(AST)
 add_subdirectory(ASTGen)
@@ -57,4 +58,3 @@ add_subdirectory(SymbolGraphGen)
 add_subdirectory(Syntax)
 add_subdirectory(SyntaxParse)
 add_subdirectory(Threading)
-add_subdirectory(CompilerPluginSupport)
diff --git a/lib/CompilerPluginSupport/CMakeLists.txt b/lib/CompilerPluginSupport/CMakeLists.txt
@@ -26,15 +26,36 @@ if(SWIFT_SWIFT_PARSER)
     set(DEPLOYMENT_VERSION ${SWIFT_ANDROID_API_LEVEL})
   endif()
 
+  # Determine the Swift module path
+  set(module_triple ${SWIFT_SDK_${SWIFT_HOST_VARIANT_SDK}_ARCH_${SWIFT_HOST_VARIANT_ARCH}_MODULE})
+  set(module_dir "${CMAKE_LIBRARY_OUTPUT_DIRECTORY}")
+  set(module_base "${module_dir}/${module_name}.swiftmodule")
+  set(module_file "${module_base}/${module_triple}.swiftmodule")
+  set(module_interface_file "${module_base}/${module_triple}.swiftinterface")
+  set(module_doc_file "${module_base}/${module_triple}.swiftdoc")
+
   get_target_triple(target target_variant "${SWIFT_HOST_VARIANT_SDK}" "${SWIFT_HOST_VARIANT_ARCH}"
     MACCATALYST_BUILD_FLAVOR ""
     DEPLOYMENT_VERSION "${DEPLOYMENT_VERSION}")
 
+  # Add a custom target to create the module directory and remove any old
+  # compiled module file.
+  add_custom_command_target(
+      create_module_dirs_dependency_target
+      COMMAND "${CMAKE_COMMAND}" -E make_directory ${module_base}
+      COMMAND "${CMAKE_COMMAND}" -E rm -f "${module_file}"
+      OUTPUT ${module_base}
+      COMMENT "Generating module directory for ${module_name}")
+  add_dependencies(${library_name} ${create_module_dirs_dependency_target})
+
+  # Build the module with library evolution enabled and install into the
+  # appropriate locations.
   target_compile_options("${library_name}" PRIVATE
     $<$<COMPILE_LANGUAGE:Swift>:
       -module-name;${module_name};
       -enable-library-evolution;
-      -emit-module-interface;
+      -emit-module-interface-path;
+      "${module_interface_file}" ;
       -target;${target}>)
 
   target_link_libraries("${library_name}"
@@ -56,4 +77,9 @@ if(SWIFT_SWIFT_PARSER)
       DESTINATION "lib${LLVM_LIBDIR_SUFFIX}"
       COMPONENT compiler)
 
+    swift_install_in_component(DIRECTORY "${module_base}"
+                               DESTINATION "lib${LLVM_LIBDIR_SUFFIX}/swift"
+                               COMPONENT compiler)
+
+    set_property(GLOBAL APPEND PROPERTY SWIFT_EXPORTS ${library_name})
 endif()
diff --git a/test/Driver/driver-compile.swift b/test/Driver/driver-compile.swift
@@ -45,8 +45,10 @@
 
 // RUN: %swiftc_driver -driver-print-jobs -c -target x86_64-apple-macosx10.9 %s %S/../Inputs/empty.swift -module-name main -driver-filelist-threshold=0 2>&1 | %FileCheck -check-prefix=FILELIST %s
 
-// RUN: %empty-directory(%t)/DISTINCTIVE-PATH/usr/bin/
+// RUN: %empty-directory(%t/DISTINCTIVE-PATH/usr/bin/)
+// RUN: %empty-directory(%t/DISTINCTIVE-PATH/usr/lib/)
 // RUN: %hardlink-or-copy(from: %swift_frontend_plain, to: %t/DISTINCTIVE-PATH/usr/bin/swiftc)
+// RUN: %copy-plugin-support-library(%t/DISTINCTIVE-PATH/usr/lib/)
 // RUN: ln -s "swiftc" %t/DISTINCTIVE-PATH/usr/bin/swift-update
 // RUN: %t/DISTINCTIVE-PATH/usr/bin/swiftc -driver-print-jobs -c -update-code -target x86_64-apple-macosx10.9 %s 2>&1 > %t.upd.txt
 // RUN: %FileCheck -check-prefix UPDATE-CODE %s < %t.upd.txt
diff --git a/test/Driver/linker-clang_rt.swift b/test/Driver/linker-clang_rt.swift
@@ -6,7 +6,9 @@
 
 // RUN: rm -rf %t
 // RUN: %empty-directory(%t/bin)
+// RUN: %empty-directory(%t/lib)
 // RUN: %hardlink-or-copy(from: %swift_frontend_plain, to: %t/bin/swiftc)
+// RUN: %copy-plugin-support-library(%t/lib/)
 // RUN: %empty-directory(%t/lib/swift/clang/lib/darwin/)
 
 // RUN: %t/bin/swiftc -driver-print-jobs -target x86_64-apple-macosx10.9 %S/../Inputs/empty.swift | %FileCheck -check-prefix CHECK -check-prefix CHECK-NO-RUNTIME %s
diff --git a/test/Driver/options-repl-darwin.swift b/test/Driver/options-repl-darwin.swift
@@ -5,7 +5,9 @@
 // the Swift driver really thinks it's been moved.
 
 // RUN: %empty-directory(%t/usr/bin/)
+// RUN: %empty-directory(%t/usr/lib/)
 // RUN: %hardlink-or-copy(from: %swift_driver_plain, to: %t/usr/bin/swift)
+// RUN: %copy-plugin-support-library(%t/usr/lib/)
 
 // RUN: %t/usr/bin/swift -repl -### | %FileCheck -check-prefix=INTEGRATED %s
 // RUN: %t/usr/bin/swift -### | %FileCheck -check-prefix=INTEGRATED %s
@@ -16,7 +18,9 @@
 // RUN: %t/usr/bin/swift -### | %FileCheck -check-prefix=LLDB %s
 
 // RUN: %empty-directory(%t/Toolchains/Test.xctoolchain/usr/bin)
+// RUN: %empty-directory(%t/Toolchains/Test.xctoolchain/usr/lib)
 // RUN: mv %t/usr/bin/swift %t/Toolchains/Test.xctoolchain/usr/bin/swift
+// RUN: %copy-plugin-support-library(%t/Toolchains/Test.xctoolchain/usr/lib/)
 // RUN: %t/Toolchains/Test.xctoolchain/usr/bin/swift -repl -### | %FileCheck -check-prefix=LLDB %s
 
 // Clean up the test executable because hard links are expensive.
diff --git a/test/Driver/options-repl.swift b/test/Driver/options-repl.swift
@@ -7,6 +7,8 @@
 
 // RUN: %empty-directory(%t)
 // RUN: mkdir -p %t/usr/bin
+// RUN: mkdir -p %t/usr/lib
+// RUN: %copy-plugin-support-library(%t/usr/lib/)
 // RUN: %hardlink-or-copy(from: %swift_frontend_plain, to: %t/usr/bin/swift)
 
 // RUN: %t/usr/bin/swift -sdk "" -deprecated-integrated-repl -### | %FileCheck -check-prefix=INTEGRATED %s
diff --git a/test/Driver/subcommands.swift b/test/Driver/subcommands.swift
@@ -3,7 +3,9 @@
 
 // RUN: rm -rf %t.dir
 // RUN: mkdir -p %t.dir/usr/bin
+// RUN: mkdir -p %t.dir/usr/lib
 // RUN: %hardlink-or-copy(from: %swift_frontend_plain, to: %t.dir/usr/bin/swift)
+// RUN: %copy-plugin-support-library(%t.dir/usr/lib/)
 
 // RUN: %t.dir/usr/bin/swift -### 2>&1 | %FileCheck -check-prefix=CHECK-SWIFT-INVOKES-REPL %s
 // RUN: %t.dir/usr/bin/swift repl -### 2>&1 | %FileCheck -check-prefix=CHECK-SWIFT-INVOKES-REPL %s
diff --git a/test/Driver/windows-link-job.swift b/test/Driver/windows-link-job.swift
@@ -1,5 +1,7 @@
 // RUN: %empty-directory(%t/DISTINCTIVE-WINDOWS-PATH/usr/bin)
+// RUN: %empty-directory(%t/DISTINCTIVE-WINDOWS-PATH/usr/lib)
 // RUN: %hardlink-or-copy(from: %swift_frontend_plain, to: %t/DISTINCTIVE-WINDOWS-PATH/usr/bin/swiftc)
+// RUN: %copy-plugin-support-library(%t/DISTINCTIVE-WINDOWS-PATH/usr/lib/)
 // RUN: env PATH= %t/DISTINCTIVE-WINDOWS-PATH/usr/bin/swiftc -target x86_64-unknown-windows-msvc -### -module-name link -emit-library %s 2>&1 | %FileCheck %s
 
 // swift-frontend cannot be copied to another location with bootstrapping because
diff --git a/test/Macros/macro_plugin.swift b/test/Macros/macro_plugin.swift
@@ -1,7 +1,7 @@
 // RUN: %empty-directory(%t)
-// RUN: %target-build-swift -Xfrontend -disable-availability-checking -I%platform-module-dir/../.. -L%platform-dylib-dir/../.. -emit-library -emit-library-path=%t/%target-library-name(MacroDefinition) -working-directory=%t -module-name=MacroDefinition %S/Inputs/macro_definition.swift
+// RUN: %target-build-swift -Xfrontend -disable-availability-checking -I %swift-lib-dir -L %swift-lib-dir -emit-library -emit-library-path=%t/%target-library-name(MacroDefinition) -working-directory=%t -module-name=MacroDefinition %S/Inputs/macro_definition.swift
 // RUN: %target-swift-frontend -emit-module -o %t %S/Inputs/ColorLib.swift
-// RUN: %target-swift-frontend -L%platform-dylib-dir/../.. -enable-experimental-feature Macros -load-plugin-library %t/%target-library-name(MacroDefinition) -I %t -disable-availability-checking -dump-ast -primary-file %s | %FileCheck %s
+// RUN: %target-swift-frontend -I %swift-lib-dir -L %swift-lib-dir -enable-experimental-feature Macros -load-plugin-library %t/%target-library-name(MacroDefinition) -I %t -disable-availability-checking -dump-ast -primary-file %s | %FileCheck %s
 
 // FIXME: Swift parser is not enabled on Linux CI yet.
 // REQUIRES: OS=macosx
diff --git a/test/Macros/macro_plugin_diagnostics.swift b/test/Macros/macro_plugin_diagnostics.swift
@@ -1,7 +1,7 @@
 // RUN: %empty-directory(%t)
-// RUN: %target-build-swift -Xfrontend -disable-availability-checking -I%platform-module-dir/../.. -L%platform-dylib-dir/../.. -emit-library -emit-library-path=%t/%target-library-name(MacroDefinitionMissingAllMacros) -working-directory=%t -module-name=MacroDefinitionMissingAllMacros %S/Inputs/macro_definition_missing_allmacros.swift
-// RUN: %target-build-swift -Xfrontend -disable-availability-checking -I%platform-module-dir/../.. -L%platform-dylib-dir/../.. -emit-library -emit-library-path=%t/%target-library-name(MacroDefinition) -working-directory=%t -module-name=MacroDefinition %S/Inputs/macro_definition.swift
-// RUN: %target-swift-frontend -L%%platform-dylib-dir/../.. -enable-experimental-feature Macros -load-plugin-library %t/%target-library-name(MacroDefinition) -load-plugin-library %t/%target-library-name(MacroDefinitionMissingAllMacros) -disable-availability-checking -typecheck -verify -primary-file %s 2>&1 | %FileCheck %s
+// RUN: %target-build-swift -Xfrontend -disable-availability-checking -I %swift-lib-dir -L %swift-lib-dir -emit-library -emit-library-path=%t/%target-library-name(MacroDefinitionMissingAllMacros) -working-directory=%t -module-name=MacroDefinitionMissingAllMacros %S/Inputs/macro_definition_missing_allmacros.swift
+// RUN: %target-build-swift -Xfrontend -disable-availability-checking -I %swift-lib-dir -L %swift-lib-dir -emit-library -emit-library-path=%t/%target-library-name(MacroDefinition) -working-directory=%t -module-name=MacroDefinition %S/Inputs/macro_definition.swift
+// RUN: %target-swift-frontend -I %swift-lib-dir -L %swift-lib-dir -enable-experimental-feature Macros -load-plugin-library %t/%target-library-name(MacroDefinition) -load-plugin-library %t/%target-library-name(MacroDefinitionMissingAllMacros) -disable-availability-checking -typecheck -verify -primary-file %s 2>&1 | %FileCheck %s
 
 // FIXME: Swift parser is not enabled on Linux CI yet.
 // REQUIRES: OS=macosx
diff --git a/test/Macros/macro_plugin_exec.swift b/test/Macros/macro_plugin_exec.swift
@@ -1,6 +1,6 @@
 // RUN: %empty-directory(%t)
-// RUN: %target-build-swift -Xfrontend -disable-availability-checking -I%platform-module-dir/../.. -L%platform-dylib-dir/../.. -emit-library -emit-library-path=%t/%target-library-name(MacroDefinition) -working-directory=%t -module-name=MacroDefinition %S/Inputs/macro_definition.swift
-// RUN: %target-build-swift -L%platform-module-dir/../.. -enable-experimental-feature Macros -load-plugin-library %t/%target-library-name(MacroDefinition) %s -o %t/main
+// RUN: %target-build-swift -Xfrontend -disable-availability-checking -I %swift-lib-dir -L %swift-lib-dir -emit-library -emit-library-path=%t/%target-library-name(MacroDefinition) -working-directory=%t -module-name=MacroDefinition %S/Inputs/macro_definition.swift
+// RUN: %target-build-swift -enable-experimental-feature Macros -load-plugin-library %t/%target-library-name(MacroDefinition) -I %swift-lib-dir -L %swift-lib-dir %s -o %t/main
 // RUN: %target-run %t/main | %FileCheck %s
 // REQUIRES: executable_test
 
diff --git a/test/lit.cfg b/test/lit.cfg
@@ -469,6 +469,7 @@ lit_config.note("Using code completion cache: " + completion_cache_path)
 
 config.substitutions.append( ('%validate-incrparse', '%{python} %utils/incrparse/validate_parse.py --temp-dir %t --swift-syntax-test %swift-syntax-test') )
 config.substitutions.append( ('%llvm_obj_root', config.llvm_obj_root) )
+config.substitutions.append( ('%swift-lib-dir', config.swift_lib_dir) )
 config.substitutions.append( ('%llvm_src_root', config.llvm_src_root) )
 config.substitutions.append( ('%swift_obj_root', config.swift_obj_root) )
 config.substitutions.append( ('%swift_src_root', config.swift_src_root) )
@@ -2472,6 +2473,25 @@ config.substitutions.append(('%target-resilience-test', config.target_resilience
 config.substitutions.append(('%llvm-profdata', config.llvm_profdata))
 config.substitutions.append(('%llvm-cov', config.llvm_cov))
 
+# Name of the compiler plugin support library.
+plugin_support_shared_lib_name = ("%sswift_CompilerPluginSupport%s" %
+    (config.target_shared_library_prefix, config.target_shared_library_suffix))
+plugin_support_shared_lib = make_path(config.swift_lib_dir, plugin_support_shared_lib_name)
+config.substitutions.append(('%compiler_plugin_library',
+                             plugin_support_shared_lib))
+
+if "swift_swift_parser" in config.available_features:
+  config.substitutions.append(
+      (r'%copy-plugin-support-library\(*(.*)\)',
+       SubstituteCaptures(
+           r'cp %s \1' %
+           (escape_for_substitute_captures(plugin_support_shared_lib)))))
+else:
+  config.substitutions.append(
+      (r'%copy-plugin-support-library\(*(.*)\)',
+       r'echo "No plugin support library to copy"'))
+
+
 if hasattr(config, 'otool_classic'):
     config.substitutions.append(('%otool-classic', config.otool_classic))
 
diff --git a/test/lit.site.cfg.in b/test/lit.site.cfg.in
@@ -152,6 +152,9 @@ config.freestanding_sdk_name = "@SWIFT_SDK_FREESTANDING_LIB_SUBDIR@"
 if "@BOOTSTRAPPING_MODE@" != "OFF":
   config.available_features.add('swift_in_compiler')
 
+if "@SWIFT_PATH_TO_EARLYSWIFTSYNTAX_BUILD_DIR@" != "":
+  config.available_features.add('swift_swift_parser')
+
 if "@BOOTSTRAPPING_MODE@" == 'HOSTTOOLS':
   config.available_features.add('hosttools_mode')
 elif "@BOOTSTRAPPING_MODE@" == 'BOOTSTRAPPING':
diff --git a/tools/SourceKit/cmake/modules/AddSwiftSourceKit.cmake b/tools/SourceKit/cmake/modules/AddSwiftSourceKit.cmake
@@ -430,6 +430,10 @@ macro(add_sourcekit_framework name)
         LIBRARY_DIR ${SOURCEKIT_LIBRARY_OUTPUT_INTDIR})
     set(RPATH_LIST)
     add_sourcekit_swift_runtime_link_flags(${name} "${SOURCEKIT_LIBRARY_OUTPUT_INTDIR}" ${SOURCEKITFW_HAS_SWIFT_MODULES})
+    file(RELATIVE_PATH relative_lib_path
+      "${framework_location}/Versions/A" "${SOURCEKIT_LIBRARY_OUTPUT_INTDIR}")
+    list(APPEND RPATH_LIST "@loader_path/${relative_lib_path}")
+
     set_target_properties(${name} PROPERTIES
                           BUILD_WITH_INSTALL_RPATH TRUE
                           FOLDER "SourceKit frameworks"
@@ -461,6 +465,10 @@ macro(add_sourcekit_framework name)
         LIBRARY_DIR ${framework_location})
     set(RPATH_LIST)
     add_sourcekit_swift_runtime_link_flags(${name} "${framework_location}" SOURCEKITFW_HAS_SWIFT_MODULES RPATH_LIST)
+    file(RELATIVE_PATH relative_lib_path
+      "${framework_location}" "${SOURCEKIT_LIBRARY_OUTPUT_INTDIR}")
+    list(APPEND RPATH_LIST "@loader_path/${relative_lib_path}")
+
     set_target_properties(${name} PROPERTIES
                           BUILD_WITH_INSTALL_RPATH TRUE
                           FOLDER "SourceKit frameworks"
diff --git a/tools/SourceKit/lib/SwiftLang/CMakeLists.txt b/tools/SourceKit/lib/SwiftLang/CMakeLists.txt
@@ -67,3 +67,8 @@ target_link_libraries(SourceKitSwiftLang PRIVATE
   clangAPINotes
   clangBasic)
 add_dependencies(SourceKitSwiftLang clang-tablegen-targets)
+
+if (SWIFT_SWIFT_PARSER)
+  target_link_libraries(SourceKitSwiftLang
+    PRIVATE swift_CompilerPluginSupport)
+endif()
diff --git a/tools/driver/CMakeLists.txt b/tools/driver/CMakeLists.txt
@@ -1,5 +1,15 @@
 # The swift-frontend tool
 
+
+# Add additional libraries to which we need to link when the Swift Swift
+# parser is built in.
+function(add_swift_parser_link_libraries target)
+  if(SWIFT_SWIFT_PARSER)
+    target_link_libraries(${target}
+                          PRIVATE swiftCore)
+  endif()
+endfunction()
+
 if(${BOOTSTRAPPING_MODE} MATCHES "BOOTSTRAPPING.*")
 
   # Bootstrapping - level 0
@@ -17,11 +27,7 @@ if(${BOOTSTRAPPING_MODE} MATCHES "BOOTSTRAPPING.*")
                           swiftDriverTool
                           swiftCompilerStub)
 
-  if(SWIFT_SWIFT_PARSER)
-    target_link_libraries(swift-frontend-bootstrapping0
-                          PRIVATE
-                            swiftCore)
-  endif()
+  add_swift_parser_link_libraries(swift-frontend-bootstrapping0)
 
   swift_create_post_build_symlink(swift-frontend-bootstrapping0
     SOURCE "swift-frontend${CMAKE_EXECUTABLE_SUFFIX}"
@@ -42,11 +48,7 @@ if(${BOOTSTRAPPING_MODE} MATCHES "BOOTSTRAPPING.*")
                           swiftDriverTool
                           swiftCompilerModules-bootstrapping1)
 
-  if(SWIFT_SWIFT_PARSER)
-    target_link_libraries(swift-frontend-bootstrapping1
-                          PRIVATE
-                            swiftCore)
-  endif()
+  add_swift_parser_link_libraries(swift-frontend-bootstrapping1)
 
   swift_create_post_build_symlink(swift-frontend-bootstrapping1
     SOURCE "swift-frontend${CMAKE_EXECUTABLE_SUFFIX}"
@@ -64,11 +66,7 @@ target_link_libraries(swift-frontend
                         swiftDriverTool
                         swiftCompilerModules)
 
-if(SWIFT_SWIFT_PARSER)
-  target_link_libraries(swift-frontend
-                        PRIVATE
-                          swiftCore)
-endif()
+add_swift_parser_link_libraries(swift-frontend)
 
 _add_swift_runtime_link_flags(swift-frontend "../../lib" "")
 

Original file line number	Diff line number	Diff line change
`@@ -68,6 +68,7 @@ if (SWIFT_SWIFT_PARSER)`
`68`	`68`	`$<TARGET_OBJECTS:SwiftSyntax::SwiftCompilerSupport>`
`69`	`69`
`70`	`70`	`swiftAST`
	`71`	`+ swift_CompilerPluginSupport`
`71`	`72`	`)`
`72`	`73`
`73`	`74`	`target_include_directories(swiftASTGen PUBLIC`