6187113: DefaultListSelectionModel.removeIndexInterval(0, Integer.MAX_VALUE) fails #10409

prsadhuk · 2022-09-23T13:19:01Z

DefaultListSelectionModel.removeIndexInterva accepts int value which allows it to take in Integer.MAX_VALUE theoratically but it does calculation with that value which can results in IOOBE.
Fix is to make sure the calculation stays within bounds.

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
Change requires CSR request JDK-8295329 to be approved

Issues

JDK-6187113: DefaultListSelectionModel.removeIndexInterval(0, Integer.MAX_VALUE) fails
JDK-8295329: DefaultListSelectionModel.removeIndexInterval(0, Integer.MAX_VALUE) fails (CSR)

Reviewers

Alexey Ivanov (@aivanov-jdk - Reviewer) ⚠️ Review applies to b1857d3c

Contributors

Alexey Ivanov <aivanov@openjdk.org>

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 10409

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

Using diff file

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

…_VALUE) fails

bridgekeeper · 2022-09-23T13:19:39Z

👋 Welcome back psadhukhan! 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 · 2022-09-23T13:23:38Z

@prsadhuk 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 · 2022-09-23T13:37:12Z

Webrevs

test/jdk/javax/swing/TestDefListModelExcpn.java

src/java.desktop/share/classes/javax/swing/DefaultListSelectionModel.java

prsadhuk · 2022-10-14T09:24:01Z

CSR raised..https://bugs.openjdk.org/browse/JDK-8295329...please review

aivanov-jdk

I was wrong, disallowing Integer.MAX_VALUE for setSelectionInterval is not enough. Moreover, if Integer.MAX_VALUE isn't accepted for setSelectionInterval and removeIndexInterval, it should be rejected in other places too. Otherwise, selectionModel.isSelectedIndex(Integer.MAX_VALUE)) being valid looks inconsistent.

Even when the gapLength remains positive, the following loop could throw IOOBE because a negative index being accessed. The following code

        selectionModel.setSelectionInterval(Integer.MAX_VALUE - 2, Integer.MAX_VALUE - 1);
        selectionModel.removeIndexInterval(0, Integer.MAX_VALUE - 1);

throws

Exception in thread "main" java.lang.IndexOutOfBoundsException: bitIndex < 0: -2147483648
	at java.base/java.util.BitSet.get(BitSet.java:626)
	at java.desktop/javax.swing.DefaultListSelectionModel.removeIndexInterval(DefaultListSelectionModel.java:713)
	at SelectionModelTest.main(SelectionModelTest.java)

where line 713

jdk/src/java.desktop/share/classes/javax/swing/DefaultListSelectionModel.java

Line 713 in ee43bd8

setState(i, value.get(i + gapLength));

I suggested the code to fix that problem.

Then the infinite loop in changeSelection

jdk/src/java.desktop/share/classes/javax/swing/DefaultListSelectionModel.java

Line 432 in ee43bd8

for(int i = Math.min(setMin, clearMin); i <= Math.max(setMax, clearMax); i++) {

for MAX_VALUE is resolved by reversing it:

-        for(int i = Math.min(setMin, clearMin); i <= Math.max(setMax, clearMax); i++) {
+        for(int i = Math.max(setMax, clearMax); i >= Math.min(setMin, clearMin); i--) {

The proposed changes will resolve the bug.

src/java.desktop/share/classes/javax/swing/DefaultListSelectionModel.java

aivanov-jdk · 2022-10-14T19:33:56Z

src/java.desktop/share/classes/javax/swing/DefaultListSelectionModel.java

        for(int i = rmMinIndex; i <= maxIndex; i++) {
-            if ((i + gapLength) > gapLength) {
-                setState(i, value.get(i + gapLength));
-            } else {
-                setState(i, value.get(gapLength));
-            }
+            setState(i, value.get(i + gapLength));
        }


The for-loop should look like this:

for(int i = rmMinIndex; i >= 0 && i <= maxIndex; i++) { setState(i, (i <= Integer.MAX_VALUE - gapLength) && (i + gapLength >= minIndex) && value.get(i + gapLength)); }

It breaks if i becomes negative. In the body, the first condition (i <= Integer.MAX_VALUE - gapLength) prevents accessing indexes greater than Integer.MAX_VALUE, the second condition (i + gapLength >= minIndex) is an optimisation, the values for indexes below minIndex are false, so the call to value.get is skipped. (The second condition is not required.)

aivanov-jdk · 2022-10-14T20:05:23Z

There exists at least one other problem because of integer overflow in insertIndexInterval.

This code

        selectionModel.setSelectionInterval(Integer.MAX_VALUE - 1, Integer.MAX_VALUE);
        selectionModel.insertIndexInterval(Integer.MAX_VALUE - 1, Integer.MAX_VALUE, true);

throws

Exception in thread "main" java.lang.IndexOutOfBoundsException: bitIndex < 0: -2
	at java.base/java.util.BitSet.get(BitSet.java:626)
	at java.desktop/javax.swing.DefaultListSelectionModel.set(DefaultListSelectionModel.java:311)
	at java.desktop/javax.swing.DefaultListSelectionModel.setState(DefaultListSelectionModel.java:629)
	at java.desktop/javax.swing.DefaultListSelectionModel.insertIndexInterval(DefaultListSelectionModel.java:657)
	at SelectionModelTest.main(SelectionModelTest.java)

Would you like to include it as part of this fix? Shall I submit a new bug for this?

prsadhuk · 2022-10-18T04:57:11Z

Thanks for your suggestive code..
I guess you are now ok with handling Integer.MAX_VALUE in the code rather than only in javadoc.

BTW, your code change resulted in JCK failure so I have used a mix of what I had in previous iterations and your code and this satisfied JCK as well as the unit tests.
Regarding insertIndexInterval I guess it's better to address in this PR as it has same issue in same file, so I have added a fix for it also in this PR.

aivanov-jdk

This is tough. The number of test cases has grown to 25. There are many failures.

src/java.desktop/share/classes/javax/swing/DefaultListSelectionModel.java

aivanov-jdk · 2022-10-18T19:52:34Z

src/java.desktop/share/classes/javax/swing/DefaultListSelectionModel.java

+            if ((i + length) >= length) {
+                setState(i + length, value.get(i));
+            } else {
+                setState(i, value.get(i));


This operation in the else block doesn't make sense, you can just skip it.

aivanov-jdk · 2022-10-18T19:54:18Z

src/java.desktop/share/classes/javax/swing/DefaultListSelectionModel.java

@@ -654,7 +658,11 @@ public void insertIndexInterval(int index, int length, boolean before)
         * insMinIndex).
         */
        for(int i = maxIndex; i >= insMinIndex; i--) {
-            setState(i + length, value.get(i));
+            if ((i + length) >= length) {


I suggest using i <= Integer.MAX_VALUE - length. Yet I'm still unsure it's enough and correct.

aivanov-jdk · 2022-10-18T19:55:31Z

src/java.desktop/share/classes/javax/swing/DefaultListSelectionModel.java

@@ -654,7 +658,11 @@ public void insertIndexInterval(int index, int length, boolean before)
         * insMinIndex).
         */
        for(int i = maxIndex; i >= insMinIndex; i--) {


insertIndexInterval doesn't verify its parameters: negative index, negative length should be rejected right away.

aivanov-jdk · 2022-10-18T20:01:22Z

src/java.desktop/share/classes/javax/swing/DefaultListSelectionModel.java

+            if ((i + gapLength) >= gapLength) {
+                setState(i, value.get(i + gapLength));
+            } else {
+                setState(i, value.get(gapLength));
+                break;
+            }


This does not work. It must not break. With this code, 5 of my tests fail.

For example,

selectionModel.setSelectionInterval(0, Integer.MAX_VALUE); selectionModel.removeIndexInterval(0, Integer.MAX_VALUE);

must result in empty selection. All the possible indexes were selected, you removed all the possible indexes (so that “the list” contains no elements at all). This test case fails either way, unfortunately: selectionModel.isSelectedIndex(0) still returns true.

This edge case where rmMinIndex = 0 and rmMaxIndex = Integer.MAX_VALUE should probably be short-circuited: setState(i, false) for all the elements. Other values are handled correctly by my suggested code, as far as I can see.

This test case:

selectionModel.setSelectionInterval(0, Integer.MAX_VALUE); selectionModel.removeIndexInterval(1, Integer.MAX_VALUE);

passed before and now it fails again. Here, selectionModel.isSelectedIndex(0) must be true.

If we handle the edge case separately, it looks better and the first test case as well as other tests for remove pass successfully:

public void removeIndexInterval(int index0, int index1) { if (index0 < 0 || index1 < 0) { throw new IndexOutOfBoundsException("index is negative"); } int rmMinIndex = Math.min(index0, index1); int rmMaxIndex = Math.max(index0, index1); if (rmMinIndex == 0 && rmMaxIndex == Integer.MAX_VALUE) { for (int i = Integer.MAX_VALUE; i >= 0; i--) { setState(i, false); } // min and max are updated automatically by the for-loop // TODO Update anchor and lead return; } int gapLength = (rmMaxIndex - rmMinIndex) + 1; /* Shift the entire bitset to the left to close the index0, index1 * gap. */ for(int i = rmMinIndex; i >= 0 && i <= maxIndex; i++) { setState(i, (i <= Integer.MAX_VALUE - gapLength) && (i + gapLength >= minIndex) && value.get(i + gapLength)); } // The rest of the method }

aivanov-jdk · 2022-10-18T20:05:01Z

test/jdk/javax/swing/TestDefListModelException.java

+        selectionModel.setSelectionInterval(Integer.MAX_VALUE - 1, Integer.MAX_VALUE);
+        selectionModel.insertIndexInterval(Integer.MAX_VALUE - 1, Integer.MAX_VALUE, true);


I think testing that it does not throw an exception is not enough. You should verify that the data selection model holds is correct.

According to the spec, the interval from Integer.MAX_VALUE - 1 to Integer.MAX_VALUE should remain selected.

aivanov-jdk · 2022-10-21T20:27:12Z

src/java.desktop/share/classes/javax/swing/DefaultListSelectionModel.java

+        if (length < 0 || index < 0) {
+            return;
+        }


Throw IOOBE as it's done in other methods. Silently ignoring bad parameters isn't good, likely it means an error in the calling code.

aivanov-jdk · 2022-10-21T20:32:04Z

src/java.desktop/share/classes/javax/swing/DefaultListSelectionModel.java

+        if (index + length < 0) {
+            return;
+        }


Other methods, like removeIndexInterval, accept parameters which result in integer overflow, I think this should allow it too. Yet you have to ensure index + length isn't greater than Integer.MAX_VALUE. I mean length should be normalized in such a case, so that it doesn't cause the overflow.

Something like length = Integer.MAX_VALUE - index, it's off the top of my head, I haven't verified it's correct, it's just an idea on how this should be handled.

aivanov-jdk · 2022-10-21T20:38:56Z

src/java.desktop/share/classes/javax/swing/DefaultListSelectionModel.java

+        if (length + maxIndex < 0) {
+            maxIndex = Integer.MAX_VALUE - length;
+        }


You must not change maxIndex this way — you just broke the class invariant: maxIndex points to the highest selected index. Now it doesn't.

You have to make sure i + length <= Integer.MAX_VALUE but you must not modify maxIndex directly. This would probably be handled automatically if you normalize length. If not, the body of if may need a condition. Alternatively, a better way, the start value of i should be reduced so that is always i + length <= Integer.MAX_VALUE and doesn't cause integer overflow.

aivanov-jdk · 2022-10-21T20:42:44Z

src/java.desktop/share/classes/javax/swing/DefaultListSelectionModel.java

+            setState(i, (i <= Integer.MAX_VALUE - gapLength)
+                    && (i + gapLength >= minIndex)
+                    && value.get(i + gapLength));


I would prefer if the && operators are aligned to the opening parenthesis of the first condition, it makes it clearer that the condition is part of the second parameter. I don't insist on this one, the wrapping style is not agreed on.

aivanov-jdk

I already mentioned that I wrote a comprehensive unit-test to test the changes to removeIndexInterval and insertIndexInterval. The latest version of my test SelectionModelTest.java.

With the current code in the PR, six (6) test cases still fail. The changes I've suggested should resolve those failures. (I've been testing and proposing fixes to resolve test failures since the start of this code review.)

The test can be run as a jtreg test or as a standalone app. Depending on the hardware, it may take up to 10 minutes; the more cores the system has, the faster the test completes as all the test cases are run in parallel. (The minimum time I've ever seen is around 2–3 minutes.)

I can contribute the test to OpenJDK if deemed useful. I believe such a fix can't be done without extensive testing which verifies all the values in the object remain correct.

src/java.desktop/share/classes/javax/swing/DefaultListSelectionModel.java

aivanov-jdk · 2022-10-26T16:43:27Z

src/java.desktop/share/classes/javax/swing/DefaultListSelectionModel.java

        boolean setInsertedValues = ((getSelectionMode() == SINGLE_SELECTION) ?
                                        false : value.get(index));


I propose resolving an IDE warning and simplifying this condition:

Suggested change

boolean setInsertedValues = ((getSelectionMode() == SINGLE_SELECTION) ?

false : value.get(index));

boolean setInsertedValues = (getSelectionMode() != SINGLE_SELECTION

&& value.get(index));

Although this change is unrelated.

src/java.desktop/share/classes/javax/swing/DefaultListSelectionModel.java

aivanov-jdk · 2022-10-26T16:59:42Z

src/java.desktop/share/classes/javax/swing/DefaultListSelectionModel.java

@@ -449,6 +449,10 @@ private void changeSelection(int clearMin, int clearMax,
            if (shouldClear) {
                clear(i);
            }
+            // Integer overlfow
+            if (i + 1 < i) {


Suggested change

if (i + 1 < i) {

if (i == Integer.MAX_VALUE) {

Will it be clearer this way? (And one less operation: no addition.)

As I mentioned before, I would prefer reversing the loop and iterating from max to min instead. But it causes a failure in JCK which I can't explain because the effective result is the same. Moreover, I believe iterating from max to min is more efficient as touching the maximum index will ensure the internal storage in the underlying BitSet is allocated right away to fit all the bits whereas the storage gets continuously re-allocated and copied as the accessed indexes grow.

aivanov-jdk · 2022-10-26T17:09:06Z

test/jdk/javax/swing/TestDefListModelException.java

+ */
+import javax.swing.DefaultListSelectionModel;
+
+public class TestDefListModelException {


I propose moving this test to JList folder which already contains several tests which use ListSelectionModel via JList.

aivanov-jdk · 2022-10-26T18:20:53Z

With the current code in the PR, six (6) test cases still fail.

The failure of test10 is expected: you adjust the value of length so that insMaxIndex can't be greater than Integer.MAX_VALUE. It is a valid failure, the test needs changing: lead should be become Integer.MAX_VALUE + 1 = -2147483648 (0x80000000).

Other five failures are valid ones, minIndex and maxIndex in the object don't have the expected values.

aivanov-jdk · 2022-11-29T19:11:48Z

Let's keep it open. CSR review has stalled.

bridgekeeper · 2022-12-27T19:27:38Z

@prsadhuk This pull request has been inactive for more than 4 weeks and will be automatically closed if another 4 weeks passes without any activity. To avoid this, simply add a new comment to the pull request. Feel free to ask for assistance if you need help with progressing this pull request towards integration!

aivanov-jdk · 2023-01-19T19:50:58Z

The CSR was approved two days ago, yet the bots didn't update the status of the issue. It should be ready for integration.

prsadhuk · 2023-01-30T07:05:20Z

/label add csr

openjdk · 2023-01-30T07:05:50Z

@prsadhuk
The label csr is not a valid label.
These labels are valid:

serviceability
hotspot
hotspot-compiler
ide-support
kulla
i18n
shenandoah
jdk
javadoc
security
hotspot-runtime
jmx
build
nio
client
core-libs
compiler
net
hotspot-gc
hotspot-jfr

prsadhuk · 2023-01-30T07:06:37Z

/csr

openjdk · 2023-01-30T07:07:05Z

@prsadhuk an approved CSR request is already required for this pull request.

prsadhuk · 2023-01-30T07:09:22Z

/csr JDK-8295329

openjdk · 2023-01-30T07:10:38Z

@prsadhuk usage: /csr [needed|unneeded], requires that the issue the pull request refers to links to an approved CSR request.

prsadhuk · 2023-01-30T07:19:48Z

/csr unneeded

openjdk · 2023-01-30T07:20:19Z

@prsadhuk determined that a CSR request is not needed for this pull request.

openjdk · 2023-01-30T07:21:19Z

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

6187113: DefaultListSelectionModel.removeIndexInterval(0, Integer.MAX_VALUE) fails

Co-authored-by: Alexey Ivanov <aivanov@openjdk.org>
Reviewed-by: aivanov

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 no new commits pushed to the master branch. If another commit should be pushed before you perform the /integrate command, your PR will be automatically rebased. If you prefer to avoid any potential 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.

prsadhuk · 2023-01-30T07:21:58Z

/csr needed

openjdk · 2023-01-30T07:22:59Z

@prsadhuk has indicated that a compatibility and specification (CSR) request is needed for this pull request.

@prsadhuk please create a CSR request for issue JDK-6187113 with the correct fix version. This pull request cannot be integrated until the CSR request is approved.

…87113

prsadhuk · 2023-01-30T07:33:29Z

/integrate

openjdk · 2023-01-30T07:35:25Z

Going to push as commit c2ebd17.

openjdk · 2023-01-30T07:35:36Z

@prsadhuk Pushed as commit c2ebd17.

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

6187113: DefaultListSelectionModel.removeIndexInterval(0, Integer.MAX…

d772668

…_VALUE) fails

openjdk bot added the client client-libs-dev@openjdk.org label Sep 23, 2022

Test fix

94fdf90

openjdk bot added the rfr Pull request is ready for review label Sep 23, 2022

honkar-jdk suggested changes Sep 27, 2022

View reviewed changes

test/jdk/javax/swing/TestDefListModelExcpn.java Outdated Show resolved Hide resolved

aivanov-jdk suggested changes Sep 28, 2022

View reviewed changes

prsadhuk added 2 commits October 7, 2022 09:45

Take care of integer overflow in setSelectionInterval

391c525

Test fix

e42f2af

openjdk bot removed the rfr Pull request is ready for review label Oct 7, 2022

test fix

b70c6ad

openjdk bot added the rfr Pull request is ready for review label Oct 7, 2022

prsadhuk added 2 commits October 12, 2022 05:16

Review comment to exclude MAX_VALUE

23d5922

javadoc update

ee43bd8

openjdk bot added the csr Pull request needs approved CSR before integration label Oct 14, 2022

aivanov-jdk suggested changes Oct 14, 2022

View reviewed changes

insertIndexInterval fix. Add more subtests

0c4b284

aivanov-jdk suggested changes Oct 18, 2022

View reviewed changes

removeIndexInterval, insertIndexInterval fix

ee02dc4

aivanov-jdk suggested changes Oct 21, 2022

View reviewed changes

Review comment fix

89b9e86

aivanov-jdk suggested changes Oct 26, 2022

View reviewed changes

prsadhuk added 2 commits October 28, 2022 04:27

Review fix

0f1a943

Review fix

fce8c56

Update copyright year

da05d20

openjdk bot removed the csr Pull request needs approved CSR before integration label Jan 30, 2023

openjdk bot added the ready Pull request is ready to be integrated label Jan 30, 2023

openjdk bot added the csr Pull request needs approved CSR before integration label Jan 30, 2023

openjdk bot removed the ready Pull request is ready to be integrated label Jan 30, 2023

Merge branch 'master' of https://git.openjdk.java.net/jdk into JDK-61…

eb99ea3

…87113

openjdk bot added ready Pull request is ready to be integrated and removed csr Pull request needs approved CSR before integration labels Jan 30, 2023

openjdk bot added the integrated Pull request has been integrated label Jan 30, 2023

openjdk bot closed this Jan 30, 2023

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

prsadhuk deleted the JDK-6187113 branch June 14, 2023 12:48

		selectionModel.setSelectionInterval(Integer.MAX_VALUE - 1, Integer.MAX_VALUE);
		selectionModel.insertIndexInterval(Integer.MAX_VALUE - 1, Integer.MAX_VALUE, true);

		boolean setInsertedValues = ((getSelectionMode() == SINGLE_SELECTION) ?
		false : value.get(index));

6187113: DefaultListSelectionModel.removeIndexInterval(0, Integer.MAX_VALUE) fails #10409

6187113: DefaultListSelectionModel.removeIndexInterval(0, Integer.MAX_VALUE) fails #10409

Conversation

prsadhuk commented Sep 23, 2022 • edited by openjdk bot

Progress

Issues

Reviewers

Contributors

Reviewing

bridgekeeper bot commented Sep 23, 2022

openjdk bot commented Sep 23, 2022

mlbridge bot commented Sep 23, 2022 • edited

Webrevs

prsadhuk commented Oct 14, 2022

aivanov-jdk left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aivanov-jdk commented Oct 14, 2022

prsadhuk commented Oct 18, 2022

aivanov-jdk left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aivanov-jdk left a comment

Choose a reason for hiding this comment

aivanov-jdk Oct 26, 2022 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aivanov-jdk commented Oct 26, 2022

aivanov-jdk commented Nov 29, 2022

bridgekeeper bot commented Dec 27, 2022

aivanov-jdk commented Jan 19, 2023

prsadhuk commented Jan 30, 2023

openjdk bot commented Jan 30, 2023

prsadhuk commented Jan 30, 2023

openjdk bot commented Jan 30, 2023

prsadhuk commented Jan 30, 2023

openjdk bot commented Jan 30, 2023

prsadhuk commented Jan 30, 2023

openjdk bot commented Jan 30, 2023

openjdk bot commented Jan 30, 2023 • edited

prsadhuk commented Jan 30, 2023

openjdk bot commented Jan 30, 2023

prsadhuk commented Jan 30, 2023

openjdk bot commented Jan 30, 2023

openjdk bot commented Jan 30, 2023

prsadhuk commented Sep 23, 2022 •

edited by openjdk bot

mlbridge bot commented Sep 23, 2022 •

edited

aivanov-jdk Oct 26, 2022 •

edited

openjdk bot commented Jan 30, 2023 •

edited