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.

Sign up for GitHub

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

Jump to bottom

Can't get Rendering Assets to unload from RAM on wasm webgl2.0 build #12057

Closed
egol opened this issue Feb 23, 2024 · 3 comments · Fixed by #12166
Closed

Can't get Rendering Assets to unload from RAM on wasm webgl2.0 build #12057

egol opened this issue Feb 23, 2024 · 3 comments · Fixed by #12166
Labels
C-Bug An unexpected or incorrect behavior O-Web Specific to web (WASM) builds
Milestone
0.13.1

Comments

@egol
Copy link

egol commented Feb 23, 2024

Bevy version

v0.13.0

[Optional] Relevant system information

GPU: RTX 2080 Ti
Using Firefox 122 on Windows 10

AdapterInfo { name: "ANGLE (NVIDIA, NVIDIA GeForce GTX 980 Direct3D11 vs_5_0 ps_5_0)", vendor: 4318, device: 0, device_type: Other, driver: "", driver_info: "", backend: Gl }

(Not sure why the adapter info shows GTX 980 for firefox but problem is persistent on chrome as well)

Using Chrome shows:

 AdapterInfo { name: "ANGLE (NVIDIA, NVIDIA GeForce RTX 2080 Ti (0x00001E07) Direct3D11 vs_5_0 ps_5_0, D3D11)", vendor: 4318, device: 0, device_type: Other, driver: "", driver_info: "", backend: Gl }

What you did

I am trying to get the new "Unload Rendering Assets from RAM" feature working. I have been successful on a local cargo run --release build but I have not been able to replicate the memory usage on a wasm webgl build. The attachment below shows the comparative ram usage of the local windows build and the wasm build. For some reason the wasm build never ends up offloading the memory and stays at the pictured amount.
For reference, I am loading 63 jpg images that are on average 2MB in size and have a resolution of 2587x3375 (obviously this could be optimized and I am currently perusing a workaround of drastically decreasing their resolution)

This is the code that sets my image assets to be offloaded:

fn check_asset_loading (
    mut next_state: ResMut<NextState<AppState>>,
    book_query: Query<&Book>,
    mut images: ResMut<Assets<Image>>,
    server: Res<AssetServer>,
    mut loading_progress: ResMut<LoadingProgress>
)
{
    let mut loaded = true;
    use bevy::asset::LoadState;
    for book in book_query.iter() {

        let mut num_loaded = 0;

        for handle in book.image_handles.iter() {
            let load_state = server.get_load_state(handle);

            if load_state.is_some() {
                if load_state.unwrap() != LoadState::Loaded {
                    loaded = false;
                }
                else {
                    num_loaded += 1;

                    if let Some(image) = images.get_mut(handle) {
                        image.asset_usage = RenderAssetUsages::RENDER_WORLD;
                    }
                }
            }
        }

        loading_progress.current = (100.0 / book.image_handles.len() as f32) * num_loaded as f32;

        if loaded && book.image_handles.len() == num_loaded {
            info!("all images loaded!");
            // window.single_mut().visible = true;
            next_state.set(AppState::Running);
        }
    }

}

this is my build pipeline for wasm:

cargo build --profile wasm-release --target wasm32-unknown-unknown
wasm-bindgen --no-typescript --target web --out-dir ./out/ --out-name "mygame" ./target/wasm32-unknown-unknown/release/book1-0.wasm

relevant toml:

[profile.wasm-release]
inherits = "release"
opt-level = "z"
lto = "fat"
codegen-units = 1

html used to run wasm:

<!doctype html>
<html lang="en">

<body style="margin: 0px;">
  <script type="module">
    import init from './mygame.js'

    init().catch((error) => {
      if (!error.message.startsWith("Using exceptions for control flow, don't mind me. This isn't actually an error!")) {
        throw error;
      }
    });
  </script>

  <canvas id="mygame-canvas" width="1280" height="720"></canvas>
</body>

</html>

What went wrong

Offloading to GPU memory works on a local windows build of my application but does not happen on a wasm build of the same application.

Additional information

Memory usage:
image
Firefox performance graph:
image
@egol egol added C-Bug An unexpected or incorrect behavior S-Needs-Triage This issue needs to be labelled labels Feb 23, 2024
@egol egol closed this as not planned Won't fix, can't repro, duplicate, stale Feb 23, 2024
@egol
Copy link
Author

egol commented Feb 23, 2024

Chrome memory usage:
image

Apologies for randomly closing and reopening this issue as I was unsure of if this is a browser or bevy related bug.

@egol egol reopened this Feb 23, 2024
@mockersf
Copy link
Member

Fun fact I just learned: you can't free memory in WASM, once you allocated it you can't return it to the OS/browser 😄

See https://webassembly.github.io/spec/core/syntax/instructions.html#memory-instructions, no instruction to deallocate. Read WebAssembly/design#1397 for more details.

A workaround for your usage would be to load the images one by one, and unload them before loading the next one. that way you'll need only the memory for one image

@mockersf mockersf added O-Web Specific to web (WASM) builds and removed S-Needs-Triage This issue needs to be labelled labels Feb 23, 2024
@JMS55 JMS55 modified the milestones: 0.14, 0.13.1 Feb 25, 2024
@JMS55
Copy link
Contributor

JMS55 commented Feb 25, 2024

Not much we can really do to fix this, but I'd like to add a note to the documentation for 0.13.1.

@mockersf mockersf mentioned this issue Feb 27, 2024
Merged
github-merge-queue bot pushed a commit that referenced this issue Feb 28, 2024
@mockersf
add note about unloading assets from ram in wasm (#12166)
6f849d3 
# Objective

- Fixes #12057 

## Solution

- Add a note about memory management in Wasm
mockersf added a commit that referenced this issue Feb 28, 2024
@mockersf
add note about unloading assets from ram in wasm (#12166)
8234978 
# Objective

- Fixes #12057 

## Solution

- Add a note about memory management in Wasm
@alice-i-cecile alice-i-cecile mentioned this issue Mar 22, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
C-Bug An unexpected or incorrect behavior O-Web Specific to web (WASM) builds
Projects
None yet
Milestone
0.13.1
Development

Successfully merging a pull request may close this issue.

add note about unloading assets from ram in wasm mockersf/bevy
3 participants
@mockersf @egol @JMS55