3 /* Copyright (c) 2002,2003,2004 Arnaud Legrand. All rights reserved. */
5 /* This program is free software; you can redistribute it and/or modify it
6 * under the terms of the license (GNU LGPL) which comes with this package. */
9 #include "xbt/sysdep.h"
12 #include "msg/mailbox.h"
14 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_process, simix,
15 "Logging specific to SIMIX (process)");
18 * \brief Move a process to the list of process to destroy. *
20 void SIMIX_process_cleanup(void *arg)
22 xbt_swag_remove(arg, simix_global->process_to_run);
23 xbt_swag_remove(arg, simix_global->process_list);
24 xbt_swag_remove(arg, ((smx_process_t)arg)->smx_host->process_list);
25 xbt_swag_insert(arg, simix_global->process_to_destroy);
31 * Should be called some time to time to free the memory allocated for processes
32 * that have finished (or killed).
34 void SIMIX_process_empty_trash(void)
36 smx_process_t process = NULL;
38 while ((process = xbt_swag_extract(simix_global->process_to_destroy))){
39 SIMIX_context_free(process->context);
47 * \brief Creates and runs the maestro process
49 void __SIMIX_create_maestro_process()
51 smx_process_t process = NULL;
52 process = xbt_new0(s_smx_process_t, 1);
55 process->name = (char *)"";
57 /* Create a dummy context for maestro */
58 process->context = SIMIX_context_new(NULL, 0, NULL, NULL, NULL);
60 /* Set it as the maestro process */
61 simix_global->maestro_process = process;
62 simix_global->current_process = process;
68 * \brief Creates and runs a new #smx_process_t.
70 * A constructor for #m_process_t taking four arguments and returning the corresponding object. The structure (and the corresponding thread) is created, and put in the list of ready process.
72 * \param name a name for the object. It is for user-level information and can be NULL.
73 * \param data a pointer to any data one may want to attach to the new object. It is for user-level information and can be NULL. It can be retrieved with the function \ref MSG_process_get_data.
74 * \param host the location where the new agent is executed.
75 * \param argc first argument passed to \a code
76 * \param argv second argument passed to \a code
77 * \param clean_process_function The cleanup function of user process. It will be called when the process finish. This function have to call the SIMIX_process_cleanup.
79 * \return The new corresponding object.
81 smx_process_t SIMIX_process_create(const char *name,
82 xbt_main_func_t code, void *data,
83 const char *hostname, int argc,
84 char **argv, xbt_dict_t properties)
86 smx_process_t process = NULL;
87 smx_host_t host = SIMIX_host_get_by_name(hostname);
89 DEBUG2("Start process %s on host %s", name, hostname);
91 if (!SIMIX_host_get_state(host)) {
92 WARN2("Cannot launch process '%s' on failed host '%s'", name, hostname);
95 process = xbt_new0(s_smx_process_t, 1);
97 xbt_assert0(((code != NULL) && (host != NULL)), "Invalid parameters");
100 process->name = xbt_strdup(name);
101 process->smx_host = host;
102 process->mutex = NULL;
103 process->cond = NULL;
104 process->iwannadie = 0;
106 VERB1("Create context %s", process->name);
107 process->context = SIMIX_context_new(code, argc, argv,
108 simix_global->cleanup_process_function,
111 process->data = data;
114 process->properties = properties;
116 /* Add the process to it's host process list */
117 xbt_swag_insert(process, host->process_list);
119 DEBUG1("Start context '%s'", process->name);
120 SIMIX_context_start(process->context);
122 /* Now insert it in the global process list and in the process to run list */
123 xbt_swag_insert(process, simix_global->process_list);
124 DEBUG2("Inserting %s(%s) in the to_run list", process->name, host->name);
125 xbt_swag_insert(process, simix_global->process_to_run);
131 * \brief Creates and runs a new #smx_process_t hosting a JAVA thread
133 * Warning: this should only be used in libsimgrid4java, since it create
134 * a context with no code, which leads to segfaults in plain libsimgrid
136 void SIMIX_jprocess_create(const char *name, smx_host_t host,
138 void *jprocess, void *jenv, smx_process_t * res)
140 smx_process_t process = xbt_new0(s_smx_process_t, 1);
141 smx_process_t self = NULL;
143 /* HACK: We need this trick because when we xbt_context_new() do
144 syncronization stuff, the s_process field in the m_process needs
145 to have a valid value, and we call xbt_context_new() before
146 returning, of course, ie, before providing a right value to the
147 caller (Java_simgrid_msg_Msg_processCreate) have time to store it
148 in place. This way, we initialize the m_process->simdata->s_process
151 All this would be much simpler if the synchronization stuff would be done
152 in the JAVA world, I think.
156 DEBUG5("jprocess_create(name=%s,host=%p,data=%p,jproc=%p,jenv=%p)",
157 name, host, data, jprocess, jenv);
158 xbt_assert0(host, "Invalid parameters");
161 process->name = xbt_strdup(name);
162 process->smx_host = host;
163 process->mutex = NULL;
164 process->cond = NULL;
165 SIMIX_context_new(jprocess, 0, NULL, NULL, NULL);
166 process->data = data;
168 /* Add the process to it's host process list */
169 xbt_swag_insert(&process, host->process_list);
171 /* fix current_process, about which xbt_context_start mocks around */
172 self = simix_global->current_process;
173 SIMIX_context_start(process->context);
174 simix_global->current_process = self;
176 /* Now insert it in the global process list and in the process to run list */
177 xbt_swag_insert(process, simix_global->process_list);
178 DEBUG2("Inserting %s(%s) in the to_run list", process->name, host->name);
179 xbt_swag_insert(process, simix_global->process_to_run);
182 /** \brief Kill a SIMIX process
184 * This function simply kills a \a process... scarry isn't it ? :).
185 * \param process poor victim
188 void SIMIX_process_kill(smx_process_t process)
190 DEBUG2("Killing process %s on %s", process->name, process->smx_host->name);
192 /* Cleanup if we were waiting for something */
194 xbt_swag_remove(process, process->mutex->sleeping);
197 xbt_swag_remove(process, process->cond->sleeping);
199 DEBUG2("%p here! killing %p", simix_global->current_process, process);
201 process->iwannadie = 1;
203 /* If I'm killing myself then stop otherwise schedule the process to kill */
204 if (process == SIMIX_process_self())
205 SIMIX_context_stop(process->context);
207 __SIMIX_process_schedule(process);
212 * \brief Return the user data of a #smx_process_t.
214 * This functions checks whether \a process is a valid pointer or not and return the user data associated to \a process if it is possible.
215 * \param process SIMIX process
216 * \return A void pointer to the user data
218 void *SIMIX_process_get_data(smx_process_t process)
220 xbt_assert0((process != NULL), "Invalid parameters");
221 return (process->data);
225 * \brief Set the user data of a #m_process_t.
227 * This functions checks whether \a process is a valid pointer or not and set the user data associated to \a process if it is possible.
228 * \param process SIMIX process
229 * \param data User data
231 void SIMIX_process_set_data(smx_process_t process, void *data)
233 xbt_assert0((process != NULL), "Invalid parameters");
235 process->data = data;
240 * \brief Return the location on which an agent is running.
242 * This functions checks whether \a process is a valid pointer or not and return the m_host_t corresponding to the location on which \a process is running.
243 * \param process SIMIX process
246 smx_host_t SIMIX_process_get_host(smx_process_t process)
248 xbt_assert0((process != NULL), "Invalid parameters");
249 return (process->smx_host);
253 * \brief Return the name of an agent.
255 * This functions checks whether \a process is a valid pointer or not and return its name.
256 * \param process SIMIX process
257 * \return The process name
259 const char *SIMIX_process_get_name(smx_process_t process)
261 xbt_assert0((process != NULL), "Invalid parameters");
262 return (process->name);
266 * \brief Changes the name of an agent.
268 * This functions checks whether \a process is a valid pointer or not and return its name.
269 * \param process SIMIX process
270 * \param name The new process name
272 void SIMIX_process_set_name(smx_process_t process, char *name)
274 xbt_assert0((process != NULL), "Invalid parameters");
275 process->name = name;
278 /** \ingroup m_process_management
279 * \brief Return the properties
281 * This functions returns the properties associated with this process
283 xbt_dict_t SIMIX_process_get_properties(smx_process_t process)
285 return process->properties;
289 * \brief Return the current agent.
291 * This functions returns the currently running #smx_process_t.
292 * \return The SIMIX process
294 smx_process_t SIMIX_process_self(void)
296 return simix_global ? simix_global->current_process : NULL;
300 * \brief Suspend the process.
302 * This functions suspend the process by suspending the action on
303 * which it was waiting for the completion.
305 * \param process SIMIX process
307 void SIMIX_process_suspend(smx_process_t process)
309 xbt_assert0(process, "Invalid parameters");
311 if (process != SIMIX_process_self()) {
313 if (process->mutex) {
314 /* process blocked on a mutex, only set suspend=1 */
315 process->suspended = 1;
316 } else if (process->cond) {
317 /* process blocked cond, suspend all actions */
319 /* temporaries variables */
324 process->suspended = 1;
326 xbt_fifo_foreach(c->actions, i, act, smx_action_t) {
327 surf_workstation_model->suspend(act->surf_action);
330 process->suspended = 1;
333 /* process executing, I can create an action and suspend it */
336 char name[] = "dummy";
337 process->suspended = 1;
339 cond = SIMIX_cond_init();
340 dummy = SIMIX_action_execute(SIMIX_process_get_host(process), name, 0);
341 surf_workstation_model->suspend(dummy->surf_action);
342 SIMIX_register_action_to_condition(dummy, cond);
343 __SIMIX_cond_wait(cond);
344 SIMIX_unregister_action_to_condition(dummy, cond);
345 SIMIX_action_destroy(dummy);
346 SIMIX_cond_destroy(cond);
352 * \brief Resume a suspended process.
354 * This functions resume a suspended process by resuming the task on which it was waiting for the completion.
355 * \param process SIMIX process
357 void SIMIX_process_resume(smx_process_t process)
359 xbt_assert0((process != NULL), "Invalid parameters");
362 if (process == SIMIX_process_self())
365 if (process->mutex) {
366 DEBUG0("Resume process blocked on a mutex");
367 process->suspended = 0; /* It'll wake up by itself when mutex releases */
369 } else if (process->cond) {
370 /* temporaries variables */
374 DEBUG0("Resume process blocked on a conditional");
375 process->suspended = 0;
377 xbt_fifo_foreach(c->actions, i, act, smx_action_t) {
378 surf_workstation_model->resume(act->surf_action);
380 SIMIX_cond_signal(c);
383 process->suspended = 0;
384 xbt_swag_insert(process, simix_global->process_to_run);
389 * \brief Migrates an agent to another location.
391 * This function changes the value of the host on which \a process is running.
393 void SIMIX_process_change_host(smx_process_t process, char *source, char *dest)
395 xbt_assert0((process != NULL), "Invalid parameters");
396 smx_host_t h1 = SIMIX_host_get_by_name(source);
397 smx_host_t h2 = SIMIX_host_get_by_name(dest);
398 process->smx_host = h2;
399 xbt_swag_remove(process, h1->process_list);
400 xbt_swag_insert(process, h2->process_list);
404 * \brief Returns true if the process is suspended .
406 * This checks whether a process is suspended or not by inspecting the task on which it was waiting for the completion.
407 * \param process SIMIX process
408 * \return 1, if the process is suspended, else 0.
410 int SIMIX_process_is_suspended(smx_process_t process)
412 xbt_assert0((process != NULL), "Invalid parameters");
414 return (process->suspended);
418 * \brief Returns the amount of SIMIX processes in the system
420 * Maestro internal process is not counted, only user code processes are
422 int SIMIX_process_count()
424 return xbt_swag_size(simix_global->process_list);
428 * Calling this function makes the process process to yield. The process
429 * that scheduled it returns from __SIMIX_process_schedule as if nothing
432 * Only the processes can call this function, giving back the control
435 void __SIMIX_process_yield(void)
437 DEBUG1("Yield process '%s'", simix_global->current_process->name);
438 xbt_assert0((simix_global->current_process != simix_global->maestro_process),
439 "You are not supposed to run this function here!");
441 SIMIX_context_suspend(simix_global->current_process->context);
443 if (simix_global->current_process->iwannadie)
444 SIMIX_context_stop(simix_global->current_process->context);
447 void __SIMIX_process_schedule(smx_process_t new_process)
449 DEBUG1("Scheduling context: '%s'", new_process->name);
451 /* save the current process */
452 smx_process_t old_process = simix_global->current_process;
454 /* update the current process */
455 simix_global->current_process = new_process;
457 /* schedule the context */
458 SIMIX_context_resume(old_process->context, new_process->context);
460 /* restore the current process to the previously saved process */
461 simix_global->current_process = old_process;