Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Use CommImpl* for comm_copy callbacks.
[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-2019. 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.h"
14 #include "simgrid/simix/blocking_simcall.hpp"
15 #include "src/kernel/activity/CommImpl.hpp"
16 #include "src/kernel/activity/ConditionVariableImpl.hpp"
17 #include "src/kernel/activity/ExecImpl.hpp"
18 #include "src/kernel/activity/IoImpl.hpp"
19 #include "src/kernel/activity/MailboxImpl.hpp"
20 #include "src/kernel/activity/MutexImpl.hpp"
21 #include "src/mc/mc_replay.hpp"
22 #include "src/plugins/vm/VirtualMachineImpl.hpp"
23 #include "src/simix/smx_host_private.hpp"
24
25 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(simix);
26
27 #include "popping_bodies.cpp"
28
29 /**
30  * @ingroup simix_process_management
31  * @brief Creates a synchro that may involve parallel computation on
32  * several hosts and communication between them.
33  *
34  * @param name Name of the execution synchro to create
35  * @param host_nb Number of hosts where the synchro will be executed
36  * @param host_list Array (of size host_nb) of hosts where the synchro will be executed
37  * @param flops_amount Array (of size host_nb) of computation amount of hosts (in bytes)
38  * @param bytes_amount Array (of size host_nb * host_nb) representing the communication
39  * amount between each pair of hosts
40  * @param rate the SURF action rate
41  * @param timeout timeout
42  * @return A new SIMIX execution synchronization
43  */
44 smx_activity_t simcall_execution_parallel_start(const std::string& name, int host_nb, const sg_host_t* host_list,
45                                                 const double* flops_amount, const double* bytes_amount, double rate,
46                                                 double timeout)
47 {
48   /* checking for infinite values */
49   for (int i = 0 ; i < host_nb ; ++i) {
50     if (flops_amount != nullptr)
51       xbt_assert(std::isfinite(flops_amount[i]), "flops_amount[%d] is not finite!", i);
52     if (bytes_amount != nullptr) {
53       for (int j = 0 ; j < host_nb ; ++j) {
54         xbt_assert(std::isfinite(bytes_amount[i + host_nb * j]),
55                    "bytes_amount[%d+%d*%d] is not finite!", i, host_nb, j);
56       }
57     }
58   }
59
60   xbt_assert(std::isfinite(rate), "rate is not finite!");
61
62   return simgrid::simix::simcall([name, host_nb, host_list, flops_amount, bytes_amount, rate, timeout] {
63     return SIMIX_execution_parallel_start(std::move(name), host_nb, host_list, flops_amount, bytes_amount, rate,
64                                           timeout);
65   });
66 }
67
68 /**
69  * @ingroup simix_host_management
70  * @brief Waits for the completion of an execution synchro and destroy it.
71  *
72  * @param execution The execution synchro
73  */
74 e_smx_state_t simcall_execution_wait(smx_activity_t execution)
75 {
76   return (e_smx_state_t) simcall_BODY_execution_wait(execution);
77 }
78
79 e_smx_state_t simcall_execution_test(smx_activity_t execution)
80 {
81   return (e_smx_state_t)simcall_BODY_execution_test(execution);
82 }
83
84 void simcall_process_join(smx_actor_t process, double timeout)
85 {
86   simcall_BODY_process_join(process, timeout);
87 }
88
89 /**
90  * @ingroup simix_process_management
91  * @brief Suspends an actor
92  */
93 void simcall_process_suspend(smx_actor_t process)
94 {
95   simcall_BODY_process_suspend(process);
96 }
97
98 /**
99  * @ingroup simix_process_management
100  * @brief Creates a new sleep SIMIX synchro.
101  *
102  * This function creates a SURF action and allocates the data necessary
103  * to create the SIMIX synchro. It can raise a HostFailureException if the
104  * host crashed. The default SIMIX name of the synchro is "sleep".
105  *
106  *   @param duration Time duration of the sleep.
107  *   @return A result telling whether the sleep was successful
108  */
109 e_smx_state_t simcall_process_sleep(double duration)
110 {
111   /* checking for infinite values */
112   xbt_assert(std::isfinite(duration), "duration is not finite!");
113   return (e_smx_state_t) simcall_BODY_process_sleep(duration);
114 }
115
116 /**
117  * @ingroup simix_comm_management
118  */
119 void simcall_comm_send(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
120                        size_t src_buff_size, int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
121                        void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t), void* data,
122                        double timeout)
123 {
124   /* checking for infinite values */
125   xbt_assert(std::isfinite(task_size), "task_size is not finite!");
126   xbt_assert(std::isfinite(rate), "rate is not finite!");
127   xbt_assert(std::isfinite(timeout), "timeout is not finite!");
128
129   xbt_assert(mbox, "No rendez-vous point defined for send");
130
131   if (MC_is_active() || MC_record_replay_is_active()) {
132     /* the model-checker wants two separate simcalls */
133     smx_activity_t comm = nullptr; /* MC needs the comm to be set to nullptr during the simcall */
134     comm = simcall_comm_isend(sender, mbox, task_size, rate,
135         src_buff, src_buff_size, match_fun, nullptr, copy_data_fun, data, 0);
136     simcall_comm_wait(comm, timeout);
137     comm = nullptr;
138   }
139   else {
140     simcall_BODY_comm_send(sender, mbox, task_size, rate, src_buff, src_buff_size,
141                          match_fun, copy_data_fun, data, timeout);
142   }
143 }
144
145 /**
146  * @ingroup simix_comm_management
147  */
148 smx_activity_t simcall_comm_isend(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
149                                   size_t src_buff_size,
150                                   int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
151                                   void (*clean_fun)(void*),
152                                   void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t),
153                                   void* data, int detached)
154 {
155   /* checking for infinite values */
156   xbt_assert(std::isfinite(task_size), "task_size is not finite!");
157   xbt_assert(std::isfinite(rate), "rate is not finite!");
158
159   xbt_assert(mbox, "No rendez-vous point defined for isend");
160
161   return simcall_BODY_comm_isend(sender, mbox, task_size, rate, src_buff,
162                                  src_buff_size, match_fun,
163                                  clean_fun, copy_data_fun, data, detached);
164 }
165
166 /**
167  * @ingroup simix_comm_management
168  */
169 void simcall_comm_recv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
170                        int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
171                        void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t), void* data,
172                        double timeout, double rate)
173 {
174   xbt_assert(std::isfinite(timeout), "timeout is not finite!");
175   xbt_assert(mbox, "No rendez-vous point defined for recv");
176
177   if (MC_is_active() || MC_record_replay_is_active()) {
178     /* the model-checker wants two separate simcalls */
179     smx_activity_t comm = nullptr; /* MC needs the comm to be set to nullptr during the simcall */
180     comm = simcall_comm_irecv(receiver, mbox, dst_buff, dst_buff_size,
181                               match_fun, copy_data_fun, data, rate);
182     simcall_comm_wait(comm, timeout);
183     comm = nullptr;
184   }
185   else {
186     simcall_BODY_comm_recv(receiver, mbox, dst_buff, dst_buff_size,
187                            match_fun, copy_data_fun, data, timeout, rate);
188   }
189 }
190 /**
191  * @ingroup simix_comm_management
192  */
193 smx_activity_t simcall_comm_irecv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
194                                   int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
195                                   void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t),
196                                   void* data, double rate)
197 {
198   xbt_assert(mbox, "No rendez-vous point defined for irecv");
199
200   return simcall_BODY_comm_irecv(receiver, mbox, dst_buff, dst_buff_size,
201                                  match_fun, copy_data_fun, data, rate);
202 }
203
204 /**
205  * @ingroup simix_comm_management
206  */
207 smx_activity_t simcall_comm_iprobe(smx_mailbox_t mbox, int type,
208                                    int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*), void* data)
209 {
210   xbt_assert(mbox, "No rendez-vous point defined for iprobe");
211
212   return simgrid::simix::simcall([mbox, type, match_fun, data] { return mbox->iprobe(type, match_fun, data); });
213 }
214
215 /**
216  * @ingroup simix_comm_management
217  */
218 unsigned int simcall_comm_waitany(xbt_dynar_t comms, double timeout)
219 {
220   return simcall_BODY_comm_waitany(comms, timeout);
221 }
222
223 /**
224  * @ingroup simix_comm_management
225  */
226 int simcall_comm_testany(smx_activity_t* comms, size_t count)
227 {
228   if (count == 0)
229     return -1;
230   return simcall_BODY_comm_testany(comms, count);
231 }
232
233 /**
234  * @ingroup simix_comm_management
235  */
236 void simcall_comm_wait(smx_activity_t comm, double timeout)
237 {
238   xbt_assert(std::isfinite(timeout), "timeout is not finite!");
239   simcall_BODY_comm_wait(comm, timeout);
240 }
241
242 /**
243  * @ingroup simix_comm_management
244  *
245  */
246 int simcall_comm_test(smx_activity_t comm)
247 {
248   return simcall_BODY_comm_test(comm);
249 }
250
251 /**
252  * @ingroup simix_synchro_management
253  *
254  */
255 smx_mutex_t simcall_mutex_init()
256 {
257   if (simix_global == nullptr) {
258     fprintf(stderr, "You must initialize the SimGrid engine before using it\n"); // We can't use xbt_die since we may
259                                                                                  // get there before the initialization
260     xbt_abort();
261   }
262   return simgrid::simix::simcall([] { return new simgrid::kernel::activity::MutexImpl(); });
263 }
264
265 /**
266  * @ingroup simix_synchro_management
267  *
268  */
269 void simcall_mutex_lock(smx_mutex_t mutex)
270 {
271   simcall_BODY_mutex_lock(mutex);
272 }
273
274 /**
275  * @ingroup simix_synchro_management
276  *
277  */
278 int simcall_mutex_trylock(smx_mutex_t mutex)
279 {
280   return simcall_BODY_mutex_trylock(mutex);
281 }
282
283 /**
284  * @ingroup simix_synchro_management
285  *
286  */
287 void simcall_mutex_unlock(smx_mutex_t mutex)
288 {
289   simcall_BODY_mutex_unlock(mutex);
290 }
291
292 /**
293  * @ingroup simix_synchro_management
294  *
295  */
296 smx_cond_t simcall_cond_init()
297 {
298   return simgrid::simix::simcall([] { return new simgrid::kernel::activity::ConditionVariableImpl(); });
299 }
300
301 /**
302  * @ingroup simix_synchro_management
303  *
304  */
305 void simcall_cond_wait(smx_cond_t cond, smx_mutex_t mutex)
306 {
307   simcall_BODY_cond_wait(cond, mutex);
308 }
309
310 /**
311  * @ingroup simix_synchro_management
312  *
313  */
314 int simcall_cond_wait_timeout(smx_cond_t cond, smx_mutex_t mutex, double timeout)
315 {
316   xbt_assert(std::isfinite(timeout), "timeout is not finite!");
317   return simcall_BODY_cond_wait_timeout(cond, mutex, timeout);
318 }
319
320 /**
321  * @ingroup simix_synchro_management
322  *
323  */
324 void simcall_sem_acquire(smx_sem_t sem)
325 {
326   simcall_BODY_sem_acquire(sem);
327 }
328
329 /**
330  * @ingroup simix_synchro_management
331  *
332  */
333 int simcall_sem_acquire_timeout(smx_sem_t sem, double timeout)
334 {
335   xbt_assert(std::isfinite(timeout), "timeout is not finite!");
336   return simcall_BODY_sem_acquire_timeout(sem, timeout);
337 }
338
339 e_smx_state_t simcall_io_wait(smx_activity_t io)
340 {
341   return (e_smx_state_t)simcall_BODY_io_wait(io);
342 }
343
344 void simcall_run_kernel(std::function<void()> const& code)
345 {
346   simcall_BODY_run_kernel(&code);
347 }
348
349 void simcall_run_blocking(std::function<void()> const& code)
350 {
351   simcall_BODY_run_blocking(&code);
352 }
353
354 int simcall_mc_random(int min, int max) {
355   return simcall_BODY_mc_random(min, max);
356 }
357
358 /* ************************************************************************** */
359
360 /** @brief returns a printable string representing a simcall */
361 const char *SIMIX_simcall_name(e_smx_simcall_t kind) {
362   return simcall_names[kind];
363 }
364
365 namespace simgrid {
366 namespace simix {
367
368 void unblock(smx_actor_t process)
369 {
370   xbt_assert(SIMIX_is_maestro());
371   SIMIX_simcall_answer(&process->simcall);
372 }
373 } // namespace simix
374 } // namespace simgrid
375
376 /* ****************************DEPRECATED CALLS******************************* */
377 void simcall_process_set_kill_time(smx_actor_t process, double kill_time)
378 {
379   simgrid::simix::simcall([process, kill_time] { process->set_kill_time(kill_time); });
380 }
381 void simcall_comm_cancel(smx_activity_t comm)
382 {
383   simgrid::simix::simcall([comm] { boost::static_pointer_cast<simgrid::kernel::activity::CommImpl>(comm)->cancel(); });
384 }
385 void simcall_execution_cancel(smx_activity_t exec)
386 {
387   simgrid::simix::simcall([exec] { boost::static_pointer_cast<simgrid::kernel::activity::ExecImpl>(exec)->cancel(); });
388 }
389 void simcall_execution_set_priority(smx_activity_t exec, double priority)
390 {
391   simgrid::simix::simcall([exec, priority] {
392     boost::static_pointer_cast<simgrid::kernel::activity::ExecImpl>(exec)->set_priority(priority);
393   });
394 }
395
396 void simcall_execution_set_bound(smx_activity_t exec, double bound)
397 {
398   simgrid::simix::simcall(
399       [exec, bound] { boost::static_pointer_cast<simgrid::kernel::activity::ExecImpl>(exec)->set_bound(bound); });
400 }
401
402 smx_activity_t simcall_execution_start(const std::string& name, const std::string& category, double flops_amount,
403                                        double priority, double bound, sg_host_t host)
404 {
405   return simgrid::simix::simcall([name, category, flops_amount, priority, bound, host] {
406     return simgrid::kernel::activity::ExecImplPtr(
407                new simgrid::kernel::activity::ExecImpl(std::move(name), std::move(category), nullptr, host))
408         ->start(flops_amount, priority, bound);
409   });
410 }
411
412 // deprecated
413 void SIMIX_comm_finish(smx_activity_t synchro)
414 {
415   boost::static_pointer_cast<simgrid::kernel::activity::CommImpl>(synchro)->finish();
416 }