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 com.google.common.util.concurrent.MoreExecutors;
  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.Nonnull;
  22 import javax.annotation.Nullable;
  23 import org.opendaylight.controller.md.sal.binding.api.NotificationPublishService;
  24 import org.opendaylight.controller.sal.binding.api.BindingAwareBroker.RoutedRpcRegistration;
  25 import org.opendaylight.controller.sal.binding.api.RpcProviderRegistry;
  26 import org.opendaylight.mdsal.singleton.common.api.ServiceGroupIdentifier;
  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.lifecycle.ContextChainMastershipState;
  31 import org.opendaylight.openflowplugin.api.openflow.lifecycle.ContextChainMastershipWatcher;
  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 final DeviceInfo deviceInfo;
  56     private final DeviceContext deviceContext;
  57     private final ExtensionConverterProvider extensionConverterProvider;
  58     private final ConvertorExecutor convertorExecutor;
  59     private final NotificationPublishService notificationPublishService;
  60     private ContextChainMastershipWatcher contextChainMastershipWatcher;
  61
  62     RpcContextImpl(@Nonnull final RpcProviderRegistry rpcProviderRegistry,
  63                    final int maxRequests,
  64                    @Nonnull final DeviceContext deviceContext,
  65                    @Nonnull final ExtensionConverterProvider extensionConverterProvider,
  66                    @Nonnull final ConvertorExecutor convertorExecutor,
  67                    @Nonnull final NotificationPublishService notificationPublishService,
  68                    boolean statisticsRpcEnabled) {
  69         this.deviceContext = deviceContext;
  70         this.deviceInfo = deviceContext.getDeviceInfo();
  71         this.nodeInstanceIdentifier = deviceContext.getDeviceInfo().getNodeInstanceIdentifier();
  72         this.messageSpy = deviceContext.getMessageSpy();
  73         this.rpcProviderRegistry = rpcProviderRegistry;
  74         this.extensionConverterProvider = extensionConverterProvider;
  75         this.notificationPublishService = notificationPublishService;
  76         this.convertorExecutor = convertorExecutor;
  77         this.isStatisticsRpcEnabled = statisticsRpcEnabled;
  78         this.tracker = new Semaphore(maxRequests, true);
  79     }
  80
  81     @Override
  82     public <S extends RpcService> void registerRpcServiceImplementation(final Class<S> serviceClass,
  83                                                                         final S serviceInstance) {
  84         if (!rpcRegistrations.containsKey(serviceClass)) {
  85             final RoutedRpcRegistration<S> routedRpcReg =
  86                     rpcProviderRegistry.addRoutedRpcImplementation(serviceClass, serviceInstance);
  87             routedRpcReg.registerPath(NodeContext.class, nodeInstanceIdentifier);
  88             rpcRegistrations.put(serviceClass, routedRpcReg);
  89             if (LOG.isDebugEnabled()) {
  90                 LOG.debug("Registration of service {} for device {}.",
  91                         serviceClass.getSimpleName(),
  92                         nodeInstanceIdentifier.getKey().getId().getValue());
  93             }
  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 serviceClass.cast(rpcService);
 102     }
 103
 104     @Override
 105     public void close() {
 106         unregisterRPCs();
 107     }
 108
 109     private void unregisterRPCs() {
 110         for (final Iterator<Entry<Class<?>, RoutedRpcRegistration<?>>> iterator = Iterators
 111                 .consumingIterator(rpcRegistrations.entrySet().iterator()); iterator.hasNext(); ) {
 112             final RoutedRpcRegistration<?> rpcRegistration = iterator.next().getValue();
 113             rpcRegistration.unregisterPath(NodeContext.class, nodeInstanceIdentifier);
 114             rpcRegistration.close();
 115
 116             if (LOG.isDebugEnabled()) {
 117                 LOG.debug("Closing RPC Registration of service {} for device {}.",
 118                         rpcRegistration.getServiceType().getSimpleName(),
 119                         nodeInstanceIdentifier.getKey().getId().getValue());
 120             }
 121         }
 122     }
 123
 124     @Override
 125     public <T> RequestContext<T> createRequestContext() {
 126         if (!tracker.tryAcquire()) {
 127             LOG.trace("Device queue {} at capacity", this);
 128             return null;
 129         } else {
 130             LOG.trace("Acquired semaphore for {}, available permits:{} ",
 131                     nodeInstanceIdentifier.getKey().getId().getValue(), tracker.availablePermits());
 132         }
 133
 134         final Long xid = deviceInfo.reserveXidForDeviceMessage();
 135         if (xid == null) {
 136             LOG.warn("Xid cannot be reserved for new RequestContext, node:{}",
 137                     nodeInstanceIdentifier.getKey().getId().getValue());
 138             tracker.release();
 139             return null;
 140         }
 141
 142         return new AbstractRequestContext<T>(xid) {
 143             @Override
 144             public void close() {
 145                 tracker.release();
 146                 final long xid = getXid().getValue();
 147                 LOG.trace("Removed request context with xid {}", xid);
 148                 messageSpy.spyMessage(RpcContextImpl.class, MessageSpy.StatisticsGroup.REQUEST_STACK_FREED);
 149             }
 150         };
 151     }
 152
 153     @Override
 154     public <S extends RpcService> void unregisterRpcServiceImplementation(final Class<S> serviceClass) {
 155         LOG.trace("Try to unregister serviceClass {} for Node {}",
 156                 serviceClass, nodeInstanceIdentifier.getKey().getId());
 157         final RoutedRpcRegistration<?> rpcRegistration = rpcRegistrations.remove(serviceClass);
 158         if (rpcRegistration != null) {
 159             rpcRegistration.unregisterPath(NodeContext.class, nodeInstanceIdentifier);
 160             rpcRegistration.close();
 161             LOG.debug("Un-registration serviceClass {} for Node {}", serviceClass.getSimpleName(),
 162                     nodeInstanceIdentifier.getKey().getId().getValue());
 163         }
 164     }
 165
 166     @VisibleForTesting
 167     boolean isEmptyRpcRegistrations() {
 168         return this.rpcRegistrations.isEmpty();
 169     }
 170
 171     @Override
 172     public DeviceInfo getDeviceInfo() {
 173         return this.deviceInfo;
 174     }
 175
 176     @Override
 177     public void registerMastershipWatcher(@Nonnull final ContextChainMastershipWatcher contextChainMastershipWatcher) {
 178         this.contextChainMastershipWatcher = contextChainMastershipWatcher;
 179     }
 180
 181     @Override
 182     public ListenableFuture<Void> closeServiceInstance() {
 183         return Futures.transform(Futures.immediateFuture(null), new Function<Void, Void>() {
 184             @Nullable
 185             @Override
 186             public Void apply(@Nullable final Void input) {
 187                 unregisterRPCs();
 188                 return null;
 189             }
 190         }, MoreExecutors.directExecutor());
 191     }
 192
 193     @Override
 194     public void instantiateServiceInstance() {
 195         MdSalRegistrationUtils.registerServices(this, deviceContext, extensionConverterProvider, convertorExecutor);
 196
 197         if (isStatisticsRpcEnabled && !deviceContext.canUseSingleLayerSerialization()) {
 198             MdSalRegistrationUtils.registerStatCompatibilityServices(
 199                     this,
 200                     deviceContext,
 201                     notificationPublishService,
 202                     convertorExecutor);
 203         }
 204
 205         contextChainMastershipWatcher.onMasterRoleAcquired(deviceInfo, ContextChainMastershipState.RPC_REGISTRATION);
 206     }
 207
 208     @Nonnull
 209     @Override
 210     public ServiceGroupIdentifier getIdentifier() {
 211         return deviceInfo.getServiceIdentifier();
 212     }
 213 }