1 /* Copyright (c) 2006-2019. The SimGrid Team. All rights reserved. */
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. */
6 #ifndef SIMGRID_S4U_ACTIVITY_HPP
7 #define SIMGRID_S4U_ACTIVITY_HPP
9 #include <simgrid/forward.h>
10 #include <xbt/signal.hpp>
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.
20 * They are somewhat linked but not identical to simgrid::kernel::resource::Action,
21 * that are stuff occurring on a resource:
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.
30 class XBT_PUBLIC Activity {
31 friend simgrid::s4u::Comm;
32 friend XBT_PUBLIC void intrusive_ptr_release(Comm * c);
33 friend XBT_PUBLIC void intrusive_ptr_add_ref(Comm * c);
34 friend simgrid::s4u::Exec;
35 friend XBT_PUBLIC void intrusive_ptr_release(Exec * e);
36 friend XBT_PUBLIC void intrusive_ptr_add_ref(Exec * e);
37 friend simgrid::s4u::Io;
38 friend XBT_PUBLIC void intrusive_ptr_release(Io* i);
39 friend XBT_PUBLIC void intrusive_ptr_add_ref(Io* i);
43 virtual ~Activity() = default;
47 Activity(Activity const&) = delete;
48 Activity& operator=(Activity const&) = delete;
51 enum class State { INITED = 0, STARTED, CANCELED, ERRORED, FINISHED };
53 /** Starts a previously created activity.
55 * This function is optional: you can call wait() even if you didn't call start()
57 virtual Activity* start() = 0;
58 /** Blocks until the activity is terminated */
59 virtual Activity* wait() = 0;
60 /** Blocks until the activity is terminated, or until the timeout is elapsed
61 * Raises: timeout exception.*/
62 virtual Activity* wait_for(double timeout) = 0;
63 /** Blocks until the activity is terminated, or until the time limit is reached
64 * Raises: timeout exception. */
65 void wait_until(double time_limit);
67 /** Cancel that activity */
68 virtual Activity* cancel() = 0;
69 /** Retrieve the current state of the activity */
70 Activity::State get_state() { return state_; }
71 /** Tests whether the given activity is terminated yet. This is a pure function. */
72 virtual bool test() = 0;
74 /** Get the remaining amount of work that this Activity entails. When it's 0, it's done. */
75 virtual double get_remaining();
77 /** Set the [remaining] amount of work that this Activity will entail
79 * It is forbidden to change the amount of work once the Activity is started */
80 Activity* set_remaining(double remains);
82 /** Put some user data onto the Activity */
83 Activity* set_user_data(void* data)
88 /** Retrieve the user data of the Activity */
89 void* get_user_data() { return user_data_; }
91 kernel::activity::ActivityImplPtr get_impl() { return pimpl_; }
94 XBT_ATTRIB_DEPRECATED_v324("Please use Activity::wait_for()") virtual void wait(double timeout) = 0;
95 XBT_ATTRIB_DEPRECATED_v323("Please use Activity::get_state()") Activity::State getState() { return state_; }
96 XBT_ATTRIB_DEPRECATED_v323("Please use Activity::get_remaining()") double getRemains() { return get_remaining(); }
97 XBT_ATTRIB_DEPRECATED_v323("Please use Activity::set_remaining()") Activity* setRemains(double remains)
99 return set_remaining(remains);
101 XBT_ATTRIB_DEPRECATED_v323("Please use Activity::set_user_data()") Activity* setUserData(void* data)
103 return set_user_data(data);
105 XBT_ATTRIB_DEPRECATED_v323("Please use Activity::get_user_data()") void* getUserData() { return user_data_; }
109 kernel::activity::ActivityImplPtr pimpl_ = nullptr;
110 Activity::State state_ = Activity::State::INITED;
112 void* user_data_ = nullptr;
116 } // namespace simgrid
118 #endif /* SIMGRID_S4U_ACTIVITY_HPP */