Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
424d8510f2efc903e8c08298c7420e61727b5c23
[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 Returns the amount of SIMIX processes in the system
214  *
215  * Maestro internal process is not counted, only user code processes are
216  */
217 int simcall_process_count()
218 {
219   return simgrid::simix::kernelImmediate(SIMIX_process_count);
220 }
221
222 /**
223  * \ingroup simix_process_management
224  * \brief Set the user data of a #smx_actor_t.
225  *
226  * This functions sets the user data associated to \a process.
227  * \param process SIMIX process
228  * \param data User data
229  */
230 void simcall_process_set_data(smx_actor_t process, void *data)
231 {
232   simgrid::simix::kernelImmediate([process, data] { process->setUserData(data); });
233 }
234
235 /**
236  * \ingroup simix_process_management
237  * \brief Set the kill time of a process.
238  */
239 void simcall_process_set_kill_time(smx_actor_t process, double kill_time)
240 {
241
242   if (kill_time <= SIMIX_get_clock() || simix_global->kill_process_function == nullptr)
243     return;
244   XBT_DEBUG("Set kill time %f for process %s@%s", kill_time, process->cname(), process->host->getCname());
245   process->kill_timer = SIMIX_timer_set(kill_time, [=] {
246     simix_global->kill_process_function(process);
247     process->kill_timer=nullptr;
248   });
249 }
250
251 /**
252  * \ingroup simix_process_management
253  * \brief Return the properties
254  *
255  * This function returns the properties associated with this process
256  */
257 xbt_dict_t simcall_process_get_properties(smx_actor_t process)
258 {
259   return process->properties;
260 }
261 /**
262  * \ingroup simix_process_management
263  * \brief Add an on_exit function
264  * Add an on_exit function which will be executed when the process exits/is killed.
265  */
266 XBT_PUBLIC(void) simcall_process_on_exit(smx_actor_t process, int_f_pvoid_pvoid_t fun, void *data)
267 {
268   simcall_BODY_process_on_exit(process, fun, data);
269 }
270
271 /**
272  * \ingroup simix_process_management
273  * \brief Creates a new sleep SIMIX synchro.
274  *
275  * This function creates a SURF action and allocates the data necessary
276  * to create the SIMIX synchro. It can raise a host_error exception if the
277  * host crashed. The default SIMIX name of the synchro is "sleep".
278  *
279  *   \param duration Time duration of the sleep.
280  *   \return A result telling whether the sleep was successful
281  */
282 e_smx_state_t simcall_process_sleep(double duration)
283 {
284   /* checking for infinite values */
285   xbt_assert(std::isfinite(duration), "duration is not finite!");
286   return (e_smx_state_t) simcall_BODY_process_sleep(duration);
287 }
288
289 /**
290  * \ingroup simix_comm_management
291  */
292 void simcall_comm_send(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
293                        size_t src_buff_size, int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
294                        void (*copy_data_fun)(smx_activity_t, void*, size_t), void* data, double timeout)
295 {
296   /* checking for infinite values */
297   xbt_assert(std::isfinite(task_size), "task_size is not finite!");
298   xbt_assert(std::isfinite(rate), "rate is not finite!");
299   xbt_assert(std::isfinite(timeout), "timeout is not finite!");
300
301   xbt_assert(mbox, "No rendez-vous point defined for send");
302
303   if (MC_is_active() || MC_record_replay_is_active()) {
304     /* the model-checker wants two separate simcalls */
305     smx_activity_t comm = nullptr; /* MC needs the comm to be set to nullptr during the simcall */
306     comm = simcall_comm_isend(sender, mbox, task_size, rate,
307         src_buff, src_buff_size, match_fun, nullptr, copy_data_fun, data, 0);
308     simcall_comm_wait(comm, timeout);
309     comm = nullptr;
310   }
311   else {
312     simcall_BODY_comm_send(sender, mbox, task_size, rate, src_buff, src_buff_size,
313                          match_fun, copy_data_fun, data, timeout);
314   }
315 }
316
317 /**
318  * \ingroup simix_comm_management
319  */
320 smx_activity_t simcall_comm_isend(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
321                                   size_t src_buff_size,
322                                   int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
323                                   void (*clean_fun)(void*), void (*copy_data_fun)(smx_activity_t, void*, size_t),
324                                   void* data, int detached)
325 {
326   /* checking for infinite values */
327   xbt_assert(std::isfinite(task_size), "task_size is not finite!");
328   xbt_assert(std::isfinite(rate), "rate is not finite!");
329
330   xbt_assert(mbox, "No rendez-vous point defined for isend");
331
332   return simcall_BODY_comm_isend(sender, mbox, task_size, rate, src_buff,
333                                  src_buff_size, match_fun,
334                                  clean_fun, copy_data_fun, data, detached);
335 }
336
337 /**
338  * \ingroup simix_comm_management
339  */
340 void simcall_comm_recv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
341                        int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
342                        void (*copy_data_fun)(smx_activity_t, void*, size_t), void* data, double timeout, double rate)
343 {
344   xbt_assert(std::isfinite(timeout), "timeout is not finite!");
345   xbt_assert(mbox, "No rendez-vous point defined for recv");
346
347   if (MC_is_active() || MC_record_replay_is_active()) {
348     /* the model-checker wants two separate simcalls */
349     smx_activity_t comm = nullptr; /* MC needs the comm to be set to nullptr during the simcall */
350     comm = simcall_comm_irecv(receiver, mbox, dst_buff, dst_buff_size,
351                               match_fun, copy_data_fun, data, rate);
352     simcall_comm_wait(comm, timeout);
353     comm = nullptr;
354   }
355   else {
356     simcall_BODY_comm_recv(receiver, mbox, dst_buff, dst_buff_size,
357                            match_fun, copy_data_fun, data, timeout, rate);
358   }
359 }
360 /**
361  * \ingroup simix_comm_management
362  */
363 smx_activity_t simcall_comm_irecv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
364                                   int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
365                                   void (*copy_data_fun)(smx_activity_t, void*, size_t), void* data, double rate)
366 {
367   xbt_assert(mbox, "No rendez-vous point defined for irecv");
368
369   return simcall_BODY_comm_irecv(receiver, mbox, dst_buff, dst_buff_size,
370                                  match_fun, copy_data_fun, data, rate);
371 }
372
373 /**
374  * \ingroup simix_comm_management
375  */
376 smx_activity_t simcall_comm_iprobe(smx_mailbox_t mbox, int type,
377                                    int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*), void* data)
378 {
379   xbt_assert(mbox, "No rendez-vous point defined for iprobe");
380
381   return simcall_BODY_comm_iprobe(mbox, type, match_fun, data);
382 }
383
384 /**
385  * \ingroup simix_comm_management
386  */
387 void simcall_comm_cancel(smx_activity_t synchro)
388 {
389   simgrid::simix::kernelImmediate([synchro] {
390     simgrid::kernel::activity::CommImplPtr comm =
391         boost::static_pointer_cast<simgrid::kernel::activity::CommImpl>(synchro);
392     comm->cancel();
393   });
394 }
395
396 /**
397  * \ingroup simix_comm_management
398  */
399 unsigned int simcall_comm_waitany(xbt_dynar_t comms, double timeout)
400 {
401   return simcall_BODY_comm_waitany(comms, timeout);
402 }
403
404 /**
405  * \ingroup simix_comm_management
406  */
407 int simcall_comm_testany(smx_activity_t* comms, size_t count)
408 {
409   if (count == 0)
410     return -1;
411   return simcall_BODY_comm_testany(comms, count);
412 }
413
414 /**
415  * \ingroup simix_comm_management
416  */
417 void simcall_comm_wait(smx_activity_t comm, double timeout)
418 {
419   xbt_assert(std::isfinite(timeout), "timeout is not finite!");
420   simcall_BODY_comm_wait(comm, timeout);
421 }
422
423 /**
424  * \brief Set the category of an synchro.
425  *
426  * This functions changes the category only. It calls a surf function.
427  * \param synchro The execution synchro
428  * \param category The tracing category
429  */
430 void simcall_set_category(smx_activity_t synchro, const char *category)
431 {
432   if (category == nullptr) {
433     return;
434   }
435   simcall_BODY_set_category(synchro, category);
436 }
437
438 /**
439  * \ingroup simix_comm_management
440  *
441  */
442 int simcall_comm_test(smx_activity_t comm)
443 {
444   return simcall_BODY_comm_test(comm);
445 }
446
447 /**
448  * \ingroup simix_synchro_management
449  *
450  */
451 smx_mutex_t simcall_mutex_init()
452 {
453   if (not simix_global) {
454     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
455     xbt_abort();
456   }
457   return simgrid::simix::kernelImmediate([] { return new simgrid::simix::MutexImpl(); });
458 }
459
460 /**
461  * \ingroup simix_synchro_management
462  *
463  */
464 void simcall_mutex_lock(smx_mutex_t mutex)
465 {
466   simcall_BODY_mutex_lock(mutex);
467 }
468
469 /**
470  * \ingroup simix_synchro_management
471  *
472  */
473 int simcall_mutex_trylock(smx_mutex_t mutex)
474 {
475   return simcall_BODY_mutex_trylock(mutex);
476 }
477
478 /**
479  * \ingroup simix_synchro_management
480  *
481  */
482 void simcall_mutex_unlock(smx_mutex_t mutex)
483 {
484   simcall_BODY_mutex_unlock(mutex);
485 }
486
487 /**
488  * \ingroup simix_synchro_management
489  *
490  */
491 smx_cond_t simcall_cond_init()
492 {
493   return simcall_BODY_cond_init();
494 }
495
496 /**
497  * \ingroup simix_synchro_management
498  *
499  */
500 void simcall_cond_signal(smx_cond_t cond)
501 {
502   simcall_BODY_cond_signal(cond);
503 }
504
505 /**
506  * \ingroup simix_synchro_management
507  *
508  */
509 void simcall_cond_wait(smx_cond_t cond, smx_mutex_t mutex)
510 {
511   simcall_BODY_cond_wait(cond, mutex);
512 }
513
514 /**
515  * \ingroup simix_synchro_management
516  *
517  */
518 void simcall_cond_wait_timeout(smx_cond_t cond,
519                                  smx_mutex_t mutex,
520                                  double timeout)
521 {
522   xbt_assert(std::isfinite(timeout), "timeout is not finite!");
523   simcall_BODY_cond_wait_timeout(cond, mutex, timeout);
524 }
525
526 /**
527  * \ingroup simix_synchro_management
528  *
529  */
530 void simcall_cond_broadcast(smx_cond_t cond)
531 {
532   simcall_BODY_cond_broadcast(cond);
533 }
534
535 /**
536  * \ingroup simix_synchro_management
537  *
538  */
539 void simcall_sem_acquire(smx_sem_t sem)
540 {
541   simcall_BODY_sem_acquire(sem);
542 }
543
544 /**
545  * \ingroup simix_synchro_management
546  *
547  */
548 void simcall_sem_acquire_timeout(smx_sem_t sem, double timeout)
549 {
550   xbt_assert(std::isfinite(timeout), "timeout is not finite!");
551   simcall_BODY_sem_acquire_timeout(sem, timeout);
552 }
553
554 /**
555  * \ingroup simix_file_management
556  *
557  */
558 sg_size_t simcall_file_read(surf_file_t fd, sg_size_t size)
559 {
560   return simcall_BODY_file_read(fd, size);
561 }
562
563 /**
564  * \ingroup simix_file_management
565  *
566  */
567 sg_size_t simcall_file_write(surf_file_t fd, sg_size_t size)
568 {
569   return simcall_BODY_file_write(fd, size);
570 }
571
572 void simcall_run_kernel(std::function<void()> const& code)
573 {
574   simcall_BODY_run_kernel(&code);
575 }
576
577 void simcall_run_blocking(std::function<void()> const& code)
578 {
579   simcall_BODY_run_blocking(&code);
580 }
581
582 int simcall_mc_random(int min, int max) {
583   return simcall_BODY_mc_random(min, max);
584 }
585
586 /* ************************************************************************** */
587
588 /** @brief returns a printable string representing a simcall */
589 const char *SIMIX_simcall_name(e_smx_simcall_t kind) {
590   return simcall_names[kind];
591 }
592
593 namespace simgrid {
594 namespace simix {
595
596 void unblock(smx_actor_t process)
597 {
598   xbt_assert(SIMIX_is_maestro());
599   SIMIX_simcall_answer(&process->simcall);
600 }
601
602 }
603 }