2 * Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.openflowplugin.impl.rpc;
10 import com.google.common.annotations.VisibleForTesting;
11 import com.google.common.base.Preconditions;
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.ExecutionException;
20 import java.util.concurrent.Semaphore;
21 import org.opendaylight.controller.md.sal.binding.api.NotificationPublishService;
22 import org.opendaylight.controller.sal.binding.api.BindingAwareBroker.RoutedRpcRegistration;
23 import org.opendaylight.controller.sal.binding.api.RpcProviderRegistry;
24 import org.opendaylight.mdsal.singleton.common.api.ServiceGroupIdentifier;
25 import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
26 import org.opendaylight.openflowplugin.api.openflow.device.DeviceInfo;
27 import org.opendaylight.openflowplugin.api.openflow.device.RequestContext;
28 import org.opendaylight.openflowplugin.api.openflow.rpc.RpcContext;
29 import org.opendaylight.openflowplugin.api.openflow.statistics.ofpspecific.MessageSpy;
30 import org.opendaylight.openflowplugin.extension.api.core.extension.ExtensionConverterProvider;
31 import org.opendaylight.openflowplugin.impl.util.MdSalRegistrationUtils;
32 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.ConvertorExecutor;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeContext;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
36 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
37 import org.opendaylight.yangtools.yang.binding.RpcService;
38 import org.slf4j.Logger;
39 import org.slf4j.LoggerFactory;
41 class RpcContextImpl implements RpcContext {
42 private static final Logger LOG = LoggerFactory.getLogger(RpcContextImpl.class);
43 private final RpcProviderRegistry rpcProviderRegistry;
44 private final MessageSpy messageSpy;
45 private final Semaphore tracker;
46 private boolean isStatisticsRpcEnabled;
48 // TODO: add private Sal salBroker
49 private final ConcurrentMap<Class<?>, RoutedRpcRegistration<?>> rpcRegistrations = new ConcurrentHashMap<>();
50 private final KeyedInstanceIdentifier<Node, NodeKey> nodeInstanceIdentifier;
51 private CONTEXT_STATE state;
52 private final DeviceInfo deviceInfo;
53 private final DeviceContext deviceContext;
54 private final ExtensionConverterProvider extensionConverterProvider;
55 private final ConvertorExecutor convertorExecutor;
56 private final NotificationPublishService notificationPublishService;
58 RpcContextImpl(final DeviceInfo deviceInfo,
59 final RpcProviderRegistry rpcProviderRegistry,
60 final MessageSpy messageSpy,
61 final int maxRequests,
62 final KeyedInstanceIdentifier<Node, NodeKey> nodeInstanceIdentifier,
63 final DeviceContext deviceContext,
64 final ExtensionConverterProvider extensionConverterProvider,
65 final ConvertorExecutor convertorExecutor,
66 final NotificationPublishService notificationPublishService) {
67 this.messageSpy = Preconditions.checkNotNull(messageSpy);
68 this.rpcProviderRegistry = Preconditions.checkNotNull(rpcProviderRegistry);
69 this.nodeInstanceIdentifier = nodeInstanceIdentifier;
71 tracker = new Semaphore(maxRequests, true);
72 this.extensionConverterProvider = extensionConverterProvider;
73 this.notificationPublishService = notificationPublishService;
74 setState(CONTEXT_STATE.WORKING);
75 this.deviceInfo = deviceInfo;
76 this.deviceContext = deviceContext;
77 this.convertorExecutor = convertorExecutor;
81 * @see org.opendaylight.openflowplugin.api.openflow.rpc.RpcContext#registerRpcServiceImplementation(java.lang.Class,
82 * org.opendaylight.yangtools.yang.binding.RpcService)
85 public <S extends RpcService> void registerRpcServiceImplementation(final Class<S> serviceClass,
86 final S serviceInstance) {
87 LOG.trace("Try to register service {} for device {}.", serviceClass, nodeInstanceIdentifier);
88 if (! rpcRegistrations.containsKey(serviceClass)) {
89 final RoutedRpcRegistration<S> routedRpcReg = rpcProviderRegistry.addRoutedRpcImplementation(serviceClass, serviceInstance);
90 routedRpcReg.registerPath(NodeContext.class, nodeInstanceIdentifier);
91 rpcRegistrations.put(serviceClass, routedRpcReg);
92 LOG.debug("Registration of service {} for device {}.", serviceClass.getSimpleName(), nodeInstanceIdentifier.getKey().getId().getValue());
97 public <S extends RpcService> S lookupRpcService(final Class<S> serviceClass) {
98 RoutedRpcRegistration<?> registration = rpcRegistrations.get(serviceClass);
99 final RpcService rpcService = registration.getInstance();
100 return (S) rpcService;
104 * Unregisters all services.
106 * @see java.lang.AutoCloseable#close()
109 public void close() {
110 if (CONTEXT_STATE.TERMINATION.equals(getState())){
111 if (LOG.isDebugEnabled()) {
112 LOG.debug("RpcContext is already in TERMINATION state.");
115 setState(CONTEXT_STATE.TERMINATION);
116 for (final Iterator<Entry<Class<?>, RoutedRpcRegistration<?>>> iterator = Iterators
117 .consumingIterator(rpcRegistrations.entrySet().iterator()); iterator.hasNext(); ) {
118 final RoutedRpcRegistration<?> rpcRegistration = iterator.next().getValue();
119 rpcRegistration.unregisterPath(NodeContext.class, nodeInstanceIdentifier);
120 rpcRegistration.close();
121 if (LOG.isDebugEnabled()) {
122 LOG.debug("Closing RPC Registration of service {} for device {}.", rpcRegistration.getServiceType().getSimpleName(),
123 nodeInstanceIdentifier.getKey().getId().getValue());
130 public <T> RequestContext<T> createRequestContext() {
131 if (!tracker.tryAcquire()) {
132 LOG.trace("Device queue {} at capacity", this);
135 LOG.trace("Acquired semaphore for {}, available permits:{} ", nodeInstanceIdentifier.getKey().getId().getValue(), tracker.availablePermits());
138 final Long xid = deviceInfo.reserveXidForDeviceMessage();
140 LOG.warn("Xid cannot be reserved for new RequestContext, node:{}", nodeInstanceIdentifier.getKey().getId().getValue());
145 return new AbstractRequestContext<T>(xid) {
147 public void close() {
149 final long xid = getXid().getValue();
150 LOG.trace("Removed request context with xid {}", xid);
151 messageSpy.spyMessage(RpcContextImpl.class, MessageSpy.STATISTIC_GROUP.REQUEST_STACK_FREED);
157 public <S extends RpcService> void unregisterRpcServiceImplementation(final Class<S> serviceClass) {
158 LOG.trace("Try to unregister serviceClass {} for Node {}", serviceClass, nodeInstanceIdentifier.getKey().getId());
159 final RoutedRpcRegistration<?> rpcRegistration = rpcRegistrations.remove(serviceClass);
160 if (rpcRegistration != null) {
161 rpcRegistration.unregisterPath(NodeContext.class, nodeInstanceIdentifier);
162 rpcRegistration.close();
163 LOG.debug("Un-registration serviceClass {} for Node {}", serviceClass.getSimpleName(), nodeInstanceIdentifier.getKey().getId().getValue());
168 boolean isEmptyRpcRegistrations() {
169 return this.rpcRegistrations.isEmpty();
173 public void setStatisticsRpcEnabled(boolean isStatisticsRpcEnabled) {
174 this.isStatisticsRpcEnabled = isStatisticsRpcEnabled;
178 public boolean isStatisticsRpcEnabled() {
179 return isStatisticsRpcEnabled;
183 public CONTEXT_STATE getState() {
188 public void setState(CONTEXT_STATE state) {
193 public ServiceGroupIdentifier getServiceIdentifier() {
194 return this.deviceInfo.getServiceIdentifier();
198 public DeviceInfo getDeviceInfo() {
199 return this.deviceInfo;
203 public void startupClusterServices() throws ExecutionException, InterruptedException {
204 MdSalRegistrationUtils.registerServices(this, deviceContext, extensionConverterProvider, convertorExecutor);
205 if (isStatisticsRpcEnabled) {
206 MdSalRegistrationUtils.registerStatCompatibilityServices(
209 notificationPublishService,
216 public ListenableFuture<Void> stopClusterServices(boolean deviceDisconnected) {
217 MdSalRegistrationUtils.unregisterServices(this);
218 return Futures.immediateFuture(null);