include/simgrid/simix.h

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