Bug 5596 - restart devices management improvement
[openflowplugin.git] / openflowplugin-impl / src / main / java / org / opendaylight / openflowplugin / impl / role / RoleContextImpl.java
index 2d84f9a69cafd1ee3969b530247e0f2bb15bce99..888a4e9590f5853bde315c33c6bf9094465093cd 100644 (file)
@@ -7,27 +7,27 @@
  */
 package org.opendaylight.openflowplugin.impl.role;
 
-import javax.annotation.Nullable;
-import java.util.concurrent.Future;
-
-import com.google.common.annotations.VisibleForTesting;
+import com.google.common.base.Function;
 import com.google.common.base.Preconditions;
 import com.google.common.util.concurrent.FutureCallback;
 import com.google.common.util.concurrent.Futures;
 import com.google.common.util.concurrent.JdkFutureAdapters;
 import com.google.common.util.concurrent.ListenableFuture;
-import com.google.common.util.concurrent.SettableFuture;
-import org.opendaylight.controller.md.sal.common.api.clustering.CandidateAlreadyRegisteredException;
-import org.opendaylight.controller.md.sal.common.api.clustering.Entity;
-import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipCandidateRegistration;
-import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipService;
-import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
-import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
-import org.opendaylight.openflowplugin.api.openflow.device.DeviceState;
+import io.netty.util.HashedWheelTimer;
+import io.netty.util.TimerTask;
+import java.util.concurrent.ExecutionException;
+import java.util.concurrent.Future;
+import java.util.concurrent.TimeUnit;
+import javax.annotation.Nonnull;
+import javax.annotation.Nullable;
+import org.opendaylight.mdsal.singleton.common.api.ServiceGroupIdentifier;
+import org.opendaylight.openflowplugin.api.OFConstants;
+import org.opendaylight.openflowplugin.api.openflow.device.DeviceInfo;
 import org.opendaylight.openflowplugin.api.openflow.device.RequestContext;
 import org.opendaylight.openflowplugin.api.openflow.role.RoleContext;
+import org.opendaylight.openflowplugin.api.openflow.role.RoleManager;
 import org.opendaylight.openflowplugin.impl.rpc.AbstractRequestContext;
-import org.opendaylight.openflowplugin.impl.services.SalRoleServiceImpl;
+import org.opendaylight.openflowplugin.impl.util.DeviceStateUtil;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.role.service.rev150727.OfpRole;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.role.service.rev150727.SalRoleService;
@@ -39,140 +39,150 @@ import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 /**
- * Created by kramesha on 9/12/15.
+ * Role context hold information about entity ownership registration,
+ * register and unregister candidate (main and tx)
  */
-public class RoleContextImpl implements RoleContext {
-    private static final Logger LOG = LoggerFactory.getLogger(RoleContextImpl.class);
-
-    private final EntityOwnershipService entityOwnershipService;
-    private EntityOwnershipCandidateRegistration entityOwnershipCandidateRegistration;
-    private final DeviceContext deviceContext;
-    private final Entity entity;
-    private SalRoleService salRoleService;
+class RoleContextImpl implements RoleContext {
 
-    private final SettableFuture<OfpRole> initRoleChangeFuture;
+    private static final Logger LOG = LoggerFactory.getLogger(RoleContextImpl.class);
+    // Maximum limit of timeout retries when cleaning DS, to prevent infinite recursive loops
+    private static final int MAX_CLEAN_DS_RETRIES = 3;
+
+    private SalRoleService salRoleService = null;
+    private final HashedWheelTimer hashedWheelTimer;
+    private final DeviceInfo deviceInfo;
+    private CONTEXT_STATE state;
+    private final RoleManager myManager;
+
+    RoleContextImpl(final DeviceInfo deviceInfo,
+                    final HashedWheelTimer hashedWheelTimer,
+                    final RoleManager myManager) {
+        this.deviceInfo = deviceInfo;
+        state = CONTEXT_STATE.WORKING;
+        this.myManager = myManager;
+        this.hashedWheelTimer = hashedWheelTimer;
+    }
 
-    public RoleContextImpl(final DeviceContext deviceContext, final EntityOwnershipService entityOwnershipService, final Entity entity) {
-        this.entityOwnershipService = Preconditions.checkNotNull(entityOwnershipService);
-        this.deviceContext = Preconditions.checkNotNull(deviceContext);
-        this.entity = Preconditions.checkNotNull(entity);
+    @Nullable
+    @Override
+    public <T> RequestContext<T> createRequestContext() {
+        return new AbstractRequestContext<T>(deviceInfo.reserveXidForDeviceMessage()) {
+            @Override
+            public void close() {
+            }
+        };
+    }
 
-        salRoleService = new SalRoleServiceImpl(this, deviceContext);
-        initRoleChangeFuture = SettableFuture.create();
+    @Override
+    public void setSalRoleService(@Nonnull final SalRoleService salRoleService) {
+        Preconditions.checkNotNull(salRoleService);
+        this.salRoleService = salRoleService;
     }
 
     @Override
-    public ListenableFuture<OfpRole> initialization() {
-        LOG.debug("Initialization requestOpenflowEntityOwnership for entity {}", entity);
-        try {
-            entityOwnershipCandidateRegistration = entityOwnershipService.registerCandidate(entity);
-            LOG.debug("RoleContextImpl : Candidate registered with ownership service for device :{}", deviceContext
-                    .getPrimaryConnectionContext().getNodeId().getValue());
-        } catch (final CandidateAlreadyRegisteredException e) {
-            completeInitRoleChangeFuture(null, e);
-        }
-        return initRoleChangeFuture;
+    public SalRoleService getSalRoleService() {
+        return this.salRoleService;
     }
 
     @Override
-    public void onRoleChanged(final OfpRole oldRole, final OfpRole newRole) {
-        LOG.trace("onRoleChanged method call for Entity {}", entity);
-
-        if (!isDeviceConnected()) {
-            // this can happen as after the disconnect, we still get a last messsage from EntityOwnershipService.
-            LOG.info("Device {} is disconnected from this node. Hence not attempting a role change.",
-                    deviceContext.getPrimaryConnectionContext().getNodeId());
-            completeInitRoleChangeFuture(null, null);
-            return;
-        }
+    public CONTEXT_STATE getState() {
+        return this.state;
+    }
 
-        LOG.debug("Role change received from ownership listener from {} to {} for device:{}", oldRole, newRole,
-                deviceContext.getPrimaryConnectionContext().getNodeId());
+    @Override
+    public void setState(CONTEXT_STATE state) {
+        this.state = state;
+    }
 
-        final SetRoleInput setRoleInput = (new SetRoleInputBuilder())
-                .setControllerRole(newRole)
-                .setNode(new NodeRef(deviceContext.getDeviceState().getNodeInstanceIdentifier()))
-                .build();
+    @Override
+    public ServiceGroupIdentifier getServiceIdentifier() {
+        return this.deviceInfo.getServiceIdentifier();
+    }
 
-        final Future<RpcResult<SetRoleOutput>> setRoleOutputFuture = salRoleService.setRole(setRoleInput);
+    @Override
+    public DeviceInfo getDeviceInfo() {
+        return this.deviceInfo;
+    }
 
-        Futures.addCallback(JdkFutureAdapters.listenInPoolThread(setRoleOutputFuture), new FutureCallback<RpcResult<SetRoleOutput>>() {
+    public void startupClusterServices() throws ExecutionException, InterruptedException {
+        Futures.addCallback(sendRoleChangeToDevice(OfpRole.BECOMEMASTER), new FutureCallback<RpcResult<SetRoleOutput>>() {
             @Override
-            public void onSuccess(final RpcResult<SetRoleOutput> setRoleOutputRpcResult) {
-                LOG.debug("Rolechange {} successful made on switch :{}", newRole,
-                        deviceContext.getPrimaryConnectionContext().getNodeId());
-                deviceContext.getDeviceState().setRole(newRole);
-                deviceContext.onClusterRoleChange(newRole);
-                completeInitRoleChangeFuture(newRole, null);
+            public void onSuccess(@Nullable RpcResult<SetRoleOutput> setRoleOutputRpcResult) {
+                if (LOG.isDebugEnabled()) {
+                    LOG.debug("Role MASTER was successfully set on device, node {}", deviceInfo.getLOGValue());
+                }
             }
 
             @Override
             public void onFailure(final Throwable throwable) {
-                LOG.error("Error in setRole {} for device {} ", newRole,
-                        deviceContext.getPrimaryConnectionContext().getNodeId(), throwable);
-                completeInitRoleChangeFuture(null, throwable);
+                LOG.warn("Was not able to set MASTER role on device, node {}", deviceInfo.getLOGValue());
             }
         });
     }
 
-    void completeInitRoleChangeFuture(@Nullable final OfpRole role, @Nullable final Throwable throwable) {
-        if (initRoleChangeFuture.isDone()) {
-            return;
-        }
-        if (!isDeviceConnected()) {
-            LOG.debug("Device {} is disconnected from this node. Hence not attempting a role change.", deviceContext
-                    .getPrimaryConnectionContext().getNodeId());
-            initRoleChangeFuture.cancel(true);
-            return;
-        }
-        if (throwable != null) {
-            LOG.warn("Connection Role change fail for entity {}", entity);
-            initRoleChangeFuture.setException(throwable);
-        } else if (role != null) {
-            LOG.debug("Initialization Role for entity {} is chosed {}", entity, role);
-            initRoleChangeFuture.set(role);
-        } else {
-            LOG.debug("Unexpected initialization Role Change close for entity {}", entity);
-            initRoleChangeFuture.cancel(true);
-        }
-    }
-
     @Override
-    public void close() {
-        if (entityOwnershipCandidateRegistration != null) {
-            LOG.debug("Closing EntityOwnershipCandidateRegistration for {}", entity);
-            entityOwnershipCandidateRegistration.close();
+    public ListenableFuture<Void> stopClusterServices(final boolean deviceDisconnected) {
+
+        if (!deviceDisconnected) {
+            ListenableFuture<Void> future = Futures.transform(makeDeviceSlave(), new Function<RpcResult<SetRoleOutput>, Void>() {
+                @Nullable
+                @Override
+                public Void apply(@Nullable RpcResult<SetRoleOutput> setRoleOutputRpcResult) {
+                    return null;
+                }
+            });
+
+            Futures.addCallback(future, new FutureCallback<Void>() {
+                @Override
+                public void onSuccess(@Nullable Void aVoid) {
+                    if (LOG.isDebugEnabled()) {
+                        LOG.debug("Role SLAVE was successfully propagated on device, node {}", deviceInfo.getLOGValue());
+                    }
+                }
+
+                @Override
+                public void onFailure(final Throwable throwable) {
+                    LOG.warn("Was not able to set role SLAVE to device on node {} ", deviceInfo.getLOGValue());
+                    LOG.trace("Error occurred on device role setting, probably connection loss: ", throwable);
+                    myManager.removeDeviceFromOperationalDS(deviceInfo, MAX_CLEAN_DS_RETRIES);
+
+                }
+            });
+            return future;
+        } else {
+            return myManager.removeDeviceFromOperationalDS(deviceInfo, MAX_CLEAN_DS_RETRIES);
         }
     }
 
     @Override
-    public Entity getEntity() {
-        return entity;
-    }
-
-    private boolean isDeviceConnected() {
-        return ConnectionContext.CONNECTION_STATE.WORKING.equals(
-                deviceContext.getPrimaryConnectionContext().getConnectionState());
-    }
-
-    @Nullable
-    @Override
-    public <T> RequestContext<T> createRequestContext() {
-        final AbstractRequestContext<T> ret = new AbstractRequestContext<T>(deviceContext.getReservedXid()) {
-            @Override
-            public void close() {
-            }
-        };
-        return ret;
+    public ListenableFuture<RpcResult<SetRoleOutput>> makeDeviceSlave(){
+        return sendRoleChangeToDevice(OfpRole.BECOMESLAVE);
     }
 
-    @VisibleForTesting
-    void setSalRoleService(final SalRoleService salRoleService) {
-        this.salRoleService = salRoleService;
+    private ListenableFuture<RpcResult<SetRoleOutput>> sendRoleChangeToDevice(final OfpRole newRole) {
+        LOG.debug("Sending new role {} to device {}", newRole, deviceInfo.getNodeId());
+        final Future<RpcResult<SetRoleOutput>> setRoleOutputFuture;
+        final Short version = deviceInfo.getVersion();
+        if (null == version) {
+            LOG.debug("Device version is null");
+            return Futures.immediateFuture(null);
+        }
+        if (version < OFConstants.OFP_VERSION_1_3) {
+            LOG.debug("Device version not support ROLE");
+            return Futures.immediateFuture(null);
+        } else {
+            final SetRoleInput setRoleInput = (new SetRoleInputBuilder()).setControllerRole(newRole)
+                    .setNode(new NodeRef(DeviceStateUtil.createNodeInstanceIdentifier(deviceInfo.getNodeId()))).build();
+            setRoleOutputFuture = getSalRoleService().setRole(setRoleInput);
+            final TimerTask timerTask = timeout -> {
+                if (!setRoleOutputFuture.isDone()) {
+                    LOG.warn("New role {} was not propagated to device {} during 10 sec", newRole, deviceInfo.getLOGValue());
+                    setRoleOutputFuture.cancel(true);
+                }
+            };
+            hashedWheelTimer.newTimeout(timerTask, 10, TimeUnit.SECONDS);
+        }
+        return JdkFutureAdapters.listenInPoolThread(setRoleOutputFuture);
     }
 
-    @Override
-    public DeviceState getDeviceState() {
-        return deviceContext.getDeviceState();
-    }
 }