szetszwo commented on code in PR #5853: URL: https://github.com/apache/ozone/pull/5853#discussion_r1435257652
########## hadoop-hdds/common/src/main/java/org/apache/hadoop/hdds/resource/LeakDetector.java: ########## @@ -0,0 +1,102 @@ +/* + * 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.hadoop.hdds.resource; Review Comment: It should use the `org.apache.hadoop.hdds.utils` package. ########## hadoop-hdds/common/src/main/java/org/apache/hadoop/hdds/resource/LeakTracker.java: ########## @@ -0,0 +1,50 @@ +/* + * 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.hadoop.hdds.resource; + +import java.lang.ref.ReferenceQueue; +import java.lang.ref.WeakReference; +import java.util.Set; + +/** + * A token to track resource closure. + * + * @see LeakDetector + */ +public class LeakTracker extends WeakReference<Object> { Review Comment: Use generic type instead of `Object`, i.e. ```java public class LeakTracker extends WeakReference<Object> { ``` ########## hadoop-hdds/common/src/main/java/org/apache/hadoop/hdds/resource/LeakTracker.java: ########## @@ -0,0 +1,50 @@ +/* + * 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.hadoop.hdds.resource; + +import java.lang.ref.ReferenceQueue; +import java.lang.ref.WeakReference; +import java.util.Set; + +/** + * A token to track resource closure. + * + * @see LeakDetector + */ +public class LeakTracker extends WeakReference<Object> { + private final Set<LeakTracker> allLeaks; Review Comment: Use a boolean instead, i.e. ```java public class LeakTracker<T> extends WeakReference<T> implements AutoCloseable { private final AtomicBoolean closed = new AtomicBoolean(); private final Runnable reporter; LeakTracker(T referent, ReferenceQueue<T> referenceQueue, Runnable reporter) { super(referent, referenceQueue); this.reporter = reporter; } public void assertClosed() { if (!closed.get()) { reporter.run(); } } @Override public void close() { closed.set(true); } } ``` ########## hadoop-hdds/managed-rocksdb/src/main/java/org/apache/hadoop/hdds/utils/db/managed/ManagedRocksObjectUtils.java: ########## @@ -41,27 +42,24 @@ private ManagedRocksObjectUtils() { public static final Logger LOG = LoggerFactory.getLogger(ManagedRocksObjectUtils.class); + private static final Duration POLL_DELAY_DURATION = Duration.ZERO; private static final Duration POLL_INTERVAL_DURATION = Duration.ofMillis(100); - public static void assertClosed(ManagedObject<?> object) { - assertClosed(object.get(), object.getStackTrace()); - } - static void assertClosed(RocksObject rocksObject, String stackTrace) { + private static final LeakDetector LEAK_DETECTOR = new LeakDetector("ManagedRocksObject"); + + static LeakTracker track(AutoCloseable object, @Nullable StackTraceElement[] stackTrace) { ManagedRocksObjectMetrics.INSTANCE.increaseManagedObject(); - if (rocksObject.isOwningHandle()) { - reportLeak(rocksObject, stackTrace); - } + final String name = object.getClass().getSimpleName(); Review Comment: Use `object.toString() instead`. ########## hadoop-hdds/managed-rocksdb/src/main/java/org/apache/hadoop/hdds/utils/db/managed/ManagedRocksObjectUtils.java: ########## @@ -41,27 +42,24 @@ private ManagedRocksObjectUtils() { public static final Logger LOG = LoggerFactory.getLogger(ManagedRocksObjectUtils.class); + private static final Duration POLL_DELAY_DURATION = Duration.ZERO; private static final Duration POLL_INTERVAL_DURATION = Duration.ofMillis(100); - public static void assertClosed(ManagedObject<?> object) { - assertClosed(object.get(), object.getStackTrace()); - } - static void assertClosed(RocksObject rocksObject, String stackTrace) { + private static final LeakDetector LEAK_DETECTOR = new LeakDetector("ManagedRocksObject"); + + static LeakTracker track(AutoCloseable object, @Nullable StackTraceElement[] stackTrace) { ManagedRocksObjectMetrics.INSTANCE.increaseManagedObject(); - if (rocksObject.isOwningHandle()) { - reportLeak(rocksObject, stackTrace); - } + final String name = object.getClass().getSimpleName(); + return LEAK_DETECTOR.track(object, () -> reportLeak(name, formatStackTrace(stackTrace))); } - static void reportLeak(Object object, String stackTrace) { + static void reportLeak(String name, String stackTrace) { ManagedRocksObjectMetrics.INSTANCE.increaseLeakObject(); - String warning = String.format("%s is not closed properly", - object.getClass().getSimpleName()); + String warning = String.format("%s is not closed properly", name); if (stackTrace != null && LOG.isDebugEnabled()) { - String debugMessage = String - .format("%nStackTrace for unclosed instance: %s", stackTrace); + String debugMessage = String.format("%nStackTrace for unclosed instance: %s", stackTrace); warning = warning.concat(debugMessage); } LOG.warn(warning); Review Comment: How about making it configurable to call `System.exit`? ########## hadoop-hdds/managed-rocksdb/src/main/java/org/apache/hadoop/hdds/utils/db/managed/ManagedRocksObjectUtils.java: ########## @@ -41,27 +42,24 @@ private ManagedRocksObjectUtils() { public static final Logger LOG = LoggerFactory.getLogger(ManagedRocksObjectUtils.class); + private static final Duration POLL_DELAY_DURATION = Duration.ZERO; private static final Duration POLL_INTERVAL_DURATION = Duration.ofMillis(100); - public static void assertClosed(ManagedObject<?> object) { - assertClosed(object.get(), object.getStackTrace()); - } - static void assertClosed(RocksObject rocksObject, String stackTrace) { + private static final LeakDetector LEAK_DETECTOR = new LeakDetector("ManagedRocksObject"); + + static LeakTracker track(AutoCloseable object, @Nullable StackTraceElement[] stackTrace) { Review Comment: - Use `RocksObject` instead of `AutoCloseable`. - Get `stackTrace` inside this method instead of passing it in order to reduce code duplication. ########## hadoop-hdds/common/src/main/java/org/apache/hadoop/hdds/resource/LeakDetector.java: ########## @@ -0,0 +1,102 @@ +/* + * 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.hadoop.hdds.resource; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.lang.ref.ReferenceQueue; +import java.util.Collections; +import java.util.Set; +import java.util.concurrent.ConcurrentHashMap; + +/** + * Simple general resource leak detector using {@link ReferenceQueue} and {@link java.lang.ref.WeakReference} to + * observe resource object life-cycle and assert proper resource closure before they are GCed. + * + * <p> + * Example usage: + * + * <pre> {@code + * class MyResource implements AutoClosable { + * static final LeakDetector LEAK_DETECTOR = new LeakDetector("MyResource"); + * + * private final LeakTracker leakTracker = LEAK_DETECTOR.track(this, () -> { + * // report leaks, don't refer to the original object (MyResource) here. + * System.out.println("MyResource is not closed before being discarded."); + * }); + * + * @Override + * public void close() { + * // proper resources cleanup... + * // inform tracker that this object is closed properly. + * leakTracker.close(); + * } + * } + * + * }</pre> + */ +public class LeakDetector implements Runnable { + public static final Logger LOG = LoggerFactory.getLogger(LeakDetector.class); + private final ReferenceQueue<Object> queue = new ReferenceQueue<>(); + private final Set<LeakTracker> allLeaks = Collections.newSetFromMap(new ConcurrentHashMap<>()); + private final String name; + + public LeakDetector(String name) { + this.name = name; + start(); + } + + private void start() { + Thread t = new Thread(this); + t.setName(LeakDetector.class.getSimpleName() + "-" + name); + t.setDaemon(true); + LOG.info("Starting leak detector thread {}.", name); + t.start(); + } + + @Override + public void run() { + while (true) { + try { + LeakTracker tracker = (LeakTracker) queue.remove(); + // Original resource already been GCed, if tracker is not closed yet, + // report a leak. + if (allLeaks.remove(tracker)) { + tracker.reportLeak(); + } Review Comment: Use `tracker.assertClosed()` instead; see the comment in `LeakTracker`. ########## hadoop-hdds/common/src/main/java/org/apache/hadoop/hdds/resource/LeakDetector.java: ########## @@ -0,0 +1,102 @@ +/* + * 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.hadoop.hdds.resource; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.lang.ref.ReferenceQueue; +import java.util.Collections; +import java.util.Set; +import java.util.concurrent.ConcurrentHashMap; + +/** + * Simple general resource leak detector using {@link ReferenceQueue} and {@link java.lang.ref.WeakReference} to + * observe resource object life-cycle and assert proper resource closure before they are GCed. + * + * <p> + * Example usage: + * + * <pre> {@code + * class MyResource implements AutoClosable { + * static final LeakDetector LEAK_DETECTOR = new LeakDetector("MyResource"); + * + * private final LeakTracker leakTracker = LEAK_DETECTOR.track(this, () -> { + * // report leaks, don't refer to the original object (MyResource) here. + * System.out.println("MyResource is not closed before being discarded."); + * }); + * + * @Override + * public void close() { + * // proper resources cleanup... + * // inform tracker that this object is closed properly. + * leakTracker.close(); + * } + * } + * + * }</pre> + */ +public class LeakDetector implements Runnable { + public static final Logger LOG = LoggerFactory.getLogger(LeakDetector.class); + private final ReferenceQueue<Object> queue = new ReferenceQueue<>(); + private final Set<LeakTracker> allLeaks = Collections.newSetFromMap(new ConcurrentHashMap<>()); Review Comment: This set is not needed since `LeakTracker` can have a boolean to track whether it is closed. ########## hadoop-hdds/common/src/main/java/org/apache/hadoop/hdds/resource/LeakDetector.java: ########## @@ -0,0 +1,102 @@ +/* + * 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.hadoop.hdds.resource; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.lang.ref.ReferenceQueue; +import java.util.Collections; +import java.util.Set; +import java.util.concurrent.ConcurrentHashMap; + +/** + * Simple general resource leak detector using {@link ReferenceQueue} and {@link java.lang.ref.WeakReference} to + * observe resource object life-cycle and assert proper resource closure before they are GCed. + * + * <p> + * Example usage: + * + * <pre> {@code + * class MyResource implements AutoClosable { + * static final LeakDetector LEAK_DETECTOR = new LeakDetector("MyResource"); + * + * private final LeakTracker leakTracker = LEAK_DETECTOR.track(this, () -> { + * // report leaks, don't refer to the original object (MyResource) here. + * System.out.println("MyResource is not closed before being discarded."); + * }); + * + * @Override + * public void close() { + * // proper resources cleanup... + * // inform tracker that this object is closed properly. + * leakTracker.close(); + * } + * } + * + * }</pre> + */ +public class LeakDetector implements Runnable { + public static final Logger LOG = LoggerFactory.getLogger(LeakDetector.class); + private final ReferenceQueue<Object> queue = new ReferenceQueue<>(); + private final Set<LeakTracker> allLeaks = Collections.newSetFromMap(new ConcurrentHashMap<>()); + private final String name; + + public LeakDetector(String name) { + this.name = name; + start(); + } + + private void start() { + Thread t = new Thread(this); + t.setName(LeakDetector.class.getSimpleName() + "-" + name); + t.setDaemon(true); + LOG.info("Starting leak detector thread {}.", name); + t.start(); + } + + @Override + public void run() { Review Comment: Make a private and pass it using `new Thread(this::run)`. ########## hadoop-hdds/common/src/main/java/org/apache/hadoop/hdds/resource/LeakDetector.java: ########## @@ -0,0 +1,102 @@ +/* + * 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.hadoop.hdds.resource; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.lang.ref.ReferenceQueue; +import java.util.Collections; +import java.util.Set; +import java.util.concurrent.ConcurrentHashMap; + +/** + * Simple general resource leak detector using {@link ReferenceQueue} and {@link java.lang.ref.WeakReference} to + * observe resource object life-cycle and assert proper resource closure before they are GCed. + * + * <p> + * Example usage: + * + * <pre> {@code + * class MyResource implements AutoClosable { + * static final LeakDetector LEAK_DETECTOR = new LeakDetector("MyResource"); + * + * private final LeakTracker leakTracker = LEAK_DETECTOR.track(this, () -> { + * // report leaks, don't refer to the original object (MyResource) here. + * System.out.println("MyResource is not closed before being discarded."); + * }); + * + * @Override + * public void close() { + * // proper resources cleanup... + * // inform tracker that this object is closed properly. + * leakTracker.close(); + * } + * } + * + * }</pre> + */ +public class LeakDetector implements Runnable { Review Comment: Use generic type and don't implements `Runnable`. -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
