Skip to content

[Serialization] Use full target architectures for swiftmodule files #21053

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 6, 2018
Merged

[Serialization] Use full target architectures for swiftmodule files #21053

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 49 additions & 14 deletions lib/Serialization/SerializedModuleLoader.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,23 @@ bool SerializedModuleLoader::maybeDiagnoseArchitectureMismatch(
return true;
}

static std::pair<llvm::SmallString<16>, llvm::SmallString<16>>
getArchSpecificModuleFileNames(StringRef archName) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why not pass along the Triple rather than StringRef? It feels like it would be nicer to derive that from the triple rather than the architecture name specifically. We could have a boolean flag for whether it should do the fallback or not.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think that actually makes the call sites nicer, and as a helper function that's the important thing.

llvm::SmallString<16> archFile, archDocFile;

if (!archName.empty()) {
archFile += archName;
archFile += '.';
archFile += file_types::getExtension(file_types::TY_SwiftModuleFile);

archDocFile += archName;
archDocFile += '.';
archDocFile += file_types::getExtension(file_types::TY_SwiftModuleDocFile);
}

return {archFile, archDocFile};
}

bool
SerializedModuleLoaderBase::findModule(AccessPathElem moduleID,
std::unique_ptr<llvm::MemoryBuffer> *moduleBuffer,
Expand All @@ -157,19 +174,19 @@ SerializedModuleLoaderBase::findModule(AccessPathElem moduleID,
moduleDocFilename +=
file_types::getExtension(file_types::TY_SwiftModuleDocFile);

// FIXME: Which name should we be using here? Do we care about CPU subtypes?
// FIXME: At the very least, don't hardcode "arch".
llvm::SmallString<16> archName{
Ctx.LangOpts.getPlatformConditionValue(PlatformConditionKind::Arch)};
llvm::SmallString<16> archFile{archName};
llvm::SmallString<16> archDocFile{archName};
if (!archFile.empty()) {
archFile += '.';
archFile += file_types::getExtension(file_types::TY_SwiftModuleFile);
StringRef archName = Ctx.LangOpts.Target.getArchName();
auto archFileNames = getArchSpecificModuleFileNames(archName);

archDocFile += '.';
archDocFile += file_types::getExtension(file_types::TY_SwiftModuleDocFile);
}
// FIXME: We used to use "major architecture" names for these files---the
// names checked in "#if arch(...)". Fall back to that name in the one case
// where it's different from what Swift 4.2 supported: 32-bit ARM platforms.
// We should be able to drop this once there's an Xcode that supports the
// new names.
StringRef alternateArchName;
if (Ctx.LangOpts.Target.getArch() == llvm::Triple::ArchType::arm)
alternateArchName = "arm";
auto alternateArchFileNames =
getArchSpecificModuleFileNames(alternateArchName);

auto &fs = *Ctx.SourceMgr.getFileSystem();
isFramework = false;
Expand All @@ -188,10 +205,19 @@ SerializedModuleLoaderBase::findModule(AccessPathElem moduleID,
if (statResult && statResult->isDirectory()) {
// A .swiftmodule directory contains architecture-specific files.
result = openModuleFiles(currPath,
archFile.str(), archDocFile.str(),
archFileNames.first, archFileNames.second,
moduleBuffer, moduleDocBuffer,
scratch);

if (result == std::errc::no_such_file_or_directory &&
!alternateArchName.empty()) {
result = openModuleFiles(currPath,
alternateArchFileNames.first,
alternateArchFileNames.second,
moduleBuffer, moduleDocBuffer,
scratch);
}

if (result == std::errc::no_such_file_or_directory) {
if (maybeDiagnoseArchitectureMismatch(moduleID.second, moduleName,
archName, currPath)) {
Expand Down Expand Up @@ -228,9 +254,18 @@ SerializedModuleLoaderBase::findModule(AccessPathElem moduleID,
// Frameworks always use architecture-specific files within a .swiftmodule
// directory.
llvm::sys::path::append(currPath, "Modules", moduleFilename.str());
auto err = openModuleFiles(currPath, archFile.str(), archDocFile.str(),
auto err = openModuleFiles(currPath,
archFileNames.first, archFileNames.second,
moduleBuffer, moduleDocBuffer, scratch);

if (err == std::errc::no_such_file_or_directory &&
!alternateArchName.empty()) {
err = openModuleFiles(currPath,
alternateArchFileNames.first,
alternateArchFileNames.second,
moduleBuffer, moduleDocBuffer, scratch);
}

if (err == std::errc::no_such_file_or_directory) {
if (maybeDiagnoseArchitectureMismatch(moduleID.second, moduleName,
archName, currPath)) {
Expand Down
18 changes: 18 additions & 0 deletions test/Serialization/load-arch-fallback-framework.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
// Test the fallback for 32-bit ARM platforms.

// RUN: %empty-directory(%t)
// RUN: mkdir -p %t/empty.framework/Modules/empty.swiftmodule
// RUN: %target-swift-frontend -emit-module -o %t/empty.framework/Modules/empty.swiftmodule/arm.swiftmodule %S/../Inputs/empty.swift -module-name empty
// RUN: %target-swift-frontend -typecheck %s -F %t

// RUN: mv %t/empty.framework/Modules/empty.swiftmodule/arm.swiftmodule %t/empty.framework/Modules/empty.swiftmodule/%target-swiftmodule-name
// RUN: touch %t/empty.framework/Modules/empty.swiftmodule/arm.swiftmodule
// RUN: %target-swift-frontend -typecheck %s -F %t

// RUN: rm %t/empty.framework/Modules/empty.swiftmodule/%target-swiftmodule-name
// RUN: not %target-swift-frontend -typecheck %s -F %t 2>&1 | %FileCheck %s

// REQUIRES: CPU=armv7 || CPU=armv7k || CPU=armv7s

import empty
// CHECK: :[[@LINE-1]]:8: error: malformed module file: {{.*}}arm.swiftmodule
18 changes: 18 additions & 0 deletions test/Serialization/load-arch-fallback.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
// Test the fallback for 32-bit ARM platforms.

// RUN: %empty-directory(%t)
// RUN: mkdir %t/empty.swiftmodule
// RUN: %target-swift-frontend -emit-module -o %t/empty.swiftmodule/arm.swiftmodule %S/../Inputs/empty.swift -module-name empty
// RUN: %target-swift-frontend -typecheck %s -I %t

// RUN: mv %t/empty.swiftmodule/arm.swiftmodule %t/empty.swiftmodule/%target-swiftmodule-name
// RUN: touch %t/empty.swiftmodule/arm.swiftmodule
// RUN: %target-swift-frontend -typecheck %s -I %t

// RUN: rm %t/empty.swiftmodule/%target-swiftmodule-name
// RUN: not %target-swift-frontend -typecheck %s -I %t 2>&1 | %FileCheck %s

// REQUIRES: CPU=armv7 || CPU=armv7k || CPU=armv7s

import empty
// CHECK: :[[@LINE-1]]:8: error: malformed module file: {{.*}}arm.swiftmodule
21 changes: 2 additions & 19 deletions test/lit.cfg
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -584,8 +584,6 @@ elif platform.system() == 'Linux':
if 'swift_interpreter' in config.available_features:
config.available_features.add('swift-remoteast-test')

config.target_swiftmodule_name = "unknown.swiftmodule"
config.target_swiftdoc_name = "unknown.swiftdoc"
config.target_runtime = "unknown"

swift_reflection_test_name = 'swift-reflection-test' + config.variant_suffix
Expand Down Expand Up @@ -623,8 +621,6 @@ def use_interpreter_for_simple_runs():

if run_vendor == 'apple':
config.available_features.add('objc_interop')
config.target_swiftmodule_name = run_cpu + ".swiftmodule"
config.target_swiftdoc_name = run_cpu + ".swiftdoc"
config.target_object_format = "macho"
config.target_dylib_extension = "dylib"
config.target_codesign = "codesign -f -s -"
Expand Down Expand Up @@ -660,15 +656,6 @@ if run_vendor == 'apple':
lit_config.note('Testing watchOS ' + config.variant_triple)
xcrun_sdk_name = "watchos"

if run_cpu == "armv7" or run_cpu == "armv7s" or run_cpu == "armv7k":
config.target_swiftmodule_name = "arm.swiftmodule"
config.target_swiftdoc_name = "arm.swiftdoc"
elif run_cpu == "arm64":
config.target_swiftmodule_name = "arm64.swiftmodule"
config.target_swiftdoc_name = "arm64.swiftdoc"
else:
lit_config.fatal("Unknown CPU '%s'" % run_cpu)

config.target_cc_options = (
"-arch %s -m%s-version-min=%s %s" %
(run_cpu, run_os, run_vers, clang_mcp_opt))
Expand Down Expand Up @@ -807,8 +794,6 @@ elif run_os in ['windows-msvc']:
config.target_dylib_extension = 'dll'
config.target_sdk_name = 'windows'
config.target_runtime = 'native'
config.target_swiftmodule_name = run_cpu + '.swiftmodule'
config.target_swiftdoc_name = run_cpu + '.swiftdoc'

config.target_build_swift = \
('%r -target %s %s %s %s %s %s' % (config.swiftc, \
Expand Down Expand Up @@ -880,8 +865,6 @@ elif run_os in ['linux-gnu', 'linux-gnueabihf', 'freebsd', 'windows-cygnus', 'wi
config.target_object_format = "elf"
config.target_dylib_extension = "so"
config.target_sdk_name = "linux"
config.target_swiftmodule_name = run_cpu + ".swiftmodule"
config.target_swiftdoc_name = run_cpu + ".swiftdoc"
config.target_runtime = "native"
config.target_swift_autolink_extract = inferSwiftBinary("swift-autolink-extract")
config.target_build_swift = (
Expand Down Expand Up @@ -1333,8 +1316,8 @@ else:
config.substitutions.insert(0, ('%platform-module-dir', platform_module_dir))
config.substitutions.insert(0, ('%platform-sdk-overlay-dir', platform_sdk_overlay_dir))

config.substitutions.append(('%target-swiftmodule-name', config.target_swiftmodule_name))
config.substitutions.append(('%target-swiftdoc-name', config.target_swiftdoc_name))
config.substitutions.append(('%target-swiftmodule-name', run_cpu + '.swiftmodule'))
config.substitutions.append(('%target-swiftdoc-name', run_cpu + '.swiftdoc'))

config.substitutions.append(('%target-object-format', config.target_object_format))
config.substitutions.append(('%target-dylib-extension', config.target_dylib_extension))
Expand Down