1610381 - Improve memory reporting for missing/incomplete images

Status: RESOLVED FIXED

(Core :: Graphics: ImageLib, enhancement, P2)

Description

[Andrew Osmond [:aosmond] (he/him)]

We can add more to memory reporting to potentially help debug missing/incomplete image problems.

Comment 1

[Andrew Osmond [:aosmond] (he/him)]

Attachment: Bug 1610381 - Improve image memory reporting for missing/incomplete surfaces.

This dumps more information about the surface cache. Each surface has a
flag indicating whether or not it has finished decoding; incomplete
surfaces are now marked as such in the cache reports. We now also have
counters for various insertion errors, as well as the composition of the
cache (total vs locked images, total vs locked surfaces).

Comment 2

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/8d10347dbc8b
Improve image memory reporting for missing/incomplete surfaces. r=tnikkel

Comment 3

[Andrew Osmond [:aosmond] (he/him)]

Attachment: Bug 1610381 - Part 2. Improve image memory reporting with more state information.

This patch adds error and progress tracker states to the memory dump. It
also now will include requests that have yet to create an image, and
fills in what information it is able to without it (such as URI, error
and progress tracker states).

Comment 4

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/9f3c7fe6b9f2
Part 2. Improve image memory reporting with more state information. r=jrmuizel

Comment 5

[Stefan Hindli [:stefan_hindli]]

https://hg.mozilla.org/mozilla-central/rev/8d10347dbc8b

Comment 6

[Andrew Osmond [:aosmond] (he/him)]

Attachment: Bug 1610381 - Part 3. Improve image memory reporting by including validation state.

This patch adds an annotation to an image cache entry if it is in the
process of being validated. This is very useful to know when debugging
missing images because state notifications are suppressed when we are
validating and may prevent the image from being displayed.

Comment 7

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/ee5aca178575
Part 3. Improve image memory reporting by including validation state. r=jrmuizel

Comment 8

[Noemi Erli[:noemi_erli]]

https://hg.mozilla.org/mozilla-central/rev/9f3c7fe6b9f2
https://hg.mozilla.org/mozilla-central/rev/ee5aca178575

Comment 9

[Andrew Osmond [:aosmond] (he/him)]

Cleanly cherry-picked to beta for me. I feel fairly confident about uplifting if there is a willingness to take it. Given we have isolated reports on seeing this on release as well, getting a better ability to grasp the image cache state would be valuable beyond nightly.

try on beta: https://treeherder.mozilla.org/#/jobs?repo=try&revision=dd203da79559fe222ab02a35f7e53dee5713bb41

Comment 10

[Andrew Osmond [:aosmond] (he/him)]

Comment on attachment 9121918 [details]
Bug 1610381 - Improve image memory reporting for missing/incomplete surfaces.

Beta/Release Uplift Approval Request

• User impact if declined: We won't be able to get more detailed memory reports for image missing issues on beta/release as quickly. We seem to be getting more reports in the last month across all channels.
• Is this code covered by automated tests?: Yes
• Has the fix been verified in Nightly?: Yes
• Needs manual test from QE?: No
• If yes, steps to reproduce:
• List of other uplifts needed: Parts 1-3 on this bug
• Risk to taking this patch: Low
• Why is the change risky/not risky? (and alternatives if risky): The patches just affect code on the memory reporting path accessed through about:memory.
• String changes made/needed:

Comment 11

[Ryan VanderMeulen [:RyanVM]]

Comment on attachment 9121918 [details]
Bug 1610381 - Improve image memory reporting for missing/incomplete surfaces.

Given that these changes are only being made on the memory reporting paths, I agree that the risk seems pretty low and that there's value in trying to get diagnostics for bug 1609672 as early as possible. Approved for 73.0b9.

Comment 12

[Andrei Ciure[:aciure]]

https://hg.mozilla.org/releases/mozilla-beta/rev/f18a1b991e0c
https://hg.mozilla.org/releases/mozilla-beta/rev/c3b49b0d837a
https://hg.mozilla.org/releases/mozilla-beta/rev/eeeb6d082bbc