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;
38 void inline set_name(const std::string& name)
40 // This is to keep name_ private while allowing ActivityImpl_T<??> to set it and then return a Ptr to qualified
46 const std::string& get_name() const { return name_; }
47 const char* get_cname() const { return name_.c_str(); }
50 virtual void wait_for(actor::ActorImpl* issuer, double timeout);
51 virtual ActivityImpl& set_timeout(double) { THROW_UNIMPLEMENTED; }
53 virtual void suspend();
54 virtual void resume();
55 virtual void cancel();
57 virtual void post() = 0; // Called by the main loop when the activity is marked as terminated or failed by its model.
58 // Setups the status, clean things up, and call finish()
59 virtual void set_exception(actor::ActorImpl* issuer) = 0; // Raising exceptions and stuff
60 virtual void finish() = 0; // Unlock all simcalls blocked on that activity, either because it was marked as done by
61 // the model or because it terminated without waiting for the model
63 void register_simcall(smx_simcall_t simcall);
64 void unregister_simcall(smx_simcall_t simcall);
66 virtual double get_remaining() const;
67 const char* get_state_str() const;
68 // Support for the boost::intrusive_ptr<ActivityImpl> datatype
69 friend XBT_PUBLIC void intrusive_ptr_add_ref(ActivityImpl* activity);
70 friend XBT_PUBLIC void intrusive_ptr_release(ActivityImpl* activity);
72 static xbt::signal<void(ActivityImpl const&)> on_suspended;
73 static xbt::signal<void(ActivityImpl const&)> on_resumed;
76 /* This class exists to allow chained setters as in exec->set_name()->set_priority()->set_blah()
77 * The difficulty is that set_name() must return a qualified child class, not the generic ancestor
78 * But the getter is still in the ancestor to be usable on generic activities with no downcast */
79 template <class AnyActivityImpl> class ActivityImpl_T : public ActivityImpl {
81 std::string tracing_category_ = "";
84 AnyActivityImpl& set_name(const std::string& name) /* Hides the function in the ancestor class */
86 ActivityImpl::set_name(name);
87 return static_cast<AnyActivityImpl&>(*this);
90 AnyActivityImpl& set_tracing_category(const std::string& category)
92 tracing_category_ = category;
93 return static_cast<AnyActivityImpl&>(*this);
95 const std::string& get_tracing_category() const { return tracing_category_; }
98 } // namespace activity
100 } // namespace simgrid
102 #endif /* SIMGRID_KERNEL_ACTIVITY_ACTIVITYIMPL_HPP */