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