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