2 * Copyright (c) 2015 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.immediateFailedFluentFuture;
13 import static org.opendaylight.yangtools.util.concurrent.FluentFutures.immediateFluentFuture;
15 import com.google.common.annotations.Beta;
16 import com.google.common.base.MoreObjects.ToStringHelper;
17 import com.google.common.base.Verify;
18 import com.google.common.collect.ArrayListMultimap;
19 import com.google.common.collect.ImmutableSet;
20 import com.google.common.collect.Multimap;
21 import com.google.common.util.concurrent.FluentFuture;
22 import com.google.common.util.concurrent.ListenableFuture;
23 import java.io.IOException;
24 import java.io.InputStream;
26 import java.util.Collection;
27 import java.util.Optional;
29 import java.util.concurrent.ConcurrentLinkedDeque;
30 import java.util.concurrent.ExecutionException;
31 import java.util.concurrent.TimeUnit;
32 import java.util.concurrent.atomic.AtomicReference;
33 import org.eclipse.jdt.annotation.NonNull;
34 import org.opendaylight.yangtools.yang.common.Revision;
35 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
36 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
37 import org.opendaylight.yangtools.yang.model.parser.api.YangSyntaxErrorException;
38 import org.opendaylight.yangtools.yang.model.repo.api.EffectiveModelContextFactory;
39 import org.opendaylight.yangtools.yang.model.repo.api.MissingSchemaSourceException;
40 import org.opendaylight.yangtools.yang.model.repo.api.RevisionSourceIdentifier;
41 import org.opendaylight.yangtools.yang.model.repo.api.SchemaContextFactoryConfiguration;
42 import org.opendaylight.yangtools.yang.model.repo.api.SchemaRepository;
43 import org.opendaylight.yangtools.yang.model.repo.api.SchemaResolutionException;
44 import org.opendaylight.yangtools.yang.model.repo.api.SchemaSourceException;
45 import org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier;
46 import org.opendaylight.yangtools.yang.model.repo.api.StatementParserMode;
47 import org.opendaylight.yangtools.yang.model.repo.api.YangTextSchemaSource;
48 import org.opendaylight.yangtools.yang.model.repo.spi.PotentialSchemaSource;
49 import org.opendaylight.yangtools.yang.model.repo.spi.PotentialSchemaSource.Costs;
50 import org.opendaylight.yangtools.yang.model.repo.spi.SchemaListenerRegistration;
51 import org.opendaylight.yangtools.yang.model.repo.spi.SchemaSourceProvider;
52 import org.opendaylight.yangtools.yang.model.repo.spi.SchemaSourceRegistration;
53 import org.opendaylight.yangtools.yang.model.repo.spi.SchemaSourceRegistry;
54 import org.opendaylight.yangtools.yang.model.repo.util.InMemorySchemaSourceCache;
55 import org.opendaylight.yangtools.yang.parser.rfc7950.repo.ASTSchemaSource;
56 import org.opendaylight.yangtools.yang.parser.rfc7950.repo.TextToASTTransformer;
57 import org.slf4j.Logger;
58 import org.slf4j.LoggerFactory;
60 public final class YangTextSchemaContextResolver implements AutoCloseable, SchemaSourceProvider<YangTextSchemaSource> {
61 private static final Logger LOG = LoggerFactory.getLogger(YangTextSchemaContextResolver.class);
62 private static final long SOURCE_LIFETIME_SECONDS = 60;
64 private final Collection<SourceIdentifier> requiredSources = new ConcurrentLinkedDeque<>();
65 private final Multimap<SourceIdentifier, YangTextSchemaSource> texts = ArrayListMultimap.create();
66 private final AtomicReference<Optional<SchemaContext>> currentSchemaContext =
67 new AtomicReference<>(Optional.empty());
68 private final InMemorySchemaSourceCache<ASTSchemaSource> cache;
69 private final SchemaListenerRegistration transReg;
70 private final SchemaSourceRegistry registry;
71 private final SchemaRepository repository;
72 private volatile Object version = new Object();
73 private volatile Object contextVersion = version;
75 private YangTextSchemaContextResolver(final SchemaRepository repository, final SchemaSourceRegistry registry) {
76 this.repository = requireNonNull(repository);
77 this.registry = requireNonNull(registry);
79 final TextToASTTransformer t = TextToASTTransformer.create(repository, registry);
80 transReg = registry.registerSchemaSourceListener(t);
82 cache = InMemorySchemaSourceCache.createSoftCache(registry, ASTSchemaSource.class, SOURCE_LIFETIME_SECONDS,
86 public static YangTextSchemaContextResolver create(final String name) {
87 final SharedSchemaRepository sharedRepo = new SharedSchemaRepository(name);
88 return new YangTextSchemaContextResolver(sharedRepo, sharedRepo);
92 * Register a {@link YangTextSchemaSource}.
94 * @param source YANG text source
95 * @return a YangTextSchemaSourceRegistration
96 * @throws YangSyntaxErrorException When the YANG file is syntactically invalid
97 * @throws IOException when the URL is not readable
98 * @throws SchemaSourceException When parsing encounters general error
100 public @NonNull YangTextSchemaSourceRegistration registerSource(final @NonNull YangTextSchemaSource source)
101 throws SchemaSourceException, IOException, YangSyntaxErrorException {
102 checkArgument(source != null);
104 final ASTSchemaSource ast = TextToASTTransformer.transformText(source);
105 LOG.trace("Resolved source {} to source {}", source, ast);
107 // AST carries an accurate identifier, check if it matches the one supplied by the source. If it
108 // does not, check how much it differs and emit a warning.
109 final SourceIdentifier providedId = source.getIdentifier();
110 final SourceIdentifier parsedId = ast.getIdentifier();
111 final YangTextSchemaSource text;
112 if (!parsedId.equals(providedId)) {
113 if (!parsedId.getName().equals(providedId.getName())) {
114 LOG.info("Provided module name {} does not match actual text {}, corrected",
115 providedId.toYangFilename(), parsedId.toYangFilename());
117 final Optional<Revision> sourceRev = providedId.getRevision();
118 final Optional<Revision> astRev = parsedId.getRevision();
119 if (sourceRev.isPresent()) {
120 if (!sourceRev.equals(astRev)) {
121 LOG.info("Provided module revision {} does not match actual text {}, corrected",
122 providedId.toYangFilename(), parsedId.toYangFilename());
125 LOG.debug("Expanded module {} to {}", providedId.toYangFilename(), parsedId.toYangFilename());
129 text = YangTextSchemaSource.delegateForByteSource(parsedId, source);
134 synchronized (this) {
135 texts.put(parsedId, text);
136 LOG.debug("Populated {} with text", parsedId);
138 final SchemaSourceRegistration<YangTextSchemaSource> reg = registry.registerSchemaSource(this,
139 PotentialSchemaSource.create(parsedId, YangTextSchemaSource.class, Costs.IMMEDIATE.getValue()));
140 requiredSources.add(parsedId);
141 cache.schemaSourceEncountered(ast);
142 LOG.debug("Added source {} to schema context requirements", parsedId);
143 version = new Object();
145 return new AbstractYangTextSchemaSourceRegistration(text) {
147 protected void removeRegistration() {
148 synchronized (YangTextSchemaContextResolver.this) {
149 requiredSources.remove(parsedId);
150 LOG.trace("Removed source {} from schema context requirements", parsedId);
151 version = new Object();
153 texts.remove(parsedId, text);
161 * Register a URL containing a YANG text.
163 * @param url YANG text source URL
164 * @return a YangTextSchemaSourceRegistration for this URL
165 * @throws YangSyntaxErrorException When the YANG file is syntactically invalid
166 * @throws IOException when the URL is not readable
167 * @throws SchemaSourceException When parsing encounters general error
169 public @NonNull YangTextSchemaSourceRegistration registerSource(final @NonNull URL url)
170 throws SchemaSourceException, IOException, YangSyntaxErrorException {
171 checkArgument(url != null, "Supplied URL must not be null");
173 final String path = url.getPath();
174 final String fileName = path.substring(path.lastIndexOf('/') + 1);
175 final SourceIdentifier guessedId = guessSourceIdentifier(fileName);
176 return registerSource(new YangTextSchemaSource(guessedId) {
178 public InputStream openStream() throws IOException {
179 return url.openStream();
183 protected ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
184 return toStringHelper.add("url", url);
189 private static SourceIdentifier guessSourceIdentifier(final @NonNull String fileName) {
191 return YangTextSchemaSource.identifierFromFilename(fileName);
192 } catch (final IllegalArgumentException e) {
193 LOG.warn("Invalid file name format in '{}'", fileName, e);
194 return RevisionSourceIdentifier.create(fileName);
199 * Try to parse all currently available yang files and build new schema context.
201 * @return new schema context iif there is at least 1 yang file registered and
202 * new schema context was successfully built.
204 public Optional<SchemaContext> getSchemaContext() {
205 return getSchemaContext(StatementParserMode.DEFAULT_MODE);
209 * Try to parse all currently available yang files and build new schema context depending on specified parsing mode.
211 * @param statementParserMode mode of statement parser
212 * @return new schema context iif there is at least 1 yang file registered and
213 * new schema context was successfully built.
215 public Optional<SchemaContext> getSchemaContext(final StatementParserMode statementParserMode) {
216 final EffectiveModelContextFactory factory = repository.createEffectiveModelContextFactory(
217 config(statementParserMode));
218 Optional<SchemaContext> sc;
221 // Spin get stable context version
225 sc = currentSchemaContext.get();
229 } while (cv != contextVersion);
231 // Version has been updated
232 Collection<SourceIdentifier> sources;
235 sources = ImmutableSet.copyOf(requiredSources);
236 } while (ver != version);
239 final ListenableFuture<EffectiveModelContext> f = factory.createEffectiveModelContext(sources);
241 sc = Optional.of(f.get());
243 } catch (final InterruptedException e) {
244 throw new IllegalStateException("Interrupted while assembling schema context", e);
245 } catch (final ExecutionException e) {
246 LOG.info("Failed to fully assemble schema context for {}", sources, e);
247 final Throwable cause = e.getCause();
248 Verify.verify(cause instanceof SchemaResolutionException);
249 sources = ((SchemaResolutionException) cause).getResolvedSources();
253 LOG.debug("Resolved schema context for {}", sources);
255 synchronized (this) {
256 if (contextVersion == cv) {
257 currentSchemaContext.set(sc);
258 contextVersion = ver;
261 } while (version == ver);
267 public synchronized FluentFuture<YangTextSchemaSource> getSource(
268 final SourceIdentifier sourceIdentifier) {
269 final Collection<YangTextSchemaSource> ret = texts.get(sourceIdentifier);
271 LOG.debug("Lookup {} result {}", sourceIdentifier, ret);
273 return immediateFailedFluentFuture(new MissingSchemaSourceException("URL for " + sourceIdentifier
274 + " not registered", sourceIdentifier));
277 return immediateFluentFuture(ret.iterator().next());
281 * Return the set of sources currently available in this resolved.
283 * @return An immutable point-in-time view of available sources.
285 public synchronized Set<SourceIdentifier> getAvailableSources() {
286 return ImmutableSet.copyOf(texts.keySet());
290 public synchronized Collection<YangTextSchemaSource> getSourceTexts(final SourceIdentifier sourceIdentifier) {
291 return ImmutableSet.copyOf(texts.get(sourceIdentifier));
295 public EffectiveModelContext trySchemaContext() throws SchemaResolutionException {
296 return trySchemaContext(StatementParserMode.DEFAULT_MODE);
300 @SuppressWarnings("checkstyle:avoidHidingCauseException")
301 public EffectiveModelContext trySchemaContext(final StatementParserMode statementParserMode)
302 throws SchemaResolutionException {
303 final ListenableFuture<EffectiveModelContext> future = repository
304 .createEffectiveModelContextFactory(config(statementParserMode))
305 .createEffectiveModelContext(ImmutableSet.copyOf(requiredSources));
309 } catch (final InterruptedException e) {
310 throw new IllegalStateException("Interrupted while waiting for SchemaContext assembly", e);
311 } catch (final ExecutionException e) {
312 final Throwable cause = e.getCause();
313 if (cause instanceof SchemaResolutionException) {
314 throw (SchemaResolutionException) cause;
317 throw new SchemaResolutionException("Failed to assemble SchemaContext", e);
322 public void close() {
326 private static SchemaContextFactoryConfiguration config(final StatementParserMode statementParserMode) {
327 return SchemaContextFactoryConfiguration.builder().setStatementParserMode(statementParserMode).build();