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