-/* Copyright (c) 2006-2017. The SimGrid Team. All rights reserved. */
+/* Copyright (c) 2006-2020. 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. */
#ifndef SIMGRID_S4U_ACTIVITY_HPP
#define SIMGRID_S4U_ACTIVITY_HPP
-#include <simgrid/s4u/forward.hpp>
+#include "xbt/asserts.h"
+#include <atomic>
+#include <set>
#include <simgrid/forward.h>
+#include <string>
+#include <vector>
+#include <xbt/log.hpp>
+#include <xbt/signal.hpp>
-enum e_s4u_activity_state_t { inited = 0, started, canceled, errored, finished };
+XBT_LOG_EXTERNAL_CATEGORY(s4u_activity);
namespace simgrid {
namespace s4u {
/** @brief Activities
*
- * This class is the ancestor of every activities that an actor can undertake, that is, of the actions that do take time in the simulated world.
+ * This class is the ancestor of every activities that an actor can undertake.
+ * That is, activities are all the things that do take time to the actor in the simulated world.
*/
-XBT_PUBLIC_CLASS Activity {
+class XBT_PUBLIC Activity {
friend Comm;
- friend void intrusive_ptr_release(Comm * c);
- friend void intrusive_ptr_add_ref(Comm * c);
+ friend XBT_PUBLIC void intrusive_ptr_release(Comm * c);
+ friend XBT_PUBLIC void intrusive_ptr_add_ref(Comm * c);
+
+ friend Exec;
+ friend ExecSeq;
+ friend ExecPar;
+ friend XBT_PUBLIC void intrusive_ptr_release(Exec * e);
+ friend XBT_PUBLIC void intrusive_ptr_add_ref(Exec * e);
+
+ friend Io;
+ friend XBT_PUBLIC void intrusive_ptr_release(Io* i);
+ friend XBT_PUBLIC void intrusive_ptr_add_ref(Io* i);
protected:
Activity() = default;
virtual ~Activity() = default;
-
public:
+#ifndef DOXYGEN
Activity(Activity const&) = delete;
Activity& operator=(Activity const&) = delete;
+#endif
+
+ enum class State { INITED = 0, STARTING, STARTED, CANCELED, ERRORED, FINISHED };
/** Starts a previously created activity.
*
* This function is optional: you can call wait() even if you didn't call start()
*/
- virtual void start()=0;
- /** Tests whether the given activity is terminated yet. This is a pure function. */
- //virtual bool test()=0;
+ virtual Activity* start() = 0;
/** Blocks until the activity is terminated */
- virtual void wait()=0;
+ virtual Activity* wait() = 0;
/** Blocks until the activity is terminated, or until the timeout is elapsed
* Raises: timeout exception.*/
- virtual void wait(double timeout)=0;
+ virtual Activity* wait_for(double timeout) = 0;
+ /** Blocks until the activity is terminated, or until the time limit is reached
+ * Raises: timeout exception. */
+ void wait_until(double time_limit);
+
/** Cancel that activity */
- //virtual void cancel();
+ virtual Activity* cancel() = 0;
/** Retrieve the current state of the activity */
- e_s4u_activity_state_t getState() {return state_;}
+ Activity::State get_state() { return state_; }
+ void set_state(Activity::State state) { state_ = state; }
+ /** Tests whether the given activity is terminated yet. This is a pure function. */
+ virtual bool test() = 0;
/** Get the remaining amount of work that this Activity entails. When it's 0, it's done. */
- double getRemains();
+ virtual double get_remaining();
+
/** Set the [remaining] amount of work that this Activity will entail
*
* It is forbidden to change the amount of work once the Activity is started */
- void setRemains(double remains);
+ Activity* set_remaining(double remains);
- /** Put some user data onto the Activity */
- void setUserData(void *data) {userData_=data;}
- /** Retrieve the user data of the Activity */
- void *getUserData() { return userData_; }
+ /** Returns the internal implementation of this Activity */
+ kernel::activity::ActivityImpl* get_impl() const { return pimpl_.get(); }
+
+private:
+ kernel::activity::ActivityImplPtr pimpl_ = nullptr;
+ Activity::State state_ = Activity::State::INITED;
+ double remains_ = 0;
+};
+template <class AnyActivity> class Activity_T : public Activity {
private:
- simgrid::kernel::activity::ActivityImplPtr pimpl_ = nullptr;
- e_s4u_activity_state_t state_ = inited;
- double remains_ = 0;
- void *userData_ = nullptr;
-}; // class
+ std::string name_ = "unnamed";
+ std::string tracing_category_ = "";
+ void* user_data_ = nullptr;
+ std::atomic_int_fast32_t refcount_{0};
+ std::vector<AnyActivity*> successors_;
+ std::set<AnyActivity*> dependencies_;
+
+public:
+#ifndef DOXYGEN
+ friend void intrusive_ptr_release(AnyActivity* a)
+ {
+ if (a->refcount_.fetch_sub(1, std::memory_order_release) == 1) {
+ std::atomic_thread_fence(std::memory_order_acquire);
+ delete a;
+ }
+ }
+ friend void intrusive_ptr_add_ref(AnyActivity* a) { a->refcount_.fetch_add(1, std::memory_order_relaxed); }
+#endif
+
+ void add_successor(AnyActivity* a)
+ {
+ successors_.push_back(a);
+ a->add_dependency_on(static_cast<AnyActivity*>(this));
+ }
+ void remove_successor() { successors_.pop_back(); }
+ AnyActivity* get_successor() { return successors_.back(); }
+ bool has_successors() { return not successors_.empty(); }
+
+ void add_dependency_on(AnyActivity* a) { dependencies_.insert({a}); }
+ void remove_dependency_on(AnyActivity* a) { dependencies_.erase(a); }
+ bool has_dependencies() { return not dependencies_.empty(); }
+ void release_dependencies()
+ {
+ while (has_successors()) {
+ AnyActivity* b = get_successor();
+ XBT_CDEBUG(s4u_activity, "Remove a dependency from '%s' on '%s'", get_cname(), b->get_cname());
+ b->remove_dependency_on(static_cast<AnyActivity*>(this));
+ if (not b->has_dependencies()) {
+ b->vetoable_start();
+ }
+ remove_successor();
+ }
+ }
+
+ AnyActivity* vetoable_start()
+ {
+ set_state(State::STARTING);
+ if (has_dependencies())
+ return static_cast<AnyActivity*>(this);
+ set_state(State::STARTED);
+ XBT_CDEBUG(s4u_activity, "All dependencies are solved, let's start '%s'", get_cname());
+ static_cast<AnyActivity*>(this)->start();
+ return static_cast<AnyActivity*>(this);
+ }
+
+ 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_name() { return name_; }
+ const char* get_cname() { return name_.c_str(); }
+
+ AnyActivity* set_tracing_category(const std::string& category)
+ {
+ xbt_assert(get_state() == State::INITED, "Cannot change the tracing category of an activity after its start");
+ tracing_category_ = category;
+ return static_cast<AnyActivity*>(this);
+ }
+ const std::string& get_tracing_category() { return tracing_category_; }
+
+ AnyActivity* set_user_data(void* data)
+ {
+ user_data_ = data;
+ return static_cast<AnyActivity*>(this);
+ }
+
+ void* get_user_data() { return user_data_; }
+};
-}}; // Namespace simgrid::s4u
+} // namespace s4u
+} // namespace simgrid
#endif /* SIMGRID_S4U_ACTIVITY_HPP */
