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.reflect.BindingReflections;
  43 import org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier;
  44 import org.opendaylight.yangtools.yang.binding.DataObject;
  45 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  46 import org.opendaylight.yangtools.yang.binding.RpcInput;
  47 import org.opendaylight.yangtools.yang.binding.RpcService;
  48 import org.opendaylight.yangtools.yang.binding.contract.Naming;
  49 import org.opendaylight.yangtools.yang.common.QName;
  50 import org.opendaylight.yangtools.yang.common.QNameModule;
  51 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  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     @Deprecated
  66     private static final MethodType RPC_SERVICE_METHOD_SIGNATURE = MethodType.methodType(ListenableFuture.class,
  67         RpcService.class, RpcInput.class);
  68
  69     private final LoadingCache<InstanceIdentifier<?>, YangInstanceIdentifier> cache = CacheBuilder.newBuilder()
  70             .softValues().build(new CacheLoader<InstanceIdentifier<?>, YangInstanceIdentifier>() {
  71                 @Override
  72                 public YangInstanceIdentifier load(final InstanceIdentifier<?> key) {
  73                     return toYangInstanceIdentifier(key);
  74                 }
  75             });
  76
  77     private final ConcurrentMap<JavaTypeName, ContextReferenceExtractor> extractors = new ConcurrentHashMap<>();
  78     @Deprecated
  79     private final ConcurrentMap<Class<? extends RpcService>, ImmutableMap<QName, MethodHandle>> rpcMethods =
  80         new ConcurrentHashMap<>();
  81     private final @NonNull BindingDOMCodecServices delegate;
  82
  83     public CurrentAdapterSerializer(final BindingDOMCodecServices delegate) {
  84         this.delegate = requireNonNull(delegate);
  85     }
  86
  87     @Override
  88     protected BindingDOMCodecServices delegate() {
  89         return delegate;
  90     }
  91
  92     @NonNull YangInstanceIdentifier toCachedYangInstanceIdentifier(final @NonNull InstanceIdentifier<?> path) {
  93         return cache.getUnchecked(path);
  94     }
  95
  96     <T extends DataObject> @NonNull InstanceIdentifier<T> coerceInstanceIdentifier(final YangInstanceIdentifier dom) {
  97         return verifyNotNull(fromYangInstanceIdentifier(dom));
  98     }
  99
 100     DOMDataTreeIdentifier toDOMDataTreeIdentifier(final DataTreeIdentifier<?> path) {
 101         return new DOMDataTreeIdentifier(path.getDatastoreType(), toYangInstanceIdentifier(path.getRootIdentifier()));
 102     }
 103
 104     Collection<DOMDataTreeIdentifier> toDOMDataTreeIdentifiers(final Collection<DataTreeIdentifier<?>> subtrees) {
 105         return subtrees.stream().map(this::toDOMDataTreeIdentifier).collect(Collectors.toSet());
 106     }
 107
 108     @NonNull Absolute getActionPath(final @NonNull ActionSpec<?, ?> spec) {
 109         final var entry = resolvePath(spec.path());
 110         final var stack = entry.getKey();
 111         final var stmt = stack.enterSchemaTree(BindingReflections.findQName(spec.type()).bindTo(entry.getValue()));
 112         verify(stmt instanceof ActionEffectiveStatement, "Action %s resolved to unexpected statement %s", spec, stmt);
 113         return stack.toSchemaNodeIdentifier();
 114     }
 115
 116     @NonNull Absolute getNotificationPath(final @NonNull InstanceNotificationSpec<?, ?> spec) {
 117         final var entry = resolvePath(spec.path());
 118         final var stack = entry.getKey();
 119         final var stmt = stack.enterSchemaTree(BindingReflections.findQName(spec.type()).bindTo(entry.getValue()));
 120         verify(stmt instanceof NotificationEffectiveStatement, "Notification %s resolved to unexpected statement %s",
 121             spec, stmt);
 122         return stack.toSchemaNodeIdentifier();
 123     }
 124
 125     @Nullable ContextReferenceExtractor findExtractor(final @NonNull InputRuntimeType inputType) {
 126         final var inputName = inputType.getIdentifier();
 127         final var cached = extractors.get(inputName);
 128         if (cached != null) {
 129             return cached;
 130         }
 131
 132         // Load the class
 133         final Class<?> inputClass;
 134         try {
 135             inputClass = getRuntimeContext().loadClass(inputName);
 136         } catch (ClassNotFoundException e) {
 137             throw new IllegalArgumentException("Failed to load class for " + inputType, e);
 138         }
 139
 140         // Check if there is an extractor at all
 141         final var created = ContextReferenceExtractor.of(inputClass);
 142         if (created == null) {
 143             return null;
 144         }
 145
 146         // Reconcile with cache
 147         final var raced = extractors.putIfAbsent(inputName, created);
 148         return raced != null ? raced : created;
 149     }
 150
 151     @Deprecated
 152     @NonNull ImmutableMap<QName, MethodHandle> getRpcMethods(final @NonNull Class<? extends RpcService> serviceType) {
 153         return rpcMethods.computeIfAbsent(serviceType, ignored -> {
 154             final var lookup = MethodHandles.publicLookup();
 155             return ImmutableMap.copyOf(Maps.transformValues(createQNameToMethod(serviceType), method -> {
 156                 final MethodHandle raw;
 157                 try {
 158                     raw = lookup.unreflect(method);
 159                 } catch (IllegalAccessException e) {
 160                     throw new IllegalStateException("Lookup on public method failed", e);
 161                 }
 162                 return raw.asType(RPC_SERVICE_METHOD_SIGNATURE);
 163             }));
 164         });
 165     }
 166
 167     @Deprecated
 168     @VisibleForTesting
 169     // FIXME: This should be probably part of Binding Runtime context
 170     ImmutableMap<QName, Method> createQNameToMethod(final Class<? extends RpcService> key) {
 171         final var moduleName = BindingReflections.getQNameModule(key);
 172         final var runtimeContext = getRuntimeContext();
 173         final var module = runtimeContext.getEffectiveModelContext().findModule(moduleName).orElse(null);
 174         if (module == null) {
 175             LOG.trace("Schema for {} is not available; expected module name: {}; BindingRuntimeContext: {}",
 176                 key, moduleName, runtimeContext);
 177             throw new IllegalStateException(String.format("Schema for %s is not available; expected module name: %s;"
 178                 + " full BindingRuntimeContext available in trace log", key, moduleName));
 179         }
 180
 181         final var ret = ImmutableBiMap.<QName, Method>builder();
 182         try {
 183             for (var rpcDef : module.getRpcs()) {
 184                 final var rpcName = rpcDef.getQName();
 185                 ret.put(rpcName, key.getMethod(Naming.getRpcMethodName(rpcName), 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             final var qname = arg.getNodeType();
 202             final var stmt = stack.enterDataTree(qname);
 203             lastNamespace = qname.getModule();
 204             if (stmt instanceof ListEffectiveStatement) {
 205                 // Lists have two steps
 206                 verify(it.hasNext(), "Unexpected list termination at %s in %s", stmt, path);
 207                 // Verify just to make sure we are doing the right thing
 208                 final var skipped = it.next();
 209                 verify(skipped instanceof NodeIdentifier, "Unexpected skipped list entry item %s in %s", skipped, path);
 210                 verify(stmt.argument().equals(skipped.getNodeType()), "Mismatched list entry item %s in %s", skipped,
 211                     path);
 212             }
 213         } while (it.hasNext());
 214
 215         return Map.entry(stack, lastNamespace);
 216     }
 217 }