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.util.concurrent.FutureCallback;
  12 import com.google.common.util.concurrent.Futures;
  13 import com.google.common.util.concurrent.ListenableFuture;
  14 import java.util.Objects;
  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.SemaphoreKeeperGuavaImpl;
  22 import org.opendaylight.openflowplugin.applications.frsync.util.SyncupEntry;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNode;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
  25 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  26 import org.slf4j.Logger;
  27 import org.slf4j.LoggerFactory;
  28
  29 /**
  30  * Decorator for NodeId level syncup locking.
  31  */
  32 public class SyncReactorGuardDecorator implements SyncReactor {
  33
  34     private static final Logger LOG = LoggerFactory.getLogger(SyncReactorGuardDecorator.class);
  35     private final SyncReactor delegate;
  36     private final SemaphoreKeeper<InstanceIdentifier<FlowCapableNode>> semaphoreKeeper =
  37             new SemaphoreKeeperGuavaImpl<>(1, true);
  38
  39     public SyncReactorGuardDecorator(final SyncReactor delegate) {
  40         this.delegate = delegate;
  41     }
  42
  43     public ListenableFuture<Boolean> syncup(final InstanceIdentifier<FlowCapableNode> flowcapableNodePath,
  44                                             final SyncupEntry syncupEntry) {
  45         final NodeId nodeId = PathUtil.digNodeId(flowcapableNodePath);
  46         final long stampBeforeGuard = System.nanoTime();
  47         final Semaphore guard = semaphoreKeeper.summonGuardAndAcquire(flowcapableNodePath);
  48         if (Objects.isNull(guard)) {
  49             return Futures.immediateFuture(Boolean.FALSE);
  50         }
  51         final long stampAfterGuard = System.nanoTime();
  52
  53         if (LOG.isDebugEnabled()) {
  54             LOG.debug("Syncup guard acquired and running for {} ", nodeId.getValue());
  55         }
  56         final ListenableFuture<Boolean> endResult = delegate.syncup(flowcapableNodePath, syncupEntry);
  57         Futures.addCallback(endResult, createSyncupCallback(guard, stampBeforeGuard, stampAfterGuard, nodeId));
  58         return endResult;
  59     }
  60
  61     private FutureCallback<Boolean> createSyncupCallback(final Semaphore guard,
  62                                                          final long stampBeforeGuard,
  63                                                          final long stampAfterGuard,
  64                                                          final NodeId nodeId) {
  65         return new FutureCallback<Boolean>() {
  66             @Override
  67             public void onSuccess(@Nullable final Boolean result) {
  68                 if (LOG.isDebugEnabled()) {
  69                     final long stampFinished = System.nanoTime();
  70                     LOG.debug("Syncup finished {} took:{} rpc:{} wait:{}", nodeId.getValue(),
  71                             formatNanos(stampFinished - stampBeforeGuard), formatNanos(stampFinished - stampAfterGuard),
  72                             formatNanos(stampAfterGuard - stampBeforeGuard));
  73                 }
  74                 semaphoreKeeper.releaseGuard(guard);
  75             }
  76             @Override
  77             public void onFailure(final Throwable t) {
  78                 final long stampFinished = System.nanoTime();
  79                 LOG.warn("Syncup failed {} took:{} rpc:{} wait:{}", nodeId.getValue(),
  80                         formatNanos(stampFinished - stampBeforeGuard), formatNanos(stampFinished - stampAfterGuard),
  81                         formatNanos(stampAfterGuard - stampBeforeGuard));
  82                 semaphoreKeeper.releaseGuard(guard);
  83             }};
  84     }
  85
  86     private static String formatNanos(final long nanos) {
  87         return "'" + TimeUnit.NANOSECONDS.toMillis(nanos) + " ms'";
  88     }
  89 }