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