BUG-582: Optimize SchemaContextImpl.findModuleByNamespace()

This is by far the hottest method, taking full 10 seconds from the
startup. Optimizing it looks simple enough: just create a SetMultimap
and precompute the URI->Module mappings.

Change-Id: Icf9b42424a083f665911c5b3a8853c38662b1e87
Signed-off-by: Robert Varga <rovarga@cisco.com>

diff --git a/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/impl/SchemaContextImpl.java b/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/impl/SchemaContextImpl.java
index 6f81e7adaf66bfa951ccda2a25f2ab4eec886ea8..c689fa9011725cb241c27d5c86c5a3e18423706f 100644 (file)
--- a/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/impl/SchemaContextImpl.java
+++ b/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/impl/SchemaContextImpl.java
@@ -7,7 +7,18 @@
  */
 package org.opendaylight.yangtools.yang.parser.impl;
 
-import com.google.common.base.Optional;
+import java.net.URI;
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.Date;
+import java.util.HashSet;
+import java.util.LinkedHashSet;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+import java.util.TreeMap;
+
 import org.opendaylight.yangtools.yang.common.QName;
 import org.opendaylight.yangtools.yang.model.api.AugmentationSchema;
 import org.opendaylight.yangtools.yang.model.api.ConstraintDefinition;
@@ -26,24 +37,39 @@ import org.opendaylight.yangtools.yang.model.api.UnknownSchemaNode;
 import org.opendaylight.yangtools.yang.model.api.UsesNode;
 import org.opendaylight.yangtools.yang.parser.util.ModuleDependencySort;
 
-import java.net.URI;
-import java.util.ArrayList;
-import java.util.Collections;
-import java.util.Date;
-import java.util.HashSet;
-import java.util.LinkedHashSet;
-import java.util.List;
-import java.util.Map;
-import java.util.Set;
-import java.util.TreeMap;
+import com.google.common.base.Optional;
+import com.google.common.base.Supplier;
+import com.google.common.collect.ImmutableSetMultimap;
+import com.google.common.collect.Multimaps;
+import com.google.common.collect.SetMultimap;
 
 final class SchemaContextImpl implements SchemaContext {
-    private final Set<Module> modules;
+    private static final Supplier<HashSet<Module>> URI_SET_SUPPLIER = new Supplier<HashSet<Module>>() {
+        @Override
+        public HashSet<Module> get() {
+            return new HashSet<>();
+        }
+    };
+
     private final Map<ModuleIdentifier, String> identifiersToSources;
+    private final SetMultimap<URI, Module> namespaceToModules;
+    private final Set<Module> modules;
 
-    SchemaContextImpl(final Set<Module> modules, Map<ModuleIdentifier, String> identifiersToSources) {
+    SchemaContextImpl(final Set<Module> modules, final Map<ModuleIdentifier, String> identifiersToSources) {
         this.modules = modules;
         this.identifiersToSources = identifiersToSources;
+
+        /*
+         * The most common lookup is from Namespace->Module. Invest some quality time in
+         * building that up.
+         */
+        final SetMultimap<URI, Module> multimap = Multimaps.newSetMultimap(
+                new TreeMap<URI, Collection<Module>>(), URI_SET_SUPPLIER);
+        for (Module m : modules) {
+            multimap.put(m.getNamespace(), m);
+        }
+
+        namespaceToModules = ImmutableSetMultimap.copyOf(multimap);
     }
 
     @Override
@@ -57,6 +83,7 @@ final class SchemaContextImpl implements SchemaContext {
 
     @Override
     public Set<Module> getModules() {
+        // FIXME: can we pre-compute this in the constructor?
         List<Module> sorted = ModuleDependencySort.sort(modules.toArray(new Module[modules.size()]));
         return new LinkedHashSet<Module>(sorted);
     }
@@ -106,19 +133,12 @@ final class SchemaContextImpl implements SchemaContext {
 
     @Override
     public Set<Module> findModuleByNamespace(final URI namespace) {
-        final Set<Module> ret = new HashSet<Module>();
-        if (namespace != null) {
-            for (final Module module : modules) {
-                if (module.getNamespace().equals(namespace)) {
-                    ret.add(module);
-                }
-            }
-        }
-        return ret;
+        final Set<Module> ret = namespaceToModules.get(namespace);
+        return ret == null ? Collections.<Module>emptySet() : ret;
     }
 
     @Override
-    public Module findModuleByNamespaceAndRevision(URI namespace, Date revision) {
+    public Module findModuleByNamespaceAndRevision(final URI namespace, final Date revision) {
         if (namespace != null) {
             Set<Module> modules = findModuleByNamespace(namespace);
 
@@ -224,7 +244,7 @@ final class SchemaContextImpl implements SchemaContext {
     }
 
     @Override
-    public DataSchemaNode getDataChildByName(QName name) {
+    public DataSchemaNode getDataChildByName(final QName name) {
         DataSchemaNode result = null;
         for (Module module : modules) {
             result = module.getDataChildByName(name);
@@ -236,7 +256,7 @@ final class SchemaContextImpl implements SchemaContext {
     }
 
     @Override
-    public DataSchemaNode getDataChildByName(String name) {
+    public DataSchemaNode getDataChildByName(final String name) {
         DataSchemaNode result = null;
         for (Module module : modules) {
             result = module.getDataChildByName(name);
@@ -269,7 +289,7 @@ final class SchemaContextImpl implements SchemaContext {
     }
 
     @Override
-    public Optional<String> getModuleSource(ModuleIdentifier moduleIdentifier) {
+    public Optional<String> getModuleSource(final ModuleIdentifier moduleIdentifier) {
         String maybeSource = identifiersToSources.get(moduleIdentifier);
         return Optional.fromNullable(maybeSource);
     }

diff --git a/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/util/ModuleDependencySort.java b/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/util/ModuleDependencySort.java
index 4c4b64a37cf1eeeeed0d0625a0e4c32ed58285a3..ea304d4f10696b48dd3c41dde8ca7a76aca0ec6e 100644 (file)
--- a/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/util/ModuleDependencySort.java
+++ b/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/util/ModuleDependencySort.java
@@ -51,31 +51,35 @@ public final class ModuleDependencySort {
     private ModuleDependencySort() {
     }
 
+    /**
+     * Extracts {@link ModuleBuilder} from a {@link ModuleNodeImpl}.
+     */
+    private static final Function<Node, ModuleBuilder> NODE_TO_MODULEBUILDER = new Function<Node, ModuleBuilder>() {
+        @Override
+        public ModuleBuilder apply(final Node input) {
+            // Cast to ModuleBuilder from Node and return
+            return (ModuleBuilder) ((ModuleNodeImpl) input).getReference();
+        }
+    };
+
     /**
      * Topological sort of module builder dependency graph.
      *
      * @return Sorted list of Module builders. Modules can be further processed
      *         in returned order.
      */
-    public static List<ModuleBuilder> sort(ModuleBuilder... builders) {
+    public static List<ModuleBuilder> sort(final ModuleBuilder... builders) {
         List<Node> sorted = sortInternal(Arrays.asList(builders));
-        // Cast to ModuleBuilder from Node and return
-        return Lists.transform(sorted, new Function<Node, ModuleBuilder>() {
-
-            @Override
-            public ModuleBuilder apply(Node input) {
-                return (ModuleBuilder) ((ModuleNodeImpl) input).getReference();
-            }
-        });
+        return Lists.transform(sorted, NODE_TO_MODULEBUILDER);
     }
 
-    public static List<ModuleBuilder> sort(Collection<ModuleBuilder> builders) {
+    public static List<ModuleBuilder> sort(final Collection<ModuleBuilder> builders) {
         ModuleBuilder[] array = new ModuleBuilder[builders.size()];
         builders.toArray(array);
         return sort(array);
     }
 
-    public static List<ModuleBuilder> sortWithContext(SchemaContext context, ModuleBuilder... builders) {
+    public static List<ModuleBuilder> sortWithContext(final SchemaContext context, final ModuleBuilder... builders) {
         List<Object> modules = new ArrayList<Object>();
         Collections.addAll(modules, builders);
         modules.addAll(context.getModules());
@@ -85,7 +89,7 @@ public final class ModuleDependencySort {
         return Lists.transform(sorted, new Function<Node, ModuleBuilder>() {
 
             @Override
-            public ModuleBuilder apply(Node input) {
+            public ModuleBuilder apply(final Node input) {
                 if (((ModuleNodeImpl) input).getReference() instanceof ModuleBuilder) {
                     return (ModuleBuilder) ((ModuleNodeImpl) input).getReference();
                 } else {
@@ -101,19 +105,19 @@ public final class ModuleDependencySort {
      * @return Sorted list of Modules. Modules can be further processed in
      *         returned order.
      */
-    public static List<Module> sort(Module... modules) {
+    public static List<Module> sort(final Module... modules) {
         List<Node> sorted = sortInternal(Arrays.asList(modules));
         // Cast to Module from Node and return
         return Lists.transform(sorted, new Function<Node, Module>() {
 
             @Override
-            public Module apply(Node input) {
+            public Module apply(final Node input) {
                 return (Module) ((ModuleNodeImpl) input).getReference();
             }
         });
     }
 
-    private static List<Node> sortInternal(List<?> modules) {
+    private static List<Node> sortInternal(final List<?> modules) {
         Map<String, Map<Date, ModuleNodeImpl>> moduleGraph = createModuleGraph(modules);
 
         Set<Node> nodes = Sets.newHashSet();
@@ -127,7 +131,7 @@ public final class ModuleDependencySort {
     }
 
     @VisibleForTesting
-    static Map<String, Map<Date, ModuleNodeImpl>> createModuleGraph(List<?> builders) {
+    static Map<String, Map<Date, ModuleNodeImpl>> createModuleGraph(final List<?> builders) {
         Map<String, Map<Date, ModuleNodeImpl>> moduleGraph = Maps.newHashMap();
 
         processModules(moduleGraph, builders);
@@ -139,7 +143,7 @@ public final class ModuleDependencySort {
     /**
      * Extract module:revision from module builders
      */
-    private static void processDependencies(Map<String, Map<Date, ModuleNodeImpl>> moduleGraph, List<?> builders) {
+    private static void processDependencies(final Map<String, Map<Date, ModuleNodeImpl>> moduleGraph, final List<?> builders) {
         Map<URI, Object> allNS = new HashMap<>();
 
         // Create edges in graph
@@ -219,8 +223,8 @@ public final class ModuleDependencySort {
     /**
      * Get imported module by its name and revision from moduleGraph
      */
-    private static ModuleNodeImpl getModuleByNameAndRevision(Map<String, Map<Date, ModuleNodeImpl>> moduleGraph,
-            String fromName, Date fromRevision, String toName, Date toRevision) {
+    private static ModuleNodeImpl getModuleByNameAndRevision(final Map<String, Map<Date, ModuleNodeImpl>> moduleGraph,
+            final String fromName, final Date fromRevision, final String toName, final Date toRevision) {
         ModuleNodeImpl to = null;
 
         if (moduleGraph.get(toName) == null || !moduleGraph.get(toName).containsKey(toRevision)) {
@@ -246,7 +250,7 @@ public final class ModuleDependencySort {
         return to;
     }
 
-    private static void ex(String message) {
+    private static void ex(final String message) {
         throw new YangValidationException(message);
     }
 
@@ -254,7 +258,7 @@ public final class ModuleDependencySort {
      * Extract dependencies from module builders or modules to fill dependency
      * graph
      */
-    private static void processModules(Map<String, Map<Date, ModuleNodeImpl>> moduleGraph, List<?> builders) {
+    private static void processModules(final Map<String, Map<Date, ModuleNodeImpl>> moduleGraph, final List<?> builders) {
 
         // Process nodes
         for (Object mb : builders) {
@@ -290,7 +294,7 @@ public final class ModuleDependencySort {
         }
     }
 
-    private static String formatRevDate(Date rev) {
+    private static String formatRevDate(final Date rev) {
         return rev.equals(DEFAULT_REVISION) ? "default" : new SimpleDateFormat("yyyy-MM-dd").format(rev);
     }
 
@@ -300,7 +304,7 @@ public final class ModuleDependencySort {
         private final Date revision;
         private final Object originalObject;
 
-        public ModuleNodeImpl(String name, Date revision, Object builder) {
+        public ModuleNodeImpl(final String name, final Date revision, final Object builder) {
             this.name = name;
             this.revision = revision;
             this.originalObject = builder;
@@ -324,7 +328,7 @@ public final class ModuleDependencySort {
         }
 
         @Override
-        public boolean equals(Object obj) {
+        public boolean equals(final Object obj) {
             if (this == obj) {
                 return true;
             }