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
  40 public:
  41   virtual ~ActivityImpl();
  42   ActivityImpl() = default;
  43   State state_   = State::WAITING;      /* State of the activity */
  44   std::list<smx_simcall_t> simcalls_;   /* List of simcalls waiting for this activity */
  45   resource::Action* surf_action_ = nullptr;
  46
  47   bool test();
  48   void wait_for(actor::ActorImpl* issuer, double timeout);
  49   virtual ActivityImpl& set_timeout(double) { THROW_UNIMPLEMENTED; }
  50
  51   virtual void suspend();
  52   virtual void resume();
  53   virtual void cancel();
  54
  55   virtual void post() = 0; // Called by the main loop when the activity is marked as terminated or failed by its model.
  56                            // Setups the status, clean things up, and call finish()
  57   virtual void finish() = 0; // Unlock all simcalls blocked on that activity, either because it was marked as done by
  58                              // the model or because it terminated without waiting for the model
  59
  60   virtual void register_simcall(smx_simcall_t simcall);
  61   void clean_action();
  62   virtual double get_remaining() const;
  63   // Support for the boost::intrusive_ptr<ActivityImpl> datatype
  64   friend XBT_PUBLIC void intrusive_ptr_add_ref(ActivityImpl* activity);
  65   friend XBT_PUBLIC void intrusive_ptr_release(ActivityImpl* activity);
  66
  67   static xbt::signal<void(ActivityImpl const&)> on_suspended;
  68   static xbt::signal<void(ActivityImpl const&)> on_resumed;
  69 };
  70
  71 template <class AnyActivityImpl> class ActivityImpl_T : public ActivityImpl {
  72 private:
  73   std::string name_             = "";
  74   std::string tracing_category_ = "";
  75
  76 public:
  77   AnyActivityImpl& set_name(const std::string& name)
  78   {
  79     name_ = name;
  80     return static_cast<AnyActivityImpl&>(*this);
  81   }
  82   const std::string& get_name() { return name_; }
  83   const char* get_cname() { return name_.c_str(); }
  84
  85   AnyActivityImpl& set_tracing_category(const std::string& category)
  86   {
  87     tracing_category_ = category;
  88     return static_cast<AnyActivityImpl&>(*this);
  89   }
  90   const std::string& get_tracing_category() { return tracing_category_; }
  91 };
  92
  93 } // namespace activity
  94 } // namespace kernel
  95 } // namespace simgrid
  96
  97 #endif /* SIMGRID_KERNEL_ACTIVITY_ACTIVITYIMPL_HPP */