Change return type of events
[openflowplugin.git] / openflowplugin-impl / src / main / java / org / opendaylight / openflowplugin / impl / lifecycle / ContextChainImpl.java
index dfc6d67c0558418a1c9907424a6049f44ed4e225..153945c307746a327b54d333f1743fbe10d9340b 100644 (file)
  */
 package org.opendaylight.openflowplugin.impl.lifecycle;
 
-import java.util.HashSet;
-import java.util.Set;
-import java.util.concurrent.Future;
+import static org.opendaylight.openflowplugin.api.openflow.OFPContext.ContextState;
+
+import com.google.common.collect.Lists;
+import com.google.common.util.concurrent.FutureCallback;
+import com.google.common.util.concurrent.Futures;
+import com.google.common.util.concurrent.ListenableFuture;
+import java.util.List;
+import java.util.Objects;
+import java.util.concurrent.CopyOnWriteArrayList;
+import java.util.concurrent.ExecutorService;
+import java.util.concurrent.atomic.AtomicBoolean;
+import java.util.stream.Collectors;
+import javax.annotation.Nonnull;
+import javax.annotation.Nullable;
+import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonServiceProvider;
+import org.opendaylight.mdsal.singleton.common.api.ServiceGroupIdentifier;
+import org.opendaylight.openflowplugin.api.ConnectionException;
 import org.opendaylight.openflowplugin.api.openflow.OFPContext;
 import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
+import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
+import org.opendaylight.openflowplugin.api.openflow.device.DeviceInfo;
+import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceRemovedHandler;
 import org.opendaylight.openflowplugin.api.openflow.lifecycle.ContextChain;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflow.provider.config.rev160510.ContextChainState;
+import org.opendaylight.openflowplugin.api.openflow.lifecycle.ContextChainMastershipState;
+import org.opendaylight.openflowplugin.api.openflow.lifecycle.ContextChainMastershipWatcher;
+import org.opendaylight.openflowplugin.api.openflow.lifecycle.ContextChainState;
+import org.opendaylight.openflowplugin.api.openflow.lifecycle.ContextChainStateListener;
+import org.opendaylight.openflowplugin.api.openflow.statistics.StatisticsContext;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.role.service.rev150727.SetRoleOutput;
+import org.opendaylight.yangtools.yang.common.RpcResult;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 public class ContextChainImpl implements ContextChain {
+    private static final Logger LOG = LoggerFactory.getLogger(ContextChainImpl.class);
+    private final AtomicBoolean masterStateOnDevice = new AtomicBoolean(false);
+    private final AtomicBoolean initialGathering = new AtomicBoolean(false);
+    private final AtomicBoolean initialSubmitting = new AtomicBoolean(false);
+    private final AtomicBoolean registryFilling = new AtomicBoolean(false);
+    private final AtomicBoolean rpcRegistration = new AtomicBoolean(false);
+    private final List<DeviceRemovedHandler> deviceRemovedHandlers = new CopyOnWriteArrayList<>();
+    private final List<OFPContext> contexts = new CopyOnWriteArrayList<>();
+    private final List<ConnectionContext> auxiliaryConnections = new CopyOnWriteArrayList<>();
+    private final ExecutorService executorService;
+    private final ContextChainMastershipWatcher contextChainMastershipWatcher;
+    private final DeviceInfo deviceInfo;
+    private final ConnectionContext primaryConnection;
+    private AutoCloseable registration;
+    private ContextState state = ContextState.INITIALIZATION;
 
-    private Set<OFPContext> contexts = new HashSet<>();
-    private final ContextChainState contextChainState;
-    private ConnectionContext primaryConnectionContext;
+    private volatile ContextChainState contextChainState = ContextChainState.UNDEFINED;
 
-    public ContextChainImpl(final ContextChainState contextChainState) {
-        this.contextChainState = contextChainState;
+    ContextChainImpl(@Nonnull final ContextChainMastershipWatcher contextChainMastershipWatcher,
+                     @Nonnull final ConnectionContext connectionContext,
+                     @Nonnull final ExecutorService executorService) {
+        this.contextChainMastershipWatcher = contextChainMastershipWatcher;
+        this.primaryConnection = connectionContext;
+        this.deviceInfo = connectionContext.getDeviceInfo();
+        this.executorService = executorService;
     }
 
     @Override
-    public boolean isReady() {
-        return false;
+    public <T extends OFPContext> void addContext(@Nonnull final T context) {
+        contexts.add(context);
     }
 
     @Override
-    public <T extends OFPContext> void addContext(final T context) {
+    public void instantiateServiceInstance() {
+        LOG.info("Starting clustering services for node {}", deviceInfo);
 
+        try {
+            contexts.forEach(this::initializeContextService);
+            LOG.info("Started clustering services for node {}", deviceInfo);
+        } catch (final Exception ex) {
+            executorService.submit(() -> contextChainMastershipWatcher
+                    .onNotAbleToStartMastershipMandatory(deviceInfo, ex.getMessage()));
+        }
     }
 
     @Override
-    public Future<Void> stopChain() {
-        return null;
+    public ListenableFuture<Void> closeServiceInstance() {
+        LOG.info("Closing clustering services for node {}", deviceInfo);
+        contextChainMastershipWatcher.onSlaveRoleAcquired(deviceInfo);
+
+        final ListenableFuture<List<Void>> servicesToBeClosed = Futures
+                .successfulAsList(Lists.reverse(contexts)
+                        .stream()
+                        .map(this::closeContextService)
+                        .collect(Collectors.toList()));
+
+        return Futures.transform(servicesToBeClosed, (input) -> {
+            LOG.info("Closed clustering services for node {}", deviceInfo);
+            return null;
+        }, executorService);
     }
 
+    @Nonnull
     @Override
-    public Future<Void> startChain() {
-        return null;
+    public ServiceGroupIdentifier getIdentifier() {
+        return deviceInfo.getServiceIdentifier();
     }
 
     @Override
     public void close() {
+        if (ContextState.TERMINATION.equals(state)) {
+            LOG.debug("ContextChain for node {} is already in TERMINATION state.", deviceInfo);
+            return;
+        }
+
+        state = ContextState.TERMINATION;
+        contextChainMastershipWatcher.onSlaveRoleAcquired(deviceInfo);
+
+        // Close all connections to devices
+        auxiliaryConnections.forEach(connectionContext -> connectionContext.closeConnection(false));
+        auxiliaryConnections.clear();
+        primaryConnection.closeConnection(true);
+
+        // Close all contexts (device, statistics, rpc)
+        contexts.forEach(OFPContext::close);
+        contexts.clear();
+
+        // If we are still registered and we are not already closing, then close the registration
+        if (Objects.nonNull(registration)) {
+            try {
+                LOG.info("Closing clustering services registration for node {}", deviceInfo);
+                registration.close();
+                registration = null;
+                LOG.info("Closed clustering services registration for node {}", deviceInfo);
+            } catch (final Exception e) {
+                LOG.warn("Failed to close clustering services registration for node {} with exception: ",
+                        deviceInfo, e);
+            }
+        }
+
+        // We are closing, so cleanup all managers now
+        deviceRemovedHandlers.forEach(h -> h.onDeviceRemoved(deviceInfo));
+        deviceRemovedHandlers.clear();
+    }
+
+    @Override
+    public void makeContextChainStateSlave() {
+        unMasterMe();
+        changeState(ContextChainState.WORKING_SLAVE);
+    }
+
+    @Override
+    public void registerServices(final ClusterSingletonServiceProvider clusterSingletonServiceProvider) {
+        LOG.info("Registering clustering services for node {}", deviceInfo);
+        state = ContextState.WORKING;
+        registration = Objects.requireNonNull(clusterSingletonServiceProvider
+                .registerClusterSingletonService(this));
+        LOG.info("Registered clustering services for node {}", deviceInfo);
+    }
+
+    @Override
+    public void makeDeviceSlave() {
+        unMasterMe();
+
+        contexts.stream()
+                .filter(DeviceContext.class::isInstance)
+                .map(DeviceContext.class::cast)
+                .findAny()
+                .ifPresent(deviceContext -> Futures
+                        .addCallback(
+                                deviceContext.makeDeviceSlave(),
+                                new DeviceSlaveCallback(),
+                                executorService));
+    }
+
+    @Override
+    public boolean isMastered(@Nonnull ContextChainMastershipState mastershipState) {
+        switch (mastershipState) {
+            case INITIAL_SUBMIT:
+                LOG.debug("Device {}, initial submit OK.", deviceInfo);
+                this.initialSubmitting.set(true);
+                break;
+            case MASTER_ON_DEVICE:
+                LOG.debug("Device {}, master state OK.", deviceInfo);
+                this.masterStateOnDevice.set(true);
+                break;
+            case INITIAL_GATHERING:
+                LOG.debug("Device {}, initial gathering OK.", deviceInfo);
+                this.initialGathering.set(true);
+                break;
+            case RPC_REGISTRATION:
+                LOG.debug("Device {}, RPC registration OK.", deviceInfo);
+                this.rpcRegistration.set(true);
+                break;
+            case INITIAL_FLOW_REGISTRY_FILL:
+                // Flow registry fill is not mandatory to work as a master
+                LOG.debug("Device {}, initial registry filling OK.", deviceInfo);
+                this.registryFilling.set(true);
+            case CHECK:
+            default:
+        }
+
+        final boolean result = initialGathering.get() &&
+                masterStateOnDevice.get() &&
+                initialSubmitting.get() &&
+                rpcRegistration.get();
+
+        if (result && mastershipState != ContextChainMastershipState.CHECK) {
+            LOG.info("Device {} is able to work as master{}",
+                    deviceInfo,
+                    registryFilling.get() ? "." : " WITHOUT flow registry !!!");
+            changeState(ContextChainState.WORKING_MASTER);
+        }
+
+        return result;
+    }
+
+    @Override
+    public boolean isClosing() {
+        return ContextState.TERMINATION.equals(state);
+    }
+
+    @Override
+    public boolean isPrepared() {
+        return this.initialGathering.get() &&
+                this.masterStateOnDevice.get() &&
+                this.rpcRegistration.get();
+    }
+
+    @Override
+    public boolean continueInitializationAfterReconciliation() {
+        return contexts.stream()
+                .filter(StatisticsContext.class::isInstance)
+                .map(StatisticsContext.class::cast)
+                .findAny()
+                .map(StatisticsContext::initialSubmitAfterReconciliation)
+                .orElse(false) &&
+        isMastered(ContextChainMastershipState.INITIAL_SUBMIT);
+    }
 
+    @Override
+    public boolean addAuxiliaryConnection(@Nonnull ConnectionContext connectionContext) {
+        return (connectionContext.getFeatures().getAuxiliaryId() != 0)
+                && (!ConnectionContext.CONNECTION_STATE.RIP.equals(primaryConnection.getConnectionState()))
+                && auxiliaryConnections.add(connectionContext);
     }
 
     @Override
-    public void changePrimaryConnection(final ConnectionContext connectionContext) {
-        this.primaryConnectionContext = connectionContext;
+    public boolean auxiliaryConnectionDropped(@Nonnull ConnectionContext connectionContext) {
+        return auxiliaryConnections.remove(connectionContext);
+    }
+
+    @Override
+    public void registerDeviceRemovedHandler(@Nonnull final DeviceRemovedHandler deviceRemovedHandler) {
+        deviceRemovedHandlers.add(deviceRemovedHandler);
+    }
+
+    private void changeState(final ContextChainState contextChainState) {
+        boolean propagate = this.contextChainState == ContextChainState.UNDEFINED;
+        this.contextChainState = contextChainState;
+
+        if (propagate) {
+            contexts.stream()
+                    .filter(ContextChainStateListener.class::isInstance)
+                    .map(ContextChainStateListener.class::cast)
+                    .forEach(listener -> listener.onStateAcquired(contextChainState));
+        }
+    }
+
+    private void initializeContextService(final OFPContext context) {
+        if (ConnectionContext.CONNECTION_STATE.WORKING.equals(primaryConnection.getConnectionState())) {
+            context.instantiateServiceInstance();
+        } else {
+            LOG.warn("Device connection for node {} doesn't exist anymore. Primary connection status: {}",
+                    deviceInfo,
+                    primaryConnection.getConnectionState());
+        }
+    }
+
+    private ListenableFuture<Void> closeContextService(final OFPContext context) {
+        if (ConnectionContext.CONNECTION_STATE.RIP.equals(primaryConnection.getConnectionState())) {
+            final String errMsg = String
+                    .format("Device connection for node %s doesn't exist anymore. Primary connection status: %s",
+                            deviceInfo.toString(),
+                            primaryConnection.getConnectionState());
+
+            return Futures.immediateFailedFuture(new ConnectionException(errMsg));
+        }
+
+        return context.closeServiceInstance();
+    }
+
+    private void unMasterMe() {
+        registryFilling.set(false);
+        initialSubmitting.set(false);
+        initialGathering.set(false);
+        masterStateOnDevice.set(false);
+        rpcRegistration.set(false);
+    }
+
+    private final class DeviceSlaveCallback implements FutureCallback<RpcResult<SetRoleOutput>> {
+        @Override
+        public void onSuccess(@Nullable final RpcResult<SetRoleOutput> result) {
+            contextChainMastershipWatcher.onSlaveRoleAcquired(deviceInfo);
+        }
+
+        @Override
+        public void onFailure(@Nonnull final Throwable t) {
+            contextChainMastershipWatcher.onSlaveRoleNotAcquired(deviceInfo);
+        }
     }
 }