X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;ds=sidebyside;f=opendaylight%2Fmd-sal%2Fmdsal-trace%2Fdom-impl%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fmd%2Fsal%2Ftrace%2Fdom%2Fimpl%2FTracingBroker.java;h=8291a72c2577157f629bde2c0c2b79034c62b259;hb=b4bf55727093657662d8c16a50fa85f87978a586;hp=2150e28905a8cfbee60116324f1e6cb3aa11b652;hpb=9f3c837502dbffe101a3571b73d567899b9a9945;p=controller.git diff --git a/opendaylight/md-sal/mdsal-trace/dom-impl/src/main/java/org/opendaylight/controller/md/sal/trace/dom/impl/TracingBroker.java b/opendaylight/md-sal/mdsal-trace/dom-impl/src/main/java/org/opendaylight/controller/md/sal/trace/dom/impl/TracingBroker.java index 2150e28905..8291a72c25 100644 --- a/opendaylight/md-sal/mdsal-trace/dom-impl/src/main/java/org/opendaylight/controller/md/sal/trace/dom/impl/TracingBroker.java +++ b/opendaylight/md-sal/mdsal-trace/dom-impl/src/main/java/org/opendaylight/controller/md/sal/trace/dom/impl/TracingBroker.java @@ -7,20 +7,20 @@ */ package org.opendaylight.controller.md.sal.trace.dom.impl; +import static java.util.Objects.requireNonNull; + +import edu.umd.cs.findbugs.annotations.SuppressFBWarnings; import java.io.PrintStream; import java.util.ArrayList; import java.util.HashMap; import java.util.List; import java.util.Map; -import java.util.Objects; import java.util.Set; -import javax.annotation.Nonnull; -import org.opendaylight.controller.md.sal.common.api.data.AsyncDataBroker; import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType; import org.opendaylight.controller.md.sal.common.api.data.TransactionChainListener; +import org.opendaylight.controller.md.sal.dom.api.ClusteredDOMDataTreeChangeListener; import org.opendaylight.controller.md.sal.dom.api.DOMDataBroker; import org.opendaylight.controller.md.sal.dom.api.DOMDataBrokerExtension; -import org.opendaylight.controller.md.sal.dom.api.DOMDataChangeListener; import org.opendaylight.controller.md.sal.dom.api.DOMDataReadOnlyTransaction; import org.opendaylight.controller.md.sal.dom.api.DOMDataReadWriteTransaction; import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeChangeListener; @@ -100,11 +100,12 @@ import org.slf4j.LoggerFactory; * */ public class TracingBroker implements TracingDOMDataBroker { - + @SuppressFBWarnings("SLF4J_LOGGER_SHOULD_BE_PRIVATE") static final Logger LOG = LoggerFactory.getLogger(TracingBroker.class); private static final int STACK_TRACE_FIRST_RELEVANT_FRAME = 2; + private final String type; // "default" VS "pingpong" private final BindingNormalizedNodeSerializer codec; private final DOMDataBroker delegate; private final List registrationWatches = new ArrayList<>(); @@ -146,24 +147,17 @@ public class TracingBroker implements TracingDOMDataBroker { return child.startsWith(parent.substring(parentOffset), childOffset); } - public boolean subtreesOverlap(YangInstanceIdentifier iid, LogicalDatastoreType store, - AsyncDataBroker.DataChangeScope scope) { + @SuppressWarnings({ "checkstyle:hiddenField", "hiding" }) + public boolean subtreesOverlap(YangInstanceIdentifier iid, LogicalDatastoreType store) { if (this.store != null && !this.store.equals(store)) { return false; } String otherIidString = toIidCompString(iid); - switch (scope) { - case BASE: - return isParent(iidString, otherIidString); - case ONE: //for now just treat like SUBTREE, even though it's not - case SUBTREE: - return isParent(iidString, otherIidString) || isParent(otherIidString, iidString); - default: - return false; - } + return isParent(iidString, otherIidString) || isParent(otherIidString, iidString); } + @SuppressWarnings({ "checkstyle:hiddenField", "hiding" }) public boolean eventIsOfInterest(YangInstanceIdentifier iid, LogicalDatastoreType store) { if (this.store != null && !this.store.equals(store)) { return false; @@ -173,9 +167,10 @@ public class TracingBroker implements TracingDOMDataBroker { } } - public TracingBroker(DOMDataBroker delegate, Config config, BindingNormalizedNodeSerializer codec) { - this.delegate = Objects.requireNonNull(delegate); - this.codec = Objects.requireNonNull(codec); + public TracingBroker(String type, DOMDataBroker delegate, Config config, BindingNormalizedNodeSerializer codec) { + this.type = requireNonNull(type, "type"); + this.delegate = requireNonNull(delegate, "delegate"); + this.codec = requireNonNull(codec, "codec"); configure(config); if (config.isTransactionDebugContextEnabled() != null) { @@ -229,14 +224,13 @@ public class TracingBroker implements TracingDOMDataBroker { writeWatches.add(watch); } - private boolean isRegistrationWatched(YangInstanceIdentifier iid, - LogicalDatastoreType store, DataChangeScope scope) { + private boolean isRegistrationWatched(YangInstanceIdentifier iid, LogicalDatastoreType store) { if (registrationWatches.isEmpty()) { return true; } for (Watch regInterest : registrationWatches) { - if (regInterest.subtreesOverlap(iid, store, scope)) { + if (regInterest.subtreesOverlap(iid, store)) { return true; } } @@ -313,17 +307,6 @@ public class TracingBroker implements TracingDOMDataBroker { return new TracingWriteTransaction(delegate.newWriteOnlyTransaction(), this, writeTransactionsRegistry); } - @Override - public ListenerRegistration registerDataChangeListener( - LogicalDatastoreType store, YangInstanceIdentifier yiid, - DOMDataChangeListener listener, DataChangeScope scope) { - if (isRegistrationWatched(yiid, store, scope)) { - LOG.warn("Registration (registerDataChangeListener) for {} from {}", - toPathString(yiid), getStackSummary()); - } - return delegate.registerDataChangeListener(store, yiid, listener, scope); - } - @Override public DOMTransactionChain createTransactionChain(TransactionChainListener transactionChainListener) { return new TracingTransactionChain( @@ -332,10 +315,9 @@ public class TracingBroker implements TracingDOMDataBroker { @Override public DOMDataReadOnlyTransaction newReadOnlyTransaction() { - return new TracingReadOnlyTransaction(delegate.newReadOnlyTransaction(), this, readOnlyTransactionsRegistry); + return new TracingReadOnlyTransaction(delegate.newReadOnlyTransaction(), readOnlyTransactionsRegistry); } - @Nonnull @Override public Map, DOMDataBrokerExtension> getSupportedExtensions() { Map, DOMDataBrokerExtension> res = delegate.getSupportedExtensions(); @@ -347,13 +329,13 @@ public class TracingBroker implements TracingDOMDataBroker { res = new HashMap<>(res); res.put(DOMDataTreeChangeService.class, new DOMDataTreeChangeService() { - @Nonnull @Override public ListenerRegistration registerDataTreeChangeListener( - @Nonnull DOMDataTreeIdentifier domDataTreeIdentifier, @Nonnull L listener) { + DOMDataTreeIdentifier domDataTreeIdentifier, L listener) { if (isRegistrationWatched(domDataTreeIdentifier.getRootIdentifier(), - domDataTreeIdentifier.getDatastoreType(), DataChangeScope.SUBTREE)) { - LOG.warn("Registration (registerDataTreeChangeListener) for {} from {}", + domDataTreeIdentifier.getDatastoreType())) { + LOG.warn("{} registration (registerDataTreeChangeListener) for {} from {}.", + listener instanceof ClusteredDOMDataTreeChangeListener ? "Clustered" : "Non-clustered", toPathString(domDataTreeIdentifier.getRootIdentifier()), getStackSummary()); } return treeChangeSvc.registerDataTreeChangeListener(domDataTreeIdentifier, listener); @@ -364,22 +346,25 @@ public class TracingBroker implements TracingDOMDataBroker { } @Override - public boolean printOpenTransactions(PrintStream ps) { + public boolean printOpenTransactions(PrintStream ps, int minOpenTXs) { if (transactionChainsRegistry.getAllUnique().isEmpty() && readOnlyTransactionsRegistry.getAllUnique().isEmpty() && writeTransactionsRegistry.getAllUnique().isEmpty() && readWriteTransactionsRegistry.getAllUnique().isEmpty()) { + ps.println(type + ": No open transactions, great!"); return false; } - ps.println(getClass().getSimpleName() + " found some not yet (or never..) closed transaction[chain]s!"); + ps.println(type + ": " + getClass().getSimpleName() + + " found some not yet (or never..) closed transaction[chain]s!"); ps.println("[NB: If no stack traces are shown below, then " + "enable transaction-debug-context-enabled in mdsaltrace_config.xml]"); ps.println(); - printRegistryOpenTransactions(readOnlyTransactionsRegistry, ps, " "); - printRegistryOpenTransactions(writeTransactionsRegistry, ps, " "); - printRegistryOpenTransactions(readWriteTransactionsRegistry, ps, " "); + // Flag to track if we really found any real leaks with more (or equal) to minOpenTXs + boolean hasFound = print(readOnlyTransactionsRegistry, ps, " ", minOpenTXs); + hasFound |= print(writeTransactionsRegistry, ps, " ", minOpenTXs); + hasFound |= print(readWriteTransactionsRegistry, ps, " ", minOpenTXs); // Now print details for each non-closed TransactionChain // incl. in turn each ones own read/Write[Only]TransactionsRegistry @@ -389,34 +374,68 @@ public class TracingBroker implements TracingDOMDataBroker { ps.println(" " + transactionChainsRegistry.getAnchor() + " : " + transactionChainsRegistry.getCreateDescription()); } - entries.forEach(entry -> { + for (CloseTrackedRegistryReportEntry entry : entries) { ps.println(" " + entry.getNumberAddedNotRemoved() + "x TransactionChains opened but not closed here:"); - entry.getStackTraceElements().forEach(line -> ps.println(" " + line)); + printStackTraceElements(ps, " ", entry.getStackTraceElements()); @SuppressWarnings("resource") TracingTransactionChain txChain = (TracingTransactionChain) entry .getExampleCloseTracked().getRealCloseTracked(); - printRegistryOpenTransactions(txChain.getReadOnlyTransactionsRegistry(), ps, " "); - printRegistryOpenTransactions(txChain.getWriteTransactionsRegistry(), ps, " "); - printRegistryOpenTransactions(txChain.getReadWriteTransactionsRegistry(), ps, " "); - }); + hasFound |= print(txChain.getReadOnlyTransactionsRegistry(), ps, " ", minOpenTXs); + hasFound |= print(txChain.getWriteTransactionsRegistry(), ps, " ", minOpenTXs); + hasFound |= print(txChain.getReadWriteTransactionsRegistry(), ps, " ", minOpenTXs); + } ps.println(); - return true; + return hasFound; } - private > void printRegistryOpenTransactions( - CloseTrackedRegistry registry, PrintStream ps, String indent) { - Set> entries = registry.getAllUnique(); + private > boolean print( + CloseTrackedRegistry registry, PrintStream ps, String indent, int minOpenTransactions) { + Set> unsorted = registry.getAllUnique(); + if (unsorted.size() < minOpenTransactions) { + return false; + } + + List> entries = new ArrayList<>(unsorted); + entries.sort((o1, o2) -> Long.compare(o2.getNumberAddedNotRemoved(), o1.getNumberAddedNotRemoved())); + if (!entries.isEmpty()) { ps.println(indent + registry.getAnchor() + " : " + registry.getCreateDescription()); } entries.forEach(entry -> { ps.println(indent + " " + entry.getNumberAddedNotRemoved() + "x transactions opened here, which are not closed:"); - entry.getStackTraceElements().forEach(line -> ps.println(indent + " " + line)); + printStackTraceElements(ps, indent + " ", entry.getStackTraceElements()); }); if (!entries.isEmpty()) { ps.println(); } + return true; + } + + private void printStackTraceElements(PrintStream ps, String indent, List stackTraceElements) { + boolean ellipsis = false; + for (final StackTraceElement stackTraceElement : stackTraceElements) { + if (isStackTraceElementInteresting(stackTraceElement)) { + ps.println(indent + stackTraceElement); + ellipsis = false; + } else if (!ellipsis) { + ps.println(indent + "(...)"); + ellipsis = true; + } + } + } + + private boolean isStackTraceElementInteresting(StackTraceElement element) { + final String className = element.getClassName(); + return !className.startsWith(getClass().getPackage().getName()) + && !className.startsWith(CloseTracked.class.getPackage().getName()) + && !className.startsWith("Proxy") + && !className.startsWith("akka") + && !className.startsWith("scala") + && !className.startsWith("sun.reflect") + && !className.startsWith("java.lang.reflect") + && !className.startsWith("org.apache.aries.blueprint") + && !className.startsWith("org.osgi.util.tracker"); } }