1// Copyright 2006-2008 the V8 project authors. All rights reserved.
2// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
5// This files contains runtime support implemented in JavaScript.
6
7// CAUTION: Some of the functions specified in this file are called
8// directly from compiled code. These are the functions with names in
9// ALL CAPS. The compiled code passes the first argument in 'this' and
10// it does not push the function onto the stack. This means that you
11// cannot use contexts in all these functions.
12
13
14/* -----------------------------------
15   - - -   C o m p a r i s o n   - - -
16   -----------------------------------
17*/
18
19// The following declarations are shared with other native JS files.
20// They are all declared at this one spot to avoid redeclaration errors.
21var $Object = global.Object;
22var $Array = global.Array;
23var $String = global.String;
24var $Number = global.Number;
25var $Function = global.Function;
26var $Boolean = global.Boolean;
27var $NaN = %GetRootNaN();
28
29// ECMA-262 Section 11.9.3.
30function EQUALS(y) {
31  if (IS_STRING(this) && IS_STRING(y)) return %StringEquals(this, y);
32  var x = this;
33
34  while (true) {
35    if (IS_NUMBER(x)) {
36      while (true) {
37        if (IS_NUMBER(y)) return %NumberEquals(x, y);
38        if (IS_NULL_OR_UNDEFINED(y)) return 1;  // not equal
39        if (IS_SYMBOL(y)) return 1;  // not equal
40        if (!IS_SPEC_OBJECT(y)) {
41          // String or boolean.
42          return %NumberEquals(x, %ToNumber(y));
43        }
44        y = %ToPrimitive(y, NO_HINT);
45      }
46    } else if (IS_STRING(x)) {
47      while (true) {
48        if (IS_STRING(y)) return %StringEquals(x, y);
49        if (IS_SYMBOL(y)) return 1;  // not equal
50        if (IS_NUMBER(y)) return %NumberEquals(%ToNumber(x), y);
51        if (IS_BOOLEAN(y)) return %NumberEquals(%ToNumber(x), %ToNumber(y));
52        if (IS_NULL_OR_UNDEFINED(y)) return 1;  // not equal
53        y = %ToPrimitive(y, NO_HINT);
54      }
55    } else if (IS_SYMBOL(x)) {
56      if (IS_SYMBOL(y)) return %_ObjectEquals(x, y) ? 0 : 1;
57      return 1; // not equal
58    } else if (IS_BOOLEAN(x)) {
59      if (IS_BOOLEAN(y)) return %_ObjectEquals(x, y) ? 0 : 1;
60      if (IS_NULL_OR_UNDEFINED(y)) return 1;
61      if (IS_NUMBER(y)) return %NumberEquals(%ToNumber(x), y);
62      if (IS_STRING(y)) return %NumberEquals(%ToNumber(x), %ToNumber(y));
63      if (IS_SYMBOL(y)) return 1;  // not equal
64      // y is object.
65      x = %ToNumber(x);
66      y = %ToPrimitive(y, NO_HINT);
67    } else if (IS_NULL_OR_UNDEFINED(x)) {
68      return IS_NULL_OR_UNDEFINED(y) ? 0 : 1;
69    } else {
70      // x is an object.
71      if (IS_SPEC_OBJECT(y)) {
72        return %_ObjectEquals(x, y) ? 0 : 1;
73      }
74      if (IS_NULL_OR_UNDEFINED(y)) return 1;  // not equal
75      if (IS_SYMBOL(y)) return 1;  // not equal
76      if (IS_BOOLEAN(y)) y = %ToNumber(y);
77      x = %ToPrimitive(x, NO_HINT);
78    }
79  }
80}
81
82// ECMA-262, section 11.9.4, page 56.
83function STRICT_EQUALS(x) {
84  if (IS_STRING(this)) {
85    if (!IS_STRING(x)) return 1;  // not equal
86    return %StringEquals(this, x);
87  }
88
89  if (IS_NUMBER(this)) {
90    if (!IS_NUMBER(x)) return 1;  // not equal
91    return %NumberEquals(this, x);
92  }
93
94  // If anything else gets here, we just do simple identity check.
95  // Objects (including functions), null, undefined and booleans were
96  // checked in the CompareStub, so there should be nothing left.
97  return %_ObjectEquals(this, x) ? 0 : 1;
98}
99
100
101// ECMA-262, section 11.8.5, page 53. The 'ncr' parameter is used as
102// the result when either (or both) the operands are NaN.
103function COMPARE(x, ncr) {
104  var left;
105  var right;
106  // Fast cases for string, numbers and undefined compares.
107  if (IS_STRING(this)) {
108    if (IS_STRING(x)) return %_StringCompare(this, x);
109    if (IS_UNDEFINED(x)) return ncr;
110    left = this;
111  } else if (IS_NUMBER(this)) {
112    if (IS_NUMBER(x)) return %NumberCompare(this, x, ncr);
113    if (IS_UNDEFINED(x)) return ncr;
114    left = this;
115  } else if (IS_UNDEFINED(this)) {
116    if (!IS_UNDEFINED(x)) {
117      %ToPrimitive(x, NUMBER_HINT);
118    }
119    return ncr;
120  } else if (IS_UNDEFINED(x)) {
121    %ToPrimitive(this, NUMBER_HINT);
122    return ncr;
123  } else {
124    left = %ToPrimitive(this, NUMBER_HINT);
125  }
126
127  right = %ToPrimitive(x, NUMBER_HINT);
128  if (IS_STRING(left) && IS_STRING(right)) {
129    return %_StringCompare(left, right);
130  } else {
131    var left_number = %ToNumber(left);
132    var right_number = %ToNumber(right);
133    if (NUMBER_IS_NAN(left_number) || NUMBER_IS_NAN(right_number)) return ncr;
134    return %NumberCompare(left_number, right_number, ncr);
135  }
136}
137
138
139
140/* -----------------------------------
141   - - -   A r i t h m e t i c   - - -
142   -----------------------------------
143*/
144
145// ECMA-262, section 11.6.1, page 50.
146function ADD(x) {
147  // Fast case: Check for number operands and do the addition.
148  if (IS_NUMBER(this) && IS_NUMBER(x)) return %NumberAdd(this, x);
149  if (IS_STRING(this) && IS_STRING(x)) return %_StringAdd(this, x);
150
151  // Default implementation.
152  var a = %ToPrimitive(this, NO_HINT);
153  var b = %ToPrimitive(x, NO_HINT);
154
155  if (IS_STRING(a)) {
156    return %_StringAdd(a, %ToString(b));
157  } else if (IS_STRING(b)) {
158    return %_StringAdd(%NonStringToString(a), b);
159  } else {
160    return %NumberAdd(%ToNumber(a), %ToNumber(b));
161  }
162}
163
164
165// Left operand (this) is already a string.
166function STRING_ADD_LEFT(y) {
167  if (!IS_STRING(y)) {
168    if (IS_STRING_WRAPPER(y) && %_IsStringWrapperSafeForDefaultValueOf(y)) {
169      y = %_ValueOf(y);
170    } else {
171      y = IS_NUMBER(y)
172          ? %_NumberToString(y)
173          : %ToString(%ToPrimitive(y, NO_HINT));
174    }
175  }
176  return %_StringAdd(this, y);
177}
178
179
180// Right operand (y) is already a string.
181function STRING_ADD_RIGHT(y) {
182  var x = this;
183  if (!IS_STRING(x)) {
184    if (IS_STRING_WRAPPER(x) && %_IsStringWrapperSafeForDefaultValueOf(x)) {
185      x = %_ValueOf(x);
186    } else {
187      x = IS_NUMBER(x)
188          ? %_NumberToString(x)
189          : %ToString(%ToPrimitive(x, NO_HINT));
190    }
191  }
192  return %_StringAdd(x, y);
193}
194
195
196// ECMA-262, section 11.6.2, page 50.
197function SUB(y) {
198  var x = IS_NUMBER(this) ? this : %NonNumberToNumber(this);
199  if (!IS_NUMBER(y)) y = %NonNumberToNumber(y);
200  return %NumberSub(x, y);
201}
202
203
204// ECMA-262, section 11.5.1, page 48.
205function MUL(y) {
206  var x = IS_NUMBER(this) ? this : %NonNumberToNumber(this);
207  if (!IS_NUMBER(y)) y = %NonNumberToNumber(y);
208  return %NumberMul(x, y);
209}
210
211
212// ECMA-262, section 11.5.2, page 49.
213function DIV(y) {
214  var x = IS_NUMBER(this) ? this : %NonNumberToNumber(this);
215  if (!IS_NUMBER(y)) y = %NonNumberToNumber(y);
216  return %NumberDiv(x, y);
217}
218
219
220// ECMA-262, section 11.5.3, page 49.
221function MOD(y) {
222  var x = IS_NUMBER(this) ? this : %NonNumberToNumber(this);
223  if (!IS_NUMBER(y)) y = %NonNumberToNumber(y);
224  return %NumberMod(x, y);
225}
226
227
228
229/* -------------------------------------------
230   - - -   B i t   o p e r a t i o n s   - - -
231   -------------------------------------------
232*/
233
234// ECMA-262, section 11.10, page 57.
235function BIT_OR(y) {
236  var x = IS_NUMBER(this) ? this : %NonNumberToNumber(this);
237  if (!IS_NUMBER(y)) y = %NonNumberToNumber(y);
238  return %NumberOr(x, y);
239}
240
241
242// ECMA-262, section 11.10, page 57.
243function BIT_AND(y) {
244  var x;
245  if (IS_NUMBER(this)) {
246    x = this;
247    if (!IS_NUMBER(y)) y = %NonNumberToNumber(y);
248  } else {
249    x = %NonNumberToNumber(this);
250    // Make sure to convert the right operand to a number before
251    // bailing out in the fast case, but after converting the
252    // left operand. This ensures that valueOf methods on the right
253    // operand are always executed.
254    if (!IS_NUMBER(y)) y = %NonNumberToNumber(y);
255    // Optimize for the case where we end up AND'ing a value
256    // that doesn't convert to a number. This is common in
257    // certain benchmarks.
258    if (NUMBER_IS_NAN(x)) return 0;
259  }
260  return %NumberAnd(x, y);
261}
262
263
264// ECMA-262, section 11.10, page 57.
265function BIT_XOR(y) {
266  var x = IS_NUMBER(this) ? this : %NonNumberToNumber(this);
267  if (!IS_NUMBER(y)) y = %NonNumberToNumber(y);
268  return %NumberXor(x, y);
269}
270
271
272// ECMA-262, section 11.7.1, page 51.
273function SHL(y) {
274  var x = IS_NUMBER(this) ? this : %NonNumberToNumber(this);
275  if (!IS_NUMBER(y)) y = %NonNumberToNumber(y);
276  return %NumberShl(x, y);
277}
278
279
280// ECMA-262, section 11.7.2, page 51.
281function SAR(y) {
282  var x;
283  if (IS_NUMBER(this)) {
284    x = this;
285    if (!IS_NUMBER(y)) y = %NonNumberToNumber(y);
286  } else {
287    x = %NonNumberToNumber(this);
288    // Make sure to convert the right operand to a number before
289    // bailing out in the fast case, but after converting the
290    // left operand. This ensures that valueOf methods on the right
291    // operand are always executed.
292    if (!IS_NUMBER(y)) y = %NonNumberToNumber(y);
293    // Optimize for the case where we end up shifting a value
294    // that doesn't convert to a number. This is common in
295    // certain benchmarks.
296    if (NUMBER_IS_NAN(x)) return 0;
297  }
298  return %NumberSar(x, y);
299}
300
301
302// ECMA-262, section 11.7.3, page 52.
303function SHR(y) {
304  var x = IS_NUMBER(this) ? this : %NonNumberToNumber(this);
305  if (!IS_NUMBER(y)) y = %NonNumberToNumber(y);
306  return %NumberShr(x, y);
307}
308
309
310
311/* -----------------------------
312   - - -   H e l p e r s   - - -
313   -----------------------------
314*/
315
316// ECMA-262, section 11.4.1, page 46.
317function DELETE(key, strict) {
318  return %DeleteProperty(%ToObject(this), %ToName(key), strict);
319}
320
321
322// ECMA-262, section 11.8.7, page 54.
323function IN(x) {
324  if (!IS_SPEC_OBJECT(x)) {
325    throw %MakeTypeError('invalid_in_operator_use', [this, x]);
326  }
327  return %_IsNonNegativeSmi(this) ?
328    %HasElement(x, this) : %HasProperty(x, %ToName(this));
329}
330
331
332// ECMA-262, section 11.8.6, page 54. To make the implementation more
333// efficient, the return value should be zero if the 'this' is an
334// instance of F, and non-zero if not. This makes it possible to avoid
335// an expensive ToBoolean conversion in the generated code.
336function INSTANCE_OF(F) {
337  var V = this;
338  if (!IS_SPEC_FUNCTION(F)) {
339    throw %MakeTypeError('instanceof_function_expected', [F]);
340  }
341
342  // If V is not an object, return false.
343  if (!IS_SPEC_OBJECT(V)) {
344    return 1;
345  }
346
347  // Check if function is bound, if so, get [[BoundFunction]] from it
348  // and use that instead of F.
349  var bindings = %BoundFunctionGetBindings(F);
350  if (bindings) {
351    F = bindings[kBoundFunctionIndex];  // Always a non-bound function.
352  }
353  // Get the prototype of F; if it is not an object, throw an error.
354  var O = F.prototype;
355  if (!IS_SPEC_OBJECT(O)) {
356    throw %MakeTypeError('instanceof_nonobject_proto', [O]);
357  }
358
359  // Return whether or not O is in the prototype chain of V.
360  return %IsInPrototypeChain(O, V) ? 0 : 1;
361}
362
363
364// Filter a given key against an object by checking if the object
365// has a property with the given key; return the key as a string if
366// it has. Otherwise returns 0 (smi). Used in for-in statements.
367function FILTER_KEY(key) {
368  var string = %ToName(key);
369  if (%HasProperty(this, string)) return string;
370  return 0;
371}
372
373
374function CALL_NON_FUNCTION() {
375  var delegate = %GetFunctionDelegate(this);
376  if (!IS_FUNCTION(delegate)) {
377    throw %MakeTypeError('called_non_callable', [typeof this]);
378  }
379  return %Apply(delegate, this, arguments, 0, %_ArgumentsLength());
380}
381
382
383function CALL_NON_FUNCTION_AS_CONSTRUCTOR() {
384  var delegate = %GetConstructorDelegate(this);
385  if (!IS_FUNCTION(delegate)) {
386    throw %MakeTypeError('called_non_callable', [typeof this]);
387  }
388  return %Apply(delegate, this, arguments, 0, %_ArgumentsLength());
389}
390
391
392function CALL_FUNCTION_PROXY() {
393  var arity = %_ArgumentsLength() - 1;
394  var proxy = %_Arguments(arity);  // The proxy comes in as an additional arg.
395  var trap = %GetCallTrap(proxy);
396  return %Apply(trap, this, arguments, 0, arity);
397}
398
399
400function CALL_FUNCTION_PROXY_AS_CONSTRUCTOR() {
401  var proxy = this;
402  var trap = %GetConstructTrap(proxy);
403  return %Apply(trap, this, arguments, 0, %_ArgumentsLength());
404}
405
406
407function APPLY_PREPARE(args) {
408  var length;
409  // First check whether length is a positive Smi and args is an
410  // array. This is the fast case. If this fails, we do the slow case
411  // that takes care of more eventualities.
412  if (IS_ARRAY(args)) {
413    length = args.length;
414    if (%_IsSmi(length) && length >= 0 && length < 0x800000 &&
415        IS_SPEC_FUNCTION(this)) {
416      return length;
417    }
418  }
419
420  length = (args == null) ? 0 : %ToUint32(args.length);
421
422  // We can handle any number of apply arguments if the stack is
423  // big enough, but sanity check the value to avoid overflow when
424  // multiplying with pointer size.
425  if (length > 0x800000) {
426    throw %MakeRangeError('stack_overflow', []);
427  }
428
429  if (!IS_SPEC_FUNCTION(this)) {
430    throw %MakeTypeError('apply_non_function',
431                         [ %ToString(this), typeof this ]);
432  }
433
434  // Make sure the arguments list has the right type.
435  if (args != null && !IS_SPEC_OBJECT(args)) {
436    throw %MakeTypeError('apply_wrong_args', []);
437  }
438
439  // Return the length which is the number of arguments to copy to the
440  // stack. It is guaranteed to be a small integer at this point.
441  return length;
442}
443
444
445function STACK_OVERFLOW(length) {
446  throw %MakeRangeError('stack_overflow', []);
447}
448
449
450// Convert the receiver to an object - forward to ToObject.
451function TO_OBJECT() {
452  return %ToObject(this);
453}
454
455
456// Convert the receiver to a number - forward to ToNumber.
457function TO_NUMBER() {
458  return %ToNumber(this);
459}
460
461
462// Convert the receiver to a string - forward to ToString.
463function TO_STRING() {
464  return %ToString(this);
465}
466
467
468/* -------------------------------------
469   - - -   C o n v e r s i o n s   - - -
470   -------------------------------------
471*/
472
473// ECMA-262, section 9.1, page 30. Use null/undefined for no hint,
474// (1) for number hint, and (2) for string hint.
475function ToPrimitive(x, hint) {
476  // Fast case check.
477  if (IS_STRING(x)) return x;
478  // Normal behavior.
479  if (!IS_SPEC_OBJECT(x)) return x;
480  if (IS_SYMBOL_WRAPPER(x)) throw MakeTypeError('symbol_to_primitive', []);
481  if (hint == NO_HINT) hint = (IS_DATE(x)) ? STRING_HINT : NUMBER_HINT;
482  return (hint == NUMBER_HINT) ? %DefaultNumber(x) : %DefaultString(x);
483}
484
485
486// ECMA-262, section 9.2, page 30
487function ToBoolean(x) {
488  if (IS_BOOLEAN(x)) return x;
489  if (IS_STRING(x)) return x.length != 0;
490  if (x == null) return false;
491  if (IS_NUMBER(x)) return !((x == 0) || NUMBER_IS_NAN(x));
492  return true;
493}
494
495
496// ECMA-262, section 9.3, page 31.
497function ToNumber(x) {
498  if (IS_NUMBER(x)) return x;
499  if (IS_STRING(x)) {
500    return %_HasCachedArrayIndex(x) ? %_GetCachedArrayIndex(x)
501                                    : %StringToNumber(x);
502  }
503  if (IS_BOOLEAN(x)) return x ? 1 : 0;
504  if (IS_UNDEFINED(x)) return NAN;
505  if (IS_SYMBOL(x)) throw MakeTypeError('symbol_to_number', []);
506  return (IS_NULL(x)) ? 0 : ToNumber(%DefaultNumber(x));
507}
508
509function NonNumberToNumber(x) {
510  if (IS_STRING(x)) {
511    return %_HasCachedArrayIndex(x) ? %_GetCachedArrayIndex(x)
512                                    : %StringToNumber(x);
513  }
514  if (IS_BOOLEAN(x)) return x ? 1 : 0;
515  if (IS_UNDEFINED(x)) return NAN;
516  if (IS_SYMBOL(x)) throw MakeTypeError('symbol_to_number', []);
517  return (IS_NULL(x)) ? 0 : ToNumber(%DefaultNumber(x));
518}
519
520
521// ECMA-262, section 9.8, page 35.
522function ToString(x) {
523  if (IS_STRING(x)) return x;
524  if (IS_NUMBER(x)) return %_NumberToString(x);
525  if (IS_BOOLEAN(x)) return x ? 'true' : 'false';
526  if (IS_UNDEFINED(x)) return 'undefined';
527  if (IS_SYMBOL(x)) throw %MakeTypeError('symbol_to_string', []);
528  return (IS_NULL(x)) ? 'null' : %ToString(%DefaultString(x));
529}
530
531function NonStringToString(x) {
532  if (IS_NUMBER(x)) return %_NumberToString(x);
533  if (IS_BOOLEAN(x)) return x ? 'true' : 'false';
534  if (IS_UNDEFINED(x)) return 'undefined';
535  if (IS_SYMBOL(x)) throw %MakeTypeError('symbol_to_string', []);
536  return (IS_NULL(x)) ? 'null' : %ToString(%DefaultString(x));
537}
538
539
540// ES6 symbols
541function ToName(x) {
542  return IS_SYMBOL(x) ? x : %ToString(x);
543}
544
545
546// ECMA-262, section 9.9, page 36.
547function ToObject(x) {
548  if (IS_STRING(x)) return new $String(x);
549  if (IS_NUMBER(x)) return new $Number(x);
550  if (IS_BOOLEAN(x)) return new $Boolean(x);
551  if (IS_SYMBOL(x)) return %NewSymbolWrapper(x);
552  if (IS_NULL_OR_UNDEFINED(x) && !IS_UNDETECTABLE(x)) {
553    throw %MakeTypeError('undefined_or_null_to_object', []);
554  }
555  return x;
556}
557
558
559// ECMA-262, section 9.4, page 34.
560function ToInteger(x) {
561  if (%_IsSmi(x)) return x;
562  return %NumberToInteger(ToNumber(x));
563}
564
565
566// ES6, draft 08-24-14, section 7.1.15
567function ToLength(arg) {
568  arg = ToInteger(arg);
569  if (arg < 0) return 0;
570  return arg < $Number.MAX_SAFE_INTEGER ? arg : $Number.MAX_SAFE_INTEGER;
571}
572
573
574// ECMA-262, section 9.6, page 34.
575function ToUint32(x) {
576  if (%_IsSmi(x) && x >= 0) return x;
577  return %NumberToJSUint32(ToNumber(x));
578}
579
580
581// ECMA-262, section 9.5, page 34
582function ToInt32(x) {
583  if (%_IsSmi(x)) return x;
584  return %NumberToJSInt32(ToNumber(x));
585}
586
587
588// ES5, section 9.12
589function SameValue(x, y) {
590  if (typeof x != typeof y) return false;
591  if (IS_NUMBER(x)) {
592    if (NUMBER_IS_NAN(x) && NUMBER_IS_NAN(y)) return true;
593    // x is +0 and y is -0 or vice versa.
594    if (x === 0 && y === 0 && %_IsMinusZero(x) != %_IsMinusZero(y)) {
595      return false;
596    }
597  }
598  return x === y;
599}
600
601
602/* ---------------------------------
603   - - -   U t i l i t i e s   - - -
604   ---------------------------------
605*/
606
607// Returns if the given x is a primitive value - not an object or a
608// function.
609function IsPrimitive(x) {
610  // Even though the type of null is "object", null is still
611  // considered a primitive value. IS_SPEC_OBJECT handles this correctly
612  // (i.e., it will return false if x is null).
613  return !IS_SPEC_OBJECT(x);
614}
615
616
617// ECMA-262, section 8.6.2.6, page 28.
618function DefaultNumber(x) {
619  if (!IS_SYMBOL_WRAPPER(x)) {
620    var valueOf = x.valueOf;
621    if (IS_SPEC_FUNCTION(valueOf)) {
622      var v = %_CallFunction(x, valueOf);
623      if (%IsPrimitive(v)) return v;
624    }
625
626    var toString = x.toString;
627    if (IS_SPEC_FUNCTION(toString)) {
628      var s = %_CallFunction(x, toString);
629      if (%IsPrimitive(s)) return s;
630    }
631  }
632  throw %MakeTypeError('cannot_convert_to_primitive', []);
633}
634
635// ECMA-262, section 8.6.2.6, page 28.
636function DefaultString(x) {
637  if (!IS_SYMBOL_WRAPPER(x)) {
638    var toString = x.toString;
639    if (IS_SPEC_FUNCTION(toString)) {
640      var s = %_CallFunction(x, toString);
641      if (%IsPrimitive(s)) return s;
642    }
643
644    var valueOf = x.valueOf;
645    if (IS_SPEC_FUNCTION(valueOf)) {
646      var v = %_CallFunction(x, valueOf);
647      if (%IsPrimitive(v)) return v;
648    }
649  }
650  throw %MakeTypeError('cannot_convert_to_primitive', []);
651}
652
653function ToPositiveInteger(x, rangeErrorName) {
654  var i = TO_INTEGER(x);
655  if (i < 0) throw MakeRangeError(rangeErrorName);
656  return i;
657}
658
659
660// NOTE: Setting the prototype for Array must take place as early as
661// possible due to code generation for array literals.  When
662// generating code for a array literal a boilerplate array is created
663// that is cloned when running the code.  It is essential that the
664// boilerplate gets the right prototype.
665%FunctionSetPrototype($Array, new $Array(0));
666