2 * Copyright (c) 2017 Pantheon Technologies, s.r.o. 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.rfc7950.stmt.uses;
10 import static com.google.common.base.Verify.verify;
11 import static com.google.common.base.Verify.verifyNotNull;
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;
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.BoundStmtCtx;
51 import org.opendaylight.yangtools.yang.parser.spi.meta.CopyType;
52 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
53 import org.opendaylight.yangtools.yang.parser.spi.meta.InferenceException;
54 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder;
55 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.InferenceAction;
56 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.InferenceContext;
57 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.Prerequisite;
58 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase;
59 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
60 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
61 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
62 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
63 import org.opendaylight.yangtools.yang.parser.spi.source.ModuleCtxToModuleQName;
64 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
65 import org.opendaylight.yangtools.yang.parser.spi.validation.ValidationBundlesNamespace;
66 import org.opendaylight.yangtools.yang.parser.spi.validation.ValidationBundlesNamespace.ValidationBundleType;
67 import org.slf4j.Logger;
68 import org.slf4j.LoggerFactory;
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)
84 public UsesStatementSupport(final YangParserConfiguration config) {
85 super(YangStmtMapping.USES, StatementPolicy.exactReplica(), config, SUBSTATEMENT_VALIDATOR);
89 public QName parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
90 return StmtContextUtils.parseNodeIdentifier(ctx, value);
94 public void onFullDefinitionDeclared(final Mutable<QName, UsesStatement, UsesEffectiveStatement> usesNode) {
95 if (!usesNode.isSupportedByFeatures()) {
98 super.onFullDefinitionDeclared(usesNode);
100 final ModelActionBuilder usesAction = usesNode.newInferenceAction(ModelProcessingPhase.EFFECTIVE_MODEL);
101 final QName groupingName = usesNode.argument();
103 final Prerequisite<StmtContext<?, ?, ?>> sourceGroupingPre = usesAction.requiresCtx(usesNode,
104 GroupingNamespace.class, groupingName, ModelProcessingPhase.EFFECTIVE_MODEL);
105 final Prerequisite<? extends Mutable<?, ?, ?>> targetNodePre = usesAction.mutatesEffectiveCtx(
106 usesNode.getParentContext());
108 usesAction.apply(new InferenceAction() {
111 public void apply(final InferenceContext ctx) {
112 final Mutable<?, ?, ?> targetNodeStmtCtx = targetNodePre.resolve(ctx);
113 final StmtContext<?, ?, ?> sourceGrpStmtCtx = sourceGroupingPre.resolve(ctx);
115 copyFromSourceToTarget(sourceGrpStmtCtx, targetNodeStmtCtx, usesNode);
116 resolveUsesNode(usesNode, targetNodeStmtCtx);
117 StmtContextUtils.validateIfFeatureAndWhenOnListKeys(usesNode);
118 usesNode.addToNs(SourceGroupingNamespace.class, Empty.value(), sourceGrpStmtCtx);
122 public void prerequisiteFailed(final Collection<? extends Prerequisite<?>> failed) {
123 InferenceException.throwIf(failed.contains(sourceGroupingPre), usesNode,
124 "Grouping '%s' was not resolved.", groupingName);
125 throw new InferenceException("Unknown error occurred.", usesNode);
131 protected UsesStatement createDeclared(final BoundStmtCtx<QName> ctx,
132 final ImmutableList<DeclaredStatement<?>> substatements) {
133 return DeclaredStatements.createUses(ctx.getRawArgument(), ctx.getArgument(), substatements);
137 protected UsesStatement attachDeclarationReference(final UsesStatement stmt, final DeclarationReference reference) {
138 return DeclaredStatementDecorators.decorateUses(stmt, reference);
142 protected UsesEffectiveStatement createEffective(final Current<QName, UsesStatement> stmt,
143 final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
144 final EffectiveStatement<?, ?> source =
145 verifyNotNull(stmt.getFromNamespace(SourceGroupingNamespace.class, Empty.value())).buildEffective();
146 verify(source instanceof GroupingDefinition, "Unexpected source %s", source);
147 final GroupingDefinition sourceGrouping = (GroupingDefinition) source;
149 final int flags = EffectiveStmtUtils.historyAndStatusFlags(stmt.history(), substatements);
150 final QName argument = stmt.getArgument();
151 final UsesStatement declared = stmt.declared();
153 if (substatements.isEmpty()) {
154 return argument.equals(declared.argument())
155 ? new EmptyLocalUsesEffectiveStatement(declared, sourceGrouping, flags)
156 : new SimpleCopiedUsesEffectiveStatement(declared, argument, sourceGrouping, flags);
159 if (declared.argument().equals(argument)) {
160 return new RegularLocalUsesEffectiveStatement(declared, sourceGrouping, flags, substatements);
162 if (findFirstStatement(substatements, RefineEffectiveStatement.class) == null) {
163 return new SimpleCopiedUsesEffectiveStatement(declared, argument, sourceGrouping, flags, substatements);
165 return new FullCopiedUsesEffectiveStatement(declared, argument, sourceGrouping, flags, substatements);
168 static @NonNull ImmutableMap<Descendant, SchemaNode> indexRefines(
169 final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
170 final Map<Descendant, SchemaNode> refines = new LinkedHashMap<>();
172 for (EffectiveStatement<?, ?> effectiveStatement : substatements) {
173 if (effectiveStatement instanceof RefineEffectiveStatementImpl) {
174 final RefineEffectiveStatementImpl refineStmt = (RefineEffectiveStatementImpl) effectiveStatement;
175 refines.put(refineStmt.argument(), refineStmt.getRefineTargetNode());
179 return ImmutableMap.copyOf(refines);
183 * Copy statements from a grouping to a target node.
185 * @param sourceGrpStmtCtx
186 * source grouping statement context
191 * @throws SourceException
192 * instance of SourceException
194 @SuppressFBWarnings(value = "UPM_UNCALLED_PRIVATE_METHOD",
195 justification = "https://github.com/spotbugs/spotbugs/issues/811")
196 private static void copyFromSourceToTarget(final StmtContext<?, ?, ?> sourceGrpStmtCtx,
197 final Mutable<?, ?, ?> targetCtx, final Mutable<QName, UsesStatement, UsesEffectiveStatement> usesNode) {
198 final var declared = sourceGrpStmtCtx.declaredSubstatements();
199 final var effective = sourceGrpStmtCtx.effectiveSubstatements();
200 final var buffer = new ArrayList<Mutable<?, ?, ?>>(declared.size() + effective.size());
201 final QNameModule newQNameModule = getNewQNameModule(targetCtx, sourceGrpStmtCtx);
203 for (StmtContext<?, ?, ?> original : declared) {
204 if (original.isSupportedByFeatures() && shouldCopy(original)) {
205 original.copyAsChildOf(targetCtx, CopyType.ADDED_BY_USES, newQNameModule).ifPresent(buffer::add);
209 for (StmtContext<?, ?, ?> original : effective) {
210 if (shouldCopy(original)) {
211 original.copyAsChildOf(targetCtx, CopyType.ADDED_BY_USES, newQNameModule).ifPresent(buffer::add);
215 targetCtx.addEffectiveSubstatements(buffer);
216 usesNode.addAsEffectOfStatement(buffer);
219 private static boolean shouldCopy(final StmtContext<?, ?, ?> stmt) {
220 // https://tools.ietf.org/html/rfc7950#section-7.13:
222 // The effect of a "uses" reference to a grouping is that the nodes
223 // defined by the grouping are copied into the current schema tree and
224 // are then updated according to the "refine" and "augment" statements.
226 // This means that the statement that is about to be copied (and can be subjected to buildEffective() I think)
227 // is actually a SchemaTreeEffectiveStatement
228 if (SchemaTreeEffectiveStatement.class.isAssignableFrom(
229 stmt.publicDefinition().getEffectiveRepresentationClass())) {
233 // As per https://tools.ietf.org/html/rfc7950#section-7.13.2:
235 // o Any node can get refined extensions, if the extension allows
236 // refinement. See Section 7.19 for details.
238 // and https://tools.ietf.org/html/rfc7950#section-7.19:
240 // An extension can allow refinement (see Section 7.13.2) and deviations
241 // (Section 7.20.3.2), but the mechanism for how this is defined is
242 // outside the scope of this specification.
244 // This is actively used out there (tailf-common.yang's tailf:action), which is incorrect, though. They do
245 // publish a bunch of metadata (through tailf-meta-extension.yang), but fail to publish a key aspect of the
246 // statement: it attaches to schema tree namespace (just as RFC7950 action does). Such an extension would
247 // automatically result in the extension being picked up by the above check and everybody would live happily
250 // We do not live in that world yet, hence we do the following and keep our fingers crossed.
251 // FIXME: YANGTOOLS-403: this should not be necessary once we implement the above (although tests will complain)
252 return StmtContextUtils.isUnknownStatement(stmt);
255 private static QNameModule getNewQNameModule(final StmtContext<?, ?, ?> targetCtx,
256 final StmtContext<?, ?, ?> stmtContext) {
257 if (targetCtx.getParentContext() == null) {
258 return targetCtx.getFromNamespace(ModuleCtxToModuleQName.class, targetCtx);
260 if (targetCtx.publicDefinition() == YangStmtMapping.AUGMENT) {
261 return StmtContextUtils.getRootModuleQName(targetCtx);
264 final Object targetStmtArgument = targetCtx.argument();
265 final Object sourceStmtArgument = stmtContext.argument();
266 if (targetStmtArgument instanceof QName && sourceStmtArgument instanceof QName) {
267 return ((QName) targetStmtArgument).getModule();
273 @SuppressFBWarnings(value = "UPM_UNCALLED_PRIVATE_METHOD",
274 justification = "https://github.com/spotbugs/spotbugs/issues/811")
275 private static void resolveUsesNode(final Mutable<QName, UsesStatement, UsesEffectiveStatement> usesNode,
276 final StmtContext<?, ?, ?> targetNodeStmtCtx) {
277 for (Mutable<?, ?, ?> subStmtCtx : usesNode.mutableDeclaredSubstatements()) {
278 if (subStmtCtx.producesDeclared(RefineStatement.class) && areFeaturesSupported(subStmtCtx)) {
279 performRefine(subStmtCtx, targetNodeStmtCtx);
284 private static boolean areFeaturesSupported(final StmtContext<?, ?, ?> subStmtCtx) {
286 * In case of Yang 1.1, checks whether features are supported.
288 return !YangVersion.VERSION_1_1.equals(subStmtCtx.yangVersion()) || subStmtCtx.isSupportedByFeatures();
291 private static void performRefine(final Mutable<?, ?, ?> subStmtCtx, final StmtContext<?, ?, ?> usesParentCtx) {
292 final Object refineArgument = subStmtCtx.argument();
293 InferenceException.throwIf(!(refineArgument instanceof SchemaNodeIdentifier), subStmtCtx,
294 "Invalid refine argument %s. It must be instance of SchemaNodeIdentifier.", refineArgument);
296 // FIXME: this really should be handled via separate inference, i.e. we first instantiate the template and when
297 // it appears, this refine will trigger on it. This reinforces the FIXME below.
298 final Optional<StmtContext<?, ?, ?>> optRefineTargetCtx = SchemaTreeNamespace.findNode(
299 usesParentCtx, (SchemaNodeIdentifier) refineArgument);
300 InferenceException.throwIf(!optRefineTargetCtx.isPresent(), subStmtCtx, "Refine target node %s not found.",
303 // FIXME: This communicates the looked-up target node to RefineStatementSupport.buildEffective(). We should do
304 // this trick through a shared namespace or similar reactor-agnostic meeting place. It really feels like
305 // an inference action RefineStatementSupport should be doing.
306 final StmtContext<?, ?, ?> refineTargetNodeCtx = optRefineTargetCtx.get();
307 if (StmtContextUtils.isUnknownStatement(refineTargetNodeCtx)) {
308 LOG.trace("Refine node '{}' in uses '{}' has target node unknown statement '{}'. "
309 + "Refine has been skipped. At line: {}", subStmtCtx.argument(),
310 subStmtCtx.coerceParentContext().argument(), refineTargetNodeCtx.argument(),
311 subStmtCtx.sourceReference());
313 verify(refineTargetNodeCtx instanceof Mutable, "Unexpected target %s", refineTargetNodeCtx);
314 addOrReplaceNodes(subStmtCtx, (Mutable<?, ?, ?>) refineTargetNodeCtx);
317 // Target is a prerequisite for the 'refine', hence if the target is not supported, the refine is not supported
318 // as well. Otherwise add a pointer to the target into refine's local namespace.
319 if (refineTargetNodeCtx.isSupportedToBuildEffective()) {
320 subStmtCtx.addToNs(RefineTargetNamespace.class, Empty.value(), refineTargetNodeCtx);
322 subStmtCtx.setUnsupported();
326 private static void addOrReplaceNodes(final StmtContext<?, ?, ?> subStmtCtx,
327 final Mutable<?, ?, ?> refineTargetNodeCtx) {
328 for (StmtContext<?, ?, ?> refineSubstatementCtx : subStmtCtx.declaredSubstatements()) {
329 if (isSupportedRefineSubstatement(refineSubstatementCtx)) {
330 addOrReplaceNode(refineSubstatementCtx, refineTargetNodeCtx);
335 private static void addOrReplaceNode(final StmtContext<?, ?, ?> refineSubstatementCtx,
336 final Mutable<?, ?, ?> refineTargetNodeCtx) {
338 final StatementDefinition refineSubstatementDef = refineSubstatementCtx.publicDefinition();
340 // FIXME: this is quite costly, use an explicit block
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());
347 if (!isAllowedToAddByRefine(refineSubstatementDef)) {
348 refineTargetNodeCtx.removeStatementFromEffectiveSubstatements(refineSubstatementDef);
350 // FIXME: childCopyOf() should handle this through per-statement copy policy, right?
351 refineTargetNodeCtx.addEffectiveSubstatement(refineSubstatementCtx.replicaAsChildOf(refineTargetNodeCtx));
354 // FIXME: clarify this and inline into single caller
355 private static boolean isAllowedToAddByRefine(final StatementDefinition publicDefinition) {
356 return YangStmtMapping.MUST.equals(publicDefinition);
359 private static boolean isSupportedRefineSubstatement(final StmtContext<?, ?, ?> refineSubstatementCtx) {
360 final Collection<?> supportedRefineSubstatements = refineSubstatementCtx.getFromNamespace(
361 ValidationBundlesNamespace.class, ValidationBundleType.SUPPORTED_REFINE_SUBSTATEMENTS);
363 return supportedRefineSubstatements == null || supportedRefineSubstatements.isEmpty()
364 || supportedRefineSubstatements.contains(refineSubstatementCtx.publicDefinition())
365 || StmtContextUtils.isUnknownStatement(refineSubstatementCtx);
368 private static boolean isSupportedRefineTarget(final StmtContext<?, ?, ?> refineSubstatementCtx,
369 final StmtContext<?, ?, ?> refineTargetNodeCtx) {
370 final Collection<?> supportedRefineTargets = YangValidationBundles.SUPPORTED_REFINE_TARGETS.get(
371 refineSubstatementCtx.publicDefinition());
373 return supportedRefineTargets == null || supportedRefineTargets.isEmpty()
374 || supportedRefineTargets.contains(refineTargetNodeCtx.publicDefinition());