#ifndef SIMGRID_KERNEL_RESOURCE_ACTION_HPP
#define SIMGRID_KERNEL_RESOURCE_ACTION_HPP
-#include "src/surf/surf_interface.hpp"
+#include <simgrid/forward.h>
+#include <xbt/signal.hpp>
+#include <xbt/utility.hpp>
+
+#include <boost/heap/pairing_heap.hpp>
+#include <boost/optional.hpp>
+
+const int NO_MAX_DURATION = -1.0;
namespace simgrid {
namespace kernel {
boost::heap::compare<simgrid::xbt::HeapComparator<heap_element_type>>>
heap_type;
-/** @ingroup SURF_interface
- * @brief SURF action interface class
- * @details An action is an event generated by a resource (e.g.: a communication for the network)
- */
+/** @details An action is a consumption on a resource (e.g.: a communication for the network) */
class XBT_PUBLIC Action {
public:
- boost::intrusive::list_member_hook<> modifiedSetHook_; /* Used by the lazy update to list the actions to track */
- bool isLinkedModifiedSet() const { return modifiedSetHook_.is_linked(); }
-
- typedef boost::intrusive::member_hook<Action, boost::intrusive::list_member_hook<>, &Action::modifiedSetHook_>
- ActionLmmOptions;
- typedef boost::intrusive::list<Action, ActionLmmOptions> ActionLmmList;
-
- boost::intrusive::list_member_hook<> stateSetHook_;
- typedef boost::intrusive::member_hook<Action, boost::intrusive::list_member_hook<>, &Action::stateSetHook_>
- ActionOptions;
- typedef boost::intrusive::list<Action, ActionOptions> ActionList;
+ /* Lazy update needs this Set hook to maintain a list of the tracked actions */
+ boost::intrusive::list_member_hook<> modified_set_hook_;
+ bool isLinkedModifiedSet() const { return modified_set_hook_.is_linked(); }
+ typedef boost::intrusive::list<
+ Action, boost::intrusive::member_hook<Action, boost::intrusive::list_member_hook<>, &Action::modified_set_hook_>>
+ ModifiedSet;
+
+ boost::intrusive::list_member_hook<> state_set_hook_;
+ typedef boost::intrusive::list<
+ Action, boost::intrusive::member_hook<Action, boost::intrusive::list_member_hook<>, &Action::state_set_hook_>>
+ StateSet;
enum class State {
ready = 0, /**< Ready */
* @param cost The cost of the Action
* @param failed If the action is impossible (e.g.: execute something on a switched off host)
*/
- Action(simgrid::kernel::resource::Model* model, double cost, bool failed);
+ Action(Model* model, double cost, bool failed);
/**
* @brief Action constructor
* @param failed If the action is impossible (e.g.: execute something on a switched off host)
* @param var The lmm variable associated to this Action if it is part of a LMM component
*/
- Action(simgrid::kernel::resource::Model* model, double cost, bool failed, kernel::lmm::Variable* var);
+ Action(Model* model, double cost, bool failed, lmm::Variable* var);
virtual ~Action();
void finish(Action::State state);
/** @brief Get the [state](\ref simgrid::kernel::resource::Action::State) of the current Action */
- Action::State getState() const; /**< get the state*/
+ Action::State get_state() const; /**< get the state*/
/** @brief Set the [state](\ref simgrid::kernel::resource::Action::State) of the current Action */
- virtual void setState(Action::State state);
+ virtual void set_state(Action::State state);
/** @brief Get the bound of the current Action */
- double getBound() const;
+ double get_bound() const;
/** @brief Set the bound of the current Action */
- void setBound(double bound);
+ void set_bound(double bound);
/** @brief Get the start time of the current action */
- double getStartTime() const { return start_; }
+ double get_start_time() const { return start_time_; }
/** @brief Get the finish time of the current action */
- double getFinishTime() const { return finishTime_; }
+ double getFinishTime() const { return finish_time_; }
/** @brief Get the user data associated to the current action */
- void* getData() const { return data_; }
+ void* get_data() const { return data_; }
/** @brief Set the user data associated to the current action */
- void setData(void* data) { data_ = data; }
+ void set_data(void* data) { data_ = data; }
/** @brief Get the cost of the current action */
- double getCost() const { return cost_; }
+ double get_cost() const { return cost_; }
/** @brief Set the cost of the current action */
- void setCost(double cost) { cost_ = cost; }
+ void set_cost(double cost) { cost_ = cost; }
/** @brief Update the maximum duration of the current action
* @param delta Amount to remove from the MaxDuration */
- void updateMaxDuration(double delta) { double_update(&maxDuration_, delta, sg_surf_precision); }
+ void update_max_duration(double delta);
/** @brief Update the remaining time of the current action
* @param delta Amount to remove from the remaining time */
- void updateRemains(double delta) { double_update(&remains_, delta, sg_maxmin_precision * sg_surf_precision); }
+ void update_remains(double delta);
+
+ virtual void update_remains_lazy(double now) = 0;
/** @brief Set the remaining time of the current action */
- void setRemains(double value) { remains_ = value; }
+ void set_remains(double value) { remains_ = value; }
+
/** @brief Get the remaining time of the current action after updating the resource */
- virtual double getRemains();
+ virtual double get_remains();
/** @brief Get the remaining time of the current action without updating the resource */
- double getRemainsNoUpdate() const { return remains_; }
+ double get_remains_no_update() const { return remains_; }
/** @brief Set the finish time of the current action */
- void setFinishTime(double value) { finishTime_ = value; }
+ void set_finish_time(double value) { finish_time_ = value; }
/**@brief Add a reference to the current action (refcounting) */
void ref();
/** @brief Unref that action (and destroy it if refcount reaches 0)
* @return true if the action was destroyed and false if someone still has references on it
*/
- virtual int unref();
+ int unref();
/** @brief Cancel the current Action if running */
virtual void cancel();
virtual bool isSuspended();
/** @brief Get the maximum duration of the current action */
- double getMaxDuration() const { return maxDuration_; }
+ double get_max_duration() const { return max_duration_; }
/** @brief Set the maximum duration of the current Action */
- virtual void setMaxDuration(double duration);
+ virtual void set_max_duration(double duration);
/** @brief Get the tracing category associated to the current action */
- char* getCategory() const { return category_; }
+ char* get_category() const { return category_; }
/** @brief Set the tracing category of the current Action */
- void setCategory(const char* category);
+ void set_category(const char* category);
/** @brief Get the priority of the current Action */
- double getPriority() const { return sharingWeight_; };
+ double get_priority() const { return sharing_priority_; };
/** @brief Set the priority of the current Action */
- virtual void setSharingWeight(double priority);
- void setSharingWeightNoUpdate(double weight) { sharingWeight_ = weight; }
+ virtual void set_priority(double priority);
+ void set_priority_no_update(double priority) { sharing_priority_ = priority; }
/** @brief Get the state set in which the action is */
- ActionList* getStateSet() const { return stateSet_; };
+ StateSet* get_state_set() const { return state_set_; };
- simgrid::kernel::resource::Model* getModel() const { return model_; }
+ simgrid::kernel::resource::Model* get_model() const { return model_; }
protected:
- ActionList* stateSet_;
- int refcount_ = 1;
+ StateSet* state_set_;
private:
- double sharingWeight_ = 1.0; /**< priority (1.0 by default) */
- double maxDuration_ = NO_MAX_DURATION; /*< max_duration (may fluctuate until the task is completed) */
+ int refcount_ = 1;
+ double sharing_priority_ = 1.0; /**< priority (1.0 by default) */
+ double max_duration_ = NO_MAX_DURATION; /*< max_duration (may fluctuate until the task is completed) */
double remains_; /**< How much of that cost remains to be done in the currently running task */
- double start_; /**< start time */
+ double start_time_; /**< start time */
char* category_ = nullptr; /**< tracing category for categorized resource utilization monitoring */
- double finishTime_ =
+ double finish_time_ =
-1; /**< finish time : this is modified during the run and fluctuates until the task is completed */
double cost_;
void* data_ = nullptr; /**< for your convenience */
/* LMM */
- double lastUpdate_ = 0;
- double lastValue_ = 0;
+ double last_update_ = 0;
+ double last_value_ = 0;
kernel::lmm::Variable* variable_ = nullptr;
Action::Type type_ = Action::Type::NOTSET;
- boost::optional<heap_type::handle_type> heapHandle_ = boost::none;
+ boost::optional<heap_type::handle_type> heap_handle_ = boost::none;
public:
- virtual void updateRemainingLazy(double now) { THROW_IMPOSSIBLE; };
void heapInsert(heap_type& heap, double key, Action::Type hat);
void heapRemove(heap_type& heap);
void heapUpdate(heap_type& heap, double key, Action::Type hat);
- void clearHeapHandle() { heapHandle_ = boost::none; }
+ void clearHeapHandle() { heap_handle_ = boost::none; }
kernel::lmm::Variable* getVariable() const { return variable_; }
void setVariable(kernel::lmm::Variable* var) { variable_ = var; }
- double getLastUpdate() const { return lastUpdate_; }
- void refreshLastUpdate() { lastUpdate_ = surf_get_clock(); }
- double getLastValue() const { return lastValue_; }
- void setLastValue(double val) { lastValue_ = val; }
+ double getLastUpdate() const { return last_update_; }
+ void refreshLastUpdate();
+ double getLastValue() const { return last_value_; }
+ void setLastValue(double val) { last_value_ = val; }
Action::Type getType() const { return type_; }
protected:
Action::SuspendStates suspended_ = Action::SuspendStates::not_suspended;
};
-typedef Action::ActionList ActionList;
-typedef Action::ActionLmmList ActionLmmList;
-typedef Action::ActionLmmList* ActionLmmListPtr;
} // namespace resource
} // namespace kernel
} // namespace simgrid
