Skip to content

HIVE-29598: Fix vectorized outer join wrong results due to stale scratch column values#6486

Open
ryukobayashi wants to merge 1 commit into
apache:masterfrom
ryukobayashi:HIVE-29598
Open

HIVE-29598: Fix vectorized outer join wrong results due to stale scratch column values#6486
ryukobayashi wants to merge 1 commit into
apache:masterfrom
ryukobayashi:HIVE-29598

Conversation

@ryukobayashi
Copy link
Copy Markdown
Contributor

What changes were proposed in this pull request?

In vectorized outer join, generateOuterNulls() and generateOuterNullsRepeatedAll() set isNull[i] = true on scratch columns but leave vector[i] untouched. When hive.vectorized.reuse.scratch.columns=true (the default), a scratch column slot
freed after an expression evaluation (e.g. CastStringToLong) can be reused for the outer join's null-marking column. After reset() clears isNull[], the expression overwrites vector[i] with a fresh value (e.g. 2025). Later, generateOuterNulls()
sets isNull[i] = true without clearing vector[i], leaving a stale non-zero value.

Downstream operators such as ColOrCol read vector[i] directly to distinguish "false" (== 0) from "null" (!= 0). The stale value causes null rows to be misinterpreted as "true", producing wrong OR/AND/CASE WHEN results.

The fix adds clearVectorValue(), called whenever isNull[i] is set to true in the outer join null-marking paths, zeroing vector[i] for all supported column vector types (LongColumnVector, DoubleColumnVector, BytesColumnVector,
TimestampColumnVector, IntervalDayTimeColumnVector).

Why are the changes needed?

Without the fix, vectorized outer joins silently return wrong results when scratch column reuse is enabled (the default). The bug is non-obvious because it only triggers when a specific combination of conditions is met: a type-casting expression allocates a scratch column that is later reused for the outer join's null-marking column, and the join result is consumed by a boolean operator that reads the raw vector value for null discrimination. Users have no indication that results are wrong; workarounds require disabling vectorization entirely (hive.vectorization.enabled=false) or disabling scratch column reuse (hive.vectorized.reuse.scratch.columns=false), both of which carry a significant performance cost.

Does this PR introduce any user-facing change?

No

How was this patch tested?

The existing TestMapJoinOperator suite (17 tests) passes without regression. The bug can also be verified manually with the minimal SQL reproducer below; with the fix applied, the result matches the expected output (C 2026 new, D 2026 new) that was previously only obtainable by disabling vectorization.

  CREATE TABLE src (k STRING, v STRING);
  INSERT INTO src VALUES
    ('p','1'),('p','2'),('p','3'),
    ('q','2'),('q','3'),
    ('r','3'),
    ('s','3');

  WITH base AS (
    SELECT k, v FROM src GROUP BY k, v
  ),
  classified AS (
    SELECT t1.k, t1.v,
           CASE WHEN COALESCE(t2.k,'') = '' THEN 'new'
                WHEN COALESCE(t3.k,'') = '' THEN 'two_step'
                ELSE 'three_step' END AS status
    FROM base t1
    LEFT JOIN base t2
      ON  t1.k = t2.k
      AND CAST(t1.v AS INT) - 1 = CAST(t2.v AS INT)
    LEFT JOIN base t3
      ON  t1.k = t3.k
      AND CAST(t1.v AS INT) - 2 = CAST(t3.v AS INT)
    WHERE CAST(t1.v AS INT) >= 3
    GROUP BY t1.k, t1.v,
             CASE WHEN COALESCE(t2.k,'') = '' THEN 'new'
                  WHEN COALESCE(t3.k,'') = '' THEN 'two_step'
                  ELSE 'three_step' END
  )
  SELECT * FROM classified WHERE status = 'new';

@sonarqubecloud
Copy link
Copy Markdown

Copy link
Copy Markdown
Contributor

@soumyakanti3578 soumyakanti3578 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Vectorization code can be tricky and brittle. To ensure there are no unintended consequences of this change, could you please add some tests? A minimal reproducer as a qtest is essential, and unit tests for the vector clearing operation across different ColumnVector types would also be valuable.

Comment on lines +769 to +782
private static void clearVectorValue(ColumnVector colVector, int index) {
if (colVector instanceof LongColumnVector) {
((LongColumnVector) colVector).vector[index] = 0L;
} else if (colVector instanceof DoubleColumnVector) {
((DoubleColumnVector) colVector).vector[index] = 0.0;
} else if (colVector instanceof BytesColumnVector) {
BytesColumnVector bcv = (BytesColumnVector) colVector;
bcv.vector[index] = null;
bcv.start[index] = 0;
bcv.length[index] = 0;
} else if (colVector instanceof TimestampColumnVector) {
((TimestampColumnVector) colVector).setNullValue(index);
} else if (colVector instanceof IntervalDayTimeColumnVector) {
((IntervalDayTimeColumnVector) colVector).setNullValue(index);
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you please confirm that these are the only ColumnVectors that can appear in smallTableValueColumnMap and outerSmallTableKeyColumnMap?
Maybe we should do the same for all ColumnVector types, and it would be better to do this in the individual classes instead of handling it here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants