Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
17ff1ba9e5f51266bb7cda3e1453e62562b1c537
[simgrid.git] / src / simix / libsmx.c
1 /* libsmx.c - public interface to simix                                       */
2 /* --------                                                                   */
3 /* These functions are the only ones that are visible from the higher levels  */
4 /* (most of them simply add some documentation to the generated simcall body) */
5 /*                                                                            */
6 /* This is somehow the "libc" of SimGrid                                      */
7
8 /* Copyright (c) 2010-2014. The SimGrid Team. All rights reserved.            */
9
10 /* This program is free software; you can redistribute it and/or modify it
11  * under the terms of the license (GNU LGPL) which comes with this package.   */
12
13 #include "mc/mc_replay.h"
14 #include "smx_private.h"
15 #include "mc/mc_interface.h"
16 #include "xbt/ex.h"
17 #include <math.h>         /* isfinite() */
18
19 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(simix);
20
21 #include "popping_bodies.c"
22
23 /**
24  * \ingroup simix_host_management
25  * \brief Returns a host given its name.
26  *
27  * \param name The name of the host to get
28  * \return The corresponding host
29  */
30 smx_host_t simcall_host_get_by_name(const char *name)
31 {
32   return simcall_BODY_host_get_by_name(name);
33 }
34
35 /**
36  * \ingroup simix_host_management
37  * \brief Returns the name of a host.
38  *
39  * \param host A SIMIX host
40  * \return The name of this host
41  */
42 const char* simcall_host_get_name(smx_host_t host)
43 {
44   return simcall_BODY_host_get_name(host);
45 }
46
47 /**
48  * \ingroup simix_host_management
49  * \brief Start the host if it is off
50  *
51  * \param host A SIMIX host
52  */
53 void simcall_host_on(smx_host_t host)
54 {
55   simcall_BODY_host_on(host);
56 }
57
58 /**
59  * \ingroup simix_host_management
60  * \brief Stop the host if it is on
61  *
62  * \param host A SIMIX host
63  */
64 void simcall_host_off(smx_host_t host)
65 {
66   simcall_BODY_host_off(host);
67 }
68
69 /**
70  * \ingroup simix_host_management
71  * \brief Returns a dict of the properties assigned to a host.
72  *
73  * \param host A host
74  * \return The properties of this host
75  */
76 xbt_dict_t simcall_host_get_properties(smx_host_t host)
77 {
78   return simcall_BODY_host_get_properties(host);
79 }
80
81 /**
82  * \ingroup simix_host_management
83  * \brief Returns a dict of the properties assigned to a router or AS.
84  *
85  * \param name The name of the router or AS
86  * \return The properties
87  */
88 xbt_dict_t simcall_asr_get_properties(const char *name)
89 {
90   return simcall_BODY_asr_get_properties(name);
91 }
92
93
94 /**
95  * \ingroup simix_host_management
96  * \brief Returns the speed of the processor.
97  *
98  * The speed returned does not take into account the current load on the machine.
99  * \param host A SIMIX host
100  * \return The speed of this host (in Mflop/s)
101  */
102 double simcall_host_get_speed(smx_host_t host)
103 {
104   return simcall_BODY_host_get_speed(host);
105 }
106
107 /**
108  * \ingroup simix_host_management
109  * \brief Returns the number of core of the processor.
110  *
111  * \param host A SIMIX host
112  * \return The number of core
113  */
114 int simcall_host_get_core(smx_host_t host)
115 {
116   return simcall_BODY_host_get_core(host);
117 }
118
119 /**
120  * \ingroup simix_host_management
121  * \brief Returns the list of processes attached to the host.
122  *
123  * \param host A SIMIX host
124  * \return the swag of attached processes
125  */
126 xbt_swag_t simcall_host_get_process_list(smx_host_t host)
127 {
128   return simcall_BODY_host_get_process_list(host);
129 }
130
131
132 /**
133  * \ingroup simix_host_management
134  * \brief Returns the available speed of the processor.
135  *
136  * \return Speed currently available (in Mflop/s)
137  */
138 double simcall_host_get_available_speed(smx_host_t host)
139 {
140   return simcall_BODY_host_get_available_speed(host);
141 }
142
143 /**
144  * \ingroup simix_host_management
145  * \brief Returns the state of a host.
146  *
147  * Two states are possible: 1 if the host is active or 0 if it has crashed.
148  * \param host A SIMIX host
149  * \return 1 if the host is available, 0 otherwise
150  */
151 int simcall_host_get_state(smx_host_t host)
152 {
153   return simcall_BODY_host_get_state(host);
154 }
155
156 /**
157  * \ingroup simix_host_management
158  * \brief Returns the power peak of a host.
159  *
160  * \param host A SIMIX host
161  * \return the current power peak value (double)
162  */
163 double simcall_host_get_current_power_peak(smx_host_t host)
164 {
165   return simcall_BODY_host_get_current_power_peak(host);
166 }
167
168 /**
169  * \ingroup simix_host_management
170  * \brief Returns one power peak (in flops/s) of a host at a given pstate
171  *
172  * \param host A SIMIX host
173  * \param pstate_index pstate to test
174  * \return the current power peak value (double) for pstate_index
175  */
176 double simcall_host_get_power_peak_at(smx_host_t host, int pstate_index)
177 {
178   return simcall_BODY_host_get_power_peak_at(host, pstate_index);
179 }
180
181 /**
182  * \ingroup simix_host_management
183  * \brief Returns the number of power states for a host.
184  *
185  * \param host A SIMIX host
186  * \return the number of power states
187  */
188 int simcall_host_get_nb_pstates(smx_host_t host)
189 {
190   return simcall_BODY_host_get_nb_pstates(host);
191 }
192
193 /**
194  * \ingroup simix_host_management
195  * \brief Sets a new power peak for a host.
196  *
197  * \param host A SIMIX host
198  * \param pstate_index The pstate to which the CPU power will be set
199  */
200 void simcall_host_set_power_peak_at(smx_host_t host, int pstate_index)
201 {
202         simcall_BODY_host_set_power_peak_at(host, pstate_index);
203 }
204
205 /**
206  * \ingroup simix_host_management
207  * \brief Returns the total energy consumed by the host (in Joules)
208  *
209  * \param host A SIMIX host
210  * \return the energy consumed by the host (double)
211  */
212 double simcall_host_get_consumed_energy(smx_host_t host)
213 {
214   return simcall_BODY_host_get_consumed_energy(host);
215 }
216
217
218 /**
219  * \ingroup simix_host_management
220  * \brief Creates a synchro that executes some computation of an host.
221  *
222  * This function creates a SURF action and allocates the data necessary
223  * to create the SIMIX synchro. It can raise a host_error exception if the host crashed.
224  *
225  * \param name Name of the execution synchro to create
226  * \param host SIMIX host where the synchro will be executed
227  * \param flops_amount amount Computation amount (in flops)
228  * \param priority computation priority
229  * \param bound
230  * \param affinity_mask
231  * \return A new SIMIX execution synchronization
232  */
233 smx_synchro_t simcall_host_execute(const char *name, smx_host_t host,
234                                     double flops_amount,
235                                     double priority, double bound, unsigned long affinity_mask)
236 {
237   /* checking for infinite values */
238   xbt_assert(isfinite(flops_amount), "flops_amount is not finite!");
239   xbt_assert(isfinite(priority), "priority is not finite!");
240
241   return simcall_BODY_host_execute(name, host, flops_amount, priority, bound, affinity_mask);
242 }
243
244 /**
245  * \ingroup simix_host_management
246  * \brief Creates a synchro that may involve parallel computation on
247  * several hosts and communication between them.
248  *
249  * \param name Name of the execution synchro to create
250  * \param host_nb Number of hosts where the synchro will be executed
251  * \param host_list Array (of size host_nb) of hosts where the synchro will be executed
252  * \param flops_amount Array (of size host_nb) of computation amount of hosts (in bytes)
253  * \param bytes_amount Array (of size host_nb * host_nb) representing the communication
254  * amount between each pair of hosts
255  * \param amount the SURF action amount
256  * \param rate the SURF action rate
257  * \return A new SIMIX execution synchronization
258  */
259 smx_synchro_t simcall_host_parallel_execute(const char *name,
260                                          int host_nb,
261                                          smx_host_t *host_list,
262                                          double *flops_amount,
263                                          double *bytes_amount,
264                                          double amount,
265                                          double rate)
266 {
267   int i,j;
268   /* checking for infinite values */
269   for (i = 0 ; i < host_nb ; ++i) {
270      xbt_assert(isfinite(flops_amount[i]), "flops_amount[%d] is not finite!", i);
271      for (j = 0 ; j < host_nb ; ++j) {
272         xbt_assert(isfinite(bytes_amount[i + host_nb * j]),
273              "bytes_amount[%d+%d*%d] is not finite!", i, host_nb, j);
274      }
275   }
276
277   xbt_assert(isfinite(amount), "amount is not finite!");
278   xbt_assert(isfinite(rate), "rate is not finite!");
279
280   return simcall_BODY_host_parallel_execute(name, host_nb, host_list,
281                                             flops_amount,
282                                             bytes_amount,
283                                             amount, rate);
284
285 }
286
287 /**
288  * \ingroup simix_host_management
289  * \brief Destroys an execution synchro.
290  *
291  * Destroys a synchro, freeing its memory. This function cannot be called if there are a conditional waiting for it.
292  * \param execution The execution synchro to destroy
293  */
294 void simcall_host_execution_destroy(smx_synchro_t execution)
295 {
296   simcall_BODY_host_execution_destroy(execution);
297 }
298
299 /**
300  * \ingroup simix_host_management
301  * \brief Cancels an execution synchro.
302  *
303  * This functions stops the execution. It calls a surf function.
304  * \param execution The execution synchro to cancel
305  */
306 void simcall_host_execution_cancel(smx_synchro_t execution)
307 {
308   simcall_BODY_host_execution_cancel(execution);
309 }
310
311 /**
312  * \ingroup simix_host_management
313  * \brief Returns how much of an execution synchro remains to be done.
314  *
315  * \param execution The execution synchro
316  * \return The remaining amount
317  */
318 double simcall_host_execution_get_remains(smx_synchro_t execution)
319 {
320   return simcall_BODY_host_execution_get_remains(execution);
321 }
322
323 /**
324  * \ingroup simix_host_management
325  * \brief Returns the state of an execution synchro.
326  *
327  * \param execution The execution synchro
328  * \return The state
329  */
330 e_smx_state_t simcall_host_execution_get_state(smx_synchro_t execution)
331 {
332   return simcall_BODY_host_execution_get_state(execution);
333 }
334
335 /**
336  * \ingroup simix_host_management
337  * \brief Changes the priority of an execution synchro.
338  *
339  * This functions changes the priority only. It calls a surf function.
340  * \param execution The execution synchro
341  * \param priority The new priority
342  */
343 void simcall_host_execution_set_priority(smx_synchro_t execution, double priority)
344 {
345   /* checking for infinite values */
346   xbt_assert(isfinite(priority), "priority is not finite!");
347
348   simcall_BODY_host_execution_set_priority(execution, priority);
349 }
350
351 /**
352  * \ingroup simix_host_management
353  * \brief Changes the capping (the maximum CPU utilization) of an execution synchro.
354  *
355  * This functions changes the capping only. It calls a surf function.
356  * \param execution The execution synchro
357  * \param bound The new bound
358  */
359 void simcall_host_execution_set_bound(smx_synchro_t execution, double bound)
360 {
361   simcall_BODY_host_execution_set_bound(execution, bound);
362 }
363
364 /**
365  * \ingroup simix_host_management
366  * \brief Changes the CPU affinity of an execution synchro.
367  *
368  * This functions changes the CPU affinity of an execution synchro. See taskset(1) on Linux.
369  * \param execution The execution synchro
370  * \param host Host
371  * \param mask Affinity mask
372  */
373 void simcall_host_execution_set_affinity(smx_synchro_t execution, smx_host_t host, unsigned long mask)
374 {
375   simcall_BODY_host_execution_set_affinity(execution, host, mask);
376 }
377
378 /**
379  * \ingroup simix_host_management
380  * \brief Waits for the completion of an execution synchro and destroy it.
381  *
382  * \param execution The execution synchro
383  */
384 e_smx_state_t simcall_host_execution_wait(smx_synchro_t execution)
385 {
386   return simcall_BODY_host_execution_wait(execution);
387 }
388
389
390 /**
391  * \ingroup simix_vm_management
392  * \brief Create a VM on the given physical host.
393  *
394  * \param name VM name
395  * \param host Physical host
396  *
397  * \return The host object of the VM
398  */
399 void* simcall_vm_create(const char *name, smx_host_t phys_host){
400   return simcall_BODY_vm_create(name, phys_host);
401 }
402
403 /**
404  * \ingroup simix_vm_management
405  * \brief Start the given VM to the given physical host
406  *
407  * \param vm VM
408  */
409 void simcall_vm_start(smx_host_t vm)
410 {
411   simcall_BODY_vm_start(vm);
412 }
413
414 /**
415  * \ingroup simix_vm_management
416  * \brief Get the state of the given VM
417  *
418  * \param vm VM
419  * \return The state of the VM
420  */
421 int simcall_vm_get_state(smx_host_t vm)
422 {
423   return simcall_BODY_vm_get_state(vm);
424 }
425
426 /**
427  * \ingroup simix_vm_management
428  * \brief Get the name of the physical host on which the given VM runs.
429  *
430  * \param vm VM
431  * \return The name of the physical host
432  */
433 void *simcall_vm_get_pm(smx_host_t vm)
434 {
435   return simcall_BODY_vm_get_pm(vm);
436 }
437
438 void simcall_vm_set_bound(smx_host_t vm, double bound)
439 {
440   simcall_BODY_vm_set_bound(vm, bound);
441 }
442
443 void simcall_vm_set_affinity(smx_host_t vm, smx_host_t pm, unsigned long mask)
444 {
445   simcall_BODY_vm_set_affinity(vm, pm, mask);
446 }
447
448 void simcall_host_get_params(smx_host_t vm, ws_params_t params)
449 {
450   simcall_BODY_host_get_params(vm, params);
451 }
452
453 void simcall_host_set_params(smx_host_t vm, ws_params_t params)
454 {
455   simcall_BODY_host_set_params(vm, params);
456 }
457
458 /**
459  * \ingroup simix_vm_management
460  * \brief Migrate the given VM to the given physical host
461  *
462  * \param vm VM
463  * \param host Destination physical host
464  */
465 void simcall_vm_migrate(smx_host_t vm, smx_host_t host)
466 {
467   simcall_BODY_vm_migrate(vm, host);
468 }
469
470 /**
471  * \ingroup simix_vm_management
472  * \brief Suspend the given VM
473  *
474  * \param vm VM
475  */
476 void simcall_vm_suspend(smx_host_t vm)
477 {
478   simcall_BODY_vm_suspend(vm);
479 }
480
481 /**
482  * \ingroup simix_vm_management
483  * \brief Resume the given VM
484  *
485  * \param vm VM
486  */
487 void simcall_vm_resume(smx_host_t vm)
488 {
489   simcall_BODY_vm_resume(vm);
490 }
491
492 /**
493  * \ingroup simix_vm_management
494  * \brief Save the given VM
495  *
496  * \param vm VM
497  */
498 void simcall_vm_save(smx_host_t vm)
499 {
500   simcall_BODY_vm_save(vm);
501 }
502
503 /**
504  * \ingroup simix_vm_management
505  * \brief Restore the given VM
506  *
507  * \param vm VM
508  */
509 void simcall_vm_restore(smx_host_t vm)
510 {
511   simcall_BODY_vm_restore(vm);
512 }
513
514 /**
515  * \ingroup simix_vm_management
516  * \brief Shutdown the given VM
517  *
518  * \param vm VM
519  */
520 void simcall_vm_shutdown(smx_host_t vm)
521 {
522   simcall_BODY_vm_shutdown(vm);
523 }
524
525 /**
526  * \ingroup simix_vm_management
527  * \brief Destroy the given VM
528  *
529  * \param vm VM
530  */
531 void simcall_vm_destroy(smx_host_t vm)
532 {
533   simcall_BODY_vm_destroy(vm);
534 }
535
536
537 /**
538  * \ingroup simix_process_management
539  * \brief Creates and runs a new SIMIX process.
540  *
541  * The structure and the corresponding thread are created and put in the list of ready processes.
542  *
543  * \param process the process created will be stored in this pointer
544  * \param name a name for the process. It is for user-level information and can be NULL.
545  * \param code the main function of the process
546  * \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.
547  * It can be retrieved with the function \ref simcall_process_get_data.
548  * \param hostname name of the host where the new agent is executed.
549  * \param kill_time time when the process is killed
550  * \param argc first argument passed to \a code
551  * \param argv second argument passed to \a code
552  * \param properties the properties of the process
553  * \param auto_restart either it is autorestarting or not.
554  */
555 void simcall_process_create(smx_process_t *process, const char *name,
556                               xbt_main_func_t code,
557                               void *data,
558                               const char *hostname,
559                               double kill_time,
560                               int argc, char **argv,
561                               xbt_dict_t properties,
562                               int auto_restart)
563 {
564   simcall_BODY_process_create(process, name, code, data, hostname,
565                               kill_time, argc, argv, properties,
566                               auto_restart);
567 }
568
569 /**
570  * \ingroup simix_process_management
571  * \brief Kills a SIMIX process.
572  *
573  * This function simply kills a  process.
574  *
575  * \param process poor victim
576  */
577 void simcall_process_kill(smx_process_t process)
578 {
579   simcall_BODY_process_kill(process);
580 }
581
582 /**
583  * \ingroup simix_process_management
584  * \brief Kills all SIMIX processes.
585  */
586 void simcall_process_killall(int reset_pid)
587 {
588   simcall_BODY_process_killall(reset_pid);
589 }
590
591 /**
592  * \ingroup simix_process_management
593  * \brief Cleans up a SIMIX process.
594  * \param process poor victim (must have already been killed)
595  */
596 void simcall_process_cleanup(smx_process_t process)
597 {
598   simcall_BODY_process_cleanup(process);
599 }
600
601 /**
602  * \ingroup simix_process_management
603  * \brief Migrates an agent to another location.
604  *
605  * This function changes the value of the host on which \a process is running.
606  *
607  * \param process the process to migrate
608  * \param dest name of the new host
609  */
610 void simcall_process_change_host(smx_process_t process, smx_host_t dest)
611 {
612   simcall_BODY_process_change_host(process, dest);
613 }
614
615 void simcall_process_join(smx_process_t process, double timeout)
616 {
617   simcall_BODY_process_join(process, timeout);
618 }
619
620 /**
621  * \ingroup simix_process_management
622  * \brief Suspends a process.
623  *
624  * This function suspends the process by suspending the synchro
625  * it was waiting for completion.
626  *
627  * \param process a SIMIX process
628  */
629 void simcall_process_suspend(smx_process_t process)
630 {
631   xbt_assert(process, "Invalid parameters");
632
633   simcall_BODY_process_suspend(process);
634 }
635
636 /**
637  * \ingroup simix_process_management
638  * \brief Resumes a suspended process.
639  *
640  * This function resumes a suspended process by resuming the synchro
641  * it was waiting for completion.
642  *
643  * \param process a SIMIX process
644  */
645 void simcall_process_resume(smx_process_t process)
646 {
647   simcall_BODY_process_resume(process);
648 }
649
650 /**
651  * \ingroup simix_process_management
652  * \brief Returns the amount of SIMIX processes in the system
653  *
654  * Maestro internal process is not counted, only user code processes are
655  */
656 int simcall_process_count(void)
657 {
658   return simcall_BODY_process_count();
659 }
660
661 /**
662  * \ingroup simix_process_management
663  * \brief Return the PID of a #smx_process_t.
664  * \param process a SIMIX process
665  * \return the PID of this process
666  */
667 int simcall_process_get_PID(smx_process_t process)
668 {
669   if (process == SIMIX_process_self()) {
670     /* avoid a simcall if this function is called by the process itself */
671     return SIMIX_process_get_PID(process);
672   }
673
674   return simcall_BODY_process_get_PID(process);
675 }
676
677 /**
678  * \ingroup simix_process_management
679  * \brief Return the parent PID of a #smx_process_t.
680  * \param process a SIMIX process
681  * \return the PID of this process parenrt
682  */
683 int simcall_process_get_PPID(smx_process_t process)
684 {
685   if (process == SIMIX_process_self()) {
686     /* avoid a simcall if this function is called by the process itself */
687     return SIMIX_process_get_PPID(process);
688   }
689
690   return simcall_BODY_process_get_PPID(process);
691 }
692
693 /**
694  * \ingroup simix_process_management
695  * \brief Return the user data of a #smx_process_t.
696  * \param process a SIMIX process
697  * \return the user data of this process
698  */
699 void* simcall_process_get_data(smx_process_t process)
700 {
701   if (process == SIMIX_process_self()) {
702     /* avoid a simcall if this function is called by the process itself */
703     return SIMIX_process_get_data(process);
704   }
705
706   return simcall_BODY_process_get_data(process);
707 }
708
709 /**
710  * \ingroup simix_process_management
711  * \brief Set the user data of a #smx_process_t.
712  *
713  * This functions sets the user data associated to \a process.
714  * \param process SIMIX process
715  * \param data User data
716  */
717 void simcall_process_set_data(smx_process_t process, void *data)
718 {
719   if (process == SIMIX_process_self()) {
720     /* avoid a simcall if this function is called by the process itself */
721     SIMIX_process_self_set_data(process, data);
722   }
723   else {
724     simcall_BODY_process_set_data(process, data);
725   }
726 }
727
728 /**
729  * \ingroup simix_process_management
730  * \brief Set the kill time of a process.
731  * \param process a process
732  * \param kill_time a double
733  */
734 void simcall_process_set_kill_time(smx_process_t process, double kill_time)
735 {
736
737   if (kill_time > SIMIX_get_clock()) {
738     if (simix_global->kill_process_function) {
739       XBT_DEBUG("Set kill time %f for process %s(%s)",kill_time, process->name,
740           sg_host_name(process->smx_host));
741       SIMIX_timer_set(kill_time, simix_global->kill_process_function, process);
742     }
743   }
744 }
745
746 /**
747  * \ingroup simix_process_management
748  * \brief Return the location on which an agent is running.
749  *
750  * This functions returns the smx_host_t corresponding to the location on which
751  * \a process is running.
752  * \param process SIMIX process
753  * \return SIMIX host
754  */
755 smx_host_t simcall_process_get_host(smx_process_t process)
756 {
757   return simcall_BODY_process_get_host(process);
758 }
759
760 /**
761  * \ingroup simix_process_management
762  * \brief Return the name of an agent.
763  *
764  * This functions checks whether \a process is a valid pointer or not and return its name.
765  * \param process SIMIX process
766  * \return The process name
767  */
768 const char* simcall_process_get_name(smx_process_t process)
769 {
770   if (process == SIMIX_process_self()) {
771     /* avoid a simcall if this function is called by the process itself */
772     return process->name;
773   }
774   return simcall_BODY_process_get_name(process);
775 }
776
777 /**
778  * \ingroup simix_process_management
779  * \brief Returns true if the process is suspended .
780  *
781  * This checks whether a process is suspended or not by inspecting the task on which it was waiting for the completion.
782  * \param process SIMIX process
783  * \return 1, if the process is suspended, else 0.
784  */
785 int simcall_process_is_suspended(smx_process_t process)
786 {
787   return  simcall_BODY_process_is_suspended(process);
788 }
789
790 /**
791  * \ingroup simix_process_management
792  * \brief Return the properties
793  *
794  * This functions returns the properties associated with this process
795  */
796 xbt_dict_t simcall_process_get_properties(smx_process_t process)
797 {
798   return simcall_BODY_process_get_properties(process);
799 }
800 /**
801  * \ingroup simix_process_management
802  * \brief Add an on_exit function
803  * Add an on_exit function which will be executed when the process exits/is killed.
804  */
805 XBT_PUBLIC(void) simcall_process_on_exit(smx_process_t process, int_f_pvoid_pvoid_t fun, void *data)
806 {
807   simcall_BODY_process_on_exit(process, fun, data);
808 }
809 /**
810  * \ingroup simix_process_management
811  * \brief Sets the process to be auto-restarted or not by SIMIX when its host comes back up.
812  * Will restart the process when the host comes back up if auto_restart is set to 1.
813  */
814
815 XBT_PUBLIC(void) simcall_process_auto_restart_set(smx_process_t process, int auto_restart)
816 {
817   simcall_BODY_process_auto_restart_set(process, auto_restart);
818 }
819
820 /**
821  * \ingroup simix_process_management
822  * \brief Restarts the process, killing it and starting it again from scratch.
823  */
824 XBT_PUBLIC(smx_process_t) simcall_process_restart(smx_process_t process)
825 {
826   return simcall_BODY_process_restart(process);
827 }
828 /**
829  * \ingroup simix_process_management
830  * \brief Creates a new sleep SIMIX synchro.
831  *
832  * This function creates a SURF action and allocates the data necessary
833  * to create the SIMIX synchro. It can raise a host_error exception if the
834  * host crashed. The default SIMIX name of the synchro is "sleep".
835  *
836  *   \param duration Time duration of the sleep.
837  *   \return A result telling whether the sleep was successful
838  */
839 e_smx_state_t simcall_process_sleep(double duration)
840 {
841   /* checking for infinite values */
842   xbt_assert(isfinite(duration), "duration is not finite!");
843   return simcall_BODY_process_sleep(duration);
844 }
845
846 /**
847  *  \ingroup simix_rdv_management
848  *  \brief Creates a new rendez-vous point
849  *  \param name The name of the rendez-vous point
850  *  \return The created rendez-vous point
851  */
852 smx_rdv_t simcall_rdv_create(const char *name)
853 {
854   return simcall_BODY_rdv_create(name);
855 }
856
857
858 /**
859  *  \ingroup simix_rdv_management
860  *  \brief Destroy a rendez-vous point
861  *  \param rdv The rendez-vous point to destroy
862  */
863 void simcall_rdv_destroy(smx_rdv_t rdv)
864 {
865   simcall_BODY_rdv_destroy(rdv);
866 }
867 /**
868  *  \ingroup simix_rdv_management
869  *  \brief Returns a rendez-vous point knowing its name
870  */
871 smx_rdv_t simcall_rdv_get_by_name(const char *name)
872 {
873   xbt_assert(name != NULL, "Invalid parameter for simcall_rdv_get_by_name (name is NULL)");
874
875   /* FIXME: this is a horrible loss of performance, so we hack it out by
876    * skipping the simcall (for now). It works in parallel, it won't work on
877    * distributed but probably we will change MSG for that. */
878
879   return SIMIX_rdv_get_by_name(name);
880 }
881
882 /**
883  *  \ingroup simix_rdv_management
884  *  \brief Counts the number of communication synchros of a given host pending
885  *         on a rendez-vous point.
886  *  \param rdv The rendez-vous point
887  *  \param host The host to be counted
888  *  \return The number of comm synchros pending in the rdv
889  */
890 int simcall_rdv_comm_count_by_host(smx_rdv_t rdv, smx_host_t host)
891 {
892   return simcall_BODY_rdv_comm_count_by_host(rdv, host);
893 }
894
895 /**
896  *  \ingroup simix_rdv_management
897  *  \brief returns the communication at the head of the rendez-vous
898  *  \param rdv The rendez-vous point
899  *  \return The communication or NULL if empty
900  */
901 smx_synchro_t simcall_rdv_get_head(smx_rdv_t rdv)
902 {
903   return simcall_BODY_rdv_get_head(rdv);
904 }
905
906 void simcall_rdv_set_receiver(smx_rdv_t rdv, smx_process_t process)
907 {
908   simcall_BODY_rdv_set_receiver(rdv, process);
909 }
910
911 smx_process_t simcall_rdv_get_receiver(smx_rdv_t rdv)
912 {
913   return simcall_BODY_rdv_get_receiver(rdv);
914 }
915
916 /**
917  * \ingroup simix_comm_management
918  */
919 void simcall_comm_send(smx_process_t src, smx_rdv_t rdv, double task_size, double rate,
920                          void *src_buff, size_t src_buff_size,
921                          int (*match_fun)(void *, void *, smx_synchro_t),
922                          void (*copy_data_fun)(smx_synchro_t, void*, size_t), void *data,
923                          double timeout)
924 {
925   /* checking for infinite values */
926   xbt_assert(isfinite(task_size), "task_size is not finite!");
927   xbt_assert(isfinite(rate), "rate is not finite!");
928   xbt_assert(isfinite(timeout), "timeout is not finite!");
929
930   xbt_assert(rdv, "No rendez-vous point defined for send");
931
932   if (MC_is_active() || MC_record_replay_is_active()) {
933     /* the model-checker wants two separate simcalls */
934     smx_synchro_t comm = NULL; /* MC needs the comm to be set to NULL during the simcall */
935     comm = simcall_comm_isend(src, rdv, task_size, rate,
936         src_buff, src_buff_size, match_fun, NULL, copy_data_fun, data, 0);
937     simcall_comm_wait(comm, timeout);
938     comm = NULL;
939   }
940   else {
941     simcall_BODY_comm_send(src, rdv, task_size, rate, src_buff, src_buff_size,
942                          match_fun, copy_data_fun, data, timeout);
943   }
944 }
945
946 /**
947  * \ingroup simix_comm_management
948  */
949 smx_synchro_t simcall_comm_isend(smx_process_t src, smx_rdv_t rdv, double task_size, double rate,
950                               void *src_buff, size_t src_buff_size,
951                               int (*match_fun)(void *, void *, smx_synchro_t),
952                               void (*clean_fun)(void *),
953                               void (*copy_data_fun)(smx_synchro_t, void*, size_t),
954                               void *data,
955                               int detached)
956 {
957   /* checking for infinite values */
958   xbt_assert(isfinite(task_size), "task_size is not finite!");
959   xbt_assert(isfinite(rate), "rate is not finite!");
960
961   xbt_assert(rdv, "No rendez-vous point defined for isend");
962
963   return simcall_BODY_comm_isend(src, rdv, task_size, rate, src_buff,
964                                  src_buff_size, match_fun,
965                                  clean_fun, copy_data_fun, data, detached);
966 }
967
968 /**
969  * \ingroup simix_comm_management
970  */
971 void simcall_comm_recv(smx_rdv_t rdv, void *dst_buff, size_t * dst_buff_size,
972                        int (*match_fun)(void *, void *, smx_synchro_t),
973                        void (*copy_data_fun)(smx_synchro_t, void*, size_t),
974                        void *data, double timeout, double rate)
975 {
976   xbt_assert(isfinite(timeout), "timeout is not finite!");
977   xbt_assert(rdv, "No rendez-vous point defined for recv");
978
979   if (MC_is_active() || MC_record_replay_is_active()) {
980     /* the model-checker wants two separate simcalls */
981     smx_synchro_t comm = NULL; /* MC needs the comm to be set to NULL during the simcall */
982     comm = simcall_comm_irecv(rdv, dst_buff, dst_buff_size,
983                               match_fun, copy_data_fun, data, rate);
984     simcall_comm_wait(comm, timeout);
985     comm = NULL;
986   }
987   else {
988     simcall_BODY_comm_recv(rdv, dst_buff, dst_buff_size,
989                            match_fun, copy_data_fun, data, timeout, rate);
990   }
991 }
992 /**
993  * \ingroup simix_comm_management
994  */
995 smx_synchro_t simcall_comm_irecv(smx_rdv_t rdv, void *dst_buff, size_t *dst_buff_size,
996                                 int (*match_fun)(void *, void *, smx_synchro_t),
997                                 void (*copy_data_fun)(smx_synchro_t, void*, size_t),
998                                 void *data, double rate)
999 {
1000   xbt_assert(rdv, "No rendez-vous point defined for irecv");
1001
1002   return simcall_BODY_comm_irecv(rdv, dst_buff, dst_buff_size,
1003                                  match_fun, copy_data_fun, data, rate);
1004 }
1005
1006 /**
1007  * \ingroup simix_comm_management
1008  */
1009 smx_synchro_t simcall_comm_iprobe(smx_rdv_t rdv, int type, int src, int tag,
1010                                 int (*match_fun)(void *, void *, smx_synchro_t), void *data)
1011 {
1012   xbt_assert(rdv, "No rendez-vous point defined for iprobe");
1013
1014   return simcall_BODY_comm_iprobe(rdv, type, src, tag, match_fun, data);
1015 }
1016
1017 /**
1018  * \ingroup simix_comm_management
1019  */
1020 void simcall_comm_cancel(smx_synchro_t comm)
1021 {
1022   simcall_BODY_comm_cancel(comm);
1023 }
1024
1025 /**
1026  * \ingroup simix_comm_management
1027  */
1028 unsigned int simcall_comm_waitany(xbt_dynar_t comms)
1029 {
1030   return simcall_BODY_comm_waitany(comms);
1031 }
1032
1033 /**
1034  * \ingroup simix_comm_management
1035  */
1036 int simcall_comm_testany(xbt_dynar_t comms)
1037 {
1038   if (xbt_dynar_is_empty(comms))
1039     return -1;
1040   return simcall_BODY_comm_testany(comms);
1041 }
1042
1043 /**
1044  * \ingroup simix_comm_management
1045  */
1046 void simcall_comm_wait(smx_synchro_t comm, double timeout)
1047 {
1048   xbt_assert(isfinite(timeout), "timeout is not finite!");
1049   simcall_BODY_comm_wait(comm, timeout);
1050 }
1051
1052 /**
1053  * \brief Set the category of an synchro.
1054  *
1055  * This functions changes the category only. It calls a surf function.
1056  * \param execution The execution synchro
1057  * \param category The tracing category
1058  */
1059 void simcall_set_category(smx_synchro_t synchro, const char *category)
1060 {
1061   if (category == NULL) {
1062     return;
1063   }
1064   simcall_BODY_set_category(synchro, category);
1065 }
1066
1067 /**
1068  * \ingroup simix_comm_management
1069  *
1070  */
1071 int simcall_comm_test(smx_synchro_t comm)
1072 {
1073   return simcall_BODY_comm_test(comm);
1074 }
1075
1076 /**
1077  * \ingroup simix_comm_management
1078  *
1079  */
1080 double simcall_comm_get_remains(smx_synchro_t comm)
1081 {
1082   return simcall_BODY_comm_get_remains(comm);
1083 }
1084
1085 /**
1086  * \ingroup simix_comm_management
1087  *
1088  */
1089 e_smx_state_t simcall_comm_get_state(smx_synchro_t comm)
1090 {
1091   return simcall_BODY_comm_get_state(comm);
1092 }
1093
1094 /**
1095  * \ingroup simix_comm_management
1096  *
1097  */
1098 void *simcall_comm_get_src_data(smx_synchro_t comm)
1099 {
1100   return simcall_BODY_comm_get_src_data(comm);
1101 }
1102
1103 /**
1104  * \ingroup simix_comm_management
1105  *
1106  */
1107 void *simcall_comm_get_dst_data(smx_synchro_t comm)
1108 {
1109   return simcall_BODY_comm_get_dst_data(comm);
1110 }
1111
1112 /**
1113  * \ingroup simix_comm_management
1114  *
1115  */
1116 smx_process_t simcall_comm_get_src_proc(smx_synchro_t comm)
1117 {
1118   return simcall_BODY_comm_get_src_proc(comm);
1119 }
1120
1121 /**
1122  * \ingroup simix_comm_management
1123  *
1124  */
1125 smx_process_t simcall_comm_get_dst_proc(smx_synchro_t comm)
1126 {
1127   return simcall_BODY_comm_get_dst_proc(comm);
1128 }
1129
1130 #ifdef HAVE_LATENCY_BOUND_TRACKING
1131 int simcall_comm_is_latency_bounded(smx_synchro_t comm)
1132 {
1133   return simcall_BODY_comm_is_latency_bounded(comm);
1134 }
1135 #endif
1136
1137 /**
1138  * \ingroup simix_synchro_management
1139  *
1140  */
1141 smx_mutex_t simcall_mutex_init(void)
1142 {
1143   if(!simix_global) {
1144     fprintf(stderr,"You must run MSG_init before using MSG\n"); // We can't use xbt_die since we may get there before the initialization
1145     xbt_abort();
1146   }
1147   return simcall_BODY_mutex_init();
1148 }
1149
1150 /**
1151  * \ingroup simix_synchro_management
1152  *
1153  */
1154 void simcall_mutex_destroy(smx_mutex_t mutex)
1155 {
1156   simcall_BODY_mutex_destroy(mutex);
1157 }
1158
1159 /**
1160  * \ingroup simix_synchro_management
1161  *
1162  */
1163 void simcall_mutex_lock(smx_mutex_t mutex)
1164 {
1165   simcall_BODY_mutex_lock(mutex);
1166 }
1167
1168 /**
1169  * \ingroup simix_synchro_management
1170  *
1171  */
1172 int simcall_mutex_trylock(smx_mutex_t mutex)
1173 {
1174   return simcall_BODY_mutex_trylock(mutex);
1175 }
1176
1177 /**
1178  * \ingroup simix_synchro_management
1179  *
1180  */
1181 void simcall_mutex_unlock(smx_mutex_t mutex)
1182 {
1183   simcall_BODY_mutex_unlock(mutex);
1184 }
1185
1186 /**
1187  * \ingroup simix_synchro_management
1188  *
1189  */
1190 smx_cond_t simcall_cond_init(void)
1191 {
1192   return simcall_BODY_cond_init();
1193 }
1194
1195 /**
1196  * \ingroup simix_synchro_management
1197  *
1198  */
1199 void simcall_cond_destroy(smx_cond_t cond)
1200 {
1201   simcall_BODY_cond_destroy(cond);
1202 }
1203
1204 /**
1205  * \ingroup simix_synchro_management
1206  *
1207  */
1208 void simcall_cond_signal(smx_cond_t cond)
1209 {
1210   simcall_BODY_cond_signal(cond);
1211 }
1212
1213 /**
1214  * \ingroup simix_synchro_management
1215  *
1216  */
1217 void simcall_cond_wait(smx_cond_t cond, smx_mutex_t mutex)
1218 {
1219   simcall_BODY_cond_wait(cond, mutex);
1220 }
1221
1222 /**
1223  * \ingroup simix_synchro_management
1224  *
1225  */
1226 void simcall_cond_wait_timeout(smx_cond_t cond,
1227                                  smx_mutex_t mutex,
1228                                  double timeout)
1229 {
1230   xbt_assert(isfinite(timeout), "timeout is not finite!");
1231   simcall_BODY_cond_wait_timeout(cond, mutex, timeout);
1232 }
1233
1234 /**
1235  * \ingroup simix_synchro_management
1236  *
1237  */
1238 void simcall_cond_broadcast(smx_cond_t cond)
1239 {
1240   simcall_BODY_cond_broadcast(cond);
1241 }
1242
1243 /**
1244  * \ingroup simix_synchro_management
1245  *
1246  */
1247 smx_sem_t simcall_sem_init(int capacity)
1248 {
1249   return simcall_BODY_sem_init(capacity);
1250 }
1251
1252 /**
1253  * \ingroup simix_synchro_management
1254  *
1255  */
1256 void simcall_sem_destroy(smx_sem_t sem)
1257 {
1258   simcall_BODY_sem_destroy(sem);
1259 }
1260
1261 /**
1262  * \ingroup simix_synchro_management
1263  *
1264  */
1265 void simcall_sem_release(smx_sem_t sem)
1266 {
1267   simcall_BODY_sem_release(sem);
1268 }
1269
1270 /**
1271  * \ingroup simix_synchro_management
1272  *
1273  */
1274 int simcall_sem_would_block(smx_sem_t sem)
1275 {
1276   return simcall_BODY_sem_would_block(sem);
1277 }
1278
1279 /**
1280  * \ingroup simix_synchro_management
1281  *
1282  */
1283 void simcall_sem_acquire(smx_sem_t sem)
1284 {
1285   simcall_BODY_sem_acquire(sem);
1286 }
1287
1288 /**
1289  * \ingroup simix_synchro_management
1290  *
1291  */
1292 void simcall_sem_acquire_timeout(smx_sem_t sem, double timeout)
1293 {
1294   xbt_assert(isfinite(timeout), "timeout is not finite!");
1295   simcall_BODY_sem_acquire_timeout(sem, timeout);
1296 }
1297
1298 /**
1299  * \ingroup simix_synchro_management
1300  *
1301  */
1302 int simcall_sem_get_capacity(smx_sem_t sem)
1303 {
1304   return simcall_BODY_sem_get_capacity(sem);
1305 }
1306
1307 /**
1308  * \ingroup simix_file_management
1309  *
1310  */
1311 sg_size_t simcall_file_read(smx_file_t fd, sg_size_t size, smx_host_t host)
1312 {
1313   return simcall_BODY_file_read(fd, size, host);
1314 }
1315
1316 /**
1317  * \ingroup simix_file_management
1318  *
1319  */
1320 sg_size_t simcall_file_write(smx_file_t fd, sg_size_t size, smx_host_t host)
1321 {
1322   return simcall_BODY_file_write(fd, size, host);
1323 }
1324
1325 /**
1326  * \ingroup simix_file_management
1327  * \brief
1328  */
1329 smx_file_t simcall_file_open(const char* fullpath, smx_host_t host)
1330 {
1331   return simcall_BODY_file_open(fullpath, host);
1332 }
1333
1334 /**
1335  * \ingroup simix_file_management
1336  *
1337  */
1338 int simcall_file_close(smx_file_t fd, smx_host_t host)
1339 {
1340   return simcall_BODY_file_close(fd, host);
1341 }
1342
1343 /**
1344  * \ingroup simix_file_management
1345  *
1346  */
1347 int simcall_file_unlink(smx_file_t fd, smx_host_t host)
1348 {
1349   return simcall_BODY_file_unlink(fd, host);
1350 }
1351
1352 /**
1353  * \ingroup simix_file_management
1354  *
1355  */
1356 sg_size_t simcall_file_get_size(smx_file_t fd){
1357   return simcall_BODY_file_get_size(fd);
1358 }
1359
1360 /**
1361  * \ingroup simix_file_management
1362  *
1363  */
1364 sg_size_t simcall_file_tell(smx_file_t fd){
1365   return simcall_BODY_file_tell(fd);
1366 }
1367
1368 /**
1369  * \ingroup simix_file_management
1370  *
1371  */
1372 xbt_dynar_t simcall_file_get_info(smx_file_t fd)
1373 {
1374   return simcall_BODY_file_get_info(fd);
1375 }
1376
1377 /**
1378  * \ingroup simix_file_management
1379  *
1380  */
1381 int simcall_file_seek(smx_file_t fd, sg_offset_t offset, int origin){
1382   return simcall_BODY_file_seek(fd, offset, origin);
1383 }
1384
1385 /**
1386  * \ingroup simix_file_management
1387  * \brief Move a file to another location on the *same mount point*.
1388  *
1389  */
1390 int simcall_file_move(smx_file_t fd, const char* fullpath)
1391 {
1392   return simcall_BODY_file_move(fd, fullpath);
1393 }
1394
1395 /**
1396  * \ingroup simix_storage_management
1397  * \brief Returns the free space size on a given storage element.
1398  * \param storage a storage
1399  * \return Return the free space size on a given storage element (as sg_size_t)
1400  */
1401 sg_size_t simcall_storage_get_free_size (smx_storage_t storage){
1402   return simcall_BODY_storage_get_free_size(storage);
1403 }
1404
1405 /**
1406  * \ingroup simix_storage_management
1407  * \brief Returns the used space size on a given storage element.
1408  * \param storage a storage
1409  * \return Return the used space size on a given storage element (as sg_size_t)
1410  */
1411 sg_size_t simcall_storage_get_used_size (smx_storage_t storage){
1412   return simcall_BODY_storage_get_used_size(storage);
1413 }
1414
1415 /**
1416  * \ingroup simix_storage_management
1417  * \brief Returns the list of storages mounted on an host.
1418  * \param host A SIMIX host
1419  * \return a dict containing all storages mounted on the host
1420  */
1421 xbt_dict_t simcall_host_get_mounted_storage_list(smx_host_t host)
1422 {
1423   return simcall_BODY_host_get_mounted_storage_list(host);
1424 }
1425
1426 /**
1427  * \ingroup simix_storage_management
1428  * \brief Returns the list of storages attached to an host.
1429  * \param host A SIMIX host
1430  * \return a dict containing all storages attached to the host
1431  */
1432 xbt_dynar_t simcall_host_get_attached_storage_list(smx_host_t host)
1433 {
1434   return simcall_BODY_host_get_attached_storage_list(host);
1435 }
1436
1437 /**
1438  * \ingroup simix_storage_management
1439  * \brief Returns a dict of the properties assigned to a storage element.
1440  *
1441  * \param storage A storage element
1442  * \return The properties of this storage element
1443  */
1444 xbt_dict_t simcall_storage_get_properties(smx_storage_t storage)
1445 {
1446   return simcall_BODY_storage_get_properties(storage);
1447 }
1448
1449 /**
1450  * \ingroup simix_storage_management
1451  * \brief Returns a dict containing the content of a storage element.
1452  *
1453  * \param storage A storage element
1454  * \return The content of this storage element as a dict (full path file => size)
1455  */
1456 xbt_dict_t simcall_storage_get_content(smx_storage_t storage)
1457 {
1458   return simcall_BODY_storage_get_content(storage);
1459 }
1460
1461
1462
1463 #ifdef HAVE_MC
1464
1465 void *simcall_mc_snapshot(void) {
1466   return simcall_BODY_mc_snapshot();
1467 }
1468
1469 int simcall_mc_compare_snapshots(void *s1, void *s2) {
1470   return simcall_BODY_mc_compare_snapshots(s1, s2);
1471 }
1472
1473 #endif /* HAVE_MC */
1474
1475 int simcall_mc_random(int min, int max) {
1476   return simcall_BODY_mc_random(min, max);
1477 }
1478
1479 /* ************************************************************************** */
1480
1481 /** @brief returns a printable string representing a simcall */
1482 const char *SIMIX_simcall_name(e_smx_simcall_t kind) {
1483   return simcall_names[kind];
1484 }