applications/southbound-cli/src/main/java/org/opendaylight/openflowplugin/applications/southboundcli/ReconciliationServiceImpl.java

   1 /*
   2  * Copyright (c) 2018 Ericsson India Global Services Pvt Ltd. 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
   9 package org.opendaylight.openflowplugin.applications.southboundcli;
  10
  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;
  14
  15 import com.google.common.base.Optional;
  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.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.controller.md.sal.binding.api.DataBroker;
  29 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
  30 import org.opendaylight.controller.md.sal.binding.api.ReadWriteTransaction;
  31 import org.opendaylight.controller.md.sal.common.api.data.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.slf4j.Logger;
  63 import org.slf4j.LoggerFactory;
  64
  65 public class ReconciliationServiceImpl implements ReconciliationService, AutoCloseable {
  66
  67     private static final Logger LOG = LoggerFactory.getLogger(ReconciliationServiceImpl.class);
  68
  69     private final DataBroker broker;
  70     private final FrmReconciliationService frmReconciliationService;
  71     private final AlarmAgent alarmAgent;
  72     private final Long startCount = 1L;
  73     private final int threadPoolSize = 10;
  74     private final ExecutorService executor = Executors.newWorkStealingPool(threadPoolSize);
  75
  76     public ReconciliationServiceImpl(final DataBroker broker, final FrmReconciliationService frmReconciliationService,
  77                                      final AlarmAgent alarmAgent) {
  78         this.broker = broker;
  79         this.frmReconciliationService = frmReconciliationService;
  80         this.alarmAgent = alarmAgent;
  81     }
  82
  83     @Override
  84     public void close() {
  85         if (executor != null) {
  86             executor.shutdownNow();
  87         }
  88     }
  89
  90     @Override
  91     public ListenableFuture<RpcResult<ReconcileOutput>> reconcile(ReconcileInput input) {
  92         boolean reconcileAllNodes = input.isReconcileAllNodes();
  93         List<BigInteger> inputNodes = input.getNodes();
  94         if (inputNodes == null) {
  95             inputNodes = new ArrayList<>();
  96         }
  97         if (reconcileAllNodes && inputNodes.size() > 0) {
  98             return buildErrorResponse("Error executing command reconcile. "
  99                     + "If 'all' option is enabled, no Node must be specified as input parameter.");
 100         }
 101         if (!reconcileAllNodes && inputNodes.size() == 0) {
 102             return buildErrorResponse("Error executing command reconcile. No Node information was specified.");
 103         }
 104         SettableFuture<RpcResult<ReconcileOutput>> result = SettableFuture.create();
 105         List<Long> nodeList = getAllNodes();
 106         List<Long> nodesToReconcile = reconcileAllNodes ? nodeList :
 107                 inputNodes.stream().distinct().map(BigInteger::longValue).collect(Collectors.toList());
 108         if (nodesToReconcile.size() > 0) {
 109             List<Long> unresolvedNodes =
 110                     nodesToReconcile.stream().filter(node -> !nodeList.contains(node)).collect(Collectors.toList());
 111             if (!unresolvedNodes.isEmpty()) {
 112                 return buildErrorResponse("Error executing command reconcile. "
 113                         + "Node(s) not found: " + String.join(", ", unresolvedNodes.toString()));
 114             }
 115             List<BigInteger> inprogressNodes = new ArrayList<>();
 116             nodesToReconcile.parallelStream().forEach(nodeId -> {
 117                 Optional<ReconciliationStateList> state = getReconciliationState(nodeId);
 118                 if (state.isPresent() && state.get().getState().equals(INPROGRESS)) {
 119                     inprogressNodes.add(new BigInteger(String.valueOf(nodeId)));
 120                 } else {
 121                     alarmAgent.raiseNodeReconciliationAlarm(nodeId);
 122                     LOG.info("Executing reconciliation for node {}", nodeId);
 123                     NodeKey nodeKey = new NodeKey(new NodeId("openflow:" + nodeId));
 124                     ReconciliationTask reconcileTask = new ReconciliationTask(new BigInteger(String.valueOf(nodeId)),
 125                             nodeKey);
 126                     executor.execute(reconcileTask);
 127                 }
 128             });
 129             ReconcileOutput reconcilingInProgress = new ReconcileOutputBuilder()
 130                     .setInprogressNodes(inprogressNodes)
 131                     .build();
 132             result.set(RpcResultBuilder.success(reconcilingInProgress).build());
 133             return result;
 134         } else {
 135             return buildErrorResponse("Error executing command reconcile. "
 136                     + "No node information is found for reconciliation");
 137         }
 138     }
 139
 140     private Optional<ReconciliationStateList> getReconciliationState(final Long nodeId) {
 141         InstanceIdentifier<ReconciliationStateList> instanceIdentifier = InstanceIdentifier
 142                 .builder(ReconciliationState.class).child(ReconciliationStateList.class,
 143                         new ReconciliationStateListKey(new BigInteger(String.valueOf(nodeId)))).build();
 144         try (ReadOnlyTransaction tx = broker.newReadOnlyTransaction()) {
 145             return tx.read(LogicalDatastoreType.OPERATIONAL, instanceIdentifier).get();
 146
 147         } catch (InterruptedException  | ExecutionException e) {
 148             LOG.error("Exception while reading reconciliation state for {}", nodeId, e);
 149         }
 150         return Optional.absent();
 151     }
 152
 153     private ListenableFuture<RpcResult<ReconcileOutput>> buildErrorResponse(String msg) {
 154         SettableFuture<RpcResult<ReconcileOutput>> result = SettableFuture.create();
 155         LOG.error("Error {}", msg);
 156         RpcError error = RpcResultBuilder.newError(RpcError.ErrorType.PROTOCOL, "reconcile", msg);
 157         result.set(RpcResultBuilder.<ReconcileOutput>failed().withRpcError(error).build());
 158         return result;
 159     }
 160
 161     private List<Long> getAllNodes() {
 162         List<OFNode> nodeList = ShellUtil.getAllNodes(broker);
 163         List<Long> nodes = nodeList.stream().distinct().map(OFNode::getNodeId).collect(Collectors.toList());
 164         return nodes;
 165     }
 166
 167     private final class ReconciliationTask implements Runnable {
 168         private static final String DATE_AND_TIME_FORMAT = "yyyy-MM-dd'T'HH:mm:ss.SSSXXX";
 169         private final NodeKey nodeKey;
 170         private final BigInteger nodeId;
 171
 172         private ReconciliationTask(BigInteger nodeId, NodeKey nodeKey) {
 173             this.nodeId = nodeId;
 174             this.nodeKey = nodeKey;
 175         }
 176
 177         @Override
 178         public void run() {
 179             ReconcileNodeInput reconInput = new ReconcileNodeInputBuilder()
 180                     .setNodeId(nodeId).setNode(new NodeRef(InstanceIdentifier.builder(Nodes.class)
 181                             .child(Node.class, nodeKey).build())).build();
 182             updateReconciliationState(INPROGRESS);
 183             Future<RpcResult<ReconcileNodeOutput>> reconOutput = frmReconciliationService
 184                     .reconcileNode(reconInput);
 185             try {
 186                 RpcResult<ReconcileNodeOutput> rpcResult = reconOutput.get();
 187                 if (rpcResult.isSuccessful()) {
 188                     increaseReconcileCount(true);
 189                     updateReconciliationState(COMPLETED);
 190                     LOG.info("Reconciliation successfully completed for node {}", this.nodeId);
 191                 } else {
 192                     increaseReconcileCount(false);
 193                     updateReconciliationState(FAILED);
 194                     LOG.error("Reconciliation failed for node {} with error {}", this.nodeId, rpcResult.getErrors());
 195                 }
 196             } catch (ExecutionException | InterruptedException e) {
 197                 increaseReconcileCount(false);
 198                 updateReconciliationState(FAILED);
 199                 LOG.error("Error occurred while invoking reconcile RPC for node {}", this.nodeId, e);
 200             } finally {
 201                 alarmAgent.clearNodeReconciliationAlarm(nodeId.longValue());
 202             }
 203         }
 204
 205         private void increaseReconcileCount(final boolean isSuccess) {
 206             final SimpleDateFormat simpleDateFormat = new SimpleDateFormat(DATE_AND_TIME_FORMAT);
 207             InstanceIdentifier<ReconcileCounter> instanceIdentifier = InstanceIdentifier
 208                     .builder(ReconciliationCounter.class).child(ReconcileCounter.class,
 209                             new ReconcileCounterKey(nodeId)).build();
 210             ReadWriteTransaction tx = broker.newReadWriteTransaction();
 211             Optional<ReconcileCounter> count = getReconciliationCount(tx, instanceIdentifier);
 212             ReconcileCounterBuilder counterBuilder = new ReconcileCounterBuilder()
 213                     .withKey(new ReconcileCounterKey(nodeId))
 214                     .setLastRequestTime(new DateAndTime(simpleDateFormat.format(new Date())));
 215
 216             if (isSuccess) {
 217                 if (count.isPresent()) {
 218                     Long successCount = count.get().getSuccessCount();
 219                     counterBuilder.setSuccessCount(++successCount);
 220                     LOG.debug("Reconcile success count {} for the node: {} ", successCount, nodeId);
 221                 } else {
 222                     counterBuilder.setSuccessCount(startCount);
 223                 }
 224             } else {
 225                 if (count.isPresent()) {
 226                     Long failureCount = count.get().getFailureCount();
 227                     counterBuilder.setFailureCount(++failureCount);
 228                     LOG.debug("Reconcile failure count {} for the node: {} ", failureCount, nodeId);
 229                 } else {
 230                     counterBuilder.setFailureCount(startCount);
 231                 }
 232             }
 233             try {
 234                 tx.merge(LogicalDatastoreType.OPERATIONAL, instanceIdentifier, counterBuilder.build(), true);
 235                 tx.submit().get();
 236             } catch (InterruptedException | ExecutionException e) {
 237                 LOG.error("Exception while submitting counter for {}", nodeId, e);
 238             }
 239         }
 240
 241         private Optional<ReconcileCounter> getReconciliationCount(ReadWriteTransaction tx,
 242                                 InstanceIdentifier<ReconcileCounter> instanceIdentifier) {
 243             try {
 244                 return tx.read(LogicalDatastoreType.OPERATIONAL, instanceIdentifier).get();
 245             } catch (InterruptedException | ExecutionException e) {
 246                 LOG.error("Exception while reading counter for node: {}", nodeId, e);
 247             }
 248             return Optional.absent();
 249         }
 250
 251         private void updateReconciliationState(State state) {
 252             ReadWriteTransaction tx = broker.newReadWriteTransaction();
 253             InstanceIdentifier<ReconciliationStateList> instanceIdentifier = InstanceIdentifier
 254                     .builder(ReconciliationState.class).child(ReconciliationStateList.class,
 255                             new ReconciliationStateListKey(nodeId)).build();
 256             ReconciliationStateListBuilder stateBuilder = new ReconciliationStateListBuilder()
 257                     .withKey(new ReconciliationStateListKey(nodeId))
 258                     .setState(state);
 259             try {
 260                 tx.merge(LogicalDatastoreType.OPERATIONAL, instanceIdentifier, stateBuilder.build(), true);
 261                 tx.submit().get();
 262             } catch (InterruptedException | ExecutionException e) {
 263                 LOG.error("Exception while updating reconciliation state: {}", nodeId, e);
 264             }
 265         }
 266     }
 267 }
 268