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