-
Notifications
You must be signed in to change notification settings - Fork 614
[GLUTEN-12225][CORE] Fix arrow.c shading: exclude memory/vector packages so public API stays unshaded #12226
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
sezruby
wants to merge
2
commits into
apache:main
Choose a base branch
from
sezruby:fix/arrow-c-shading-mismatch
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+131
−1
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,89 @@ | ||
| #!/usr/bin/env bash | ||
| # Licensed to the Apache Software Foundation (ASF) under one or more | ||
| # contributor license agreements. See the NOTICE file distributed with | ||
| # this work for additional information regarding copyright ownership. | ||
| # The ASF licenses this file to You under the Apache License, Version 2.0 | ||
| # (the "License"); you may not use this file except in compliance with | ||
| # the License. You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
| # | ||
| # Verify the bundled gluten-velox jar's Arrow C-Data classes have method | ||
| # signatures referencing the *unshaded* org.apache.arrow.memory.BufferAllocator | ||
| # and org.apache.arrow.vector.* types — not the gluten-shaded copies. | ||
| # | ||
| # Background: org.apache.arrow.c.* must NOT be relocated (its native JNI binds | ||
| # to the original class names), but its public API methods accept/return | ||
| # org.apache.arrow.memory.* and org.apache.arrow.vector.* types. Those types | ||
| # must therefore also stay unshaded in the bundle, otherwise the bundled | ||
| # ArrowArrayStream/ArrowSchema get re-bound to the shaded BufferAllocator at | ||
| # compile time and any caller passing a vanilla Apache Arrow allocator hits | ||
| # `NoSuchMethodError`. See gluten#12225. | ||
| # | ||
| # Usage: | ||
| # dev/check-arrow-c-shading.sh <path-to-gluten-velox-bundle.jar> | ||
| # | ||
| # Exit codes: | ||
| # 0 — bundle is well-shaded (Arrow C-Data API uses public Apache Arrow types) | ||
| # 1 — bundle is broken (Arrow C-Data API references gluten-shaded types) | ||
| # 2 — usage / setup error | ||
|
|
||
| set -euo pipefail | ||
|
|
||
| JAR="${1:?usage: $0 <path-to-gluten-velox-bundle.jar>}" | ||
| if [[ ! -f "$JAR" ]]; then | ||
| echo "error: jar not found: $JAR" >&2 | ||
| exit 2 | ||
| fi | ||
|
|
||
| if ! command -v javap >/dev/null; then | ||
| echo "error: javap not found on PATH" >&2 | ||
| exit 2 | ||
| fi | ||
|
|
||
| WORKDIR=$(mktemp -d) | ||
| trap 'rm -rf "$WORKDIR"' EXIT | ||
|
|
||
| # Classes whose public API touches the unshaded boundary. | ||
| CLASSES=( | ||
| "org/apache/arrow/c/ArrowArrayStream" | ||
| "org/apache/arrow/c/ArrowSchema" | ||
| "org/apache/arrow/c/ArrowArray" | ||
| "org/apache/arrow/c/Data" | ||
| ) | ||
|
|
||
| failures=0 | ||
| for cls in "${CLASSES[@]}"; do | ||
| if ! unzip -p "$JAR" "${cls}.class" > "$WORKDIR/$(basename "$cls").class" 2>/dev/null; then | ||
| echo " SKIP $cls (not in bundle)" | ||
| continue | ||
| fi | ||
| signatures=$(javap -p "$WORKDIR/$(basename "$cls").class" 2>/dev/null || true) | ||
| # Any method signature mentioning the gluten-shaded Arrow path is the bug. | ||
| bad=$(echo "$signatures" | grep -E "org\.apache\.gluten\.shaded\.org\.apache\.arrow\.(memory|vector)\." || true) | ||
| if [[ -n "$bad" ]]; then | ||
| echo " FAIL $cls — public API references gluten-shaded Arrow types:" | ||
| echo "$bad" | sed 's/^/ /' | ||
| failures=$((failures + 1)) | ||
| else | ||
| echo " OK $cls" | ||
| fi | ||
| done | ||
|
|
||
| if (( failures > 0 )); then | ||
| echo | ||
| echo "Bundle has $failures Arrow C-Data class(es) with shaded API types." | ||
| echo "See gluten#12225 for context. Update package/pom.xml's" | ||
| echo "<relocation org.apache.arrow> excludes to also exclude" | ||
| echo "org.apache.arrow.memory.** and org.apache.arrow.vector.**." | ||
| exit 1 | ||
| fi | ||
|
|
||
| echo | ||
| echo "All Arrow C-Data classes use unshaded public Apache Arrow API. ✓" |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: Should we directly exclude all arrow packages? E.g.,
org.apache.arrow.*There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The full org.apache.arrow.* exclusion would lose gluten's isolation from the user's Arrow version everywhere, not just on the C-Data boundary. The C-Data classes have to be unshaded because their JNI native lib hardcodes the original class names; arrow.memory.* and arrow.vector.* follow because they appear in arrow.c.* public method signatures. Anything else under org.apache.arrow.* (flight, algorithm, adapter, etc.) is internal to gluten's columnar batch handling and safer to keep shaded so it doesn't conflict with user Arrow. The narrow exclusion is the minimum that makes the public C-Data API self-consistent without giving up isolation elsewhere.