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(gos, msg,
12 "Logging specific to MSG (gos)");
14 /** \defgroup msg_gos_functions MSG Operating System Functions
15 * \brief This section describes the functions that can be used
16 * by an agent for handling some task.
19 /** \ingroup msg_gos_functions
20 * \brief Listen on a channel and wait for receiving a task.
22 * It takes two parameters.
23 * \param task a memory location for storing a #m_task_t. It will
24 hold a task when this function will return. Thus \a task should not
25 be equal to \c NULL and \a *task should be equal to \c NULL. If one of
26 those two condition does not hold, there will be a warning message.
27 * \param channel the channel on which the agent should be
28 listening. This value has to be >=0 and < than the maximal
29 number of channels fixed with MSG_set_channel_number().
30 * \return #MSG_FATAL if \a task is equal to \c NULL, #MSG_WARNING
31 * if \a *task is not equal to \c NULL, and #MSG_OK otherwise.
33 MSG_error_t MSG_task_get(m_task_t * task,
36 return MSG_task_get_with_time_out(task, channel, -1);
39 /** \ingroup msg_gos_functions
40 * \brief Listen on a channel and wait for receiving a task with a timeout.
42 * It takes three parameters.
43 * \param task a memory location for storing a #m_task_t. It will
44 hold a task when this function will return. Thus \a task should not
45 be equal to \c NULL and \a *task should be equal to \c NULL. If one of
46 those two condition does not hold, there will be a warning message.
47 * \param channel the channel on which the agent should be
48 listening. This value has to be >=0 and < than the maximal
49 number of channels fixed with MSG_set_channel_number().
50 * \param max_duration the maximum time to wait for a task before giving
51 up. In such a case, \a task will not be modified and will still be
52 equal to \c NULL when returning.
53 * \return #MSG_FATAL if \a task is equal to \c NULL, #MSG_WARNING
54 if \a *task is not equal to \c NULL, and #MSG_OK otherwise.
57 MSG_error_t MSG_task_get_with_time_out(m_task_t * task,
61 m_process_t process = MSG_process_self();
64 simdata_task_t t_simdata = NULL;
65 simdata_host_t h_simdata = NULL;
67 e_surf_action_state_t state = SURF_ACTION_NOT_IN_THE_SYSTEM;
70 xbt_assert1((channel>=0) && (channel < msg_global->max_channel),"Invalid channel %d",channel);
72 xbt_assert0(task,"Null pointer for the task\n");
75 CRITICAL0("MSG_task_get() was asked to write in a non empty task struct.");
79 h_simdata = h->simdata;
81 DEBUG2("Waiting for a task on channel %d (%s)", channel,h->name);
83 while ((t = xbt_fifo_shift(h_simdata->mbox[channel])) == NULL) {
89 xbt_assert2(!(h_simdata->sleeping[channel]),
90 "A process (%s(%d)) is already blocked on this channel",
91 h_simdata->sleeping[channel]->name,
92 h_simdata->sleeping[channel]->simdata->PID);
93 h_simdata->sleeping[channel] = process; /* I'm waiting. Wake me up when you're ready */
95 __MSG_process_block(max_duration);
97 __MSG_process_block(-1);
99 if(surf_workstation_resource->extension_public->get_state(h_simdata->host)
101 MSG_RETURN(MSG_HOST_FAILURE);
102 h_simdata->sleeping[channel] = NULL;
104 /* OK, we should both be ready now. Are you there ? */
107 t_simdata = t->simdata;
108 /* *task = __MSG_task_copy(t); */
114 t_simdata->comm = surf_workstation_resource->extension_public->
115 communicate(MSG_process_get_host(t_simdata->sender)->simdata->host,
116 h->simdata->host, t_simdata->message_size,t_simdata->rate);
118 surf_workstation_resource->common_public->action_set_data(t_simdata->comm,t);
120 if(__MSG_process_isBlocked(t_simdata->sender))
121 __MSG_process_unblock(t_simdata->sender);
123 PAJE_PROCESS_PUSH_STATE(process,"C");
126 __MSG_task_wait_event(process, t);
127 state=surf_workstation_resource->common_public->action_get_state(t_simdata->comm);
128 } while (state==SURF_ACTION_RUNNING);
130 if(t->simdata->using>1) {
131 xbt_fifo_unshift(msg_global->process_to_run,process);
135 PAJE_PROCESS_POP_STATE(process);
136 PAJE_COMM_STOP(process,t,channel);
138 if(state == SURF_ACTION_DONE) {
139 if(surf_workstation_resource->common_public->action_free(t_simdata->comm))
140 t_simdata->comm = NULL;
142 } else if(surf_workstation_resource->extension_public->get_state(h_simdata->host)
144 if(surf_workstation_resource->common_public->action_free(t_simdata->comm))
145 t_simdata->comm = NULL;
146 MSG_RETURN(MSG_HOST_FAILURE);
148 if(surf_workstation_resource->common_public->action_free(t_simdata->comm))
149 t_simdata->comm = NULL;
150 MSG_RETURN(MSG_TRANSFER_FAILURE);
154 /** \ingroup msg_gos_functions
155 * \brief Test whether there is a pending communication on a channel.
157 * It takes one parameter.
158 * \param channel the channel on which the agent should be
159 listening. This value has to be >=0 and < than the maximal
160 number of channels fixed with MSG_set_channel_number().
161 * \return 1 if there is a pending communication and 0 otherwise
163 int MSG_task_Iprobe(m_channel_t channel)
166 simdata_host_t h_simdata = NULL;
168 xbt_assert1((channel>=0) && (channel < msg_global->max_channel),"Invalid channel %d",channel);
169 DEBUG2("Probing on channel %d (%s)", channel,h->name);
172 h_simdata = h->simdata;
173 return(xbt_fifo_get_first_item(h_simdata->mbox[channel])!=NULL);
176 /** \ingroup msg_gos_functions
177 * \brief Test whether there is a pending communication on a channel, and who sent it.
179 * It takes one parameter.
180 * \param channel the channel on which the agent should be
181 listening. This value has to be >=0 and < than the maximal
182 number of channels fixed with MSG_set_channel_number().
183 * \return -1 if there is no pending communication and the PID of the process who sent it otherwise
185 int MSG_task_probe_from(m_channel_t channel)
188 simdata_host_t h_simdata = NULL;
189 xbt_fifo_item_t item;
192 xbt_assert1((channel>=0) && (channel < msg_global->max_channel),"Invalid channel %d",channel);
195 h_simdata = h->simdata;
197 DEBUG2("Probing on channel %d (%s)", channel,h->name);
199 item = xbt_fifo_get_first_item(h->simdata->mbox[channel]);
200 if (!item || !(t = xbt_fifo_get_item_content(item)))
203 return MSG_process_get_PID(t->simdata->sender);
206 MSG_error_t MSG_channel_select_from(m_channel_t channel, double max_duration,
210 simdata_host_t h_simdata = NULL;
211 xbt_fifo_item_t item;
214 m_process_t process = MSG_process_self();
216 xbt_assert1((channel>=0) && (channel < msg_global->max_channel),"Invalid channel %d",channel);
221 if(max_duration==0.0) {
222 return MSG_task_probe_from(channel);
226 h_simdata = h->simdata;
228 DEBUG2("Probing on channel %d (%s)", channel,h->name);
229 while(!(item = xbt_fifo_get_first_item(h->simdata->mbox[channel]))) {
235 xbt_assert2(!(h_simdata->sleeping[channel]),
236 "A process (%s(%d)) is already blocked on this channel",
237 h_simdata->sleeping[channel]->name,
238 h_simdata->sleeping[channel]->simdata->PID);
239 h_simdata->sleeping[channel] = process; /* I'm waiting. Wake me up when you're ready */
241 __MSG_process_block(max_duration);
243 __MSG_process_block(-1);
245 if(surf_workstation_resource->extension_public->get_state(h_simdata->host)
247 MSG_RETURN(MSG_HOST_FAILURE);
249 h_simdata->sleeping[channel] = NULL;
252 if (!item || !(t = xbt_fifo_get_item_content(item))) {
256 *PID = MSG_process_get_PID(t->simdata->sender);
261 /** \ingroup msg_gos_functions
262 * \brief Put a task on a channel of an host and waits for the end of the
265 * This function is used for describing the behavior of an agent. It
266 * takes three parameter.
267 * \param task a #m_task_t to send on another location. This task
268 will not be usable anymore when the function will return. There is
269 no automatic task duplication and you have to save your parameters
270 before calling this function. Tasks are unique and once it has been
271 sent to another location, you should not access it anymore. You do
272 not need to call MSG_task_destroy() but to avoid using, as an
273 effect of inattention, this task anymore, you definitely should
274 renitialize it with #MSG_TASK_UNINITIALIZED. Note that this task
275 can be transfered iff it has been correctly created with
277 * \param dest the destination of the message
278 * \param channel the channel on which the agent should put this
279 task. This value has to be >=0 and < than the maximal number of
280 channels fixed with MSG_set_channel_number().
281 * \return #MSG_FATAL if \a task is not properly initialized and
284 MSG_error_t MSG_task_put(m_task_t task,
285 m_host_t dest, m_channel_t channel)
287 m_process_t process = MSG_process_self();
288 simdata_task_t task_simdata = NULL;
289 e_surf_action_state_t state = SURF_ACTION_NOT_IN_THE_SYSTEM;
290 m_host_t local_host = NULL;
291 m_host_t remote_host = NULL;
295 xbt_assert1((channel>=0) && (channel < msg_global->max_channel),"Invalid channel %d",channel);
297 task_simdata = task->simdata;
298 task_simdata->sender = process;
299 xbt_assert0(task_simdata->using==1,"Gargl!");
300 task_simdata->comm = NULL;
302 local_host = ((simdata_process_t) process->simdata)->host;
305 DEBUG4("Trying to send a task (%g Mb) from %s to %s on channel %d",
306 task->simdata->message_size,local_host->name, remote_host->name, channel);
308 xbt_fifo_push(((simdata_host_t) remote_host->simdata)->
309 mbox[channel], task);
311 PAJE_COMM_START(process,task,channel);
313 if(remote_host->simdata->sleeping[channel])
314 __MSG_process_unblock(remote_host->simdata->sleeping[channel]);
316 process->simdata->put_host = dest;
317 process->simdata->put_channel = channel;
318 while(!(task_simdata->comm))
319 __MSG_process_block(-1);
320 surf_workstation_resource->common_public->action_use(task_simdata->comm);
321 process->simdata->put_host = NULL;
322 process->simdata->put_channel = -1;
325 PAJE_PROCESS_PUSH_STATE(process,"C");
327 state=surf_workstation_resource->common_public->action_get_state(task_simdata->comm);
328 while (state==SURF_ACTION_RUNNING) {
329 __MSG_task_wait_event(process, task);
330 state=surf_workstation_resource->common_public->action_get_state(task_simdata->comm);
334 PAJE_PROCESS_POP_STATE(process);
336 if(state == SURF_ACTION_DONE) {
337 if(surf_workstation_resource->common_public->action_free(task_simdata->comm))
338 task_simdata->comm = NULL;
339 MSG_task_destroy(task);
341 } else if(surf_workstation_resource->extension_public->get_state(local_host->simdata->host)
343 if(surf_workstation_resource->common_public->action_free(task_simdata->comm))
344 task_simdata->comm = NULL;
345 MSG_task_destroy(task);
346 MSG_RETURN(MSG_HOST_FAILURE);
348 if(surf_workstation_resource->common_public->action_free(task_simdata->comm))
349 task_simdata->comm = NULL;
350 MSG_task_destroy(task);
351 MSG_RETURN(MSG_TRANSFER_FAILURE);
355 /** \ingroup msg_gos_functions
356 * \brief Does exactly the same as MSG_task_put but with a bounded transmition
361 MSG_error_t MSG_task_put_bounded(m_task_t task,
362 m_host_t dest, m_channel_t channel,
365 MSG_error_t res = MSG_OK;
366 task->simdata->rate=max_rate;
367 res = MSG_task_put(task, dest, channel);
368 task->simdata->rate=-1.0;
372 /** \ingroup msg_gos_functions
373 * \brief Executes a task and waits for its termination.
375 * This function is used for describing the behavior of an agent. It
376 * takes only one parameter.
377 * \param task a #m_task_t to execute on the location on which the
379 * \return #MSG_FATAL if \a task is not properly initialized and
382 MSG_error_t MSG_task_execute(m_task_t task)
384 m_process_t process = MSG_process_self();
387 DEBUG1("Computing on %s", process->simdata->host->name);
389 __MSG_task_execute(process, task);
391 PAJE_PROCESS_PUSH_STATE(process,"E");
392 res = __MSG_wait_for_computation(process,task);
393 PAJE_PROCESS_POP_STATE(process);
397 void __MSG_task_execute(m_process_t process, m_task_t task)
399 simdata_task_t simdata = NULL;
403 simdata = task->simdata;
405 simdata->compute = surf_workstation_resource->extension_public->
406 execute(MSG_process_get_host(process)->simdata->host,
407 simdata->computation_amount);
408 surf_workstation_resource->common_public->
409 set_priority(simdata->compute, simdata->priority);
411 surf_workstation_resource->common_public->action_set_data(simdata->compute,task);
414 MSG_error_t __MSG_wait_for_computation(m_process_t process, m_task_t task)
416 e_surf_action_state_t state = SURF_ACTION_NOT_IN_THE_SYSTEM;
417 simdata_task_t simdata = task->simdata;
421 __MSG_task_wait_event(process, task);
422 state=surf_workstation_resource->common_public->action_get_state(simdata->compute);
423 } while (state==SURF_ACTION_RUNNING);
427 if(state == SURF_ACTION_DONE) {
428 if(surf_workstation_resource->common_public->action_free(simdata->compute))
429 simdata->compute = NULL;
430 simdata->computation_amount = 0.0;
432 } else if(surf_workstation_resource->extension_public->
433 get_state(MSG_process_get_host(process)->simdata->host)
435 if(surf_workstation_resource->common_public->action_free(simdata->compute))
436 simdata->compute = NULL;
437 MSG_RETURN(MSG_HOST_FAILURE);
439 if(surf_workstation_resource->common_public->action_free(simdata->compute))
440 simdata->compute = NULL;
441 MSG_RETURN(MSG_TASK_CANCELLED);
444 /** \ingroup m_task_management
445 * \brief Creates a new #m_task_t (a parallel one....).
447 * A constructor for #m_task_t taking six arguments and returning the
448 corresponding object.
449 * \param name a name for the object. It is for user-level information
451 * \param host_nb the number of hosts implied in the parallel task.
452 * \param host_list an array of #host_nb m_host_t.
453 * \param computation_amount an array of #host_nb
454 doubles. computation_amount[i] is the total number of operations
455 that have to be performed on host_list[i].
456 * \param communication_amount an array of #host_nb*#host_nb doubles.
457 * \param data a pointer to any data may want to attach to the new
458 object. It is for user-level information and can be NULL. It can
459 be retrieved with the function \ref MSG_task_get_data.
461 * \return The new corresponding object.
463 m_task_t MSG_parallel_task_create(const char *name,
465 const m_host_t *host_list,
466 double *computation_amount,
467 double *communication_amount,
470 simdata_task_t simdata = xbt_new0(s_simdata_task_t,1);
471 m_task_t task = xbt_new0(s_m_task_t,1);
475 task->name = xbt_strdup(name);
476 task->simdata = simdata;
480 simdata->sleeping = xbt_dynar_new(sizeof(m_process_t),NULL);
481 simdata->rate = -1.0;
483 simdata->sender = NULL;
484 simdata->host_nb = host_nb;
486 simdata->host_list = xbt_new0(void *, host_nb);
487 simdata->comp_amount = computation_amount;
488 simdata->comm_amount = communication_amount;
490 for(i=0;i<host_nb;i++)
491 simdata->host_list[i] = host_list[i]->simdata->host;
497 static void __MSG_parallel_task_execute(m_process_t process, m_task_t task)
499 simdata_task_t simdata = NULL;
503 simdata = task->simdata;
505 xbt_assert0(simdata->host_nb,"This is not a parallel task. Go to hell.");
507 simdata->compute = surf_workstation_resource->extension_public->
508 execute_parallel_task(task->simdata->host_nb,
509 task->simdata->host_list,
510 task->simdata->comp_amount,
511 task->simdata->comm_amount,
515 surf_workstation_resource->common_public->action_set_data(simdata->compute,task);
518 MSG_error_t MSG_parallel_task_execute(m_task_t task)
520 m_process_t process = MSG_process_self();
523 DEBUG0("Computing on a tons of guys");
525 __MSG_parallel_task_execute(process, task);
527 if(task->simdata->compute)
528 res = __MSG_wait_for_computation(process,task);
536 /** \ingroup msg_gos_functions
537 * \brief Sleep for the specified number of seconds
539 * Makes the current process sleep until \a time seconds have elapsed.
541 * \param nb_sec a number of second
543 MSG_error_t MSG_process_sleep(double nb_sec)
545 e_surf_action_state_t state = SURF_ACTION_NOT_IN_THE_SYSTEM;
546 m_process_t process = MSG_process_self();
547 m_task_t dummy = NULL;
548 simdata_task_t simdata = NULL;
551 dummy = MSG_task_create("MSG_sleep", nb_sec, 0.0, NULL);
552 simdata = dummy->simdata;
554 simdata->compute = surf_workstation_resource->extension_public->
555 sleep(MSG_process_get_host(process)->simdata->host,
556 simdata->computation_amount);
557 surf_workstation_resource->common_public->action_set_data(simdata->compute,dummy);
562 __MSG_task_wait_event(process, dummy);
563 state=surf_workstation_resource->common_public->action_get_state(simdata->compute);
564 } while (state==SURF_ACTION_RUNNING);
567 if(state == SURF_ACTION_DONE) {
568 if(surf_workstation_resource->extension_public->
569 get_state(MSG_process_get_host(process)->simdata->host)
571 if(surf_workstation_resource->common_public->action_free(simdata->compute))
572 simdata->compute = NULL;
573 MSG_RETURN(MSG_HOST_FAILURE);
575 if(__MSG_process_isBlocked(process)) {
576 __MSG_process_unblock(MSG_process_self());
578 if(surf_workstation_resource->extension_public->
579 get_state(MSG_process_get_host(process)->simdata->host)
581 if(surf_workstation_resource->common_public->action_free(simdata->compute))
582 simdata->compute = NULL;
583 MSG_RETURN(MSG_HOST_FAILURE);
585 if(surf_workstation_resource->common_public->action_free(simdata->compute))
586 simdata->compute = NULL;
587 MSG_task_destroy(dummy);
589 } else MSG_RETURN(MSG_HOST_FAILURE);
592 /** \ingroup msg_gos_functions
593 * \brief Return the number of MSG tasks currently running on a
594 * the host of the current running process.
596 static int MSG_get_msgload(void)
602 xbt_assert0(0, "This function is still to be specified correctly (what do you mean by 'load', exactly?). In the meantime, please don't use it");
603 process = MSG_process_self();
604 return xbt_fifo_size(process->simdata->host->simdata->process_list);
607 /** \ingroup msg_gos_functions
609 * \brief Return the the last value returned by a MSG function (except
612 MSG_error_t MSG_get_errno(void)
614 return PROCESS_GET_ERRNO();