include/simgrid/simix.h

   1 /* Copyright (c) 2007-2020. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #ifndef SIMGRID_SIMIX_H
   7 #define SIMGRID_SIMIX_H
   8
   9 #include <simgrid/forward.h>
  10 #include <simgrid/host.h>
  11 #include <xbt/ex.h>
  12 #include <xbt/parmap.h>
  13 #ifdef __cplusplus
  14 #include <functional>
  15 #include <string>
  16 #include <unordered_map>
  17 #include <vector>
  18 #endif
  19
  20 /******************************* Networking ***********************************/
  21 extern unsigned smx_context_stack_size;
  22 extern unsigned smx_context_guard_size;
  23
  24 SG_BEGIN_DECL
  25
  26 XBT_PUBLIC smx_actor_t SIMIX_process_from_PID(aid_t PID);
  27
  28 /* parallelism */
  29 XBT_PUBLIC int SIMIX_context_is_parallel();
  30 XBT_PUBLIC int SIMIX_context_get_nthreads();
  31 XBT_PUBLIC void SIMIX_context_set_nthreads(int nb_threads);
  32 XBT_PUBLIC int SIMIX_context_get_parallel_threshold();
  33 XBT_PUBLIC void SIMIX_context_set_parallel_threshold(int threshold);
  34 XBT_PUBLIC e_xbt_parmap_mode_t SIMIX_context_get_parallel_mode();
  35 XBT_PUBLIC void SIMIX_context_set_parallel_mode(e_xbt_parmap_mode_t mode);
  36 XBT_PUBLIC int SIMIX_is_maestro();
  37
  38 /********************************** Global ************************************/
  39 /* Initialization and exit */
  40 XBT_PUBLIC void SIMIX_global_init(int* argc, char** argv);
  41
  42 /* Set to execute in the maestro
  43  *
  44  * If no maestro code is registered (the default), the main thread
  45  * is assumed to be the maestro. */
  46 XBT_PUBLIC void SIMIX_set_maestro(void (*code)(void*), void* data);
  47
  48 /* Simulation execution */
  49 XBT_PUBLIC void SIMIX_run();
  50 XBT_PUBLIC double SIMIX_get_clock();
  51
  52 XBT_ATTRIB_DEPRECATED_v329("Please use simgrid::simix::Timer::set()") XBT_PUBLIC smx_timer_t
  53     SIMIX_timer_set(double date, void (*function)(void*), void* arg);
  54 XBT_ATTRIB_DEPRECATED_v329("Please use simgrid::simix::Timer::remove()") XBT_PUBLIC
  55     void SIMIX_timer_remove(smx_timer_t timer);
  56 XBT_ATTRIB_DEPRECATED_v329("Please use simgrid::simix::Timer::next()") XBT_PUBLIC double SIMIX_timer_next();
  57 XBT_ATTRIB_DEPRECATED_v329("Please use simgrid::simix::Timer::get_date()") XBT_PUBLIC
  58     double SIMIX_timer_get_date(smx_timer_t timer);
  59
  60 XBT_ATTRIB_DEPRECATED_v329("Please use simix_global->display_all_actor_status()") XBT_PUBLIC
  61     void SIMIX_display_process_status();
  62 SG_END_DECL
  63
  64 /******************************** Deployment **********************************/
  65 SG_BEGIN_DECL
  66 XBT_ATTRIB_DEPRECATED_v329("Please use simgrid_register_default() or Engine::register_default()") XBT_PUBLIC
  67     void SIMIX_function_register_default(xbt_main_func_t code);
  68 XBT_ATTRIB_DEPRECATED_v329("This function will be removed in 3.29") XBT_PUBLIC void SIMIX_init_application();
  69
  70 XBT_PUBLIC void SIMIX_process_set_function(const char* process_host, const char* process_function,
  71                                            xbt_dynar_t arguments, double process_start_time, double process_kill_time);
  72 SG_END_DECL
  73
  74 #ifdef __cplusplus
  75 XBT_ATTRIB_DEPRECATED_v329("Please use simgrid_register_function() or Engine::register_function()") XBT_PUBLIC
  76     void SIMIX_function_register(const std::string& name, void (*code)(std::vector<std::string>));
  77 XBT_ATTRIB_DEPRECATED_v329("Please use simgrid_register_function() or Engine::register_function()") XBT_PUBLIC
  78     void SIMIX_function_register(const std::string& name, xbt_main_func_t code);
  79 XBT_ATTRIB_DEPRECATED_v329("Please use simgrid_load_deployment() or Engine::load_deployment()") XBT_PUBLIC
  80     void SIMIX_launch_application(const std::string& file);
  81 #endif
  82
  83 /********************************* Process ************************************/
  84 SG_BEGIN_DECL
  85 XBT_ATTRIB_DEPRECATED_v329("Please use simgrid_get_actor_count()") XBT_PUBLIC int SIMIX_process_count();
  86 XBT_PUBLIC smx_actor_t SIMIX_process_self();
  87 XBT_PUBLIC const char* SIMIX_process_self_get_name();
  88 XBT_ATTRIB_DEPRECATED_v329("This function will be removed in 3.29") XBT_PUBLIC
  89     void SIMIX_process_self_set_data(void* data);
  90 XBT_ATTRIB_DEPRECATED_v329("This function will be removed in 3.29") XBT_PUBLIC void* SIMIX_process_self_get_data();
  91 SG_END_DECL
  92
  93 #ifdef __cplusplus
  94 XBT_ATTRIB_DEPRECATED_v329("This function will be removed in 3.29") XBT_PUBLIC
  95     void SIMIX_process_on_exit(smx_actor_t process, const std::function<void(bool /*failed*/)>& fun);
  96 #endif
  97
  98 /****************************** Communication *********************************/
  99 #ifdef __cplusplus
 100 XBT_PUBLIC void SIMIX_comm_set_copy_data_callback(void (*callback)(simgrid::kernel::activity::CommImpl*, void*,
 101                                                                    size_t));
 102 XBT_PUBLIC void SIMIX_comm_copy_pointer_callback(simgrid::kernel::activity::CommImpl* comm, void* buff,
 103                                                  size_t buff_size);
 104 XBT_PUBLIC void SIMIX_comm_copy_buffer_callback(simgrid::kernel::activity::CommImpl* comm, void* buff,
 105                                                 size_t buff_size);
 106 #endif
 107
 108 /******************************************************************************/
 109 /*                            SIMIX simcalls                                  */
 110 /******************************************************************************/
 111 /* These functions are a system call-like interface to the simulation kernel. */
 112 /* They can also be called from maestro's context, and they are thread safe.  */
 113 /******************************************************************************/
 114
 115 /******************************* Host simcalls ********************************/
 116 #ifdef __cplusplus
 117 XBT_PUBLIC e_smx_state_t simcall_execution_wait(simgrid::kernel::activity::ActivityImpl* execution, double timeout);
 118 XBT_PUBLIC unsigned int simcall_execution_waitany_for(simgrid::kernel::activity::ExecImpl* execs[], size_t count,
 119                                                       double timeout);
 120 XBT_ATTRIB_DEPRECATED_v330("Please use s4u::Exec::test()") XBT_PUBLIC
 121     bool simcall_execution_test(simgrid::kernel::activity::ActivityImpl* execution);
 122 XBT_ATTRIB_DEPRECATED_v330("Please use s4u::Exec::test()") XBT_PUBLIC
 123     bool simcall_execution_test(const simgrid::kernel::activity::ActivityImplPtr& execution);
 124
 125 XBT_ATTRIB_DEPRECATED_v330("Please use an ActivityImpl* for first parameter") inline e_smx_state_t
 126     simcall_execution_wait(const simgrid::kernel::activity::ActivityImplPtr& execution, double timeout)
 127 {
 128   return simcall_execution_wait(execution.get(), timeout);
 129 }
 130 #endif
 131
 132 /**************************** Process simcalls ********************************/
 133 SG_BEGIN_DECL
 134 XBT_ATTRIB_DEPRECATED_v329("This function will be removed in 3.29") void simcall_process_set_data(smx_actor_t process,
 135                                                                                                   void* data);
 136 XBT_ATTRIB_DEPRECATED_v328("Please use sg_actor_suspend()") XBT_PUBLIC
 137     void simcall_process_suspend(smx_actor_t process);
 138
 139 XBT_ATTRIB_DEPRECATED_v328("Please use sg_actor_join()") XBT_PUBLIC
 140     void simcall_process_join(smx_actor_t process, double timeout);
 141
 142 XBT_ATTRIB_DEPRECATED_v329("Please use sg_actor_sleep_for()") XBT_PUBLIC e_smx_state_t
 143     simcall_process_sleep(double duration);
 144 SG_END_DECL
 145
 146 /************************** Communication simcalls ****************************/
 147
 148 #ifdef __cplusplus
 149 XBT_PUBLIC void simcall_comm_send(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
 150                                   size_t src_buff_size,
 151                                   bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
 152                                   void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t),
 153                                   void* data, double timeout);
 154
 155 XBT_PUBLIC simgrid::kernel::activity::ActivityImplPtr
 156 simcall_comm_isend(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
 157                    size_t src_buff_size, bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
 158                    void (*clean_fun)(void*), void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t),
 159                    void* data, bool detached);
 160
 161 XBT_PUBLIC void simcall_comm_recv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
 162                                   bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
 163                                   void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t),
 164                                   void* data, double timeout, double rate);
 165
 166 XBT_PUBLIC simgrid::kernel::activity::ActivityImplPtr
 167 simcall_comm_irecv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
 168                    bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
 169                    void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t), void* data, double rate);
 170
 171 XBT_ATTRIB_DEPRECATED_v330("Please use Mailbox::iprobe()") XBT_PUBLIC simgrid::kernel::activity::ActivityImplPtr
 172     simcall_comm_iprobe(smx_mailbox_t mbox, int type,
 173                         bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*), void* data);
 174
 175 XBT_ATTRIB_DEPRECATED_v330("Please use a CommImpl*[] for first parameter") XBT_PUBLIC
 176     unsigned int simcall_comm_waitany(simgrid::kernel::activity::ActivityImplPtr comms[], size_t count, double timeout);
 177 XBT_PUBLIC unsigned int simcall_comm_waitany(simgrid::kernel::activity::CommImpl* comms[], size_t count,
 178                                              double timeout);
 179 XBT_PUBLIC void simcall_comm_wait(simgrid::kernel::activity::ActivityImpl* comm, double timeout);
 180 XBT_PUBLIC bool simcall_comm_test(simgrid::kernel::activity::ActivityImpl* comm);
 181 XBT_ATTRIB_DEPRECATED_v330("Please use a CommImpl*[] for first parameter") XBT_PUBLIC
 182     int simcall_comm_testany(simgrid::kernel::activity::ActivityImplPtr comms[], size_t count);
 183 XBT_PUBLIC int simcall_comm_testany(simgrid::kernel::activity::CommImpl* comms[], size_t count);
 184
 185 XBT_ATTRIB_DEPRECATED_v330("Please use a ActivityImpl* for first parameter") inline void simcall_comm_wait(
 186     const simgrid::kernel::activity::ActivityImplPtr& comm, double timeout)
 187 {
 188   simcall_comm_wait(comm.get(), timeout);
 189 }
 190 XBT_ATTRIB_DEPRECATED_v330("Please use a ActivityImpl* for first parameter") inline bool simcall_comm_test(
 191     const simgrid::kernel::activity::ActivityImplPtr& comm)
 192 {
 193   return simcall_comm_test(comm.get());
 194 }
 195 #endif
 196
 197 /************************** Synchro simcalls **********************************/
 198 SG_BEGIN_DECL
 199 XBT_ATTRIB_DEPRECATED_v330("Please use sg_mutex_init()") XBT_PUBLIC smx_mutex_t simcall_mutex_init();
 200 XBT_PUBLIC void simcall_mutex_lock(smx_mutex_t mutex);
 201 XBT_PUBLIC int simcall_mutex_trylock(smx_mutex_t mutex);
 202 XBT_PUBLIC void simcall_mutex_unlock(smx_mutex_t mutex);
 203
 204 XBT_ATTRIB_DEPRECATED_v330("Please use sg_cond_init()") XBT_PUBLIC smx_cond_t simcall_cond_init();
 205 XBT_PUBLIC void simcall_cond_wait(smx_cond_t cond, smx_mutex_t mutex);
 206 XBT_PUBLIC int simcall_cond_wait_timeout(smx_cond_t cond, smx_mutex_t mutex, double max_duration);
 207
 208 XBT_PUBLIC void simcall_sem_acquire(smx_sem_t sem);
 209 XBT_PUBLIC int simcall_sem_acquire_timeout(smx_sem_t sem, double max_duration);
 210 SG_END_DECL
 211
 212 /*****************************   Io   **************************************/
 213 #ifdef __cplusplus
 214 XBT_PUBLIC e_smx_state_t simcall_io_wait(simgrid::kernel::activity::ActivityImpl* io, double timeout);
 215 XBT_ATTRIB_DEPRECATED_v330("Please use s4u::Io::test()") XBT_PUBLIC
 216     bool simcall_io_test(simgrid::kernel::activity::ActivityImpl* io);
 217 XBT_ATTRIB_DEPRECATED_v330("Please use s4u::Io::test()") XBT_PUBLIC
 218     bool simcall_io_test(const simgrid::kernel::activity::ActivityImplPtr& io);
 219
 220 XBT_ATTRIB_DEPRECATED_v330("Please use an ActivityImpl* for first parameter") inline e_smx_state_t
 221     simcall_io_wait(const simgrid::kernel::activity::ActivityImplPtr& io, double timeout)
 222 {
 223   return simcall_io_wait(io.get(), timeout);
 224 }
 225
 226 #endif
 227 /************************** MC simcalls   **********************************/
 228 SG_BEGIN_DECL
 229 XBT_PUBLIC int simcall_mc_random(int min, int max);
 230 SG_END_DECL
 231
 232 #endif