Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
ae935f923da7eef11e1c0281528631418a89f25b
[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-2018. 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 <cmath>         /* std::isfinite() */
14
15 #include <functional>
16
17 #include "mc/mc.h"
18 #include "simgrid/s4u/VirtualMachine.hpp"
19 #include "simgrid/simix.hpp"
20 #include "simgrid/simix/blocking_simcall.hpp"
21 #include "smx_private.hpp"
22 #include "src/kernel/activity/CommImpl.hpp"
23 #include "src/kernel/activity/ConditionVariableImpl.hpp"
24 #include "src/kernel/activity/MutexImpl.hpp"
25 #include "src/mc/mc_forward.hpp"
26 #include "src/mc/mc_replay.hpp"
27 #include "src/plugins/vm/VirtualMachineImpl.hpp"
28 #include "src/simix/smx_host_private.hpp"
29 #include "xbt/ex.h"
30 #include "xbt/functional.hpp"
31
32 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(simix);
33
34 #include "popping_bodies.cpp"
35
36 void simcall_call(smx_actor_t actor)
37 {
38   if (actor != simix_global->maestro_process) {
39     XBT_DEBUG("Yield actor '%s' on simcall %s (%d)", actor->get_cname(), SIMIX_simcall_name(actor->simcall.call),
40               (int)actor->simcall.call);
41     SIMIX_process_yield(actor);
42   } else {
43     SIMIX_simcall_handle(&actor->simcall, 0);
44   }
45 }
46
47 /**
48  * \ingroup simix_process_management
49  * \brief Creates a synchro that executes some computation of an host.
50  *
51  * This function creates a SURF action and allocates the data necessary
52  * to create the SIMIX synchro. It can raise a host_error exception if the host crashed.
53  *
54  * \param name Name of the execution synchro to create
55  * \param flops_amount amount Computation amount (in flops)
56  * \param priority computation priority
57  * \param bound
58  * \param host host where the synchro will be executed
59  * \return A new SIMIX execution synchronization
60  */
61 smx_activity_t simcall_execution_start(const char* name, double flops_amount, double priority, double bound,
62                                        simgrid::s4u::Host* host)
63 {
64   /* checking for infinite values */
65   xbt_assert(std::isfinite(flops_amount), "flops_amount is not finite!");
66   xbt_assert(std::isfinite(priority), "priority is not finite!");
67
68   return simcall_BODY_execution_start(name, flops_amount, priority, bound, host);
69 }
70
71 /**
72  * \ingroup simix_process_management
73  * \brief Creates a synchro that may involve parallel computation on
74  * several hosts and communication between them.
75  *
76  * \param name Name of the execution synchro to create
77  * \param host_nb Number of hosts where the synchro will be executed
78  * \param host_list Array (of size host_nb) of hosts where the synchro will be executed
79  * \param flops_amount Array (of size host_nb) of computation amount of hosts (in bytes)
80  * \param bytes_amount Array (of size host_nb * host_nb) representing the communication
81  * amount between each pair of hosts
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 rate, double timeout)
88 {
89   /* checking for infinite values */
90   for (int i = 0 ; i < host_nb ; ++i) {
91     xbt_assert(std::isfinite(flops_amount[i]), "flops_amount[%d] is not finite!", i);
92     if (bytes_amount != nullptr) {
93       for (int j = 0 ; j < host_nb ; ++j) {
94         xbt_assert(std::isfinite(bytes_amount[i + host_nb * j]),
95                    "bytes_amount[%d+%d*%d] is not finite!", i, host_nb, j);
96       }
97     }
98   }
99
100   xbt_assert(std::isfinite(rate), "rate is not finite!");
101
102   return simcall_BODY_execution_parallel_start(name, host_nb, host_list, flops_amount, bytes_amount, rate, timeout);
103 }
104
105 /**
106  * \ingroup simix_process_management
107  * \brief Cancels an execution synchro.
108  *
109  * This functions stops the execution. It calls a surf function.
110  * \param execution The execution synchro to cancel
111  */
112 void simcall_execution_cancel(smx_activity_t execution)
113 {
114   simgrid::kernel::activity::ExecImplPtr exec =
115       boost::static_pointer_cast<simgrid::kernel::activity::ExecImpl>(execution);
116   if (not exec->surfAction_)
117     return;
118   simgrid::simix::kernelImmediate([exec] {
119     XBT_DEBUG("Cancel synchro %p", exec.get());
120     if (exec->surfAction_)
121       exec->surfAction_->cancel();
122   });
123 }
124
125 /**
126  * \ingroup simix_process_management
127  * \brief Changes the priority of an execution synchro.
128  *
129  * This functions changes the priority only. It calls a surf function.
130  * \param execution The execution synchro
131  * \param priority The new priority
132  */
133 void simcall_execution_set_priority(smx_activity_t execution, double priority)
134 {
135   /* checking for infinite values */
136   xbt_assert(std::isfinite(priority), "priority is not finite!");
137   simgrid::simix::kernelImmediate([execution, priority] {
138
139     simgrid::kernel::activity::ExecImplPtr exec =
140         boost::static_pointer_cast<simgrid::kernel::activity::ExecImpl>(execution);
141     if (exec->surfAction_)
142       exec->surfAction_->set_priority(priority);
143   });
144 }
145
146 /**
147  * \ingroup simix_process_management
148  * \brief Changes the capping (the maximum CPU utilization) of an execution synchro.
149  *
150  * This functions changes the capping only. It calls a surf function.
151  * \param execution The execution synchro
152  * \param bound The new bound
153  */
154 void simcall_execution_set_bound(smx_activity_t execution, double bound)
155 {
156   simgrid::simix::kernelImmediate([execution, bound] {
157     simgrid::kernel::activity::ExecImplPtr exec =
158         boost::static_pointer_cast<simgrid::kernel::activity::ExecImpl>(execution);
159     if (exec->surfAction_)
160       exec->surfAction_->set_bound(bound);
161   });
162 }
163
164 /**
165  * \ingroup simix_host_management
166  * \brief Waits for the completion of an execution synchro and destroy it.
167  *
168  * \param execution The execution synchro
169  */
170 e_smx_state_t simcall_execution_wait(smx_activity_t execution)
171 {
172   return (e_smx_state_t) simcall_BODY_execution_wait(execution);
173 }
174
175 e_smx_state_t simcall_execution_test(smx_activity_t execution)
176 {
177   return (e_smx_state_t)simcall_BODY_execution_test(execution);
178 }
179
180 /**
181  * \ingroup simix_process_management
182  * \brief Kills all SIMIX processes.
183  */
184 void simcall_process_killall()
185 {
186   simcall_BODY_process_killall();
187 }
188
189 /**
190  * \ingroup simix_process_management
191  * \brief Cleans up a SIMIX process.
192  * \param process poor victim (must have already been killed)
193  */
194 void simcall_process_cleanup(smx_actor_t process)
195 {
196   simcall_BODY_process_cleanup(process);
197 }
198
199 void simcall_process_join(smx_actor_t process, double timeout)
200 {
201   simcall_BODY_process_join(process, timeout);
202 }
203
204 /**
205  * \ingroup simix_process_management
206  * \brief Suspends a process.
207  *
208  * This function suspends the process by suspending the synchro
209  * it was waiting for completion.
210  *
211  * \param process a SIMIX process
212  */
213 void simcall_process_suspend(smx_actor_t process)
214 {
215   simcall_BODY_process_suspend(process);
216 }
217
218 /**
219  * \ingroup simix_process_management
220  * \brief Returns the amount of SIMIX processes in the system
221  *
222  * Maestro internal process is not counted, only user code processes are
223  */
224 int simcall_process_count()
225 {
226   return simgrid::simix::kernelImmediate(SIMIX_process_count);
227 }
228
229 /**
230  * \ingroup simix_process_management
231  * \brief Set the user data of a #smx_actor_t.
232  *
233  * This functions sets the user data associated to \a process.
234  * \param process SIMIX process
235  * \param data User data
236  */
237 void simcall_process_set_data(smx_actor_t process, void *data)
238 {
239   simgrid::simix::kernelImmediate([process, data] { process->setUserData(data); });
240 }
241
242 /**
243  * \ingroup simix_process_management
244  * \brief Set the kill time of a process.
245  */
246 void simcall_process_set_kill_time(smx_actor_t process, double kill_time)
247 {
248
249   if (kill_time <= SIMIX_get_clock() || simix_global->kill_process_function == nullptr)
250     return;
251   XBT_DEBUG("Set kill time %f for process %s@%s", kill_time, process->get_cname(), process->host->get_cname());
252   process->kill_timer = SIMIX_timer_set(kill_time, [process] {
253     simix_global->kill_process_function(process);
254     process->kill_timer=nullptr;
255   });
256 }
257
258 /**
259  * \ingroup simix_process_management
260  * \brief Add an on_exit function
261  * Add an on_exit function which will be executed when the process exits/is killed.
262  */
263 XBT_PUBLIC void simcall_process_on_exit(smx_actor_t process, int_f_pvoid_pvoid_t fun, void* data)
264 {
265   simcall_BODY_process_on_exit(process, fun, data);
266 }
267
268 /**
269  * \ingroup simix_process_management
270  * \brief Creates a new sleep SIMIX synchro.
271  *
272  * This function creates a SURF action and allocates the data necessary
273  * to create the SIMIX synchro. It can raise a host_error exception if the
274  * host crashed. The default SIMIX name of the synchro is "sleep".
275  *
276  *   \param duration Time duration of the sleep.
277  *   \return A result telling whether the sleep was successful
278  */
279 e_smx_state_t simcall_process_sleep(double duration)
280 {
281   /* checking for infinite values */
282   xbt_assert(std::isfinite(duration), "duration is not finite!");
283   return (e_smx_state_t) simcall_BODY_process_sleep(duration);
284 }
285
286 /**
287  * \ingroup simix_comm_management
288  */
289 void simcall_comm_send(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
290                        size_t src_buff_size, int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
291                        void (*copy_data_fun)(smx_activity_t, void*, size_t), void* data, double timeout)
292 {
293   /* checking for infinite values */
294   xbt_assert(std::isfinite(task_size), "task_size is not finite!");
295   xbt_assert(std::isfinite(rate), "rate is not finite!");
296   xbt_assert(std::isfinite(timeout), "timeout is not finite!");
297
298   xbt_assert(mbox, "No rendez-vous point defined for send");
299
300   if (MC_is_active() || MC_record_replay_is_active()) {
301     /* the model-checker wants two separate simcalls */
302     smx_activity_t comm = nullptr; /* MC needs the comm to be set to nullptr during the simcall */
303     comm = simcall_comm_isend(sender, mbox, task_size, rate,
304         src_buff, src_buff_size, match_fun, nullptr, copy_data_fun, data, 0);
305     simcall_comm_wait(comm, timeout);
306     comm = nullptr;
307   }
308   else {
309     simcall_BODY_comm_send(sender, mbox, task_size, rate, src_buff, src_buff_size,
310                          match_fun, copy_data_fun, data, timeout);
311   }
312 }
313
314 /**
315  * \ingroup simix_comm_management
316  */
317 smx_activity_t simcall_comm_isend(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
318                                   size_t src_buff_size,
319                                   int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
320                                   void (*clean_fun)(void*), void (*copy_data_fun)(smx_activity_t, void*, size_t),
321                                   void* data, int detached)
322 {
323   /* checking for infinite values */
324   xbt_assert(std::isfinite(task_size), "task_size is not finite!");
325   xbt_assert(std::isfinite(rate), "rate is not finite!");
326
327   xbt_assert(mbox, "No rendez-vous point defined for isend");
328
329   return simcall_BODY_comm_isend(sender, mbox, task_size, rate, src_buff,
330                                  src_buff_size, match_fun,
331                                  clean_fun, copy_data_fun, data, detached);
332 }
333
334 /**
335  * \ingroup simix_comm_management
336  */
337 void simcall_comm_recv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
338                        int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
339                        void (*copy_data_fun)(smx_activity_t, void*, size_t), void* data, double timeout, double rate)
340 {
341   xbt_assert(std::isfinite(timeout), "timeout is not finite!");
342   xbt_assert(mbox, "No rendez-vous point defined for recv");
343
344   if (MC_is_active() || MC_record_replay_is_active()) {
345     /* the model-checker wants two separate simcalls */
346     smx_activity_t comm = nullptr; /* MC needs the comm to be set to nullptr during the simcall */
347     comm = simcall_comm_irecv(receiver, mbox, dst_buff, dst_buff_size,
348                               match_fun, copy_data_fun, data, rate);
349     simcall_comm_wait(comm, timeout);
350     comm = nullptr;
351   }
352   else {
353     simcall_BODY_comm_recv(receiver, mbox, dst_buff, dst_buff_size,
354                            match_fun, copy_data_fun, data, timeout, rate);
355   }
356 }
357 /**
358  * \ingroup simix_comm_management
359  */
360 smx_activity_t simcall_comm_irecv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
361                                   int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
362                                   void (*copy_data_fun)(smx_activity_t, void*, size_t), void* data, double rate)
363 {
364   xbt_assert(mbox, "No rendez-vous point defined for irecv");
365
366   return simcall_BODY_comm_irecv(receiver, mbox, dst_buff, dst_buff_size,
367                                  match_fun, copy_data_fun, data, rate);
368 }
369
370 /**
371  * \ingroup simix_comm_management
372  */
373 smx_activity_t simcall_comm_iprobe(smx_mailbox_t mbox, int type,
374                                    int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*), void* data)
375 {
376   xbt_assert(mbox, "No rendez-vous point defined for iprobe");
377
378   return simcall_BODY_comm_iprobe(mbox, type, match_fun, data);
379 }
380
381 /**
382  * \ingroup simix_comm_management
383  */
384 void simcall_comm_cancel(smx_activity_t synchro)
385 {
386   simgrid::simix::kernelImmediate([synchro] {
387     simgrid::kernel::activity::CommImplPtr comm =
388         boost::static_pointer_cast<simgrid::kernel::activity::CommImpl>(synchro);
389     comm->cancel();
390   });
391 }
392
393 /**
394  * \ingroup simix_comm_management
395  */
396 unsigned int simcall_comm_waitany(xbt_dynar_t comms, double timeout)
397 {
398   return simcall_BODY_comm_waitany(comms, timeout);
399 }
400
401 /**
402  * \ingroup simix_comm_management
403  */
404 int simcall_comm_testany(smx_activity_t* comms, size_t count)
405 {
406   if (count == 0)
407     return -1;
408   return simcall_BODY_comm_testany(comms, count);
409 }
410
411 /**
412  * \ingroup simix_comm_management
413  */
414 void simcall_comm_wait(smx_activity_t comm, double timeout)
415 {
416   xbt_assert(std::isfinite(timeout), "timeout is not finite!");
417   simcall_BODY_comm_wait(comm, timeout);
418 }
419
420 /**
421  * \brief Set the category of an synchro.
422  *
423  * This functions changes the category only. It calls a surf function.
424  * \param synchro The execution synchro
425  * \param category The tracing category
426  */
427 void simcall_set_category(smx_activity_t synchro, const char *category)
428 {
429   if (category == nullptr) {
430     return;
431   }
432   simcall_BODY_set_category(synchro, category);
433 }
434
435 /**
436  * \ingroup simix_comm_management
437  *
438  */
439 int simcall_comm_test(smx_activity_t comm)
440 {
441   return simcall_BODY_comm_test(comm);
442 }
443
444 /**
445  * \ingroup simix_synchro_management
446  *
447  */
448 smx_mutex_t simcall_mutex_init()
449 {
450   if (not simix_global) {
451     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
452     xbt_abort();
453   }
454   return simgrid::simix::kernelImmediate([] { return new simgrid::kernel::activity::MutexImpl(); });
455 }
456
457 /**
458  * \ingroup simix_synchro_management
459  *
460  */
461 void simcall_mutex_lock(smx_mutex_t mutex)
462 {
463   simcall_BODY_mutex_lock(mutex);
464 }
465
466 /**
467  * \ingroup simix_synchro_management
468  *
469  */
470 int simcall_mutex_trylock(smx_mutex_t mutex)
471 {
472   return simcall_BODY_mutex_trylock(mutex);
473 }
474
475 /**
476  * \ingroup simix_synchro_management
477  *
478  */
479 void simcall_mutex_unlock(smx_mutex_t mutex)
480 {
481   simcall_BODY_mutex_unlock(mutex);
482 }
483
484 /**
485  * \ingroup simix_synchro_management
486  *
487  */
488 smx_cond_t simcall_cond_init()
489 {
490   return simcall_BODY_cond_init();
491 }
492
493 /**
494  * \ingroup simix_synchro_management
495  *
496  */
497 void simcall_cond_wait(smx_cond_t cond, smx_mutex_t mutex)
498 {
499   simcall_BODY_cond_wait(cond, mutex);
500 }
501
502 /**
503  * \ingroup simix_synchro_management
504  *
505  */
506 void simcall_cond_wait_timeout(smx_cond_t cond, smx_mutex_t mutex, double timeout)
507 {
508   xbt_assert(std::isfinite(timeout), "timeout is not finite!");
509   simcall_BODY_cond_wait_timeout(cond, mutex, timeout);
510 }
511
512 /**
513  * \ingroup simix_synchro_management
514  *
515  */
516 void simcall_sem_acquire(smx_sem_t sem)
517 {
518   simcall_BODY_sem_acquire(sem);
519 }
520
521 /**
522  * \ingroup simix_synchro_management
523  *
524  */
525 void simcall_sem_acquire_timeout(smx_sem_t sem, double timeout)
526 {
527   xbt_assert(std::isfinite(timeout), "timeout is not finite!");
528   simcall_BODY_sem_acquire_timeout(sem, timeout);
529 }
530
531 sg_size_t simcall_storage_read(surf_storage_t st, sg_size_t size)
532 {
533   return simcall_BODY_storage_read(st, size);
534 }
535
536 sg_size_t simcall_storage_write(surf_storage_t st, sg_size_t size)
537 {
538   return simcall_BODY_storage_write(st, size);
539 }
540
541 void simcall_run_kernel(std::function<void()> const& code)
542 {
543   simcall_BODY_run_kernel(&code);
544 }
545
546 void simcall_run_blocking(std::function<void()> const& code)
547 {
548   simcall_BODY_run_blocking(&code);
549 }
550
551 int simcall_mc_random(int min, int max) {
552   return simcall_BODY_mc_random(min, max);
553 }
554
555 /* ************************************************************************** */
556
557 /** @brief returns a printable string representing a simcall */
558 const char *SIMIX_simcall_name(e_smx_simcall_t kind) {
559   return simcall_names[kind];
560 }
561
562 namespace simgrid {
563 namespace simix {
564
565 void unblock(smx_actor_t process)
566 {
567   xbt_assert(SIMIX_is_maestro());
568   SIMIX_simcall_answer(&process->simcall);
569 }
570
571 }
572 }