/* This program is free software; you can redistribute it and/or modify it
* under the terms of the license (GNU LGPL) which comes with this package. */
-#include "xbt/asserts.h"
-
#ifndef SIMGRID_MC_STRATEGY_HPP
#define SIMGRID_MC_STRATEGY_HPP
+#include "simgrid/forward.h"
+#include "src/mc/api/RemoteApp.hpp"
+#include "src/mc/mc_config.hpp"
+#include "xbt/asserts.h"
+#include <map>
+#include <utility>
+
namespace simgrid::mc {
class Strategy {
protected:
- /** State's exploration status by actor. Not all the actors are there, only the ones that are ready-to-run in this
- * state */
+ /** State's exploration status by actor. All actors should be present, eventually disabled for now. */
std::map<aid_t, ActorState> actors_to_run_;
public:
- /** Used to store penalties computed by the strategy to each actor */
- std::map<aid_t, double> penalties_;
- virtual ~Strategy() = default;
- virtual std::pair<aid_t, double> next_transition() const = 0;
- virtual void execute_next(aid_t aid, RemoteApp& app) = 0;
- virtual void consider_best() = 0;
-
- // Mark the first enabled and not yet done transition as todo
- // If there's already a transition marked as todo, does nothing
+ /** Strategies can have values shared from parent to children state.
+ * This method should copy all value the strategy needs from its parent. */
+ virtual void copy_from(const Strategy*) = 0;
+
+ Strategy() = default;
+ virtual ~Strategy() = default;
+
+ /** Returns the best transition among according to the strategy for this state.
+ * The strategy should consider only enabled transition not already done.
+ * Furthermore, if must_be_todo is set to true, only transitions marked as todo
+ * should be considered. */
+ virtual std::pair<aid_t, int> best_transition(bool must_be_todo) const = 0;
+
+ /** Returns the best transition among those that should be interleaved. */
+ std::pair<aid_t, int> next_transition() const { return best_transition(true); }
+
+ /** Allows for the strategy to update its fields knowing that the actor aid will
+ * be executed and a children strategy will then be created. */
+ virtual void execute_next(aid_t aid, RemoteApp& app) = 0;
+
+ /** Ensure at least one transition is marked as todo among the enabled ones not done.
+ * If required, it marks as todo the best transition according to the strategy. */
+ void consider_best() {
+ if (std::any_of(begin(actors_to_run_), end(actors_to_run_),
+ [](const auto& actor) { return actor.second.is_todo(); }))
+ return;
+ aid_t best_aid = best_transition(false).first;
+ if (best_aid != -1)
+ actors_to_run_.at(best_aid).mark_todo();
+ }
+
+ // Mark aid as todo. If it makes no sense, ie. if it is already done or not enabled,
+ // else raise an error
void consider_one(aid_t aid)
{
- xbt_assert(actors_to_run_.at(aid).is_enabled() and not actors_to_run_.at(aid).is_done(),
+ xbt_assert(actors_to_run_.at(aid).is_enabled() && not actors_to_run_.at(aid).is_done(),
"Tried to mark as TODO actor %ld but it is either not enabled or already done", aid);
actors_to_run_.at(aid).mark_todo();
}
- // Matk as todo all actors enabled that are not done yet
+ // Mark as todo all actors enabled that are not done yet and return the number
+ // of marked actors
unsigned long consider_all()
{
unsigned long count = 0;
for (auto& [_, actor] : actors_to_run_)
- if (actor.is_enabled() and not actor.is_done()) {
+ if (actor.is_enabled() && not actor.is_done()) {
actor.mark_todo();
count++;
}
