2 * Copyright (c) 2013 Cisco Systems, Inc. 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.controller.yang.parser.util;
10 import java.util.ArrayList;
11 import java.util.Arrays;
12 import java.util.Collections;
13 import java.util.Date;
14 import java.util.List;
18 import org.opendaylight.controller.yang.model.api.Module;
19 import org.opendaylight.controller.yang.model.api.ModuleImport;
20 import org.opendaylight.controller.yang.model.api.SchemaContext;
21 import org.opendaylight.controller.yang.parser.builder.impl.ModuleBuilder;
22 import org.opendaylight.controller.yang.parser.impl.YangParserListenerImpl;
23 import org.opendaylight.controller.yang.parser.util.TopologicalSort.Node;
24 import org.opendaylight.controller.yang.parser.util.TopologicalSort.NodeImpl;
25 import org.slf4j.Logger;
26 import org.slf4j.LoggerFactory;
28 import com.google.common.annotations.VisibleForTesting;
29 import com.google.common.base.Function;
30 import com.google.common.collect.Lists;
31 import com.google.common.collect.Maps;
32 import com.google.common.collect.Sets;
35 * Creates a module dependency graph from provided {@link ModuleBuilder}s and
36 * provides a {@link #sort()} method. It is topological sort and returns modules
37 * in order in which they should be processed (e.g. if A imports B, sort returns
40 public final class ModuleDependencySort {
42 private static final Date DEFAULT_REVISION = new Date(0);
43 private static final Logger logger = LoggerFactory
44 .getLogger(ModuleDependencySort.class);
47 * Topological sort of module builder dependency graph.
49 * @return Sorted list of Module builders. Modules can be further processed
52 public static List<ModuleBuilder> sort(ModuleBuilder... builders) {
53 List<Node> sorted = sortInternal(Arrays.asList(builders));
54 // Cast to ModuleBuilder from Node and return
55 return Lists.transform(sorted, new Function<Node, ModuleBuilder>() {
58 public ModuleBuilder apply(Node input) {
59 return (ModuleBuilder) ((ModuleNodeImpl) input).getReference();
64 public static List<ModuleBuilder> sortWithContext(SchemaContext context, ModuleBuilder... builders) {
65 List<Object> modules = new ArrayList<Object>();
66 Collections.addAll(modules, builders);
67 modules.addAll(context.getModules());
69 List<Node> sorted = sortInternal(modules);
70 // Cast to ModuleBuilder from Node if possible and return
71 return Lists.transform(sorted, new Function<Node, ModuleBuilder>() {
74 public ModuleBuilder apply(Node input) {
75 if(((ModuleNodeImpl) input).getReference() instanceof ModuleBuilder) {
76 return (ModuleBuilder) ((ModuleNodeImpl) input).getReference();
85 * Topological sort of module dependency graph.
87 * @return Sorted list of Modules. Modules can be further processed in
90 public static List<Module> sort(Module... modules) {
91 List<Node> sorted = sortInternal(Arrays.asList(modules));
92 // Cast to Module from Node and return
93 return Lists.transform(sorted, new Function<Node, Module>() {
96 public Module apply(Node input) {
97 return (Module) ((ModuleNodeImpl) input).getReference();
102 private static List<Node> sortInternal(List<?> modules) {
103 Map<String, Map<Date, ModuleNodeImpl>> moduleGraph = createModuleGraph(modules);
105 Set<Node> nodes = Sets.newHashSet();
106 for (Map<Date, ModuleNodeImpl> map : moduleGraph.values()) {
107 for (ModuleNodeImpl node : map.values()) {
112 return TopologicalSort.sort(nodes);
116 static Map<String, Map<Date, ModuleNodeImpl>> createModuleGraph(
118 Map<String, Map<Date, ModuleNodeImpl>> moduleGraph = Maps.newHashMap();
120 processModules(moduleGraph, builders);
121 processDependencies(moduleGraph, builders);
127 * Extract module:revision from module builders
129 private static void processDependencies(
130 Map<String, Map<Date, ModuleNodeImpl>> moduleGraph, List<?> builders) {
131 Map<String, Date> imported = Maps.newHashMap();
133 // Create edges in graph
134 for (Object mb : builders) {
136 String fromName = null;
137 Date fromRevision = null;
138 Set<ModuleImport> imports = null;
140 if (mb instanceof Module) {
141 fromName = ((Module) mb).getName();
142 fromRevision = ((Module) mb).getRevision();
143 imports = ((Module) mb).getImports();
144 } else if (mb instanceof ModuleBuilder) {
145 fromName = ((ModuleBuilder) mb).getName();
146 fromRevision = ((ModuleBuilder) mb).getRevision();
147 imports = ((ModuleBuilder) mb).getModuleImports();
149 // no need to check if other Type of object, check is performed in
152 if (fromRevision == null)
153 fromRevision = DEFAULT_REVISION;
155 for (ModuleImport imprt : imports) {
156 String toName = imprt.getModuleName();
157 Date toRevision = imprt.getRevision() == null ? DEFAULT_REVISION
158 : imprt.getRevision();
160 ModuleNodeImpl from = moduleGraph.get(fromName).get(
163 ModuleNodeImpl to = getModuleByNameAndRevision(moduleGraph,
164 fromName, fromRevision, toName, toRevision);
167 * Check imports: If module is imported twice with different
168 * revisions then throw exception
170 if (imported.get(toName) != null
171 && !imported.get(toName).equals(toRevision))
173 .format("Module:%s imported twice with different revisions:%s, %s",
175 formatRevDate(imported.get(toName)),
176 formatRevDate(toRevision)));
177 imported.put(toName, toRevision);
185 * Get imported module by its name and revision from moduleGraph
187 private static ModuleNodeImpl getModuleByNameAndRevision(
188 Map<String, Map<Date, ModuleNodeImpl>> moduleGraph,
189 String fromName, Date fromRevision, String toName, Date toRevision) {
190 ModuleNodeImpl to = null;
192 if (moduleGraph.get(toName) == null
193 || !moduleGraph.get(toName).containsKey(toRevision)) {
194 // If revision is not specified in import, but module exists
195 // with different revisions, take first
196 if (moduleGraph.get(toName) != null
197 && !moduleGraph.get(toName).isEmpty()
198 && toRevision.equals(DEFAULT_REVISION)) {
199 to = moduleGraph.get(toName).values().iterator().next();
201 .format("Import:%s:%s by module:%s:%s does not specify revision, using:%s:%s for module dependency sort",
202 toName, formatRevDate(toRevision), fromName,
203 formatRevDate(fromRevision), to.getName(),
204 formatRevDate(to.getRevision())));
206 ex(String.format("Not existing module imported:%s:%s by:%s:%s",
207 toName, formatRevDate(toRevision), fromName,
208 formatRevDate(fromRevision)));
210 to = moduleGraph.get(toName).get(toRevision);
215 private static void ex(String message) {
216 throw new YangValidationException(message);
220 * Extract dependencies from module builders or modules to fill dependency
223 private static void processModules(
224 Map<String, Map<Date, ModuleNodeImpl>> moduleGraph, List<?> builders) {
227 for (Object mb : builders) {
232 if (mb instanceof Module) {
233 name = ((Module) mb).getName();
234 rev = ((Module) mb).getRevision();
235 } else if (mb instanceof ModuleBuilder) {
236 name = ((ModuleBuilder) mb).getName();
237 rev = ((ModuleBuilder) mb).getRevision();
239 throw new IllegalStateException(
241 "Unexpected type of node for sort, expected only:%s, %s, got:%s",
242 Module.class, ModuleBuilder.class,
247 rev = DEFAULT_REVISION;
249 if (moduleGraph.get(name) == null)
250 moduleGraph.put(name, Maps.<Date, ModuleNodeImpl> newHashMap());
252 if (moduleGraph.get(name).get(rev) != null)
253 ex(String.format("Module:%s with revision:%s declared twice",
254 name, formatRevDate(rev)));
256 moduleGraph.get(name).put(rev, new ModuleNodeImpl(name, rev, mb));
260 private static String formatRevDate(Date rev) {
261 return rev == DEFAULT_REVISION ? "default"
262 : YangParserListenerImpl.simpleDateFormat.format(rev);
266 static class ModuleNodeImpl extends NodeImpl {
267 private final String name;
268 private final Date revision;
269 private final Object originalObject;
271 public ModuleNodeImpl(String name, Date revision, Object builder) {
273 this.revision = revision;
274 this.originalObject = builder;
277 public String getName() {
281 public Date getRevision() {
286 public int hashCode() {
287 final int prime = 31;
289 result = prime * result + ((name == null) ? 0 : name.hashCode());
290 result = prime * result
291 + ((revision == null) ? 0 : revision.hashCode());
296 public boolean equals(Object obj) {
301 if (getClass() != obj.getClass())
303 ModuleNodeImpl other = (ModuleNodeImpl) obj;
305 if (other.name != null)
307 } else if (!name.equals(other.name))
309 if (revision == null) {
310 if (other.revision != null)
312 } else if (!revision.equals(other.revision))
318 public String toString() {
319 return "Module [name=" + name + ", revision="
320 + formatRevDate(revision) + "]";
323 public Object getReference() {
324 return originalObject;