include/simgrid/s4u/Activity.hpp

   1 /* Copyright (c) 2006-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_S4U_ACTIVITY_HPP
   7 #define SIMGRID_S4U_ACTIVITY_HPP
   8
   9 #include <simgrid/forward.h>
  10 #include <xbt/signal.hpp>
  11
  12 namespace simgrid {
  13 namespace s4u {
  14
  15 /** @brief Activities
  16  *
  17  * This class is the ancestor of every activities that an actor can undertake.
  18  * That is, activities are all the things that do take time to the actor in the simulated world.
  19  *
  20  * They are somewhat linked but not identical to simgrid::kernel::resource::Action,
  21  * that are stuff occurring on a resource:
  22  *
  23  * - A sequential execution activity encompasses 2 actions: one for the exec itself,
  24  *   and a time-limited sleep used as timeout detector.
  25  * - A point-to-point communication activity encompasses 3 actions: one for the comm itself
  26  *   (which spans on all links of the path), and one infinite sleep used as failure detector
  27  *   on both sender and receiver hosts.
  28  * - Synchronization activities may possibly be connected to no action.
  29  */
  30 class XBT_PUBLIC Activity {
  31   friend Comm;
  32   friend XBT_PUBLIC void intrusive_ptr_release(Comm * c);
  33   friend XBT_PUBLIC void intrusive_ptr_add_ref(Comm * c);
  34
  35   friend Exec;
  36   friend ExecSeq;
  37   friend ExecPar;
  38   friend XBT_PUBLIC void intrusive_ptr_release(Exec * e);
  39   friend XBT_PUBLIC void intrusive_ptr_add_ref(Exec * e);
  40
  41   friend Io;
  42   friend XBT_PUBLIC void intrusive_ptr_release(Io* i);
  43   friend XBT_PUBLIC void intrusive_ptr_add_ref(Io* i);
  44
  45 protected:
  46   Activity()  = default;
  47   virtual ~Activity() = default;
  48
  49 public:
  50 #ifndef DOXYGEN
  51   Activity(Activity const&) = delete;
  52   Activity& operator=(Activity const&) = delete;
  53 #endif
  54
  55   enum class State { INITED = 0, STARTED, CANCELED, ERRORED, FINISHED };
  56
  57   /** Starts a previously created activity.
  58    *
  59    * This function is optional: you can call wait() even if you didn't call start()
  60    */
  61   virtual Activity* start() = 0;
  62   /** Blocks until the activity is terminated */
  63   virtual Activity* wait() = 0;
  64   /** Blocks until the activity is terminated, or until the timeout is elapsed
  65    *  Raises: timeout exception.*/
  66   virtual Activity* wait_for(double timeout) = 0;
  67   /** Blocks until the activity is terminated, or until the time limit is reached
  68    * Raises: timeout exception. */
  69   void wait_until(double time_limit);
  70
  71   /** Cancel that activity */
  72   virtual Activity* cancel() = 0;
  73   /** Retrieve the current state of the activity */
  74   Activity::State get_state() { return state_; }
  75   /** Tests whether the given activity is terminated yet. This is a pure function. */
  76   virtual bool test() = 0;
  77
  78   /** Get the remaining amount of work that this Activity entails. When it's 0, it's done. */
  79   virtual double get_remaining();
  80
  81   /** Set the [remaining] amount of work that this Activity will entail
  82    *
  83    * It is forbidden to change the amount of work once the Activity is started */
  84   Activity* set_remaining(double remains);
  85
  86   /** Put some user data onto the Activity */
  87   Activity* set_user_data(void* data)
  88   {
  89     user_data_ = data;
  90     return this;
  91   }
  92   /** Retrieve the user data of the Activity */
  93   void* get_user_data() { return user_data_; }
  94
  95   kernel::activity::ActivityImplPtr get_impl() { return pimpl_; }
  96
  97 #ifndef DOXYGEN
  98   XBT_ATTRIB_DEPRECATED_v324("Please use Activity::wait_for()") virtual void wait(double timeout) = 0;
  99   XBT_ATTRIB_DEPRECATED_v323("Please use Activity::get_state()") Activity::State getState() { return state_; }
 100   XBT_ATTRIB_DEPRECATED_v323("Please use Activity::get_remaining()") double getRemains() { return get_remaining(); }
 101   XBT_ATTRIB_DEPRECATED_v323("Please use Activity::set_remaining()") Activity* setRemains(double remains)
 102   {
 103     return set_remaining(remains);
 104   }
 105   XBT_ATTRIB_DEPRECATED_v323("Please use Activity::set_user_data()") Activity* setUserData(void* data)
 106   {
 107     return set_user_data(data);
 108   }
 109   XBT_ATTRIB_DEPRECATED_v323("Please use Activity::get_user_data()") void* getUserData() { return user_data_; }
 110 #endif
 111
 112 private:
 113   kernel::activity::ActivityImplPtr pimpl_ = nullptr;
 114   Activity::State state_                   = Activity::State::INITED;
 115   double remains_                          = 0;
 116   void* user_data_                         = nullptr;
 117 };
 118
 119 } // namespace s4u
 120 } // namespace simgrid
 121
 122 #endif /* SIMGRID_S4U_ACTIVITY_HPP */