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 argc first argument passed to \a code
347 * \param argv second argument passed to \a code
348 * \param properties the properties of the process
350 void simcall_process_create(smx_process_t *process, const char *name,
351 xbt_main_func_t code,
353 const char *hostname,
354 int argc, char **argv,
355 xbt_dict_t properties)
357 smx_simcall_t simcall = SIMIX_simcall_mine();
359 simcall->call = SIMCALL_PROCESS_CREATE;
360 simcall->process_create.process = process;
361 simcall->process_create.name = name;
362 simcall->process_create.code = code;
363 simcall->process_create.data = data;
364 simcall->process_create.hostname = hostname;
365 simcall->process_create.argc = argc;
366 simcall->process_create.argv = argv;
367 simcall->process_create.properties = properties;
368 SIMIX_simcall_push(simcall->issuer);
371 /** \brief Kills a SIMIX process.
373 * This function simply kills a process.
375 * \param process poor victim
377 void simcall_process_kill(smx_process_t process)
379 smx_simcall_t simcall = SIMIX_simcall_mine();
381 simcall->call = SIMCALL_PROCESS_KILL;
382 simcall->process_kill.process = process;
383 SIMIX_simcall_push(simcall->issuer);
386 /** \brief Kills all SIMIX processes.
388 void simcall_process_killall(void)
390 smx_simcall_t simcall = SIMIX_simcall_mine();
392 simcall->call = SIMCALL_PROCESS_KILLALL;
393 SIMIX_simcall_push(simcall->issuer);
396 /** \brief Cleans up a SIMIX process.
397 * \param process poor victim (must have already been killed)
399 void simcall_process_cleanup(smx_process_t process)
401 smx_simcall_t simcall = SIMIX_simcall_mine();
403 simcall->call = SIMCALL_PROCESS_CLEANUP;
404 simcall->process_cleanup.process = process;
405 SIMIX_simcall_push(simcall->issuer);
409 * \brief Migrates an agent to another location.
411 * This function changes the value of the host on which \a process is running.
413 * \param process the process to migrate
414 * \param source name of the previous host
415 * \param dest name of the new host
417 void simcall_process_change_host(smx_process_t process, smx_host_t dest)
419 smx_simcall_t simcall = SIMIX_simcall_mine();
421 simcall->call = SIMCALL_PROCESS_CHANGE_HOST;
422 simcall->process_change_host.process = process;
423 simcall->process_change_host.dest = dest;
424 SIMIX_simcall_push(simcall->issuer);
428 * \brief Suspends a process.
430 * This function suspends the process by suspending the action
431 * it was waiting for completion.
433 * \param process a SIMIX process
435 void simcall_process_suspend(smx_process_t process)
437 xbt_assert(process, "Invalid parameters");
439 smx_simcall_t simcall = SIMIX_simcall_mine();
441 simcall->call = SIMCALL_PROCESS_SUSPEND;
442 simcall->process_suspend.process = process;
443 SIMIX_simcall_push(simcall->issuer);
447 * \brief Resumes a suspended process.
449 * This function resumes a suspended process by resuming the action
450 * it was waiting for completion.
452 * \param process a SIMIX process
454 void simcall_process_resume(smx_process_t process)
456 smx_simcall_t simcall = SIMIX_simcall_mine();
458 simcall->call = SIMCALL_PROCESS_RESUME;
459 simcall->process_resume.process = process;
460 SIMIX_simcall_push(simcall->issuer);
464 * \brief Returns the amount of SIMIX processes in the system
466 * Maestro internal process is not counted, only user code processes are
468 int simcall_process_count(void)
470 smx_simcall_t simcall = SIMIX_simcall_mine();
472 simcall->call = SIMCALL_PROCESS_COUNT;
473 SIMIX_simcall_push(simcall->issuer);
474 return simcall->process_count.result;
478 * \brief Return the user data of a #smx_process_t.
479 * \param process a SIMIX process
480 * \return the user data of this process
482 void* simcall_process_get_data(smx_process_t process)
484 if (process == SIMIX_process_self()) {
485 /* avoid a simcall if this function is called by the process itself */
486 return SIMIX_process_get_data(process);
489 smx_simcall_t simcall = SIMIX_simcall_mine();
491 simcall->call = SIMCALL_PROCESS_GET_DATA;
492 simcall->process_get_data.process = process;
493 SIMIX_simcall_push(simcall->issuer);
494 return simcall->process_get_data.result;
498 * \brief Set the user data of a #m_process_t.
500 * 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.
501 * \param process SIMIX process
502 * \param data User data
504 void simcall_process_set_data(smx_process_t process, void *data)
506 if (process == SIMIX_process_self()) {
507 /* avoid a simcall if this function is called by the process itself */
508 SIMIX_process_self_set_data(process, data);
512 smx_simcall_t simcall = SIMIX_simcall_mine();
514 simcall->call = SIMCALL_PROCESS_SET_DATA;
515 simcall->process_set_data.process = process;
516 simcall->process_set_data.data = data;
517 SIMIX_simcall_push(simcall->issuer);
522 * \brief Return the location on which an agent is running.
524 * 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.
525 * \param process SIMIX process
528 smx_host_t simcall_process_get_host(smx_process_t process)
530 smx_simcall_t simcall = SIMIX_simcall_mine();
532 simcall->call = SIMCALL_PROCESS_GET_HOST;
533 simcall->process_get_host.process = process;
534 SIMIX_simcall_push(simcall->issuer);
535 return simcall->process_get_host.result;
539 * \brief Return the name of an agent.
541 * This functions checks whether \a process is a valid pointer or not and return its name.
542 * \param process SIMIX process
543 * \return The process name
545 const char* simcall_process_get_name(smx_process_t process)
547 if (process == SIMIX_process_self()) {
548 /* avoid a simcall if this function is called by the process itself */
549 return process->name;
552 smx_simcall_t simcall = SIMIX_simcall_mine();
554 simcall->call = SIMCALL_PROCESS_GET_NAME;
555 simcall->process_get_name.process = process;
556 SIMIX_simcall_push(simcall->issuer);
557 return simcall->process_get_name.result;
561 * \brief Returns true if the process is suspended .
563 * This checks whether a process is suspended or not by inspecting the task on which it was waiting for the completion.
564 * \param process SIMIX process
565 * \return 1, if the process is suspended, else 0.
567 int simcall_process_is_suspended(smx_process_t process)
569 smx_simcall_t simcall = SIMIX_simcall_mine();
571 simcall->call = SIMCALL_PROCESS_IS_SUSPENDED;
572 simcall->process_is_suspended.process = process;
573 SIMIX_simcall_push(simcall->issuer);
574 return simcall->process_is_suspended.result;
577 /** \ingroup m_process_management
578 * \brief Return the properties
580 * This functions returns the properties associated with this process
582 xbt_dict_t simcall_process_get_properties(smx_process_t process)
584 smx_simcall_t simcall = SIMIX_simcall_mine();
586 simcall->call = SIMCALL_PROCESS_GET_PROPERTIES;
587 simcall->process_get_properties.process = process;
588 SIMIX_simcall_push(simcall->issuer);
589 return simcall->process_get_properties.result;
592 /** \brief Creates a new sleep SIMIX action.
594 * This function creates a SURF action and allocates the data necessary
595 * to create the SIMIX action. It can raise a host_error exception if the
596 * host crashed. The default SIMIX name of the action is "sleep".
598 * \param duration Time duration of the sleep.
599 * \return A result telling whether the sleep was successful
601 e_smx_state_t simcall_process_sleep(double duration)
603 /* checking for infinite values */
604 xbt_assert(isfinite(duration), "duration is not finite!");
606 smx_simcall_t simcall = SIMIX_simcall_mine();
608 simcall->call = SIMCALL_PROCESS_SLEEP;
609 simcall->process_sleep.duration = duration;
610 SIMIX_simcall_push(simcall->issuer);
611 return simcall->process_sleep.result;
615 * \brief Creates a new rendez-vous point
616 * \param name The name of the rendez-vous point
617 * \return The created rendez-vous point
619 smx_rdv_t simcall_rdv_create(const char *name)
621 smx_simcall_t simcall = SIMIX_simcall_mine();
623 simcall->call = SIMCALL_RDV_CREATE;
624 simcall->rdv_create.name = name;
626 SIMIX_simcall_push(simcall->issuer);
627 return simcall->rdv_create.result;
632 * \brief Destroy a rendez-vous point
633 * \param name The rendez-vous point to destroy
635 void simcall_rdv_destroy(smx_rdv_t rdv)
637 smx_simcall_t simcall = SIMIX_simcall_mine();
639 simcall->call = SIMCALL_RDV_DESTROY;
640 simcall->rdv_destroy.rdv = rdv;
642 SIMIX_simcall_push(simcall->issuer);
645 smx_rdv_t simcall_rdv_get_by_name(const char *name)
647 xbt_assert(name != NULL, "Invalid parameter for simcall_rdv_get_by_name (name is NULL)");
649 /* FIXME: this is a horrible lost of performance, so we hack it out by
650 * skipping the simcall (for now). It works in parallel, it won't work on
651 * distributed but probably we will change MSG for that. */
654 smx_simcall_t simcall = simcall_mine();
655 simcall->call = SIMCALL_RDV_GEY_BY_NAME;
656 simcall->rdv_get_by_name.name = name;
657 SIMIX_simcall_push(simcall->issuer);
658 return simcall->rdv_get_by_name.result;*/
660 return SIMIX_rdv_get_by_name(name);
664 * \brief Counts the number of communication actions of a given host pending
665 * on a rendez-vous point.
666 * \param rdv The rendez-vous point
667 * \param host The host to be counted
668 * \return The number of comm actions pending in the rdv
670 int simcall_rdv_comm_count_by_host(smx_rdv_t rdv, smx_host_t host)
672 smx_simcall_t simcall = SIMIX_simcall_mine();
674 simcall->call = SIMCALL_RDV_COMM_COUNT_BY_HOST;
675 simcall->rdv_comm_count_by_host.rdv = rdv;
676 simcall->rdv_comm_count_by_host.host = host;
678 SIMIX_simcall_push(simcall->issuer);
679 return simcall->rdv_comm_count_by_host.result;
683 * \brief returns the communication at the head of the rendez-vous
684 * \param rdv The rendez-vous point
685 * \return The communication or NULL if empty
687 smx_action_t simcall_rdv_get_head(smx_rdv_t rdv)
689 smx_simcall_t simcall = SIMIX_simcall_mine();
691 simcall->call = SIMCALL_RDV_GET_HEAD;
692 simcall->rdv_get_head.rdv = rdv;
694 SIMIX_simcall_push(simcall->issuer);
695 return simcall->rdv_get_head.result;
698 void simcall_comm_send(smx_rdv_t rdv, double task_size, double rate,
699 void *src_buff, size_t src_buff_size,
700 int (*match_fun)(void *, void *), void *data,
703 /* checking for infinite values */
704 xbt_assert(isfinite(task_size), "task_size is not finite!");
705 xbt_assert(isfinite(rate), "rate is not finite!");
706 xbt_assert(isfinite(timeout), "timeout is not finite!");
708 xbt_assert(rdv, "No rendez-vous point defined for send");
711 /* the model-checker wants two separate simcalls */
712 smx_action_t comm = simcall_comm_isend(rdv, task_size, rate,
713 src_buff, src_buff_size, match_fun, NULL, data, 0);
714 simcall_comm_wait(comm, timeout);
717 smx_simcall_t simcall = SIMIX_simcall_mine();
719 simcall->call = SIMCALL_COMM_SEND;
720 simcall->comm_send.rdv = rdv;
721 simcall->comm_send.task_size = task_size;
722 simcall->comm_send.rate = rate;
723 simcall->comm_send.src_buff = src_buff;
724 simcall->comm_send.src_buff_size = src_buff_size;
725 simcall->comm_send.match_fun = match_fun;
726 simcall->comm_send.data = data;
727 simcall->comm_send.timeout = timeout;
729 SIMIX_simcall_push(simcall->issuer);
733 smx_action_t simcall_comm_isend(smx_rdv_t rdv, double task_size, double rate,
734 void *src_buff, size_t src_buff_size,
735 int (*match_fun)(void *, void *),
736 void (*clean_fun)(void *),
740 /* checking for infinite values */
741 xbt_assert(isfinite(task_size), "task_size is not finite!");
742 xbt_assert(isfinite(rate), "rate is not finite!");
744 xbt_assert(rdv, "No rendez-vous point defined for isend");
746 smx_simcall_t simcall = SIMIX_simcall_mine();
748 simcall->call = SIMCALL_COMM_ISEND;
749 simcall->comm_isend.rdv = rdv;
750 simcall->comm_isend.task_size = task_size;
751 simcall->comm_isend.rate = rate;
752 simcall->comm_isend.src_buff = src_buff;
753 simcall->comm_isend.src_buff_size = src_buff_size;
754 simcall->comm_isend.match_fun = match_fun;
755 simcall->comm_isend.clean_fun = clean_fun;
756 simcall->comm_isend.data = data;
757 simcall->comm_isend.detached = detached;
759 SIMIX_simcall_push(simcall->issuer);
760 return simcall->comm_isend.result;
763 void simcall_comm_recv(smx_rdv_t rdv, void *dst_buff, size_t * dst_buff_size,
764 int (*match_fun)(void *, void *), void *data, double timeout)
766 xbt_assert(isfinite(timeout), "timeout is not finite!");
767 xbt_assert(rdv, "No rendez-vous point defined for recv");
770 /* the model-checker wants two separate simcalls */
771 smx_action_t comm = simcall_comm_irecv(rdv, dst_buff, dst_buff_size,
773 simcall_comm_wait(comm, timeout);
776 smx_simcall_t simcall = SIMIX_simcall_mine();
778 simcall->call = SIMCALL_COMM_RECV;
779 simcall->comm_recv.rdv = rdv;
780 simcall->comm_recv.dst_buff = dst_buff;
781 simcall->comm_recv.dst_buff_size = dst_buff_size;
782 simcall->comm_recv.match_fun = match_fun;
783 simcall->comm_recv.data = data;
784 simcall->comm_recv.timeout = timeout;
786 SIMIX_simcall_push(simcall->issuer);
790 smx_action_t simcall_comm_irecv(smx_rdv_t rdv, void *dst_buff, size_t * dst_buff_size,
791 int (*match_fun)(void *, void *), void *data)
793 xbt_assert(rdv, "No rendez-vous point defined for irecv");
795 smx_simcall_t simcall = SIMIX_simcall_mine();
797 simcall->call = SIMCALL_COMM_IRECV;
798 simcall->comm_irecv.rdv = rdv;
799 simcall->comm_irecv.dst_buff = dst_buff;
800 simcall->comm_irecv.dst_buff_size = dst_buff_size;
801 simcall->comm_irecv.match_fun = match_fun;
802 simcall->comm_irecv.data = data;
804 SIMIX_simcall_push(simcall->issuer);
805 return simcall->comm_irecv.result;
808 void simcall_comm_destroy(smx_action_t comm)
810 xbt_assert(comm, "Invalid parameter");
812 /* FIXME remove this simcall type: comms are auto-destroyed now */
815 smx_simcall_t simcall = simcall_mine();
817 simcall->call = SIMCALL_COMM_DESTROY;
818 simcall->comm_destroy.comm = comm;
820 SIMIX_simcall_push(simcall->issuer);
824 void simcall_comm_cancel(smx_action_t comm)
826 smx_simcall_t simcall = SIMIX_simcall_mine();
828 simcall->call = SIMCALL_COMM_CANCEL;
829 simcall->comm_cancel.comm = comm;
831 SIMIX_simcall_push(simcall->issuer);
834 unsigned int simcall_comm_waitany(xbt_dynar_t comms)
836 smx_simcall_t simcall = SIMIX_simcall_mine();
838 simcall->call = SIMCALL_COMM_WAITANY;
839 simcall->comm_waitany.comms = comms;
841 SIMIX_simcall_push(simcall->issuer);
842 return simcall->comm_waitany.result;
845 int simcall_comm_testany(xbt_dynar_t comms)
847 smx_simcall_t simcall = SIMIX_simcall_mine();
848 if (xbt_dynar_is_empty(comms))
851 simcall->call = SIMCALL_COMM_TESTANY;
852 simcall->comm_testany.comms = comms;
854 SIMIX_simcall_push(simcall->issuer);
855 return simcall->comm_testany.result;
858 void simcall_comm_wait(smx_action_t comm, double timeout)
860 xbt_assert(isfinite(timeout), "timeout is not finite!");
862 smx_simcall_t simcall = SIMIX_simcall_mine();
864 simcall->call = SIMCALL_COMM_WAIT;
865 simcall->comm_wait.comm = comm;
866 simcall->comm_wait.timeout = timeout;
868 SIMIX_simcall_push(simcall->issuer);
873 * \brief Set the category of an action.
875 * This functions changes the category only. It calls a surf function.
876 * \param execution The execution action
877 * \param category The tracing category
879 void simcall_set_category(smx_action_t action, const char *category)
881 if (category == NULL) {
885 smx_simcall_t simcall = SIMIX_simcall_mine();
887 simcall->call = SIMCALL_SET_CATEGORY;
888 simcall->set_category.action = action;
889 simcall->set_category.category = category;
891 SIMIX_simcall_push(simcall->issuer);
895 int simcall_comm_test(smx_action_t comm)
897 smx_simcall_t simcall = SIMIX_simcall_mine();
899 simcall->call = SIMCALL_COMM_TEST;
900 simcall->comm_test.comm = comm;
902 SIMIX_simcall_push(simcall->issuer);
903 return simcall->comm_test.result;
906 double simcall_comm_get_remains(smx_action_t comm)
908 smx_simcall_t simcall = SIMIX_simcall_mine();
910 simcall->call = SIMCALL_COMM_GET_REMAINS;
911 simcall->comm_get_remains.comm = comm;
913 SIMIX_simcall_push(simcall->issuer);
914 return simcall->comm_get_remains.result;
917 e_smx_state_t simcall_comm_get_state(smx_action_t comm)
919 smx_simcall_t simcall = SIMIX_simcall_mine();
921 simcall->call = SIMCALL_COMM_GET_STATE;
922 simcall->comm_get_state.comm = comm;
924 SIMIX_simcall_push(simcall->issuer);
925 return simcall->comm_get_state.result;
928 void *simcall_comm_get_src_data(smx_action_t comm)
930 smx_simcall_t simcall = SIMIX_simcall_mine();
932 simcall->call = SIMCALL_COMM_GET_SRC_DATA;
933 simcall->comm_get_src_data.comm = comm;
935 SIMIX_simcall_push(simcall->issuer);
936 return simcall->comm_get_src_data.result;
939 void *simcall_comm_get_dst_data(smx_action_t comm)
941 smx_simcall_t simcall = SIMIX_simcall_mine();
943 simcall->call = SIMCALL_COMM_GET_DST_DATA;
944 simcall->comm_get_dst_data.comm = comm;
946 SIMIX_simcall_push(simcall->issuer);
947 return simcall->comm_get_dst_data.result;
950 smx_process_t simcall_comm_get_src_proc(smx_action_t comm)
952 smx_simcall_t simcall = SIMIX_simcall_mine();
954 simcall->call = SIMCALL_COMM_GET_SRC_PROC;
955 simcall->comm_get_src_proc.comm = comm;
957 SIMIX_simcall_push(simcall->issuer);
958 return simcall->comm_get_src_proc.result;
961 smx_process_t simcall_comm_get_dst_proc(smx_action_t comm)
963 smx_simcall_t simcall = SIMIX_simcall_mine();
965 simcall->call = SIMCALL_COMM_GET_DST_PROC;
966 simcall->comm_get_dst_proc.comm = comm;
968 SIMIX_simcall_push(simcall->issuer);
969 return simcall->comm_get_dst_proc.result;
972 #ifdef HAVE_LATENCY_BOUND_TRACKING
973 int simcall_comm_is_latency_bounded(smx_action_t comm)
975 smx_simcall_t simcall = SIMIX_simcall_mine();
977 simcall->call = SIMCALL_COMM_IS_LATENCY_BOUNDED;
978 simcall->comm_is_latency_bounded.comm = comm;
980 SIMIX_simcall_push(simcall->issuer);
981 return simcall->comm_is_latency_bounded.result;
985 smx_mutex_t simcall_mutex_init(void)
987 smx_simcall_t simcall = SIMIX_simcall_mine();
989 simcall->call = SIMCALL_MUTEX_INIT;
991 SIMIX_simcall_push(simcall->issuer);
992 return simcall->mutex_init.result;
995 void simcall_mutex_destroy(smx_mutex_t mutex)
997 smx_simcall_t simcall = SIMIX_simcall_mine();
999 simcall->call = SIMCALL_MUTEX_DESTROY;
1000 simcall->mutex_destroy.mutex = mutex;
1002 SIMIX_simcall_push(simcall->issuer);
1005 void simcall_mutex_lock(smx_mutex_t mutex)
1007 smx_simcall_t simcall = SIMIX_simcall_mine();
1009 simcall->call = SIMCALL_MUTEX_LOCK;
1010 simcall->mutex_lock.mutex = mutex;
1012 SIMIX_simcall_push(simcall->issuer);
1015 int simcall_mutex_trylock(smx_mutex_t mutex)
1017 smx_simcall_t simcall = SIMIX_simcall_mine();
1019 simcall->call = SIMCALL_MUTEX_TRYLOCK;
1020 simcall->mutex_trylock.mutex = mutex;
1022 SIMIX_simcall_push(simcall->issuer);
1023 return simcall->mutex_trylock.result;
1026 void simcall_mutex_unlock(smx_mutex_t mutex)
1028 smx_simcall_t simcall = SIMIX_simcall_mine();
1030 simcall->call = SIMCALL_MUTEX_UNLOCK;
1031 simcall->mutex_unlock.mutex = mutex;
1033 SIMIX_simcall_push(simcall->issuer);
1037 smx_cond_t simcall_cond_init(void)
1039 smx_simcall_t simcall = SIMIX_simcall_mine();
1041 simcall->call = SIMCALL_COND_INIT;
1043 SIMIX_simcall_push(simcall->issuer);
1044 return simcall->cond_init.result;
1047 void simcall_cond_destroy(smx_cond_t cond)
1049 smx_simcall_t simcall = SIMIX_simcall_mine();
1051 simcall->call = SIMCALL_COND_DESTROY;
1052 simcall->cond_destroy.cond = cond;
1054 SIMIX_simcall_push(simcall->issuer);
1057 void simcall_cond_signal(smx_cond_t cond)
1059 smx_simcall_t simcall = SIMIX_simcall_mine();
1061 simcall->call = SIMCALL_COND_SIGNAL;
1062 simcall->cond_signal.cond = cond;
1064 SIMIX_simcall_push(simcall->issuer);
1067 void simcall_cond_wait(smx_cond_t cond, smx_mutex_t mutex)
1069 smx_simcall_t simcall = SIMIX_simcall_mine();
1071 simcall->call = SIMCALL_COND_WAIT;
1072 simcall->cond_wait.cond = cond;
1073 simcall->cond_wait.mutex = mutex;
1075 SIMIX_simcall_push(simcall->issuer);
1078 void simcall_cond_wait_timeout(smx_cond_t cond,
1082 xbt_assert(isfinite(timeout), "timeout is not finite!");
1084 smx_simcall_t simcall = SIMIX_simcall_mine();
1086 simcall->call = SIMCALL_COND_WAIT_TIMEOUT;
1087 simcall->cond_wait_timeout.cond = cond;
1088 simcall->cond_wait_timeout.mutex = mutex;
1089 simcall->cond_wait_timeout.timeout = timeout;
1091 SIMIX_simcall_push(simcall->issuer);
1094 void simcall_cond_broadcast(smx_cond_t cond)
1096 smx_simcall_t simcall = SIMIX_simcall_mine();
1098 simcall->call = SIMCALL_COND_BROADCAST;
1099 simcall->cond_broadcast.cond = cond;
1101 SIMIX_simcall_push(simcall->issuer);
1105 smx_sem_t simcall_sem_init(int capacity)
1107 smx_simcall_t simcall = SIMIX_simcall_mine();
1109 simcall->call = SIMCALL_SEM_INIT;
1110 simcall->sem_init.capacity = capacity;
1112 SIMIX_simcall_push(simcall->issuer);
1113 return simcall->sem_init.result;
1116 void simcall_sem_destroy(smx_sem_t sem)
1118 smx_simcall_t simcall = SIMIX_simcall_mine();
1120 simcall->call = SIMCALL_SEM_DESTROY;
1121 simcall->sem_destroy.sem = sem;
1123 SIMIX_simcall_push(simcall->issuer);
1126 void simcall_sem_release(smx_sem_t sem)
1128 smx_simcall_t simcall = SIMIX_simcall_mine();
1130 simcall->call = SIMCALL_SEM_RELEASE;
1131 simcall->sem_release.sem = sem;
1133 SIMIX_simcall_push(simcall->issuer);
1136 int simcall_sem_would_block(smx_sem_t sem)
1138 smx_simcall_t simcall = SIMIX_simcall_mine();
1140 simcall->call = SIMCALL_SEM_WOULD_BLOCK;
1141 simcall->sem_would_block.sem = sem;
1143 SIMIX_simcall_push(simcall->issuer);
1144 return simcall->sem_would_block.result;
1147 void simcall_sem_acquire(smx_sem_t sem)
1149 smx_simcall_t simcall = SIMIX_simcall_mine();
1151 simcall->call = SIMCALL_SEM_ACQUIRE;
1152 simcall->sem_acquire.sem = sem;
1154 SIMIX_simcall_push(simcall->issuer);
1157 void simcall_sem_acquire_timeout(smx_sem_t sem, double timeout)
1159 xbt_assert(isfinite(timeout), "timeout is not finite!");
1161 smx_simcall_t simcall = SIMIX_simcall_mine();
1163 simcall->call = SIMCALL_SEM_ACQUIRE_TIMEOUT;
1164 simcall->sem_acquire_timeout.sem = sem;
1165 simcall->sem_acquire_timeout.timeout = timeout;
1167 SIMIX_simcall_push(simcall->issuer);
1170 int simcall_sem_get_capacity(smx_sem_t sem)
1172 smx_simcall_t simcall = SIMIX_simcall_mine();
1174 simcall->call = SIMCALL_SEM_GET_CAPACITY;
1175 simcall->sem_get_capacity.sem = sem;
1177 SIMIX_simcall_push(simcall->issuer);
1178 return simcall->sem_get_capacity.result;
1181 size_t simcall_file_read(const char* storage, void* ptr, size_t size, size_t nmemb, smx_file_t stream)
1183 smx_simcall_t simcall = SIMIX_simcall_mine();
1185 simcall->call = SIMCALL_FILE_READ;
1186 simcall->file_read.storage = storage;
1187 simcall->file_read.ptr = ptr;
1188 simcall->file_read.size = size;
1189 simcall->file_read.nmemb = nmemb;
1190 simcall->file_read.stream = stream;
1191 SIMIX_simcall_push(simcall->issuer);
1193 return simcall->file_read.result;
1196 size_t simcall_file_write(const char* storage, const void* ptr, size_t size, size_t nmemb, smx_file_t stream)
1198 smx_simcall_t simcall = SIMIX_simcall_mine();
1200 simcall->call = SIMCALL_FILE_WRITE;
1201 simcall->file_write.storage = storage;
1202 simcall->file_write.ptr = ptr;
1203 simcall->file_write.size = size;
1204 simcall->file_write.nmemb = nmemb;
1205 simcall->file_write.stream = stream;
1206 SIMIX_simcall_push(simcall->issuer);
1208 return simcall->file_write.result;
1211 smx_file_t simcall_file_open(const char* storage, const char* path, const char* mode)
1213 smx_simcall_t simcall = SIMIX_simcall_mine();
1215 simcall->call = SIMCALL_FILE_OPEN;
1216 simcall->file_open.storage = storage;
1217 simcall->file_open.path = path;
1218 simcall->file_open.mode = mode;
1219 SIMIX_simcall_push(simcall->issuer);
1221 return simcall->file_open.result;
1224 int simcall_file_close(const char* storage, smx_file_t fp)
1226 smx_simcall_t simcall = SIMIX_simcall_mine();
1228 simcall->call = SIMCALL_FILE_CLOSE;
1229 simcall->file_close.storage = storage;
1230 simcall->file_close.fp = fp;
1231 SIMIX_simcall_push(simcall->issuer);
1233 return simcall->file_close.result;
1236 int simcall_file_stat(const char* storage, smx_file_t fd, s_file_stat_t *buf)
1238 smx_simcall_t simcall = SIMIX_simcall_mine();
1239 simcall->call = SIMCALL_FILE_STAT;
1240 simcall->file_stat.storage = storage;
1241 simcall->file_stat.fd = fd;
1243 SIMIX_simcall_push(simcall->issuer);
1245 *buf = simcall->file_stat.buf;
1247 return simcall->file_stat.result;
1250 /* ************************************************************************** */
1252 /** @brief returns a printable string representing a simcall */
1253 const char *SIMIX_simcall_name(e_smx_simcall_t kind) {
1254 return simcall_names[kind];