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   friend WakeupTreeIterator;
  31
  32 public:
  33   WakeupTreeNode(const WakeupTreeNode&)            = delete;
  34   WakeupTreeNode(WakeupTreeNode&&)                 = default;
  35   WakeupTreeNode& operator=(const WakeupTreeNode&) = delete;
  36   WakeupTreeNode& operator=(WakeupTreeNode&&)      = default;
  37
  38   const auto begin() const { return this->children_.begin(); }
  39   const auto end() const { return this->children_.end(); }
  40   const auto rbegin() const { return this->children_.rbegin(); }
  41   const auto rend() const { return this->children_.rend(); }
  42
  43   const PartialExecution& get_sequence() const { return seq_; }
  44   const std::list<WakeupTreeNode*>& get_ordered_children() const { return children_; }
  45   bool is_leaf() const { return children_.empty(); }
  46   bool is_single_process() const { return children_.size() == static_cast<size_t>(1); }
  47
  48   /** Insert a node `node` as a new child of this node */
  49   void add_child(WakeupTreeNode* node) { this->children_.push_back(node); }
  50 };
  51
  52 class WakeupTree {
  53 private:
  54   /** @brief The root node of the tree */
  55   WakeupTreeNode* const root_;
  56
  57   /**
  58    * @brief All of the nodes that are currently are a part of the tree
  59    *
  60    * @invariant Each node event maps itself to the owner of that node,
  61    * i.e. the unique pointer that manages the data at the address. The tree owns all
  62    * of the addresses that are referenced by the nodes WakeupTreeNode and Configuration.
  63    * ODPOR guarantees that nodes are persisted as long as needed.
  64    */
  65   std::unordered_map<WakeupTreeNode*, std::unique_ptr<WakeupTreeNode>> nodes_;
  66
  67   void insert_node(std::unique_ptr<WakeupTreeNode> node);
  68   void remove_node(WakeupTreeNode* node);
  69
  70   /**
  71    * @brief Adds a new node to the tree, disconnected from
  72    * any other, which represents the partial execution
  73    * "fragment" `u`
  74    */
  75   WakeupTreeNode* make_node(const PartialExecution& u);
  76
  77   bool contains(WakeupTreeNode* node) const;
  78
  79   /* Allow the iterator to access the contents of the tree */
  80   friend WakeupTreeIterator;
  81
  82 public:
  83   WakeupTree();
  84   explicit WakeupTree(std::unique_ptr<WakeupTreeNode> root);
  85
  86   auto begin() const { return WakeupTreeIterator(*this); }
  87   auto end() const { return WakeupTreeIterator(); }
  88
  89   void remove_subtree_rooted_at(WakeupTreeNode* root);
  90   static WakeupTree new_subtree_rooted_at(WakeupTreeNode* root);
  91
  92   /**
  93    * @brief Whether or not this tree is considered empty
  94    *
  95    * @note Unlike other collection types, a wakeup tree is
  96    * considered "empty" if it only contains the root node;
  97    * that is, if it is "uninteresting". In such a case,
  98    */
  99   bool is_empty() const { return nodes_.size() == static_cast<size_t>(1); }
 100
 101   /**
 102    * @brief Inserts an sequence `seq` of processes into the tree
 103    * such that that this tree is a wakeup tree relative to the
 104    * given execution
 105    */
 106   void insert(const Execution& E, const PartialExecution& seq);
 107 };
 108
 109 } // namespace simgrid::mc::odpor
 110 #endif