2 * Copyright (c) 2016 Cisco Systems, 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
9 package org.opendaylight.openflowplugin.applications.frsync.impl;
11 import com.google.common.base.Optional;
12 import com.google.common.util.concurrent.ListenableFuture;
13 import java.util.Collection;
14 import org.opendaylight.controller.md.sal.binding.api.DataObjectModification;
15 import org.opendaylight.controller.md.sal.binding.api.DataTreeModification;
16 import org.opendaylight.controller.md.sal.common.api.data.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;
29 * Listens to config changes and delegates sync entry to {@link SyncReactor}.
31 public class SimplifiedConfigListener extends AbstractFrmSyncListener<FlowCapableNode> {
32 private static final Logger LOG = LoggerFactory.getLogger(SimplifiedConfigListener.class);
33 private final SyncReactor reactor;
34 private final FlowCapableNodeSnapshotDao configSnapshot;
35 private final FlowCapableNodeDao operationalDao;
37 public SimplifiedConfigListener(final SyncReactor reactor,
38 final FlowCapableNodeSnapshotDao configSnapshot,
39 final FlowCapableNodeDao operationalDao) {
40 this.reactor = reactor;
41 this.configSnapshot = configSnapshot;
42 this.operationalDao = operationalDao;
46 public void onDataTreeChanged(Collection<DataTreeModification<FlowCapableNode>> modifications) {
47 LOG.trace("Config changes: {}", modifications.size());
48 super.onDataTreeChanged(modifications);
52 * Update cache. If operational data are present, choose appropriate data and start syncup.
53 * Otherwise skip incoming change.
54 * @throws InterruptedException from syncup
56 protected Optional<ListenableFuture<Boolean>> processNodeModification(
57 DataTreeModification<FlowCapableNode> modification) throws InterruptedException {
58 final InstanceIdentifier<FlowCapableNode> nodePath = modification.getRootPath().getRootIdentifier();
59 final NodeId nodeId = PathUtil.digNodeId(nodePath);
61 configSnapshot.updateCache(nodeId, Optional.fromNullable(modification.getRootNode().getDataAfter()));
63 final Optional<FlowCapableNode> operationalNode = operationalDao.loadByNodeId(nodeId);
64 if (!operationalNode.isPresent()) {
65 LOG.info("Skip syncup, {} operational is not present", nodeId.getValue());
66 return Optional.absent();
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);
78 endResult = onNodeUpdated(nodePath, dataBefore, dataAfter);
81 return Optional.of(endResult);
85 * Add only what is missing on device. If node was added to config DS and it is already present
86 * in operational DS (connected) diff between current new configuration and actual configuration
87 * (seen in operational) should be calculated and sent to device.
89 private ListenableFuture<Boolean> onNodeAdded(final InstanceIdentifier<FlowCapableNode> nodePath,
90 final FlowCapableNode dataAfter,
91 final FlowCapableNode operationalNode) throws InterruptedException {
92 NodeId nodeId = PathUtil.digNodeId(nodePath);
93 LOG.trace("onNodeAdded {}", nodeId.getValue());
94 LOG.debug("Reconciliation {}: {}", dsType(), nodeId.getValue());
95 final SyncupEntry syncupEntry = new SyncupEntry(dataAfter, dsType(), operationalNode, LogicalDatastoreType.OPERATIONAL);
96 return reactor.syncup(nodePath, syncupEntry);
100 * Apply minimal changes very fast. For better performance needed just compare config
101 * after+before. Config listener should not be dependent on operational flows/groups/meters while
102 * updating config because operational store is highly async and it depends on another module in
103 * system which is updating operational store (that components is also trying to solve
104 * scale/performance issues on several layers).
106 private ListenableFuture<Boolean> onNodeUpdated(final InstanceIdentifier<FlowCapableNode> nodePath,
107 final FlowCapableNode dataBefore,
108 final FlowCapableNode dataAfter) throws InterruptedException {
109 NodeId nodeId = PathUtil.digNodeId(nodePath);
110 LOG.trace("onNodeUpdated {}", nodeId.getValue());
111 final SyncupEntry syncupEntry = new SyncupEntry(dataAfter, dsType(), dataBefore, dsType());
112 return reactor.syncup(nodePath, syncupEntry);
116 * Remove values that are being deleted in the config from the switch.
117 * Note, this could be probably optimized using dedicated wipe-out RPC.
119 private ListenableFuture<Boolean> onNodeDeleted(final InstanceIdentifier<FlowCapableNode> nodePath,
120 final FlowCapableNode dataBefore) throws InterruptedException {
121 NodeId nodeId = PathUtil.digNodeId(nodePath);
122 LOG.trace("onNodeDeleted {}", nodeId.getValue());
123 final SyncupEntry syncupEntry = new SyncupEntry(null, dsType(), dataBefore, dsType());
124 return reactor.syncup(nodePath, syncupEntry);
128 public LogicalDatastoreType dsType() {
129 return LogicalDatastoreType.CONFIGURATION;