Merge "Report (TCP) port number for switches"
[openflowplugin.git] / openflowplugin-impl / src / main / java / org / opendaylight / openflowplugin / impl / rpc / RpcContextImpl.java
index 91feab60f6580be9199c1d9046cb845fde4c3780..f450b96160b137e3b426601d5af3ea5ae4917e53 100644 (file)
@@ -8,22 +8,32 @@
 package org.opendaylight.openflowplugin.impl.rpc;
 
 import com.google.common.annotations.VisibleForTesting;
-import com.google.common.base.Preconditions;
+import com.google.common.base.Function;
 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.Nonnull;
+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.device.DeviceContext;
+import org.opendaylight.openflowplugin.api.openflow.device.DeviceInfo;
 import org.opendaylight.openflowplugin.api.openflow.device.RequestContext;
-import org.opendaylight.openflowplugin.api.openflow.device.XidSequencer;
+import org.opendaylight.openflowplugin.api.openflow.lifecycle.ContextChainMastershipState;
+import org.opendaylight.openflowplugin.api.openflow.lifecycle.MastershipChangeListener;
 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.controller.md.sal.binding.api.NotificationPublishService;
 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;
@@ -31,28 +41,40 @@ 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 MessageSpy messageSpy;
     private final Semaphore tracker;
-    private final XidSequencer xidSequencer;
+    private boolean isStatisticsRpcEnabled;
 
     // TODO: add private Sal salBroker
     private final ConcurrentMap<Class<?>, RoutedRpcRegistration<?>> rpcRegistrations = new ConcurrentHashMap<>();
     private final KeyedInstanceIdentifier<Node, NodeKey> nodeInstanceIdentifier;
-
-    public RpcContextImpl(final RpcProviderRegistry rpcProviderRegistry,
-                          final XidSequencer xidSequencer,
-                          final MessageSpy messageSpy,
-                          final int maxRequests,
-                          final KeyedInstanceIdentifier<Node, NodeKey> nodeInstanceIdentifier) {
-        this.xidSequencer = Preconditions.checkNotNull(xidSequencer);
-        this.messageSpy = Preconditions.checkNotNull(messageSpy);
-        this.rpcProviderRegistry = Preconditions.checkNotNull(rpcProviderRegistry);
-        this.nodeInstanceIdentifier = nodeInstanceIdentifier;
-
-        tracker = new Semaphore(maxRequests, true);
+    private volatile ContextState state = ContextState.INITIALIZATION;
+    private final DeviceInfo deviceInfo;
+    private final DeviceContext deviceContext;
+    private final ExtensionConverterProvider extensionConverterProvider;
+    private final ConvertorExecutor convertorExecutor;
+    private final NotificationPublishService notificationPublishService;
+
+    RpcContextImpl(@Nonnull final RpcProviderRegistry rpcProviderRegistry,
+                   final int maxRequests,
+                   @Nonnull final DeviceContext deviceContext,
+                   @Nonnull final ExtensionConverterProvider extensionConverterProvider,
+                   @Nonnull final ConvertorExecutor convertorExecutor,
+                   @Nonnull final NotificationPublishService notificationPublishService,
+                   boolean statisticsRpcEnabled) {
+        this.deviceContext = deviceContext;
+        this.deviceInfo = deviceContext.getDeviceInfo();
+        this.nodeInstanceIdentifier = deviceContext.getDeviceInfo().getNodeInstanceIdentifier();
+        this.messageSpy = deviceContext.getMessageSpy();
+        this.rpcProviderRegistry = rpcProviderRegistry;
+        this.extensionConverterProvider = extensionConverterProvider;
+        this.notificationPublishService = notificationPublishService;
+        this.convertorExecutor = convertorExecutor;
+        this.isStatisticsRpcEnabled = statisticsRpcEnabled;
+        this.tracker = new Semaphore(maxRequests, true);
     }
 
     /**
@@ -62,12 +84,15 @@ public class RpcContextImpl implements RpcContext {
     @Override
     public <S extends RpcService> void registerRpcServiceImplementation(final Class<S> serviceClass,
                                                                         final S 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, nodeInstanceIdentifier);
+            if (LOG.isDebugEnabled()) {
+                LOG.debug("Registration of service {} for device {}.",
+                        serviceClass.getSimpleName(),
+                        nodeInstanceIdentifier.getKey().getId().getValue());
+            }
         }
     }
 
@@ -85,13 +110,27 @@ public class RpcContextImpl implements RpcContext {
      */
     @Override
     public void close() {
+        if (ContextState.TERMINATION.equals(state)) {
+            if (LOG.isDebugEnabled()) {
+                LOG.debug("RpcContext for node {} is already in TERMINATION state.", getDeviceInfo().getLOGValue());
+            }
+        } else {
+            this.state = ContextState.TERMINATION;
+            unregisterRPCs();
+        }
+    }
+
+    private void unregisterRPCs() {
         for (final Iterator<Entry<Class<?>, RoutedRpcRegistration<?>>> iterator = Iterators
-                .consumingIterator(rpcRegistrations.entrySet().iterator()); iterator.hasNext();) {
+                .consumingIterator(rpcRegistrations.entrySet().iterator()); iterator.hasNext(); ) {
             final RoutedRpcRegistration<?> rpcRegistration = iterator.next().getValue();
             rpcRegistration.unregisterPath(NodeContext.class, nodeInstanceIdentifier);
             rpcRegistration.close();
-            LOG.debug("Closing RPC Registration of service {} for device {}.", rpcRegistration.getServiceType(),
-                    nodeInstanceIdentifier);
+
+            if (LOG.isDebugEnabled()) {
+                LOG.debug("Closing RPC Registration of service {} for device {}.", rpcRegistration.getServiceType().getSimpleName(),
+                        nodeInstanceIdentifier.getKey().getId().getValue());
+            }
         }
     }
 
@@ -101,12 +140,12 @@ public class RpcContextImpl implements RpcContext {
             LOG.trace("Device queue {} at capacity", this);
             return null;
         } else {
-            LOG.trace("Acquired semaphore for {}, available permits:{} ", nodeInstanceIdentifier.getKey().getId(), tracker.availablePermits());
+            LOG.trace("Acquired semaphore for {}, available permits:{} ", nodeInstanceIdentifier.getKey().getId().getValue(), tracker.availablePermits());
         }
 
-        final Long xid = xidSequencer.reserveXidForDeviceMessage();
+        final Long xid = deviceInfo.reserveXidForDeviceMessage();
         if (xid == null) {
-            LOG.warn("Xid cannot be reserved for new RequestContext, node:{}", nodeInstanceIdentifier.getKey().getId());
+            LOG.warn("Xid cannot be reserved for new RequestContext, node:{}", nodeInstanceIdentifier.getKey().getId().getValue());
             tracker.release();
             return null;
         }
@@ -117,7 +156,7 @@ public class RpcContextImpl implements RpcContext {
                 tracker.release();
                 final long xid = getXid().getValue();
                 LOG.trace("Removed request context with xid {}", xid);
-                messageSpy.spyMessage(RpcContextImpl.class, MessageSpy.STATISTIC_GROUP.REQUEST_STACK_FREED);
+                messageSpy.spyMessage(RpcContextImpl.class, MessageSpy.StatisticsGroup.REQUEST_STACK_FREED);
             }
         };
     }
@@ -129,14 +168,55 @@ public class RpcContextImpl implements RpcContext {
         if (rpcRegistration != null) {
             rpcRegistration.unregisterPath(NodeContext.class, nodeInstanceIdentifier);
             rpcRegistration.close();
-            LOG.debug("Unregistration serviceClass {} for Node {}", serviceClass, nodeInstanceIdentifier.getKey().getId());
+            LOG.debug("Un-registration serviceClass {} for Node {}", serviceClass.getSimpleName(), nodeInstanceIdentifier.getKey().getId().getValue());
         }
     }
 
     @VisibleForTesting
-    public boolean isEmptyRpcRegistrations() {
+    boolean isEmptyRpcRegistrations() {
         return this.rpcRegistrations.isEmpty();
     }
 
+    @Override
+    public ServiceGroupIdentifier getServiceIdentifier() {
+        return this.deviceInfo.getServiceIdentifier();
+    }
+
+    @Override
+    public DeviceInfo getDeviceInfo() {
+        return this.deviceInfo;
+    }
+
+    @Override
+    public ListenableFuture<Void> stopClusterServices() {
+        if (ContextState.TERMINATION.equals(this.state)) {
+            return Futures.immediateCancelledFuture();
+        }
+
+        return Futures.transform(Futures.immediateFuture(null), new Function<Object, Void>() {
+            @Nullable
+            @Override
+            public Void apply(@Nullable Object input) {
+                unregisterRPCs();
+                return null;
+            }
+        });
+    }
+
+    @Override
+    public boolean onContextInstantiateService(final MastershipChangeListener mastershipChangeListener) {
+        LOG.info("Starting rpc context cluster services for node {}", deviceInfo.getLOGValue());
+        MdSalRegistrationUtils.registerServices(this, deviceContext, extensionConverterProvider, convertorExecutor);
+
+        if (isStatisticsRpcEnabled && !deviceContext.canUseSingleLayerSerialization()) {
+            MdSalRegistrationUtils.registerStatCompatibilityServices(
+                    this,
+                    deviceContext,
+                    notificationPublishService,
+                    convertorExecutor);
+        }
 
+        mastershipChangeListener.onMasterRoleAcquired(deviceInfo, ContextChainMastershipState.RPC_REGISTRATION);
+        return true;
+    }
 }