parser/yang-parser-rfc7950/src/main/java/org/opendaylight/yangtools/yang/parser/rfc7950/stmt/uses/UsesStatementSupport.java

   1 /*
   2  * Copyright (c) 2017 Pantheon Technologies, s.r.o. 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.rfc7950.stmt.uses;
   9
  10 import static com.google.common.base.Verify.verify;
  11 import static com.google.common.base.Verify.verifyNotNull;
  12
  13 import com.google.common.collect.ImmutableList;
  14 import com.google.common.collect.ImmutableMap;
  15 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
  16 import java.util.ArrayList;
  17 import java.util.Collection;
  18 import java.util.LinkedHashMap;
  19 import java.util.Map;
  20 import java.util.Optional;
  21 import org.eclipse.jdt.annotation.NonNull;
  22 import org.opendaylight.yangtools.yang.common.Empty;
  23 import org.opendaylight.yangtools.yang.common.QName;
  24 import org.opendaylight.yangtools.yang.common.QNameModule;
  25 import org.opendaylight.yangtools.yang.common.SchemaNodeIdentifier;
  26 import org.opendaylight.yangtools.yang.common.SchemaNodeIdentifier.Descendant;
  27 import org.opendaylight.yangtools.yang.common.YangVersion;
  28 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
  29 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
  30 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
  31 import org.opendaylight.yangtools.yang.model.api.meta.DeclarationReference;
  32 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  33 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  34 import org.opendaylight.yangtools.yang.model.api.meta.StatementDefinition;
  35 import org.opendaylight.yangtools.yang.model.api.stmt.RefineEffectiveStatement;
  36 import org.opendaylight.yangtools.yang.model.api.stmt.RefineStatement;
  37 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaTreeEffectiveStatement;
  38 import org.opendaylight.yangtools.yang.model.api.stmt.UsesEffectiveStatement;
  39 import org.opendaylight.yangtools.yang.model.api.stmt.UsesStatement;
  40 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatementDecorators;
  41 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatements;
  42 import org.opendaylight.yangtools.yang.model.spi.meta.EffectiveStatementMixins;
  43 import org.opendaylight.yangtools.yang.parser.api.YangParserConfiguration;
  44 import org.opendaylight.yangtools.yang.parser.rfc7950.reactor.YangValidationBundles;
  45 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.refine.RefineEffectiveStatementImpl;
  46 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.refine.RefineTargetNamespace;
  47 import org.opendaylight.yangtools.yang.parser.spi.GroupingNamespace;
  48 import org.opendaylight.yangtools.yang.parser.spi.SchemaTreeNamespace;
  49 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractQNameStatementSupport;
  50 import org.opendaylight.yangtools.yang.parser.spi.meta.CopyType;
  51 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
  52 import org.opendaylight.yangtools.yang.parser.spi.meta.InferenceException;
  53 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder;
  54 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.InferenceAction;
  55 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.InferenceContext;
  56 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.Prerequisite;
  57 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase;
  58 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  59 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
  60 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
  61 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
  62 import org.opendaylight.yangtools.yang.parser.spi.source.ModuleCtxToModuleQName;
  63 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
  64 import org.opendaylight.yangtools.yang.parser.spi.validation.ValidationBundlesNamespace;
  65 import org.opendaylight.yangtools.yang.parser.spi.validation.ValidationBundlesNamespace.ValidationBundleType;
  66 import org.opendaylight.yangtools.yang.parser.stmt.reactor.StatementContextBase;
  67 import org.slf4j.Logger;
  68 import org.slf4j.LoggerFactory;
  69
  70 public final class UsesStatementSupport
  71         extends AbstractQNameStatementSupport<UsesStatement, UsesEffectiveStatement> {
  72     private static final Logger LOG = LoggerFactory.getLogger(UsesStatementSupport.class);
  73     private static final SubstatementValidator SUBSTATEMENT_VALIDATOR =
  74         SubstatementValidator.builder(YangStmtMapping.USES)
  75             .addAny(YangStmtMapping.AUGMENT)
  76             .addOptional(YangStmtMapping.DESCRIPTION)
  77             .addAny(YangStmtMapping.IF_FEATURE)
  78             .addAny(YangStmtMapping.REFINE)
  79             .addOptional(YangStmtMapping.REFERENCE)
  80             .addOptional(YangStmtMapping.STATUS)
  81             .addOptional(YangStmtMapping.WHEN)
  82             .build();
  83
  84     public UsesStatementSupport(final YangParserConfiguration config) {
  85         super(YangStmtMapping.USES, StatementPolicy.exactReplica(), config, SUBSTATEMENT_VALIDATOR);
  86     }
  87
  88     @Override
  89     public QName parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
  90         return StmtContextUtils.parseNodeIdentifier(ctx, value);
  91     }
  92
  93     @Override
  94     public void onFullDefinitionDeclared(final Mutable<QName, UsesStatement, UsesEffectiveStatement> usesNode) {
  95         if (!usesNode.isSupportedByFeatures()) {
  96             return;
  97         }
  98         super.onFullDefinitionDeclared(usesNode);
  99
 100         final ModelActionBuilder usesAction = usesNode.newInferenceAction(ModelProcessingPhase.EFFECTIVE_MODEL);
 101         final QName groupingName = usesNode.argument();
 102
 103         final Prerequisite<StmtContext<?, ?, ?>> sourceGroupingPre = usesAction.requiresCtx(usesNode,
 104                 GroupingNamespace.class, groupingName, ModelProcessingPhase.EFFECTIVE_MODEL);
 105         final Prerequisite<? extends StmtContext.Mutable<?, ?, ?>> targetNodePre = usesAction.mutatesEffectiveCtx(
 106                 usesNode.getParentContext());
 107
 108         usesAction.apply(new InferenceAction() {
 109
 110             @Override
 111             public void apply(final InferenceContext ctx) {
 112                 final StatementContextBase<?, ?, ?> targetNodeStmtCtx =
 113                         (StatementContextBase<?, ?, ?>) targetNodePre.resolve(ctx);
 114                 final StatementContextBase<?, ?, ?> sourceGrpStmtCtx =
 115                         (StatementContextBase<?, ?, ?>) sourceGroupingPre.resolve(ctx);
 116
 117                 copyFromSourceToTarget(sourceGrpStmtCtx, targetNodeStmtCtx, usesNode);
 118                 resolveUsesNode(usesNode, targetNodeStmtCtx);
 119                 StmtContextUtils.validateIfFeatureAndWhenOnListKeys(usesNode);
 120                 usesNode.addToNs(SourceGroupingNamespace.class, Empty.getInstance(), sourceGrpStmtCtx);
 121             }
 122
 123             @Override
 124             public void prerequisiteFailed(final Collection<? extends Prerequisite<?>> failed) {
 125                 InferenceException.throwIf(failed.contains(sourceGroupingPre), usesNode,
 126                     "Grouping '%s' was not resolved.", groupingName);
 127                 throw new InferenceException("Unknown error occurred.", usesNode);
 128             }
 129         });
 130     }
 131
 132     @Override
 133     protected UsesStatement createDeclared(final StmtContext<QName, UsesStatement, ?> ctx,
 134             final ImmutableList<? extends DeclaredStatement<?>> substatements) {
 135         return DeclaredStatements.createUses(ctx.getRawArgument(), ctx.getArgument(), substatements);
 136     }
 137
 138     @Override
 139     protected UsesStatement attachDeclarationReference(final UsesStatement stmt, final DeclarationReference reference) {
 140         return DeclaredStatementDecorators.decorateUses(stmt, reference);
 141     }
 142
 143     @Override
 144     protected UsesEffectiveStatement createEffective(final Current<QName, UsesStatement> stmt,
 145             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 146         final EffectiveStatement<?, ?> source =
 147             verifyNotNull(stmt.getFromNamespace(SourceGroupingNamespace.class, Empty.getInstance())).buildEffective();
 148         verify(source instanceof GroupingDefinition, "Unexpected source %s", source);
 149         final GroupingDefinition sourceGrouping = (GroupingDefinition) source;
 150
 151         final int flags = EffectiveStatementMixins.historyAndStatusFlags(stmt.history(), substatements);
 152         final QName argument = stmt.getArgument();
 153         final UsesStatement declared = stmt.declared();
 154
 155         if (substatements.isEmpty()) {
 156             return argument.equals(declared.argument())
 157                 ? new EmptyLocalUsesEffectiveStatement(declared, sourceGrouping, flags)
 158                         : new SimpleCopiedUsesEffectiveStatement(declared, argument, sourceGrouping, flags);
 159         }
 160
 161         if (declared.argument().equals(argument)) {
 162             return new RegularLocalUsesEffectiveStatement(declared, sourceGrouping, flags, substatements);
 163         }
 164         if (findFirstStatement(substatements, RefineEffectiveStatement.class) == null) {
 165             return new SimpleCopiedUsesEffectiveStatement(declared, argument, sourceGrouping, flags, substatements);
 166         }
 167         return new FullCopiedUsesEffectiveStatement(declared, argument, sourceGrouping, flags, substatements);
 168     }
 169
 170     static @NonNull ImmutableMap<Descendant, SchemaNode> indexRefines(
 171             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 172         final Map<Descendant, SchemaNode> refines = new LinkedHashMap<>();
 173
 174         for (EffectiveStatement<?, ?> effectiveStatement : substatements) {
 175             if (effectiveStatement instanceof RefineEffectiveStatementImpl) {
 176                 final RefineEffectiveStatementImpl refineStmt = (RefineEffectiveStatementImpl) effectiveStatement;
 177                 refines.put(refineStmt.argument(), refineStmt.getRefineTargetNode());
 178             }
 179         }
 180
 181         return ImmutableMap.copyOf(refines);
 182     }
 183
 184     /**
 185      * Copy statements from a grouping to a target node.
 186      *
 187      * @param sourceGrpStmtCtx
 188      *            source grouping statement context
 189      * @param targetCtx
 190      *            target context
 191      * @param usesNode
 192      *            uses node
 193      * @throws SourceException
 194      *             instance of SourceException
 195      */
 196     @SuppressFBWarnings(value = "UPM_UNCALLED_PRIVATE_METHOD",
 197             justification = "https://github.com/spotbugs/spotbugs/issues/811")
 198     private static void copyFromSourceToTarget(final Mutable<?, ?, ?> sourceGrpStmtCtx,
 199             final StatementContextBase<?, ?, ?> targetCtx,
 200             final Mutable<QName, UsesStatement, UsesEffectiveStatement> usesNode) {
 201         final Collection<? extends Mutable<?, ?, ?>> declared = sourceGrpStmtCtx.mutableDeclaredSubstatements();
 202         final Collection<? extends Mutable<?, ?, ?>> effective = sourceGrpStmtCtx.mutableEffectiveSubstatements();
 203         final Collection<Mutable<?, ?, ?>> buffer = new ArrayList<>(declared.size() + effective.size());
 204         final QNameModule newQNameModule = getNewQNameModule(targetCtx, sourceGrpStmtCtx);
 205
 206         for (final Mutable<?, ?, ?> original : declared) {
 207             if (original.isSupportedByFeatures() && shouldCopy(original)) {
 208                 original.copyAsChildOf(targetCtx, CopyType.ADDED_BY_USES, newQNameModule).ifPresent(buffer::add);
 209             }
 210         }
 211
 212         for (final Mutable<?, ?, ?> original : effective) {
 213             if (shouldCopy(original)) {
 214                 original.copyAsChildOf(targetCtx, CopyType.ADDED_BY_USES, newQNameModule).ifPresent(buffer::add);
 215             }
 216         }
 217
 218         targetCtx.addEffectiveSubstatements(buffer);
 219         usesNode.addAsEffectOfStatement(buffer);
 220     }
 221
 222     private static boolean shouldCopy(final StmtContext<?, ?, ?> stmt) {
 223         // https://tools.ietf.org/html/rfc7950#section-7.13:
 224         //
 225         //        The effect of a "uses" reference to a grouping is that the nodes
 226         //        defined by the grouping are copied into the current schema tree and
 227         //        are then updated according to the "refine" and "augment" statements.
 228         //
 229         // This means that the statement that is about to be copied (and can be subjected to buildEffective() I think)
 230         // is actually a SchemaTreeEffectiveStatement
 231         if (SchemaTreeEffectiveStatement.class.isAssignableFrom(
 232                 stmt.publicDefinition().getEffectiveRepresentationClass())) {
 233             return true;
 234         }
 235
 236         // As per https://tools.ietf.org/html/rfc7950#section-7.13.2:
 237         //
 238         //        o  Any node can get refined extensions, if the extension allows
 239         //           refinement.  See Section 7.19 for details.
 240         //
 241         // and https://tools.ietf.org/html/rfc7950#section-7.19:
 242         //
 243         //        An extension can allow refinement (see Section 7.13.2) and deviations
 244         //        (Section 7.20.3.2), but the mechanism for how this is defined is
 245         //        outside the scope of this specification.
 246         //
 247         // This is actively used out there (tailf-common.yang's tailf:action), which is incorrect, though. They do
 248         // publish a bunch of metadata (through tailf-meta-extension.yang), but fail to publish a key aspect of the
 249         // statement: it attaches to schema tree namespace (just as RFC7950 action does). Such an extension would
 250         // automatically result in the extension being picked up by the above check and everybody would live happily
 251         // ever after.
 252         //
 253         // We do not live in that world yet, hence we do the following and keep our fingers crossed.
 254         // FIXME: YANGTOOLS-403: this should not be necessary once we implement the above (although tests will complain)
 255         return StmtContextUtils.isUnknownStatement(stmt);
 256     }
 257
 258     private static QNameModule getNewQNameModule(final StmtContext<?, ?, ?> targetCtx,
 259             final StmtContext<?, ?, ?> stmtContext) {
 260         if (targetCtx.getParentContext() == null) {
 261             return targetCtx.getFromNamespace(ModuleCtxToModuleQName.class, targetCtx);
 262         }
 263         if (targetCtx.publicDefinition() == YangStmtMapping.AUGMENT) {
 264             return StmtContextUtils.getRootModuleQName(targetCtx);
 265         }
 266
 267         final Object targetStmtArgument = targetCtx.argument();
 268         final Object sourceStmtArgument = stmtContext.argument();
 269         if (targetStmtArgument instanceof QName && sourceStmtArgument instanceof QName) {
 270             return ((QName) targetStmtArgument).getModule();
 271         }
 272
 273         return null;
 274     }
 275
 276     @SuppressFBWarnings(value = "UPM_UNCALLED_PRIVATE_METHOD",
 277             justification = "https://github.com/spotbugs/spotbugs/issues/811")
 278     private static void resolveUsesNode(final Mutable<QName, UsesStatement, UsesEffectiveStatement> usesNode,
 279             final StmtContext<?, ?, ?> targetNodeStmtCtx) {
 280         for (final Mutable<?, ?, ?> subStmtCtx : usesNode.mutableDeclaredSubstatements()) {
 281             if (subStmtCtx.producesDeclared(RefineStatement.class) && areFeaturesSupported(subStmtCtx)) {
 282                 performRefine(subStmtCtx, targetNodeStmtCtx);
 283             }
 284         }
 285     }
 286
 287     private static boolean areFeaturesSupported(final StmtContext<?, ?, ?> subStmtCtx) {
 288         /*
 289          * In case of Yang 1.1, checks whether features are supported.
 290          */
 291         return !YangVersion.VERSION_1_1.equals(subStmtCtx.yangVersion()) || subStmtCtx.isSupportedByFeatures();
 292     }
 293
 294     private static void performRefine(final Mutable<?, ?, ?> subStmtCtx, final StmtContext<?, ?, ?> usesParentCtx) {
 295         final Object refineArgument = subStmtCtx.argument();
 296         InferenceException.throwIf(!(refineArgument instanceof SchemaNodeIdentifier), subStmtCtx,
 297             "Invalid refine argument %s. It must be instance of SchemaNodeIdentifier.", refineArgument);
 298
 299         final Optional<StmtContext<?, ?, ?>> optRefineTargetCtx = SchemaTreeNamespace.findNode(
 300             usesParentCtx, (SchemaNodeIdentifier) refineArgument);
 301         InferenceException.throwIf(!optRefineTargetCtx.isPresent(), subStmtCtx, "Refine target node %s not found.",
 302             refineArgument);
 303
 304         // FIXME: This communicates the looked-up target node to RefineStatementSupport.buildEffective(). We should do
 305         //        this trick through a shared namespace or similar reactor-agnostic meeting place. It really feels like
 306         //        an inference action RefineStatementSupport should be doing.
 307         final StmtContext<?, ?, ?> refineTargetNodeCtx = optRefineTargetCtx.get();
 308         if (StmtContextUtils.isUnknownStatement(refineTargetNodeCtx)) {
 309             LOG.trace("Refine node '{}' in uses '{}' has target node unknown statement '{}'. "
 310                 + "Refine has been skipped. At line: {}", subStmtCtx.argument(),
 311                 subStmtCtx.coerceParentContext().argument(), refineTargetNodeCtx.argument(),
 312                 subStmtCtx.sourceReference());
 313         } else {
 314             verify(refineTargetNodeCtx instanceof StatementContextBase);
 315             addOrReplaceNodes(subStmtCtx, (StatementContextBase<?, ?, ?>) refineTargetNodeCtx);
 316         }
 317
 318         // Target is a prerequisite for the 'refine', hence if the target is not supported, the refine is not supported
 319         // as well. Otherwise add a pointer to the target into refine's local namespace.
 320         if (refineTargetNodeCtx.isSupportedToBuildEffective()) {
 321             subStmtCtx.addToNs(RefineTargetNamespace.class, Empty.getInstance(), refineTargetNodeCtx);
 322         } else {
 323             subStmtCtx.setIsSupportedToBuildEffective(false);
 324         }
 325     }
 326
 327     private static void addOrReplaceNodes(final Mutable<?, ?, ?> subStmtCtx,
 328             final StatementContextBase<?, ?, ?> refineTargetNodeCtx) {
 329         for (final Mutable<?, ?, ?> refineSubstatementCtx : subStmtCtx.mutableDeclaredSubstatements()) {
 330             if (isSupportedRefineSubstatement(refineSubstatementCtx)) {
 331                 addOrReplaceNode(refineSubstatementCtx, refineTargetNodeCtx);
 332             }
 333         }
 334     }
 335
 336     private static void addOrReplaceNode(final Mutable<?, ?, ?> refineSubstatementCtx,
 337             final StatementContextBase<?, ?, ?> refineTargetNodeCtx) {
 338
 339         final StatementDefinition refineSubstatementDef = refineSubstatementCtx.publicDefinition();
 340
 341         SourceException.throwIf(!isSupportedRefineTarget(refineSubstatementCtx, refineTargetNodeCtx),
 342                 refineSubstatementCtx,
 343                 "Error in module '%s' in the refine of uses '%s': can not perform refine of '%s' for the target '%s'.",
 344                 refineSubstatementCtx.getRoot().rawArgument(), refineSubstatementCtx.coerceParentContext().argument(),
 345                 refineSubstatementCtx.publicDefinition(), refineTargetNodeCtx.publicDefinition());
 346
 347         if (!isAllowedToAddByRefine(refineSubstatementDef)) {
 348             refineTargetNodeCtx.removeStatementFromEffectiveSubstatements(refineSubstatementDef);
 349         }
 350         refineTargetNodeCtx.addEffectiveSubstatement(refineSubstatementCtx.replicaAsChildOf(refineTargetNodeCtx));
 351     }
 352
 353     // FIXME: clarify this and inline into single caller
 354     private static boolean isAllowedToAddByRefine(final StatementDefinition publicDefinition) {
 355         return YangStmtMapping.MUST.equals(publicDefinition);
 356     }
 357
 358     private static boolean isSupportedRefineSubstatement(final StmtContext<?, ?, ?> refineSubstatementCtx) {
 359         final Collection<?> supportedRefineSubstatements = refineSubstatementCtx.getFromNamespace(
 360                 ValidationBundlesNamespace.class, ValidationBundleType.SUPPORTED_REFINE_SUBSTATEMENTS);
 361
 362         return supportedRefineSubstatements == null || supportedRefineSubstatements.isEmpty()
 363                 || supportedRefineSubstatements.contains(refineSubstatementCtx.publicDefinition())
 364                 || StmtContextUtils.isUnknownStatement(refineSubstatementCtx);
 365     }
 366
 367     private static boolean isSupportedRefineTarget(final StmtContext<?, ?, ?> refineSubstatementCtx,
 368             final StmtContext<?, ?, ?> refineTargetNodeCtx) {
 369         final Collection<?> supportedRefineTargets = YangValidationBundles.SUPPORTED_REFINE_TARGETS.get(
 370             refineSubstatementCtx.publicDefinition());
 371
 372         return supportedRefineTargets == null || supportedRefineTargets.isEmpty()
 373                 || supportedRefineTargets.contains(refineTargetNodeCtx.publicDefinition());
 374     }
 375 }