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 /* ******************************** Synchro ************************************ */
  50
  51 /** @ingroup simix_synchro_management */
  52 typedef struct s_smx_sem_t* smx_sem_t;
  53
  54 /* ****************************** Process *********************************** */
  55
  56 typedef enum {
  57   SMX_EXIT_SUCCESS = 0,
  58   SMX_EXIT_FAILURE = 1
  59 } smx_process_exit_status_t;
  60 /** @} */
  61
  62 /******************************* Networking ***********************************/
  63 extern unsigned smx_context_stack_size;
  64 extern int smx_context_stack_size_was_set;
  65 extern unsigned smx_context_guard_size;
  66 extern int smx_context_guard_size_was_set;
  67
  68 SG_BEGIN_DECL()
  69
  70 XBT_PUBLIC smx_actor_t SIMIX_process_from_PID(aid_t PID);
  71
  72 /* parallelism */
  73 XBT_PUBLIC int SIMIX_context_is_parallel();
  74 XBT_PUBLIC int SIMIX_context_get_nthreads();
  75 XBT_PUBLIC void SIMIX_context_set_nthreads(int nb_threads);
  76 XBT_PUBLIC int SIMIX_context_get_parallel_threshold();
  77 XBT_PUBLIC void SIMIX_context_set_parallel_threshold(int threshold);
  78 XBT_PUBLIC e_xbt_parmap_mode_t SIMIX_context_get_parallel_mode();
  79 XBT_PUBLIC void SIMIX_context_set_parallel_mode(e_xbt_parmap_mode_t mode);
  80 XBT_PUBLIC int SIMIX_is_maestro();
  81
  82 /********************************** Global ************************************/
  83 /* Initialization and exit */
  84 XBT_PUBLIC void SIMIX_global_init(int* argc, char** argv);
  85
  86 /* Set to execute in the maestro
  87  *
  88  * If no maestro code is registered (the default), the main thread
  89  * is assumed to be the maestro. */
  90 XBT_PUBLIC void SIMIX_set_maestro(void (*code)(void*), void* data);
  91
  92 /* Simulation execution */
  93 XBT_PUBLIC void SIMIX_run();
  94 XBT_PUBLIC double SIMIX_get_clock();
  95
  96 /* Timer functions FIXME: should these be public? */
  97 typedef struct s_smx_timer_t* smx_timer_t;
  98
  99 XBT_PUBLIC smx_timer_t SIMIX_timer_set(double date, void (*function)(void*), void* arg);
 100 XBT_PUBLIC void SIMIX_timer_remove(smx_timer_t timer);
 101 XBT_PUBLIC double SIMIX_timer_next();
 102 XBT_PUBLIC double SIMIX_timer_get_date(smx_timer_t timer);
 103
 104 XBT_PUBLIC void SIMIX_display_process_status();
 105 SG_END_DECL()
 106
 107 /******************************* Environment **********************************/
 108 SG_BEGIN_DECL()
 109 XBT_ATTRIB_DEPRECATED_v324("Please use simgrid_load_platform()") XBT_PUBLIC
 110     void SIMIX_create_environment(const char* file);
 111 SG_END_DECL()
 112
 113 #ifdef __cplusplus
 114 XBT_PUBLIC void SIMIX_create_environment(std::string file);
 115 #endif
 116
 117 /******************************** Deployment **********************************/
 118 SG_BEGIN_DECL()
 119 XBT_ATTRIB_DEPRECATED_v324("Please use simgrid_register_function()") XBT_PUBLIC
 120     void SIMIX_function_register(const char* name, xbt_main_func_t code);
 121 XBT_ATTRIB_DEPRECATED_v324("Please use simgrid_load_deployment()") XBT_PUBLIC
 122     void SIMIX_launch_application(const char* file);
 123 XBT_PUBLIC void SIMIX_function_register_default(xbt_main_func_t code);
 124
 125 XBT_PUBLIC void SIMIX_init_application();
 126 XBT_PUBLIC void SIMIX_process_set_function(const char* process_host, const char* process_function,
 127                                            xbt_dynar_t arguments, double process_start_time, double process_kill_time);
 128 SG_END_DECL()
 129
 130 #ifdef __cplusplus
 131 XBT_PUBLIC void SIMIX_function_register(std::string name, void (*code)(std::vector<std::string>));
 132 XBT_PUBLIC void SIMIX_function_register(std::string name, xbt_main_func_t code);
 133 XBT_PUBLIC void SIMIX_launch_application(std::string file);
 134 #endif
 135
 136 /*********************************** Host *************************************/
 137 /* Functions for running a process in main()
 138  *
 139  *  1. create the maestro process
 140  *  2. attach (create a context and wait for maestro to give control back to you)
 141  *  3. do you process job
 142  *  4. detach (this waits for the simulation to terminate)
 143  */
 144
 145 SG_BEGIN_DECL()
 146 XBT_PUBLIC void SIMIX_maestro_create(void (*code)(void*), void* data);
 147 SG_END_DECL()
 148 #ifdef __cplusplus
 149 XBT_PUBLIC smx_actor_t SIMIX_process_attach(const char* name, void* data, const char* hostname,
 150                                             std::unordered_map<std::string, std::string>* properties,
 151                                             smx_actor_t parent_process);
 152 #endif
 153 SG_BEGIN_DECL()
 154 XBT_PUBLIC void SIMIX_process_detach();
 155 SG_END_DECL()
 156
 157 /********************************* Process ************************************/
 158 SG_BEGIN_DECL()
 159 XBT_PUBLIC int SIMIX_process_count();
 160 XBT_PUBLIC smx_actor_t SIMIX_process_self();
 161 XBT_PUBLIC const char* SIMIX_process_self_get_name();
 162 XBT_PUBLIC void SIMIX_process_self_set_data(void* data);
 163 XBT_PUBLIC void* SIMIX_process_self_get_data();
 164 XBT_PUBLIC int SIMIX_process_has_pending_comms(smx_actor_t process);
 165 XBT_PUBLIC void SIMIX_process_on_exit_runall(smx_actor_t process);
 166 XBT_PUBLIC void SIMIX_process_on_exit(smx_actor_t process, int_f_pvoid_pvoid_t fun, void* data);
 167 SG_END_DECL()
 168
 169 #ifdef __cplusplus
 170 XBT_PUBLIC void SIMIX_process_on_exit(smx_actor_t process, std::function<void(int, void*)> fun, void* data);
 171 #endif
 172
 173 /****************************** Communication *********************************/
 174 XBT_PUBLIC void SIMIX_comm_set_copy_data_callback(void (*callback)(smx_activity_t, void*, size_t));
 175 XBT_PUBLIC void SIMIX_comm_copy_pointer_callback(smx_activity_t comm, void* buff, size_t buff_size);
 176 XBT_PUBLIC void SIMIX_comm_copy_buffer_callback(smx_activity_t comm, void* buff, size_t buff_size);
 177
 178 XBT_PUBLIC void SIMIX_comm_finish(smx_activity_t synchro);
 179
 180 /******************************************************************************/
 181 /*                            SIMIX simcalls                                  */
 182 /******************************************************************************/
 183 /* These functions are a system call-like interface to the simulation kernel. */
 184 /* They can also be called from maestro's context, and they are thread safe.  */
 185 /******************************************************************************/
 186
 187 /******************************* Host simcalls ********************************/
 188 #ifdef __cplusplus
 189 XBT_PUBLIC smx_activity_t simcall_execution_start(std::string name, std::string category, double flops_amount,
 190                                                   double priority, double bound, sg_host_t host);
 191 XBT_PUBLIC smx_activity_t simcall_execution_parallel_start(std::string name, int host_nb, sg_host_t* host_list,
 192                                                            double* flops_amount, double* bytes_amount, double rate,
 193                                                            double timeout);
 194 #endif
 195 XBT_PUBLIC void simcall_execution_cancel(smx_activity_t execution);
 196 XBT_PUBLIC void simcall_execution_set_priority(smx_activity_t execution, double priority);
 197 XBT_PUBLIC void simcall_execution_set_bound(smx_activity_t execution, double bound);
 198 XBT_PUBLIC e_smx_state_t simcall_execution_wait(smx_activity_t execution);
 199 XBT_PUBLIC e_smx_state_t simcall_execution_test(smx_activity_t execution);
 200
 201 /**************************** Process simcalls ********************************/
 202 SG_BEGIN_DECL()
 203 XBT_ATTRIB_DEPRECATED_v324("Please use ActorImpl::throw_exception") XBT_PUBLIC
 204     void SIMIX_process_throw(smx_actor_t process, xbt_errcat_t cat, int value, const char* mesg);
 205
 206 /* Process handling */
 207 XBT_PUBLIC void simcall_process_suspend(smx_actor_t process);
 208
 209 /* Getters and Setters */
 210 XBT_PUBLIC void simcall_process_set_data(smx_actor_t process, void* data);
 211 XBT_PUBLIC void simcall_process_set_kill_time(smx_actor_t process, double kill_time);
 212 XBT_PUBLIC void simcall_process_join(smx_actor_t process, double timeout);
 213 /* Sleep control */
 214 XBT_PUBLIC e_smx_state_t simcall_process_sleep(double duration);
 215 SG_END_DECL()
 216
 217 /************************** Comunication simcalls *****************************/
 218
 219 #ifdef __cplusplus
 220 XBT_PUBLIC void simcall_comm_send(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
 221                                   size_t src_buff_size,
 222                                   int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
 223                                   void (*copy_data_fun)(smx_activity_t, void*, size_t), void* data, double timeout);
 224
 225 XBT_PUBLIC smx_activity_t simcall_comm_isend(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate,
 226                                              void* src_buff, size_t src_buff_size,
 227                                              int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
 228                                              void (*clean_fun)(void*),
 229                                              void (*copy_data_fun)(smx_activity_t, void*, size_t), void* data,
 230                                              int detached);
 231
 232 XBT_PUBLIC void simcall_comm_recv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
 233                                   int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
 234                                   void (*copy_data_fun)(smx_activity_t, void*, size_t), void* data, double timeout,
 235                                   double rate);
 236
 237 XBT_PUBLIC smx_activity_t simcall_comm_irecv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff,
 238                                              size_t* dst_buff_size,
 239                                              int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
 240                                              void (*copy_data_fun)(smx_activity_t, void*, size_t), void* data,
 241                                              double rate);
 242
 243 XBT_PUBLIC smx_activity_t simcall_comm_iprobe(smx_mailbox_t mbox, int type,
 244                                               int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
 245                                               void* data);
 246 #endif
 247 XBT_PUBLIC void simcall_comm_cancel(smx_activity_t comm);
 248
 249 /* FIXME: waitany is going to be a vararg function, and should take a timeout */
 250 XBT_PUBLIC unsigned int simcall_comm_waitany(xbt_dynar_t comms, double timeout);
 251 XBT_PUBLIC void simcall_comm_wait(smx_activity_t comm, double timeout);
 252 XBT_PUBLIC int simcall_comm_test(smx_activity_t comm);
 253 XBT_PUBLIC int simcall_comm_testany(smx_activity_t* comms, size_t count);
 254
 255 /************************** Tracing handling **********************************/
 256 #ifdef __cplusplus
 257 XBT_PUBLIC void simcall_set_category(smx_activity_t synchro, std::string category);
 258 #endif
 259
 260 /************************** Synchro simcalls **********************************/
 261 SG_BEGIN_DECL()
 262 XBT_PUBLIC smx_mutex_t simcall_mutex_init();
 263 XBT_PUBLIC smx_mutex_t SIMIX_mutex_ref(smx_mutex_t mutex);
 264 XBT_PUBLIC void SIMIX_mutex_unref(smx_mutex_t mutex);
 265 XBT_PUBLIC void simcall_mutex_lock(smx_mutex_t mutex);
 266 XBT_PUBLIC int simcall_mutex_trylock(smx_mutex_t mutex);
 267 XBT_PUBLIC void simcall_mutex_unlock(smx_mutex_t mutex);
 268
 269 XBT_PUBLIC smx_cond_t simcall_cond_init();
 270 XBT_PUBLIC void simcall_cond_wait(smx_cond_t cond, smx_mutex_t mutex);
 271 XBT_PUBLIC int simcall_cond_wait_timeout(smx_cond_t cond, smx_mutex_t mutex, double max_duration);
 272
 273 XBT_PUBLIC void SIMIX_sem_destroy(smx_sem_t sem);
 274 XBT_PUBLIC void simcall_sem_acquire(smx_sem_t sem);
 275 XBT_PUBLIC int simcall_sem_acquire_timeout(smx_sem_t sem, double max_duration);
 276
 277 /*****************************   Io   **************************************/
 278 XBT_PUBLIC e_smx_state_t simcall_io_wait(smx_activity_t io);
 279 /************************** MC simcalls   **********************************/
 280 XBT_PUBLIC int simcall_mc_random(int min, int max);
 281
 282 SG_END_DECL()
 283
 284 #endif