code-generator/binding-generator-impl/src/main/java/org/opendaylight/yangtools/sal/binding/generator/impl/RuntimeGeneratedMappingServiceImpl.java

   1 /**
   2  * Copyright (c) 2014 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.yangtools.sal.binding.generator.impl;
   9
  10 import java.util.AbstractMap.SimpleEntry;
  11 import java.util.ArrayList;
  12 import java.util.Collection;
  13 import java.util.Collections;
  14 import java.util.HashSet;
  15 import java.util.LinkedList;
  16 import java.util.List;
  17 import java.util.Map;
  18 import java.util.Map.Entry;
  19 import java.util.Set;
  20 import java.util.concurrent.ConcurrentHashMap;
  21 import java.util.concurrent.ConcurrentMap;
  22 import java.util.concurrent.ExecutionException;
  23
  24 import javassist.ClassPool;
  25
  26 import javax.annotation.concurrent.GuardedBy;
  27
  28 import org.opendaylight.yangtools.binding.generator.util.BindingGeneratorUtil;
  29 import org.opendaylight.yangtools.binding.generator.util.ReferencedTypeImpl;
  30 import org.opendaylight.yangtools.binding.generator.util.Types;
  31 import org.opendaylight.yangtools.sal.binding.generator.api.ClassLoadingStrategy;
  32 import org.opendaylight.yangtools.sal.binding.generator.util.YangSchemaUtils;
  33 import org.opendaylight.yangtools.sal.binding.model.api.Type;
  34 import org.opendaylight.yangtools.sal.binding.model.api.type.builder.GeneratedTypeBuilder;
  35 import org.opendaylight.yangtools.yang.binding.Augmentation;
  36 import org.opendaylight.yangtools.yang.binding.BindingMapping;
  37 import org.opendaylight.yangtools.yang.binding.DataContainer;
  38 import org.opendaylight.yangtools.yang.binding.DataObject;
  39 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier.IdentifiableItem;
  40 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier.Item;
  41 import org.opendaylight.yangtools.yang.binding.RpcService;
  42 import org.opendaylight.yangtools.yang.common.QName;
  43 import org.opendaylight.yangtools.yang.data.api.CompositeNode;
  44 import org.opendaylight.yangtools.yang.data.api.InstanceIdentifier;
  45 import org.opendaylight.yangtools.yang.data.api.InstanceIdentifier.NodeIdentifierWithPredicates;
  46 import org.opendaylight.yangtools.yang.data.api.InstanceIdentifier.PathArgument;
  47 import org.opendaylight.yangtools.yang.data.api.Node;
  48 import org.opendaylight.yangtools.yang.data.impl.CompositeNodeTOImpl;
  49 import org.opendaylight.yangtools.yang.data.impl.SimpleNodeTOImpl;
  50 import org.opendaylight.yangtools.yang.data.impl.codec.AugmentationCodec;
  51 import org.opendaylight.yangtools.yang.data.impl.codec.BindingIndependentMappingService;
  52 import org.opendaylight.yangtools.yang.data.impl.codec.CodecRegistry;
  53 import org.opendaylight.yangtools.yang.data.impl.codec.DataContainerCodec;
  54 import org.opendaylight.yangtools.yang.data.impl.codec.DeserializationException;
  55 import org.opendaylight.yangtools.yang.data.impl.codec.InstanceIdentifierCodec;
  56 import org.opendaylight.yangtools.yang.data.impl.codec.ValueWithQName;
  57 import org.opendaylight.yangtools.yang.model.api.AugmentationSchema;
  58 import org.opendaylight.yangtools.yang.model.api.Module;
  59 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
  60 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  61 import org.opendaylight.yangtools.yang.model.api.SchemaContextHolder;
  62 import org.opendaylight.yangtools.yang.model.api.SchemaContextListener;
  63 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
  64 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  65 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
  66 import org.opendaylight.yangtools.yang.model.util.SchemaContextUtil;
  67 import org.slf4j.Logger;
  68 import org.slf4j.LoggerFactory;
  69
  70 import com.google.common.base.Optional;
  71 import com.google.common.base.Preconditions;
  72 import com.google.common.collect.HashMultimap;
  73 import com.google.common.collect.Multimap;
  74 import com.google.common.util.concurrent.ListenableFuture;
  75 import com.google.common.util.concurrent.SettableFuture;
  76
  77 public class RuntimeGeneratedMappingServiceImpl implements BindingIndependentMappingService, SchemaContextListener,
  78         SchemaLock, AutoCloseable, SchemaContextHolder, TypeResolver {
  79
  80     private static final Logger LOG = LoggerFactory.getLogger(RuntimeGeneratedMappingServiceImpl.class);
  81
  82     private final ConcurrentMap<Type, Set<QName>> serviceTypeToRpc = new ConcurrentHashMap<>();
  83
  84     /**
  85      * This is map of types which users are waiting for.
  86      */
  87     @GuardedBy("this")
  88     private final Multimap<Type, SettableFuture<Type>> promisedTypes = HashMultimap.create();
  89
  90     private final ClassLoadingStrategy classLoadingStrategy;
  91
  92     private final AbstractTransformerGenerator binding;
  93     private final LazyGeneratedCodecRegistry registry;
  94     private final ClassPool pool;
  95
  96     /*
  97      * FIXME: updated here, access from AbstractTransformer
  98      */
  99     private final Map<Type, AugmentationSchema> typeToAugmentation = new ConcurrentHashMap<>();
 100     private final ConcurrentMap<Type, GeneratedTypeBuilder> typeToDefinition = new ConcurrentHashMap<>();
 101     private final ConcurrentMap<Type, SchemaNode> typeToSchemaNode = new ConcurrentHashMap<>();
 102     private final Map<SchemaPath, GeneratedTypeBuilder> pathToType = new ConcurrentHashMap<>();
 103
 104     // FIXME: need to figure these out
 105     private final ConcurrentMap<Type, Type> typeDefinitions = new ConcurrentHashMap<>();
 106     private SchemaContext schemaContext;
 107
 108     public RuntimeGeneratedMappingServiceImpl(final ClassPool pool) {
 109         this(pool, GeneratedClassLoadingStrategy.getTCCLClassLoadingStrategy());
 110     }
 111
 112     public RuntimeGeneratedMappingServiceImpl(final ClassPool pool, final ClassLoadingStrategy strat) {
 113         this.pool = Preconditions.checkNotNull(pool);
 114         this.classLoadingStrategy = Preconditions.checkNotNull(strat);
 115         // FIXME: this escapes constructor
 116         binding = new TransformerGenerator(this, pool);
 117         registry = new LazyGeneratedCodecRegistry(this, binding, classLoadingStrategy);
 118         binding.setListener(registry);
 119
 120         // if (ctx !== null) {
 121         // listenerRegistration = ctx.registerService(SchemaServiceListener,
 122         // this, new Hashtable<String, String>());
 123         // }
 124     }
 125
 126     @Override
 127     public synchronized SchemaContext getSchemaContext() {
 128         return schemaContext;
 129     }
 130
 131     @Override
 132     public synchronized void onGlobalContextUpdated(final SchemaContext context) {
 133         this.schemaContext = Preconditions.checkNotNull(context);
 134         this.recreateBindingContext(context);
 135         this.registry.onGlobalContextUpdated(context);
 136     }
 137
 138     @GuardedBy("this")
 139     private void recreateBindingContext(final SchemaContext schemaContext) {
 140         BindingGeneratorImpl newBinding = new BindingGeneratorImpl();
 141         newBinding.generateTypes(schemaContext);
 142
 143         for (Map.Entry<Module, ModuleContext> entry : newBinding.getModuleContexts().entrySet()) {
 144
 145             registry.onModuleContextAdded(schemaContext, entry.getKey(), entry.getValue());
 146             pathToType.putAll(entry.getValue().getChildNodes());
 147             Module module = entry.getKey();
 148             ModuleContext context = entry.getValue();
 149             updateBindingFor(context.getChildNodes(), schemaContext);
 150             updateBindingFor(context.getCases(), schemaContext);
 151             String namespace = BindingGeneratorUtil.moduleNamespaceToPackageName(module);
 152
 153             if (!module.getRpcs().isEmpty()) {
 154                 Set<QName> rpcs = new HashSet<>();
 155                 for (RpcDefinition rpc : module.getRpcs()) {
 156                     rpcs.add(rpc.getQName());
 157                 }
 158                 Type serviceClass = new ReferencedTypeImpl(namespace, BindingMapping.getClassName(module.getName())
 159                         + "Service");
 160                 serviceTypeToRpc.put(serviceClass, rpcs);
 161             }
 162
 163             Map<SchemaPath, Type> typedefs = context.getTypedefs();
 164             for (Map.Entry<SchemaPath, Type> typedef : typedefs.entrySet()) {
 165                 Type value = typedef.getValue();
 166                 Type typeRef = new ReferencedTypeImpl(value.getPackageName(), value.getName());
 167                 typeDefinitions.put(typeRef, value);
 168                 TypeDefinition<?> schemaNode = YangSchemaUtils.findTypeDefinition(schemaContext, typedef.getKey());
 169                 if (schemaNode != null) {
 170
 171                     typeToSchemaNode.put(typeRef, schemaNode);
 172                 } else {
 173                     LOG.error("Type definition for {} is not available", value);
 174                 }
 175             }
 176             List<GeneratedTypeBuilder> augmentations = context.getAugmentations();
 177             for (GeneratedTypeBuilder augmentation : augmentations) {
 178                 typeToDefinition.put(augmentation, augmentation);
 179             }
 180             typeToAugmentation.putAll(context.getTypeToAugmentation());
 181             for (GeneratedTypeBuilder augmentation : augmentations) {
 182                 updatePromisedSchemas(augmentation);
 183             }
 184         }
 185     }
 186
 187     @Override
 188     public CompositeNode toDataDom(final DataObject data) {
 189         return toCompositeNodeImpl(data);
 190     }
 191
 192     @Override
 193     public Entry<InstanceIdentifier, CompositeNode> toDataDom(
 194             final Entry<org.opendaylight.yangtools.yang.binding.InstanceIdentifier<? extends DataObject>, DataObject> entry) {
 195         try {
 196             org.opendaylight.yangtools.yang.data.api.InstanceIdentifier key = toDataDom(entry.getKey());
 197             CompositeNode data;
 198             if (Augmentation.class.isAssignableFrom(entry.getKey().getTargetType())) {
 199                 data = toCompositeNodeImplAugument(key, entry.getValue());
 200             } else {
 201                 data = toCompositeNodeImpl(key, entry.getValue());
 202             }
 203             return new SimpleEntry<org.opendaylight.yangtools.yang.data.api.InstanceIdentifier, CompositeNode>(key,
 204                     data);
 205
 206         } catch (Exception e) {
 207             LOG.error("Error during serialization for {}.", entry.getKey(), e);
 208             throw e;
 209         }
 210     }
 211
 212     private CompositeNode toCompositeNodeImpl(final DataObject object) {
 213         Class<? extends DataContainer> cls = object.getImplementedInterface();
 214         waitForSchema(cls);
 215         DataContainerCodec<DataObject> codec = (DataContainerCodec<DataObject>) registry.getCodecForDataObject(cls);
 216         return codec.serialize(new ValueWithQName<DataObject>(null, object));
 217     }
 218
 219     private CompositeNode toCompositeNodeImpl(final org.opendaylight.yangtools.yang.data.api.InstanceIdentifier identifier,
 220             final DataObject object) {
 221         PathArgument last = identifier.getPath().get(identifier.getPath().size() - 1);
 222         Class<? extends DataContainer> cls = object.getImplementedInterface();
 223         waitForSchema(cls);
 224         DataContainerCodec<DataObject> codec = (DataContainerCodec<DataObject>) registry.getCodecForDataObject(cls);
 225         return codec.serialize(new ValueWithQName<DataObject>(last.getNodeType(), object));
 226     }
 227
 228     private CompositeNode toCompositeNodeImplAugument(
 229             final org.opendaylight.yangtools.yang.data.api.InstanceIdentifier identifier, final DataObject object) {
 230
 231         // val cls = object.implementedInterface;
 232         // waitForSchema(cls);
 233         org.opendaylight.yangtools.yang.data.api.InstanceIdentifier.PathArgument last = identifier.getPath().get(
 234                 identifier.getPath().size() - 1);
 235         AugmentationCodec codec = registry.getCodecForAugmentation((Class) object.getImplementedInterface());
 236         CompositeNode ret = codec.serialize(new ValueWithQName<DataObject>(last.getNodeType(), object));
 237         if (last instanceof NodeIdentifierWithPredicates) {
 238             NodeIdentifierWithPredicates predicates = (NodeIdentifierWithPredicates) last;
 239             List<Node<?>> newNodes = new ArrayList<Node<?>>(predicates.getKeyValues().size());
 240             for (Map.Entry<QName, Object> predicate : predicates.getKeyValues().entrySet()) {
 241                 newNodes.add(new SimpleNodeTOImpl<Object>(predicate.getKey(), null, predicate.getValue()));
 242             }
 243             newNodes.addAll(ret.getValue());
 244             return new CompositeNodeTOImpl(last.getNodeType(), null, newNodes);
 245         }
 246         return ret;
 247     }
 248
 249     @Override
 250     public void waitForSchema(final Class<?> cls) {
 251         final ListenableFuture<Type> f = getSchemaDefinition(cls);
 252         if (f != null) {
 253             try {
 254                 f.get();
 255             } catch (InterruptedException | ExecutionException e) {
 256                 LOG.warn("Waiting for schema for class {} failed", cls, e);
 257                 throw new IllegalStateException(String.format("Failed to get schema for %s", cls), e);
 258             }
 259             LOG.info("Schema for {} became available, thread unblocked", cls);
 260         }
 261     }
 262
 263     @Override
 264     public InstanceIdentifier toDataDom(
 265             final org.opendaylight.yangtools.yang.binding.InstanceIdentifier<? extends DataObject> path) {
 266         for (final org.opendaylight.yangtools.yang.binding.InstanceIdentifier.PathArgument arg : path.getPathArguments()) {
 267             this.waitForSchema(arg.getType());
 268         }
 269
 270         final InstanceIdentifierCodec c = registry.getInstanceIdentifierCodec();
 271         Preconditions.checkState(c != null, "InstanceIdentifierCodec not present");
 272         return c.serialize(path);
 273     }
 274
 275     @Override
 276     public DataObject dataObjectFromDataDom(
 277             final org.opendaylight.yangtools.yang.binding.InstanceIdentifier<? extends DataObject> path,
 278             final CompositeNode domData) throws DeserializationException {
 279         if (domData == null) {
 280             return null;
 281         }
 282
 283         try {
 284             final Class<? extends DataContainer> container = path.getTargetType();
 285             // FIXME: deprecate use without iid
 286             final org.opendaylight.yangtools.yang.binding.InstanceIdentifier<? extends DataObject> wildcardedPath = createWildcarded(path);
 287
 288             final DataContainerCodec<? extends DataContainer> transformer = registry.getCodecForDataObject(container);
 289             Preconditions.checkState(transformer != null, "Failed to find codec for type %s", container);
 290
 291             final ValueWithQName<? extends DataContainer> deserialize = transformer.deserialize(domData, wildcardedPath);
 292             if (deserialize == null) {
 293                 return null;
 294             }
 295
 296             return (DataObject) deserialize.getValue();
 297         } catch (Exception e) {
 298             LOG.warn("Failed to deserialize path {} data {}", path, domData);
 299             throw new DeserializationException("Data deserialization failed", e);
 300         }
 301     }
 302
 303     @Override
 304     public org.opendaylight.yangtools.yang.binding.InstanceIdentifier<? extends Object> fromDataDom(final InstanceIdentifier entry) throws DeserializationException {
 305         try {
 306             final InstanceIdentifierCodec c = registry.getInstanceIdentifierCodec();
 307             Preconditions.checkState(c != null, "InstanceIdentifierCodec not present");
 308             return c.deserialize(entry);
 309         } catch (Exception e) {
 310             LOG.warn("Failed to deserialize entry {}", entry);
 311             throw new DeserializationException("Entry deserialization failed", e);
 312         }
 313     }
 314
 315     @Override
 316     public CodecRegistry getCodecRegistry() {
 317         return this.registry;
 318     }
 319
 320     private void updateBindingFor(final Map<SchemaPath, GeneratedTypeBuilder> map, final SchemaContext module) {
 321         for (Map.Entry<SchemaPath, GeneratedTypeBuilder> entry : map.entrySet()) {
 322             SchemaNode schemaNode = SchemaContextUtil.findDataSchemaNode(module, entry.getKey());
 323
 324             // LOG.info("{} : {}",entry.key,entry.value.fullyQualifiedName)
 325             Type typeRef = new ReferencedTypeImpl(entry.getValue().getPackageName(), entry.getValue().getName());
 326             typeToDefinition.put(typeRef, entry.getValue());
 327             if (schemaNode != null) {
 328                 typeToSchemaNode.put(typeRef, schemaNode);
 329                 updatePromisedSchemas(entry.getValue());
 330             }
 331         }
 332     }
 333
 334
 335     @Override
 336     public Set<QName> getRpcQNamesFor(final Class<? extends RpcService> service) {
 337         Set<QName> serviceRef = serviceTypeToRpc.get(new ReferencedTypeImpl(service.getPackage().getName(), service
 338                 .getSimpleName()));
 339         if (serviceRef == null) {
 340             serviceRef = Collections.emptySet();
 341         }
 342         return serviceRef;
 343     }
 344
 345     private ListenableFuture<Type> getSchemaDefinition(final Class<?> cls) {
 346         final Type type = Types.typeForClass(cls);
 347         synchronized (this) {
 348             if (typeToDefinition.containsKey(type)) {
 349                 return null;
 350             }
 351
 352             LOG.info("Thread is going to wait for schema for: {}", type.getFullyQualifiedName());
 353             final SettableFuture<Type> f = SettableFuture.create();
 354             promisedTypes.put(type, f);
 355             return f;
 356         }
 357     }
 358
 359     @GuardedBy("this")
 360     private void updatePromisedSchemas(final Type builder) {
 361         final Type ref = new ReferencedTypeImpl(builder.getPackageName(), builder.getName());
 362         final Collection<SettableFuture<Type>> futures = promisedTypes.get(ref);
 363
 364         if (futures != null) {
 365             for (SettableFuture<Type> future : futures) {
 366                 future.set(builder);
 367             }
 368             promisedTypes.removeAll(builder);
 369         }
 370     }
 371
 372     @Override
 373     public void close() {
 374         // Nothing to do
 375     }
 376
 377     @Override
 378     public DataContainer dataObjectFromDataDom(final Class<? extends DataContainer> container,
 379             final CompositeNode domData) {
 380         // FIXME: Add check for valids inputs
 381         // which are Notification and Rpc Input / Rpc Output
 382
 383         org.opendaylight.yangtools.yang.binding.InstanceIdentifier<? extends DataContainer> id = org.opendaylight.yangtools.yang.binding.InstanceIdentifier
 384                 .create((Class) container);
 385         Preconditions.checkNotNull(id, "Failed to create path for type %s", container);
 386
 387         try {
 388             return dataObjectFromDataDom(id, domData);
 389         } catch (DeserializationException e) {
 390             LOG.warn("Conversion of class {} path {} data {} failed", container, id, domData, e);
 391             throw new IllegalStateException("Failed to create data object", e);
 392         }
 393     }
 394
 395     @Override
 396     public synchronized Optional<Class<? extends RpcService>> getRpcServiceClassFor(final String namespace, final String revision) {
 397         Module module = null;
 398         if (schemaContext != null) {
 399             module = schemaContext.findModuleByName(namespace, QName.parseRevision(revision));
 400         }
 401         if (module == null) {
 402             return Optional.absent();
 403         }
 404         try {
 405             Optional<Type> rpcTypeName = getRpcServiceType(module);
 406             if (rpcTypeName.isPresent()) {
 407                 Class<?> rpcClass = classLoadingStrategy.loadClass(rpcTypeName.get().getFullyQualifiedName());
 408                 return Optional.<Class<? extends RpcService>> of((Class<? extends RpcService>) rpcClass);
 409             }
 410         } catch (Exception e) {
 411             LOG.debug("RPC class not present for {},{}", namespace, revision, e);
 412         }
 413         return Optional.absent();
 414     }
 415
 416     public Optional<Type> getRpcServiceType(final Module module) {
 417         String namespace = BindingGeneratorUtil.moduleNamespaceToPackageName(module);
 418         if (module.getRpcs().isEmpty()) {
 419             return Optional.<Type> absent();
 420         }
 421         return Optional.<Type> of(new ReferencedTypeImpl(namespace, BindingMapping.getClassName(module.getName())
 422                 + BindingMapping.RPC_SERVICE_SUFFIX));
 423     }
 424
 425     @SuppressWarnings({ "rawtypes", "unchecked" })
 426     private static final org.opendaylight.yangtools.yang.binding.InstanceIdentifier<? extends DataObject> createWildcarded(
 427             final org.opendaylight.yangtools.yang.binding.InstanceIdentifier<? extends DataObject> path) {
 428
 429         LinkedList<org.opendaylight.yangtools.yang.binding.InstanceIdentifier.PathArgument> wildcardedArgs = new LinkedList<>();
 430         for(org.opendaylight.yangtools.yang.binding.InstanceIdentifier.PathArgument pathArg : path.getPathArguments()) {
 431             if(pathArg instanceof IdentifiableItem<?,?>) {
 432                 pathArg = new Item(pathArg.getType());
 433             }
 434             wildcardedArgs.add(pathArg);
 435         }
 436         return org.opendaylight.yangtools.yang.binding.InstanceIdentifier.create(wildcardedArgs);
 437     }
 438
 439     @Override
 440     public final AugmentationSchema getAugmentation(final Type type) {
 441         return typeToAugmentation.get(type);
 442     }
 443
 444     @Override
 445     public final GeneratedTypeBuilder getDefinition(final Type type) {
 446         return typeToDefinition.get(type);
 447     }
 448
 449     @Override
 450     public final SchemaNode getSchemaNode(final Type type) {
 451         return typeToSchemaNode.get(type);
 452     }
 453
 454     @Override
 455     public final GeneratedTypeBuilder getTypeBuilder(final SchemaPath path) {
 456         return pathToType.get(path);
 457     }
 458 }