1 /* smx_user.c - public interface to simix */
3 /* Copyright (c) 2010, 2011. Da SimGrid team. 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. */
8 # define _SVID_SOURCE /* strdup() */
10 #ifndef _ISOC99_SOURCE
11 # define _ISOC99_SOURCE /* isfinite() */
13 #ifndef _ISO_C99_SOURCE
14 # define _ISO_C99_SOURCE /* isfinite() */
16 #include <math.h> /* isfinite() */
18 #include "smx_private.h"
22 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(simix);
24 static const char* simcall_names[] = {
25 #undef SIMCALL_ENUM_ELEMENT
26 #define SIMCALL_ENUM_ELEMENT(x) #x /* generate strings from the enumeration values */
28 #undef SIMCALL_ENUM_ELEMENT
32 * \brief Returns a host given its name.
34 * \param name The name of the host to get
35 * \return The corresponding host
37 smx_host_t simcall_host_get_by_name(const char *name)
39 smx_simcall_t simcall = SIMIX_simcall_mine();
41 simcall->call = SIMCALL_HOST_GET_BY_NAME;
42 simcall->host_get_by_name.name = name;
43 SIMIX_simcall_push(simcall->issuer);
44 return simcall->host_get_by_name.result;
48 * \brief Returns the name of a host.
50 * \param host A SIMIX host
51 * \return The name of this host
53 const char* simcall_host_get_name(smx_host_t host)
55 smx_simcall_t simcall = SIMIX_simcall_mine();
57 simcall->call = SIMCALL_HOST_GET_NAME;
58 simcall->host_get_name.host = host;
59 SIMIX_simcall_push(simcall->issuer);
60 return simcall->host_get_name.result;
64 * \brief Returns a dict of the properties assigned to a host.
67 * \return The properties of this host
69 xbt_dict_t simcall_host_get_properties(smx_host_t host)
71 smx_simcall_t simcall = SIMIX_simcall_mine();
73 simcall->call = SIMCALL_HOST_GET_PROPERTIES;
74 simcall->host_get_properties.host = host;
75 SIMIX_simcall_push(simcall->issuer);
76 return simcall->host_get_properties.result;
80 * \brief Returns the speed of the processor.
82 * The speed returned does not take into account the current load on the machine.
83 * \param host A SIMIX host
84 * \return The speed of this host (in Mflop/s)
86 double simcall_host_get_speed(smx_host_t host)
88 smx_simcall_t simcall = SIMIX_simcall_mine();
90 simcall->call = SIMCALL_HOST_GET_SPEED;
91 simcall->host_get_speed.host = host;
92 SIMIX_simcall_push(simcall->issuer);
93 return simcall->host_get_speed.result;
97 * \brief Returns the available speed of the processor.
99 * \return Speed currently available (in Mflop/s)
101 double simcall_host_get_available_speed(smx_host_t host)
103 smx_simcall_t simcall = SIMIX_simcall_mine();
105 simcall->call = SIMCALL_HOST_GET_AVAILABLE_SPEED;
106 simcall->host_get_available_speed.host = host;
107 SIMIX_simcall_push(simcall->issuer);
108 return simcall->host_get_available_speed.result;
112 * \brief Returns the state of a host.
114 * Two states are possible: 1 if the host is active or 0 if it has crashed.
115 * \param host A SIMIX host
116 * \return 1 if the host is available, 0 otherwise
118 int simcall_host_get_state(smx_host_t host)
120 smx_simcall_t simcall = SIMIX_simcall_mine();
122 simcall->call = SIMCALL_HOST_GET_STATE;
123 simcall->host_get_state.host = host;
124 SIMIX_simcall_push(simcall->issuer);
125 return simcall->host_get_state.result;
129 * \brief Returns the user data associated to a host.
131 * \param host SIMIX host
132 * \return the user data of this host
134 void* simcall_host_get_data(smx_host_t host)
136 smx_simcall_t simcall = SIMIX_simcall_mine();
138 simcall->call = SIMCALL_HOST_GET_DATA;
139 simcall->host_get_data.host = host;
140 SIMIX_simcall_push(simcall->issuer);
141 return simcall->host_get_data.result;
145 * \brief Sets the user data associated to a host.
147 * The host must not have previous user data associated to it.
148 * \param A host SIMIX host
149 * \param data The user data to set
151 void simcall_host_set_data(smx_host_t host, void *data)
153 smx_simcall_t simcall = SIMIX_simcall_mine();
155 simcall->call = SIMCALL_HOST_SET_DATA;
156 simcall->host_set_data.host = host;
157 simcall->host_set_data.data = data;
158 SIMIX_simcall_push(simcall->issuer);
161 /** \brief Creates an action that executes some computation of an host.
163 * This function creates a SURF action and allocates the data necessary
164 * to create the SIMIX action. It can raise a host_error exception if the host crashed.
166 * \param name Name of the execution action to create
167 * \param host SIMIX host where the action will be executed
168 * \param amount Computation amount (in bytes)
169 * \return A new SIMIX execution action
171 smx_action_t simcall_host_execute(const char *name, smx_host_t host,
172 double computation_amount,
175 /* checking for infinite values */
176 xbt_assert(isfinite(computation_amount), "computation_amount is not finite!");
177 xbt_assert(isfinite(priority), "priority is not finite!");
179 smx_simcall_t simcall = SIMIX_simcall_mine();
181 simcall->call = SIMCALL_HOST_EXECUTE;
182 simcall->host_execute.name = name;
183 simcall->host_execute.host = host;
184 simcall->host_execute.computation_amount = computation_amount;
185 simcall->host_execute.priority = priority;
186 SIMIX_simcall_push(simcall->issuer);
187 return simcall->host_execute.result;
190 /** \brief Creates an action that may involve parallel computation on
191 * several hosts and communication between them.
193 * \param name Name of the execution action to create
194 * \param host_nb Number of hosts where the action will be executed
195 * \param host_list Array (of size host_nb) of hosts where the action will be executed
196 * \param computation_amount Array (of size host_nb) of computation amount of hosts (in bytes)
197 * \param communication_amount Array (of size host_nb * host_nb) representing the communication
198 * amount between each pair of hosts
199 * \param amount the SURF action amount
200 * \param rate the SURF action rate
201 * \return A new SIMIX execution action
203 smx_action_t simcall_host_parallel_execute(const char *name,
205 smx_host_t *host_list,
206 double *computation_amount,
207 double *communication_amount,
212 /* checking for infinite values */
213 for (i = 0 ; i < host_nb ; ++i) {
214 xbt_assert(isfinite(computation_amount[i]), "computation_amount[%d] is not finite!", i);
215 for (j = 0 ; j < host_nb ; ++j) {
216 xbt_assert(isfinite(communication_amount[i + host_nb * j]),
217 "communication_amount[%d+%d*%d] is not finite!", i, host_nb, j);
221 xbt_assert(isfinite(amount), "amount is not finite!");
222 xbt_assert(isfinite(rate), "rate is not finite!");
224 smx_simcall_t simcall = SIMIX_simcall_mine();
226 simcall->call = SIMCALL_HOST_PARALLEL_EXECUTE;
227 simcall->host_parallel_execute.name = name;
228 simcall->host_parallel_execute.host_nb = host_nb;
229 simcall->host_parallel_execute.host_list = host_list;
230 simcall->host_parallel_execute.computation_amount = computation_amount;
231 simcall->host_parallel_execute.communication_amount = communication_amount;
232 simcall->host_parallel_execute.amount = amount;
233 simcall->host_parallel_execute.rate = rate;
234 SIMIX_simcall_push(simcall->issuer);
235 return simcall->host_parallel_execute.result;
239 * \brief Destroys an execution action.
241 * Destroys an action, freing its memory. This function cannot be called if there are a conditional waiting for it.
242 * \param action The execution action to destroy
244 void simcall_host_execution_destroy(smx_action_t execution)
246 smx_simcall_t simcall = SIMIX_simcall_mine();
248 simcall->call = SIMCALL_HOST_EXECUTION_DESTROY;
249 simcall->host_execution_destroy.execution = execution;
250 SIMIX_simcall_push(simcall->issuer);
254 * \brief Cancels an execution action.
256 * This functions stops the execution. It calls a surf function.
257 * \param action The execution action to cancel
259 void simcall_host_execution_cancel(smx_action_t execution)
261 smx_simcall_t simcall = SIMIX_simcall_mine();
263 simcall->call = SIMCALL_HOST_EXECUTION_CANCEL;
264 simcall->host_execution_cancel.execution = execution;
265 SIMIX_simcall_push(simcall->issuer);
269 * \brief Returns how much of an execution action remains to be done.
271 * \param Action The execution action
272 * \return The remaining amount
274 double simcall_host_execution_get_remains(smx_action_t execution)
276 smx_simcall_t simcall = SIMIX_simcall_mine();
278 simcall->call = SIMCALL_HOST_EXECUTION_GET_REMAINS;
279 simcall->host_execution_get_remains.execution = execution;
280 SIMIX_simcall_push(simcall->issuer);
281 return simcall->host_execution_get_remains.result;
285 * \brief Returns the state of an execution action.
287 * \param execution The execution action
290 e_smx_state_t simcall_host_execution_get_state(smx_action_t execution)
292 smx_simcall_t simcall = SIMIX_simcall_mine();
294 simcall->call = SIMCALL_HOST_EXECUTION_GET_STATE;
295 simcall->host_execution_get_state.execution = execution;
296 SIMIX_simcall_push(simcall->issuer);
297 return simcall->host_execution_get_state.result;
301 * \brief Changes the priority of an execution action.
303 * This functions changes the priority only. It calls a surf function.
304 * \param execution The execution action
305 * \param priority The new priority
307 void simcall_host_execution_set_priority(smx_action_t execution, double priority)
309 /* checking for infinite values */
310 xbt_assert(isfinite(priority), "priority is not finite!");
312 smx_simcall_t simcall = SIMIX_simcall_mine();
314 simcall->call = SIMCALL_HOST_EXECUTION_SET_PRIORITY;
315 simcall->host_execution_set_priority.execution = execution;
316 simcall->host_execution_set_priority.priority = priority;
317 SIMIX_simcall_push(simcall->issuer);
321 * \brief Waits for the completion of an execution action and destroy it.
323 * \param execution The execution action
325 e_smx_state_t simcall_host_execution_wait(smx_action_t execution)
327 smx_simcall_t simcall = SIMIX_simcall_mine();
329 simcall->call = SIMCALL_HOST_EXECUTION_WAIT;
330 simcall->host_execution_wait.execution = execution;
331 SIMIX_simcall_push(simcall->issuer);
332 return simcall->host_execution_wait.result;
336 * \brief Creates and runs a new SIMIX process.
338 * The structure and the corresponding thread are created and put in the list of ready processes.
340 * \param process the process created will be stored in this pointer
341 * \param name a name for the process. It is for user-level information and can be NULL.
342 * \param code the main function of the process
343 * \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.
344 * It can be retrieved with the function \ref simcall_process_get_data.
345 * \param hostname name of the host where the new agent is executed.
346 * \param kill_time time when the process is killed
347 * \param argc first argument passed to \a code
348 * \param argv second argument passed to \a code
349 * \param properties the properties of the process
351 void simcall_process_create(smx_process_t *process, const char *name,
352 xbt_main_func_t code,
354 const char *hostname,
356 int argc, char **argv,
357 xbt_dict_t properties)
359 smx_simcall_t simcall = SIMIX_simcall_mine();
361 simcall->call = SIMCALL_PROCESS_CREATE;
362 simcall->process_create.process = process;
363 simcall->process_create.name = name;
364 simcall->process_create.code = code;
365 simcall->process_create.data = data;
366 simcall->process_create.hostname = hostname;
367 simcall->process_create.kill_time = kill_time;
368 simcall->process_create.argc = argc;
369 simcall->process_create.argv = argv;
370 simcall->process_create.properties = properties;
371 SIMIX_simcall_push(simcall->issuer);
374 /** \brief Kills a SIMIX process.
376 * This function simply kills a process.
378 * \param process poor victim
380 void simcall_process_kill(smx_process_t process)
382 smx_simcall_t simcall = SIMIX_simcall_mine();
384 simcall->call = SIMCALL_PROCESS_KILL;
385 simcall->process_kill.process = process;
386 SIMIX_simcall_push(simcall->issuer);
389 /** \brief Kills all SIMIX processes.
391 void simcall_process_killall(void)
393 smx_simcall_t simcall = SIMIX_simcall_mine();
395 simcall->call = SIMCALL_PROCESS_KILLALL;
396 SIMIX_simcall_push(simcall->issuer);
399 /** \brief Cleans up a SIMIX process.
400 * \param process poor victim (must have already been killed)
402 void simcall_process_cleanup(smx_process_t process)
404 smx_simcall_t simcall = SIMIX_simcall_mine();
406 simcall->call = SIMCALL_PROCESS_CLEANUP;
407 simcall->process_cleanup.process = process;
408 SIMIX_simcall_push(simcall->issuer);
412 * \brief Migrates an agent to another location.
414 * This function changes the value of the host on which \a process is running.
416 * \param process the process to migrate
417 * \param source name of the previous host
418 * \param dest name of the new host
420 void simcall_process_change_host(smx_process_t process, smx_host_t dest)
422 smx_simcall_t simcall = SIMIX_simcall_mine();
424 simcall->call = SIMCALL_PROCESS_CHANGE_HOST;
425 simcall->process_change_host.process = process;
426 simcall->process_change_host.dest = dest;
427 SIMIX_simcall_push(simcall->issuer);
431 * \brief Suspends a process.
433 * This function suspends the process by suspending the action
434 * it was waiting for completion.
436 * \param process a SIMIX process
438 void simcall_process_suspend(smx_process_t process)
440 xbt_assert(process, "Invalid parameters");
442 smx_simcall_t simcall = SIMIX_simcall_mine();
444 simcall->call = SIMCALL_PROCESS_SUSPEND;
445 simcall->process_suspend.process = process;
446 SIMIX_simcall_push(simcall->issuer);
450 * \brief Resumes a suspended process.
452 * This function resumes a suspended process by resuming the action
453 * it was waiting for completion.
455 * \param process a SIMIX process
457 void simcall_process_resume(smx_process_t process)
459 smx_simcall_t simcall = SIMIX_simcall_mine();
461 simcall->call = SIMCALL_PROCESS_RESUME;
462 simcall->process_resume.process = process;
463 SIMIX_simcall_push(simcall->issuer);
467 * \brief Returns the amount of SIMIX processes in the system
469 * Maestro internal process is not counted, only user code processes are
471 int simcall_process_count(void)
473 smx_simcall_t simcall = SIMIX_simcall_mine();
475 simcall->call = SIMCALL_PROCESS_COUNT;
476 SIMIX_simcall_push(simcall->issuer);
477 return simcall->process_count.result;
481 * \brief Return the user data of a #smx_process_t.
482 * \param process a SIMIX process
483 * \return the user data of this process
485 void* simcall_process_get_data(smx_process_t process)
487 if (process == SIMIX_process_self()) {
488 /* avoid a simcall if this function is called by the process itself */
489 return SIMIX_process_get_data(process);
492 smx_simcall_t simcall = SIMIX_simcall_mine();
494 simcall->call = SIMCALL_PROCESS_GET_DATA;
495 simcall->process_get_data.process = process;
496 SIMIX_simcall_push(simcall->issuer);
497 return simcall->process_get_data.result;
501 * \brief Set the user data of a #m_process_t.
503 * 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.
504 * \param process SIMIX process
505 * \param data User data
507 void simcall_process_set_data(smx_process_t process, void *data)
509 if (process == SIMIX_process_self()) {
510 /* avoid a simcall if this function is called by the process itself */
511 SIMIX_process_self_set_data(process, data);
515 smx_simcall_t simcall = SIMIX_simcall_mine();
517 simcall->call = SIMCALL_PROCESS_SET_DATA;
518 simcall->process_set_data.process = process;
519 simcall->process_set_data.data = data;
520 SIMIX_simcall_push(simcall->issuer);
525 * \brief Return the location on which an agent is running.
527 * 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.
528 * \param process SIMIX process
531 smx_host_t simcall_process_get_host(smx_process_t process)
533 smx_simcall_t simcall = SIMIX_simcall_mine();
535 simcall->call = SIMCALL_PROCESS_GET_HOST;
536 simcall->process_get_host.process = process;
537 SIMIX_simcall_push(simcall->issuer);
538 return simcall->process_get_host.result;
542 * \brief Return the name of an agent.
544 * This functions checks whether \a process is a valid pointer or not and return its name.
545 * \param process SIMIX process
546 * \return The process name
548 const char* simcall_process_get_name(smx_process_t process)
550 if (process == SIMIX_process_self()) {
551 /* avoid a simcall if this function is called by the process itself */
552 return process->name;
555 smx_simcall_t simcall = SIMIX_simcall_mine();
557 simcall->call = SIMCALL_PROCESS_GET_NAME;
558 simcall->process_get_name.process = process;
559 SIMIX_simcall_push(simcall->issuer);
560 return simcall->process_get_name.result;
564 * \brief Returns true if the process is suspended .
566 * This checks whether a process is suspended or not by inspecting the task on which it was waiting for the completion.
567 * \param process SIMIX process
568 * \return 1, if the process is suspended, else 0.
570 int simcall_process_is_suspended(smx_process_t process)
572 smx_simcall_t simcall = SIMIX_simcall_mine();
574 simcall->call = SIMCALL_PROCESS_IS_SUSPENDED;
575 simcall->process_is_suspended.process = process;
576 SIMIX_simcall_push(simcall->issuer);
577 return simcall->process_is_suspended.result;
580 /** \ingroup m_process_management
581 * \brief Return the properties
583 * This functions returns the properties associated with this process
585 xbt_dict_t simcall_process_get_properties(smx_process_t process)
587 smx_simcall_t simcall = SIMIX_simcall_mine();
589 simcall->call = SIMCALL_PROCESS_GET_PROPERTIES;
590 simcall->process_get_properties.process = process;
591 SIMIX_simcall_push(simcall->issuer);
592 return simcall->process_get_properties.result;
595 /** \brief Creates a new sleep SIMIX action.
597 * This function creates a SURF action and allocates the data necessary
598 * to create the SIMIX action. It can raise a host_error exception if the
599 * host crashed. The default SIMIX name of the action is "sleep".
601 * \param duration Time duration of the sleep.
602 * \return A result telling whether the sleep was successful
604 e_smx_state_t simcall_process_sleep(double duration)
606 /* checking for infinite values */
607 xbt_assert(isfinite(duration), "duration is not finite!");
609 smx_simcall_t simcall = SIMIX_simcall_mine();
611 simcall->call = SIMCALL_PROCESS_SLEEP;
612 simcall->process_sleep.duration = duration;
613 SIMIX_simcall_push(simcall->issuer);
614 return simcall->process_sleep.result;
618 * \brief Creates a new rendez-vous point
619 * \param name The name of the rendez-vous point
620 * \return The created rendez-vous point
622 smx_rdv_t simcall_rdv_create(const char *name)
624 smx_simcall_t simcall = SIMIX_simcall_mine();
626 simcall->call = SIMCALL_RDV_CREATE;
627 simcall->rdv_create.name = name;
629 SIMIX_simcall_push(simcall->issuer);
630 return simcall->rdv_create.result;
635 * \brief Destroy a rendez-vous point
636 * \param name The rendez-vous point to destroy
638 void simcall_rdv_destroy(smx_rdv_t rdv)
640 smx_simcall_t simcall = SIMIX_simcall_mine();
642 simcall->call = SIMCALL_RDV_DESTROY;
643 simcall->rdv_destroy.rdv = rdv;
645 SIMIX_simcall_push(simcall->issuer);
648 smx_rdv_t simcall_rdv_get_by_name(const char *name)
650 xbt_assert(name != NULL, "Invalid parameter for simcall_rdv_get_by_name (name is NULL)");
652 /* FIXME: this is a horrible lost of performance, so we hack it out by
653 * skipping the simcall (for now). It works in parallel, it won't work on
654 * distributed but probably we will change MSG for that. */
657 smx_simcall_t simcall = simcall_mine();
658 simcall->call = SIMCALL_RDV_GEY_BY_NAME;
659 simcall->rdv_get_by_name.name = name;
660 SIMIX_simcall_push(simcall->issuer);
661 return simcall->rdv_get_by_name.result;*/
663 return SIMIX_rdv_get_by_name(name);
667 * \brief Counts the number of communication actions of a given host pending
668 * on a rendez-vous point.
669 * \param rdv The rendez-vous point
670 * \param host The host to be counted
671 * \return The number of comm actions pending in the rdv
673 int simcall_rdv_comm_count_by_host(smx_rdv_t rdv, smx_host_t host)
675 smx_simcall_t simcall = SIMIX_simcall_mine();
677 simcall->call = SIMCALL_RDV_COMM_COUNT_BY_HOST;
678 simcall->rdv_comm_count_by_host.rdv = rdv;
679 simcall->rdv_comm_count_by_host.host = host;
681 SIMIX_simcall_push(simcall->issuer);
682 return simcall->rdv_comm_count_by_host.result;
686 * \brief returns the communication at the head of the rendez-vous
687 * \param rdv The rendez-vous point
688 * \return The communication or NULL if empty
690 smx_action_t simcall_rdv_get_head(smx_rdv_t rdv)
692 smx_simcall_t simcall = SIMIX_simcall_mine();
694 simcall->call = SIMCALL_RDV_GET_HEAD;
695 simcall->rdv_get_head.rdv = rdv;
697 SIMIX_simcall_push(simcall->issuer);
698 return simcall->rdv_get_head.result;
701 void simcall_comm_send(smx_rdv_t rdv, double task_size, double rate,
702 void *src_buff, size_t src_buff_size,
703 int (*match_fun)(void *, void *, smx_action_t), void *data,
706 /* checking for infinite values */
707 xbt_assert(isfinite(task_size), "task_size is not finite!");
708 xbt_assert(isfinite(rate), "rate is not finite!");
709 xbt_assert(isfinite(timeout), "timeout is not finite!");
711 xbt_assert(rdv, "No rendez-vous point defined for send");
714 /* the model-checker wants two separate simcalls */
715 smx_action_t comm = simcall_comm_isend(rdv, task_size, rate,
716 src_buff, src_buff_size, match_fun, NULL, data, 0);
717 simcall_comm_wait(comm, timeout);
720 smx_simcall_t simcall = SIMIX_simcall_mine();
722 simcall->call = SIMCALL_COMM_SEND;
723 simcall->comm_send.rdv = rdv;
724 simcall->comm_send.task_size = task_size;
725 simcall->comm_send.rate = rate;
726 simcall->comm_send.src_buff = src_buff;
727 simcall->comm_send.src_buff_size = src_buff_size;
728 simcall->comm_send.match_fun = match_fun;
729 simcall->comm_send.data = data;
730 simcall->comm_send.timeout = timeout;
732 SIMIX_simcall_push(simcall->issuer);
736 smx_action_t simcall_comm_isend(smx_rdv_t rdv, double task_size, double rate,
737 void *src_buff, size_t src_buff_size,
738 int (*match_fun)(void *, void *, smx_action_t),
739 void (*clean_fun)(void *),
743 /* checking for infinite values */
744 xbt_assert(isfinite(task_size), "task_size is not finite!");
745 xbt_assert(isfinite(rate), "rate is not finite!");
747 xbt_assert(rdv, "No rendez-vous point defined for isend");
749 smx_simcall_t simcall = SIMIX_simcall_mine();
751 simcall->call = SIMCALL_COMM_ISEND;
752 simcall->comm_isend.rdv = rdv;
753 simcall->comm_isend.task_size = task_size;
754 simcall->comm_isend.rate = rate;
755 simcall->comm_isend.src_buff = src_buff;
756 simcall->comm_isend.src_buff_size = src_buff_size;
757 simcall->comm_isend.match_fun = match_fun;
758 simcall->comm_isend.clean_fun = clean_fun;
759 simcall->comm_isend.data = data;
760 simcall->comm_isend.detached = detached;
762 SIMIX_simcall_push(simcall->issuer);
763 return simcall->comm_isend.result;
766 void simcall_comm_recv(smx_rdv_t rdv, void *dst_buff, size_t * dst_buff_size,
767 int (*match_fun)(void *, void *, smx_action_t), void *data, double timeout)
769 xbt_assert(isfinite(timeout), "timeout is not finite!");
770 xbt_assert(rdv, "No rendez-vous point defined for recv");
773 /* the model-checker wants two separate simcalls */
774 smx_action_t comm = simcall_comm_irecv(rdv, dst_buff, dst_buff_size,
776 simcall_comm_wait(comm, timeout);
779 smx_simcall_t simcall = SIMIX_simcall_mine();
781 simcall->call = SIMCALL_COMM_RECV;
782 simcall->comm_recv.rdv = rdv;
783 simcall->comm_recv.dst_buff = dst_buff;
784 simcall->comm_recv.dst_buff_size = dst_buff_size;
785 simcall->comm_recv.match_fun = match_fun;
786 simcall->comm_recv.data = data;
787 simcall->comm_recv.timeout = timeout;
789 SIMIX_simcall_push(simcall->issuer);
793 smx_action_t simcall_comm_irecv(smx_rdv_t rdv, void *dst_buff, size_t * dst_buff_size,
794 int (*match_fun)(void *, void *, smx_action_t), void *data)
796 xbt_assert(rdv, "No rendez-vous point defined for irecv");
798 smx_simcall_t simcall = SIMIX_simcall_mine();
800 simcall->call = SIMCALL_COMM_IRECV;
801 simcall->comm_irecv.rdv = rdv;
802 simcall->comm_irecv.dst_buff = dst_buff;
803 simcall->comm_irecv.dst_buff_size = dst_buff_size;
804 simcall->comm_irecv.match_fun = match_fun;
805 simcall->comm_irecv.data = data;
807 SIMIX_simcall_push(simcall->issuer);
808 return simcall->comm_irecv.result;
811 void simcall_comm_destroy(smx_action_t comm)
813 xbt_assert(comm, "Invalid parameter");
815 /* FIXME remove this simcall type: comms are auto-destroyed now */
818 smx_simcall_t simcall = simcall_mine();
820 simcall->call = SIMCALL_COMM_DESTROY;
821 simcall->comm_destroy.comm = comm;
823 SIMIX_simcall_push(simcall->issuer);
827 void simcall_comm_cancel(smx_action_t comm)
829 smx_simcall_t simcall = SIMIX_simcall_mine();
831 simcall->call = SIMCALL_COMM_CANCEL;
832 simcall->comm_cancel.comm = comm;
834 SIMIX_simcall_push(simcall->issuer);
837 unsigned int simcall_comm_waitany(xbt_dynar_t comms)
839 smx_simcall_t simcall = SIMIX_simcall_mine();
841 simcall->call = SIMCALL_COMM_WAITANY;
842 simcall->comm_waitany.comms = comms;
844 SIMIX_simcall_push(simcall->issuer);
845 return simcall->comm_waitany.result;
848 int simcall_comm_testany(xbt_dynar_t comms)
850 smx_simcall_t simcall = SIMIX_simcall_mine();
851 if (xbt_dynar_is_empty(comms))
854 simcall->call = SIMCALL_COMM_TESTANY;
855 simcall->comm_testany.comms = comms;
857 SIMIX_simcall_push(simcall->issuer);
858 return simcall->comm_testany.result;
861 void simcall_comm_wait(smx_action_t comm, double timeout)
863 xbt_assert(isfinite(timeout), "timeout is not finite!");
865 smx_simcall_t simcall = SIMIX_simcall_mine();
867 simcall->call = SIMCALL_COMM_WAIT;
868 simcall->comm_wait.comm = comm;
869 simcall->comm_wait.timeout = timeout;
871 SIMIX_simcall_push(simcall->issuer);
876 * \brief Set the category of an action.
878 * This functions changes the category only. It calls a surf function.
879 * \param execution The execution action
880 * \param category The tracing category
882 void simcall_set_category(smx_action_t action, const char *category)
884 if (category == NULL) {
888 smx_simcall_t simcall = SIMIX_simcall_mine();
890 simcall->call = SIMCALL_SET_CATEGORY;
891 simcall->set_category.action = action;
892 simcall->set_category.category = category;
894 SIMIX_simcall_push(simcall->issuer);
898 int simcall_comm_test(smx_action_t comm)
900 smx_simcall_t simcall = SIMIX_simcall_mine();
902 simcall->call = SIMCALL_COMM_TEST;
903 simcall->comm_test.comm = comm;
905 SIMIX_simcall_push(simcall->issuer);
906 return simcall->comm_test.result;
909 double simcall_comm_get_remains(smx_action_t comm)
911 smx_simcall_t simcall = SIMIX_simcall_mine();
913 simcall->call = SIMCALL_COMM_GET_REMAINS;
914 simcall->comm_get_remains.comm = comm;
916 SIMIX_simcall_push(simcall->issuer);
917 return simcall->comm_get_remains.result;
920 e_smx_state_t simcall_comm_get_state(smx_action_t comm)
922 smx_simcall_t simcall = SIMIX_simcall_mine();
924 simcall->call = SIMCALL_COMM_GET_STATE;
925 simcall->comm_get_state.comm = comm;
927 SIMIX_simcall_push(simcall->issuer);
928 return simcall->comm_get_state.result;
931 void *simcall_comm_get_src_data(smx_action_t comm)
933 smx_simcall_t simcall = SIMIX_simcall_mine();
935 simcall->call = SIMCALL_COMM_GET_SRC_DATA;
936 simcall->comm_get_src_data.comm = comm;
938 SIMIX_simcall_push(simcall->issuer);
939 return simcall->comm_get_src_data.result;
942 void *simcall_comm_get_dst_data(smx_action_t comm)
944 smx_simcall_t simcall = SIMIX_simcall_mine();
946 simcall->call = SIMCALL_COMM_GET_DST_DATA;
947 simcall->comm_get_dst_data.comm = comm;
949 SIMIX_simcall_push(simcall->issuer);
950 return simcall->comm_get_dst_data.result;
953 smx_process_t simcall_comm_get_src_proc(smx_action_t comm)
955 smx_simcall_t simcall = SIMIX_simcall_mine();
957 simcall->call = SIMCALL_COMM_GET_SRC_PROC;
958 simcall->comm_get_src_proc.comm = comm;
960 SIMIX_simcall_push(simcall->issuer);
961 return simcall->comm_get_src_proc.result;
964 smx_process_t simcall_comm_get_dst_proc(smx_action_t comm)
966 smx_simcall_t simcall = SIMIX_simcall_mine();
968 simcall->call = SIMCALL_COMM_GET_DST_PROC;
969 simcall->comm_get_dst_proc.comm = comm;
971 SIMIX_simcall_push(simcall->issuer);
972 return simcall->comm_get_dst_proc.result;
975 #ifdef HAVE_LATENCY_BOUND_TRACKING
976 int simcall_comm_is_latency_bounded(smx_action_t comm)
978 smx_simcall_t simcall = SIMIX_simcall_mine();
980 simcall->call = SIMCALL_COMM_IS_LATENCY_BOUNDED;
981 simcall->comm_is_latency_bounded.comm = comm;
983 SIMIX_simcall_push(simcall->issuer);
984 return simcall->comm_is_latency_bounded.result;
988 smx_mutex_t simcall_mutex_init(void)
990 smx_simcall_t simcall = SIMIX_simcall_mine();
992 simcall->call = SIMCALL_MUTEX_INIT;
994 SIMIX_simcall_push(simcall->issuer);
995 return simcall->mutex_init.result;
998 void simcall_mutex_destroy(smx_mutex_t mutex)
1000 smx_simcall_t simcall = SIMIX_simcall_mine();
1002 simcall->call = SIMCALL_MUTEX_DESTROY;
1003 simcall->mutex_destroy.mutex = mutex;
1005 SIMIX_simcall_push(simcall->issuer);
1008 void simcall_mutex_lock(smx_mutex_t mutex)
1010 smx_simcall_t simcall = SIMIX_simcall_mine();
1012 simcall->call = SIMCALL_MUTEX_LOCK;
1013 simcall->mutex_lock.mutex = mutex;
1015 SIMIX_simcall_push(simcall->issuer);
1018 int simcall_mutex_trylock(smx_mutex_t mutex)
1020 smx_simcall_t simcall = SIMIX_simcall_mine();
1022 simcall->call = SIMCALL_MUTEX_TRYLOCK;
1023 simcall->mutex_trylock.mutex = mutex;
1025 SIMIX_simcall_push(simcall->issuer);
1026 return simcall->mutex_trylock.result;
1029 void simcall_mutex_unlock(smx_mutex_t mutex)
1031 smx_simcall_t simcall = SIMIX_simcall_mine();
1033 simcall->call = SIMCALL_MUTEX_UNLOCK;
1034 simcall->mutex_unlock.mutex = mutex;
1036 SIMIX_simcall_push(simcall->issuer);
1040 smx_cond_t simcall_cond_init(void)
1042 smx_simcall_t simcall = SIMIX_simcall_mine();
1044 simcall->call = SIMCALL_COND_INIT;
1046 SIMIX_simcall_push(simcall->issuer);
1047 return simcall->cond_init.result;
1050 void simcall_cond_destroy(smx_cond_t cond)
1052 smx_simcall_t simcall = SIMIX_simcall_mine();
1054 simcall->call = SIMCALL_COND_DESTROY;
1055 simcall->cond_destroy.cond = cond;
1057 SIMIX_simcall_push(simcall->issuer);
1060 void simcall_cond_signal(smx_cond_t cond)
1062 smx_simcall_t simcall = SIMIX_simcall_mine();
1064 simcall->call = SIMCALL_COND_SIGNAL;
1065 simcall->cond_signal.cond = cond;
1067 SIMIX_simcall_push(simcall->issuer);
1070 void simcall_cond_wait(smx_cond_t cond, smx_mutex_t mutex)
1072 smx_simcall_t simcall = SIMIX_simcall_mine();
1074 simcall->call = SIMCALL_COND_WAIT;
1075 simcall->cond_wait.cond = cond;
1076 simcall->cond_wait.mutex = mutex;
1078 SIMIX_simcall_push(simcall->issuer);
1081 void simcall_cond_wait_timeout(smx_cond_t cond,
1085 xbt_assert(isfinite(timeout), "timeout is not finite!");
1087 smx_simcall_t simcall = SIMIX_simcall_mine();
1089 simcall->call = SIMCALL_COND_WAIT_TIMEOUT;
1090 simcall->cond_wait_timeout.cond = cond;
1091 simcall->cond_wait_timeout.mutex = mutex;
1092 simcall->cond_wait_timeout.timeout = timeout;
1094 SIMIX_simcall_push(simcall->issuer);
1097 void simcall_cond_broadcast(smx_cond_t cond)
1099 smx_simcall_t simcall = SIMIX_simcall_mine();
1101 simcall->call = SIMCALL_COND_BROADCAST;
1102 simcall->cond_broadcast.cond = cond;
1104 SIMIX_simcall_push(simcall->issuer);
1108 smx_sem_t simcall_sem_init(int capacity)
1110 smx_simcall_t simcall = SIMIX_simcall_mine();
1112 simcall->call = SIMCALL_SEM_INIT;
1113 simcall->sem_init.capacity = capacity;
1115 SIMIX_simcall_push(simcall->issuer);
1116 return simcall->sem_init.result;
1119 void simcall_sem_destroy(smx_sem_t sem)
1121 smx_simcall_t simcall = SIMIX_simcall_mine();
1123 simcall->call = SIMCALL_SEM_DESTROY;
1124 simcall->sem_destroy.sem = sem;
1126 SIMIX_simcall_push(simcall->issuer);
1129 void simcall_sem_release(smx_sem_t sem)
1131 smx_simcall_t simcall = SIMIX_simcall_mine();
1133 simcall->call = SIMCALL_SEM_RELEASE;
1134 simcall->sem_release.sem = sem;
1136 SIMIX_simcall_push(simcall->issuer);
1139 int simcall_sem_would_block(smx_sem_t sem)
1141 smx_simcall_t simcall = SIMIX_simcall_mine();
1143 simcall->call = SIMCALL_SEM_WOULD_BLOCK;
1144 simcall->sem_would_block.sem = sem;
1146 SIMIX_simcall_push(simcall->issuer);
1147 return simcall->sem_would_block.result;
1150 void simcall_sem_acquire(smx_sem_t sem)
1152 smx_simcall_t simcall = SIMIX_simcall_mine();
1154 simcall->call = SIMCALL_SEM_ACQUIRE;
1155 simcall->sem_acquire.sem = sem;
1157 SIMIX_simcall_push(simcall->issuer);
1160 void simcall_sem_acquire_timeout(smx_sem_t sem, double timeout)
1162 xbt_assert(isfinite(timeout), "timeout is not finite!");
1164 smx_simcall_t simcall = SIMIX_simcall_mine();
1166 simcall->call = SIMCALL_SEM_ACQUIRE_TIMEOUT;
1167 simcall->sem_acquire_timeout.sem = sem;
1168 simcall->sem_acquire_timeout.timeout = timeout;
1170 SIMIX_simcall_push(simcall->issuer);
1173 int simcall_sem_get_capacity(smx_sem_t sem)
1175 smx_simcall_t simcall = SIMIX_simcall_mine();
1177 simcall->call = SIMCALL_SEM_GET_CAPACITY;
1178 simcall->sem_get_capacity.sem = sem;
1180 SIMIX_simcall_push(simcall->issuer);
1181 return simcall->sem_get_capacity.result;
1184 size_t simcall_file_read(const char* storage, void* ptr, size_t size, size_t nmemb, smx_file_t stream)
1186 smx_simcall_t simcall = SIMIX_simcall_mine();
1188 simcall->call = SIMCALL_FILE_READ;
1189 simcall->file_read.storage = storage;
1190 simcall->file_read.ptr = ptr;
1191 simcall->file_read.size = size;
1192 simcall->file_read.nmemb = nmemb;
1193 simcall->file_read.stream = stream;
1194 SIMIX_simcall_push(simcall->issuer);
1196 return simcall->file_read.result;
1199 size_t simcall_file_write(const char* storage, const void* ptr, size_t size, size_t nmemb, smx_file_t stream)
1201 smx_simcall_t simcall = SIMIX_simcall_mine();
1203 simcall->call = SIMCALL_FILE_WRITE;
1204 simcall->file_write.storage = storage;
1205 simcall->file_write.ptr = ptr;
1206 simcall->file_write.size = size;
1207 simcall->file_write.nmemb = nmemb;
1208 simcall->file_write.stream = stream;
1209 SIMIX_simcall_push(simcall->issuer);
1211 return simcall->file_write.result;
1214 smx_file_t simcall_file_open(const char* storage, const char* path, const char* mode)
1216 smx_simcall_t simcall = SIMIX_simcall_mine();
1218 simcall->call = SIMCALL_FILE_OPEN;
1219 simcall->file_open.storage = storage;
1220 simcall->file_open.path = path;
1221 simcall->file_open.mode = mode;
1222 SIMIX_simcall_push(simcall->issuer);
1224 return simcall->file_open.result;
1227 int simcall_file_close(const char* storage, smx_file_t fp)
1229 smx_simcall_t simcall = SIMIX_simcall_mine();
1231 simcall->call = SIMCALL_FILE_CLOSE;
1232 simcall->file_close.storage = storage;
1233 simcall->file_close.fp = fp;
1234 SIMIX_simcall_push(simcall->issuer);
1236 return simcall->file_close.result;
1239 int simcall_file_stat(const char* storage, smx_file_t fd, s_file_stat_t *buf)
1241 smx_simcall_t simcall = SIMIX_simcall_mine();
1242 simcall->call = SIMCALL_FILE_STAT;
1243 simcall->file_stat.storage = storage;
1244 simcall->file_stat.fd = fd;
1246 SIMIX_simcall_push(simcall->issuer);
1248 *buf = simcall->file_stat.buf;
1250 return simcall->file_stat.result;
1253 /* ************************************************************************** */
1255 /** @brief returns a printable string representing a simcall */
1256 const char *SIMIX_simcall_name(e_smx_simcall_t kind) {
1257 return simcall_names[kind];