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