*/
package org.opendaylight.yangtools.yang.parser.stmt.reactor;
+import static com.google.common.base.Preconditions.checkArgument;
import static com.google.common.base.Verify.verify;
import com.google.common.base.MoreObjects;
import org.eclipse.jdt.annotation.NonNull;
import org.eclipse.jdt.annotation.Nullable;
import org.opendaylight.yangtools.yang.common.QName;
+import org.opendaylight.yangtools.yang.common.QNameModule;
import org.opendaylight.yangtools.yang.common.YangVersion;
import org.opendaylight.yangtools.yang.model.api.SchemaPath;
import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
-import org.opendaylight.yangtools.yang.model.api.meta.IdentifierNamespace;
import org.opendaylight.yangtools.yang.model.api.meta.StatementDefinition;
import org.opendaylight.yangtools.yang.model.api.stmt.AugmentStatement;
import org.opendaylight.yangtools.yang.model.api.stmt.ConfigEffectiveStatement;
import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier;
import org.opendaylight.yangtools.yang.model.api.stmt.UsesStatement;
import org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier;
-import org.opendaylight.yangtools.yang.parser.spi.meta.CommonStmtCtx;
+import org.opendaylight.yangtools.yang.parser.spi.meta.CopyType;
import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
import org.opendaylight.yangtools.yang.parser.spi.meta.InferenceException;
import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder;
import org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase;
-import org.opendaylight.yangtools.yang.parser.spi.meta.MutableStatement;
import org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceBehaviour.Registry;
+import org.opendaylight.yangtools.yang.parser.spi.meta.ParserNamespace;
import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
// of this flag -- eliminating the initial alignment shadow used by below gap-filler fields.
private boolean isSupportedToBuildEffective = true;
+ // EffectiveConfig mapping
+ private static final int MASK_CONFIG = 0x03;
+ private static final int HAVE_CONFIG = 0x04;
+ // Effective instantiation mechanics for StatementContextBase: if this flag is set all substatements are known not
+ // change when instantiated. This includes context-independent statements as well as any statements which are
+ // ignored during copy instantiation.
+ private static final int ALL_INDEPENDENT = 0x08;
// Flag bit assignments
- private static final int IS_SUPPORTED_BY_FEATURES = 0x01;
- private static final int HAVE_SUPPORTED_BY_FEATURES = 0x02;
- private static final int IS_IGNORE_IF_FEATURE = 0x04;
- private static final int HAVE_IGNORE_IF_FEATURE = 0x08;
- // Note: these four are related
- private static final int IS_IGNORE_CONFIG = 0x10;
- private static final int HAVE_IGNORE_CONFIG = 0x20;
- private static final int IS_CONFIGURATION = 0x40;
- private static final int HAVE_CONFIGURATION = 0x80;
-
+ private static final int IS_SUPPORTED_BY_FEATURES = 0x10;
+ private static final int HAVE_SUPPORTED_BY_FEATURES = 0x20;
+ private static final int IS_IGNORE_IF_FEATURE = 0x40;
+ private static final int HAVE_IGNORE_IF_FEATURE = 0x80;
// Have-and-set flag constants, also used as masks
- private static final int SET_SUPPORTED_BY_FEATURES = HAVE_SUPPORTED_BY_FEATURES | IS_SUPPORTED_BY_FEATURES;
- private static final int SET_CONFIGURATION = HAVE_CONFIGURATION | IS_CONFIGURATION;
- // Note: implies SET_CONFIGURATION, allowing fewer bit operations to be performed
- private static final int SET_IGNORE_CONFIG = HAVE_IGNORE_CONFIG | IS_IGNORE_CONFIG | SET_CONFIGURATION;
- private static final int SET_IGNORE_IF_FEATURE = HAVE_IGNORE_IF_FEATURE | IS_IGNORE_IF_FEATURE;
+ private static final int SET_SUPPORTED_BY_FEATURES = HAVE_SUPPORTED_BY_FEATURES | IS_SUPPORTED_BY_FEATURES;
+ private static final int SET_IGNORE_IF_FEATURE = HAVE_IGNORE_IF_FEATURE | IS_IGNORE_IF_FEATURE;
+
+ private static final EffectiveConfig[] EFFECTIVE_CONFIGS;
+
+ static {
+ final EffectiveConfig[] values = EffectiveConfig.values();
+ final int length = values.length;
+ verify(length == 4, "Unexpected EffectiveConfig cardinality %s", length);
+ EFFECTIVE_CONFIGS = values;
+ }
// Flags for use with SubstatementContext. These are hiding in the alignment shadow created by above boolean and
// hence improve memory layout.
// SchemaPath cache for use with SubstatementContext and InferredStatementContext. This hurts RootStatementContext
// a bit in terms of size -- but those are only a few and SchemaPath is on its way out anyway.
- @Deprecated
- private volatile SchemaPath schemaPath;
+ // FIXME: this should become 'QName'
+ private SchemaPath schemaPath;
ReactorStmtCtx() {
// Empty on purpose
getRoot().setRootVersionImpl(version);
}
- @Override
- public final void addMutableStmtToSeal(final MutableStatement mutableStatement) {
- getRoot().addMutableStmtToSealImpl(mutableStatement);
- }
-
@Override
public final void addRequiredSource(final SourceIdentifier dependency) {
getRoot().addRequiredSourceImpl(dependency);
}
@Override
- public final CommonStmtCtx root() {
- return getRoot();
+ public final QName moduleName() {
+ final RootStatementContext<?, ?, ?> root = getRoot();
+ return QName.create(StmtContextUtils.getRootModuleQName(root), root.getRawArgument());
}
@Override
return getOriginalCtx().map(StmtContext::buildEffective).orElse(null);
}
+ @Override
+ // Non-final due to InferredStatementContext's override
+ public <X, Z extends EffectiveStatement<X, ?>> @NonNull Optional<X> findSubstatementArgument(
+ final @NonNull Class<Z> type) {
+ return allSubstatementsStream()
+ .filter(ctx -> ctx.isSupportedToBuildEffective() && ctx.producesEffective(type))
+ .findAny()
+ .map(ctx -> (X) ctx.getArgument());
+ }
+
+ @Override
+ // Non-final due to InferredStatementContext's override
+ public boolean hasSubstatement(final @NonNull Class<? extends EffectiveStatement<?, ?>> type) {
+ return allSubstatementsStream()
+ .anyMatch(ctx -> ctx.isSupportedToBuildEffective() && ctx.producesEffective(type));
+ }
+
@Override
@Deprecated
@SuppressWarnings("unchecked")
//
@Override
- public final <K, V, T extends K, N extends IdentifierNamespace<K, V>> V namespaceItem(final Class<@NonNull N> type,
+ public final <K, V, T extends K, N extends ParserNamespace<K, V>> V namespaceItem(final Class<@NonNull N> type,
final T key) {
return getBehaviourRegistry().getNamespaceBehaviour(type).getFrom(this, key);
}
@Override
- public final <K, V, N extends IdentifierNamespace<K, V>> Map<K, V> namespace(final Class<@NonNull N> type) {
+ public final <K, V, N extends ParserNamespace<K, V>> Map<K, V> namespace(final Class<@NonNull N> type) {
return getNamespace(type);
}
@Override
- public final <K, V, N extends IdentifierNamespace<K, V>> Map<K, V> localNamespace(final Class<@NonNull N> type) {
+ public final <K, V, N extends ParserNamespace<K, V>>
+ Map<K, V> localNamespacePortion(final Class<@NonNull N> type) {
return getLocalNamespace(type);
}
@Override
- protected final void checkLocalNamespaceAllowed(final Class<? extends IdentifierNamespace<?, ?>> type) {
+ protected final void checkLocalNamespaceAllowed(final Class<? extends ParserNamespace<?, ?>> type) {
definition().checkNamespaceAllowed(type);
}
@Override
- protected <K, V, N extends IdentifierNamespace<K, V>> void onNamespaceElementAdded(final Class<N> type, final K key,
+ protected <K, V, N extends ParserNamespace<K, V>> void onNamespaceElementAdded(final Class<N> type, final K key,
final V value) {
// definition().onNamespaceElementAdded(this, type, key, value);
}
+ /**
+ * Return the effective statement view of a copy operation. This method may return one of:
+ * <ul>
+ * <li>{@code this}, when the effective view did not change</li>
+ * <li>an InferredStatementContext, when there is a need for inference-equivalent copy</li>
+ * <li>{@code null}, when the statement failed to materialize</li>
+ * </ul>
+ *
+ * @param parent Proposed new parent
+ * @param type Copy operation type
+ * @param targetModule New target module
+ * @return {@link ReactorStmtCtx} holding effective view
+ */
+ abstract @Nullable ReactorStmtCtx<?, ?, ?> asEffectiveChildOf(StatementContextBase<?, ?, ?> parent, CopyType type,
+ QNameModule targetModule);
+
+ @Override
+ public final ReactorStmtCtx<A, D, E> replicaAsChildOf(final Mutable<?, ?, ?> parent) {
+ checkArgument(parent instanceof StatementContextBase, "Unsupported parent %s", parent);
+ return replicaAsChildOf((StatementContextBase<?, ?, ?>) parent);
+ }
+
+ abstract @NonNull ReplicaStatementContext<A, D, E> replicaAsChildOf(@NonNull StatementContextBase<?, ?, ?> parent);
+
//
//
// Statement build entry points -- both public and package-private.
/**
* Config statements are not all that common which means we are performing a recursive search towards the root
- * every time {@link #isConfiguration()} is invoked. This is quite expensive because it causes a linear search
+ * every time {@link #effectiveConfig()} is invoked. This is quite expensive because it causes a linear search
* for the (usually non-existent) config statement.
*
* <p>
* This method maintains a resolution cache, so once we have returned a result, we will keep on returning the same
- * result without performing any lookups, solely to support {@link SubstatementContext#isConfiguration()}.
+ * result without performing any lookups, solely to support {@link #effectiveConfig()}.
*
* <p>
* Note: use of this method implies that {@link #isIgnoringConfig()} is realized with
* {@link #isIgnoringConfig(StatementContextBase)}.
*/
- final boolean isConfiguration(final StatementContextBase<?, ?, ?> parent) {
- final int fl = flags & SET_CONFIGURATION;
- if (fl != 0) {
- return fl == SET_CONFIGURATION;
- }
- if (isIgnoringConfig(parent)) {
- // Note: SET_CONFIGURATION has been stored in flags
- return true;
- }
+ final @NonNull EffectiveConfig effectiveConfig(final ReactorStmtCtx<?, ?, ?> parent) {
+ return (flags & HAVE_CONFIG) != 0 ? EFFECTIVE_CONFIGS[flags & MASK_CONFIG] : loadEffectiveConfig(parent);
+ }
+
+ private @NonNull EffectiveConfig loadEffectiveConfig(final ReactorStmtCtx<?, ?, ?> parent) {
+ final EffectiveConfig parentConfig = parent.effectiveConfig();
- final boolean isConfig;
- final Optional<Boolean> optConfig = findSubstatementArgument(ConfigEffectiveStatement.class);
- if (optConfig.isPresent()) {
- isConfig = optConfig.orElseThrow();
- if (isConfig) {
- // Validity check: if parent is config=false this cannot be a config=true
- InferenceException.throwIf(!parent.effectiveConfig(), sourceReference(),
+ final EffectiveConfig myConfig;
+ if (parentConfig != EffectiveConfig.IGNORED && !definition().support().isIgnoringConfig()) {
+ final Optional<Boolean> optConfig = findSubstatementArgument(ConfigEffectiveStatement.class);
+ if (optConfig.isPresent()) {
+ if (optConfig.orElseThrow()) {
+ // Validity check: if parent is config=false this cannot be a config=true
+ InferenceException.throwIf(parentConfig == EffectiveConfig.FALSE, this,
"Parent node has config=false, this node must not be specifed as config=true");
+ myConfig = EffectiveConfig.TRUE;
+ } else {
+ myConfig = EffectiveConfig.FALSE;
+ }
+ } else {
+ // If "config" statement is not specified, the default is the same as the parent's "config" value.
+ myConfig = parentConfig;
}
} else {
- // If "config" statement is not specified, the default is the same as the parent's "config" value.
- isConfig = parent.effectiveConfig();
+ myConfig = EffectiveConfig.IGNORED;
}
- // Resolved, make sure we cache this return
- flags |= isConfig ? SET_CONFIGURATION : HAVE_CONFIGURATION;
- return isConfig;
+ flags = (byte) (flags & ~MASK_CONFIG | HAVE_CONFIG | myConfig.ordinal());
+ return myConfig;
}
protected abstract boolean isIgnoringConfig();
*
* <p>
* Note: use of this method implies that {@link #isConfiguration()} is realized with
- * {@link #isConfiguration(StatementContextBase)}.
+ * {@link #effectiveConfig(StatementContextBase)}.
*/
final boolean isIgnoringConfig(final StatementContextBase<?, ?, ?> parent) {
- final int fl = flags & SET_IGNORE_CONFIG;
- if (fl != 0) {
- return fl == SET_IGNORE_CONFIG;
- }
- if (definition().support().isIgnoringConfig() || parent.isIgnoringConfig()) {
- flags |= SET_IGNORE_CONFIG;
- return true;
- }
-
- flags |= HAVE_IGNORE_CONFIG;
- return false;
+ return EffectiveConfig.IGNORED == effectiveConfig(parent);
}
protected abstract boolean isIgnoringIfFeatures();
return false;
}
- // These two exists only due to memory optimization, should live in AbstractResumedStatement. We are also reusing
+ // These two exist only due to memory optimization, should live in AbstractResumedStatement. We are also reusing
// this for ReplicaStatementContext's refcount tracking.
final boolean fullyDefined() {
return fullyDefined;
fullyDefined = true;
}
+ // These two exist only for StatementContextBase. Since we are squeezed for size, with only a single bit available
+ // in flags, we default to 'false' and only set the flag to true when we are absolutely sure -- and all other cases
+ // err on the side of caution by taking the time to evaluate each substatement separately.
+ final boolean allSubstatementsContextIndependent() {
+ return (flags & ALL_INDEPENDENT) != 0;
+ }
+
+ final void setAllSubstatementsContextIndependent() {
+ flags |= ALL_INDEPENDENT;
+ }
+
+ //
+ //
+ // Various functionality from AbstractTypeStatementSupport. This used to work on top of SchemaPath, now it still
+ // lives here. Ultimate future is either proper graduation or (more likely) move to AbstractTypeStatementSupport.
+ //
+ //
+
+ @Override
+ public final QName argumentAsTypeQName() {
+ final Object argument = argument();
+ verify(argument instanceof String, "Unexpected argument %s", argument);
+ return interpretAsQName((String) argument);
+ }
+
+ @Override
+ public final QNameModule effectiveNamespace() {
+ // FIXME: there has to be a better way to do this
+ return getSchemaPath().getLastComponent().getModule();
+ }
+
//
//
// Common SchemaPath cache. All of this is bound to be removed once YANGTOOLS-1066 is done.
// Exists only to support {SubstatementContext,InferredStatementContext}.schemaPath()
@Deprecated
- final @NonNull Optional<SchemaPath> substatementGetSchemaPath() {
- SchemaPath local = schemaPath;
- if (local == null) {
- synchronized (this) {
- local = schemaPath;
- if (local == null) {
- schemaPath = local = createSchemaPath((StatementContextBase<?, ?, ?>) coerceParentContext());
- }
- }
+ final @Nullable SchemaPath substatementGetSchemaPath() {
+ if (schemaPath == null) {
+ schemaPath = createSchemaPath((StatementContextBase<?, ?, ?>) coerceParentContext());
}
-
- return Optional.ofNullable(local);
+ return schemaPath;
}
+ // FIXME: 7.0.0: this method's logic needs to be moved to the respective StatementSupport classes
@Deprecated
private SchemaPath createSchemaPath(final StatementContextBase<?, ?, ?> parent) {
- final Optional<SchemaPath> maybeParentPath = parent.schemaPath();
- verify(maybeParentPath.isPresent(), "Parent %s does not have a SchemaPath", parent);
- final SchemaPath parentPath = maybeParentPath.get();
-
+ final SchemaPath parentPath = parent.getSchemaPath();
if (StmtContextUtils.isUnknownStatement(this)) {
return parentPath.createChild(publicDefinition().getStatementName());
}
if (argument instanceof QName) {
final QName qname = (QName) argument;
if (producesDeclared(UsesStatement.class)) {
- return maybeParentPath.orElse(null);
+ return parentPath;
}
return parentPath.createChild(qname);
}
if (argument instanceof String) {
- // FIXME: This may yield illegal argument exceptions
- final Optional<StmtContext<A, D, E>> originalCtx = getOriginalCtx();
- final QName qname = StmtContextUtils.qnameFromArgument(originalCtx.orElse(this), (String) argument);
- return parentPath.createChild(qname);
+ return parentPath.createChild(interpretAsQName((String) argument));
}
if (argument instanceof SchemaNodeIdentifier
&& (producesDeclared(AugmentStatement.class) || producesDeclared(RefineStatement.class)
return parentPath.createChild(((SchemaNodeIdentifier) argument).getNodeIdentifiers());
}
- // FIXME: this does not look right
- return maybeParentPath.orElse(null);
+ // FIXME: this does not look right, investigate more?
+ return parentPath;
+ }
+
+ private @NonNull QName interpretAsQName(final String argument) {
+ // FIXME: This may yield illegal argument exceptions
+ return StmtContextUtils.qnameFromArgument(getOriginalCtx().orElse(this), argument);
}
//
//
//
+ /**
+ * Local knowledge of {@link #refcount} values up to statement root. We use this field to prevent recursive lookups
+ * in {@link #noParentRefs(StatementContextBase)} -- once we discover a parent reference once, we keep that
+ * knowledge and update it when {@link #sweep()} is invoked.
+ */
+ private byte parentRef = PARENTREF_UNKNOWN;
+ private static final byte PARENTREF_UNKNOWN = -1;
+ private static final byte PARENTREF_ABSENT = 0;
+ private static final byte PARENTREF_PRESENT = 1;
+
/**
* Acquire a reference on this context. As long as there is at least one reference outstanding,
* {@link #buildEffective()} will not result in {@link #effectiveSubstatements()} being discarded.
refcount = current - 1;
LOG.trace("Refcount {} on {}", refcount, this);
- if (isSweepable()) {
- // We are no longer guarded by effective instance
- sweepOnDecrement();
+
+ if (refcount == REFCOUNT_NONE) {
+ lastDecRef();
}
}
/**
- * Sweep this statement context as a result of {@link #sweepSubstatements()}, i.e. when parent is also being swept.
+ * Return {@code true} if this context has an outstanding reference.
+ *
+ * @return True if this context has an outstanding reference.
*/
- private void sweep() {
- if (isSweepable()) {
- LOG.trace("Releasing {}", this);
- sweepState();
+ final boolean haveRef() {
+ return refcount > REFCOUNT_NONE;
+ }
+
+ private void lastDecRef() {
+ if (noImplictRef()) {
+ // We are no longer guarded by effective instance
+ sweepOnDecrement();
+ return;
+ }
+
+ final byte prevRefs = parentRef;
+ if (prevRefs == PARENTREF_ABSENT) {
+ // We are the last reference towards root, any children who observed PARENTREF_PRESENT from us need to be
+ // updated
+ markNoParentRef();
+ } else if (prevRefs == PARENTREF_UNKNOWN) {
+ // Noone observed our parentRef, just update it
+ loadParentRefcount();
}
}
+ static final void markNoParentRef(final Collection<? extends ReactorStmtCtx<?, ?, ?>> substatements) {
+ for (ReactorStmtCtx<?, ?, ?> stmt : substatements) {
+ final byte prevRef = stmt.parentRef;
+ stmt.parentRef = PARENTREF_ABSENT;
+ if (prevRef == PARENTREF_PRESENT && stmt.refcount == REFCOUNT_NONE) {
+ // Child thinks it is pinned down, update its perspective
+ stmt.markNoParentRef();
+ }
+ }
+ }
+
+ abstract void markNoParentRef();
+
static final void sweep(final Collection<? extends ReactorStmtCtx<?, ?, ?>> substatements) {
for (ReactorStmtCtx<?, ?, ?> stmt : substatements) {
stmt.sweep();
}
}
+ /**
+ * Sweep this statement context as a result of {@link #sweepSubstatements()}, i.e. when parent is also being swept.
+ */
+ private void sweep() {
+ parentRef = PARENTREF_ABSENT;
+ if (refcount == REFCOUNT_NONE && noImplictRef()) {
+ LOG.trace("Releasing {}", this);
+ sweepState();
+ }
+ }
+
static final int countUnswept(final Collection<? extends ReactorStmtCtx<?, ?, ?>> substatements) {
int result = 0;
for (ReactorStmtCtx<?, ?, ?> stmt : substatements) {
// Called when this statement does not have an implicit reference and have reached REFCOUNT_NONE
private void sweepOnDecrement() {
LOG.trace("Sweeping on decrement {}", this);
- if (noParentRefcount()) {
+ if (noParentRef()) {
// No further parent references, sweep our state.
sweepState();
}
}
// parent is potentially reclaimable
- if (noParentRefcount()) {
+ if (noParentRef()) {
LOG.trace("Cleanup {} of parent {}", refcount, this);
if (sweepState()) {
final ReactorStmtCtx<?, ?, ?> parent = getParentContext();
return effectiveInstance != null || !isSupportedToBuildEffective();
}
- // FIXME: cache the resolution of this
- private boolean noParentRefcount() {
+ private boolean noParentRef() {
+ return parentRefcount() == PARENTREF_ABSENT;
+ }
+
+ private byte parentRefcount() {
+ final byte refs;
+ return (refs = parentRef) != PARENTREF_UNKNOWN ? refs : loadParentRefcount();
+ }
+
+ private byte loadParentRefcount() {
+ return parentRef = calculateParentRefcount();
+ }
+
+ private byte calculateParentRefcount() {
final ReactorStmtCtx<?, ?, ?> parent = getParentContext();
- if (parent != null) {
- // There are three possibilities:
- // - REFCOUNT_NONE, in which case we need to search next parent
- // - negative (< REFCOUNT_NONE), meaning parent is in some stage of sweeping, hence it does not have
- // a reference to us
- // - positive (> REFCOUNT_NONE), meaning parent has an explicit refcount which is holding us down
- final int refs = parent.refcount;
- return refs == REFCOUNT_NONE ? parent.noParentRefcount() : refs < REFCOUNT_NONE;
+ if (parent == null) {
+ return PARENTREF_ABSENT;
}
- return true;
+ // There are three possibilities:
+ // - REFCOUNT_NONE, in which case we need to search next parent
+ // - negative (< REFCOUNT_NONE), meaning parent is in some stage of sweeping, hence it does not have
+ // a reference to us
+ // - positive (> REFCOUNT_NONE), meaning parent has an explicit refcount which is holding us down
+ final int refs = parent.refcount;
+ if (refs == REFCOUNT_NONE) {
+ return parent.parentRefcount();
+ }
+ return refs < REFCOUNT_NONE ? PARENTREF_ABSENT : PARENTREF_PRESENT;
}
private boolean isAwaitingChildren() {
return refcount > REFCOUNT_SWEEPING && refcount < REFCOUNT_NONE;
}
- private boolean isSweepable() {
- return refcount == REFCOUNT_NONE && noImplictRef();
- }
-
private void sweepOnChildDone() {
LOG.trace("Sweeping on child done {}", this);
final int current = refcount;
Code Review / yangtools.git / blobdiff