[JSC] Implement `Array.prototype.includes` in C++ by sosukesuzuki · Pull Request #40613 · WebKit/WebKit

sosukesuzuki · 2025-02-14T09:53:56Z

`febcbad`

[JSC] Implement `Array.prototype.includes` in C++
https://bugs.webkit.org/show_bug.cgi?id=287693

Reviewed by Yusuke Suzuki.

Currently, JSC’s `Array#includes` is implemented in JavaScript, whereas
the similar `Array#indexOf` is implemented in C++ and benefits from
DFG/FTL optimizations.

This patch reimplements `Array#includes` in C++ in the same way as
`Array#indexOf`, thereby enabling DFG/FTL support.

In most cases, the patch shows performance improvements:

```
                                                  TipOfTree                  Patched
array-prototype-includes-double                25.2368+-0.1405     ^     20.9887+-3.0246        ^ definitely 1.2024x faster
array-prototype-includes-int32-from-contiguous
                                               22.4340+-0.4231     ^     17.1624+-0.2591        ^ definitely 1.3072x faster
array-prototype-includes-string                43.4965+-0.6154     ^     30.8301+-0.7207        ^ definitely 1.4108x faster
array-prototype-includes-string-16             73.3458+-0.8209     ^     51.7629+-0.5639        ^ definitely 1.4170x faster
array-prototype-includes-double-from-contiguous
                                               73.3174+-0.9760     ^     42.4634+-1.0352        ^ definitely 1.7266x faster
array-prototype-includes-int32                205.9207+-0.2986     ^    107.2346+-0.4414        ^ definitely 1.9203x faster
array-prototype-includes-contiguous            27.8838+-2.6451     ^      9.7461+-0.1414        ^ definitely 2.8610x faster
array-prototype-includes-bigint                17.6066+-0.2040     ^     12.2816+-0.1275        ^ definitely 1.4336x faster
```

However, benchmarks that use constant strings experience a performance
regression. This is due to the loss of constant folding for the `===`
operator that was effective in the JavaScript implementation:

```
                                                  TipOfTree                  Patched
array-prototype-includes-string-const          17.8715+-0.0715     !     24.9579+-0.2986        ! definitely 1.3965x slower
array-prototype-includes-string-16-const       17.9026+-0.0907     !     50.5343+-0.6068        ! definitely 2.8227x slower
```

* Source/JavaScriptCore/builtins/ArrayPrototype.js:
(includes): Deleted.
* Source/JavaScriptCore/runtime/ArrayPrototype.cpp:
(JSC::ArrayPrototype::finishCreation):
(JSC::JSC_DEFINE_HOST_FUNCTION):
* Source/JavaScriptCore/runtime/CommonIdentifiers.h:
* Source/JavaScriptCore/runtime/JSCJSValueInlines.h:
(JSC::sameValueZero):

Canonical link: https://commits.webkit.org/290906@main

b81a2fe

Misc	iOS, visionOS, tvOS & watchOS	macOS	Linux	Windows
✅ 🧪 style	✅ 🛠 ios	✅ 🛠 mac	✅ 🛠 wpe	✅ 🛠 win
	✅ 🛠 ios-sim	✅ 🛠 mac-AS-debug	✅ 🧪 wpe-wk2	✅ 🧪 win-tests
✅ 🧪 webkitperl	✅ 🧪 ios-wk2	✅ 🧪 api-mac	✅ 🧪 api-wpe
	✅ 🧪 ios-wk2-wpt	✅ 🧪 mac-wk1	✅ 🛠 wpe-cairo
✅ 🛠 🧪 jsc	✅ 🧪 api-ios	✅ 🧪 mac-wk2	✅ 🛠 gtk
✅ 🛠 🧪 jsc-arm64	✅ 🛠 vision	❌ 🧪 mac-AS-debug-wk2	✅ 🧪 gtk-wk2
	✅ 🛠 vision-sim	✅ 🧪 mac-wk2-stress	✅ 🧪 api-gtk
✅ 🛠 🧪 merge	✅ 🧪 vision-wk2	✅ 🧪 mac-intel-wk2	✅ 🛠 playstation
	✅ 🛠 tv	✅ 🛠 mac-safer-cpp	✅ 🛠 jsc-armv7
	✅ 🛠 tv-sim		❌ 🧪 jsc-armv7-tests
	✅ 🛠 watch
	✅ 🛠 watch-sim

webkit-early-warning-system · 2025-02-14T09:54:05Z

EWS run on previous version of this PR (hash fe2384a)

Details

Misc	iOS, visionOS, tvOS & watchOS	macOS	Linux	Windows
✅ 🧪 style	✅ 🛠 ios	✅ 🛠 mac	✅ 🛠 wpe	✅ 🛠 win
	✅ 🛠 ios-sim	✅ 🛠 mac-AS-debug	~~🧪 wpe-wk2~~	~~🧪 win-tests~~
✅ 🧪 webkitperl	~~🧪 ios-wk2~~	~~🧪 api-mac~~	~~🧪 api-wpe~~
	~~🧪 ios-wk2-wpt~~	⏳ 🧪 mac-wk1	✅ 🛠 wpe-cairo
~~🛠 🧪 jsc~~	⏳ 🧪 api-ios	~~🧪 mac-wk2~~	✅ 🛠 gtk
~~🛠 🧪 jsc-arm64~~	✅ 🛠 vision	⏳ 🧪 mac-AS-debug-wk2	~~🧪 gtk-wk2~~
	✅ 🛠 vision-sim	~~🧪 mac-wk2-stress~~	~~🧪 api-gtk~~
	~~🧪 vision-wk2~~	~~🧪 mac-intel-wk2~~	✅ 🛠 playstation
	✅ 🛠 tv	~~🛠 mac-safer-cpp~~	~~🛠 jsc-armv7~~
	✅ 🛠 tv-sim		~~🧪 jsc-armv7-tests~~
	✅ 🛠 watch
	✅ 🛠 watch-sim

webkit-early-warning-system · 2025-02-14T09:58:46Z

EWS run on previous version of this PR (hash 71e9316)

Details

Misc	iOS, visionOS, tvOS & watchOS	macOS	Linux	Windows
✅ 🧪 style	✅ 🛠 ios	✅ 🛠 mac	✅ 🛠 wpe	✅ 🛠 win
	✅ 🛠 ios-sim	✅ 🛠 mac-AS-debug	~~🧪 wpe-wk2~~	~~🧪 win-tests~~
✅ 🧪 webkitperl	~~🧪 ios-wk2~~	~~🧪 api-mac~~	~~🧪 api-wpe~~
	~~🧪 ios-wk2-wpt~~	⏳ 🧪 mac-wk1	✅ 🛠 wpe-cairo
~~🛠 🧪 jsc~~	⏳ 🧪 api-ios	~~🧪 mac-wk2~~	✅ 🛠 gtk
~~🛠 🧪 jsc-arm64~~	✅ 🛠 vision	⏳ 🧪 mac-AS-debug-wk2	~~🧪 gtk-wk2~~
	✅ 🛠 vision-sim	~~🧪 mac-wk2-stress~~	~~🧪 api-gtk~~
	~~🧪 vision-wk2~~	~~🧪 mac-intel-wk2~~	~~🛠 playstation~~
	✅ 🛠 tv	~~🛠 mac-safer-cpp~~	~~🛠 jsc-armv7~~
	✅ 🛠 tv-sim		~~🧪 jsc-armv7-tests~~
	✅ 🛠 watch
	✅ 🛠 watch-sim

webkit-early-warning-system · 2025-02-14T10:02:42Z

EWS run on previous version of this PR (hash 64f07ef)

Details

Misc	iOS, visionOS, tvOS & watchOS	macOS	Linux	Windows
✅ 🧪 style	✅ 🛠 ios	✅ 🛠 mac	✅ 🛠 wpe	~~🛠 win~~
	✅ 🛠 ios-sim	✅ 🛠 mac-AS-debug	~~🧪 wpe-wk2~~	~~🧪 win-tests~~
✅ 🧪 webkitperl	~~🧪 ios-wk2~~	~~🧪 api-mac~~	~~🧪 api-wpe~~
	~~🧪 ios-wk2-wpt~~	⏳ 🧪 mac-wk1	✅ 🛠 wpe-cairo
~~🛠 🧪 jsc~~	⏳ 🧪 api-ios	~~🧪 mac-wk2~~	✅ 🛠 gtk
~~🛠 🧪 jsc-arm64~~	✅ 🛠 vision	⏳ 🧪 mac-AS-debug-wk2	~~🧪 gtk-wk2~~
	✅ 🛠 vision-sim	~~🧪 mac-wk2-stress~~	~~🧪 api-gtk~~
	~~🧪 vision-wk2~~	~~🧪 mac-intel-wk2~~	~~🛠 playstation~~
	✅ 🛠 tv	~~🛠 mac-safer-cpp~~	❌ 🛠 jsc-armv7
	✅ 🛠 tv-sim		❌ 🧪 jsc-armv7-tests
	✅ 🛠 watch
	✅ 🛠 watch-sim

webkit-early-warning-system · 2025-02-14T10:16:06Z

EWS run on previous version of this PR (hash afe4045)

Details

Misc	iOS, visionOS, tvOS & watchOS	macOS	Linux	Windows
✅ 🧪 style	✅ 🛠 ios	✅ 🛠 mac	✅ 🛠 wpe	✅ 🛠 win
	✅ 🛠 ios-sim	✅ 🛠 mac-AS-debug	❌ 🧪 wpe-wk2	❌ 🧪 win-tests
✅ 🧪 webkitperl	❌ 🧪 ios-wk2	✅ 🧪 api-mac	✅ 🧪 api-wpe
	✅ 🧪 ios-wk2-wpt	❌ 🧪 mac-wk1	✅ 🛠 wpe-cairo
❌ 🛠 🧪 jsc	✅ 🧪 api-ios	❌ 🧪 mac-wk2	✅ 🛠 gtk
❌ 🛠 🧪 jsc-arm64	✅ 🛠 vision	❌ 🧪 mac-AS-debug-wk2	✅ 🧪 gtk-wk2
	✅ 🛠 vision-sim	✅ 🧪 mac-wk2-stress	✅ 🧪 api-gtk
	✅ 🧪 vision-wk2	❌ 🧪 mac-intel-wk2	✅ 🛠 playstation
	✅ 🛠 tv	✅ 🛠 mac-safer-cpp	✅ 🛠 jsc-armv7
	✅ 🛠 tv-sim		❌ 🧪 jsc-armv7-tests
	✅ 🛠 watch
	✅ 🛠 watch-sim

webkit-early-warning-system · 2025-02-15T04:47:08Z

EWS run on previous version of this PR (hash 7f8cc43)

Details

Misc	iOS, visionOS, tvOS & watchOS	macOS	Linux	Windows
✅ 🧪 style	✅ 🛠 ios	✅ 🛠 mac	✅ 🛠 wpe	✅ 🛠 win
	✅ 🛠 ios-sim	✅ 🛠 mac-AS-debug	✅ 🧪 wpe-wk2	✅ 🧪 win-tests
✅ 🧪 webkitperl	✅ 🧪 ios-wk2	✅ 🧪 api-mac	✅ 🧪 api-wpe
	✅ 🧪 ios-wk2-wpt	❌ 🧪 mac-wk1	✅ 🛠 wpe-cairo
✅ 🛠 🧪 jsc	✅ 🧪 api-ios	✅ 🧪 mac-wk2	✅ 🛠 gtk
✅ 🛠 🧪 jsc-arm64	✅ 🛠 vision	✅ 🧪 mac-AS-debug-wk2	✅ 🧪 gtk-wk2
	✅ 🛠 vision-sim	✅ 🧪 mac-wk2-stress	✅ 🧪 api-gtk
	✅ 🧪 vision-wk2	✅ 🧪 mac-intel-wk2	✅ 🛠 playstation
	✅ 🛠 tv	✅ 🛠 mac-safer-cpp	✅ 🛠 jsc-armv7
	✅ 🛠 tv-sim		❌ 🧪 jsc-armv7-tests
	✅ 🛠 watch
	✅ 🛠 watch-sim

webkit-early-warning-system · 2025-02-21T12:30:21Z

EWS run on current version of this PR (hash b81a2fe)

Details

Misc	iOS, visionOS, tvOS & watchOS	macOS	Linux	Windows
✅ 🧪 style	✅ 🛠 ios	✅ 🛠 mac	✅ 🛠 wpe	✅ 🛠 win
	✅ 🛠 ios-sim	✅ 🛠 mac-AS-debug	✅ 🧪 wpe-wk2	✅ 🧪 win-tests
✅ 🧪 webkitperl	✅ 🧪 ios-wk2	✅ 🧪 api-mac	✅ 🧪 api-wpe
	✅ 🧪 ios-wk2-wpt	✅ 🧪 mac-wk1	✅ 🛠 wpe-cairo
✅ 🛠 🧪 jsc	✅ 🧪 api-ios	✅ 🧪 mac-wk2	✅ 🛠 gtk
✅ 🛠 🧪 jsc-arm64	✅ 🛠 vision	❌ 🧪 mac-AS-debug-wk2	✅ 🧪 gtk-wk2
	✅ 🛠 vision-sim	✅ 🧪 mac-wk2-stress	✅ 🧪 api-gtk
✅ 🛠 🧪 merge	✅ 🧪 vision-wk2	✅ 🧪 mac-intel-wk2	✅ 🛠 playstation
	✅ 🛠 tv	✅ 🛠 mac-safer-cpp	✅ 🛠 jsc-armv7
	✅ 🛠 tv-sim		❌ 🧪 jsc-armv7-tests
	✅ 🛠 watch
	✅ 🛠 watch-sim

https://bugs.webkit.org/show_bug.cgi?id=287693 Reviewed by Yusuke Suzuki. Currently, JSC’s `Array#includes` is implemented in JavaScript, whereas the similar `Array#indexOf` is implemented in C++ and benefits from DFG/FTL optimizations. This patch reimplements `Array#includes` in C++ in the same way as `Array#indexOf`, thereby enabling DFG/FTL support. In most cases, the patch shows performance improvements: ``` TipOfTree Patched array-prototype-includes-double 25.2368+-0.1405 ^ 20.9887+-3.0246 ^ definitely 1.2024x faster array-prototype-includes-int32-from-contiguous 22.4340+-0.4231 ^ 17.1624+-0.2591 ^ definitely 1.3072x faster array-prototype-includes-string 43.4965+-0.6154 ^ 30.8301+-0.7207 ^ definitely 1.4108x faster array-prototype-includes-string-16 73.3458+-0.8209 ^ 51.7629+-0.5639 ^ definitely 1.4170x faster array-prototype-includes-double-from-contiguous 73.3174+-0.9760 ^ 42.4634+-1.0352 ^ definitely 1.7266x faster array-prototype-includes-int32 205.9207+-0.2986 ^ 107.2346+-0.4414 ^ definitely 1.9203x faster array-prototype-includes-contiguous 27.8838+-2.6451 ^ 9.7461+-0.1414 ^ definitely 2.8610x faster array-prototype-includes-bigint 17.6066+-0.2040 ^ 12.2816+-0.1275 ^ definitely 1.4336x faster ``` However, benchmarks that use constant strings experience a performance regression. This is due to the loss of constant folding for the `===` operator that was effective in the JavaScript implementation: ``` TipOfTree Patched array-prototype-includes-string-const 17.8715+-0.0715 ! 24.9579+-0.2986 ! definitely 1.3965x slower array-prototype-includes-string-16-const 17.9026+-0.0907 ! 50.5343+-0.6068 ! definitely 2.8227x slower ``` * Source/JavaScriptCore/builtins/ArrayPrototype.js: (includes): Deleted. * Source/JavaScriptCore/runtime/ArrayPrototype.cpp: (JSC::ArrayPrototype::finishCreation): (JSC::JSC_DEFINE_HOST_FUNCTION): * Source/JavaScriptCore/runtime/CommonIdentifiers.h: * Source/JavaScriptCore/runtime/JSCJSValueInlines.h: (JSC::sameValueZero): Canonical link: https://commits.webkit.org/290906@main

webkit-commit-queue · 2025-02-23T08:14:35Z

Committed 290906@main (febcbad): https://commits.webkit.org/290906@main

Reviewed commits have been landed. Closing PR #40613 and removing active labels.

sosukesuzuki self-assigned this Feb 14, 2025

sosukesuzuki added the JavaScriptCore For bugs in JavaScriptCore, the JS engine used by WebKit, other than kxmlcore issues. label Feb 14, 2025

sosukesuzuki force-pushed the eng/fast-includes branch from fe2384a to 71e9316 Compare February 14, 2025 09:58

sosukesuzuki force-pushed the eng/fast-includes branch from 71e9316 to 64f07ef Compare February 14, 2025 10:02

sosukesuzuki force-pushed the eng/fast-includes branch from 64f07ef to afe4045 Compare February 14, 2025 10:16

webkit-ews-buildbot added the merging-blocked Applied to prevent a change from being merged label Feb 14, 2025

sosukesuzuki removed the merging-blocked Applied to prevent a change from being merged label Feb 15, 2025

sosukesuzuki force-pushed the eng/fast-includes branch from afe4045 to 7f8cc43 Compare February 15, 2025 04:47

sosukesuzuki marked this pull request as ready for review February 15, 2025 06:54

sosukesuzuki requested a review from a team as a code owner February 15, 2025 06:54

webkit-ews-buildbot added the merging-blocked Applied to prevent a change from being merged label Feb 15, 2025

Constellation approved these changes Feb 17, 2025

View reviewed changes

sosukesuzuki removed the merging-blocked Applied to prevent a change from being merged label Feb 21, 2025

sosukesuzuki force-pushed the eng/fast-includes branch from 7f8cc43 to b81a2fe Compare February 21, 2025 12:30

sosukesuzuki added the merge-queue Applied to send a pull request to merge-queue label Feb 21, 2025

webkit-ews-buildbot added merging-blocked Applied to prevent a change from being merged and removed merge-queue Applied to send a pull request to merge-queue labels Feb 21, 2025

sosukesuzuki added merge-queue Applied to send a pull request to merge-queue and removed merging-blocked Applied to prevent a change from being merged labels Feb 23, 2025

webkit-commit-queue force-pushed the eng/fast-includes branch from b81a2fe to febcbad Compare February 23, 2025 08:14

webkit-commit-queue merged commit febcbad into WebKit:main Feb 23, 2025

webkit-commit-queue removed the merge-queue Applied to send a pull request to merge-queue label Feb 23, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[JSC] Implement `Array.prototype.includes` in C++#40613

[JSC] Implement `Array.prototype.includes` in C++#40613
webkit-commit-queue merged 1 commit intoWebKit:mainfrom
sosukesuzuki:eng/fast-includes

sosukesuzuki commented Feb 14, 2025 •

edited by webkit-early-warning-system

Loading

Uh oh!

webkit-early-warning-system commented Feb 14, 2025 •

edited

Loading

Uh oh!

webkit-early-warning-system commented Feb 14, 2025 •

edited

Loading

Uh oh!

webkit-early-warning-system commented Feb 14, 2025 •

edited

Loading

Uh oh!

webkit-early-warning-system commented Feb 14, 2025 •

edited

Loading

Uh oh!

webkit-early-warning-system commented Feb 15, 2025 •

edited

Loading

Uh oh!

webkit-early-warning-system commented Feb 21, 2025 •

edited

Loading

Uh oh!

webkit-commit-queue commented Feb 23, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Conversation

sosukesuzuki commented Feb 14, 2025 • edited by webkit-early-warning-system Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

febcbad

Uh oh!

webkit-early-warning-system commented Feb 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

webkit-early-warning-system commented Feb 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

webkit-early-warning-system commented Feb 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

webkit-early-warning-system commented Feb 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

webkit-early-warning-system commented Feb 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

webkit-early-warning-system commented Feb 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

webkit-commit-queue commented Feb 23, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

sosukesuzuki commented Feb 14, 2025 •

edited by webkit-early-warning-system

Loading

`febcbad`

webkit-early-warning-system commented Feb 14, 2025 •

edited

Loading

webkit-early-warning-system commented Feb 14, 2025 •

edited

Loading

webkit-early-warning-system commented Feb 14, 2025 •

edited

Loading

webkit-early-warning-system commented Feb 14, 2025 •

edited

Loading

webkit-early-warning-system commented Feb 15, 2025 •

edited

Loading

webkit-early-warning-system commented Feb 21, 2025 •

edited

Loading