src/kernel/activity/ActivityImpl.hpp

   1 /* Copyright (c) 2007-2019. 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
  23 class XBT_PUBLIC ActivityImpl {
  24   std::atomic_int_fast32_t refcount_{0};
  25 public:
  26   virtual ~ActivityImpl();
  27   ActivityImpl() = default;
  28   e_smx_state_t state_ = SIMIX_WAITING; /* State of the activity */
  29   std::list<smx_simcall_t> simcalls_;   /* List of simcalls waiting for this activity */
  30   resource::Action* surf_action_ = nullptr;
  31
  32   virtual void suspend();
  33   virtual void resume();
  34   virtual void cancel();
  35
  36   virtual void post() = 0; // Called by the main loop when the activity is marked as terminated or failed by its model.
  37                            // Setups the status, clean things up, and call finish()
  38   virtual void finish() = 0; // Unlock all simcalls blocked on that activity, either because it was marked as done by
  39                              // the model or because it terminated without waiting for the model
  40
  41   virtual void register_simcall(smx_simcall_t simcall);
  42   void clean_action();
  43   virtual double get_remaining() const;
  44   // boost::intrusive_ptr<ActivityImpl> support:
  45   friend XBT_PUBLIC void intrusive_ptr_add_ref(ActivityImpl* activity);
  46   friend XBT_PUBLIC void intrusive_ptr_release(ActivityImpl* activity);
  47
  48   static xbt::signal<void(ActivityImpl const&)> on_suspended;
  49   static xbt::signal<void(ActivityImpl const&)> on_resumed;
  50 };
  51
  52 template <class AnyActivityImpl> class ActivityImpl_T : public ActivityImpl {
  53 private:
  54   std::string name_             = "";
  55   std::string tracing_category_ = "";
  56
  57 public:
  58   AnyActivityImpl& set_name(const std::string& name)
  59   {
  60     name_ = name;
  61     return static_cast<AnyActivityImpl&>(*this);
  62   }
  63   const std::string& get_name() { return name_; }
  64   const char* get_cname() { return name_.c_str(); }
  65
  66   AnyActivityImpl& set_tracing_category(const std::string& category)
  67   {
  68     tracing_category_ = category;
  69     return static_cast<AnyActivityImpl&>(*this);
  70   }
  71   const std::string& get_tracing_category() { return tracing_category_; }
  72 };
  73
  74 } // namespace activity
  75 } // namespace kernel
  76 } // namespace simgrid
  77
  78 #endif /* SIMGRID_KERNEL_ACTIVITY_ACTIVITYIMPL_HPP */