1 /* Copyright (c) 2007-2022. The SimGrid Team. All rights reserved. */
3 /* This program is free software; you can redistribute it and/or modify it
4 * under the terms of the license (GNU LGPL) which comes with this package. */
6 #ifndef SIMGRID_KERNEL_ACTIVITY_ACTIVITYIMPL_HPP
7 #define SIMGRID_KERNEL_ACTIVITY_ACTIVITYIMPL_HPP
12 #include "simgrid/forward.h"
13 #include <xbt/utility.hpp>
16 #include <simgrid/kernel/resource/Action.hpp>
17 #include <simgrid/simix.hpp>
23 XBT_DECLARE_ENUM_CLASS(State, WAITING, READY, RUNNING, DONE, CANCELED, FAILED, SRC_HOST_FAILURE, DST_HOST_FAILURE,
24 TIMEOUT, SRC_TIMEOUT, DST_TIMEOUT, LINK_FAILURE);
26 class XBT_PUBLIC ActivityImpl {
27 std::atomic_int_fast32_t refcount_{0};
28 std::string name_ = "";
29 actor::ActorImpl* actor_ = nullptr;
30 State state_ = State::WAITING; /* State of the activity */
31 double start_time_ = -1.0;
32 double finish_time_ = -1.0;
35 virtual ~ActivityImpl();
36 ActivityImpl() = default;
37 std::list<actor::Simcall*> simcalls_; /* List of simcalls waiting for this activity */
38 s4u::Activity* piface_ = nullptr;
39 resource::Action* surf_action_ = nullptr;
42 void inline set_name(const std::string& name)
44 // This is to keep name_ private while allowing ActivityImpl_T<??> to set it and then return a Ptr to qualified
48 void set_start_time(double start_time) { start_time_ = start_time; }
51 const std::string& get_name() const { return name_; }
52 const char* get_cname() const { return name_.c_str(); }
54 void set_actor(actor::ActorImpl* actor) { actor_ = actor; }
55 actor::ActorImpl* get_actor() const { return actor_; }
57 void set_iface(s4u::Activity* iface) { piface_ = iface; }
58 s4u::Activity* get_iface() { return piface_; }
60 void set_state(State state) { state_ = state; }
61 const State& get_state() const { return state_; }
62 const char* get_state_str() const;
64 double get_start_time() const { return start_time_; }
65 void set_finish_time(double finish_time) { finish_time_ = finish_time; }
66 double get_finish_time() const { return finish_time_; }
68 virtual bool test(actor::ActorImpl* issuer);
69 static ssize_t test_any(actor::ActorImpl* issuer, const std::vector<ActivityImpl*>& activities);
71 virtual void wait_for(actor::ActorImpl* issuer, double timeout);
72 static void wait_any_for(actor::ActorImpl* issuer, const std::vector<ActivityImpl*>& activities, double timeout);
73 virtual ActivityImpl& set_timeout(double) { THROW_UNIMPLEMENTED; }
75 virtual void suspend();
76 virtual void resume();
77 virtual void cancel();
79 virtual void post() = 0; // Called by the main loop when the activity is marked as terminated or failed by its model.
80 // Setups the status, clean things up, and call finish()
81 virtual void set_exception(actor::ActorImpl* issuer) = 0; // Raising exceptions and stuff
82 virtual void finish() = 0; // Unlock all simcalls blocked on that activity, either because it was marked as done by
83 // the model or because it terminated without waiting for the model
85 void register_simcall(actor::Simcall* simcall);
86 void unregister_simcall(actor::Simcall* simcall);
87 void handle_activity_waitany(actor::Simcall* simcall);
89 virtual double get_remaining() const;
90 // Support for the boost::intrusive_ptr<ActivityImpl> datatype
91 friend XBT_PUBLIC void intrusive_ptr_add_ref(ActivityImpl* activity);
92 friend XBT_PUBLIC void intrusive_ptr_release(ActivityImpl* activity);
93 int get_refcount() const { return static_cast<int>(refcount_); } // For debugging purpose
96 /* This class exists to allow chained setters as in exec->set_name()->set_priority()->set_blah()
97 * The difficulty is that set_name() must return a qualified child class, not the generic ancestor
98 * But the getter is still in the ancestor to be usable on generic activities with no downcast */
99 template <class AnyActivityImpl> class ActivityImpl_T : public ActivityImpl {
100 std::string tracing_category_ = "";
103 AnyActivityImpl& set_name(const std::string& name) /* Hides the function in the ancestor class */
105 ActivityImpl::set_name(name);
106 return static_cast<AnyActivityImpl&>(*this);
109 AnyActivityImpl& set_tracing_category(const std::string& category)
111 tracing_category_ = category;
112 return static_cast<AnyActivityImpl&>(*this);
114 const std::string& get_tracing_category() const { return tracing_category_; }
117 } // namespace activity
118 } // namespace kernel
119 } // namespace simgrid
121 #endif /* SIMGRID_KERNEL_ACTIVITY_ACTIVITYIMPL_HPP */