You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@spark.apache.org by "aknayar (via GitHub)" <gi...@apache.org> on 2026/04/22 08:46:10 UTC
[PR] [SPARK-56567] Fix array_insert `Int.MinValue` pos overflow [spark]
aknayar opened a new pull request, #55476:
URL: https://github.com/apache/spark/pull/55476
<!--
Thanks for sending a pull request! Here are some tips for you:
1. If this is your first time, please read our contributor guidelines: https://spark.apache.org/contributing.html
2. Ensure you have added or run the appropriate tests for your PR: https://spark.apache.org/developer-tools.html
3. If the PR is unfinished, add '[WIP]' in your PR title, e.g., '[WIP][SPARK-XXXX] Your PR title ...'.
4. Be sure to keep the PR description updated to reflect all changes.
5. Please write your PR title to summarize what this PR proposes.
6. If possible, provide a concise example to reproduce the issue for a faster review.
7. If you want to add a new configuration, please read the guideline first for naming configurations in
'core/src/main/scala/org/apache/spark/internal/config/ConfigEntry.scala'.
8. If you want to add or modify an error type or message, please read the guideline first in
'common/utils/src/main/resources/error/README.md'.
-->
### What changes were proposed in this pull request?
<!--
Please clarify what changes you are proposing. The purpose of this section is to outline the changes and how this PR fixes the issue.
If possible, please consider writing useful notes for better and faster reviews in your PR. See the examples below.
1. If you refactor some codes with changing classes, showing the class hierarchy will help reviewers.
2. If you fix some SQL features, you can provide some references of other DBMSes.
3. If there is design documentation, please add the link.
4. If there is a discussion in the mailing list, please add the link.
-->
This PR fixes `array_insert` to raise the documented `COLLECTION_SIZE_LIMIT_EXCEEDED.FUNCTION` error when called with `pos = Int.MinValue`, instead of leaking an internal JVM exception. Below is a minimalistic repro for the bug:
```
from pyspark.sql import SparkSession
spark = SparkSession.builder.appName("ArrayInsertIntMinTest").getOrCreate()
def run(query):
print(query)
try:
spark.sql(query).show()
except Exception as e:
print(f"> {type(e).__name__}: {str(e).splitlines()[0]}")
print()
print("Correctly throws COLLECTION_SIZE_LIMIT_EXCEEDED.FUNCTION")
run("SELECT array_insert(array(1), -2147483647, 3)")
print("Incorrectly throws ArrayIndexOutOfBoundsException")
run("SELECT array_insert(array(1), -2147483648, 3)")
spark.stop()
```
`array_insert` should raise `SparkRuntimeException` with condition `COLLECTION_SIZE_LIMIT_EXCEEDED.FUNCTION` here. However, it instead crashes with an internal JVM exception: `java.lang.AssertionError` from `UnsafeArrayData.setInt(-2147483646, ...)` under whole-stage codegen, or `java.lang.ArrayIndexOutOfBoundsException: Index -2147483646 out of bounds for length 2` in interpreted mode. This is because `ArrayInsert` does `int` arithmetic on `pos` (e.g. `-pos`, `java.lang.Math.abs(pos)`), which silently wraps back to `Int.MinValue`. The `newPosExtendsArrayLeft` check therefore returns the wrong answer, the code takes the wrong branch, never reaches the `MAX_ROUNDED_ARRAY_LENGTH` guard, and computes a garbage index that crashes later.
The fix is to widen `pos` arithmetic to `Long` in both `ArrayInsert.nullSafeEval` (interpreted) and `ArrayInsert.doGenCode` (codegen). The existing `MAX_ROUNDED_ARRAY_LENGTH` check then correctly catches the oversized result on the right branch.
### Why are the changes needed?
<!--
Please clarify why the changes are needed. For instance,
1. If you propose a new API, clarify the use case for a new API.
2. If you fix a bug, you can clarify why it is a bug.
-->
There is currently an error-reporting bug. `array_insert(arr, Int.MinValue, item)` fails with an internal JVM exception (`AssertionError` or `ArrayIndexOutOfBoundsException`) instead of the documented `COLLECTION_SIZE_LIMIT_EXCEEDED.FUNCTION` error.
### Does this PR introduce _any_ user-facing change?
<!--
Note that it means *any* user-facing change including all aspects such as new features, bug fixes, or other behavior changes. Documentation-only updates are not considered user-facing changes.
If yes, please clarify the previous behavior and the change this PR proposes - provide the console output, description and/or an example to show the behavior difference if possible.
If possible, please also clarify if this is a user-facing change compared to the released Spark versions or within the unreleased branches such as master.
If no, write 'No'.
-->
Yes, for `pos = Int.MinValue` with a non-empty input array, `array_insert` now throws `SparkRuntimeException` with condition `COLLECTION_SIZE_LIMIT_EXCEEDED.FUNCTION` instead of leaking an internal `AssertionError` / `ArrayIndexOutOfBoundsException`. This matches the behavior already in place for neighboring positions like `Int.MinValue + 1`.
### How was this patch tested?
<!--
If tests were added, s ay they were added here. Please make sure to add some test cases that check the changes thoroughly including negative and positive cases if possible.
If it was tested in a way different from regular unit tests, please clarify how you tested step by step, ideally copy and paste-able, so that other reviewers can test and check, and descendants can verify in the future.
If tests were not added, please describe why they were not added and/or why it was difficult to add.
If benchmark tests were added, please run the benchmarks in GitHub Actions for the consistent environment, and the instructions could accord to: https://spark.apache.org/developer-tools.html#github-workflow-benchmarks.
-->
Added unit tests to `CollectionExpressionsSuite` to validate correct error reporting when `pos = Int.MinValue`.
### Was this patch authored or co-authored using generative AI tooling?
<!--
If generative AI tooling has been used in the process of authoring this patch, please include the
phrase: 'Generated-by: ' followed by the name of the tool and its version.
If no, write 'No'.
Please refer to the [ASF Generative Tooling Guidance](https://www.apache.org/legal/generative-tooling.html) for details.
-->
Generated-by: claude-4.7-opus-high
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
Re: [PR] [SPARK-56567][SQL] Fix array_insert `Int.MinValue` pos overflow [spark]
Posted by "dongjoon-hyun (via GitHub)" <gi...@apache.org>.
dongjoon-hyun commented on code in PR #55476:
URL: https://github.com/apache/spark/pull/55476#discussion_r3126684490
##########
sql/catalyst/src/main/scala/org/apache/spark/sql/catalyst/expressions/collectionOperations.scala:
##########
Review Comment:
Hmm. Maybe, it's related to the previous Wenchen's comment, but it's a little counter-intuitive to use `$pos` again from here. If it's for `looping` variable arithmetic, it would be great to add a one-line comment about why we need to use `$pos` instead of `posLong`.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
Re: [PR] [SPARK-56567] Fix array_insert `Int.MinValue` pos overflow [spark]
Posted by "aknayar (via GitHub)" <gi...@apache.org>.
aknayar commented on code in PR #55476:
URL: https://github.com/apache/spark/pull/55476#discussion_r3125733763
##########
sql/catalyst/src/main/scala/org/apache/spark/sql/catalyst/expressions/collectionOperations.scala:
##########
@@ -5238,34 +5241,42 @@ case class ArrayInsert(
} else {
val pos = posExpr.value
val baseOffset = if (legacyNegativeIndex) 1 else 0
+ // Widen `pos` arithmetic to long so that `Int.MIN_VALUE` doesn't silently overflow
+ // (e.g. `Math.abs(Int.MIN_VALUE)` returns `Int.MIN_VALUE`).
+ val posLong = ctx.freshName("posLong")
+ val resLengthLong = ctx.freshName("resLengthLong")
s"""
+ |long $posLong = (long) $pos;
|int $itemInsertionIndex = 0;
|int $resLength = 0;
|int $adjustedAllocIdx = 0;
|boolean $insertedItemIsNull = ${itemExpr.isNull};
|
- |if ($pos == 0) {
+ |if ($posLong == 0L) {
| throw QueryExecutionErrors.invalidIndexOfZeroError($errorContext);
|}
|
- |if ($pos < 0 && (java.lang.Math.abs($pos) > $arr.numElements())) {
+ |if ($posLong < 0L && (-$posLong > $arr.numElements())) {
|
- | $resLength = java.lang.Math.abs($pos) + $baseOffset;
- | if ($resLength > ${ByteArrayMethods.MAX_ROUNDED_ARRAY_LENGTH}) {
+ | long $resLengthLong = -$posLong + ${baseOffset}L;
+ | if ($resLengthLong > ${ByteArrayMethods.MAX_ROUNDED_ARRAY_LENGTH}) {
| throw QueryExecutionErrors.arrayFunctionWithElementsExceedLimitError(
- | "$prettyName", $resLength);
+ | "$prettyName", $resLengthLong);
| }
+ | $resLength = (int) $resLengthLong;
|
| $allocation
| for (int $i = 0; $i < $arr.numElements(); $i ++) {
- | $adjustedAllocIdx = $i + $baseOffset + java.lang.Math.abs($pos + $arr.numElements());
+ | $adjustedAllocIdx =
+ | $i + $baseOffset + (int) java.lang.Math.abs($posLong + $arr.numElements());
| $assignment
| }
| ${CodeGenerator.setArrayElement(
values, elementType, itemInsertionIndex, item, Some(insertedItemIsNull))}
|
| for (int $j = ${if (legacyNegativeIndex) 0 else 1} + $pos + $arr.numElements(); $j < 0; $j ++) {
Review Comment:
Fixed, thanks! `pos` is validated by this point so I can just use it from line 5263 onward.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
Re: [PR] [SPARK-56567][SQL] Fix array_insert `Int.MinValue` pos overflow [spark]
Posted by "cloud-fan (via GitHub)" <gi...@apache.org>.
cloud-fan commented on PR #55476:
URL: https://github.com/apache/spark/pull/55476#issuecomment-4302456844
thanks, merging to master!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
Re: [PR] [SPARK-56567][SQL] Fix array_insert `Int.MinValue` pos overflow [spark]
Posted by "dongjoon-hyun (via GitHub)" <gi...@apache.org>.
dongjoon-hyun commented on code in PR #55476:
URL: https://github.com/apache/spark/pull/55476#discussion_r3126674138
##########
sql/catalyst/src/main/scala/org/apache/spark/sql/catalyst/expressions/collectionOperations.scala:
##########
Review Comment:
~Why do we still use `$pos` here instead of `$posLong`, @aknayar ?~
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
Re: [PR] [SPARK-56567][SQL] Fix array_insert `Int.MinValue` pos overflow [spark]
Posted by "dongjoon-hyun (via GitHub)" <gi...@apache.org>.
dongjoon-hyun commented on code in PR #55476:
URL: https://github.com/apache/spark/pull/55476#discussion_r3126684490
##########
sql/catalyst/src/main/scala/org/apache/spark/sql/catalyst/expressions/collectionOperations.scala:
##########
Review Comment:
~Hmm. Maybe, it's related to the previous Wenchen's comment, but it's a little counter-intuitive to use `$pos` again from here. If it's for `looping` variable arithmetic, it would be great to add a one-line comment about why we need to use `$pos` instead of `posLong`.~
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
Re: [PR] [SPARK-56567][SQL] Fix array_insert `Int.MinValue` pos overflow [spark]
Posted by "dongjoon-hyun (via GitHub)" <gi...@apache.org>.
dongjoon-hyun commented on code in PR #55476:
URL: https://github.com/apache/spark/pull/55476#discussion_r3126674138
##########
sql/catalyst/src/main/scala/org/apache/spark/sql/catalyst/expressions/collectionOperations.scala:
##########
Review Comment:
Why do we still use `$pos` here instead of `$posLong`, @aknayar ?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
Re: [PR] [SPARK-56567][SQL] Fix array_insert `Int.MinValue` pos overflow [spark]
Posted by "dongjoon-hyun (via GitHub)" <gi...@apache.org>.
dongjoon-hyun commented on code in PR #55476:
URL: https://github.com/apache/spark/pull/55476#discussion_r3126726920
##########
sql/catalyst/src/main/scala/org/apache/spark/sql/catalyst/expressions/collectionOperations.scala:
##########
@@ -5238,23 +5241,29 @@ case class ArrayInsert(
} else {
val pos = posExpr.value
val baseOffset = if (legacyNegativeIndex) 1 else 0
+ // Widen `pos` arithmetic to long so that `Int.MIN_VALUE` doesn't silently overflow
+ // (e.g. `Math.abs(Int.MIN_VALUE)` returns `Int.MIN_VALUE`).
+ val posLong = ctx.freshName("posLong")
+ val resLengthLong = ctx.freshName("resLengthLong")
s"""
+ |long $posLong = (long) $pos;
|int $itemInsertionIndex = 0;
|int $resLength = 0;
|int $adjustedAllocIdx = 0;
|boolean $insertedItemIsNull = ${itemExpr.isNull};
|
- |if ($pos == 0) {
+ |if ($posLong == 0L) {
| throw QueryExecutionErrors.invalidIndexOfZeroError($errorContext);
|}
|
- |if ($pos < 0 && (java.lang.Math.abs($pos) > $arr.numElements())) {
+ |if ($posLong < 0L && (-$posLong > $arr.numElements())) {
|
- | $resLength = java.lang.Math.abs($pos) + $baseOffset;
- | if ($resLength > ${ByteArrayMethods.MAX_ROUNDED_ARRAY_LENGTH}) {
+ | long $resLengthLong = -$posLong + ${baseOffset}L;
+ | if ($resLengthLong > ${ByteArrayMethods.MAX_ROUNDED_ARRAY_LENGTH}) {
| throw QueryExecutionErrors.arrayFunctionWithElementsExceedLimitError(
- | "$prettyName", $resLength);
+ | "$prettyName", $resLengthLong);
| }
+ | $resLength = (int) $resLengthLong;
Review Comment:
Got it. Please ignore my previous comment about `pos` and `posLong`. I realized that this PR only needs `posLong` and `resLengthLong` until here. It makes sense to me.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
Re: [PR] [SPARK-56567][SQL] Fix array_insert `Int.MinValue` pos overflow [spark]
Posted by "dongjoon-hyun (via GitHub)" <gi...@apache.org>.
dongjoon-hyun commented on code in PR #55476:
URL: https://github.com/apache/spark/pull/55476#discussion_r3126695640
##########
sql/catalyst/src/main/scala/org/apache/spark/sql/catalyst/expressions/collectionOperations.scala:
##########
@@ -5238,23 +5241,29 @@ case class ArrayInsert(
} else {
val pos = posExpr.value
val baseOffset = if (legacyNegativeIndex) 1 else 0
Review Comment:
This looks inconsistent to me because this PR changed like the following in other code path.
```
val baseOffset: Long = if (legacyNegativeIndex) 1L else 0L
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
Re: [PR] [SPARK-56567][SQL] Fix array_insert `Int.MinValue` pos overflow [spark]
Posted by "dongjoon-hyun (via GitHub)" <gi...@apache.org>.
dongjoon-hyun commented on code in PR #55476:
URL: https://github.com/apache/spark/pull/55476#discussion_r3126695640
##########
sql/catalyst/src/main/scala/org/apache/spark/sql/catalyst/expressions/collectionOperations.scala:
##########
@@ -5238,23 +5241,29 @@ case class ArrayInsert(
} else {
val pos = posExpr.value
val baseOffset = if (legacyNegativeIndex) 1 else 0
Review Comment:
~This looks inconsistent to me because this PR changed like the following in other code path.~
```
val baseOffset: Long = if (legacyNegativeIndex) 1L else 0L
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
Re: [PR] [SPARK-56567] Fix array_insert `Int.MinValue` pos overflow [spark]
Posted by "cloud-fan (via GitHub)" <gi...@apache.org>.
cloud-fan commented on code in PR #55476:
URL: https://github.com/apache/spark/pull/55476#discussion_r3123990197
##########
sql/catalyst/src/main/scala/org/apache/spark/sql/catalyst/expressions/collectionOperations.scala:
##########
@@ -5238,34 +5241,42 @@ case class ArrayInsert(
} else {
val pos = posExpr.value
val baseOffset = if (legacyNegativeIndex) 1 else 0
+ // Widen `pos` arithmetic to long so that `Int.MIN_VALUE` doesn't silently overflow
+ // (e.g. `Math.abs(Int.MIN_VALUE)` returns `Int.MIN_VALUE`).
+ val posLong = ctx.freshName("posLong")
+ val resLengthLong = ctx.freshName("resLengthLong")
s"""
+ |long $posLong = (long) $pos;
|int $itemInsertionIndex = 0;
|int $resLength = 0;
|int $adjustedAllocIdx = 0;
|boolean $insertedItemIsNull = ${itemExpr.isNull};
|
- |if ($pos == 0) {
+ |if ($posLong == 0L) {
| throw QueryExecutionErrors.invalidIndexOfZeroError($errorContext);
|}
|
- |if ($pos < 0 && (java.lang.Math.abs($pos) > $arr.numElements())) {
+ |if ($posLong < 0L && (-$posLong > $arr.numElements())) {
|
- | $resLength = java.lang.Math.abs($pos) + $baseOffset;
- | if ($resLength > ${ByteArrayMethods.MAX_ROUNDED_ARRAY_LENGTH}) {
+ | long $resLengthLong = -$posLong + ${baseOffset}L;
+ | if ($resLengthLong > ${ByteArrayMethods.MAX_ROUNDED_ARRAY_LENGTH}) {
| throw QueryExecutionErrors.arrayFunctionWithElementsExceedLimitError(
- | "$prettyName", $resLength);
+ | "$prettyName", $resLengthLong);
| }
+ | $resLength = (int) $resLengthLong;
|
| $allocation
| for (int $i = 0; $i < $arr.numElements(); $i ++) {
- | $adjustedAllocIdx = $i + $baseOffset + java.lang.Math.abs($pos + $arr.numElements());
+ | $adjustedAllocIdx =
+ | $i + $baseOffset + (int) java.lang.Math.abs($posLong + $arr.numElements());
| $assignment
| }
| ${CodeGenerator.setArrayElement(
values, elementType, itemInsertionIndex, item, Some(insertedItemIsNull))}
|
| for (int $j = ${if (legacyNegativeIndex) 0 else 1} + $pos + $arr.numElements(); $j < 0; $j ++) {
Review Comment:
Nit: the loop init here still uses `$pos` while the `Math.abs($posLong + ...)` one line below uses `$posLong`. It's safe — by the time this loop runs, the `resLengthLong` check has forced `posLong > Int.MinValue`, and `$pos + $arr.numElements()` with `$pos < 0` and `$arr.numElements() >= 0` can't overflow — but the mixed int/long usage within the same branch is a bit surprising. Worth widening to `$posLong` here too for consistency?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
Re: [PR] [SPARK-56567][SQL] Fix array_insert `Int.MinValue` pos overflow [spark]
Posted by "cloud-fan (via GitHub)" <gi...@apache.org>.
cloud-fan closed pull request #55476: [SPARK-56567][SQL] Fix array_insert `Int.MinValue` pos overflow
URL: https://github.com/apache/spark/pull/55476
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org