Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Begin adding tests for subtree rooting
authorMaxwell Pirtle <maxwellpirtle@gmail.com>
Mon, 22 May 2023 11:20:02 +0000 (13:20 +0200)
committerMaxwell Pirtle <maxwellpirtle@gmail.com>
Mon, 22 May 2023 11:38:57 +0000 (13:38 +0200)
src/mc/explo/odpor/WakeupTree_test.cpp

index dc9e598..412c961 100644 (file)
@@ -15,11 +15,113 @@ using namespace simgrid::mc::udpor;
 
 static void test_tree_iterator(const WakeupTree& tree, const std::vector<PartialExecution>& expected)
 {
-  auto tree_iter = tree.begin();
-  for (auto expected_iter = expected.begin(); expected_iter != expected.end(); ++expected_iter, ++tree_iter) {
+  uint64_t num_nodes_traversed = 0;
+  auto tree_iter               = tree.begin();
+  for (auto expected_iter = expected.begin(); expected_iter != expected.end();
+       ++expected_iter, ++tree_iter, ++num_nodes_traversed) {
     REQUIRE(tree_iter != tree.end());
     REQUIRE((*tree_iter)->get_sequence() == *expected_iter);
   }
+  REQUIRE(num_nodes_traversed == tree.get_num_nodes());
+}
+
+TEST_CASE("simgrid::mc::odpor::WakeupTree: Constructing Trees")
+{
+  SECTION("Constructing empty trees")
+  {
+    WakeupTree tree;
+    REQUIRE(tree.empty());
+    REQUIRE(tree.get_num_entries() == 0);
+    REQUIRE(tree.get_num_nodes() == 1);
+    test_tree_iterator(tree, std::vector<PartialExecution>{PartialExecution{}});
+  }
+
+  SECTION("Testing Subtree Rooting")
+  {
+    // Here, we make everything dependent. This will ensure that each unique sequence
+    // inserted into the tree never "eventually looks like"
+    const auto a0 = std::make_shared<DependentAction>(Transition::Type::UNKNOWN, 1);
+    const auto a1 = std::make_shared<DependentAction>(Transition::Type::UNKNOWN, 2);
+    const auto a2 = std::make_shared<DependentAction>(Transition::Type::UNKNOWN, 3);
+    const auto a3 = std::make_shared<DependentAction>(Transition::Type::UNKNOWN, 4);
+    const auto a4 = std::make_shared<DependentAction>(Transition::Type::UNKNOWN, 5);
+    const auto a5 = std::make_shared<DependentAction>(Transition::Type::UNKNOWN, 6);
+
+    Execution execution;
+    execution.push_transition(a0);
+    execution.push_transition(a1);
+    execution.push_transition(a2);
+    execution.push_transition(a3);
+    execution.push_transition(a4);
+    execution.push_transition(a5);
+
+    // The tree is as follows:
+    //                  {}
+    //               /     /
+    //             a1       a4
+    //           /    /       /
+    //          a2    a3       a1
+    //         /     /   /      /
+    //        a3    a2   a5     a2
+    //       /     /             /
+    //      a4    a4             a3
+    //
+    // Recall that new nodes (in this case the one with
+    // action `a2`) are added such that they are "greater than" (under
+    // the tree's `<` relation) all those that exist under the given parent
+    WakeupTree tree;
+    tree.insert(Execution(), {a1, a2, a3, a4});
+    tree.insert(Execution(), {a1, a3, a2, a4});
+    tree.insert(Execution(), {a1, a3, a2, a4, a5});
+    tree.insert(Execution(), {a1, a3, a5});
+    tree.insert(Execution(), {a4, a2, a1, a3});
+    REQUIRE(tree.get_num_nodes() == 13);
+
+    SECTION("Cloning a tree from the root produces the same tree")
+    {
+      // The root node is the last node
+      auto tree_root = tree.begin();
+      std::advance(tree_root, tree.get_num_nodes() - 1);
+
+      WakeupTree clone = WakeupTree::make_subtree_rooted_at(*tree_root);
+      REQUIRE(clone.empty() == tree.empty());
+      REQUIRE(clone.get_num_entries() == tree.get_num_entries());
+      REQUIRE(clone.get_num_nodes() == tree.get_num_nodes());
+
+      auto tree_iter = tree.begin();
+      for (auto clone_iter = clone.begin(); clone_iter != clone.end(); ++clone_iter, ++tree_iter) {
+        REQUIRE(tree_iter != tree.end());
+        REQUIRE((*tree_iter)->get_sequence() == (*clone_iter)->get_sequence());
+      }
+    }
+
+    SECTION("Cloning a subtree from a leaf gives an empty tree")
+    {
+      // Let's pick the first leaf
+      WakeupTree clone = WakeupTree::make_subtree_rooted_at(*tree.begin());
+      REQUIRE(clone.empty());
+      REQUIRE(clone.get_num_entries() == 0);
+      REQUIRE(clone.get_num_nodes() == 1);
+    }
+
+    SECTION("Cloning a subtree from an interior node gives the subtree underneath")
+    {
+      // Here, we pick the second-to-last node in the
+      // series, which is the right-most child of the root
+      auto right_most = tree.begin();
+      std::advance(right_most, tree.get_num_nodes() - 2);
+
+      WakeupTree clone = WakeupTree::make_subtree_rooted_at(*right_most);
+      REQUIRE_FALSE(clone.empty());
+      REQUIRE(clone.get_num_entries() == 3);
+      REQUIRE(clone.get_num_nodes() == 4);
+      // Importantly, note that action `a4` is not included in
+      // any of the executions; for in the subtree `clone` `a4`
+      // is now the root.
+      test_tree_iterator(clone, std::vector<PartialExecution>{PartialExecution{a2, a1, a3}, PartialExecution{a2, a1},
+                                                              PartialExecution{a2}, PartialExecution{}});
+    }
+  }
 }
 
 TEST_CASE("simgrid::mc::odpor::WakeupTree: Testing Insertion for Empty Executions")
@@ -28,12 +130,12 @@ TEST_CASE("simgrid::mc::odpor::WakeupTree: Testing Insertion for Empty Execution
   {
     // We imagine the following completed execution `E`
     // consisting of executing actions a0-a3. Execution
-    // `E` cis the first such maximal execution explored
+    // `E` is the first such maximal execution explored
     // by ODPOR, which implies that a) all sleep sets are
     // empty and b) all wakeup trees (i.e. for each prefix) consist of the root
     // node with a single leaf containing the action
     // taken, save for the wakeup tree of the execution itself
-    // which is empty
+    // which is empty.
 
     // We first notice that there's a reversible race between
     // events 0 and 3.
@@ -61,11 +163,11 @@ TEST_CASE("simgrid::mc::odpor::WakeupTree: Testing Insertion for Empty Execution
     }
 
     // First, we initialize the tree to how it looked prior
-    // to the insertion of the race
+    // to the insertion of the race.
     tree.insert(Execution(), {a0});
 
     // Then, after insertion, we ensure that the node was
-    // indeed added to the tree
+    // indeed added to the tree.
     tree.insert(Execution(), {a1, a3});
     test_tree_iterator(tree, std::vector<PartialExecution>{PartialExecution{a0}, PartialExecution{a1, a3},
                                                            PartialExecution{a1}, PartialExecution{}});
@@ -80,7 +182,7 @@ TEST_CASE("simgrid::mc::odpor::WakeupTree: Testing Insertion for Empty Execution
     SECTION("Attempting to re-insert an equivalent sequence should have no effect")
     {
       // a3 and a1 are interchangeable since `a1` is independent with everything.
-      // Since we found an equivalent sequence that is a leaf, nothing should result
+      // Since we found an equivalent sequence that is a leaf, nothing should result..
       tree.insert(Execution(), {a3, a1});
       test_tree_iterator(tree, std::vector<PartialExecution>{PartialExecution{a0}, PartialExecution{a1, a3},
                                                              PartialExecution{a1}, PartialExecution{}});
@@ -106,7 +208,7 @@ TEST_CASE("simgrid::mc::odpor::WakeupTree: Testing Insertion for Empty Execution
       //
       // Recall that new nodes (in this case the one with
       // action `a2`) are added such that they are "greater than" (under
-      // the tree's `<` relation) all those that exist under the given parent
+      // the tree's `<` relation) all those that exist under the given parent.
       tree.insert(Execution(), {a1, a2});
       test_tree_iterator(tree, std::vector<PartialExecution>{PartialExecution{a0}, PartialExecution{a1, a3},
                                                              PartialExecution{a1, a2}, PartialExecution{a1},
@@ -157,7 +259,7 @@ TEST_CASE("simgrid::mc::odpor::WakeupTree: Testing Insertion for Empty Execution
       // checks whether `a1` is independent with everything in the sequence
       // (in this case, consisting only of `a1`) which IS true. Since `a4`
       // is already a leaf node of the tree, it suffices to only have `a4`
-      // in this tree to guide ODPOR
+      // in this tree to guide ODPOR.
       tree.insert(Execution(), {a4});
       tree.insert(Execution(), {a1});
       REQUIRE(tree.get_num_nodes() == 2);
@@ -181,6 +283,12 @@ TEST_CASE("simgrid::mc::odpor::WakeupTree: Testing Insertion for Empty Execution
 
     SECTION("Stress test with multiple branch points: `~_E` with different looking sequences")
     {
+      // After the insertions below, the tree looks like the following:
+      //                {}
+      //              /    /
+      //            a0     a2
+      //                 /  |   /
+      //               a0  a3   a5
       tree.insert(Execution(), {a0});
       tree.insert(Execution(), {a2, a0});
       tree.insert(Execution(), {a2, a3});
@@ -196,13 +304,22 @@ TEST_CASE("simgrid::mc::odpor::WakeupTree: Testing Insertion for Empty Execution
         // containing `a2`, we attempt to add the what remains (viz. `a1`) to the
         // series. HOWEVER: we notice that `a2.a5` is "eventually equivalent to"
         // (that is `~` with) `a1.a2` since `a2` is an initial of the latter and
-        // `a1` and `a5` are independent of each other
+        // `a1` and `a5` are independent of each other.
         tree.insert(Execution(), {a1, a2});
         REQUIRE(tree.get_num_nodes() == 6);
         test_tree_iterator(tree, std::vector<PartialExecution>{PartialExecution{a0}, PartialExecution{a2, a0},
                                                                PartialExecution{a2, a3}, PartialExecution{a2, a5},
                                                                PartialExecution{a2}, PartialExecution{}});
 
+        // With a3.a0, we notice that starting a sequence with `a3` is
+        // always different than starting one with either `a0` or
+        //
+        // After the insertion, the tree looks like the following:
+        //                     {}
+        //              /     /        /
+        //            a0     a2        a3
+        //                 /  |  /     |
+        //               a0  a3  a5    a0
         tree.insert(Execution(), {a3, a0});
         REQUIRE(tree.get_num_nodes() == 8);
         test_tree_iterator(tree, std::vector<PartialExecution>{PartialExecution{a0}, PartialExecution{a2, a0},
@@ -212,27 +329,4 @@ TEST_CASE("simgrid::mc::odpor::WakeupTree: Testing Insertion for Empty Execution
       }
     }
   }
-}
-
-TEST_CASE("simgrid::mc::odpor::WakeupTree: Testing Subtree Rooting")
-{
-  const auto a0 = std::make_shared<DependentAction>(Transition::Type::UNKNOWN, 3);
-  const auto a1 = std::make_shared<IndependentAction>(Transition::Type::UNKNOWN, 4);
-  const auto a2 = std::make_shared<ConditionallyDependentAction>(Transition::Type::UNKNOWN, 1);
-  const auto a3 = std::make_shared<ConditionallyDependentAction>(Transition::Type::UNKNOWN, 4);
-  const auto a4 = std::make_shared<DependentAction>(Transition::Type::UNKNOWN, 1);
-  const auto a5 = std::make_shared<IndependentAction>(Transition::Type::UNKNOWN, 4);
-
-  Execution execution;
-  execution.push_transition(a0);
-  execution.push_transition(a1);
-  execution.push_transition(a2);
-  execution.push_transition(a3);
-
-  REQUIRE(execution.get_racing_events_of(2) == std::unordered_set<Execution::EventHandle>{0});
-  REQUIRE(execution.get_racing_events_of(3) == std::unordered_set<Execution::EventHandle>{0});
-
-  // The wakeup tree should
-
-  WakeupTree tree;
 }
\ No newline at end of file