Skip to content

Validate C++ and ObjC related args for Darwin toolchain #184

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.

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 3 commits into from
Jul 28, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 2 additions & 1 deletion Sources/SwiftDriver/Driver/Driver.swift
Original file line number Diff line number Diff line change
Expand Up @@ -311,7 +311,8 @@ public struct Driver {
Self.validateCoverageArgs(&parsedOptions, diagnosticsEngine: diagnosticEngine)
try toolchain.validateArgs(&parsedOptions,
targetTriple: self.frontendTargetInfo.target.triple,
targetVariantTriple: self.frontendTargetInfo.targetVariant?.triple)
targetVariantTriple: self.frontendTargetInfo.targetVariant?.triple,
diagnosticsEngine: diagnosticEngine)

// Compute debug information output.
self.debugInfo = Self.computeDebugInfo(&parsedOptions, diagnosticsEngine: diagnosticEngine)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import TSCBasic
import SwiftOptions

extension DarwinToolchain {
private func findARCLiteLibPath() throws -> AbsolutePath? {
internal func findARCLiteLibPath() throws -> AbsolutePath? {
let path = try getToolPath(.swiftCompiler)
.parentDirectory // 'swift'
.parentDirectory // 'bin'
Expand Down
48 changes: 42 additions & 6 deletions Sources/SwiftDriver/Toolchains/DarwinToolchain.swift
Original file line number Diff line number Diff line change
Expand Up @@ -123,8 +123,10 @@ public final class DarwinToolchain: Toolchain {

public enum ToolchainValidationError: Error, DiagnosticData {
case osVersionBelowMinimumDeploymentTarget(String)
case argumentNotSupported(String)
case iOSVersionAboveMaximumDeploymentTarget(Int)
case unsupportedTargetVariant(variant: Triple)
case darwinOnlySupportsLibCxx

public var description: String {
switch self {
Expand All @@ -134,24 +136,38 @@ public final class DarwinToolchain: Toolchain {
return "iOS \(version) does not support 32-bit programs"
case .unsupportedTargetVariant(variant: let variant):
return "unsupported '\(variant.isiOS ? "-target" : "-target-variant")' value '\(variant)'; use 'ios-macabi' instead"
case .argumentNotSupported(let argument):
return "\(argument) is no longer supported for Apple platforms"
case .darwinOnlySupportsLibCxx:
return "The only C++ standard library supported on Apple platforms is libc++"
}
}
}

public func validateArgs(_ parsedOptions: inout ParsedOptions,
targetTriple: Triple,
targetVariantTriple: Triple?) throws {
// TODO: Validating arclite library path when link-objc-runtime.

targetVariantTriple: Triple?,
diagnosticsEngine: DiagnosticsEngine) throws {
// Validating arclite library path when link-objc-runtime.
validateLinkObjcRuntimeARCLiteLib(&parsedOptions,
targetTriple: targetTriple,
diagnosticsEngine: diagnosticsEngine)
// Validating apple platforms deployment targets.
try validateDeploymentTarget(&parsedOptions, targetTriple: targetTriple)
if let targetVariantTriple = targetVariantTriple,
!targetTriple.isValidForZipperingWithTriple(targetVariantTriple) {
throw ToolchainValidationError.unsupportedTargetVariant(variant: targetVariantTriple)
}

// TODO: Validating darwin unsupported -static-stdlib argument.
// TODO: If a C++ standard library is specified, it has to be libc++.
// Validating darwin unsupported -static-stdlib argument.
if parsedOptions.hasArgument(.staticStdlib) {
throw ToolchainValidationError.argumentNotSupported("-static-stdlib")
}
// If a C++ standard library is specified, it has to be libc++.
if let cxxLib = parsedOptions.getLastArgument(.experimentalCxxStdlib) {
if cxxLib.asSingle != "libc++" {
throw ToolchainValidationError.darwinOnlySupportsLibCxx
}
}
}

func validateDeploymentTarget(_ parsedOptions: inout ParsedOptions,
Expand All @@ -178,4 +194,24 @@ public final class DarwinToolchain: Toolchain {
throw ToolchainValidationError.osVersionBelowMinimumDeploymentTarget("watchOS 2.0")
}
}

func validateLinkObjcRuntimeARCLiteLib(_ parsedOptions: inout ParsedOptions,
targetTriple: Triple,
diagnosticsEngine: DiagnosticsEngine) {
if parsedOptions.hasFlag(positive: .linkObjcRuntime, negative: .noLinkObjcRuntime, default: targetTriple.supports(.compatibleObjCRuntime)) {
guard let _ = try? findARCLiteLibPath() else {
diagnosticsEngine.emit(.warn_arclite_not_found_when_link_objc_runtime)
return
}
}
}
}

extension Diagnostic.Message {
static var warn_arclite_not_found_when_link_objc_runtime: Diagnostic.Message {
.warning(
"unable to find Objective-C runtime support library 'arclite'; " +
"pass '-no-link-objc-runtime' to silence this warning"
)
}
}
4 changes: 2 additions & 2 deletions Sources/SwiftDriver/Toolchains/Toolchain.swift
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ public protocol Toolchain {
/// Perform platform-specific argument validation.
func validateArgs(_ parsedOptions: inout ParsedOptions,
targetTriple: Triple,
targetVariantTriple: Triple?) throws
targetVariantTriple: Triple?, diagnosticsEngine: DiagnosticsEngine) throws

/// Adds platform-specific linker flags to the provided command line
func addPlatformSpecificLinkerArgs(
Expand Down Expand Up @@ -155,7 +155,7 @@ extension Toolchain {

public func validateArgs(_ parsedOptions: inout ParsedOptions,
targetTriple: Triple,
targetVariantTriple: Triple?) {}
targetVariantTriple: Triple?, diagnosticsEngine: DiagnosticsEngine) {}
}

public enum ToolchainError: Swift.Error {
Expand Down
17 changes: 17 additions & 0 deletions Tests/SwiftDriverTests/SwiftDriverTests.swift
Original file line number Diff line number Diff line change
Expand Up @@ -1540,6 +1540,23 @@ final class SwiftDriverTests: XCTestCase {
return
}
}

XCTAssertThrowsError(try Driver(args: ["swiftc", "-c", "-static-stdlib", "-target", "x86_64-apple-macosx10.14",
"foo.swift"])) { error in
guard case DarwinToolchain.ToolchainValidationError.argumentNotSupported("-static-stdlib") = error else {
XCTFail()
return
}
}

XCTAssertThrowsError(try Driver(args: ["swiftc", "-c", "-target", "x86_64-apple-macosx10.14", "-experimental-cxx-stdlib", "libstdc++",
"foo.swift"])) { error in
guard case DarwinToolchain.ToolchainValidationError.darwinOnlySupportsLibCxx = error else {
XCTFail()
return
}
}
try assertNoDriverDiagnostics(args: "swiftc", "-c", "-target", "x86_64-apple-macosx10.14", "-link-objc-runtime", "foo.swift")
}

func testDSYMGeneration() throws {
Expand Down