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