applications/forwardingrules-sync/src/main/java/org/opendaylight/openflowplugin/applications/frsync/impl/SyncReactorGuardDecorator.java

   1 /**
   2  * Copyright (c) 2016 Cisco Systems, 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
   9 package org.opendaylight.openflowplugin.applications.frsync.impl;
  10
  11 import com.google.common.base.Preconditions;
  12 import com.google.common.util.concurrent.FutureCallback;
  13 import com.google.common.util.concurrent.Futures;
  14 import com.google.common.util.concurrent.ListenableFuture;
  15 import java.util.concurrent.Semaphore;
  16 import java.util.concurrent.TimeUnit;
  17 import javax.annotation.Nullable;
  18 import org.opendaylight.openflowplugin.applications.frsync.SemaphoreKeeper;
  19 import org.opendaylight.openflowplugin.applications.frsync.SyncReactor;
  20 import org.opendaylight.openflowplugin.applications.frsync.util.PathUtil;
  21 import org.opendaylight.openflowplugin.applications.frsync.util.SyncupEntry;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNode;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
  24 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  25 import org.slf4j.Logger;
  26 import org.slf4j.LoggerFactory;
  27
  28 /**
  29  * Decorator for NodeId level syncup locking.
  30  */
  31 public class SyncReactorGuardDecorator implements SyncReactor {
  32
  33     private static final Logger LOG = LoggerFactory.getLogger(SyncReactorGuardDecorator.class);
  34
  35     private final SyncReactor delegate;
  36     private final SemaphoreKeeper<InstanceIdentifier<FlowCapableNode>> semaphoreKeeper;
  37
  38     public SyncReactorGuardDecorator(SyncReactor delegate,
  39             SemaphoreKeeper<InstanceIdentifier<FlowCapableNode>> semaphoreKeeper) {
  40         this.delegate = delegate;
  41         this.semaphoreKeeper = semaphoreKeeper;
  42     }
  43
  44     public ListenableFuture<Boolean> syncup(final InstanceIdentifier<FlowCapableNode> flowcapableNodePath,
  45                                             final SyncupEntry syncupEntry) throws InterruptedException {
  46         final NodeId nodeId = PathUtil.digNodeId(flowcapableNodePath);
  47         LOG.trace("syncup guard decorator: {}", nodeId.getValue());
  48
  49         final long stampBeforeGuard = System.nanoTime();
  50         final Semaphore guard = summonGuardAndAcquire(flowcapableNodePath);
  51         if (guard == null) {
  52             return Futures.immediateFuture(false);
  53         }
  54         final long stampAfterGuard = System.nanoTime();
  55
  56         try {
  57             if (LOG.isDebugEnabled()) {
  58                 LOG.debug("syncup start {} waiting:{} guard:{} thread:{}", nodeId.getValue(),
  59                         formatNanos(stampAfterGuard - stampBeforeGuard),
  60                         guard, threadName());
  61             }
  62
  63             final ListenableFuture<Boolean> endResult =
  64                     delegate.syncup(flowcapableNodePath, syncupEntry);
  65
  66             Futures.addCallback(endResult, new FutureCallback<Boolean>() {
  67                 @Override
  68                 public void onSuccess(@Nullable final Boolean result) {
  69                     if (LOG.isDebugEnabled()) {
  70                         final long stampFinished = System.nanoTime();
  71                         LOG.debug("syncup finished {} took:{} rpc:{} wait:{} guard:{} permits thread:{}", nodeId.getValue(),
  72                                 formatNanos(stampFinished - stampBeforeGuard),
  73                                 formatNanos(stampFinished - stampAfterGuard),
  74                                 formatNanos(stampAfterGuard - stampBeforeGuard),
  75                                 guard.availablePermits(), threadName());
  76                     }
  77
  78                     releaseGuardForNodeId(guard);
  79                 }
  80
  81                 @Override
  82                 public void onFailure(final Throwable t) {
  83                     if (LOG.isDebugEnabled()) {
  84                         final long stampFinished = System.nanoTime();
  85                         LOG.warn("syncup failed {} took:{} rpc:{} wait:{} guard:{} permits thread:{}", nodeId.getValue(),
  86                                 formatNanos(stampFinished - stampBeforeGuard),
  87                                 formatNanos(stampFinished - stampAfterGuard),
  88                                 formatNanos(stampAfterGuard - stampBeforeGuard),
  89                                 guard.availablePermits(), threadName());
  90                     }
  91
  92                     releaseGuardForNodeId(guard);
  93                 }
  94             });
  95             return endResult;
  96         } catch (InterruptedException e) {
  97             releaseGuardForNodeId(guard);
  98             throw e;
  99         }
 100     }
 101
 102     private String formatNanos(long nanos) {
 103         return "'" + TimeUnit.NANOSECONDS.toMillis(nanos) + " ms'";
 104     }
 105
 106     /**
 107      * Get guard and lock for node.
 108      * @param flowcapableNodePath II of node for which guard should be acquired
 109      * @return semaphore guard
 110      */
 111     private Semaphore summonGuardAndAcquire(final InstanceIdentifier<FlowCapableNode> flowcapableNodePath) {
 112         final NodeId nodeId = PathUtil.digNodeId(flowcapableNodePath);
 113         final Semaphore guard = Preconditions.checkNotNull(semaphoreKeeper.summonGuard(flowcapableNodePath),
 114                 "no guard for " + nodeId.getValue());
 115         try {
 116             guard.acquire();
 117         } catch (InterruptedException e) {
 118             LOG.error("syncup summon {} failed {}", nodeId.getValue(), e);
 119             return null;
 120         }
 121         LOG.trace("syncup summon {} guard:{} thread:{}", nodeId.getValue(), guard, threadName());
 122         return guard;
 123     }
 124
 125     /**
 126      * Unlock and release guard.
 127      * @param guard semaphore guard which should be unlocked
 128      */
 129     private void releaseGuardForNodeId(final Semaphore guard) {
 130         if (guard != null) {
 131             guard.release();
 132             LOG.trace("syncup release guard:{} thread:{}", guard, threadName());
 133         }
 134     }
 135
 136     private static String threadName() {
 137         final Thread currentThread = Thread.currentThread();
 138         return currentThread.getName();
 139     }
 140
 141 }