1 /* Copyright (c) 2007-2021. 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_ = "";
31 virtual ~ActivityImpl();
32 ActivityImpl() = default;
33 State state_ = State::WAITING; /* State of the activity */
34 std::list<smx_simcall_t> simcalls_; /* List of simcalls waiting for this activity */
35 resource::Action* surf_action_ = nullptr;
36 actor::ActorImpl* actor_ = nullptr;
37 s4u::Activity* piface_ = nullptr;
38 double start_time_ = -1.0;
39 double finish_time_ = -1.0;
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
50 const std::string& get_name() const { return name_; }
51 const char* get_cname() const { return name_.c_str(); }
53 void set_actor(actor::ActorImpl* actor) { actor_ = actor; }
54 actor::ActorImpl* get_actor() const { return actor_; }
56 void set_iface(s4u::Activity* iface) { piface_ = iface; }
57 s4u::Activity* get_iface() { return piface_; }
59 double get_start_time() const { return start_time_; }
60 void set_finish_time(double finish_time) { finish_time_ = finish_time; }
61 double get_finish_time() const { return finish_time_; }
64 virtual void wait_for(actor::ActorImpl* issuer, double timeout);
65 virtual ActivityImpl& set_timeout(double) { THROW_UNIMPLEMENTED; }
67 virtual void suspend();
68 virtual void resume();
69 virtual void cancel();
71 virtual void post() = 0; // Called by the main loop when the activity is marked as terminated or failed by its model.
72 // Setups the status, clean things up, and call finish()
73 virtual void set_exception(actor::ActorImpl* issuer) = 0; // Raising exceptions and stuff
74 virtual void finish() = 0; // Unlock all simcalls blocked on that activity, either because it was marked as done by
75 // the model or because it terminated without waiting for the model
77 void register_simcall(smx_simcall_t simcall);
78 void unregister_simcall(smx_simcall_t simcall);
80 virtual double get_remaining() const;
81 const char* get_state_str() const;
82 // Support for the boost::intrusive_ptr<ActivityImpl> datatype
83 friend XBT_PUBLIC void intrusive_ptr_add_ref(ActivityImpl* activity);
84 friend XBT_PUBLIC void intrusive_ptr_release(ActivityImpl* activity);
86 static xbt::signal<void(ActivityImpl const&)> on_suspended;
87 static xbt::signal<void(ActivityImpl const&)> on_resumed;
90 /* This class exists to allow chained setters as in exec->set_name()->set_priority()->set_blah()
91 * The difficulty is that set_name() must return a qualified child class, not the generic ancestor
92 * But the getter is still in the ancestor to be usable on generic activities with no downcast */
93 template <class AnyActivityImpl> class ActivityImpl_T : public ActivityImpl {
95 std::string tracing_category_ = "";
98 AnyActivityImpl& set_name(const std::string& name) /* Hides the function in the ancestor class */
100 ActivityImpl::set_name(name);
101 return static_cast<AnyActivityImpl&>(*this);
104 AnyActivityImpl& set_tracing_category(const std::string& category)
106 tracing_category_ = category;
107 return static_cast<AnyActivityImpl&>(*this);
109 const std::string& get_tracing_category() const { return tracing_category_; }
112 } // namespace activity
113 } // namespace kernel
114 } // namespace simgrid
116 #endif /* SIMGRID_KERNEL_ACTIVITY_ACTIVITYIMPL_HPP */