2 * Copyright (c) 2016 Pantheon Technologies s.r.o. and others. All rights reserved.
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
8 package org.opendaylight.openflowplugin.impl.lifecycle;
10 import com.google.common.collect.Lists;
11 import com.google.common.util.concurrent.Futures;
12 import com.google.common.util.concurrent.ListenableFuture;
13 import java.util.List;
14 import java.util.Objects;
15 import java.util.concurrent.CopyOnWriteArrayList;
16 import java.util.concurrent.ExecutorService;
17 import java.util.concurrent.atomic.AtomicBoolean;
18 import java.util.concurrent.atomic.AtomicReference;
19 import java.util.stream.Collectors;
20 import javax.annotation.Nonnull;
21 import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonServiceProvider;
22 import org.opendaylight.mdsal.singleton.common.api.ServiceGroupIdentifier;
23 import org.opendaylight.openflowplugin.api.openflow.OFPContext;
24 import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
25 import org.opendaylight.openflowplugin.api.openflow.device.DeviceInfo;
26 import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceRemovedHandler;
27 import org.opendaylight.openflowplugin.api.openflow.lifecycle.ContextChain;
28 import org.opendaylight.openflowplugin.api.openflow.lifecycle.ContextChainMastershipState;
29 import org.opendaylight.openflowplugin.api.openflow.lifecycle.ContextChainMastershipWatcher;
30 import org.opendaylight.openflowplugin.api.openflow.lifecycle.ContextChainState;
31 import org.opendaylight.openflowplugin.api.openflow.lifecycle.ContextChainStateListener;
32 import org.opendaylight.openflowplugin.api.openflow.lifecycle.GuardedContext;
33 import org.opendaylight.openflowplugin.api.openflow.statistics.StatisticsContext;
34 import org.slf4j.Logger;
35 import org.slf4j.LoggerFactory;
37 public class ContextChainImpl implements ContextChain {
38 private static final Logger LOG = LoggerFactory.getLogger(ContextChainImpl.class);
40 private final AtomicBoolean masterStateOnDevice = new AtomicBoolean(false);
41 private final AtomicBoolean initialGathering = new AtomicBoolean(false);
42 private final AtomicBoolean initialSubmitting = new AtomicBoolean(false);
43 private final AtomicBoolean registryFilling = new AtomicBoolean(false);
44 private final AtomicBoolean rpcRegistration = new AtomicBoolean(false);
45 private final List<DeviceRemovedHandler> deviceRemovedHandlers = new CopyOnWriteArrayList<>();
46 private final List<GuardedContext> contexts = new CopyOnWriteArrayList<>();
47 private final List<ConnectionContext> auxiliaryConnections = new CopyOnWriteArrayList<>();
48 private final ExecutorService executorService;
49 private final ContextChainMastershipWatcher contextChainMastershipWatcher;
50 private final DeviceInfo deviceInfo;
51 private final ConnectionContext primaryConnection;
52 private final AtomicReference<ContextChainState> contextChainState =
53 new AtomicReference<>(ContextChainState.UNDEFINED);
54 private AutoCloseable registration;
56 ContextChainImpl(@Nonnull final ContextChainMastershipWatcher contextChainMastershipWatcher,
57 @Nonnull final ConnectionContext connectionContext,
58 @Nonnull final ExecutorService executorService) {
59 this.contextChainMastershipWatcher = contextChainMastershipWatcher;
60 this.primaryConnection = connectionContext;
61 this.deviceInfo = connectionContext.getDeviceInfo();
62 this.executorService = executorService;
66 public <T extends OFPContext> void addContext(@Nonnull final T context) {
67 contexts.add(new GuardedContextImpl(context));
71 @SuppressWarnings("checkstyle:IllegalCatch")
72 public void instantiateServiceInstance() {
75 contexts.forEach(OFPContext::instantiateServiceInstance);
76 LOG.info("Started clustering services for node {}", deviceInfo);
77 } catch (final Exception ex) {
78 LOG.warn("Not able to start clustering services for node {}", deviceInfo);
79 executorService.submit(() -> contextChainMastershipWatcher
80 .onNotAbleToStartMastershipMandatory(deviceInfo, ex.toString()));
85 public ListenableFuture<Void> closeServiceInstance() {
87 contextChainMastershipWatcher.onSlaveRoleAcquired(deviceInfo);
89 final ListenableFuture<List<Void>> servicesToBeClosed = Futures
90 .allAsList(Lists.reverse(contexts)
92 .map(OFPContext::closeServiceInstance)
93 .collect(Collectors.toList()));
95 return Futures.transform(servicesToBeClosed, (input) -> {
96 LOG.info("Closed clustering services for node {}", deviceInfo);
103 public ServiceGroupIdentifier getIdentifier() {
104 return deviceInfo.getServiceIdentifier();
108 @SuppressWarnings("checkstyle:IllegalCatch")
109 public void close() {
110 if (ContextChainState.CLOSED.equals(contextChainState.get())) {
111 LOG.debug("ContextChain for node {} is already in TERMINATION state.", deviceInfo);
115 contextChainState.set(ContextChainState.CLOSED);
118 // Close all connections to devices
119 auxiliaryConnections.forEach(connectionContext -> connectionContext.closeConnection(false));
120 auxiliaryConnections.clear();
122 // If we are still registered and we are not already closing, then close the registration
123 if (Objects.nonNull(registration)) {
125 registration.close();
127 LOG.info("Closed clustering services registration for node {}", deviceInfo);
128 } catch (final Exception e) {
129 LOG.warn("Failed to close clustering services registration for node {} with exception: ",
135 // Close all contexts (device, statistics, rpc)
136 contexts.forEach(OFPContext::close);
139 // We are closing, so cleanup all managers now
140 deviceRemovedHandlers.forEach(h -> h.onDeviceRemoved(deviceInfo));
141 deviceRemovedHandlers.clear();
143 primaryConnection.closeConnection(false);
148 public void makeContextChainStateSlave() {
150 changeMastershipState(ContextChainState.WORKING_SLAVE);
154 public void registerServices(final ClusterSingletonServiceProvider clusterSingletonServiceProvider) {
155 registration = Objects.requireNonNull(clusterSingletonServiceProvider
156 .registerClusterSingletonService(this));
157 LOG.debug("Registered clustering services for node {}", deviceInfo);
161 public boolean isMastered(@Nonnull ContextChainMastershipState mastershipState) {
162 switch (mastershipState) {
164 LOG.debug("Device {}, initial submit OK.", deviceInfo);
165 this.initialSubmitting.set(true);
167 case MASTER_ON_DEVICE:
168 LOG.debug("Device {}, master state OK.", deviceInfo);
169 this.masterStateOnDevice.set(true);
171 case INITIAL_GATHERING:
172 LOG.debug("Device {}, initial gathering OK.", deviceInfo);
173 this.initialGathering.set(true);
175 case RPC_REGISTRATION:
176 LOG.debug("Device {}, RPC registration OK.", deviceInfo);
177 this.rpcRegistration.set(true);
179 case INITIAL_FLOW_REGISTRY_FILL:
180 // Flow registry fill is not mandatory to work as a master
181 LOG.debug("Device {}, initial registry filling OK.", deviceInfo);
182 this.registryFilling.set(true);
192 final boolean result = initialGathering.get()
193 && masterStateOnDevice.get()
194 && initialSubmitting.get()
195 && rpcRegistration.get();
197 if (result && mastershipState != ContextChainMastershipState.CHECK) {
198 LOG.info("Device {} is able to work as master{}",
200 registryFilling.get() ? "." : " WITHOUT flow registry !!!");
201 changeMastershipState(ContextChainState.WORKING_MASTER);
208 public boolean isClosing() {
209 return ContextChainState.CLOSED.equals(contextChainState.get());
213 public boolean isPrepared() {
214 return this.initialGathering.get()
215 && this.masterStateOnDevice.get()
216 && this.rpcRegistration.get();
220 public boolean continueInitializationAfterReconciliation() {
221 final AtomicBoolean initialSubmit = new AtomicBoolean(false);
223 contexts.forEach(context -> {
224 if (context.map(StatisticsContext.class::isInstance)) {
225 initialSubmit.set(context.map(StatisticsContext.class::cast).initialSubmitAfterReconciliation());
229 return initialSubmit.get() && isMastered(ContextChainMastershipState.INITIAL_SUBMIT);
233 public boolean addAuxiliaryConnection(@Nonnull ConnectionContext connectionContext) {
234 return (connectionContext.getFeatures().getAuxiliaryId() != 0)
235 && (!ConnectionContext.CONNECTION_STATE.RIP.equals(primaryConnection.getConnectionState()))
236 && auxiliaryConnections.add(connectionContext);
240 public boolean auxiliaryConnectionDropped(@Nonnull ConnectionContext connectionContext) {
241 return auxiliaryConnections.remove(connectionContext);
245 public void registerDeviceRemovedHandler(@Nonnull final DeviceRemovedHandler deviceRemovedHandler) {
246 deviceRemovedHandlers.add(deviceRemovedHandler);
249 private void changeMastershipState(final ContextChainState contextChainState) {
250 if (ContextChainState.CLOSED.equals(this.contextChainState.get())) {
254 boolean propagate = ContextChainState.UNDEFINED.equals(this.contextChainState.get());
255 this.contextChainState.set(contextChainState);
258 contexts.forEach(context -> {
259 if (context.map(ContextChainStateListener.class::isInstance)) {
260 context.map(ContextChainStateListener.class::cast).onStateAcquired(contextChainState);
266 private void unMasterMe() {
267 registryFilling.set(false);
268 initialSubmitting.set(false);
269 initialGathering.set(false);
270 masterStateOnDevice.set(false);
271 rpcRegistration.set(false);