apple/swift-nio

NIOLoopBound should get `unchecked` variants that are truly free in release mode

Open

#2,506 opened on Aug 17, 2023

View on GitHub
 (5 comments) (0 reactions) (0 assignees)Swift (8,453 stars) (749 forks)batch import
good first issuekind/enhancement

Description

NIOLoopBound(Box) is super useful when adopting Sendable but the eventLoop.preconditionInEventLoop() checks everywhere are expensive and -- for repeated accesses -- unnecessary.

There should be unchecked variants of init, get and set value that do eventLoop.assertInEventLoop() instead. Together with @inlinable that should become completely free in release mode (and still check in debug).

Docs:

Contributor guide

Tech stack
swift
Domain
backendperformance
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Swift concurrencyNIOLoopBound APIassert vs precondition
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
The implementation should add new initializers and methods to `NIOLoopBound` and `NIOLoopBoundBox` in the NIO module. The issue suggests using `assertInEventLoop` instead of `preconditionInEventLoop` in the unchecked variants, and marking them with `@inlinable` for release mode optimization. Contributors should review the existing implementation at the provided documentation links and consider any thread safety implications.