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