builtins-iterator-gen.cc 17.1 KB
Newer Older
1 2 3 4 5
// Copyright 2017 the V8 project authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include "src/builtins/builtins-iterator-gen.h"
6
#include "src/builtins/growable-fixed-array-gen.h"
7

8
#include "src/builtins/builtins-collections-gen.h"
9
#include "src/builtins/builtins-string-gen.h"
10 11
#include "src/builtins/builtins-utils-gen.h"
#include "src/builtins/builtins.h"
12
#include "src/codegen/code-stub-assembler.h"
13
#include "src/heap/factory-inl.h"
14

15 16 17
namespace v8 {
namespace internal {

18
using IteratorRecord = TorqueStructIteratorRecord;
19 20
using compiler::Node;

21 22
TNode<Object> IteratorBuiltinsAssembler::GetIteratorMethod(Node* context,
                                                           Node* object) {
23 24 25
  return GetProperty(context, object, factory()->iterator_symbol());
}

26 27 28 29
IteratorRecord IteratorBuiltinsAssembler::GetIterator(Node* context,
                                                      Node* object,
                                                      Label* if_exception,
                                                      Variable* exception) {
30
  TNode<Object> method = GetIteratorMethod(context, object);
31 32 33 34 35 36 37 38
  return GetIterator(context, object, method, if_exception, exception);
}

IteratorRecord IteratorBuiltinsAssembler::GetIterator(Node* context,
                                                      Node* object,
                                                      Node* method,
                                                      Label* if_exception,
                                                      Variable* exception) {
39
  GotoIfException(method, if_exception, exception);
40

41 42 43
  Label if_not_callable(this, Label::kDeferred), if_callable(this);
  GotoIf(TaggedIsSmi(method), &if_not_callable);
  Branch(IsCallable(method), &if_callable, &if_not_callable);
44

45
  BIND(&if_not_callable);
46
  {
47 48
    TNode<Object> ret =
        CallRuntime(Runtime::kThrowIteratorError, context, object);
49 50 51
    GotoIfException(ret, if_exception, exception);
    Unreachable();
  }
52

53 54 55 56 57 58 59 60 61
  BIND(&if_callable);
  {
    Callable callable = CodeFactory::Call(isolate());
    Node* iterator = CallJS(callable, context, method, object);
    GotoIfException(iterator, if_exception, exception);

    Label get_next(this), if_notobject(this, Label::kDeferred);
    GotoIf(TaggedIsSmi(iterator), &if_notobject);
    Branch(IsJSReceiver(iterator), &get_next, &if_notobject);
62

63 64
    BIND(&if_notobject);
    {
65 66
      TNode<Object> ret =
          CallRuntime(Runtime::kThrowSymbolIteratorInvalid, context);
67 68 69 70 71
      GotoIfException(ret, if_exception, exception);
      Unreachable();
    }

    BIND(&get_next);
72
    const TNode<Object> next =
73
        GetProperty(context, iterator, factory()->next_string());
74 75 76 77 78
    GotoIfException(next, if_exception, exception);

    return IteratorRecord{TNode<JSReceiver>::UncheckedCast(iterator),
                          TNode<Object>::UncheckedCast(next)};
  }
79 80
}

81
TNode<JSReceiver> IteratorBuiltinsAssembler::IteratorStep(
82 83 84
    TNode<Context> context, const IteratorRecord& iterator, Label* if_done,
    base::Optional<TNode<Map>> fast_iterator_result_map, Label* if_exception,
    Variable* exception) {
85 86 87
  DCHECK_NOT_NULL(if_done);
  // 1. a. Let result be ? Invoke(iterator, "next", « »).
  Callable callable = CodeFactory::Call(isolate());
88
  Node* result = CallJS(callable, context, iterator.next, iterator.object);
89
  GotoIfException(result, if_exception, exception);
90 91 92 93

  // 3. If Type(result) is not Object, throw a TypeError exception.
  Label if_notobject(this, Label::kDeferred), return_result(this);
  GotoIf(TaggedIsSmi(result), &if_notobject);
94
  TNode<Map> result_map = LoadMap(result);
95

96
  if (fast_iterator_result_map) {
97 98 99
    // Fast iterator result case:
    Label if_generic(this);

100
    // 4. Return result.
101
    GotoIfNot(TaggedEqual(result_map, *fast_iterator_result_map), &if_generic);
102 103 104

    // IteratorComplete
    // 2. Return ToBoolean(? Get(iterResult, "done")).
105
    TNode<Object> done = LoadObjectField(result, JSIteratorResult::kDoneOffset);
106
    BranchIfToBooleanIsTrue(done, if_done, &return_result);
107 108

    BIND(&if_generic);
109 110
  }

111
  // Generic iterator result case:
112
  {
113 114 115
    // 3. If Type(result) is not Object, throw a TypeError exception.
    GotoIfNot(IsJSReceiverMap(result_map), &if_notobject);

116 117
    // IteratorComplete
    // 2. Return ToBoolean(? Get(iterResult, "done")).
118
    TNode<Object> done = GetProperty(context, result, factory()->done_string());
119
    GotoIfException(done, if_exception, exception);
120
    BranchIfToBooleanIsTrue(done, if_done, &return_result);
121 122 123 124
  }

  BIND(&if_notobject);
  {
125
    TNode<Object> ret =
126 127 128
        CallRuntime(Runtime::kThrowIteratorResultNotAnObject, context, result);
    GotoIfException(ret, if_exception, exception);
    Unreachable();
129 130 131
  }

  BIND(&return_result);
132
  return CAST(result);
133 134
}

135 136 137 138
TNode<Object> IteratorBuiltinsAssembler::IteratorValue(
    TNode<Context> context, TNode<JSReceiver> result,
    base::Optional<TNode<Map>> fast_iterator_result_map, Label* if_exception,
    Variable* exception) {
139
  Label exit(this);
140 141
  TVARIABLE(Object, var_value);
  if (fast_iterator_result_map) {
142 143
    // Fast iterator result case:
    Label if_generic(this);
144 145
    TNode<Map> map = LoadMap(result);
    GotoIfNot(TaggedEqual(map, *fast_iterator_result_map), &if_generic);
146
    var_value = LoadObjectField(result, JSIteratorResult::kValueOffset);
147
    Goto(&exit);
148 149

    BIND(&if_generic);
150 151
  }

152
  // Generic iterator result case:
153
  {
154 155
    TNode<Object> value =
        GetProperty(context, result, factory()->value_string());
156
    GotoIfException(value, if_exception, exception);
157
    var_value = value;
158 159 160 161 162 163 164
    Goto(&exit);
  }

  BIND(&exit);
  return var_value.value();
}

165 166 167
void IteratorBuiltinsAssembler::IteratorCloseOnException(
    Node* context, const IteratorRecord& iterator, Label* if_exception,
    Variable* exception) {
168 169 170
  // Perform ES #sec-iteratorclose when an exception occurs. This simpler
  // algorithm does not include redundant steps which are never reachable from
  // the spec IteratorClose algorithm.
171
  DCHECK((if_exception != nullptr && exception != nullptr));
172
  CSA_ASSERT(this, IsNotTheHole(exception->value()));
173
  CSA_ASSERT(this, IsJSReceiver(iterator.object));
174

175
  // Let return be ? GetMethod(iterator, "return").
176
  TNode<Object> method =
177
      GetProperty(context, iterator.object, factory()->return_string());
178
  GotoIfException(method, if_exception, exception);
179

180 181
  // If return is undefined, return Completion(completion).
  GotoIf(Word32Or(IsUndefined(method), IsNull(method)), if_exception);
182 183

  {
184 185 186
    // Let innerResult be Call(return, iterator, « »).
    // If an exception occurs, the original exception remains bound
    Node* inner_result =
187
        CallJS(CodeFactory::Call(isolate()), context, method, iterator.object);
188 189 190 191
    GotoIfException(inner_result, if_exception, nullptr);

    // (If completion.[[Type]] is throw) return Completion(completion).
    Goto(if_exception);
192
  }
193
}
194

195
void IteratorBuiltinsAssembler::IteratorCloseOnException(
196
    Node* context, const IteratorRecord& iterator, TNode<Object> exception) {
197
  Label rethrow(this, Label::kDeferred);
198 199
  TVARIABLE(Object, exception_variable, exception);
  IteratorCloseOnException(context, iterator, &rethrow, &exception_variable);
200

201
  BIND(&rethrow);
202
  CallRuntime(Runtime::kReThrow, context, exception_variable.value());
203
  Unreachable();
204 205
}

206 207
TNode<JSArray> IteratorBuiltinsAssembler::IterableToList(
    TNode<Context> context, TNode<Object> iterable, TNode<Object> iterator_fn) {
208 209 210 211 212 213 214 215 216 217 218 219 220 221 222
  // 1. Let iteratorRecord be ? GetIterator(items, method).
  IteratorRecord iterator_record = GetIterator(context, iterable, iterator_fn);

  // 2. Let values be a new empty List.
  GrowableFixedArray values(state());

  Variable* vars[] = {values.var_array(), values.var_length(),
                      values.var_capacity()};
  Label loop_start(this, 3, vars), done(this);
  Goto(&loop_start);
  // 3. Let next be true.
  // 4. Repeat, while next is not false
  BIND(&loop_start);
  {
    //  a. Set next to ? IteratorStep(iteratorRecord).
223
    TNode<JSReceiver> next = IteratorStep(context, iterator_record, &done);
224 225
    //  b. If next is not false, then
    //   i. Let nextValue be ? IteratorValue(next).
226
    TNode<Object> next_value = IteratorValue(context, next);
227 228 229 230
    //   ii. Append nextValue to the end of the List values.
    values.Push(next_value);
    Goto(&loop_start);
  }
231

232 233 234
  BIND(&done);
  return values.ToJSArray(context);
}
235

236 237 238 239 240 241 242 243
TF_BUILTIN(IterableToList, IteratorBuiltinsAssembler) {
  TNode<Context> context = CAST(Parameter(Descriptor::kContext));
  TNode<Object> iterable = CAST(Parameter(Descriptor::kIterable));
  TNode<Object> iterator_fn = CAST(Parameter(Descriptor::kIteratorFn));

  Return(IterableToList(context, iterable, iterator_fn));
}

244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278
TF_BUILTIN(IterableToFixedArrayForWasm, IteratorBuiltinsAssembler) {
  TNode<Context> context = CAST(Parameter(Descriptor::kContext));
  TNode<Object> iterable = CAST(Parameter(Descriptor::kIterable));
  TNode<Smi> expected_length = CAST(Parameter(Descriptor::kExpectedLength));

  TNode<Object> iterator_fn = GetIteratorMethod(context, iterable);

  IteratorRecord iterator_record = GetIterator(context, iterable, iterator_fn);

  GrowableFixedArray values(state());

  Variable* vars[] = {values.var_array(), values.var_length(),
                      values.var_capacity()};
  Label loop_start(this, 3, vars), compare_length(this), done(this);
  Goto(&loop_start);
  BIND(&loop_start);
  {
    TNode<JSReceiver> next =
        IteratorStep(context, iterator_record, &compare_length);
    TNode<Object> next_value = IteratorValue(context, next);
    values.Push(next_value);
    Goto(&loop_start);
  }

  BIND(&compare_length);
  GotoIf(WordEqual(SmiUntag(expected_length), values.var_length()->value()),
         &done);
  Return(CallRuntime(
      Runtime::kThrowTypeError, context,
      SmiConstant(MessageTemplate::kWasmTrapMultiReturnLengthMismatch)));

  BIND(&done);
  Return(values.var_array()->value());
}

279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341
TNode<JSArray> IteratorBuiltinsAssembler::StringListFromIterable(
    TNode<Context> context, TNode<Object> iterable) {
  Label done(this);
  GrowableFixedArray list(state());
  // 1. If iterable is undefined, then
  //   a. Return a new empty List.
  GotoIf(IsUndefined(iterable), &done);

  // 2. Let iteratorRecord be ? GetIterator(items).
  IteratorRecord iterator_record = GetIterator(context, iterable);

  // 3. Let list be a new empty List.

  Variable* vars[] = {list.var_array(), list.var_length(), list.var_capacity()};
  Label loop_start(this, 3, vars);
  Goto(&loop_start);
  // 4. Let next be true.
  // 5. Repeat, while next is not false
  Label if_isnotstringtype(this, Label::kDeferred),
      if_exception(this, Label::kDeferred);
  BIND(&loop_start);
  {
    //  a. Set next to ? IteratorStep(iteratorRecord).
    TNode<JSReceiver> next = IteratorStep(context, iterator_record, &done);
    //  b. If next is not false, then
    //   i. Let nextValue be ? IteratorValue(next).
    TNode<Object> next_value = IteratorValue(context, next);
    //   ii. If Type(nextValue) is not String, then
    GotoIf(TaggedIsSmi(next_value), &if_isnotstringtype);
    TNode<Uint16T> next_value_type = LoadInstanceType(CAST(next_value));
    GotoIfNot(IsStringInstanceType(next_value_type), &if_isnotstringtype);
    //   iii. Append nextValue to the end of the List list.
    list.Push(next_value);
    Goto(&loop_start);
    // 5.b.ii
    BIND(&if_isnotstringtype);
    {
      // 1. Let error be ThrowCompletion(a newly created TypeError object).
      TVARIABLE(Object, var_exception);
      TNode<Object> ret = CallRuntime(
          Runtime::kThrowTypeError, context,
          SmiConstant(MessageTemplate::kIterableYieldedNonString), next_value);
      GotoIfException(ret, &if_exception, &var_exception);
      Unreachable();

      // 2. Return ? IteratorClose(iteratorRecord, error).
      BIND(&if_exception);
      IteratorCloseOnException(context, iterator_record, var_exception.value());
    }
  }

  BIND(&done);
  // 6. Return list.
  return list.ToJSArray(context);
}

TF_BUILTIN(StringListFromIterable, IteratorBuiltinsAssembler) {
  TNode<Context> context = CAST(Parameter(Descriptor::kContext));
  TNode<Object> iterable = CAST(Parameter(Descriptor::kIterable));

  Return(StringListFromIterable(context, iterable));
}

342 343 344 345 346 347 348 349
// This builtin always returns a new JSArray and is thus safe to use even in the
// presence of code that may call back into user-JS. This builtin will take the
// fast path if the iterable is a fast array and the Array prototype and the
// Symbol.iterator is untouched. The fast path skips the iterator and copies the
// backing store to the new array. Note that if the array has holes, the holes
// will be copied to the new array, which is inconsistent with the behavior of
// an actual iteration, where holes should be replaced with undefined (if the
// prototype has no elements). To maintain the correct behavior for holey
350
// arrays, use the builtins IterableToList or IterableToListWithSymbolLookup.
351 352 353 354
TF_BUILTIN(IterableToListMayPreserveHoles, IteratorBuiltinsAssembler) {
  TNode<Context> context = CAST(Parameter(Descriptor::kContext));
  TNode<Object> iterable = CAST(Parameter(Descriptor::kIterable));
  TNode<Object> iterator_fn = CAST(Parameter(Descriptor::kIteratorFn));
355

356 357
  Label slow_path(this);

358
  GotoIfNot(IsFastJSArrayWithNoCustomIteration(context, iterable), &slow_path);
359 360

  // The fast path will copy holes to the new array.
361
  TailCallBuiltin(Builtins::kCloneFastJSArray, context, iterable);
362 363

  BIND(&slow_path);
364
  TailCallBuiltin(Builtins::kIterableToList, context, iterable, iterator_fn);
365
}
366

367 368 369 370
void IteratorBuiltinsAssembler::FastIterableToList(
    TNode<Context> context, TNode<Object> iterable,
    TVariable<Object>* var_result, Label* slow) {
  Label done(this), check_string(this), check_map(this), check_set(this);
371

372 373 374 375
  GotoIfNot(
      Word32Or(IsFastJSArrayWithNoCustomIteration(context, iterable),
               IsFastJSArrayForReadWithNoCustomIteration(context, iterable)),
      &check_string);
376 377

  // Fast path for fast JSArray.
378 379 380
  *var_result =
      CallBuiltin(Builtins::kCloneFastJSArrayFillingHoles, context, iterable);
  Goto(&done);
381

382 383
  BIND(&check_string);
  {
384
    Label string_maybe_fast_call(this);
385
    StringBuiltinsAssembler string_assembler(state());
386
    string_assembler.BranchIfStringPrimitiveWithNoCustomIteration(
387 388 389
        iterable, context, &string_maybe_fast_call, &check_map);

    BIND(&string_maybe_fast_call);
390
    const TNode<IntPtrT> length = LoadStringLengthAsWord(CAST(iterable));
391 392 393 394
    // Use string length as conservative approximation of number of codepoints.
    GotoIf(
        IntPtrGreaterThan(length, IntPtrConstant(JSArray::kMaxFastArrayLength)),
        slow);
395 396
    *var_result = CallBuiltin(Builtins::kStringToList, context, iterable);
    Goto(&done);
397 398
  }

399 400 401 402 403 404 405
  BIND(&check_map);
  {
    Label map_fast_call(this);
    BranchIfIterableWithOriginalKeyOrValueMapIterator(
        state(), iterable, context, &map_fast_call, &check_set);

    BIND(&map_fast_call);
406 407
    *var_result = CallBuiltin(Builtins::kMapIteratorToList, context, iterable);
    Goto(&done);
408 409 410 411 412 413
  }

  BIND(&check_set);
  {
    Label set_fast_call(this);
    BranchIfIterableWithOriginalValueSetIterator(state(), iterable, context,
414
                                                 &set_fast_call, slow);
415 416

    BIND(&set_fast_call);
417 418 419
    *var_result =
        CallBuiltin(Builtins::kSetOrSetIteratorToList, context, iterable);
    Goto(&done);
420 421
  }

422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447
  BIND(&done);
}

// This builtin loads the property Symbol.iterator as the iterator, and has fast
// paths for fast arrays, for primitive strings, for sets and set iterators, and
// for map iterators. These fast paths will only be taken if Symbol.iterator and
// the Iterator prototype are not modified in a way that changes the original
// iteration behavior.
// * In case of fast holey arrays, holes will be converted to undefined to
//   reflect iteration semantics. Note that replacement by undefined is only
//   correct when the NoElements protector is valid.
// * In case of map/set iterators, there is an additional requirement that the
//   iterator is not partially consumed. To be spec-compliant, after spreading
//   the iterator is set to be exhausted.
TF_BUILTIN(IterableToListWithSymbolLookup, IteratorBuiltinsAssembler) {
  TNode<Context> context = CAST(Parameter(Descriptor::kContext));
  TNode<Object> iterable = CAST(Parameter(Descriptor::kIterable));

  Label slow_path(this);

  GotoIfForceSlowPath(&slow_path);

  TVARIABLE(Object, var_result);
  FastIterableToList(context, iterable, &var_result, &slow_path);
  Return(var_result.value());

448 449 450
  BIND(&slow_path);
  {
    TNode<Object> iterator_fn = GetIteratorMethod(context, iterable);
451
    TailCallBuiltin(Builtins::kIterableToList, context, iterable, iterator_fn);
452
  }
453 454
}

455 456 457 458 459 460 461 462 463 464 465 466 467 468
TF_BUILTIN(GetIteratorWithFeedbackLazyDeoptContinuation,
           IteratorBuiltinsAssembler) {
  TNode<Context> context = CAST(Parameter(Descriptor::kContext));
  TNode<Object> receiver = CAST(Parameter(Descriptor::kReceiver));
  TNode<Smi> callSlot = CAST(Parameter(Descriptor::kCallSlot));
  TNode<FeedbackVector> feedback = CAST(Parameter(Descriptor::kFeedback));
  TNode<Object> iteratorMethod = CAST(Parameter(Descriptor::kResult));

  TNode<Object> result =
      CallBuiltin(Builtins::kCallIteratorWithFeedback, context, receiver,
                  iteratorMethod, callSlot, feedback);
  Return(result);
}

469 470
}  // namespace internal
}  // namespace v8