include/simgrid/simix.h

   1 /* Copyright (c) 2007-2019. 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 /* ******************************** Host ************************************ */
  21 /** @brief Host datatype
  22     @ingroup simix_host_management
  23
  24     A <em>location</em> (or <em>host</em>) is any possible place where
  25     a process may run. Thus it is represented as a <em>physical
  26     resource with computing capabilities</em>, some <em>mailboxes</em>
  27     to enable running process to communicate with remote ones, and
  28     some <em>private data</em> that can be only accessed by local
  29     process.
  30
  31     @see m_host_management
  32   @{ */
  33 typedef enum {
  34   SIMIX_WAITING,
  35   SIMIX_READY,
  36   SIMIX_RUNNING,
  37   SIMIX_DONE,
  38   SIMIX_CANCELED,
  39   SIMIX_FAILED,
  40   SIMIX_SRC_HOST_FAILURE,
  41   SIMIX_DST_HOST_FAILURE,
  42   SIMIX_TIMEOUT,
  43   SIMIX_SRC_TIMEOUT,
  44   SIMIX_DST_TIMEOUT,
  45   SIMIX_LINK_FAILURE
  46 } e_smx_state_t;
  47 /** @} */
  48
  49 /******************************* Networking ***********************************/
  50 extern unsigned smx_context_stack_size;
  51 extern unsigned smx_context_guard_size;
  52
  53 SG_BEGIN_DECL
  54
  55 XBT_PUBLIC smx_actor_t SIMIX_process_from_PID(aid_t PID);
  56
  57 /* parallelism */
  58 XBT_PUBLIC int SIMIX_context_is_parallel();
  59 XBT_PUBLIC int SIMIX_context_get_nthreads();
  60 XBT_PUBLIC void SIMIX_context_set_nthreads(int nb_threads);
  61 XBT_PUBLIC int SIMIX_context_get_parallel_threshold();
  62 XBT_PUBLIC void SIMIX_context_set_parallel_threshold(int threshold);
  63 XBT_PUBLIC e_xbt_parmap_mode_t SIMIX_context_get_parallel_mode();
  64 XBT_PUBLIC void SIMIX_context_set_parallel_mode(e_xbt_parmap_mode_t mode);
  65 XBT_PUBLIC int SIMIX_is_maestro();
  66
  67 /********************************** Global ************************************/
  68 /* Initialization and exit */
  69 XBT_PUBLIC void SIMIX_global_init(int* argc, char** argv);
  70
  71 /* Set to execute in the maestro
  72  *
  73  * If no maestro code is registered (the default), the main thread
  74  * is assumed to be the maestro. */
  75 XBT_PUBLIC void SIMIX_set_maestro(void (*code)(void*), void* data);
  76
  77 /* Simulation execution */
  78 XBT_PUBLIC void SIMIX_run();
  79 XBT_PUBLIC double SIMIX_get_clock();
  80
  81 XBT_ATTRIB_DEPRECATED_v329("Please use simgrid::simix::Timer::set()") XBT_PUBLIC smx_timer_t
  82     SIMIX_timer_set(double date, void (*function)(void*), void* arg);
  83 XBT_ATTRIB_DEPRECATED_v329("Please use simgrid::simix::Timer::remove()") XBT_PUBLIC
  84     void SIMIX_timer_remove(smx_timer_t timer);
  85 XBT_ATTRIB_DEPRECATED_v329("Please use simgrid::simix::Timer::next()") XBT_PUBLIC double SIMIX_timer_next();
  86 XBT_ATTRIB_DEPRECATED_v329("Please use simgrid::simix::Timer::get_date()") XBT_PUBLIC
  87     double SIMIX_timer_get_date(smx_timer_t timer);
  88
  89 XBT_PUBLIC void SIMIX_display_process_status();
  90 SG_END_DECL
  91
  92 /******************************** Deployment **********************************/
  93 SG_BEGIN_DECL
  94 XBT_ATTRIB_DEPRECATED_v329("Please use simgrid_register_default() or Engine::register_default()") XBT_PUBLIC
  95     void SIMIX_function_register_default(xbt_main_func_t code);
  96 XBT_ATTRIB_DEPRECATED_v329("This function will be removed in 3.29") XBT_PUBLIC void SIMIX_init_application();
  97
  98 XBT_PUBLIC void SIMIX_process_set_function(const char* process_host, const char* process_function,
  99                                            xbt_dynar_t arguments, double process_start_time, double process_kill_time);
 100 SG_END_DECL
 101
 102 #ifdef __cplusplus
 103 XBT_ATTRIB_DEPRECATED_v329("Please use simgrid_register_function() or Engine::register_function()") XBT_PUBLIC
 104     void SIMIX_function_register(const std::string& name, void (*code)(std::vector<std::string>));
 105 XBT_ATTRIB_DEPRECATED_v329("Please use simgrid_register_function() or Engine::register_function()") XBT_PUBLIC
 106     void SIMIX_function_register(const std::string& name, xbt_main_func_t code);
 107 XBT_ATTRIB_DEPRECATED_v329("Please use simgrid_load_deployment() or Engine::load_deployment()") XBT_PUBLIC
 108     void SIMIX_launch_application(const std::string& file);
 109 #endif
 110
 111 /********************************* Process ************************************/
 112 SG_BEGIN_DECL
 113 XBT_ATTRIB_DEPRECATED_v329("Please use simgrid_get_actor_count()") XBT_PUBLIC int SIMIX_process_count();
 114 XBT_PUBLIC smx_actor_t SIMIX_process_self();
 115 XBT_PUBLIC const char* SIMIX_process_self_get_name();
 116 XBT_ATTRIB_DEPRECATED_v329("This function will be removed in 3.29") XBT_PUBLIC
 117     void SIMIX_process_self_set_data(void* data);
 118 XBT_ATTRIB_DEPRECATED_v329("This function will be removed in 3.29") XBT_PUBLIC void* SIMIX_process_self_get_data();
 119 SG_END_DECL
 120
 121 #ifdef __cplusplus
 122 XBT_PUBLIC void SIMIX_process_on_exit(smx_actor_t process, const std::function<void(bool /*failed*/)>& fun);
 123 #endif
 124
 125 /****************************** Communication *********************************/
 126 #ifdef __cplusplus
 127 XBT_PUBLIC void SIMIX_comm_set_copy_data_callback(void (*callback)(simgrid::kernel::activity::CommImpl*, void*,
 128                                                                    size_t));
 129 XBT_PUBLIC void SIMIX_comm_copy_pointer_callback(simgrid::kernel::activity::CommImpl* comm, void* buff,
 130                                                  size_t buff_size);
 131 XBT_PUBLIC void SIMIX_comm_copy_buffer_callback(simgrid::kernel::activity::CommImpl* comm, void* buff,
 132                                                 size_t buff_size);
 133 #endif
 134
 135 /******************************************************************************/
 136 /*                            SIMIX simcalls                                  */
 137 /******************************************************************************/
 138 /* These functions are a system call-like interface to the simulation kernel. */
 139 /* They can also be called from maestro's context, and they are thread safe.  */
 140 /******************************************************************************/
 141
 142 /******************************* Host simcalls ********************************/
 143 #ifdef __cplusplus
 144 XBT_PUBLIC e_smx_state_t simcall_execution_wait(const smx_activity_t& execution);
 145 XBT_PUBLIC unsigned int simcall_execution_waitany_for(simgrid::kernel::activity::ExecImpl* execs[], size_t count,
 146                                                       double timeout);
 147 XBT_PUBLIC bool simcall_execution_test(const smx_activity_t& execution);
 148 #endif
 149
 150 /**************************** Process simcalls ********************************/
 151 SG_BEGIN_DECL
 152 XBT_ATTRIB_DEPRECATED_v329("This function will be removed in 3.29") void simcall_process_set_data(smx_actor_t process,
 153                                                                                                   void* data);
 154 XBT_ATTRIB_DEPRECATED_v328("Please use Actor::suspend()") XBT_PUBLIC void simcall_process_suspend(smx_actor_t process);
 155
 156 XBT_ATTRIB_DEPRECATED_v328("Please use Actor::join()") XBT_PUBLIC
 157     void simcall_process_join(smx_actor_t process, double timeout);
 158
 159 XBT_ATTRIB_DEPRECATED_v329("Please use sg_actor_sleep_for()") XBT_PUBLIC e_smx_state_t
 160     simcall_process_sleep(double duration);
 161 SG_END_DECL
 162
 163 /************************** Communication simcalls ****************************/
 164
 165 #ifdef __cplusplus
 166 XBT_PUBLIC void simcall_comm_send(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
 167                                   size_t src_buff_size,
 168                                   int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
 169                                   void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t),
 170                                   void* data, double timeout);
 171
 172 XBT_PUBLIC smx_activity_t simcall_comm_isend(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate,
 173                                              void* src_buff, size_t src_buff_size,
 174                                              int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
 175                                              void (*clean_fun)(void*),
 176                                              void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t),
 177                                              void* data, bool detached);
 178
 179 XBT_PUBLIC void simcall_comm_recv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
 180                                   int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
 181                                   void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t),
 182                                   void* data, double timeout, double rate);
 183
 184 XBT_PUBLIC smx_activity_t simcall_comm_irecv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff,
 185                                              size_t* dst_buff_size,
 186                                              int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
 187                                              void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t),
 188                                              void* data, double rate);
 189
 190 XBT_PUBLIC smx_activity_t simcall_comm_iprobe(smx_mailbox_t mbox, int type,
 191                                               int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
 192                                               void* data);
 193
 194 /* FIXME: waitany is going to be a vararg function, and should take a timeout */
 195 XBT_PUBLIC unsigned int simcall_comm_waitany(smx_activity_t comms[], size_t count, double timeout);
 196 XBT_PUBLIC unsigned int simcall_comm_waitany(simgrid::kernel::activity::CommImpl* comms[], size_t count,
 197                                              double timeout);
 198 XBT_PUBLIC void simcall_comm_wait(const smx_activity_t& comm, double timeout);
 199 XBT_PUBLIC bool simcall_comm_test(const smx_activity_t& comm);
 200 XBT_PUBLIC int simcall_comm_testany(smx_activity_t comms[], size_t count);
 201 XBT_PUBLIC int simcall_comm_testany(simgrid::kernel::activity::CommImpl* comms[], size_t count);
 202 #endif
 203
 204 /************************** Synchro simcalls **********************************/
 205 SG_BEGIN_DECL
 206 XBT_PUBLIC smx_mutex_t simcall_mutex_init();
 207 XBT_PUBLIC void simcall_mutex_lock(smx_mutex_t mutex);
 208 XBT_PUBLIC int simcall_mutex_trylock(smx_mutex_t mutex);
 209 XBT_PUBLIC void simcall_mutex_unlock(smx_mutex_t mutex);
 210
 211 XBT_PUBLIC smx_cond_t simcall_cond_init();
 212 XBT_PUBLIC void simcall_cond_wait(smx_cond_t cond, smx_mutex_t mutex);
 213 XBT_PUBLIC int simcall_cond_wait_timeout(smx_cond_t cond, smx_mutex_t mutex, double max_duration);
 214
 215 XBT_PUBLIC void simcall_sem_acquire(smx_sem_t sem);
 216 XBT_PUBLIC int simcall_sem_acquire_timeout(smx_sem_t sem, double max_duration);
 217 SG_END_DECL
 218
 219 /*****************************   Io   **************************************/
 220 #ifdef __cplusplus
 221 XBT_PUBLIC e_smx_state_t simcall_io_wait(const smx_activity_t& io);
 222 #endif
 223 /************************** MC simcalls   **********************************/
 224 SG_BEGIN_DECL
 225 XBT_PUBLIC int simcall_mc_random(int min, int max);
 226 SG_END_DECL
 227
 228 #endif