dom/mdsal-dom-broker/src/main/java/org/opendaylight/mdsal/dom/broker/DOMRpcRouter.java

   1 /*
   2  * Copyright (c) 2015 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   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
   7  */
   8 package org.opendaylight.mdsal.dom.broker;
   9
  10 import static com.google.common.base.Preconditions.checkArgument;
  11 import static com.google.common.base.Verify.verifyNotNull;
  12 import static java.util.Objects.requireNonNull;
  13
  14 import com.google.common.annotations.VisibleForTesting;
  15 import com.google.common.collect.Collections2;
  16 import com.google.common.collect.ImmutableList;
  17 import com.google.common.collect.ImmutableSet;
  18 import com.google.common.collect.ImmutableTable;
  19 import com.google.common.collect.MapDifference;
  20 import com.google.common.collect.MapDifference.ValueDifference;
  21 import com.google.common.collect.Maps;
  22 import com.google.common.collect.Sets;
  23 import com.google.common.util.concurrent.Futures;
  24 import com.google.common.util.concurrent.ListenableFuture;
  25 import com.google.common.util.concurrent.ThreadFactoryBuilder;
  26 import java.util.ArrayList;
  27 import java.util.Collection;
  28 import java.util.HashSet;
  29 import java.util.List;
  30 import java.util.Map;
  31 import java.util.Map.Entry;
  32 import java.util.Set;
  33 import java.util.concurrent.ExecutorService;
  34 import java.util.concurrent.Executors;
  35 import java.util.concurrent.ThreadFactory;
  36 import javax.annotation.PreDestroy;
  37 import javax.inject.Inject;
  38 import javax.inject.Singleton;
  39 import org.checkerframework.checker.lock.qual.GuardedBy;
  40 import org.eclipse.jdt.annotation.NonNull;
  41 import org.eclipse.jdt.annotation.NonNullByDefault;
  42 import org.opendaylight.mdsal.dom.api.DOMActionAvailabilityExtension;
  43 import org.opendaylight.mdsal.dom.api.DOMActionAvailabilityExtension.AvailabilityListener;
  44 import org.opendaylight.mdsal.dom.api.DOMActionImplementation;
  45 import org.opendaylight.mdsal.dom.api.DOMActionInstance;
  46 import org.opendaylight.mdsal.dom.api.DOMActionNotAvailableException;
  47 import org.opendaylight.mdsal.dom.api.DOMActionProviderService;
  48 import org.opendaylight.mdsal.dom.api.DOMActionResult;
  49 import org.opendaylight.mdsal.dom.api.DOMActionService;
  50 import org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier;
  51 import org.opendaylight.mdsal.dom.api.DOMRpcAvailabilityListener;
  52 import org.opendaylight.mdsal.dom.api.DOMRpcIdentifier;
  53 import org.opendaylight.mdsal.dom.api.DOMRpcImplementation;
  54 import org.opendaylight.mdsal.dom.api.DOMRpcImplementationNotAvailableException;
  55 import org.opendaylight.mdsal.dom.api.DOMRpcProviderService;
  56 import org.opendaylight.mdsal.dom.api.DOMRpcResult;
  57 import org.opendaylight.mdsal.dom.api.DOMRpcService;
  58 import org.opendaylight.mdsal.dom.api.DOMSchemaService;
  59 import org.opendaylight.yangtools.concepts.AbstractRegistration;
  60 import org.opendaylight.yangtools.concepts.Registration;
  61 import org.opendaylight.yangtools.yang.common.QName;
  62 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  63 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  64 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
  65 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Absolute;
  66 import org.osgi.service.component.annotations.Activate;
  67 import org.osgi.service.component.annotations.Component;
  68 import org.osgi.service.component.annotations.Deactivate;
  69 import org.osgi.service.component.annotations.Reference;
  70 import org.slf4j.Logger;
  71 import org.slf4j.LoggerFactory;
  72
  73 @Singleton
  74 @Component(service = DOMRpcRouter.class)
  75 public final class DOMRpcRouter extends AbstractRegistration {
  76     private static final Logger LOG = LoggerFactory.getLogger(DOMRpcRouter.class);
  77     private static final ThreadFactory THREAD_FACTORY = new ThreadFactoryBuilder().setNameFormat(
  78             "DOMRpcRouter-listener-%s").setDaemon(true).build();
  79
  80     private final ExecutorService listenerNotifier = Executors.newSingleThreadExecutor(THREAD_FACTORY);
  81     private final @NonNull DOMActionProviderService actionProviderService = new ActionProviderServiceFacade();
  82     private final @NonNull DOMActionService actionService = new ActionServiceFacade();
  83     private final @NonNull DOMRpcProviderService rpcProviderService = new RpcProviderServiceFacade();
  84     private final @NonNull DOMRpcService rpcService = new RpcServiceFacade();
  85
  86     @GuardedBy("this")
  87     private ImmutableList<RpcAvailReg> listeners = ImmutableList.of();
  88
  89     @GuardedBy("this")
  90     private ImmutableList<ActionAvailReg> actionListeners = ImmutableList.of();
  91
  92     private volatile DOMRpcRoutingTable routingTable = DOMRpcRoutingTable.EMPTY;
  93
  94     private volatile DOMActionRoutingTable actionRoutingTable = DOMActionRoutingTable.EMPTY;
  95
  96     private Registration listenerRegistration;
  97
  98     @Deprecated
  99     @VisibleForTesting
 100     // FIXME: 9.0.0: make this constructor package-private
 101     public DOMRpcRouter() {
 102
 103     }
 104
 105     @Inject
 106     @Activate
 107     public DOMRpcRouter(@Reference final DOMSchemaService schemaService) {
 108         listenerRegistration = schemaService.registerSchemaContextListener(this::onModelContextUpdated);
 109         LOG.info("DOM RPC/Action router started");
 110     }
 111
 112     @Deprecated(forRemoval = true)
 113     public static DOMRpcRouter newInstance(final DOMSchemaService schemaService) {
 114         return new DOMRpcRouter(schemaService);
 115     }
 116
 117     @PreDestroy
 118     @Deactivate
 119     public void shutdown() {
 120         close();
 121     }
 122
 123     public @NonNull DOMActionService actionService() {
 124         return actionService;
 125     }
 126
 127     public @NonNull DOMActionProviderService actionProviderService() {
 128         return actionProviderService;
 129     }
 130
 131     public @NonNull DOMRpcService rpcService() {
 132         return rpcService;
 133     }
 134
 135     public @NonNull DOMRpcProviderService rpcProviderService() {
 136         return rpcProviderService;
 137     }
 138
 139     private synchronized void removeRpcImplementation(final DOMRpcImplementation implementation,
 140             final Set<DOMRpcIdentifier> rpcs) {
 141         final DOMRpcRoutingTable oldTable = routingTable;
 142         final DOMRpcRoutingTable newTable = (DOMRpcRoutingTable) oldTable.remove(implementation, rpcs);
 143         routingTable = newTable;
 144
 145         listenerNotifier.execute(() -> notifyRemoved(newTable, implementation));
 146     }
 147
 148     private synchronized void removeRpcImplementations(
 149             final ImmutableTable<QName, YangInstanceIdentifier, DOMRpcImplementation> implTable) {
 150         final DOMRpcRoutingTable oldTable = routingTable;
 151         final DOMRpcRoutingTable newTable = (DOMRpcRoutingTable) oldTable.removeAll(implTable);
 152         routingTable = newTable;
 153
 154         listenerNotifier.execute(() -> notifyRemoved(newTable, implTable.values()));
 155     }
 156
 157     private synchronized void removeActionImplementation(final DOMActionImplementation implementation,
 158             final Set<DOMActionInstance> actions) {
 159         final DOMActionRoutingTable oldTable = actionRoutingTable;
 160         final DOMActionRoutingTable newTable = (DOMActionRoutingTable) oldTable.remove(implementation, actions);
 161         actionRoutingTable = newTable;
 162
 163         listenerNotifier.execute(() -> notifyActionChanged(newTable, implementation));
 164     }
 165
 166     private synchronized void removeListener(final RpcAvailReg reg) {
 167         listeners = ImmutableList.copyOf(Collections2.filter(listeners, input -> !reg.equals(input)));
 168     }
 169
 170     private synchronized void removeActionListener(final ActionAvailReg reg) {
 171         actionListeners = ImmutableList.copyOf(Collections2.filter(actionListeners, input -> !reg.equals(input)));
 172     }
 173
 174     private synchronized void notifyAdded(final DOMRpcRoutingTable newTable, final DOMRpcImplementation impl) {
 175         for (var l : listeners) {
 176             l.addRpc(newTable, impl);
 177         }
 178     }
 179
 180     private synchronized void notifyAdded(final DOMRpcRoutingTable newTable,
 181             final Collection<? extends DOMRpcImplementation> impls) {
 182         for (var l : listeners) {
 183             for (var impl : impls) {
 184                 l.addRpc(newTable, impl);
 185             }
 186         }
 187     }
 188
 189     private synchronized void notifyRemoved(final DOMRpcRoutingTable newTable, final DOMRpcImplementation impl) {
 190         for (var l : listeners) {
 191             l.removeRpc(newTable, impl);
 192         }
 193     }
 194
 195     private synchronized void notifyRemoved(final DOMRpcRoutingTable newTable,
 196             final Collection<? extends DOMRpcImplementation> impls) {
 197         for (var l : listeners) {
 198             for (DOMRpcImplementation impl : impls) {
 199                 l.removeRpc(newTable, impl);
 200             }
 201         }
 202     }
 203
 204     private synchronized void notifyActionChanged(final DOMActionRoutingTable newTable,
 205             final DOMActionImplementation impl) {
 206         for (var l : actionListeners) {
 207             l.actionChanged(newTable, impl);
 208         }
 209     }
 210
 211
 212     synchronized void onModelContextUpdated(final @NonNull EffectiveModelContext newModelContext) {
 213         final DOMRpcRoutingTable oldTable = routingTable;
 214         final DOMRpcRoutingTable newTable = (DOMRpcRoutingTable) oldTable.setSchemaContext(newModelContext);
 215         routingTable = newTable;
 216
 217         final DOMActionRoutingTable oldActionTable = actionRoutingTable;
 218         final DOMActionRoutingTable newActionTable =
 219                 (DOMActionRoutingTable) oldActionTable.setSchemaContext(newModelContext);
 220         actionRoutingTable = newActionTable;
 221     }
 222
 223     @Override
 224     protected void removeRegistration() {
 225         if (listenerRegistration != null) {
 226             listenerRegistration.close();
 227             listenerRegistration = null;
 228         }
 229         listenerNotifier.shutdown();
 230         LOG.info("DOM RPC/Action router stopped");
 231     }
 232
 233     @VisibleForTesting
 234     synchronized List<?> listeners() {
 235         return listeners;
 236     }
 237
 238     @VisibleForTesting
 239     synchronized List<?> actionListeners() {
 240         return actionListeners;
 241     }
 242
 243     @VisibleForTesting
 244     DOMRpcRoutingTable routingTable() {
 245         return routingTable;
 246     }
 247
 248     private static final class RpcAvailReg extends AbstractRegistration {
 249         private final DOMRpcAvailabilityListener listener;
 250
 251         private Map<QName, Set<YangInstanceIdentifier>> prevRpcs;
 252         private DOMRpcRouter router;
 253
 254         RpcAvailReg(final DOMRpcRouter router, final DOMRpcAvailabilityListener listener,
 255                 final Map<QName, Set<YangInstanceIdentifier>> rpcs) {
 256             this.listener = requireNonNull(listener);
 257             this.router = requireNonNull(router);
 258             prevRpcs = requireNonNull(rpcs);
 259         }
 260
 261         @Override
 262         protected void removeRegistration() {
 263             router.removeListener(this);
 264             router = null;
 265         }
 266
 267         void initialTable() {
 268             final List<DOMRpcIdentifier> added = new ArrayList<>();
 269             for (Entry<QName, Set<YangInstanceIdentifier>> e : prevRpcs.entrySet()) {
 270                 added.addAll(Collections2.transform(e.getValue(), i -> DOMRpcIdentifier.create(e.getKey(), i)));
 271             }
 272             if (!added.isEmpty()) {
 273                 listener.onRpcAvailable(added);
 274             }
 275         }
 276
 277         void addRpc(final DOMRpcRoutingTable newTable, final DOMRpcImplementation impl) {
 278             if (!listener.acceptsImplementation(impl)) {
 279                 return;
 280             }
 281
 282             final Map<QName, Set<YangInstanceIdentifier>> rpcs = verifyNotNull(newTable.getOperations(listener));
 283             final MapDifference<QName, Set<YangInstanceIdentifier>> diff = Maps.difference(prevRpcs, rpcs);
 284
 285             final List<DOMRpcIdentifier> added = new ArrayList<>();
 286             for (Entry<QName, Set<YangInstanceIdentifier>> e : diff.entriesOnlyOnRight().entrySet()) {
 287                 added.addAll(Collections2.transform(e.getValue(), i -> DOMRpcIdentifier.create(e.getKey(), i)));
 288             }
 289             for (Entry<QName, ValueDifference<Set<YangInstanceIdentifier>>> e : diff.entriesDiffering().entrySet()) {
 290                 for (YangInstanceIdentifier i : Sets.difference(e.getValue().rightValue(), e.getValue().leftValue())) {
 291                     added.add(DOMRpcIdentifier.create(e.getKey(), i));
 292                 }
 293             }
 294
 295             prevRpcs = rpcs;
 296             if (!added.isEmpty()) {
 297                 listener.onRpcAvailable(added);
 298             }
 299         }
 300
 301         void removeRpc(final DOMRpcRoutingTable newTable, final DOMRpcImplementation impl) {
 302             if (!listener.acceptsImplementation(impl)) {
 303                 return;
 304             }
 305
 306             final Map<QName, Set<YangInstanceIdentifier>> rpcs = verifyNotNull(newTable.getOperations(listener));
 307             final MapDifference<QName, Set<YangInstanceIdentifier>> diff = Maps.difference(prevRpcs, rpcs);
 308
 309             final List<DOMRpcIdentifier> removed = new ArrayList<>();
 310             for (Entry<QName, Set<YangInstanceIdentifier>> e : diff.entriesOnlyOnLeft().entrySet()) {
 311                 removed.addAll(Collections2.transform(e.getValue(), i -> DOMRpcIdentifier.create(e.getKey(), i)));
 312             }
 313             for (Entry<QName, ValueDifference<Set<YangInstanceIdentifier>>> e : diff.entriesDiffering().entrySet()) {
 314                 for (YangInstanceIdentifier i : Sets.difference(e.getValue().leftValue(), e.getValue().rightValue())) {
 315                     removed.add(DOMRpcIdentifier.create(e.getKey(), i));
 316                 }
 317             }
 318
 319             prevRpcs = rpcs;
 320             if (!removed.isEmpty()) {
 321                 listener.onRpcUnavailable(removed);
 322             }
 323         }
 324     }
 325
 326     private static final class ActionAvailReg extends AbstractRegistration {
 327         private final AvailabilityListener listener;
 328
 329         private Map<Absolute, Set<DOMDataTreeIdentifier>> prevActions;
 330         private DOMRpcRouter router;
 331
 332         ActionAvailReg(final DOMRpcRouter router, final AvailabilityListener listener,
 333                 final Map<Absolute, Set<DOMDataTreeIdentifier>> actions) {
 334             this.listener = requireNonNull(listener);
 335             this.router = requireNonNull(router);
 336             prevActions = requireNonNull(actions);
 337         }
 338
 339         @Override
 340         protected void removeRegistration() {
 341             router.removeActionListener(this);
 342             router = null;
 343         }
 344
 345         void initialTable() {
 346             final var added = new ArrayList<DOMActionInstance>();
 347             for (var e : prevActions.entrySet()) {
 348                 added.addAll(Collections2.transform(e.getValue(), i -> DOMActionInstance.of(e.getKey(), i)));
 349             }
 350             if (!added.isEmpty()) {
 351                 listener.onActionsChanged(ImmutableSet.of(), ImmutableSet.copyOf(added));
 352             }
 353         }
 354
 355         void actionChanged(final DOMActionRoutingTable newTable, final DOMActionImplementation impl) {
 356             if (!listener.acceptsImplementation(impl)) {
 357                 return;
 358             }
 359
 360             final Map<Absolute, Set<DOMDataTreeIdentifier>> actions = verifyNotNull(newTable.getOperations(listener));
 361             final MapDifference<Absolute, Set<DOMDataTreeIdentifier>> diff = Maps.difference(prevActions, actions);
 362
 363             final Set<DOMActionInstance> removed = new HashSet<>();
 364             final Set<DOMActionInstance> added = new HashSet<>();
 365
 366             for (Entry<Absolute, Set<DOMDataTreeIdentifier>> e : diff.entriesOnlyOnLeft().entrySet()) {
 367                 removed.addAll(Collections2.transform(e.getValue(), i -> DOMActionInstance.of(e.getKey(), i)));
 368             }
 369
 370             for (Entry<Absolute, Set<DOMDataTreeIdentifier>> e : diff.entriesOnlyOnRight().entrySet()) {
 371                 added.addAll(Collections2.transform(e.getValue(), i -> DOMActionInstance.of(e.getKey(), i)));
 372             }
 373
 374             for (Entry<Absolute, ValueDifference<Set<DOMDataTreeIdentifier>>> e : diff.entriesDiffering().entrySet()) {
 375                 for (DOMDataTreeIdentifier i : Sets.difference(e.getValue().leftValue(), e.getValue().rightValue())) {
 376                     removed.add(DOMActionInstance.of(e.getKey(), i));
 377                 }
 378
 379                 for (DOMDataTreeIdentifier i : Sets.difference(e.getValue().rightValue(), e.getValue().leftValue())) {
 380                     added.add(DOMActionInstance.of(e.getKey(), i));
 381                 }
 382             }
 383
 384             prevActions = actions;
 385             if (!removed.isEmpty() || !added.isEmpty()) {
 386                 listener.onActionsChanged(removed, added);
 387             }
 388         }
 389     }
 390
 391     @NonNullByDefault
 392     private final class ActionServiceFacade implements DOMActionService, DOMActionAvailabilityExtension {
 393         @Override
 394         public List<Extension> supportedExtensions() {
 395             return List.of(this);
 396         }
 397
 398         @Override
 399         public ListenableFuture<? extends DOMActionResult> invokeAction(final Absolute type,
 400                 final DOMDataTreeIdentifier path, final ContainerNode input) {
 401             final YangInstanceIdentifier pathRoot = path.path();
 402             checkArgument(!pathRoot.isEmpty(), "Action path must not be empty");
 403
 404             final DOMActionRoutingTableEntry entry = (DOMActionRoutingTableEntry) actionRoutingTable.getEntry(type);
 405             return entry != null ? OperationInvocation.invoke(entry, type, path, requireNonNull(input))
 406                 : Futures.immediateFailedFuture(
 407                     new DOMActionNotAvailableException("No implementation of Action %s available", type));
 408         }
 409
 410         @Override
 411         public Registration registerAvailabilityListener(final AvailabilityListener listener) {
 412             synchronized (DOMRpcRouter.this) {
 413                 final var ret = new ActionAvailReg(DOMRpcRouter.this, listener,
 414                     actionRoutingTable.getOperations(listener));
 415                 actionListeners = ImmutableList.<ActionAvailReg>builder()
 416                     .addAll(actionListeners)
 417                     .add(ret)
 418                     .build();
 419
 420                 listenerNotifier.execute(ret::initialTable);
 421                 return ret;
 422             }
 423         }
 424     }
 425
 426     @NonNullByDefault
 427     private final class ActionProviderServiceFacade implements DOMActionProviderService {
 428         @Override
 429         public Registration registerActionImplementation(final DOMActionImplementation implementation,
 430                 final Set<DOMActionInstance> instances) {
 431             checkArgument(!instances.isEmpty(), "Instances must not be empty");
 432
 433             synchronized (DOMRpcRouter.this) {
 434                 final DOMActionRoutingTable oldTable = actionRoutingTable;
 435                 final DOMActionRoutingTable newTable = (DOMActionRoutingTable) oldTable.add(implementation, instances);
 436                 actionRoutingTable = newTable;
 437
 438                 listenerNotifier.execute(() -> notifyActionChanged(newTable, implementation));
 439             }
 440
 441             return new AbstractRegistration() {
 442                 @Override
 443                 protected void removeRegistration() {
 444                     removeActionImplementation(implementation, instances);
 445                 }
 446             };
 447         }
 448     }
 449
 450     private final class RpcServiceFacade implements DOMRpcService {
 451         @Override
 452         public ListenableFuture<? extends DOMRpcResult> invokeRpc(final QName type, final ContainerNode input) {
 453             final var entry = (AbstractDOMRpcRoutingTableEntry) routingTable.getEntry(type);
 454             if (entry == null) {
 455                 return Futures.immediateFailedFuture(
 456                     new DOMRpcImplementationNotAvailableException("No implementation of RPC %s available", type));
 457             }
 458
 459             return OperationInvocation.invoke(entry, requireNonNull(input));
 460         }
 461
 462         @Override
 463         public Registration registerRpcListener(final DOMRpcAvailabilityListener listener) {
 464             synchronized (DOMRpcRouter.this) {
 465                 final var ret = new RpcAvailReg(DOMRpcRouter.this, listener, routingTable.getOperations(listener));
 466                 listeners = ImmutableList.<RpcAvailReg>builder().addAll(listeners).add(ret).build();
 467
 468                 listenerNotifier.execute(ret::initialTable);
 469                 return ret;
 470             }
 471         }
 472     }
 473
 474     private final class RpcProviderServiceFacade implements DOMRpcProviderService {
 475         @Override
 476         public Registration registerRpcImplementation(final DOMRpcImplementation implementation,
 477                 final Set<DOMRpcIdentifier> rpcs) {
 478
 479             synchronized (DOMRpcRouter.this) {
 480                 final DOMRpcRoutingTable oldTable = routingTable;
 481                 final DOMRpcRoutingTable newTable = (DOMRpcRoutingTable) oldTable.add(implementation, rpcs);
 482                 routingTable = newTable;
 483
 484                 listenerNotifier.execute(() -> notifyAdded(newTable, implementation));
 485             }
 486
 487             return new AbstractRegistration() {
 488                 @Override
 489                 protected void removeRegistration() {
 490                     removeRpcImplementation(implementation, rpcs);
 491                 }
 492             };
 493         }
 494
 495         @Override
 496         public Registration registerRpcImplementations(final Map<DOMRpcIdentifier, DOMRpcImplementation> map) {
 497             checkArgument(!map.isEmpty());
 498
 499             final var builder = ImmutableTable.<QName, YangInstanceIdentifier, DOMRpcImplementation>builder();
 500             for (var entry : map.entrySet()) {
 501                 final var id = entry.getKey();
 502                 builder.put(id.getType(), id.getContextReference(), entry.getValue());
 503             }
 504             final var implTable = builder.build();
 505
 506             synchronized (DOMRpcRouter.this) {
 507                 final DOMRpcRoutingTable oldTable = routingTable;
 508                 final DOMRpcRoutingTable newTable = (DOMRpcRoutingTable) oldTable.addAll(implTable);
 509                 routingTable = newTable;
 510
 511                 listenerNotifier.execute(() -> notifyAdded(newTable, implTable.values()));
 512             }
 513
 514             return new AbstractRegistration() {
 515                 @Override
 516                 protected void removeRegistration() {
 517                     removeRpcImplementations(implTable);
 518                 }
 519             };
 520         }
 521     }
 522 }