BurntSushi/memchr

Consider hinting to the compiler that indices returned from `memchr()` are within bounds of the haystack

Open

#195 ouverte le 1 déc. 2025

Voir sur GitHub
 (1 commentaire) (0 réactions) (0 assignés)Rust (146 forks)github user discovery
enhancementhelp wanted

Métriques du dépôt

Stars
 (1 457 stars)
Métriques de merge PR
 (Merge moyen 18m) (2 PRs mergées en 30 j)

Description

Currently, indexing into the haystack with the index returned by memchr usually generates a bounds check, because the compiler doesn't know that it's valid. However, if an assert_unchecked(i < haystack.len()) is inserted, the compiler has enough information to elide the check (godbolt).

Pros:

  • Reduces bounds-checking in downstream code; this doesn't remove a ton of overhead but could possibly allow for further optimizations that had been inhibited by the branch.

Cons:

  • assert_unchecked() is only available since Rust 1.81, so would either have to feature-gate this, do rust version detection, or (most likely) use if !cond { unreachable_unchecked(); } to polyfill it. The last option should be equivalent to assert_unchecked(), but I'm not sure if it's treated exactly the same by the compiler.
  • Returning an out-of-bound index becomes UB rather than just a logic error. I assume there was already downstream code relying on this, though, and also it'd probably already be UB internally.

Guide contributeur

Direction de recherche
Examinez le code source de memchr et identifiez où l'index renvoyé par memchr est utilisé pour indexer dans la botte de foin. Insérez un `assert unchecked(i < haystack.len())` avant cette indexation, en utilisant un polyfill pour les anciennes versions de Rust si nécessaire. Vérifiez que la vérification des limites est éliminée en utilisant godbolt ou une compilation locale.
Stack technique
rust
Domaine
performance
Type d'issue
Performance
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Plutôt claire
Prérequis
RustUnsafe Rust
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
40