Logo AND Algorithmique Numérique Distribuée

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