bytecode-analysis-unittest.cc 15.3 KB
Newer Older
1 2 3 4
// Copyright 2015 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.

5
#include "src/init/v8.h"
6 7 8 9 10 11 12

#include "src/compiler/bytecode-analysis.h"
#include "src/interpreter/bytecode-array-builder.h"
#include "src/interpreter/bytecode-array-iterator.h"
#include "src/interpreter/bytecode-decoder.h"
#include "src/interpreter/bytecode-label.h"
#include "src/interpreter/control-flow-builders.h"
13
#include "src/objects/objects-inl.h"
14
#include "test/unittests/interpreter/bytecode-utils.h"
15 16 17 18 19 20
#include "test/unittests/test-utils.h"

namespace v8 {
namespace internal {
namespace compiler {

21 22
using ToBooleanMode = interpreter::BytecodeArrayBuilder::ToBooleanMode;

23 24
class BytecodeAnalysisTest : public TestWithIsolateAndZone {
 public:
25 26
  BytecodeAnalysisTest() = default;
  ~BytecodeAnalysisTest() override = default;
27 28

  static void SetUpTestCase() {
29 30 31
    CHECK_NULL(save_flags_);
    save_flags_ = new SaveFlags();
    i::FLAG_ignition_elide_noneffectful_bytecodes = false;
32 33 34 35 36 37 38
    i::FLAG_ignition_reo = false;

    TestWithIsolateAndZone::SetUpTestCase();
  }

  static void TearDownTestCase() {
    TestWithIsolateAndZone::TearDownTestCase();
39 40
    delete save_flags_;
    save_flags_ = nullptr;
41 42
  }

43 44 45
  std::string ToLivenessString(const BytecodeLivenessState* liveness) const {
    const BitVector& bit_vector = liveness->bit_vector();

46
    std::string out;
47 48 49
    out.resize(bit_vector.length());
    for (int i = 0; i < bit_vector.length(); ++i) {
      if (bit_vector.Contains(i)) {
50 51 52 53 54 55 56 57 58 59 60 61
        out[i] = 'L';
      } else {
        out[i] = '.';
      }
    }
    return out;
  }

  void EnsureLivenessMatches(
      Handle<BytecodeArray> bytecode,
      const std::vector<std::pair<std::string, std::string>>&
          expected_liveness) {
62
    BytecodeAnalysis analysis(bytecode, zone(), BailoutId::None(), true);
63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84

    interpreter::BytecodeArrayIterator iterator(bytecode);
    for (auto liveness : expected_liveness) {
      std::stringstream ss;
      ss << std::setw(4) << iterator.current_offset() << " : ";
      iterator.PrintTo(ss);

      EXPECT_EQ(liveness.first, ToLivenessString(analysis.GetInLivenessFor(
                                    iterator.current_offset())))
          << " at bytecode " << ss.str();

      EXPECT_EQ(liveness.second, ToLivenessString(analysis.GetOutLivenessFor(
                                     iterator.current_offset())))
          << " at bytecode " << ss.str();

      iterator.Advance();
    }

    EXPECT_TRUE(iterator.done());
  }

 private:
85
  static SaveFlags* save_flags_;
86 87 88 89

  DISALLOW_COPY_AND_ASSIGN(BytecodeAnalysisTest);
};

90
SaveFlags* BytecodeAnalysisTest::save_flags_ = nullptr;
91 92

TEST_F(BytecodeAnalysisTest, EmptyBlock) {
93
  interpreter::BytecodeArrayBuilder builder(zone(), 3, 3);
94 95 96 97 98 99 100 101 102 103 104 105 106
  std::vector<std::pair<std::string, std::string>> expected_liveness;

  interpreter::Register reg_0(0);

  builder.Return();
  expected_liveness.emplace_back("...L", "....");

  Handle<BytecodeArray> bytecode = builder.ToBytecodeArray(isolate());

  EnsureLivenessMatches(bytecode, expected_liveness);
}

TEST_F(BytecodeAnalysisTest, SimpleLoad) {
107
  interpreter::BytecodeArrayBuilder builder(zone(), 3, 3);
108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123
  std::vector<std::pair<std::string, std::string>> expected_liveness;

  interpreter::Register reg_0(0);

  builder.LoadAccumulatorWithRegister(reg_0);
  expected_liveness.emplace_back("L...", "...L");

  builder.Return();
  expected_liveness.emplace_back("...L", "....");

  Handle<BytecodeArray> bytecode = builder.ToBytecodeArray(isolate());

  EnsureLivenessMatches(bytecode, expected_liveness);
}

TEST_F(BytecodeAnalysisTest, StoreThenLoad) {
124
  interpreter::BytecodeArrayBuilder builder(zone(), 3, 3);
125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143
  std::vector<std::pair<std::string, std::string>> expected_liveness;

  interpreter::Register reg_0(0);

  builder.StoreAccumulatorInRegister(reg_0);
  expected_liveness.emplace_back("...L", "L...");

  builder.LoadAccumulatorWithRegister(reg_0);
  expected_liveness.emplace_back("L...", "...L");

  builder.Return();
  expected_liveness.emplace_back("...L", "....");

  Handle<BytecodeArray> bytecode = builder.ToBytecodeArray(isolate());

  EnsureLivenessMatches(bytecode, expected_liveness);
}

TEST_F(BytecodeAnalysisTest, DiamondLoad) {
144
  interpreter::BytecodeArrayBuilder builder(zone(), 3, 3);
145 146 147 148 149 150 151 152 153
  std::vector<std::pair<std::string, std::string>> expected_liveness;

  interpreter::Register reg_0(0);
  interpreter::Register reg_1(1);
  interpreter::Register reg_2(2);

  interpreter::BytecodeLabel ld1_label;
  interpreter::BytecodeLabel end_label;

154
  builder.JumpIfTrue(ToBooleanMode::kConvertToBoolean, &ld1_label);
155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180
  expected_liveness.emplace_back("LLLL", "LLL.");

  builder.LoadAccumulatorWithRegister(reg_0);
  expected_liveness.emplace_back("L.L.", "..L.");

  builder.Jump(&end_label);
  expected_liveness.emplace_back("..L.", "..L.");

  builder.Bind(&ld1_label);
  builder.LoadAccumulatorWithRegister(reg_1);
  expected_liveness.emplace_back(".LL.", "..L.");

  builder.Bind(&end_label);

  builder.LoadAccumulatorWithRegister(reg_2);
  expected_liveness.emplace_back("..L.", "...L");

  builder.Return();
  expected_liveness.emplace_back("...L", "....");

  Handle<BytecodeArray> bytecode = builder.ToBytecodeArray(isolate());

  EnsureLivenessMatches(bytecode, expected_liveness);
}

TEST_F(BytecodeAnalysisTest, DiamondLookupsAndBinds) {
181
  interpreter::BytecodeArrayBuilder builder(zone(), 3, 3);
182 183 184 185 186 187 188 189 190 191 192 193
  std::vector<std::pair<std::string, std::string>> expected_liveness;

  interpreter::Register reg_0(0);
  interpreter::Register reg_1(1);
  interpreter::Register reg_2(2);

  interpreter::BytecodeLabel ld1_label;
  interpreter::BytecodeLabel end_label;

  builder.StoreAccumulatorInRegister(reg_0);
  expected_liveness.emplace_back(".LLL", "LLLL");

194
  builder.JumpIfTrue(ToBooleanMode::kConvertToBoolean, &ld1_label);
195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227
  expected_liveness.emplace_back("LLLL", "LLL.");

  {
    builder.LoadAccumulatorWithRegister(reg_0);
    expected_liveness.emplace_back("L...", "...L");

    builder.StoreAccumulatorInRegister(reg_2);
    expected_liveness.emplace_back("...L", "..L.");

    builder.Jump(&end_label);
    expected_liveness.emplace_back("..L.", "..L.");
  }

  builder.Bind(&ld1_label);
  {
    builder.LoadAccumulatorWithRegister(reg_1);
    expected_liveness.emplace_back(".LL.", "..L.");
  }

  builder.Bind(&end_label);

  builder.LoadAccumulatorWithRegister(reg_2);
  expected_liveness.emplace_back("..L.", "...L");

  builder.Return();
  expected_liveness.emplace_back("...L", "....");

  Handle<BytecodeArray> bytecode = builder.ToBytecodeArray(isolate());

  EnsureLivenessMatches(bytecode, expected_liveness);
}

TEST_F(BytecodeAnalysisTest, SimpleLoop) {
228
  interpreter::BytecodeArrayBuilder builder(zone(), 3, 3);
229 230 231 232 233 234
  std::vector<std::pair<std::string, std::string>> expected_liveness;

  interpreter::Register reg_0(0);
  interpreter::Register reg_1(1);
  interpreter::Register reg_2(2);

235
  // Kill r0.
236
  builder.StoreAccumulatorInRegister(reg_0);
237
  expected_liveness.emplace_back("..LL", "L.L.");
238 239

  {
240
    interpreter::LoopBuilder loop_builder(&builder, nullptr, nullptr);
241 242
    loop_builder.LoopHeader();

243 244 245
    builder.LoadUndefined();
    expected_liveness.emplace_back("L.L.", "L.LL");

246 247
    builder.JumpIfTrue(ToBooleanMode::kConvertToBoolean,
                       loop_builder.break_labels()->New());
248 249
    expected_liveness.emplace_back("L.LL", "L.L.");

250
    // Gen r0.
251 252 253
    builder.LoadAccumulatorWithRegister(reg_0);
    expected_liveness.emplace_back("L...", "L..L");

254
    // Kill r2.
255
    builder.StoreAccumulatorInRegister(reg_2);
256
    expected_liveness.emplace_back("L..L", "L.L.");
257 258

    loop_builder.BindContinueTarget();
259
    loop_builder.JumpToHeader(0, nullptr);
260
    expected_liveness.emplace_back("L.L.", "L.L.");
261 262
  }

263
  // Gen r2.
264 265 266 267 268 269 270 271 272 273 274 275
  builder.LoadAccumulatorWithRegister(reg_2);
  expected_liveness.emplace_back("..L.", "...L");

  builder.Return();
  expected_liveness.emplace_back("...L", "....");

  Handle<BytecodeArray> bytecode = builder.ToBytecodeArray(isolate());

  EnsureLivenessMatches(bytecode, expected_liveness);
}

TEST_F(BytecodeAnalysisTest, TryCatch) {
276
  interpreter::BytecodeArrayBuilder builder(zone(), 3, 3);
277 278 279 280 281 282
  std::vector<std::pair<std::string, std::string>> expected_liveness;

  interpreter::Register reg_0(0);
  interpreter::Register reg_1(1);
  interpreter::Register reg_context(2);

283
  // Kill r0.
284 285 286
  builder.StoreAccumulatorInRegister(reg_0);
  expected_liveness.emplace_back(".LLL", "LLL.");

287 288
  interpreter::TryCatchBuilder try_builder(&builder, nullptr, nullptr,
                                           HandlerTable::CAUGHT);
289 290
  try_builder.BeginTry(reg_context);
  {
291
    // Gen r0.
292 293 294
    builder.LoadAccumulatorWithRegister(reg_0);
    expected_liveness.emplace_back("LLL.", ".LLL");

295
    // Kill r0.
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
    builder.StoreAccumulatorInRegister(reg_0);
    expected_liveness.emplace_back(".LLL", ".LL.");

    builder.CallRuntime(Runtime::kThrow);
    expected_liveness.emplace_back(".LL.", ".LLL");

    builder.StoreAccumulatorInRegister(reg_0);
    // Star can't throw, so doesn't take handler liveness
    expected_liveness.emplace_back("...L", "...L");
  }
  try_builder.EndTry();
  expected_liveness.emplace_back("...L", "...L");

  // Catch
  {
    builder.LoadAccumulatorWithRegister(reg_1);
    expected_liveness.emplace_back(".L..", "...L");
  }
  try_builder.EndCatch();

  builder.Return();
  expected_liveness.emplace_back("...L", "....");

  Handle<BytecodeArray> bytecode = builder.ToBytecodeArray(isolate());

  EnsureLivenessMatches(bytecode, expected_liveness);
}

TEST_F(BytecodeAnalysisTest, DiamondInLoop) {
325 326 327 328
  // For a logic diamond inside a loop, the liveness down one path of the
  // diamond should eventually propagate up the other path when the loop is
  // reprocessed.

329
  interpreter::BytecodeArrayBuilder builder(zone(), 3, 3);
330 331 332 333 334
  std::vector<std::pair<std::string, std::string>> expected_liveness;

  interpreter::Register reg_0(0);

  {
335
    interpreter::LoopBuilder loop_builder(&builder, nullptr, nullptr);
336 337
    loop_builder.LoopHeader();

338 339
    builder.LoadUndefined();
    expected_liveness.emplace_back("L...", "L..L");
340 341
    builder.JumpIfTrue(ToBooleanMode::kConvertToBoolean,
                       loop_builder.break_labels()->New());
342 343 344 345
    expected_liveness.emplace_back("L..L", "L..L");

    interpreter::BytecodeLabel ld1_label;
    interpreter::BytecodeLabel end_label;
346
    builder.JumpIfTrue(ToBooleanMode::kConvertToBoolean, &ld1_label);
347
    expected_liveness.emplace_back("L..L", "L...");
348 349 350

    {
      builder.Jump(&end_label);
351
      expected_liveness.emplace_back("L...", "L...");
352 353 354 355
    }

    builder.Bind(&ld1_label);
    {
356
      // Gen r0.
357
      builder.LoadAccumulatorWithRegister(reg_0);
358
      expected_liveness.emplace_back("L...", "L...");
359 360 361 362 363
    }

    builder.Bind(&end_label);

    loop_builder.BindContinueTarget();
364
    loop_builder.JumpToHeader(0, nullptr);
365
    expected_liveness.emplace_back("L...", "L...");
366 367
  }

368 369
  builder.LoadUndefined();
  expected_liveness.emplace_back("....", "...L");
370 371 372 373 374 375 376 377 378
  builder.Return();
  expected_liveness.emplace_back("...L", "....");

  Handle<BytecodeArray> bytecode = builder.ToBytecodeArray(isolate());

  EnsureLivenessMatches(bytecode, expected_liveness);
}

TEST_F(BytecodeAnalysisTest, KillingLoopInsideLoop) {
379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398
  // For a loop inside a loop, the inner loop has to be processed after the
  // outer loop has been processed, to ensure that it can propagate the
  // information in its header. Consider
  //
  //     0: do {
  //     1:   acc = r0;
  //     2:   acc = r1;
  //     3:   do {
  //     4:     r0 = acc;
  //     5:     break;
  //     6:   } while(true);
  //     7: } while(true);
  //
  // r0 should should be dead at 3 and 6, while r1 is live throughout. On the
  // initial pass, r1 is dead from 3-7. On the outer loop pass, it becomes live
  // in 3 and 7 (but not 4-6 because 6 only reads liveness from 3). Only after
  // the inner loop pass does it become live in 4-6. It's necessary, however, to
  // still process the inner loop when processing the outer loop, to ensure that
  // r1 becomes live in 3 (via 5), but r0 stays dead (because of 4).

399
  interpreter::BytecodeArrayBuilder builder(zone(), 3, 3);
400 401 402 403 404 405
  std::vector<std::pair<std::string, std::string>> expected_liveness;

  interpreter::Register reg_0(0);
  interpreter::Register reg_1(1);

  {
406
    interpreter::LoopBuilder loop_builder(&builder, nullptr, nullptr);
407 408
    loop_builder.LoopHeader();

409
    // Gen r0.
410 411 412
    builder.LoadAccumulatorWithRegister(reg_0);
    expected_liveness.emplace_back("LL..", ".L..");

413
    // Gen r1.
414 415 416
    builder.LoadAccumulatorWithRegister(reg_1);
    expected_liveness.emplace_back(".L..", ".L.L");

417 418
    builder.JumpIfTrue(ToBooleanMode::kConvertToBoolean,
                       loop_builder.break_labels()->New());
419
    expected_liveness.emplace_back(".L.L", ".L..");
420 421

    {
422
      interpreter::LoopBuilder inner_loop_builder(&builder, nullptr, nullptr);
423 424
      inner_loop_builder.LoopHeader();

425 426 427
      // Kill r0.
      builder.LoadUndefined();
      expected_liveness.emplace_back(".L..", ".L.L");
428 429 430
      builder.StoreAccumulatorInRegister(reg_0);
      expected_liveness.emplace_back(".L.L", "LL.L");

431 432
      builder.JumpIfTrue(ToBooleanMode::kConvertToBoolean,
                         inner_loop_builder.break_labels()->New());
433
      expected_liveness.emplace_back("LL.L", "LL..");
434 435

      inner_loop_builder.BindContinueTarget();
436
      inner_loop_builder.JumpToHeader(1, &loop_builder);
437
      expected_liveness.emplace_back(".L..", ".L..");
438 439 440
    }

    loop_builder.BindContinueTarget();
441
    loop_builder.JumpToHeader(0, nullptr);
442 443 444
    expected_liveness.emplace_back("LL..", "LL..");
  }

445 446
  builder.LoadUndefined();
  expected_liveness.emplace_back("....", "...L");
447 448 449 450 451 452 453 454
  builder.Return();
  expected_liveness.emplace_back("...L", "....");

  Handle<BytecodeArray> bytecode = builder.ToBytecodeArray(isolate());

  EnsureLivenessMatches(bytecode, expected_liveness);
}

455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501
TEST_F(BytecodeAnalysisTest, SuspendPoint) {
  interpreter::BytecodeArrayBuilder builder(zone(), 3, 3);
  std::vector<std::pair<std::string, std::string>> expected_liveness;

  interpreter::Register reg_0(0);
  interpreter::Register reg_1(1);
  interpreter::Register reg_gen(2);
  interpreter::BytecodeJumpTable* gen_jump_table =
      builder.AllocateJumpTable(1, 0);

  builder.StoreAccumulatorInRegister(reg_gen);
  expected_liveness.emplace_back("L..L", "L.LL");

  // Note: technically, r0 should be dead here since the resume will write it,
  // but in practice the bytecode analysis doesn't bother to special case it,
  // since the generator switch is close to the top of the function anyway.
  builder.SwitchOnGeneratorState(reg_gen, gen_jump_table);
  expected_liveness.emplace_back("L.LL", "L.LL");

  builder.StoreAccumulatorInRegister(reg_0);
  expected_liveness.emplace_back("..LL", "L.LL");

  // Reg 1 is never read, so should be dead.
  builder.StoreAccumulatorInRegister(reg_1);
  expected_liveness.emplace_back("L.LL", "L.LL");

  builder.SuspendGenerator(
      reg_gen, interpreter::BytecodeUtils::NewRegisterList(0, 3), 0);
  expected_liveness.emplace_back("L.LL", "L.L.");

  builder.Bind(gen_jump_table, 0);

  builder.ResumeGenerator(reg_gen,
                          interpreter::BytecodeUtils::NewRegisterList(0, 1));
  expected_liveness.emplace_back("L.L.", "L...");

  builder.LoadAccumulatorWithRegister(reg_0);
  expected_liveness.emplace_back("L...", "...L");

  builder.Return();
  expected_liveness.emplace_back("...L", "....");

  Handle<BytecodeArray> bytecode = builder.ToBytecodeArray(isolate());

  EnsureLivenessMatches(bytecode, expected_liveness);
}

502 503 504
}  // namespace compiler
}  // namespace internal
}  // namespace v8