2 * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.yangtools.yang.parser.repo;
10 import static com.google.common.base.Preconditions.checkArgument;
11 import static java.util.Objects.requireNonNull;
12 import static org.opendaylight.yangtools.util.concurrent.FluentFutures.immediateFluentFuture;
14 import com.google.common.base.Function;
15 import com.google.common.cache.Cache;
16 import com.google.common.cache.CacheBuilder;
17 import com.google.common.collect.Collections2;
18 import com.google.common.collect.ImmutableList;
19 import com.google.common.collect.Iterables;
20 import com.google.common.collect.Maps;
21 import com.google.common.util.concurrent.AsyncFunction;
22 import com.google.common.util.concurrent.FluentFuture;
23 import com.google.common.util.concurrent.FutureCallback;
24 import com.google.common.util.concurrent.Futures;
25 import com.google.common.util.concurrent.ListenableFuture;
26 import com.google.common.util.concurrent.MoreExecutors;
27 import java.util.Collection;
28 import java.util.LinkedHashMap;
29 import java.util.LinkedHashSet;
30 import java.util.List;
32 import java.util.Map.Entry;
34 import org.antlr.v4.runtime.ParserRuleContext;
35 import org.eclipse.jdt.annotation.NonNull;
36 import org.opendaylight.yangtools.antlrv4.code.gen.YangStatementParser.StatementContext;
37 import org.opendaylight.yangtools.yang.common.QName;
38 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
39 import org.opendaylight.yangtools.yang.model.repo.api.SchemaContextFactory;
40 import org.opendaylight.yangtools.yang.model.repo.api.SchemaContextFactoryConfiguration;
41 import org.opendaylight.yangtools.yang.model.repo.api.SchemaRepository;
42 import org.opendaylight.yangtools.yang.model.repo.api.SchemaResolutionException;
43 import org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier;
44 import org.opendaylight.yangtools.yang.model.repo.api.StatementParserMode;
45 import org.opendaylight.yangtools.yang.parser.impl.DefaultReactors;
46 import org.opendaylight.yangtools.yang.parser.rfc7950.repo.ASTSchemaSource;
47 import org.opendaylight.yangtools.yang.parser.rfc7950.repo.YangModelDependencyInfo;
48 import org.opendaylight.yangtools.yang.parser.rfc7950.repo.YangStatementStreamSource;
49 import org.opendaylight.yangtools.yang.parser.spi.meta.ReactorException;
50 import org.opendaylight.yangtools.yang.parser.stmt.reactor.CrossSourceStatementReactor.BuildAction;
51 import org.slf4j.Logger;
52 import org.slf4j.LoggerFactory;
54 final class SharedSchemaContextFactory implements SchemaContextFactory {
55 private static final Logger LOG = LoggerFactory.getLogger(SharedSchemaContextFactory.class);
57 private final Cache<Collection<SourceIdentifier>, SchemaContext> revisionCache = CacheBuilder.newBuilder()
58 .weakValues().build();
59 private final Cache<Collection<SourceIdentifier>, SchemaContext> semVerCache = CacheBuilder.newBuilder()
60 .weakValues().build();
61 private final @NonNull SchemaRepository repository;
62 private final @NonNull SchemaContextFactoryConfiguration config;
64 SharedSchemaContextFactory(final @NonNull SchemaRepository repository,
65 final @NonNull SchemaContextFactoryConfiguration config) {
66 this.repository = requireNonNull(repository);
67 this.config = requireNonNull(config);
72 public @NonNull ListenableFuture<SchemaContext> createSchemaContext(
73 final Collection<SourceIdentifier> requiredSources,
74 final StatementParserMode statementParserMode, final Set<QName> supportedFeatures) {
75 return createSchemaContext(requiredSources,
76 statementParserMode == StatementParserMode.SEMVER_MODE ? semVerCache : revisionCache,
77 new AssembleSources(SchemaContextFactoryConfiguration.builder()
78 .setFilter(config.getSchemaSourceFilter()).setStatementParserMode(statementParserMode)
79 .setSupportedFeatures(supportedFeatures).build()));
83 public @NonNull ListenableFuture<SchemaContext> createSchemaContext(
84 final @NonNull Collection<SourceIdentifier> requiredSources) {
85 return createSchemaContext(requiredSources,
86 config.getStatementParserMode() == StatementParserMode.SEMVER_MODE ? semVerCache : revisionCache,
87 new AssembleSources(config));
90 private @NonNull ListenableFuture<SchemaContext> createSchemaContext(
91 final Collection<SourceIdentifier> requiredSources,
92 final Cache<Collection<SourceIdentifier>, SchemaContext> cache,
93 final AsyncFunction<List<ASTSchemaSource>, SchemaContext> assembleSources) {
94 // Make sources unique
95 final List<SourceIdentifier> uniqueSourceIdentifiers = deDuplicateSources(requiredSources);
97 final SchemaContext existing = cache.getIfPresent(uniqueSourceIdentifiers);
98 if (existing != null) {
99 LOG.debug("Returning cached context {}", existing);
100 return immediateFluentFuture(existing);
103 // Request all sources be loaded
104 ListenableFuture<List<ASTSchemaSource>> sf = Futures.allAsList(Collections2.transform(uniqueSourceIdentifiers,
105 this::requestSource));
107 // Detect mismatch between requested Source IDs and IDs that are extracted from parsed source
108 // Also remove duplicates if present
109 // We are relying on preserved order of uniqueSourceIdentifiers as well as sf
110 sf = Futures.transform(sf, new SourceIdMismatchDetector(uniqueSourceIdentifiers),
111 MoreExecutors.directExecutor());
113 // Assemble sources into a schema context
114 final ListenableFuture<SchemaContext> cf = Futures.transformAsync(sf, assembleSources,
115 MoreExecutors.directExecutor());
117 // Populate cache when successful
118 Futures.addCallback(cf, new FutureCallback<SchemaContext>() {
120 public void onSuccess(final SchemaContext result) {
121 cache.put(uniqueSourceIdentifiers, result);
125 public void onFailure(final Throwable cause) {
126 LOG.debug("Failed to assemble sources", cause);
128 }, MoreExecutors.directExecutor());
133 private ListenableFuture<ASTSchemaSource> requestSource(final @NonNull SourceIdentifier identifier) {
134 return repository.getSchemaSource(identifier, ASTSchemaSource.class);
138 * Return a set of de-duplicated inputs.
140 * @return set (preserving ordering) from the input collection
142 private static List<SourceIdentifier> deDuplicateSources(final Collection<SourceIdentifier> requiredSources) {
143 final Set<SourceIdentifier> uniqueSourceIdentifiers = new LinkedHashSet<>(requiredSources);
144 if (uniqueSourceIdentifiers.size() == requiredSources.size()) {
145 // Can potentially reuse input
146 return ImmutableList.copyOf(requiredSources);
149 LOG.warn("Duplicate sources requested for schema context, removed duplicate sources: {}",
150 Collections2.filter(uniqueSourceIdentifiers, input -> Iterables.frequency(requiredSources, input) > 1));
151 return ImmutableList.copyOf(uniqueSourceIdentifiers);
154 private static final class SourceIdMismatchDetector implements Function<List<ASTSchemaSource>,
155 List<ASTSchemaSource>> {
156 private final List<SourceIdentifier> sourceIdentifiers;
158 SourceIdMismatchDetector(final List<SourceIdentifier> sourceIdentifiers) {
159 this.sourceIdentifiers = requireNonNull(sourceIdentifiers);
163 public List<ASTSchemaSource> apply(final List<ASTSchemaSource> input) {
164 final Map<SourceIdentifier, ASTSchemaSource> filtered = new LinkedHashMap<>();
166 for (int i = 0; i < input.size(); i++) {
168 final SourceIdentifier expectedSId = sourceIdentifiers.get(i);
169 final ASTSchemaSource astSchemaSource = input.get(i);
170 final SourceIdentifier realSId = astSchemaSource.getIdentifier();
172 if (!expectedSId.equals(realSId)) {
173 LOG.warn("Source identifier mismatch for module \"{}\", requested as {} but actually is {}. "
174 + "Using actual id", expectedSId.getName(), expectedSId, realSId);
177 if (filtered.containsKey(realSId)) {
178 LOG.warn("Duplicate source for module {} detected in reactor", realSId);
181 filtered.put(realSId, astSchemaSource);
184 return ImmutableList.copyOf(filtered.values());
188 private static final class AssembleSources implements AsyncFunction<List<ASTSchemaSource>, SchemaContext> {
189 private final @NonNull SchemaContextFactoryConfiguration config;
190 private final @NonNull Function<ASTSchemaSource, SourceIdentifier> getIdentifier;
192 private AssembleSources(final @NonNull SchemaContextFactoryConfiguration config) {
193 this.config = config;
194 switch (config.getStatementParserMode()) {
196 this.getIdentifier = ASTSchemaSource::getSemVerIdentifier;
199 this.getIdentifier = ASTSchemaSource::getIdentifier;
204 public FluentFuture<SchemaContext> apply(final List<ASTSchemaSource> sources)
205 throws SchemaResolutionException, ReactorException {
206 final Map<SourceIdentifier, ASTSchemaSource> srcs = Maps.uniqueIndex(sources, getIdentifier);
207 final Map<SourceIdentifier, YangModelDependencyInfo> deps =
208 Maps.transformValues(srcs, ASTSchemaSource::getDependencyInformation);
210 LOG.debug("Resolving dependency reactor {}", deps);
212 final StatementParserMode statementParserMode = config.getStatementParserMode();
213 final DependencyResolver res = statementParserMode == StatementParserMode.SEMVER_MODE
214 ? SemVerDependencyResolver.create(deps) : RevisionDependencyResolver.create(deps);
215 if (!res.getUnresolvedSources().isEmpty()) {
216 LOG.debug("Omitting models {} due to unsatisfied imports {}", res.getUnresolvedSources(),
217 res.getUnsatisfiedImports());
218 throw new SchemaResolutionException("Failed to resolve required models",
219 res.getResolvedSources(), res.getUnsatisfiedImports());
222 final BuildAction reactor = DefaultReactors.defaultReactor().newBuild(statementParserMode);
223 config.getSupportedFeatures().ifPresent(reactor::setSupportedFeatures);
224 config.getModulesDeviatedByModules().ifPresent(reactor::setModulesWithSupportedDeviations);
226 for (final Entry<SourceIdentifier, ASTSchemaSource> e : srcs.entrySet()) {
227 final ASTSchemaSource ast = e.getValue();
228 final ParserRuleContext parserRuleCtx = ast.getAST();
229 checkArgument(parserRuleCtx instanceof StatementContext, "Unsupported context class %s for source %s",
230 parserRuleCtx.getClass(), e.getKey());
232 reactor.addSource(YangStatementStreamSource.create(e.getKey(), (StatementContext) parserRuleCtx,
233 ast.getSymbolicName().orElse(null)));
236 final SchemaContext schemaContext;
238 schemaContext = reactor.buildEffective();
239 } catch (final ReactorException ex) {
240 throw new SchemaResolutionException("Failed to resolve required models", ex.getSourceIdentifier(), ex);
243 return immediateFluentFuture(schemaContext);