p4: misc fixes for tests (#664)

* p4: misc fixes for tests

Signed-off-by: Alex Chi <[email protected]>

* check plan

Signed-off-by: Alex Chi <[email protected]>

---------

Signed-off-by: Alex Chi <[email protected]>

Author: skyzh

test/txn/txn_common.h

@@ -206,12 +206,15 @@ void CheckUndoLogNum(BustubInstance &instance, const std::string &txn_var_name,
 }
 
 void CheckUndoLogColumn(BustubInstance &instance, const std::string &txn_var_name, Transaction *txn,
-                        size_t expected_columns) {
+                        size_t expected_columns, bool enable_length_check = true) {
   fmt::println(stderr, "- {} var={} id={} status={} read_ts={}", Header("check_undo_log"), txn_var_name,
                txn->GetTransactionIdHumanReadable(), txn->GetTransactionState(), txn->GetReadTs());
   auto undo_log_num = txn->GetUndoLogNum();
   if (undo_log_num != 1) {
     fmt::println(stderr, "Error: expected to have {} undo logs in txn, found {}", 1, undo_log_num);
+    std::cerr << "hint: please refer to the writeup delete and update section. you should generate a partial tuple, "
+                 "keep adding things to the tuple when updating, and never remove things from it."
+              << std::endl;
     std::terminate();
   }
   auto undo_log = txn->GetUndoLog(0);
@@ -225,6 +228,16 @@ void CheckUndoLogColumn(BustubInstance &instance, const std::string &txn_var_nam
               << std::endl;
     std::terminate();
   }
+  if (enable_length_check) {
+    if (undo_log.tuple_.GetLength() > expected_columns * 4 /* integer width */) {
+      fmt::println(stderr, "Error: tuple length not correct? expecting <column> * 4, found {} while having {} columns",
+                   undo_log.tuple_.GetLength(), cnt);
+      std::cerr << "hint: probably your implementation stores `modified_fields` correctly but did not actually "
+                   "use it in the tuple reconstruction process."
+                << std::endl;
+      std::terminate();
+    }
+  }
 }
 
 #define WithTxn(txn, func)                             \

test/txn/txn_index_concurrent_test.cpp

@@ -65,7 +65,7 @@ TEST(TxnIndexTest, DISABLED_IndexConcurrentInsertTest) {  // NOLINT
       for (int j = 0; j < thread_cnt; j++) {
         if (operation_result[j][i]) {
           if (winner != -1) {
-            fmt::println(stderr, "multiple winner for inserting {}: [{}]", i, fmt::join(operation_result[j], ","));
+            fmt::println(stderr, "multiple winner for inserting {}", i);
             std::terminate();
           }
           winner = j;

tools/terrier_bench/terrier.cpp

@@ -449,13 +449,30 @@ void TaskComputeDbSize(const uint64_t duration_ms, std::atomic<int> &db_size, bu
   }
 }
 
+void PrintPlan(bustub::BustubInstance &instance, const std::string &query, bool ensure_index_scan = true) {
+  {
+    std::stringstream ss;
+    bustub::SimpleStreamWriter writer_ss(ss);
+    auto *txn = instance.txn_manager_->Begin();
+    instance.ExecuteSqlTxn("EXPLAIN (o) " + query, writer_ss, txn);
+    fmt::println(stderr, "> {}\n[PLAN]\n{}", query, ss.str());
+    if (ensure_index_scan) {
+      if (!bustub::StringUtil::Contains(ss.str(), "IndexScan")) {
+        fmt::println(stderr, "ERROR: index scan not found in plan.");
+        std::terminate();
+      }
+    }
+  }
+}
+
 // NOLINTNEXTLINE
 auto main(int argc, char **argv) -> int {
   const auto isolation_lvl = bustub::IsolationLevel::SNAPSHOT_ISOLATION;
   argparse::ArgumentParser program("bustub-terrier-bench");
   program.add_argument("--duration").help("run terrier bench for n milliseconds");
   program.add_argument("--terriers").help("number of terriers in the bench");
   program.add_argument("--threads").help("number of threads in the bench");
+  program.add_argument("--commit-threshold").help("number of commits to pass the benchmark");
   program.add_argument("--bench-1")
       .default_value(false)
       .implicit_value(true)
@@ -468,6 +485,7 @@ auto main(int argc, char **argv) -> int {
   size_t bustub_terrier_num = 10;
   size_t bustub_thread_cnt = 2;
   const size_t bpm_size = 4096;  // ensure benchmark does not hit BPM
+  size_t commit_threshold = 100;
 
   try {
     program.parse_args(argc, argv);
@@ -483,6 +501,10 @@ auto main(int argc, char **argv) -> int {
     bustub_terrier_num = std::stoi(program.get("--terriers"));
   }
 
+  if (program.present("--commit-threshold")) {
+    commit_threshold = std::stoi(program.get("--commit-threshold"));
+  }
+
   if (program.present("--threads")) {
     bustub_thread_cnt = std::stoi(program.get("--threads"));
   }
@@ -509,25 +531,25 @@ auto main(int argc, char **argv) -> int {
     fmt::println(stderr, "x: create schema for benchmark #1");
     bustub->ExecuteSql(schema, writer);
     fmt::println(stderr, "x: please ensure plans are correct for all queries");
-    bustub->ExecuteSql("explain (o) UPDATE terriers SET token = token + 1 WHERE terrier = 0", writer);
-    bustub->ExecuteSql("explain (o) UPDATE terriers SET token = token - 1 WHERE terrier = 0", writer);
-    bustub->ExecuteSql("explain (o) DELETE FROM terriers WHERE terrier = 0", writer);
-    bustub->ExecuteSql("explain (o) INSERT INTO terriers VALUES (0, 0)", writer);
-    bustub->ExecuteSql("explain (o) SELECT * from terriers", writer);
+    PrintPlan(*bustub, "UPDATE terriers SET token = token + 1 WHERE terrier = 0");
+    PrintPlan(*bustub, "UPDATE terriers SET token = token - 1 WHERE terrier = 0");
+    PrintPlan(*bustub, "DELETE FROM terriers WHERE terrier = 0");
+    PrintPlan(*bustub, "INSERT INTO terriers VALUES (0, 0)", false);
+    PrintPlan(*bustub, "SELECT * from terriers", false);
   }
   if (bench_2) {
     auto schema = "CREATE TABLE terriers(terrier int PRIMARY KEY, token int, network int);";
     fmt::println(stderr, "x: create schema for benchmark #2");
     bustub->ExecuteSql(schema, writer);
     fmt::println(stderr, "x: please ensure plans are correct for all queries");
-    bustub->ExecuteSql("explain (o) UPDATE terriers SET token = token + 1 WHERE terrier = 0", writer);
-    bustub->ExecuteSql("explain (o) UPDATE terriers SET token = token - 1 WHERE terrier = 0", writer);
-    bustub->ExecuteSql("explain (o) UPDATE terriers SET network = 1, token = token + 1000 WHERE terrier = 0", writer);
-    bustub->ExecuteSql("explain (o) UPDATE terriers SET network = 1, token = token - 1000 WHERE terrier = 0", writer);
-    bustub->ExecuteSql("explain (o) SELECT network from terriers WHERE terrier = 0", writer);
-    bustub->ExecuteSql("explain (o) DELETE FROM terriers WHERE terrier = 0", writer);
-    bustub->ExecuteSql("explain (o) INSERT INTO terriers VALUES (0, 0, 0)", writer);
-    bustub->ExecuteSql("explain (o) SELECT * from terriers", writer);
+    PrintPlan(*bustub, "UPDATE terriers SET token = token + 1 WHERE terrier = 0");
+    PrintPlan(*bustub, "UPDATE terriers SET token = token - 1 WHERE terrier = 0");
+    PrintPlan(*bustub, "UPDATE terriers SET network = 1, token = token + 1000 WHERE terrier = 0");
+    PrintPlan(*bustub, "UPDATE terriers SET network = 1, token = token - 1000 WHERE terrier = 0");
+    PrintPlan(*bustub, "SELECT network from terriers WHERE terrier = 0");
+    PrintPlan(*bustub, "DELETE FROM terriers WHERE terrier = 0");
+    PrintPlan(*bustub, "INSERT INTO terriers VALUES (0, 0, 0)", false);
+    PrintPlan(*bustub, "SELECT * from terriers", false);
   }
 
   const int initial_token = 10000;
@@ -635,13 +657,15 @@ auto main(int argc, char **argv) -> int {
 
   total_metrics.Report(db_size);
 
-  if (total_metrics.committed_transfer_txn_cnt_ <= 100) {
-    fmt::println(stderr, "too many txn are aborted");
+  if (total_metrics.committed_transfer_txn_cnt_ <= commit_threshold) {
+    fmt::println(stderr, "too many txn are aborted: {} txn committed, expect more than {}",
+                 total_metrics.committed_transfer_txn_cnt_, commit_threshold);
     exit(1);
   }
 
-  if (bench_2 && total_metrics.committed_join_txn_cnt_ <= 100) {
-    fmt::println(stderr, "too many txn are aborted");
+  if (bench_2 && total_metrics.committed_join_txn_cnt_ <= commit_threshold) {
+    fmt::println(stderr, "too many txn are aborted: {} txn committed, expect more than {}",
+                 total_metrics.committed_join_txn_cnt_, commit_threshold);
     exit(1);
   }