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.DeclaredStatement;
30 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
31 import org.opendaylight.yangtools.yang.model.api.meta.StatementDefinition;
32 import org.opendaylight.yangtools.yang.model.api.stmt.RefineEffectiveStatement;
33 import org.opendaylight.yangtools.yang.model.api.stmt.RefineStatement;
34 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier;
35 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Descendant;
36 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaTreeEffectiveStatement;
37 import org.opendaylight.yangtools.yang.model.api.stmt.UsesEffectiveStatement;
38 import org.opendaylight.yangtools.yang.model.api.stmt.UsesStatement;
39 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatements;
40 import org.opendaylight.yangtools.yang.parser.rfc7950.reactor.YangValidationBundles;
41 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.EffectiveStatementMixins;
42 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.refine.RefineEffectiveStatementImpl;
43 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.refine.RefineTargetNamespace;
44 import org.opendaylight.yangtools.yang.parser.spi.GroupingNamespace;
45 import org.opendaylight.yangtools.yang.parser.spi.SchemaTreeNamespace;
46 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractQNameStatementSupport;
47 import org.opendaylight.yangtools.yang.parser.spi.meta.CopyType;
48 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
49 import org.opendaylight.yangtools.yang.parser.spi.meta.InferenceException;
50 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder;
51 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.InferenceAction;
52 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.InferenceContext;
53 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.Prerequisite;
54 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase;
55 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
56 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
57 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
58 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
59 import org.opendaylight.yangtools.yang.parser.spi.source.ModuleCtxToModuleQName;
60 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
61 import org.opendaylight.yangtools.yang.parser.spi.validation.ValidationBundlesNamespace;
62 import org.opendaylight.yangtools.yang.parser.spi.validation.ValidationBundlesNamespace.ValidationBundleType;
63 import org.opendaylight.yangtools.yang.parser.stmt.reactor.StatementContextBase;
64 import org.slf4j.Logger;
65 import org.slf4j.LoggerFactory;
67 public final class UsesStatementSupport
68 extends AbstractQNameStatementSupport<UsesStatement, UsesEffectiveStatement> {
69 private static final Logger LOG = LoggerFactory.getLogger(UsesStatementSupport.class);
70 private static final SubstatementValidator SUBSTATEMENT_VALIDATOR = SubstatementValidator.builder(YangStmtMapping
72 .addAny(YangStmtMapping.AUGMENT)
73 .addOptional(YangStmtMapping.DESCRIPTION)
74 .addAny(YangStmtMapping.IF_FEATURE)
75 .addAny(YangStmtMapping.REFINE)
76 .addOptional(YangStmtMapping.REFERENCE)
77 .addOptional(YangStmtMapping.STATUS)
78 .addOptional(YangStmtMapping.WHEN)
80 private static final UsesStatementSupport INSTANCE = new UsesStatementSupport();
82 private UsesStatementSupport() {
83 super(YangStmtMapping.USES, StatementPolicy.exactReplica());
86 public static UsesStatementSupport getInstance() {
91 public QName parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
92 return StmtContextUtils.parseNodeIdentifier(ctx, value);
96 public void onFullDefinitionDeclared(final Mutable<QName, UsesStatement, UsesEffectiveStatement> usesNode) {
97 if (!usesNode.isSupportedByFeatures()) {
100 super.onFullDefinitionDeclared(usesNode);
102 final ModelActionBuilder usesAction = usesNode.newInferenceAction(ModelProcessingPhase.EFFECTIVE_MODEL);
103 final QName groupingName = usesNode.argument();
105 final Prerequisite<StmtContext<?, ?, ?>> sourceGroupingPre = usesAction.requiresCtx(usesNode,
106 GroupingNamespace.class, groupingName, ModelProcessingPhase.EFFECTIVE_MODEL);
107 final Prerequisite<? extends StmtContext.Mutable<?, ?, ?>> targetNodePre = usesAction.mutatesEffectiveCtx(
108 usesNode.getParentContext());
110 usesAction.apply(new InferenceAction() {
113 public void apply(final InferenceContext ctx) {
114 final StatementContextBase<?, ?, ?> targetNodeStmtCtx =
115 (StatementContextBase<?, ?, ?>) targetNodePre.resolve(ctx);
116 final StatementContextBase<?, ?, ?> sourceGrpStmtCtx =
117 (StatementContextBase<?, ?, ?>) sourceGroupingPre.resolve(ctx);
119 copyFromSourceToTarget(sourceGrpStmtCtx, targetNodeStmtCtx, usesNode);
120 resolveUsesNode(usesNode, targetNodeStmtCtx);
121 StmtContextUtils.validateIfFeatureAndWhenOnListKeys(usesNode);
122 usesNode.addToNs(SourceGroupingNamespace.class, Empty.getInstance(), sourceGrpStmtCtx);
126 public void prerequisiteFailed(final Collection<? extends Prerequisite<?>> failed) {
127 InferenceException.throwIf(failed.contains(sourceGroupingPre), usesNode,
128 "Grouping '%s' was not resolved.", groupingName);
129 throw new InferenceException("Unknown error occurred.", usesNode);
135 protected SubstatementValidator getSubstatementValidator() {
136 return SUBSTATEMENT_VALIDATOR;
140 protected UsesStatement createDeclared(final StmtContext<QName, UsesStatement, ?> ctx,
141 final ImmutableList<? extends DeclaredStatement<?>> substatements) {
142 return DeclaredStatements.createUses(ctx.getRawArgument(), ctx.getArgument(), substatements);
146 protected UsesStatement createEmptyDeclared(final StmtContext<QName, UsesStatement, ?> ctx) {
147 return DeclaredStatements.createUses(ctx.getRawArgument(), ctx.getArgument());
151 protected UsesEffectiveStatement createEffective(final Current<QName, UsesStatement> stmt,
152 final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
153 final GroupingDefinition sourceGrouping = (GroupingDefinition)
154 verifyNotNull(stmt.getFromNamespace(SourceGroupingNamespace.class, Empty.getInstance())).buildEffective();
155 final int flags = EffectiveStatementMixins.historyAndStatusFlags(stmt.history(), substatements);
156 final QName argument = stmt.getArgument();
157 final UsesStatement declared = stmt.declared();
159 if (substatements.isEmpty()) {
160 return argument.equals(declared.argument())
161 ? new EmptyLocalUsesEffectiveStatement(declared, sourceGrouping, flags)
162 : new SimpleCopiedUsesEffectiveStatement(declared, argument, sourceGrouping, flags);
165 if (declared.argument().equals(argument)) {
166 return new RegularLocalUsesEffectiveStatement(declared, sourceGrouping, flags, substatements);
168 if (findFirstStatement(substatements, RefineEffectiveStatement.class) == null) {
169 return new SimpleCopiedUsesEffectiveStatement(declared, argument, sourceGrouping, flags, substatements);
171 return new FullCopiedUsesEffectiveStatement(declared, argument, sourceGrouping, flags, substatements);
174 static @NonNull ImmutableMap<Descendant, SchemaNode> indexRefines(
175 final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
176 final Map<Descendant, SchemaNode> refines = new LinkedHashMap<>();
178 for (EffectiveStatement<?, ?> effectiveStatement : substatements) {
179 if (effectiveStatement instanceof RefineEffectiveStatementImpl) {
180 final RefineEffectiveStatementImpl refineStmt = (RefineEffectiveStatementImpl) effectiveStatement;
181 refines.put(refineStmt.argument(), refineStmt.getRefineTargetNode());
185 return ImmutableMap.copyOf(refines);
189 * Copy statements from a grouping to a target node.
191 * @param sourceGrpStmtCtx
192 * source grouping statement context
197 * @throws SourceException
198 * instance of SourceException
200 @SuppressFBWarnings(value = "UPM_UNCALLED_PRIVATE_METHOD",
201 justification = "https://github.com/spotbugs/spotbugs/issues/811")
202 private static void copyFromSourceToTarget(final Mutable<?, ?, ?> sourceGrpStmtCtx,
203 final StatementContextBase<?, ?, ?> targetCtx,
204 final Mutable<QName, UsesStatement, UsesEffectiveStatement> usesNode) {
205 final Collection<? extends Mutable<?, ?, ?>> declared = sourceGrpStmtCtx.mutableDeclaredSubstatements();
206 final Collection<? extends Mutable<?, ?, ?>> effective = sourceGrpStmtCtx.mutableEffectiveSubstatements();
207 final Collection<Mutable<?, ?, ?>> buffer = new ArrayList<>(declared.size() + effective.size());
208 final QNameModule newQNameModule = getNewQNameModule(targetCtx, sourceGrpStmtCtx);
210 for (final Mutable<?, ?, ?> original : declared) {
211 if (original.isSupportedByFeatures() && shouldCopy(original)) {
212 original.copyAsChildOf(targetCtx, CopyType.ADDED_BY_USES, newQNameModule).ifPresent(buffer::add);
216 for (final Mutable<?, ?, ?> original : effective) {
217 if (shouldCopy(original)) {
218 original.copyAsChildOf(targetCtx, CopyType.ADDED_BY_USES, newQNameModule).ifPresent(buffer::add);
222 targetCtx.addEffectiveSubstatements(buffer);
223 usesNode.addAsEffectOfStatement(buffer);
226 private static boolean shouldCopy(final StmtContext<?, ?, ?> stmt) {
227 // https://tools.ietf.org/html/rfc7950#section-7.13:
229 // The effect of a "uses" reference to a grouping is that the nodes
230 // defined by the grouping are copied into the current schema tree and
231 // are then updated according to the "refine" and "augment" statements.
233 // This means that the statement that is about to be copied (and can be subjected to buildEffective() I think)
234 // is actually a SchemaTreeEffectiveStatement
235 if (SchemaTreeEffectiveStatement.class.isAssignableFrom(
236 stmt.publicDefinition().getEffectiveRepresentationClass())) {
240 // As per https://tools.ietf.org/html/rfc7950#section-7.13.2:
242 // o Any node can get refined extensions, if the extension allows
243 // refinement. See Section 7.19 for details.
245 // and https://tools.ietf.org/html/rfc7950#section-7.19:
247 // An extension can allow refinement (see Section 7.13.2) and deviations
248 // (Section 7.20.3.2), but the mechanism for how this is defined is
249 // outside the scope of this specification.
251 // This is actively used out there (tailf-common.yang's tailf:action), which is incorrect, though. They do
252 // publish a bunch of metadata (through tailf-meta-extension.yang), but fail to publish a key aspect of the
253 // statement: it attaches to schema tree namespace (just as RFC7950 action does). Such an extension would
254 // automatically result in the extension being picked up by the above check and everybody would live happily
257 // We do not live in that world yet, hence we do the following and keep our fingers crossed.
258 // FIXME: YANGTOOLS-403: this should not be necessary once we implement the above (although tests will complain)
259 return StmtContextUtils.isUnknownStatement(stmt);
262 private static QNameModule getNewQNameModule(final StmtContext<?, ?, ?> targetCtx,
263 final StmtContext<?, ?, ?> stmtContext) {
264 if (targetCtx.getParentContext() == null) {
265 return targetCtx.getFromNamespace(ModuleCtxToModuleQName.class, targetCtx);
267 if (targetCtx.publicDefinition() == YangStmtMapping.AUGMENT) {
268 return StmtContextUtils.getRootModuleQName(targetCtx);
271 final Object targetStmtArgument = targetCtx.argument();
272 final Object sourceStmtArgument = stmtContext.argument();
273 if (targetStmtArgument instanceof QName && sourceStmtArgument instanceof QName) {
274 return ((QName) targetStmtArgument).getModule();
280 @SuppressFBWarnings(value = "UPM_UNCALLED_PRIVATE_METHOD",
281 justification = "https://github.com/spotbugs/spotbugs/issues/811")
282 private static void resolveUsesNode(final Mutable<QName, UsesStatement, UsesEffectiveStatement> usesNode,
283 final StmtContext<?, ?, ?> targetNodeStmtCtx) {
284 for (final Mutable<?, ?, ?> subStmtCtx : usesNode.mutableDeclaredSubstatements()) {
285 if (subStmtCtx.producesDeclared(RefineStatement.class) && areFeaturesSupported(subStmtCtx)) {
286 performRefine(subStmtCtx, targetNodeStmtCtx);
291 private static boolean areFeaturesSupported(final StmtContext<?, ?, ?> subStmtCtx) {
293 * In case of Yang 1.1, checks whether features are supported.
295 return !YangVersion.VERSION_1_1.equals(subStmtCtx.yangVersion()) || subStmtCtx.isSupportedByFeatures();
298 private static void performRefine(final Mutable<?, ?, ?> subStmtCtx, final StmtContext<?, ?, ?> usesParentCtx) {
299 final Object refineArgument = subStmtCtx.argument();
300 InferenceException.throwIf(!(refineArgument instanceof SchemaNodeIdentifier), subStmtCtx,
301 "Invalid refine argument %s. It must be instance of SchemaNodeIdentifier.", refineArgument);
303 final Optional<StmtContext<?, ?, ?>> optRefineTargetCtx = SchemaTreeNamespace.findNode(
304 usesParentCtx, (SchemaNodeIdentifier) refineArgument);
305 InferenceException.throwIf(!optRefineTargetCtx.isPresent(), subStmtCtx, "Refine target node %s not found.",
308 // FIXME: This communicates the looked-up target node to RefineStatementSupport.buildEffective(). We should do
309 // this trick through a shared namespace or similar reactor-agnostic meeting place. It really feels like
310 // an inference action RefineStatementSupport should be doing.
311 final StmtContext<?, ?, ?> refineTargetNodeCtx = optRefineTargetCtx.get();
312 if (StmtContextUtils.isUnknownStatement(refineTargetNodeCtx)) {
313 LOG.trace("Refine node '{}' in uses '{}' has target node unknown statement '{}'. "
314 + "Refine has been skipped. At line: {}", subStmtCtx.argument(),
315 subStmtCtx.coerceParentContext().argument(), refineTargetNodeCtx.argument(),
316 subStmtCtx.sourceReference());
318 verify(refineTargetNodeCtx instanceof StatementContextBase);
319 addOrReplaceNodes(subStmtCtx, (StatementContextBase<?, ?, ?>) refineTargetNodeCtx);
322 // Target is a prerequisite for the 'refine', hence if the target is not supported, the refine is not supported
323 // as well. Otherwise add a pointer to the target into refine's local namespace.
324 if (refineTargetNodeCtx.isSupportedToBuildEffective()) {
325 subStmtCtx.addToNs(RefineTargetNamespace.class, Empty.getInstance(), refineTargetNodeCtx);
327 subStmtCtx.setIsSupportedToBuildEffective(false);
331 private static void addOrReplaceNodes(final Mutable<?, ?, ?> subStmtCtx,
332 final StatementContextBase<?, ?, ?> refineTargetNodeCtx) {
333 for (final Mutable<?, ?, ?> refineSubstatementCtx : subStmtCtx.mutableDeclaredSubstatements()) {
334 if (isSupportedRefineSubstatement(refineSubstatementCtx)) {
335 addOrReplaceNode(refineSubstatementCtx, refineTargetNodeCtx);
340 private static void addOrReplaceNode(final Mutable<?, ?, ?> refineSubstatementCtx,
341 final StatementContextBase<?, ?, ?> refineTargetNodeCtx) {
343 final StatementDefinition refineSubstatementDef = refineSubstatementCtx.publicDefinition();
345 SourceException.throwIf(!isSupportedRefineTarget(refineSubstatementCtx, refineTargetNodeCtx),
346 refineSubstatementCtx,
347 "Error in module '%s' in the refine of uses '%s': can not perform refine of '%s' for the target '%s'.",
348 refineSubstatementCtx.getRoot().rawArgument(), refineSubstatementCtx.coerceParentContext().argument(),
349 refineSubstatementCtx.publicDefinition(), refineTargetNodeCtx.publicDefinition());
351 if (!isAllowedToAddByRefine(refineSubstatementDef)) {
352 refineTargetNodeCtx.removeStatementFromEffectiveSubstatements(refineSubstatementDef);
354 refineTargetNodeCtx.addEffectiveSubstatement(refineSubstatementCtx.replicaAsChildOf(refineTargetNodeCtx));
357 // FIXME: clarify this and inline into single caller
358 private static boolean isAllowedToAddByRefine(final StatementDefinition publicDefinition) {
359 return YangStmtMapping.MUST.equals(publicDefinition);
362 private static boolean isSupportedRefineSubstatement(final StmtContext<?, ?, ?> refineSubstatementCtx) {
363 final Collection<?> supportedRefineSubstatements = refineSubstatementCtx.getFromNamespace(
364 ValidationBundlesNamespace.class, ValidationBundleType.SUPPORTED_REFINE_SUBSTATEMENTS);
366 return supportedRefineSubstatements == null || supportedRefineSubstatements.isEmpty()
367 || supportedRefineSubstatements.contains(refineSubstatementCtx.publicDefinition())
368 || StmtContextUtils.isUnknownStatement(refineSubstatementCtx);
371 private static boolean isSupportedRefineTarget(final StmtContext<?, ?, ?> refineSubstatementCtx,
372 final StmtContext<?, ?, ?> refineTargetNodeCtx) {
373 final Collection<?> supportedRefineTargets = YangValidationBundles.SUPPORTED_REFINE_TARGETS.get(
374 refineSubstatementCtx.publicDefinition());
376 return supportedRefineTargets == null || supportedRefineTargets.isEmpty()
377 || supportedRefineTargets.contains(refineTargetNodeCtx.publicDefinition());