Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
simcall to kernelImmediate
[simgrid.git] / src / simix / libsmx.cpp
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 <cmath>         /* std::isfinite() */
15
16 #include <functional>
17
18 #include "mc/mc.h"
19 #include "simgrid/s4u/VirtualMachine.hpp"
20 #include "simgrid/simix.hpp"
21 #include "simgrid/simix/blocking_simcall.hpp"
22 #include "smx_private.h"
23 #include "src/kernel/activity/CommImpl.hpp"
24 #include "src/mc/mc_forward.hpp"
25 #include "src/mc/mc_replay.h"
26 #include "src/plugins/vm/VirtualMachineImpl.hpp"
27 #include "src/simix/smx_host_private.h"
28 #include "xbt/ex.h"
29 #include "xbt/functional.hpp"
30
31 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(simix);
32
33 #include "popping_bodies.cpp"
34
35 void simcall_call(smx_actor_t actor)
36 {
37   if (actor != simix_global->maestro_process) {
38     XBT_DEBUG("Yield actor '%s' on simcall %s (%d)", actor->cname(), SIMIX_simcall_name(actor->simcall.call),
39               (int)actor->simcall.call);
40     SIMIX_process_yield(actor);
41   } else {
42     SIMIX_simcall_handle(&actor->simcall, 0);
43   }
44 }
45
46 /**
47  * \ingroup simix_process_management
48  * \brief Creates a synchro that executes some computation of an host.
49  *
50  * This function creates a SURF action and allocates the data necessary
51  * to create the SIMIX synchro. It can raise a host_error exception if the host crashed.
52  *
53  * \param name Name of the execution synchro to create
54  * \param flops_amount amount Computation amount (in flops)
55  * \param priority computation priority
56  * \param bound
57  * \return A new SIMIX execution synchronization
58  */
59 smx_activity_t simcall_execution_start(const char *name,
60                                     double flops_amount,
61                                     double priority, double bound)
62 {
63   /* checking for infinite values */
64   xbt_assert(std::isfinite(flops_amount), "flops_amount is not finite!");
65   xbt_assert(std::isfinite(priority), "priority is not finite!");
66
67   return simcall_BODY_execution_start(name, flops_amount, priority, bound);
68 }
69
70 /**
71  * \ingroup simix_process_management
72  * \brief Creates a synchro that may involve parallel computation on
73  * several hosts and communication between them.
74  *
75  * \param name Name of the execution synchro to create
76  * \param host_nb Number of hosts where the synchro will be executed
77  * \param host_list Array (of size host_nb) of hosts where the synchro will be executed
78  * \param flops_amount Array (of size host_nb) of computation amount of hosts (in bytes)
79  * \param bytes_amount Array (of size host_nb * host_nb) representing the communication
80  * amount between each pair of hosts
81  * \param amount the SURF action amount
82  * \param rate the SURF action rate
83  * \param timeout timeout
84  * \return A new SIMIX execution synchronization
85  */
86 smx_activity_t simcall_execution_parallel_start(const char* name, int host_nb, sg_host_t* host_list,
87                                                 double* flops_amount, double* bytes_amount, double amount, double rate,
88                                                 double timeout)
89 {
90   /* checking for infinite values */
91   for (int i = 0 ; i < host_nb ; ++i) {
92     xbt_assert(std::isfinite(flops_amount[i]), "flops_amount[%d] is not finite!", i);
93     if (bytes_amount != nullptr) {
94       for (int j = 0 ; j < host_nb ; ++j) {
95         xbt_assert(std::isfinite(bytes_amount[i + host_nb * j]),
96                    "bytes_amount[%d+%d*%d] is not finite!", i, host_nb, j);
97       }
98     }
99   }
100
101   xbt_assert(std::isfinite(amount), "amount is not finite!");
102   xbt_assert(std::isfinite(rate), "rate is not finite!");
103
104   return simcall_BODY_execution_parallel_start(name, host_nb, host_list, flops_amount, bytes_amount, amount, rate,
105                                                timeout);
106 }
107
108 /**
109  * \ingroup simix_process_management
110  * \brief Cancels an execution synchro.
111  *
112  * This functions stops the execution. It calls a surf function.
113  * \param execution The execution synchro to cancel
114  */
115 void simcall_execution_cancel(smx_activity_t execution)
116 {
117   simcall_BODY_execution_cancel(execution);
118 }
119
120 /**
121  * \ingroup simix_process_management
122  * \brief Changes the priority of an execution synchro.
123  *
124  * This functions changes the priority only. It calls a surf function.
125  * \param execution The execution synchro
126  * \param priority The new priority
127  */
128 void simcall_execution_set_priority(smx_activity_t execution, double priority)
129 {
130   /* checking for infinite values */
131   xbt_assert(std::isfinite(priority), "priority is not finite!");
132
133   simcall_BODY_execution_set_priority(execution, priority);
134 }
135
136 /**
137  * \ingroup simix_process_management
138  * \brief Changes the capping (the maximum CPU utilization) of an execution synchro.
139  *
140  * This functions changes the capping only. It calls a surf function.
141  * \param execution The execution synchro
142  * \param bound The new bound
143  */
144 void simcall_execution_set_bound(smx_activity_t execution, double bound)
145 {
146   simcall_BODY_execution_set_bound(execution, bound);
147 }
148
149 /**
150  * \ingroup simix_host_management
151  * \brief Waits for the completion of an execution synchro and destroy it.
152  *
153  * \param execution The execution synchro
154  */
155 e_smx_state_t simcall_execution_wait(smx_activity_t execution)
156 {
157   return (e_smx_state_t) simcall_BODY_execution_wait(execution);
158 }
159
160 /**
161  * \ingroup simix_process_management
162  * \brief Kills a SIMIX process.
163  *
164  * This function simply kills a  process.
165  *
166  * \param process poor victim
167  */
168 void simcall_process_kill(smx_actor_t process)
169 {
170   simcall_BODY_process_kill(process);
171 }
172
173 /**
174  * \ingroup simix_process_management
175  * \brief Kills all SIMIX processes.
176  */
177 void simcall_process_killall(int reset_pid)
178 {
179   simcall_BODY_process_killall(reset_pid);
180 }
181
182 /**
183  * \ingroup simix_process_management
184  * \brief Cleans up a SIMIX process.
185  * \param process poor victim (must have already been killed)
186  */
187 void simcall_process_cleanup(smx_actor_t process)
188 {
189   simcall_BODY_process_cleanup(process);
190 }
191
192 void simcall_process_join(smx_actor_t process, double timeout)
193 {
194   simcall_BODY_process_join(process, timeout);
195 }
196
197 /**
198  * \ingroup simix_process_management
199  * \brief Suspends a process.
200  *
201  * This function suspends the process by suspending the synchro
202  * it was waiting for completion.
203  *
204  * \param process a SIMIX process
205  */
206 void simcall_process_suspend(smx_actor_t process)
207 {
208   simcall_BODY_process_suspend(process);
209 }
210
211 /**
212  * \ingroup simix_process_management
213  * \brief Resumes a suspended process.
214  *
215  * This function resumes a suspended process by resuming the synchro
216  * it was waiting for completion.
217  *
218  * \param process a SIMIX process
219  */
220 void simcall_process_resume(smx_actor_t process)
221 {
222   simcall_BODY_process_resume(process);
223 }
224
225 /**
226  * \ingroup simix_process_management
227  * \brief Returns the amount of SIMIX processes in the system
228  *
229  * Maestro internal process is not counted, only user code processes are
230  */
231 int simcall_process_count()
232 {
233   return simgrid::simix::kernelImmediate(SIMIX_process_count);
234 }
235
236 /**
237  * \ingroup simix_process_management
238  * \brief Set the user data of a #smx_actor_t.
239  *
240  * This functions sets the user data associated to \a process.
241  * \param process SIMIX process
242  * \param data User data
243  */
244 void simcall_process_set_data(smx_actor_t process, void *data)
245 {
246   simgrid::simix::kernelImmediate(std::bind(SIMIX_process_set_data, process, data));
247 }
248
249 /**
250  * \ingroup simix_process_management
251  * \brief Set the kill time of a process.
252  */
253 void simcall_process_set_kill_time(smx_actor_t process, double kill_time)
254 {
255
256   if (kill_time <= SIMIX_get_clock() || simix_global->kill_process_function == nullptr)
257     return;
258   XBT_DEBUG("Set kill time %f for process %s@%s", kill_time, process->cname(), process->host->cname());
259   process->kill_timer = SIMIX_timer_set(kill_time, [=] {
260     simix_global->kill_process_function(process);
261     process->kill_timer=nullptr;
262   });
263 }
264 /**
265  * \ingroup simix_process_management
266  * \brief Get the kill time of a process (or 0 if unset).
267  */
268 double simcall_process_get_kill_time(smx_actor_t process) {
269   return SIMIX_timer_get_date(process->kill_timer);
270 }
271
272 /**
273  * \ingroup simix_process_management
274  * \brief Return the properties
275  *
276  * This functions returns the properties associated with this process
277  */
278 xbt_dict_t simcall_process_get_properties(smx_actor_t process)
279 {
280   return SIMIX_process_get_properties(process);
281 }
282 /**
283  * \ingroup simix_process_management
284  * \brief Add an on_exit function
285  * Add an on_exit function which will be executed when the process exits/is killed.
286  */
287 XBT_PUBLIC(void) simcall_process_on_exit(smx_actor_t process, int_f_pvoid_pvoid_t fun, void *data)
288 {
289   simcall_BODY_process_on_exit(process, fun, data);
290 }
291 /**
292  * \ingroup simix_process_management
293  * \brief Sets the process to be auto-restarted or not by SIMIX when its host comes back up.
294  * Will restart the process when the host comes back up if auto_restart is set to 1.
295  */
296
297 XBT_PUBLIC(void) simcall_process_auto_restart_set(smx_actor_t process, int auto_restart)
298 {
299   simcall_BODY_process_auto_restart_set(process, auto_restart);
300 }
301
302 /**
303  * \ingroup simix_process_management
304  * \brief Restarts the process, killing it and starting it again from scratch.
305  */
306 XBT_PUBLIC(smx_actor_t) simcall_process_restart(smx_actor_t process)
307 {
308   return (smx_actor_t) simcall_BODY_process_restart(process);
309 }
310 /**
311  * \ingroup simix_process_management
312  * \brief Creates a new sleep SIMIX synchro.
313  *
314  * This function creates a SURF action and allocates the data necessary
315  * to create the SIMIX synchro. It can raise a host_error exception if the
316  * host crashed. The default SIMIX name of the synchro is "sleep".
317  *
318  *   \param duration Time duration of the sleep.
319  *   \return A result telling whether the sleep was successful
320  */
321 e_smx_state_t simcall_process_sleep(double duration)
322 {
323   /* checking for infinite values */
324   xbt_assert(std::isfinite(duration), "duration is not finite!");
325   return (e_smx_state_t) simcall_BODY_process_sleep(duration);
326 }
327
328 /**
329  * \ingroup simix_comm_management
330  */
331 void simcall_comm_send(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
332                        size_t src_buff_size, int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
333                        void (*copy_data_fun)(smx_activity_t, void*, size_t), void* data, double timeout)
334 {
335   /* checking for infinite values */
336   xbt_assert(std::isfinite(task_size), "task_size is not finite!");
337   xbt_assert(std::isfinite(rate), "rate is not finite!");
338   xbt_assert(std::isfinite(timeout), "timeout is not finite!");
339
340   xbt_assert(mbox, "No rendez-vous point defined for send");
341
342   if (MC_is_active() || MC_record_replay_is_active()) {
343     /* the model-checker wants two separate simcalls */
344     smx_activity_t comm = nullptr; /* MC needs the comm to be set to nullptr during the simcall */
345     comm = simcall_comm_isend(sender, mbox, task_size, rate,
346         src_buff, src_buff_size, match_fun, nullptr, copy_data_fun, data, 0);
347     simcall_comm_wait(comm, timeout);
348     comm = nullptr;
349   }
350   else {
351     simcall_BODY_comm_send(sender, mbox, task_size, rate, src_buff, src_buff_size,
352                          match_fun, copy_data_fun, data, timeout);
353   }
354 }
355
356 /**
357  * \ingroup simix_comm_management
358  */
359 smx_activity_t simcall_comm_isend(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
360                                   size_t src_buff_size,
361                                   int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
362                                   void (*clean_fun)(void*), void (*copy_data_fun)(smx_activity_t, void*, size_t),
363                                   void* data, int detached)
364 {
365   /* checking for infinite values */
366   xbt_assert(std::isfinite(task_size), "task_size is not finite!");
367   xbt_assert(std::isfinite(rate), "rate is not finite!");
368
369   xbt_assert(mbox, "No rendez-vous point defined for isend");
370
371   return simcall_BODY_comm_isend(sender, mbox, task_size, rate, src_buff,
372                                  src_buff_size, match_fun,
373                                  clean_fun, copy_data_fun, data, detached);
374 }
375
376 /**
377  * \ingroup simix_comm_management
378  */
379 void simcall_comm_recv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
380                        int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
381                        void (*copy_data_fun)(smx_activity_t, void*, size_t), void* data, double timeout, double rate)
382 {
383   xbt_assert(std::isfinite(timeout), "timeout is not finite!");
384   xbt_assert(mbox, "No rendez-vous point defined for recv");
385
386   if (MC_is_active() || MC_record_replay_is_active()) {
387     /* the model-checker wants two separate simcalls */
388     smx_activity_t comm = nullptr; /* MC needs the comm to be set to nullptr during the simcall */
389     comm = simcall_comm_irecv(receiver, mbox, dst_buff, dst_buff_size,
390                               match_fun, copy_data_fun, data, rate);
391     simcall_comm_wait(comm, timeout);
392     comm = nullptr;
393   }
394   else {
395     simcall_BODY_comm_recv(receiver, mbox, dst_buff, dst_buff_size,
396                            match_fun, copy_data_fun, data, timeout, rate);
397   }
398 }
399 /**
400  * \ingroup simix_comm_management
401  */
402 smx_activity_t simcall_comm_irecv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
403                                   int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
404                                   void (*copy_data_fun)(smx_activity_t, void*, size_t), void* data, double rate)
405 {
406   xbt_assert(mbox, "No rendez-vous point defined for irecv");
407
408   return simcall_BODY_comm_irecv(receiver, mbox, dst_buff, dst_buff_size,
409                                  match_fun, copy_data_fun, data, rate);
410 }
411
412 /**
413  * \ingroup simix_comm_management
414  */
415 smx_activity_t simcall_comm_iprobe(smx_mailbox_t mbox, int type, int src, int tag,
416                                    int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*), void* data)
417 {
418   xbt_assert(mbox, "No rendez-vous point defined for iprobe");
419
420   return simcall_BODY_comm_iprobe(mbox, type, src, tag, match_fun, data);
421 }
422
423 /**
424  * \ingroup simix_comm_management
425  */
426 void simcall_comm_cancel(smx_activity_t synchro)
427 {
428   simgrid::simix::kernelImmediate([synchro] {
429     simgrid::kernel::activity::CommImplPtr comm =
430         boost::static_pointer_cast<simgrid::kernel::activity::CommImpl>(synchro);
431     comm->cancel();
432   });
433 }
434
435 /**
436  * \ingroup simix_comm_management
437  */
438 unsigned int simcall_comm_waitany(xbt_dynar_t comms, double timeout)
439 {
440   return simcall_BODY_comm_waitany(comms, timeout);
441 }
442
443 /**
444  * \ingroup simix_comm_management
445  */
446 int simcall_comm_testany(smx_activity_t* comms, size_t count)
447 {
448   if (count == 0)
449     return -1;
450   return simcall_BODY_comm_testany(comms, count);
451 }
452
453 /**
454  * \ingroup simix_comm_management
455  */
456 void simcall_comm_wait(smx_activity_t comm, double timeout)
457 {
458   xbt_assert(std::isfinite(timeout), "timeout is not finite!");
459   simcall_BODY_comm_wait(comm, timeout);
460 }
461
462 /**
463  * \brief Set the category of an synchro.
464  *
465  * This functions changes the category only. It calls a surf function.
466  * \param synchro The execution synchro
467  * \param category The tracing category
468  */
469 void simcall_set_category(smx_activity_t synchro, const char *category)
470 {
471   if (category == nullptr) {
472     return;
473   }
474   simcall_BODY_set_category(synchro, category);
475 }
476
477 /**
478  * \ingroup simix_comm_management
479  *
480  */
481 int simcall_comm_test(smx_activity_t comm)
482 {
483   return simcall_BODY_comm_test(comm);
484 }
485
486 /**
487  * \ingroup simix_synchro_management
488  *
489  */
490 smx_mutex_t simcall_mutex_init()
491 {
492   if (not simix_global) {
493     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
494     xbt_abort();
495   }
496   return simcall_BODY_mutex_init();
497 }
498
499 /**
500  * \ingroup simix_synchro_management
501  *
502  */
503 void simcall_mutex_lock(smx_mutex_t mutex)
504 {
505   simcall_BODY_mutex_lock(mutex);
506 }
507
508 /**
509  * \ingroup simix_synchro_management
510  *
511  */
512 int simcall_mutex_trylock(smx_mutex_t mutex)
513 {
514   return simcall_BODY_mutex_trylock(mutex);
515 }
516
517 /**
518  * \ingroup simix_synchro_management
519  *
520  */
521 void simcall_mutex_unlock(smx_mutex_t mutex)
522 {
523   simcall_BODY_mutex_unlock(mutex);
524 }
525
526 /**
527  * \ingroup simix_synchro_management
528  *
529  */
530 smx_cond_t simcall_cond_init()
531 {
532   return simcall_BODY_cond_init();
533 }
534
535 /**
536  * \ingroup simix_synchro_management
537  *
538  */
539 void simcall_cond_signal(smx_cond_t cond)
540 {
541   simcall_BODY_cond_signal(cond);
542 }
543
544 /**
545  * \ingroup simix_synchro_management
546  *
547  */
548 void simcall_cond_wait(smx_cond_t cond, smx_mutex_t mutex)
549 {
550   simcall_BODY_cond_wait(cond, mutex);
551 }
552
553 /**
554  * \ingroup simix_synchro_management
555  *
556  */
557 void simcall_cond_wait_timeout(smx_cond_t cond,
558                                  smx_mutex_t mutex,
559                                  double timeout)
560 {
561   xbt_assert(std::isfinite(timeout), "timeout is not finite!");
562   simcall_BODY_cond_wait_timeout(cond, mutex, timeout);
563 }
564
565 /**
566  * \ingroup simix_synchro_management
567  *
568  */
569 void simcall_cond_broadcast(smx_cond_t cond)
570 {
571   simcall_BODY_cond_broadcast(cond);
572 }
573
574 /**
575  * \ingroup simix_synchro_management
576  *
577  */
578 smx_sem_t simcall_sem_init(int capacity)
579 {
580   return simcall_BODY_sem_init(capacity);
581 }
582
583 /**
584  * \ingroup simix_synchro_management
585  *
586  */
587 void simcall_sem_release(smx_sem_t sem)
588 {
589   simcall_BODY_sem_release(sem);
590 }
591
592 /**
593  * \ingroup simix_synchro_management
594  *
595  */
596 int simcall_sem_would_block(smx_sem_t sem)
597 {
598   return simcall_BODY_sem_would_block(sem);
599 }
600
601 /**
602  * \ingroup simix_synchro_management
603  *
604  */
605 void simcall_sem_acquire(smx_sem_t sem)
606 {
607   simcall_BODY_sem_acquire(sem);
608 }
609
610 /**
611  * \ingroup simix_synchro_management
612  *
613  */
614 void simcall_sem_acquire_timeout(smx_sem_t sem, double timeout)
615 {
616   xbt_assert(std::isfinite(timeout), "timeout is not finite!");
617   simcall_BODY_sem_acquire_timeout(sem, timeout);
618 }
619
620 /**
621  * \ingroup simix_synchro_management
622  *
623  */
624 int simcall_sem_get_capacity(smx_sem_t sem)
625 {
626   return simcall_BODY_sem_get_capacity(sem);
627 }
628
629 /**
630  * \ingroup simix_file_management
631  *
632  */
633 sg_size_t simcall_file_read(surf_file_t fd, sg_size_t size, sg_host_t host)
634 {
635   return simcall_BODY_file_read(fd, size, host);
636 }
637
638 /**
639  * \ingroup simix_file_management
640  *
641  */
642 sg_size_t simcall_file_write(surf_file_t fd, sg_size_t size, sg_host_t host)
643 {
644   return simcall_BODY_file_write(fd, size, host);
645 }
646
647 /**
648  * \ingroup simix_file_management
649  * \brief
650  */
651 surf_file_t simcall_file_open(const char* mount, const char* path, sg_storage_t st)
652 {
653   return simcall_BODY_file_open(mount, path, st);
654 }
655
656 /**
657  * \ingroup simix_file_management
658  *
659  */
660 int simcall_file_close(surf_file_t fd, sg_host_t host)
661 {
662   return simcall_BODY_file_close(fd, host);
663 }
664
665 void simcall_run_kernel(std::function<void()> const& code)
666 {
667   simcall_BODY_run_kernel(&code);
668 }
669
670 void simcall_run_blocking(std::function<void()> const& code)
671 {
672   simcall_BODY_run_blocking(&code);
673 }
674
675 int simcall_mc_random(int min, int max) {
676   return simcall_BODY_mc_random(min, max);
677 }
678
679 /* ************************************************************************** */
680
681 /** @brief returns a printable string representing a simcall */
682 const char *SIMIX_simcall_name(e_smx_simcall_t kind) {
683   return simcall_names[kind];
684 }
685
686 namespace simgrid {
687 namespace simix {
688
689 void unblock(smx_actor_t process)
690 {
691   xbt_assert(SIMIX_is_maestro());
692   SIMIX_simcall_answer(&process->simcall);
693 }
694
695 }
696 }