Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Misc issues in shell scripts (codefator.io).
[simgrid.git] / src / kernel / activity / ActivityImpl.hpp
1 /* Copyright (c) 2007-2020. The SimGrid Team. All rights reserved.          */
2
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. */
5
6 #ifndef SIMGRID_KERNEL_ACTIVITY_ACTIVITYIMPL_HPP
7 #define SIMGRID_KERNEL_ACTIVITY_ACTIVITYIMPL_HPP
8
9 #include <string>
10 #include <list>
11
12 #include <xbt/base.h>
13 #include "simgrid/forward.h"
14
15 #include <atomic>
16 #include <simgrid/kernel/resource/Action.hpp>
17 #include <simgrid/simix.hpp>
18
19 namespace simgrid {
20 namespace kernel {
21 namespace activity {
22 enum class State {
23   WAITING = 0,
24   READY,
25   RUNNING,
26   DONE,
27   CANCELED,
28   FAILED,
29   SRC_HOST_FAILURE,
30   DST_HOST_FAILURE,
31   TIMEOUT,
32   SRC_TIMEOUT,
33   DST_TIMEOUT,
34   LINK_FAILURE
35 };
36
37 class XBT_PUBLIC ActivityImpl {
38   std::atomic_int_fast32_t refcount_{0};
39   std::string name_ = "";
40
41 public:
42   virtual ~ActivityImpl();
43   ActivityImpl() = default;
44   State state_   = State::WAITING;      /* State of the activity */
45   std::list<smx_simcall_t> simcalls_;   /* List of simcalls waiting for this activity */
46   resource::Action* surf_action_ = nullptr;
47
48 protected:
49   void inline set_name(const std::string& name)
50   {
51     // This is to keep name_ private while allowing ActivityImpl_T<??> to set it and then return a Ptr to qualified
52     // child type
53     name_ = name;
54   }
55
56 public:
57   const std::string& get_name() { return name_; }
58   const char* get_cname() { return name_.c_str(); }
59
60   bool test();
61   void wait_for(actor::ActorImpl* issuer, double timeout);
62   virtual ActivityImpl& set_timeout(double) { THROW_UNIMPLEMENTED; }
63
64   virtual void suspend();
65   virtual void resume();
66   virtual void cancel();
67
68   virtual void post() = 0; // Called by the main loop when the activity is marked as terminated or failed by its model.
69                            // Setups the status, clean things up, and call finish()
70   virtual void finish() = 0; // Unlock all simcalls blocked on that activity, either because it was marked as done by
71                              // the model or because it terminated without waiting for the model
72
73   virtual void register_simcall(smx_simcall_t simcall);
74   void clean_action();
75   virtual double get_remaining() const;
76   // Support for the boost::intrusive_ptr<ActivityImpl> datatype
77   friend XBT_PUBLIC void intrusive_ptr_add_ref(ActivityImpl* activity);
78   friend XBT_PUBLIC void intrusive_ptr_release(ActivityImpl* activity);
79
80   static xbt::signal<void(ActivityImpl const&)> on_suspended;
81   static xbt::signal<void(ActivityImpl const&)> on_resumed;
82 };
83
84 /* This class exists to allow chained setters as in exec->set_name()->set_priority()->set_blah()
85  * The difficulty is that set_name() must return a qualified child class, not the generic ancestor
86  * But the getter is still in the ancestor to be usable on generic activities with no downcast */
87 template <class AnyActivityImpl> class ActivityImpl_T : public ActivityImpl {
88 private:
89   std::string tracing_category_ = "";
90
91 public:
92   AnyActivityImpl& set_name(const std::string& name) /* Hides the function in the ancestor class */
93   {
94     ActivityImpl::set_name(name);
95     return static_cast<AnyActivityImpl&>(*this);
96   }
97
98   AnyActivityImpl& set_tracing_category(const std::string& category)
99   {
100     tracing_category_ = category;
101     return static_cast<AnyActivityImpl&>(*this);
102   }
103   const std::string& get_tracing_category() { return tracing_category_; }
104 };
105
106 } // namespace activity
107 } // namespace kernel
108 } // namespace simgrid
109
110 #endif /* SIMGRID_KERNEL_ACTIVITY_ACTIVITYIMPL_HPP */