binding/mdsal-binding-dom-adapter/src/main/java/org/opendaylight/mdsal/binding/dom/adapter/CurrentAdapterSerializer.java

   1 /*
   2  * Copyright (c) 2020 PANTHEON.tech, s.r.o. 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.binding.dom.adapter;
   9
  10 import static com.google.common.base.Verify.verify;
  11 import static com.google.common.base.Verify.verifyNotNull;
  12 import static java.util.Objects.requireNonNull;
  13
  14 import com.google.common.annotations.Beta;
  15 import com.google.common.annotations.VisibleForTesting;
  16 import com.google.common.cache.CacheBuilder;
  17 import com.google.common.cache.CacheLoader;
  18 import com.google.common.cache.LoadingCache;
  19 import com.google.common.collect.ImmutableBiMap;
  20 import com.google.common.collect.ImmutableMap;
  21 import com.google.common.collect.Maps;
  22 import com.google.common.util.concurrent.ListenableFuture;
  23 import java.lang.invoke.MethodHandle;
  24 import java.lang.invoke.MethodHandles;
  25 import java.lang.invoke.MethodType;
  26 import java.lang.reflect.Method;
  27 import java.util.Collection;
  28 import java.util.Map;
  29 import java.util.Map.Entry;
  30 import java.util.concurrent.ConcurrentHashMap;
  31 import java.util.concurrent.ConcurrentMap;
  32 import java.util.stream.Collectors;
  33 import org.eclipse.jdt.annotation.NonNull;
  34 import org.eclipse.jdt.annotation.Nullable;
  35 import org.opendaylight.mdsal.binding.api.ActionSpec;
  36 import org.opendaylight.mdsal.binding.api.DataTreeIdentifier;
  37 import org.opendaylight.mdsal.binding.api.InstanceNotificationSpec;
  38 import org.opendaylight.mdsal.binding.dom.codec.spi.BindingDOMCodecServices;
  39 import org.opendaylight.mdsal.binding.dom.codec.spi.ForwardingBindingDOMCodecServices;
  40 import org.opendaylight.mdsal.binding.model.api.JavaTypeName;
  41 import org.opendaylight.mdsal.binding.runtime.api.InputRuntimeType;
  42 import org.opendaylight.mdsal.binding.spec.naming.BindingMapping;
  43 import org.opendaylight.mdsal.binding.spec.reflect.BindingReflections;
  44 import org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier;
  45 import org.opendaylight.yangtools.yang.binding.DataObject;
  46 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  47 import org.opendaylight.yangtools.yang.binding.RpcService;
  48 import org.opendaylight.yangtools.yang.common.QName;
  49 import org.opendaylight.yangtools.yang.common.QNameModule;
  50 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  51 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.AugmentationIdentifier;
  52 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  53 import org.opendaylight.yangtools.yang.model.api.stmt.ActionEffectiveStatement;
  54 import org.opendaylight.yangtools.yang.model.api.stmt.ListEffectiveStatement;
  55 import org.opendaylight.yangtools.yang.model.api.stmt.NotificationEffectiveStatement;
  56 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Absolute;
  57 import org.opendaylight.yangtools.yang.model.util.SchemaInferenceStack;
  58 import org.slf4j.Logger;
  59 import org.slf4j.LoggerFactory;
  60
  61 @Beta
  62 @VisibleForTesting
  63 public final class CurrentAdapterSerializer extends ForwardingBindingDOMCodecServices {
  64     private static final Logger LOG = LoggerFactory.getLogger(CurrentAdapterSerializer.class);
  65     private static final MethodType RPC_SERVICE_METHOD_SIGNATURE = MethodType.methodType(ListenableFuture.class,
  66         RpcService.class, DataObject.class);
  67
  68     private final LoadingCache<InstanceIdentifier<?>, YangInstanceIdentifier> cache = CacheBuilder.newBuilder()
  69             .softValues().build(new CacheLoader<InstanceIdentifier<?>, YangInstanceIdentifier>() {
  70                 @Override
  71                 public YangInstanceIdentifier load(final InstanceIdentifier<?> key) {
  72                     return toYangInstanceIdentifier(key);
  73                 }
  74             });
  75
  76     private final ConcurrentMap<JavaTypeName, ContextReferenceExtractor> extractors = new ConcurrentHashMap<>();
  77     @Deprecated
  78     private final ConcurrentMap<Class<? extends RpcService>, ImmutableMap<QName, MethodHandle>> rpcMethods =
  79         new ConcurrentHashMap<>();
  80     private final @NonNull BindingDOMCodecServices delegate;
  81
  82     public CurrentAdapterSerializer(final BindingDOMCodecServices delegate) {
  83         this.delegate = requireNonNull(delegate);
  84     }
  85
  86     @Override
  87     protected BindingDOMCodecServices delegate() {
  88         return delegate;
  89     }
  90
  91     @NonNull YangInstanceIdentifier toCachedYangInstanceIdentifier(final @NonNull InstanceIdentifier<?> path) {
  92         return cache.getUnchecked(path);
  93     }
  94
  95     <T extends DataObject> @NonNull InstanceIdentifier<T> coerceInstanceIdentifier(final YangInstanceIdentifier dom) {
  96         return verifyNotNull(fromYangInstanceIdentifier(dom));
  97     }
  98
  99     DOMDataTreeIdentifier toDOMDataTreeIdentifier(final DataTreeIdentifier<?> path) {
 100         return new DOMDataTreeIdentifier(path.getDatastoreType(), toYangInstanceIdentifier(path.getRootIdentifier()));
 101     }
 102
 103     Collection<DOMDataTreeIdentifier> toDOMDataTreeIdentifiers(final Collection<DataTreeIdentifier<?>> subtrees) {
 104         return subtrees.stream().map(this::toDOMDataTreeIdentifier).collect(Collectors.toSet());
 105     }
 106
 107     @NonNull Absolute getActionPath(final @NonNull ActionSpec<?, ?> spec) {
 108         final var entry = resolvePath(spec.path());
 109         final var stack = entry.getKey();
 110         final var stmt = stack.enterSchemaTree(BindingReflections.findQName(spec.type()).bindTo(entry.getValue()));
 111         verify(stmt instanceof ActionEffectiveStatement, "Action %s resolved to unexpected statement %s", spec, stmt);
 112         return stack.toSchemaNodeIdentifier();
 113     }
 114
 115     @NonNull Absolute getNotificationPath(final @NonNull InstanceNotificationSpec<?, ?> spec) {
 116         final var entry = resolvePath(spec.path());
 117         final var stack = entry.getKey();
 118         final var stmt = stack.enterSchemaTree(BindingReflections.findQName(spec.type()).bindTo(entry.getValue()));
 119         verify(stmt instanceof NotificationEffectiveStatement, "Notification %s resolved to unexpected statement %s",
 120             spec, stmt);
 121         return stack.toSchemaNodeIdentifier();
 122     }
 123
 124     @Nullable ContextReferenceExtractor findExtractor(final @NonNull InputRuntimeType inputType) {
 125         final var inputName = inputType.getIdentifier();
 126         final var cached = extractors.get(inputName);
 127         if (cached != null) {
 128             return cached;
 129         }
 130
 131         // Load the class
 132         final Class<?> inputClass;
 133         try {
 134             inputClass = getRuntimeContext().loadClass(inputName);
 135         } catch (ClassNotFoundException e) {
 136             throw new IllegalArgumentException("Failed to load class for " + inputType, e);
 137         }
 138
 139         // Check if there is an extractor at all
 140         final var created = ContextReferenceExtractor.of(inputClass);
 141         if (created == null) {
 142             return null;
 143         }
 144
 145         // Reconcile with cache
 146         final var raced = extractors.putIfAbsent(inputName, created);
 147         return raced != null ? raced : created;
 148     }
 149
 150     @Deprecated
 151     @NonNull ImmutableMap<QName, MethodHandle> getRpcMethods(final @NonNull Class<? extends RpcService> serviceType) {
 152         return rpcMethods.computeIfAbsent(serviceType, ignored -> {
 153             final var lookup = MethodHandles.publicLookup();
 154             return ImmutableMap.copyOf(Maps.transformValues(createQNameToMethod(serviceType), method -> {
 155                 final MethodHandle raw;
 156                 try {
 157                     raw = lookup.unreflect(method);
 158                 } catch (IllegalAccessException e) {
 159                     throw new IllegalStateException("Lookup on public method failed", e);
 160                 }
 161                 return raw.asType(RPC_SERVICE_METHOD_SIGNATURE);
 162             }));
 163         });
 164     }
 165
 166     @Deprecated
 167     @VisibleForTesting
 168     // FIXME: This should be probably part of Binding Runtime context
 169     ImmutableMap<QName, Method> createQNameToMethod(final Class<? extends RpcService> key) {
 170         final var moduleName = BindingReflections.getQNameModule(key);
 171         final var runtimeContext = getRuntimeContext();
 172         final var module = runtimeContext.getEffectiveModelContext().findModule(moduleName).orElse(null);
 173         if (module == null) {
 174             LOG.trace("Schema for {} is not available; expected module name: {}; BindingRuntimeContext: {}",
 175                 key, moduleName, runtimeContext);
 176             throw new IllegalStateException(String.format("Schema for %s is not available; expected module name: %s;"
 177                 + " full BindingRuntimeContext available in trace log", key, moduleName));
 178         }
 179
 180         final var ret = ImmutableBiMap.<QName, Method>builder();
 181         try {
 182             for (var rpcDef : module.getRpcs()) {
 183                 final var rpcName = rpcDef.getQName();
 184                 ret.put(rpcName, key.getMethod(BindingMapping.getRpcMethodName(rpcName),
 185                     runtimeContext.getRpcInput(rpcName)));
 186             }
 187         } catch (NoSuchMethodException e) {
 188             throw new IllegalStateException("Rpc defined in model does not have representation in generated class.", e);
 189         }
 190         return ret.build();
 191     }
 192
 193     private @NonNull Entry<SchemaInferenceStack, QNameModule> resolvePath(final @NonNull InstanceIdentifier<?> path) {
 194         final var stack = SchemaInferenceStack.of(getRuntimeContext().getEffectiveModelContext());
 195         final var it = toYangInstanceIdentifier(path).getPathArguments().iterator();
 196         verify(it.hasNext(), "Unexpected empty instance identifier for %s", path);
 197
 198         QNameModule lastNamespace;
 199         do {
 200             final var arg = it.next();
 201             if (arg instanceof AugmentationIdentifier) {
 202                 final var augChildren = ((AugmentationIdentifier) arg).getPossibleChildNames();
 203                 verify(!augChildren.isEmpty(), "Invalid empty augmentation %s", arg);
 204                 lastNamespace = augChildren.iterator().next().getModule();
 205                 continue;
 206             }
 207
 208             final var qname = arg.getNodeType();
 209             final var stmt = stack.enterDataTree(qname);
 210             lastNamespace = qname.getModule();
 211             if (stmt instanceof ListEffectiveStatement) {
 212                 // Lists have two steps
 213                 verify(it.hasNext(), "Unexpected list termination at %s in %s", stmt, path);
 214                 // Verify just to make sure we are doing the right thing
 215                 final var skipped = it.next();
 216                 verify(skipped instanceof NodeIdentifier, "Unexpected skipped list entry item %s in %s", skipped, path);
 217                 verify(stmt.argument().equals(skipped.getNodeType()), "Mismatched list entry item %s in %s", skipped,
 218                     path);
 219             }
 220         } while (it.hasNext());
 221
 222         return Map.entry(stack, lastNamespace);
 223     }
 224 }