Skip to content

Commit

Permalink
Use swift-driver triple (swiftlang#6627)
Browse files Browse the repository at this point in the history
Removes and replaces the custom LLVM Triple type from the Basics module
with the implementation from SwiftDrvier. This change allows spm to
understand all triples that swift-driver already does and resolves some
issues surrounding incorrect triple parsing. For example the
Basics.Triple was not able to parse 'armv7em-apple-none-eabihf-macho'
where as SwiftDriver.Triple can.
  • Loading branch information
rauhul authored Jun 21, 2023
1 parent 383fa10 commit 4e6501b
Show file tree
Hide file tree
Showing 12 changed files with 2,464 additions and 349 deletions.
2 changes: 1 addition & 1 deletion Package.swift
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ let package = Package(
.product(name: "SwiftToolsSupport-auto", package: "swift-tools-support-core"),
.product(name: "SystemPackage", package: "swift-system"),
],
exclude: ["CMakeLists.txt"]
exclude: ["CMakeLists.txt", "Vendor/README.md"]
),

.target(
Expand Down
6 changes: 4 additions & 2 deletions Sources/Basics/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -53,9 +53,11 @@ add_library(Basics
String+Extensions.swift
SwiftVersion.swift
SQLiteBackedCache.swift
Triple.swift
Triple+Basics.swift
Version+Extensions.swift
WritableByteStream+Extensions.swift)
WritableByteStream+Extensions.swift
Vendor/Triple.swift
Vendor/Triple+Platforms.swift)
target_link_libraries(Basics PUBLIC
SwiftCollections::DequeModule
SwiftCollections::OrderedCollections
Expand Down
198 changes: 198 additions & 0 deletions Sources/Basics/Triple+Basics.swift
Original file line number Diff line number Diff line change
@@ -0,0 +1,198 @@
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift open source project
//
// Copyright (c) 2014-2023 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See http://swift.org/LICENSE.txt for license information
// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//

import enum TSCBasic.JSON
import class TSCBasic.Process

extension Triple {
public init(_ description: String) throws {
self.init(description, normalizing: false)
}
}

extension Triple {
public static let macOS = try! Self("x86_64-apple-macosx")
}

extension Triple {
public func isApple() -> Bool {
vendor == .apple
}

public func isAndroid() -> Bool {
os == .linux && environment == .android
}

public func isDarwin() -> Bool {
switch (vendor, os) {
case (.apple, .noneOS):
return false
case (.apple, _), (_, .macosx), (_, .darwin):
return true
default:
return false
}
}

public func isLinux() -> Bool {
os == .linux
}

public func isWindows() -> Bool {
os == .win32
}

public func isWASI() -> Bool {
os == .wasi
}

public func isOpenBSD() -> Bool {
os == .openbsd
}

/// Returns the triple string for the given platform version.
///
/// This is currently meant for Apple platforms only.
public func tripleString(forPlatformVersion version: String) -> String {
precondition(isDarwin())
// This function did not handle triples with a specific environments and
// object formats previously to using SwiftDriver.Triple and still does
// not.
return """
\(self.archName)-\
\(self.vendorName)-\
\(self.osNameUnversioned)\(version)
"""
}

public var tripleString: String {
self.triple
}

/// Determine the versioned host triple using the Swift compiler.
public static func getHostTriple(usingSwiftCompiler swiftCompiler: AbsolutePath) throws -> Triple {
// Call the compiler to get the target info JSON.
let compilerOutput: String
do {
let result = try Process.popen(args: swiftCompiler.pathString, "-print-target-info")
compilerOutput = try result.utf8Output().spm_chomp()
} catch {
throw InternalError("Failed to get target info (\(error.interpolationDescription))")
}
// Parse the compiler's JSON output.
let parsedTargetInfo: JSON
do {
parsedTargetInfo = try JSON(string: compilerOutput)
} catch {
throw InternalError(
"Failed to parse target info (\(error.interpolationDescription)).\nRaw compiler output: \(compilerOutput)"
)
}
// Get the triple string from the parsed JSON.
let tripleString: String
do {
tripleString = try parsedTargetInfo.get("target").get("triple")
} catch {
throw InternalError(
"Target info does not contain a triple string (\(error.interpolationDescription)).\nTarget info: \(parsedTargetInfo)"
)
}

// Parse the triple string.
do {
return try Triple(tripleString)
} catch {
throw InternalError(
"Failed to parse triple string (\(error.interpolationDescription)).\nTriple string: \(tripleString)"
)
}
}
}

extension Triple {
/// The file prefix for dynamic libraries
public var dynamicLibraryPrefix: String {
switch os {
case .win32:
return ""
default:
return "lib"
}
}

/// The file extension for dynamic libraries (eg. `.dll`, `.so`, or `.dylib`)
public var dynamicLibraryExtension: String {
guard let os = self.os else {
fatalError("Cannot create dynamic libraries unknown os.")
}

switch os {
case .darwin, .macosx:
return ".dylib"
case .linux, .openbsd:
return ".so"
case .win32:
return ".dll"
case .wasi:
return ".wasm"
default:
fatalError("Cannot create dynamic libraries for os \"\(os)\".")
}
}

public var executableExtension: String {
guard let os = self.os else {
return ""
}

switch os {
case .darwin, .macosx:
return ""
case .linux, .openbsd:
return ""
case .wasi:
return ".wasm"
case .win32:
return ".exe"
case .noneOS:
return ""
default:
return ""
}
}

/// The file extension for static libraries.
public var staticLibraryExtension: String {
".a"
}

/// The file extension for Foundation-style bundle.
public var nsbundleExtension: String {
switch os {
case .darwin, .macosx:
return ".bundle"
default:
// See: https://github.com/apple/swift-corelibs-foundation/blob/master/Docs/FHS%20Bundles.md
return ".resources"
}
}
}

extension Triple: CustomStringConvertible {
public var description: String { tripleString }
}

extension Triple: Equatable {
public static func == (lhs: Self, rhs: Self) -> Bool {
lhs.triple == rhs.triple
}
}
Loading

0 comments on commit 4e6501b

Please sign in to comment.