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