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-2020. 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
  24 #include "popping_bodies.cpp"
  25
  26 /**
  27  * @ingroup simix_host_management
  28  * @brief Waits for the completion of an execution synchro and destroy it.
  29  *
  30  * @param execution The execution synchro
  31  */
  32 e_smx_state_t simcall_execution_wait(simgrid::kernel::activity::ActivityImpl* execution, double timeout)
  33 {
  34   return (e_smx_state_t)simcall_BODY_execution_wait(static_cast<simgrid::kernel::activity::ExecImpl*>(execution),
  35                                                     timeout);
  36 }
  37
  38 bool simcall_execution_test(simgrid::kernel::activity::ActivityImpl* execution) // XBT_ATTRIB_DEPRECATED_v330
  39 {
  40   return simgrid::kernel::actor::simcall([execution] { return execution->test(); });
  41 }
  42
  43 bool simcall_execution_test(const simgrid::kernel::activity::ActivityImplPtr& execution) // XBT_ATTRIB_DEPRECATED_v330
  44 {
  45   return simgrid::kernel::actor::simcall([execution] { return execution->test(); });
  46 }
  47
  48 unsigned int simcall_execution_waitany_for(simgrid::kernel::activity::ExecImpl* execs[], size_t count, double timeout)
  49 {
  50   return simcall_BODY_execution_waitany_for(execs, count, timeout);
  51 }
  52
  53 void simcall_process_join(smx_actor_t process, double timeout) // XBT_DEPRECATED_v328
  54 {
  55   simgrid::kernel::actor::ActorImpl::self()->join(process, timeout);
  56 }
  57
  58 void simcall_process_suspend(smx_actor_t process) // XBT_DEPRECATED_v328
  59 {
  60   process->iface()->suspend();
  61 }
  62
  63 e_smx_state_t simcall_process_sleep(double duration) // XBT_DEPRECATED_v329
  64 {
  65   simgrid::kernel::actor::ActorImpl::self()->sleep(duration);
  66   return simgrid::kernel::activity::State::DONE;
  67 }
  68
  69 /**
  70  * @ingroup simix_comm_management
  71  */
  72 void simcall_comm_send(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
  73                        size_t src_buff_size, bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
  74                        void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t), void* data,
  75                        double timeout)
  76 {
  77   /* checking for infinite values */
  78   xbt_assert(std::isfinite(task_size), "task_size is not finite!");
  79   xbt_assert(std::isfinite(rate), "rate is not finite!");
  80   xbt_assert(std::isfinite(timeout), "timeout is not finite!");
  81
  82   xbt_assert(mbox, "No rendez-vous point defined for send");
  83
  84   if (MC_is_active() || MC_record_replay_is_active()) {
  85     /* the model-checker wants two separate simcalls */
  86     simgrid::kernel::activity::ActivityImplPtr comm =
  87         nullptr; /* MC needs the comm to be set to nullptr during the simcall */
  88     comm = simcall_comm_isend(sender, mbox, task_size, rate,
  89         src_buff, src_buff_size, match_fun, nullptr, copy_data_fun, data, 0);
  90     simcall_comm_wait(comm.get(), timeout);
  91     comm = nullptr;
  92   }
  93   else {
  94     simcall_BODY_comm_send(sender, mbox, task_size, rate, static_cast<unsigned char*>(src_buff), src_buff_size,
  95                            match_fun, copy_data_fun, data, timeout);
  96   }
  97 }
  98
  99 /**
 100  * @ingroup simix_comm_management
 101  */
 102 simgrid::kernel::activity::ActivityImplPtr
 103 simcall_comm_isend(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
 104                    size_t src_buff_size, bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
 105                    void (*clean_fun)(void*), void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t),
 106                    void* data, bool detached)
 107 {
 108   /* checking for infinite values */
 109   xbt_assert(std::isfinite(task_size), "task_size is not finite!");
 110   xbt_assert(std::isfinite(rate), "rate is not finite!");
 111
 112   xbt_assert(mbox, "No rendez-vous point defined for isend");
 113
 114   return simcall_BODY_comm_isend(sender, mbox, task_size, rate, static_cast<unsigned char*>(src_buff), src_buff_size,
 115                                  match_fun, clean_fun, copy_data_fun, data, detached);
 116 }
 117
 118 /**
 119  * @ingroup simix_comm_management
 120  */
 121 void simcall_comm_recv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
 122                        bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
 123                        void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t), void* data,
 124                        double timeout, double rate)
 125 {
 126   xbt_assert(std::isfinite(timeout), "timeout is not finite!");
 127   xbt_assert(mbox, "No rendez-vous point defined for recv");
 128
 129   if (MC_is_active() || MC_record_replay_is_active()) {
 130     /* the model-checker wants two separate simcalls */
 131     simgrid::kernel::activity::ActivityImplPtr comm =
 132         nullptr; /* MC needs the comm to be set to nullptr during the simcall */
 133     comm = simcall_comm_irecv(receiver, mbox, dst_buff, dst_buff_size,
 134                               match_fun, copy_data_fun, data, rate);
 135     simcall_comm_wait(comm.get(), timeout);
 136     comm = nullptr;
 137   }
 138   else {
 139     simcall_BODY_comm_recv(receiver, mbox, static_cast<unsigned char*>(dst_buff), dst_buff_size, match_fun,
 140                            copy_data_fun, data, timeout, rate);
 141   }
 142 }
 143 /**
 144  * @ingroup simix_comm_management
 145  */
 146 simgrid::kernel::activity::ActivityImplPtr
 147 simcall_comm_irecv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
 148                    bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
 149                    void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t), void* data, double rate)
 150 {
 151   xbt_assert(mbox, "No rendez-vous point defined for irecv");
 152
 153   return simcall_BODY_comm_irecv(receiver, mbox, static_cast<unsigned char*>(dst_buff), dst_buff_size, match_fun,
 154                                  copy_data_fun, data, rate);
 155 }
 156
 157 /**
 158  * @ingroup simix_comm_management
 159  */
 160 simgrid::kernel::activity::ActivityImplPtr
 161 simcall_comm_iprobe(smx_mailbox_t mbox, int type, bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
 162                     void* data) // XBT_ATTRIB_DEPRECATED_v330
 163 {
 164   xbt_assert(mbox, "No rendez-vous point defined for iprobe");
 165
 166   return simgrid::kernel::actor::simcall([mbox, type, match_fun, data] { return mbox->iprobe(type, match_fun, data); });
 167 }
 168
 169 /**
 170  * @ingroup simix_comm_management
 171  */
 172 unsigned int simcall_comm_waitany(simgrid::kernel::activity::ActivityImplPtr comms[], size_t count,
 173                                   double timeout) // XBT_ATTRIB_DEPRECATED_v330
 174 {
 175   std::unique_ptr<simgrid::kernel::activity::CommImpl* []> rcomms(new simgrid::kernel::activity::CommImpl*[count]);
 176   std::transform(comms, comms + count, rcomms.get(), [](const simgrid::kernel::activity::ActivityImplPtr& comm) {
 177     return static_cast<simgrid::kernel::activity::CommImpl*>(comm.get());
 178   });
 179   return simcall_BODY_comm_waitany(rcomms.get(), count, timeout);
 180 }
 181
 182 unsigned int simcall_comm_waitany(simgrid::kernel::activity::CommImpl* comms[], size_t count, double timeout)
 183 {
 184   return simcall_BODY_comm_waitany(comms, count, timeout);
 185 }
 186
 187 /**
 188  * @ingroup simix_comm_management
 189  */
 190 int simcall_comm_testany(simgrid::kernel::activity::ActivityImplPtr comms[], size_t count) // XBT_ATTRIB_DEPRECATED_v330
 191 {
 192   if (count == 0)
 193     return -1;
 194   std::unique_ptr<simgrid::kernel::activity::CommImpl* []> rcomms(new simgrid::kernel::activity::CommImpl*[count]);
 195   std::transform(comms, comms + count, rcomms.get(), [](const simgrid::kernel::activity::ActivityImplPtr& comm) {
 196     return static_cast<simgrid::kernel::activity::CommImpl*>(comm.get());
 197   });
 198   return simcall_BODY_comm_testany(rcomms.get(), count);
 199 }
 200
 201 int simcall_comm_testany(simgrid::kernel::activity::CommImpl* comms[], size_t count)
 202 {
 203   if (count == 0)
 204     return -1;
 205   return simcall_BODY_comm_testany(comms, count);
 206 }
 207
 208 /**
 209  * @ingroup simix_comm_management
 210  */
 211 void simcall_comm_wait(simgrid::kernel::activity::ActivityImpl* comm, double timeout)
 212 {
 213   xbt_assert(std::isfinite(timeout), "timeout is not finite!");
 214   simcall_BODY_comm_wait(static_cast<simgrid::kernel::activity::CommImpl*>(comm), timeout);
 215 }
 216
 217 /**
 218  * @ingroup simix_comm_management
 219  *
 220  */
 221 bool simcall_comm_test(simgrid::kernel::activity::ActivityImpl* comm)
 222 {
 223   return simcall_BODY_comm_test(static_cast<simgrid::kernel::activity::CommImpl*>(comm));
 224 }
 225
 226 /**
 227  * @ingroup simix_synchro_management
 228  *
 229  */
 230 smx_mutex_t simcall_mutex_init() // XBT_ATTRIB_DEPRECATED_v330
 231 {
 232   if (simix_global == nullptr) {
 233     fprintf(stderr, "You must initialize the SimGrid engine before using it\n"); // We can't use xbt_die since we may
 234                                                                                  // get there before the initialization
 235     xbt_abort();
 236   }
 237   return simgrid::kernel::actor::simcall([] { return new simgrid::kernel::activity::MutexImpl(); });
 238 }
 239
 240 /**
 241  * @ingroup simix_synchro_management
 242  *
 243  */
 244 void simcall_mutex_lock(smx_mutex_t mutex)
 245 {
 246   simcall_BODY_mutex_lock(mutex);
 247 }
 248
 249 /**
 250  * @ingroup simix_synchro_management
 251  *
 252  */
 253 int simcall_mutex_trylock(smx_mutex_t mutex)
 254 {
 255   return simcall_BODY_mutex_trylock(mutex);
 256 }
 257
 258 /**
 259  * @ingroup simix_synchro_management
 260  *
 261  */
 262 void simcall_mutex_unlock(smx_mutex_t mutex)
 263 {
 264   simcall_BODY_mutex_unlock(mutex);
 265 }
 266
 267 /**
 268  * @ingroup simix_synchro_management
 269  *
 270  */
 271 smx_cond_t simcall_cond_init() // XBT_ATTRIB_DEPRECATED_v330
 272 {
 273   return simgrid::kernel::actor::simcall([] { return new simgrid::kernel::activity::ConditionVariableImpl(); });
 274 }
 275
 276 /**
 277  * @ingroup simix_synchro_management
 278  *
 279  */
 280 void simcall_cond_wait(smx_cond_t cond, smx_mutex_t mutex)
 281 {
 282   simcall_BODY_cond_wait(cond, mutex);
 283 }
 284
 285 /**
 286  * @ingroup simix_synchro_management
 287  *
 288  */
 289 int simcall_cond_wait_timeout(smx_cond_t cond, smx_mutex_t mutex, double timeout)
 290 {
 291   xbt_assert(std::isfinite(timeout), "timeout is not finite!");
 292   return simcall_BODY_cond_wait_timeout(cond, mutex, timeout);
 293 }
 294
 295 /**
 296  * @ingroup simix_synchro_management
 297  *
 298  */
 299 void simcall_sem_acquire(smx_sem_t sem)
 300 {
 301   simcall_BODY_sem_acquire(sem);
 302 }
 303
 304 /**
 305  * @ingroup simix_synchro_management
 306  *
 307  */
 308 int simcall_sem_acquire_timeout(smx_sem_t sem, double timeout)
 309 {
 310   xbt_assert(std::isfinite(timeout), "timeout is not finite!");
 311   return simcall_BODY_sem_acquire_timeout(sem, timeout);
 312 }
 313
 314 e_smx_state_t simcall_io_wait(simgrid::kernel::activity::ActivityImpl* io, double timeout)
 315 {
 316   return (e_smx_state_t)simcall_BODY_io_wait(static_cast<simgrid::kernel::activity::IoImpl*>(io), timeout);
 317 }
 318
 319 bool simcall_io_test(simgrid::kernel::activity::ActivityImpl* io) // XBT_ATTRIB_DEPRECATED_v330
 320 {
 321   return simgrid::kernel::actor::simcall([io] { return io->test(); });
 322 }
 323
 324 bool simcall_io_test(const simgrid::kernel::activity::ActivityImplPtr& io) // XBT_ATTRIB_DEPRECATD_v330
 325 {
 326   return simgrid::kernel::actor::simcall([io] { return io->test(); });
 327 }
 328
 329 void simcall_run_kernel(std::function<void()> const& code, simgrid::mc::SimcallInspector* t)
 330 {
 331   simgrid::kernel::actor::ActorImpl::self()->simcall.inspector_ = t;
 332   simcall_BODY_run_kernel(&code);
 333 }
 334
 335 void simcall_run_blocking(std::function<void()> const& code, simgrid::mc::SimcallInspector* t = nullptr)
 336 {
 337   simgrid::kernel::actor::ActorImpl::self()->simcall.inspector_ = t;
 338   simcall_BODY_run_blocking(&code);
 339 }
 340
 341 int simcall_mc_random(int min, int max) {
 342   return simcall_BODY_mc_random(min, max);
 343 }
 344
 345 /* ************************************************************************** */
 346
 347 /** @brief returns a printable string representing a simcall */
 348 const char *SIMIX_simcall_name(e_smx_simcall_t kind) {
 349   return simcall_names[kind];
 350 }
 351
 352 namespace simgrid {
 353 namespace simix {
 354
 355 void unblock(smx_actor_t actor)
 356 {
 357   xbt_assert(SIMIX_is_maestro());
 358   actor->simcall_answer();
 359 }
 360 } // namespace simix
 361 } // namespace simgrid