Change IOContext from READONCE to DEFAULT to avoid WrongThreadException by sachinpkale · Pull Request #17502 · opensearch-project/OpenSearch

sachinpkale · 2025-03-04T10:40:17Z

Description

As part of Update Apache Lucene to 9.12.0 #15333, read context in RemoteStoreRefreshListener is changed from DEFAULT to READONCE.
But this fails with java.lang.WrongThreadException: Attempted access outside owning thread.

Caused by: java.lang.WrongThreadException: Attempted access outside owning thread
                at java.base/jdk.internal.foreign.MemorySessionImpl.wrongThread(MemorySessionImpl.java:315) ~[?:?]
                at java.base/jdk.internal.misc.ScopedMemoryAccess$ScopedAccessError.newRuntimeException(ScopedMemoryAccess.java:113) ~[?:?]
                at java.base/jdk.internal.foreign.MemorySessionImpl.checkValidState(MemorySessionImpl.java:219) ~[?:?]
                at java.base/jdk.internal.foreign.ConfinedSession.justClose(ConfinedSession.java:83) ~[?:?]
                at java.base/jdk.internal.foreign.MemorySessionImpl.close(MemorySessionImpl.java:242) ~[?:?]
                at java.base/jdk.internal.foreign.MemorySessionImpl$1.close(MemorySessionImpl.java:88) ~[?:?]
                at org.apache.lucene.store.MemorySegmentIndexInput.close(MemorySegmentIndexInput.java:514) ~[lucene-core-9.12.1.jar:9.12.1 7a97a05a239d6fb9f1f347aa09bfa52e875be092 - 2024-12-09 16:47:48]
                at org.opensearch.common.blobstore.transfer.stream.OffsetRangeIndexInputStream$OffsetRangeRefCount.lambda$new$0(OffsetRangeIndexInputStream.java:157) ~[opensearch-2.19.1.jar:2.19.1]
                at org.opensearch.common.concurrent.RefCountedReleasable.closeInternal(RefCountedReleasable.java:49) ~[opensearch-2.19.1.jar:2.19.1]
                at org.opensearch.common.util.concurrent.AbstractRefCounted.decRef(AbstractRefCounted.java:78) ~[opensearch-common-2.19.1.jar:2.19.1]
                at org.opensearch.common.util.concurrent.RunOnce.run(RunOnce.java:55) ~[opensearch-2.19.1.jar:2.19.1]
                at org.opensearch.common.blobstore.transfer.stream.OffsetRangeIndexInputStream.close(OffsetRangeIndexInputStream.java:167) ~[opensearch-2.19.1.jar:2.19.1]
                at org.opensearch.common.blobstore.transfer.stream.RateLimitingOffsetRangeInputStream.close(RateLimitingOffsetRangeInputStream.java:86) ~[opensearch-2.19.1.jar:2.19.1]
                at java.base/java.io.BufferedInputStream.close(BufferedInputStream.java:618) ~[?:?]
                at org.opensearch.repositories.s3.async.AsyncPartsHandler$UploadTrackedBufferedInputStream.close(AsyncPartsHandler.java:204) ~[repository-s3-2.19.1.jar:2.19.1]
                at org.opensearch.repositories.s3.async.AsyncTransferManager.releaseResourcesSafely(AsyncTransferManager.java:446) ~[repository-s3-2.19.1.jar:2.19.1]
                at org.opensearch.repositories.s3.async.AsyncTransferManager.lambda$uploadInOneChunk$19(AsyncTransferManager.java:403) [repository-s3-2.19.1.jar:2.19.1]
                at java.base/java.util.concurrent.CompletableFuture.uniHandle(CompletableFuture.java:934) ~[?:?]
                ... 49 more

This is due to the async flow of repository-s3 where IndexInput is getting close in the following code flow.

OpenSearch/server/src/main/java/org/opensearch/common/blobstore/transfer/stream/OffsetRangeIndexInputStream.java

Lines 149 to 162 in f6d6aa6

    
           public OffsetRangeRefCount(ClosingStreams ref) { 
        
               super("OffsetRangeRefCount", ref, () -> { 
        
                   try { 
        
                       ref.inputStreamIndexInput.close(); 
        
                   } catch (IOException ex) { 
        
                       logger.error("Failed to close indexStreamIndexInput", ex); 
        
                   } 
        
                   try { 
        
                       ref.indexInput.close(); 
        
                   } catch (IOException ex) { 
        
                       logger.error("Failed to close indexInput", ex); 
        
                   } 
        
               }); 
        
           }

Remote store integ tests use FsRepository but as the implementation changes for repository-s3, ideally we need to integ tests that talk directly to s3. We will take this up as a follow-up task.

Related Issues

[BUG] Segment-based replication / Remote Store is not compatible with Lucene 9.12 / 10 #15902

Check List

Functionality includes testing.
API changes companion pull request created, if applicable.
Public documentation issue/PR created, if applicable.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Signed-off-by: Sachin Kale <sachinpkale@gmail.com>

sachinpkale · 2025-03-04T10:46:32Z

Created an issue to run remote store integ tests with different repository plugin implementations: #17503

github-actions · 2025-03-04T11:36:24Z

❌ Gradle check result for 23319dd: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

sachinpkale · 2025-03-04T11:48:29Z

Test failing with:

1> java.lang.RuntimeException: MockDirectoryWrapper: opening segments file [segments_3n] with a non-READONCE context[IOContext[context=DEFAULT, mergeInfo=null, flushInfo=null, readAdvice=RANDOM]]

Taking a look

github-actions · 2025-03-04T12:14:04Z

❌ Gradle check result for 23319dd: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

sachinpkale · 2025-03-06T05:27:05Z

The following code in MockDirectoryWrapper is causing the test failures:

https://github.com/apache/lucene/blob/576c449cce64fa497cbc9000bb2c7600b3b7efe0/lucene/test-framework/src/java/org/apache/lucene/tests/store/MockDirectoryWrapper.java#L820-L827

Fixed the test failures as part of latest commit

github-actions · 2025-03-06T06:23:07Z

❕ Gradle check result for 553ef13: UNSTABLE

Please review all flaky tests that succeeded after retry and create an issue if one does not already exist to track the flaky failure.

Bukhtawar

Can we add an assertion on here on the IOContext to ensure all uploads have IOContext correctly set

Signed-off-by: Sachin Kale <sachinpkale@gmail.com>

github-actions · 2025-03-06T09:54:22Z

❌ Gradle check result for e762397: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

Signed-off-by: Sachin Kale <sachinpkale@gmail.com>

github-actions · 2025-03-06T10:49:11Z

❌ Gradle check result for c8904cd: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

github-actions · 2025-03-06T11:37:44Z

❌ Gradle check result for c8904cd: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

github-actions · 2025-03-06T13:19:09Z

❕ Gradle check result for c8904cd: UNSTABLE

Please review all flaky tests that succeeded after retry and create an issue if one does not already exist to track the flaky failure.

codecov · 2025-03-06T13:19:38Z

Codecov Report

Attention: Patch coverage is 50.00000% with 1 line in your changes missing coverage. Please review.

Project coverage is 72.57%. Comparing base (f6d6aa6) to head (c8904cd).
Report is 12 commits behind head on main.

Files with missing lines	Patch %	Lines
...va/org/opensearch/index/store/RemoteDirectory.java	0.00%	0 Missing and 1 partial ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##               main   #17502      +/-   ##
============================================
+ Coverage     72.47%   72.57%   +0.09%     
- Complexity    65705    65741      +36     
============================================
  Files          5307     5307              
  Lines        304774   304775       +1     
  Branches      44193    44193              
============================================
+ Hits         220898   221197     +299     
+ Misses        65738    65463     -275     
+ Partials      18138    18115      -23

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

opensearch-trigger-bot · 2025-03-07T05:59:29Z

The backport to 2.x failed:

The process '/usr/bin/git' failed with exit code 128

To backport manually, run these commands in your terminal:

# Navigate to the root of your repository
cd $(git rev-parse --show-toplevel)
# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/OpenSearch/backport-2.x 2.x
# Navigate to the new working tree
pushd ../.worktrees/OpenSearch/backport-2.x
# Create a new branch
git switch --create backport/backport-17502-to-2.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 588f46d731587bebd54511dc2df21a2f4ffb9f32
# Push it to GitHub
git push --set-upstream origin backport/backport-17502-to-2.x
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/OpenSearch/backport-2.x

Then, create a pull request where the base branch is 2.x and the compare/head branch is backport/backport-17502-to-2.x.

opensearch-trigger-bot · 2025-03-07T05:59:30Z

The backport to 2.19 failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Navigate to the root of your repository
cd $(git rev-parse --show-toplevel)
# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/OpenSearch/backport-2.19 2.19
# Navigate to the new working tree
pushd ../.worktrees/OpenSearch/backport-2.19
# Create a new branch
git switch --create backport/backport-17502-to-2.19
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 588f46d731587bebd54511dc2df21a2f4ffb9f32
# Push it to GitHub
git push --set-upstream origin backport/backport-17502-to-2.19
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/OpenSearch/backport-2.19

Then, create a pull request where the base branch is 2.19 and the compare/head branch is backport/backport-17502-to-2.19.

…on (opensearch-project#17502) --------- Signed-off-by: Sachin Kale <sachinpkale@gmail.com>

…on (#17502) (#17545) --------- Signed-off-by: Sachin Kale <sachinpkale@gmail.com>

…on (#17502) (#17544) --------- Signed-off-by: Sachin Kale <sachinpkale@gmail.com>

…on (opensearch-project#17502) --------- Signed-off-by: Sachin Kale <sachinpkale@gmail.com> Signed-off-by: Vinay Krishna Pudyodu <vinkrish.neo@gmail.com>

Change IOContext from READONCE to DEFAULT to avoid WrongThreadException

23319dd

Signed-off-by: Sachin Kale <sachinpkale@gmail.com>

sachinpkale requested review from Bukhtawar, CEHENKLE, Rishikesh1159, VachaShah, anasalkouz, andrross, ashking94, cwperks, dblock, dbwiddis, gbbafna, jed326, kotwanikunal, mch2, msfroh, nknize, owaiskazi19, reta, saratvemulapalli, shwetathareja and sohami as code owners March 4, 2025 10:40

sachinpkale added the skip-changelog label Mar 4, 2025

sachinpkale self-assigned this Mar 4, 2025

sachinpkale added the backport 2.x Backport to 2.x branch label Mar 4, 2025

ashking94 approved these changes Mar 4, 2025

View reviewed changes

sachinpkale requested review from jainankitk and linuxpi as code owners March 6, 2025 05:26

Bukhtawar reviewed Mar 6, 2025

View reviewed changes

Add assert in uploadBlob

e762397

Signed-off-by: Sachin Kale <sachinpkale@gmail.com>

Fix failing tests

c8904cd

Signed-off-by: Sachin Kale <sachinpkale@gmail.com>

Bukhtawar approved these changes Mar 7, 2025

View reviewed changes

sachinpkale merged commit 588f46d into opensearch-project:main Mar 7, 2025

opensearch-trigger-bot Bot added the backport-failed label Mar 7, 2025

sachinpkale added a commit to sachinpkale/OpenSearch that referenced this pull request Mar 7, 2025

Change IOContext from READONCE to DEFAULT to avoid WrongThreadExcepti…

c416354

…on (opensearch-project#17502) --------- Signed-off-by: Sachin Kale <sachinpkale@gmail.com>

sachinpkale mentioned this pull request Mar 7, 2025

Change IOContext from READONCE to DEFAULT to avoid WrongThreadException (#17502) #17544

Merged

sachinpkale added a commit to sachinpkale/OpenSearch that referenced this pull request Mar 7, 2025

Change IOContext from READONCE to DEFAULT to avoid WrongThreadExcepti…

fa7e7ad

…on (opensearch-project#17502) --------- Signed-off-by: Sachin Kale <sachinpkale@gmail.com>

sachinpkale mentioned this pull request Mar 7, 2025

Change IOContext from READONCE to DEFAULT to avoid WrongThreadException (#17502) #17545

Merged

sachinpkale added a commit that referenced this pull request Mar 7, 2025

Change IOContext from READONCE to DEFAULT to avoid WrongThreadExcepti…

e3a5d64

…on (#17502) (#17545) --------- Signed-off-by: Sachin Kale <sachinpkale@gmail.com>

opensearch-ci-bot mentioned this pull request Mar 7, 2025

[AUTOCUT] Gradle Check Flaky Test Report for DedicatedClusterSnapshotRestoreIT #15806

Open

sachinpkale added a commit that referenced this pull request Mar 10, 2025

Change IOContext from READONCE to DEFAULT to avoid WrongThreadExcepti…

cf525b2

…on (#17502) (#17544) --------- Signed-off-by: Sachin Kale <sachinpkale@gmail.com>

ankitkala mentioned this pull request Apr 2, 2025

[BUG] Cross cluster replication fails to allocate shard on follower cluster opensearch-project/cross-cluster-replication#1465

Closed

opensearch-ci-bot mentioned this pull request Apr 14, 2025

[AUTOCUT] Gradle Check Flaky Test Report for UpdateByQueryBasicTests #16439

Open

sachinpkale mentioned this pull request Apr 15, 2025

[BUG] Segment-based replication / Remote Store is not compatible with Lucene 9.12 / 10 #15902

Open

msfroh mentioned this pull request Jun 5, 2025

Don't force IOContext.READONCE for src file in RemoteDirectory's copyFrom #18450

Open

3 tasks

gbbafna mentioned this pull request Aug 13, 2025

Use of IOContext.DEFAULT leading to exhaustion of maps apache/lucene#15054

Closed

	public OffsetRangeRefCount(ClosingStreams ref) {
	super("OffsetRangeRefCount", ref, () -> {
	try {
	ref.inputStreamIndexInput.close();
	} catch (IOException ex) {
	logger.error("Failed to close indexStreamIndexInput", ex);
	}
	try {
	ref.indexInput.close();
	} catch (IOException ex) {
	logger.error("Failed to close indexInput", ex);
	}
	});
	}

Conversation

sachinpkale commented Mar 4, 2025

Description

Related Issues

Check List

Uh oh!

sachinpkale commented Mar 4, 2025

Uh oh!

github-actions Bot commented Mar 4, 2025

Uh oh!

sachinpkale commented Mar 4, 2025

Uh oh!

github-actions Bot commented Mar 4, 2025

Uh oh!

sachinpkale commented Mar 6, 2025

Uh oh!

github-actions Bot commented Mar 6, 2025

Uh oh!

Bukhtawar left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions Bot commented Mar 6, 2025

Uh oh!

github-actions Bot commented Mar 6, 2025

Uh oh!

github-actions Bot commented Mar 6, 2025

Uh oh!

github-actions Bot commented Mar 6, 2025

Uh oh!

codecov Bot commented Mar 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

opensearch-trigger-bot Bot commented Mar 7, 2025

Uh oh!

opensearch-trigger-bot Bot commented Mar 7, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

codecov Bot commented Mar 6, 2025 •

edited

Loading