src/kernel/activity/ActivityImpl.hpp

   1 /* Copyright (c) 2007-2021. 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
  30 public:
  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
  37 protected:
  38   void inline set_name(const std::string& name)
  39   {
  40     // This is to keep name_ private while allowing ActivityImpl_T<??> to set it and then return a Ptr to qualified
  41     // child type
  42     name_ = name;
  43   }
  44
  45 public:
  46   const std::string& get_name() const { return name_; }
  47   const char* get_cname() const { return name_.c_str(); }
  48
  49   virtual bool test();
  50   virtual void wait_for(actor::ActorImpl* issuer, double timeout);
  51   virtual ActivityImpl& set_timeout(double) { THROW_UNIMPLEMENTED; }
  52
  53   virtual void suspend();
  54   virtual void resume();
  55   virtual void cancel();
  56
  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 finish() = 0; // Unlock all simcalls blocked on that activity, either because it was marked as done by
  60                              // the model or because it terminated without waiting for the model
  61
  62   void register_simcall(smx_simcall_t simcall);
  63   void unregister_simcall(smx_simcall_t simcall);
  64   void clean_action();
  65   virtual double get_remaining() const;
  66   const char* get_state_str() const;
  67   // Support for the boost::intrusive_ptr<ActivityImpl> datatype
  68   friend XBT_PUBLIC void intrusive_ptr_add_ref(ActivityImpl* activity);
  69   friend XBT_PUBLIC void intrusive_ptr_release(ActivityImpl* activity);
  70
  71   static xbt::signal<void(ActivityImpl const&)> on_suspended;
  72   static xbt::signal<void(ActivityImpl const&)> on_resumed;
  73 };
  74
  75 /* This class exists to allow chained setters as in exec->set_name()->set_priority()->set_blah()
  76  * The difficulty is that set_name() must return a qualified child class, not the generic ancestor
  77  * But the getter is still in the ancestor to be usable on generic activities with no downcast */
  78 template <class AnyActivityImpl> class ActivityImpl_T : public ActivityImpl {
  79 private:
  80   std::string tracing_category_ = "";
  81
  82 public:
  83   AnyActivityImpl& set_name(const std::string& name) /* Hides the function in the ancestor class */
  84   {
  85     ActivityImpl::set_name(name);
  86     return static_cast<AnyActivityImpl&>(*this);
  87   }
  88
  89   AnyActivityImpl& set_tracing_category(const std::string& category)
  90   {
  91     tracing_category_ = category;
  92     return static_cast<AnyActivityImpl&>(*this);
  93   }
  94   const std::string& get_tracing_category() const { return tracing_category_; }
  95 };
  96
  97 } // namespace activity
  98 } // namespace kernel
  99 } // namespace simgrid
 100
 101 #endif /* SIMGRID_KERNEL_ACTIVITY_ACTIVITYIMPL_HPP */