X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=parser%2Fyang-parser-reactor%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fyangtools%2Fyang%2Fparser%2Fstmt%2Freactor%2FStatementContextBase.java;h=1be883cd2b2213fea83f50024247b09c67e87a7c;hb=710d9e5c81cde651ad0c1093fe93ab9e6f899e1e;hp=c11ef99baf9ddffa5dcb58b30a6836a98f8c4615;hpb=c85d71ba3a00f5a566f9a4d533abd9a572f37bc4;p=yangtools.git diff --git a/parser/yang-parser-reactor/src/main/java/org/opendaylight/yangtools/yang/parser/stmt/reactor/StatementContextBase.java b/parser/yang-parser-reactor/src/main/java/org/opendaylight/yangtools/yang/parser/stmt/reactor/StatementContextBase.java index c11ef99baf..1be883cd2b 100644 --- a/parser/yang-parser-reactor/src/main/java/org/opendaylight/yangtools/yang/parser/stmt/reactor/StatementContextBase.java +++ b/parser/yang-parser-reactor/src/main/java/org/opendaylight/yangtools/yang/parser/stmt/reactor/StatementContextBase.java @@ -13,7 +13,6 @@ import static com.google.common.base.Verify.verify; import static com.google.common.base.Verify.verifyNotNull; import static java.util.Objects.requireNonNull; -import com.google.common.annotations.Beta; import com.google.common.base.VerifyException; import com.google.common.collect.ImmutableCollection; import com.google.common.collect.ImmutableList; @@ -31,6 +30,7 @@ import java.util.Map.Entry; import java.util.Optional; import java.util.stream.Stream; import org.eclipse.jdt.annotation.NonNull; +import org.eclipse.jdt.annotation.Nullable; import org.opendaylight.yangtools.yang.common.QNameModule; import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement; import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement; @@ -50,7 +50,7 @@ import org.opendaylight.yangtools.yang.parser.spi.meta.StatementNamespace; import org.opendaylight.yangtools.yang.parser.spi.meta.StatementSupport; import org.opendaylight.yangtools.yang.parser.spi.meta.StatementSupport.CopyPolicy; import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext; -import org.opendaylight.yangtools.yang.parser.spi.source.ImplicitSubstatement; +import org.opendaylight.yangtools.yang.parser.spi.meta.UndeclaredStatementFactory; import org.opendaylight.yangtools.yang.parser.spi.source.SourceException; import org.opendaylight.yangtools.yang.parser.stmt.reactor.NamespaceBehaviourWithListeners.KeyedValueAddedListener; import org.opendaylight.yangtools.yang.parser.stmt.reactor.NamespaceBehaviourWithListeners.PredicateValueAddedListener; @@ -64,7 +64,7 @@ import org.slf4j.LoggerFactory; * @param Declared Statement representation * @param Effective Statement representation */ -public abstract class StatementContextBase, E extends EffectiveStatement> +abstract class StatementContextBase, E extends EffectiveStatement> extends ReactorStmtCtx implements CopyHistory { /** * Event listener when an item is added to model namespace. @@ -150,6 +150,24 @@ public abstract class StatementContextBase, E */ private byte executionOrder; + /** + * This field should live in AbstractResumedStatement, but is placed here for memory efficiency to squat in the + * alignment shadow of {@link #bitsAight} and {@link #executionOrder}. + */ + private boolean implicitDeclaredFlag; + + // TODO: we a single byte of alignment shadow left, we should think how we can use it to cache information we build + // during InferredStatementContext.tryToReusePrototype(). We usually end up being routed to + // copyAsChildOfImpl() -- which performs an eager instantiation and checks for changes afterwards. We should + // be able to capture how parent scope affects the copy in a few bits. If we can do that, than we can reap + // the benefits by just examining new parent context and old parent context contribution to the state. If + // their impact is the same, we can skip instantiation of statements and directly reuse them (individually, + // or as a complete file). + // + // Whatever we end up tracking, we need to track two views of that -- for the statement itself + // (sans substatements) and a summary of substatements. I think it should be possible to get this working + // with 2x5bits -- we have up to 15 mutable bits available if we share the field with implicitDeclaredFlag. + // Copy constructor used by subclasses to implement reparent() StatementContextBase(final StatementContextBase original) { super(original); @@ -195,12 +213,12 @@ public abstract class StatementContextBase, E } @Override - public Collection> getEffectOfStatement() { + public final Collection> getEffectOfStatement() { return effectOfStatement; } @Override - public void addAsEffectOfStatement(final Collection> ctxs) { + public final void addAsEffectOfStatement(final Collection> ctxs) { if (ctxs.isEmpty()) { return; } @@ -272,8 +290,6 @@ public abstract class StatementContextBase, E return effective.isEmpty() ? ImmutableList.of() : effective; } - public abstract void removeStatementFromEffectiveSubstatements(StatementDefinition statementDef); - static final List> removeStatementFromEffectiveSubstatements( final List> effective, final StatementDefinition statementDef) { if (effective.isEmpty()) { @@ -291,21 +307,6 @@ public abstract class StatementContextBase, E return shrinkEffective(effective); } - /** - * Removes a statement context from the effective substatements based on its statement definition (i.e statement - * keyword) and raw (in String form) statement argument. The statement context is removed only if both statement - * definition and statement argument match with one of the effective substatements' statement definition - * and argument. - * - *

- * If the statementArg parameter is null, the statement context is removed based only on its statement definition. - * - * @param statementDef statement definition of the statement context to remove - * @param statementArg statement argument of the statement context to remove - */ - public abstract void removeStatementFromEffectiveSubstatements(StatementDefinition statementDef, - String statementArg); - static final List> removeStatementFromEffectiveSubstatements( final List> effective, final StatementDefinition statementDef, final String statementArg) { @@ -328,28 +329,17 @@ public abstract class StatementContextBase, E return shrinkEffective(effective); } - // YANG example: RPC/action statements always have 'input' and 'output' defined - @Beta - public , Z extends EffectiveStatement> @NonNull Mutable - appendImplicitSubstatement(final StatementSupport support, final String rawArg) { - // FIXME: YANGTOOLS-652: This does not need to be a SubstatementContext, in can be a specialized - // StatementContextBase subclass. - final Mutable ret = new SubstatementContext<>(this, new StatementDefinitionContext<>(support), - ImplicitSubstatement.of(sourceReference()), rawArg); + @Override + public final , Z extends EffectiveStatement> + Mutable createUndeclaredSubstatement(final StatementSupport support, final X arg) { + requireNonNull(support); + checkArgument(support instanceof UndeclaredStatementFactory, "Unsupported statement support %s", support); + + final var ret = new UndeclaredStmtCtx<>(this, support, arg); support.onStatementAdded(ret); - addEffectiveSubstatement(ret); return ret; } - /** - * Adds an effective statement to collection of substatements. - * - * @param substatement substatement - * @throws IllegalStateException if added in declared phase - * @throws NullPointerException if statement parameter is null - */ - public abstract void addEffectiveSubstatement(Mutable substatement); - final List> addEffectiveSubstatement(final List> effective, final Mutable substatement) { verifyStatement(substatement); @@ -361,15 +351,20 @@ public abstract class StatementContextBase, E return resized; } - /** - * Adds an effective statement to collection of substatements. - * - * @param statements substatements - * @throws IllegalStateException - * if added in declared phase - * @throws NullPointerException - * if statement parameter is null - */ + static final void afterAddEffectiveSubstatement(final Mutable substatement) { + // Undeclared statements still need to have 'onDeclarationFinished()' triggered + if (substatement instanceof UndeclaredStmtCtx) { + finishDeclaration((UndeclaredStmtCtx) substatement); + } + } + + // Split out to keep generics working without a warning + private static , Z extends EffectiveStatement> void finishDeclaration( + final UndeclaredStmtCtx substatement) { + substatement.definition().onDeclarationFinished(substatement, ModelProcessingPhase.FULL_DECLARATION); + } + + @Override public final void addEffectiveSubstatements(final Collection> statements) { if (!statements.isEmpty()) { statements.forEach(StatementContextBase::verifyStatement); @@ -394,7 +389,7 @@ public abstract class StatementContextBase, E return resized; } - abstract Iterable> effectiveChildrenToComplete(); + abstract Iterator> effectiveChildrenToComplete(); // exposed for InferredStatementContext only final void ensureCompletedPhase(final Mutable stmt) { @@ -448,15 +443,7 @@ public abstract class StatementContextBase, E return result; } - @NonNull E createEffective(final StatementFactory factory) { - return createEffective(factory, this); - } - - // Creates EffectiveStatement through full materialization - static , E extends EffectiveStatement> @NonNull E createEffective( - final StatementFactory factory, final StatementContextBase ctx) { - return factory.createEffective(ctx, ctx.streamDeclared(), ctx.streamEffective()); - } + abstract @NonNull E createEffective(@NonNull StatementFactory factory); /** * Return a stream of declared statements which can be built into an {@link EffectiveStatement}, as per @@ -491,8 +478,9 @@ public abstract class StatementContextBase, E for (final StatementContextBase child : mutableDeclaredSubstatements()) { finished &= child.tryToCompletePhase(targetOrder); } - for (final ReactorStmtCtx child : effectiveChildrenToComplete()) { - finished &= child.tryToCompletePhase(targetOrder); + final var it = effectiveChildrenToComplete(); + while (it.hasNext()) { + finished &= it.next().tryToCompletePhase(targetOrder); } return finished; } @@ -613,13 +601,6 @@ public abstract class StatementContextBase, E } } - /** - * Ends declared section of current node. - */ - void endDeclared(final ModelProcessingPhase phase) { - definition.onDeclarationFinished(this, phase); - } - @Override final StatementDefinitionContext definition() { return definition; @@ -750,19 +731,19 @@ public abstract class StatementContextBase, E } @Override - public > void addContext(final Class<@NonNull N> namespace, - final KT key,final StmtContext stmt) { + public final > void addContext( + final Class<@NonNull N> namespace, final KT key,final StmtContext stmt) { addContextToNamespace(namespace, key, stmt); } @Override - public Optional> copyAsChildOf(final Mutable parent, final CopyType type, + public final Optional> copyAsChildOf(final Mutable parent, final CopyType type, final QNameModule targetModule) { checkEffectiveModelCompleted(this); return Optional.ofNullable(copyAsChildOfImpl(parent, type, targetModule)); } - private ReactorStmtCtx copyAsChildOfImpl(final Mutable parent, final CopyType type, + private @Nullable ReactorStmtCtx copyAsChildOfImpl(final Mutable parent, final CopyType type, final QNameModule targetModule) { final StatementSupport support = definition.support(); final CopyPolicy policy = support.copyPolicy(); @@ -800,7 +781,7 @@ public abstract class StatementContextBase, E return canReuseCurrent(copy) ? this : copy; } - private boolean canReuseCurrent(final ReactorStmtCtx copy) { + private boolean canReuseCurrent(final @NonNull ReactorStmtCtx copy) { // Defer to statement factory to see if we can reuse this object. If we can and have only context-independent // substatements we can reuse the object. More complex cases are handled indirectly via the copy. return definition.getFactory().canReuseCurrent(copy, this, buildEffective().effectiveSubstatements()) @@ -828,9 +809,7 @@ public abstract class StatementContextBase, E final InferredStatementContext copy; if (implicitParent.isPresent()) { - final StatementDefinitionContext def = new StatementDefinitionContext<>(implicitParent.get()); - result = new SubstatementContext(this, def, original.sourceReference(), original.rawArgument(), - original.argument(), type); + result = new UndeclaredStmtCtx(this, implicitParent.orElseThrow(), original, type); final CopyType childCopyType; switch (type) { @@ -848,6 +827,7 @@ public abstract class StatementContextBase, E copy = new InferredStatementContext<>(result, original, childCopyType, type, targetModule); result.addEffectiveSubstatement(copy); + result.definition.onStatementAdded(result); } else { result = copy = new InferredStatementContext<>(this, original, type, type, targetModule); } @@ -867,25 +847,24 @@ public abstract class StatementContextBase, E "Attempted to copy statement %s which has completed phase %s", stmt, phase); } - @Beta - // FIXME: this information should be exposed as a well-known Namespace + @Override public final boolean hasImplicitParentSupport() { return definition.getFactory() instanceof ImplicitParentAwareStatementSupport; } - @Beta - public final StatementContextBase wrapWithImplicit(final StatementContextBase original) { + @Override + public final StmtContext wrapWithImplicit(final StmtContext original) { final var optImplicit = definition.getImplicitParentFor(this, original.publicDefinition()); if (optImplicit.isEmpty()) { return original; } - final StatementDefinitionContext def = new StatementDefinitionContext<>(optImplicit.orElseThrow()); - final CopyType type = original.history().getLastOperation(); - final SubstatementContext result = new SubstatementContext(original.getParentContext(), def, - original.sourceReference(), original.rawArgument(), original.argument(), type); + checkArgument(original instanceof StatementContextBase, "Unsupported original %s", original); + final var origBase = (StatementContextBase)original; - result.addEffectiveSubstatement(original.reparent(result)); + @SuppressWarnings({ "rawtypes", "unchecked" }) + final UndeclaredStmtCtx result = new UndeclaredStmtCtx(origBase, optImplicit.orElseThrow()); + result.addEffectiveSubstatement(origBase.reparent(result)); result.setCompletedPhase(original.getCompletedPhase()); return result; } @@ -898,4 +877,13 @@ public abstract class StatementContextBase, E * @return True if {@link #allSubstatements()} and {@link #allSubstatementsStream()} would return an empty stream. */ abstract boolean hasEmptySubstatements(); + + // Note: these two are exposed for AbstractResumedStatement only + final boolean getImplicitDeclaredFlag() { + return implicitDeclaredFlag; + } + + final void setImplicitDeclaredFlag() { + implicitDeclaredFlag = true; + } }