-/* Copyright (c) 2006-2020. The SimGrid Team. All rights reserved. */
+/* Copyright (c) 2006-2021. 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. */
#define SIMGRID_S4U_ACTIVITY_HPP
#include "xbt/asserts.h"
+#include <algorithm>
#include <atomic>
#include <set>
#include <simgrid/forward.h>
#include <string>
#include <vector>
#include <xbt/signal.hpp>
+#include <xbt/utility.hpp>
XBT_LOG_EXTERNAL_CATEGORY(s4u_activity);
class XBT_PUBLIC Activity {
friend Comm;
friend Exec;
- friend ExecSeq;
- friend ExecPar;
friend Io;
protected:
Activity() = default;
virtual ~Activity() = default;
+ virtual bool is_assigned() const = 0;
+
void release_dependencies()
{
while (not successors_.empty()) {
ActivityPtr b = successors_.back();
- XBT_CDEBUG(s4u_activity, "Remove a dependency from '%s' on '%s'", get_cname(), b->get_cname());
+ XBT_CVERB(s4u_activity, "Remove a dependency from '%s' on '%s'", get_cname(), b->get_cname());
b->dependencies_.erase(this);
if (b->dependencies_.empty()) {
b->vetoable_start();
void add_successor(ActivityPtr a)
{
+ if(this == a)
+ throw std::invalid_argument("Cannot be its own successor");
+ auto p = std::find_if(successors_.begin(), successors_.end(), [a](ActivityPtr const& i){ return i.get() == a.get(); });
+ if (p != successors_.end())
+ throw std::invalid_argument("Dependency already exists");
+
successors_.push_back(a);
a->dependencies_.insert({this});
}
+ void remove_successor(ActivityPtr a)
+ {
+ if(this == a)
+ throw std::invalid_argument("Cannot ask to remove its from successors");
+
+ auto p = std::find_if(successors_.begin(), successors_.end(), [a](ActivityPtr const& i){ return i.get() == a.get(); });
+ if (p != successors_.end()){
+ successors_.erase(p);
+ a->dependencies_.erase({this});
+ } else
+ throw std::invalid_argument("Dependency does not exist. Can not be removed.");
+
+ }
+
public:
void vetoable_start()
{
state_ = State::STARTING;
- if (dependencies_.empty()) {
- XBT_CDEBUG(s4u_activity, "All dependencies are solved, let's start '%s'", get_cname());
+ if (dependencies_.empty() && is_assigned()) {
+ XBT_CVERB(s4u_activity, "'%s' is assigned to a resource and all dependencies are solved. Let's start", get_cname());
start();
}
}
Activity& operator=(Activity const&) = delete;
#endif
- enum class State { INITED = 0, STARTING, STARTED, CANCELED, ERRORED, FINISHED };
+ // enum class State { ... }
+ XBT_DECLARE_ENUM_CLASS(State, INITED, STARTING, STARTED, CANCELED, FINISHED);
/** Starts a previously created activity.
*
* This function is optional: you can call wait() even if you didn't call start()
*/
virtual Activity* start() = 0;
- /** Blocks until the activity is terminated */
+ /** Blocks the current actor until the activity is terminated */
virtual Activity* wait() = 0;
- /** Blocks until the activity is terminated, or until the timeout is elapsed
+ /** Blocks the current actor until the activity is terminated, or until the timeout is elapsed\n
* Raises: timeout exception.*/
virtual Activity* wait_for(double timeout) = 0;
- /** Blocks until the activity is terminated, or until the time limit is reached
+ /** 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);
/** Cancel that activity */
virtual Activity* cancel() = 0;
/** Retrieve the current state of the activity */
- Activity::State get_state() { return state_; }
+ Activity::State get_state() const { return state_; }
+ /** 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. This is a pure function. */
- virtual bool test() = 0;
- virtual const char* get_cname() = 0;
- virtual const std::string& get_name() = 0;
+ /** Tests whether the given activity is terminated yet. */
+ virtual bool test();
+
+ /** Blocks the progression of this activity until it gets resumed */
+ virtual Activity* suspend();
+ /** Unblock the progression of this activity if it was suspended previously */
+ virtual Activity* resume();
+ /** Whether or not the progression of this activity is blocked */
+ bool is_suspended() const { return suspended_; }
+
+ virtual const char* get_cname() const = 0;
+ virtual const std::string& get_name() const = 0;
/** Get the remaining amount of work that this Activity entails. When it's 0, it's done. */
- virtual double get_remaining();
+ virtual double get_remaining() const;
/** 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 */
}
friend void intrusive_ptr_add_ref(Activity* a) { a->refcount_.fetch_add(1, std::memory_order_relaxed); }
#endif
+ Activity* add_ref()
+ {
+ intrusive_ptr_add_ref(this);
+ return this;
+ }
+ void unref() { intrusive_ptr_release(this); }
+
private:
kernel::activity::ActivityImplPtr pimpl_ = nullptr;
Activity::State state_ = Activity::State::INITED;
double remains_ = 0;
+ bool suspended_ = false;
std::vector<ActivityPtr> successors_;
std::set<ActivityPtr> dependencies_;
std::atomic_int_fast32_t refcount_{0};
Activity::add_successor(a);
return static_cast<AnyActivity*>(this);
}
-
+ AnyActivity* remove_successor(ActivityPtr a)
+ {
+ Activity::remove_successor(a);
+ 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(); }
+ const std::string& get_name() const override { return name_; }
+ const char* get_cname() const override { return name_.c_str(); }
AnyActivity* set_tracing_category(const std::string& category)
{
tracing_category_ = category;
return static_cast<AnyActivity*>(this);
}
- const std::string& get_tracing_category() { return tracing_category_; }
+ const std::string& get_tracing_category() const { return tracing_category_; }
AnyActivity* set_user_data(void* data)
{
return static_cast<AnyActivity*>(this);
}
- void* get_user_data() { return user_data_; }
+ void* get_user_data() const { return user_data_; }
+
+ AnyActivity* vetoable_start()
+ {
+ Activity::vetoable_start();
+ return static_cast<AnyActivity*>(this);
+ }
#ifndef DOXYGEN
/* The refcounting is done in the ancestor class, Activity, but we want each of the classes benefiting of the CRTP
* (Exec, Comm, etc) to have smart pointers too, so we define these methods here, that forward the ptr_release and
