Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Modernize simcall process_on_exit.
[simgrid.git] / src / msg / msg_process.cpp
1 /* Copyright (c) 2004-2018. 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 #include "msg_private.hpp"
7 #include "simgrid/s4u/Host.hpp"
8 #include "src/instr/instr_private.hpp"
9 #include "src/simix/ActorImpl.hpp"
10 #include "src/simix/smx_private.hpp"
11
12 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_process, msg, "Logging specific to MSG (process)");
13
14 /** @addtogroup m_process_management
15  *
16  *  Processes (#msg_process_t) are independent agents that can do stuff on their own. They are in charge of executing
17  *  your code interacting with the simulated world.
18  *  A process may be defined as a <em>code</em> with some <em>private data</em>.
19  *  Processes must be located on <em>hosts</em> (#msg_host_t), and they exchange data by sending tasks (#msg_task_t)
20  *  that are similar to envelops containing data.
21  */
22
23 /******************************** Process ************************************/
24 /**
25  * \brief Cleans the MSG data of an actor
26  * \param smx_actor a SIMIX actor
27  */
28 void MSG_process_cleanup_from_SIMIX(smx_actor_t smx_actor)
29 {
30   simgrid::msg::ActorExt* msg_actor;
31
32   // get the MSG process from the SIMIX process
33   if (smx_actor == SIMIX_process_self()) {
34     /* avoid a SIMIX request if this function is called by the process itself */
35     msg_actor = (simgrid::msg::ActorExt*)SIMIX_process_self_get_data();
36     SIMIX_process_self_set_data(nullptr);
37   } else {
38     msg_actor = (simgrid::msg::ActorExt*)smx_actor->getUserData();
39     simcall_process_set_data(smx_actor, nullptr);
40   }
41
42   if (TRACE_actor_is_enabled())
43     simgrid::instr::Container::byName(instr_pid(smx_actor->ciface()))->removeFromParent();
44
45   // free the data if a function was provided
46   if (msg_actor && msg_actor->data && msg_global->process_data_cleanup) {
47     msg_global->process_data_cleanup(msg_actor->data);
48   }
49
50   delete msg_actor;
51   SIMIX_process_cleanup(smx_actor);
52 }
53
54 /* This function creates a MSG process. It has the prototype enforced by SIMIX_function_register_process_create */
55 smx_actor_t MSG_process_create_from_SIMIX(const char* name, std::function<void()> code, void* data, sg_host_t host,
56                                           std::map<std::string, std::string>* properties,
57                                           smx_actor_t /*parent_process*/)
58 {
59   msg_process_t p = MSG_process_create_from_stdfunc(name, std::move(code), data, host, properties);
60   return p == nullptr ? nullptr : p->get_impl();
61 }
62
63 /** \ingroup m_process_management
64  * \brief Creates and runs a new #msg_process_t.
65  *
66  * Does exactly the same as #MSG_process_create_with_arguments but without providing standard arguments
67  * (\a argc, \a argv, \a start_time, \a kill_time).
68  * \sa MSG_process_create_with_arguments
69  */
70 msg_process_t MSG_process_create(const char *name, xbt_main_func_t code, void *data, msg_host_t host)
71 {
72   return MSG_process_create_with_environment(name, code, data, host, 0, nullptr, nullptr);
73 }
74
75 /** \ingroup m_process_management
76  * \brief Creates and runs a new #msg_process_t.
77
78  * A constructor for #msg_process_t taking four arguments and returning the corresponding object. The structure (and
79  * the corresponding thread) is created, and put in the list of ready process.
80  * \param name a name for the object. It is for user-level information and can be nullptr.
81  * \param code is a function describing the behavior of the process. It should then only use functions described
82  * in \ref m_process_management (to create a new #msg_process_t for example),
83    in \ref m_host_management (only the read-only functions i.e. whose name contains the word get),
84    in \ref m_task_management (to create or destroy some #msg_task_t for example) and
85    in \ref msg_task_usage (to handle file transfers and task processing).
86  * \param data a pointer to any data one may want to attach to the new object.  It is for user-level information and
87  *        can be nullptr. It can be retrieved with the function \ref MSG_process_get_data.
88  * \param host the location where the new process is executed.
89  * \param argc first argument passed to \a code
90  * \param argv second argument passed to \a code
91  * \see msg_process_t
92  * \return The new corresponding object.
93  */
94
95 msg_process_t MSG_process_create_with_arguments(const char *name, xbt_main_func_t code, void *data, msg_host_t host,
96                                               int argc, char **argv)
97 {
98   return MSG_process_create_with_environment(name, code, data, host, argc, argv, nullptr);
99 }
100
101 /** \ingroup m_process_management
102  * \brief Creates and runs a new #msg_process_t.
103
104  * A constructor for #msg_process_t taking four arguments and returning the corresponding object. The structure (and
105  * the corresponding thread) is created, and put in the list of ready process.
106  * \param name a name for the object. It is for user-level information and can be nullptr.
107  * \param code is a function describing the behavior of the process. It should then only use functions described
108  * in \ref m_process_management (to create a new #msg_process_t for example),
109    in \ref m_host_management (only the read-only functions i.e. whose name contains the word get),
110    in \ref m_task_management (to create or destroy some #msg_task_t for example) and
111    in \ref msg_task_usage (to handle file transfers and task processing).
112  * \param data a pointer to any data one may want to attach to the new object.  It is for user-level information and
113  *        can be nullptr. It can be retrieved with the function \ref MSG_process_get_data.
114  * \param host the location where the new process is executed.
115  * \param argc first argument passed to \a code
116  * \param argv second argument passed to \a code. WARNING, these strings are freed by the SimGrid kernel when the
117  *             process exits, so they cannot be static nor shared between several processes.
118  * \param properties list a properties defined for this process
119  * \see msg_process_t
120  * \return The new corresponding object.
121  */
122 msg_process_t MSG_process_create_with_environment(const char *name, xbt_main_func_t code, void *data, msg_host_t host,
123                                                   int argc, char **argv, xbt_dict_t properties)
124 {
125   std::function<void()> function;
126   if (code)
127     function = simgrid::xbt::wrapMain(code, argc, static_cast<const char* const*>(argv));
128
129   std::map<std::string, std::string> props;
130   xbt_dict_cursor_t cursor = nullptr;
131   char* key;
132   char* value;
133   xbt_dict_foreach (properties, cursor, key, value)
134     props[key] = value;
135   xbt_dict_free(&properties);
136
137   msg_process_t res = MSG_process_create_from_stdfunc(name, std::move(function), data, host, &props);
138   for (int i = 0; i != argc; ++i)
139     xbt_free(argv[i]);
140   xbt_free(argv);
141   return res;
142 }
143
144 msg_process_t MSG_process_create_from_stdfunc(const char* name, std::function<void()> code, void* data, msg_host_t host,
145                                               std::map<std::string, std::string>* properties)
146 {
147   xbt_assert(code != nullptr && host != nullptr, "Invalid parameters: host and code params must not be nullptr");
148   simgrid::msg::ActorExt* msgExt = new simgrid::msg::ActorExt(data);
149
150   smx_actor_t process = simcall_process_create(name, std::move(code), msgExt, host, properties);
151
152   if (not process) { /* Undo everything */
153     delete msgExt;
154     return nullptr;
155   }
156
157   process->ciface()->on_exit((int_f_pvoid_pvoid_t)TRACE_msg_process_kill, process);
158   return process->ciface();
159 }
160
161 /* Become a process in the simulation
162  *
163  * Currently this can only be called by the main thread (once) and only work with some thread factories
164  * (currently ThreadContextFactory).
165  *
166  * In the future, it might be extended in order to attach other threads created by a third party library.
167  */
168 msg_process_t MSG_process_attach(const char *name, void *data, msg_host_t host, xbt_dict_t properties)
169 {
170   xbt_assert(host != nullptr, "Invalid parameters: host and code params must not be nullptr");
171   std::map<std::string, std::string> props;
172   xbt_dict_cursor_t cursor = nullptr;
173   char* key;
174   char* value;
175   xbt_dict_foreach (properties, cursor, key, value)
176     props[key] = value;
177   xbt_dict_free(&properties);
178
179   /* Let's create the process: SIMIX may decide to start it right now, even before returning the flow control to us */
180   smx_actor_t process =
181       SIMIX_process_attach(name, new simgrid::msg::ActorExt(data), host->get_cname(), &props, nullptr);
182   if (not process)
183     xbt_die("Could not attach");
184   process->ciface()->on_exit((int_f_pvoid_pvoid_t)TRACE_msg_process_kill, process);
185   return process->ciface();
186 }
187
188 /** Detach a process attached with `MSG_process_attach()`
189  *
190  *  This is called when the current process has finished its job.
191  *  Used in the main thread, it waits for the simulation to finish before  returning. When it returns, the other
192  *  simulated processes and the maestro are destroyed.
193  */
194 void MSG_process_detach()
195 {
196   SIMIX_process_detach();
197 }
198
199 /** Yield the current actor; let the other actors execute first */
200 void MSG_process_yield()
201 {
202   simgrid::simix::kernelImmediate([] { /* do nothing*/ });
203 }
204
205 /** \ingroup m_process_management
206  * \brief Returns the user data of a process.
207  *
208  * This function checks whether \a process is a valid pointer and returns the user data associated to this process.
209  */
210 void* MSG_process_get_data(msg_process_t process)
211 {
212   xbt_assert(process != nullptr, "Invalid parameter: first parameter must not be nullptr!");
213
214   /* get from SIMIX the MSG process data, and then the user data */
215   simgrid::msg::ActorExt* msgExt = (simgrid::msg::ActorExt*)process->get_impl()->getUserData();
216   if (msgExt)
217     return msgExt->data;
218   else
219     return nullptr;
220 }
221
222 /** \ingroup m_process_management
223  * \brief Sets the user data of a process.
224  *
225  * This function checks whether \a process is a valid pointer and sets the user data associated to this process.
226  */
227 msg_error_t MSG_process_set_data(msg_process_t process, void *data)
228 {
229   xbt_assert(process != nullptr, "Invalid parameter: first parameter must not be nullptr!");
230
231   static_cast<simgrid::msg::ActorExt*>(process->get_impl()->getUserData())->data = data;
232
233   return MSG_OK;
234 }
235
236 /** \ingroup m_process_management
237  * \brief Sets a cleanup function to be called to free the userdata of a process when a process is destroyed.
238  * \param data_cleanup a cleanup function for the userdata of a process, or nullptr to call no function
239  */
240 XBT_PUBLIC void MSG_process_set_data_cleanup(void_f_pvoid_t data_cleanup)
241 {
242   msg_global->process_data_cleanup = data_cleanup;
243 }
244
245 /** \ingroup m_process_management
246  *
247  * \brief Return a #msg_process_t given its PID.
248  *
249  * This function search in the list of all the created msg_process_t for a msg_process_t  whose PID is equal to \a PID.
250  * If no host is found, \c nullptr is returned.
251    Note that the PID are uniq in the whole simulation, not only on a given host.
252  */
253 msg_process_t MSG_process_from_PID(int PID)
254 {
255   return SIMIX_process_from_PID(PID)->ciface();
256 }
257
258 /** @brief returns a list of all currently existing processes */
259 xbt_dynar_t MSG_processes_as_dynar() {
260   xbt_dynar_t res = xbt_dynar_new(sizeof(smx_actor_t), nullptr);
261   for (auto const& kv : simix_global->process_list) {
262     smx_actor_t actor = kv.second;
263     xbt_dynar_push(res, &actor);
264   }
265   return res;
266 }
267
268 /** @brief Return the current number MSG processes. */
269 int MSG_process_get_number()
270 {
271   return SIMIX_process_count();
272 }
273
274 /** \ingroup m_process_management
275  * \brief Return the PID of the current process.
276  *
277  * This function returns the PID of the currently running #msg_process_t.
278  */
279 int MSG_process_self_PID()
280 {
281   smx_actor_t self = SIMIX_process_self();
282   return self == nullptr ? 0 : self->pid;
283 }
284
285 /** \ingroup m_process_management
286  * \brief Return the PPID of the current process.
287  *
288  * This function returns the PID of the parent of the currently running #msg_process_t.
289  */
290 int MSG_process_self_PPID()
291 {
292   return MSG_process_get_PPID(MSG_process_self());
293 }
294
295 /** \ingroup m_process_management
296  * \brief Return the name of the current process.
297  */
298 const char* MSG_process_self_name()
299 {
300   return SIMIX_process_self_get_name();
301 }
302
303 /** \ingroup m_process_management
304  * \brief Return the current process.
305  *
306  * This function returns the currently running #msg_process_t.
307  */
308 msg_process_t MSG_process_self()
309 {
310   return SIMIX_process_self()->ciface();
311 }
312
313 smx_context_t MSG_process_get_smx_ctx(msg_process_t process) { // deprecated -- smx_context_t should die afterward
314   return process->get_impl()->context;
315 }
316 /**
317  * \ingroup m_process_management
318  * \brief Add a function to the list of "on_exit" functions for the current process.
319  * The on_exit functions are the functions executed when your process is killed.
320  * You should use them to free the data used by your process.
321  */
322 void MSG_process_on_exit(int_f_pvoid_pvoid_t fun, void *data) {
323   simgrid::s4u::this_actor::on_exit(fun, data);
324 }
325 /**
326  * \ingroup m_process_management
327  * \brief Sets the "auto-restart" flag of the process.
328  * If the flag is set to 1, the process will be automatically restarted when its host comes back up.
329  */
330 XBT_PUBLIC void MSG_process_auto_restart_set(msg_process_t process, int auto_restart)
331 {
332   process->set_auto_restart(auto_restart);
333 }
334
335 /** @ingroup m_process_management
336  * @brief Take an extra reference on that process to prevent it to be garbage-collected
337  */
338 XBT_PUBLIC void MSG_process_ref(msg_process_t process)
339 {
340   intrusive_ptr_add_ref(process);
341 }
342 /** @ingroup m_process_management
343  * @brief Release a reference on that process so that it can get be garbage-collected
344  */
345 XBT_PUBLIC void MSG_process_unref(msg_process_t process)
346 {
347   intrusive_ptr_release(process);
348 }