boost::heap::compare<simgrid::xbt::HeapComparator<heap_element_type>>>
heap_type;
-/** @details An action is a consumption on a resource (e.g.: a communication for the network) */
+typedef std::pair<double, simgrid::kernel::resource::Action*> heap_element_type;
+class XBT_PUBLIC ActionHeap : public heap_type {
+ friend Action;
+
+public:
+ enum class Type {
+ latency = 100, /* this is a heap entry to warn us when the latency is payed */
+ max_duration, /* this is a heap entry to warn us when the max_duration limit (timeout) is reached */
+ normal, /* this is a normal heap entry stating the date to finish transmitting */
+ unset
+ };
+
+ double top_date() const;
+ void insert(Action* action, double date, ActionHeap::Type type);
+ void update(Action* action, double date, ActionHeap::Type type);
+ void remove(Action* action);
+ Action* pop();
+ bool empty() const { return heap_type::empty(); }
+};
+
+/** @details An action is a consumption on a resource (e.g.: a communication for the network).
+ *
+ * It is related (but still different) from activities, that are the stuff on which an actor can be blocked.
+ * See simgrid::s4u::Activity for more details.
+ */
class XBT_PUBLIC Action {
+ friend ActionHeap;
+
public:
/* Lazy update needs this Set hook to maintain a list of the tracked actions */
boost::intrusive::list_member_hook<> modified_set_hook_;
StateSet;
enum class State {
- ready = 0, /**< Ready */
- running, /**< Running */
- failed, /**< Task Failure */
- done, /**< Completed */
- to_free, /**< Action to free in next cleanup */
- not_in_the_system /**< Not in the system anymore. Why did you ask ? */
+ INITED, /**< Created, but not started yet */
+ STARTED, /**< Currently running */
+ FAILED, /**< either the resource failed, or the action was canceled */
+ FINISHED, /**< Successfully completed */
+ IGNORED /**< e.g. failure detectors: infinite sleep actions that are put on resources which failure should get
+ noticed */
};
enum class SuspendStates {
sleeping
};
- enum class Type {
- latency = 100, /* this is a heap entry to warn us when the latency is payed */
- max_duration, /* this is a heap entry to warn us when the max_duration limit (timeout) is reached */
- normal, /* this is a normal heap entry stating the date to finish transmitting */
- unset
- };
-
/**
* @brief Action constructor
*
/**
* @brief Mark that the action is now finished
*
- * @param state the new [state](\ref simgrid::kernel::resource::Action::State) of the current Action
+ * @param state the new [state](@ref simgrid::kernel::resource::Action::State) of the current Action
*/
void finish(Action::State state);
- /** @brief Get the [state](\ref simgrid::kernel::resource::Action::State) of the current Action */
+ /** @brief Get the [state](@ref simgrid::kernel::resource::Action::State) of the current Action */
Action::State get_state() const; /**< get the state*/
- /** @brief Set the [state](\ref simgrid::kernel::resource::Action::State) of the current Action */
+ /** @brief Set the [state](@ref simgrid::kernel::resource::Action::State) of the current Action */
virtual void set_state(Action::State state);
/** @brief Get the bound of the current Action */
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 */
- int unref();
+ bool unref();
/** @brief Cancel the current Action if running */
virtual void cancel();
virtual void set_max_duration(double duration);
/** @brief Get the tracing category associated to the current action */
- char* get_category() const { return category_; }
+ std::string get_category() const { return category_; }
/** @brief Set the tracing category of the current Action */
- void set_category(const char* category);
+ void set_category(std::string category) { category_ = category; }
/** @brief Get the priority of the current Action */
double get_priority() const { return sharing_priority_; };
double remains_; /**< How much of that cost remains to be done in the currently running task */
double start_time_; /**< start time */
double finish_time_ = -1; /**< finish time (may fluctuate until the task is completed) */
- char* category_ = nullptr; /**< tracing category for categorized resource utilization monitoring */
+ std::string category_; /**< tracing category for categorized resource utilization monitoring */
double cost_;
simgrid::kernel::resource::Model* model_;
double last_update_ = 0;
double last_value_ = 0;
kernel::lmm::Variable* variable_ = nullptr;
- Action::Type type_ = Action::Type::unset;
- boost::optional<heap_type::handle_type> heap_hook_ = boost::none;
+
+ ActionHeap::Type type_ = ActionHeap::Type::unset;
+ boost::optional<ActionHeap::handle_type> heap_hook_ = boost::none;
public:
- void heapInsert(double key, Action::Type type);
- void heapRemove();
- void heapUpdate(double key, Action::Type type);
- void heap_clear_handle();
+ ActionHeap::Type get_type() const { return type_; }
lmm::Variable* get_variable() const { return variable_; }
void set_variable(lmm::Variable* var) { variable_ = var; }
double get_last_value() const { return last_value_; }
void set_last_value(double val) { last_value_ = val; }
- Action::Type get_type() const { return type_; }
-
protected:
Action::SuspendStates suspended_ = Action::SuspendStates::not_suspended;
};
