Use package access control for BinaryInstructionDecoder

This is a preparation for a future internal breakpoint instruction, for which we need `visitUnknown` of `BinaryInstructionDecoder` to be available in the `WasmKit` module.

Bumped `swift-tools-version` to 6.0 to get proper support for `package` in SwiftPM enabled.

Author: MaxDesiatov

Package.swift

@@ -1,4 +1,4 @@
-// swift-tools-version:5.8
+// swift-tools-version:6.0
 
 import PackageDescription
 

Sources/WasmKit/Execution/Function.swift

@@ -124,6 +124,8 @@ struct InternalFunction: Equatable, Hashable {
         _storage = bitPattern
     }
 
+    /// Returns `true` if the function is defined as a Wasm function in its original module.
+    /// Returns `false` if the function is implemented by the host.
     var isWasm: Bool {
         _storage & 0b1 == 0
     }
@@ -241,7 +243,7 @@ struct WasmFunctionEntity {
         switch code {
         case .uncompiled(let code):
             return try compile(store: store, code: code)
-        case .compiled(let iseq):
+        case .compiled(let iseq), .compiledAndPatchable(_, let iseq):
             return iseq
         }
     }
@@ -281,7 +283,8 @@ extension EntityHandle<WasmFunctionEntity> {
                 $0.code = .compiled(iseq)
                 return iseq
             }
-        case .compiled(let iseq): return iseq
+        case .compiled(let iseq), .compiledAndPatchable(_, let iseq):
+            return iseq
         }
     }
 }
@@ -313,6 +316,7 @@ struct InstructionSequence {
 enum CodeBody {
     case uncompiled(InternalUncompiledCode)
     case compiled(InstructionSequence)
+    case compiledAndPatchable(InternalUncompiledCode, InstructionSequence)
 }
 
 extension Reference {

Sources/WasmParser/BinaryInstructionDecoder.swift

@@ -5,7 +5,7 @@
 import WasmTypes
 
 @usableFromInline
-protocol BinaryInstructionDecoder {
+package protocol BinaryInstructionDecoder {
     /// Claim the next byte to be decoded
     @inlinable func claimNextByte() throws -> UInt8
     /// Visit unknown instruction

Sources/WasmParser/WasmParser.swift

@@ -606,23 +606,23 @@ extension Parser: BinaryInstructionDecoder {
         return 0
     }
 
-    @inlinable func visitUnknown(_ opcode: [UInt8]) throws {
+    @inlinable package func visitUnknown(_ opcode: [UInt8]) throws {
         throw makeError(.illegalOpcode(opcode))
     }
 
-    @inlinable mutating func visitBlock() throws -> BlockType { try parseResultType() }
-    @inlinable mutating func visitLoop() throws -> BlockType { try parseResultType() }
-    @inlinable mutating func visitIf() throws -> BlockType { try parseResultType() }
-    @inlinable mutating func visitBr() throws -> UInt32 { try parseUnsigned() }
-    @inlinable mutating func visitBrIf() throws -> UInt32 { try parseUnsigned() }
-    @inlinable mutating func visitBrTable() throws -> BrTable {
+    @inlinable package mutating func visitBlock() throws -> BlockType { try parseResultType() }
+    @inlinable package mutating func visitLoop() throws -> BlockType { try parseResultType() }
+    @inlinable package mutating func visitIf() throws -> BlockType { try parseResultType() }
+    @inlinable package mutating func visitBr() throws -> UInt32 { try parseUnsigned() }
+    @inlinable package mutating func visitBrIf() throws -> UInt32 { try parseUnsigned() }
+    @inlinable package mutating func visitBrTable() throws -> BrTable {
         let labelIndices: [UInt32] = try parseVector { try parseUnsigned() }
         let labelIndex: UInt32 = try parseUnsigned()
         return BrTable(labelIndices: labelIndices, defaultIndex: labelIndex)
     }
-    @inlinable mutating func visitCall() throws -> UInt32 { try parseUnsigned() }
+    @inlinable package mutating func visitCall() throws -> UInt32 { try parseUnsigned() }
 
-    @inlinable mutating func visitCallIndirect() throws -> (typeIndex: UInt32, tableIndex: UInt32) {
+    @inlinable package mutating func visitCallIndirect() throws -> (typeIndex: UInt32, tableIndex: UInt32) {
         let typeIndex: TypeIndex = try parseUnsigned()
         if try !features.contains(.referenceTypes) && stream.peek() != 0 {
             // Check that reserved byte is zero when reference-types is disabled
@@ -632,115 +632,115 @@ extension Parser: BinaryInstructionDecoder {
         return (typeIndex, tableIndex)
     }
 
-    @inlinable mutating func visitReturnCall() throws -> UInt32 {
+    @inlinable package mutating func visitReturnCall() throws -> UInt32 {
         try parseUnsigned()
     }
 
-    @inlinable mutating func visitReturnCallIndirect() throws -> (typeIndex: UInt32, tableIndex: UInt32) {
+    @inlinable package mutating func visitReturnCallIndirect() throws -> (typeIndex: UInt32, tableIndex: UInt32) {
         let typeIndex: TypeIndex = try parseUnsigned()
         let tableIndex: TableIndex = try parseUnsigned()
         return (typeIndex, tableIndex)
     }
 
-    @inlinable mutating func visitTypedSelect() throws -> WasmTypes.ValueType {
+    @inlinable package mutating func visitTypedSelect() throws -> WasmTypes.ValueType {
         let results = try parseVector { try parseValueType() }
         guard results.count == 1 else {
             throw makeError(.invalidResultArity(expected: 1, actual: results.count))
         }
         return results[0]
     }
 
-    @inlinable mutating func visitLocalGet() throws -> UInt32 { try parseUnsigned() }
-    @inlinable mutating func visitLocalSet() throws -> UInt32 { try parseUnsigned() }
-    @inlinable mutating func visitLocalTee() throws -> UInt32 { try parseUnsigned() }
-    @inlinable mutating func visitGlobalGet() throws -> UInt32 { try parseUnsigned() }
-    @inlinable mutating func visitGlobalSet() throws -> UInt32 { try parseUnsigned() }
-    @inlinable mutating func visitLoad(_: Instruction.Load) throws -> MemArg { try parseMemarg() }
-    @inlinable mutating func visitStore(_: Instruction.Store) throws -> MemArg { try parseMemarg() }
-    @inlinable mutating func visitMemorySize() throws -> UInt32 {
+    @inlinable package mutating func visitLocalGet() throws -> UInt32 { try parseUnsigned() }
+    @inlinable package mutating func visitLocalSet() throws -> UInt32 { try parseUnsigned() }
+    @inlinable package mutating func visitLocalTee() throws -> UInt32 { try parseUnsigned() }
+    @inlinable package mutating func visitGlobalGet() throws -> UInt32 { try parseUnsigned() }
+    @inlinable package mutating func visitGlobalSet() throws -> UInt32 { try parseUnsigned() }
+    @inlinable package mutating func visitLoad(_: Instruction.Load) throws -> MemArg { try parseMemarg() }
+    @inlinable package mutating func visitStore(_: Instruction.Store) throws -> MemArg { try parseMemarg() }
+    @inlinable package mutating func visitMemorySize() throws -> UInt32 {
         try parseMemoryIndex()
     }
-    @inlinable mutating func visitMemoryGrow() throws -> UInt32 {
+    @inlinable package mutating func visitMemoryGrow() throws -> UInt32 {
         try parseMemoryIndex()
     }
-    @inlinable mutating func visitI32Const() throws -> Int32 {
+    @inlinable package mutating func visitI32Const() throws -> Int32 {
         let n: UInt32 = try parseInteger()
         return Int32(bitPattern: n)
     }
-    @inlinable mutating func visitI64Const() throws -> Int64 {
+    @inlinable package mutating func visitI64Const() throws -> Int64 {
         let n: UInt64 = try parseInteger()
         return Int64(bitPattern: n)
     }
-    @inlinable mutating func visitF32Const() throws -> IEEE754.Float32 {
+    @inlinable package mutating func visitF32Const() throws -> IEEE754.Float32 {
         let n = try parseFloat()
         return IEEE754.Float32(bitPattern: n)
     }
-    @inlinable mutating func visitF64Const() throws -> IEEE754.Float64 {
+    @inlinable package mutating func visitF64Const() throws -> IEEE754.Float64 {
         let n = try parseDouble()
         return IEEE754.Float64(bitPattern: n)
     }
-    @inlinable mutating func visitRefNull() throws -> WasmTypes.ReferenceType {
+    @inlinable package mutating func visitRefNull() throws -> WasmTypes.ReferenceType {
         let type = try parseValueType()
         guard case let .ref(refType) = type else {
             throw makeError(.expectedRefType(actual: type))
         }
         return refType
     }
 
-    @inlinable mutating func visitRefFunc() throws -> UInt32 { try parseUnsigned() }
-    @inlinable mutating func visitMemoryInit() throws -> UInt32 {
+    @inlinable package mutating func visitRefFunc() throws -> UInt32 { try parseUnsigned() }
+    @inlinable package mutating func visitMemoryInit() throws -> UInt32 {
         let dataIndex: DataIndex = try parseUnsigned()
         _ = try parseMemoryIndex()
         return dataIndex
     }
 
-    @inlinable mutating func visitDataDrop() throws -> UInt32 {
+    @inlinable package mutating func visitDataDrop() throws -> UInt32 {
         try parseUnsigned()
     }
 
-    @inlinable mutating func visitMemoryCopy() throws -> (dstMem: UInt32, srcMem: UInt32) {
+    @inlinable package mutating func visitMemoryCopy() throws -> (dstMem: UInt32, srcMem: UInt32) {
         _ = try parseMemoryIndex()
         _ = try parseMemoryIndex()
         return (0, 0)
     }
 
-    @inlinable mutating func visitMemoryFill() throws -> UInt32 {
+    @inlinable package mutating func visitMemoryFill() throws -> UInt32 {
         let zero = try stream.consumeAny()
         guard zero == 0x00 else {
             throw makeError(.zeroExpected(actual: zero))
         }
         return 0
     }
 
-    @inlinable mutating func visitTableInit() throws -> (elemIndex: UInt32, table: UInt32) {
+    @inlinable package mutating func visitTableInit() throws -> (elemIndex: UInt32, table: UInt32) {
         let elementIndex: ElementIndex = try parseUnsigned()
         let tableIndex: TableIndex = try parseUnsigned()
         return (elementIndex, tableIndex)
     }
-    @inlinable mutating func visitElemDrop() throws -> UInt32 {
+    @inlinable package mutating func visitElemDrop() throws -> UInt32 {
         try parseUnsigned()
     }
-    @inlinable mutating func visitTableCopy() throws -> (dstTable: UInt32, srcTable: UInt32) {
+    @inlinable package mutating func visitTableCopy() throws -> (dstTable: UInt32, srcTable: UInt32) {
         let destination: TableIndex = try parseUnsigned()
         let source: TableIndex = try parseUnsigned()
         return (destination, source)
     }
-    @inlinable mutating func visitTableFill() throws -> UInt32 {
+    @inlinable package mutating func visitTableFill() throws -> UInt32 {
         try parseUnsigned()
     }
-    @inlinable mutating func visitTableGet() throws -> UInt32 {
+    @inlinable package mutating func visitTableGet() throws -> UInt32 {
         try parseUnsigned()
     }
-    @inlinable mutating func visitTableSet() throws -> UInt32 {
+    @inlinable package mutating func visitTableSet() throws -> UInt32 {
         try parseUnsigned()
     }
-    @inlinable mutating func visitTableGrow() throws -> UInt32 {
+    @inlinable package mutating func visitTableGrow() throws -> UInt32 {
         try parseUnsigned()
     }
-    @inlinable mutating func visitTableSize() throws -> UInt32 {
+    @inlinable package mutating func visitTableSize() throws -> UInt32 {
         try parseUnsigned()
     }
-    @inlinable func claimNextByte() throws -> UInt8 {
+    @inlinable package func claimNextByte() throws -> UInt8 {
         return try stream.consumeAny()
     }
 

Utilities/Sources/WasmGen.swift

@@ -524,7 +524,7 @@ enum WasmGen {
         import WasmTypes
 
         @usableFromInline
-        protocol BinaryInstructionDecoder {
+        package protocol BinaryInstructionDecoder {
             /// Claim the next byte to be decoded
             @inlinable func claimNextByte() throws -> UInt8
             /// Visit unknown instruction