Reduce copying, redundancy & repetition for codegen of comparison instructions

runtime/vm/intermediate_language_dbc.cc

 // Copyright (c) 2016, 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_DBC.
 #if defined(TARGET_ARCH_DBC)
 
 #include "vm/intermediate_language.h"
 
 #include "vm/cpu.h"
@@ skipping 465 matching lines @@
     if (labels.fall_through != labels.true_label) {
       // The preceeding Jump instruction will be skipped if the test succeeds.
       // If we aren't falling through to the true case, then we have to do
       // a Jump to it here.
       __ Jump(labels.true_label);
     }
   }
 }
 
 
+Condition StrictCompareInstr::GetPredictedCondition(FlowGraphCompiler* compiler,

[Vyacheslav Egorov (Google), 2017/06/15 11:32:46]

The name GetPredicatedCondition(...) is very confusing. 

Maybe it should be simply called GetNextInstructioCondition(...) or something
like that.

[erikcorry, 2017/06/19 07:15:09]

Done.

+                                                    BranchLabels labels) {
+  return (labels.fall_through == labels.false_label) ? NEXT_IS_TRUE
+                                                     : NEXT_IS_FALSE;
+}
+
+
 Condition StrictCompareInstr::EmitComparisonCode(FlowGraphCompiler* compiler,
                                                  BranchLabels labels) {
   ASSERT((kind() == Token::kNE_STRICT) || (kind() == Token::kEQ_STRICT));
 
   Token::Kind comparison;
   Condition condition;
   if (labels.fall_through == labels.false_label) {
     condition = NEXT_IS_TRUE;
     comparison = kind();
   } else {
@@ skipping 19 matching lines @@
     __ Emit(Bytecode::Encode((comparison == Token::kEQ_STRICT) ? eq_op : ne_op,
                              locs()->in(0).reg(), locs()->in(1).reg()));
   }
 
   if (needs_number_check() && token_pos().IsReal()) {
     compiler->RecordSafepoint(locs());
     compiler->AddCurrentDescriptor(RawPcDescriptors::kRuntimeCall, deopt_id_,
                                    token_pos());
   }
 
   return condition;

[Vyacheslav Egorov (Google), 2017/06/15 11:32:46]

this should probably be return GetPredictedCondition(...).

[erikcorry, 2017/06/19 07:15:09]

We assert that they return the same. I think that's better because it will
trigger if this is changed without fixing the GetPredictedCondition.

 }
 
 
-void StrictCompareInstr::EmitBranchCode(FlowGraphCompiler* compiler,
-                                        BranchInstr* branch) {
-  ASSERT((kind() == Token::kEQ_STRICT) || (kind() == Token::kNE_STRICT));
+DEFINE_MAKE_LOCATION_SUMMARY(StrictCompare,
+                             2,
+                             Location::RequiresRegister(),
+                             needs_number_check() ? LocationSummary::kCall
+                                                  : LocationSummary::kNoCall)
 
+
+template <intptr_t N,
+          typename ThrowsTrait,
+          template <typename Impure, typename Pure> class CSETrait>
+void TemplateComparison<N, ThrowsTrait, CSETrait>::EmitBranchCode(
+    FlowGraphCompiler* compiler,
+    BranchInstr* branch) {
   BranchLabels labels = compiler->CreateBranchLabels(branch);
   Condition true_condition = EmitComparisonCode(compiler, labels);
-  EmitBranchOnCondition(compiler, true_condition, labels);
+  if (true_condition != INVALID_CONDITION) {
+    EmitBranchOnCondition(compiler, true_condition, labels);
+  }
 }
 
 
-EMIT_NATIVE_CODE(StrictCompare,
-                 2,
-                 Location::RequiresRegister(),
-                 needs_number_check() ? LocationSummary::kCall
-                                      : LocationSummary::kNoCall) {
-  ASSERT((kind() == Token::kEQ_STRICT) || (kind() == Token::kNE_STRICT));
+// IA32 compiler needs this to link.
+template <>
+void TemplateComparison<2, Throws, NoCSE>::EmitBranchCode(
+    FlowGraphCompiler* compiler,
+    BranchInstr* branch) {
+  UNREACHABLE();
+}
 
+
+template <intptr_t N,
+          typename ThrowsTrait,
+          template <typename Impure, typename Pure> class CSETrait>
+void TemplateComparison<N, ThrowsTrait, CSETrait>::EmitNativeCode(
+    FlowGraphCompiler* compiler) {
   Label is_true, is_false;
   BranchLabels labels = {&is_true, &is_false, &is_false};
-  Condition true_condition = EmitComparisonCode(compiler, labels);
-  EmitBranchOnCondition(compiler, true_condition, labels);
-  Label done;
-  if (compiler->is_optimizing()) {
-    const Register result = locs()->out(0).reg();
-    __ Bind(&is_false);
-    __ LoadConstant(result, Bool::False());
-    __ Jump(&done);
-    __ Bind(&is_true);
-    __ LoadConstant(result, Bool::True());
-    __ Bind(&done);
-  } else {
+  Condition true_condition = this->GetPredictedCondition(compiler, labels);
+  if (true_condition == INVALID_CONDITION || !compiler->is_optimizing() ||
+      is_true.IsLinked() || is_false.IsLinked()) {
+    Condition actual_condition = EmitComparisonCode(compiler, labels);
+    ASSERT(actual_condition == true_condition);
+    if (true_condition != INVALID_CONDITION) {
+      EmitBranchOnCondition(compiler, true_condition, labels);
+    }
+    Label done;
     __ Bind(&is_false);
     __ PushConstant(Bool::False());
     __ Jump(&done);
     __ Bind(&is_true);
     __ PushConstant(Bool::True());
     __ Bind(&done);
+  } else {
+    const Register result = this->locs()->out(0).reg();
+    __ LoadConstant(
+        result, true_condition == NEXT_IS_TRUE ? Bool::False() : Bool::True());
+    Condition actual_condition = EmitComparisonCode(compiler, labels);
+    ASSERT(actual_condition == true_condition);
+    __ LoadConstant(
+        result, true_condition == NEXT_IS_TRUE ? Bool::True() : Bool::False());
   }
 }
 
 
+// IA32 compiler needs this to link (for the simmips config).
+template <>
+void TemplateComparison<2, Throws, NoCSE>::EmitNativeCode(
+    FlowGraphCompiler* compiler) {
+  UNREACHABLE();
+}
+
+
+// Explicit template instantiations.
+template void TemplateComparison<1, NoThrow, Pure>::EmitNativeCode(
+    FlowGraphCompiler*);
+template void TemplateComparison<2, NoThrow, Pure>::EmitNativeCode(
+    FlowGraphCompiler*);
+template void TemplateComparison<1, NoThrow, Pure>::EmitBranchCode(
+    FlowGraphCompiler* compiler,
+    BranchInstr* branch);
+template void TemplateComparison<2, NoThrow, Pure>::EmitBranchCode(
+    FlowGraphCompiler* compiler,
+    BranchInstr* branch);
+
+
 LocationSummary* BranchInstr::MakeLocationSummary(Zone* zone, bool opt) const {
   comparison()->InitializeLocationSummary(zone, opt);
   if (!comparison()->HasLocs()) {
     return NULL;
   }
   // Branches don't produce a result.
   comparison()->locs()->set_out(0, Location::NoLocation());
   return comparison()->locs();
 }
 
@@ skipping 14 matching lines @@
     compiler->parallel_move_resolver()->EmitNativeCode(parallel_move());
   }
   // We can fall through if the successor is the next block in the list.
   // Otherwise, we need a jump.
   if (!compiler->CanFallThroughTo(successor())) {
     __ Jump(compiler->GetJumpLabel(successor()));
   }
 }
 
 
+Condition TestSmiInstr::GetPredictedCondition(FlowGraphCompiler* compiler,
+                                              BranchLabels labels) {
+  ASSERT((kind() == Token::kEQ) || (kind() == Token::kNE));
+  return (kind() == Token::kEQ) ? NEXT_IS_TRUE : NEXT_IS_FALSE;
+}
+
+
 Condition TestSmiInstr::EmitComparisonCode(FlowGraphCompiler* compiler,
                                            BranchLabels labels) {
   ASSERT((kind() == Token::kEQ) || (kind() == Token::kNE));
   Register left = locs()->in(0).reg();
   Register right = locs()->in(1).reg();
   __ TestSmi(left, right);
   return (kind() == Token::kEQ) ? NEXT_IS_TRUE : NEXT_IS_FALSE;

[Vyacheslav Egorov (Google), 2017/06/15 11:32:46]

should this get return GetPredictedCondition()?

[erikcorry, 2017/06/19 07:15:09]

See above.

 }
 
 
-void TestSmiInstr::EmitBranchCode(FlowGraphCompiler* compiler,
-                                  BranchInstr* branch) {
-  BranchLabels labels = compiler->CreateBranchLabels(branch);
-  Condition true_condition = EmitComparisonCode(compiler, labels);
-  EmitBranchOnCondition(compiler, true_condition, labels);
-}
-
-
-EMIT_NATIVE_CODE(TestSmi,
-                 2,
-                 Location::RequiresRegister(),
-                 LocationSummary::kNoCall) {
-  // Never emitted outside of the BranchInstr.
-  UNREACHABLE();
-}
+DEFINE_MAKE_LOCATION_SUMMARY(TestSmi,
+                             2,
+                             Location::RequiresRegister(),
+                             LocationSummary::kNoCall)
 
 
 Condition TestCidsInstr::EmitComparisonCode(FlowGraphCompiler* compiler,
                                             BranchLabels labels) {
   ASSERT((kind() == Token::kIS) || (kind() == Token::kISNOT));
   const Register value = locs()->in(0).reg();
   const intptr_t true_result = (kind() == Token::kIS) ? 1 : 0;
 
   const ZoneGrowableArray<intptr_t>& data = cid_results();
   const intptr_t num_cases = data.length() / 2;
@@ skipping 16 matching lines @@
     // that are in the list.  These must be all the same (see asserts in the
     // constructor).
     Label* target = result ? labels.false_label : labels.true_label;
     __ Jump(target);
   }
 
   return NEXT_IS_TRUE;
 }
 
 
-void TestCidsInstr::EmitBranchCode(FlowGraphCompiler* compiler,
-                                   BranchInstr* branch) {
-  BranchLabels labels = compiler->CreateBranchLabels(branch);
-  Condition true_condition = EmitComparisonCode(compiler, labels);
-  EmitBranchOnCondition(compiler, true_condition, labels);
+Condition TestCidsInstr::GetPredictedCondition(FlowGraphCompiler* compiler,
+                                               BranchLabels labels) {
+  return NEXT_IS_TRUE;
 }
 
 
-EMIT_NATIVE_CODE(TestCids,
-                 1,
-                 Location::RequiresRegister(),
-                 LocationSummary::kNoCall) {
-  Register result_reg = locs()->out(0).reg();
-  Label is_true, is_false, done;
-  BranchLabels labels = {&is_true, &is_false, &is_false};
-  EmitComparisonCode(compiler, labels);
-  __ Jump(&is_true);
-  __ Bind(&is_false);
-  __ LoadConstant(result_reg, Bool::False());
-  __ Jump(&done);
-  __ Bind(&is_true);
-  __ LoadConstant(result_reg, Bool::True());
-  __ Bind(&done);
-}
+DEFINE_MAKE_LOCATION_SUMMARY(TestCids,
+                             1,
+                             Location::RequiresRegister(),
+                             LocationSummary::kNoCall)
 
 
 EMIT_NATIVE_CODE(CreateArray,
                  2,
                  Location::RequiresRegister(),
                  LocationSummary::kCall) {
   if (compiler->is_optimizing()) {
     const Register length = locs()->in(kLengthPos).reg();
     const Register type_arguments = locs()->in(kElementTypePos).reg();
     const Register out = locs()->out(0).reg();
@@ skipping 1047 matching lines @@
       __ DDiv(result, left, right);
       break;
     default:
       UNREACHABLE();
   }
 }
 
 
 Condition DoubleTestOpInstr::EmitComparisonCode(FlowGraphCompiler* compiler,
                                                 BranchLabels labels) {
-  UNREACHABLE();
-  return Condition();
-}
-
-
-void DoubleTestOpInstr::EmitBranchCode(FlowGraphCompiler* compiler,
-                                       BranchInstr* branch) {
   ASSERT(compiler->is_optimizing());
-  BranchLabels labels = compiler->CreateBranchLabels(branch);
   const Register value = locs()->in(0).reg();
   switch (op_kind()) {
     case MethodRecognizer::kDouble_getIsNaN:
       __ DoubleIsNaN(value);
       break;
     case MethodRecognizer::kDouble_getIsInfinite:
       __ DoubleIsInfinite(value);
       break;
     default:
       UNREACHABLE();
   }
   const bool is_negated = kind() != Token::kEQ;

[Vyacheslav Egorov (Google), 2017/06/15 11:32:46]

return GetPredictedCondition();

[erikcorry, 2017/06/19 07:15:09]

See above

-  EmitBranchOnCondition(compiler, is_negated ? NEXT_IS_FALSE : NEXT_IS_TRUE,
-                        labels);
+  return is_negated ? NEXT_IS_FALSE : NEXT_IS_TRUE;
 }
 
 
-EMIT_NATIVE_CODE(DoubleTestOp, 1, Location::RequiresRegister()) {
-  ASSERT(compiler->is_optimizing());
-  const Register value = locs()->in(0).reg();
-  const Register result = locs()->out(0).reg();
+Condition DoubleTestOpInstr::GetPredictedCondition(FlowGraphCompiler* compiler,
+                                                   BranchLabels labels) {
   const bool is_negated = kind() != Token::kEQ;
-  __ LoadConstant(result, is_negated ? Bool::True() : Bool::False());
-  switch (op_kind()) {
-    case MethodRecognizer::kDouble_getIsNaN:
-      __ DoubleIsNaN(value);
-      break;
-    case MethodRecognizer::kDouble_getIsInfinite:
-      __ DoubleIsInfinite(value);
-      break;
-    default:
-      UNREACHABLE();
-  }
-  __ LoadConstant(result, is_negated ? Bool::False() : Bool::True());
+  return is_negated ? NEXT_IS_FALSE : NEXT_IS_TRUE;
 }
 
 
+DEFINE_MAKE_LOCATION_SUMMARY(DoubleTestOp, 1, Location::RequiresRegister())
+
+
 EMIT_NATIVE_CODE(UnaryDoubleOp, 1, Location::RequiresRegister()) {
   const Register value = locs()->in(0).reg();
   const Register result = locs()->out(0).reg();
   __ DNeg(result, value);
 }
 
 
 EMIT_NATIVE_CODE(MathUnary, 1, Location::RequiresRegister()) {
   const Register value = locs()->in(0).reg();
   const Register result = locs()->out(0).reg();
@@ skipping 154 matching lines @@
                                      Token::Kind kind,
                                      BranchLabels labels) {
   const Register left = locs->in(0).reg();
   const Register right = locs->in(1).reg();
   Token::Kind comparison = kind;
   Condition condition = NEXT_IS_TRUE;
   if (labels.fall_through != labels.false_label) {
     // If we aren't falling through to the false label, we can save a Jump
     // instruction in the case that the true case is the fall through by
     // flipping the sense of the test such that the instruction following the
-    // test is the Jump to the false label.
+    // test is the Jump to the false label.  In the case where both labels are
+    // null we don't flip the sense of the test.
     condition = NEXT_IS_FALSE;
     comparison = FlipCondition(kind);
   }
   __ Emit(Bytecode::Encode(OpcodeForSmiCondition(comparison), left, right));
   return condition;
 }
 
 
 static Condition EmitDoubleComparisonOp(FlowGraphCompiler* compiler,
                                         LocationSummary* locs,
@@ skipping 16 matching lines @@
                                                    BranchLabels labels) {
   if (operation_cid() == kSmiCid) {
     return EmitSmiComparisonOp(compiler, locs(), kind(), labels);
   } else {
     ASSERT(operation_cid() == kDoubleCid);
     return EmitDoubleComparisonOp(compiler, locs(), kind());
   }
 }
 
 
-EMIT_NATIVE_CODE(EqualityCompare, 2, Location::RequiresRegister()) {
-  ASSERT(compiler->is_optimizing());
-  ASSERT((kind() == Token::kEQ) || (kind() == Token::kNE));
-  Label is_true, is_false;
-  // These labels are not used. They are arranged so that EmitComparisonCode
-  // emits a test that executes the following instruction when the test
-  // succeeds.
-  BranchLabels labels = {&is_true, &is_false, &is_false};
-  const Register result = locs()->out(0).reg();
-  __ LoadConstant(result, Bool::False());
-  Condition true_condition = EmitComparisonCode(compiler, labels);
-  ASSERT(true_condition == NEXT_IS_TRUE);
-  __ LoadConstant(result, Bool::True());
+Condition EqualityCompareInstr::GetPredictedCondition(
+    FlowGraphCompiler* compiler,
+    BranchLabels labels) {
+  if (operation_cid() == kSmiCid) {
+    return (labels.fall_through != labels.false_label) ? NEXT_IS_FALSE
+                                                       : NEXT_IS_TRUE;
+  } else {
+    ASSERT(operation_cid() == kDoubleCid);
+    return NEXT_IS_TRUE;
+  }
 }
 
 
-void EqualityCompareInstr::EmitBranchCode(FlowGraphCompiler* compiler,
-                                          BranchInstr* branch) {
-  ASSERT((kind() == Token::kNE) || (kind() == Token::kEQ));
-  BranchLabels labels = compiler->CreateBranchLabels(branch);
-  Condition true_condition = EmitComparisonCode(compiler, labels);
-  EmitBranchOnCondition(compiler, true_condition, labels);
-}
+DEFINE_MAKE_LOCATION_SUMMARY(EqualityCompare, 2, Location::RequiresRegister());
 
 
 Condition RelationalOpInstr::EmitComparisonCode(FlowGraphCompiler* compiler,
                                                 BranchLabels labels) {
   if (operation_cid() == kSmiCid) {
     return EmitSmiComparisonOp(compiler, locs(), kind(), labels);
   } else {
     ASSERT(operation_cid() == kDoubleCid);
     return EmitDoubleComparisonOp(compiler, locs(), kind());
   }
 }
 
 
-EMIT_NATIVE_CODE(RelationalOp, 2, Location::RequiresRegister()) {
-  ASSERT(compiler->is_optimizing());
-  Label is_true, is_false;
-  BranchLabels labels = {&is_true, &is_false, &is_false};
-  const Register result = locs()->out(0).reg();
-  __ LoadConstant(result, Bool::False());
-  Condition true_condition = EmitComparisonCode(compiler, labels);
-  ASSERT(true_condition == NEXT_IS_TRUE);
-  __ LoadConstant(result, Bool::True());
+Condition RelationalOpInstr::GetPredictedCondition(FlowGraphCompiler* compiler,
+                                                   BranchLabels labels) {
+  if (operation_cid() == kSmiCid) {
+    return (labels.fall_through != labels.false_label) ? NEXT_IS_FALSE
+                                                       : NEXT_IS_TRUE;
+  } else {
+    ASSERT(operation_cid() == kDoubleCid);
+    return NEXT_IS_TRUE;
+  }
 }
 
 
-void RelationalOpInstr::EmitBranchCode(FlowGraphCompiler* compiler,
-                                       BranchInstr* branch) {
-  BranchLabels labels = compiler->CreateBranchLabels(branch);
-  Condition true_condition = EmitComparisonCode(compiler, labels);
-  EmitBranchOnCondition(compiler, true_condition, labels);
-}
+DEFINE_MAKE_LOCATION_SUMMARY(RelationalOp, 2, Location::RequiresRegister())
 
 
 EMIT_NATIVE_CODE(CheckArrayBound, 2) {
   const Register length = locs()->in(kLengthPos).reg();
   const Register index = locs()->in(kIndexPos).reg();
   const intptr_t index_cid = this->index()->Type()->ToCid();
   if (index_cid != kSmiCid) {
     __ CheckSmi(index);
     compiler->EmitDeopt(deopt_id(), ICData::kDeoptCheckArrayBound,
                         (generalized_ ? ICData::kGeneralized : 0) |
                             (licm_hoisted_ ? ICData::kHoisted : 0));
   }
   __ IfULe(length, index);
   compiler->EmitDeopt(deopt_id(), ICData::kDeoptCheckArrayBound,
                       (generalized_ ? ICData::kGeneralized : 0) |
                           (licm_hoisted_ ? ICData::kHoisted : 0));
 }
 
 }  // namespace dart
 
 #endif  // defined TARGET_ARCH_DBC