src/mc/explo/odpor/WakeupTree.hpp

   1 /* Copyright (c) 2007-2023. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #ifndef SIMGRID_MC_ODPOR_WAKEUP_TREE_HPP
   7 #define SIMGRID_MC_ODPOR_WAKEUP_TREE_HPP
   8
   9 #include "src/mc/explo/odpor/WakeupTreeIterator.hpp"
  10 #include "src/mc/explo/odpor/odpor_forward.hpp"
  11
  12 #include <memory>
  13 #include <unordered_map>
  14
  15 namespace simgrid::mc::odpor {
  16
  17 class WakeupTreeNode {
  18 private:
  19   explicit WakeupTreeNode(const PartialExecution& u) : seq_(u) {}
  20   explicit WakeupTreeNode(PartialExecution&& u) : seq_(std::move(u)) {}
  21
  22   /** An ordered list of children of for this node in the tree */
  23   std::list<WakeupTreeNode*> children_;
  24
  25   /** @brief The contents of the node */
  26   PartialExecution seq_;
  27
  28   /** Allows the owning tree to insert directly into the child */
  29   friend WakeupTree;
  30
  31 public:
  32   WakeupTreeNode(const WakeupTreeNode&)            = delete;
  33   WakeupTreeNode(WakeupTreeNode&&)                 = default;
  34   WakeupTreeNode& operator=(const WakeupTreeNode&) = delete;
  35   WakeupTreeNode& operator=(WakeupTreeNode&&)      = default;
  36
  37   const auto begin() const { return this->children_.begin(); }
  38   const auto end() const { return this->children_.end(); }
  39   const auto rbegin() const { return this->children_.rbegin(); }
  40   const auto rend() const { return this->children_.rend(); }
  41
  42   const PartialExecution& get_sequence() const { return seq_; }
  43   const std::list<WakeupTreeNode*>& get_ordered_children() const { return children_; }
  44   bool is_leaf() const { return children_.empty(); }
  45   bool is_single_process() const { return children_.size() == static_cast<size_t>(1); }
  46
  47   /** Insert a node `node` as a new child of this node */
  48   void add_child(WakeupTreeNode* node) { this->children_.push_back(node); }
  49 };
  50
  51 class WakeupTree {
  52 private:
  53   /** @brief The root node of the tree */
  54   WakeupTreeNode* const root_;
  55
  56   /**
  57    * @brief All of the nodes that are currently are a part of the tree
  58    *
  59    * @invariant Each node event maps itself to the owner of that node,
  60    * i.e. the unique pointer that manages the data at the address. The tree owns all
  61    * of the addresses that are referenced by the nodes WakeupTreeNode and Configuration.
  62    * ODPOR guarantees that nodes are persisted as long as needed.
  63    */
  64   std::unordered_map<WakeupTreeNode*, std::unique_ptr<WakeupTreeNode>> nodes_;
  65
  66   /**
  67    * @brief Transfers the lifetime of node `node` to the tree
  68    */
  69   void insert_node(std::unique_ptr<WakeupTreeNode> node);
  70
  71   /**
  72    * @brief Creates a new, disconnected node in this tree
  73    */
  74   WakeupTreeNode* make_node(const PartialExecution& u);
  75
  76   /* Allow the iterator to access the contents of the tree */
  77   friend WakeupTreeIterator;
  78
  79 public:
  80   WakeupTree();
  81   explicit WakeupTree(std::unique_ptr<WakeupTreeNode> root);
  82   static WakeupTree new_subtree_rooted_at(WakeupTreeNode* root);
  83
  84   auto begin() const { return WakeupTreeIterator(*this); }
  85   auto end() const { return WakeupTreeIterator(); }
  86
  87   /**
  88    * @brief Inserts an sequence `seq` of processes into the tree
  89    * such that that this tree is a wakeup tree relative to the
  90    * given execution
  91    */
  92   void insert(const Execution& E, const PartialExecution& seq);
  93 };
  94
  95 } // namespace simgrid::mc::odpor
  96 #endif