1 /* Copyright (c) 2004-2015. The SimGrid Team.
2 * All rights reserved. */
4 /* This program is free software; you can redistribute it and/or modify it
5 * under the terms of the license (GNU LGPL) which comes with this package. */
7 #include "msg_private.h"
8 #include "xbt/sysdep.h"
10 #include "src/simix/smx_process_private.h"
11 #include "src/simix/smx_private.h"
13 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_process, msg, "Logging specific to MSG (process)");
15 /** @addtogroup m_process_management
17 * Processes (#msg_process_t) are independent agents that can do stuff on their own. They are in charge of executing
18 * your code interacting with the simulated world.
19 * A process may be defined as a <em>code</em> with some <em>private data</em>.
20 * Processes must be located on <em>hosts</em> (#msg_host_t), and they exchange data by sending tasks (#msg_task_t)
21 * that are similar to envelops containing data.
24 /******************************** Process ************************************/
26 * \brief Cleans the MSG data of a process.
27 * \param smx_proc a SIMIX process
29 void MSG_process_cleanup_from_SIMIX(smx_process_t smx_proc)
31 simdata_process_t msg_proc;
33 // get the MSG process from the SIMIX process
34 if (smx_proc == SIMIX_process_self()) {
35 /* avoid a SIMIX request if this function is called by the process itself */
36 msg_proc = (simdata_process_t) SIMIX_process_self_get_data();
37 SIMIX_process_self_set_data(NULL);
39 msg_proc = (simdata_process_t) simcall_process_get_data(smx_proc);
40 simcall_process_set_data(smx_proc, NULL);
43 TRACE_msg_process_destroy(smx_proc->name.c_str(), smx_proc->pid);
44 // free the data if a function was provided
45 if (msg_proc && msg_proc->data && msg_global->process_data_cleanup) {
46 msg_global->process_data_cleanup(msg_proc->data);
49 // free the MSG process
51 SIMIX_process_cleanup(smx_proc);
54 /* This function creates a MSG process. It has the prototype enforced by SIMIX_function_register_process_create */
55 smx_process_t MSG_process_create_from_SIMIX(const char *name, xbt_main_func_t code, void *data, const char *hostname,
56 double kill_time, int argc, char **argv, xbt_dict_t properties,
57 int auto_restart, smx_process_t parent_process)
59 msg_host_t host = MSG_host_by_name(hostname);
60 msg_process_t p = MSG_process_create_with_environment(name, code, data, host, argc, argv, properties);
62 MSG_process_set_kill_time(p,kill_time);
63 MSG_process_auto_restart_set(p,auto_restart);
68 /** \ingroup m_process_management
69 * \brief Creates and runs a new #msg_process_t.
71 * Does exactly the same as #MSG_process_create_with_arguments but without providing standard arguments
72 * (\a argc, \a argv, \a start_time, \a kill_time).
73 * \sa MSG_process_create_with_arguments
75 msg_process_t MSG_process_create(const char *name, xbt_main_func_t code, void *data, msg_host_t host)
77 return MSG_process_create_with_environment(name, code, data, host, 0, NULL, NULL);
80 /** \ingroup m_process_management
81 * \brief Creates and runs a new #msg_process_t.
83 * A constructor for #msg_process_t taking four arguments and returning the corresponding object. The structure (and
84 * the corresponding thread) is created, and put in the list of ready process.
85 * \param name a name for the object. It is for user-level information and can be NULL.
86 * \param code is a function describing the behavior of the process. It should then only use functions described
87 * in \ref m_process_management (to create a new #msg_process_t for example),
88 in \ref m_host_management (only the read-only functions i.e. whose name contains the word get),
89 in \ref m_task_management (to create or destroy some #msg_task_t for example) and
90 in \ref msg_task_usage (to handle file transfers and task processing).
91 * \param data a pointer to any data one may want to attach to the new object. It is for user-level information and
92 * can be NULL. It can be retrieved with the function \ref MSG_process_get_data.
93 * \param host the location where the new process is executed.
94 * \param argc first argument passed to \a code
95 * \param argv second argument passed to \a code
97 * \return The new corresponding object.
100 msg_process_t MSG_process_create_with_arguments(const char *name, xbt_main_func_t code, void *data, msg_host_t host,
101 int argc, char **argv)
103 return MSG_process_create_with_environment(name, code, data, host, argc, argv, NULL);
106 /** \ingroup m_process_management
107 * \brief Creates and runs a new #msg_process_t.
109 * A constructor for #msg_process_t taking four arguments and returning the corresponding object. The structure (and
110 * the corresponding thread) is created, and put in the list of ready process.
111 * \param name a name for the object. It is for user-level information and can be NULL.
112 * \param code is a function describing the behavior of the process. It should then only use functions described
113 * in \ref m_process_management (to create a new #msg_process_t for example),
114 in \ref m_host_management (only the read-only functions i.e. whose name contains the word get),
115 in \ref m_task_management (to create or destroy some #msg_task_t for example) and
116 in \ref msg_task_usage (to handle file transfers and task processing).
117 * \param data a pointer to any data one may want to attach to the new object. It is for user-level information and
118 * can be NULL. It can be retrieved with the function \ref MSG_process_get_data.
119 * \param host the location where the new process is executed.
120 * \param argc first argument passed to \a code
121 * \param argv second argument passed to \a code. WARNING, these strings are freed by the SimGrid kernel when the
122 * process exits, so they cannot be static nor shared between several processes.
123 * \param properties list a properties defined for this process
125 * \return The new corresponding object.
127 msg_process_t MSG_process_create_with_environment(const char *name, xbt_main_func_t code, void *data, msg_host_t host,
128 int argc, char **argv, xbt_dict_t properties)
130 xbt_assert(code != NULL && host != NULL, "Invalid parameters: host and code params must not be NULL");
131 simdata_process_t simdata = xbt_new0(s_simdata_process_t, 1);
132 msg_process_t process;
134 /* Simulator data for MSG */
135 simdata->waiting_action = NULL;
136 simdata->waiting_task = NULL;
137 simdata->m_host = host;
138 simdata->argc = argc;
139 simdata->argv = argv;
140 simdata->data = data;
141 simdata->last_errno = MSG_OK;
143 /* Let's create the process: SIMIX may decide to start it right now,
144 * even before returning the flow control to us */
145 process = simcall_process_create(name, code, simdata, sg_host_get_name(host), -1, argc, argv, properties,0);
148 /* Undo everything we have just changed */
153 simcall_process_on_exit(process,(int_f_pvoid_pvoid_t)TRACE_msg_process_kill,process);
158 static int MSG_maestro(int argc, char** argv)
160 int res = MSG_main();
164 /* Become a process in the simulation
166 * Currently this can only be called by the main thread (once) and only work with some thread factories
167 * (currently ThreadContextFactory).
169 * In the future, it might be extended in order to attach other threads created by a third party library.
171 msg_process_t MSG_process_attach(const char *name, void *data, msg_host_t host, xbt_dict_t properties)
173 xbt_assert(host != NULL, "Invalid parameters: host and code params must not be NULL");
174 simdata_process_t simdata = xbt_new0(s_simdata_process_t, 1);
175 msg_process_t process;
177 /* Simulator data for MSG */
178 simdata->waiting_action = NULL;
179 simdata->waiting_task = NULL;
180 simdata->m_host = host;
182 simdata->argv = NULL;
183 simdata->data = data;
184 simdata->last_errno = MSG_OK;
186 /* Let's create the process: SIMIX may decide to start it right now, even before returning the flow control to us */
187 process = SIMIX_process_attach(name, simdata, sg_host_get_name(host), properties, NULL);
189 xbt_die("Could not attach");
190 simcall_process_on_exit(process,(int_f_pvoid_pvoid_t)TRACE_msg_process_kill,process);
194 /** Detach a process attached with `MSG_process_attach()`
196 * This is called when the current process has finished its job.
197 * Used in the main thread, it waits for the simulation to finish before returning. When it returns, the other
198 * simulated processes and the maestro are destroyed.
200 void MSG_process_detach(void)
202 SIMIX_process_detach();
205 /** \ingroup m_process_management
206 * \param process poor victim
208 * This function simply kills a \a process... scary isn't it ? :)
210 void MSG_process_kill(msg_process_t process)
212 // /* FIXME: why do we only cancel communication actions? is this useful? */
213 // simdata_process_t p_simdata = simcall_process_get_data(process);
214 // if (p_simdata->waiting_task && p_simdata->waiting_task->simdata->comm) {
215 // simcall_comm_cancel(p_simdata->waiting_task->simdata->comm);
217 simcall_process_kill(process);
221 * \brief Wait for the completion of a #msg_process_t.
223 * \param process the process to wait for
224 * \param timeout wait until the process is over, or the timeout occurs
226 msg_error_t MSG_process_join(msg_process_t process, double timeout){
227 simcall_process_join(process, timeout);
231 /** \ingroup m_process_management
232 * \brief Migrates a process to another location.
234 * This function checks whether \a process and \a host are valid pointers and change the value of the #msg_host_t on
235 * which \a process is running.
237 msg_error_t MSG_process_migrate(msg_process_t process, msg_host_t host)
239 simdata_process_t simdata = (simdata_process_t) simcall_process_get_data(process);
240 simdata->m_host = host;
241 msg_host_t now = simdata->m_host;
242 TRACE_msg_process_change_host(process, now, host);
243 simcall_process_set_host(process, host);
247 /** \ingroup m_process_management
248 * \brief Returns the user data of a process.
250 * This function checks whether \a process is a valid pointer and returns the user data associated to this process.
252 void* MSG_process_get_data(msg_process_t process)
254 xbt_assert(process != NULL, "Invalid parameter: first parameter must not be NULL!");
256 /* get from SIMIX the MSG process data, and then the user data */
257 simdata_process_t simdata = (simdata_process_t) simcall_process_get_data(process);
259 return simdata->data;
264 /** \ingroup m_process_management
265 * \brief Sets the user data of a process.
267 * This function checks whether \a process is a valid pointer and sets the user data associated to this process.
269 msg_error_t MSG_process_set_data(msg_process_t process, void *data)
271 xbt_assert(process != NULL, "Invalid parameter: first parameter must not be NULL!");
273 simdata_process_t simdata = (simdata_process_t) simcall_process_get_data(process);
274 simdata->data = data;
279 /** \ingroup m_process_management
280 * \brief Sets a cleanup function to be called to free the userdata of a process when a process is destroyed.
281 * \param data_cleanup a cleanup function for the userdata of a process, or NULL to call no function
283 XBT_PUBLIC(void) MSG_process_set_data_cleanup(void_f_pvoid_t data_cleanup) {
284 msg_global->process_data_cleanup = data_cleanup;
287 /** \ingroup m_process_management
288 * \brief Return the location on which a process is running.
289 * \param process a process (NULL means the current one)
290 * \return the msg_host_t corresponding to the location on which \a process is running.
292 msg_host_t MSG_process_get_host(msg_process_t process)
294 simdata_process_t simdata;
295 if (process == NULL) {
296 simdata = (simdata_process_t) SIMIX_process_self_get_data();
299 simdata = (simdata_process_t) simcall_process_get_data(process);
301 return simdata ? simdata->m_host : NULL;
304 /** \ingroup m_process_management
306 * \brief Return a #msg_process_t given its PID.
308 * 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.
309 * If no host is found, \c NULL is returned.
310 Note that the PID are uniq in the whole simulation, not only on a given host.
312 msg_process_t MSG_process_from_PID(int PID)
314 return SIMIX_process_from_PID(PID);
317 /** @brief returns a list of all currently existing processes */
318 xbt_dynar_t MSG_processes_as_dynar(void) {
319 return SIMIX_processes_as_dynar();
322 /** @brief Return the current number MSG processes. */
323 int MSG_process_get_number(void)
325 return SIMIX_process_count();
328 /** \ingroup m_process_management
329 * \brief Set the kill time of a process.
331 * \param process a process
332 * \param kill_time the time when the process is killed.
334 msg_error_t MSG_process_set_kill_time(msg_process_t process, double kill_time)
336 simcall_process_set_kill_time(process,kill_time);
340 /** \ingroup m_process_management
341 * \brief Returns the process ID of \a process.
343 * This function checks whether \a process is a valid pointer and return its PID (or 0 in case of problem).
345 int MSG_process_get_PID(msg_process_t process)
347 /* Do not raise an exception here: this function is called by the logs
348 * and the exceptions, so it would be called back again and again */
349 if (process == NULL) {
352 return simcall_process_get_PID(process);
355 /** \ingroup m_process_management
356 * \brief Returns the process ID of the parent of \a process.
358 * This function checks whether \a process is a valid pointer and return its PID.
359 * Returns -1 if the process has not been created by any other process.
361 int MSG_process_get_PPID(msg_process_t process)
363 xbt_assert(process != NULL, "Invalid parameter: First argument must not be NULL");
364 return simcall_process_get_PPID(process);
367 /** \ingroup m_process_management
368 * \brief Return the name of a process.
370 * This function checks whether \a process is a valid pointer and return its name.
372 const char *MSG_process_get_name(msg_process_t process)
374 xbt_assert(process != NULL, "Invalid parameter: First argument must not be NULL");
375 return simcall_process_get_name(process);
378 /** \ingroup m_process_management
379 * \brief Returns the value of a given process property
381 * \param process a process
382 * \param name a property name
383 * \return value of a property (or NULL if the property is not set)
385 const char *MSG_process_get_property_value(msg_process_t process, const char *name)
387 return (char*) xbt_dict_get_or_null(MSG_process_get_properties(process), name);
390 /** \ingroup m_process_management
391 * \brief Return the list of properties
393 * This function returns all the parameters associated with a process
395 xbt_dict_t MSG_process_get_properties(msg_process_t process)
397 xbt_assert(process != NULL, "Invalid parameter: First argument must not be NULL");
398 return simcall_process_get_properties(process);
401 /** \ingroup m_process_management
402 * \brief Return the PID of the current process.
404 * This function returns the PID of the currently running #msg_process_t.
406 int MSG_process_self_PID(void)
408 return MSG_process_get_PID(MSG_process_self());
411 /** \ingroup m_process_management
412 * \brief Return the PPID of the current process.
414 * This function returns the PID of the parent of the currently running #msg_process_t.
416 int MSG_process_self_PPID(void)
418 return MSG_process_get_PPID(MSG_process_self());
421 /** \ingroup m_process_management
422 * \brief Return the current process.
424 * This function returns the currently running #msg_process_t.
426 msg_process_t MSG_process_self(void)
428 return SIMIX_process_self();
431 /** \ingroup m_process_management
432 * \brief Suspend the process.
434 * This function suspends the process by suspending the task on which it was waiting for the completion.
436 msg_error_t MSG_process_suspend(msg_process_t process)
438 xbt_assert(process != NULL, "Invalid parameter: First argument must not be NULL");
440 TRACE_msg_process_suspend(process);
441 simcall_process_suspend(process);
445 /** \ingroup m_process_management
446 * \brief Resume a suspended process.
448 * This function resumes a suspended process by resuming the task on which it was waiting for the completion.
450 msg_error_t MSG_process_resume(msg_process_t process)
452 xbt_assert(process != NULL, "Invalid parameter: First argument must not be NULL");
454 TRACE_msg_process_resume(process);
455 simcall_process_resume(process);
459 /** \ingroup m_process_management
460 * \brief Returns true if the process is suspended .
462 * This checks whether a process is suspended or not by inspecting the task on which it was waiting for the completion.
464 int MSG_process_is_suspended(msg_process_t process)
466 xbt_assert(process != NULL, "Invalid parameter: First argument must not be NULL");
467 return simcall_process_is_suspended(process);
470 smx_context_t MSG_process_get_smx_ctx(msg_process_t process) {
471 return SIMIX_process_get_context(process);
474 * \ingroup m_process_management
475 * \brief Add a function to the list of "on_exit" functions for the current process.
476 * The on_exit functions are the functions executed when your process is killed.
477 * You should use them to free the data used by your process.
479 void MSG_process_on_exit(int_f_pvoid_pvoid_t fun, void *data) {
480 simcall_process_on_exit(MSG_process_self(),fun,data);
483 * \ingroup m_process_management
484 * \brief Sets the "auto-restart" flag of the process.
485 * If the flag is set to 1, the process will be automatically restarted when its host comes back up.
487 XBT_PUBLIC(void) MSG_process_auto_restart_set(msg_process_t process, int auto_restart) {
488 simcall_process_auto_restart_set(process,auto_restart);
491 * \ingroup m_process_management
492 * \brief Restarts a process from the beginning.
494 XBT_PUBLIC(msg_process_t) MSG_process_restart(msg_process_t process) {
495 return simcall_process_restart(process);