2 * Copyright (c) 2020 PANTHEON.tech, 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.mdsal.binding.runtime.spi;
10 import static com.google.common.base.Preconditions.checkState;
11 import static java.util.Objects.requireNonNull;
13 import com.google.common.annotations.Beta;
14 import com.google.common.base.MoreObjects;
15 import com.google.common.collect.ImmutableList;
16 import com.google.common.collect.ImmutableList.Builder;
17 import com.google.common.collect.ListMultimap;
18 import com.google.common.collect.MultimapBuilder;
19 import java.io.IOException;
20 import java.util.ArrayList;
21 import java.util.HashMap;
22 import java.util.HashSet;
23 import java.util.LinkedHashSet;
24 import java.util.List;
26 import java.util.Map.Entry;
27 import java.util.Optional;
29 import org.checkerframework.checker.lock.qual.GuardedBy;
30 import org.checkerframework.checker.lock.qual.Holding;
31 import org.eclipse.jdt.annotation.NonNull;
32 import org.eclipse.jdt.annotation.Nullable;
33 import org.opendaylight.mdsal.binding.runtime.api.ModuleInfoSnapshot;
34 import org.opendaylight.mdsal.binding.spec.reflect.BindingReflections;
35 import org.opendaylight.yangtools.concepts.AbstractObjectRegistration;
36 import org.opendaylight.yangtools.concepts.Mutable;
37 import org.opendaylight.yangtools.concepts.ObjectRegistration;
38 import org.opendaylight.yangtools.concepts.Registration;
39 import org.opendaylight.yangtools.yang.binding.YangModuleInfo;
40 import org.opendaylight.yangtools.yang.common.QName;
41 import org.opendaylight.yangtools.yang.common.QNameModule;
42 import org.opendaylight.yangtools.yang.common.Revision;
43 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
44 import org.opendaylight.yangtools.yang.model.api.stmt.ModuleEffectiveStatement;
45 import org.opendaylight.yangtools.yang.model.api.stmt.SubmoduleEffectiveStatement;
46 import org.opendaylight.yangtools.yang.model.repo.api.RevisionSourceIdentifier;
47 import org.opendaylight.yangtools.yang.model.repo.api.SchemaSourceException;
48 import org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier;
49 import org.opendaylight.yangtools.yang.model.repo.api.YangTextSchemaSource;
50 import org.opendaylight.yangtools.yang.parser.api.YangParserFactory;
51 import org.opendaylight.yangtools.yang.parser.api.YangSyntaxErrorException;
52 import org.opendaylight.yangtools.yang.parser.repo.YangTextSchemaContextResolver;
53 import org.slf4j.Logger;
54 import org.slf4j.LoggerFactory;
57 * A dynamic registry of {@link YangModuleInfo} objects, capable of combining them into an
58 * {@link ModuleInfoSnapshot}. If you need a one-shot way of creating an ModuleInfoSnapshot, prefer
59 * {@link ModuleInfoSnapshotBuilder} instead.
62 public final class ModuleInfoSnapshotResolver implements Mutable {
63 private static final class RegisteredModuleInfo {
64 final Registration reg;
65 final YangModuleInfo info;
66 final ClassLoader loader;
68 private int refcount = 1;
70 RegisteredModuleInfo(final YangModuleInfo info, final Registration reg, final ClassLoader loader) {
71 this.info = requireNonNull(info);
72 this.reg = requireNonNull(reg);
73 this.loader = requireNonNull(loader);
81 return --refcount == 0;
85 public String toString() {
86 return MoreObjects.toStringHelper(this).add("info", info).add("registration", reg)
87 .add("classLoader", loader).add("refCount", refcount).toString();
91 private static final Logger LOG = LoggerFactory.getLogger(ModuleInfoSnapshotResolver.class);
93 private final YangTextSchemaContextResolver ctxResolver;
96 private final ListMultimap<SourceIdentifier, RegisteredModuleInfo> sourceToInfoReg =
97 MultimapBuilder.hashKeys().arrayListValues().build();
99 private @Nullable ModuleInfoSnapshot currentSnapshot;
101 public ModuleInfoSnapshotResolver(final String name, final YangParserFactory parserFactory) {
102 ctxResolver = YangTextSchemaContextResolver.create(name, parserFactory);
105 public synchronized List<ObjectRegistration<YangModuleInfo>> registerModuleInfos(
106 final Iterable<? extends YangModuleInfo> moduleInfos) {
107 final List<ObjectRegistration<YangModuleInfo>> ret = new ArrayList<>();
108 for (YangModuleInfo yangModuleInfo : moduleInfos) {
109 ret.add(register(requireNonNull(yangModuleInfo)));
115 private ObjectRegistration<YangModuleInfo> register(final @NonNull YangModuleInfo moduleInfo) {
116 final Builder<RegisteredModuleInfo> regBuilder = ImmutableList.builder();
117 for (YangModuleInfo info : flatDependencies(moduleInfo)) {
118 regBuilder.add(registerModuleInfo(info));
120 final ImmutableList<RegisteredModuleInfo> regInfos = regBuilder.build();
122 return new AbstractObjectRegistration<>(moduleInfo) {
124 protected void removeRegistration() {
125 unregister(regInfos);
131 * Perform registration of a YangModuleInfo.
134 private RegisteredModuleInfo registerModuleInfo(final @NonNull YangModuleInfo info) {
135 // First search for an existing explicit registration
136 final SourceIdentifier sourceId = sourceIdentifierFrom(info);
137 for (RegisteredModuleInfo reg : sourceToInfoReg.get(sourceId)) {
138 if (info.equals(reg.info)) {
140 LOG.debug("Reusing registration {}", reg);
145 // Create an explicit registration
146 final Registration reg;
148 reg = ctxResolver.registerSource(toYangTextSource(sourceId, info));
149 } catch (YangSyntaxErrorException | SchemaSourceException | IOException e) {
150 throw new IllegalStateException("Failed to register info " + info, e);
153 final RegisteredModuleInfo regInfo = new RegisteredModuleInfo(info, reg, info.getClass().getClassLoader());
154 LOG.debug("Created new registration {}", regInfo);
156 sourceToInfoReg.put(sourceId, regInfo);
160 public synchronized @NonNull ModuleInfoSnapshot takeSnapshot() {
161 final EffectiveModelContext effectiveModel = ctxResolver.getEffectiveModelContext().orElseThrow();
162 final ModuleInfoSnapshot local = currentSnapshot;
163 if (local != null && local.getEffectiveModelContext().equals(effectiveModel)) {
167 return updateSnapshot(effectiveModel);
171 private @NonNull ModuleInfoSnapshot updateSnapshot(final EffectiveModelContext effectiveModel) {
172 // Alright, now let's find out which sources got captured
173 final Set<SourceIdentifier> sources = new HashSet<>();
174 for (Entry<QNameModule, ModuleEffectiveStatement> entry : effectiveModel.getModuleStatements().entrySet()) {
175 final Optional<Revision> revision = entry.getKey().getRevision();
176 final ModuleEffectiveStatement module = entry.getValue();
178 sources.add(RevisionSourceIdentifier.create(module.argument().getLocalName(), revision));
179 module.streamEffectiveSubstatements(SubmoduleEffectiveStatement.class)
180 .map(submodule -> RevisionSourceIdentifier.create(submodule.argument().getLocalName(), revision))
181 .forEach(sources::add);
184 final Map<SourceIdentifier, YangModuleInfo> moduleInfos = new HashMap<>();
185 final Map<String, ClassLoader> classLoaders = new HashMap<>();
186 for (SourceIdentifier source : sources) {
187 final List<RegisteredModuleInfo> regs = sourceToInfoReg.get(source);
188 checkState(!regs.isEmpty(), "No registration for %s", source);
190 final RegisteredModuleInfo reg = regs.get(0);
191 final YangModuleInfo info = reg.info;
192 moduleInfos.put(source, info);
193 final Class<?> infoClass = info.getClass();
194 classLoaders.put(BindingReflections.getModelRootPackageName(infoClass.getPackage()),
195 infoClass.getClassLoader());
198 final ModuleInfoSnapshot next = new DefaultModuleInfoSnapshot(effectiveModel, moduleInfos, classLoaders);
199 currentSnapshot = next;
203 private synchronized void unregister(final ImmutableList<RegisteredModuleInfo> regInfos) {
204 for (RegisteredModuleInfo regInfo : regInfos) {
205 if (!regInfo.decRef()) {
206 LOG.debug("Registration {} has references, not removing it", regInfo);
210 final SourceIdentifier sourceId = sourceIdentifierFrom(regInfo.info);
211 if (!sourceToInfoReg.remove(sourceId, regInfo)) {
212 LOG.warn("Failed to find {} registered under {}", regInfo, sourceId);
219 static @NonNull YangTextSchemaSource toYangTextSource(final YangModuleInfo moduleInfo) {
220 return YangTextSchemaSource.delegateForByteSource(sourceIdentifierFrom(moduleInfo),
221 moduleInfo.getYangTextByteSource());
224 private static @NonNull YangTextSchemaSource toYangTextSource(final SourceIdentifier identifier,
225 final YangModuleInfo moduleInfo) {
226 return YangTextSchemaSource.delegateForByteSource(identifier, moduleInfo.getYangTextByteSource());
229 private static SourceIdentifier sourceIdentifierFrom(final YangModuleInfo moduleInfo) {
230 final QName name = moduleInfo.getName();
231 return RevisionSourceIdentifier.create(name.getLocalName(), name.getRevision());
234 private static @NonNull List<@NonNull YangModuleInfo> flatDependencies(final YangModuleInfo moduleInfo) {
235 // Flatten the modules being registered, with the triggering module being first...
236 final Set<YangModuleInfo> requiredInfos = new LinkedHashSet<>();
237 flatDependencies(requiredInfos, moduleInfo);
239 // ... now reverse the order in an effort to register dependencies first (triggering module last)
240 return ImmutableList.copyOf(requiredInfos).reverse();
243 static void flatDependencies(final Set<YangModuleInfo> set, final YangModuleInfo moduleInfo) {
244 if (set.add(moduleInfo)) {
245 for (YangModuleInfo dep : moduleInfo.getImportedModules()) {
246 flatDependencies(set, dep);