openflowplugin-impl/src/main/java/org/opendaylight/openflowplugin/impl/rpc/RpcContextImpl.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.rpc;
   9
  10 import com.google.common.annotations.VisibleForTesting;
  11 import com.google.common.base.Function;
  12 import com.google.common.base.Preconditions;
  13 import com.google.common.collect.Iterators;
  14 import com.google.common.util.concurrent.Futures;
  15 import com.google.common.util.concurrent.ListenableFuture;
  16 import java.util.Iterator;
  17 import java.util.Map.Entry;
  18 import java.util.concurrent.ConcurrentHashMap;
  19 import java.util.concurrent.ConcurrentMap;
  20 import java.util.concurrent.Semaphore;
  21 import javax.annotation.Nullable;
  22 import org.opendaylight.controller.md.sal.binding.api.NotificationPublishService;
  23 import org.opendaylight.controller.sal.binding.api.BindingAwareBroker.RoutedRpcRegistration;
  24 import org.opendaylight.controller.sal.binding.api.RpcProviderRegistry;
  25 import org.opendaylight.mdsal.singleton.common.api.ServiceGroupIdentifier;
  26 import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
  27 import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
  28 import org.opendaylight.openflowplugin.api.openflow.device.DeviceInfo;
  29 import org.opendaylight.openflowplugin.api.openflow.device.RequestContext;
  30 import org.opendaylight.openflowplugin.api.openflow.device.handlers.ClusterInitializationPhaseHandler;
  31 import org.opendaylight.openflowplugin.api.openflow.lifecycle.MastershipChangeListener;
  32 import org.opendaylight.openflowplugin.api.openflow.rpc.RpcContext;
  33 import org.opendaylight.openflowplugin.api.openflow.statistics.ofpspecific.MessageSpy;
  34 import org.opendaylight.openflowplugin.extension.api.core.extension.ExtensionConverterProvider;
  35 import org.opendaylight.openflowplugin.impl.util.MdSalRegistrationUtils;
  36 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.ConvertorExecutor;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeContext;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
  40 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
  41 import org.opendaylight.yangtools.yang.binding.RpcService;
  42 import org.slf4j.Logger;
  43 import org.slf4j.LoggerFactory;
  44
  45 class RpcContextImpl implements RpcContext {
  46     private static final Logger LOG = LoggerFactory.getLogger(RpcContextImpl.class);
  47     private final RpcProviderRegistry rpcProviderRegistry;
  48     private final MessageSpy messageSpy;
  49     private final Semaphore tracker;
  50     private boolean isStatisticsRpcEnabled;
  51
  52     // TODO: add private Sal salBroker
  53     private final ConcurrentMap<Class<?>, RoutedRpcRegistration<?>> rpcRegistrations = new ConcurrentHashMap<>();
  54     private final KeyedInstanceIdentifier<Node, NodeKey> nodeInstanceIdentifier;
  55     private volatile CONTEXT_STATE state = CONTEXT_STATE.INITIALIZATION;
  56     private final DeviceInfo deviceInfo;
  57     private final DeviceContext deviceContext;
  58     private final ExtensionConverterProvider extensionConverterProvider;
  59     private final ConvertorExecutor convertorExecutor;
  60     private final NotificationPublishService notificationPublishService;
  61     private ClusterInitializationPhaseHandler clusterInitializationPhaseHandler;
  62
  63     RpcContextImpl(final DeviceInfo deviceInfo,
  64                    final RpcProviderRegistry rpcProviderRegistry,
  65                    final MessageSpy messageSpy,
  66                    final int maxRequests,
  67                    final KeyedInstanceIdentifier<Node, NodeKey> nodeInstanceIdentifier,
  68                    final DeviceContext deviceContext,
  69                    final ExtensionConverterProvider extensionConverterProvider,
  70                    final ConvertorExecutor convertorExecutor,
  71                    final NotificationPublishService notificationPublishService) {
  72         this.messageSpy = Preconditions.checkNotNull(messageSpy);
  73         this.rpcProviderRegistry = Preconditions.checkNotNull(rpcProviderRegistry);
  74         this.nodeInstanceIdentifier = nodeInstanceIdentifier;
  75         this.tracker = new Semaphore(maxRequests, true);
  76         this.extensionConverterProvider = extensionConverterProvider;
  77         this.notificationPublishService = notificationPublishService;
  78         this.deviceInfo = deviceInfo;
  79         this.deviceContext = deviceContext;
  80         this.convertorExecutor = convertorExecutor;
  81     }
  82
  83     /**
  84      * @see org.opendaylight.openflowplugin.api.openflow.rpc.RpcContext#registerRpcServiceImplementation(java.lang.Class,
  85      * org.opendaylight.yangtools.yang.binding.RpcService)
  86      */
  87     @Override
  88     public <S extends RpcService> void registerRpcServiceImplementation(final Class<S> serviceClass,
  89                                                                         final S serviceInstance) {
  90         LOG.trace("Try to register service {} for device {}.", serviceClass, nodeInstanceIdentifier);
  91         if (! rpcRegistrations.containsKey(serviceClass)) {
  92             final RoutedRpcRegistration<S> routedRpcReg = rpcProviderRegistry.addRoutedRpcImplementation(serviceClass, serviceInstance);
  93             routedRpcReg.registerPath(NodeContext.class, nodeInstanceIdentifier);
  94             rpcRegistrations.put(serviceClass, routedRpcReg);
  95             LOG.debug("Registration of service {} for device {}.", serviceClass.getSimpleName(), nodeInstanceIdentifier.getKey().getId().getValue());
  96         }
  97     }
  98
  99     @Override
 100     public <S extends RpcService> S lookupRpcService(final Class<S> serviceClass) {
 101         RoutedRpcRegistration<?> registration = rpcRegistrations.get(serviceClass);
 102         final RpcService rpcService = registration.getInstance();
 103         return (S) rpcService;
 104     }
 105
 106     /**
 107      * Unregisters all services.
 108      *
 109      * @see java.lang.AutoCloseable#close()
 110      */
 111     @Override
 112     public void close() {
 113         if (CONTEXT_STATE.TERMINATION.equals(getState())){
 114             if (LOG.isDebugEnabled()) {
 115                 LOG.debug("RpcContext for node {} is already in TERMINATION state.", getDeviceInfo().getLOGValue());
 116             }
 117         } else {
 118             try {
 119                 stopClusterServices(true).get();
 120             } catch (Exception e) {
 121                 LOG.debug("Failed to close RpcContext for node {} with exception: ", getDeviceInfo().getLOGValue(), e);
 122             }
 123
 124             this.state = CONTEXT_STATE.TERMINATION;
 125         }
 126     }
 127
 128     @Override
 129     public <T> RequestContext<T> createRequestContext() {
 130         if (!tracker.tryAcquire()) {
 131             LOG.trace("Device queue {} at capacity", this);
 132             return null;
 133         } else {
 134             LOG.trace("Acquired semaphore for {}, available permits:{} ", nodeInstanceIdentifier.getKey().getId().getValue(), tracker.availablePermits());
 135         }
 136
 137         final Long xid = deviceInfo.reserveXidForDeviceMessage();
 138         if (xid == null) {
 139             LOG.warn("Xid cannot be reserved for new RequestContext, node:{}", nodeInstanceIdentifier.getKey().getId().getValue());
 140             tracker.release();
 141             return null;
 142         }
 143
 144         return new AbstractRequestContext<T>(xid) {
 145             @Override
 146             public void close() {
 147                 tracker.release();
 148                 final long xid = getXid().getValue();
 149                 LOG.trace("Removed request context with xid {}", xid);
 150                 messageSpy.spyMessage(RpcContextImpl.class, MessageSpy.STATISTIC_GROUP.REQUEST_STACK_FREED);
 151             }
 152         };
 153     }
 154
 155     @Override
 156     public <S extends RpcService> void unregisterRpcServiceImplementation(final Class<S> serviceClass) {
 157         LOG.trace("Try to unregister serviceClass {} for Node {}", serviceClass, nodeInstanceIdentifier.getKey().getId());
 158         final RoutedRpcRegistration<?> rpcRegistration = rpcRegistrations.remove(serviceClass);
 159         if (rpcRegistration != null) {
 160             rpcRegistration.unregisterPath(NodeContext.class, nodeInstanceIdentifier);
 161             rpcRegistration.close();
 162             LOG.debug("Un-registration serviceClass {} for Node {}", serviceClass.getSimpleName(), nodeInstanceIdentifier.getKey().getId().getValue());
 163         }
 164     }
 165
 166     @VisibleForTesting
 167     boolean isEmptyRpcRegistrations() {
 168         return this.rpcRegistrations.isEmpty();
 169     }
 170
 171     @Override
 172     public void setStatisticsRpcEnabled(boolean isStatisticsRpcEnabled) {
 173         this.isStatisticsRpcEnabled = isStatisticsRpcEnabled;
 174     }
 175
 176     @Override
 177     public CONTEXT_STATE getState() {
 178         return this.state;
 179     }
 180
 181     @Override
 182     public ServiceGroupIdentifier getServiceIdentifier() {
 183         return this.deviceInfo.getServiceIdentifier();
 184     }
 185
 186     @Override
 187     public DeviceInfo getDeviceInfo() {
 188         return this.deviceInfo;
 189     }
 190
 191     @Override
 192     public ListenableFuture<Void> stopClusterServices(boolean connectionInterrupted) {
 193         if (CONTEXT_STATE.TERMINATION.equals(getState())) {
 194             return Futures.immediateCancelledFuture();
 195         }
 196
 197         return Futures.transform(Futures.immediateFuture(null), new Function<Object, Void>() {
 198             @Nullable
 199             @Override
 200             public Void apply(@Nullable Object input) {
 201                 for (final Iterator<Entry<Class<?>, RoutedRpcRegistration<?>>> iterator = Iterators
 202                         .consumingIterator(rpcRegistrations.entrySet().iterator()); iterator.hasNext(); ) {
 203                     final RoutedRpcRegistration<?> rpcRegistration = iterator.next().getValue();
 204                     rpcRegistration.unregisterPath(NodeContext.class, nodeInstanceIdentifier);
 205                     rpcRegistration.close();
 206
 207                     if (LOG.isDebugEnabled()) {
 208                         LOG.debug("Closing RPC Registration of service {} for device {}.", rpcRegistration.getServiceType().getSimpleName(),
 209                                 nodeInstanceIdentifier.getKey().getId().getValue());
 210                     }
 211                 }
 212
 213                 return null;
 214             }
 215         });
 216     }
 217
 218     @Override
 219     public void setLifecycleInitializationPhaseHandler(final ClusterInitializationPhaseHandler handler) {
 220         this.clusterInitializationPhaseHandler = handler;
 221     }
 222
 223     @Override
 224     public boolean onContextInstantiateService(final MastershipChangeListener mastershipChangeListener) {
 225
 226         MdSalRegistrationUtils.registerServices(this, deviceContext, extensionConverterProvider, convertorExecutor);
 227
 228         if (isStatisticsRpcEnabled) {
 229             MdSalRegistrationUtils.registerStatCompatibilityServices(
 230                     this,
 231                     deviceContext,
 232                     notificationPublishService,
 233                     convertorExecutor);
 234         }
 235
 236         return true;
 237     }
 238 }