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.lang.management.ManagementFactory;
  19 import java.text.SimpleDateFormat;
  20 import java.time.LocalDateTime;
  21 import java.util.Date;
  22 import java.util.List;
  23 import java.util.Map;
  24 import java.util.Optional;
  25 import java.util.Set;
  26 import java.util.concurrent.ExecutionException;
  27 import java.util.concurrent.ExecutorService;
  28 import java.util.concurrent.Executors;
  29 import java.util.stream.Collectors;
  30 import javax.management.InstanceAlreadyExistsException;
  31 import javax.management.InstanceNotFoundException;
  32 import javax.management.MBeanRegistrationException;
  33 import javax.management.MalformedObjectNameException;
  34 import javax.management.NotCompliantMBeanException;
  35 import javax.management.ObjectName;
  36 import org.eclipse.jdt.annotation.NonNull;
  37 import org.opendaylight.mdsal.binding.api.DataBroker;
  38 import org.opendaylight.mdsal.binding.api.ReadWriteTransaction;
  39 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  40 import org.opendaylight.openflowplugin.api.openflow.FlowGroupCacheManager;
  41 import org.opendaylight.openflowplugin.api.openflow.ReconciliationState;
  42 import org.opendaylight.openflowplugin.applications.frm.FlowNodeReconciliation;
  43 import org.opendaylight.openflowplugin.applications.frm.ForwardingRulesManager;
  44 import org.opendaylight.openflowplugin.applications.southboundcli.alarm.NodeReconciliationAlarm;
  45 import org.opendaylight.openflowplugin.applications.southboundcli.util.OFNode;
  46 import org.opendaylight.openflowplugin.applications.southboundcli.util.ShellUtil;
  47 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.DateAndTime;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNode;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.reconciliation.service.rev180227.ReconcileInput;
  54 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.reconciliation.service.rev180227.ReconcileOutput;
  55 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.reconciliation.service.rev180227.ReconcileOutputBuilder;
  56 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.reconciliation.service.rev180227.ReconciliationCounter;
  57 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.reconciliation.service.rev180227.ReconciliationService;
  58 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.reconciliation.service.rev180227.reconciliation.counter.ReconcileCounter;
  59 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.reconciliation.service.rev180227.reconciliation.counter.ReconcileCounterBuilder;
  60 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.reconciliation.service.rev180227.reconciliation.counter.ReconcileCounterKey;
  61 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  62 import org.opendaylight.yangtools.yang.common.ErrorTag;
  63 import org.opendaylight.yangtools.yang.common.ErrorType;
  64 import org.opendaylight.yangtools.yang.common.RpcResult;
  65 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
  66 import org.opendaylight.yangtools.yang.common.Uint32;
  67 import org.opendaylight.yangtools.yang.common.Uint64;
  68 import org.slf4j.Logger;
  69 import org.slf4j.LoggerFactory;
  70
  71 // FIXME: this is not just a CLI component, it should live somewhere else
  72 public final class ReconciliationServiceImpl implements ReconciliationService, AutoCloseable {
  73     private static final Logger LOG = LoggerFactory.getLogger(ReconciliationServiceImpl.class);
  74     private static final ObjectName ALARM_NAME;
  75
  76     static {
  77         try {
  78             ALARM_NAME = new ObjectName("SDNC.FM:name=NodeReconciliationOperationOngoingBean");
  79         } catch (MalformedObjectNameException e) {
  80             throw new ExceptionInInitializerError(e);
  81         }
  82     }
  83
  84     private final NodeReconciliationAlarm alarm = new NodeReconciliationAlarm();
  85     private final DataBroker broker;
  86     private final FlowNodeReconciliation flowNodeReconciliation;
  87     private final NodeListener nodeListener;
  88     private final Map<String, ReconciliationState> reconciliationStates;
  89
  90     private ExecutorService executor = Executors.newWorkStealingPool(10);
  91     private boolean unregister;
  92
  93     public ReconciliationServiceImpl(final DataBroker broker, final ForwardingRulesManager frm,
  94             final NodeListener nodeListener, final FlowGroupCacheManager flowGroupCacheManager) {
  95         this.broker = requireNonNull(broker);
  96         flowNodeReconciliation = frm.getFlowNodeReconciliation();
  97         this.nodeListener = requireNonNull(nodeListener);
  98         reconciliationStates = flowGroupCacheManager.getReconciliationStates();
  99
 100         unregister = false;
 101         final var mbs = ManagementFactory.getPlatformMBeanServer();
 102         if (!mbs.isRegistered(ALARM_NAME)) {
 103             try {
 104                 mbs.registerMBean(alarm, ALARM_NAME);
 105                 unregister = true;
 106                 LOG.info("Registered Mbean {} successfully", ALARM_NAME);
 107             } catch (InstanceAlreadyExistsException | MBeanRegistrationException | NotCompliantMBeanException e) {
 108                 LOG.error("Registeration failed for Mbean {}", ALARM_NAME, e);
 109             }
 110         }
 111     }
 112
 113     @Override
 114     public void close() {
 115         if (unregister) {
 116             unregister = false;
 117             try {
 118                 ManagementFactory.getPlatformMBeanServer().unregisterMBean(ALARM_NAME);
 119             } catch (MBeanRegistrationException | InstanceNotFoundException e) {
 120                 LOG.error("Unregisteration failed for Mbean {}", ALARM_NAME, e);
 121             }
 122         }
 123
 124         if (executor != null) {
 125             executor.shutdownNow();
 126             executor = null;
 127         }
 128     }
 129
 130     @Override
 131     public ListenableFuture<RpcResult<ReconcileOutput>> reconcile(final ReconcileInput input) {
 132         boolean reconcileAllNodes = input.getReconcileAllNodes();
 133         Set<Uint64> inputNodes = input.getNodes();
 134         if (inputNodes == null) {
 135             inputNodes = Set.of();
 136         }
 137         if (reconcileAllNodes && inputNodes.size() > 0) {
 138             return buildErrorResponse("Error executing command reconcile. "
 139                     + "If 'all' option is enabled, no Node must be specified as input parameter.");
 140         }
 141         if (!reconcileAllNodes && inputNodes.size() == 0) {
 142             return buildErrorResponse("Error executing command reconcile. No Node information was specified.");
 143         }
 144         SettableFuture<RpcResult<ReconcileOutput>> result = SettableFuture.create();
 145         List<Long> nodeList = getAllNodes();
 146         List<Long> nodesToReconcile = reconcileAllNodes ? nodeList :
 147                 inputNodes.stream().distinct().map(Uint64::longValue).collect(Collectors.toList());
 148         if (nodesToReconcile.size() > 0) {
 149             List<Long> unresolvedNodes =
 150                     nodesToReconcile.stream().filter(node -> !nodeList.contains(node)).collect(Collectors.toList());
 151             if (!unresolvedNodes.isEmpty()) {
 152                 return buildErrorResponse("Error executing command reconcile. "
 153                         + "Node(s) not found: " + String.join(", ", unresolvedNodes.toString()));
 154             }
 155             ImmutableSet.Builder<Uint64> inprogressNodes = ImmutableSet.builder();
 156             nodesToReconcile.parallelStream().forEach(nodeId -> {
 157                 ReconciliationState state = getReconciliationState(nodeId);
 158                 if (state != null && state.getState().equals(STARTED)) {
 159                     inprogressNodes.add(Uint64.valueOf(nodeId));
 160                 } else {
 161                     final var alarmText = getAlarmText(nodeId,  " started reconciliation");
 162                     final var source = getSourceText(nodeId);
 163                     LOG.debug("Raising NodeReconciliationOperationOngoing alarm, alarmText {} source {}", alarmText,
 164                         source);
 165                     alarm.raiseAlarm("NodeReconciliationOperationOngoing", alarmText, source);
 166                     LOG.info("Executing reconciliation for node {} with state ", nodeId);
 167                     NodeKey nodeKey = new NodeKey(new NodeId("openflow:" + nodeId));
 168                     executor.execute(new ReconciliationTask(Uint64.valueOf(nodeId), nodeKey));
 169                 }
 170             });
 171             ReconcileOutput reconcilingInProgress = new ReconcileOutputBuilder()
 172                     .setInprogressNodes(inprogressNodes.build())
 173                     .build();
 174             result.set(RpcResultBuilder.success(reconcilingInProgress).build());
 175             return result;
 176         } else {
 177             return buildErrorResponse("Error executing command reconcile. "
 178                     + "No node information is found for reconciliation");
 179         }
 180     }
 181
 182     private ReconciliationState getReconciliationState(final Long nodeId) {
 183         return reconciliationStates.get(nodeId.toString());
 184     }
 185
 186     private static ListenableFuture<RpcResult<ReconcileOutput>> buildErrorResponse(final String msg) {
 187         LOG.error("Error {}", msg);
 188         return RpcResultBuilder.<ReconcileOutput>failed()
 189                 .withError(ErrorType.PROTOCOL, new ErrorTag("reconcile"), msg)
 190                 .buildFuture();
 191     }
 192
 193     private List<Long> getAllNodes() {
 194         List<OFNode> nodeList = ShellUtil.getAllNodes(nodeListener);
 195         List<Long> nodes = nodeList.stream().distinct().map(OFNode::getNodeId).collect(Collectors.toList());
 196         return nodes;
 197     }
 198
 199     /**
 200      * Method gets the alarm text for the nodeId.
 201      *
 202      * @param nodeId Source of the alarm nodeId
 203      * @param event reason for alarm invoke/clear
 204      */
 205     private static @NonNull String getAlarmText(final Long nodeId, final String event) {
 206         return "OF Switch " + nodeId + event;
 207     }
 208
 209     /**
 210      * Method gets the source text for the nodeId.
 211      *
 212      * @param nodeId Source of the alarm nodeId
 213      */
 214     private static String getSourceText(final Long nodeId) {
 215         return "Dpn=" + nodeId;
 216     }
 217
 218     private final class ReconciliationTask implements Runnable {
 219         private static final String DATE_AND_TIME_FORMAT = "yyyy-MM-dd'T'HH:mm:ss.SSSXXX";
 220         private final NodeKey nodeKey;
 221         private final Uint64 nodeId;
 222
 223         private ReconciliationTask(final Uint64 nodeId, final NodeKey nodeKey) {
 224             this.nodeId = nodeId;
 225             this.nodeKey = nodeKey;
 226         }
 227
 228         @Override
 229         public void run() {
 230             updateReconciliationState(STARTED);
 231             final var reconOutput = flowNodeReconciliation.reconcileConfiguration(
 232                 InstanceIdentifier.create(Nodes.class)
 233                     .child(Node.class, nodeKey)
 234                     .augmentation(FlowCapableNode.class));
 235             try {
 236                 final boolean rpcResult = reconOutput.get();
 237                 increaseReconcileCount(rpcResult);
 238                 if (rpcResult) {
 239                     updateReconciliationState(COMPLETED);
 240                     LOG.info("Reconciliation successfully completed for node {}", nodeId);
 241                 } else {
 242                     updateReconciliationState(FAILED);
 243                     LOG.error("Reconciliation failed for node {}", nodeId);
 244                 }
 245             } catch (ExecutionException | InterruptedException e) {
 246                 increaseReconcileCount(false);
 247                 updateReconciliationState(FAILED);
 248                 LOG.error("Error occurred while invoking reconcile RPC for node {}", nodeId, e);
 249             } finally {
 250                 final var dpnId = nodeId.longValue();
 251                 final var alarmText = getAlarmText(dpnId, " finished reconciliation");
 252                 final var source = getSourceText(dpnId);
 253                 LOG.debug("Clearing NodeReconciliationOperationOngoing alarm of source {}", source);
 254                 alarm.clearAlarm("NodeReconciliationOperationOngoing", alarmText, source);
 255             }
 256         }
 257
 258         private void increaseReconcileCount(final boolean isSuccess) {
 259             // FIXME: do not use SimpleDateFormat
 260             final SimpleDateFormat simpleDateFormat = new SimpleDateFormat(DATE_AND_TIME_FORMAT);
 261             InstanceIdentifier<ReconcileCounter> instanceIdentifier = InstanceIdentifier
 262                     .builder(ReconciliationCounter.class).child(ReconcileCounter.class,
 263                             new ReconcileCounterKey(nodeId)).build();
 264             ReadWriteTransaction tx = broker.newReadWriteTransaction();
 265             Optional<ReconcileCounter> count = getReconciliationCount(tx, instanceIdentifier);
 266             ReconcileCounterBuilder counterBuilder = new ReconcileCounterBuilder()
 267                     .withKey(new ReconcileCounterKey(nodeId))
 268                     .setLastRequestTime(new DateAndTime(simpleDateFormat.format(new Date())));
 269
 270             if (isSuccess) {
 271                 if (count.isPresent()) {
 272                     long successCount = count.orElseThrow().getSuccessCount().toJava();
 273                     counterBuilder.setSuccessCount(Uint32.valueOf(++successCount));
 274                     LOG.debug("Reconcile success count {} for the node: {} ", successCount, nodeId);
 275                 } else {
 276                     counterBuilder.setSuccessCount(Uint32.ONE);
 277                 }
 278             } else if (count.isPresent()) {
 279                 long failureCount = count.orElseThrow().getFailureCount().toJava();
 280                 counterBuilder.setFailureCount(Uint32.valueOf(++failureCount));
 281                 LOG.debug("Reconcile failure count {} for the node: {} ", failureCount, nodeId);
 282             } else {
 283                 counterBuilder.setFailureCount(Uint32.ONE);
 284             }
 285             try {
 286                 tx.mergeParentStructureMerge(LogicalDatastoreType.OPERATIONAL, instanceIdentifier,
 287                         counterBuilder.build());
 288                 tx.commit().get();
 289             } catch (InterruptedException | ExecutionException e) {
 290                 LOG.error("Exception while submitting counter for {}", nodeId, e);
 291             }
 292         }
 293
 294         private Optional<ReconcileCounter> getReconciliationCount(final ReadWriteTransaction tx,
 295                 final InstanceIdentifier<ReconcileCounter> instanceIdentifier) {
 296             try {
 297                 return tx.read(LogicalDatastoreType.OPERATIONAL, instanceIdentifier).get();
 298             } catch (InterruptedException | ExecutionException e) {
 299                 LOG.error("Exception while reading counter for node: {}", nodeId, e);
 300             }
 301             return Optional.empty();
 302         }
 303
 304         private void updateReconciliationState(final ReconciliationState.ReconciliationStatus status) {
 305             reconciliationStates.put(nodeId.toString(), new ReconciliationState(status, LocalDateTime.now()));
 306         }
 307     }
 308 }
 309