-/* Copyright (c) 2006-2021. The SimGrid Team. All rights reserved. */
+/* Copyright (c) 2006-2022. 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. */
* That is, activities are all the things that do take time to the actor in the simulated world.
*/
class XBT_PUBLIC Activity : public xbt::Extendable<Activity> {
+#ifndef DOXYGEN
friend Comm;
friend Exec;
friend Io;
-#ifndef DOXYGEN
+ friend kernel::activity::ActivityImpl;
friend std::vector<ActivityPtr> create_DAG_from_dot(const std::string& filename);
friend std::vector<ActivityPtr> create_DAG_from_DAX(const std::string& filename);
#endif
XBT_DECLARE_ENUM_CLASS(State, INITED, STARTING, STARTED, FAILED, CANCELED, FINISHED);
virtual bool is_assigned() const = 0;
- virtual bool dependencies_solved() const { return dependencies_.empty(); }
- virtual unsigned long is_waited_by() const { return successors_.size(); }
+ bool dependencies_solved() const { return dependencies_.empty(); }
+ bool has_no_successor() const { return successors_.empty(); }
const std::set<ActivityPtr>& get_dependencies() const { return dependencies_; }
const std::vector<ActivityPtr>& get_successors() const { return successors_; }
static std::set<Activity*>* vetoed_activities_;
+private:
+ static xbt::signal<void(Activity&)> on_veto;
+ static xbt::signal<void(Activity const&)> on_completion;
+ static xbt::signal<void(Activity const&)> on_suspended;
+ static xbt::signal<void(Activity const&)> on_resumed;
+
public:
- /*! Signal fired each time that the activity fails to start because of a veto (e.g., unsolved dependency or no
+ /*! Add a callback fired each time that the activity fails to start because of a veto (e.g., unsolved dependency or no
* resource assigned) */
- static xbt::signal<void(Activity&)> on_veto;
- /*! Signal fired when theactivity completes (either normally, cancelled or failed) */
- static xbt::signal<void(Activity&)> on_completion;
+ static void on_veto_cb(const std::function<void(Activity&)>& cb) { on_veto.connect(cb); }
+ /*! Add a callback fired when the activity completes (either normally, cancelled or failed) */
+ static void on_completion_cb(const std::function<void(Activity const&)>& cb) { on_completion.connect(cb); }
+ /*! Add a callback fired when the activity is suspended */
+ static void on_suspended_cb(const std::function<void(Activity const&)>& cb) { on_suspended.connect(cb); }
+ /*! Add a callback fired when the activity is resumed after being suspended */
+ static void on_resumed_cb(const std::function<void(Activity const&)>& cb) { on_resumed.connect(cb); }
void vetoable_start()
{
* This function is optional: you can call wait() even if you didn't call start()
*/
virtual Activity* start() = 0;
+ /** Tests whether the given activity is terminated yet. */
+ virtual bool test();
+ /*! take a vector s4u::ActivityPtr and return the rank of the first finished one (or -1 if none is done). */
+ static ssize_t test_any(const std::vector<ActivityPtr>& activities);
+
/** Blocks the current actor until the activity is terminated */
Activity* wait() { return wait_for(-1.0); }
/** Blocks the current actor until the activity is terminated, or until the timeout is elapsed\n
/** Blocks the current actor until the activity is terminated, or until the time limit is reached\n
* Raises: timeout exception. */
void wait_until(double time_limit);
+ /*! take a vector of s4u::ActivityPtr and return when one of them is finished.
+ * The return value is the rank of the first finished ActivityPtr. */
+ static ssize_t wait_any(const std::vector<ActivityPtr>& activities) { return wait_any_for(activities, -1); }
+ /*! Same as wait_any, but with a timeout. If the timeout occurs, parameter last is returned.*/
+ static ssize_t wait_any_for(const std::vector<ActivityPtr>& activities, double timeout);
/** Cancel that activity */
Activity* cancel();
/** Return a string representation of the activity's state (one of INITED, STARTING, STARTED, CANCELED, FINISHED) */
const char* get_state_str() const;
void set_state(Activity::State state) { state_ = state; }
- /** Tests whether the given activity is terminated yet. */
- virtual bool test();
/** Blocks the progression of this activity until it gets resumed */
virtual Activity* suspend();
template <class AnyActivity> class Activity_T : public Activity {
std::string name_ = "unnamed";
std::string tracing_category_ = "";
- void* user_data_ = nullptr;
public:
AnyActivity* add_successor(ActivityPtr a)
}
AnyActivity* set_name(const std::string& name)
{
- xbt_assert(get_state() == State::INITED, "Cannot change the name of an activity after its start");
name_ = name;
return static_cast<AnyActivity*>(this);
}
}
const std::string& get_tracing_category() const { return tracing_category_; }
- AnyActivity* set_user_data(void* data)
+ XBT_ATTRIB_DEPRECATED_v334("Please use Activity::set_data()") AnyActivity* set_user_data(void* data)
{
- user_data_ = data;
+ set_data(data);
return static_cast<AnyActivity*>(this);
}
- void* get_user_data() const { return user_data_; }
+ XBT_ATTRIB_DEPRECATED_v334("Please use Activity::get_data<>()") void* get_user_data() const
+ {
+ return get_data<void>();
+ }
AnyActivity* vetoable_start()
{
