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.collect.ImmutableSet;
  16 import com.google.common.util.concurrent.ListenableFuture;
  17 import com.google.common.util.concurrent.SettableFuture;
  18 import java.text.SimpleDateFormat;
  19 import java.time.LocalDateTime;
  20 import java.util.Date;
  21 import java.util.List;
  22 import java.util.Map;
  23 import java.util.Optional;
  24 import java.util.Set;
  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.ErrorTag;
  58 import org.opendaylight.yangtools.yang.common.ErrorType;
  59 import org.opendaylight.yangtools.yang.common.RpcResult;
  60 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
  61 import org.opendaylight.yangtools.yang.common.Uint32;
  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     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 NodeListener nodeListener;
  73     private final int threadPoolSize = 10;
  74     private final Map<String, ReconciliationState> reconciliationStates;
  75
  76     private ExecutorService executor = Executors.newWorkStealingPool(threadPoolSize);
  77
  78     public ReconciliationServiceImpl(final DataBroker broker, final FrmReconciliationService frmReconciliationService,
  79                                      final AlarmAgent alarmAgent, final NodeListener nodeListener,
  80                                      final FlowGroupCacheManager flowGroupCacheManager) {
  81         this.broker = broker;
  82         this.frmReconciliationService = frmReconciliationService;
  83         this.alarmAgent = alarmAgent;
  84         this.nodeListener = requireNonNull(nodeListener, "NodeListener cannot be null!");
  85         reconciliationStates = flowGroupCacheManager.getReconciliationStates();
  86     }
  87
  88     @Override
  89     public void close() {
  90         if (executor != null) {
  91             executor.shutdownNow();
  92             executor = null;
  93         }
  94     }
  95
  96     @Override
  97     public ListenableFuture<RpcResult<ReconcileOutput>> reconcile(final ReconcileInput input) {
  98         boolean reconcileAllNodes = input.getReconcileAllNodes();
  99         Set<Uint64> inputNodes = input.getNodes();
 100         if (inputNodes == null) {
 101             inputNodes = Set.of();
 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             ImmutableSet.Builder<Uint64> inprogressNodes = ImmutableSet.builder();
 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(Uint64.valueOf(nodeId), nodeKey);
 131                     executor.execute(reconcileTask);
 132                 }
 133             });
 134             ReconcileOutput reconcilingInProgress = new ReconcileOutputBuilder()
 135                     .setInprogressNodes(inprogressNodes.build())
 136                     .build();
 137             result.set(RpcResultBuilder.success(reconcilingInProgress).build());
 138             return result;
 139         } else {
 140             return buildErrorResponse("Error executing command reconcile. "
 141                     + "No node information is found for reconciliation");
 142         }
 143     }
 144
 145     private ReconciliationState getReconciliationState(final Long nodeId) {
 146         return reconciliationStates.get(nodeId.toString());
 147     }
 148
 149     private static ListenableFuture<RpcResult<ReconcileOutput>> buildErrorResponse(final String msg) {
 150         LOG.error("Error {}", msg);
 151         return RpcResultBuilder.<ReconcileOutput>failed()
 152                 .withError(ErrorType.PROTOCOL, new ErrorTag("reconcile"), msg)
 153                 .buildFuture();
 154     }
 155
 156     private List<Long> getAllNodes() {
 157         List<OFNode> nodeList = ShellUtil.getAllNodes(nodeListener);
 158         List<Long> nodes = nodeList.stream().distinct().map(OFNode::getNodeId).collect(Collectors.toList());
 159         return nodes;
 160     }
 161
 162     private final class ReconciliationTask implements Runnable {
 163         private static final String DATE_AND_TIME_FORMAT = "yyyy-MM-dd'T'HH:mm:ss.SSSXXX";
 164         private final NodeKey nodeKey;
 165         private final Uint64 nodeId;
 166
 167         private ReconciliationTask(final Uint64 nodeId, final NodeKey nodeKey) {
 168             this.nodeId = nodeId;
 169             this.nodeKey = nodeKey;
 170         }
 171
 172         @Override
 173         public void run() {
 174             ReconcileNodeInput reconInput = new ReconcileNodeInputBuilder()
 175                     .setNodeId(nodeId).setNode(new NodeRef(InstanceIdentifier.builder(Nodes.class)
 176                             .child(Node.class, nodeKey).build())).build();
 177             updateReconciliationState(STARTED);
 178             Future<RpcResult<ReconcileNodeOutput>> reconOutput = frmReconciliationService
 179                     .reconcileNode(reconInput);
 180             try {
 181                 RpcResult<ReconcileNodeOutput> rpcResult = reconOutput.get();
 182                 if (rpcResult.isSuccessful()) {
 183                     increaseReconcileCount(true);
 184                     updateReconciliationState(COMPLETED);
 185                     LOG.info("Reconciliation successfully completed for node {}", nodeId);
 186                 } else {
 187                     increaseReconcileCount(false);
 188                     updateReconciliationState(FAILED);
 189                     LOG.error("Reconciliation failed for node {} with error {}", nodeId, rpcResult.getErrors());
 190                 }
 191             } catch (ExecutionException | InterruptedException e) {
 192                 increaseReconcileCount(false);
 193                 updateReconciliationState(FAILED);
 194                 LOG.error("Error occurred while invoking reconcile RPC for node {}", nodeId, e);
 195             } finally {
 196                 alarmAgent.clearNodeReconciliationAlarm(nodeId.longValue());
 197             }
 198         }
 199
 200         private void increaseReconcileCount(final boolean isSuccess) {
 201             // FIXME: do not use SimpleDateFormat
 202             final SimpleDateFormat simpleDateFormat = new SimpleDateFormat(DATE_AND_TIME_FORMAT);
 203             InstanceIdentifier<ReconcileCounter> instanceIdentifier = InstanceIdentifier
 204                     .builder(ReconciliationCounter.class).child(ReconcileCounter.class,
 205                             new ReconcileCounterKey(nodeId)).build();
 206             ReadWriteTransaction tx = broker.newReadWriteTransaction();
 207             Optional<ReconcileCounter> count = getReconciliationCount(tx, instanceIdentifier);
 208             ReconcileCounterBuilder counterBuilder = new ReconcileCounterBuilder()
 209                     .withKey(new ReconcileCounterKey(nodeId))
 210                     .setLastRequestTime(new DateAndTime(simpleDateFormat.format(new Date())));
 211
 212             if (isSuccess) {
 213                 if (count.isPresent()) {
 214                     long successCount = count.get().getSuccessCount().toJava();
 215                     counterBuilder.setSuccessCount(Uint32.valueOf(++successCount));
 216                     LOG.debug("Reconcile success count {} for the node: {} ", successCount, nodeId);
 217                 } else {
 218                     counterBuilder.setSuccessCount(Uint32.ONE);
 219                 }
 220             } else {
 221                 if (count.isPresent()) {
 222                     long failureCount = count.get().getFailureCount().toJava();
 223                     counterBuilder.setFailureCount(Uint32.valueOf(++failureCount));
 224                     LOG.debug("Reconcile failure count {} for the node: {} ", failureCount, nodeId);
 225                 } else {
 226                     counterBuilder.setFailureCount(Uint32.ONE);
 227                 }
 228             }
 229             try {
 230                 tx.mergeParentStructureMerge(LogicalDatastoreType.OPERATIONAL, instanceIdentifier,
 231                         counterBuilder.build());
 232                 tx.commit().get();
 233             } catch (InterruptedException | ExecutionException e) {
 234                 LOG.error("Exception while submitting counter for {}", nodeId, e);
 235             }
 236         }
 237
 238         private Optional<ReconcileCounter> getReconciliationCount(final ReadWriteTransaction tx,
 239                 final InstanceIdentifier<ReconcileCounter> instanceIdentifier) {
 240             try {
 241                 return tx.read(LogicalDatastoreType.OPERATIONAL, instanceIdentifier).get();
 242             } catch (InterruptedException | ExecutionException e) {
 243                 LOG.error("Exception while reading counter for node: {}", nodeId, e);
 244             }
 245             return Optional.empty();
 246         }
 247
 248         private void updateReconciliationState(final ReconciliationState.ReconciliationStatus status) {
 249             ReconciliationState state = new ReconciliationState(status, LocalDateTime.now());
 250             reconciliationStates.put(nodeId.toString(),state);
 251         }
 252     }
 253 }
 254