*/
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.base.Verify;
-import com.google.common.util.concurrent.AsyncFunction;
+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 io.netty.util.Timeout;
+import io.netty.util.HashedWheelTimer;
import io.netty.util.TimerTask;
+import java.util.concurrent.ExecutionException;
import java.util.concurrent.Future;
-import java.util.concurrent.Semaphore;
import java.util.concurrent.TimeUnit;
+import javax.annotation.Nonnull;
import javax.annotation.Nullable;
-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.mdsal.singleton.common.api.ServiceGroupIdentifier;
import org.opendaylight.openflowplugin.api.OFConstants;
-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 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;
import org.opendaylight.yang.gen.v1.urn.opendaylight.role.service.rev150727.SetRoleInputBuilder;
import org.opendaylight.yang.gen.v1.urn.opendaylight.role.service.rev150727.SetRoleOutput;
import org.opendaylight.yangtools.yang.common.RpcResult;
-import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
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;
-
- private EntityOwnershipCandidateRegistration txEntityOwnershipCandidateRegistration;
- private final Entity txEntity;
-
- private final Semaphore mainCandidateGuard = new Semaphore(1, true);
- private final Semaphore txCandidateGuard = new Semaphore(1, true);
- private volatile ROLE_CONTEXT_STATE state;
- private volatile boolean txLockOwned;
- private volatile OfpRole propagatingRole;
-
- public RoleContextImpl(final DeviceContext deviceContext, final EntityOwnershipService entityOwnershipService,
- final Entity entity, final Entity txEnitity) {
- this.entityOwnershipService = Preconditions.checkNotNull(entityOwnershipService);
- this.deviceContext = Preconditions.checkNotNull(deviceContext);
- this.entity = Preconditions.checkNotNull(entity);
- this.txEntity = Preconditions.checkNotNull(txEnitity);
-
- salRoleService = new SalRoleServiceImpl(this, deviceContext);
- }
-
- @Override
- public void initialization() throws CandidateAlreadyRegisteredException {
- state = ROLE_CONTEXT_STATE.STARTING;
- LOG.debug("Initialization requestOpenflowEntityOwnership for entity {}", entity);
- entityOwnershipCandidateRegistration = entityOwnershipService.registerCandidate(entity);
- LOG.debug("RoleContextImpl : Candidate registered with ownership service for device :{}", deviceContext
- .getPrimaryConnectionContext().getNodeId().getValue());
- }
-
- @Override
- public ListenableFuture<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());
- LOG.debug("SetRole cancelled for entity [{}], reason = device disconnected.", entity);
- return Futures.immediateFailedFuture(new Exception(
- "Device disconnected - stopped by setRole: " + deviceContext
- .getPrimaryConnectionContext().getNodeId()));
- }
+class RoleContextImpl implements RoleContext {
- LOG.debug("Role change received from ownership listener from {} to {} for device:{}", oldRole, newRole,
- deviceContext.getPrimaryConnectionContext().getNodeId());
-
- final SetRoleInput setRoleInput = (new SetRoleInputBuilder())
- .setControllerRole(newRole)
- .setNode(new NodeRef(deviceContext.getDeviceState().getNodeInstanceIdentifier()))
- .build();
-
- final Future<RpcResult<SetRoleOutput>> setRoleOutputFuture = salRoleService.setRole(setRoleInput);
-
- return Futures.transform(JdkFutureAdapters.listenInPoolThread(setRoleOutputFuture),
- new AsyncFunction<RpcResult<SetRoleOutput>, Void>() {
- @Override
- public ListenableFuture<Void> apply(final RpcResult<SetRoleOutput> setRoleOutputRpcResult) throws Exception {
- LOG.debug("Rolechange {} successful made on switch :{}", newRole, deviceContext.getDeviceState().getNodeId());
- final ListenableFuture<Void> nextStepFuture;
- switch (state) {
- case STARTING:
- if (OfpRole.BECOMESLAVE.equals(newRole)) {
- getDeviceState().setRole(newRole);
- nextStepFuture = Futures.immediateFuture(null);
- } else if (OfpRole.BECOMEMASTER.equals(newRole)) {
- nextStepFuture = deviceContext.onClusterRoleChange(newRole);
- } else {
- nextStepFuture = Futures.immediateFuture(null);
- }
-
- break;
- case WORKING:
- nextStepFuture = deviceContext.onClusterRoleChange(newRole);
- break;
- //case TEARING_DOWN:
- default:
- nextStepFuture = Futures.immediateFuture(null);
- break;
- }
-
- return nextStepFuture;
- }
- });
- }
-
- @Override
- public void setupTxCandidate() throws CandidateAlreadyRegisteredException {
- LOG.debug("setupTxCandidate for entity {} and Transaction entity {}", entity, txEntity);
- Verify.verify(txEntity != null);
-
- txEntityOwnershipCandidateRegistration = entityOwnershipService.registerCandidate(txEntity);
- }
-
- @Override
- public void close() {
- if (entityOwnershipCandidateRegistration != null) {
- LOG.debug("Closing EntityOwnershipCandidateRegistration for {}", entity);
- entityOwnershipCandidateRegistration.close();
- }
- promoteStateToTearingDown();
- }
-
- @Override
- public Entity getEntity() {
- return entity;
- }
+ 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;
- @Override
- public Entity getTxEntity() {
- return txEntity;
- }
+ private SalRoleService salRoleService = null;
+ private final HashedWheelTimer hashedWheelTimer;
+ private final DeviceInfo deviceInfo;
+ private CONTEXT_STATE state;
+ private final RoleManager myManager;
- private boolean isDeviceConnected() {
- return ConnectionContext.CONNECTION_STATE.WORKING.equals(
- deviceContext.getPrimaryConnectionContext().getConnectionState());
+ RoleContextImpl(final DeviceInfo deviceInfo,
+ final HashedWheelTimer hashedWheelTimer,
+ final RoleManager myManager) {
+ this.deviceInfo = deviceInfo;
+ state = CONTEXT_STATE.WORKING;
+ this.myManager = myManager;
+ this.hashedWheelTimer = hashedWheelTimer;
}
@Nullable
@Override
public <T> RequestContext<T> createRequestContext() {
- final AbstractRequestContext<T> ret = new AbstractRequestContext<T>(deviceContext.getReservedXid()) {
+ return new AbstractRequestContext<T>(deviceInfo.reserveXidForDeviceMessage()) {
@Override
public void close() {
}
};
- return ret;
}
- @VisibleForTesting
- void setSalRoleService(final SalRoleService salRoleService) {
+ @Override
+ public void setSalRoleService(@Nonnull final SalRoleService salRoleService) {
+ Preconditions.checkNotNull(salRoleService);
this.salRoleService = salRoleService;
}
@Override
- public DeviceState getDeviceState() {
- return deviceContext.getDeviceState();
+ public SalRoleService getSalRoleService() {
+ return this.salRoleService;
}
@Override
- public void suspendTxCandidate() {
- if (txEntityOwnershipCandidateRegistration != null) {
- txEntityOwnershipCandidateRegistration.close();
- txEntityOwnershipCandidateRegistration = null;
- }
+ public CONTEXT_STATE getState() {
+ return this.state;
}
@Override
- public DeviceContext getDeviceContext() {
- return deviceContext;
+ public void setState(CONTEXT_STATE state) {
+ this.state = state;
}
@Override
- public Semaphore getMainCandidateGuard() {
- return mainCandidateGuard;
+ public ServiceGroupIdentifier getServiceIdentifier() {
+ return this.deviceInfo.getServiceIdentifier();
}
@Override
- public Semaphore getTxCandidateGuard() {
- return txCandidateGuard;
+ public DeviceInfo getDeviceInfo() {
+ return this.deviceInfo;
}
- @Override
- public ROLE_CONTEXT_STATE getState() {
- return state;
- }
+ public void startupClusterServices() throws ExecutionException, InterruptedException {
+ Futures.addCallback(sendRoleChangeToDevice(OfpRole.BECOMEMASTER), new FutureCallback<RpcResult<SetRoleOutput>>() {
+ @Override
+ public void onSuccess(@Nullable RpcResult<SetRoleOutput> setRoleOutputRpcResult) {
+ if (LOG.isDebugEnabled()) {
+ LOG.debug("Role MASTER was successfully set on device, node {}", deviceInfo.getLOGValue());
+ }
+ }
- @Override
- public boolean isTxLockOwned() {
- return txLockOwned;
+ @Override
+ public void onFailure(final Throwable throwable) {
+ LOG.warn("Was not able to set MASTER role on device, node {}", deviceInfo.getLOGValue());
+ }
+ });
}
@Override
- public void setTxLockOwned(final boolean txLockOwned) {
- this.txLockOwned = txLockOwned;
- }
+ public ListenableFuture<Void> stopClusterServices(final boolean deviceDisconnected) {
- private void promoteStateToTearingDown() {
- state = ROLE_CONTEXT_STATE.TEARING_DOWN;
- }
+ if (!deviceDisconnected) {
+ ListenableFuture<Void> future = Futures.transform(makeDeviceSlave(), new Function<RpcResult<SetRoleOutput>, Void>() {
+ @Nullable
+ @Override
+ public Void apply(@Nullable RpcResult<SetRoleOutput> setRoleOutputRpcResult) {
+ return null;
+ }
+ });
- @Override
- public void promoteStateToWorking() {
- state = ROLE_CONTEXT_STATE.WORKING;
- }
+ 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 OfpRole getPropagatingRole() {
- return propagatingRole;
+ @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 void setPropagatingRole(final OfpRole propagatingRole) {
- this.propagatingRole = propagatingRole;
+ public ListenableFuture<RpcResult<SetRoleOutput>> makeDeviceSlave(){
+ return sendRoleChangeToDevice(OfpRole.BECOMESLAVE);
}
- private ListenableFuture<Void> sendRoleChangeToDevice(final OfpRole newRole, final AsyncFunction<RpcResult<SetRoleOutput>, Void> function) {
- LOG.debug("Send new Role {} to Device {}", newRole, deviceContext.getDeviceState().getNodeId());
+ private ListenableFuture<RpcResult<SetRoleOutput>> sendRoleChangeToDevice(final OfpRole newRole) {
+ LOG.debug("Sending new role {} to device {}", newRole, deviceInfo.getNodeId());
final Future<RpcResult<SetRoleOutput>> setRoleOutputFuture;
- if (deviceContext.getDeviceState().getFeatures().getVersion() < OFConstants.OFP_VERSION_1_3) {
- LOG.debug("Device OF version {} not support ROLE", deviceContext.getDeviceState().getFeatures().getVersion());
- setRoleOutputFuture = Futures.immediateFuture(RpcResultBuilder.<SetRoleOutput> success().build());
+ 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(deviceContext.getDeviceState().getNodeInstanceIdentifier())).build();
- setRoleOutputFuture = salRoleService.setRole(setRoleInput);
- final TimerTask timerTask = new TimerTask() {
-
- @Override
- public void run(final Timeout timeout) throws Exception {
- if (!setRoleOutputFuture.isDone()) {
- LOG.info("New Role {} was not propagated to device {} during 10 sec. Close connection immediately.",
- newRole, deviceContext.getDeviceState().getNodeId());
- deviceContext.close();
- }
+ .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);
}
};
- deviceContext.getTimer().newTimeout(timerTask, 10, TimeUnit.SECONDS);
+ hashedWheelTimer.newTimeout(timerTask, 10, TimeUnit.SECONDS);
}
- return Futures.transform(JdkFutureAdapters.listenInPoolThread(setRoleOutputFuture), function);
+ return JdkFutureAdapters.listenInPoolThread(setRoleOutputFuture);
}
+
}
Code Review / openflowplugin.git / blobdiff