include/simgrid/simix.h

   1 /* Copyright (c) 2007-2010, 2012-2015. The SimGrid Team.
   2  * All rights reserved.                                                     */
   3
   4 /* This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the license (GNU LGPL) which comes with this package. */
   6
   7 #ifndef _SIMIX_SIMIX_H
   8 #define _SIMIX_SIMIX_H
   9
  10 #include "simgrid/datatypes.h"
  11 #include "simgrid/host.h"
  12 #include "xbt/ex.h"
  13 #include "xbt/parmap.h"
  14
  15 #ifdef __cplusplus
  16
  17 namespace simgrid {
  18 namespace kernel {
  19 namespace context {
  20   class Context;
  21   class ContextFactory;
  22 }}
  23
  24 namespace simix {
  25
  26   /** @brief Process datatype
  27       @ingroup simix_process_management
  28
  29       A process may be defined as a <em>code</em>, with some <em>private
  30       data</em>, executing in a <em>location</em>.
  31       \see m_process_management
  32     @{ */
  33   class ActorImpl;
  34   class Mutex;
  35   class MailboxImpl;
  36 }
  37 }
  38
  39 typedef simgrid::kernel::context::Context *smx_context_t;
  40 typedef simgrid::simix::ActorImpl *smx_actor_t;
  41 typedef simgrid::simix::Mutex   *smx_mutex_t;
  42 typedef simgrid::simix::MailboxImpl* smx_mailbox_t;
  43
  44 #else
  45
  46 typedef struct s_smx_context *smx_context_t;
  47 typedef struct s_smx_actor   *smx_actor_t;
  48 typedef struct s_smx_mutex   *smx_mutex_t;
  49 typedef struct s_smx_mailbox *smx_mailbox_t;
  50
  51 #endif
  52
  53 /**************************** Scalar Values **********************************/
  54
  55 typedef union u_smx_scalar u_smx_scalar_t;
  56
  57 /* ******************************** Host ************************************ */
  58 /** @brief Host datatype
  59     @ingroup simix_host_management
  60
  61     A <em>location</em> (or <em>host</em>) is any possible place where
  62     a process may run. Thus it is represented as a <em>physical
  63     resource with computing capabilities</em>, some <em>mailboxes</em>
  64     to enable running process to communicate with remote ones, and
  65     some <em>private data</em> that can be only accessed by local
  66     process.
  67
  68     \see m_host_management
  69   @{ */
  70 typedef enum {
  71   SIMIX_WAITING,
  72   SIMIX_READY,
  73   SIMIX_RUNNING,
  74   SIMIX_DONE,
  75   SIMIX_CANCELED,
  76   SIMIX_FAILED,
  77   SIMIX_SRC_HOST_FAILURE,
  78   SIMIX_DST_HOST_FAILURE,
  79   SIMIX_TIMEOUT,
  80   SIMIX_SRC_TIMEOUT,
  81   SIMIX_DST_TIMEOUT,
  82   SIMIX_LINK_FAILURE
  83 } e_smx_state_t;
  84 /** @} */
  85
  86 /* ******************************** Synchro ************************************ */
  87
  88 /**
  89  * \ingroup simix_synchro_management
  90  */
  91 typedef struct s_smx_cond *smx_cond_t;
  92 /**
  93  * \ingroup simix_synchro_management
  94  */
  95 typedef struct s_smx_sem *smx_sem_t;
  96
  97 /********************************** File *************************************/
  98 typedef struct s_smx_file *smx_file_t;
  99
 100 /********************************** Storage *************************************/
 101 typedef xbt_dictelm_t smx_storage_t;
 102 typedef struct s_smx_storage_priv *smx_storage_priv_t;
 103
 104 /* ****************************** Process *********************************** */
 105
 106 typedef enum {
 107   SMX_EXIT_SUCCESS = 0,
 108   SMX_EXIT_FAILURE = 1
 109 } smx_process_exit_status_t;
 110 /** @} */
 111
 112 /******************************* Networking ***********************************/
 113
 114 /* Process creation/destruction callbacks */
 115 typedef void (*void_pfn_smxprocess_t) (smx_actor_t);
 116 /* for auto-restart function */
 117 typedef void (*void_pfn_sghost_t) (sg_host_t);
 118
 119 extern int smx_context_stack_size;
 120 extern int smx_context_stack_size_was_set;
 121 extern int smx_context_guard_size;
 122 extern int smx_context_guard_size_was_set;
 123
 124 SG_BEGIN_DECL()
 125
 126 XBT_PUBLIC(xbt_dynar_t) SIMIX_process_get_runnable();
 127 XBT_PUBLIC(smx_actor_t) SIMIX_process_from_PID(int PID);
 128 XBT_PUBLIC(xbt_dynar_t) SIMIX_processes_as_dynar();
 129
 130 /* parallelism */
 131 XBT_PUBLIC(int) SIMIX_context_is_parallel();
 132 XBT_PUBLIC(int) SIMIX_context_get_nthreads();
 133 XBT_PUBLIC(void) SIMIX_context_set_nthreads(int nb_threads);
 134 XBT_PUBLIC(int) SIMIX_context_get_parallel_threshold();
 135 XBT_PUBLIC(void) SIMIX_context_set_parallel_threshold(int threshold);
 136 XBT_PUBLIC(e_xbt_parmap_mode_t) SIMIX_context_get_parallel_mode();
 137 XBT_PUBLIC(void) SIMIX_context_set_parallel_mode(e_xbt_parmap_mode_t mode);
 138 XBT_PUBLIC(int) SIMIX_is_maestro();
 139
 140
 141 /********************************** Global ************************************/
 142 /* Initialization and exit */
 143 XBT_PUBLIC(void) SIMIX_global_init(int *argc, char **argv);
 144
 145 /* Set to execute in the maestro
 146  *
 147  * If no maestro code is registered (the default), the main thread
 148  * is assumed to be the maestro. */
 149 XBT_PUBLIC(void) SIMIX_set_maestro(void (*code)(void*), void* data);
 150
 151 XBT_PUBLIC(void) SIMIX_function_register_process_cleanup(void_pfn_smxprocess_t function);
 152 XBT_PUBLIC(void) SIMIX_function_register_process_kill(void_pfn_smxprocess_t function);
 153
 154 /* Simulation execution */
 155 XBT_PUBLIC(void) SIMIX_run();
 156 XBT_PUBLIC(double) SIMIX_get_clock();
 157
 158 /* Timer functions FIXME: should these be public? */
 159 typedef struct s_smx_timer* smx_timer_t;
 160
 161 XBT_PUBLIC(smx_timer_t) SIMIX_timer_set(double date, void (*function)(void*), void *arg);
 162 XBT_PUBLIC(void) SIMIX_timer_remove(smx_timer_t timer);
 163 XBT_PUBLIC(double) SIMIX_timer_next();
 164 XBT_PUBLIC(double) SIMIX_timer_get_date(smx_timer_t timer);
 165
 166 XBT_PUBLIC(void) SIMIX_display_process_status();
 167
 168 /******************************* Environment **********************************/
 169 XBT_PUBLIC(void) SIMIX_create_environment(const char *file);
 170
 171 /******************************** Deployment **********************************/
 172
 173 XBT_PUBLIC(void) SIMIX_function_register(const char *name, xbt_main_func_t code);
 174 XBT_PUBLIC(void) SIMIX_function_register_default(xbt_main_func_t code);
 175 XBT_PUBLIC(void) SIMIX_init_application();
 176 XBT_PUBLIC(void) SIMIX_launch_application(const char *file);
 177
 178 XBT_PUBLIC(void) SIMIX_process_set_function(const char* process_host,
 179                                             const char *process_function,
 180                                             xbt_dynar_t arguments,
 181                                             double process_start_time,
 182                                             double process_kill_time);
 183
 184 /*********************************** Host *************************************/
 185 /* Functions for running a process in main()
 186  *
 187  *  1. create the maestro process
 188  *  2. attach (create a context and wait for maestro to give control back to you)
 189  *  3. do you process job
 190  *  4. detach (this waits for the simulation to terminate)
 191  */
 192
 193 XBT_PUBLIC(void) SIMIX_maestro_create(void (*code)(void*), void* data);
 194 XBT_PUBLIC(smx_actor_t) SIMIX_process_attach(
 195   const char* name,
 196   void *data,
 197   const char* hostname,
 198   xbt_dict_t properties,
 199   smx_actor_t parent_process);
 200 XBT_PUBLIC(void) SIMIX_process_detach();
 201
 202 /*********************************** Host *************************************/
 203 XBT_PUBLIC(sg_host_t) SIMIX_host_self();
 204 XBT_PUBLIC(const char*) SIMIX_host_self_get_name();
 205 XBT_PUBLIC(void) SIMIX_host_off(sg_host_t host, smx_actor_t issuer);
 206 XBT_PUBLIC(void) SIMIX_host_self_set_data(void *data);
 207 XBT_PUBLIC(void*) SIMIX_host_self_get_data();
 208
 209 /********************************* Process ************************************/
 210 XBT_PUBLIC(smx_actor_t) SIMIX_process_ref(smx_actor_t process);
 211 XBT_PUBLIC(void) SIMIX_process_unref(smx_actor_t process);
 212 XBT_PUBLIC(int) SIMIX_process_count();
 213 XBT_PUBLIC(smx_actor_t) SIMIX_process_self();
 214 XBT_PUBLIC(const char*) SIMIX_process_self_get_name();
 215 XBT_PUBLIC(void) SIMIX_process_self_set_data(void *data);
 216 XBT_PUBLIC(void*) SIMIX_process_self_get_data();
 217 XBT_PUBLIC(smx_context_t) SIMIX_process_get_context(smx_actor_t process);
 218 XBT_PUBLIC(void) SIMIX_process_set_context(smx_actor_t p,smx_context_t c);
 219 XBT_PUBLIC(int) SIMIX_process_has_pending_comms(smx_actor_t process);
 220 XBT_PUBLIC(void) SIMIX_process_on_exit_runall(smx_actor_t process);
 221 XBT_PUBLIC(void) SIMIX_process_on_exit(smx_actor_t process, int_f_pvoid_pvoid_t fun, void *data);
 222
 223 /****************************** Communication *********************************/
 224 XBT_PUBLIC(void) SIMIX_comm_set_copy_data_callback(void (*callback) (smx_activity_t, void*, size_t));
 225 XBT_PUBLIC(void) SIMIX_comm_copy_pointer_callback(smx_activity_t comm, void* buff, size_t buff_size);
 226 XBT_PUBLIC(void) SIMIX_comm_copy_buffer_callback(smx_activity_t comm, void* buff, size_t buff_size);
 227
 228 XBT_PUBLIC(smx_activity_t) SIMIX_comm_get_send_match(smx_mailbox_t mbox, int (*match_fun)(void*, void*), void* data);
 229 XBT_PUBLIC(int) SIMIX_comm_has_send_match(smx_mailbox_t mbox, int (*match_fun)(void*, void*), void* data);
 230 XBT_PUBLIC(int) SIMIX_comm_has_recv_match(smx_mailbox_t mbox, int (*match_fun)(void*, void*), void* data);
 231 XBT_PUBLIC(void) SIMIX_comm_finish(smx_activity_t synchro);
 232
 233 /******************************************************************************/
 234 /*                            SIMIX simcalls                                  */
 235 /******************************************************************************/
 236 /* These functions are a system call-like interface to the simulation kernel. */
 237 /* They can also be called from maestro's context, and they are thread safe.  */
 238 /******************************************************************************/
 239
 240 XBT_PUBLIC(void) simcall_call(smx_actor_t process);
 241
 242 /******************************* Host simcalls ********************************/
 243 XBT_PUBLIC(void) simcall_host_set_data(sg_host_t host, void *data);
 244
 245 XBT_PUBLIC(smx_activity_t) simcall_execution_start(const char *name,
 246                                                 double flops_amount,
 247                                                 double priority, double bound);
 248 XBT_PUBLIC(smx_activity_t)
 249 simcall_execution_parallel_start(const char* name, int host_nb, sg_host_t* host_list, double* flops_amount,
 250                                  double* bytes_amount, double amount, double rate, double timeout);
 251 XBT_PUBLIC(void) simcall_execution_cancel(smx_activity_t execution);
 252 XBT_PUBLIC(void) simcall_execution_set_priority(smx_activity_t execution, double priority);
 253 XBT_PUBLIC(void) simcall_execution_set_bound(smx_activity_t execution, double bound);
 254 XBT_PUBLIC(e_smx_state_t) simcall_execution_wait(smx_activity_t execution);
 255
 256 /**************************** Process simcalls ********************************/
 257 /* Constructor and Destructor */
 258 XBT_PUBLIC(smx_actor_t) simcall_process_create(const char *name,
 259                                           xbt_main_func_t code,
 260                                           void *data,
 261                                           sg_host_t host,
 262                                           double kill_time,
 263                                           int argc, char **argv,
 264                                           xbt_dict_t properties,
 265                                           int auto_restart);
 266
 267 XBT_PUBLIC(void) simcall_process_kill(smx_actor_t process);
 268 XBT_PUBLIC(void) simcall_process_killall(int reset_pid);
 269 XBT_PUBLIC(void) SIMIX_process_throw(smx_actor_t process, xbt_errcat_t cat, int value, const char *msg);
 270
 271
 272 /* Process handling */
 273 XBT_PUBLIC(void) simcall_process_cleanup(smx_actor_t process);
 274 XBT_PUBLIC(void) simcall_process_suspend(smx_actor_t process);
 275 XBT_PUBLIC(void) simcall_process_resume(smx_actor_t process);
 276
 277 /* Getters and Setters */
 278 XBT_PUBLIC(int) simcall_process_count();
 279 XBT_PUBLIC(void *) simcall_process_get_data(smx_actor_t process);
 280 XBT_PUBLIC(void) simcall_process_set_data(smx_actor_t process, void *data);
 281 XBT_PUBLIC(void) simcall_process_set_host(smx_actor_t process, sg_host_t dest);
 282 XBT_PUBLIC(int) simcall_process_is_suspended(smx_actor_t process);
 283 XBT_PUBLIC(xbt_dict_t) simcall_process_get_properties(smx_actor_t host);
 284 XBT_PUBLIC(void) simcall_process_set_kill_time(smx_actor_t process, double kill_time);
 285 XBT_PUBLIC(double) simcall_process_get_kill_time(smx_actor_t process);
 286 XBT_PUBLIC(void) simcall_process_on_exit(smx_actor_t process, int_f_pvoid_pvoid_t fun, void *data);
 287 XBT_PUBLIC(void) simcall_process_auto_restart_set(smx_actor_t process, int auto_restart);
 288 XBT_PUBLIC(smx_actor_t) simcall_process_restart(smx_actor_t process);
 289 XBT_PUBLIC(void) simcall_process_join(smx_actor_t process, double timeout);
 290 /* Sleep control */
 291 XBT_PUBLIC(e_smx_state_t) simcall_process_sleep(double duration);
 292
 293 /************************** Comunication simcalls *****************************/
 294 /***** Rendez-vous points *****/
 295
 296 XBT_PUBLIC(smx_mailbox_t) simcall_mbox_create(const char *name);
 297 XBT_PUBLIC(void) simcall_mbox_set_receiver(smx_mailbox_t mbox , smx_actor_t process);
 298
 299 /***** Communication simcalls *****/
 300
 301 XBT_PUBLIC(void) simcall_comm_send(smx_actor_t sender, smx_mailbox_t mbox, double task_size,
 302                                      double rate, void *src_buff,
 303                                      size_t src_buff_size,
 304                                      int (*match_fun)(void *, void *, smx_activity_t),
 305                                      void (*copy_data_fun)(smx_activity_t, void*, size_t),
 306                                      void *data, double timeout);
 307
 308 XBT_PUBLIC(smx_activity_t) simcall_comm_isend(smx_actor_t sender, smx_mailbox_t mbox,
 309                                               double task_size,
 310                                               double rate, void *src_buff,
 311                                               size_t src_buff_size,
 312                                               int (*match_fun)(void *, void *, smx_activity_t),
 313                                               void (*clean_fun)(void *),
 314                                               void (*copy_data_fun)(smx_activity_t, void*, size_t),
 315                                               void *data, int detached);
 316
 317 XBT_PUBLIC(void) simcall_comm_recv(smx_actor_t receiver, smx_mailbox_t mbox, void *dst_buff,
 318                                    size_t * dst_buff_size,
 319                                    int (*match_fun)(void *, void *, smx_activity_t),
 320                                    void (*copy_data_fun)(smx_activity_t, void*, size_t),
 321                                    void *data, double timeout, double rate);
 322
 323 XBT_PUBLIC(smx_activity_t) simcall_comm_irecv(smx_actor_t receiver, smx_mailbox_t mbox, void *dst_buff,
 324                                             size_t * dst_buff_size,
 325                                             int (*match_fun)(void *, void *, smx_activity_t),
 326                                             void (*copy_data_fun)(smx_activity_t, void*, size_t),
 327                                             void *data, double rate);
 328
 329 XBT_PUBLIC(smx_activity_t) simcall_comm_iprobe(smx_mailbox_t mbox, int type, int src, int tag,
 330                                 int (*match_fun)(void *, void *, smx_activity_t), void *data);
 331 XBT_PUBLIC(void) simcall_comm_cancel(smx_activity_t comm);
 332
 333 /* FIXME: waitany is going to be a vararg function, and should take a timeout */
 334 XBT_PUBLIC(unsigned int) simcall_comm_waitany(xbt_dynar_t comms, double timeout);
 335 XBT_PUBLIC(void) simcall_comm_wait(smx_activity_t comm, double timeout);
 336 XBT_PUBLIC(int) simcall_comm_test(smx_activity_t comm);
 337 XBT_PUBLIC(int) simcall_comm_testany(smx_activity_t* comms, size_t count);
 338
 339 /************************** Tracing handling **********************************/
 340 XBT_PUBLIC(void) simcall_set_category(smx_activity_t synchro, const char *category);
 341
 342 /************************** Synchro simcalls **********************************/
 343 XBT_PUBLIC(smx_mutex_t) simcall_mutex_init();
 344 XBT_PUBLIC(smx_mutex_t) SIMIX_mutex_ref(smx_mutex_t mutex);
 345 XBT_PUBLIC(void) SIMIX_mutex_unref(smx_mutex_t mutex);
 346 XBT_PUBLIC(void) simcall_mutex_lock(smx_mutex_t mutex);
 347 XBT_PUBLIC(int) simcall_mutex_trylock(smx_mutex_t mutex);
 348 XBT_PUBLIC(void) simcall_mutex_unlock(smx_mutex_t mutex);
 349
 350 XBT_PUBLIC(smx_cond_t) simcall_cond_init();
 351 XBT_PUBLIC(void) SIMIX_cond_unref(smx_cond_t cond);
 352 XBT_PUBLIC(smx_cond_t) SIMIX_cond_ref(smx_cond_t cond);
 353 XBT_PUBLIC(void) simcall_cond_signal(smx_cond_t cond);
 354 XBT_PUBLIC(void) simcall_cond_wait(smx_cond_t cond, smx_mutex_t mutex);
 355 XBT_PUBLIC(void) simcall_cond_wait_timeout(smx_cond_t cond, smx_mutex_t mutex, double max_duration);
 356 XBT_PUBLIC(void) simcall_cond_broadcast(smx_cond_t cond);
 357
 358 XBT_PUBLIC(smx_sem_t) simcall_sem_init(int capacity);
 359 XBT_PUBLIC(void) SIMIX_sem_destroy(smx_sem_t sem);
 360 XBT_PUBLIC(void) simcall_sem_release(smx_sem_t sem);
 361 XBT_PUBLIC(int) simcall_sem_would_block(smx_sem_t sem);
 362 XBT_PUBLIC(void) simcall_sem_acquire(smx_sem_t sem);
 363 XBT_PUBLIC(void) simcall_sem_acquire_timeout(smx_sem_t sem, double max_duration);
 364 XBT_PUBLIC(int) simcall_sem_get_capacity(smx_sem_t sem);
 365
 366 /*****************************   File   **********************************/
 367 XBT_PUBLIC(void *) simcall_file_get_data(smx_file_t fd);
 368 XBT_PUBLIC(void) simcall_file_set_data(smx_file_t fd, void *data);
 369 XBT_PUBLIC(sg_size_t) simcall_file_read(smx_file_t fd, sg_size_t size, sg_host_t host);
 370 XBT_PUBLIC(sg_size_t) simcall_file_write(smx_file_t fd, sg_size_t size, sg_host_t host);
 371 XBT_PUBLIC(smx_file_t) simcall_file_open(const char* fullpath, sg_host_t host);
 372 XBT_PUBLIC(int) simcall_file_close(smx_file_t fd, sg_host_t host);
 373 XBT_PUBLIC(int) simcall_file_unlink(smx_file_t fd, sg_host_t host);
 374 XBT_PUBLIC(sg_size_t) simcall_file_get_size(smx_file_t fd);
 375 XBT_PUBLIC(xbt_dynar_t) simcall_file_get_info(smx_file_t fd);
 376 XBT_PUBLIC(sg_size_t) simcall_file_tell(smx_file_t fd);
 377 XBT_PUBLIC(int) simcall_file_seek(smx_file_t fd, sg_offset_t offset, int origin);
 378 XBT_PUBLIC(int) simcall_file_move(smx_file_t fd, const char* fullpath);
 379 /*****************************   Storage   **********************************/
 380 XBT_PUBLIC(sg_size_t) simcall_storage_get_free_size (smx_storage_t storage);
 381 XBT_PUBLIC(sg_size_t) simcall_storage_get_used_size (smx_storage_t storage);
 382 XBT_PUBLIC(xbt_dict_t) simcall_storage_get_properties(smx_storage_t storage);
 383 XBT_PUBLIC(void*) SIMIX_storage_get_data(smx_storage_t storage);
 384 XBT_PUBLIC(void) SIMIX_storage_set_data(smx_storage_t storage, void *data);
 385 XBT_PUBLIC(xbt_dict_t) SIMIX_storage_get_content(smx_storage_t storage);
 386 XBT_PUBLIC(xbt_dict_t) simcall_storage_get_content(smx_storage_t storage);
 387 XBT_PUBLIC(const char*) SIMIX_storage_get_name(smx_storage_t storage);
 388 XBT_PUBLIC(sg_size_t) SIMIX_storage_get_size(smx_storage_t storage);
 389 XBT_PUBLIC(const char*) SIMIX_storage_get_host(smx_storage_t storage);
 390
 391 /************************** MC simcalls   **********************************/
 392 XBT_PUBLIC(int) simcall_mc_random(int min, int max);
 393
 394 SG_END_DECL()
 395 #endif                          /* _SIMIX_SIMIX_H */