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