Merge pull request #13 from MxIris-Reverse-Engineering/develop

0.5.0

Author: Mx-Iris

Package.swift

@@ -1,10 +1,31 @@
-// swift-tools-version: 5.10
+// swift-tools-version: 6.1
 // The swift-tools-version declares the minimum version of Swift required to build this package.
 
-import PackageDescription
+@preconcurrency import PackageDescription
 import CompilerPluginSupport
 
-let useSPMPrebuildVersion = false
+func envEnable(_ key: String, default defaultValue: Bool = false) -> Bool {
+    guard let value = Context.environment[key] else {
+        return defaultValue
+    }
+    if value == "1" {
+        return true
+    } else if value == "0" {
+        return false
+    } else {
+        return defaultValue
+    }
+}
+
+let isSilentTest = envEnable("MACHO_SWIFT_SECTION_SILENT_TEST", default: false)
+
+let useSPMPrebuildVersion = envEnable("MACHO_SWIFT_SECTION_USE_SPM_PREBUILD_VERSION", default: false)
+
+var testSettings: [SwiftSetting] = []
+
+if isSilentTest {
+    testSettings.append(.define("SILENT_TEST"))
+}
 
 extension Package.Dependency {
     static let MachOKit: Package.Dependency = {
@@ -72,7 +93,7 @@ extension Target.Dependency {
 
 let package = Package(
     name: "MachOSwiftSection",
-    platforms: [.macOS(.v10_15)],
+    platforms: [.macOS(.v10_15), .iOS(.v13), .tvOS(.v13), .watchOS(.v6), .visionOS(.v1)],
     products: [
         .library(
             name: "MachOSwiftSection",
@@ -89,7 +110,7 @@ let package = Package(
     ],
     dependencies: [
         .MachOKit,
-        .package(url: "https://github.com/swiftlang/swift-syntax.git", "509.1.0"..<"602.0.0"),
+        .package(url: "https://github.com/swiftlang/swift-syntax.git", "509.1.0" ..< "602.0.0"),
         .package(url: "https://github.com/p-x9/AssociatedObject", from: "0.13.0"),
         .package(url: "https://github.com/p-x9/swift-fileio.git", from: "0.9.0"),
         .package(url: "https://github.com/apple/swift-argument-parser", from: "1.5.1"),
@@ -111,6 +132,7 @@ let package = Package(
             name: "MachOExtensions",
             dependencies: [
                 .MachOKit,
+                "MachOMacro",
             ]
         ),
 
@@ -146,10 +168,10 @@ let package = Package(
         .target(
             name: "MachOSwiftSection",
             dependencies: [
+                .MachOKit,
                 "Demangle",
                 "MachOFoundation",
                 "MachOMacro",
-                .MachOKit,
             ]
         ),
 
@@ -158,7 +180,9 @@ let package = Package(
             dependencies: [
                 .MachOKit,
                 "MachOExtensions",
-            ]
+                "SwiftDump",
+            ],
+            swiftSettings: testSettings
         ),
 
         .target(
@@ -209,15 +233,18 @@ let package = Package(
                 "MachOSwiftSection",
                 "SwiftDump",
                 "MachOTestingSupport",
-            ]
+            ],
+            swiftSettings: testSettings
         ),
 
         .testTarget(
             name: "SwiftDumpTests",
             dependencies: [
                 "SwiftDump",
                 "MachOTestingSupport",
-            ]
+            ],
+            swiftSettings: testSettings
         ),
-    ]
+    ],
+    swiftLanguageModes: [.v5]
 )

Sources/Demangle/Main/DemangleOptions.swift

@@ -24,8 +24,8 @@ public struct DemangleOptions: OptionSet, Codable, Sendable {
     public static let printForTypeName = DemangleOptions(rawValue: 1 << 19)
     public static let showClosureSignature = DemangleOptions(rawValue: 1 << 20)
     public static let showModuleInDependentMemberType = DemangleOptions(rawValue: 1 << 21)
-    public static let showPrefixAndSuffix = DemangleOptions(rawValue: 1 << 22)
 
+    package static let removeWeakPrefix = DemangleOptions(rawValue: 1 << 22)
 
     public init(rawValue: Int) {
         self.rawValue = rawValue
@@ -47,8 +47,7 @@ public struct DemangleOptions: OptionSet, Codable, Sendable {
         .displayStdlibModule,
         .displayObjCModule,
         .showClosureSignature,
-        .showModuleInDependentMemberType,
-        .showPrefixAndSuffix
+        .showModuleInDependentMemberType
     ]
 
     public static let simplified: DemangleOptions = [

Sources/Demangle/Main/NodePrinter.swift

@@ -5,7 +5,7 @@ struct NodePrinter: Sendable {
     var specializationPrefixPrinted: Bool
     var options: DemangleOptions
     var hidingCurrentModule: String = ""
-    
+
     init(options: DemangleOptions = .default) {
         self.target = .init()
         self.specializationPrefixPrinted = false
@@ -16,7 +16,7 @@ struct NodePrinter: Sendable {
         guard options.contains(.qualifyEntities) else {
             return false
         }
-        if !options.contains(.showModuleInDependentMemberType), let dependentMemberType = context.parent?.parent?.parent?.parent, dependentMemberType.kind == .dependentMemberType  {
+        if !options.contains(.showModuleInDependentMemberType), let dependentMemberType = context.parent?.parent?.parent?.parent, dependentMemberType.kind == .dependentMemberType {
             return false
         }
         if context.kind == .module, let text = context.text, !text.isEmpty {
@@ -35,13 +35,9 @@ struct NodePrinter: Sendable {
 
     mutating func printOptional(_ optional: Node?, prefix: String? = nil, suffix: String? = nil, asPrefixContext: Bool = false) -> Node? {
         guard let o = optional else { return nil }
-        if options.contains(.showPrefixAndSuffix) {
-            prefix.map { target.write($0) }
-        }
+        prefix.map { target.write($0) }
         let r = printName(o)
-        if options.contains(.showPrefixAndSuffix) {
-            suffix.map { target.write($0) }
-        }
+        suffix.map { target.write($0) }
         return r
     }
 
@@ -105,7 +101,7 @@ struct NodePrinter: Sendable {
 
     mutating func printModule(_ name: Node) {
         if options.contains(.displayModuleNames) {
-            target.write(name.text ?? "")
+            target.write(name.text ?? "", type: .other)
         }
     }
 
@@ -848,7 +844,7 @@ struct NodePrinter: Sendable {
 
     mutating func printImplDifferentiabilityKind(_ name: Node) {
         target.write("@differentiable")
-        if case let .index(value) = name.contents, let differentiability = Differentiability(value) {
+        if case .index(let value) = name.contents, let differentiability = Differentiability(value) {
             switch differentiability {
             case .normal: break
             case .linear: target.write("(_linear)")
@@ -859,7 +855,7 @@ struct NodePrinter: Sendable {
     }
 
     mutating func printImplCoroutineKind(_ name: Node) {
-        guard case let .name(value) = name.contents, !value.isEmpty else { return }
+        guard case .name(let value) = name.contents, !value.isEmpty else { return }
         target.write("@\(value)")
     }
 
@@ -876,7 +872,7 @@ struct NodePrinter: Sendable {
     }
 
     mutating func printImplParameterName(_ name: Node) {
-        guard case let .name(value) = name.contents, !value.isEmpty else { return }
+        guard case .name(let value) = name.contents, !value.isEmpty else { return }
         target.write("\(value) ")
     }
 
@@ -1183,7 +1179,7 @@ struct NodePrinter: Sendable {
         case .globalVariableOnceFunction,
              .globalVariableOnceToken: printGlobalVariableOnceFunction(name)
         case .hasSymbolQuery: target.write("#_hasSymbol query for ")
-        case .identifier: target.write(name.text ?? "", type: (name.parent?.kind == .function || name.parent?.kind == .variable) ? .functionDeclaration : .typeName)
+        case .identifier: printIdentifier(name, asPrefixContext: asPrefixContext)
         case .implConvention: target.write(name.text ?? "")
         case .implCoroutineKind: printImplCoroutineKind(name)
         case .implDifferentiabilityKind: printImplDifferentiabilityKind(name)
@@ -1396,13 +1392,36 @@ struct NodePrinter: Sendable {
         case .variadicMarker: target.write(" variadic-marker ")
         case .vTableAttribute: target.write("override ")
         case .vTableThunk: printVTableThunk(name)
-        case .weak: printFirstChild(name, prefix: "weak ")
+        case .weak: printFirstChild(name, prefix: options.contains(.removeWeakPrefix) ? "" : "weak ")
         case .willSet: return printAbstractStorage(name.children.first, asPrefixContext: asPrefixContext, extraName: "willset")
         }
 
         return nil
     }
 
+    mutating func printIdentifier(_ name: Node, asPrefixContext: Bool = false) {
+        let semanticType: SemanticType
+
+        switch name.parent?.kind {
+        case .function:
+            semanticType = .function(.declaration)
+        case .variable:
+            semanticType = .variable
+        case .enum:
+            semanticType = .type(.enum, .name)
+        case .structure:
+            semanticType = .type(.struct, .name)
+        case .class:
+            semanticType = .type(.class, .name)
+        case .protocol:
+            semanticType = .type(.protocol, .name)
+        default:
+            semanticType = .standard
+        }
+
+        target.write(name.text ?? "", type: semanticType)
+    }
+
     mutating func printAbstractStorage(_ name: Node?, asPrefixContext: Bool, extraName: String) -> Node? {
         guard let n = name else { return nil }
         switch n.kind {
@@ -1609,17 +1628,17 @@ struct NodePrinter: Sendable {
         target.write("(")
         for tuple in parameters.children.enumerated() {
             if let label = labelList?.children.at(tuple.offset) {
-                target.write(label.kind == .identifier ? (label.text ?? "") : "_", type: .functionDeclaration)
+                target.write(label.kind == .identifier ? (label.text ?? "") : "_", type: .function(.declaration))
                 target.write(":")
                 if showTypes {
                     target.write(" ")
                 }
             } else if !showTypes {
                 if let label = tuple.element.children.first(where: { $0.kind == .tupleElementName }) {
-                    target.write(label.text ?? "", type: .functionDeclaration)
+                    target.write(label.text ?? "", type: .function(.declaration))
                     target.write(":")
                 } else {
-                    target.write("_", type: .functionDeclaration)
+                    target.write("_", type: .function(.declaration))
                     target.write(":")
                 }
             }

Sources/MachOExtensions/MachORepresentable+.swift

@@ -0,0 +1,17 @@
+import Foundation
+import MachOKit
+import MachOMacro
+
+@MachOImageAllMembersGenerator
+extension MachORepresentable {
+    package func _section(
+        for name: String,
+        in machOFile: MachOFile
+    ) -> (any SectionProtocol)? {
+        sections.first(
+            where: {
+                $0.sectionName == name
+            }
+        )
+    }
+}

Sources/MachOExtensions/MachORepresentableWithCache.swift

@@ -1,7 +1,9 @@
 import MachOKit
 
 package protocol MachORepresentableWithCache: MachORepresentable {
-    var cache: DyldCache? { get }
+    associatedtype Cache: DyldCacheRepresentable
+
+    var cache: Cache? { get }
     var startOffset: Int { get }
 }
 
@@ -16,8 +18,22 @@ extension MachOFile: MachORepresentableWithCache {
 }
 
 extension MachOImage: MachORepresentableWithCache {
-    package var cache: DyldCache? { nil }
-    package var startOffset: Int { 0 }
+    package var cache: DyldCacheLoaded? {
+        guard let currentCache = DyldCacheLoaded.current else { return nil }
+
+        if ptr.int - currentCache.mainCacheHeader.sharedRegionStart.cast() >= 0 {
+            return currentCache
+        }
+        return nil
+    }
+
+    package var startOffset: Int {
+        if let cache {
+            return cache.mainCacheHeader.sharedRegionStart.cast()
+        } else {
+            return 0
+        }
+    }
 }
 
 package func address<MachO: MachORepresentableWithCache>(of fileOffset: Int, in machO: MachO) -> UInt64 {

Sources/MachOExtensions/SegmentCommandProtocol+.swift

@@ -18,3 +18,6 @@ extension SegmentCommandProtocol {
         )
     }
 }
+
+
+

Sources/MachOPointer/Symbol/MachOSymbolCache.swift

@@ -34,14 +34,16 @@ class MachOSymbolCache {
         var cacheEntry: CacheEntry = [:]
         for symbol in symbols64 where !symbol.name.isEmpty {
             var offset = symbol.offset
+            cacheEntry[offset] = .init(offset: offset, stringValue: symbol.name)
             if let cache = machO.cache {
                 offset -= cache.mainCacheHeader.sharedRegionStart.cast()
+                cacheEntry[offset] = .init(offset: offset, stringValue: symbol.name)
             }
-            cacheEntry[offset] = .init(offset: offset, stringValue: symbol.name)
         }
 
         for exportedSymbol in machO.exportedSymbols {
             if var offset = exportedSymbol.offset {
+                cacheEntry[offset] = .init(offset: offset, stringValue: exportedSymbol.name)
                 offset += machO.startOffset
                 cacheEntry[offset] = .init(offset: offset, stringValue: exportedSymbol.name)
             }
@@ -78,15 +80,19 @@ class MachOSymbolCache {
 
     func symbol(for offset: Int, in machOImage: MachOImage) -> MachOSymbol? {
         let identifier = CacheIdentifier.image(machOImage.ptr)
-        return symbol(for: offset, with: identifier)
+        return symbol(for: offset, with: identifier, in: machOImage)
     }
 
     func symbol(for offset: Int, in machOFile: MachOFile) -> MachOSymbol? {
         let identifier = CacheIdentifier.file(machOFile.imagePath)
-        return symbol(for: offset, with: identifier)
+        return symbol(for: offset, with: identifier, in: machOFile)
     }
 
-    private func symbol(for offset: Int, with identifier: CacheIdentifier) -> MachOSymbol? {
-        return entryByIdentifier[identifier]?[offset]
+    private func symbol<MachO: MachORepresentableWithCache>(for offset: Int, with identifier: CacheIdentifier, in machO: MachO) -> MachOSymbol? {
+        if let symbol = entryByIdentifier[identifier, default: [:]][offset] {
+            return symbol
+        } else {
+            return nil
+        }
     }
 }

Sources/MachOSwiftSection/Extensions/Array+.swift

@@ -0,0 +1,13 @@
+import Foundation
+
+func + <Element>(lhs: [Element]?, rhs: [Element]?) -> [Element] {
+    (lhs ?? []) + (rhs ?? [])
+}
+
+func + <Element>(lhs: [Element], rhs: [Element]?) -> [Element] {
+    lhs + (rhs ?? [])
+}
+
+func + <Element>(lhs: [Element]?, rhs: [Element]) -> [Element] {
+    (lhs ?? []) + rhs
+}