yang/yang-parser-reactor/src/main/java/org/opendaylight/yangtools/yang/parser/stmt/reactor/BuildGlobalContext.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.yangtools.yang.parser.stmt.reactor;
   9
  10 import static com.google.common.base.Preconditions.checkState;
  11 import static java.util.Objects.requireNonNull;
  12
  13 import com.google.common.base.Verify;
  14 import com.google.common.collect.HashBasedTable;
  15 import com.google.common.collect.ImmutableList;
  16 import com.google.common.collect.ImmutableMap;
  17 import com.google.common.collect.ImmutableSet;
  18 import com.google.common.collect.Table;
  19 import com.google.common.collect.TreeBasedTable;
  20 import java.util.ArrayList;
  21 import java.util.Collection;
  22 import java.util.HashMap;
  23 import java.util.HashSet;
  24 import java.util.Iterator;
  25 import java.util.List;
  26 import java.util.Map;
  27 import java.util.Map.Entry;
  28 import java.util.Objects;
  29 import java.util.Optional;
  30 import java.util.Set;
  31 import java.util.SortedMap;
  32 import javax.annotation.Nonnull;
  33 import org.opendaylight.yangtools.util.RecursiveObjectLeaker;
  34 import org.opendaylight.yangtools.yang.common.QName;
  35 import org.opendaylight.yangtools.yang.common.QNameModule;
  36 import org.opendaylight.yangtools.yang.common.Revision;
  37 import org.opendaylight.yangtools.yang.common.YangVersion;
  38 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  39 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  40 import org.opendaylight.yangtools.yang.model.api.meta.IdentifierNamespace;
  41 import org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier;
  42 import org.opendaylight.yangtools.yang.model.repo.api.StatementParserMode;
  43 import org.opendaylight.yangtools.yang.parser.spi.meta.DerivedNamespaceBehaviour;
  44 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase;
  45 import org.opendaylight.yangtools.yang.parser.spi.meta.MutableStatement;
  46 import org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceBehaviour;
  47 import org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceBehaviour.NamespaceStorageNode;
  48 import org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceBehaviour.Registry;
  49 import org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceBehaviour.StorageNodeType;
  50 import org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceNotAvailableException;
  51 import org.opendaylight.yangtools.yang.parser.spi.meta.ReactorException;
  52 import org.opendaylight.yangtools.yang.parser.spi.meta.SomeModifiersUnresolvedException;
  53 import org.opendaylight.yangtools.yang.parser.spi.meta.StatementSupport;
  54 import org.opendaylight.yangtools.yang.parser.spi.meta.StatementSupportBundle;
  55 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
  56 import org.opendaylight.yangtools.yang.parser.spi.source.ModulesDeviatedByModules;
  57 import org.opendaylight.yangtools.yang.parser.spi.source.ModulesDeviatedByModules.SupportedModules;
  58 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
  59 import org.opendaylight.yangtools.yang.parser.spi.source.StatementStreamSource;
  60 import org.opendaylight.yangtools.yang.parser.spi.source.SupportedFeaturesNamespace;
  61 import org.opendaylight.yangtools.yang.parser.spi.source.SupportedFeaturesNamespace.SupportedFeatures;
  62 import org.opendaylight.yangtools.yang.parser.spi.validation.ValidationBundlesNamespace;
  63 import org.opendaylight.yangtools.yang.parser.spi.validation.ValidationBundlesNamespace.ValidationBundleType;
  64 import org.opendaylight.yangtools.yang.parser.stmt.reactor.SourceSpecificContext.PhaseCompletionProgress;
  65 import org.slf4j.Logger;
  66 import org.slf4j.LoggerFactory;
  67
  68 class BuildGlobalContext extends NamespaceStorageSupport implements Registry {
  69     private static final Logger LOG = LoggerFactory.getLogger(BuildGlobalContext.class);
  70
  71     private static final List<ModelProcessingPhase> PHASE_EXECUTION_ORDER =
  72             ImmutableList.<ModelProcessingPhase>builder().add(ModelProcessingPhase.SOURCE_PRE_LINKAGE)
  73             .add(ModelProcessingPhase.SOURCE_LINKAGE).add(ModelProcessingPhase.STATEMENT_DEFINITION)
  74             .add(ModelProcessingPhase.FULL_DECLARATION).add(ModelProcessingPhase.EFFECTIVE_MODEL).build();
  75
  76     private final Table<YangVersion, QName, StatementDefinitionContext<?, ?, ?>> definitions = HashBasedTable.create();
  77     private final Map<QName, StatementDefinitionContext<?, ?, ?>> modelDefinedStmtDefs = new HashMap<>();
  78     private final Map<Class<?>, NamespaceBehaviourWithListeners<?, ?, ?>> supportedNamespaces = new HashMap<>();
  79     private final List<MutableStatement> mutableStatementsToSeal = new ArrayList<>();
  80     private final Map<ModelProcessingPhase, StatementSupportBundle> supports;
  81     private final Set<SourceSpecificContext> sources = new HashSet<>();
  82     private final Set<YangVersion> supportedVersions;
  83     private final boolean enabledSemanticVersions;
  84
  85     private Set<SourceSpecificContext> libSources = new HashSet<>();
  86     private ModelProcessingPhase currentPhase = ModelProcessingPhase.INIT;
  87     private ModelProcessingPhase finishedPhase = ModelProcessingPhase.INIT;
  88
  89     BuildGlobalContext(final Map<ModelProcessingPhase, StatementSupportBundle> supports,
  90             final Map<ValidationBundleType, Collection<?>> supportedValidation,
  91             final StatementParserMode statementParserMode) {
  92         this.supports = requireNonNull(supports, "BuildGlobalContext#supports cannot be null");
  93
  94         switch (statementParserMode) {
  95             case DEFAULT_MODE:
  96                 enabledSemanticVersions = false;
  97                 break;
  98             case SEMVER_MODE:
  99                 enabledSemanticVersions = true;
 100                 break;
 101             default:
 102                 throw new IllegalArgumentException("Unhandled parser mode " + statementParserMode);
 103         }
 104
 105         for (final Entry<ValidationBundleType, Collection<?>> validationBundle : supportedValidation.entrySet()) {
 106             addToNs(ValidationBundlesNamespace.class, validationBundle.getKey(), validationBundle.getValue());
 107         }
 108
 109         this.supportedVersions = ImmutableSet.copyOf(supports.get(ModelProcessingPhase.INIT).getSupportedVersions());
 110     }
 111
 112     boolean isEnabledSemanticVersioning() {
 113         return enabledSemanticVersions;
 114     }
 115
 116     StatementSupportBundle getSupportsForPhase(final ModelProcessingPhase currentPhase) {
 117         return supports.get(currentPhase);
 118     }
 119
 120     void addSource(@Nonnull final StatementStreamSource source) {
 121         sources.add(new SourceSpecificContext(this, source));
 122     }
 123
 124     void addLibSource(@Nonnull final StatementStreamSource libSource) {
 125         checkState(!isEnabledSemanticVersioning(),
 126             "Library sources are not supported in semantic version mode currently.");
 127         checkState(currentPhase == ModelProcessingPhase.INIT,
 128                 "Add library source is allowed in ModelProcessingPhase.INIT only");
 129         libSources.add(new SourceSpecificContext(this, libSource));
 130     }
 131
 132     void setSupportedFeatures(final Set<QName> supportedFeatures) {
 133         addToNs(SupportedFeaturesNamespace.class, SupportedFeatures.SUPPORTED_FEATURES,
 134                     ImmutableSet.copyOf(supportedFeatures));
 135     }
 136
 137     void setModulesDeviatedByModules(final Map<QNameModule, Set<QNameModule>> modulesDeviatedByModules) {
 138         addToNs(ModulesDeviatedByModules.class, SupportedModules.SUPPORTED_MODULES,
 139                     ImmutableMap.copyOf(modulesDeviatedByModules));
 140     }
 141
 142     @Override
 143     public StorageNodeType getStorageNodeType() {
 144         return StorageNodeType.GLOBAL;
 145     }
 146
 147     @Override
 148     public NamespaceStorageNode getParentNamespaceStorage() {
 149         return null;
 150     }
 151
 152     @Override
 153     public NamespaceBehaviour.Registry getBehaviourRegistry() {
 154         return this;
 155     }
 156
 157     @Override
 158     public <K, V, N extends IdentifierNamespace<K, V>> NamespaceBehaviourWithListeners<K, V, N> getNamespaceBehaviour(
 159             final Class<N> type) {
 160         NamespaceBehaviourWithListeners<?, ?, ?> potential = supportedNamespaces.get(type);
 161         if (potential == null) {
 162             final NamespaceBehaviour<K, V, N> potentialRaw = supports.get(currentPhase).getNamespaceBehaviour(type);
 163             if (potentialRaw != null) {
 164                 potential = createNamespaceContext(potentialRaw);
 165                 supportedNamespaces.put(type, potential);
 166             } else {
 167                 throw new NamespaceNotAvailableException("Namespace " + type + " is not available in phase "
 168                         + currentPhase);
 169             }
 170         }
 171
 172         Verify.verify(type.equals(potential.getIdentifier()));
 173         /*
 174          * Safe cast, previous checkState checks equivalence of key from which
 175          * type argument are derived
 176          */
 177         return (NamespaceBehaviourWithListeners<K, V, N>) potential;
 178     }
 179
 180     @SuppressWarnings({ "unchecked", "rawtypes" })
 181     private <K, V, N extends IdentifierNamespace<K, V>> NamespaceBehaviourWithListeners<K, V, N> createNamespaceContext(
 182             final NamespaceBehaviour<K, V, N> potentialRaw) {
 183         if (potentialRaw instanceof DerivedNamespaceBehaviour) {
 184             final VirtualNamespaceContext derivedContext = new VirtualNamespaceContext(
 185                     (DerivedNamespaceBehaviour) potentialRaw);
 186             getNamespaceBehaviour(((DerivedNamespaceBehaviour) potentialRaw).getDerivedFrom()).addDerivedNamespace(
 187                     derivedContext);
 188             return derivedContext;
 189         }
 190         return new SimpleNamespaceContext<>(potentialRaw);
 191     }
 192
 193     StatementDefinitionContext<?, ?, ?> getStatementDefinition(final YangVersion version, final QName name) {
 194         StatementDefinitionContext<?, ?, ?> potential = definitions.get(version, name);
 195         if (potential == null) {
 196             final StatementSupport<?, ?, ?> potentialRaw = supports.get(currentPhase).getStatementDefinition(version,
 197                     name);
 198             if (potentialRaw != null) {
 199                 potential = new StatementDefinitionContext<>(potentialRaw);
 200                 definitions.put(version, name, potential);
 201             }
 202         }
 203         return potential;
 204     }
 205
 206     StatementDefinitionContext<?, ?, ?> getModelDefinedStatementDefinition(final QName name) {
 207         return modelDefinedStmtDefs.get(name);
 208     }
 209
 210     void putModelDefinedStatementDefinition(final QName name, final StatementDefinitionContext<?, ?, ?> def) {
 211         modelDefinedStmtDefs.put(name, def);
 212     }
 213
 214     private void executePhases() throws ReactorException {
 215         for (final ModelProcessingPhase phase : PHASE_EXECUTION_ORDER) {
 216             startPhase(phase);
 217             loadPhaseStatements();
 218             completePhaseActions();
 219             endPhase(phase);
 220         }
 221     }
 222
 223     EffectiveModelContext build() throws ReactorException {
 224         executePhases();
 225         return transform();
 226     }
 227
 228     EffectiveSchemaContext buildEffective() throws ReactorException {
 229         executePhases();
 230         return transformEffective();
 231     }
 232
 233     private EffectiveModelContext transform() {
 234         checkState(finishedPhase == ModelProcessingPhase.EFFECTIVE_MODEL);
 235         final List<DeclaredStatement<?>> rootStatements = new ArrayList<>(sources.size());
 236         for (final SourceSpecificContext source : sources) {
 237             rootStatements.add(source.getRoot().buildDeclared());
 238         }
 239         return new EffectiveModelContext(rootStatements);
 240     }
 241
 242     private SomeModifiersUnresolvedException propagateException(final SourceSpecificContext source,
 243             final RuntimeException cause) throws SomeModifiersUnresolvedException {
 244         final SourceIdentifier sourceId = StmtContextUtils.createSourceIdentifier(source.getRoot());
 245         if (!(cause instanceof SourceException)) {
 246             /*
 247              * This should not be happening as all our processing should provide SourceExceptions.
 248              * We will wrap the exception to provide enough information to identify the problematic model,
 249              * but also emit a warning so the offending codepath will get fixed.
 250              */
 251             LOG.warn("Unexpected error processing source {}. Please file an issue with this model attached.",
 252                 sourceId, cause);
 253         }
 254
 255         throw new SomeModifiersUnresolvedException(currentPhase, sourceId, cause);
 256     }
 257
 258     @SuppressWarnings("checkstyle:illegalCatch")
 259     private EffectiveSchemaContext transformEffective() throws ReactorException {
 260         checkState(finishedPhase == ModelProcessingPhase.EFFECTIVE_MODEL);
 261         final List<DeclaredStatement<?>> rootStatements = new ArrayList<>(sources.size());
 262         final List<EffectiveStatement<?, ?>> rootEffectiveStatements = new ArrayList<>(sources.size());
 263
 264         try {
 265             for (final SourceSpecificContext source : sources) {
 266                 final RootStatementContext<?, ?, ?> root = source.getRoot();
 267                 try {
 268                     rootStatements.add(root.buildDeclared());
 269                     rootEffectiveStatements.add(root.buildEffective());
 270                 } catch (final RuntimeException ex) {
 271                     throw propagateException(source, ex);
 272                 }
 273             }
 274         } finally {
 275             RecursiveObjectLeaker.cleanup();
 276         }
 277
 278         sealMutableStatements();
 279         return EffectiveSchemaContext.create(rootStatements, rootEffectiveStatements);
 280     }
 281
 282     private void startPhase(final ModelProcessingPhase phase) {
 283         checkState(Objects.equals(finishedPhase, phase.getPreviousPhase()));
 284         startPhaseFor(phase, sources);
 285         startPhaseFor(phase, libSources);
 286
 287         currentPhase = phase;
 288         LOG.debug("Global phase {} started", phase);
 289     }
 290
 291     private static void startPhaseFor(final ModelProcessingPhase phase, final Set<SourceSpecificContext> sources) {
 292         for (final SourceSpecificContext source : sources) {
 293             source.startPhase(phase);
 294         }
 295     }
 296
 297     private void loadPhaseStatements() throws ReactorException {
 298         checkState(currentPhase != null);
 299         loadPhaseStatementsFor(sources);
 300         loadPhaseStatementsFor(libSources);
 301     }
 302
 303     @SuppressWarnings("checkstyle:illegalCatch")
 304     private void loadPhaseStatementsFor(final Set<SourceSpecificContext> sources) throws ReactorException {
 305         for (final SourceSpecificContext source : sources) {
 306             try {
 307                 source.loadStatements();
 308             } catch (final RuntimeException ex) {
 309                 throw propagateException(source, ex);
 310             }
 311         }
 312     }
 313
 314     private SomeModifiersUnresolvedException addSourceExceptions(final List<SourceSpecificContext> sourcesToProgress) {
 315         boolean addedCause = false;
 316         SomeModifiersUnresolvedException buildFailure = null;
 317         for (final SourceSpecificContext failedSource : sourcesToProgress) {
 318             final Optional<SourceException> optSourceEx = failedSource.failModifiers(currentPhase);
 319             if (!optSourceEx.isPresent()) {
 320                 continue;
 321             }
 322
 323             final SourceException sourceEx = optSourceEx.get();
 324             // Workaround for broken logging implementations which ignore
 325             // suppressed exceptions
 326             final Throwable cause = sourceEx.getCause() != null ? sourceEx.getCause() : sourceEx;
 327             if (LOG.isDebugEnabled()) {
 328                 LOG.error("Failed to parse YANG from source {}", failedSource, sourceEx);
 329             } else {
 330                 LOG.error("Failed to parse YANG from source {}: {}", failedSource, cause.getMessage());
 331             }
 332
 333             final Throwable[] suppressed = sourceEx.getSuppressed();
 334             if (suppressed.length > 0) {
 335                 LOG.error("{} additional errors reported:", suppressed.length);
 336
 337                 int count = 1;
 338                 for (final Throwable t : suppressed) {
 339                     // FIXME: this should be configured in the appender, really
 340                     if (LOG.isDebugEnabled()) {
 341                         LOG.error("Error {}: {}", count, t.getMessage(), t);
 342                     } else {
 343                         LOG.error("Error {}: {}", count, t.getMessage());
 344                     }
 345
 346                     count++;
 347                 }
 348             }
 349
 350             if (!addedCause) {
 351                 addedCause = true;
 352                 final SourceIdentifier sourceId = StmtContextUtils.createSourceIdentifier(failedSource.getRoot());
 353                 buildFailure = new SomeModifiersUnresolvedException(currentPhase, sourceId, sourceEx);
 354             } else {
 355                 buildFailure.addSuppressed(sourceEx);
 356             }
 357         }
 358         return buildFailure;
 359     }
 360
 361     @SuppressWarnings("checkstyle:illegalCatch")
 362     private void completePhaseActions() throws ReactorException {
 363         checkState(currentPhase != null);
 364         final List<SourceSpecificContext> sourcesToProgress = new ArrayList<>(sources);
 365         if (!libSources.isEmpty()) {
 366             checkState(currentPhase == ModelProcessingPhase.SOURCE_PRE_LINKAGE,
 367                     "Yang library sources should be empty after ModelProcessingPhase.SOURCE_PRE_LINKAGE, "
 368                             + "but current phase was %s", currentPhase);
 369             sourcesToProgress.addAll(libSources);
 370         }
 371
 372         boolean progressing = true;
 373         while (progressing) {
 374             // We reset progressing to false.
 375             progressing = false;
 376             final Iterator<SourceSpecificContext> currentSource = sourcesToProgress.iterator();
 377             while (currentSource.hasNext()) {
 378                 final SourceSpecificContext nextSourceCtx = currentSource.next();
 379                 try {
 380                     final PhaseCompletionProgress sourceProgress = nextSourceCtx.tryToCompletePhase(currentPhase);
 381                     switch (sourceProgress) {
 382                         case FINISHED:
 383                             currentSource.remove();
 384                             // we were able to make progress in computation
 385                             progressing = true;
 386                             break;
 387                         case PROGRESS:
 388                             progressing = true;
 389                             break;
 390                         case NO_PROGRESS:
 391                             // Noop
 392                             break;
 393                         default:
 394                             throw new IllegalStateException("Unsupported phase progress " + sourceProgress);
 395                     }
 396                 } catch (final RuntimeException ex) {
 397                     throw propagateException(nextSourceCtx, ex);
 398                 }
 399             }
 400         }
 401
 402         if (!libSources.isEmpty()) {
 403             final Set<SourceSpecificContext> requiredLibs = getRequiredSourcesFromLib();
 404             sources.addAll(requiredLibs);
 405             libSources = ImmutableSet.of();
 406             /*
 407              * We want to report errors of relevant sources only, so any others can
 408              * be removed.
 409              */
 410             sourcesToProgress.retainAll(sources);
 411         }
 412
 413         if (!sourcesToProgress.isEmpty()) {
 414             final SomeModifiersUnresolvedException buildFailure = addSourceExceptions(sourcesToProgress);
 415             if (buildFailure != null) {
 416                 throw buildFailure;
 417             }
 418         }
 419     }
 420
 421     private Set<SourceSpecificContext> getRequiredSourcesFromLib() {
 422         checkState(currentPhase == ModelProcessingPhase.SOURCE_PRE_LINKAGE,
 423                 "Required library sources can be collected only in ModelProcessingPhase.SOURCE_PRE_LINKAGE phase,"
 424                         + " but current phase was %s", currentPhase);
 425         final TreeBasedTable<String, Optional<Revision>, SourceSpecificContext> libSourcesTable = TreeBasedTable.create(
 426             String::compareTo, Revision::compare);
 427         for (final SourceSpecificContext libSource : libSources) {
 428             final SourceIdentifier libSourceIdentifier = requireNonNull(libSource.getRootIdentifier());
 429             libSourcesTable.put(libSourceIdentifier.getName(), libSourceIdentifier.getRevision(), libSource);
 430         }
 431
 432         final Set<SourceSpecificContext> requiredLibs = new HashSet<>();
 433         for (final SourceSpecificContext source : sources) {
 434             collectRequiredSourcesFromLib(libSourcesTable, requiredLibs, source);
 435             removeConflictingLibSources(source, requiredLibs);
 436         }
 437         return requiredLibs;
 438     }
 439
 440     private void collectRequiredSourcesFromLib(
 441             final TreeBasedTable<String, Optional<Revision>, SourceSpecificContext> libSourcesTable,
 442             final Set<SourceSpecificContext> requiredLibs, final SourceSpecificContext source) {
 443         for (final SourceIdentifier requiredSource : source.getRequiredSources()) {
 444             final SourceSpecificContext libSource = getRequiredLibSource(requiredSource, libSourcesTable);
 445             if (libSource != null && requiredLibs.add(libSource)) {
 446                 collectRequiredSourcesFromLib(libSourcesTable, requiredLibs, libSource);
 447             }
 448         }
 449     }
 450
 451     private static SourceSpecificContext getRequiredLibSource(final SourceIdentifier requiredSource,
 452             final TreeBasedTable<String, Optional<Revision>, SourceSpecificContext> libSourcesTable) {
 453         return requiredSource.getRevision().isPresent()
 454                 ? libSourcesTable.get(requiredSource.getName(), requiredSource.getRevision())
 455                         : getLatestRevision(libSourcesTable.row(requiredSource.getName()));
 456     }
 457
 458     private static SourceSpecificContext getLatestRevision(final SortedMap<Optional<Revision>,
 459             SourceSpecificContext> sourceMap) {
 460         return sourceMap != null && !sourceMap.isEmpty() ? sourceMap.get(sourceMap.lastKey()) : null;
 461     }
 462
 463     // removes required library sources which would cause namespace/name conflict with one of the main sources
 464     // later in the parsing process. this can happen if we add a parent module or a submodule as a main source
 465     // and the same parent module or submodule is added as one of the library sources.
 466     // such situation may occur when using the yang-system-test artifact - if a parent module/submodule is specified
 467     // as its argument and the same dir is specified as one of the library dirs through -p option).
 468     private static void removeConflictingLibSources(final SourceSpecificContext source,
 469             final Set<SourceSpecificContext> requiredLibs) {
 470         final Iterator<SourceSpecificContext> requiredLibsIter = requiredLibs.iterator();
 471         while (requiredLibsIter.hasNext()) {
 472             final SourceSpecificContext currentReqSource = requiredLibsIter.next();
 473             if (source.getRootIdentifier().equals(currentReqSource.getRootIdentifier())) {
 474                 requiredLibsIter.remove();
 475             }
 476         }
 477     }
 478
 479     private void endPhase(final ModelProcessingPhase phase) {
 480         checkState(currentPhase == phase);
 481         finishedPhase = currentPhase;
 482         LOG.debug("Global phase {} finished", phase);
 483     }
 484
 485     Set<SourceSpecificContext> getSources() {
 486         return sources;
 487     }
 488
 489     public Set<YangVersion> getSupportedVersions() {
 490         return supportedVersions;
 491     }
 492
 493     void addMutableStmtToSeal(final MutableStatement mutableStatement) {
 494         mutableStatementsToSeal.add(mutableStatement);
 495     }
 496
 497     void sealMutableStatements() {
 498         for (final MutableStatement mutableStatement : mutableStatementsToSeal) {
 499             mutableStatement.seal();
 500         }
 501         mutableStatementsToSeal.clear();
 502     }
 503 }