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.device.XidSequencer;
29 import org.opendaylight.openflowplugin.api.openflow.rpc.RpcContext;
30 import org.opendaylight.openflowplugin.api.openflow.statistics.ofpspecific.MessageSpy;
31 import org.opendaylight.openflowplugin.extension.api.core.extension.ExtensionConverterProvider;
32 import org.opendaylight.openflowplugin.impl.util.MdSalRegistrationUtils;
33 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.ConvertorExecutor;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeContext;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
37 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
38 import org.opendaylight.yangtools.yang.binding.RpcService;
39 import org.slf4j.Logger;
40 import org.slf4j.LoggerFactory;
42 class RpcContextImpl implements RpcContext {
43 private static final Logger LOG = LoggerFactory.getLogger(RpcContextImpl.class);
44 private final RpcProviderRegistry rpcProviderRegistry;
45 private final MessageSpy messageSpy;
46 private final Semaphore tracker;
47 private boolean isStatisticsRpcEnabled;
49 // TODO: add private Sal salBroker
50 private final ConcurrentMap<Class<?>, RoutedRpcRegistration<?>> rpcRegistrations = new ConcurrentHashMap<>();
51 private final KeyedInstanceIdentifier<Node, NodeKey> nodeInstanceIdentifier;
52 private CONTEXT_STATE state;
53 private final DeviceInfo deviceInfo;
54 private final DeviceContext deviceContext;
55 private final ExtensionConverterProvider extensionConverterProvider;
56 private final ConvertorExecutor convertorExecutor;
57 private final NotificationPublishService notificationPublishService;
59 RpcContextImpl(final DeviceInfo deviceInfo,
60 final RpcProviderRegistry rpcProviderRegistry,
61 final MessageSpy messageSpy,
62 final int maxRequests,
63 final KeyedInstanceIdentifier<Node, NodeKey> nodeInstanceIdentifier,
64 final DeviceContext deviceContext,
65 final ExtensionConverterProvider extensionConverterProvider,
66 final ConvertorExecutor convertorExecutor,
67 final NotificationPublishService notificationPublishService) {
68 this.messageSpy = Preconditions.checkNotNull(messageSpy);
69 this.rpcProviderRegistry = Preconditions.checkNotNull(rpcProviderRegistry);
70 this.nodeInstanceIdentifier = nodeInstanceIdentifier;
72 tracker = new Semaphore(maxRequests, true);
73 this.extensionConverterProvider = extensionConverterProvider;
74 this.notificationPublishService = notificationPublishService;
75 setState(CONTEXT_STATE.WORKING);
76 this.deviceInfo = deviceInfo;
77 this.deviceContext = deviceContext;
78 this.convertorExecutor = convertorExecutor;
82 * @see org.opendaylight.openflowplugin.api.openflow.rpc.RpcContext#registerRpcServiceImplementation(java.lang.Class,
83 * org.opendaylight.yangtools.yang.binding.RpcService)
86 public <S extends RpcService> void registerRpcServiceImplementation(final Class<S> serviceClass,
87 final S serviceInstance) {
88 LOG.trace("Try to register service {} for device {}.", serviceClass, nodeInstanceIdentifier);
89 if (! rpcRegistrations.containsKey(serviceClass)) {
90 final RoutedRpcRegistration<S> routedRpcReg = rpcProviderRegistry.addRoutedRpcImplementation(serviceClass, serviceInstance);
91 routedRpcReg.registerPath(NodeContext.class, nodeInstanceIdentifier);
92 rpcRegistrations.put(serviceClass, routedRpcReg);
93 LOG.debug("Registration of service {} for device {}.", serviceClass, nodeInstanceIdentifier);
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 (S) rpcService;
105 * Unregisters all services.
107 * @see java.lang.AutoCloseable#close()
110 public void close() {
111 if (CONTEXT_STATE.TERMINATION.equals(getState())){
112 if (LOG.isDebugEnabled()) {
113 LOG.debug("RpcContext is already in TERMINATION state.");
116 setState(CONTEXT_STATE.TERMINATION);
117 for (final Iterator<Entry<Class<?>, RoutedRpcRegistration<?>>> iterator = Iterators
118 .consumingIterator(rpcRegistrations.entrySet().iterator()); iterator.hasNext(); ) {
119 final RoutedRpcRegistration<?> rpcRegistration = iterator.next().getValue();
120 rpcRegistration.unregisterPath(NodeContext.class, nodeInstanceIdentifier);
121 rpcRegistration.close();
122 LOG.debug("Closing RPC Registration of service {} for device {}.", rpcRegistration.getServiceType(),
123 nodeInstanceIdentifier);
129 public <T> RequestContext<T> createRequestContext() {
130 if (!tracker.tryAcquire()) {
131 LOG.trace("Device queue {} at capacity", this);
134 LOG.trace("Acquired semaphore for {}, available permits:{} ", nodeInstanceIdentifier.getKey().getId(), tracker.availablePermits());
137 final Long xid = deviceInfo.reserveXidForDeviceMessage();
139 LOG.warn("Xid cannot be reserved for new RequestContext, node:{}", nodeInstanceIdentifier.getKey().getId());
144 return new AbstractRequestContext<T>(xid) {
146 public void close() {
148 final long xid = getXid().getValue();
149 LOG.trace("Removed request context with xid {}", xid);
150 messageSpy.spyMessage(RpcContextImpl.class, MessageSpy.STATISTIC_GROUP.REQUEST_STACK_FREED);
156 public <S extends RpcService> void unregisterRpcServiceImplementation(final Class<S> serviceClass) {
157 LOG.trace("Try to unregister serviceClass {} for Node {}", serviceClass, nodeInstanceIdentifier.getKey().getId());
158 final RoutedRpcRegistration<?> rpcRegistration = rpcRegistrations.remove(serviceClass);
159 if (rpcRegistration != null) {
160 rpcRegistration.unregisterPath(NodeContext.class, nodeInstanceIdentifier);
161 rpcRegistration.close();
162 LOG.debug("Unregistration serviceClass {} for Node {}", serviceClass, nodeInstanceIdentifier.getKey().getId());
167 boolean isEmptyRpcRegistrations() {
168 return this.rpcRegistrations.isEmpty();
172 public void setStatisticsRpcEnabled(boolean isStatisticsRpcEnabled) {
173 this.isStatisticsRpcEnabled = isStatisticsRpcEnabled;
177 public boolean isStatisticsRpcEnabled() {
178 return isStatisticsRpcEnabled;
182 public CONTEXT_STATE getState() {
187 public void setState(CONTEXT_STATE state) {
192 public ServiceGroupIdentifier getServiceIdentifier() {
193 return this.deviceInfo.getServiceIdentifier();
197 public DeviceInfo getDeviceInfo() {
198 return this.deviceInfo;
202 public void startupClusterServices() throws ExecutionException, InterruptedException {
203 MdSalRegistrationUtils.registerServices(this, deviceContext, extensionConverterProvider, convertorExecutor);
204 if (isStatisticsRpcEnabled) {
205 MdSalRegistrationUtils.registerStatCompatibilityServices(
208 notificationPublishService,
215 public ListenableFuture<Void> stopClusterServices() {
216 MdSalRegistrationUtils.unregisterServices(this);
217 return Futures.immediateFuture(null);