Introduce a class encapsulating arguments descriptor arrays.

runtime/vm/stub_code_ia32.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"
 #if defined(TARGET_ARCH_IA32)
 
 #include "vm/assembler.h"
 #include "vm/assembler_macros.h"
 #include "vm/compiler.h"
+#include "vm/dart_entry.h"
 #include "vm/flow_graph_compiler.h"
 #include "vm/instructions.h"
 #include "vm/object_store.h"
 #include "vm/pages.h"
 #include "vm/resolver.h"
 #include "vm/scavenger.h"
 #include "vm/stub_code.h"
 
 
 #define __ assembler->
@@ skipping 155 matching lines @@
 
   // Cache Context pointer into CTX while executing Dart code.
   __ movl(CTX, EDI);
 
   __ LeaveFrame();
   __ ret();
 }
 
 
 // Input parameters:
-//   EDX: arguments descriptor array (num_args is first Smi element).
+//   EDX: arguments descriptor array.
 void StubCode::GenerateCallStaticFunctionStub(Assembler* assembler) {
   const Immediate raw_null =
       Immediate(reinterpret_cast<intptr_t>(Object::null()));
   AssemblerMacros::EnterStubFrame(assembler);
   __ pushl(EDX);  // Preserve arguments descriptor array.
   __ pushl(raw_null);  // Setup space on stack for return value.
   __ CallRuntime(kPatchStaticCallRuntimeEntry);
   __ popl(EAX);  // Get Code object result.
   __ popl(EDX);  // Restore arguments descriptor array.
   // Remove the stub frame as we are about to jump to the dart function.
   __ LeaveFrame();
 
   __ movl(ECX, FieldAddress(EAX, Code::instructions_offset()));
   __ addl(ECX, Immediate(Instructions::HeaderSize() - kHeapObjectTag));
   __ jmp(ECX);
 }
 
 
 // Called from a static call only when an invalid code has been entered
 // (invalid because its function was optimized or deoptimized).
-// EDX: arguments descriptor array (num_args is first Smi element).
+// EDX: arguments descriptor array.
 void StubCode::GenerateFixCallersTargetStub(Assembler* assembler) {
   const Immediate raw_null =
       Immediate(reinterpret_cast<intptr_t>(Object::null()));
   // Create a stub frame as we are pushing some objects on the stack before
   // calling into the runtime.
   AssemblerMacros::EnterStubFrame(assembler);
   __ pushl(EDX);  // Preserve arguments descriptor array.
   __ pushl(raw_null);  // Setup space on stack for return value.
   __ CallRuntime(kFixCallersTargetRuntimeEntry);
   __ popl(EAX);  // Get Code object.
@@ skipping 32 matching lines @@
   __ AddImmediate(ECX, Immediate(kWordSize));
   __ AddImmediate(EBX, Immediate(-kWordSize));
   __ Bind(&loop_condition);
   __ decl(EDX);
   __ j(POSITIVE, &loop, Assembler::kNearJump);
 }
 
 
 // Input parameters:
 //   ECX: ic-data.
-//   EDX: arguments descriptor array (num_args is first Smi element).
+//   EDX: arguments descriptor array.
 // Note: The receiver object is the first argument to the function being
 //       called, the stub accesses the receiver from this location directly
 //       when trying to resolve the call.
 // Uses EDI.
 void StubCode::GenerateInstanceFunctionLookupStub(Assembler* assembler) {
   const Immediate raw_null =
       Immediate(reinterpret_cast<intptr_t>(Object::null()));
 
   // Create a stub frame as we are pushing some objects on the stack before
   // calling into the runtime.
   AssemblerMacros::EnterStubFrame(assembler);
 
   // Preserve values across call to resolving.
   // Stack at this point:
   // TOS + 0: PC marker => RawInstruction object.
   // TOS + 1: Saved EBP of previous frame. <== EBP
   // TOS + 2: Dart code return address
   // TOS + 3: Last argument of caller.
   // ....
-  // Total number of args is the first Smi in args descriptor array (EDX).
-  __ movl(EAX, FieldAddress(EDX, Array::data_offset()));
+  __ movl(EAX, FieldAddress(EDX, ArgumentsDescriptor::count_offset()));
   __ movl(EAX, Address(EBP, EAX, TIMES_2, kWordSize));  // Get receiver.
   __ pushl(EDX);  // Preserve arguments descriptor array.
   __ pushl(EAX);  // Preserve receiver.
   __ pushl(ECX);  // Preserve ic-data.
   // First resolve the function to get the function object.
 
   __ pushl(raw_null);  // Setup space on stack for return value.
   __ pushl(EAX);  // Push receiver.
   __ CallRuntime(kResolveCompileInstanceFunctionRuntimeEntry);
   __ popl(EAX);  // Remove receiver pushed earlier.
@@ skipping 78 matching lines @@
 
   __ cmpl(ECX, raw_null);
   Label function_not_found;
   __ j(EQUAL, &function_not_found, Assembler::kNearJump);
 
   // ECX: Closure object.
   // EDI: Arguments descriptor array.
   __ pushl(raw_null);  // Setup space on stack for result from invoking Closure.
   __ pushl(ECX);  // Closure object.
   __ pushl(EDI);  // Arguments descriptor.
-  __ movl(EDI, FieldAddress(EDI, Array::data_offset()));
+  __ movl(EDI, FieldAddress(EDI, ArgumentsDescriptor::count_offset()));
   __ SmiUntag(EDI);
   __ subl(EDI, Immediate(1));  // Arguments array length, minus the receiver.
   PushArgumentsArray(assembler, (kWordSize * 6));
   // Stack layout explaining "(kWordSize * 6)" offset.
   // TOS + 0: Argument array.
   // TOS + 1: Arguments descriptor array.
   // TOS + 2: Closure object.
   // TOS + 3: Place for result from closure function.
   // TOS + 4: PC marker => RawInstruction object.
   // TOS + 5: Saved EBP of previous frame. <== EBP
@@ skipping 11 matching lines @@
   // Remove the stub frame as we are about to return.
   __ LeaveFrame();
   __ ret();
 
   __ Bind(&function_not_found);
   // The target function was not found, so invoke method
   // "void noSuchMethod(function_name, args_array)".
   //   EAX: receiver.
   //   EDX: ic-data.
   //   ECX: raw_null.
-  //   EDI: argument descriptor array.
+  //   EDI: arguments descriptor array.
 
   __ pushl(raw_null);  // Setup space on stack for result from noSuchMethod.
   __ pushl(EAX);  // Receiver.
   __ pushl(EDX);  // IC-data.
-  __ pushl(EDI);  // Argument descriptor array.
-  __ movl(EDI, FieldAddress(EDI, Array::data_offset()));
+  __ pushl(EDI);  // Arguments descriptor array.
+  __ movl(EDI, FieldAddress(EDI, ArgumentsDescriptor::count_offset()));
   __ SmiUntag(EDI);
   __ subl(EDI, Immediate(1));  // Arguments array length, minus the receiver.
   // See stack layout below explaining "wordSize * 7" offset.
   PushArgumentsArray(assembler, (kWordSize * 7));
 
   // Stack:
-  // TOS + 0: Argument array.
-  // TOS + 1: Argument descriptor array.
+  // TOS + 0: Arguments array.
+  // TOS + 1: Arguments descriptor array.
   // TOS + 2: IC-data.
   // TOS + 3: Receiver
   // TOS + 4: Place for result from noSuchMethod.
   // TOS + 5: PC marker => RawInstruction object.
   // TOS + 6: Saved EBP of previous frame. <== EBP
   // TOS + 7: Dart code return address
   // TOS + 8: Last argument of caller.
   // ....
 
   __ CallRuntime(kInvokeNoSuchMethodFunctionRuntimeEntry);
@@ skipping 260 matching lines @@
   __ CallRuntime(kAllocateArrayRuntimeEntry);
   __ popl(EAX);  // Pop element type argument.
   __ popl(EDX);  // Pop array length argument.
   __ popl(EAX);  // Pop return value from return slot.
   __ LeaveFrame();
   __ ret();
 }
 
 
 // Input parameters:
-//   EDX: Arguments descriptor array (num_args is first Smi element, closure
-//        object is included in num_args and is first argument).
+//   EDX: Arguments descriptor array.
 // Note: The closure object is the first argument to the function being
 //       called, the stub accesses the closure from this location directly
 //       when trying to resolve the call.
 // Uses EDI.
 void StubCode::GenerateCallClosureFunctionStub(Assembler* assembler) {
   const Immediate raw_null =
       Immediate(reinterpret_cast<intptr_t>(Object::null()));
 
-  // Total number of args is the first Smi in args descriptor array (EDX).
-  __ movl(EAX, FieldAddress(EDX, Array::data_offset()));  // Load num_args.
+  // Load num_args.
+  __ movl(EAX, FieldAddress(EDX, ArgumentsDescriptor::count_offset()));
   // Load closure object in EDI.
   __ movl(EDI, Address(ESP, EAX, TIMES_2, 0));  // EAX is a Smi.
 
   // Verify that EDI is a closure by checking its class.
   Label not_closure;
   __ cmpl(EDI, raw_null);
   // Not a closure, but null object.
   __ j(EQUAL, &not_closure, Assembler::kNearJump);
   __ testl(EDI, Immediate(kSmiTagMask));
   __ j(ZERO, &not_closure, Assembler::kNearJump);  // Not a closure, but a smi.
@@ skipping 28 matching lines @@
   __ popl(EDX);  // Restore arguments descriptor array.
   // Restore EAX.
   __ movl(EAX, FieldAddress(ECX, Function::code_offset()));
 
   // Remove the stub frame as we are about to jump to the closure function.
   __ LeaveFrame();
 
   __ Bind(&function_compiled);
   // EAX: Code.
   // ECX: Function.
-  // EDX: Arguments descriptor array (num_args is first Smi element).
+  // EDX: Arguments descriptor array.
 
   __ movl(ECX, FieldAddress(EAX, Code::instructions_offset()));
   __ addl(ECX, Immediate(Instructions::HeaderSize() - kHeapObjectTag));
   __ jmp(ECX);
 
   __ Bind(&not_closure);
   // Call runtime to report that a closure call was attempted on a non-closure
   // object, passing the non-closure object and its arguments array.
   // EDI: non-closure object.
-  // EDX: arguments descriptor array (num_args is first Smi element, closure
-  //      object is included in num_args).
+  // EDX: arguments descriptor array.
 
   // Create a stub frame as we are pushing some objects on the stack before
   // calling into the runtime.
   AssemblerMacros::EnterStubFrame(assembler);
 
   __ pushl(raw_null);  // Setup space on stack for result from error reporting.
   __ pushl(EDI);  // Non-closure object.
-    // Total number of args is the first Smi in args descriptor array (EDX).
-  __ movl(EDI, FieldAddress(EDX, Array::data_offset()));  // Load num_args.
+  // Load num_args.
+  __ movl(EDI, FieldAddress(EDX, ArgumentsDescriptor::count_offset()));
   __ SmiUntag(EDI);
   __ subl(EDI, Immediate(1));  // Arguments array length, minus the closure.
   // See stack layout below explaining "wordSize * 5" offset.
   PushArgumentsArray(assembler, (kWordSize * 5));
 
   // Stack:
   // TOS + 0: Argument array.
   // TOS + 1: Non-closure object.
   // TOS + 2: Place for result from reporting the error.
   // TOS + 3: PC marker => RawInstruction object.
@@ skipping 55 matching lines @@
   // GC marking, since it traverses any information between SP and
   // FP - kExitLinkOffsetInEntryFrame.
   __ movl(ECX, Address(EDI, Isolate::top_context_offset()));
   __ pushl(ECX);
 
   // Load arguments descriptor array into EDX.
   __ movl(EDX, Address(EBP, kArgumentsDescOffset));
   __ movl(EDX, Address(EDX, VMHandles::kOffsetOfRawPtrInHandle));
 
   // Load number of arguments into EBX.
-  __ movl(EBX, FieldAddress(EDX, Array::data_offset()));
+  __ movl(EBX, FieldAddress(EDX, ArgumentsDescriptor::count_offset()));
   __ SmiUntag(EBX);
 
   // Set up arguments for the dart call.
   Label push_arguments;
   Label done_push_arguments;
   __ testl(EBX, EBX);  // check if there are arguments.
   __ j(ZERO, &done_push_arguments, Assembler::kNearJump);
   __ movl(EAX, Immediate(0));
   __ movl(EDI, Address(EBP, kArgumentsOffset));  // start of arguments.
   __ Bind(&push_arguments);
   __ movl(ECX, Address(EDI, EAX, TIMES_4, 0));
   __ movl(ECX, Address(ECX, VMHandles::kOffsetOfRawPtrInHandle));
   __ pushl(ECX);
   __ incl(EAX);
   __ cmpl(EAX, EBX);
   __ j(LESS, &push_arguments, Assembler::kNearJump);
   __ Bind(&done_push_arguments);
 
   // Call the dart code entrypoint.
   __ call(Address(EBP, kEntryPointOffset));
 
   // Reread the Context pointer.
   __ movl(CTX, Address(EBP, kNewContextOffset));
   __ movl(CTX, Address(CTX, VMHandles::kOffsetOfRawPtrInHandle));
 
   // Reread the arguments descriptor array to obtain the number of passed
-  // arguments, which is the first element of the array, a Smi.
+  // arguments.
   __ movl(EDX, Address(EBP, kArgumentsDescOffset));
   __ movl(EDX, Address(EDX, VMHandles::kOffsetOfRawPtrInHandle));
-  __ movl(EDX, FieldAddress(EDX, Array::data_offset()));
+  __ movl(EDX, FieldAddress(EDX, ArgumentsDescriptor::count_offset()));
   // Get rid of arguments pushed on the stack.
   __ leal(ESP, Address(ESP, EDX, TIMES_2, 0));  // EDX is a Smi.
 
   // Load Isolate pointer from Context structure into CTX. Drop Context.
   __ movl(CTX, FieldAddress(CTX, Context::isolate_offset()));
 
   // Restore the saved Context pointer into the Isolate structure.
   // Uses ECX as a temporary register for this.
   __ popl(ECX);
   __ movl(Address(CTX, Isolate::top_context_offset()), ECX);
@@ skipping 537 matching lines @@
 void StubCode::GenerateCallNoSuchMethodFunctionStub(Assembler* assembler) {
   // The target function was not found, so invoke method
   // "void noSuchMethod(function_name, Array arguments)".
   // TODO(regis): For now, we simply pass the actual arguments, both positional
   // and named, as the argument array. This is not correct if out-of-order
   // named arguments were passed.
   // The signature of the "noSuchMethod" method has to change from
   // noSuchMethod(String name, Array arguments) to something like
   // noSuchMethod(InvocationMirror call).
   // Also, the class NoSuchMethodError has to be modified accordingly.
-  // Total number of args is the first Smi in args descriptor array (EDX).
   const Immediate raw_null =
       Immediate(reinterpret_cast<intptr_t>(Object::null()));
-  __ movl(EDI, FieldAddress(EDX, Array::data_offset()));
+  __ movl(EDI, FieldAddress(EDX, ArgumentsDescriptor::count_offset()));
   __ SmiUntag(EDI);
   __ movl(EAX, Address(EBP, EDI, TIMES_4, kWordSize));  // Get receiver.
 
   // Create a stub frame as we are pushing some objects on the stack before
   // calling into the runtime.
   AssemblerMacros::EnterStubFrame(assembler);
 
   __ pushl(raw_null);  // Setup space on stack for result from noSuchMethod.
   __ pushl(EAX);  // Receiver.
   __ pushl(ECX);  // IC data array.
@@ skipping 117 matching lines @@
 
   // Loop that checks if there is an IC data match.
   Label loop, update, test, found, get_class_id_as_smi;
   // ECX: IC data object (preserved).
   __ movl(EBX, FieldAddress(ECX, ICData::ic_data_offset()));
   // EBX: ic_data_array with check entries: classes and target functions.
   __ leal(EBX, FieldAddress(EBX, Array::data_offset()));
   // EBX: points directly to the first ic data array element.
 
   // Get the receiver's class ID (first read number of arguments from
-  // argument descriptor array and then access the receiver from the stack).
-  __ movl(EAX, FieldAddress(EDX, Array::data_offset()));
+  // arguments descriptor array and then access the receiver from the stack).
+  __ movl(EAX, FieldAddress(EDX, ArgumentsDescriptor::count_offset()));
   __ movl(EAX, Address(ESP, EAX, TIMES_2, 0));  // EAX (argument_count) is smi.
   __ call(&get_class_id_as_smi);
   // EAX: receiver's class ID (smi).
   __ movl(EDI, Address(EBX, 0));  // First class id (smi) to check.
   __ jmp(&test);
 
   __ Bind(&loop);
   for (int i = 0; i < num_args; i++) {
     if (i > 0) {
       // If not the first, load the next argument's class ID.
-      __ movl(EAX, FieldAddress(EDX, Array::data_offset()));
+      __ movl(EAX, FieldAddress(EDX, ArgumentsDescriptor::count_offset()));
       __ movl(EAX, Address(ESP, EAX, TIMES_2, - i * kWordSize));
       __ call(&get_class_id_as_smi);
       // EAX: next argument class ID (smi).
       __ movl(EDI, Address(EBX, i * kWordSize));
       // EDI: next class ID to check (smi).
     }
     __ cmpl(EAX, EDI);  // Class id match?
     if (i < (num_args - 1)) {
       __ j(NOT_EQUAL, &update);  // Continue.
     } else {
       // Last check, all checks before matched.
       __ j(EQUAL, &found, Assembler::kNearJump);  // Break.
     }
   }
   __ Bind(&update);
   // Reload receiver class ID.  It has not been destroyed when num_args == 1.
   if (num_args > 1) {
-    __ movl(EAX, FieldAddress(EDX, Array::data_offset()));
+    __ movl(EAX, FieldAddress(EDX, ArgumentsDescriptor::count_offset()));
     __ movl(EAX, Address(ESP, EAX, TIMES_2, 0));
     __ call(&get_class_id_as_smi);
   }
 
   const intptr_t entry_size = ICData::TestEntryLengthFor(num_args) * kWordSize;
   __ addl(EBX, Immediate(entry_size));  // Next entry.
   __ movl(EDI, Address(EBX, 0));  // Next class ID.
 
   __ Bind(&test);
   __ cmpl(EDI, Immediate(Smi::RawValue(kIllegalCid)));  // Done?
   __ j(NOT_EQUAL, &loop, Assembler::kNearJump);
 
   // IC miss.
   const Immediate raw_null =
       Immediate(reinterpret_cast<intptr_t>(Object::null()));
   // Compute address of arguments (first read number of arguments from
-  // argument descriptor array and then compute address on the stack).
-  __ movl(EAX, FieldAddress(EDX, Array::data_offset()));
+  // arguments descriptor array and then compute address on the stack).
+  __ movl(EAX, FieldAddress(EDX, ArgumentsDescriptor::count_offset()));
   __ leal(EAX, Address(ESP, EAX, TIMES_2, 0));  // EAX is Smi.
   // Create a stub frame as we are pushing some objects on the stack before
   // calling into the runtime.
   AssemblerMacros::EnterStubFrame(assembler);
-  __ pushl(EDX);  // Preserve arguments array.
+  __ pushl(EDX);  // Preserve arguments descriptor array.
   __ pushl(ECX);  // Preserve IC data array
   __ pushl(raw_null);  // Setup space on stack for result (target code object).
   // Push call arguments.
   for (intptr_t i = 0; i < num_args; i++) {
     __ movl(EDX, Address(EAX, -kWordSize * i));
     __ pushl(EDX);
   }
   if (num_args == 1) {
     __ CallRuntime(kInlineCacheMissHandlerOneArgRuntimeEntry);
   } else if (num_args == 2) {
     __ CallRuntime(kInlineCacheMissHandlerTwoArgsRuntimeEntry);
   } else if (num_args == 3) {
     __ CallRuntime(kInlineCacheMissHandlerThreeArgsRuntimeEntry);
   } else {
     UNIMPLEMENTED();
   }
   // Remove call arguments pushed earlier.
   for (intptr_t i = 0; i < num_args; i++) {
     __ popl(EAX);
   }
   __ popl(EAX);  // Pop returned code object into EAX (null if not found).
   __ popl(ECX);  // Restore IC data array.
-  __ popl(EDX);  // Restore arguments array.
+  __ popl(EDX);  // Restore arguments descriptor array.
   __ LeaveFrame();
   Label call_target_function;
   __ cmpl(EAX, raw_null);
   __ j(NOT_EQUAL, &call_target_function, Assembler::kNearJump);
   // NoSuchMethod or closure.
   // Mark IC call that it may be a closure call that does not collect
   // type feedback.
   __ movb(FieldAddress(ECX, ICData::is_closure_call_offset()), Immediate(1));
   __ jmp(&StubCode::InstanceFunctionLookupLabel());
 
@@ skipping 26 matching lines @@
   __ Bind(&not_smi);
   __ LoadClassId(EAX, EAX);
   __ SmiTag(EAX);
   __ ret();
 }
 
 
 // Use inline cache data array to invoke the target or continue in inline
 // cache miss handler. Stub for 1-argument check (receiver class).
 //  ECX: Inline cache data object.
-//  EDX: Arguments array.
+//  EDX: Arguments descriptor array.
 //  TOS(0): Return address.
 // Inline cache data object structure:
 // 0: function-name
 // 1: N, number of arguments checked.
 // 2 .. (length - 1): group of checks, each check containing:
 //   - N classes.
 //   - 1 target function.
 void StubCode::GenerateOneArgCheckInlineCacheStub(Assembler* assembler) {
   GenerateUsageCounterIncrement(assembler, EBX);
   GenerateNArgsCheckInlineCacheStub(assembler, 1);
@@ skipping 10 matching lines @@
   GenerateUsageCounterIncrement(assembler, EBX);
   GenerateNArgsCheckInlineCacheStub(assembler, 3);
 }
 
 
 
 // Use inline cache data array to invoke the target or continue in inline
 // cache miss handler. Stub for 1-argument check (receiver class).
 //  EDI: function which counter needs to be incremented.
 //  ECX: Inline cache data object.
-//  EDX: Arguments array.
+//  EDX: Arguments descriptor array.
 //  TOS(0): Return address.
 // Inline cache data object structure:
 // 0: function-name
 // 1: N, number of arguments checked.
 // 2 .. (length - 1): group of checks, each check containing:
 //   - N classes.
 //   - 1 target function.
 void StubCode::GenerateOneArgOptimizedCheckInlineCacheStub(
     Assembler* assembler) {
   GenerateOptimizedUsageCounterIncrement(assembler);
@@ skipping 21 matching lines @@
 }
 
 
 // Megamorphic call is currently implemented as IC call but through a stub
 // that does not check/count function invocations.
 void StubCode::GenerateMegamorphicCallStub(Assembler* assembler) {
   GenerateNArgsCheckInlineCacheStub(assembler, 1);
 }
 
 
-//  EDX: Arguments array.
+//  EDX: Arguments descriptor array.
 //  TOS(0): return address (Dart code).
 void StubCode::GenerateBreakpointStaticStub(Assembler* assembler) {
   // Create a stub frame as we are pushing some objects on the stack before
   // calling into the runtime.
   AssemblerMacros::EnterStubFrame(assembler);
   __ pushl(EDX);  // Preserve arguments descriptor.
   const Immediate raw_null =
       Immediate(reinterpret_cast<intptr_t>(Object::null()));
   __ pushl(raw_null);  // Room for result.
   __ CallRuntime(kBreakpointStaticHandlerRuntimeEntry);
@@ skipping 22 matching lines @@
   // Instead of returning to the patched Dart function, emulate the
   // smashed return code pattern and return to the function's caller.
   __ popl(ECX);  // Discard return address to patched dart code.
   // Execute function epilog code that was smashed in the Dart code.
   __ LeaveFrame();
   __ ret();
 }
 
 
 //  ECX: Inline cache data array.
-//  EDX: Arguments array.
+//  EDX: Arguments descriptor array.
 //  TOS(0): return address (Dart code).
 void StubCode::GenerateBreakpointDynamicStub(Assembler* assembler) {
   // Create a stub frame as we are pushing some objects on the stack before
   // calling into the runtime.
   AssemblerMacros::EnterStubFrame(assembler);
   __ pushl(ECX);
   __ pushl(EDX);
   __ CallRuntime(kBreakpointDynamicHandlerRuntimeEntry);
   __ popl(EDX);
   __ popl(ECX);
@@ skipping 370 matching lines @@
   __ Bind(&done);
   __ popl(temp);
   __ popl(right);
   __ popl(left);
   __ ret();
 }
 
 }  // namespace dart
 
 #endif  // defined TARGET_ARCH_IA32