-
Notifications
You must be signed in to change notification settings - Fork 147
GH-1067: Close cached HDFS FileSystem instances #1141
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
xborder
wants to merge
2
commits into
apache:main
Choose a base branch
from
xborder:gh-1067
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.
+261
−0
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
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
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 |
|---|---|---|
|
|
@@ -16,7 +16,11 @@ | |
| */ | ||
| package org.apache.arrow.dataset.file; | ||
|
|
||
| import java.lang.reflect.Method; | ||
| import java.net.URI; | ||
| import java.util.LinkedHashSet; | ||
| import java.util.Optional; | ||
| import java.util.Set; | ||
| import org.apache.arrow.dataset.jni.NativeDatasetFactory; | ||
| import org.apache.arrow.dataset.jni.NativeMemoryPool; | ||
| import org.apache.arrow.dataset.scanner.FragmentScanOptions; | ||
|
|
@@ -25,9 +29,12 @@ | |
| /** Java binding of the C++ FileSystemDatasetFactory. */ | ||
| public class FileSystemDatasetFactory extends NativeDatasetFactory { | ||
|
|
||
| private final Set<URI> hdfsFileSystems; | ||
|
|
||
| public FileSystemDatasetFactory( | ||
| BufferAllocator allocator, NativeMemoryPool memoryPool, FileFormat format, String uri) { | ||
| super(allocator, memoryPool, createNative(format, uri, Optional.empty())); | ||
| this.hdfsFileSystems = toHdfsFileSystems(uri); | ||
| } | ||
|
|
||
| public FileSystemDatasetFactory( | ||
|
|
@@ -37,11 +44,13 @@ public FileSystemDatasetFactory( | |
| String uri, | ||
| Optional<FragmentScanOptions> fragmentScanOptions) { | ||
| super(allocator, memoryPool, createNative(format, uri, fragmentScanOptions)); | ||
| this.hdfsFileSystems = toHdfsFileSystems(uri); | ||
| } | ||
|
|
||
| public FileSystemDatasetFactory( | ||
| BufferAllocator allocator, NativeMemoryPool memoryPool, FileFormat format, String[] uris) { | ||
| super(allocator, memoryPool, createNative(format, uris, Optional.empty())); | ||
| this.hdfsFileSystems = toHdfsFileSystems(uris); | ||
| } | ||
|
|
||
| public FileSystemDatasetFactory( | ||
|
|
@@ -51,6 +60,65 @@ public FileSystemDatasetFactory( | |
| String[] uris, | ||
| Optional<FragmentScanOptions> fragmentScanOptions) { | ||
| super(allocator, memoryPool, createNative(format, uris, fragmentScanOptions)); | ||
| this.hdfsFileSystems = toHdfsFileSystems(uris); | ||
| } | ||
|
|
||
| /** | ||
| * Close this factory and release the native instance. For HDFS URIs, also closes the cached | ||
| * Hadoop FileSystem to release non-daemon threads that would otherwise prevent JVM exit. See <a | ||
| * href="https://github.com/apache/arrow-java/issues/1067">#1067</a>. | ||
| */ | ||
| @Override | ||
| public synchronized void close() { | ||
| try { | ||
| super.close(); | ||
| } finally { | ||
| hdfsFileSystems.forEach(FileSystemDatasetFactory::closeHadoopFileSystem); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * For each {@code hdfs://} URI, close the cached Hadoop FileSystem. | ||
| * When Arrow C++ accesses HDFS via libhdfs, the Hadoop Java client creates cached FileSystem | ||
| * instances with non-daemon threads (IPC connections, lease renewers) that prevent JVM exit. | ||
| * Closing the FileSystem terminates these connections. Uses reflection to avoid a compile-time | ||
| * dependency on hadoop-common. | ||
| */ | ||
| static void closeHadoopFileSystemsIfHdfs(String... uris) { | ||
| toHdfsFileSystems(uris).forEach(FileSystemDatasetFactory::closeHadoopFileSystem); | ||
| } | ||
|
|
||
| private static Set<URI> toHdfsFileSystems(String... uris) { | ||
| Set<URI> hdfsFileSystems = new LinkedHashSet<>(); | ||
| if (uris == null) { | ||
| return hdfsFileSystems; | ||
| } | ||
| for (String uri : uris) { | ||
| try { | ||
| URI parsedUri = new URI(uri); | ||
| if ("hdfs".equalsIgnoreCase(parsedUri.getScheme())) { | ||
| hdfsFileSystems.add( | ||
| new URI(parsedUri.getScheme(), parsedUri.getAuthority(), null, null, null)); | ||
| } | ||
| } catch (Exception e) { | ||
| // Ignore here; native factory creation reports invalid user URIs. | ||
|
Comment on lines
+103
to
+104
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. nit: could we catch a more specific exception class for invalid URIs? |
||
| } | ||
| } | ||
| return hdfsFileSystems; | ||
| } | ||
|
|
||
| private static void closeHadoopFileSystem(URI hdfsUri) { | ||
| try { | ||
| Class<?> confClass = Class.forName("org.apache.hadoop.conf.Configuration"); | ||
| Object conf = confClass.getDeclaredConstructor().newInstance(); | ||
| Class<?> fsClass = Class.forName("org.apache.hadoop.fs.FileSystem"); | ||
| Method getMethod = fsClass.getMethod("get", URI.class, confClass); | ||
| Object fs = getMethod.invoke(null, hdfsUri, conf); | ||
| Method closeMethod = fsClass.getMethod("close"); | ||
| closeMethod.invoke(fs); | ||
| } catch (Exception e) { | ||
| // Best-effort cleanup; Hadoop may not be on classpath or FileSystem already closed | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. nit: worth perhaps logging this? |
||
| } | ||
| } | ||
|
|
||
| private static long createNative( | ||
|
|
||
132 changes: 132 additions & 0 deletions
132
dataset/src/test/java/org/apache/arrow/dataset/file/TestHdfsFileSystemCleanup.java
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,132 @@ | ||
| /* | ||
| * 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. | ||
| */ | ||
| package org.apache.arrow.dataset.file; | ||
|
|
||
| import static org.junit.jupiter.api.Assertions.assertEquals; | ||
| import static org.junit.jupiter.api.Assertions.assertFalse; | ||
| import static org.junit.jupiter.api.Assertions.assertTrue; | ||
|
|
||
| import java.io.File; | ||
| import java.io.IOException; | ||
| import java.util.concurrent.TimeUnit; | ||
| import org.apache.hadoop.conf.Configuration; | ||
| import org.apache.hadoop.fs.FileSystem; | ||
| import org.apache.hadoop.fs.Path; | ||
| import org.apache.hadoop.hdfs.MiniDFSCluster; | ||
| import org.junit.jupiter.api.AfterAll; | ||
| import org.junit.jupiter.api.BeforeAll; | ||
| import org.junit.jupiter.api.Test; | ||
| import org.junit.jupiter.api.io.TempDir; | ||
|
|
||
| /** Regression test for <a href="https://github.com/apache/arrow-java/issues/1067">#1067</a>. */ | ||
| public class TestHdfsFileSystemCleanup { | ||
|
|
||
| private static final int CHILD_TIMEOUT_SECONDS = 10; | ||
|
|
||
| private static MiniDFSCluster cluster; | ||
|
|
||
| @TempDir static File clusterDir; | ||
|
|
||
| @BeforeAll | ||
| static void startCluster() throws IOException { | ||
| Configuration conf = new Configuration(); | ||
| conf.set(MiniDFSCluster.HDFS_MINIDFS_BASEDIR, clusterDir.getAbsolutePath()); | ||
| cluster = new MiniDFSCluster.Builder(conf).numDataNodes(1).build(); | ||
| cluster.waitActive(); | ||
| } | ||
|
|
||
| @AfterAll | ||
| static void stopCluster() { | ||
| if (cluster != null) { | ||
| cluster.shutdown(); | ||
| } | ||
| } | ||
|
|
||
| @Test | ||
| void testJvmHangsWithoutCleanup() throws Exception { | ||
| Process child = forkChildProcess(false); | ||
| assertFalse(waitForExit(child), "JVM should hang when HDFS is not cleaned up"); | ||
| } | ||
|
|
||
| @Test | ||
| void testJvmExitsWithCleanup() throws Exception { | ||
| Process child = forkChildProcess(true); | ||
| assertTrue( | ||
| waitForExit(child), "JVM should exit when FileSystemDatasetFactory cleanup runs"); | ||
| assertEquals(0, child.exitValue(), "Child process should exit cleanly (exit code 0)"); | ||
| } | ||
|
|
||
| private boolean waitForExit(Process child) throws InterruptedException { | ||
| boolean exited = child.waitFor(CHILD_TIMEOUT_SECONDS, TimeUnit.SECONDS); | ||
| if (!exited) { | ||
| child.destroyForcibly(); | ||
| } | ||
| return exited; | ||
| } | ||
|
|
||
| private Process forkChildProcess(boolean withCleanup) throws IOException { | ||
| String classpath = System.getProperty("java.class.path"); | ||
| int port = cluster.getNameNodePort(); | ||
| ProcessBuilder pb = | ||
| new ProcessBuilder( | ||
| ProcessHandle.current().info().command().orElse("java"), | ||
| "-cp", | ||
| classpath, | ||
| HdfsClientSimulator.class.getName(), | ||
| String.valueOf(port), | ||
| String.valueOf(withCleanup)); | ||
| pb.redirectError(ProcessBuilder.Redirect.DISCARD); | ||
| pb.redirectOutput(ProcessBuilder.Redirect.DISCARD); | ||
| return pb.start(); | ||
| } | ||
|
|
||
| /** Simulates libhdfs leaving a non-daemon thread attached to an HDFS connection. */ | ||
| public static class HdfsClientSimulator { | ||
| public static void main(String[] args) throws Exception { | ||
| int port = Integer.parseInt(args[0]); | ||
| boolean withCleanup = Boolean.parseBoolean(args[1]); | ||
|
|
||
| Configuration conf = new Configuration(); | ||
| String hdfsUri = "hdfs://localhost:" + port; | ||
| conf.set("fs.defaultFS", hdfsUri); | ||
|
|
||
| FileSystem fs = FileSystem.get(conf); | ||
| fs.exists(new Path("/")); | ||
|
|
||
| Thread connectionThread = | ||
| new Thread( | ||
| () -> { | ||
| while (true) { | ||
| try { | ||
| fs.getFileStatus(new Path("/")); | ||
| Thread.sleep(500); | ||
| } catch (Exception e) { | ||
| break; | ||
| } | ||
| } | ||
| }, | ||
| "simulated-libhdfs-ipc-thread"); | ||
| connectionThread.setDaemon(false); | ||
| connectionThread.start(); | ||
|
|
||
| if (withCleanup) { | ||
| FileSystemDatasetFactory.closeHadoopFileSystemsIfHdfs(hdfsUri); | ||
| connectionThread.join(5000); | ||
| } | ||
| } | ||
| } | ||
| } |
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: could we use AutoCloseables here?