trace/mdsal-trace-impl/src/main/java/org/opendaylight/mdsal/trace/impl/TracingBroker.java

   1 /*
   2  * Copyright (c) 2016 Red Hat, Inc. and others.  All rights reserved.
   3  *
   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
   7  */
   8 package org.opendaylight.mdsal.trace.impl;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import com.google.common.collect.ClassToInstanceMap;
  13 import com.google.common.collect.MutableClassToInstanceMap;
  14 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
  15 import java.io.PrintStream;
  16 import java.util.ArrayList;
  17 import java.util.List;
  18 import java.util.Set;
  19 import org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeSerializer;
  20 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  21 import org.opendaylight.mdsal.dom.api.ClusteredDOMDataTreeChangeListener;
  22 import org.opendaylight.mdsal.dom.api.DOMDataBroker;
  23 import org.opendaylight.mdsal.dom.api.DOMDataBrokerExtension;
  24 import org.opendaylight.mdsal.dom.api.DOMDataTreeChangeListener;
  25 import org.opendaylight.mdsal.dom.api.DOMDataTreeChangeService;
  26 import org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier;
  27 import org.opendaylight.mdsal.dom.api.DOMDataTreeReadTransaction;
  28 import org.opendaylight.mdsal.dom.api.DOMDataTreeReadWriteTransaction;
  29 import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteTransaction;
  30 import org.opendaylight.mdsal.dom.api.DOMTransactionChain;
  31 import org.opendaylight.mdsal.dom.api.DOMTransactionChainListener;
  32 import org.opendaylight.mdsal.trace.api.TracingDOMDataBroker;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.mdsaltrace.rev160908.Config;
  34 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  35 import org.opendaylight.yangtools.yang.binding.DataObject;
  36 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  37 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  38 import org.slf4j.Logger;
  39 import org.slf4j.LoggerFactory;
  40
  41 @SuppressWarnings("checkstyle:JavadocStyle")
  42 //...because otherwise it whines about the elements in the @code block even though it's completely valid Javadoc
  43
  44 /**
  45  * TracingBroker logs "write" operations and listener registrations to the md-sal. It logs the instance identifier path,
  46  * the objects themselves, as well as the stack trace of the call invoking the registration or write operation.
  47  * It works by operating as a "bump on the stack" between the application and actual DataBroker, intercepting write
  48  * and registration calls and writing to the log.
  49  *
  50  * <p>In addition, it (optionally) can also keep track of the stack trace of all new transaction allocations
  51  * (including TransactionChains, and transactions created in turn from them), in order to detect and report leaks
  52  * from transactions which were not closed.
  53  *
  54  * <h1>Wiring:</h1>
  55  * TracingBroker is designed to be easy to use. In fact, for bundles using Blueprint to inject their DataBroker
  56  * TracingBroker can be used without modifying your code at all in two simple steps:
  57  * <ol>
  58  * <li>
  59  * Simply add the dependency "mdsaltrace-features" to
  60  * your Karaf pom:
  61  * <pre>
  62  * {@code
  63  *  <dependency>
  64  *    <groupId>org.opendaylight.controller</groupId>
  65  *    <artifactId>features-mdsal-trace</artifactId>
  66  *    <version>1.7.0-SNAPSHOT</version>
  67  *    <classifier>features</classifier>
  68  *    <type>xml</type>
  69  *    <scope>runtime</scope>
  70  *  </dependency>
  71  * }
  72  * </pre>
  73  * </li>
  74  * <li>
  75  * Then just "feature:install odl-mdsal-trace" before you install your "real" feature(s) and you're done.
  76  * Beware that with Karaf 4 due to <a href="https://bugs.opendaylight.org/show_bug.cgi?id=9068">Bug 9068</a>
  77  * you'll probably have to use feature:install's --no-auto-refresh flag when installing your "real" feature.
  78  * </li>
  79  * </ol>
  80  * This works because the mdsaltrace-impl bundle registers its service implementing DOMDataBroker with a higher
  81  * rank than sal-binding-broker. As such, any OSGi service lookup for DataBroker will receive the TracingBroker.
  82  * <p> </p>
  83  * <h1>Avoiding log bloat:</h1>
  84  * TracingBroker can be configured to only print registrations or write ops pertaining to certain subtrees of the
  85  * md-sal. This can be done in the code via the methods of this class or via a config file. TracingBroker uses a more
  86  * convenient but non-standard representation of the instance identifiers. Each instance identifier segment's
  87  * class.getSimpleName() is used separated by a '/'.
  88  * <p> </p>
  89  * <h1>Known issues</h1>
  90  * <ul>
  91  *     <li>
  92  *        Filtering by paths. For some registrations the codec that converts back from the DOM to binding paths is
  93  *        busted. As such, an aproximated path is used in the output. For now it is recommended not to use
  94  *        watchRegistrations and allow all registrations to be logged.
  95  *     </li>
  96  * </ul>
  97  *
  98  */
  99 public class TracingBroker implements TracingDOMDataBroker {
 100     @SuppressFBWarnings("SLF4J_LOGGER_SHOULD_BE_PRIVATE")
 101     static final Logger LOG = LoggerFactory.getLogger(TracingBroker.class);
 102
 103     private static final int STACK_TRACE_FIRST_RELEVANT_FRAME = 2;
 104
 105     // "default" VS "pingpong"
 106     private final String type;
 107     private final BindingNormalizedNodeSerializer codec;
 108     private final DOMDataBroker delegate;
 109     private final List<Watch> registrationWatches = new ArrayList<>();
 110     private final List<Watch> writeWatches = new ArrayList<>();
 111
 112     private final boolean isDebugging;
 113     private final CloseTrackedRegistry<TracingTransactionChain> transactionChainsRegistry;
 114     private final CloseTrackedRegistry<TracingReadOnlyTransaction> readOnlyTransactionsRegistry;
 115     private final CloseTrackedRegistry<TracingWriteTransaction> writeTransactionsRegistry;
 116     private final CloseTrackedRegistry<TracingReadWriteTransaction> readWriteTransactionsRegistry;
 117
 118     private class Watch {
 119         final String iidString;
 120         final LogicalDatastoreType store;
 121
 122         Watch(String iidString, LogicalDatastoreType storeOrNull) {
 123             this.store = storeOrNull;
 124             this.iidString = iidString;
 125         }
 126
 127         private String toIidCompString(YangInstanceIdentifier iid) {
 128             StringBuilder builder = new StringBuilder();
 129             toPathString(iid, builder);
 130             builder.append('/');
 131             return builder.toString();
 132         }
 133
 134         private boolean isParent(String parent, String child) {
 135             int parentOffset = 0;
 136             if (parent.length() > 0 && parent.charAt(0) == '<') {
 137                 parentOffset = parent.indexOf('>') + 1;
 138             }
 139
 140             int childOffset = 0;
 141             if (child.length() > 0 && child.charAt(0) == '<') {
 142                 childOffset = child.indexOf('>') + 1;
 143             }
 144
 145             return child.startsWith(parent.substring(parentOffset), childOffset);
 146         }
 147
 148         @SuppressWarnings({ "checkstyle:hiddenField", "hiding" })
 149         public boolean subtreesOverlap(YangInstanceIdentifier iid, LogicalDatastoreType store) {
 150             if (this.store != null && !this.store.equals(store)) {
 151                 return false;
 152             }
 153
 154             String otherIidString = toIidCompString(iid);
 155             return isParent(iidString, otherIidString) || isParent(otherIidString, iidString);
 156         }
 157
 158         @SuppressWarnings({ "checkstyle:hiddenField", "hiding" })
 159         public boolean eventIsOfInterest(YangInstanceIdentifier iid, LogicalDatastoreType store) {
 160             if (this.store != null && !this.store.equals(store)) {
 161                 return false;
 162             }
 163
 164             return isParent(iidString, toPathString(iid));
 165         }
 166     }
 167
 168     public TracingBroker(String type, DOMDataBroker delegate, Config config, BindingNormalizedNodeSerializer codec) {
 169         this.type = requireNonNull(type, "type");
 170         this.delegate = requireNonNull(delegate, "delegate");
 171         this.codec = requireNonNull(codec, "codec");
 172         configure(config);
 173
 174         if (config.isTransactionDebugContextEnabled() != null) {
 175             this.isDebugging = config.isTransactionDebugContextEnabled();
 176         } else {
 177             this.isDebugging = false;
 178         }
 179         final String db = "DataBroker";
 180         this.transactionChainsRegistry     = new CloseTrackedRegistry<>(db, "createTransactionChain()", isDebugging);
 181         this.readOnlyTransactionsRegistry  = new CloseTrackedRegistry<>(db, "newReadOnlyTransaction()", isDebugging);
 182         this.writeTransactionsRegistry     = new CloseTrackedRegistry<>(db, "newWriteOnlyTransaction()", isDebugging);
 183         this.readWriteTransactionsRegistry = new CloseTrackedRegistry<>(db, "newReadWriteTransaction()", isDebugging);
 184     }
 185
 186     private void configure(Config config) {
 187         registrationWatches.clear();
 188         List<String> paths = config.getRegistrationWatches();
 189         if (paths != null) {
 190             for (String path : paths) {
 191                 watchRegistrations(path, null);
 192             }
 193         }
 194
 195         writeWatches.clear();
 196         paths = config.getWriteWatches();
 197         if (paths != null) {
 198             for (String path : paths) {
 199                 watchWrites(path, null);
 200             }
 201         }
 202     }
 203
 204     /**
 205      * Log registrations to this subtree of the md-sal.
 206      * @param iidString the iid path of the root of the subtree
 207      * @param store Which LogicalDataStore? or null for both
 208      */
 209     public void watchRegistrations(String iidString, LogicalDatastoreType store) {
 210         LOG.info("Watching registrations to {} in {}", iidString, store);
 211         registrationWatches.add(new Watch(iidString, store));
 212     }
 213
 214     /**
 215      * Log writes to this subtree of the md-sal.
 216      * @param iidString the iid path of the root of the subtree
 217      * @param store Which LogicalDataStore? or null for both
 218      */
 219     public void watchWrites(String iidString, LogicalDatastoreType store) {
 220         LOG.info("Watching writes to {} in {}", iidString, store);
 221         Watch watch = new Watch(iidString, store);
 222         writeWatches.add(watch);
 223     }
 224
 225     private boolean isRegistrationWatched(YangInstanceIdentifier iid, LogicalDatastoreType store) {
 226         if (registrationWatches.isEmpty()) {
 227             return true;
 228         }
 229
 230         for (Watch regInterest : registrationWatches) {
 231             if (regInterest.subtreesOverlap(iid, store)) {
 232                 return true;
 233             }
 234         }
 235
 236         return false;
 237     }
 238
 239     boolean isWriteWatched(YangInstanceIdentifier iid, LogicalDatastoreType store) {
 240         if (writeWatches.isEmpty()) {
 241             return true;
 242         }
 243
 244         for (Watch watch : writeWatches) {
 245             if (watch.eventIsOfInterest(iid, store)) {
 246                 return true;
 247             }
 248         }
 249
 250         return false;
 251     }
 252
 253     static void toPathString(InstanceIdentifier<? extends DataObject> iid, StringBuilder builder) {
 254         for (InstanceIdentifier.PathArgument pathArg : iid.getPathArguments()) {
 255             builder.append('/').append(pathArg.getType().getSimpleName());
 256         }
 257     }
 258
 259     String toPathString(YangInstanceIdentifier  yiid) {
 260         StringBuilder sb = new StringBuilder();
 261         toPathString(yiid, sb);
 262         return sb.toString();
 263     }
 264
 265
 266     private void toPathString(YangInstanceIdentifier yiid, StringBuilder sb) {
 267         InstanceIdentifier<?> iid = codec.fromYangInstanceIdentifier(yiid);
 268         if (null == iid) {
 269             reconstructIidPathString(yiid, sb);
 270         } else {
 271             toPathString(iid, sb);
 272         }
 273     }
 274
 275     private static void reconstructIidPathString(YangInstanceIdentifier yiid, StringBuilder sb) {
 276         sb.append("<RECONSTRUCTED FROM: \"").append(yiid.toString()).append("\">");
 277         for (YangInstanceIdentifier.PathArgument pathArg : yiid.getPathArguments()) {
 278             if (pathArg instanceof YangInstanceIdentifier.AugmentationIdentifier) {
 279                 sb.append('/').append("AUGMENTATION");
 280                 continue;
 281             }
 282             sb.append('/').append(pathArg.getNodeType().getLocalName());
 283         }
 284     }
 285
 286     String getStackSummary() {
 287         StackTraceElement[] stack = Thread.currentThread().getStackTrace();
 288
 289         StringBuilder sb = new StringBuilder();
 290         for (int i = STACK_TRACE_FIRST_RELEVANT_FRAME; i < stack.length; i++) {
 291             StackTraceElement frame = stack[i];
 292             sb.append("\n\t(TracingBroker)\t").append(frame.getClassName()).append('.').append(frame.getMethodName());
 293         }
 294
 295         return sb.toString();
 296     }
 297
 298     @Override
 299     public DOMDataTreeReadWriteTransaction newReadWriteTransaction() {
 300         return new TracingReadWriteTransaction(delegate.newReadWriteTransaction(), this, readWriteTransactionsRegistry);
 301     }
 302
 303     @Override
 304     public DOMDataTreeWriteTransaction newWriteOnlyTransaction() {
 305         return new TracingWriteTransaction(delegate.newWriteOnlyTransaction(), this, writeTransactionsRegistry);
 306     }
 307
 308     @Override
 309     public DOMTransactionChain createTransactionChain(DOMTransactionChainListener transactionChainListener) {
 310         return new TracingTransactionChain(delegate.createTransactionChain(transactionChainListener), this,
 311             transactionChainsRegistry);
 312     }
 313
 314     @Override
 315     public DOMTransactionChain createMergingTransactionChain(DOMTransactionChainListener transactionChainListener) {
 316         return new TracingTransactionChain(delegate.createMergingTransactionChain(transactionChainListener), this,
 317             transactionChainsRegistry);
 318     }
 319
 320     @Override
 321     public DOMDataTreeReadTransaction newReadOnlyTransaction() {
 322         return new TracingReadOnlyTransaction(delegate.newReadOnlyTransaction(), readOnlyTransactionsRegistry);
 323     }
 324
 325     @Override
 326     public ClassToInstanceMap<DOMDataBrokerExtension> getExtensions() {
 327         final ClassToInstanceMap<DOMDataBrokerExtension> delegateExt = delegate.getExtensions();
 328         final DOMDataTreeChangeService treeChangeSvc = delegateExt.getInstance(DOMDataTreeChangeService.class);
 329         if (treeChangeSvc == null) {
 330             return delegateExt;
 331         }
 332
 333         final ClassToInstanceMap<DOMDataBrokerExtension> res = MutableClassToInstanceMap.create(delegateExt);
 334         res.put(DOMDataTreeChangeService.class, new DOMDataTreeChangeService() {
 335             @Override
 336             public <L extends DOMDataTreeChangeListener> ListenerRegistration<L> registerDataTreeChangeListener(
 337                     DOMDataTreeIdentifier domDataTreeIdentifier, L listener) {
 338                 if (isRegistrationWatched(domDataTreeIdentifier.getRootIdentifier(),
 339                         domDataTreeIdentifier.getDatastoreType())) {
 340                     LOG.warn("{} registration (registerDataTreeChangeListener) for {} from {}.",
 341                             listener instanceof ClusteredDOMDataTreeChangeListener ? "Clustered" : "Non-clustered",
 342                             toPathString(domDataTreeIdentifier.getRootIdentifier()), getStackSummary());
 343                 }
 344                 return treeChangeSvc.registerDataTreeChangeListener(domDataTreeIdentifier, listener);
 345             }
 346         });
 347
 348         return res;
 349     }
 350
 351     @Override
 352     public boolean printOpenTransactions(PrintStream ps, int minOpenTXs) {
 353         if (transactionChainsRegistry.getAllUnique().isEmpty()
 354             && readOnlyTransactionsRegistry.getAllUnique().isEmpty()
 355             && writeTransactionsRegistry.getAllUnique().isEmpty()
 356             && readWriteTransactionsRegistry.getAllUnique().isEmpty()) {
 357
 358             ps.println(type + ": No open transactions, great!");
 359             return false;
 360         }
 361
 362         ps.println(type + ": " + getClass().getSimpleName()
 363                  + " found some not yet (or never..) closed transaction[chain]s!");
 364         ps.println("[NB: If no stack traces are shown below, then "
 365                  + "enable transaction-debug-context-enabled in mdsaltrace_config.xml]");
 366         ps.println();
 367         // Flag to track if we really found any real leaks with more (or equal) to minOpenTXs
 368         boolean hasFound = print(readOnlyTransactionsRegistry, ps, "  ", minOpenTXs);
 369         hasFound |= print(writeTransactionsRegistry, ps, "  ", minOpenTXs);
 370         hasFound |= print(readWriteTransactionsRegistry, ps, "  ", minOpenTXs);
 371
 372         // Now print details for each non-closed TransactionChain
 373         // incl. in turn each ones own read/Write[Only]TransactionsRegistry
 374         Set<CloseTrackedRegistryReportEntry<TracingTransactionChain>>
 375             entries = transactionChainsRegistry.getAllUnique();
 376         if (!entries.isEmpty()) {
 377             ps.println("  " + transactionChainsRegistry.getAnchor() + " : "
 378                     + transactionChainsRegistry.getCreateDescription());
 379         }
 380         for (CloseTrackedRegistryReportEntry<TracingTransactionChain> entry : entries) {
 381             ps.println("    " + entry.getNumberAddedNotRemoved() + "x TransactionChains opened but not closed here:");
 382             printStackTraceElements(ps, "      ", entry.getStackTraceElements());
 383             @SuppressWarnings("resource")
 384             TracingTransactionChain txChain = (TracingTransactionChain) entry
 385                 .getExampleCloseTracked().getRealCloseTracked();
 386             hasFound |= print(txChain.getReadOnlyTransactionsRegistry(), ps, "        ", minOpenTXs);
 387             hasFound |= print(txChain.getWriteTransactionsRegistry(), ps, "        ", minOpenTXs);
 388             hasFound |= print(txChain.getReadWriteTransactionsRegistry(), ps, "        ", minOpenTXs);
 389         }
 390         ps.println();
 391
 392         return hasFound;
 393     }
 394
 395     private <T extends CloseTracked<T>> boolean print(
 396             CloseTrackedRegistry<T> registry, PrintStream ps, String indent, int minOpenTransactions) {
 397         Set<CloseTrackedRegistryReportEntry<T>> unsorted = registry.getAllUnique();
 398         if (unsorted.size() < minOpenTransactions) {
 399             return false;
 400         }
 401
 402         List<CloseTrackedRegistryReportEntry<T>> entries = new ArrayList<>(unsorted);
 403         entries.sort((o1, o2) -> Long.compare(o2.getNumberAddedNotRemoved(), o1.getNumberAddedNotRemoved()));
 404
 405         if (!entries.isEmpty()) {
 406             ps.println(indent + registry.getAnchor() + " : " + registry.getCreateDescription());
 407         }
 408         entries.forEach(entry -> {
 409             ps.println(indent + "  " + entry.getNumberAddedNotRemoved()
 410                 + "x transactions opened here, which are not closed:");
 411             printStackTraceElements(ps, indent + "    ", entry.getStackTraceElements());
 412         });
 413         if (!entries.isEmpty()) {
 414             ps.println();
 415         }
 416         return true;
 417     }
 418
 419     private void printStackTraceElements(PrintStream ps, String indent, List<StackTraceElement> stackTraceElements) {
 420         boolean ellipsis = false;
 421         for (final StackTraceElement stackTraceElement : stackTraceElements) {
 422             if (isStackTraceElementInteresting(stackTraceElement)) {
 423                 ps.println(indent + stackTraceElement);
 424                 ellipsis = false;
 425             } else if (!ellipsis) {
 426                 ps.println(indent + "(...)");
 427                 ellipsis = true;
 428             }
 429         }
 430     }
 431
 432     private boolean isStackTraceElementInteresting(StackTraceElement element) {
 433         final String className = element.getClassName();
 434         return !className.startsWith(getClass().getPackage().getName())
 435             && !className.startsWith(CloseTracked.class.getPackage().getName())
 436             && !className.startsWith("Proxy")
 437             && !className.startsWith("akka")
 438             && !className.startsWith("scala")
 439             && !className.startsWith("sun.reflect")
 440             && !className.startsWith("java.lang.reflect")
 441             && !className.startsWith("org.apache.aries.blueprint")
 442             && !className.startsWith("org.osgi.util.tracker");
 443     }
 444 }