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
8 package org.opendaylight.openflowplugin.applications.frsync.impl;
10 import static java.util.Objects.requireNonNull;
12 import com.google.common.util.concurrent.ThreadFactoryBuilder;
13 import java.util.concurrent.ExecutorService;
14 import java.util.concurrent.Executors;
15 import javax.annotation.PreDestroy;
16 import javax.inject.Inject;
17 import javax.inject.Singleton;
18 import org.opendaylight.mdsal.binding.api.DataBroker;
19 import org.opendaylight.mdsal.binding.api.DataTreeIdentifier;
20 import org.opendaylight.mdsal.binding.api.RpcConsumerRegistry;
21 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
22 import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonServiceProvider;
23 import org.opendaylight.openflowplugin.applications.frsync.NodeListener;
24 import org.opendaylight.openflowplugin.applications.frsync.dao.FlowCapableNodeCachedDao;
25 import org.opendaylight.openflowplugin.applications.frsync.dao.FlowCapableNodeOdlDao;
26 import org.opendaylight.openflowplugin.applications.frsync.dao.FlowCapableNodeSnapshotDao;
27 import org.opendaylight.openflowplugin.applications.frsync.impl.clustering.DeviceMastershipManager;
28 import org.opendaylight.openflowplugin.applications.frsync.impl.strategy.SyncPlanPushStrategyFlatBatchImpl;
29 import org.opendaylight.openflowplugin.applications.frsync.util.ReconciliationRegistry;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.flat.batch.service.rev160321.ProcessFlatBatch;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNode;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.table.service.rev131026.UpdateTable;
35 import org.opendaylight.yangtools.concepts.ListenerRegistration;
36 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
37 import org.osgi.service.component.annotations.Activate;
38 import org.osgi.service.component.annotations.Component;
39 import org.osgi.service.component.annotations.Deactivate;
40 import org.osgi.service.component.annotations.Reference;
41 import org.slf4j.Logger;
42 import org.slf4j.LoggerFactory;
45 * Top provider of forwarding rules synchronization functionality.
48 @Component(service = { })
49 public class ForwardingRulesSyncProvider implements AutoCloseable {
50 private static final Logger LOG = LoggerFactory.getLogger(ForwardingRulesSyncProvider.class);
51 private static final String FRS_EXECUTOR_PREFIX = "FRS-executor-";
53 private final DataBroker dataService;
54 private final ClusterSingletonServiceProvider clusterSingletonService;
55 private final UpdateTable updateTable;
56 private final ProcessFlatBatch processFlatBatch;
58 /** Wildcard path to flow-capable-node augmentation of inventory node. */
59 private static final InstanceIdentifier<FlowCapableNode> FLOW_CAPABLE_NODE_WC_PATH =
60 InstanceIdentifier.create(Nodes.class).child(Node.class).augmentation(FlowCapableNode.class);
61 /** Wildcard path to node (not flow-capable-node augmentation) of inventory node. */
62 private static final InstanceIdentifier<Node> NODE_WC_PATH =
63 InstanceIdentifier.create(Nodes.class).child(Node.class);
65 private final DataTreeIdentifier<FlowCapableNode> nodeConfigDataTreePath;
66 private final DataTreeIdentifier<Node> nodeOperationalDataTreePath;
68 private ListenerRegistration<?> dataTreeConfigChangeListener;
69 private ListenerRegistration<?> dataTreeOperationalChangeListener;
71 private final ExecutorService syncThreadPool;
75 public ForwardingRulesSyncProvider(@Reference final DataBroker dataBroker,
76 @Reference final RpcConsumerRegistry rpcRegistry,
77 @Reference final ClusterSingletonServiceProvider clusterSingletonService) {
78 requireNonNull(rpcRegistry, "RpcConsumerRegistry can not be null!");
79 dataService = requireNonNull(dataBroker, "DataBroker can not be null!");
80 this.clusterSingletonService = requireNonNull(clusterSingletonService,
81 "ClusterSingletonServiceProvider can not be null!");
82 updateTable = requireNonNull(rpcRegistry.getRpc(UpdateTable.class),
83 "RPC UpdateTable not found.");
84 processFlatBatch = requireNonNull(rpcRegistry.getRpc(ProcessFlatBatch.class),
85 "RPC SalFlatBatchService not found.");
87 nodeConfigDataTreePath = DataTreeIdentifier.create(LogicalDatastoreType.CONFIGURATION,
88 FLOW_CAPABLE_NODE_WC_PATH);
89 nodeOperationalDataTreePath = DataTreeIdentifier.create(LogicalDatastoreType.OPERATIONAL, NODE_WC_PATH);
91 syncThreadPool = Executors.newCachedThreadPool(new ThreadFactoryBuilder()
92 .setNameFormat(FRS_EXECUTOR_PREFIX + "%d")
94 .setUncaughtExceptionHandler((thread, ex) -> LOG.error("Uncaught exception {}", thread, ex))
97 final var syncPlanPushStrategy = new SyncPlanPushStrategyFlatBatchImpl(processFlatBatch);
99 final var reconciliationRegistry = new ReconciliationRegistry();
100 final var deviceMastershipManager = new DeviceMastershipManager(clusterSingletonService,
101 reconciliationRegistry);
103 final var syncReactorImpl = new SyncReactorImpl(syncPlanPushStrategy);
104 final var syncReactorRetry = new SyncReactorRetryDecorator(syncReactorImpl, reconciliationRegistry);
105 final var syncReactorGuard = new SyncReactorGuardDecorator(syncReactorRetry);
106 final var syncReactorFutureZip = new SyncReactorFutureZipDecorator(syncReactorGuard, syncThreadPool);
108 final var reactor = new SyncReactorClusterDecorator(syncReactorFutureZip, deviceMastershipManager);
110 final var configSnapshot = new FlowCapableNodeSnapshotDao();
111 final var operationalSnapshot = new FlowCapableNodeSnapshotDao();
112 final var configDao = new FlowCapableNodeCachedDao(configSnapshot,
113 new FlowCapableNodeOdlDao(dataService, LogicalDatastoreType.CONFIGURATION));
114 final var operationalDao = new FlowCapableNodeCachedDao(operationalSnapshot,
115 new FlowCapableNodeOdlDao(dataService, LogicalDatastoreType.OPERATIONAL));
117 final NodeListener<FlowCapableNode> nodeListenerConfig =
118 new SimplifiedConfigListener(reactor, configSnapshot, operationalDao);
119 final NodeListener<Node> nodeListenerOperational = new SimplifiedOperationalListener(reactor,
120 operationalSnapshot, configDao, reconciliationRegistry, deviceMastershipManager);
122 dataTreeConfigChangeListener =
123 dataService.registerDataTreeChangeListener(nodeConfigDataTreePath, nodeListenerConfig);
124 dataTreeOperationalChangeListener =
125 dataService.registerDataTreeChangeListener(nodeOperationalDataTreePath, nodeListenerOperational);
126 LOG.info("ForwardingRulesSync started");
132 public void close() {
133 if (dataTreeConfigChangeListener != null) {
134 dataTreeConfigChangeListener.close();
135 dataTreeConfigChangeListener = null;
138 if (dataTreeOperationalChangeListener != null) {
139 dataTreeOperationalChangeListener.close();
140 dataTreeOperationalChangeListener = null;
143 syncThreadPool.shutdown();
144 LOG.info("ForwardingRulesSync stopped");