2 * Copyright (c) 2018 Ericsson India Global Services Pvt Ltd. 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.southboundcli;
11 import static org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.reconciliation.service.rev180227.NodeReconcileState.State.COMPLETED;
12 import static org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.reconciliation.service.rev180227.NodeReconcileState.State.FAILED;
13 import static org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.reconciliation.service.rev180227.NodeReconcileState.State.INPROGRESS;
15 import com.google.common.util.concurrent.ListenableFuture;
16 import com.google.common.util.concurrent.SettableFuture;
17 import java.math.BigInteger;
18 import java.text.SimpleDateFormat;
19 import java.util.ArrayList;
20 import java.util.Date;
21 import java.util.List;
22 import java.util.Optional;
23 import java.util.concurrent.ExecutionException;
24 import java.util.concurrent.ExecutorService;
25 import java.util.concurrent.Executors;
26 import java.util.concurrent.Future;
27 import java.util.stream.Collectors;
28 import org.opendaylight.mdsal.binding.api.DataBroker;
29 import org.opendaylight.mdsal.binding.api.ReadTransaction;
30 import org.opendaylight.mdsal.binding.api.ReadWriteTransaction;
31 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
32 import org.opendaylight.openflowplugin.applications.southboundcli.alarm.AlarmAgent;
33 import org.opendaylight.openflowplugin.applications.southboundcli.util.OFNode;
34 import org.opendaylight.openflowplugin.applications.southboundcli.util.ShellUtil;
35 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.DateAndTime;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.frm.reconciliation.service.rev180227.FrmReconciliationService;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.frm.reconciliation.service.rev180227.ReconcileNodeInput;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.frm.reconciliation.service.rev180227.ReconcileNodeInputBuilder;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.frm.reconciliation.service.rev180227.ReconcileNodeOutput;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.reconciliation.service.rev180227.NodeReconcileState.State;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.reconciliation.service.rev180227.ReconcileInput;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.reconciliation.service.rev180227.ReconcileOutput;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.reconciliation.service.rev180227.ReconcileOutputBuilder;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.reconciliation.service.rev180227.ReconciliationCounter;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.reconciliation.service.rev180227.ReconciliationService;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.reconciliation.service.rev180227.ReconciliationState;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.reconciliation.service.rev180227.reconciliation.counter.ReconcileCounter;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.reconciliation.service.rev180227.reconciliation.counter.ReconcileCounterBuilder;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.reconciliation.service.rev180227.reconciliation.counter.ReconcileCounterKey;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.reconciliation.service.rev180227.reconciliation.state.ReconciliationStateList;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.reconciliation.service.rev180227.reconciliation.state.ReconciliationStateListBuilder;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.reconciliation.service.rev180227.reconciliation.state.ReconciliationStateListKey;
58 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
59 import org.opendaylight.yangtools.yang.common.RpcError;
60 import org.opendaylight.yangtools.yang.common.RpcResult;
61 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
62 import org.opendaylight.yangtools.yang.common.Uint64;
63 import org.slf4j.Logger;
64 import org.slf4j.LoggerFactory;
66 public class ReconciliationServiceImpl implements ReconciliationService, AutoCloseable {
68 private static final Logger LOG = LoggerFactory.getLogger(ReconciliationServiceImpl.class);
70 private final DataBroker broker;
71 private final FrmReconciliationService frmReconciliationService;
72 private final AlarmAgent alarmAgent;
73 private final Long startCount = 1L;
74 private final int threadPoolSize = 10;
75 private final ExecutorService executor = Executors.newWorkStealingPool(threadPoolSize);
77 public ReconciliationServiceImpl(final DataBroker broker, final FrmReconciliationService frmReconciliationService,
78 final AlarmAgent alarmAgent) {
80 this.frmReconciliationService = frmReconciliationService;
81 this.alarmAgent = alarmAgent;
86 if (executor != null) {
87 executor.shutdownNow();
92 public ListenableFuture<RpcResult<ReconcileOutput>> reconcile(ReconcileInput input) {
93 boolean reconcileAllNodes = input.isReconcileAllNodes();
94 List<Uint64> inputNodes = input.getNodes();
95 if (inputNodes == null) {
96 inputNodes = new ArrayList<>();
98 if (reconcileAllNodes && inputNodes.size() > 0) {
99 return buildErrorResponse("Error executing command reconcile. "
100 + "If 'all' option is enabled, no Node must be specified as input parameter.");
102 if (!reconcileAllNodes && inputNodes.size() == 0) {
103 return buildErrorResponse("Error executing command reconcile. No Node information was specified.");
105 SettableFuture<RpcResult<ReconcileOutput>> result = SettableFuture.create();
106 List<Long> nodeList = getAllNodes();
107 List<Long> nodesToReconcile = reconcileAllNodes ? nodeList :
108 inputNodes.stream().distinct().map(Uint64::longValue).collect(Collectors.toList());
109 if (nodesToReconcile.size() > 0) {
110 List<Long> unresolvedNodes =
111 nodesToReconcile.stream().filter(node -> !nodeList.contains(node)).collect(Collectors.toList());
112 if (!unresolvedNodes.isEmpty()) {
113 return buildErrorResponse("Error executing command reconcile. "
114 + "Node(s) not found: " + String.join(", ", unresolvedNodes.toString()));
116 List<Uint64> inprogressNodes = new ArrayList<>();
117 nodesToReconcile.parallelStream().forEach(nodeId -> {
118 Optional<ReconciliationStateList> state = getReconciliationState(nodeId);
119 if (state.isPresent() && state.get().getState().equals(INPROGRESS)) {
120 inprogressNodes.add(Uint64.valueOf(nodeId));
122 alarmAgent.raiseNodeReconciliationAlarm(nodeId);
123 LOG.info("Executing reconciliation for node {}", nodeId);
124 NodeKey nodeKey = new NodeKey(new NodeId("openflow:" + nodeId));
125 ReconciliationTask reconcileTask = new ReconciliationTask(new BigInteger(String.valueOf(nodeId)),
127 executor.execute(reconcileTask);
130 ReconcileOutput reconcilingInProgress = new ReconcileOutputBuilder()
131 .setInprogressNodes(inprogressNodes)
133 result.set(RpcResultBuilder.success(reconcilingInProgress).build());
136 return buildErrorResponse("Error executing command reconcile. "
137 + "No node information is found for reconciliation");
141 private Optional<ReconciliationStateList> getReconciliationState(final Long nodeId) {
142 InstanceIdentifier<ReconciliationStateList> instanceIdentifier = InstanceIdentifier
143 .builder(ReconciliationState.class).child(ReconciliationStateList.class,
144 new ReconciliationStateListKey(new BigInteger(String.valueOf(nodeId)))).build();
145 try (ReadTransaction tx = broker.newReadOnlyTransaction()) {
146 return tx.read(LogicalDatastoreType.OPERATIONAL, instanceIdentifier).get();
148 } catch (InterruptedException | ExecutionException e) {
149 LOG.error("Exception while reading reconciliation state for {}", nodeId, e);
151 return Optional.empty();
154 private ListenableFuture<RpcResult<ReconcileOutput>> buildErrorResponse(String msg) {
155 SettableFuture<RpcResult<ReconcileOutput>> result = SettableFuture.create();
156 LOG.error("Error {}", msg);
157 RpcError error = RpcResultBuilder.newError(RpcError.ErrorType.PROTOCOL, "reconcile", msg);
158 result.set(RpcResultBuilder.<ReconcileOutput>failed().withRpcError(error).build());
162 private List<Long> getAllNodes() {
163 List<OFNode> nodeList = ShellUtil.getAllNodes(broker);
164 List<Long> nodes = nodeList.stream().distinct().map(OFNode::getNodeId).collect(Collectors.toList());
168 private final class ReconciliationTask implements Runnable {
169 private static final String DATE_AND_TIME_FORMAT = "yyyy-MM-dd'T'HH:mm:ss.SSSXXX";
170 private final NodeKey nodeKey;
171 private final BigInteger nodeId;
173 private ReconciliationTask(BigInteger nodeId, NodeKey nodeKey) {
174 this.nodeId = nodeId;
175 this.nodeKey = nodeKey;
180 ReconcileNodeInput reconInput = new ReconcileNodeInputBuilder()
181 .setNodeId(nodeId).setNode(new NodeRef(InstanceIdentifier.builder(Nodes.class)
182 .child(Node.class, nodeKey).build())).build();
183 updateReconciliationState(INPROGRESS);
184 Future<RpcResult<ReconcileNodeOutput>> reconOutput = frmReconciliationService
185 .reconcileNode(reconInput);
187 RpcResult<ReconcileNodeOutput> rpcResult = reconOutput.get();
188 if (rpcResult.isSuccessful()) {
189 increaseReconcileCount(true);
190 updateReconciliationState(COMPLETED);
191 LOG.info("Reconciliation successfully completed for node {}", this.nodeId);
193 increaseReconcileCount(false);
194 updateReconciliationState(FAILED);
195 LOG.error("Reconciliation failed for node {} with error {}", this.nodeId, rpcResult.getErrors());
197 } catch (ExecutionException | InterruptedException e) {
198 increaseReconcileCount(false);
199 updateReconciliationState(FAILED);
200 LOG.error("Error occurred while invoking reconcile RPC for node {}", this.nodeId, e);
202 alarmAgent.clearNodeReconciliationAlarm(nodeId.longValue());
206 private void increaseReconcileCount(final boolean isSuccess) {
207 final SimpleDateFormat simpleDateFormat = new SimpleDateFormat(DATE_AND_TIME_FORMAT);
208 InstanceIdentifier<ReconcileCounter> instanceIdentifier = InstanceIdentifier
209 .builder(ReconciliationCounter.class).child(ReconcileCounter.class,
210 new ReconcileCounterKey(nodeId)).build();
211 ReadWriteTransaction tx = broker.newReadWriteTransaction();
212 Optional<ReconcileCounter> count = getReconciliationCount(tx, instanceIdentifier);
213 ReconcileCounterBuilder counterBuilder = new ReconcileCounterBuilder()
214 .withKey(new ReconcileCounterKey(nodeId))
215 .setLastRequestTime(new DateAndTime(simpleDateFormat.format(new Date())));
218 if (count.isPresent()) {
219 long successCount = count.get().getSuccessCount().toJava();
220 counterBuilder.setSuccessCount(++successCount);
221 LOG.debug("Reconcile success count {} for the node: {} ", successCount, nodeId);
223 counterBuilder.setSuccessCount(startCount);
226 if (count.isPresent()) {
227 long failureCount = count.get().getFailureCount().toJava();
228 counterBuilder.setFailureCount(++failureCount);
229 LOG.debug("Reconcile failure count {} for the node: {} ", failureCount, nodeId);
231 counterBuilder.setFailureCount(startCount);
235 tx.merge(LogicalDatastoreType.OPERATIONAL, instanceIdentifier, counterBuilder.build(), true);
237 } catch (InterruptedException | ExecutionException e) {
238 LOG.error("Exception while submitting counter for {}", nodeId, e);
242 private Optional<ReconcileCounter> getReconciliationCount(ReadWriteTransaction tx,
243 InstanceIdentifier<ReconcileCounter> instanceIdentifier) {
245 return tx.read(LogicalDatastoreType.OPERATIONAL, instanceIdentifier).get();
246 } catch (InterruptedException | ExecutionException e) {
247 LOG.error("Exception while reading counter for node: {}", nodeId, e);
249 return Optional.empty();
252 private void updateReconciliationState(State state) {
253 ReadWriteTransaction tx = broker.newReadWriteTransaction();
254 InstanceIdentifier<ReconciliationStateList> instanceIdentifier = InstanceIdentifier
255 .builder(ReconciliationState.class).child(ReconciliationStateList.class,
256 new ReconciliationStateListKey(nodeId)).build();
257 ReconciliationStateListBuilder stateBuilder = new ReconciliationStateListBuilder()
258 .withKey(new ReconciliationStateListKey(nodeId))
261 tx.merge(LogicalDatastoreType.OPERATIONAL, instanceIdentifier, stateBuilder.build(), true);
263 } catch (InterruptedException | ExecutionException e) {
264 LOG.error("Exception while updating reconciliation state: {}", nodeId, e);