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"
13 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_process, simix,
14 "Logging specific to SIMIX (process)");
16 /******************************** Process ************************************/
18 * \brief Creates and runs a new #smx_process_t.
20 * Does exactly the same as #SIMIX_process_create_with_arguments but without
21 providing standard arguments (\a argc, \a argv).
22 * \see SIMIX_process_create_with_arguments
26 void SIMIX_process_cleanup(void *arg)
28 xbt_swag_remove(arg, simix_global->process_list);
29 xbt_swag_remove(arg, simix_global->process_to_run);
31 ((smx_process_t) arg)->simdata->smx_host->simdata->
33 free(((smx_process_t) arg)->name);
34 ((smx_process_t) arg)->name = NULL;
36 free(((smx_process_t) arg)->simdata);
37 ((smx_process_t) arg)->simdata = NULL;
42 * \brief Creates and runs a new #smx_process_t.
44 * 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.
46 * \param name a name for the object. It is for user-level information and can be NULL.
47 * \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.
48 * \param host the location where the new agent is executed.
49 * \param argc first argument passed to \a code
50 * \param argv second argument passed to \a code
51 * \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.
53 * \return The new corresponding object.
55 smx_process_t SIMIX_process_create(const char *name,
56 xbt_main_func_t code, void *data,
57 const char *hostname, int argc,
58 char **argv, xbt_dict_t properties)
60 smx_simdata_process_t simdata = xbt_new0(s_smx_simdata_process_t, 1);
61 smx_process_t process = xbt_new0(s_smx_process_t, 1);
62 smx_process_t self = NULL;
63 smx_host_t host = SIMIX_host_get_by_name(hostname);
65 xbt_assert0(((code != NULL) && (host != NULL)), "Invalid parameters");
68 simdata->smx_host = host;
69 simdata->mutex = NULL;
73 simdata->context = xbt_context_new(name,code, NULL, NULL,
75 cleanup_process_function, process,
76 simdata->argc, simdata->argv);
78 /* Process structure */
79 process->name = xbt_strdup(name);
80 process->simdata = simdata;
84 simdata->properties = properties;
86 xbt_swag_insert(process, host->simdata->process_list);
88 /* fix current_process, about which xbt_context_start mocks around */
89 self = simix_global->current_process;
90 xbt_context_start(process->simdata->context);
91 simix_global->current_process = self;
93 xbt_swag_insert(process, simix_global->process_list);
94 DEBUG2("Inserting %s(%s) in the to_run list", process->name, host->name);
95 xbt_swag_insert(process, simix_global->process_to_run);
100 * \brief Creates and runs a new #smx_process_t hosting a JAVA thread
102 * Warning: this should only be used in libsimgrid4java, since it create
103 * a context with no code, which leads to segfaults in plain libsimgrid
105 void SIMIX_jprocess_create(const char *name, smx_host_t host,
107 void *jprocess, void *jenv, smx_process_t * res)
109 smx_simdata_process_t simdata = xbt_new0(s_smx_simdata_process_t, 1);
110 smx_process_t process = xbt_new0(s_smx_process_t, 1);
111 smx_process_t self = NULL;
113 /* HACK: We need this trick because when we xbt_context_new() do
114 syncronization stuff, the s_process field in the m_process needs
115 to have a valid value, and we call xbt_context_new() before
116 returning, of course, ie, before providing a right value to the
117 caller (Java_simgrid_msg_Msg_processCreate) have time to store it
118 in place. This way, we initialize the m_process->simdata->s_process
121 All this would be much simpler if the synchronization stuff would be done
122 in the JAVA world, I think.
128 DEBUG5("jprocess_create(name=%s,host=%p,data=%p,jproc=%p,jenv=%p)",
129 name, host, data, jprocess, jenv);
130 xbt_assert0(host, "Invalid parameters");
132 simdata->smx_host = host;
133 simdata->mutex = NULL;
134 simdata->cond = NULL;
136 simdata->argv = NULL;
139 simdata->context = xbt_context_new(name,NULL, NULL, jprocess,
141 cleanup_process_function, process,
142 /* argc/argv */ 0, NULL);
144 /* Process structure */
145 process->name = xbt_strdup(name);
146 process->simdata = simdata;
147 process->data = data;
149 xbt_swag_insert(process, host->simdata->process_list);
151 /* fix current_process, about which xbt_context_start mocks around */
152 self = simix_global->current_process;
154 xbt_context_start(process->simdata->context);
156 simix_global->current_process = self;
158 xbt_swag_insert(process, simix_global->process_list);
159 DEBUG2("Inserting %s(%s) in the to_run list", process->name, host->name);
160 xbt_swag_insert(process, simix_global->process_to_run);
165 /** \brief Kill a SIMIX process
167 * This function simply kills a \a process... scarry isn't it ? :).
168 * \param process poor victim
171 void SIMIX_process_kill(smx_process_t process)
173 smx_simdata_process_t p_simdata = process->simdata;
175 DEBUG2("Killing process %s on %s", process->name,
176 p_simdata->smx_host->name);
178 /* Cleanup if we were waiting for something */
179 if (p_simdata->mutex)
180 xbt_swag_remove(process, p_simdata->mutex->sleeping);
183 xbt_swag_remove(process, p_simdata->cond->sleeping);
185 xbt_swag_remove(process, simix_global->process_to_run);
186 xbt_swag_remove(process, simix_global->process_list);
187 DEBUG2("%p here! killing %p", simix_global->current_process, process);
188 xbt_context_kill(process->simdata->context);
190 if (process == SIMIX_process_self()) {
191 /* I just killed myself */
197 * \brief Return the user data of a #smx_process_t.
199 * 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.
200 * \param process SIMIX process
201 * \return A void pointer to the user data
203 void *SIMIX_process_get_data(smx_process_t process)
205 xbt_assert0((process != NULL), "Invalid parameters");
207 return (process->data);
211 * \brief Set the user data of a #m_process_t.
213 * 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.
214 * \param process SIMIX process
215 * \param data User data
217 void SIMIX_process_set_data(smx_process_t process, void *data)
219 xbt_assert0((process != NULL), "Invalid parameters");
220 //xbt_assert0((process->data == NULL), "Data already set");
222 process->data = data;
228 * \brief Return the location on which an agent is running.
230 * 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.
231 * \param process SIMIX process
234 smx_host_t SIMIX_process_get_host(smx_process_t process)
236 xbt_assert0(((process != NULL)
237 && (process->simdata)), "Invalid parameters");
239 return (process->simdata->smx_host);
243 * \brief Return the name of an agent.
245 * This functions checks whether \a process is a valid pointer or not and return its name.
246 * \param process SIMIX process
247 * \return The process name
249 const char *SIMIX_process_get_name(smx_process_t process)
251 xbt_assert0(((process != NULL)
252 && (process->simdata)), "Invalid parameters");
254 return (process->name);
257 /** \ingroup m_process_management
258 * \brief Return the properties
260 * This functions returns the properties associated with this process
262 xbt_dict_t SIMIX_process_get_properties(smx_process_t process)
264 return process->simdata->properties;
268 * \brief Return the current agent.
270 * This functions returns the currently running #smx_process_t.
271 * \return The SIMIX process
273 smx_process_t SIMIX_process_self(void)
275 return simix_global ? simix_global->current_process : NULL;
279 * \brief Suspend the process.
281 * This functions suspend the process by suspending the action on
282 * which it was waiting for the completion.
284 * \param process SIMIX process
286 void SIMIX_process_suspend(smx_process_t process)
288 smx_simdata_process_t simdata = NULL;
290 xbt_assert0(((process) && (process->simdata)), "Invalid parameters");
292 if (process != SIMIX_process_self()) {
293 simdata = process->simdata;
295 if (simdata->mutex) {
296 /* process blocked on a mutex, only set suspend=1 */
297 simdata->suspended = 1;
298 } else if (simdata->cond) {
299 /* process blocked cond, suspend all actions */
301 /* temporaries variables */
306 simdata->suspended = 1;
308 xbt_fifo_foreach(c->actions, i, act, smx_action_t) {
309 surf_workstation_model->common_public->suspend(act->simdata->
313 simdata->suspended = 1;
316 /* process executing, I can create an action and suspend it */
319 char name[] = "dummy";
320 process->simdata->suspended = 1;
322 cond = SIMIX_cond_init();
323 dummy = SIMIX_action_execute(SIMIX_process_get_host(process), name, 0);
324 surf_workstation_model->common_public->suspend(dummy->simdata->surf_action);
325 SIMIX_register_action_to_condition(dummy, cond);
326 __SIMIX_cond_wait(cond);
327 //SIMIX_action_destroy(dummy);
328 //SIMIX_cond_destroy(cond);
334 * \brief Resume a suspended process.
336 * This functions resume a suspended process by resuming the task on which it was waiting for the completion.
337 * \param process SIMIX process
339 void SIMIX_process_resume(smx_process_t process)
341 smx_simdata_process_t simdata = NULL;
343 xbt_assert0(((process != NULL)
344 && (process->simdata)), "Invalid parameters");
347 if (process == SIMIX_process_self()) {
351 simdata = process->simdata;
352 if (simdata->mutex) {
353 DEBUG0("Resume process blocked on a mutex");
354 simdata->suspended = 0; /* He'll wake up by itself */
356 } else if (simdata->cond) {
357 /* temporaries variables */
361 DEBUG0("Resume process blocked on a conditional");
362 simdata->suspended = 0;
364 xbt_fifo_foreach(c->actions, i, act, smx_action_t) {
365 surf_workstation_model->common_public->resume(act->simdata->surf_action);
367 SIMIX_cond_signal(c);
370 simdata->suspended = 0;
371 xbt_swag_insert(process, simix_global->process_to_run);
377 * \brief Returns true if the process is suspended .
379 * This checks whether a process is suspended or not by inspecting the task on which it was waiting for the completion.
380 * \param process SIMIX process
381 * \return 1, if the process is suspended, else 0.
383 int SIMIX_process_is_suspended(smx_process_t process)
385 xbt_assert0(((process != NULL)
386 && (process->simdata)), "Invalid parameters");
388 return (process->simdata->suspended);