Implement new optional parameters syntax in the vm (issue 4290).

runtime/vm/flow_graph_compiler_x64.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.
 
 #include "vm/globals.h"  // Needed here to get TARGET_ARCH_X64.
 #if defined(TARGET_ARCH_X64)
 
 #include "vm/flow_graph_compiler.h"
 
 #include "lib/error.h"
 #include "vm/ast_printer.h"
 #include "vm/il_printer.h"
 #include "vm/locations.h"
 #include "vm/object_store.h"
 #include "vm/parser.h"
 #include "vm/stub_code.h"
 #include "vm/symbols.h"
 
 namespace dart {
 
 DECLARE_FLAG(bool, enable_type_checks);
 DECLARE_FLAG(bool, print_ast);
 DECLARE_FLAG(bool, print_scopes);
+DECLARE_FLAG(bool, reject_named_argument_as_positional);
 DECLARE_FLAG(bool, trace_functions);
 
 
 void CompilerDeoptInfoWithStub::GenerateCode(FlowGraphCompiler* compiler,
                                              intptr_t stub_ix) {
   // Calls do not need stubs, they share a deoptimization trampoline.
   ASSERT(reason() != kDeoptAtCall);
   Assembler* assem = compiler->assembler();
 #define __ assem->
   __ Comment("Deopt stub for id %"Pd"", deopt_id());
@@ skipping 548 matching lines @@
   __ movq(RDX, Address(RSP, 0));  // Get instantiator type arguments.
   __ movq(RCX, Address(RSP, kWordSize));  // Get instantiator.
   __ PushObject(Object::ZoneHandle());  // Make room for the result.
   __ pushq(RAX);  // Push the source object.
   __ PushObject(dst_type);  // Push the type of the destination.
   __ pushq(RCX);  // Instantiator.
   __ pushq(RDX);  // Instantiator type arguments.
   __ PushObject(dst_name);  // Push the name of the destination.
   __ LoadObject(RAX, test_cache);
   __ pushq(RAX);
-  GenerateCallRuntime(token_pos,
-                      kTypeCheckRuntimeEntry,
-                      locs);
+  GenerateCallRuntime(token_pos, kTypeCheckRuntimeEntry, locs);
   // Pop the parameters supplied to the runtime entry. The result of the
   // type check runtime call is the checked value.
   __ Drop(6);
   __ popq(RAX);
 
   __ Bind(&is_assignable);
   __ popq(RDX);  // Remove pushed instantiator type arguments.
   __ popq(RCX);  // Remove pushed instantiator.
 }
 
@@ skipping 14 matching lines @@
 }
 
 
 void FlowGraphCompiler::CopyParameters() {
   __ Comment("Copy parameters");
   const Function& function = parsed_function().function();
   const bool is_native_instance_closure =
       function.is_native() && function.IsImplicitInstanceClosureFunction();
   LocalScope* scope = parsed_function().node_sequence()->scope();
   const int num_fixed_params = function.num_fixed_parameters();
-  const int num_opt_params = function.num_optional_parameters();
+  const int num_opt_pos_params = function.num_optional_positional_parameters();
+  int num_opt_named_params = function.num_optional_named_parameters();
+  const int num_params =
+      num_fixed_params + num_opt_pos_params + num_opt_named_params;
   int implicit_this_param_pos = is_native_instance_closure ? -1 : 0;
   ASSERT(parsed_function().first_parameter_index() ==
          ParsedFunction::kFirstLocalSlotIndex + implicit_this_param_pos);
+
+  // Check that min_num_pos_args <= num_pos_args <= max_num_pos_args,
+  // where num_pos_args is the number of positional arguments passed in.
+  const int min_num_pos_args = num_fixed_params;
+  const int max_num_pos_args = num_fixed_params + num_opt_pos_params +
+      (FLAG_reject_named_argument_as_positional ? 0 : num_opt_named_params);
+
+  // Number of positional args is the second Smi in descriptor array (R10).
+  __ movq(RCX, FieldAddress(R10, Array::data_offset() + (1 * kWordSize)));
+  // Check that min_num_pos_args <= num_pos_args.
+  Label wrong_num_arguments;
+  __ cmpq(RCX, Immediate(Smi::RawValue(min_num_pos_args)));
+  __ j(LESS, &wrong_num_arguments);
+  // Check that num_pos_args <= max_num_pos_args.
+  __ cmpq(RCX, Immediate(Smi::RawValue(max_num_pos_args)));
+  __ j(GREATER, &wrong_num_arguments);
+
   // Copy positional arguments.
-  // Check that no fewer than num_fixed_params positional arguments are passed
-  // in and that no more than num_params arguments are passed in.
-  // Passed argument i at fp[1 + argc - i]
-  // copied to fp[ParsedFunction::kFirstLocalSlotIndex - i].
-  const int num_params = num_fixed_params + num_opt_params;
+  // Argument i passed at fp[1 + num_args - i] is copied
+  // to fp[ParsedFunction::kFirstLocalSlotIndex - i].
 
   // Total number of args is the first Smi in args descriptor array (R10).
   __ movq(RBX, FieldAddress(R10, Array::data_offset()));
-  // Check that num_args <= num_params.
-  Label wrong_num_arguments;
-  __ cmpq(RBX, Immediate(Smi::RawValue(num_params)));
-  __ j(GREATER, &wrong_num_arguments);
-  // Number of positional args is the second Smi in descriptor array (R10).
-  __ movq(RCX, FieldAddress(R10, Array::data_offset() + (1 * kWordSize)));
-  // Check that num_pos_args >= num_fixed_params.
-  __ cmpq(RCX, Immediate(Smi::RawValue(num_fixed_params)));
-  __ j(LESS, &wrong_num_arguments);
-
   // Since RBX and RCX are Smi, use TIMES_4 instead of TIMES_8.
   // Let RBX point to the last passed positional argument, i.e. to
   // fp[1 + num_args - (num_pos_args - 1)].
   __ subq(RBX, RCX);
   __ leaq(RBX, Address(RBP, RBX, TIMES_4, 2 * kWordSize));
 
   // Let RDI point to the last copied positional argument, i.e. to
   // fp[ParsedFunction::kFirstLocalSlotIndex - (num_pos_args - 1)].
   const int index =
       ParsedFunction::kFirstLocalSlotIndex + 1 + implicit_this_param_pos;
@@ skipping 17 matching lines @@
   const Address argument_addr(RBX, RCX, TIMES_8, 0);
   const Address copy_addr(RDI, RCX, TIMES_8, 0);
   __ Bind(&loop);
   __ movq(RAX, argument_addr);
   __ movq(copy_addr, RAX);
   __ Bind(&loop_condition);
   __ decq(RCX);
   __ j(POSITIVE, &loop, Assembler::kNearJump);
 
   // Copy or initialize optional named arguments.
+
+  if (!FLAG_reject_named_argument_as_positional) {
+    // Treat optional positional parameters as optional named parameters.
+    num_opt_named_params += num_opt_pos_params;
+  }
   const Immediate raw_null =
       Immediate(reinterpret_cast<intptr_t>(Object::null()));
   Label all_arguments_processed;
-  if (num_opt_params > 0) {
+  if (num_opt_named_params > 0) {
     // Start by alphabetically sorting the names of the optional parameters.
-    LocalVariable** opt_param = new LocalVariable*[num_opt_params];
-    int* opt_param_position = new int[num_opt_params];
+    LocalVariable** opt_param = new LocalVariable*[num_opt_named_params];
+    int* opt_param_position = new int[num_opt_named_params];
     for (int pos = num_fixed_params; pos < num_params; pos++) {
       LocalVariable* parameter = scope->VariableAt(pos);
       const String& opt_param_name = parameter->name();
       int i = pos - num_fixed_params;
       while (--i >= 0) {
         LocalVariable* param_i = opt_param[i];
         const intptr_t result = opt_param_name.CompareTo(param_i->name());
         ASSERT(result != 0);
         if (result > 0) break;
         opt_param[i + 1] = opt_param[i];
         opt_param_position[i + 1] = opt_param_position[i];
       }
       opt_param[i + 1] = parameter;
       opt_param_position[i + 1] = pos;
     }
     // Generate code handling each optional parameter in alphabetical order.
     // Total number of args is the first Smi in args descriptor array (R10).
     __ movq(RBX, FieldAddress(R10, Array::data_offset()));
     // Number of positional args is the second Smi in descriptor array (R10).
     __ movq(RCX, FieldAddress(R10, Array::data_offset() + (1 * kWordSize)));
     __ SmiUntag(RCX);
     // Let RBX point to the first passed argument, i.e. to fp[1 + argc - 0].
     __ leaq(RBX, Address(RBP, RBX, TIMES_4, kWordSize));  // RBX is Smi.
     // Let EDI point to the name/pos pair of the first named argument.
     __ leaq(RDI, FieldAddress(R10, Array::data_offset() + (2 * kWordSize)));
-    for (int i = 0; i < num_opt_params; i++) {
-      // Handle this optional parameter only if k or fewer positional arguments
-      // have been passed, where k is the position of this optional parameter in
-      // the formal parameter list.
+    for (int i = 0; i < num_opt_named_params; i++) {
       Label load_default_value, assign_optional_parameter, next_parameter;
       const int param_pos = opt_param_position[i];
-      __ cmpq(RCX, Immediate(param_pos));
-      __ j(GREATER, &next_parameter, Assembler::kNearJump);
+      if (!FLAG_reject_named_argument_as_positional) {
+        // Handle this optional parameter only if k or fewer positional
+        // arguments have been passed, where k is the position of this optional
+        // parameter in the formal parameter list.
+        __ cmpq(RCX, Immediate(param_pos));
+        __ j(GREATER, &next_parameter, Assembler::kNearJump);
+      }
       // Check if this named parameter was passed in.
       __ movq(RAX, Address(RDI, 0));  // Load RAX with the name of the argument.
+      ASSERT(opt_param[i]->name().IsSymbol());
       __ CompareObject(RAX, opt_param[i]->name());
       __ j(NOT_EQUAL, &load_default_value, Assembler::kNearJump);
       // Load RAX with passed-in argument at provided arg_pos, i.e. at
       // fp[1 + argc - arg_pos].
       __ movq(RAX, Address(RDI, kWordSize));  // RAX is arg_pos as Smi.
       __ addq(RDI, Immediate(2 * kWordSize));  // Point to next name/pos pair.
       __ negq(RAX);
       Address argument_addr(RBX, RAX, TIMES_4, 0);  // RAX is a negative Smi.
       __ movq(RAX, argument_addr);
       __ jmp(&assign_optional_parameter, Assembler::kNearJump);
       __ Bind(&load_default_value);
-      // Load RAX with default argument at pos.
+      // Load RAX with default argument.
       const Object& value = Object::ZoneHandle(
           parsed_function().default_parameter_values().At(
               param_pos - num_fixed_params));
       __ LoadObject(RAX, value);
       __ Bind(&assign_optional_parameter);
       // Assign RAX to fp[ParsedFunction::kFirstLocalSlotIndex - param_pos].
       // We do not use the final allocation index of the variable here, i.e.
       // scope->VariableAt(i)->index(), because captured variables still need
       // to be copied to the context that is not yet allocated.
       intptr_t computed_param_pos = (ParsedFunction::kFirstLocalSlotIndex -
                                      param_pos + implicit_this_param_pos);
       const Address param_addr(RBP, (computed_param_pos * kWordSize));
       __ movq(param_addr, RAX);
       __ Bind(&next_parameter);
     }
     delete[] opt_param;
     delete[] opt_param_position;
     // Check that RDI now points to the null terminator in the array descriptor.
     __ cmpq(Address(RDI, 0), raw_null);
     __ j(EQUAL, &all_arguments_processed, Assembler::kNearJump);
+  } else if (num_opt_pos_params > 0) {
+    ASSERT(FLAG_reject_named_argument_as_positional);
+    // Number of positional args is the second Smi in descriptor array (R10).
+    __ movq(RCX, FieldAddress(R10, Array::data_offset() + (1 * kWordSize)));
+    __ SmiUntag(RCX);
+    for (int i = 0; i < num_opt_pos_params; i++) {
+      Label next_parameter;
+      // Handle this optional positonal parameter only if k or fewer positional
+      // arguments have been passed, where k is param_pos, the position of this
+      // optional parameter in the formal parameter list.
+      const int param_pos = num_fixed_params + i;
+      __ cmpq(RCX, Immediate(param_pos));
+      __ j(GREATER, &next_parameter, Assembler::kNearJump);
+      // Load RAX with default argument.
+      const Object& value = Object::ZoneHandle(
+          parsed_function().default_parameter_values().At(i));
+      __ LoadObject(RAX, value);
+      // Assign RAX to fp[ParsedFunction::kFirstLocalSlotIndex - param_pos].
+      // We do not use the final allocation index of the variable here, i.e.
+      // scope->VariableAt(i)->index(), because captured variables still need
+      // to be copied to the context that is not yet allocated.
+      intptr_t computed_param_pos = (ParsedFunction::kFirstLocalSlotIndex -
+                                     param_pos + implicit_this_param_pos);
+      const Address param_addr(RBP, (computed_param_pos * kWordSize));
+      __ movq(param_addr, RAX);
+      __ Bind(&next_parameter);
+    }
+    // Total number of args is the first Smi in args descriptor array (R10).
+    __ movq(RBX, FieldAddress(R10, Array::data_offset()));
+    __ SmiUntag(RBX);
+    // Check that RCX equals RBX, i.e. no named arguments passed.
+    __ cmpq(RCX, RBX);
+    __ j(EQUAL, &all_arguments_processed, Assembler::kNearJump);
   } else {
     ASSERT(is_native_instance_closure);
     __ jmp(&all_arguments_processed, Assembler::kNearJump);
   }
 
   __ Bind(&wrong_num_arguments);
   if (StackSize() != 0) {
     // We need to unwind the space we reserved for locals and copied parameters.
     // The NoSuchMethodFunction stub does not expect to see that area on the
     // stack.
@@ skipping 24 matching lines @@
     // RBP + 8 : points to return address.
     // RBP + 16 : address of last argument (arg n-1).
     // RSP + 16 + 8*(n-1) : address of first argument (arg 0).
     // RBX : ic-data.
     // R10 : arguments descriptor array.
     __ call(&StubCode::CallNoSuchMethodFunctionLabel());
   }
   if (is_optimizing()) {
     stackmap_table_builder_->AddEntry(assembler()->CodeSize(),
                                       empty_stack_bitmap,
-                                      0);
+                                      0);  // No registers.
   }
 
   if (FLAG_trace_functions) {
     __ pushq(RAX);  // Preserve result.
     __ PushObject(Function::ZoneHandle(function.raw()));
     // We do not use GenerateCallRuntime because of the non-standard (empty)
     // stackmap used here.
     __ CallRuntime(kTraceFunctionExitRuntimeEntry);
     AddCurrentDescriptor(PcDescriptors::kOther,
                          Isolate::kNoDeoptId,
                          0);  // No token position.
     if (is_optimizing()) {
       stackmap_table_builder_->AddEntry(assembler()->CodeSize(),
                                         empty_stack_bitmap,
-                                        0);
+                                        0);  // No registers.
     }
     __ popq(RAX);  // Remove argument.
     __ popq(RAX);  // Restore result.
   }
   __ LeaveFrame();
   __ ret();
 
   __ Bind(&all_arguments_processed);
   // Nullify originally passed arguments only after they have been copied and
   // checked, otherwise noSuchMethod would not see their original values.
@@ skipping 74 matching lines @@
     // CodePatcher::CodeIsPatchable, which verifies that this code has a minimum
     // code size, and nop(2) increases the minimum code size appropriately.
     __ nop(2);
     __ int3();
     __ jmp(&StubCode::FixCallersTargetLabel());
     return;
   }
   // Specialized version of entry code from CodeGenerator::GenerateEntryCode.
   const Function& function = parsed_function().function();
 
-  const int parameter_count = function.num_fixed_parameters();
-  const int copied_parameter_count = parsed_function().copied_parameter_count();
-  const int local_count = parsed_function().stack_local_count();
+  const int num_fixed_params = function.num_fixed_parameters();
+  const int num_copied_params = parsed_function().num_copied_params();
+  const int num_locals = parsed_function().num_stack_locals();
   __ Comment("Enter frame");
   if (IsLeaf()) {
     AssemblerMacros::EnterDartLeafFrame(assembler(), (StackSize() * kWordSize));
   } else {
     AssemblerMacros::EnterDartFrame(assembler(), (StackSize() * kWordSize));
   }
 
   // For optimized code, keep a bitmap of the frame in order to build
   // stackmaps for GC safepoints in the prologue.
   LocationSummary* prologue_locs = NULL;
   if (is_optimizing()) {
     // Spill slots are allocated but not initialized.
     prologue_locs = new LocationSummary(0, 0, LocationSummary::kCall);
     prologue_locs->stack_bitmap()->SetLength(StackSize());
   }
 
   // We check the number of passed arguments when we have to copy them due to
-  // the presence of optional named parameters.
+  // the presence of optional parameters.
   // No such checking code is generated if only fixed parameters are declared,
   // unless we are debug mode or unless we are compiling a closure.
   LocalVariable* saved_args_desc_var =
       parsed_function().GetSavedArgumentsDescriptorVar();
-  if (copied_parameter_count == 0) {
+  if (num_copied_params == 0) {
 #ifdef DEBUG
+    ASSERT(!parsed_function().function().HasOptionalParameters());
     const bool check_arguments = true;
 #else
     const bool check_arguments = function.IsClosureFunction();
 #endif
     if (check_arguments) {
       __ Comment("Check argument count");
       // Check that num_fixed <= argc <= num_params.
       Label argc_in_range;
       // Total number of args is the first Smi in args descriptor array (R10).
       __ movq(RAX, FieldAddress(R10, Array::data_offset()));
-      __ cmpq(RAX, Immediate(Smi::RawValue(parameter_count)));
+      __ cmpq(RAX, Immediate(Smi::RawValue(num_fixed_params)));
       __ j(EQUAL, &argc_in_range, Assembler::kNearJump);
       if (function.IsClosureFunction()) {
         GenerateCallRuntime(function.token_pos(),
                             kClosureArgumentMismatchRuntimeEntry,
                             prologue_locs);
       } else {
         __ Stop("Wrong number of arguments");
       }
       __ Bind(&argc_in_range);
     }
@@ skipping 10 matching lines @@
       // and later to the context, once the context is allocated.
       ASSERT(saved_args_desc_var->is_captured() ||
              (saved_args_desc_var->index() == slot));
       __ movq(Address(RBP, slot * kWordSize), kArgumentsDescriptorReg);
     }
     CopyParameters();
   }
 
   // In unoptimized code, initialize (non-argument) stack allocated slots to
   // null. This does not cover the saved_args_desc_var slot.
-  if (!is_optimizing() && (local_count > 0)) {
+  if (!is_optimizing() && (num_locals > 0)) {
     __ Comment("Initialize spill slots");
     const intptr_t slot_base = parsed_function().first_stack_local_index();
     const Immediate raw_null =
         Immediate(reinterpret_cast<intptr_t>(Object::null()));
     __ movq(RAX, raw_null);
-    for (intptr_t i = 0; i < local_count; ++i) {
+    for (intptr_t i = 0; i < num_locals; ++i) {
       // Subtract index i (locals lie at lower addresses than RBP).
       __ movq(Address(RBP, (slot_base - i) * kWordSize), RAX);
     }
   }
 
   if (FLAG_print_scopes) {
     // Print the function scope (again) after generating the prologue in order
     // to see annotations such as allocation indices of locals.
     if (FLAG_print_ast) {
       // Second printing.
@@ skipping 315 matching lines @@
 void ParallelMoveResolver::Exchange(const Address& mem1, const Address& mem2) {
   __ Exchange(mem1, mem2);
 }
 
 
 #undef __
 
 }  // namespace dart
 
 #endif  // defined TARGET_ARCH_X64