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