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 java.util.Objects.requireNonNull;
  12 import static org.opendaylight.openflowplugin.api.openflow.ReconciliationState.ReconciliationStatus.COMPLETED;
  13 import static org.opendaylight.openflowplugin.api.openflow.ReconciliationState.ReconciliationStatus.FAILED;
  14 import static org.opendaylight.openflowplugin.api.openflow.ReconciliationState.ReconciliationStatus.STARTED;
  15
  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.time.LocalDateTime;
  21 import java.util.ArrayList;
  22 import java.util.Date;
  23 import java.util.List;
  24 import java.util.Map;
  25 import java.util.Optional;
  26 import java.util.concurrent.ConcurrentHashMap;
  27 import java.util.concurrent.ExecutionException;
  28 import java.util.concurrent.ExecutorService;
  29 import java.util.concurrent.Executors;
  30 import java.util.concurrent.Future;
  31 import java.util.stream.Collectors;
  32 import org.opendaylight.mdsal.binding.api.DataBroker;
  33 import org.opendaylight.mdsal.binding.api.ReadWriteTransaction;
  34 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  35 import org.opendaylight.openflowplugin.api.openflow.FlowGroupCacheManager;
  36 import org.opendaylight.openflowplugin.api.openflow.ReconciliationState;
  37 import org.opendaylight.openflowplugin.applications.southboundcli.alarm.AlarmAgent;
  38 import org.opendaylight.openflowplugin.applications.southboundcli.util.OFNode;
  39 import org.opendaylight.openflowplugin.applications.southboundcli.util.ShellUtil;
  40 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.DateAndTime;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.frm.reconciliation.service.rev180227.FrmReconciliationService;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.frm.reconciliation.service.rev180227.ReconcileNodeInput;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.frm.reconciliation.service.rev180227.ReconcileNodeInputBuilder;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.frm.reconciliation.service.rev180227.ReconcileNodeOutput;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.reconciliation.service.rev180227.ReconcileInput;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.reconciliation.service.rev180227.ReconcileOutput;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.reconciliation.service.rev180227.ReconcileOutputBuilder;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.reconciliation.service.rev180227.ReconciliationCounter;
  54 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.reconciliation.service.rev180227.ReconciliationService;
  55 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.reconciliation.service.rev180227.reconciliation.counter.ReconcileCounter;
  56 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.reconciliation.service.rev180227.reconciliation.counter.ReconcileCounterBuilder;
  57 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.reconciliation.service.rev180227.reconciliation.counter.ReconcileCounterKey;
  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;
  65
  66 public class ReconciliationServiceImpl implements ReconciliationService, AutoCloseable {
  67
  68     private static final Logger LOG = LoggerFactory.getLogger(ReconciliationServiceImpl.class);
  69
  70     private final DataBroker broker;
  71     private final FrmReconciliationService frmReconciliationService;
  72     private final AlarmAgent alarmAgent;
  73     private final NodeListener nodeListener;
  74     private final Long startCount = 1L;
  75     private final int threadPoolSize = 10;
  76     private final ExecutorService executor = Executors.newWorkStealingPool(threadPoolSize);
  77     private volatile Map<String, ReconciliationState> reconciliationStates = new ConcurrentHashMap();
  78
  79     public ReconciliationServiceImpl(final DataBroker broker, final FrmReconciliationService frmReconciliationService,
  80                                      final AlarmAgent alarmAgent, final NodeListener nodeListener,
  81                                      final FlowGroupCacheManager flowGroupCacheManager) {
  82         this.broker = broker;
  83         this.frmReconciliationService = frmReconciliationService;
  84         this.alarmAgent = alarmAgent;
  85         this.nodeListener = requireNonNull(nodeListener, "NodeListener cannot be null!");
  86         reconciliationStates = flowGroupCacheManager.getReconciliationStates();
  87     }
  88
  89     @Override
  90     public void close() {
  91         if (executor != null) {
  92             executor.shutdownNow();
  93         }
  94     }
  95
  96     @Override
  97     public ListenableFuture<RpcResult<ReconcileOutput>> reconcile(ReconcileInput input) {
  98         boolean reconcileAllNodes = input.isReconcileAllNodes();
  99         List<Uint64> inputNodes = input.getNodes();
 100         if (inputNodes == null) {
 101             inputNodes = new ArrayList<>();
 102         }
 103         if (reconcileAllNodes && inputNodes.size() > 0) {
 104             return buildErrorResponse("Error executing command reconcile. "
 105                     + "If 'all' option is enabled, no Node must be specified as input parameter.");
 106         }
 107         if (!reconcileAllNodes && inputNodes.size() == 0) {
 108             return buildErrorResponse("Error executing command reconcile. No Node information was specified.");
 109         }
 110         SettableFuture<RpcResult<ReconcileOutput>> result = SettableFuture.create();
 111         List<Long> nodeList = getAllNodes();
 112         List<Long> nodesToReconcile = reconcileAllNodes ? nodeList :
 113                 inputNodes.stream().distinct().map(Uint64::longValue).collect(Collectors.toList());
 114         if (nodesToReconcile.size() > 0) {
 115             List<Long> unresolvedNodes =
 116                     nodesToReconcile.stream().filter(node -> !nodeList.contains(node)).collect(Collectors.toList());
 117             if (!unresolvedNodes.isEmpty()) {
 118                 return buildErrorResponse("Error executing command reconcile. "
 119                         + "Node(s) not found: " + String.join(", ", unresolvedNodes.toString()));
 120             }
 121             List<Uint64> inprogressNodes = new ArrayList<>();
 122             nodesToReconcile.parallelStream().forEach(nodeId -> {
 123                 ReconciliationState state = getReconciliationState(nodeId);
 124                 if (state != null && state.getState().equals(STARTED)) {
 125                     inprogressNodes.add(Uint64.valueOf(nodeId));
 126                 } else {
 127                     alarmAgent.raiseNodeReconciliationAlarm(nodeId);
 128                     LOG.info("Executing reconciliation for node {} with state ", nodeId);
 129                     NodeKey nodeKey = new NodeKey(new NodeId("openflow:" + nodeId));
 130                     ReconciliationTask reconcileTask = new ReconciliationTask(new BigInteger(String.valueOf(nodeId)),
 131                             nodeKey);
 132                     executor.execute(reconcileTask);
 133                 }
 134             });
 135             ReconcileOutput reconcilingInProgress = new ReconcileOutputBuilder()
 136                     .setInprogressNodes(inprogressNodes)
 137                     .build();
 138             result.set(RpcResultBuilder.success(reconcilingInProgress).build());
 139             return result;
 140         } else {
 141             return buildErrorResponse("Error executing command reconcile. "
 142                     + "No node information is found for reconciliation");
 143         }
 144     }
 145
 146     private ReconciliationState getReconciliationState(final Long nodeId) {
 147         return reconciliationStates.get(nodeId.toString());
 148     }
 149
 150     private ListenableFuture<RpcResult<ReconcileOutput>> buildErrorResponse(String msg) {
 151         SettableFuture<RpcResult<ReconcileOutput>> result = SettableFuture.create();
 152         LOG.error("Error {}", msg);
 153         RpcError error = RpcResultBuilder.newError(RpcError.ErrorType.PROTOCOL, "reconcile", msg);
 154         result.set(RpcResultBuilder.<ReconcileOutput>failed().withRpcError(error).build());
 155         return result;
 156     }
 157
 158     private List<Long> getAllNodes() {
 159         List<OFNode> nodeList = ShellUtil.getAllNodes(nodeListener);
 160         List<Long> nodes = nodeList.stream().distinct().map(node -> node.getNodeId()).collect(Collectors.toList());
 161         return nodes;
 162     }
 163
 164     private final class ReconciliationTask implements Runnable {
 165         private static final String DATE_AND_TIME_FORMAT = "yyyy-MM-dd'T'HH:mm:ss.SSSXXX";
 166         private final NodeKey nodeKey;
 167         private final BigInteger nodeId;
 168
 169         private ReconciliationTask(BigInteger nodeId, NodeKey nodeKey) {
 170             this.nodeId = nodeId;
 171             this.nodeKey = nodeKey;
 172         }
 173
 174         @Override
 175         public void run() {
 176             ReconcileNodeInput reconInput = new ReconcileNodeInputBuilder()
 177                     .setNodeId(nodeId).setNode(new NodeRef(InstanceIdentifier.builder(Nodes.class)
 178                             .child(Node.class, nodeKey).build())).build();
 179             updateReconciliationState(STARTED);
 180             Future<RpcResult<ReconcileNodeOutput>> reconOutput = frmReconciliationService
 181                     .reconcileNode(reconInput);
 182             try {
 183                 RpcResult<ReconcileNodeOutput> rpcResult = reconOutput.get();
 184                 if (rpcResult.isSuccessful()) {
 185                     increaseReconcileCount(true);
 186                     updateReconciliationState(COMPLETED);
 187                     LOG.info("Reconciliation successfully completed for node {}", this.nodeId);
 188                 } else {
 189                     increaseReconcileCount(false);
 190                     updateReconciliationState(FAILED);
 191                     LOG.error("Reconciliation failed for node {} with error {}", this.nodeId, rpcResult.getErrors());
 192                 }
 193             } catch (ExecutionException | InterruptedException e) {
 194                 increaseReconcileCount(false);
 195                 updateReconciliationState(FAILED);
 196                 LOG.error("Error occurred while invoking reconcile RPC for node {}", this.nodeId, e);
 197             } finally {
 198                 alarmAgent.clearNodeReconciliationAlarm(nodeId.longValue());
 199             }
 200         }
 201
 202         private void increaseReconcileCount(final boolean isSuccess) {
 203             final SimpleDateFormat simpleDateFormat = new SimpleDateFormat(DATE_AND_TIME_FORMAT);
 204             InstanceIdentifier<ReconcileCounter> instanceIdentifier = InstanceIdentifier
 205                     .builder(ReconciliationCounter.class).child(ReconcileCounter.class,
 206                             new ReconcileCounterKey(nodeId)).build();
 207             ReadWriteTransaction tx = broker.newReadWriteTransaction();
 208             Optional<ReconcileCounter> count = getReconciliationCount(tx, instanceIdentifier);
 209             ReconcileCounterBuilder counterBuilder = new ReconcileCounterBuilder()
 210                     .withKey(new ReconcileCounterKey(nodeId))
 211                     .setLastRequestTime(new DateAndTime(simpleDateFormat.format(new Date())));
 212
 213             if (isSuccess) {
 214                 if (count.isPresent()) {
 215                     long successCount = count.get().getSuccessCount().toJava();
 216                     counterBuilder.setSuccessCount(++successCount);
 217                     LOG.debug("Reconcile success count {} for the node: {} ", successCount, nodeId);
 218                 } else {
 219                     counterBuilder.setSuccessCount(startCount);
 220                 }
 221             } else {
 222                 if (count.isPresent()) {
 223                     long failureCount = count.get().getFailureCount().toJava();
 224                     counterBuilder.setFailureCount(++failureCount);
 225                     LOG.debug("Reconcile failure count {} for the node: {} ", failureCount, nodeId);
 226                 } else {
 227                     counterBuilder.setFailureCount(startCount);
 228                 }
 229             }
 230             try {
 231                 tx.mergeParentStructureMerge(LogicalDatastoreType.OPERATIONAL, instanceIdentifier,
 232                         counterBuilder.build());
 233                 tx.commit().get();
 234             } catch (InterruptedException | ExecutionException e) {
 235                 LOG.error("Exception while submitting counter for {}", nodeId, e);
 236             }
 237         }
 238
 239         private Optional<ReconcileCounter> getReconciliationCount(ReadWriteTransaction tx,
 240                                                              InstanceIdentifier<ReconcileCounter> instanceIdentifier) {
 241             try {
 242                 return tx.read(LogicalDatastoreType.OPERATIONAL, instanceIdentifier).get();
 243             } catch (InterruptedException | ExecutionException e) {
 244                 LOG.error("Exception while reading counter for node: {}", nodeId, e);
 245             }
 246             return Optional.empty();
 247         }
 248
 249
 250         private void updateReconciliationState(ReconciliationState.ReconciliationStatus status) {
 251             ReconciliationState state = new ReconciliationState(status, LocalDateTime.now());
 252             reconciliationStates.put(nodeId.toString(),state);
 253         }
 254     }
 255 }
 256