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 java.util.Objects.requireNonNull;
12 import static org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.reconciliation.service.rev180227.NodeReconcileState.State.COMPLETED;
13 import static org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.reconciliation.service.rev180227.NodeReconcileState.State.FAILED;
14 import static org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.reconciliation.service.rev180227.NodeReconcileState.State.INPROGRESS;
16 import com.google.common.util.concurrent.ListenableFuture;
17 import com.google.common.util.concurrent.SettableFuture;
18 import java.math.BigInteger;
19 import java.text.SimpleDateFormat;
20 import java.util.ArrayList;
21 import java.util.Date;
22 import java.util.List;
23 import java.util.Optional;
24 import java.util.concurrent.ExecutionException;
25 import java.util.concurrent.ExecutorService;
26 import java.util.concurrent.Executors;
27 import java.util.concurrent.Future;
28 import java.util.stream.Collectors;
29 import org.opendaylight.mdsal.binding.api.DataBroker;
30 import org.opendaylight.mdsal.binding.api.ReadTransaction;
31 import org.opendaylight.mdsal.binding.api.ReadWriteTransaction;
32 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
33 import org.opendaylight.openflowplugin.applications.southboundcli.alarm.AlarmAgent;
34 import org.opendaylight.openflowplugin.applications.southboundcli.util.OFNode;
35 import org.opendaylight.openflowplugin.applications.southboundcli.util.ShellUtil;
36 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.DateAndTime;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.frm.reconciliation.service.rev180227.FrmReconciliationService;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.frm.reconciliation.service.rev180227.ReconcileNodeInput;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.frm.reconciliation.service.rev180227.ReconcileNodeInputBuilder;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.frm.reconciliation.service.rev180227.ReconcileNodeOutput;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.reconciliation.service.rev180227.NodeReconcileState.State;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.reconciliation.service.rev180227.ReconcileInput;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.reconciliation.service.rev180227.ReconcileOutput;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.reconciliation.service.rev180227.ReconcileOutputBuilder;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.reconciliation.service.rev180227.ReconciliationCounter;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.reconciliation.service.rev180227.ReconciliationService;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.reconciliation.service.rev180227.ReconciliationState;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.reconciliation.service.rev180227.reconciliation.counter.ReconcileCounter;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.reconciliation.service.rev180227.reconciliation.counter.ReconcileCounterBuilder;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.reconciliation.service.rev180227.reconciliation.counter.ReconcileCounterKey;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.reconciliation.service.rev180227.reconciliation.state.ReconciliationStateList;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.reconciliation.service.rev180227.reconciliation.state.ReconciliationStateListBuilder;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.reconciliation.service.rev180227.reconciliation.state.ReconciliationStateListKey;
59 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
60 import org.opendaylight.yangtools.yang.common.RpcError;
61 import org.opendaylight.yangtools.yang.common.RpcResult;
62 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
63 import org.opendaylight.yangtools.yang.common.Uint64;
64 import org.slf4j.Logger;
65 import org.slf4j.LoggerFactory;
67 public class ReconciliationServiceImpl implements ReconciliationService, AutoCloseable {
69 private static final Logger LOG = LoggerFactory.getLogger(ReconciliationServiceImpl.class);
71 private final DataBroker broker;
72 private final FrmReconciliationService frmReconciliationService;
73 private final AlarmAgent alarmAgent;
74 private final NodeListener nodeListener;
75 private final Long startCount = 1L;
76 private final int threadPoolSize = 10;
77 private final ExecutorService executor = Executors.newWorkStealingPool(threadPoolSize);
79 public ReconciliationServiceImpl(final DataBroker broker, final FrmReconciliationService frmReconciliationService,
80 final AlarmAgent alarmAgent, final NodeListener nodeListener) {
82 this.frmReconciliationService = frmReconciliationService;
83 this.alarmAgent = alarmAgent;
84 this.nodeListener = requireNonNull(nodeListener, "NodeListener cannot be null!");
89 if (executor != null) {
90 executor.shutdownNow();
95 public ListenableFuture<RpcResult<ReconcileOutput>> reconcile(ReconcileInput input) {
96 boolean reconcileAllNodes = input.isReconcileAllNodes();
97 List<Uint64> inputNodes = input.getNodes();
98 if (inputNodes == null) {
99 inputNodes = new ArrayList<>();
101 if (reconcileAllNodes && inputNodes.size() > 0) {
102 return buildErrorResponse("Error executing command reconcile. "
103 + "If 'all' option is enabled, no Node must be specified as input parameter.");
105 if (!reconcileAllNodes && inputNodes.size() == 0) {
106 return buildErrorResponse("Error executing command reconcile. No Node information was specified.");
108 SettableFuture<RpcResult<ReconcileOutput>> result = SettableFuture.create();
109 List<Long> nodeList = getAllNodes();
110 List<Long> nodesToReconcile = reconcileAllNodes ? nodeList :
111 inputNodes.stream().distinct().map(Uint64::longValue).collect(Collectors.toList());
112 if (nodesToReconcile.size() > 0) {
113 List<Long> unresolvedNodes =
114 nodesToReconcile.stream().filter(node -> !nodeList.contains(node)).collect(Collectors.toList());
115 if (!unresolvedNodes.isEmpty()) {
116 return buildErrorResponse("Error executing command reconcile. "
117 + "Node(s) not found: " + String.join(", ", unresolvedNodes.toString()));
119 List<Uint64> inprogressNodes = new ArrayList<>();
120 nodesToReconcile.parallelStream().forEach(nodeId -> {
121 Optional<ReconciliationStateList> state = getReconciliationState(nodeId);
122 if (state.isPresent() && state.get().getState().equals(INPROGRESS)) {
123 inprogressNodes.add(Uint64.valueOf(nodeId));
125 alarmAgent.raiseNodeReconciliationAlarm(nodeId);
126 LOG.info("Executing reconciliation for node {}", nodeId);
127 NodeKey nodeKey = new NodeKey(new NodeId("openflow:" + nodeId));
128 ReconciliationTask reconcileTask = new ReconciliationTask(new BigInteger(String.valueOf(nodeId)),
130 executor.execute(reconcileTask);
133 ReconcileOutput reconcilingInProgress = new ReconcileOutputBuilder()
134 .setInprogressNodes(inprogressNodes)
136 result.set(RpcResultBuilder.success(reconcilingInProgress).build());
139 return buildErrorResponse("Error executing command reconcile. "
140 + "No node information is found for reconciliation");
144 private Optional<ReconciliationStateList> getReconciliationState(final Long nodeId) {
145 InstanceIdentifier<ReconciliationStateList> instanceIdentifier = InstanceIdentifier
146 .builder(ReconciliationState.class).child(ReconciliationStateList.class,
147 new ReconciliationStateListKey(new BigInteger(String.valueOf(nodeId)))).build();
148 try (ReadTransaction tx = broker.newReadOnlyTransaction()) {
149 return tx.read(LogicalDatastoreType.OPERATIONAL, instanceIdentifier).get();
151 } catch (InterruptedException | ExecutionException e) {
152 LOG.error("Exception while reading reconciliation state for {}", nodeId, e);
154 return Optional.empty();
157 private ListenableFuture<RpcResult<ReconcileOutput>> buildErrorResponse(String msg) {
158 SettableFuture<RpcResult<ReconcileOutput>> result = SettableFuture.create();
159 LOG.error("Error {}", msg);
160 RpcError error = RpcResultBuilder.newError(RpcError.ErrorType.PROTOCOL, "reconcile", msg);
161 result.set(RpcResultBuilder.<ReconcileOutput>failed().withRpcError(error).build());
165 private List<Long> getAllNodes() {
166 List<OFNode> nodeList = ShellUtil.getAllNodes(nodeListener);
167 List<Long> nodes = nodeList.stream().distinct().map(node -> node.getNodeId()).collect(Collectors.toList());
171 private final class ReconciliationTask implements Runnable {
172 private static final String DATE_AND_TIME_FORMAT = "yyyy-MM-dd'T'HH:mm:ss.SSSXXX";
173 private final NodeKey nodeKey;
174 private final BigInteger nodeId;
176 private ReconciliationTask(BigInteger nodeId, NodeKey nodeKey) {
177 this.nodeId = nodeId;
178 this.nodeKey = nodeKey;
183 ReconcileNodeInput reconInput = new ReconcileNodeInputBuilder()
184 .setNodeId(nodeId).setNode(new NodeRef(InstanceIdentifier.builder(Nodes.class)
185 .child(Node.class, nodeKey).build())).build();
186 updateReconciliationState(INPROGRESS);
187 Future<RpcResult<ReconcileNodeOutput>> reconOutput = frmReconciliationService
188 .reconcileNode(reconInput);
190 RpcResult<ReconcileNodeOutput> rpcResult = reconOutput.get();
191 if (rpcResult.isSuccessful()) {
192 increaseReconcileCount(true);
193 updateReconciliationState(COMPLETED);
194 LOG.info("Reconciliation successfully completed for node {}", this.nodeId);
196 increaseReconcileCount(false);
197 updateReconciliationState(FAILED);
198 LOG.error("Reconciliation failed for node {} with error {}", this.nodeId, rpcResult.getErrors());
200 } catch (ExecutionException | InterruptedException e) {
201 increaseReconcileCount(false);
202 updateReconciliationState(FAILED);
203 LOG.error("Error occurred while invoking reconcile RPC for node {}", this.nodeId, e);
205 alarmAgent.clearNodeReconciliationAlarm(nodeId.longValue());
209 private void increaseReconcileCount(final boolean isSuccess) {
210 final SimpleDateFormat simpleDateFormat = new SimpleDateFormat(DATE_AND_TIME_FORMAT);
211 InstanceIdentifier<ReconcileCounter> instanceIdentifier = InstanceIdentifier
212 .builder(ReconciliationCounter.class).child(ReconcileCounter.class,
213 new ReconcileCounterKey(nodeId)).build();
214 ReadWriteTransaction tx = broker.newReadWriteTransaction();
215 Optional<ReconcileCounter> count = getReconciliationCount(tx, instanceIdentifier);
216 ReconcileCounterBuilder counterBuilder = new ReconcileCounterBuilder()
217 .withKey(new ReconcileCounterKey(nodeId))
218 .setLastRequestTime(new DateAndTime(simpleDateFormat.format(new Date())));
221 if (count.isPresent()) {
222 long successCount = count.get().getSuccessCount().toJava();
223 counterBuilder.setSuccessCount(++successCount);
224 LOG.debug("Reconcile success count {} for the node: {} ", successCount, nodeId);
226 counterBuilder.setSuccessCount(startCount);
229 if (count.isPresent()) {
230 long failureCount = count.get().getFailureCount().toJava();
231 counterBuilder.setFailureCount(++failureCount);
232 LOG.debug("Reconcile failure count {} for the node: {} ", failureCount, nodeId);
234 counterBuilder.setFailureCount(startCount);
238 tx.merge(LogicalDatastoreType.OPERATIONAL, instanceIdentifier, counterBuilder.build(), true);
240 } catch (InterruptedException | ExecutionException e) {
241 LOG.error("Exception while submitting counter for {}", nodeId, e);
245 private Optional<ReconcileCounter> getReconciliationCount(ReadWriteTransaction tx,
246 InstanceIdentifier<ReconcileCounter> instanceIdentifier) {
248 return tx.read(LogicalDatastoreType.OPERATIONAL, instanceIdentifier).get();
249 } catch (InterruptedException | ExecutionException e) {
250 LOG.error("Exception while reading counter for node: {}", nodeId, e);
252 return Optional.empty();
255 private void updateReconciliationState(State state) {
256 ReadWriteTransaction tx = broker.newReadWriteTransaction();
257 InstanceIdentifier<ReconciliationStateList> instanceIdentifier = InstanceIdentifier
258 .builder(ReconciliationState.class).child(ReconciliationStateList.class,
259 new ReconciliationStateListKey(nodeId)).build();
260 ReconciliationStateListBuilder stateBuilder = new ReconciliationStateListBuilder()
261 .withKey(new ReconciliationStateListKey(nodeId))
264 tx.merge(LogicalDatastoreType.OPERATIONAL, instanceIdentifier, stateBuilder.build(), true);
266 } catch (InterruptedException | ExecutionException e) {
267 LOG.error("Exception while updating reconciliation state: {}", nodeId, e);