Logo AND Algorithmique Numérique Distribuée

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