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