Skip to content

[stdlib] add more debug-mode range checking to UnsafeBufferPointer #13340

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 2 commits into from
Mar 8, 2018
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
8 changes: 6 additions & 2 deletions stdlib/public/core/UnsafeBufferPointer.swift.gyb
Original file line number Diff line number Diff line change
Expand Up @@ -165,12 +165,16 @@ public struct Unsafe${Mutable}BufferPointer<Element>

@_inlineable
public func _failEarlyRangeCheck(_ index: Int, bounds: Range<Int>) {
// NOTE: This method is a no-op for performance reasons.
// NOTE: In release mode, this method is a no-op for performance reasons.
_debugPrecondition(index >= bounds.lowerBound)
_debugPrecondition(index < bounds.upperBound)
}

@_inlineable
public func _failEarlyRangeCheck(_ range: Range<Int>, bounds: Range<Int>) {
// NOTE: This method is a no-op for performance reasons.
// NOTE: In release mode, this method is a no-op for performance reasons.
_debugPrecondition(range.lowerBound >= bounds.lowerBound)
_debugPrecondition(range.upperBound <= bounds.upperBound)
}

public typealias Indices = CountableRange<Int>
Expand Down
85 changes: 85 additions & 0 deletions validation-test/stdlib/UnsafeBufferPointer.swift.gyb
Original file line number Diff line number Diff line change
Expand Up @@ -326,6 +326,91 @@ UnsafeMutableBufferPointerTestSuite.test("changeElementViaBuffer") {
expectEqual(-1.0, allocated[count-1])
}

let bufCount = 4
let sliceRange: Range = 1..<bufCount-1
% for mutable in [True, False]:
% for raw in [True, False]:
% for action in ['read', 'change']:
% if action != 'change' or mutable:
for testIndex in (0..<bufCount) {
% Type = 'Unsafe' + ('Mutable' if mutable else '') + ('Raw' if raw else '') + 'BufferPointer'
${Type}TestSuite.test("${action}Element\(testIndex)ViaSlice") {
% if raw:
let allocated = UnsafeMutableRawPointer.allocate(bytes: bufCount, alignedTo: 8)
for i in 0..<bufCount {
allocated.storeBytes(of: UInt8(i), toByteOffset: i, as: UInt8.self)
}
% else:
let allocated = UnsafeMutablePointer<Int>.allocate(capacity: bufCount)
for i in 0..<bufCount { allocated[i] = i }
% end # if mutable
defer { allocated.deallocate() }

let buffer = ${Type}(start: allocated, count: bufCount)
${'var' if mutable else 'let'} slice = buffer[sliceRange]

if _isDebugAssertConfiguration(),
testIndex < sliceRange.lowerBound ||
testIndex >= sliceRange.upperBound {
expectCrashLater()
}
% if action == 'read':
let value = slice[testIndex]
expectEqual(buffer[testIndex], value)
% else:
slice[testIndex] = 103
expectEqual(buffer[testIndex], 103)
% end # if action
}
}
% end # if action or mutable
% end # for action
% end # for raw
% end # for mutable

let testRanges = (0..<bufCount-1).map({ i -> Range<Int> in i..<i+2 })
% for mutable in [True, False]:
% for raw in [True, False]:
% for action in ['read', 'change']:
% if action != 'change' or mutable:
for testRange in testRanges {
% Type = 'Unsafe' + ('Mutable' if mutable else '') + ('Raw' if raw else '') + 'BufferPointer'
${Type}TestSuite.test("${action}Slice\(testRange)ViaSlice") {
% if raw:
let allocated = UnsafeMutableRawPointer.allocate(bytes: bufCount+2, alignedTo: 8)
for i in 0..<bufCount+2 {
allocated.storeBytes(of: UInt8(i), toByteOffset: i, as: UInt8.self)
}
% else:
let allocated = UnsafeMutablePointer<Int>.allocate(capacity: bufCount+2)
for i in 0..<bufCount+2 { allocated[i] = i }
% end # if mutable
defer { allocated.deallocate() }

let buffer = ${Type}(start: allocated, count: bufCount+2)
${'var' if mutable else 'let'} slice = buffer[sliceRange]

if _isDebugAssertConfiguration(),
testRange.lowerBound < sliceRange.lowerBound ||
testRange.upperBound > sliceRange.upperBound {
expectCrashLater()
}

% if action == 'read':
let value = slice[testRange]
expectEqualSequence(buffer[testRange], value)
% else:
let sourceSlice = buffer[bufCount..<bufCount+2]
slice[testRange] = sourceSlice
expectEqualSequence(buffer[testRange], sourceSlice)
% end # if action
}
}
% end # if action or mutable
% end # for action
% end # for raw
% end # for mutable

protocol SubscriptTest {
static var start: Int { get }
static var end: Int { get }
Expand Down