Files
swift-mirror/test/stdlib/Span/MutableRawSpanTests.swift
2025-07-14 23:04:49 -07:00

557 lines
16 KiB
Swift

//===--- MutableRawSpanTests.swift ----------------------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2025 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See https://swift.org/LICENSE.txt for license information
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//
// RUN: %target-run-stdlib-swift
// REQUIRES: executable_test
import StdlibUnittest
var suite = TestSuite("MutableRawSpan Tests")
defer { runAllTests() }
suite.test("Basic Initializer")
.skip(.custom(
{ if #available(SwiftStdlib 6.2, *) { false } else { true } },
reason: "Requires Swift 6.2's standard library"
))
.code {
guard #available(SwiftStdlib 6.2, *) else { return }
var s = Array("\(#file)+\(#function)--\(Int.random(in: 1000...9999))".utf8)
s.withUnsafeMutableBytes {
var b = MutableRawSpan(_unsafeBytes: $0)
expectEqual(b.byteCount, $0.count)
expectFalse(b.isEmpty)
expectEqual(b.byteOffsets, 0..<$0.count)
b = MutableRawSpan()
expectEqual(b.byteCount, 0)
}
}
private struct Padded: BitwiseCopyable {
var storage: (Int64, Int8)
}
suite.test("Initializer from MutableSpan")
.require(.stdlib_6_2).code {
guard #available(SwiftStdlib 6.2, *) else { return }
var array = [0, 1, 2].map({ Padded(storage: (Int64($0), Int8($0))) })
array.withUnsafeMutableBufferPointer {
var span = MutableSpan(_unsafeElements: $0)
var rawSpan = MutableRawSpan(_elements: &span)
expectEqual(rawSpan.byteCount, $0.count * MemoryLayout<Padded>.stride)
rawSpan.storeBytes(of: 15, as: Int64.self)
}
expectEqual(array[0].storage.0, 15)
var slice = array.prefix(1)
slice.withUnsafeMutableBufferPointer {
expectEqual($0.count, 1)
var span = MutableSpan(_unsafeElements: $0)
var rawSpan = MutableRawSpan(_elements: &span)
expectEqual(rawSpan.byteCount, MemoryLayout<Padded>.size)
rawSpan.storeBytes(of: 3, as: Int64.self)
}
expectEqual(slice[0].storage.0, 3)
}
suite.test("isEmpty property")
.skip(.custom(
{ if #available(SwiftStdlib 6.2, *) { false } else { true } },
reason: "Requires Swift 6.2's standard library"
))
.code {
guard #available(SwiftStdlib 6.2, *) else { return }
var array = [0, 1, 2]
array.withUnsafeMutableBufferPointer {
var span = MutableRawSpan(_unsafeElements: $0)
expectFalse(span.isEmpty)
let e = $0.extracting(0..<0)
span = MutableRawSpan(_unsafeElements: e)
expectTrue(span.isEmpty)
}
}
suite.test("indices property")
.skip(.custom(
{ if #available(SwiftStdlib 6.2, *) { false } else { true } },
reason: "Requires Swift 6.2's standard library"
))
.code {
guard #available(SwiftStdlib 6.2, *) else { return }
let capacity = 4 as UInt8
var a = Array(0..<capacity)
a.withUnsafeMutableBytes {
let view = MutableRawSpan(_unsafeBytes: $0)
expectEqual(view.byteCount, view.byteOffsets.count)
expectTrue(view.byteOffsets.elementsEqual(0..<view.byteCount))
}
}
suite.test("withUnsafeBytes()")
.skip(.custom(
{ if #available(SwiftStdlib 6.2, *) { false } else { true } },
reason: "Requires Swift 6.2's standard library"
))
.code {
guard #available(SwiftStdlib 6.2, *) else { return }
let capacity: UInt8 = 64
var a = Array(0..<capacity)
let i = Int.random(in: a.indices)
a.withUnsafeMutableBytes {
var view = MutableRawSpan(_unsafeBytes: $0)
view.withUnsafeBytes {
expectEqual($0.load(fromByteOffset: i, as: UInt8.self), $0[i])
}
let empty = UnsafeMutableRawBufferPointer(start: $0.baseAddress, count: 0)
view = MutableRawSpan(_unsafeBytes: empty)
view.withUnsafeBytes {
expectEqual($0.count, 0)
expectNil($0.baseAddress)
}
}
}
suite.test("withUnsafeMutableBytes")
.skip(.custom(
{ if #available(SwiftStdlib 6.2, *) { false } else { true } },
reason: "Requires Swift 6.2's standard library"
))
.code {
guard #available(SwiftStdlib 6.2, *) else { return }
let capacity: UInt8 = 16
var a = Array(0..<capacity)
let i = Int.random(in: a.indices)
a.withUnsafeMutableBytes {
var view = MutableRawSpan(_unsafeBytes: $0)
let o = view.unsafeLoad(fromByteOffset: i, as: UInt8.self)
view.withUnsafeMutableBytes {
$0.storeBytes(of: UInt8(i+1), toByteOffset: i, as: UInt8.self)
}
let m = view.unsafeLoad(fromByteOffset: i, as: UInt8.self)
expectEqual(m, o+1)
let empty = UnsafeMutableRawBufferPointer(start: $0.baseAddress, count: 0)
view = MutableRawSpan(_unsafeBytes: empty)
view.withUnsafeMutableBytes {
expectEqual($0.count, 0)
expectNil($0.baseAddress)
}
}
expectEqual(Int(a[i]), i+1)
}
suite.test("bytes property")
.skip(.custom(
{ if #available(SwiftStdlib 6.2, *) { false } else { true } },
reason: "Requires Swift 6.2's standard library"
))
.code {
guard #available(SwiftStdlib 6.2, *) else { return }
var array = [0, 1, 2]
array.withUnsafeMutableBufferPointer {
let mutable = MutableRawSpan(_unsafeElements: $0)
let immutable = mutable.bytes
expectEqual(mutable.byteCount, immutable.byteCount)
}
}
suite.test("unsafeView(as:)")
.skip(.custom(
{ if #available(SwiftStdlib 6.2, *) { false } else { true } },
reason: "Requires Swift 6.2's standard library"
))
.code {
guard #available(SwiftStdlib 6.2, *) else { return }
var array = [0, 1, 2]
array.withUnsafeMutableBufferPointer {
let mutable = MutableRawSpan(_unsafeElements: $0)
let view = mutable._unsafeView(as: Int.self)
expectEqual($0[1], view[1])
}
}
suite.test("unsafeMutableView(as:)")
.skip(.custom(
{ if #available(SwiftStdlib 6.2, *) { false } else { true } },
reason: "Requires Swift 6.2's standard library"
))
.code {
guard #available(SwiftStdlib 6.2, *) else { return }
var array = [0, 1, 2]
let value = Int.random(in: 0..<1000)
array.withUnsafeMutableBufferPointer {
var mutable = MutableRawSpan(_unsafeElements: $0)
var view = mutable._unsafeMutableView(as: Int.self)
view[1] = value
}
expectEqual(array[1], value)
}
suite.test("unsafeLoad(as:)")
.skip(.custom(
{ if #available(SwiftStdlib 6.2, *) { false } else { true } },
reason: "Requires Swift 6.2's standard library"
))
.code {
guard #available(SwiftStdlib 6.2, *) else { return }
let capacity = 4
var s = (0..<capacity).map({ "\(#file)+\(#function) #\($0)" })
s.withUnsafeMutableBytes {
let span = MutableRawSpan(_unsafeBytes: $0)
let stride = MemoryLayout<String>.stride
let s0 = span.unsafeLoad(as: String.self)
expectEqual(s0.contains("0"), true)
let s1 = span.unsafeLoad(fromByteOffset: stride, as: String.self)
expectEqual(s1.contains("1"), true)
let s2 = span.unsafeLoad(fromUncheckedByteOffset: 2*stride, as: String.self)
expectEqual(s2.contains("2"), true)
}
}
suite.test("unsafeLoadUnaligned(as:)")
.skip(.custom(
{ if #available(SwiftStdlib 6.2, *) { false } else { true } },
reason: "Requires Swift 6.2's standard library"
))
.code {
guard #available(SwiftStdlib 6.2, *) else { return }
let capacity = 64
var a = Array(0..<UInt8(capacity))
a.withUnsafeMutableBytes {
var span = MutableRawSpan(_unsafeBytes: $0)
let suffix = span._mutatingExtracting(droppingFirst: 2)
let u0 = suffix.unsafeLoadUnaligned(as: UInt64.self)
expectEqual(u0 & 0xff, 2)
expectEqual(u0.byteSwapped & 0xff, 9)
let u1 = span.unsafeLoadUnaligned(fromByteOffset: 6, as: UInt64.self)
expectEqual(u1 & 0xff, 6)
let u3 = span.unsafeLoadUnaligned(fromUncheckedByteOffset: 7, as: UInt32.self)
expectEqual(u3 & 0xff, 7)
}
}
suite.test("storeBytes(of:as:)")
.skip(.custom(
{ if #available(SwiftStdlib 6.2, *) { false } else { true } },
reason: "Requires Swift 6.2's standard library"
))
.code {
guard #available(SwiftStdlib 6.2, *) else { return }
let count = 4
var a = Array(repeating: 0, count: count)
a.withUnsafeMutableBytes {
var span = MutableRawSpan(_unsafeBytes: $0)
span.storeBytes(of: .max, as: UInt8.self)
span.storeBytes(
of: .max, toByteOffset: MemoryLayout<UInt>.stride/2, as: UInt.self
)
}
expectEqual(a[0].littleEndian & 0xffff, 0xff)
expectEqual(a[0].bigEndian & 0xffff, 0xffff)
}
suite.test("_mutatingExtracting()")
.skip(.custom(
{ if #available(SwiftStdlib 6.2, *) { false } else { true } },
reason: "Requires Swift 6.2's standard library"
))
.code {
guard #available(SwiftStdlib 6.2, *) else { return }
let capacity = 4
var b = (0..<capacity).map(Int8.init)
b.withUnsafeMutableBytes {
var span = MutableRawSpan(_unsafeBytes: $0)
var sub = span._mutatingExtracting(0..<2)
expectEqual(sub.byteCount, 2)
expectEqual(sub.unsafeLoad(as: UInt8.self), 0)
sub = span._mutatingExtracting(..<2)
expectEqual(sub.byteCount, 2)
expectEqual(sub.unsafeLoad(as: UInt8.self), 0)
sub = span._mutatingExtracting(...)
expectEqual(sub.byteCount, 4)
expectEqual(sub.unsafeLoad(as: UInt8.self), 0)
sub = span._mutatingExtracting(2...)
expectEqual(sub.byteCount, 2)
expectEqual(sub.unsafeLoad(as: UInt8.self), 2)
}
}
suite.test("_consumingExtracting()")
.require(.stdlib_6_2).code {
let c = 16
let b = UnsafeMutableRawBufferPointer.allocate(byteCount: c, alignment: c)
defer { b.deallocate() }
_ = b.initializeMemory(as: UInt8.self, from: 0..<UInt8(c))
var span = b.mutableBytes
span = span._consumingExtracting(0..<2)
expectEqual(span.byteCount, 2)
expectEqual(span.unsafeLoad(as: UInt8.self), 0)
span = b.mutableBytes
span = span._consumingExtracting(..<2)
expectEqual(span.byteCount, 2)
expectEqual(span.unsafeLoad(as: UInt8.self), 0)
span = b.mutableBytes
span = span._consumingExtracting(...)
expectEqual(span.byteCount, c)
expectEqual(span.unsafeLoad(as: UInt8.self), 0)
span = b.mutableBytes
span = span._consumingExtracting(2...)
expectEqual(span.byteCount, c-2)
expectEqual(span.unsafeLoad(as: UInt8.self), 2)
}
suite.test("_mutatingExtracting(unchecked:)")
.skip(.custom(
{ if #available(SwiftStdlib 6.2, *) { false } else { true } },
reason: "Requires Swift 6.2's standard library"
))
.code {
guard #available(SwiftStdlib 6.2, *) else { return }
let capacity = 32
var b = (0..<capacity).map(UInt8.init)
b.withUnsafeMutableBytes {
var span = MutableRawSpan(_unsafeBytes: $0.prefix(8))
let beyond = span._mutatingExtracting(unchecked: 16...23)
expectEqual(beyond.byteCount, 8)
let fromBeyond = beyond.unsafeLoad(as: UInt8.self)
expectEqual(fromBeyond, 16)
}
}
suite.test("_consumingExtracting(unchecked:)")
.require(.stdlib_6_2).code {
let capacity = 32
var b = (0..<capacity).map(UInt8.init)
b.withUnsafeMutableBytes {
let span = MutableRawSpan(_unsafeBytes: $0.prefix(8))
let beyond = span._consumingExtracting(unchecked: 16...23)
expectEqual(beyond.byteCount, 8)
let fromBeyond = beyond.unsafeLoad(as: UInt8.self)
expectEqual(fromBeyond, 16)
}
}
suite.test("_mutatingExtracting prefixes")
.skip(.custom(
{ if #available(SwiftStdlib 6.2, *) { false } else { true } },
reason: "Requires Swift 6.2's standard library"
))
.code {
guard #available(SwiftStdlib 6.2, *) else { return }
let capacity = 4
var a = Array(0..<UInt8(capacity))
a.withUnsafeMutableBytes {
var prefix: MutableRawSpan
var span = MutableRawSpan(_unsafeBytes: $0)
expectEqual(span.byteCount, capacity)
prefix = span._mutatingExtracting(first: 1)
expectEqual(prefix.unsafeLoad(as: UInt8.self), 0)
prefix = span._mutatingExtracting(first: capacity)
expectEqual(
prefix.unsafeLoad(fromByteOffset: capacity-1, as: UInt8.self),
UInt8(capacity-1)
)
prefix = span._mutatingExtracting(droppingLast: capacity)
expectEqual(prefix.isEmpty, true)
prefix = span._mutatingExtracting(droppingLast: 1)
expectEqual(
prefix.unsafeLoad(fromByteOffset: capacity-2, as: UInt8.self),
UInt8(capacity-2)
)
}
do {
let b = UnsafeMutableRawBufferPointer(start: nil, count: 0)
var span = MutableRawSpan(_unsafeBytes: b)
expectEqual(span.byteCount, b.count)
expectEqual(span._mutatingExtracting(first: 1).byteCount, b.count)
expectEqual(span._mutatingExtracting(droppingLast: 1).byteCount, b.count)
}
}
suite.test("_consumingExtracting prefixes")
.require(.stdlib_6_2).code {
let capacity = 4
var a = Array(0..<UInt8(capacity))
a.withUnsafeMutableBytes {
var span = $0.mutableBytes
expectEqual(span.byteCount, capacity)
span = span._consumingExtracting(first: 1)
expectEqual(span.unsafeLoad(as: UInt8.self), 0)
span = $0.mutableBytes._consumingExtracting(first: capacity)
expectEqual(
span.unsafeLoad(fromByteOffset: capacity-1, as: UInt8.self),
UInt8(capacity-1)
)
span = $0.mutableBytes._consumingExtracting(droppingLast: capacity)
expectEqual(span.isEmpty, true)
span = $0.mutableBytes._consumingExtracting(droppingLast: 1)
expectEqual(
span.unsafeLoad(fromByteOffset: capacity-2, as: UInt8.self),
UInt8(capacity-2)
)
}
do {
let b = UnsafeMutableRawBufferPointer(start: nil, count: 0)
var span = MutableRawSpan(_unsafeBytes: b)
expectEqual(span.byteCount, b.count)
span = b.mutableBytes._consumingExtracting(first: 1)
expectEqual(span.byteCount, b.count)
span = b.mutableBytes._consumingExtracting(droppingLast: 1)
expectEqual(span.byteCount, b.count)
}
}
suite.test("_mutatingExtracting suffixes")
.skip(.custom(
{ if #available(SwiftStdlib 6.2, *) { false } else { true } },
reason: "Requires Swift 6.2's standard library"
))
.code {
guard #available(SwiftStdlib 6.2, *) else { return }
let capacity = 4
var a = Array(0..<UInt8(capacity))
a.withUnsafeMutableBytes {
var prefix: MutableRawSpan
var span = MutableRawSpan(_unsafeBytes: $0)
expectEqual(span.byteCount, capacity)
prefix = span._mutatingExtracting(last: capacity)
expectEqual(prefix.unsafeLoad(as: UInt8.self), 0)
prefix = span._mutatingExtracting(last: capacity-1)
expectEqual(prefix.unsafeLoad(as: UInt8.self), 1)
prefix = span._mutatingExtracting(last: 1)
expectEqual(prefix.unsafeLoad(as: UInt8.self), UInt8(capacity-1))
prefix = span._mutatingExtracting(droppingFirst: capacity)
expectTrue(prefix.isEmpty)
prefix = span._mutatingExtracting(droppingFirst: 1)
expectEqual(prefix.unsafeLoad(as: UInt8.self), 1)
}
do {
let b = UnsafeMutableRawBufferPointer(start: nil, count: 0)
var span = MutableRawSpan(_unsafeBytes: b)
expectEqual(span.byteCount, b.count)
expectEqual(span._mutatingExtracting(last: 1).byteCount, b.count)
expectEqual(span._mutatingExtracting(droppingFirst: 1).byteCount, b.count)
}
}
suite.test("_consumingExtracting suffixes")
.require(.stdlib_6_2).code {
let capacity = 4
var a = Array(0..<UInt8(capacity))
a.withUnsafeMutableBytes {
var span = $0.mutableBytes
expectEqual(span.byteCount, capacity)
span = span._consumingExtracting(last: capacity)
expectEqual(span.unsafeLoad(as: UInt8.self), 0)
span = $0.mutableBytes._consumingExtracting(last: capacity-1)
expectEqual(span.unsafeLoad(as: UInt8.self), 1)
span = $0.mutableBytes._consumingExtracting(last: 1)
expectEqual(span.unsafeLoad(as: UInt8.self), UInt8(capacity-1))
span = $0.mutableBytes._consumingExtracting(droppingFirst: capacity)
expectEqual(span.isEmpty, true)
span = $0.mutableBytes._consumingExtracting(droppingFirst: 1)
expectEqual(span.unsafeLoad(as: UInt8.self), 1)
}
do {
let b = UnsafeMutableRawBufferPointer(start: nil, count: 0)
var span = MutableRawSpan(_unsafeBytes: b)
expectEqual(span.byteCount, b.count)
span = b.mutableBytes._consumingExtracting(last: 1)
expectEqual(span.byteCount, b.count)
span = b.mutableBytes._consumingExtracting(droppingFirst: 1)
expectEqual(span.byteCount, b.count)
}
}
suite.test("MutableRawSpan from UnsafeMutableRawBufferPointer")
.require(.stdlib_6_2).code {
guard #available(SwiftStdlib 6.2, *) else { return }
let capacity = 4
let b = UnsafeMutableRawBufferPointer.allocate(
byteCount: capacity*MemoryLayout<Int64>.stride,
alignment: MemoryLayout<Int64>.alignment
)
defer {
b.deallocate()
}
_ = b.initializeMemory(as: Int64.self, fromContentsOf: 0..<Int64(capacity))
var span = b.mutableBytes
span.storeBytes(of: 3, toByteOffset: 10, as: UInt16.self)
_ = consume span
let v = b.load(fromByteOffset: 8, as: Int64.self)
expectNotEqual(v, 1)
}