Skip to content
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

Improve memory usage of the new backend #74740

Merged
merged 8 commits into from
Jan 10, 2025
Merged

Improve memory usage of the new backend #74740

merged 8 commits into from
Jan 10, 2025

Conversation

sokra
Copy link
Member

@sokra sokra commented Jan 10, 2025

What?

Improves memory usage by changing the way data is stored in the new backend. Instead of keeping a map enum CachedDataItemKey -> enum CachedDataItemValue, it uses a Vec enum CachedDataItemStorage which keeps a single storage for every enum CachedDataItemType. The storage is strongly types and e. g. stores a map TaskId -> (), which makes it more memory efficient while still not wasting memory for unused types.

It also calls shrink_to_fit after task completion and shrink_amortized after removing items, to reduce the unnecessary capacity.

Closes PACK-3703

@ijjk ijjk added the created-by: Turbopack team PRs by the Turbopack team. label Jan 10, 2025
@sokra sokra changed the title use shrink_amortized when removing items Improve memory usage of the new backend Jan 10, 2025
Copy link
Member Author

sokra commented Jan 10, 2025

This stack of pull requests is managed by Graphite. Learn more about stacking.

@sokra sokra requested a review from mischnic January 10, 2025 11:49
@sokra sokra marked this pull request as ready for review January 10, 2025 11:49
@ijjk
Copy link
Member

ijjk commented Jan 10, 2025

Stats from current PR

Default Build
General
vercel/next.js canary vercel/next.js sokra/shrink Change
buildDuration 24s 21.5s N/A
buildDurationCached 20.6s 17.6s N/A
nodeModulesSize 417 MB 417 MB N/A
nextStartRea..uration (ms) 570ms 565ms N/A
Client Bundles (main, webpack)
vercel/next.js canary vercel/next.js sokra/shrink Change
5306-HASH.js gzip 53.3 kB 53.3 kB N/A
8276.HASH.js gzip 169 B 168 B N/A
8377-HASH.js gzip 5.44 kB 5.44 kB N/A
bccd1874-HASH.js gzip 53 kB 53 kB
framework-HASH.js gzip 57.5 kB 57.5 kB N/A
main-app-HASH.js gzip 240 B 242 B N/A
main-HASH.js gzip 34.1 kB 34.1 kB N/A
webpack-HASH.js gzip 1.71 kB 1.71 kB N/A
Overall change 53 kB 53 kB
Legacy Client Bundles (polyfills)
vercel/next.js canary vercel/next.js sokra/shrink Change
polyfills-HASH.js gzip 39.4 kB 39.4 kB
Overall change 39.4 kB 39.4 kB
Client Pages
vercel/next.js canary vercel/next.js sokra/shrink Change
_app-HASH.js gzip 193 B 193 B
_error-HASH.js gzip 193 B 193 B
amp-HASH.js gzip 512 B 510 B N/A
css-HASH.js gzip 343 B 342 B N/A
dynamic-HASH.js gzip 1.84 kB 1.84 kB
edge-ssr-HASH.js gzip 265 B 265 B
head-HASH.js gzip 363 B 362 B N/A
hooks-HASH.js gzip 393 B 392 B N/A
image-HASH.js gzip 4.57 kB 4.57 kB N/A
index-HASH.js gzip 268 B 268 B
link-HASH.js gzip 2.35 kB 2.34 kB N/A
routerDirect..HASH.js gzip 328 B 328 B
script-HASH.js gzip 397 B 397 B
withRouter-HASH.js gzip 323 B 326 B N/A
1afbb74e6ecf..834.css gzip 106 B 106 B
Overall change 3.59 kB 3.59 kB
Client Build Manifests
vercel/next.js canary vercel/next.js sokra/shrink Change
_buildManifest.js gzip 749 B 747 B N/A
Overall change 0 B 0 B
Rendered Page Sizes
vercel/next.js canary vercel/next.js sokra/shrink Change
index.html gzip 522 B 521 B N/A
link.html gzip 538 B 535 B N/A
withRouter.html gzip 518 B 518 B
Overall change 518 B 518 B
Edge SSR bundle Size
vercel/next.js canary vercel/next.js sokra/shrink Change
edge-ssr.js gzip 128 kB 128 kB N/A
page.js gzip 207 kB 207 kB N/A
Overall change 0 B 0 B
Middleware size
vercel/next.js canary vercel/next.js sokra/shrink Change
middleware-b..fest.js gzip 672 B 667 B N/A
middleware-r..fest.js gzip 155 B 156 B N/A
middleware.js gzip 31.2 kB 31.2 kB N/A
edge-runtime..pack.js gzip 844 B 844 B
Overall change 844 B 844 B
Next Runtimes
vercel/next.js canary vercel/next.js sokra/shrink Change
274-experime...dev.js gzip 322 B 322 B
274.runtime.dev.js gzip 314 B 314 B
app-page-exp...dev.js gzip 368 kB 368 kB
app-page-exp..prod.js gzip 129 kB 129 kB
app-page-tur..prod.js gzip 142 kB 142 kB
app-page-tur..prod.js gzip 138 kB 138 kB
app-page.run...dev.js gzip 356 kB 356 kB
app-page.run..prod.js gzip 126 kB 126 kB
app-route-ex...dev.js gzip 37.6 kB 37.6 kB
app-route-ex..prod.js gzip 25.6 kB 25.6 kB
app-route-tu..prod.js gzip 25.6 kB 25.6 kB
app-route-tu..prod.js gzip 25.4 kB 25.4 kB
app-route.ru...dev.js gzip 39.2 kB 39.2 kB
app-route.ru..prod.js gzip 25.4 kB 25.4 kB
pages-api-tu..prod.js gzip 9.69 kB 9.69 kB
pages-api.ru...dev.js gzip 11.6 kB 11.6 kB
pages-api.ru..prod.js gzip 9.68 kB 9.68 kB
pages-turbo...prod.js gzip 21.7 kB 21.7 kB
pages.runtim...dev.js gzip 27.5 kB 27.5 kB
pages.runtim..prod.js gzip 21.7 kB 21.7 kB
server.runti..prod.js gzip 916 kB 916 kB
Overall change 2.46 MB 2.46 MB
build cache
vercel/next.js canary vercel/next.js sokra/shrink Change
0.pack gzip 2.09 MB 2.09 MB N/A
index.pack gzip 75.3 kB 74.4 kB N/A
Overall change 0 B 0 B
Diff details
Diff for main-HASH.js

Diff too large to display

Commit: 971ced2

@ijjk
Copy link
Member

ijjk commented Jan 10, 2025

Tests Passed

InnerStorage::Indexed { map, .. } => map.get(&key.index()),
}
fn get_map(&self, ty: CachedDataItemType) -> Option<&CachedDataItemStorage> {
self.map.iter().find(|m| m.ty() == ty)
Copy link
Contributor

@mischnic mischnic Jan 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Technically this is still constant time, but it might be beneficial to not have to always iterate through the list here?

Copy link
Member Author

@sokra sokra Jan 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We only have a maximum of 30 different types.

According to https://github.com/yegor256/micromap#benchmark using a Vec is faster. That's also the idea behind the AutoMap we have.

It's also using less memory

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sokra As a micro-optimization, if we create the maps for the most common CachedDataItemTypes in InnerStorage::new, we can ensure they always end up at the start of the list.

However, this may naturally tend to happen anyways (the most frequently accessed types are likely to get initialized first).

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As follow-up PR I want to pull "common" types out of this vec and just give them a native field in InnerStorage. That would save about 240 bytes per task which is about 11% of total memory

Copy link
Contributor

@mischnic mischnic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are some clippy warnings

@sokra sokra merged commit 08c4e58 into canary Jan 10, 2025
125 of 130 checks passed
Copy link
Member Author

sokra commented Jan 10, 2025

Merge activity

  • Jan 10, 11:57 AM EST: A user merged this pull request with Graphite.

@sokra sokra deleted the sokra/shrink branch January 10, 2025 16:57
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jan 25, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
created-by: Turbopack team PRs by the Turbopack team. locked
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants