Add graph intrinsics for many math library functions

runtime/vm/intrinsifier.cc

 // 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.
 // Class for intrinsifying functions.
 
 #include "vm/assembler.h"
 #include "vm/compiler.h"
 #include "vm/flags.h"
 #include "vm/flow_graph.h"
 #include "vm/flow_graph_compiler.h"
 #include "vm/flow_graph_allocator.h"
 #include "vm/flow_graph_builder.h"
 #include "vm/il_printer.h"
 #include "vm/intermediate_language.h"
 #include "vm/intrinsifier.h"
 #include "vm/object.h"
 #include "vm/parser.h"
 #include "vm/symbols.h"
 
 
 namespace dart {
 
 DEFINE_FLAG(bool, intrinsify, true, "Instrinsify when possible");
+DEFINE_FLAG(bool, trace_intrinsifier, false, "Trace intrinsifier");
 DECLARE_FLAG(bool, code_comments);
 DECLARE_FLAG(bool, print_flow_graph);
 DECLARE_FLAG(bool, print_flow_graph_optimized);
 
 bool Intrinsifier::CanIntrinsify(const Function& function) {
+  if (FLAG_trace_intrinsifier) {
+    THR_Print("CanIntrinsify %s ->", function.ToQualifiedCString());
+  }
   if (!FLAG_intrinsify) return false;
-  if (function.IsClosureFunction()) return false;
+  if (function.IsClosureFunction()) {
+    if (FLAG_trace_intrinsifier) {
+      THR_Print("No, closure function.\n");
+    }
+    return false;
+  }
   // Can occur because of compile-all flag.
-  if (function.is_external()) return false;
-  return function.is_intrinsic();
+  if (function.is_external()) {
+    if (FLAG_trace_intrinsifier) {
+      THR_Print("No, external function.\n");
+    }
+    return false;
+  }
+  if (!function.is_intrinsic()) {
+    if (FLAG_trace_intrinsifier) {
+      THR_Print("No, not intrinsic function.\n");
+    }
+    return false;
+  }
+  if (FLAG_trace_intrinsifier) {
+    THR_Print("Yes.\n");
+  }
+  return true;
 }
 
 
 #if defined(DART_NO_SNAPSHOT)
 void Intrinsifier::InitializeState() {
   Thread* thread = Thread::Current();
   Zone* zone = thread->zone();
   Library& lib = Library::Handle(zone);
   Class& cls = Class::Handle(zone);
   Function& func = Function::Handle(zone);
@@ skipping 27 matching lines @@
   lib = Library::CoreLibrary();
   ASSERT(!lib.IsNull());
   CORE_LIB_INTRINSIC_LIST(SETUP_FUNCTION);
   CORE_INTEGER_LIB_INTRINSIC_LIST(SETUP_FUNCTION);
   GRAPH_CORE_INTRINSICS_LIST(SETUP_FUNCTION);
 
   // Set up all math lib functions that can be intrinsified.
   lib = Library::MathLibrary();
   ASSERT(!lib.IsNull());
   MATH_LIB_INTRINSIC_LIST(SETUP_FUNCTION);
+  GRAPH_MATH_LIB_INTRINSIC_LIST(SETUP_FUNCTION);
 
   // Set up all dart:typed_data lib functions that can be intrinsified.
   lib = Library::TypedDataLibrary();
   ASSERT(!lib.IsNull());
   TYPED_DATA_LIB_INTRINSIC_LIST(SETUP_FUNCTION);
   GRAPH_TYPED_DATA_INTRINSICS_LIST(SETUP_FUNCTION);
 
   // Setup all dart:developer lib functions that can be intrinsified.
   lib = Library::DeveloperLibrary();
   ASSERT(!lib.IsNull());
   DEVELOPER_LIB_INTRINSIC_LIST(SETUP_FUNCTION);
 
 #undef SETUP_FUNCTION
 }
 #endif  // defined(DART_NO_SNAPSHOT).
 
 
 static void EmitCodeFor(FlowGraphCompiler* compiler,
                         FlowGraph* graph) {
   // The FlowGraph here is constructed by the intrinsics builder methods, and
   // is different from compiler->flow_graph(), the original method's flow graph.
-  compiler->assembler()->Comment("Graph intrinsic");
+  compiler->assembler()->Comment("Graph intrinsic begin");
   for (intptr_t i = 0; i < graph->reverse_postorder().length(); i++) {
     BlockEntryInstr* block = graph->reverse_postorder()[i];
     if (block->IsGraphEntry()) continue;  // No code for graph entry needed.
 
     if (block->HasParallelMove()) {
       compiler->parallel_move_resolver()->EmitNativeCode(
           block->parallel_move());
     }
 
     for (ForwardInstructionIterator it(block); !it.Done(); it.Advance()) {
       Instruction* instr = it.Current();
       if (FLAG_code_comments) compiler->EmitComment(instr);
       if (instr->IsParallelMove()) {
         compiler->parallel_move_resolver()->EmitNativeCode(
             instr->AsParallelMove());
+      } else if (instr->IsInvokeMathCFunction()) {
+        ASSERT(instr->locs() != NULL);
+        // InvokeMathCFunction always calls, but it uses registers that
+        // are free for the intrinsic to use.
+        instr->EmitNativeCode(compiler);
       } else {
         ASSERT(instr->locs() != NULL);
         // Calls are not supported in intrinsics code.
         ASSERT(!instr->locs()->always_calls());
         instr->EmitNativeCode(compiler);
       }
     }
   }
+  compiler->assembler()->Comment("Graph intrinsic end");
 }
 
 
 bool Intrinsifier::GraphIntrinsify(const ParsedFunction& parsed_function,
                                    FlowGraphCompiler* compiler) {
   ZoneGrowableArray<const ICData*>* ic_data_array =
       new ZoneGrowableArray<const ICData*>();
   FlowGraphBuilder builder(parsed_function,
                            *ic_data_array,
                            NULL,  // NULL = not inlining.
@@ skipping 81 matching lines @@
       return kFloat32x4Cid;
     case kUnboxedUint32:
       return kDynamicCid;  // smi or mint.
     default:
       UNREACHABLE();
       return kIllegalCid;
   }
 }
 
 
+// Notes about the graph intrinsics:
+//
+// IR instructions which would jump to a deoptimization sequence on failure
+// instead branch to the intrinsic slow path.
+
 class BlockBuilder : public ValueObject {
  public:
   BlockBuilder(FlowGraph* flow_graph, TargetEntryInstr* entry)
       : flow_graph_(flow_graph), entry_(entry), current_(entry) { }
 
   Definition* AddToInitialDefinitions(Definition* def) {
     def->set_ssa_temp_index(flow_graph_->alloc_ssa_temp_index());
     flow_graph_->AddToInitialDefinitions(def);
     return def;
   }
@@ skipping 16 matching lines @@
   }
 
   Definition* AddParameter(intptr_t index) {
     intptr_t adjustment = Intrinsifier::ParameterSlotFromSp();
     return AddToInitialDefinitions(
       new ParameterInstr(adjustment + index,
                          flow_graph_->graph_entry(),
                          SPREG));
   }
 
+  Definition* AddCheckedUnbox(Representation rep, Definition* boxed) {
+    const ICData& value_check = ICData::ZoneHandle(ICData::New(
+        flow_graph_->function(),
+        String::Handle(flow_graph_->function().name()),
+        Object::empty_array(),  // Dummy args. descr.
+        Thread::kNoDeoptId,
+        1));
+    value_check.AddReceiverCheck(CidForRepresentation(rep),
+                                 flow_graph_->function());
+    AddInstruction(new CheckClassInstr(new Value(boxed),
+                                       Thread::kNoDeoptId,
+                                       value_check,
+                                       TokenPos()));
+    return AddUnboxInstr(rep, new Value(boxed));
+  }
+
   TokenPosition TokenPos() {
     return flow_graph_->function().token_pos();
   }
 
   Definition* AddNullDefinition() {
     return AddDefinition(
         new ConstantInstr(Object::ZoneHandle(Object::null())));
   }
 
   Definition* AddUnboxInstr(Representation rep, Value* value) {

[Florian Schneider, 2016/03/22 09:21:02]

Definition* AddUnboxInstr(Representation rep, Value* value, bool is_checked) {

[Cutch, 2016/03/22 16:09:55]

Acknowledged.

     Definition* unboxed_value = AddDefinition(
         UnboxInstr::Create(rep, value, Thread::kNoDeoptId));
     // Manually adjust reaching type because there is no type propagation
     // when building intrinsics.

[Florian Schneider, 2016/03/22 09:21:03]

if (is_checked) {
  ...

     unboxed_value->AsUnbox()->value()->SetReachingType(ZoneCompileType::Wrap(
         CompileType::FromCid(CidForRepresentation(rep))));

[Florian Schneider, 2016/03/22 09:21:03]

}

     return unboxed_value;
   }
 
+  Definition* AddUnboxInstr(Representation rep, Definition* boxed) {

[Florian Schneider, 2016/03/22 09:21:02]

Definition* AddUnboxInstr(Representation rep, Definition* boxed, bool
is_checked) {

+    return AddUnboxInstr(rep, new Value(boxed));
+  }
+
+  Definition* InvokeMathCFunction(MethodRecognizer::Kind recognized_kind,
+                                  ZoneGrowableArray<Value*>* args) {
+    return InvokeMathCFunctionHelper(recognized_kind, args);
+  }
+
  private:
+  Definition* InvokeMathCFunctionHelper(MethodRecognizer::Kind recognized_kind,
+                                        ZoneGrowableArray<Value*>* args) {
+    InvokeMathCFunctionInstr* invoke_math_c_function =
+        new InvokeMathCFunctionInstr(args,
+                                     Thread::kNoDeoptId,
+                                     recognized_kind,
+                                     TokenPos());
+    AddDefinition(invoke_math_c_function);
+    return invoke_math_c_function;
+  }
+
+
   FlowGraph* flow_graph_;
   BlockEntryInstr* entry_;
   Instruction* current_;
 };
 
 
 static void PrepareIndexedOp(BlockBuilder* builder,
                              Definition* array,
                              Definition* index,
                              intptr_t length_offset) {
@@ skipping 583 matching lines @@
   Definition* unboxed_result = builder.AddDefinition(
       new UnaryDoubleOpInstr(Token::kNEGATE,
                              new Value(unboxed_value),
                              Thread::kNoDeoptId));
   Definition* result = builder.AddDefinition(
       BoxInstr::Create(kUnboxedDouble, new Value(unboxed_result)));
   builder.AddIntrinsicReturn(new Value(result));
   return true;
 }
 
+
+static bool BuildInvokeMathCFunction(BlockBuilder* builder,
+                                     MethodRecognizer::Kind kind) {
+  ZoneGrowableArray<Value*>* args =
+      new ZoneGrowableArray<Value*>(1);
+
+  Definition* value = builder->AddParameter(1);
+  Definition* unboxed_value = builder->AddCheckedUnbox(kUnboxedDouble, value);

[Florian Schneider, 2016/03/22 09:21:03]

builder->AddCheckedUnbox(kUnboxedDouble, value, /*is_checked =*/ false);

+  args->Add(new Value(unboxed_value));
+
+  Definition* unboxed_result =
+      builder->InvokeMathCFunction(kind, args);
+
+  Definition* result = builder->AddDefinition(
+      BoxInstr::Create(kUnboxedDouble, new Value(unboxed_result)));
+
+  builder->AddIntrinsicReturn(new Value(result));
+
+  return true;
+}
+
+
+bool Intrinsifier::Build_MathSin(FlowGraph* flow_graph) {
+  if (!FlowGraphCompiler::SupportsUnboxedDoubles()) return false;
+
+  GraphEntryInstr* graph_entry = flow_graph->graph_entry();
+  TargetEntryInstr* normal_entry = graph_entry->normal_entry();
+  BlockBuilder builder(flow_graph, normal_entry);
+
+  return BuildInvokeMathCFunction(&builder,
+                                  MethodRecognizer::kMathSin);
+}
+
+
+bool Intrinsifier::Build_MathCos(FlowGraph* flow_graph) {
+  if (!FlowGraphCompiler::SupportsUnboxedDoubles()) return false;
+
+  GraphEntryInstr* graph_entry = flow_graph->graph_entry();
+  TargetEntryInstr* normal_entry = graph_entry->normal_entry();
+  BlockBuilder builder(flow_graph, normal_entry);
+
+  return BuildInvokeMathCFunction(&builder,
+                                  MethodRecognizer::kMathCos);
+}
+
+
+bool Intrinsifier::Build_MathTan(FlowGraph* flow_graph) {
+  if (!FlowGraphCompiler::SupportsUnboxedDoubles()) return false;
+
+  GraphEntryInstr* graph_entry = flow_graph->graph_entry();
+  TargetEntryInstr* normal_entry = graph_entry->normal_entry();
+  BlockBuilder builder(flow_graph, normal_entry);
+
+  return BuildInvokeMathCFunction(&builder,
+                                  MethodRecognizer::kMathTan);
+}
+
+
+bool Intrinsifier::Build_MathAsin(FlowGraph* flow_graph) {
+  if (!FlowGraphCompiler::SupportsUnboxedDoubles()) return false;
+
+  GraphEntryInstr* graph_entry = flow_graph->graph_entry();
+  TargetEntryInstr* normal_entry = graph_entry->normal_entry();
+  BlockBuilder builder(flow_graph, normal_entry);
+
+  return BuildInvokeMathCFunction(&builder,
+                                  MethodRecognizer::kMathAsin);
+}
+
+
+bool Intrinsifier::Build_MathAcos(FlowGraph* flow_graph) {
+  if (!FlowGraphCompiler::SupportsUnboxedDoubles()) return false;
+
+  GraphEntryInstr* graph_entry = flow_graph->graph_entry();
+  TargetEntryInstr* normal_entry = graph_entry->normal_entry();
+  BlockBuilder builder(flow_graph, normal_entry);
+
+  return BuildInvokeMathCFunction(&builder,
+                                  MethodRecognizer::kMathAcos);
+}
+
+
+bool Intrinsifier::Build_MathAtan(FlowGraph* flow_graph) {
+  if (!FlowGraphCompiler::SupportsUnboxedDoubles()) return false;
+
+  GraphEntryInstr* graph_entry = flow_graph->graph_entry();
+  TargetEntryInstr* normal_entry = graph_entry->normal_entry();
+  BlockBuilder builder(flow_graph, normal_entry);
+
+  return BuildInvokeMathCFunction(&builder,
+                                  MethodRecognizer::kMathAtan);
+}
+
+
+bool Intrinsifier::Build_MathAtan2(FlowGraph* flow_graph) {
+  if (!FlowGraphCompiler::SupportsUnboxedDoubles()) return false;
+
+  GraphEntryInstr* graph_entry = flow_graph->graph_entry();
+  TargetEntryInstr* normal_entry = graph_entry->normal_entry();
+  BlockBuilder builder(flow_graph, normal_entry);
+
+  Definition* value_a = builder.AddParameter(1);

[Florian Schneider, 2016/03/22 09:21:03]

s/1/2

+  Definition* value_b = builder.AddParameter(2);

[Florian Schneider, 2016/03/22 09:21:02]

s/2/1

The index is relative to SP, so the last argument (value_b) gets index 1.

+
+  Definition* unboxed_a = builder.AddCheckedUnbox(kUnboxedDouble, value_a);

[Florian Schneider, 2016/03/22 09:21:03]

Definition* unboxed_a = builder.AddCheckedUnbox(kUnboxedDouble, value_a, false);

+  Definition* unboxed_b = builder.AddCheckedUnbox(kUnboxedDouble, value_b);

[Florian Schneider, 2016/03/22 09:21:03]

Definition* unboxed_b = builder.AddCheckedUnbox(kUnboxedDouble, value_b, false);

+
+  // C's atan2 expects the arguments in the opposite order.

[Florian Schneider, 2016/03/22 09:21:03]

Comment not needed (see comment above)

+  ZoneGrowableArray<Value*>* args =
+      new ZoneGrowableArray<Value*>(2);
+  args->Add(new Value(unboxed_b));

[Florian Schneider, 2016/03/22 09:21:03]

Swap this line with the one below.

+  args->Add(new Value(unboxed_a));
+
+  Definition* unboxed_result =
+      builder.InvokeMathCFunction(MethodRecognizer::kMathAtan2,
+                                  args);
+
+  Definition* result = builder.AddDefinition(
+      BoxInstr::Create(kUnboxedDouble, new Value(unboxed_result)));
+
+  builder.AddIntrinsicReturn(new Value(result));
+
+  return true;
+}
+
 }  // namespace dart