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"
11 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(m_process, msg,
12 "Logging specific to MSG (process)");
14 /** \defgroup m_process_management Management Functions of Agents
15 * \brief This section describes the agent structure of MSG
16 * (#m_process_t) and the functions for managing it.
18 * We need to simulate many independent scheduling decisions, so
19 * the concept of <em>process</em> is at the heart of the
20 * simulator. A process may be defined as a <em>code</em>, with
21 * some <em>private data</em>, executing in a <em>location</em>.
25 /******************************** Process ************************************/
26 /** \ingroup m_process_management
27 * \brief Creates and runs a new #m_process_t.
29 * Does exactly the same as #MSG_process_create_with_arguments but without
30 providing standard arguments (\a argc, \a argv, \a start_time, \a kill_time).
31 * \sa MSG_process_create_with_arguments
33 m_process_t MSG_process_create(const char *name,
34 m_process_code_t code, void *data,
37 return MSG_process_create_with_arguments(name, code, data, host, -1, NULL);
40 static void MSG_process_cleanup(void *arg)
43 while(((m_process_t)arg)->simdata->paje_state) {
44 PAJE_PROCESS_POP_STATE((m_process_t)arg);
47 PAJE_PROCESS_FREE(arg);
49 xbt_fifo_remove(msg_global->process_list, arg);
50 xbt_fifo_remove(msg_global->process_to_run, arg);
51 xbt_fifo_remove(((m_process_t) arg)->simdata->host->simdata->process_list, arg);
52 free(((m_process_t) arg)->name);
53 free(((m_process_t) arg)->simdata);
57 /** \ingroup m_process_management
58 * \brief Creates and runs a new #m_process_t.
60 * A constructor for #m_process_t taking four arguments and returning the
61 * corresponding object. The structure (and the corresponding thread) is
62 * created, and put in the list of ready process.
63 * \param name a name for the object. It is for user-level information
65 * \param code is a function describing the behavior of the agent. It
66 should then only use functions described in \ref
67 m_process_management (to create a new #m_process_t for example),
68 in \ref m_host_management (only the read-only functions i.e. whose
69 name contains the word get), in \ref m_task_management (to create
70 or destroy some #m_task_t for example) and in \ref
71 msg_gos_functions (to handle file transfers and task processing).
72 * \param data a pointer to any data one may want to attach to the new
73 object. It is for user-level information and can be NULL. It can
74 be retrieved with the function \ref MSG_process_get_data.
75 * \param host the location where the new agent is executed.
76 * \param argc first argument passed to \a code
77 * \param argv second argument passed to \a code
79 * \return The new corresponding object.
81 m_process_t MSG_process_create_with_arguments(const char *name,
82 m_process_code_t code, void *data,
83 m_host_t host, int argc, char **argv)
85 simdata_process_t simdata = xbt_new0(s_simdata_process_t,1);
86 m_process_t process = xbt_new0(s_m_process_t,1);
87 m_process_t self = NULL;
89 xbt_assert0(((code != NULL) && (host != NULL)), "Invalid parameters");
92 simdata->PID = msg_global->PID++;
94 simdata->waiting_task = NULL;
97 simdata->context = xbt_context_new(code, NULL, NULL,
98 MSG_process_cleanup, process,
99 simdata->argc, simdata->argv);
101 if((self=msg_global->current_process)) {
102 simdata->PPID = MSG_process_get_PID(self);
106 simdata->last_errno=MSG_OK;
109 /* Process structure */
110 process->name = xbt_strdup(name);
111 process->simdata = simdata;
112 process->data = data;
114 xbt_fifo_push(host->simdata->process_list, process);
116 /* /////////////// FIX du current_process !!! ////////////// */
117 self = msg_global->current_process;
118 xbt_context_start(process->simdata->context);
119 msg_global->current_process = self;
121 xbt_fifo_push(msg_global->process_list, process);
122 xbt_fifo_push(msg_global->process_to_run, process);
124 PAJE_PROCESS_NEW(process);
129 /** \ingroup m_process_management
130 * \param process poor victim
132 * This function simply kills a \a process... scarry isn't it ? :)
134 void MSG_process_kill(m_process_t process)
137 simdata_process_t p_simdata = process->simdata;
138 simdata_host_t h_simdata= p_simdata->host->simdata;
140 m_process_t proc = NULL;
142 /* fprintf(stderr,"Killing %s(%d) on %s.\n",process->name, */
143 /* p_simdata->PID,p_simdata->host->name); */
145 for (i=0; i<msg_global->max_channel; i++) {
146 if (h_simdata->sleeping[i] == process) {
147 h_simdata->sleeping[i] = NULL;
151 if (i==msg_global->max_channel) {
152 if(p_simdata->waiting_task) {
153 xbt_dynar_foreach(p_simdata->waiting_task->simdata->sleeping,_cursor,proc) {
155 xbt_dynar_remove_at(p_simdata->waiting_task->simdata->sleeping,_cursor,&proc);
157 if(p_simdata->waiting_task->simdata->compute)
158 surf_workstation_resource->common_public->
159 action_free(p_simdata->waiting_task->simdata->compute);
160 else if (p_simdata->waiting_task->simdata->comm) {
161 surf_workstation_resource->common_public->
162 action_change_state(p_simdata->waiting_task->simdata->comm,SURF_ACTION_FAILED);
163 surf_workstation_resource->common_public->
164 action_free(p_simdata->waiting_task->simdata->comm);
166 CRITICAL0("UNKNOWN STATUS. Please report this bug.");
167 } else { /* Must be trying to put a task somewhere */
168 if(process==MSG_process_self()) {
171 CRITICAL0("UNKNOWN STATUS. Please report this bug.");
176 xbt_fifo_remove(msg_global->process_to_run,process);
177 xbt_fifo_remove(msg_global->process_list,process);
178 xbt_context_free(process->simdata->context);
181 /** \ingroup m_process_management
182 * \brief Migrates an agent to another location.
184 * This functions checks whether \a process and \a host are valid pointers
185 and change the value of the #m_host_t on which \a process is running.
187 MSG_error_t MSG_process_change_host(m_process_t process, m_host_t host)
189 simdata_process_t simdata = NULL;
193 xbt_assert0(((process) && (process->simdata)
194 && (host)), "Invalid parameters");
195 simdata = process->simdata;
197 xbt_fifo_remove(simdata->host->simdata->process_list,process);
198 simdata->host = host;
199 xbt_fifo_push(host->simdata->process_list,process);
204 /** \ingroup m_process_management
205 * \brief Return the user data of a #m_process_t.
207 * This functions checks whether \a process is a valid pointer or not
208 and return the user data associated to \a process if it is possible.
210 void *MSG_process_get_data(m_process_t process)
212 xbt_assert0((process != NULL), "Invalid parameters");
214 return (process->data);
217 /** \ingroup m_process_management
218 * \brief Set the user data of a #m_process_t.
220 * This functions checks whether \a process is a valid pointer or not
221 and set the user data associated to \a process if it is possible.
223 MSG_error_t MSG_process_set_data(m_process_t process,void *data)
225 xbt_assert0((process != NULL), "Invalid parameters");
226 xbt_assert0((process->data == NULL), "Data already set");
228 process->data = data;
233 /** \ingroup m_process_management
234 * \brief Return the location on which an agent is running.
236 * This functions checks whether \a process is a valid pointer or not
237 and return the m_host_t corresponding to the location on which \a
240 m_host_t MSG_process_get_host(m_process_t process)
242 xbt_assert0(((process != NULL) && (process->simdata)), "Invalid parameters");
244 return (((simdata_process_t) process->simdata)->host);
247 /** \ingroup m_process_management
249 * \brief Return a #m_process_t given its PID.
251 * This functions search in the list of all the created m_process_t for a m_process_t
252 whose PID is equal to \a PID. If no host is found, \c NULL is returned.
253 Note that the PID are uniq in the whole simulation, not only on a given host.
255 m_process_t MSG_process_from_PID(int PID)
257 xbt_fifo_item_t i = NULL;
258 m_process_t process = NULL;
260 xbt_fifo_foreach(msg_global->process_list,i,process,m_process_t) {
261 if(MSG_process_get_PID(process) == PID) return process;
266 /** \ingroup m_process_management
267 * \brief Returns the process ID of \a process.
269 * This functions checks whether \a process is a valid pointer or not
272 int MSG_process_get_PID(m_process_t process)
274 xbt_assert0(((process != NULL) && (process->simdata)), "Invalid parameters");
276 return (((simdata_process_t) process->simdata)->PID);
279 /** \ingroup m_process_management
280 * \brief Returns the process ID of the parent of \a process.
282 * This functions checks whether \a process is a valid pointer or not
283 and return its PID. Returns -1 if the agent has not been created by
286 int MSG_process_get_PPID(m_process_t process)
288 xbt_assert0(((process != NULL) && (process->simdata)), "Invalid parameters");
290 return (((simdata_process_t) process->simdata)->PPID);
293 /** \ingroup m_process_management
294 * \brief Return the name of an agent.
296 * This functions checks whether \a process is a valid pointer or not
299 const char *MSG_process_get_name(m_process_t process)
301 xbt_assert0(((process != NULL) && (process->simdata)), "Invalid parameters");
303 return (process->name);
306 /** \ingroup m_process_management
307 * \brief Return the PID of the current agent.
309 * This functions returns the PID of the currently running #m_process_t.
311 int MSG_process_self_PID(void)
313 return (MSG_process_get_PID(MSG_process_self()));
316 /** \ingroup m_process_management
317 * \brief Return the PPID of the current agent.
319 * This functions returns the PID of the parent of the currently
320 * running #m_process_t.
322 int MSG_process_self_PPID(void)
324 return (MSG_process_get_PPID(MSG_process_self()));
327 /** \ingroup m_process_management
328 * \brief Return the current agent.
330 * This functions returns the currently running #m_process_t.
332 m_process_t MSG_process_self(void)
334 return msg_global ? msg_global->current_process : NULL;
337 /** \ingroup m_process_management
338 * \brief Suspend the process.
340 * This functions suspend the process by suspending the task on which
341 * it was waiting for the completion.
343 MSG_error_t MSG_process_suspend(m_process_t process)
345 simdata_process_t simdata = NULL;
346 simdata_task_t simdata_task = NULL;
348 xbt_assert0(((process) && (process->simdata)), "Invalid parameters");
350 PAJE_PROCESS_PUSH_STATE(process,"S");
352 if(process!=MSG_process_self()) {
353 simdata = process->simdata;
355 xbt_assert0(simdata->waiting_task,"Process not waiting for anything else. Weird !");
357 simdata_task = simdata->waiting_task->simdata;
359 simdata->suspended = 1;
360 if(simdata->blocked) return MSG_OK;
362 xbt_assert0(((simdata_task->compute)||(simdata_task->comm))&&
363 !((simdata_task->compute)&&(simdata_task->comm)),
364 "Got a problem in deciding which action to choose !");
365 simdata->suspended = 1;
366 if(simdata_task->compute)
367 surf_workstation_resource->common_public->suspend(simdata_task->compute);
369 surf_workstation_resource->common_public->suspend(simdata_task->comm);
371 m_task_t dummy = MSG_TASK_UNINITIALIZED;
372 dummy = MSG_task_create("suspended", 0.0, 0, NULL);
374 simdata = process->simdata;
375 simdata->suspended = 1;
376 __MSG_task_execute(process,dummy);
377 surf_workstation_resource->common_public->suspend(dummy->simdata->compute);
378 __MSG_wait_for_computation(process,dummy);
379 simdata->suspended = 0;
381 MSG_task_destroy(dummy);
386 /** \ingroup m_process_management
387 * \brief Resume a suspended process.
389 * This functions resume a suspended process by resuming the task on
390 * which it was waiting for the completion.
392 MSG_error_t MSG_process_resume(m_process_t process)
394 simdata_process_t simdata = NULL;
395 simdata_task_t simdata_task = NULL;
397 xbt_assert0(((process != NULL) && (process->simdata)), "Invalid parameters");
400 if(process == MSG_process_self()) {
404 simdata = process->simdata;
406 if(simdata->blocked) {
407 PAJE_PROCESS_POP_STATE(process);
409 simdata->suspended = 0; /* He'll wake up by itself */
413 if(!(simdata->waiting_task)) {
414 xbt_assert0(0,"Process not waiting for anything else. Weird !");
417 simdata_task = simdata->waiting_task->simdata;
420 if(simdata_task->compute) {
421 surf_workstation_resource->common_public->resume(simdata_task->compute);
422 PAJE_PROCESS_POP_STATE(process);
425 PAJE_PROCESS_POP_STATE(process);
426 surf_workstation_resource->common_public->resume(simdata_task->comm);
432 /** \ingroup m_process_management
433 * \brief Returns true if the process is suspended .
435 * This checks whether a process is suspended or not by inspecting the
436 * task on which it was waiting for the completion.
438 int MSG_process_is_suspended(m_process_t process)
440 xbt_assert0(((process != NULL) && (process->simdata)), "Invalid parameters");
442 return (process->simdata->suspended);
445 int __MSG_process_block(double max_duration)
447 m_process_t process = MSG_process_self();
449 m_task_t dummy = MSG_TASK_UNINITIALIZED;
450 dummy = MSG_task_create("blocked", 0.0, 0, NULL);
452 PAJE_PROCESS_PUSH_STATE(process,"B");
454 process->simdata->blocked=1;
455 __MSG_task_execute(process,dummy);
456 surf_workstation_resource->common_public->suspend(dummy->simdata->compute);
458 surf_workstation_resource->common_public->set_max_duration(dummy->simdata->compute,
460 __MSG_wait_for_computation(process,dummy);
461 process->simdata->blocked=0;
463 if(process->simdata->suspended)
464 MSG_process_suspend(process);
466 MSG_task_destroy(dummy);
471 MSG_error_t __MSG_process_unblock(m_process_t process)
473 simdata_process_t simdata = NULL;
474 simdata_task_t simdata_task = NULL;
476 xbt_assert0(((process != NULL) && (process->simdata)), "Invalid parameters");
479 simdata = process->simdata;
480 if(!(simdata->waiting_task)) {
481 xbt_assert0(0,"Process not waiting for anything else. Weird !");
484 simdata_task = simdata->waiting_task->simdata;
486 xbt_assert0(simdata->blocked,"Process not blocked");
488 surf_workstation_resource->common_public->resume(simdata_task->compute);
490 PAJE_PROCESS_POP_STATE(process);
495 int __MSG_process_isBlocked(m_process_t process)
497 xbt_assert0(((process != NULL) && (process->simdata)), "Invalid parameters");
499 return (process->simdata->blocked);