src/kernel/activity/ActivityImpl.hpp

   1 /* Copyright (c) 2007-2022. 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 "simgrid/forward.h"
  13 #include <xbt/utility.hpp>
  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
  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);
  25
  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;
  33
  34 public:
  35   virtual ~ActivityImpl();
  36   ActivityImpl() = default;
  37   std::list<smx_simcall_t> simcalls_;   /* List of simcalls waiting for this activity */
  38   s4u::Activity* piface_         = nullptr;
  39   resource::Action* surf_action_ = nullptr;
  40
  41 protected:
  42   void inline set_name(const std::string& name)
  43   {
  44     // This is to keep name_ private while allowing ActivityImpl_T<??> to set it and then return a Ptr to qualified
  45     // child type
  46     name_ = name;
  47   }
  48   void set_start_time(double start_time) { start_time_ = start_time; }
  49
  50 public:
  51   const std::string& get_name() const { return name_; }
  52   const char* get_cname() const { return name_.c_str(); }
  53
  54   void set_actor(actor::ActorImpl* actor) { actor_ = actor; }
  55   actor::ActorImpl* get_actor() const { return actor_; }
  56
  57   void set_iface(s4u::Activity* iface) { piface_ = iface; }
  58   s4u::Activity* get_iface() { return piface_; }
  59
  60   void set_state(State state) { state_ = state; }
  61   const State& get_state() const { return state_; }
  62   const char* get_state_str() const;
  63
  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_; }
  67
  68   virtual bool test();
  69   virtual void wait_for(actor::ActorImpl* issuer, double timeout);
  70   virtual ActivityImpl& set_timeout(double) { THROW_UNIMPLEMENTED; }
  71
  72   virtual void suspend();
  73   virtual void resume();
  74   virtual void cancel();
  75
  76   virtual void post() = 0; // Called by the main loop when the activity is marked as terminated or failed by its model.
  77                            // Setups the status, clean things up, and call finish()
  78   virtual void set_exception(actor::ActorImpl* issuer) = 0; // Raising exceptions and stuff
  79   virtual void finish() = 0; // Unlock all simcalls blocked on that activity, either because it was marked as done by
  80                              // the model or because it terminated without waiting for the model
  81
  82   void register_simcall(smx_simcall_t simcall);
  83   void unregister_simcall(smx_simcall_t simcall);
  84   void clean_action();
  85   virtual double get_remaining() const;
  86   // Support for the boost::intrusive_ptr<ActivityImpl> datatype
  87   friend XBT_PUBLIC void intrusive_ptr_add_ref(ActivityImpl* activity);
  88   friend XBT_PUBLIC void intrusive_ptr_release(ActivityImpl* activity);
  89
  90   static xbt::signal<void(ActivityImpl const&)> on_suspended;
  91   static xbt::signal<void(ActivityImpl const&)> on_resumed;
  92 };
  93
  94 /* This class exists to allow chained setters as in exec->set_name()->set_priority()->set_blah()
  95  * The difficulty is that set_name() must return a qualified child class, not the generic ancestor
  96  * But the getter is still in the ancestor to be usable on generic activities with no downcast */
  97 template <class AnyActivityImpl> class ActivityImpl_T : public ActivityImpl {
  98   std::string tracing_category_ = "";
  99
 100 public:
 101   AnyActivityImpl& set_name(const std::string& name) /* Hides the function in the ancestor class */
 102   {
 103     ActivityImpl::set_name(name);
 104     return static_cast<AnyActivityImpl&>(*this);
 105   }
 106
 107   AnyActivityImpl& set_tracing_category(const std::string& category)
 108   {
 109     tracing_category_ = category;
 110     return static_cast<AnyActivityImpl&>(*this);
 111   }
 112   const std::string& get_tracing_category() const { return tracing_category_; }
 113 };
 114
 115 } // namespace activity
 116 } // namespace kernel
 117 } // namespace simgrid
 118
 119 #endif /* SIMGRID_KERNEL_ACTIVITY_ACTIVITYIMPL_HPP */