*/
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.Preconditions;
-import com.google.common.base.Verify;
-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 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.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.lifecycle.LifecycleConductor;
import org.opendaylight.openflowplugin.api.openflow.role.RoleContext;
import org.opendaylight.openflowplugin.impl.rpc.AbstractRequestContext;
-import org.opendaylight.openflowplugin.impl.services.SalRoleServiceImpl;
-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.SetRoleInput;
-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.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 {
+class RoleContextImpl implements RoleContext {
+
private static final Logger LOG = LoggerFactory.getLogger(RoleContextImpl.class);
+ private static final int TIMEOUT = 12;
+ private final DeviceInfo deviceInfo;
private final EntityOwnershipService entityOwnershipService;
- private EntityOwnershipCandidateRegistration entityOwnershipCandidateRegistration;
- private final DeviceContext deviceContext;
+ private volatile EntityOwnershipCandidateRegistration entityOwnershipCandidateRegistration = null;
+ private volatile EntityOwnershipCandidateRegistration txEntityOwnershipCandidateRegistration = null;
+
private final Entity entity;
- private SalRoleService salRoleService;
+ private final Entity txEntity;
- private final SettableFuture<OfpRole> initRoleChangeFuture;
+ private SalRoleService salRoleService = null;
- private EntityOwnershipCandidateRegistration txEntityOwnershipCandidateRegistration;
- private SettableFuture<Void> txRoleChangeFuture;
- private final Entity txEntity;
+ private final Semaphore roleChangeGuard = new Semaphore(1, true);
- 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);
+ private final LifecycleConductor conductor;
- salRoleService = new SalRoleServiceImpl(this, deviceContext);
- initRoleChangeFuture = SettableFuture.create();
+ RoleContextImpl(final DeviceInfo deviceInfo, final EntityOwnershipService entityOwnershipService, final Entity entity, final Entity txEntity, final LifecycleConductor lifecycleConductor) {
+ this.entityOwnershipService = entityOwnershipService;
+ this.entity = entity;
+ this.txEntity = txEntity;
+ this.deviceInfo = deviceInfo;
+ this.conductor = lifecycleConductor;
}
@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 boolean initialization() {
+ LOG.info("Initialization main candidate for node {}", deviceInfo.getNodeId());
+ return registerCandidate(this.entity);
}
@Override
- public void onRoleChanged(final OfpRole oldRole, final OfpRole newRole, final FutureCallback<Void> callback) {
- 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 void unregisterAllCandidates() {
+ LOG.info("Role context closed, unregistering all candidates for ownership for node {}", deviceInfo.getNodeId());
+ if (isMainCandidateRegistered()) {
+ unregisterCandidate(this.entity);
}
+ if (isTxCandidateRegistered()) {
+ unregisterCandidate(this.txEntity);
+ }
+ }
- 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);
-
- Futures.addCallback(JdkFutureAdapters.listenInPoolThread(setRoleOutputFuture), new FutureCallback<RpcResult<SetRoleOutput>>() {
- @Override
- public void onSuccess(final RpcResult<SetRoleOutput> setRoleOutputRpcResult) {
- LOG.debug("Rolechange {} successful made on switch :{}", newRole, deviceContext.getDeviceState().getNodeId());
- deviceContext.getDeviceState().setRole(newRole);
- final ListenableFuture<Void> future = deviceContext.onClusterRoleChange(newRole);
- if (callback != null) {
- Futures.addCallback(future, callback);
- }
- completeInitRoleChangeFuture(newRole, null);
- }
-
+ @Nullable
+ @Override
+ public <T> RequestContext<T> createRequestContext() {
+ return new AbstractRequestContext<T>(conductor.reserveXidForDeviceMessage(deviceInfo)) {
@Override
- public void onFailure(final Throwable throwable) {
- LOG.error("Error in setRole {} for device {} ", newRole,
- deviceContext.getPrimaryConnectionContext().getNodeId(), throwable);
- completeInitRoleChangeFuture(null, throwable);
+ public void close() {
}
- });
+ };
}
- 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 setSalRoleService(@Nonnull final SalRoleService salRoleService) {
+ Preconditions.checkNotNull(salRoleService);
+ this.salRoleService = salRoleService;
}
@Override
- public ListenableFuture<Void> setupTxCandidate() {
- LOG.debug("setupTxCandidate for entity {} and Transaction entity {}", entity, txEntity);
- Verify.verify(txEntity != null);
-
- try {
- txEntityOwnershipCandidateRegistration = entityOwnershipService.registerCandidate(txEntity);
- txRoleChangeFuture = SettableFuture.<Void> create();
- } catch (final CandidateAlreadyRegisteredException e) {
- return Futures.<Void> immediateFailedFuture(e);
- }
-
- return txRoleChangeFuture;
+ public SalRoleService getSalRoleService() {
+ return this.salRoleService;
}
@Override
- public void onTxRoleChange(final OfpRole oldRole, final OfpRole newRole) {
- LOG.trace("onTxRoleChange method call for Entity {}", entity);
-
- Verify.verify(txRoleChangeFuture != null, "TxRoleChangeFuture for entity {} is null", 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());
- if (!txRoleChangeFuture.isDone()) {
- txRoleChangeFuture.cancel(true);
- }
- return;
- }
-
- Verify.verify(txEntity != null, "TxEntity for Entity {} is null", entity);
- if (OfpRole.BECOMEMASTER.equals(newRole)) {
- if (!txRoleChangeFuture.isDone()) {
- txRoleChangeFuture.set(null);
- }
- } else if (OfpRole.BECOMESLAVE.equals(newRole)) {
- // NOOP
- } else {
- LOG.warn("Unexpected Role for entity {} TxEntity {}", entity, txEntity);
- }
+ public Entity getEntity() {
+ return this.entity;
}
@Override
- public void close() {
- if (entityOwnershipCandidateRegistration != null) {
- LOG.debug("Closing EntityOwnershipCandidateRegistration for {}", entity);
- entityOwnershipCandidateRegistration.close();
- }
+ public Entity getTxEntity() {
+ return this.txEntity;
}
@Override
- public Entity getEntity() {
- return entity;
+ public DeviceInfo getDeviceInfo() {
+ return deviceInfo;
}
@Override
- public Entity getTxEntity() {
- return txEntity;
+ public boolean isMainCandidateRegistered() {
+ return entityOwnershipCandidateRegistration != null;
}
- private boolean isDeviceConnected() {
- return ConnectionContext.CONNECTION_STATE.WORKING.equals(
- deviceContext.getPrimaryConnectionContext().getConnectionState());
+ @Override
+ public boolean isTxCandidateRegistered() {
+ return txEntityOwnershipCandidateRegistration != null;
}
- @Nullable
@Override
- public <T> RequestContext<T> createRequestContext() {
- final AbstractRequestContext<T> ret = new AbstractRequestContext<T>(deviceContext.getReservedXid()) {
- @Override
- public void close() {
+ public boolean registerCandidate(final Entity entity_) {
+ boolean permit = false;
+ try {
+ permit = roleChangeGuard.tryAcquire(TIMEOUT, TimeUnit.SECONDS);
+ if(permit) {
+ LOG.debug("Register candidate for entity {}", entity_);
+ if (entity_.equals(this.entity)) {
+ entityOwnershipCandidateRegistration = entityOwnershipService.registerCandidate(entity_);
+ } else {
+ txEntityOwnershipCandidateRegistration = entityOwnershipService.registerCandidate(entity_);
+ }
+ } else {
+ return false;
}
- };
- return ret;
+ } catch (final CandidateAlreadyRegisteredException e) {
+ LOG.warn("Candidate for entity {} is already registered.", entity_.getType());
+ return false;
+ } catch (final InterruptedException e) {
+ LOG.warn("Cannot acquire semaphore for register entity {} candidate.", entity_.getType());
+ return false;
+ } finally {
+ if (permit) {
+ roleChangeGuard.release();
+ }
+ }
+ return true;
}
- @VisibleForTesting
- void setSalRoleService(final SalRoleService salRoleService) {
- this.salRoleService = salRoleService;
+ @Override
+ public boolean unregisterCandidate(final Entity entity_) {
+ boolean permit = false;
+ try {
+ permit = roleChangeGuard.tryAcquire(TIMEOUT, TimeUnit.SECONDS);
+ if(permit) {
+ if (entity_.equals(this.entity)) {
+ if (entityOwnershipCandidateRegistration != null) {
+ LOG.debug("Unregister candidate for entity {}", entity_);
+ entityOwnershipCandidateRegistration.close();
+ entityOwnershipCandidateRegistration = null;
+ }
+ } else {
+ if (txEntityOwnershipCandidateRegistration != null) {
+ LOG.debug("Unregister candidate for tx entity {}", entity_);
+ txEntityOwnershipCandidateRegistration.close();
+ txEntityOwnershipCandidateRegistration = null;
+ }
+ }
+ } else {
+ return false;
+ }
+ } catch (final InterruptedException e) {
+ LOG.warn("Cannot acquire semaphore for unregister entity {} candidate.", entity_.getType());
+ return false;
+ } finally {
+ if (permit) {
+ roleChangeGuard.release();
+ }
+ }
+ return true;
}
@Override
- public DeviceState getDeviceState() {
- return deviceContext.getDeviceState();
+ public void close() {
+ unregisterAllCandidates();
}
- @Override
- public void suspendTxCandidate() {
- if (txEntityOwnershipCandidateRegistration != null) {
- txEntityOwnershipCandidateRegistration.close();
- txEntityOwnershipCandidateRegistration = null;
- }
+ public boolean isMaster(){
+ return (txEntityOwnershipCandidateRegistration != null && entityOwnershipCandidateRegistration != null);
}
}