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