applications/forwardingrules-sync/src/main/java/org/opendaylight/openflowplugin/applications/frsync/impl/SimplifiedConfigListener.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 package org.opendaylight.openflowplugin.applications.frsync.impl;
   9
  10 import com.google.common.util.concurrent.ListenableFuture;
  11 import java.util.Collection;
  12 import java.util.Optional;
  13 import javax.annotation.Nonnull;
  14 import org.opendaylight.mdsal.binding.api.DataObjectModification;
  15 import org.opendaylight.mdsal.binding.api.DataTreeModification;
  16 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  17 import org.opendaylight.openflowplugin.applications.frsync.SyncReactor;
  18 import org.opendaylight.openflowplugin.applications.frsync.dao.FlowCapableNodeDao;
  19 import org.opendaylight.openflowplugin.applications.frsync.dao.FlowCapableNodeSnapshotDao;
  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  * Listens to config changes and delegates sync entry to {@link SyncReactor}.
  30  */
  31 public class SimplifiedConfigListener extends AbstractFrmSyncListener<FlowCapableNode> {
  32
  33     private static final Logger LOG = LoggerFactory.getLogger(SimplifiedConfigListener.class);
  34     private final SyncReactor reactor;
  35     private final FlowCapableNodeSnapshotDao configSnapshot;
  36     private final FlowCapableNodeDao operationalDao;
  37
  38     public SimplifiedConfigListener(final SyncReactor reactor,
  39                                     final FlowCapableNodeSnapshotDao configSnapshot,
  40                                     final FlowCapableNodeDao operationalDao) {
  41         this.reactor = reactor;
  42         this.configSnapshot = configSnapshot;
  43         this.operationalDao = operationalDao;
  44     }
  45
  46     @Override
  47     public void onDataTreeChanged(@Nonnull final Collection<DataTreeModification<FlowCapableNode>> modifications) {
  48         super.onDataTreeChanged(modifications);
  49     }
  50
  51     /**
  52      * Update cache. If operational data are present, choose appropriate data and start syncup.
  53      * Otherwise skip incoming change.
  54      */
  55     @Override
  56     protected Optional<ListenableFuture<Boolean>> processNodeModification(
  57             final DataTreeModification<FlowCapableNode> modification) {
  58         final InstanceIdentifier<FlowCapableNode> nodePath = modification.getRootPath().getRootIdentifier();
  59         final NodeId nodeId = PathUtil.digNodeId(nodePath);
  60
  61         configSnapshot.updateCache(nodeId, Optional.ofNullable(modification.getRootNode().getDataAfter()));
  62
  63         final Optional<FlowCapableNode> operationalNode = operationalDao.loadByNodeId(nodeId);
  64         if (!operationalNode.isPresent()) {
  65             LOG.debug("Skip syncup, {} operational is not present", nodeId.getValue());
  66             return Optional.empty();
  67         }
  68
  69         final DataObjectModification<FlowCapableNode> configModification = modification.getRootNode();
  70         final FlowCapableNode dataBefore = configModification.getDataBefore();
  71         final FlowCapableNode dataAfter = configModification.getDataAfter();
  72         final ListenableFuture<Boolean> endResult;
  73         if (dataBefore == null && dataAfter != null) {
  74             endResult = onNodeAdded(nodePath, dataAfter, operationalNode.get());
  75         } else if (dataBefore != null && dataAfter == null) {
  76             endResult = onNodeDeleted(nodePath, dataBefore);
  77         } else {
  78             endResult = onNodeUpdated(nodePath, dataBefore, dataAfter);
  79         }
  80
  81         return Optional.of(endResult);
  82     }
  83
  84     /**
  85      * If node was added to config DS and it is already present in operational DS (connected) diff between current
  86      * new configuration and actual configuration (seen in operational) should be calculated and sent to device.
  87      */
  88     private ListenableFuture<Boolean> onNodeAdded(final InstanceIdentifier<FlowCapableNode> nodePath,
  89                                                   final FlowCapableNode dataAfter,
  90                                                   final FlowCapableNode operationalNode) {
  91         LOG.debug("Reconciliation {}: {}", dsType(), PathUtil.digNodeId(nodePath).getValue());
  92         final SyncupEntry syncupEntry = new SyncupEntry(dataAfter, dsType(), operationalNode,
  93                 LogicalDatastoreType.OPERATIONAL);
  94         return reactor.syncup(nodePath, syncupEntry);
  95     }
  96
  97     /**
  98      * Apply minimal changes very fast. For better performance needed just compare config
  99      * after+before. Config listener should not be dependent on operational flows/groups/meters while
 100      * updating config because operational store is highly async and it depends on another module in
 101      * system which is updating operational store (that components is also trying to solve
 102      * scale/performance issues on several layers).
 103      */
 104     private ListenableFuture<Boolean> onNodeUpdated(final InstanceIdentifier<FlowCapableNode> nodePath,
 105                                                     final FlowCapableNode dataBefore,
 106                                                     final FlowCapableNode dataAfter) {
 107         final SyncupEntry syncupEntry = new SyncupEntry(dataAfter, dsType(), dataBefore, dsType());
 108         return reactor.syncup(nodePath, syncupEntry);
 109     }
 110
 111     /**
 112      * Remove values that are being deleted in the config from the switch.
 113      * Note, this could be probably optimized using dedicated wipe-out RPC.
 114      */
 115     private ListenableFuture<Boolean> onNodeDeleted(final InstanceIdentifier<FlowCapableNode> nodePath,
 116                                                     final FlowCapableNode dataBefore) {
 117         final SyncupEntry syncupEntry = new SyncupEntry(null, dsType(), dataBefore, dsType());
 118         return reactor.syncup(nodePath, syncupEntry);
 119     }
 120
 121     @Override
 122     public LogicalDatastoreType dsType() {
 123         return LogicalDatastoreType.CONFIGURATION;
 124     }
 125 }