8346610: Make all imports consistent in the FFM API #22827

minborg · 2024-12-19T10:46:03Z

This PR proposes to clean up all the imports in the FFM lib (excluding tests).

Passes tier1-tier3

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-8346610: Make all imports consistent in the FFM API (Enhancement - P5)

Reviewers

Maurizio Cimadamore (@mcimadamore - Reviewer)

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 22827

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

Using diff file

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

Using Webrev

Link to Webrev Comment

bridgekeeper · 2024-12-19T10:46:51Z

👋 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 · 2024-12-19T10:47:30Z

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

8346610: Make all imports consistent in the FFM API

Reviewed-by: mcimadamore

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

4f3dc9d: 8347352: RISC-V: Cleanup bitwise AND assembler routines
afc4529: 8346834: Tests failing with -XX:+UseNUMA due to "NUMA support disabled" warning
a3be97e: 8347761: Test tools/jimage/JImageExtractTest.java fails after JDK-8303884
28e01e6: 8347762: ClassFile attribute specification refers to non-SE modules
be1cdd9: 8344140: Refactor the discovery of AOT cache artifacts
973c630: 8342466: Improve API documentation for java.lang.classfile.attribute
9782bfd: 8347620: Shenandoah: Use 'free' tag for free set related logging
35be4a4: 8347173: java/net/DatagramSocket/InterruptibleDatagramSocket.java fails with virtual thread factory
36b7abd: 8225763: Inflater and Deflater should implement AutoCloseable
d6d45c6: 8303884: jlink --add-options plugin does not allow GNU style options to be provided
... and 96 more: https://git.openjdk.org/jdk/compare/8c87ea2bdf6e1aea5fdca4624d7b7fe590d33a37...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.

openjdk · 2024-12-19T10:48:16Z

@minborg 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 · 2024-12-19T10:50:48Z

Webrevs

AlanBateman · 2024-12-19T13:26:29Z

src/java.base/share/classes/java/lang/foreign/FunctionDescriptor.java

 import java.util.Objects;
 import java.util.Optional;
-import java.util.List;
-
-import jdk.internal.foreign.FunctionDescriptorImpl;


Just curious where this style/convention is coming from, I've always put internal packages after the import of standard APIs.

Both alternatives were present and I picked the most prevailing one in the package. Also, this is what you get when you auto format in IntelliJ. But if there is a preference for the other way, we could switch. No problem.

I don't have any strong opinion on the topic, I was mostly just curious when I saw "conformant" in the title.

I've renamed the title: "conformant" -> "consistent"

mcimadamore

copyrights should say 2025

mcimadamore · 2025-01-07T15:38:51Z

Do we have a sense on how easy would it be, moving forward, to preserve the "correct" order of imports? E.g. if I add a new one using IntelliJ autocompletion, where would it end up? Has this patch been generated using the IDE's own import reorganization? Perhaps doing something like that might be preferrable/more maintainable longer term?

minborg · 2025-01-08T09:02:57Z

copyrights should say 2025

I believe all the changes were made and committed in 2024. So, shouldn't the copyright year be 2024 then?

minborg · 2025-01-08T09:08:11Z

Do we have a sense on how easy would it be, moving forward, to preserve the "correct" order of imports? E.g. if I add a new one using IntelliJ autocompletion, where would it end up? Has this patch been generated using the IDE's own import reorganization? Perhaps doing something like that might be preferrable/more maintainable longer term?

The updates in this PR were generated automatically by selecting the relevant packages and then using IntelliJ's automatic Code->Optimize Imports. It is possible to tell IntelliJ to make this automatically upon saving a file: https://www.jetbrains.com/help/idea/creating-and-optimizing-imports.html#optimize-on-save

mcimadamore · 2025-01-08T10:43:26Z

copyrights should say 2025

I believe all the changes were made and committed in 2024. So, shouldn't the copyright year be 2024 then?

I've typically used the year of when things are integrated. It's a bit of a gray area and I'm not super sure. Note that Skara will take your commits and squash them into a new commit which will feature a 2025 date (I think).

slowhog · 2025-01-15T02:21:00Z

Do we have a sense on how easy would it be, moving forward, to preserve the "correct" order of imports? E.g. if I add a new one using IntelliJ autocompletion, where would it end up? Has this patch been generated using the IDE's own import reorganization? Perhaps doing something like that might be preferrable/more maintainable longer term?

The updates in this PR were generated automatically by selecting the relevant packages and then using IntelliJ's automatic Code->Optimize Imports. It is possible to tell IntelliJ to make this automatically upon saving a file: https://www.jetbrains.com/help/idea/creating-and-optimizing-imports.html#optimize-on-save

I like auto import, it's great feature to ensure consistency. But the prerequisite is to have consistent settings in coding style(, and different IDEs would be different as well. https://www.jetbrains.com/help/idea/code-style-java.html#imports_table

Just curious, do we have a standard IntelliJ setting for OpenJDK coding style, perhaps it's prepared by bash bin/idea.sh mentioned in https://github.com/openjdk/jdk/blob/master/doc/ide.md?

mcimadamore

Looks good. Did you also do a pass on microbenchmarks and tests? Or will that be a separate effort (probably better) ?

minborg · 2025-01-15T12:19:00Z

Did you also do a pass on microbenchmarks and tests? Or will that be a separate effort (probably better) ?

https://bugs.openjdk.org/browse/JDK-8347814

minborg · 2025-01-15T12:19:11Z

/integrate

openjdk · 2025-01-15T12:19:31Z

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

c36200b: 8347721: Replace SIZE_FORMAT in compiler directories
af3f5d8: 8347039: ThreadPerTaskExecutor terminates if cancelled tasks still running
91197b3: 8347531: The signal tests are failing after JDK-8345782 due to an unrelated warning
4f3dc9d: 8347352: RISC-V: Cleanup bitwise AND assembler routines
afc4529: 8346834: Tests failing with -XX:+UseNUMA due to "NUMA support disabled" warning
a3be97e: 8347761: Test tools/jimage/JImageExtractTest.java fails after JDK-8303884
28e01e6: 8347762: ClassFile attribute specification refers to non-SE modules
be1cdd9: 8344140: Refactor the discovery of AOT cache artifacts
973c630: 8342466: Improve API documentation for java.lang.classfile.attribute
9782bfd: 8347620: Shenandoah: Use 'free' tag for free set related logging
... and 99 more: https://git.openjdk.org/jdk/compare/8c87ea2bdf6e1aea5fdca4624d7b7fe590d33a37...master

Your commit was automatically rebased without conflicts.

openjdk · 2025-01-15T12:19:38Z

@minborg Pushed as commit d4e5ec2.

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

Fix imports

490701e

openjdk bot changed the title ~~JDK-8346610: Make all imports conformant in the FFM API~~ 8346610: Make all imports conformant in the FFM API Dec 19, 2024

openjdk bot added the rfr Pull request is ready for review label Dec 19, 2024

openjdk bot added the core-libs core-libs-dev@openjdk.org label Dec 19, 2024

AlanBateman reviewed Dec 19, 2024

View reviewed changes

mcimadamore reviewed Jan 7, 2025

View reviewed changes

minborg changed the title ~~8346610: Make all imports conformant in the FFM API~~ 8346610: Make all imports consistent in the FFM API Jan 8, 2025

minborg added 3 commits January 9, 2025 11:44

Merge branch 'master' into fix-imports

5c59127

Update copyright year and reformat

f58f338

Merge branch 'master' into fix-imports

d5e1132

mcimadamore approved these changes Jan 15, 2025

View reviewed changes

openjdk bot added the ready Pull request is ready to be integrated label Jan 15, 2025

openjdk bot added the integrated Pull request has been integrated label Jan 15, 2025

openjdk bot closed this Jan 15, 2025

openjdk bot removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels Jan 15, 2025

minborg mentioned this pull request Feb 19, 2025

8347814: Make all imports consistent in the FFM API tests and benchmarks #23689

Open

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

8346610: Make all imports consistent in the FFM API #22827

8346610: Make all imports consistent in the FFM API #22827

minborg commented Dec 19, 2024 •

edited by openjdk bot

Loading

bridgekeeper bot commented Dec 19, 2024

openjdk bot commented Dec 19, 2024 •

edited

Loading

openjdk bot commented Dec 19, 2024

mlbridge bot commented Dec 19, 2024 •

edited

Loading

AlanBateman Dec 19, 2024

minborg Dec 19, 2024

AlanBateman Dec 19, 2024

minborg Jan 8, 2025

mcimadamore left a comment

mcimadamore commented Jan 7, 2025

minborg commented Jan 8, 2025

minborg commented Jan 8, 2025

mcimadamore commented Jan 8, 2025 •

edited

Loading

slowhog commented Jan 15, 2025

mcimadamore left a comment

minborg commented Jan 15, 2025

minborg commented Jan 15, 2025

openjdk bot commented Jan 15, 2025

openjdk bot commented Jan 15, 2025

8346610: Make all imports consistent in the FFM API #22827

8346610: Make all imports consistent in the FFM API #22827

Conversation

minborg commented Dec 19, 2024 • edited by openjdk bot Loading

Progress

Issue

Reviewers

Reviewing

bridgekeeper bot commented Dec 19, 2024

openjdk bot commented Dec 19, 2024 • edited Loading

openjdk bot commented Dec 19, 2024

mlbridge bot commented Dec 19, 2024 • edited Loading

Webrevs

AlanBateman Dec 19, 2024

Choose a reason for hiding this comment

minborg Dec 19, 2024

Choose a reason for hiding this comment

AlanBateman Dec 19, 2024

Choose a reason for hiding this comment

minborg Jan 8, 2025

Choose a reason for hiding this comment

mcimadamore left a comment

Choose a reason for hiding this comment

mcimadamore commented Jan 7, 2025

minborg commented Jan 8, 2025

minborg commented Jan 8, 2025

mcimadamore commented Jan 8, 2025 • edited Loading

slowhog commented Jan 15, 2025

mcimadamore left a comment

Choose a reason for hiding this comment

minborg commented Jan 15, 2025

minborg commented Jan 15, 2025

openjdk bot commented Jan 15, 2025

openjdk bot commented Jan 15, 2025

minborg commented Dec 19, 2024 •

edited by openjdk bot

Loading

openjdk bot commented Dec 19, 2024 •

edited

Loading

mlbridge bot commented Dec 19, 2024 •

edited

Loading

mcimadamore commented Jan 8, 2025 •

edited

Loading