X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/79739657970ffcf609c1e90f6112e8f5a8583801..dc9b8feaddd53842f6204f4f24409b2382393fa9:/include/simgrid/kernel/resource/Action.hpp diff --git a/include/simgrid/kernel/resource/Action.hpp b/include/simgrid/kernel/resource/Action.hpp index 20e877ca76..ca8591819c 100644 --- a/include/simgrid/kernel/resource/Action.hpp +++ b/include/simgrid/kernel/resource/Action.hpp @@ -1,4 +1,4 @@ -/* Copyright (c) 2004-2018. The SimGrid Team. All rights reserved. */ +/* Copyright (c) 2004-2019. The SimGrid Team. All rights reserved. */ /* 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. */ @@ -12,8 +12,9 @@ #include #include +#include -const int NO_MAX_DURATION = -1.0; +static constexpr int NO_MAX_DURATION = -1.0; namespace simgrid { namespace kernel { @@ -24,12 +25,37 @@ typedef boost::heap::pairing_heap>> heap_type; -/** @details An action is a consumption on a resource (e.g.: a communication for the network) */ +typedef std::pair 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(); +}; + +/** @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_; - bool isLinkedModifiedSet() const { return modified_set_hook_.is_linked(); } + bool is_within_modified_set() const { return modified_set_hook_.is_linked(); } typedef boost::intrusive::list< Action, boost::intrusive::member_hook, &Action::modified_set_hook_>> ModifiedSet; @@ -40,12 +66,12 @@ public: 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 { @@ -54,8 +80,6 @@ public: sleeping }; - enum class Type { LATENCY = 100, MAX_DURATION, NORMAL, NOTSET }; - /** * @brief Action constructor * @@ -74,19 +98,21 @@ public: * @param var The lmm variable associated to this Action if it is part of a LMM component */ Action(Model* model, double cost, bool failed, lmm::Variable* var); + Action(const Action&) = delete; + Action& operator=(const Action&) = delete; virtual ~Action(); /** * @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 */ @@ -97,7 +123,7 @@ public: /** @brief Get the start time of the current action */ double get_start_time() const { return start_time_; } /** @brief Get the finish time of the current action */ - double getFinishTime() const { return finish_time_; } + double get_finish_time() const { return finish_time_; } /** @brief Get the user data associated to the current action */ void* get_data() const { return data_; } @@ -117,6 +143,8 @@ public: * @param delta Amount to remove from the remaining time */ void update_remains(double delta); + virtual void update_remains_lazy(double now) = 0; + /** @brief Set the remaining time of the current action */ void set_remains(double value) { remains_ = value; } @@ -131,9 +159,8 @@ public: /**@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 - */ - int unref(); + * @return true if the action was destroyed and false if someone still has references on it */ + bool unref(); /** @brief Cancel the current Action if running */ virtual void cancel(); @@ -145,7 +172,7 @@ public: virtual void resume(); /** @brief Returns true if the current action is running */ - virtual bool isSuspended(); + bool is_suspended(); /** @brief Get the maximum duration of the current action */ double get_max_duration() const { return max_duration_; } @@ -153,9 +180,9 @@ public: virtual void set_max_duration(double duration); /** @brief Get the tracing category associated to the current action */ - char* get_category() const { return category_; } + const 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(const std::string& category) { category_ = category; } /** @brief Get the priority of the current Action */ double get_priority() const { return sharing_priority_; }; @@ -177,34 +204,32 @@ private: 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_time_; /**< start time */ - char* category_ = nullptr; /**< tracing category for categorized resource utilization monitoring */ - double finish_time_ = - -1; /**< finish time : this is modified during the run and fluctuates until the task is completed */ + double finish_time_ = -1; /**< finish time (may fluctuate until the task is completed) */ + std::string category_; /**< tracing category for categorized resource utilization monitoring */ double cost_; simgrid::kernel::resource::Model* model_; void* data_ = nullptr; /**< for your convenience */ /* LMM */ - double last_update_ = 0; - double last_value_ = 0; - kernel::lmm::Variable* variable_ = nullptr; - Action::Type type_ = Action::Type::NOTSET; - boost::optional heap_handle_ = boost::none; + double last_update_ = 0; + double last_value_ = 0; + kernel::lmm::Variable* variable_ = nullptr; + + ActionHeap::Type type_ = ActionHeap::Type::unset; + boost::optional heap_hook_ = boost::none; public: - virtual void updateRemainingLazy(double now) = 0; - 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() { heap_handle_ = boost::none; } - kernel::lmm::Variable* getVariable() const { return variable_; } - void setVariable(kernel::lmm::Variable* var) { variable_ = var; } - 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_; } + 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_update() const { return last_update_; } + void set_last_update(); + + double get_last_value() const { return last_value_; } + void set_last_value(double val) { last_value_ = val; } protected: Action::SuspendStates suspended_ = Action::SuspendStates::not_suspended;