Initial support for length guards on final fields.

runtime/vm/intermediate_language_ia32.cc

 // Copyright (c) 2013, 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.
 
 #include "vm/globals.h"  // Needed here to get TARGET_ARCH_IA32.
 #if defined(TARGET_ARCH_IA32)
 
 #include "vm/intermediate_language.h"
 
 #include "vm/dart_entry.h"
@@ skipping 1559 matching lines @@
       UNREACHABLE();
   }
 }
 
 
 LocationSummary* GuardFieldInstr::MakeLocationSummary() const {
   const intptr_t kNumInputs = 1;
   LocationSummary* summary =
       new LocationSummary(kNumInputs, 0, LocationSummary::kNoCall);
   summary->set_in(0, Location::RequiresRegister());
-  if ((value()->Type()->ToCid() == kDynamicCid) &&
-      (field().guarded_cid() != kSmiCid)) {
+  const intptr_t field_length = field().guarded_list_length();
+  const bool field_has_length = field_length >= Field::kUnknownLength;

[srdjan, 2013/08/14 17:01:08]

You can move this 'intelligence' into class Field: has_length() const { return
... }

[Cutch, 2013/08/15 16:39:12]

Done.

+  const bool need_value_temp_reg =

[srdjan, 2013/08/14 17:01:08]

Maybe assert that only final fields have length. That means that the extra code
is emitted only in the constructors and should not contribute significantly to
code growth,

[Cutch, 2013/08/15 16:39:12]

The Field::needs_length_check function now includes an assertion check.

+      (field_has_length || ((value()->Type()->ToCid() == kDynamicCid) &&
+                            (field().guarded_cid() != kSmiCid)));
+  if (need_value_temp_reg) {
     summary->AddTemp(Location::RequiresRegister());
   }
-  if (field().guarded_cid() == kIllegalCid) {
+  const bool need_field_temp_reg =
+      field_has_length || (field().guarded_cid() == kIllegalCid);
+  if (need_field_temp_reg) {
     summary->AddTemp(Location::RequiresRegister());
   }
   return summary;
 }
 
 
 void GuardFieldInstr::EmitNativeCode(FlowGraphCompiler* compiler) {
   const intptr_t field_cid = field().guarded_cid();
   const intptr_t nullability = field().is_nullable() ? kNullCid : kIllegalCid;
+  const intptr_t field_length = field().guarded_list_length();
+  const bool field_has_length = field_length >= Field::kUnknownLength;
+  const bool need_value_temp_reg =

[srdjan, 2013/08/14 17:01:08]

s/need_value_temp_reg/needs_value_temp_reg/ ?

[Cutch, 2013/08/15 16:39:12]

Done.

+      (field_has_length || ((value()->Type()->ToCid() == kDynamicCid) &&
+                            (field().guarded_cid() != kSmiCid)));
+  const bool need_field_temp_reg =

[srdjan, 2013/08/14 17:01:08]

ditto ?

[Cutch, 2013/08/15 16:39:12]

Done.

+      field_has_length || (field().guarded_cid() == kIllegalCid);
+  if (field_has_length) {
+    // Currently, we should only see final fields that remember length.
+    ASSERT(field().is_final());
+  }
 
   if (field_cid == kDynamicCid) {
     ASSERT(!compiler->is_optimizing());
     return;  // Nothing to emit.
   }
 
   const intptr_t value_cid = value()->Type()->ToCid();
 
   Register value_reg = locs()->in(0).reg();
 
-  Register value_cid_reg = ((value_cid == kDynamicCid) &&
-      (field_cid != kSmiCid)) ? locs()->temp(0).reg() : kNoRegister;
+  Register value_cid_reg = need_value_temp_reg ?
+      locs()->temp(0).reg() : kNoRegister;
 
-  Register field_reg = (field_cid == kIllegalCid) ?
+  Register field_reg = need_field_temp_reg ?
       locs()->temp(locs()->temp_count() - 1).reg() : kNoRegister;
 
   Label ok, fail_label;
 
   Label* deopt = compiler->is_optimizing() ?
       compiler->AddDeoptStub(deopt_id(), kDeoptGuardField) : NULL;
 
   Label* fail = (deopt != NULL) ? deopt : &fail_label;
 
   const bool ok_is_fall_through = (deopt != NULL);
 
   if (!compiler->is_optimizing() || (field_cid == kIllegalCid)) {
-    if (!compiler->is_optimizing()) {
+    if (!compiler->is_optimizing() && (field_reg == kNoRegister)) {
       // Currently we can't have different location summaries for optimized
       // and non-optimized code. So instead we manually pick up a register
       // that is known to be free because we know how non-optimizing compiler
       // allocates registers.
       field_reg = EBX;
       ASSERT((field_reg != value_reg) && (field_reg != value_cid_reg));
     }
+    // Non-optimizing compiler or an uninitialized field guard data.
 
     __ LoadObject(field_reg, Field::ZoneHandle(field().raw()));
 
     FieldAddress field_cid_operand(field_reg, Field::guarded_cid_offset());
     FieldAddress field_nullability_operand(
         field_reg, Field::is_nullable_offset());
+    FieldAddress field_length_operand(
+        field_reg, Field::guarded_list_length_offset());
 
     if (value_cid == kDynamicCid) {
+      // Value has unknown class id.
       if (value_cid_reg == kNoRegister) {
         ASSERT(!compiler->is_optimizing());
         value_cid_reg = EDX;
         ASSERT((value_cid_reg != value_reg) && (field_reg != value_cid_reg));
       }
-
       LoadValueCid(compiler, value_cid_reg, value_reg);
 
+      Label skip_length_check;
       __ cmpl(value_cid_reg, field_cid_operand);
-      __ j(EQUAL, &ok);
+      // Value CID != Field guard CID, skip length check.
+      __ j(NOT_EQUAL, &skip_length_check);
+      if (field_has_length) {
+        // Field guard may have remembered list length, checked it.

[srdjan, 2013/08/14 17:01:08]

s/checked/check/

[Cutch, 2013/08/15 16:39:12]

Done.

+        if ((field_cid == kArrayCid) || (field_cid == kImmutableArrayCid)) {
+          __ pushl(value_cid_reg);
+          __ movl(value_cid_reg,
+                  FieldAddress(value_reg, Array::length_offset()));
+          __ cmpl(value_cid_reg, Immediate(field_length));
+          __ popl(value_cid_reg);
+        } else if (RawObject::IsTypedDataClassId(field_cid)) {
+          __ pushl(value_cid_reg);
+          __ movl(value_cid_reg,
+                  FieldAddress(value_reg, TypedData::length_offset()));
+          __ cmpl(value_cid_reg, Immediate(field_length));
+          __ popl(value_cid_reg);
+        }

[srdjan, 2013/08/14 17:01:08]

else ?

[Cutch, 2013/08/15 16:39:12]

Good catch.

+        __ j(NOT_EQUAL, fail);
+      }
+      __ Bind(&skip_length_check);
       __ cmpl(value_cid_reg, field_nullability_operand);
     } else if (value_cid == kNullCid) {
+      // Value in graph known to be null.
+      // Compare with null.
       __ cmpl(field_nullability_operand, Immediate(value_cid));
     } else {
+      // Value in graph known to be non-null.
+      Label skip_length_check;
+      // Compare class id with guard field class id.
       __ cmpl(field_cid_operand, Immediate(value_cid));
+      // If not equal, skip over length check.
+      __ j(NOT_EQUAL, &skip_length_check);
+      // Insert length check.
+      if (field_has_length) {
+        if (value_cid_reg == kNoRegister) {
+          ASSERT(!compiler->is_optimizing());
+          value_cid_reg = EDX;
+          ASSERT((value_cid_reg != value_reg) && (field_reg != value_cid_reg));
+        }
+        ASSERT(value_cid_reg != kNoRegister);
+        if ((field_cid == kArrayCid) || (field_cid == kImmutableArrayCid)) {
+          __ pushl(value_cid_reg);
+          __ movl(value_cid_reg,
+                  FieldAddress(value_reg, Array::length_offset()));
+          __ cmpl(value_cid_reg, Immediate(field_length));
+          __ popl(value_cid_reg);
+        } else if (RawObject::IsTypedDataClassId(field_cid)) {
+          __ pushl(value_cid_reg);
+          __ movl(value_cid_reg,
+                  FieldAddress(value_reg, TypedData::length_offset()));
+          __ cmpl(value_cid_reg, Immediate(field_length));
+          __ popl(value_cid_reg);
+        }

[srdjan, 2013/08/14 17:01:08]

else ?

+      }
+      // Not identical, possibly null.
+      __ Bind(&skip_length_check);
     }
+    // Jump when class id guard and list length guard are okay.
     __ j(EQUAL, &ok);
 
+
+    // Check if guard field is uninitialized.
     __ cmpl(field_cid_operand, Immediate(kIllegalCid));
+    // Jump to failure path when guard field has been initialized and
+    // the field and value class ids do not not match.
     __ j(NOT_EQUAL, fail);
 
+    // At this point the field guard is being initialized for the first time.
     if (value_cid == kDynamicCid) {

[srdjan, 2013/08/14 17:01:08]

Maybe do not emit extra code if field is not final?

[Cutch, 2013/08/15 16:39:12]

Done.

+      // Do not know value's class id.
+      Label check_array, local_exit, local_fail;
       __ movl(field_cid_operand, value_cid_reg);
       __ movl(field_nullability_operand, value_cid_reg);
+      __ cmpl(value_cid_reg, Immediate(kNullCid));
+      __ j(EQUAL, &local_fail);
+      // Check for typed data array.
+      __ cmpl(value_cid_reg, Immediate(kTypedDataFloat32x4ArrayCid));
+      __ j(GREATER, &local_fail);  // Not a typed array or a regular array.
+      __ cmpl(value_cid_reg, Immediate(kTypedDataInt8ArrayCid));
+      __ j(LESS, &check_array);  // Could still be a regular array.
+      // Destroy value_cid_reg (safe because we are finished with it).
+      __ movl(value_cid_reg,
+              FieldAddress(value_reg, TypedData::length_offset()));
+      __ movl(field_length_operand, value_cid_reg);
+      __ jmp(&local_exit);  // Updated field length typed data array.
+      // Check for regular array.
+      __ Bind(&check_array);
+      __ cmpl(value_cid_reg, Immediate(kImmutableArrayCid));
+      __ j(GREATER, &local_fail);
+      __ cmpl(value_cid_reg, Immediate(kArrayCid));
+      __ j(LESS, &local_fail);
+      // Destroy value_cid_reg (safe because we are finished with it).
+      __ movl(value_cid_reg,
+              FieldAddress(value_reg, Array::length_offset()));
+      __ movl(field_length_operand, value_cid_reg);
+      __ jmp(&local_exit);  // Updated field length from regular array.
+
+      __ Bind(&local_fail);
+      __ movl(field_length_operand, Immediate(Field::kNoLength));
+
+      __ Bind(&local_exit);
     } else {
+      if (value_cid_reg == kNoRegister) {
+          ASSERT(!compiler->is_optimizing());
+          value_cid_reg = EDX;
+          ASSERT((value_cid_reg != value_reg) && (field_reg != value_cid_reg));
+      }
+      ASSERT(value_cid_reg != kNoRegister);
+      ASSERT(field_reg != kNoRegister);
       __ movl(field_cid_operand, Immediate(value_cid));
       __ movl(field_nullability_operand, Immediate(value_cid));
+      if ((value_cid == kArrayCid) || (value_cid == kImmutableArrayCid)) {
+        // Destroy value_cid_reg (safe because we are finished with it).
+        __ movl(value_cid_reg,
+                FieldAddress(value_reg, Array::length_offset()));
+        __ movl(field_length_operand, value_cid_reg);
+      } else if (RawObject::IsTypedDataClassId(value_cid)) {
+        // Destroy value_cid_reg (safe because we are finished with it).
+        __ movl(value_cid_reg,
+                FieldAddress(value_reg, TypedData::length_offset()));
+        __ movl(field_length_operand, value_cid_reg);
+      } else {
+        __ movl(field_length_operand, Immediate(Field::kNoLength));
+      }
     }
 
     if (!ok_is_fall_through) {
       __ jmp(&ok);
     }
   } else {
+    // Field guard class has been initialized and is known.
+
+    if (field_reg != kNoRegister) {
+      __ LoadObject(field_reg, Field::ZoneHandle(field().raw()));
+    }
+
     if (value_cid == kDynamicCid) {
-      // Field's guarded class id is fixed by value's class id is not known.
+      // Value's class id is not known.
       __ testl(value_reg, Immediate(kSmiTagMask));
 
       if (field_cid != kSmiCid) {
+        // value is a smi.
         __ j(ZERO, fail);
         __ LoadClassId(value_cid_reg, value_reg);
         __ cmpl(value_cid_reg, Immediate(field_cid));
       }
 
+      if (field_has_length) {
+        // Jump when Value CID != Field guard CID
+        __ j(NOT_EQUAL, fail);
+
+        // Classes are same, perform guarded list length check.
+        ASSERT(field_reg != kNoRegister);
+        ASSERT(value_cid_reg != kNoRegister);
+        FieldAddress field_length_operand(
+            field_reg, Field::guarded_list_length_offset());
+        if ((field_cid == kArrayCid) || (field_cid == kImmutableArrayCid)) {
+          // Destroy value_cid_reg (safe because we are finished with it).
+          __ movl(value_cid_reg,
+                  FieldAddress(value_reg, Array::length_offset()));
+        } else if (RawObject::IsTypedDataClassId(field_cid)) {
+          // Destroy value_cid_reg (safe because we are finished with it).
+          __ movl(value_cid_reg,
+                  FieldAddress(value_reg, TypedData::length_offset()));
+        }
+        __ cmpl(value_cid_reg, field_length_operand);
+      }
+
       if (field().is_nullable() && (field_cid != kNullCid)) {
         __ j(EQUAL, &ok);
         const Immediate& raw_null =
             Immediate(reinterpret_cast<intptr_t>(Object::null()));
         __ cmpl(value_reg, raw_null);
       }
 
       if (ok_is_fall_through) {
         __ j(NOT_EQUAL, fail);
       } else {
         __ j(EQUAL, &ok);
       }
     } else {
       // Both value's and field's class id is known.
       if ((value_cid != field_cid) && (value_cid != nullability)) {
         if (ok_is_fall_through) {
           __ jmp(fail);
         }
+      } else if (field_has_length && (value_cid == field_cid)) {
+        ASSERT(value_cid_reg != kNoRegister);
+        if ((field_cid == kArrayCid) || (field_cid == kImmutableArrayCid)) {
+          // Destroy value_cid_reg (safe because we are finished with it).
+          __ movl(value_cid_reg,
+                  FieldAddress(value_reg, Array::length_offset()));
+        } else if (RawObject::IsTypedDataClassId(field_cid)) {
+          // Destroy value_cid_reg (safe because we are finished with it).
+          __ movl(value_cid_reg,
+                  FieldAddress(value_reg, TypedData::length_offset()));
+        }
+        __ cmpl(value_cid_reg, Immediate(field_length));
+        if (ok_is_fall_through) {
+          __ j(NOT_EQUAL, fail);
+        }
       } else {
         // Nothing to emit.
         ASSERT(!compiler->is_optimizing());
         return;
       }
     }
   }
 
   if (deopt == NULL) {
     ASSERT(!compiler->is_optimizing());
@@ skipping 3253 matching lines @@
                          PcDescriptors::kOther,
                          locs());
   __ Drop(2);  // Discard type arguments and receiver.
 }
 
 }  // namespace dart
 
 #undef __
 
 #endif  // defined TARGET_ARCH_IA32