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. */
10 #include "xbt/error.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 This function is now deprecated and useless. Please stop using it.
22 MSG_error_t MSG_process_start(m_process_t process)
24 xbt_assert0(0,"This function is now deprecated and useless. Please stop using it.");
29 /** \ingroup msg_gos_functions
30 * \brief Listen on a channel and wait for receiving a task.
32 * It takes two parameters.
33 * \param task a memory location for storing a #m_task_t. It will
34 hold a task when this function will return. Thus \a task should not
35 be equal to \c NULL and \a *task should be equal to \c NULL. If one of
36 those two condition does not hold, there will be a warning message.
37 * \param channel the channel on which the agent should be
38 listening. This value has to be >=0 and < than the maximal
39 number of channels fixed with MSG_set_channel_number().
40 * \return #MSG_FATAL if \a task is equal to \c NULL, #MSG_WARNING
41 * if \a *task is not equal to \c NULL, and #MSG_OK otherwise.
43 MSG_error_t MSG_task_get(m_task_t * task,
46 return MSG_task_get_with_time_out(task, channel, -1);
49 /** \ingroup msg_gos_functions
50 * \brief Listen on a channel and wait for receiving a task with a timeout.
52 * It takes three parameters.
53 * \param task a memory location for storing a #m_task_t. It will
54 hold a task when this function will return. Thus \a task should not
55 be equal to \c NULL and \a *task should be equal to \c NULL. If one of
56 those two condition does not hold, there will be a warning message.
57 * \param channel the channel on which the agent should be
58 listening. This value has to be >=0 and < than the maximal
59 number of channels fixed with MSG_set_channel_number().
60 * \param timeout the maximum time to wait for a task before giving
61 up. In such a case, \a task will not be modified and will still be
62 equal to \c NULL when returning.
63 * \return #MSG_FATAL if \a task is equal to \c NULL, #MSG_WARNING
64 if \a *task is not equal to \c NULL, and #MSG_OK otherwise.
67 MSG_error_t MSG_task_get_with_time_out(m_task_t * task,
71 m_process_t process = MSG_process_self();
74 simdata_task_t t_simdata = NULL;
75 simdata_host_t h_simdata = NULL;
78 e_surf_action_state_t state = SURF_ACTION_NOT_IN_THE_SYSTEM;
82 xbt_assert0(task,"Null pointer for the task\n");
85 CRITICAL0("MSG_task_get() was asked to write in a non empty task struct.");
89 h_simdata = h->simdata;
91 DEBUG2("Waiting for a task on channel %d (%s)", channel,h->name);
93 while ((t = xbt_fifo_shift(h_simdata->mbox[channel])) == NULL) {
99 xbt_assert2(!(h_simdata->sleeping[channel]),
100 "A process (%s(%d)) is already blocked on this channel",
101 h_simdata->sleeping[channel]->name,
102 h_simdata->sleeping[channel]->simdata->PID);
103 h_simdata->sleeping[channel] = process; /* I'm waiting. Wake me up when you're ready */
105 __MSG_process_block(max_duration);
107 __MSG_process_block(-1);
109 if(surf_workstation_resource->extension_public->get_state(h_simdata->host)
111 MSG_RETURN(MSG_HOST_FAILURE);
112 h_simdata->sleeping[channel] = NULL;
114 /* OK, we should both be ready now. Are you there ? */
117 t_simdata = t->simdata;
118 /* *task = __MSG_task_copy(t); */
124 t_simdata->comm = surf_workstation_resource->extension_public->
125 communicate(MSG_process_get_host(t_simdata->sender)->simdata->host,
126 h->simdata->host, t_simdata->message_size,t_simdata->rate);
128 surf_workstation_resource->common_public->action_set_data(t_simdata->comm,t);
130 if(__MSG_process_isBlocked(t_simdata->sender))
131 __MSG_process_unblock(t_simdata->sender);
133 PAJE_PROCESS_PUSH_STATE(process,"C");
136 __MSG_task_wait_event(process, t);
137 state=surf_workstation_resource->common_public->action_get_state(t_simdata->comm);
138 } while (state==SURF_ACTION_RUNNING);
140 if(t->simdata->using>1) {
141 xbt_fifo_unshift(msg_global->process_to_run,process);
145 PAJE_PROCESS_POP_STATE(process);
146 PAJE_COMM_STOP(process,t,channel);
148 if(state == SURF_ACTION_DONE) {
149 if(surf_workstation_resource->common_public->action_free(t_simdata->comm))
150 t_simdata->comm = NULL;
152 } else if(surf_workstation_resource->extension_public->get_state(h_simdata->host)
154 if(surf_workstation_resource->common_public->action_free(t_simdata->comm))
155 t_simdata->comm = NULL;
156 MSG_RETURN(MSG_HOST_FAILURE);
158 if(surf_workstation_resource->common_public->action_free(t_simdata->comm))
159 t_simdata->comm = NULL;
160 MSG_RETURN(MSG_TRANSFER_FAILURE);
164 /** \ingroup msg_gos_functions
165 * \brief Test whether there is a pending communication on a channel.
167 * It takes one parameter.
168 * \param channel the channel on which the agent should be
169 listening. This value has to be >=0 and < than the maximal
170 number of channels fixed with MSG_set_channel_number().
171 * \return 1 if there is a pending communication and 0 otherwise
173 int MSG_task_Iprobe(m_channel_t channel)
176 simdata_host_t h_simdata = NULL;
178 DEBUG2("Probing on channel %d (%s)", channel,h->name);
181 h_simdata = h->simdata;
182 return(xbt_fifo_getFirstItem(h_simdata->mbox[channel])!=NULL);
185 /** \ingroup msg_gos_functions
186 * \brief Test whether there is a pending communication on a channel, and who sent it.
188 * It takes one parameter.
189 * \param channel the channel on which the agent should be
190 listening. This value has to be >=0 and < than the maximal
191 number of channels fixed with MSG_set_channel_number().
192 * \return -1 if there is no pending communication and the PID of the process who sent it otherwise
194 int MSG_task_probe_from(m_channel_t channel)
197 simdata_host_t h_simdata = NULL;
198 xbt_fifo_item_t item;
203 h_simdata = h->simdata;
205 DEBUG2("Probing on channel %d (%s)", channel,h->name);
207 item = xbt_fifo_getFirstItem(h->simdata->mbox[channel]);
208 if (!item || !(t = xbt_fifo_get_item_content(item)))
211 return MSG_process_get_PID(t->simdata->sender);
214 /** \ingroup msg_gos_functions
215 * \brief Put a task on a channel of an host and waits for the end of the
218 * This function is used for describing the behavior of an agent. It
219 * takes three parameter.
220 * \param task a #m_task_t to send on another location. This task
221 will not be usable anymore when the function will return. There is
222 no automatic task duplication and you have to save your parameters
223 before calling this function. Tasks are unique and once it has been
224 sent to another location, you should not access it anymore. You do
225 not need to call MSG_task_destroy() but to avoid using, as an
226 effect of inattention, this task anymore, you definitely should
227 renitialize it with #MSG_TASK_UNINITIALIZED. Note that this task
228 can be transfered iff it has been correctly created with
230 * \param dest the destination of the message
231 * \param channel the channel on which the agent should put this
232 task. This value has to be >=0 and < than the maximal number of
233 channels fixed with MSG_set_channel_number().
234 * \return #MSG_FATAL if \a task is not properly initialized and
237 MSG_error_t MSG_task_put(m_task_t task,
238 m_host_t dest, m_channel_t channel)
240 m_process_t process = MSG_process_self();
241 simdata_task_t task_simdata = NULL;
242 e_surf_action_state_t state = SURF_ACTION_NOT_IN_THE_SYSTEM;
243 m_host_t local_host = NULL;
244 m_host_t remote_host = NULL;
248 task_simdata = task->simdata;
249 task_simdata->sender = process;
250 xbt_assert0(task_simdata->using==1,"Gargl!");
251 task_simdata->comm = NULL;
253 local_host = ((simdata_process_t) process->simdata)->host;
256 DEBUG4("Trying to send a task (%lg Mb) from %s to %s on channel %d",
257 task->simdata->message_size,local_host->name, remote_host->name, channel);
259 xbt_fifo_push(((simdata_host_t) remote_host->simdata)->
260 mbox[channel], task);
262 PAJE_COMM_START(process,task,channel);
264 if(remote_host->simdata->sleeping[channel])
265 __MSG_process_unblock(remote_host->simdata->sleeping[channel]);
267 process->simdata->put_host = dest;
268 process->simdata->put_channel = channel;
269 while(!(task_simdata->comm))
270 __MSG_process_block(-1);
271 surf_workstation_resource->common_public->action_use(task_simdata->comm);
272 process->simdata->put_host = NULL;
273 process->simdata->put_channel = -1;
276 PAJE_PROCESS_PUSH_STATE(process,"C");
278 state=surf_workstation_resource->common_public->action_get_state(task_simdata->comm);
279 while (state==SURF_ACTION_RUNNING) {
280 __MSG_task_wait_event(process, task);
281 state=surf_workstation_resource->common_public->action_get_state(task_simdata->comm);
284 MSG_task_destroy(task);
286 PAJE_PROCESS_POP_STATE(process);
288 if(state == SURF_ACTION_DONE) {
289 if(surf_workstation_resource->common_public->action_free(task_simdata->comm))
290 task_simdata->comm = NULL;
292 } else if(surf_workstation_resource->extension_public->get_state(local_host->simdata->host)
294 if(surf_workstation_resource->common_public->action_free(task_simdata->comm))
295 task_simdata->comm = NULL;
296 MSG_RETURN(MSG_HOST_FAILURE);
298 if(surf_workstation_resource->common_public->action_free(task_simdata->comm))
299 task_simdata->comm = NULL;
300 MSG_RETURN(MSG_TRANSFER_FAILURE);
304 /** \ingroup msg_gos_functions
305 * \brief Does exactly the same as MSG_task_put but with a bounded transmition
310 MSG_error_t MSG_task_put_bounded(m_task_t task,
311 m_host_t dest, m_channel_t channel,
314 task->simdata->rate=max_rate;
315 return(MSG_task_put(task, dest, channel));
316 task->simdata->rate=-1.0;
319 /** \ingroup msg_gos_functions
320 * \brief Executes a task and waits for its termination.
322 * This function is used for describing the behavior of an agent. It
323 * takes only one parameter.
324 * \param task a #m_task_t to execute on the location on which the
326 * \return #MSG_FATAL if \a task is not properly initialized and
329 MSG_error_t MSG_task_execute(m_task_t task)
331 m_process_t process = MSG_process_self();
334 DEBUG1("Computing on %s", process->simdata->host->name);
336 __MSG_task_execute(process, task);
338 PAJE_PROCESS_PUSH_STATE(process,"E");
339 res = __MSG_wait_for_computation(process,task);
340 PAJE_PROCESS_POP_STATE(process);
344 void __MSG_task_execute(m_process_t process, m_task_t task)
346 simdata_task_t simdata = NULL;
350 simdata = task->simdata;
352 simdata->compute = surf_workstation_resource->extension_public->
353 execute(MSG_process_get_host(process)->simdata->host,
354 simdata->computation_amount);
355 surf_workstation_resource->common_public->action_set_data(simdata->compute,task);
358 MSG_error_t __MSG_wait_for_computation(m_process_t process, m_task_t task)
360 e_surf_action_state_t state = SURF_ACTION_NOT_IN_THE_SYSTEM;
361 simdata_task_t simdata = task->simdata;
365 __MSG_task_wait_event(process, task);
366 state=surf_workstation_resource->common_public->action_get_state(simdata->compute);
367 } while (state==SURF_ACTION_RUNNING);
371 if(state == SURF_ACTION_DONE) {
372 if(surf_workstation_resource->common_public->action_free(simdata->compute))
373 simdata->compute = NULL;
375 } else if(surf_workstation_resource->extension_public->
376 get_state(MSG_process_get_host(process)->simdata->host)
378 if(surf_workstation_resource->common_public->action_free(simdata->compute))
379 simdata->compute = NULL;
380 MSG_RETURN(MSG_HOST_FAILURE);
382 if(surf_workstation_resource->common_public->action_free(simdata->compute))
383 simdata->compute = NULL;
384 MSG_RETURN(MSG_TRANSFER_FAILURE);
388 /** \ingroup msg_gos_functions
389 * \brief Sleep for the specified number of seconds
391 * Makes the current process sleep until \a time seconds have elapsed.
393 * \param nb_sec a number of second
395 MSG_error_t MSG_process_sleep(double nb_sec)
397 e_surf_action_state_t state = SURF_ACTION_NOT_IN_THE_SYSTEM;
398 m_process_t process = MSG_process_self();
399 m_task_t dummy = NULL;
400 simdata_task_t simdata = NULL;
403 dummy = MSG_task_create("MSG_sleep", nb_sec, 0.0, NULL);
404 simdata = dummy->simdata;
406 simdata->compute = surf_workstation_resource->extension_public->
407 sleep(MSG_process_get_host(process)->simdata->host,
408 simdata->computation_amount);
409 surf_workstation_resource->common_public->action_set_data(simdata->compute,dummy);
414 __MSG_task_wait_event(process, dummy);
415 state=surf_workstation_resource->common_public->action_get_state(simdata->compute);
416 } while (state==SURF_ACTION_RUNNING);
419 if(state == SURF_ACTION_DONE) {
420 if(surf_workstation_resource->extension_public->
421 get_state(MSG_process_get_host(process)->simdata->host)
423 if(surf_workstation_resource->common_public->action_free(simdata->compute))
424 simdata->compute = NULL;
425 MSG_RETURN(MSG_HOST_FAILURE);
427 if(__MSG_process_isBlocked(process)) {
428 __MSG_process_unblock(MSG_process_self());
430 if(surf_workstation_resource->extension_public->
431 get_state(MSG_process_get_host(process)->simdata->host)
433 if(surf_workstation_resource->common_public->action_free(simdata->compute))
434 simdata->compute = NULL;
435 MSG_RETURN(MSG_HOST_FAILURE);
437 if(surf_workstation_resource->common_public->action_free(simdata->compute))
438 simdata->compute = NULL;
439 MSG_task_destroy(dummy);
441 } else MSG_RETURN(MSG_HOST_FAILURE);
444 /** \ingroup msg_gos_functions
445 * \brief Return the number of MSG tasks currently running on a
446 * the host of the current running process.
448 int MSG_get_msgload(void)
454 process = MSG_process_self();
455 return xbt_fifo_size(process->simdata->host->simdata->process_list);
458 /** \ingroup msg_gos_functions
460 * \brief Return the the last value returned by a MSG function (except
463 MSG_error_t MSG_get_errno(void)
465 return PROCESS_GET_ERRNO();