Merge "Bug 6110: Fixed bugs in statistics manager due to race condition." into stable...
[openflowplugin.git] / openflowplugin-impl / src / main / java / org / opendaylight / openflowplugin / impl / rpc / RpcContextImpl.java
index 502ac137241296d82d4b68fa8ad3db3464b0aece..f794d850511c98509dc4e8a5f36c8305038b79bb 100644 (file)
@@ -7,37 +7,76 @@
  */
 package org.opendaylight.openflowplugin.impl.rpc;
 
+import com.google.common.annotations.VisibleForTesting;
+import com.google.common.base.Function;
 import com.google.common.base.Preconditions;
-import java.util.Collection;
-import java.util.HashSet;
+import com.google.common.collect.Iterators;
+import com.google.common.util.concurrent.Futures;
+import com.google.common.util.concurrent.ListenableFuture;
+import java.util.Iterator;
+import java.util.Map.Entry;
+import java.util.concurrent.ConcurrentHashMap;
+import java.util.concurrent.ConcurrentMap;
 import java.util.concurrent.Semaphore;
+import javax.annotation.Nullable;
+import org.opendaylight.controller.md.sal.binding.api.NotificationPublishService;
 import org.opendaylight.controller.sal.binding.api.BindingAwareBroker.RoutedRpcRegistration;
 import org.opendaylight.controller.sal.binding.api.RpcProviderRegistry;
+import org.opendaylight.mdsal.singleton.common.api.ServiceGroupIdentifier;
+import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
 import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
+import org.opendaylight.openflowplugin.api.openflow.device.DeviceInfo;
 import org.opendaylight.openflowplugin.api.openflow.device.RequestContext;
-import org.opendaylight.openflowplugin.api.openflow.rpc.ItemLifeCycleSource;
+import org.opendaylight.openflowplugin.api.openflow.device.handlers.ClusterInitializationPhaseHandler;
 import org.opendaylight.openflowplugin.api.openflow.rpc.RpcContext;
 import org.opendaylight.openflowplugin.api.openflow.statistics.ofpspecific.MessageSpy;
+import org.opendaylight.openflowplugin.extension.api.core.extension.ExtensionConverterProvider;
+import org.opendaylight.openflowplugin.impl.util.MdSalRegistrationUtils;
+import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.ConvertorExecutor;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeContext;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
+import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
 import org.opendaylight.yangtools.yang.binding.RpcService;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-public class RpcContextImpl implements RpcContext {
+class RpcContextImpl implements RpcContext {
     private static final Logger LOG = LoggerFactory.getLogger(RpcContextImpl.class);
     private final RpcProviderRegistry rpcProviderRegistry;
-    private final DeviceContext deviceContext;
     private final MessageSpy messageSpy;
     private final Semaphore tracker;
+    private boolean isStatisticsRpcEnabled;
 
     // TODO: add private Sal salBroker
-    private final Collection<RoutedRpcRegistration<?>> rpcRegistrations = new HashSet<>();
+    private final ConcurrentMap<Class<?>, RoutedRpcRegistration<?>> rpcRegistrations = new ConcurrentHashMap<>();
+    private final KeyedInstanceIdentifier<Node, NodeKey> nodeInstanceIdentifier;
+    private volatile CONTEXT_STATE state = CONTEXT_STATE.INITIALIZATION;
+    private final DeviceInfo deviceInfo;
+    private final DeviceContext deviceContext;
+    private final ExtensionConverterProvider extensionConverterProvider;
+    private final ConvertorExecutor convertorExecutor;
+    private final NotificationPublishService notificationPublishService;
+    private ClusterInitializationPhaseHandler clusterInitializationPhaseHandler;
 
-    public RpcContextImpl(final MessageSpy messageSpy, final RpcProviderRegistry rpcProviderRegistry, final DeviceContext deviceContext, final int maxRequests) {
-        this.messageSpy = messageSpy;
-        this.rpcProviderRegistry = rpcProviderRegistry;
-        this.deviceContext = Preconditions.checkNotNull(deviceContext);
-        tracker = new Semaphore(maxRequests, true);
+    RpcContextImpl(final DeviceInfo deviceInfo,
+                   final RpcProviderRegistry rpcProviderRegistry,
+                   final MessageSpy messageSpy,
+                   final int maxRequests,
+                   final KeyedInstanceIdentifier<Node, NodeKey> nodeInstanceIdentifier,
+                   final DeviceContext deviceContext,
+                   final ExtensionConverterProvider extensionConverterProvider,
+                   final ConvertorExecutor convertorExecutor,
+                   final NotificationPublishService notificationPublishService) {
+        this.messageSpy = Preconditions.checkNotNull(messageSpy);
+        this.rpcProviderRegistry = Preconditions.checkNotNull(rpcProviderRegistry);
+        this.nodeInstanceIdentifier = nodeInstanceIdentifier;
+        this.tracker = new Semaphore(maxRequests, true);
+        this.extensionConverterProvider = extensionConverterProvider;
+        this.notificationPublishService = notificationPublishService;
+        this.deviceInfo = deviceInfo;
+        this.deviceContext = deviceContext;
+        this.convertorExecutor = convertorExecutor;
     }
 
     /**
@@ -47,17 +86,22 @@ public class RpcContextImpl implements RpcContext {
     @Override
     public <S extends RpcService> void registerRpcServiceImplementation(final Class<S> serviceClass,
                                                                         final S serviceInstance) {
-        final RoutedRpcRegistration<S> routedRpcReg = rpcProviderRegistry.addRoutedRpcImplementation(serviceClass, serviceInstance);
-        routedRpcReg.registerPath(NodeContext.class, deviceContext.getDeviceState().getNodeInstanceIdentifier());
-        rpcRegistrations.add(routedRpcReg);
-        LOG.debug("Registration of service {} for device {}.", serviceClass, deviceContext.getDeviceState().getNodeInstanceIdentifier());
-
-        if (serviceInstance instanceof ItemLifeCycleSource) {
-            // TODO: collect registration for selective unregistering in case of tearing down only one rpc
-            deviceContext.getItemLifeCycleSourceRegistry().registerLifeCycleSource((ItemLifeCycleSource) serviceInstance);
+        LOG.trace("Try to register service {} for device {}.", serviceClass, nodeInstanceIdentifier);
+        if (! rpcRegistrations.containsKey(serviceClass)) {
+            final RoutedRpcRegistration<S> routedRpcReg = rpcProviderRegistry.addRoutedRpcImplementation(serviceClass, serviceInstance);
+            routedRpcReg.registerPath(NodeContext.class, nodeInstanceIdentifier);
+            rpcRegistrations.put(serviceClass, routedRpcReg);
+            LOG.debug("Registration of service {} for device {}.", serviceClass.getSimpleName(), nodeInstanceIdentifier.getKey().getId().getValue());
         }
     }
 
+    @Override
+    public <S extends RpcService> S lookupRpcService(final Class<S> serviceClass) {
+        RoutedRpcRegistration<?> registration = rpcRegistrations.get(serviceClass);
+        final RpcService rpcService = registration.getInstance();
+        return (S) rpcService;
+    }
+
     /**
      * Unregisters all services.
      *
@@ -65,9 +109,18 @@ public class RpcContextImpl implements RpcContext {
      */
     @Override
     public void close() {
-        for (final RoutedRpcRegistration<?> rpcRegistration : rpcRegistrations) {
-            rpcRegistration.unregisterPath(NodeContext.class, deviceContext.getDeviceState().getNodeInstanceIdentifier());
-            rpcRegistration.close();
+        if (CONTEXT_STATE.TERMINATION.equals(getState())){
+            if (LOG.isDebugEnabled()) {
+                LOG.debug("RpcContext for node {} is already in TERMINATION state.", getDeviceInfo().getLOGValue());
+            }
+        } else {
+            try {
+                stopClusterServices().get();
+            } catch (Exception e) {
+                LOG.debug("Failed to close RpcContext for node {} with exception: ", getDeviceInfo().getLOGValue(), e);
+            }
+
+            this.state = CONTEXT_STATE.TERMINATION;
         }
     }
 
@@ -76,20 +129,113 @@ public class RpcContextImpl implements RpcContext {
         if (!tracker.tryAcquire()) {
             LOG.trace("Device queue {} at capacity", this);
             return null;
+        } else {
+            LOG.trace("Acquired semaphore for {}, available permits:{} ", nodeInstanceIdentifier.getKey().getId().getValue(), tracker.availablePermits());
+        }
+
+        final Long xid = deviceInfo.reserveXidForDeviceMessage();
+        if (xid == null) {
+            LOG.warn("Xid cannot be reserved for new RequestContext, node:{}", nodeInstanceIdentifier.getKey().getId().getValue());
+            tracker.release();
+            return null;
         }
 
-        return new AbstractRequestContext<T>(deviceContext.getReservedXid()) {
+        return new AbstractRequestContext<T>(xid) {
             @Override
             public void close() {
                 tracker.release();
-                LOG.trace("Removed request context with xid {}", getXid().getValue());
+                final long xid = getXid().getValue();
+                LOG.trace("Removed request context with xid {}", xid);
                 messageSpy.spyMessage(RpcContextImpl.class, MessageSpy.STATISTIC_GROUP.REQUEST_STACK_FREED);
             }
         };
     }
 
     @Override
-    public void onDeviceContextClosed(DeviceContext deviceContext) {
-        close();
+    public <S extends RpcService> void unregisterRpcServiceImplementation(final Class<S> serviceClass) {
+        LOG.trace("Try to unregister serviceClass {} for Node {}", serviceClass, nodeInstanceIdentifier.getKey().getId());
+        final RoutedRpcRegistration<?> rpcRegistration = rpcRegistrations.remove(serviceClass);
+        if (rpcRegistration != null) {
+            rpcRegistration.unregisterPath(NodeContext.class, nodeInstanceIdentifier);
+            rpcRegistration.close();
+            LOG.debug("Un-registration serviceClass {} for Node {}", serviceClass.getSimpleName(), nodeInstanceIdentifier.getKey().getId().getValue());
+        }
+    }
+
+    @VisibleForTesting
+    boolean isEmptyRpcRegistrations() {
+        return this.rpcRegistrations.isEmpty();
+    }
+
+    @Override
+    public void setStatisticsRpcEnabled(boolean isStatisticsRpcEnabled) {
+        this.isStatisticsRpcEnabled = isStatisticsRpcEnabled;
+    }
+
+    @Override
+    public CONTEXT_STATE getState() {
+        return this.state;
+    }
+
+    @Override
+    public ServiceGroupIdentifier getServiceIdentifier() {
+        return this.deviceInfo.getServiceIdentifier();
+    }
+
+    @Override
+    public DeviceInfo getDeviceInfo() {
+        return this.deviceInfo;
+    }
+
+    @Override
+    public ListenableFuture<Void> stopClusterServices() {
+        if (CONTEXT_STATE.TERMINATION.equals(getState())) {
+            return Futures.immediateCancelledFuture();
+        }
+
+        return Futures.transform(Futures.immediateFuture(null), new Function<Object, Void>() {
+            @Nullable
+            @Override
+            public Void apply(@Nullable Object input) {
+                for (final Iterator<Entry<Class<?>, RoutedRpcRegistration<?>>> iterator = Iterators
+                        .consumingIterator(rpcRegistrations.entrySet().iterator()); iterator.hasNext(); ) {
+                    final RoutedRpcRegistration<?> rpcRegistration = iterator.next().getValue();
+                    rpcRegistration.unregisterPath(NodeContext.class, nodeInstanceIdentifier);
+                    rpcRegistration.close();
+
+                    if (LOG.isDebugEnabled()) {
+                        LOG.debug("Closing RPC Registration of service {} for device {}.", rpcRegistration.getServiceType().getSimpleName(),
+                                nodeInstanceIdentifier.getKey().getId().getValue());
+                    }
+                }
+
+                return null;
+            }
+        });
+    }
+
+    @Override
+    public void setLifecycleInitializationPhaseHandler(final ClusterInitializationPhaseHandler handler) {
+        this.clusterInitializationPhaseHandler = handler;
+    }
+
+    @Override
+    public boolean onContextInstantiateService(final ConnectionContext connectionContext) {
+        if (connectionContext.getConnectionState().equals(ConnectionContext.CONNECTION_STATE.RIP)) {
+            LOG.warn("Connection on device {} was interrupted, will stop starting master services.", deviceInfo.getLOGValue());
+            return false;
+        }
+
+        MdSalRegistrationUtils.registerServices(this, deviceContext, extensionConverterProvider, convertorExecutor);
+
+        if (isStatisticsRpcEnabled) {
+            MdSalRegistrationUtils.registerStatCompatibilityServices(
+                    this,
+                    deviceContext,
+                    notificationPublishService,
+                    convertorExecutor);
+        }
+
+        return this.clusterInitializationPhaseHandler.onContextInstantiateService(connectionContext);
     }
 }