2 * Copyright (c) 2016 Red Hat, Inc. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
8 package org.opendaylight.controller.md.sal.trace.dom.impl;
10 import static java.util.Objects.requireNonNull;
12 import java.io.PrintStream;
13 import java.util.ArrayList;
14 import java.util.HashMap;
15 import java.util.List;
18 import javax.annotation.Nonnull;
19 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
20 import org.opendaylight.controller.md.sal.common.api.data.TransactionChainListener;
21 import org.opendaylight.controller.md.sal.dom.api.ClusteredDOMDataTreeChangeListener;
22 import org.opendaylight.controller.md.sal.dom.api.DOMDataBroker;
23 import org.opendaylight.controller.md.sal.dom.api.DOMDataBrokerExtension;
24 import org.opendaylight.controller.md.sal.dom.api.DOMDataReadOnlyTransaction;
25 import org.opendaylight.controller.md.sal.dom.api.DOMDataReadWriteTransaction;
26 import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeChangeListener;
27 import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeChangeService;
28 import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeIdentifier;
29 import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
30 import org.opendaylight.controller.md.sal.dom.api.DOMTransactionChain;
31 import org.opendaylight.controller.md.sal.trace.api.TracingDOMDataBroker;
32 import org.opendaylight.controller.md.sal.trace.closetracker.impl.CloseTracked;
33 import org.opendaylight.controller.md.sal.trace.closetracker.impl.CloseTrackedRegistry;
34 import org.opendaylight.controller.md.sal.trace.closetracker.impl.CloseTrackedRegistryReportEntry;
35 import org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeSerializer;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.mdsaltrace.rev160908.Config;
37 import org.opendaylight.yangtools.concepts.ListenerRegistration;
38 import org.opendaylight.yangtools.yang.binding.DataObject;
39 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
40 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
41 import org.slf4j.Logger;
42 import org.slf4j.LoggerFactory;
44 @SuppressWarnings("checkstyle:JavadocStyle")
45 //...because otherwise it whines about the elements in the @code block even though it's completely valid Javadoc
48 * TracingBroker logs "write" operations and listener registrations to the md-sal. It logs the instance identifier path,
49 * the objects themselves, as well as the stack trace of the call invoking the registration or write operation.
50 * It works by operating as a "bump on the stack" between the application and actual DataBroker, intercepting write
51 * and registration calls and writing to the log.
53 * <p>In addition, it (optionally) can also keep track of the stack trace of all new transaction allocations
54 * (including TransactionChains, and transactions created in turn from them), in order to detect and report leaks
55 * from transactions which were not closed.
58 * TracingBroker is designed to be easy to use. In fact, for bundles using Blueprint to inject their DataBroker
59 * TracingBroker can be used without modifying your code at all in two simple steps:
62 * Simply add the dependency "mdsaltrace-features" to
67 * <groupId>org.opendaylight.controller</groupId>
68 * <artifactId>features-mdsal-trace</artifactId>
69 * <version>1.7.0-SNAPSHOT</version>
70 * <classifier>features</classifier>
72 * <scope>runtime</scope>
78 * Then just "feature:install odl-mdsal-trace" before you install your "real" feature(s) and you're done.
79 * Beware that with Karaf 4 due to <a href="https://bugs.opendaylight.org/show_bug.cgi?id=9068">Bug 9068</a>
80 * you'll probably have to use feature:install's --no-auto-refresh flag when installing your "real" feature.
83 * This works because the mdsaltrace-impl bundle registers its service implementing DOMDataBroker with a higher
84 * rank than sal-binding-broker. As such, any OSGi service lookup for DataBroker will receive the TracingBroker.
86 * <h1>Avoiding log bloat:</h1>
87 * TracingBroker can be configured to only print registrations or write ops pertaining to certain subtrees of the
88 * md-sal. This can be done in the code via the methods of this class or via a config file. TracingBroker uses a more
89 * convenient but non-standard representation of the instance identifiers. Each instance identifier segment's
90 * class.getSimpleName() is used separated by a '/'.
92 * <h1>Known issues</h1>
95 * Filtering by paths. For some registrations the codec that converts back from the DOM to binding paths is
96 * busted. As such, an aproximated path is used in the output. For now it is recommended not to use
97 * watchRegistrations and allow all registrations to be logged.
102 public class TracingBroker implements TracingDOMDataBroker {
104 static final Logger LOG = LoggerFactory.getLogger(TracingBroker.class);
106 private static final int STACK_TRACE_FIRST_RELEVANT_FRAME = 2;
108 private final String type; // "default" VS "pingpong"
109 private final BindingNormalizedNodeSerializer codec;
110 private final DOMDataBroker delegate;
111 private final List<Watch> registrationWatches = new ArrayList<>();
112 private final List<Watch> writeWatches = new ArrayList<>();
114 private final boolean isDebugging;
115 private final CloseTrackedRegistry<TracingTransactionChain> transactionChainsRegistry;
116 private final CloseTrackedRegistry<TracingReadOnlyTransaction> readOnlyTransactionsRegistry;
117 private final CloseTrackedRegistry<TracingWriteTransaction> writeTransactionsRegistry;
118 private final CloseTrackedRegistry<TracingReadWriteTransaction> readWriteTransactionsRegistry;
120 private class Watch {
121 final String iidString;
122 final LogicalDatastoreType store;
124 Watch(String iidString, LogicalDatastoreType storeOrNull) {
125 this.store = storeOrNull;
126 this.iidString = iidString;
129 private String toIidCompString(YangInstanceIdentifier iid) {
130 StringBuilder builder = new StringBuilder();
131 toPathString(iid, builder);
133 return builder.toString();
136 private boolean isParent(String parent, String child) {
137 int parentOffset = 0;
138 if (parent.length() > 0 && parent.charAt(0) == '<') {
139 parentOffset = parent.indexOf('>') + 1;
143 if (child.length() > 0 && child.charAt(0) == '<') {
144 childOffset = child.indexOf('>') + 1;
147 return child.startsWith(parent.substring(parentOffset), childOffset);
150 @SuppressWarnings({ "checkstyle:hiddenField", "hiding" })
151 public boolean subtreesOverlap(YangInstanceIdentifier iid, LogicalDatastoreType store) {
152 if (this.store != null && !this.store.equals(store)) {
156 String otherIidString = toIidCompString(iid);
157 return isParent(iidString, otherIidString) || isParent(otherIidString, iidString);
160 @SuppressWarnings({ "checkstyle:hiddenField", "hiding" })
161 public boolean eventIsOfInterest(YangInstanceIdentifier iid, LogicalDatastoreType store) {
162 if (this.store != null && !this.store.equals(store)) {
166 return isParent(iidString, toPathString(iid));
170 public TracingBroker(String type, DOMDataBroker delegate, Config config, BindingNormalizedNodeSerializer codec) {
171 this.type = requireNonNull(type, "type");
172 this.delegate = requireNonNull(delegate, "delegate");
173 this.codec = requireNonNull(codec, "codec");
176 if (config.isTransactionDebugContextEnabled() != null) {
177 this.isDebugging = config.isTransactionDebugContextEnabled();
179 this.isDebugging = false;
181 final String db = "DataBroker";
182 this.transactionChainsRegistry = new CloseTrackedRegistry<>(db, "createTransactionChain()", isDebugging);
183 this.readOnlyTransactionsRegistry = new CloseTrackedRegistry<>(db, "newReadOnlyTransaction()", isDebugging);
184 this.writeTransactionsRegistry = new CloseTrackedRegistry<>(db, "newWriteOnlyTransaction()", isDebugging);
185 this.readWriteTransactionsRegistry = new CloseTrackedRegistry<>(db, "newReadWriteTransaction()", isDebugging);
188 private void configure(Config config) {
189 registrationWatches.clear();
190 List<String> paths = config.getRegistrationWatches();
192 for (String path : paths) {
193 watchRegistrations(path, null);
197 writeWatches.clear();
198 paths = config.getWriteWatches();
200 for (String path : paths) {
201 watchWrites(path, null);
207 * Log registrations to this subtree of the md-sal.
208 * @param iidString the iid path of the root of the subtree
209 * @param store Which LogicalDataStore? or null for both
211 public void watchRegistrations(String iidString, LogicalDatastoreType store) {
212 LOG.info("Watching registrations to {} in {}", iidString, store);
213 registrationWatches.add(new Watch(iidString, store));
217 * Log writes to this subtree of the md-sal.
218 * @param iidString the iid path of the root of the subtree
219 * @param store Which LogicalDataStore? or null for both
221 public void watchWrites(String iidString, LogicalDatastoreType store) {
222 LOG.info("Watching writes to {} in {}", iidString, store);
223 Watch watch = new Watch(iidString, store);
224 writeWatches.add(watch);
227 private boolean isRegistrationWatched(YangInstanceIdentifier iid, LogicalDatastoreType store) {
228 if (registrationWatches.isEmpty()) {
232 for (Watch regInterest : registrationWatches) {
233 if (regInterest.subtreesOverlap(iid, store)) {
241 boolean isWriteWatched(YangInstanceIdentifier iid, LogicalDatastoreType store) {
242 if (writeWatches.isEmpty()) {
246 for (Watch watch : writeWatches) {
247 if (watch.eventIsOfInterest(iid, store)) {
255 static void toPathString(InstanceIdentifier<? extends DataObject> iid, StringBuilder builder) {
256 for (InstanceIdentifier.PathArgument pathArg : iid.getPathArguments()) {
257 builder.append('/').append(pathArg.getType().getSimpleName());
261 String toPathString(YangInstanceIdentifier yiid) {
262 StringBuilder sb = new StringBuilder();
263 toPathString(yiid, sb);
264 return sb.toString();
268 private void toPathString(YangInstanceIdentifier yiid, StringBuilder sb) {
269 InstanceIdentifier<?> iid = codec.fromYangInstanceIdentifier(yiid);
271 reconstructIidPathString(yiid, sb);
273 toPathString(iid, sb);
277 private void reconstructIidPathString(YangInstanceIdentifier yiid, StringBuilder sb) {
278 sb.append("<RECONSTRUCTED FROM: \"").append(yiid.toString()).append("\">");
279 for (YangInstanceIdentifier.PathArgument pathArg : yiid.getPathArguments()) {
280 if (pathArg instanceof YangInstanceIdentifier.AugmentationIdentifier) {
281 sb.append('/').append("AUGMENTATION");
284 sb.append('/').append(pathArg.getNodeType().getLocalName());
288 String getStackSummary() {
289 StackTraceElement[] stack = Thread.currentThread().getStackTrace();
291 StringBuilder sb = new StringBuilder();
292 for (int i = STACK_TRACE_FIRST_RELEVANT_FRAME; i < stack.length; i++) {
293 StackTraceElement frame = stack[i];
294 sb.append("\n\t(TracingBroker)\t").append(frame.getClassName()).append('.').append(frame.getMethodName());
297 return sb.toString();
301 public DOMDataReadWriteTransaction newReadWriteTransaction() {
302 return new TracingReadWriteTransaction(delegate.newReadWriteTransaction(), this, readWriteTransactionsRegistry);
306 public DOMDataWriteTransaction newWriteOnlyTransaction() {
307 return new TracingWriteTransaction(delegate.newWriteOnlyTransaction(), this, writeTransactionsRegistry);
311 public DOMTransactionChain createTransactionChain(TransactionChainListener transactionChainListener) {
312 return new TracingTransactionChain(
313 delegate.createTransactionChain(transactionChainListener), this, transactionChainsRegistry);
317 public DOMDataReadOnlyTransaction newReadOnlyTransaction() {
318 return new TracingReadOnlyTransaction(delegate.newReadOnlyTransaction(), readOnlyTransactionsRegistry);
323 public Map<Class<? extends DOMDataBrokerExtension>, DOMDataBrokerExtension> getSupportedExtensions() {
324 Map<Class<? extends DOMDataBrokerExtension>, DOMDataBrokerExtension> res = delegate.getSupportedExtensions();
325 DOMDataTreeChangeService treeChangeSvc = (DOMDataTreeChangeService) res.get(DOMDataTreeChangeService.class);
326 if (treeChangeSvc == null) {
330 res = new HashMap<>(res);
332 res.put(DOMDataTreeChangeService.class, new DOMDataTreeChangeService() {
335 public <L extends DOMDataTreeChangeListener> ListenerRegistration<L> registerDataTreeChangeListener(
336 @Nonnull DOMDataTreeIdentifier domDataTreeIdentifier, @Nonnull L listener) {
337 if (isRegistrationWatched(domDataTreeIdentifier.getRootIdentifier(),
338 domDataTreeIdentifier.getDatastoreType())) {
339 LOG.warn("{} registration (registerDataTreeChangeListener) for {} from {}.",
340 listener instanceof ClusteredDOMDataTreeChangeListener ? "Clustered" : "Non-clustered",
341 toPathString(domDataTreeIdentifier.getRootIdentifier()), getStackSummary());
343 return treeChangeSvc.registerDataTreeChangeListener(domDataTreeIdentifier, listener);
351 public boolean printOpenTransactions(PrintStream ps, int minOpenTXs) {
352 if (transactionChainsRegistry.getAllUnique().isEmpty()
353 && readOnlyTransactionsRegistry.getAllUnique().isEmpty()
354 && writeTransactionsRegistry.getAllUnique().isEmpty()
355 && readWriteTransactionsRegistry.getAllUnique().isEmpty()) {
357 ps.println(type + ": No open transactions, great!");
361 ps.println(type + ": " + getClass().getSimpleName()
362 + " found some not yet (or never..) closed transaction[chain]s!");
363 ps.println("[NB: If no stack traces are shown below, then "
364 + "enable transaction-debug-context-enabled in mdsaltrace_config.xml]");
366 // Flag to track if we really found any real leaks with more (or equal) to minOpenTXs
367 boolean hasFound = print(readOnlyTransactionsRegistry, ps, " ", minOpenTXs);
368 hasFound |= print(writeTransactionsRegistry, ps, " ", minOpenTXs);
369 hasFound |= print(readWriteTransactionsRegistry, ps, " ", minOpenTXs);
371 // Now print details for each non-closed TransactionChain
372 // incl. in turn each ones own read/Write[Only]TransactionsRegistry
373 Set<CloseTrackedRegistryReportEntry<TracingTransactionChain>>
374 entries = transactionChainsRegistry.getAllUnique();
375 if (!entries.isEmpty()) {
376 ps.println(" " + transactionChainsRegistry.getAnchor() + " : "
377 + transactionChainsRegistry.getCreateDescription());
379 for (CloseTrackedRegistryReportEntry<TracingTransactionChain> entry : entries) {
380 ps.println(" " + entry.getNumberAddedNotRemoved() + "x TransactionChains opened but not closed here:");
381 printStackTraceElements(ps, " ", entry.getStackTraceElements());
382 @SuppressWarnings("resource")
383 TracingTransactionChain txChain = (TracingTransactionChain) entry
384 .getExampleCloseTracked().getRealCloseTracked();
385 hasFound |= print(txChain.getReadOnlyTransactionsRegistry(), ps, " ", minOpenTXs);
386 hasFound |= print(txChain.getWriteTransactionsRegistry(), ps, " ", minOpenTXs);
387 hasFound |= print(txChain.getReadWriteTransactionsRegistry(), ps, " ", minOpenTXs);
394 private <T extends CloseTracked<T>> boolean print(
395 CloseTrackedRegistry<T> registry, PrintStream ps, String indent, int minOpenTransactions) {
396 Set<CloseTrackedRegistryReportEntry<T>> unsorted = registry.getAllUnique();
397 if (unsorted.size() < minOpenTransactions) {
401 List<CloseTrackedRegistryReportEntry<T>> entries = new ArrayList<>(unsorted);
402 entries.sort((o1, o2) -> Long.compare(o2.getNumberAddedNotRemoved(), o1.getNumberAddedNotRemoved()));
404 if (!entries.isEmpty()) {
405 ps.println(indent + registry.getAnchor() + " : " + registry.getCreateDescription());
407 entries.forEach(entry -> {
408 ps.println(indent + " " + entry.getNumberAddedNotRemoved()
409 + "x transactions opened here, which are not closed:");
410 printStackTraceElements(ps, indent + " ", entry.getStackTraceElements());
412 if (!entries.isEmpty()) {
418 private void printStackTraceElements(PrintStream ps, String indent, List<StackTraceElement> stackTraceElements) {
419 boolean ellipsis = false;
420 for (final StackTraceElement stackTraceElement : stackTraceElements) {
421 if (isStackTraceElementInteresting(stackTraceElement)) {
422 ps.println(indent + stackTraceElement);
424 } else if (!ellipsis) {
425 ps.println(indent + "(...)");
431 private boolean isStackTraceElementInteresting(StackTraceElement element) {
432 final String className = element.getClassName();
433 return !className.startsWith(getClass().getPackage().getName())
434 && !className.startsWith(CloseTracked.class.getPackage().getName())
435 && !className.startsWith("Proxy")
436 && !className.startsWith("akka")
437 && !className.startsWith("scala")
438 && !className.startsWith("sun.reflect")
439 && !className.startsWith("java.lang.reflect")
440 && !className.startsWith("org.apache.aries.blueprint")
441 && !className.startsWith("org.osgi.util.tracker");