Change the type inference for fields in dart2js

lib/compiler/implementation/js_backend/backend.dart

 // Copyright (c) 2012, the Dart project authors.  Please see the AUTHORS file
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
 typedef void Recompile(Element element);
 
 class ReturnInfo {
   HType returnType;
   List<Element> compiledFunctions;
 
@@ skipping 205 matching lines @@
       }
       index++;
     });
     return result;
   }
 
   String toString() =>
       allUnknown ? "HTypeList.ALL_UNKNOWN" : "HTypeList $types";
 }
 
+class FieldTypesRegistry {
+  final JavaScriptBackend backend;
+
+  /**
+   * For each class [constructors] holds the set of constructors. If there is

[ngeoffray, 2012/09/27 12:35:46]

each class, 

[Søren Gjesse, 2012/09/27 13:22:49]

Done.

+   * more than one constructor for a class it is currently not possible to
+   * infer the field types from construction as the information collected does

[ngeoffray, 2012/09/27 12:35:46]

from construction, 

[Søren Gjesse, 2012/09/27 13:22:49]

Done.

+   * not correlate the generative constructors and generative constructor
+   * body/bodies.
+   */
+  final Map<Element, Set<Element>> constructors;

[ngeoffray, 2012/09/27 12:35:46]

Type the keys as ClassElement?

[Søren Gjesse, 2012/09/27 13:22:49]

Done.

+
+  /**
+   * The collected type information is stored in three maps. One for types
+   * assigned in the initializer list(s) [fieldInitializerTypeMap], one for
+   * types assigned in the constructor(s) [fieldConstructorTypeMap] and one

[ngeoffray, 2012/09/27 12:35:46]

, and

[Søren Gjesse, 2012/09/27 13:22:49]

Done.

+   * for typesassigned in the rest of the code [fieldTypeMap].

[ngeoffray, 2012/09/27 12:35:46]

typesassigned -> types assigned

[ngeoffray, 2012/09/27 12:35:46]

rest of the code where the field can be resolved.

[Søren Gjesse, 2012/09/27 13:22:49]

Done.

[Søren Gjesse, 2012/09/27 13:22:49]

Done.

+   *
+   * If a field has a type both from constructors and from the initializer
+   * list(s) then the type from the constructor(s) will owerride the one from

[ngeoffray, 2012/09/27 12:35:46]

, then

[Søren Gjesse, 2012/09/27 13:22:49]

Done.

+   * the initializer list(s).
+   *
+   * As the order in which generative constructors, generative constructor

[ngeoffray, 2012/09/27 12:35:46]

As -> Because ?

[Søren Gjesse, 2012/09/27 13:22:49]

Done.

+   * bodies and normal methods/functions is undefined, and as they can all be

[ngeoffray, 2012/09/27 12:35:46]

bodies, 

[ngeoffray, 2012/09/27 12:35:46]

as -> because ?

[Søren Gjesse, 2012/09/27 13:22:49]

Done.

[Søren Gjesse, 2012/09/27 13:22:49]

Done.

+   * recompiled it is not possible to combile this information into one map at

[ngeoffray, 2012/09/27 12:35:46]

recompiled, 

[ngeoffray, 2012/09/27 12:35:46]

combile -> combine

[Søren Gjesse, 2012/09/27 13:22:49]

Done.

[Søren Gjesse, 2012/09/27 13:22:49]

Done.

+   * the moment.
+   */
+  final Map<Element, HType> fieldInitializerTypeMap;
+  final Map<Element, HType> fieldConstructorTypeMap;
+  final Map<Element, HType> fieldTypeMap;
+
+  /**
+   * The set of current names setter selectors used. If a named selector is
+   * used it is currently not possible to infer the type of the field.
+   */
+  final Set<SourceString> setterSelectorsUsed;
+
+  final Map<Element, Set<Element>> optimizedStaticFunctions;
+  final Map<Element, FunctionSet> optimizedFunctions;
+
+  FieldTypesRegistry(JavaScriptBackend backend)
+      : constructors =  new Map<Element, Set<Element>>(),
+        fieldInitializerTypeMap = new Map<Element, HType>(),
+        fieldConstructorTypeMap = new Map<Element, HType>(),
+        fieldTypeMap = new Map<Element, HType>(),
+        setterSelectorsUsed = new Set<SourceString>(),
+        optimizedStaticFunctions = new Map<Element, Set<Element>>(),
+        optimizedFunctions = new Map<Element, FunctionSet>(),
+        this.backend = backend;
+
+  Compiler get compiler => backend.compiler;
+
+  void scheduleRecompilation(Element field) {
+    Set optimizedStatics = optimizedStaticFunctions[field];
+    if (optimizedStatics != null) {
+      optimizedStatics.forEach(backend.scheduleForRecompilation);
+      optimizedStaticFunctions.remove(field);
+    }
+    FunctionSet optimized = optimizedFunctions[field];
+    if (optimized != null) {
+      optimized.forEach(backend.scheduleForRecompilation);
+      optimizedFunctions.remove(field);
+    }
+  }
+
+  int constructorCount(Element element) {
+    assert(element.isClass());
+    Set<Element> ctors = constructors[element];
+    return ctors === null ? 0 : ctors.length;
+  }
+
+  void registerFieldType(Map<Element, HType> typeMap,
+                         Element field,
+                         HType type) {
+    assert(field.isField());
+    HType before = optimisticFieldType(field);
+
+    HType oldType = typeMap[field];
+    HType newType;
+
+    if (oldType != null) {
+      newType = oldType.union(type);
+    } else {
+      newType = type;
+    }
+    typeMap[field] = newType;
+    if (oldType != newType) {
+      scheduleRecompilation(field);
+    }
+  }
+
+  void registerConstructor(Element element) {
+    assert(element.isGenerativeConstructor());
+    Element cls = element.enclosingElement;
+    constructors.putIfAbsent(cls, () => new Set<Element>());
+    Set<Element> ctors = constructors[cls];
+    if (ctors.contains(element)) return;
+    ctors.add(element);
+    // We cannot infer field types for classes with more than one constructor.
+    // When the second constructor is seen recompile all functions relying on

[ngeoffray, 2012/09/27 12:35:46]

seen, 

[Søren Gjesse, 2012/09/27 13:22:49]

Done.

+    // optimistic field types for that class.
+    // TODO(sgjesse): Handle field types for classes with more than one
+    // constructor.
+    if (ctors.length == 2) {
+      optimizedFunctions.forEach((Element field, _) {
+        if (field.enclosingElement === cls) {
+          scheduleRecompilation(field);
+        }
+      });
+    }
+  }
+
+  void registerFieldInitializer(Element field, HType type) {
+    registerFieldType(fieldInitializerTypeMap, field, type);
+  }
+
+  void registerFieldConstructor(Element field, HType type) {
+    registerFieldType(fieldConstructorTypeMap, field, type);
+  }
+
+  void registerFieldSetter(FunctionElement element, Element field, HType type) {
+    HType initializerType = fieldInitializerTypeMap[field];
+    HType constructorType = fieldConstructorTypeMap[field];
+    HType setterType = fieldTypeMap[field];
+    if (type == HType.UNKNOWN
+        && initializerType == null
+        && constructorType == null
+        && setterType == null) {
+      // Don't register UNKONWN if there is currently no type information
+      // present for the field. Instead register the function holding the
+      // setter for recompilation if better type information for the field
+      // becomes available.
+      registerOptimizedFunction(element, field, type);
+      return;
+    }
+    registerFieldType(fieldTypeMap, field, type);
+  }
+
+  void addedDynamicSetter(Selector setter, HType type) {
+    // Field type optimizations are disabled for all fields matching a
+    // setter selector.
+    assert(setter.isSetter());
+    // TODO(sgjesse): Take the type of the setter into account.
+    if (setterSelectorsUsed.contains(setter.name)) return;
+    setterSelectorsUsed.add(setter.name);
+    optimizedStaticFunctions.forEach((Element field, _) {
+      if (field.name == setter.name) {
+        scheduleRecompilation(field);
+      }
+    });
+    optimizedFunctions.forEach((Element field, _) {
+      if (field.name == setter.name) {
+        scheduleRecompilation(field);
+      }
+    });
+  }
+
+  HType optimisticFieldType(Element field) {
+    assert(field.isField());
+    if (constructorCount(field.enclosingElement) > 1) {
+      return HType.UNKNOWN;
+    }
+    if (setterSelectorsUsed.contains(field.name)) {
+      return HType.UNKNOWN;
+    }
+    HType initializerType = fieldInitializerTypeMap[field];
+    HType constructorType = fieldConstructorTypeMap[field];
+    if (initializerType === null && constructorType === null) {
+      return HType.UNKNOWN;

[ngeoffray, 2012/09/27 12:35:46]

Why don't you also check fieldTypeMap here? Please add a comment.

[Søren Gjesse, 2012/09/27 13:22:49]

Done.

+    }
+    HType result = constructorType != null ? constructorType : initializerType;

[ngeoffray, 2012/09/27 12:35:46]

Also add a comment here on why you're using constructorType first (the comment
is already in optimize.dart, but it should also be there).

[Søren Gjesse, 2012/09/27 13:22:49]

Done.

+    HType type = fieldTypeMap[field];
+    if (type !== null) result = result.union(type);
+    return result;
+  }
+
+  void registerOptimizedFunction(FunctionElement element,
+                                 Element field,
+                                 HType type) {
+    assert(field.isField());
+    if (Elements.isStaticOrTopLevel(element)) {
+      optimizedStaticFunctions.putIfAbsent(
+          field, () => new Set<Element>());
+      optimizedStaticFunctions[field].add(element);
+    } else {
+      optimizedFunctions.putIfAbsent(
+          field, () => new FunctionSet(backend.compiler));
+      optimizedFunctions[field].add(element);
+    }
+  }
+
+  void dump() {
+    Set<Element> allFields = new Set<Element>();
+    fieldInitializerTypeMap.getKeys().forEach(allFields.add);
+    fieldConstructorTypeMap.getKeys().forEach(allFields.add);
+    fieldTypeMap.getKeys().forEach(allFields.add);
+    allFields.forEach((Element field) {
+      print("Inferred $field has type ${optimisticFieldType(field)}");
+    });
+  }
+}
+
 class ArgumentTypesRegistry {
   final JavaScriptBackend backend;
 
   /**
    * Documentation wanted -- johnniwinther
    *
    * Invariant: Keys must be declaration elements.
    */
   final Map<Element, HTypeList> staticTypeMap;
 
@@ skipping 142 matching lines @@
                                                   signature,
                                                   defaultValueTypes);
       }
       assert(types.allUnknown || types.length == signature.parameterCount);
       found = (found === null) ? types : found.union(types);
       return !found.allUnknown;
     });
     return found !== null ? found : HTypeList.ALL_UNKNOWN;
   }
 
-  void registerOptimization(Element element,
-                            HTypeList parameterTypes,
-                            OptionalParameterTypes defaultValueTypes) {
-    assert(invariant(element, element.isDeclaration));
+  void registerOptimizedFunction(Element element,
+                                 HTypeList parameterTypes,
+                                 OptionalParameterTypes defaultValueTypes) {
     if (Elements.isStaticOrTopLevelFunction(element)) {
       if (parameterTypes.allUnknown) {
         optimizedStaticFunctions.remove(element);
       } else {
         optimizedStaticFunctions.add(element);
       }
     }
 
     // TODO(kasperl): What kind of non-members do we get here?
     if (!element.isMember()) return;
@@ skipping 34 matching lines @@
 
   final Namer namer;
 
   /**
    * Interface used to determine if an object has the JavaScript
    * indexing behavior. The interface is only visible to specific
    * libraries.
    */
   ClassElement jsIndexingBehaviorInterface;
 
-  final Map<Element, Map<Element, HType>> fieldInitializers;
-  final Map<Element, Map<Element, HType>> fieldConstructorSetters;
-  final Map<Element, Map<Element, HType>> fieldSettersType;
-
   final Map<Element, ReturnInfo> returnInfo;
 
   /**
    * Documentation wanted -- johnniwinther
    *
    * Invariant: Elements must be declaration elements.
    */
   final List<Element> invalidateAfterCodegen;
   ArgumentTypesRegistry argumentTypes;
+  FieldTypesRegistry fieldTypes;
 
   List<CompilerTask> get tasks {
     return <CompilerTask>[builder, optimizer, generator, emitter];
   }
 
   JavaScriptBackend(Compiler compiler, bool generateSourceMap)
-      : fieldInitializers = new Map<Element, Map<Element, HType>>(),
-        fieldConstructorSetters = new Map<Element, Map<Element, HType>>(),
-        fieldSettersType = new Map<Element, Map<Element, HType>>(),
-        namer = new Namer(compiler),
+      : namer = new Namer(compiler),
         returnInfo = new Map<Element, ReturnInfo>(),
         invalidateAfterCodegen = new List<Element>(),
         super(compiler, constantSystem: JAVA_SCRIPT_CONSTANT_SYSTEM) {
     emitter = new CodeEmitterTask(compiler, namer, generateSourceMap);
     builder = new SsaBuilderTask(this);
     optimizer = new SsaOptimizerTask(this);
     generator = new SsaCodeGeneratorTask(this);
     argumentTypes = new ArgumentTypesRegistry(this);
+    fieldTypes = new FieldTypesRegistry(this);
   }
 
   Element get cyclicThrowHelper {
     return compiler.findHelper(const SourceString("throwCyclicInit"));
   }
 
   JavaScriptItemCompilationContext createItemCompilationContext() {
     return new JavaScriptItemCompilationContext();
   }
 
@@ skipping 22 matching lines @@
       } else {
         // If the constant-handler was not able to produce a result we have to
         // go through the builder (below) to generate the lazy initializer for
         // the static variable.
         // We also need to register the use of the cyclic-error helper.
         compiler.enqueuer.codegen.registerStaticUse(cyclicThrowHelper);
       }
     }
 
     HGraph graph = builder.build(work);
-    optimizer.optimize(work, graph);
+    optimizer.optimize(work, graph, false);
     if (work.allowSpeculativeOptimization
         && optimizer.trySpeculativeOptimizations(work, graph)) {
       CodeBuffer codeBuffer = generator.generateBailoutMethod(work, graph);
       compiler.codegenWorld.addBailoutCode(work, codeBuffer);
       optimizer.prepareForSpeculativeOptimizations(work, graph);
-      optimizer.optimize(work, graph);
+      optimizer.optimize(work, graph, true);
     }
     CodeBuffer codeBuffer = generator.generateCode(work, graph);
     compiler.codegenWorld.addGeneratedCode(work, codeBuffer);
     invalidateAfterCodegen.forEach(compiler.enqueuer.codegen.eagerRecompile);
     invalidateAfterCodegen.clear();
   }
 
   void processNativeClasses(Enqueuer world,
                             Collection<LibraryElement> libraries) {
     native.processNativeClasses(world, emitter, libraries);
   }
 
   void assembleProgram() {
     emitter.assembleProgram();
   }
 
-  void updateFieldInitializers(Element field, HType propagatedType) {
-    assert(field.isField());
-    assert(field.isMember());
-    Map<Element, HType> fields =
-        fieldInitializers.putIfAbsent(
-          field.getEnclosingClass(), () => new Map<Element, HType>());
-    if (!fields.containsKey(field)) {
-      fields[field] = propagatedType;
-    } else {
-      fields[field] = fields[field].union(propagatedType);
-    }
-  }
-
-  HType typeFromInitializersSoFar(Element field) {
-    assert(field.isField());
-    assert(field.isMember());
-    if (!fieldInitializers.containsKey(field.getEnclosingClass())) {
-      return HType.CONFLICTING;
-    }
-    Map<Element, HType> fields = fieldInitializers[field.getEnclosingClass()];
-    return fields[field];
-  }
-
-  void updateFieldConstructorSetters(Element field, HType type) {
-    assert(field.isField());
-    assert(field.isMember());
-    Map<Element, HType> fields =
-        fieldConstructorSetters.putIfAbsent(
-            field.getEnclosingClass(), () => new Map<Element, HType>());
-    if (!fields.containsKey(field)) {
-      fields[field] = type;
-    } else {
-      fields[field] = fields[field].union(type);
-    }
-  }
-
-  // Check if this field is set in the constructor body.
-  bool hasConstructorBodyFieldSetter(Element field) {
-    ClassElement enclosingClass = field.getEnclosingClass();
-    if (!fieldConstructorSetters.containsKey(enclosingClass)) {
-      return false;
-    }
-    return fieldConstructorSetters[enclosingClass][field] != null;
-  }
-
-  // Provide an optimistic estimate of the type of a field after construction.
-  // If the constructor body has setters for fields returns HType.UNKNOWN.
-  // This only takes the initializer lists and field assignments in the
-  // constructor body into account. The constructor body might have method calls
-  // that could alter the field.
-  HType optimisticFieldTypeAfterConstruction(Element field) {
-    assert(field.isField());
-    assert(field.isMember());
-
-    ClassElement classElement = field.getEnclosingClass();
-    if (hasConstructorBodyFieldSetter(field)) {
-      // If there are field setters but there is only constructor then the type
-      // of the field is determined by the assignments in the constructor
-      // body.
-      var constructors = classElement.constructors;
-      if (constructors.head !== null && constructors.tail.isEmpty()) {
-        return fieldConstructorSetters[classElement][field];
-      } else {
-        return HType.UNKNOWN;
-      }
-    } else if (fieldInitializers.containsKey(classElement)) {
-      HType type = fieldInitializers[classElement][field];
-      return type == null ? HType.CONFLICTING : type;
-    } else {
-      return HType.CONFLICTING;
-    }
-  }
-
-  void updateFieldSetters(Element field, HType type) {
-    assert(field.isField());
-    assert(field.isMember());
-    Map<Element, HType> fields =
-        fieldSettersType.putIfAbsent(
-          field.getEnclosingClass(), () => new Map<Element, HType>());
-    if (!fields.containsKey(field)) {
-      fields[field] = type;
-    } else {
-      fields[field] = fields[field].union(type);
-    }
-  }
-
-  // Returns the type that field setters are setting the field to based on what
-  // have been seen during compilation so far.
-  HType fieldSettersTypeSoFar(Element field) {
-    assert(field.isField());
-    assert(field.isMember());
-    ClassElement enclosingClass = field.getEnclosingClass();
-    if (!fieldSettersType.containsKey(enclosingClass)) {
-      return HType.CONFLICTING;
-    }
-    Map<Element, HType> fields = fieldSettersType[enclosingClass];
-    if (!fields.containsKey(field)) return HType.CONFLICTING;
-    return fields[field];
-  }
-
   /**
    * Documentation wanted -- johnniwinther
    *
    * Invariant: [element] must be a declaration element.
    */
   void scheduleForRecompilation(Element element) {
     assert(invariant(element, element.isDeclaration));
     if (compiler.phase == Compiler.PHASE_COMPILING) {
       invalidateAfterCodegen.add(element);
     }
@@ skipping 48 matching lines @@
    * scheduled for recompilation.
    *
    * Invariant: [element] must be a declaration element.
    */
   registerParameterTypesOptimization(
       FunctionElement element,
       HTypeList parameterTypes,
       OptionalParameterTypes defaultValueTypes) {
     assert(invariant(element, element.isDeclaration));
     if (element.parameterCount(compiler) == 0) return;
-    argumentTypes.registerOptimization(
+    argumentTypes.registerOptimizedFunction(
         element, parameterTypes, defaultValueTypes);
   }
 
+  registerFieldTypesOptimization(FunctionElement element,
+                                 Element field,
+                                 HType type) {
+    fieldTypes.registerOptimizedFunction(element, field, type);
+  }
+
   /**
    * Documentation wanted -- johnniwinther
    *
    * Invariant: [element] must be a declaration element.
    */
   void registerReturnType(FunctionElement element, HType returnType) {
     assert(invariant(element, element.isDeclaration));
     ReturnInfo info = returnInfo[element];
     if (info != null) {
       info.update(returnType, scheduleForRecompilation);
@@ skipping 24 matching lines @@
   }
 
   void dumpReturnTypes() {
     returnInfo.forEach((Element element, ReturnInfo info) {
       if (info.returnType != HType.UNKNOWN) {
         print("Inferred $element has return type ${info.returnType}");
       }
     });
   }
 
+  void registerConstructor(Element element) {
+    fieldTypes.registerConstructor(element);
+  }
+
+  void registerFieldInitializer(Element field, HType type) {
+    fieldTypes.registerFieldInitializer(field, type);
+  }
+
+  void registerFieldConstructor(Element field, HType type) {
+    fieldTypes.registerFieldConstructor(field, type);
+  }
+
+  void registerFieldSetter(FunctionElement element, Element field, HType type) {
+    fieldTypes.registerFieldSetter(element, field, type);
+  }
+
+  void addedDynamicSetter(Selector setter, HType type) {
+    fieldTypes.addedDynamicSetter(setter, type);
+  }
+
+  HType optimisticFieldType(Element element) {
+    return fieldTypes.optimisticFieldType(element);
+  }
+
   SourceString getCheckedModeHelper(DartType type) {
     Element element = type.element;
     bool nativeCheck =
           emitter.nativeEmitter.requiresNativeIsCheck(element);
     if (element == compiler.stringClass) {
       return const SourceString('stringTypeCheck');
     } else if (element == compiler.doubleClass) {
       return const SourceString('doubleTypeCheck');
     } else if (element == compiler.numClass) {
       return const SourceString('numTypeCheck');
@@ skipping 19 matching lines @@
             ? const SourceString('listSuperNativeTypeCheck')
             : const SourceString('listSuperTypeCheck');
       } else {
         return nativeCheck
             ? const SourceString('callTypeCheck')
             : const SourceString('propertyTypeCheck');
       }
     }
   }
 }