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.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.frm.FlowNodeReconciliation;
  35 import org.opendaylight.openflowplugin.applications.frm.ForwardingRulesManager;
  36 import org.opendaylight.openflowplugin.applications.southboundcli.alarm.AlarmAgent;
  37 import org.opendaylight.openflowplugin.applications.southboundcli.util.OFNode;
  38 import org.opendaylight.openflowplugin.applications.southboundcli.util.ShellUtil;
  39 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.DateAndTime;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNode;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.reconciliation.service.rev180227.ReconcileInput;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.reconciliation.service.rev180227.ReconcileOutput;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.reconciliation.service.rev180227.ReconcileOutputBuilder;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.reconciliation.service.rev180227.ReconciliationCounter;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.reconciliation.service.rev180227.ReconciliationService;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.reconciliation.service.rev180227.reconciliation.counter.ReconcileCounter;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.reconciliation.service.rev180227.reconciliation.counter.ReconcileCounterBuilder;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.reconciliation.service.rev180227.reconciliation.counter.ReconcileCounterKey;
  53 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  54 import org.opendaylight.yangtools.yang.common.ErrorTag;
  55 import org.opendaylight.yangtools.yang.common.ErrorType;
  56 import org.opendaylight.yangtools.yang.common.RpcResult;
  57 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
  58 import org.opendaylight.yangtools.yang.common.Uint32;
  59 import org.opendaylight.yangtools.yang.common.Uint64;
  60 import org.slf4j.Logger;
  61 import org.slf4j.LoggerFactory;
  62
  63 public class ReconciliationServiceImpl implements ReconciliationService, AutoCloseable {
  64     private static final Logger LOG = LoggerFactory.getLogger(ReconciliationServiceImpl.class);
  65
  66     private final DataBroker broker;
  67     private final FlowNodeReconciliation flowNodeReconciliation;
  68     private final AlarmAgent alarmAgent;
  69     private final NodeListener nodeListener;
  70     private final Map<String, ReconciliationState> reconciliationStates;
  71
  72     private ExecutorService executor = Executors.newWorkStealingPool(10);
  73
  74     public ReconciliationServiceImpl(final DataBroker broker, final ForwardingRulesManager frm,
  75             final AlarmAgent alarmAgent, final NodeListener nodeListener,
  76             final FlowGroupCacheManager flowGroupCacheManager) {
  77         this.broker = requireNonNull(broker);
  78         flowNodeReconciliation = frm.getFlowNodeReconciliation();
  79         this.alarmAgent = requireNonNull(alarmAgent);
  80         this.nodeListener = requireNonNull(nodeListener);
  81         reconciliationStates = flowGroupCacheManager.getReconciliationStates();
  82     }
  83
  84     @Override
  85     public void close() {
  86         if (executor != null) {
  87             executor.shutdownNow();
  88             executor = null;
  89         }
  90     }
  91
  92     @Override
  93     public ListenableFuture<RpcResult<ReconcileOutput>> reconcile(final ReconcileInput input) {
  94         boolean reconcileAllNodes = input.getReconcileAllNodes();
  95         Set<Uint64> inputNodes = input.getNodes();
  96         if (inputNodes == null) {
  97             inputNodes = Set.of();
  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             ImmutableSet.Builder<Uint64> inprogressNodes = ImmutableSet.builder();
 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.build())
 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(final String msg) {
 146         LOG.error("Error {}", msg);
 147         return RpcResultBuilder.<ReconcileOutput>failed()
 148                 .withError(ErrorType.PROTOCOL, new ErrorTag("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(OFNode::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(final Uint64 nodeId, final NodeKey nodeKey) {
 164             this.nodeId = nodeId;
 165             this.nodeKey = nodeKey;
 166         }
 167
 168         @Override
 169         public void run() {
 170             updateReconciliationState(STARTED);
 171             final var reconOutput = flowNodeReconciliation.reconcileConfiguration(
 172                 InstanceIdentifier.create(Nodes.class)
 173                     .child(Node.class, nodeKey)
 174                     .augmentation(FlowCapableNode.class));
 175             try {
 176                 final boolean rpcResult = reconOutput.get();
 177                 increaseReconcileCount(rpcResult);
 178                 if (rpcResult) {
 179                     updateReconciliationState(COMPLETED);
 180                     LOG.info("Reconciliation successfully completed for node {}", nodeId);
 181                 } else {
 182                     updateReconciliationState(FAILED);
 183                     LOG.error("Reconciliation failed for node {}", nodeId);
 184                 }
 185             } catch (ExecutionException | InterruptedException e) {
 186                 increaseReconcileCount(false);
 187                 updateReconciliationState(FAILED);
 188                 LOG.error("Error occurred while invoking reconcile RPC for node {}", nodeId, e);
 189             } finally {
 190                 alarmAgent.clearNodeReconciliationAlarm(nodeId.longValue());
 191             }
 192         }
 193
 194         private void increaseReconcileCount(final boolean isSuccess) {
 195             // FIXME: do not use SimpleDateFormat
 196             final SimpleDateFormat simpleDateFormat = new SimpleDateFormat(DATE_AND_TIME_FORMAT);
 197             InstanceIdentifier<ReconcileCounter> instanceIdentifier = InstanceIdentifier
 198                     .builder(ReconciliationCounter.class).child(ReconcileCounter.class,
 199                             new ReconcileCounterKey(nodeId)).build();
 200             ReadWriteTransaction tx = broker.newReadWriteTransaction();
 201             Optional<ReconcileCounter> count = getReconciliationCount(tx, instanceIdentifier);
 202             ReconcileCounterBuilder counterBuilder = new ReconcileCounterBuilder()
 203                     .withKey(new ReconcileCounterKey(nodeId))
 204                     .setLastRequestTime(new DateAndTime(simpleDateFormat.format(new Date())));
 205
 206             if (isSuccess) {
 207                 if (count.isPresent()) {
 208                     long successCount = count.orElseThrow().getSuccessCount().toJava();
 209                     counterBuilder.setSuccessCount(Uint32.valueOf(++successCount));
 210                     LOG.debug("Reconcile success count {} for the node: {} ", successCount, nodeId);
 211                 } else {
 212                     counterBuilder.setSuccessCount(Uint32.ONE);
 213                 }
 214             } else if (count.isPresent()) {
 215                 long failureCount = count.orElseThrow().getFailureCount().toJava();
 216                 counterBuilder.setFailureCount(Uint32.valueOf(++failureCount));
 217                 LOG.debug("Reconcile failure count {} for the node: {} ", failureCount, nodeId);
 218             } else {
 219                 counterBuilder.setFailureCount(Uint32.ONE);
 220             }
 221             try {
 222                 tx.mergeParentStructureMerge(LogicalDatastoreType.OPERATIONAL, instanceIdentifier,
 223                         counterBuilder.build());
 224                 tx.commit().get();
 225             } catch (InterruptedException | ExecutionException e) {
 226                 LOG.error("Exception while submitting counter for {}", nodeId, e);
 227             }
 228         }
 229
 230         private Optional<ReconcileCounter> getReconciliationCount(final ReadWriteTransaction tx,
 231                 final InstanceIdentifier<ReconcileCounter> instanceIdentifier) {
 232             try {
 233                 return tx.read(LogicalDatastoreType.OPERATIONAL, instanceIdentifier).get();
 234             } catch (InterruptedException | ExecutionException e) {
 235                 LOG.error("Exception while reading counter for node: {}", nodeId, e);
 236             }
 237             return Optional.empty();
 238         }
 239
 240         private void updateReconciliationState(final ReconciliationState.ReconciliationStatus status) {
 241             ReconciliationState state = new ReconciliationState(status, LocalDateTime.now());
 242             reconciliationStates.put(nodeId.toString(),state);
 243         }
 244     }
 245 }
 246