8357268: Use JavaNioAccess.getBufferAddress rather than DirectBuffer.address() by minborg · Pull Request #25324 · openjdk/jdk

minborg · 2025-05-20T10:51:13Z

This PR proposes to use JavaNioAccess::getBufferAdress rather than DirectBuffer::address so that Buffer instances backed by MemorySegment instances can be used in classes that were not covered by #25321

This PR passes tier1, tier2, and tier3 tests on multiple platforms and configurations.

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-8357268: Use JavaNioAccess.getBufferAddress rather than DirectBuffer.address() (Bug - P3)

Reviewers

Valerie Peng (@valeriepeng - Reviewer) Review applies to d6b4233e
Alan Bateman (@AlanBateman - Reviewer)

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 25324

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

Using diff file

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

Using Webrev

Link to Webrev Comment

bridgekeeper · 2025-05-20T10:51:56Z

👋 Welcome back pminborg! 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 · 2025-05-20T10:52:32Z

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

8357268: Use JavaNioAccess.getBufferAddress rather than DirectBuffer.address()

Reviewed-by: alanb, valeriep

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 1 new commit pushed to the master branch:

72a3022: 8357842: PandocFilter misses copyright header

Please see this link for an up-to-date comparison between the source branch of this pull request and the master branch.
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.

openjdk · 2025-05-20T10:53:09Z

@minborg The following labels will be automatically applied to this pull request:

net
nio
security

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

minborg · 2025-05-20T11:01:46Z

            }

            boolean pending = false;
+            NIO_ACCESS.acquireSession(buf);


Here, we acquire the session after we have obtained the address. This is safe as we do not touch the segment before it is acquired. If a segment is deallocated before we try to acquire the session, an exception will be thrown.

Is there documentation on when sessions should be acquired/released? Is this only for when using MemorySegment? In security area, the bytes are passed to the JNI code which calls the native library to process the bytes and I wonder if sessions should be acquired/released for these.

Never mind, I see that there are already acquireSession/releaseSession calls when the ByteBuffer objects are accessed.

mlbridge · 2025-05-20T12:06:34Z

Webrevs

AlanBateman · 2025-05-20T12:25:22Z

We need to audit the tests for the APIs that take a byte buffer to ensure that we have tests to exercise these APIs with buffers that are views on a memory segment. That would help identify any bugs.

The temporary buffer cache is internal so I think better to separate from this JBS issue and PR as these cases cannot be views on a memory segment. Future work to re-implement the temporary buffer cache can re-visit this.

AlanBateman · 2025-05-20T13:38:11Z

A question for folks on security-dev. Are there tests for Cipher.doFinal, CipherSpi.engineUpdate, etc. that exercises cases where the ByteBuffer obtained from a memory segment?

AlanBateman · 2025-05-20T15:38:00Z

                    ioCache.remove(overlapped);

            } finally {
+                NIO_ACCESS.releaseSession(buf);


I thin the change to WindowsAsynchronousFileChannel will need more than one reviewer as the I/O operation may complete on a different thread to the one that it was initiated on.

minborg · 2025-05-20T16:11:09Z

/reviewers 2

openjdk · 2025-05-20T16:12:20Z

@minborg
The total number of required reviews for this PR (including the jcheck configuration and the last /reviewers command) is now set to 2 (with at least 1 Reviewer, 1 Author).

valeriepeng · 2025-05-21T05:00:16Z

A question for folks on security-dev. Are there tests for Cipher.doFinal, CipherSpi.engineUpdate, etc. that exercises cases where the ByteBuffer obtained from a memory segment?

I don't find any. We'd have to update them to cover the memory segment usage. Judging from the changed sources, general Cipher and SunPKCS11-specific tests update would be needed.

AlanBateman · 2025-05-21T09:10:57Z

A question for folks on security-dev. Are there tests for Cipher.doFinal, CipherSpi.engineUpdate, etc. that exercises cases where the ByteBuffer obtained from a memory segment?

I don't find any. We'd have to update them to cover the memory segment usage. Judging from the changed sources, general Cipher and SunPKCS11-specific tests update would be needed.

Thanks for checking. We need to create an issue in JBS for this. It may be a corner case to use these APIs and SPI with buffers that are views on a memory segment but it will happen at some point and would be good to ensure that it is covered by tests.

minborg · 2025-05-21T13:29:25Z

A question for folks on security-dev. Are there tests for Cipher.doFinal, CipherSpi.engineUpdate, etc. that exercises cases where the ByteBuffer obtained from a memory segment?

I don't find any. We'd have to update them to cover the memory segment usage. Judging from the changed sources, general Cipher and SunPKCS11-specific tests update would be needed.

Thanks for checking. We need to create an issue in JBS for this. It may be a corner case to use these APIs and SPI with buffers that are views on a memory segment but it will happen at some point and would be good to ensure that it is covered by tests.

I've created https://bugs.openjdk.org/browse/JDK-8357466. There are some missing fields, I hope someone can fill them in.

valeriepeng

Security source changes look fine.

AlanBateman · 2025-05-26T07:51:32Z

            }

            boolean pending = false;
+            IOUtil.acquireScope(buf, true);


Would you mind checking the use of acquireScope in WindowsAsynchronousSocketChannelImpl? From a quick look I'm wondering why it doesn't call the 2-arg acquireScope with async=true.

WASCI is using acquireScopes (plural) and this delegates to aquireScope(.., async=true). So, looks good.

Good, thanks for checking.

AlanBateman · 2025-05-26T16:05:13Z

                    ioCache.remove(overlapped);

            } finally {
+                IOUtil.releaseScope(buf);


I don't think we can release here when there is an I/O pending. I suspect it will need to go into releaseBufferIfSubstituted.

TBH, I think the change to Windows implementation of AsynchronousFileChannel are going to take more eyes and significant testing. What would you think about dropping it from this PR and creating a separate JBS issue as this is going to require more cycles that everything else in this PR.

Sounds like a good idea: https://bugs.openjdk.org/browse/JDK-8357847

minborg · 2025-05-27T12:47:02Z

/reviewers 1

I am reverting to 1 reviewer, as we have removed the asynchronous Windows class.

openjdk · 2025-05-27T12:47:46Z

@minborg
The total number of required reviews for this PR (including the jcheck configuration and the last /reviewers command) is now set to 1 (with at least 1 Reviewer).

minborg · 2025-05-27T19:10:05Z

/integrate

openjdk · 2025-05-27T19:11:13Z

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

c1f066e: 8356888: (fs) FileSystems.newFileSystem that take an env must specify IllegalArgumentException
c295377: 8357800: Initialize JvmtiThreadState bool fields with bool literals
cdff7b9: 8357801: Parallel: Remove deprecated PSVirtualSpace methods
... and 1 more: https://git.openjdk.org/jdk/compare/b4b11d777137c21c8808bbba5bdf20a2b4ff5be6...master

Your commit was automatically rebased without conflicts.

openjdk · 2025-05-27T19:11:22Z

@minborg Pushed as commit d4b923d.

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

Use getBufferAddress() rather than address()

31b5293

openjdk Bot added security security-dev@openjdk.org nio nio-dev@openjdk.org net net-dev@openjdk.org labels May 20, 2025

minborg commented May 20, 2025

View reviewed changes

minborg added 2 commits May 20, 2025 13:02

Remove comment

36ddd8b

Remove import

6e733a1

minborg marked this pull request as ready for review May 20, 2025 12:01

openjdk Bot added the rfr Pull request is ready for review label May 20, 2025

minborg added 2 commits May 20, 2025 14:45

Revoke changes in classes that is always using DirectBuffer

9c5a357

Clean up

f2764bf

AlanBateman reviewed May 20, 2025

View reviewed changes

minborg added 2 commits May 20, 2025 17:49

Add tests

be261f5

Update after comments

6435f77

wenshao reviewed May 20, 2025

View reviewed changes

Comment thread src/java.base/share/classes/com/sun/crypto/provider/GaloisCounterMode.java Outdated

wenshao reviewed May 20, 2025

View reviewed changes

Comment thread src/java.base/share/classes/com/sun/crypto/provider/GaloisCounterMode.java Outdated

wenshao reviewed May 20, 2025

View reviewed changes

Comment thread test/jdk/java/nio/channels/AsynchronousFileChannel/Basic.java

valeriepeng reviewed May 21, 2025

View reviewed changes

Comment thread src/java.base/share/classes/sun/nio/ch/Util.java Outdated

valeriepeng reviewed May 21, 2025

View reviewed changes

Comment thread src/java.base/unix/classes/sun/nio/fs/UnixUserDefinedFileAttributeView.java Outdated

minborg added 2 commits May 21, 2025 15:35

Update after comments

538147b

Fix copyright year

d6b4233

valeriepeng approved these changes May 22, 2025

View reviewed changes

AlanBateman reviewed May 26, 2025

View reviewed changes

Comment thread src/java.base/unix/classes/sun/nio/fs/UnixUserDefinedFileAttributeView.java Outdated

AlanBateman reviewed May 26, 2025

View reviewed changes

Comment thread src/java.base/windows/classes/sun/nio/ch/WindowsAsynchronousFileChannelImpl.java Outdated

AlanBateman reviewed May 26, 2025

View reviewed changes

Comment thread test/jdk/java/nio/channels/AsynchronousFileChannel/Basic.java

Address comments

ec233e0

AlanBateman reviewed May 26, 2025

View reviewed changes

minborg added 3 commits May 27, 2025 13:24

Revoke changes in WAFCI

632e9af

Revert copyright year

c2a901b

Merge branch 'master' into jdk-segment-access

1eb284d

AlanBateman approved these changes May 27, 2025

View reviewed changes

openjdk Bot added the ready Pull request is ready to be integrated label May 27, 2025

Revert changes in test

dcb67a7

openjdk Bot removed the ready Pull request is ready to be integrated label May 27, 2025

AlanBateman approved these changes May 27, 2025

View reviewed changes

openjdk Bot added the ready Pull request is ready to be integrated label May 27, 2025

openjdk Bot added the integrated Pull request has been integrated label May 27, 2025

openjdk Bot closed this May 27, 2025

openjdk Bot removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels May 27, 2025

JornVernee mentioned this pull request Jun 3, 2025

8358537: (bf) JavaNioAccess::getBufferAddress bypasses direct buffer MemorySession state check #25631

Closed

3 tasks

wendigo mentioned this pull request Jun 6, 2025

Cassandra client fails with Netty 4.2.2 netty/netty#15324

Closed

salyh mentioned this pull request Jun 24, 2025

Initial push of crypto directory opensearch-project/opensearch-storage-encryption#3

Merged

4 tasks

Conversation

minborg commented May 20, 2025 • edited by openjdk Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Progress

Issue

Reviewers

Reviewing

Uh oh!

bridgekeeper Bot commented May 20, 2025

Uh oh!

openjdk Bot commented May 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

openjdk Bot commented May 20, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mlbridge Bot commented May 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Webrevs

Uh oh!

AlanBateman commented May 20, 2025

Uh oh!

AlanBateman commented May 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

minborg commented May 20, 2025

Uh oh!

openjdk Bot commented May 20, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

valeriepeng commented May 21, 2025

Uh oh!

AlanBateman commented May 21, 2025

Uh oh!

minborg commented May 21, 2025

Uh oh!

valeriepeng left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

minborg commented May 27, 2025

Uh oh!

openjdk Bot commented May 27, 2025

Uh oh!

minborg commented May 27, 2025

Uh oh!

openjdk Bot commented May 27, 2025

Uh oh!

openjdk Bot commented May 27, 2025

Uh oh!

Reviewers

Assignees

minborg commented May 20, 2025 •

edited by openjdk Bot

Loading

openjdk Bot commented May 20, 2025 •

edited

Loading

mlbridge Bot commented May 20, 2025 •

edited

Loading

AlanBateman commented May 20, 2025 •

edited

Loading