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.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 volatile CONTEXT_STATE state = CONTEXT_STATE.INITIALIZATION;
  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 ClusterInitializationPhaseHandler clusterInitializationPhaseHandler;
  61
  62     RpcContextImpl(final DeviceInfo deviceInfo,
  63                    final RpcProviderRegistry rpcProviderRegistry,
  64                    final MessageSpy messageSpy,
  65                    final int maxRequests,
  66                    final KeyedInstanceIdentifier<Node, NodeKey> nodeInstanceIdentifier,
  67                    final DeviceContext deviceContext,
  68                    final ExtensionConverterProvider extensionConverterProvider,
  69                    final ConvertorExecutor convertorExecutor,
  70                    final NotificationPublishService notificationPublishService) {
  71         this.messageSpy = Preconditions.checkNotNull(messageSpy);
  72         this.rpcProviderRegistry = Preconditions.checkNotNull(rpcProviderRegistry);
  73         this.nodeInstanceIdentifier = nodeInstanceIdentifier;
  74         this.tracker = new Semaphore(maxRequests, true);
  75         this.extensionConverterProvider = extensionConverterProvider;
  76         this.notificationPublishService = notificationPublishService;
  77         this.deviceInfo = deviceInfo;
  78         this.deviceContext = deviceContext;
  79         this.convertorExecutor = convertorExecutor;
  80     }
  81
  82     /**
  83      * @see org.opendaylight.openflowplugin.api.openflow.rpc.RpcContext#registerRpcServiceImplementation(java.lang.Class,
  84      * org.opendaylight.yangtools.yang.binding.RpcService)
  85      */
  86     @Override
  87     public <S extends RpcService> void registerRpcServiceImplementation(final Class<S> serviceClass,
  88                                                                         final S serviceInstance) {
  89         LOG.trace("Try to register service {} for device {}.", serviceClass, nodeInstanceIdentifier);
  90         if (! rpcRegistrations.containsKey(serviceClass)) {
  91             final RoutedRpcRegistration<S> routedRpcReg = rpcProviderRegistry.addRoutedRpcImplementation(serviceClass, serviceInstance);
  92             routedRpcReg.registerPath(NodeContext.class, nodeInstanceIdentifier);
  93             rpcRegistrations.put(serviceClass, routedRpcReg);
  94             LOG.debug("Registration of service {} for device {}.", serviceClass.getSimpleName(), nodeInstanceIdentifier.getKey().getId().getValue());
  95         }
  96     }
  97
  98     @Override
  99     public <S extends RpcService> S lookupRpcService(final Class<S> serviceClass) {
 100         RoutedRpcRegistration<?> registration = rpcRegistrations.get(serviceClass);
 101         final RpcService rpcService = registration.getInstance();
 102         return (S) rpcService;
 103     }
 104
 105     /**
 106      * Unregisters all services.
 107      *
 108      * @see java.lang.AutoCloseable#close()
 109      */
 110     @Override
 111     public void close() {
 112         if (CONTEXT_STATE.TERMINATION.equals(getState())){
 113             if (LOG.isDebugEnabled()) {
 114                 LOG.debug("RpcContext for node {} is already in TERMINATION state.", getDeviceInfo().getLOGValue());
 115             }
 116         } else {
 117             try {
 118                 stopClusterServices().get();
 119             } catch (Exception e) {
 120                 LOG.debug("Failed to close RpcContext for node {} with exception: ", getDeviceInfo().getLOGValue(), e);
 121             }
 122
 123             this.state = CONTEXT_STATE.TERMINATION;
 124         }
 125     }
 126
 127     @Override
 128     public <T> RequestContext<T> createRequestContext() {
 129         if (!tracker.tryAcquire()) {
 130             LOG.trace("Device queue {} at capacity", this);
 131             return null;
 132         } else {
 133             LOG.trace("Acquired semaphore for {}, available permits:{} ", nodeInstanceIdentifier.getKey().getId().getValue(), tracker.availablePermits());
 134         }
 135
 136         final Long xid = deviceInfo.reserveXidForDeviceMessage();
 137         if (xid == null) {
 138             LOG.warn("Xid cannot be reserved for new RequestContext, node:{}", nodeInstanceIdentifier.getKey().getId().getValue());
 139             tracker.release();
 140             return null;
 141         }
 142
 143         return new AbstractRequestContext<T>(xid) {
 144             @Override
 145             public void close() {
 146                 tracker.release();
 147                 final long xid = getXid().getValue();
 148                 LOG.trace("Removed request context with xid {}", xid);
 149                 messageSpy.spyMessage(RpcContextImpl.class, MessageSpy.STATISTIC_GROUP.REQUEST_STACK_FREED);
 150             }
 151         };
 152     }
 153
 154     @Override
 155     public <S extends RpcService> void unregisterRpcServiceImplementation(final Class<S> serviceClass) {
 156         LOG.trace("Try to unregister serviceClass {} for Node {}", 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(), nodeInstanceIdentifier.getKey().getId().getValue());
 162         }
 163     }
 164
 165     @VisibleForTesting
 166     boolean isEmptyRpcRegistrations() {
 167         return this.rpcRegistrations.isEmpty();
 168     }
 169
 170     @Override
 171     public void setStatisticsRpcEnabled(boolean isStatisticsRpcEnabled) {
 172         this.isStatisticsRpcEnabled = isStatisticsRpcEnabled;
 173     }
 174
 175     @Override
 176     public CONTEXT_STATE getState() {
 177         return this.state;
 178     }
 179
 180     @Override
 181     public ServiceGroupIdentifier getServiceIdentifier() {
 182         return this.deviceInfo.getServiceIdentifier();
 183     }
 184
 185     @Override
 186     public DeviceInfo getDeviceInfo() {
 187         return this.deviceInfo;
 188     }
 189
 190     @Override
 191     public ListenableFuture<Void> stopClusterServices() {
 192         if (CONTEXT_STATE.TERMINATION.equals(getState())) {
 193             return Futures.immediateCancelledFuture();
 194         }
 195
 196         return Futures.transform(Futures.immediateFuture(null), new Function<Object, Void>() {
 197             @Nullable
 198             @Override
 199             public Void apply(@Nullable Object input) {
 200                 for (final Iterator<Entry<Class<?>, RoutedRpcRegistration<?>>> iterator = Iterators
 201                         .consumingIterator(rpcRegistrations.entrySet().iterator()); iterator.hasNext(); ) {
 202                     final RoutedRpcRegistration<?> rpcRegistration = iterator.next().getValue();
 203                     rpcRegistration.unregisterPath(NodeContext.class, nodeInstanceIdentifier);
 204                     rpcRegistration.close();
 205
 206                     if (LOG.isDebugEnabled()) {
 207                         LOG.debug("Closing RPC Registration of service {} for device {}.", rpcRegistration.getServiceType().getSimpleName(),
 208                                 nodeInstanceIdentifier.getKey().getId().getValue());
 209                     }
 210                 }
 211
 212                 return null;
 213             }
 214         });
 215     }
 216
 217     @Override
 218     public void setLifecycleInitializationPhaseHandler(final ClusterInitializationPhaseHandler handler) {
 219         this.clusterInitializationPhaseHandler = handler;
 220     }
 221
 222     @Override
 223     public boolean onContextInstantiateService(final ConnectionContext connectionContext) {
 224         if (connectionContext.getConnectionState().equals(ConnectionContext.CONNECTION_STATE.RIP)) {
 225             LOG.warn("Connection on device {} was interrupted, will stop starting master services.", deviceInfo.getLOGValue());
 226             return false;
 227         }
 228
 229         MdSalRegistrationUtils.registerServices(this, deviceContext, extensionConverterProvider, convertorExecutor);
 230
 231         if (isStatisticsRpcEnabled) {
 232             MdSalRegistrationUtils.registerStatCompatibilityServices(
 233                     this,
 234                     deviceContext,
 235                     notificationPublishService,
 236                     convertorExecutor);
 237         }
 238
 239         return this.clusterInitializationPhaseHandler.onContextInstantiateService(connectionContext);
 240     }
 241 }