8326099: GZIPOutputStream should use Deflater.getBytesRead() instead of Deflater.getTotalIn()

[eirbjo]

Please review this cleanup PR in preparation for deprecating Deflater.getTotalIn() in JDK-8326096.

This PR replaces GZIPOutputStream.writeTrailer's call to Deflater.getTotalIn() with a call to Deflater.getBytesRead() followed by an explicit conversion to "modulo 2^32" (a cast to int) as described in RFC 1952:

 ISIZE (Input SIZE)
  This contains the size of the original (uncompressed) input
  data modulo 2^32.

Testing and verification: This should be trivially verifiable by code inspection. Nevertheless, I wrote a test which writes Integer.MAX_VALUE +1 bytes of uncompressed data and verified that the last four bytes written to the file was indeed as expected. (This test is not included in this PR because of its runtime and resource requirements).

---

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-8326099: GZIPOutputStream should use Deflater.getBytesRead() instead of Deflater.getTotalIn() (Enhancement - P4)

Reviewers

• Jaikiran Pai (@jaikiran - Reviewer)

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 17900

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

Using diff file

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

Webrev

Link to Webrev Comment

[bridgekeeper]

👋 Welcome back eirbjo! 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]

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

• core-libs

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 (e768fce9)

[jaikiran]

Hello Eirik, the change looks OK to me.

For context, the getTotalIn() and getTotalOut() methods are being proposed for deprecation https://mail.openjdk.org/pipermail/core-libs-dev/2024-February/119321.html. getTotalIn() was doing the same (int) getBytesRead() internally, so this change should be OK.

[openjdk]

@eirbjo 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:

8326099: GZIPOutputStream should use Deflater.getBytesRead() instead of Deflater.getTotalIn()

Reviewed-by: jpai

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 186 new commits pushed to the master branch:

• 099b744: 8326117: ProblemList serviceability/jvmti/vthread/SuspendWithInterruptLock/SuspendWithInterruptLock.java#default in Xcomp mode
• 39627bc: 6510914: JScrollBar.getMinimumSize() breaks the contract of JComponent.setMinimumSize()
• 7004c27: 8303972: (zipfs) Make test/jdk/jdk/nio/zipfs/TestLocOffsetFromZip64EF.java independent of the zip command line
• c2d9fa2: 8326000: Remove obsolete comments for class sun.security.ssl.SunJSSE
• f50df10: 8299023: TestPLABResize.java and TestPLABPromotion.java are failing intermittently
• cf13086: 8317697: refactor-encapsulate x86 VM_Version::CpuidInfo
• 3b76372: 8325687: SimpleJavaFileObject specification would benefit from implSpec
• b5df2f4: 8323170: j2dbench is using outdated javac source/target to be able to build by itself
• 267780b: 8324680: Replace NULL with nullptr in JVMTI generated code
• f3073db: 8321408: Add Certainly roots R1 and E1
• ... and 176 more: https://git.openjdk.org/jdk/compare/692c9f8821e220560927dd6bbedfea9ddfe312f6...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.

[eirbjo]

Hello Eirik, the change looks OK to me.

Thanks for veryfying and adding helpful context!

I'll let this linger just a bit before integrating in case there is any non-correctness feedback, like about the added comment to clarify the modulo 2^32 aspect.

[eirbjo]

/integrate

[openjdk]

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

• 490825f: 8325589: C2 SuperWord refactoring: create VLoopAnalyzer with Submodules
• 3a00fc7: 8323698: Class use page does not include extends/implements type arguments
• f32f574: 8326575: Remove unused ContiguousSpace::set_top_for_allocations
• 09f755a: 8325857: G1 Full GC flushes mark stats cache too early
• 1799ffe: 8310351: Typo in ImmutableCollections
• d10f277: 8326006: Allow TEST_VM_FLAGLESS to set flagless mode
• 63f6a56: 8326530: Widen allowable error bound of Math.tan
• 27574b3: 8326585: COMPARE_BUILD=PATCH fails if patch -R fails
• c26c583: 8311003: missing @SInCE info in jdk.security.jgss
• 09a78b5: 8326378: [PPC64] CodeEntryAlignment too large
• ... and 257 more: https://git.openjdk.org/jdk/compare/692c9f8821e220560927dd6bbedfea9ddfe312f6...master

Your commit was automatically rebased without conflicts.

[openjdk]

@eirbjo Pushed as commit bb6b048.

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