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-2015. The SimGrid Team.
   9  * All rights reserved.                                                     */
  10
  11 /* This program is free software; you can redistribute it and/or modify it
  12  * under the terms of the license (GNU LGPL) which comes with this package. */
  13
  14 #include <cmath>         /* std::isfinite() */
  15
  16 #include <functional>
  17
  18 #include "mc/mc.h"
  19 #include "simgrid/s4u/VirtualMachine.hpp"
  20 #include "simgrid/simix.hpp"
  21 #include "simgrid/simix/blocking_simcall.hpp"
  22 #include "smx_private.h"
  23 #include "src/kernel/activity/CommImpl.hpp"
  24 #include "src/mc/mc_forward.hpp"
  25 #include "src/mc/mc_replay.h"
  26 #include "src/plugins/vm/VirtualMachineImpl.hpp"
  27 #include "src/simix/smx_host_private.h"
  28 #include "xbt/ex.h"
  29 #include "xbt/functional.hpp"
  30
  31 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(simix);
  32
  33 #include "popping_bodies.cpp"
  34
  35 void simcall_call(smx_actor_t actor)
  36 {
  37   if (actor != simix_global->maestro_process) {
  38     XBT_DEBUG("Yield actor '%s' on simcall %s (%d)", actor->cname(), SIMIX_simcall_name(actor->simcall.call),
  39               (int)actor->simcall.call);
  40     SIMIX_process_yield(actor);
  41   } else {
  42     SIMIX_simcall_handle(&actor->simcall, 0);
  43   }
  44 }
  45
  46 /**
  47  * \ingroup simix_process_management
  48  * \brief Creates a synchro that executes some computation of an host.
  49  *
  50  * This function creates a SURF action and allocates the data necessary
  51  * to create the SIMIX synchro. It can raise a host_error exception if the host crashed.
  52  *
  53  * \param name Name of the execution synchro to create
  54  * \param flops_amount amount Computation amount (in flops)
  55  * \param priority computation priority
  56  * \param bound
  57  * \return A new SIMIX execution synchronization
  58  */
  59 smx_activity_t simcall_execution_start(const char *name,
  60                                     double flops_amount,
  61                                     double priority, double bound)
  62 {
  63   /* checking for infinite values */
  64   xbt_assert(std::isfinite(flops_amount), "flops_amount is not finite!");
  65   xbt_assert(std::isfinite(priority), "priority is not finite!");
  66
  67   return simcall_BODY_execution_start(name, flops_amount, priority, bound);
  68 }
  69
  70 /**
  71  * \ingroup simix_process_management
  72  * \brief Creates a synchro that may involve parallel computation on
  73  * several hosts and communication between them.
  74  *
  75  * \param name Name of the execution synchro to create
  76  * \param host_nb Number of hosts where the synchro will be executed
  77  * \param host_list Array (of size host_nb) of hosts where the synchro will be executed
  78  * \param flops_amount Array (of size host_nb) of computation amount of hosts (in bytes)
  79  * \param bytes_amount Array (of size host_nb * host_nb) representing the communication
  80  * amount between each pair of hosts
  81  * \param amount the SURF action amount
  82  * \param rate the SURF action rate
  83  * \param timeout timeout
  84  * \return A new SIMIX execution synchronization
  85  */
  86 smx_activity_t simcall_execution_parallel_start(const char* name, int host_nb, sg_host_t* host_list,
  87                                                 double* flops_amount, double* bytes_amount, double amount, double rate,
  88                                                 double timeout)
  89 {
  90   /* checking for infinite values */
  91   for (int i = 0 ; i < host_nb ; ++i) {
  92     xbt_assert(std::isfinite(flops_amount[i]), "flops_amount[%d] is not finite!", i);
  93     if (bytes_amount != nullptr) {
  94       for (int j = 0 ; j < host_nb ; ++j) {
  95         xbt_assert(std::isfinite(bytes_amount[i + host_nb * j]),
  96                    "bytes_amount[%d+%d*%d] is not finite!", i, host_nb, j);
  97       }
  98     }
  99   }
 100
 101   xbt_assert(std::isfinite(amount), "amount is not finite!");
 102   xbt_assert(std::isfinite(rate), "rate is not finite!");
 103
 104   return simcall_BODY_execution_parallel_start(name, host_nb, host_list, flops_amount, bytes_amount, amount, rate,
 105                                                timeout);
 106 }
 107
 108 /**
 109  * \ingroup simix_process_management
 110  * \brief Cancels an execution synchro.
 111  *
 112  * This functions stops the execution. It calls a surf function.
 113  * \param execution The execution synchro to cancel
 114  */
 115 void simcall_execution_cancel(smx_activity_t execution)
 116 {
 117   simcall_BODY_execution_cancel(execution);
 118 }
 119
 120 /**
 121  * \ingroup simix_process_management
 122  * \brief Changes the priority of an execution synchro.
 123  *
 124  * This functions changes the priority only. It calls a surf function.
 125  * \param execution The execution synchro
 126  * \param priority The new priority
 127  */
 128 void simcall_execution_set_priority(smx_activity_t execution, double priority)
 129 {
 130   /* checking for infinite values */
 131   xbt_assert(std::isfinite(priority), "priority is not finite!");
 132
 133   simcall_BODY_execution_set_priority(execution, priority);
 134 }
 135
 136 /**
 137  * \ingroup simix_process_management
 138  * \brief Changes the capping (the maximum CPU utilization) of an execution synchro.
 139  *
 140  * This functions changes the capping only. It calls a surf function.
 141  * \param execution The execution synchro
 142  * \param bound The new bound
 143  */
 144 void simcall_execution_set_bound(smx_activity_t execution, double bound)
 145 {
 146   simcall_BODY_execution_set_bound(execution, bound);
 147 }
 148
 149 /**
 150  * \ingroup simix_host_management
 151  * \brief Waits for the completion of an execution synchro and destroy it.
 152  *
 153  * \param execution The execution synchro
 154  */
 155 e_smx_state_t simcall_execution_wait(smx_activity_t execution)
 156 {
 157   return (e_smx_state_t) simcall_BODY_execution_wait(execution);
 158 }
 159
 160 /**
 161  * \ingroup simix_process_management
 162  * \brief Kills a SIMIX process.
 163  *
 164  * This function simply kills a  process.
 165  *
 166  * \param process poor victim
 167  */
 168 void simcall_process_kill(smx_actor_t process)
 169 {
 170   simcall_BODY_process_kill(process);
 171 }
 172
 173 /**
 174  * \ingroup simix_process_management
 175  * \brief Kills all SIMIX processes.
 176  */
 177 void simcall_process_killall(int reset_pid)
 178 {
 179   simcall_BODY_process_killall(reset_pid);
 180 }
 181
 182 /**
 183  * \ingroup simix_process_management
 184  * \brief Cleans up a SIMIX process.
 185  * \param process poor victim (must have already been killed)
 186  */
 187 void simcall_process_cleanup(smx_actor_t process)
 188 {
 189   simcall_BODY_process_cleanup(process);
 190 }
 191
 192 void simcall_process_join(smx_actor_t process, double timeout)
 193 {
 194   simcall_BODY_process_join(process, timeout);
 195 }
 196
 197 /**
 198  * \ingroup simix_process_management
 199  * \brief Suspends a process.
 200  *
 201  * This function suspends the process by suspending the synchro
 202  * it was waiting for completion.
 203  *
 204  * \param process a SIMIX process
 205  */
 206 void simcall_process_suspend(smx_actor_t process)
 207 {
 208   simcall_BODY_process_suspend(process);
 209 }
 210
 211 /**
 212  * \ingroup simix_process_management
 213  * \brief Returns the amount of SIMIX processes in the system
 214  *
 215  * Maestro internal process is not counted, only user code processes are
 216  */
 217 int simcall_process_count()
 218 {
 219   return simgrid::simix::kernelImmediate(SIMIX_process_count);
 220 }
 221
 222 /**
 223  * \ingroup simix_process_management
 224  * \brief Set the user data of a #smx_actor_t.
 225  *
 226  * This functions sets the user data associated to \a process.
 227  * \param process SIMIX process
 228  * \param data User data
 229  */
 230 void simcall_process_set_data(smx_actor_t process, void *data)
 231 {
 232   simgrid::simix::kernelImmediate(std::bind(SIMIX_process_set_data, process, data));
 233 }
 234
 235 /**
 236  * \ingroup simix_process_management
 237  * \brief Set the kill time of a process.
 238  */
 239 void simcall_process_set_kill_time(smx_actor_t process, double kill_time)
 240 {
 241
 242   if (kill_time <= SIMIX_get_clock() || simix_global->kill_process_function == nullptr)
 243     return;
 244   XBT_DEBUG("Set kill time %f for process %s@%s", kill_time, process->cname(), process->host->getCname());
 245   process->kill_timer = SIMIX_timer_set(kill_time, [=] {
 246     simix_global->kill_process_function(process);
 247     process->kill_timer=nullptr;
 248   });
 249 }
 250
 251 /**
 252  * \ingroup simix_process_management
 253  * \brief Return the properties
 254  *
 255  * This function returns the properties associated with this process
 256  */
 257 xbt_dict_t simcall_process_get_properties(smx_actor_t process)
 258 {
 259   return process->properties;
 260   ;
 261 }
 262 /**
 263  * \ingroup simix_process_management
 264  * \brief Add an on_exit function
 265  * Add an on_exit function which will be executed when the process exits/is killed.
 266  */
 267 XBT_PUBLIC(void) simcall_process_on_exit(smx_actor_t process, int_f_pvoid_pvoid_t fun, void *data)
 268 {
 269   simcall_BODY_process_on_exit(process, fun, data);
 270 }
 271 /**
 272  * \ingroup simix_process_management
 273  * \brief Sets the process to be auto-restarted or not by SIMIX when its host comes back up.
 274  * Will restart the process when the host comes back up if auto_restart is set to 1.
 275  */
 276
 277 XBT_PUBLIC(void) simcall_process_auto_restart_set(smx_actor_t process, int auto_restart)
 278 {
 279   simcall_BODY_process_auto_restart_set(process, auto_restart);
 280 }
 281
 282 /**
 283  * \ingroup simix_process_management
 284  * \brief Restarts the process, killing it and starting it again from scratch.
 285  */
 286 XBT_PUBLIC(smx_actor_t) simcall_process_restart(smx_actor_t process)
 287 {
 288   return (smx_actor_t) simcall_BODY_process_restart(process);
 289 }
 290 /**
 291  * \ingroup simix_process_management
 292  * \brief Creates a new sleep SIMIX synchro.
 293  *
 294  * This function creates a SURF action and allocates the data necessary
 295  * to create the SIMIX synchro. It can raise a host_error exception if the
 296  * host crashed. The default SIMIX name of the synchro is "sleep".
 297  *
 298  *   \param duration Time duration of the sleep.
 299  *   \return A result telling whether the sleep was successful
 300  */
 301 e_smx_state_t simcall_process_sleep(double duration)
 302 {
 303   /* checking for infinite values */
 304   xbt_assert(std::isfinite(duration), "duration is not finite!");
 305   return (e_smx_state_t) simcall_BODY_process_sleep(duration);
 306 }
 307
 308 /**
 309  * \ingroup simix_comm_management
 310  */
 311 void simcall_comm_send(smx_actor_t sender, smx_mailbox_t mbox, size_t task_size, double rate, void* src_buff,
 312                        size_t src_buff_size, int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
 313                        void (*copy_data_fun)(smx_activity_t, void*, size_t), void* data, double timeout)
 314 {
 315   /* checking for infinite values */
 316   xbt_assert(std::isfinite(task_size), "task_size is not finite!");
 317   xbt_assert(std::isfinite(rate), "rate is not finite!");
 318   xbt_assert(std::isfinite(timeout), "timeout is not finite!");
 319
 320   xbt_assert(mbox, "No rendez-vous point defined for send");
 321
 322   if (MC_is_active() || MC_record_replay_is_active()) {
 323     /* the model-checker wants two separate simcalls */
 324     smx_activity_t comm = nullptr; /* MC needs the comm to be set to nullptr during the simcall */
 325     comm = simcall_comm_isend(sender, mbox, task_size, rate,
 326         src_buff, src_buff_size, match_fun, nullptr, copy_data_fun, data, 0);
 327     simcall_comm_wait(comm, timeout);
 328     comm = nullptr;
 329   }
 330   else {
 331     simcall_BODY_comm_send(sender, mbox, task_size, rate, src_buff, src_buff_size,
 332                          match_fun, copy_data_fun, data, timeout);
 333   }
 334 }
 335
 336 /**
 337  * \ingroup simix_comm_management
 338  */
 339 smx_activity_t simcall_comm_isend(smx_actor_t sender, smx_mailbox_t mbox, size_t task_size, double rate, void* src_buff,
 340                                   size_t src_buff_size,
 341                                   int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
 342                                   void (*clean_fun)(void*), void (*copy_data_fun)(smx_activity_t, void*, size_t),
 343                                   void* data, int detached)
 344 {
 345   /* checking for infinite values */
 346   xbt_assert(std::isfinite(task_size), "task_size is not finite!");
 347   xbt_assert(std::isfinite(rate), "rate is not finite!");
 348
 349   xbt_assert(mbox, "No rendez-vous point defined for isend");
 350
 351   return simcall_BODY_comm_isend(sender, mbox, task_size, rate, src_buff,
 352                                  src_buff_size, match_fun,
 353                                  clean_fun, copy_data_fun, data, detached);
 354 }
 355
 356 /**
 357  * \ingroup simix_comm_management
 358  */
 359 void simcall_comm_recv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
 360                        int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
 361                        void (*copy_data_fun)(smx_activity_t, void*, size_t), void* data, double timeout, double rate)
 362 {
 363   xbt_assert(std::isfinite(timeout), "timeout is not finite!");
 364   xbt_assert(mbox, "No rendez-vous point defined for recv");
 365
 366   if (MC_is_active() || MC_record_replay_is_active()) {
 367     /* the model-checker wants two separate simcalls */
 368     smx_activity_t comm = nullptr; /* MC needs the comm to be set to nullptr during the simcall */
 369     comm = simcall_comm_irecv(receiver, mbox, dst_buff, dst_buff_size,
 370                               match_fun, copy_data_fun, data, rate);
 371     simcall_comm_wait(comm, timeout);
 372     comm = nullptr;
 373   }
 374   else {
 375     simcall_BODY_comm_recv(receiver, mbox, dst_buff, dst_buff_size,
 376                            match_fun, copy_data_fun, data, timeout, rate);
 377   }
 378 }
 379 /**
 380  * \ingroup simix_comm_management
 381  */
 382 smx_activity_t simcall_comm_irecv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
 383                                   int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
 384                                   void (*copy_data_fun)(smx_activity_t, void*, size_t), void* data, double rate)
 385 {
 386   xbt_assert(mbox, "No rendez-vous point defined for irecv");
 387
 388   return simcall_BODY_comm_irecv(receiver, mbox, dst_buff, dst_buff_size,
 389                                  match_fun, copy_data_fun, data, rate);
 390 }
 391
 392 /**
 393  * \ingroup simix_comm_management
 394  */
 395 smx_activity_t simcall_comm_iprobe(smx_mailbox_t mbox, int type, int src, int tag,
 396                                    int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*), void* data)
 397 {
 398   xbt_assert(mbox, "No rendez-vous point defined for iprobe");
 399
 400   return simcall_BODY_comm_iprobe(mbox, type, src, tag, match_fun, data);
 401 }
 402
 403 /**
 404  * \ingroup simix_comm_management
 405  */
 406 void simcall_comm_cancel(smx_activity_t synchro)
 407 {
 408   simgrid::simix::kernelImmediate([synchro] {
 409     simgrid::kernel::activity::CommImplPtr comm =
 410         boost::static_pointer_cast<simgrid::kernel::activity::CommImpl>(synchro);
 411     comm->cancel();
 412   });
 413 }
 414
 415 /**
 416  * \ingroup simix_comm_management
 417  */
 418 unsigned int simcall_comm_waitany(xbt_dynar_t comms, double timeout)
 419 {
 420   return simcall_BODY_comm_waitany(comms, timeout);
 421 }
 422
 423 /**
 424  * \ingroup simix_comm_management
 425  */
 426 int simcall_comm_testany(smx_activity_t* comms, size_t count)
 427 {
 428   if (count == 0)
 429     return -1;
 430   return simcall_BODY_comm_testany(comms, count);
 431 }
 432
 433 /**
 434  * \ingroup simix_comm_management
 435  */
 436 void simcall_comm_wait(smx_activity_t comm, double timeout)
 437 {
 438   xbt_assert(std::isfinite(timeout), "timeout is not finite!");
 439   simcall_BODY_comm_wait(comm, timeout);
 440 }
 441
 442 /**
 443  * \brief Set the category of an synchro.
 444  *
 445  * This functions changes the category only. It calls a surf function.
 446  * \param synchro The execution synchro
 447  * \param category The tracing category
 448  */
 449 void simcall_set_category(smx_activity_t synchro, const char *category)
 450 {
 451   if (category == nullptr) {
 452     return;
 453   }
 454   simcall_BODY_set_category(synchro, category);
 455 }
 456
 457 /**
 458  * \ingroup simix_comm_management
 459  *
 460  */
 461 int simcall_comm_test(smx_activity_t comm)
 462 {
 463   return simcall_BODY_comm_test(comm);
 464 }
 465
 466 /**
 467  * \ingroup simix_synchro_management
 468  *
 469  */
 470 smx_mutex_t simcall_mutex_init()
 471 {
 472   if (not simix_global) {
 473     fprintf(stderr,"You must run MSG_init before using MSG\n"); // We can't use xbt_die since we may get there before the initialization
 474     xbt_abort();
 475   }
 476   return simcall_BODY_mutex_init();
 477 }
 478
 479 /**
 480  * \ingroup simix_synchro_management
 481  *
 482  */
 483 void simcall_mutex_lock(smx_mutex_t mutex)
 484 {
 485   simcall_BODY_mutex_lock(mutex);
 486 }
 487
 488 /**
 489  * \ingroup simix_synchro_management
 490  *
 491  */
 492 int simcall_mutex_trylock(smx_mutex_t mutex)
 493 {
 494   return simcall_BODY_mutex_trylock(mutex);
 495 }
 496
 497 /**
 498  * \ingroup simix_synchro_management
 499  *
 500  */
 501 void simcall_mutex_unlock(smx_mutex_t mutex)
 502 {
 503   simcall_BODY_mutex_unlock(mutex);
 504 }
 505
 506 /**
 507  * \ingroup simix_synchro_management
 508  *
 509  */
 510 smx_cond_t simcall_cond_init()
 511 {
 512   return simcall_BODY_cond_init();
 513 }
 514
 515 /**
 516  * \ingroup simix_synchro_management
 517  *
 518  */
 519 void simcall_cond_signal(smx_cond_t cond)
 520 {
 521   simcall_BODY_cond_signal(cond);
 522 }
 523
 524 /**
 525  * \ingroup simix_synchro_management
 526  *
 527  */
 528 void simcall_cond_wait(smx_cond_t cond, smx_mutex_t mutex)
 529 {
 530   simcall_BODY_cond_wait(cond, mutex);
 531 }
 532
 533 /**
 534  * \ingroup simix_synchro_management
 535  *
 536  */
 537 void simcall_cond_wait_timeout(smx_cond_t cond,
 538                                  smx_mutex_t mutex,
 539                                  double timeout)
 540 {
 541   xbt_assert(std::isfinite(timeout), "timeout is not finite!");
 542   simcall_BODY_cond_wait_timeout(cond, mutex, timeout);
 543 }
 544
 545 /**
 546  * \ingroup simix_synchro_management
 547  *
 548  */
 549 void simcall_cond_broadcast(smx_cond_t cond)
 550 {
 551   simcall_BODY_cond_broadcast(cond);
 552 }
 553
 554 /**
 555  * \ingroup simix_synchro_management
 556  *
 557  */
 558 smx_sem_t simcall_sem_init(int capacity)
 559 {
 560   return simcall_BODY_sem_init(capacity);
 561 }
 562
 563 /**
 564  * \ingroup simix_synchro_management
 565  *
 566  */
 567 void simcall_sem_release(smx_sem_t sem)
 568 {
 569   simcall_BODY_sem_release(sem);
 570 }
 571
 572 /**
 573  * \ingroup simix_synchro_management
 574  *
 575  */
 576 int simcall_sem_would_block(smx_sem_t sem)
 577 {
 578   return simcall_BODY_sem_would_block(sem);
 579 }
 580
 581 /**
 582  * \ingroup simix_synchro_management
 583  *
 584  */
 585 void simcall_sem_acquire(smx_sem_t sem)
 586 {
 587   simcall_BODY_sem_acquire(sem);
 588 }
 589
 590 /**
 591  * \ingroup simix_synchro_management
 592  *
 593  */
 594 void simcall_sem_acquire_timeout(smx_sem_t sem, double timeout)
 595 {
 596   xbt_assert(std::isfinite(timeout), "timeout is not finite!");
 597   simcall_BODY_sem_acquire_timeout(sem, timeout);
 598 }
 599
 600 /**
 601  * \ingroup simix_synchro_management
 602  *
 603  */
 604 int simcall_sem_get_capacity(smx_sem_t sem)
 605 {
 606   return simcall_BODY_sem_get_capacity(sem);
 607 }
 608
 609 /**
 610  * \ingroup simix_file_management
 611  *
 612  */
 613 sg_size_t simcall_file_read(surf_file_t fd, sg_size_t size, sg_host_t host)
 614 {
 615   return simcall_BODY_file_read(fd, size, host);
 616 }
 617
 618 /**
 619  * \ingroup simix_file_management
 620  *
 621  */
 622 sg_size_t simcall_file_write(surf_file_t fd, sg_size_t size, sg_host_t host)
 623 {
 624   return simcall_BODY_file_write(fd, size, host);
 625 }
 626
 627 /**
 628  * \ingroup simix_file_management
 629  * \brief
 630  */
 631 surf_file_t simcall_file_open(const char* mount, const char* path, sg_storage_t st)
 632 {
 633   return simcall_BODY_file_open(mount, path, st);
 634 }
 635
 636 /**
 637  * \ingroup simix_file_management
 638  *
 639  */
 640 int simcall_file_close(surf_file_t fd, sg_host_t host)
 641 {
 642   return simcall_BODY_file_close(fd, host);
 643 }
 644
 645 void simcall_run_kernel(std::function<void()> const& code)
 646 {
 647   simcall_BODY_run_kernel(&code);
 648 }
 649
 650 void simcall_run_blocking(std::function<void()> const& code)
 651 {
 652   simcall_BODY_run_blocking(&code);
 653 }
 654
 655 int simcall_mc_random(int min, int max) {
 656   return simcall_BODY_mc_random(min, max);
 657 }
 658
 659 /* ************************************************************************** */
 660
 661 /** @brief returns a printable string representing a simcall */
 662 const char *SIMIX_simcall_name(e_smx_simcall_t kind) {
 663   return simcall_names[kind];
 664 }
 665
 666 namespace simgrid {
 667 namespace simix {
 668
 669 void unblock(smx_actor_t process)
 670 {
 671   xbt_assert(SIMIX_is_maestro());
 672   SIMIX_simcall_answer(&process->simcall);
 673 }
 674
 675 }
 676 }