8270915: GIFImageReader disregards ignoreMetadata flag which causes memory exhaustion

[jayathirthrao]

In https://bugs.openjdk.org/browse/JDK-8270915 we have a valid GIF image which was generated using a third party app, but it contains large amount of Metadata(numerous Application extension blocks).

Also GIFImageReader doesn't use ignoreMetadata flag set by user while reading Metadata which causes heavy memory usage in this scenario. We need to provide support for ignoring metadata in GIFImageReader, so readMetadata() is updated to use the "ignoreMetadata" flag and ignore all blocks except "Image Descriptor" and "Graphics Control Extension".

I have updated readMedata() to also use ReaderUtil.staggeredReadByteStream() where we are allocating upfront memory based on parameters from metadata. Also this PR has small refactoring of import statements.

To replicate the bug we need byte stream with large amount of valid metadata, so i am not able to add regression test case. I have run all javax/imageio jtreg tests and there are no issues.

---

Progress

• Change must be properly reviewed (1 review required, with at least 1 Reviewer)
• Change must not contain extraneous whitespace
• Commit message must refer to an issue

Issue

• JDK-8270915: GIFImageReader disregards ignoreMetadata flag which causes memory exhaustion

Reviewers

• Phil Race (@prrace - Reviewer)

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.org/jdk pull/10536/head:pull/10536
$ git checkout pull/10536

Update a local copy of the PR:
$ git checkout pull/10536
$ git pull https://git.openjdk.org/jdk pull/10536/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 10536

View PR using the GUI difftool:
$ git pr show -t 10536

Using diff file

Download this PR as a diff file:
https://git.openjdk.org/jdk/pull/10536.diff

[bridgekeeper]

👋 Welcome back jdv! A progress list of the required criteria for merging this PR into master will be added to the body of your pull request. There are additional pull request commands available for use with this pull request.

[openjdk]

@jayathirthrao The following label will be automatically applied to this pull request:

• client

When this pull request is ready to be reviewed, an "RFR" email will be sent to the corresponding mailing list. If you would like to change these labels, use the /label pull request command.

[mlbridge]

Webrevs

• 00: Full (43979550)

[mrserb]

I have updated readMedata() to also use ReaderUtil.staggeredReadByteStream() where we are allocating upfront memory based on parameters from metadata.

Probably it is possible to create a small test just for this change?

[prrace]

LGTM

[openjdk]

@jayathirthrao This change now passes all automated pre-integration checks.

ℹ️ This project also has non-automated pre-integration requirements. Please see the file CONTRIBUTING.md for details.

After integration, the commit message for the final commit will be:

8270915: GIFImageReader disregards ignoreMetadata flag which causes memory exhaustion

Reviewed-by: prr

You can use pull request commands such as /summary, /contributor and /issue to adjust it as needed.

At the time when this comment was updated there had been 119 new commits pushed to the master branch:

• b22a38d: 8292309: Fix java/awt/PrintJob/ConstrainedPrintingTest/ConstrainedPrintingTest.java test
• 121d4a5: 8293579: tools/jpackage/share/jdk/jpackage/tests/UnicodeArgsTest.java fails on Japanese Windows platform
• 1166a8a: 8292214: Memory leak in getAllConfigs of awt_GraphicsEnv.c:386
• 3644e26: 8294673: JFR: Add SecurityProviderService#threshold to TestActiveSettingEvent.java
• 085949a: 8294712: G1: Use index-base iteration for G1FlushHumongousCandidateRemSets
• b850f05: 8294758: JFR: Docs build fails after changes to RecordedObject and Timespan
• 2dbedf0: 8294406: Test runtime/handshake/HandshakeDirectTest.java failed: JVMTI_ERROR_WRONG_PHASE
• 4d6668e: 8294242: JFR: jfr print doesn't handle infinite duration well
• 5a9cd33: 8294509: The sign extension bug applies to 'public static int[] convertSeedBytesToInts(byte[] seed, int n, int z)' in RandomSupport
• f03934e: 8294578: [PPC64] C2: Missing is_oop information when using disjoint compressed oops mode
• ... and 109 more: https://git.openjdk.org/jdk/compare/169a5d48afbc6627f36a768c17c2a5e56219d9c7...master

As there are no conflicts, your changes will automatically be rebased on top of these commits when integrating. If you prefer to avoid this automatic rebasing, please check the documentation for the /integrate command for further details.

➡️ To integrate this PR with the above commit message to the master branch, type /integrate in a new comment.

[jayathirthrao]

I have updated readMedata() to also use ReaderUtil.staggeredReadByteStream() where we are allocating upfront memory based on parameters from metadata.

Probably it is possible to create a small test just for this change?

Thanks for your review Sergey.
If i need to add tests for staggered read in this PR i need to create 3 different byte streams to capture all the scenarios and these streams will not be related to this bug.
I just added staggered read approach in readMetadata() as it is now time tested and acts as a barrier for corrupt header parameters.

[jayathirthrao]

/integrate

[openjdk]

Going to push as commit 8c15f77.
Since your change was applied there have been 142 commits pushed to the master branch:

• 6029120: 8278086: [REDO] ImageIO.write() method will throw IndexOutOfBoundsException
• 8f56115: 8294679: RISC-V: Misc crash dump improvements
• e986a97: 8292330: Update JCov version to 3.0.13
• d4142d8: 8290036: Define and specify Runtime shutdown sequence
• 0ec1838: 8294869: Correct failure of RemovedJDKInternals.java after JDK-8294618
• 87acfee: 8294397: Replace StringBuffer with StringBuilder within java.text
• f2c5718: 8294734: Redundant override in AES implementation
• 536c9a5: 8294618: Update openjdk.java.net => openjdk.org
• f531dae: 8294840: langtools OptionalDependencyTest.java use File.pathSeparator
• ee6c391: 8289925: Shared code shouldn't reference the platform specific method frame::interpreter_frame_last_sp()
• ... and 132 more: https://git.openjdk.org/jdk/compare/169a5d48afbc6627f36a768c17c2a5e56219d9c7...master

Your commit was automatically rebased without conflicts.

[openjdk]

@jayathirthrao Pushed as commit 8c15f77.

💡 You may see a message that your pull request was closed with unmerged commits. This can be safely ignored.