* terms of the Eclipse Public License v1.0 which accompanies this distribution,
* and is available at http://www.eclipse.org/legal/epl-v10.html
*/
-
package org.opendaylight.openflowplugin.applications.southboundcli;
-import com.google.common.base.Optional;
+import static java.util.Objects.requireNonNull;
+import static org.opendaylight.openflowplugin.api.openflow.ReconciliationState.ReconciliationStatus.COMPLETED;
+import static org.opendaylight.openflowplugin.api.openflow.ReconciliationState.ReconciliationStatus.FAILED;
+import static org.opendaylight.openflowplugin.api.openflow.ReconciliationState.ReconciliationStatus.STARTED;
+
+import com.google.common.collect.ImmutableSet;
import com.google.common.util.concurrent.ListenableFuture;
import com.google.common.util.concurrent.SettableFuture;
-import java.math.BigInteger;
+import java.lang.management.ManagementFactory;
+import java.text.SimpleDateFormat;
import java.time.LocalDateTime;
-import java.util.ArrayList;
+import java.util.Date;
import java.util.List;
+import java.util.Map;
+import java.util.Optional;
+import java.util.Set;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
-import java.util.concurrent.Future;
import java.util.stream.Collectors;
-import org.opendaylight.controller.md.sal.binding.api.DataBroker;
-import org.opendaylight.controller.md.sal.binding.api.ReadWriteTransaction;
-import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
-import org.opendaylight.openflowplugin.applications.southboundcli.alarm.AlarmAgent;
+import javax.management.InstanceAlreadyExistsException;
+import javax.management.InstanceNotFoundException;
+import javax.management.MBeanRegistrationException;
+import javax.management.MalformedObjectNameException;
+import javax.management.NotCompliantMBeanException;
+import javax.management.ObjectName;
+import org.eclipse.jdt.annotation.NonNull;
+import org.opendaylight.mdsal.binding.api.DataBroker;
+import org.opendaylight.mdsal.binding.api.ReadWriteTransaction;
+import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
+import org.opendaylight.openflowplugin.api.openflow.FlowGroupCacheManager;
+import org.opendaylight.openflowplugin.api.openflow.ReconciliationState;
+import org.opendaylight.openflowplugin.applications.frm.FlowNodeReconciliation;
+import org.opendaylight.openflowplugin.applications.frm.ForwardingRulesManager;
+import org.opendaylight.openflowplugin.applications.southboundcli.alarm.NodeReconciliationAlarm;
import org.opendaylight.openflowplugin.applications.southboundcli.util.OFNode;
-import org.opendaylight.openflowplugin.applications.southboundcli.util.ShellUtil;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.DateAndTime;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNode;
import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef;
import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.frm.reconciliation.service.rev180227.FrmReconciliationService;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.frm.reconciliation.service.rev180227.ReconcileNodeInput;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.frm.reconciliation.service.rev180227.ReconcileNodeInputBuilder;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.frm.reconciliation.service.rev180227.ReconcileNodeOutput;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.reconciliation.service.rev180227.ReconcileInput;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.reconciliation.service.rev180227.ReconcileOutput;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.reconciliation.service.rev180227.ReconcileOutputBuilder;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.reconciliation.service.rev180227.ReconciliationCounter;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.reconciliation.service.rev180227.ReconciliationService;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.reconciliation.service.rev180227.reconciliation.counter.ReconcileCounter;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.reconciliation.service.rev180227.reconciliation.counter.ReconcileCounterBuilder;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.reconciliation.service.rev180227.reconciliation.counter.ReconcileCounterKey;
import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
-import org.opendaylight.yangtools.yang.common.RpcError;
+import org.opendaylight.yangtools.yang.common.ErrorTag;
+import org.opendaylight.yangtools.yang.common.ErrorType;
import org.opendaylight.yangtools.yang.common.RpcResult;
import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
+import org.opendaylight.yangtools.yang.common.Uint32;
+import org.opendaylight.yangtools.yang.common.Uint64;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-public class ReconciliationServiceImpl implements ReconciliationService, AutoCloseable {
-
+// FIXME: this is not just a CLI component, it should live somewhere else
+public final class ReconciliationServiceImpl implements ReconciliationService, AutoCloseable {
private static final Logger LOG = LoggerFactory.getLogger(ReconciliationServiceImpl.class);
+ private static final ObjectName ALARM_NAME;
+
+ static {
+ try {
+ ALARM_NAME = new ObjectName("SDNC.FM:name=NodeReconciliationOperationOngoingBean");
+ } catch (MalformedObjectNameException e) {
+ throw new ExceptionInInitializerError(e);
+ }
+ }
+
+ private final NodeReconciliationAlarm alarm = new NodeReconciliationAlarm();
+ private final Map<String, ReconciliationState> reconciliationStates;
+ private final FlowNodeReconciliation flowNodeReconciliation;
+ private final DpnTracker dpnTracker;
private final DataBroker broker;
- private final FrmReconciliationService frmReconciliationService;
- private final Long startCount = 1L;
- private final AlarmAgent alarmAgent;
- private static final int THREAD_POOL_SIZE = 10;
- private final ExecutorService executor = Executors.newFixedThreadPool(THREAD_POOL_SIZE);
-
- public ReconciliationServiceImpl(final DataBroker broker, final FrmReconciliationService frmReconciliationService,
- final AlarmAgent alarmAgent) {
- this.broker = broker;
- this.frmReconciliationService = frmReconciliationService;
- this.alarmAgent = alarmAgent;
+
+ private ExecutorService executor = Executors.newWorkStealingPool(10);
+ private boolean unregister;
+
+ public ReconciliationServiceImpl(final DataBroker broker, final ForwardingRulesManager frm,
+ final DpnTracker dpnTracker, final FlowGroupCacheManager flowGroupCacheManager) {
+ this.broker = requireNonNull(broker);
+ flowNodeReconciliation = frm.getFlowNodeReconciliation();
+ this.dpnTracker = requireNonNull(dpnTracker);
+ reconciliationStates = flowGroupCacheManager.getReconciliationStates();
+
+ unregister = false;
+ final var mbs = ManagementFactory.getPlatformMBeanServer();
+ if (!mbs.isRegistered(ALARM_NAME)) {
+ try {
+ mbs.registerMBean(alarm, ALARM_NAME);
+ unregister = true;
+ LOG.info("Registered Mbean {} successfully", ALARM_NAME);
+ } catch (InstanceAlreadyExistsException | MBeanRegistrationException | NotCompliantMBeanException e) {
+ LOG.error("Registeration failed for Mbean {}", ALARM_NAME, e);
+ }
+ }
}
@Override
public void close() {
+ if (unregister) {
+ unregister = false;
+ try {
+ ManagementFactory.getPlatformMBeanServer().unregisterMBean(ALARM_NAME);
+ } catch (MBeanRegistrationException | InstanceNotFoundException e) {
+ LOG.error("Unregisteration failed for Mbean {}", ALARM_NAME, e);
+ }
+ }
+
if (executor != null) {
executor.shutdownNow();
+ executor = null;
}
}
@Override
- public ListenableFuture<RpcResult<ReconcileOutput>> reconcile(ReconcileInput input) {
- boolean reconcileAllNodes = input.isReconcileAllNodes();
- List<BigInteger> inputNodes = input.getNodes();
+ public ListenableFuture<RpcResult<ReconcileOutput>> reconcile(final ReconcileInput input) {
+ boolean reconcileAllNodes = input.getReconcileAllNodes();
+ Set<Uint64> inputNodes = input.getNodes();
if (inputNodes == null) {
- inputNodes = new ArrayList<>();
+ inputNodes = Set.of();
}
if (reconcileAllNodes && inputNodes.size() > 0) {
return buildErrorResponse("Error executing command reconcile. "
SettableFuture<RpcResult<ReconcileOutput>> result = SettableFuture.create();
List<Long> nodeList = getAllNodes();
List<Long> nodesToReconcile = reconcileAllNodes ? nodeList :
- inputNodes.stream().distinct().map(node -> node.longValue()).collect(Collectors.toList());
+ inputNodes.stream().distinct().map(Uint64::longValue).collect(Collectors.toList());
if (nodesToReconcile.size() > 0) {
List<Long> unresolvedNodes =
nodesToReconcile.stream().filter(node -> !nodeList.contains(node)).collect(Collectors.toList());
return buildErrorResponse("Error executing command reconcile. "
+ "Node(s) not found: " + String.join(", ", unresolvedNodes.toString()));
}
+ ImmutableSet.Builder<Uint64> inprogressNodes = ImmutableSet.builder();
nodesToReconcile.parallelStream().forEach(nodeId -> {
- alarmAgent.raiseNodeReconciliationAlarm(nodeId);
- LOG.info("Executing reconciliation for node {}", nodeId);
- NodeKey nodeKey = new NodeKey(new NodeId("openflow:" + nodeId));
- ReconciliationTask reconcileTask = new ReconciliationTask(nodeId, nodeKey);
- executor.execute(reconcileTask);
+ ReconciliationState state = getReconciliationState(nodeId);
+ if (state != null && state.getState().equals(STARTED)) {
+ inprogressNodes.add(Uint64.valueOf(nodeId));
+ } else {
+ final var alarmText = getAlarmText(nodeId, " started reconciliation");
+ final var source = getSourceText(nodeId);
+ LOG.debug("Raising NodeReconciliationOperationOngoing alarm, alarmText {} source {}", alarmText,
+ source);
+ alarm.raiseAlarm("NodeReconciliationOperationOngoing", alarmText, source);
+ LOG.info("Executing reconciliation for node {} with state ", nodeId);
+ NodeKey nodeKey = new NodeKey(new NodeId("openflow:" + nodeId));
+ executor.execute(new ReconciliationTask(Uint64.valueOf(nodeId), nodeKey));
+ }
});
+ ReconcileOutput reconcilingInProgress = new ReconcileOutputBuilder()
+ .setInprogressNodes(inprogressNodes.build())
+ .build();
+ result.set(RpcResultBuilder.success(reconcilingInProgress).build());
+ return result;
} else {
return buildErrorResponse("Error executing command reconcile. "
+ "No node information is found for reconciliation");
}
- result.set(RpcResultBuilder.<ReconcileOutput>success().build());
- return result;
}
- private ListenableFuture<RpcResult<ReconcileOutput>> buildErrorResponse(String msg) {
- SettableFuture<RpcResult<ReconcileOutput>> result = SettableFuture.create();
- LOG.error(msg);
- RpcError error = RpcResultBuilder.newError(RpcError.ErrorType.PROTOCOL, "reconcile", msg);
- result.set(RpcResultBuilder.<ReconcileOutput>failed().withRpcError(error).build());
- return result;
+ private ReconciliationState getReconciliationState(final Long nodeId) {
+ return reconciliationStates.get(nodeId.toString());
}
- public List<Long> getAllNodes() {
- List<OFNode> nodeList = ShellUtil.getAllNodes(broker);
- List<Long> nodes = nodeList.stream().distinct().map(node -> node.getNodeId()).collect(Collectors.toList());
- return nodes;
+ private static ListenableFuture<RpcResult<ReconcileOutput>> buildErrorResponse(final String msg) {
+ LOG.error("Error {}", msg);
+ return RpcResultBuilder.<ReconcileOutput>failed()
+ .withError(ErrorType.PROTOCOL, new ErrorTag("reconcile"), msg)
+ .buildFuture();
}
- private void increaseReconcileCount(BigInteger nodeId, Boolean reconcileState) {
- InstanceIdentifier<ReconcileCounter> instanceIdentifier = InstanceIdentifier
- .builder(ReconciliationCounter.class).child(ReconcileCounter.class,
- new ReconcileCounterKey(nodeId)).build();
- ReadWriteTransaction tx = broker.newReadWriteTransaction();
- Optional<ReconcileCounter> optional = readReconcileCounterFromDS(tx, instanceIdentifier, nodeId);
- ReconcileCounterBuilder counterBuilder = new ReconcileCounterBuilder()
- .withKey(new ReconcileCounterKey(nodeId)).setNodeId(nodeId)
- .setLastRequestTime(LocalDateTime.now().toString());
- if (reconcileState) {
- counterBuilder.setSuccessCount(startCount);
- if (optional.isPresent()) {
- ReconcileCounter counter = optional.get();
- Long successCount = counter.getSuccessCount();
- counterBuilder.setSuccessCount(++successCount);
- LOG.debug("Reconcile Success count {} for the node: {} ", successCount, nodeId);
- }
- } else {
- counterBuilder.setFailureCount(startCount);
- if (optional.isPresent()) {
- ReconcileCounter counter = optional.get();
- Long failureCount = counter.getFailureCount();
- counterBuilder.setFailureCount(++failureCount);
- LOG.debug("Reconcile Failure count {} for the node: {} ", failureCount, nodeId);
- }
- }
- try {
- tx.merge(LogicalDatastoreType.OPERATIONAL, instanceIdentifier, counterBuilder.build(), true);
- tx.submit().get();
- } catch (InterruptedException | ExecutionException e) {
- LOG.error("Exception while submitting counter {}", nodeId, e);
- }
+ private List<Long> getAllNodes() {
+ return dpnTracker.currentNodes().stream().distinct().map(OFNode::getNodeId).collect(Collectors.toList());
}
- private Optional<ReconcileCounter> readReconcileCounterFromDS(ReadWriteTransaction tx,
- InstanceIdentifier<ReconcileCounter> instanceIdentifier, BigInteger nodeId) {
- try {
- return tx.read(LogicalDatastoreType.OPERATIONAL, instanceIdentifier).get();
- } catch (InterruptedException | ExecutionException e) {
- LOG.error("Exception while reading counter for node: {}", nodeId, e);
- }
- return Optional.absent();
+ /**
+ * Method gets the alarm text for the nodeId.
+ *
+ * @param nodeId Source of the alarm nodeId
+ * @param event reason for alarm invoke/clear
+ */
+ private static @NonNull String getAlarmText(final Long nodeId, final String event) {
+ return "OF Switch " + nodeId + event;
+ }
+
+ /**
+ * Method gets the source text for the nodeId.
+ *
+ * @param nodeId Source of the alarm nodeId
+ */
+ private static String getSourceText(final Long nodeId) {
+ return "Dpn=" + nodeId;
}
private final class ReconciliationTask implements Runnable {
+ private static final String DATE_AND_TIME_FORMAT = "yyyy-MM-dd'T'HH:mm:ss.SSSXXX";
private final NodeKey nodeKey;
- private final Long nodeId;
+ private final Uint64 nodeId;
- private ReconciliationTask(Long nodeId, NodeKey nodeKey) {
+ private ReconciliationTask(final Uint64 nodeId, final NodeKey nodeKey) {
this.nodeId = nodeId;
this.nodeKey = nodeKey;
}
@Override
public void run() {
- BigInteger node = new BigInteger(String.valueOf(nodeId));
- ReconcileNodeInput reconInput = new ReconcileNodeInputBuilder()
- .setNodeId(node).setNode(new NodeRef(InstanceIdentifier.builder(Nodes.class)
- .child(Node.class, nodeKey).build())).build();
- Future<RpcResult<ReconcileNodeOutput>> reconOutput = frmReconciliationService
- .reconcileNode(reconInput);
+ updateReconciliationState(STARTED);
+ final var reconOutput = flowNodeReconciliation.reconcileConfiguration(
+ InstanceIdentifier.create(Nodes.class)
+ .child(Node.class, nodeKey)
+ .augmentation(FlowCapableNode.class));
try {
- RpcResult<ReconcileNodeOutput> rpcResult = reconOutput.get();
- if (rpcResult.isSuccessful()) {
- increaseReconcileCount(node, true);
+ final boolean rpcResult = reconOutput.get();
+ increaseReconcileCount(rpcResult);
+ if (rpcResult) {
+ updateReconciliationState(COMPLETED);
LOG.info("Reconciliation successfully completed for node {}", nodeId);
} else {
- increaseReconcileCount(node, false);
- LOG.error("Reconciliation failed for node {} with error {}", nodeId, rpcResult.getErrors());
+ updateReconciliationState(FAILED);
+ LOG.error("Reconciliation failed for node {}", nodeId);
}
} catch (ExecutionException | InterruptedException e) {
- increaseReconcileCount(node, false);
+ increaseReconcileCount(false);
+ updateReconciliationState(FAILED);
LOG.error("Error occurred while invoking reconcile RPC for node {}", nodeId, e);
} finally {
- alarmAgent.clearNodeReconciliationAlarm(nodeId);
+ final var dpnId = nodeId.longValue();
+ final var alarmText = getAlarmText(dpnId, " finished reconciliation");
+ final var source = getSourceText(dpnId);
+ LOG.debug("Clearing NodeReconciliationOperationOngoing alarm of source {}", source);
+ alarm.clearAlarm("NodeReconciliationOperationOngoing", alarmText, source);
+ }
+ }
+
+ private void increaseReconcileCount(final boolean isSuccess) {
+ // FIXME: do not use SimpleDateFormat
+ final SimpleDateFormat simpleDateFormat = new SimpleDateFormat(DATE_AND_TIME_FORMAT);
+ InstanceIdentifier<ReconcileCounter> instanceIdentifier = InstanceIdentifier
+ .builder(ReconciliationCounter.class).child(ReconcileCounter.class,
+ new ReconcileCounterKey(nodeId)).build();
+ ReadWriteTransaction tx = broker.newReadWriteTransaction();
+ Optional<ReconcileCounter> count = getReconciliationCount(tx, instanceIdentifier);
+ ReconcileCounterBuilder counterBuilder = new ReconcileCounterBuilder()
+ .withKey(new ReconcileCounterKey(nodeId))
+ .setLastRequestTime(new DateAndTime(simpleDateFormat.format(new Date())));
+
+ if (isSuccess) {
+ if (count.isPresent()) {
+ long successCount = count.orElseThrow().getSuccessCount().toJava();
+ counterBuilder.setSuccessCount(Uint32.valueOf(++successCount));
+ LOG.debug("Reconcile success count {} for the node: {} ", successCount, nodeId);
+ } else {
+ counterBuilder.setSuccessCount(Uint32.ONE);
+ }
+ } else if (count.isPresent()) {
+ long failureCount = count.orElseThrow().getFailureCount().toJava();
+ counterBuilder.setFailureCount(Uint32.valueOf(++failureCount));
+ LOG.debug("Reconcile failure count {} for the node: {} ", failureCount, nodeId);
+ } else {
+ counterBuilder.setFailureCount(Uint32.ONE);
}
+ try {
+ tx.mergeParentStructureMerge(LogicalDatastoreType.OPERATIONAL, instanceIdentifier,
+ counterBuilder.build());
+ tx.commit().get();
+ } catch (InterruptedException | ExecutionException e) {
+ LOG.error("Exception while submitting counter for {}", nodeId, e);
+ }
+ }
+
+ private Optional<ReconcileCounter> getReconciliationCount(final ReadWriteTransaction tx,
+ final InstanceIdentifier<ReconcileCounter> instanceIdentifier) {
+ try {
+ return tx.read(LogicalDatastoreType.OPERATIONAL, instanceIdentifier).get();
+ } catch (InterruptedException | ExecutionException e) {
+ LOG.error("Exception while reading counter for node: {}", nodeId, e);
+ }
+ return Optional.empty();
+ }
+
+ private void updateReconciliationState(final ReconciliationState.ReconciliationStatus status) {
+ reconciliationStates.put(nodeId.toString(), new ReconciliationState(status, LocalDateTime.now()));
}
}
}
Code Review / openflowplugin.git / blobdiff