-/* Copyright (c) 2004-2021. The SimGrid Team. All rights reserved. */
+/* Copyright (c) 2004-2023. 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. */
#include <boost/heap/pairing_heap.hpp>
#include <boost/optional.hpp>
#include <string>
+#include <string_view>
static constexpr double NO_MAX_DURATION = -1.0;
-namespace simgrid {
-namespace kernel {
-namespace resource {
+namespace simgrid::kernel::resource {
using heap_element_type = std::pair<double, Action*>;
using heap_type =
double cost_;
Model* model_;
- void* data_ = nullptr; /**< for your convenience */
+ void* data_ = nullptr; /**< for your convenience - XBT_ATTRIB_DEPRECATED_v334 */
activity::ActivityImpl* activity_ = nullptr;
/* LMM */
+ double factor_ = 1.0; /**< Factor for effective rate = var->get_value() * factor_ */
double last_update_ = 0;
double last_value_ = 0;
lmm::Variable* variable_ = nullptr;
double get_finish_time() const { return finish_time_; }
/** @brief Get the user data associated to the current action */
- void* get_data() const { return data_; }
+ XBT_ATTRIB_DEPRECATED_v334("Please manifest if you actually need this function") void* get_data() const
+ {
+ return data_;
+ }
/** @brief Set the user data associated to the current action */
- void set_data(void* data) { data_ = data; }
+ XBT_ATTRIB_DEPRECATED_v334("Please manifest if you actually need this function") void set_data(void* data)
+ {
+ data_ = data;
+ }
/** @brief Get the user data associated to the current action */
activity::ActivityImpl* get_activity() const { return activity_; }
/** @brief Get the tracing category associated to the current action */
const std::string& get_category() const { return category_; }
/** @brief Set the tracing category of the current Action */
- void set_category(const std::string& category) { category_ = category; }
+ void set_category(std::string_view category) { category_ = category; }
/** @brief Get the sharing_penalty (RTT or 1/thread_count) of the current Action */
double get_sharing_penalty() const { return sharing_penalty_; };
double get_last_update() const { return last_update_; }
void set_last_update();
+ /**
+ * @brief Set a factor for this action
+ *
+ * Defines a multiplicative factor for the consumption of the underlying resource.
+ *
+ * @param factor Multiplicative factor for this action (e.g. 0.97)
+ */
+ void set_rate_factor(double factor) { factor_ = factor; }
+ /**
+ * @brief Get the effective consumption rate of the resource
+ *
+ * The rate is based on the sharing given by the maxmin system underneath.
+ * However, it depends on the factor defined for this action.
+ *
+ * So, the effective rate is equal to var->get_value() * factor_
+ */
+ double get_rate() const;
double get_last_value() const { return last_value_; }
void set_last_value(double val) { last_value_ = val; }
void set_suspend_state(Action::SuspendStates state) { suspended_ = state; }
};
-} // namespace resource
-} // namespace kernel
-} // namespace simgrid
+} // namespace simgrid::kernel::resource
#endif