binding/mdsal-binding-dom-codec/src/main/java/org/opendaylight/mdsal/binding/dom/codec/impl/NotificationCodecContext.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.binding.dom.codec.impl;
   9
  10 import static com.google.common.base.Verify.verifyNotNull;
  11 import static net.bytebuddy.implementation.bytecode.member.MethodVariableAccess.loadThis;
  12 import static org.opendaylight.mdsal.binding.dom.codec.impl.ByteBuddyUtils.getField;
  13 import static org.opendaylight.mdsal.binding.dom.codec.impl.ByteBuddyUtils.putField;
  14
  15 import com.google.common.base.Throwables;
  16 import java.lang.invoke.MethodHandle;
  17 import java.lang.invoke.MethodHandles;
  18 import java.lang.invoke.MethodType;
  19 import java.time.Instant;
  20 import net.bytebuddy.ByteBuddy;
  21 import net.bytebuddy.description.method.MethodDescription;
  22 import net.bytebuddy.description.method.MethodDescription.InGenericShape;
  23 import net.bytebuddy.description.type.TypeDefinition;
  24 import net.bytebuddy.description.type.TypeDescription;
  25 import net.bytebuddy.description.type.TypeDescription.Generic;
  26 import net.bytebuddy.dynamic.scaffold.InstrumentedType;
  27 import net.bytebuddy.dynamic.scaffold.subclass.ConstructorStrategy;
  28 import net.bytebuddy.implementation.Implementation;
  29 import net.bytebuddy.implementation.bytecode.ByteCodeAppender;
  30 import net.bytebuddy.implementation.bytecode.StackManipulation;
  31 import net.bytebuddy.implementation.bytecode.member.MethodInvocation;
  32 import net.bytebuddy.implementation.bytecode.member.MethodReturn;
  33 import net.bytebuddy.implementation.bytecode.member.MethodVariableAccess;
  34 import net.bytebuddy.jar.asm.Opcodes;
  35 import net.bytebuddy.matcher.ElementMatchers;
  36 import org.eclipse.jdt.annotation.NonNull;
  37 import org.opendaylight.mdsal.binding.loader.BindingClassLoader.GeneratorResult;
  38 import org.opendaylight.mdsal.binding.runtime.api.NotificationRuntimeType;
  39 import org.opendaylight.yangtools.yang.binding.BaseNotification;
  40 import org.opendaylight.yangtools.yang.binding.DataObject;
  41 import org.opendaylight.yangtools.yang.binding.EventInstantAware;
  42 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  43 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerNode;
  44 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  45
  46 final class NotificationCodecContext<D extends DataObject & BaseNotification>
  47         extends DataObjectCodecContext<D, NotificationRuntimeType> {
  48     private static final Generic EVENT_INSTANT_AWARE = TypeDefinition.Sort.describe(EventInstantAware.class);
  49
  50     private static final String EVENT_INSTANT_NAME;
  51     private static final Generic EVENT_INSTANT_RETTYPE;
  52
  53     static {
  54         final MethodDescription eventInstance = EVENT_INSTANT_AWARE.getDeclaredMethods().getOnly();
  55         EVENT_INSTANT_NAME = eventInstance.getName();
  56         EVENT_INSTANT_RETTYPE = eventInstance.getReturnType();
  57     }
  58
  59     private static final Generic BB_DOCC = TypeDefinition.Sort.describe(DataObjectCodecContext.class);
  60     private static final Generic BB_DCN = TypeDefinition.Sort.describe(DataContainerNode.class);
  61     private static final Generic BB_I = TypeDefinition.Sort.describe(Instant.class);
  62
  63     private static final MethodType CONSTRUCTOR_TYPE = MethodType.methodType(void.class, DataObjectCodecContext.class,
  64         DataContainerNode.class, Instant.class);
  65     private static final MethodType NOTIFICATION_TYPE = MethodType.methodType(BaseNotification.class,
  66         NotificationCodecContext.class, ContainerNode.class, Instant.class);
  67     private static final String INSTANT_FIELD = "instant";
  68
  69     private final MethodHandle eventProxy;
  70
  71     NotificationCodecContext(final Class<?> key, final NotificationRuntimeType schema,
  72             final CodecContextFactory factory) {
  73         super(DataContainerCodecPrototype.from(key, schema, factory));
  74         final Class<D> bindingClass = getBindingClass();
  75
  76         final Class<?> awareClass = CodecPackage.EVENT_AWARE.generateClass(factory().getLoader(), bindingClass,
  77             (loader, fqcn, bindingInterface) -> {
  78                 final Class<?> codecImpl = CodecPackage.CODEC.getGeneratedClass(loader, bindingClass);
  79
  80                 return GeneratorResult.of(new ByteBuddy()
  81                     .subclass(codecImpl, ConstructorStrategy.Default.NO_CONSTRUCTORS)
  82                     .implement(EVENT_INSTANT_AWARE)
  83                     .name(fqcn)
  84                     .defineField(INSTANT_FIELD, BB_I, Opcodes.ACC_PRIVATE | Opcodes.ACC_FINAL | Opcodes.ACC_SYNTHETIC)
  85                     .defineConstructor(Opcodes.ACC_PUBLIC | Opcodes.ACC_SYNTHETIC)
  86                         .withParameters(BB_DOCC, BB_DCN, BB_I)
  87                         .intercept(ConstructorImplementation.INSTANCE)
  88                     .defineMethod(EVENT_INSTANT_NAME, EVENT_INSTANT_RETTYPE, Opcodes.ACC_PUBLIC | Opcodes.ACC_SYNTHETIC)
  89                         .intercept(EventInstantImplementation.INSTANCE)
  90                     .make());
  91             });
  92
  93         final MethodHandle ctor;
  94         try {
  95             ctor = MethodHandles.publicLookup().findConstructor(awareClass, CONSTRUCTOR_TYPE);
  96         } catch (IllegalAccessException | NoSuchMethodException e) {
  97             throw new LinkageError("Failed to acquire constructor", e);
  98         }
  99         eventProxy = ctor.asType(NOTIFICATION_TYPE);
 100     }
 101
 102     @Override
 103     public D deserialize(final NormalizedNode data) {
 104         return createBindingProxy(checkDataArgument(ContainerNode.class, data));
 105     }
 106
 107     @SuppressWarnings("checkstyle:illegalCatch")
 108     @NonNull BaseNotification deserialize(final @NonNull ContainerNode data, final @NonNull Instant eventInstant) {
 109         final BaseNotification ret;
 110         try {
 111             ret = (BaseNotification) eventProxy.invokeExact(this, data, eventInstant);
 112         } catch (final Throwable e) {
 113             Throwables.throwIfUnchecked(e);
 114             throw new LinkageError("Failed to instantiate notification", e);
 115         }
 116         return verifyNotNull(ret);
 117     }
 118
 119     @Override
 120     protected Object deserializeObject(final NormalizedNode normalizedNode) {
 121         return deserialize(normalizedNode);
 122     }
 123
 124     private enum ConstructorImplementation implements Implementation {
 125         INSTANCE;
 126
 127         private static final StackManipulation LOAD_INSTANT_ARG = MethodVariableAccess.REFERENCE.loadFrom(3);
 128         private static final StackManipulation LOAD_CTOR_ARGS;
 129
 130         static {
 131             try {
 132                 LOAD_CTOR_ARGS = MethodVariableAccess.allArgumentsOf(new MethodDescription.ForLoadedConstructor(
 133                     AugmentableCodecDataObject.class.getDeclaredConstructor(AbstractDataObjectCodecContext.class,
 134                         DataContainerNode.class)));
 135             } catch (NoSuchMethodException e) {
 136                 throw new ExceptionInInitializerError(e);
 137             }
 138         }
 139
 140         @Override
 141         public InstrumentedType prepare(final InstrumentedType instrumentedType) {
 142             return instrumentedType;
 143         }
 144
 145         @Override
 146         public ByteCodeAppender appender(final Target implementationTarget) {
 147             final TypeDescription instrumentedType = implementationTarget.getInstrumentedType();
 148             final InGenericShape superCtor = verifyNotNull(instrumentedType.getSuperClass()).getDeclaredMethods()
 149                     .filter(ElementMatchers.isConstructor()).getOnly();
 150
 151             return new ByteCodeAppender.Simple(
 152                 loadThis(),
 153                 LOAD_CTOR_ARGS,
 154                 MethodInvocation.invoke(superCtor),
 155                 loadThis(),
 156                 LOAD_INSTANT_ARG,
 157                 putField(instrumentedType, INSTANT_FIELD),
 158                 MethodReturn.VOID);
 159         }
 160     }
 161
 162     private enum EventInstantImplementation implements Implementation {
 163         INSTANCE;
 164
 165         @Override
 166         public InstrumentedType prepare(final InstrumentedType instrumentedType) {
 167             return instrumentedType;
 168         }
 169
 170         @Override
 171         public ByteCodeAppender appender(final Target implementationTarget) {
 172             return new ByteCodeAppender.Simple(
 173               loadThis(),
 174               getField(implementationTarget.getInstrumentedType(), INSTANT_FIELD),
 175               MethodReturn.REFERENCE);
 176         }
 177     }
 178 }