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