include/simgrid/simix.h

   1 /* Copyright (c) 2007-2017. 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 _SIMIX_SIMIX_H
   7 #define _SIMIX_SIMIX_H
   8
   9 #include "simgrid/datatypes.h"
  10 #include "simgrid/host.h"
  11 #include "xbt/ex.h"
  12 #include "xbt/parmap.h"
  13
  14
  15 /* ******************************** Host ************************************ */
  16 /** @brief Host datatype
  17     @ingroup simix_host_management
  18
  19     A <em>location</em> (or <em>host</em>) is any possible place where
  20     a process may run. Thus it is represented as a <em>physical
  21     resource with computing capabilities</em>, some <em>mailboxes</em>
  22     to enable running process to communicate with remote ones, and
  23     some <em>private data</em> that can be only accessed by local
  24     process.
  25
  26     \see m_host_management
  27   @{ */
  28 typedef enum {
  29   SIMIX_WAITING,
  30   SIMIX_READY,
  31   SIMIX_RUNNING,
  32   SIMIX_DONE,
  33   SIMIX_CANCELED,
  34   SIMIX_FAILED,
  35   SIMIX_SRC_HOST_FAILURE,
  36   SIMIX_DST_HOST_FAILURE,
  37   SIMIX_TIMEOUT,
  38   SIMIX_SRC_TIMEOUT,
  39   SIMIX_DST_TIMEOUT,
  40   SIMIX_LINK_FAILURE
  41 } e_smx_state_t;
  42 /** @} */
  43
  44 /* ******************************** Synchro ************************************ */
  45
  46 /**
  47  * \ingroup simix_synchro_management
  48  */
  49 typedef struct s_smx_cond *smx_cond_t;
  50 /**
  51  * \ingroup simix_synchro_management
  52  */
  53 typedef struct s_smx_sem *smx_sem_t;
  54
  55 /********************************** File *************************************/
  56 typedef struct s_smx_file *smx_file_t;
  57
  58 /* ****************************** Process *********************************** */
  59
  60 typedef enum {
  61   SMX_EXIT_SUCCESS = 0,
  62   SMX_EXIT_FAILURE = 1
  63 } smx_process_exit_status_t;
  64 /** @} */
  65
  66 /******************************* Networking ***********************************/
  67
  68 /* Process creation/destruction callbacks */
  69 typedef void (*void_pfn_smxprocess_t) (smx_actor_t);
  70
  71 extern int smx_context_stack_size;
  72 extern int smx_context_stack_size_was_set;
  73 extern int smx_context_guard_size;
  74 extern int smx_context_guard_size_was_set;
  75
  76 SG_BEGIN_DECL()
  77
  78 XBT_PUBLIC(xbt_dynar_t) SIMIX_process_get_runnable();
  79 XBT_PUBLIC(smx_actor_t) SIMIX_process_from_PID(aid_t PID);
  80 XBT_PUBLIC(xbt_dynar_t) SIMIX_processes_as_dynar();
  81
  82 /* parallelism */
  83 XBT_PUBLIC(int) SIMIX_context_is_parallel();
  84 XBT_PUBLIC(int) SIMIX_context_get_nthreads();
  85 XBT_PUBLIC(void) SIMIX_context_set_nthreads(int nb_threads);
  86 XBT_PUBLIC(int) SIMIX_context_get_parallel_threshold();
  87 XBT_PUBLIC(void) SIMIX_context_set_parallel_threshold(int threshold);
  88 XBT_PUBLIC(e_xbt_parmap_mode_t) SIMIX_context_get_parallel_mode();
  89 XBT_PUBLIC(void) SIMIX_context_set_parallel_mode(e_xbt_parmap_mode_t mode);
  90 XBT_PUBLIC(int) SIMIX_is_maestro();
  91
  92
  93 /********************************** Global ************************************/
  94 /* Initialization and exit */
  95 XBT_PUBLIC(void) SIMIX_global_init(int *argc, char **argv);
  96
  97 /* Set to execute in the maestro
  98  *
  99  * If no maestro code is registered (the default), the main thread
 100  * is assumed to be the maestro. */
 101 XBT_PUBLIC(void) SIMIX_set_maestro(void (*code)(void*), void* data);
 102
 103 XBT_PUBLIC(void) SIMIX_function_register_process_cleanup(void_pfn_smxprocess_t function);
 104 XBT_PUBLIC(void) SIMIX_function_register_process_kill(void_pfn_smxprocess_t function);
 105
 106 /* Simulation execution */
 107 XBT_PUBLIC(void) SIMIX_run();
 108 XBT_PUBLIC(double) SIMIX_get_clock();
 109
 110 /* Timer functions FIXME: should these be public? */
 111 typedef struct s_smx_timer* smx_timer_t;
 112
 113 XBT_PUBLIC(smx_timer_t) SIMIX_timer_set(double date, void (*function)(void*), void *arg);
 114 XBT_PUBLIC(void) SIMIX_timer_remove(smx_timer_t timer);
 115 XBT_PUBLIC(double) SIMIX_timer_next();
 116 XBT_PUBLIC(double) SIMIX_timer_get_date(smx_timer_t timer);
 117
 118 XBT_PUBLIC(void) SIMIX_display_process_status();
 119
 120 /******************************* Environment **********************************/
 121 XBT_PUBLIC(void) SIMIX_create_environment(const char *file);
 122
 123 /******************************** Deployment **********************************/
 124
 125 XBT_PUBLIC(void) SIMIX_function_register(const char *name, xbt_main_func_t code);
 126 XBT_PUBLIC(void) SIMIX_function_register_default(xbt_main_func_t code);
 127 XBT_PUBLIC(void) SIMIX_init_application();
 128 XBT_PUBLIC(void) SIMIX_launch_application(const char *file);
 129
 130 XBT_PUBLIC(void) SIMIX_process_set_function(const char* process_host,
 131                                             const char *process_function,
 132                                             xbt_dynar_t arguments,
 133                                             double process_start_time,
 134                                             double process_kill_time);
 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 XBT_PUBLIC(void) SIMIX_maestro_create(void (*code)(void*), void* data);
 146 XBT_PUBLIC(smx_actor_t) SIMIX_process_attach(
 147   const char* name,
 148   void *data,
 149   const char* hostname,
 150   xbt_dict_t properties,
 151   smx_actor_t parent_process);
 152 XBT_PUBLIC(void) SIMIX_process_detach();
 153
 154 /*********************************** Host *************************************/
 155 XBT_PUBLIC(void) SIMIX_host_off(sg_host_t host, smx_actor_t issuer);
 156 XBT_PUBLIC(void) SIMIX_host_self_set_data(void *data);
 157 XBT_PUBLIC(void*) SIMIX_host_self_get_data();
 158
 159 /********************************* Process ************************************/
 160 XBT_PUBLIC(int) SIMIX_process_count();
 161 XBT_PUBLIC(smx_actor_t) SIMIX_process_self();
 162 XBT_PUBLIC(const char*) SIMIX_process_self_get_name();
 163 XBT_PUBLIC(void) SIMIX_process_self_set_data(void *data);
 164 XBT_PUBLIC(void*) SIMIX_process_self_get_data();
 165 XBT_PUBLIC(smx_context_t) SIMIX_process_get_context(smx_actor_t process);
 166 XBT_PUBLIC(void) SIMIX_process_set_context(smx_actor_t p,smx_context_t c);
 167 XBT_PUBLIC(int) SIMIX_process_has_pending_comms(smx_actor_t process);
 168 XBT_PUBLIC(void) SIMIX_process_on_exit_runall(smx_actor_t process);
 169 XBT_PUBLIC(void) SIMIX_process_on_exit(smx_actor_t process, int_f_pvoid_pvoid_t fun, void *data);
 170
 171 SG_END_DECL()
 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(smx_activity_t) SIMIX_comm_get_send_match(smx_mailbox_t mbox, int (*match_fun)(void*, void*), void* data);
 179 XBT_PUBLIC(int) SIMIX_comm_has_send_match(smx_mailbox_t mbox, int (*match_fun)(void*, void*), void* data);
 180 XBT_PUBLIC(int) SIMIX_comm_has_recv_match(smx_mailbox_t mbox, int (*match_fun)(void*, void*), void* data);
 181 XBT_PUBLIC(void) SIMIX_comm_finish(smx_activity_t synchro);
 182
 183 /******************************************************************************/
 184 /*                            SIMIX simcalls                                  */
 185 /******************************************************************************/
 186 /* These functions are a system call-like interface to the simulation kernel. */
 187 /* They can also be called from maestro's context, and they are thread safe.  */
 188 /******************************************************************************/
 189
 190 XBT_PUBLIC(void) simcall_call(smx_actor_t process);
 191
 192 /******************************* Host simcalls ********************************/
 193 XBT_PUBLIC(void) simcall_host_set_data(sg_host_t host, void *data);
 194 XBT_PUBLIC(smx_activity_t) simcall_execution_start(const char *name,
 195                                                 double flops_amount,
 196                                                 double priority, double bound);
 197 XBT_PUBLIC(smx_activity_t)
 198 simcall_execution_parallel_start(const char* name, int host_nb, sg_host_t* host_list, double* flops_amount,
 199                                  double* bytes_amount, double amount, double rate, double timeout);
 200 XBT_PUBLIC(void) simcall_execution_cancel(smx_activity_t execution);
 201 XBT_PUBLIC(void) simcall_execution_set_priority(smx_activity_t execution, double priority);
 202 XBT_PUBLIC(void) simcall_execution_set_bound(smx_activity_t execution, double bound);
 203 XBT_PUBLIC(e_smx_state_t) simcall_execution_wait(smx_activity_t execution);
 204
 205 /**************************** Process simcalls ********************************/
 206 SG_BEGIN_DECL()
 207 /* Constructor and Destructor */
 208 XBT_PUBLIC(smx_actor_t)
 209 simcall_process_create(const char* name, xbt_main_func_t code, void* data, sg_host_t host, int argc, char** argv,
 210                        xbt_dict_t properties);
 211
 212 XBT_PUBLIC(void) simcall_process_kill(smx_actor_t process);
 213 XBT_PUBLIC(void) simcall_process_killall(int reset_pid);
 214 XBT_PUBLIC(void) SIMIX_process_throw(smx_actor_t process, xbt_errcat_t cat, int value, const char *msg);
 215
 216
 217 /* Process handling */
 218 XBT_PUBLIC(void) simcall_process_cleanup(smx_actor_t process);
 219 XBT_PUBLIC(void) simcall_process_suspend(smx_actor_t process);
 220 XBT_PUBLIC(void) simcall_process_resume(smx_actor_t process);
 221
 222 /* Getters and Setters */
 223 XBT_PUBLIC(int) simcall_process_count();
 224 XBT_PUBLIC(void) simcall_process_set_data(smx_actor_t process, void *data);
 225 XBT_PUBLIC(void) simcall_process_set_host(smx_actor_t process, sg_host_t dest);
 226 XBT_PUBLIC(int) simcall_process_is_suspended(smx_actor_t process);
 227 XBT_PUBLIC(xbt_dict_t) simcall_process_get_properties(smx_actor_t host);
 228 XBT_PUBLIC(void) simcall_process_set_kill_time(smx_actor_t process, double kill_time);
 229 XBT_PUBLIC(double) simcall_process_get_kill_time(smx_actor_t process);
 230 XBT_PUBLIC(void) simcall_process_on_exit(smx_actor_t process, int_f_pvoid_pvoid_t fun, void *data);
 231 XBT_PUBLIC(void) simcall_process_auto_restart_set(smx_actor_t process, int auto_restart);
 232 XBT_PUBLIC(smx_actor_t) simcall_process_restart(smx_actor_t process);
 233 XBT_PUBLIC(void) simcall_process_join(smx_actor_t process, double timeout);
 234 /* Sleep control */
 235 XBT_PUBLIC(e_smx_state_t) simcall_process_sleep(double duration);
 236 SG_END_DECL()
 237
 238 /************************** Comunication simcalls *****************************/
 239
 240 XBT_PUBLIC(void)
 241 simcall_comm_send(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
 242                   size_t src_buff_size, int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
 243                   void (*copy_data_fun)(smx_activity_t, void*, size_t), void* data, double timeout);
 244
 245 XBT_PUBLIC(smx_activity_t)
 246 simcall_comm_isend(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
 247                    size_t src_buff_size, int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
 248                    void (*clean_fun)(void*), void (*copy_data_fun)(smx_activity_t, void*, size_t), void* data,
 249                    int detached);
 250
 251 XBT_PUBLIC(void)
 252 simcall_comm_recv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
 253                   int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
 254                   void (*copy_data_fun)(smx_activity_t, void*, size_t), void* data, double timeout, double rate);
 255
 256 XBT_PUBLIC(smx_activity_t)
 257 simcall_comm_irecv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
 258                    int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
 259                    void (*copy_data_fun)(smx_activity_t, void*, size_t), void* data, double rate);
 260
 261 XBT_PUBLIC(smx_activity_t)
 262 simcall_comm_iprobe(smx_mailbox_t mbox, int type, int src, int tag,
 263                     int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*), void* data);
 264 XBT_PUBLIC(void) simcall_comm_cancel(smx_activity_t comm);
 265
 266 /* FIXME: waitany is going to be a vararg function, and should take a timeout */
 267 XBT_PUBLIC(unsigned int) simcall_comm_waitany(xbt_dynar_t comms, double timeout);
 268 XBT_PUBLIC(void) simcall_comm_wait(smx_activity_t comm, double timeout);
 269 XBT_PUBLIC(int) simcall_comm_test(smx_activity_t comm);
 270 XBT_PUBLIC(int) simcall_comm_testany(smx_activity_t* comms, size_t count);
 271
 272 /************************** Tracing handling **********************************/
 273 XBT_PUBLIC(void) simcall_set_category(smx_activity_t synchro, const char *category);
 274
 275 /************************** Synchro simcalls **********************************/
 276 SG_BEGIN_DECL()
 277 XBT_PUBLIC(smx_mutex_t) simcall_mutex_init();
 278 XBT_PUBLIC(smx_mutex_t) SIMIX_mutex_ref(smx_mutex_t mutex);
 279 XBT_PUBLIC(void) SIMIX_mutex_unref(smx_mutex_t mutex);
 280 XBT_PUBLIC(void) simcall_mutex_lock(smx_mutex_t mutex);
 281 XBT_PUBLIC(int) simcall_mutex_trylock(smx_mutex_t mutex);
 282 XBT_PUBLIC(void) simcall_mutex_unlock(smx_mutex_t mutex);
 283
 284 XBT_PUBLIC(smx_cond_t) simcall_cond_init();
 285 XBT_PUBLIC(void) SIMIX_cond_unref(smx_cond_t cond);
 286 XBT_PUBLIC(smx_cond_t) SIMIX_cond_ref(smx_cond_t cond);
 287 XBT_PUBLIC(void) simcall_cond_signal(smx_cond_t cond);
 288 XBT_PUBLIC(void) simcall_cond_wait(smx_cond_t cond, smx_mutex_t mutex);
 289 XBT_PUBLIC(void) simcall_cond_wait_timeout(smx_cond_t cond, smx_mutex_t mutex, double max_duration);
 290 XBT_PUBLIC(void) simcall_cond_broadcast(smx_cond_t cond);
 291
 292 XBT_PUBLIC(smx_sem_t) simcall_sem_init(int capacity);
 293 XBT_PUBLIC(void) SIMIX_sem_destroy(smx_sem_t sem);
 294 XBT_PUBLIC(void) simcall_sem_release(smx_sem_t sem);
 295 XBT_PUBLIC(int) simcall_sem_would_block(smx_sem_t sem);
 296 XBT_PUBLIC(void) simcall_sem_acquire(smx_sem_t sem);
 297 XBT_PUBLIC(void) simcall_sem_acquire_timeout(smx_sem_t sem, double max_duration);
 298 XBT_PUBLIC(int) simcall_sem_get_capacity(smx_sem_t sem);
 299
 300 /*****************************   File   **********************************/
 301 XBT_PUBLIC(void *) simcall_file_get_data(smx_file_t fd);
 302 XBT_PUBLIC(void) simcall_file_set_data(smx_file_t fd, void *data);
 303 XBT_PUBLIC(sg_size_t) simcall_file_read(smx_file_t fd, sg_size_t size, sg_host_t host);
 304 XBT_PUBLIC(sg_size_t) simcall_file_write(smx_file_t fd, sg_size_t size, sg_host_t host);
 305 XBT_PUBLIC(smx_file_t) simcall_file_open(const char* mount, const char* path, sg_storage_t st);
 306 XBT_PUBLIC(int) simcall_file_close(smx_file_t fd, sg_host_t host);
 307 XBT_PUBLIC(int) simcall_file_unlink(smx_file_t fd, sg_host_t host);
 308 XBT_PUBLIC(sg_size_t) simcall_file_get_size(smx_file_t fd);
 309 XBT_PUBLIC(sg_size_t) simcall_file_tell(smx_file_t fd);
 310 XBT_PUBLIC(int) simcall_file_seek(smx_file_t fd, sg_offset_t offset, int origin);
 311 XBT_PUBLIC(int) simcall_file_move(smx_file_t fd, const char* fullpath);
 312 /************************** MC simcalls   **********************************/
 313 XBT_PUBLIC(int) simcall_mc_random(int min, int max);
 314
 315 SG_END_DECL()
 316
 317 #endif                          /* _SIMIX_SIMIX_H */