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 executes some computation of a host.
  32  *
  33  * This function creates a SURF action and allocates the data necessary
  34  * to create the SIMIX synchro. It can raise a HostFailureException exception if the host crashed.
  35  *
  36  * @param name Name of the execution synchro to create
  37  * @param category Tracing category
  38  * @param flops_amount amount Computation amount (in flops)
  39  * @param priority computation priority
  40  * @param bound Maximal speed for this execution (in flops) or -1 if no limit
  41  * @param host host where the synchro will be executed
  42  * @return A new SIMIX execution synchronization
  43  */
  44 smx_activity_t simcall_execution_start(std::string name, std::string category, double flops_amount, double priority,
  45                                        double bound, simgrid::s4u::Host* host)
  46 {
  47   /* checking for infinite values */
  48   xbt_assert(std::isfinite(flops_amount), "flops_amount is not finite!");
  49   xbt_assert(std::isfinite(priority), "priority is not finite!");
  50
  51   return simgrid::simix::simcall([name, category, flops_amount, priority, bound, host] {
  52     return SIMIX_execution_start(name, category, flops_amount, priority, bound, host);
  53   });
  54 }
  55
  56 /**
  57  * @ingroup simix_process_management
  58  * @brief Creates a synchro that may involve parallel computation on
  59  * several hosts and communication between them.
  60  *
  61  * @param name Name of the execution synchro to create
  62  * @param host_nb Number of hosts where the synchro will be executed
  63  * @param host_list Array (of size host_nb) of hosts where the synchro will be executed
  64  * @param flops_amount Array (of size host_nb) of computation amount of hosts (in bytes)
  65  * @param bytes_amount Array (of size host_nb * host_nb) representing the communication
  66  * amount between each pair of hosts
  67  * @param rate the SURF action rate
  68  * @param timeout timeout
  69  * @return A new SIMIX execution synchronization
  70  */
  71 smx_activity_t simcall_execution_parallel_start(std::string name, int host_nb, sg_host_t* host_list,
  72                                                 double* flops_amount, double* bytes_amount, double rate, double timeout)
  73 {
  74   /* checking for infinite values */
  75   for (int i = 0 ; i < host_nb ; ++i) {
  76     if (flops_amount != nullptr)
  77       xbt_assert(std::isfinite(flops_amount[i]), "flops_amount[%d] is not finite!", i);
  78     if (bytes_amount != nullptr) {
  79       for (int j = 0 ; j < host_nb ; ++j) {
  80         xbt_assert(std::isfinite(bytes_amount[i + host_nb * j]),
  81                    "bytes_amount[%d+%d*%d] is not finite!", i, host_nb, j);
  82       }
  83     }
  84   }
  85
  86   xbt_assert(std::isfinite(rate), "rate is not finite!");
  87
  88   return simgrid::simix::simcall([name, host_nb, host_list, flops_amount, bytes_amount, rate, timeout] {
  89     return SIMIX_execution_parallel_start(name, host_nb, host_list, flops_amount, bytes_amount, rate, timeout);
  90   });
  91 }
  92
  93 /**
  94  * @ingroup simix_process_management
  95  * @brief Cancels an execution synchro.
  96  *
  97  * This functions stops the execution. It calls a surf function.
  98  * @param execution The execution synchro to cancel
  99  */
 100 void simcall_execution_cancel(smx_activity_t execution)
 101 {
 102   simgrid::kernel::activity::ExecImplPtr exec =
 103       boost::static_pointer_cast<simgrid::kernel::activity::ExecImpl>(execution);
 104   if (exec->surf_action_ == nullptr) // FIXME: One test fails if I remove this, but I don't get why...
 105     return;
 106   simgrid::simix::simcall([exec] { exec->cancel(); });
 107 }
 108
 109 /**
 110  * @ingroup simix_process_management
 111  * @brief Changes the priority of an execution synchro.
 112  *
 113  * This functions changes the priority only. It calls a surf function.
 114  * @param execution The execution synchro
 115  * @param priority The new priority
 116  */
 117 void simcall_execution_set_priority(smx_activity_t execution, double priority)
 118 {
 119   /* checking for infinite values */
 120   xbt_assert(std::isfinite(priority), "priority is not finite!");
 121   simgrid::simix::simcall([execution, priority] {
 122
 123     simgrid::kernel::activity::ExecImplPtr exec =
 124         boost::static_pointer_cast<simgrid::kernel::activity::ExecImpl>(execution);
 125     exec->set_priority(priority);
 126   });
 127 }
 128
 129 /**
 130  * @ingroup simix_process_management
 131  * @brief Changes the capping (the maximum CPU utilization) of an execution synchro.
 132  *
 133  * This functions changes the capping only. It calls a surf function.
 134  * @param execution The execution synchro
 135  * @param bound The new bound
 136  */
 137 void simcall_execution_set_bound(smx_activity_t execution, double bound)
 138 {
 139   simgrid::simix::simcall([execution, bound] {
 140     simgrid::kernel::activity::ExecImplPtr exec =
 141         boost::static_pointer_cast<simgrid::kernel::activity::ExecImpl>(execution);
 142     exec->set_bound(bound);
 143   });
 144 }
 145
 146 /**
 147  * @ingroup simix_host_management
 148  * @brief Waits for the completion of an execution synchro and destroy it.
 149  *
 150  * @param execution The execution synchro
 151  */
 152 e_smx_state_t simcall_execution_wait(smx_activity_t execution)
 153 {
 154   return (e_smx_state_t) simcall_BODY_execution_wait(execution);
 155 }
 156
 157 e_smx_state_t simcall_execution_test(smx_activity_t execution)
 158 {
 159   return (e_smx_state_t)simcall_BODY_execution_test(execution);
 160 }
 161
 162 void simcall_process_join(smx_actor_t process, double timeout)
 163 {
 164   simcall_BODY_process_join(process, timeout);
 165 }
 166
 167 /**
 168  * @ingroup simix_process_management
 169  * @brief Suspends an actor
 170  */
 171 void simcall_process_suspend(smx_actor_t process)
 172 {
 173   simcall_BODY_process_suspend(process);
 174 }
 175
 176 /**
 177  * @ingroup simix_process_management
 178  * @brief Set the user data of a #smx_actor_t.
 179  *
 180  * This functions sets the user data associated to @a process.
 181  * @param process SIMIX process
 182  * @param data User data
 183  */
 184 void simcall_process_set_data(smx_actor_t process, void *data)
 185 {
 186   simgrid::simix::simcall([process, data] { process->set_user_data(data); });
 187 }
 188
 189 /**
 190  * @ingroup simix_process_management
 191  * @brief Set the kill time of a process.
 192  */
 193 void simcall_process_set_kill_time(smx_actor_t process, double kill_time)
 194 {
 195
 196   if (kill_time <= SIMIX_get_clock())
 197     return;
 198   XBT_DEBUG("Set kill time %f for process %s@%s", kill_time, process->get_cname(), process->host_->get_cname());
 199   process->kill_timer = SIMIX_timer_set(kill_time, [process] {
 200     SIMIX_process_kill(process, nullptr);
 201     process->kill_timer=nullptr;
 202   });
 203 }
 204
 205 /**
 206  * @ingroup simix_process_management
 207  * @brief Creates a new sleep SIMIX synchro.
 208  *
 209  * This function creates a SURF action and allocates the data necessary
 210  * to create the SIMIX synchro. It can raise a HostFailureException if the
 211  * host crashed. The default SIMIX name of the synchro is "sleep".
 212  *
 213  *   @param duration Time duration of the sleep.
 214  *   @return A result telling whether the sleep was successful
 215  */
 216 e_smx_state_t simcall_process_sleep(double duration)
 217 {
 218   /* checking for infinite values */
 219   xbt_assert(std::isfinite(duration), "duration is not finite!");
 220   return (e_smx_state_t) simcall_BODY_process_sleep(duration);
 221 }
 222
 223 /**
 224  * @ingroup simix_comm_management
 225  */
 226 void simcall_comm_send(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
 227                        size_t src_buff_size, int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
 228                        void (*copy_data_fun)(smx_activity_t, void*, size_t), void* data, double timeout)
 229 {
 230   /* checking for infinite values */
 231   xbt_assert(std::isfinite(task_size), "task_size is not finite!");
 232   xbt_assert(std::isfinite(rate), "rate is not finite!");
 233   xbt_assert(std::isfinite(timeout), "timeout is not finite!");
 234
 235   xbt_assert(mbox, "No rendez-vous point defined for send");
 236
 237   if (MC_is_active() || MC_record_replay_is_active()) {
 238     /* the model-checker wants two separate simcalls */
 239     smx_activity_t comm = nullptr; /* MC needs the comm to be set to nullptr during the simcall */
 240     comm = simcall_comm_isend(sender, mbox, task_size, rate,
 241         src_buff, src_buff_size, match_fun, nullptr, copy_data_fun, data, 0);
 242     simcall_comm_wait(comm, timeout);
 243     comm = nullptr;
 244   }
 245   else {
 246     simcall_BODY_comm_send(sender, mbox, task_size, rate, src_buff, src_buff_size,
 247                          match_fun, copy_data_fun, data, timeout);
 248   }
 249 }
 250
 251 /**
 252  * @ingroup simix_comm_management
 253  */
 254 smx_activity_t simcall_comm_isend(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
 255                                   size_t src_buff_size,
 256                                   int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
 257                                   void (*clean_fun)(void*), void (*copy_data_fun)(smx_activity_t, void*, size_t),
 258                                   void* data, int detached)
 259 {
 260   /* checking for infinite values */
 261   xbt_assert(std::isfinite(task_size), "task_size is not finite!");
 262   xbt_assert(std::isfinite(rate), "rate is not finite!");
 263
 264   xbt_assert(mbox, "No rendez-vous point defined for isend");
 265
 266   return simcall_BODY_comm_isend(sender, mbox, task_size, rate, src_buff,
 267                                  src_buff_size, match_fun,
 268                                  clean_fun, copy_data_fun, data, detached);
 269 }
 270
 271 /**
 272  * @ingroup simix_comm_management
 273  */
 274 void simcall_comm_recv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
 275                        int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
 276                        void (*copy_data_fun)(smx_activity_t, void*, size_t), void* data, double timeout, double rate)
 277 {
 278   xbt_assert(std::isfinite(timeout), "timeout is not finite!");
 279   xbt_assert(mbox, "No rendez-vous point defined for recv");
 280
 281   if (MC_is_active() || MC_record_replay_is_active()) {
 282     /* the model-checker wants two separate simcalls */
 283     smx_activity_t comm = nullptr; /* MC needs the comm to be set to nullptr during the simcall */
 284     comm = simcall_comm_irecv(receiver, mbox, dst_buff, dst_buff_size,
 285                               match_fun, copy_data_fun, data, rate);
 286     simcall_comm_wait(comm, timeout);
 287     comm = nullptr;
 288   }
 289   else {
 290     simcall_BODY_comm_recv(receiver, mbox, dst_buff, dst_buff_size,
 291                            match_fun, copy_data_fun, data, timeout, rate);
 292   }
 293 }
 294 /**
 295  * @ingroup simix_comm_management
 296  */
 297 smx_activity_t simcall_comm_irecv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
 298                                   int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
 299                                   void (*copy_data_fun)(smx_activity_t, void*, size_t), void* data, double rate)
 300 {
 301   xbt_assert(mbox, "No rendez-vous point defined for irecv");
 302
 303   return simcall_BODY_comm_irecv(receiver, mbox, dst_buff, dst_buff_size,
 304                                  match_fun, copy_data_fun, data, rate);
 305 }
 306
 307 /**
 308  * @ingroup simix_comm_management
 309  */
 310 smx_activity_t simcall_comm_iprobe(smx_mailbox_t mbox, int type,
 311                                    int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*), void* data)
 312 {
 313   xbt_assert(mbox, "No rendez-vous point defined for iprobe");
 314
 315   return simcall_BODY_comm_iprobe(mbox, type, match_fun, data);
 316 }
 317
 318 /**
 319  * @ingroup simix_comm_management
 320  */
 321 void simcall_comm_cancel(smx_activity_t synchro)
 322 {
 323   simgrid::simix::simcall([synchro] {
 324     simgrid::kernel::activity::CommImplPtr comm =
 325         boost::static_pointer_cast<simgrid::kernel::activity::CommImpl>(synchro);
 326     comm->cancel();
 327   });
 328 }
 329
 330 /**
 331  * @ingroup simix_comm_management
 332  */
 333 unsigned int simcall_comm_waitany(xbt_dynar_t comms, double timeout)
 334 {
 335   return simcall_BODY_comm_waitany(comms, timeout);
 336 }
 337
 338 /**
 339  * @ingroup simix_comm_management
 340  */
 341 int simcall_comm_testany(smx_activity_t* comms, size_t count)
 342 {
 343   if (count == 0)
 344     return -1;
 345   return simcall_BODY_comm_testany(comms, count);
 346 }
 347
 348 /**
 349  * @ingroup simix_comm_management
 350  */
 351 void simcall_comm_wait(smx_activity_t comm, double timeout)
 352 {
 353   xbt_assert(std::isfinite(timeout), "timeout is not finite!");
 354   simcall_BODY_comm_wait(comm, timeout);
 355 }
 356
 357 /**
 358  * @brief Set the category of an synchro.
 359  *
 360  * This functions changes the category only. It calls a surf function.
 361  * @param synchro The execution synchro
 362  * @param category The tracing category
 363  */
 364 void simcall_set_category(smx_activity_t synchro, std::string category)
 365 {
 366   if (category.empty()) {
 367     return;
 368   }
 369   simgrid::simix::simcall([synchro, category] { SIMIX_set_category(synchro, category); });
 370 }
 371
 372 /**
 373  * @ingroup simix_comm_management
 374  *
 375  */
 376 int simcall_comm_test(smx_activity_t comm)
 377 {
 378   return simcall_BODY_comm_test(comm);
 379 }
 380
 381 /**
 382  * @ingroup simix_synchro_management
 383  *
 384  */
 385 smx_mutex_t simcall_mutex_init()
 386 {
 387   if (simix_global == nullptr) {
 388     fprintf(stderr, "You must initialize the SimGrid engine before using it\n"); // We can't use xbt_die since we may
 389                                                                                  // get there before the initialization
 390     xbt_abort();
 391   }
 392   return simgrid::simix::simcall([] { return new simgrid::kernel::activity::MutexImpl(); });
 393 }
 394
 395 /**
 396  * @ingroup simix_synchro_management
 397  *
 398  */
 399 void simcall_mutex_lock(smx_mutex_t mutex)
 400 {
 401   simcall_BODY_mutex_lock(mutex);
 402 }
 403
 404 /**
 405  * @ingroup simix_synchro_management
 406  *
 407  */
 408 int simcall_mutex_trylock(smx_mutex_t mutex)
 409 {
 410   return simcall_BODY_mutex_trylock(mutex);
 411 }
 412
 413 /**
 414  * @ingroup simix_synchro_management
 415  *
 416  */
 417 void simcall_mutex_unlock(smx_mutex_t mutex)
 418 {
 419   simcall_BODY_mutex_unlock(mutex);
 420 }
 421
 422 /**
 423  * @ingroup simix_synchro_management
 424  *
 425  */
 426 smx_cond_t simcall_cond_init()
 427 {
 428   return simgrid::simix::simcall([] { return new simgrid::kernel::activity::ConditionVariableImpl(); });
 429 }
 430
 431 /**
 432  * @ingroup simix_synchro_management
 433  *
 434  */
 435 void simcall_cond_wait(smx_cond_t cond, smx_mutex_t mutex)
 436 {
 437   simcall_BODY_cond_wait(cond, mutex);
 438 }
 439
 440 /**
 441  * @ingroup simix_synchro_management
 442  *
 443  */
 444 int simcall_cond_wait_timeout(smx_cond_t cond, smx_mutex_t mutex, double timeout)
 445 {
 446   xbt_assert(std::isfinite(timeout), "timeout is not finite!");
 447   return simcall_BODY_cond_wait_timeout(cond, mutex, timeout);
 448 }
 449
 450 /**
 451  * @ingroup simix_synchro_management
 452  *
 453  */
 454 void simcall_sem_acquire(smx_sem_t sem)
 455 {
 456   simcall_BODY_sem_acquire(sem);
 457 }
 458
 459 /**
 460  * @ingroup simix_synchro_management
 461  *
 462  */
 463 int simcall_sem_acquire_timeout(smx_sem_t sem, double timeout)
 464 {
 465   xbt_assert(std::isfinite(timeout), "timeout is not finite!");
 466   return simcall_BODY_sem_acquire_timeout(sem, timeout);
 467 }
 468
 469 e_smx_state_t simcall_io_wait(smx_activity_t io)
 470 {
 471   return (e_smx_state_t)simcall_BODY_io_wait(io);
 472 }
 473
 474 void simcall_run_kernel(std::function<void()> const& code)
 475 {
 476   simcall_BODY_run_kernel(&code);
 477 }
 478
 479 void simcall_run_blocking(std::function<void()> const& code)
 480 {
 481   simcall_BODY_run_blocking(&code);
 482 }
 483
 484 int simcall_mc_random(int min, int max) {
 485   return simcall_BODY_mc_random(min, max);
 486 }
 487
 488 /* ************************************************************************** */
 489
 490 /** @brief returns a printable string representing a simcall */
 491 const char *SIMIX_simcall_name(e_smx_simcall_t kind) {
 492   return simcall_names[kind];
 493 }
 494
 495 namespace simgrid {
 496 namespace simix {
 497
 498 void unblock(smx_actor_t process)
 499 {
 500   xbt_assert(SIMIX_is_maestro());
 501   SIMIX_simcall_answer(&process->simcall);
 502 }
 503
 504 }
 505 }