openflowplugin-impl/src/main/java/org/opendaylight/openflowplugin/impl/services/SalRoleServiceImpl.java

   1 /**
   2  * Copyright (c) 2015 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   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
   7  */
   8 package org.opendaylight.openflowplugin.impl.services;
   9
  10 import com.google.common.base.Preconditions;
  11 import com.google.common.util.concurrent.AsyncFunction;
  12 import com.google.common.util.concurrent.FutureCallback;
  13 import com.google.common.util.concurrent.Futures;
  14 import com.google.common.util.concurrent.JdkFutureAdapters;
  15 import com.google.common.util.concurrent.ListenableFuture;
  16 import com.google.common.util.concurrent.SettableFuture;
  17 import java.math.BigInteger;
  18 import java.util.concurrent.Future;
  19 import java.util.concurrent.Semaphore;
  20 import javax.annotation.concurrent.GuardedBy;
  21 import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext.CONNECTION_STATE;
  22 import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
  23 import org.opendaylight.openflowplugin.api.openflow.device.RequestContextStack;
  24 import org.opendaylight.openflowplugin.api.openflow.device.Xid;
  25 import org.opendaylight.openflowplugin.impl.role.RoleChangeException;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OfHeader;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.RoleRequestOutput;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.role.service.rev150727.OfpRole;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.role.service.rev150727.SalRoleService;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.role.service.rev150727.SetRoleInput;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.role.service.rev150727.SetRoleOutput;
  32 import org.opendaylight.yangtools.yang.common.RpcResult;
  33 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
  34 import org.slf4j.Logger;
  35 import org.slf4j.LoggerFactory;
  36
  37
  38 public final class SalRoleServiceImpl extends AbstractSimpleService<SetRoleInput, SetRoleOutput> implements SalRoleService  {
  39
  40     private static final Logger LOG = LoggerFactory.getLogger(SalRoleServiceImpl.class);
  41
  42     private static final BigInteger MAX_GENERATION_ID = new BigInteger("ffffffffffffffff", 16);
  43
  44     private static final int MAX_RETRIES = 42;
  45
  46     private final DeviceContext deviceContext;
  47     private final RoleService roleService;
  48
  49     private final Semaphore currentRoleGuard = new Semaphore(1, true);
  50
  51     @GuardedBy("currentRoleGuard")
  52     private OfpRole currentRole = OfpRole.NOCHANGE;
  53
  54     public SalRoleServiceImpl(final RequestContextStack requestContextStack, final DeviceContext deviceContext) {
  55         super(requestContextStack, deviceContext, SetRoleOutput.class);
  56         this.deviceContext = Preconditions.checkNotNull(deviceContext);
  57         this.roleService =  new RoleService(requestContextStack, deviceContext, RoleRequestOutput.class);
  58     }
  59
  60     @Override
  61     protected OfHeader buildRequest(final Xid xid, final SetRoleInput input) throws ServiceException {
  62         return null;
  63     }
  64
  65     @Override
  66     public Future<RpcResult<SetRoleOutput>> setRole(final SetRoleInput input) {
  67         LOG.info("SetRole called with input:{}", input);
  68         try {
  69             currentRoleGuard.acquire();
  70             LOG.trace("currentRole lock queue length: {} " + currentRoleGuard.getQueueLength());
  71         } catch (final InterruptedException e) {
  72             LOG.error("Unexpected exception {} for acquire semaphore for input {}", e, input);
  73             return RpcResultBuilder.<SetRoleOutput> failed().buildFuture();
  74         }
  75         // compare with last known role and set if different. If they are same, then return.
  76         if (currentRole.equals(input.getControllerRole())) {
  77             LOG.info("Role to be set is same as the last known role for the device:{}. Hence ignoring.",
  78                     input.getControllerRole());
  79             currentRoleGuard.release();
  80             return RpcResultBuilder.<SetRoleOutput> success().buildFuture();
  81         }
  82
  83         final SettableFuture<RpcResult<SetRoleOutput>> resultFuture = SettableFuture.<RpcResult<SetRoleOutput>> create();
  84         repeaterForChangeRole(resultFuture, input, 0);
  85         /* Add Callback for release Guard */
  86         Futures.addCallback(resultFuture, new FutureCallback<RpcResult<SetRoleOutput>>() {
  87
  88             @Override
  89             public void onSuccess(final RpcResult<SetRoleOutput> result) {
  90                 LOG.debug("SetRoleService for Node: {} is ok Role: {}", input.getNode().getValue(),
  91                         input.getControllerRole());
  92                 currentRoleGuard.release();
  93             }
  94
  95             @Override
  96             public void onFailure(final Throwable t) {
  97                 LOG.error("SetRoleService set Role {} for Node: {} fail . Reason {}", input.getControllerRole(),
  98                         input.getNode().getValue(), t);
  99                 currentRoleGuard.release();
 100             }
 101         });
 102         return resultFuture;
 103     }
 104
 105     private void repeaterForChangeRole(final SettableFuture<RpcResult<SetRoleOutput>> future, final SetRoleInput input,
 106             final int retryCounter) {
 107         if (future.isCancelled()) {
 108             future.setException(new RoleChangeException(String.format(
 109                     "Set Role for device %s stop because Future was canceled", input.getNode().getValue())));
 110             return;
 111         }
 112         if (retryCounter >= MAX_RETRIES) {
 113             future.setException(new RoleChangeException(String.format("Set Role failed after %s tries on device %s",
 114                     MAX_RETRIES, input.getNode().getValue())));
 115             return;
 116         }
 117         // Check current connection state
 118         final CONNECTION_STATE state = deviceContext.getPrimaryConnectionContext().getConnectionState();
 119         switch (state) {
 120         case RIP:
 121             LOG.info("Device {} has been disconnected", input.getNode());
 122             future.setException(new Exception(String.format(
 123                     "Device connection doesn't exist anymore. Primary connection status : %s", state)));
 124             return;
 125         case WORKING:
 126             // We can proceed
 127             LOG.trace("Device {} has been working", input.getNode());
 128             break;
 129         default:
 130             LOG.warn("Device {} is in state {}, role change is not allowed", input.getNode(), state);
 131             future.setException(new Exception(String.format("Unexcpected device connection status : %s", state)));
 132             return;
 133         }
 134
 135         LOG.info("Requesting state change to {}", input.getControllerRole());
 136         final ListenableFuture<RpcResult<SetRoleOutput>> changeRoleFuture = tryToChangeRole(input.getControllerRole());
 137         Futures.addCallback(changeRoleFuture, new FutureCallback<RpcResult<SetRoleOutput>>() {
 138
 139             @Override
 140             public void onSuccess(final RpcResult<SetRoleOutput> result) {
 141                 if (result.isSuccessful()) {
 142                     LOG.debug("setRoleOutput received after roleChangeTask execution:{}", result);
 143                     currentRole = input.getControllerRole();
 144                     future.set(RpcResultBuilder.<SetRoleOutput> success().withResult(result.getResult()).build());
 145                 } else {
 146                     LOG.error("setRole() failed with errors, will retry: {} times.", MAX_RETRIES - retryCounter);
 147                     repeaterForChangeRole(future, input, (retryCounter + 1));
 148                 }
 149             }
 150
 151             @Override
 152             public void onFailure(final Throwable t) {
 153                 LOG.error("Exception in setRole(), will retry: {} times.", t, MAX_RETRIES - retryCounter);
 154                 repeaterForChangeRole(future, input, (retryCounter + 1));
 155             }
 156         });
 157     }
 158
 159     private ListenableFuture<RpcResult<SetRoleOutput>> tryToChangeRole(final OfpRole role) {
 160         LOG.info("RoleChangeTask called on device:{} OFPRole:{}", getDeviceInfo().getNodeId().getValue(), role);
 161
 162         final Future<BigInteger> generationFuture = roleService.getGenerationIdFromDevice(getVersion());
 163
 164         return Futures.transform(JdkFutureAdapters.listenInPoolThread(generationFuture), (AsyncFunction<BigInteger, RpcResult<SetRoleOutput>>) generationId -> {
 165             LOG.debug("RoleChangeTask, GenerationIdFromDevice from device {} is {}", getDeviceInfo().getNodeId().getValue(), generationId);
 166             final BigInteger nextGenerationId = getNextGenerationId(generationId);
 167             LOG.debug("nextGenerationId received from device:{} is {}", getDeviceInfo().getNodeId().getValue(), nextGenerationId);
 168             final Future<RpcResult<SetRoleOutput>> submitRoleFuture = roleService.submitRoleChange(role, getVersion(), nextGenerationId);
 169             return JdkFutureAdapters.listenInPoolThread(submitRoleFuture);
 170         });
 171     }
 172
 173     private static BigInteger getNextGenerationId(final BigInteger generationId) {
 174         if (generationId.compareTo(MAX_GENERATION_ID) < 0) {
 175             return generationId.add(BigInteger.ONE);
 176         } else {
 177             return BigInteger.ZERO;
 178         }
 179     }
 180 }