2 * Copyright (c) 2014 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.controller.md.sal.dom.broker.impl;
10 import com.google.common.base.Preconditions;
11 import com.google.common.base.Predicate;
12 import com.google.common.collect.ImmutableList;
13 import com.google.common.collect.ImmutableMultimap;
14 import com.google.common.collect.ImmutableMultimap.Builder;
15 import com.google.common.collect.Multimap;
16 import com.google.common.collect.Multimaps;
17 import com.google.common.util.concurrent.Futures;
18 import com.google.common.util.concurrent.ListenableFuture;
19 import com.lmax.disruptor.EventHandler;
20 import com.lmax.disruptor.InsufficientCapacityException;
21 import com.lmax.disruptor.PhasedBackoffWaitStrategy;
22 import com.lmax.disruptor.WaitStrategy;
23 import com.lmax.disruptor.dsl.Disruptor;
24 import com.lmax.disruptor.dsl.ProducerType;
25 import java.util.Arrays;
26 import java.util.Collection;
27 import java.util.List;
29 import java.util.concurrent.ExecutorService;
30 import java.util.concurrent.Executors;
31 import java.util.concurrent.TimeUnit;
32 import org.opendaylight.controller.md.sal.dom.api.DOMNotification;
33 import org.opendaylight.controller.md.sal.dom.api.DOMNotificationListener;
34 import org.opendaylight.controller.md.sal.dom.api.DOMNotificationPublishService;
35 import org.opendaylight.controller.md.sal.dom.api.DOMNotificationService;
36 import org.opendaylight.controller.md.sal.dom.spi.DOMNotificationSubscriptionListener;
37 import org.opendaylight.controller.md.sal.dom.spi.DOMNotificationSubscriptionListenerRegistry;
38 import org.opendaylight.yangtools.concepts.AbstractListenerRegistration;
39 import org.opendaylight.yangtools.concepts.ListenerRegistration;
40 import org.opendaylight.yangtools.util.ListenerRegistry;
41 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
42 import org.slf4j.Logger;
43 import org.slf4j.LoggerFactory;
46 * Joint implementation of {@link DOMNotificationPublishService} and {@link DOMNotificationService}. Provides
47 * routing of notifications from publishers to subscribers.
49 * Internal implementation works by allocating a two-handler Disruptor. The first handler delivers notifications
50 * to subscribed listeners and the second one notifies whoever may be listening on the returned future. Registration
51 * state tracking is performed by a simple immutable multimap -- when a registration or unregistration occurs we
52 * re-generate the entire map from scratch and set it atomically. While registrations/unregistrations synchronize
53 * on this instance, notifications do not take any locks here.
55 * The fully-blocking {@link #publish(long, DOMNotification, Collection)} and non-blocking {@link #offerNotification(DOMNotification)}
56 * are realized using the Disruptor's native operations. The bounded-blocking {@link #offerNotification(DOMNotification, long, TimeUnit)}
57 * is realized by arming a background wakeup interrupt.
59 public final class DOMNotificationRouter implements AutoCloseable, DOMNotificationPublishService,
60 DOMNotificationService, DOMNotificationSubscriptionListenerRegistry {
62 private static final Logger LOG = LoggerFactory.getLogger(DOMNotificationRouter.class);
63 private static final ListenableFuture<Void> NO_LISTENERS = Futures.immediateFuture(null);
64 private static final WaitStrategy DEFAULT_STRATEGY = PhasedBackoffWaitStrategy.withLock(1L, 30L, TimeUnit.MILLISECONDS);
65 private static final EventHandler<DOMNotificationRouterEvent> DISPATCH_NOTIFICATIONS = new EventHandler<DOMNotificationRouterEvent>() {
67 public void onEvent(final DOMNotificationRouterEvent event, final long sequence, final boolean endOfBatch) throws Exception {
68 event.deliverNotification();
72 private static final EventHandler<DOMNotificationRouterEvent> NOTIFY_FUTURE = new EventHandler<DOMNotificationRouterEvent>() {
74 public void onEvent(final DOMNotificationRouterEvent event, final long sequence, final boolean endOfBatch) {
79 private final Disruptor<DOMNotificationRouterEvent> disruptor;
80 private final ExecutorService executor;
81 private volatile Multimap<SchemaPath, ListenerRegistration<? extends DOMNotificationListener>> listeners = ImmutableMultimap.of();
82 private final ListenerRegistry<DOMNotificationSubscriptionListener> subscriptionListeners = ListenerRegistry.create();
84 @SuppressWarnings("unchecked")
85 private DOMNotificationRouter(final ExecutorService executor, final int queueDepth, final WaitStrategy strategy) {
86 this.executor = Preconditions.checkNotNull(executor);
88 disruptor = new Disruptor<>(DOMNotificationRouterEvent.FACTORY, queueDepth, executor, ProducerType.MULTI, strategy);
89 disruptor.handleEventsWith(DISPATCH_NOTIFICATIONS);
90 disruptor.after(DISPATCH_NOTIFICATIONS).handleEventsWith(NOTIFY_FUTURE);
94 public static DOMNotificationRouter create(final int queueDepth) {
95 final ExecutorService executor = Executors.newCachedThreadPool();
97 return new DOMNotificationRouter(executor, queueDepth, DEFAULT_STRATEGY);
100 public static DOMNotificationRouter create(final int queueDepth, final long spinTime, final long parkTime, final TimeUnit unit) {
101 final ExecutorService executor = Executors.newCachedThreadPool();
102 final WaitStrategy strategy = PhasedBackoffWaitStrategy.withLock(spinTime, parkTime, unit);
104 return new DOMNotificationRouter(executor, queueDepth, strategy);
108 public synchronized <T extends DOMNotificationListener> ListenerRegistration<T> registerNotificationListener(final T listener, final Collection<SchemaPath> types) {
109 final ListenerRegistration<T> reg = new AbstractListenerRegistration<T>(listener) {
111 protected void removeRegistration() {
112 final ListenerRegistration<T> me = this;
114 synchronized (DOMNotificationRouter.this) {
115 replaceListeners(ImmutableMultimap.copyOf(Multimaps.filterValues(listeners, new Predicate<ListenerRegistration<? extends DOMNotificationListener>>() {
117 public boolean apply(final ListenerRegistration<? extends DOMNotificationListener> input) {
125 if (!types.isEmpty()) {
126 final Builder<SchemaPath, ListenerRegistration<? extends DOMNotificationListener>> b = ImmutableMultimap.builder();
129 for (final SchemaPath t : types) {
133 replaceListeners(b.build());
140 public <T extends DOMNotificationListener> ListenerRegistration<T> registerNotificationListener(final T listener, final SchemaPath... types) {
141 return registerNotificationListener(listener, Arrays.asList(types));
145 * Swaps registered listeners and triggers notification update
147 * @param newListeners
149 private void replaceListeners(
150 final Multimap<SchemaPath, ListenerRegistration<? extends DOMNotificationListener>> newListeners) {
151 listeners = newListeners;
152 notifyListenerTypesChanged(newListeners.keySet());
155 private void notifyListenerTypesChanged(final Set<SchemaPath> typesAfter) {
156 final List<ListenerRegistration<DOMNotificationSubscriptionListener>> listenersAfter =ImmutableList.copyOf(subscriptionListeners.getListeners());
157 executor.submit(new Runnable() {
161 for (final ListenerRegistration<DOMNotificationSubscriptionListener> subListener : listenersAfter) {
163 subListener.getInstance().onSubscriptionChanged(typesAfter);
164 } catch (final Exception e) {
165 LOG.warn("Uncaught exception during invoking listener {}", subListener.getInstance(), e);
173 public <L extends DOMNotificationSubscriptionListener> ListenerRegistration<L> registerSubscriptionListener(
175 final Set<SchemaPath> initialTypes = listeners.keySet();
176 executor.submit(new Runnable() {
180 listener.onSubscriptionChanged(initialTypes);
183 return subscriptionListeners.registerWithType(listener);
186 private ListenableFuture<Void> publish(final long seq, final DOMNotification notification, final Collection<ListenerRegistration<? extends DOMNotificationListener>> subscribers) {
187 final DOMNotificationRouterEvent event = disruptor.get(seq);
188 final ListenableFuture<Void> future = event.initialize(notification, subscribers);
189 disruptor.getRingBuffer().publish(seq);
194 public ListenableFuture<? extends Object> putNotification(final DOMNotification notification) throws InterruptedException {
195 final Collection<ListenerRegistration<? extends DOMNotificationListener>> subscribers = listeners.get(notification.getType());
196 if (subscribers.isEmpty()) {
200 final long seq = disruptor.getRingBuffer().next();
201 return publish(seq, notification, subscribers);
204 private ListenableFuture<? extends Object> tryPublish(final DOMNotification notification, final Collection<ListenerRegistration<? extends DOMNotificationListener>> subscribers) {
207 seq = disruptor.getRingBuffer().tryNext();
208 } catch (final InsufficientCapacityException e) {
209 return DOMNotificationPublishService.REJECTED;
212 return publish(seq, notification, subscribers);
216 public ListenableFuture<? extends Object> offerNotification(final DOMNotification notification) {
217 final Collection<ListenerRegistration<? extends DOMNotificationListener>> subscribers = listeners.get(notification.getType());
218 if (subscribers.isEmpty()) {
222 return tryPublish(notification, subscribers);
226 public ListenableFuture<? extends Object> offerNotification(final DOMNotification notification, final long timeout,
227 final TimeUnit unit) throws InterruptedException {
228 final Collection<ListenerRegistration<? extends DOMNotificationListener>> subscribers = listeners.get(notification.getType());
229 if (subscribers.isEmpty()) {
233 // Attempt to perform a non-blocking publish first
234 final ListenableFuture<? extends Object> noBlock = tryPublish(notification, subscribers);
235 if (!DOMNotificationPublishService.REJECTED.equals(noBlock)) {
240 * FIXME: we need a background thread, which will watch out for blocking too long. Here
241 * we will arm a tasklet for it and synchronize delivery of interrupt properly.
243 throw new UnsupportedOperationException("Not implemented yet");
247 public void close() {
248 disruptor.shutdown();