src/include/simix/simix.h

   1 /* Copyright (c) 2007, 2008, 2009, 2010. 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 "simix/datatypes.h"
  15 #include "surf/surf.h"
  16
  17 SG_BEGIN_DECL()
  18
  19
  20 /************************** Global ******************************************/
  21 XBT_PUBLIC(void) SIMIX_global_init(int *argc, char **argv);
  22 XBT_PUBLIC(void) SIMIX_clean(void);
  23 XBT_PUBLIC(void) SIMIX_function_register(const char *name,
  24                                          xbt_main_func_t code);
  25 XBT_PUBLIC(void) SIMIX_function_register_default(xbt_main_func_t code);
  26 XBT_PUBLIC(xbt_main_func_t) SIMIX_get_registered_function(const char
  27                                                           *name);
  28
  29 XBT_PUBLIC(void) SIMIX_launch_application(const char *file);
  30
  31 /*
  32  *  Deployment (Bypass the parser)
  33  */
  34 XBT_PUBLIC(void) SIMIX_process_set_function(const char *process_host,
  35                                             const char *process_function,
  36                                             xbt_dynar_t arguments,
  37                                             double process_start_time,
  38                                             double process_kill_time);
  39
  40
  41 XBT_PUBLIC(double) SIMIX_get_clock(void);
  42 XBT_PUBLIC(void) SIMIX_init(void);
  43 XBT_PUBLIC(double) SIMIX_solve(xbt_fifo_t actions_done,
  44                                xbt_fifo_t actions_failed);
  45
  46 /* Timer functions */
  47 XBT_PUBLIC(void) SIMIX_timer_set(double date, void *function, void *arg);
  48 XBT_PUBLIC(int) SIMIX_timer_get(void **function, void **arg);
  49
  50 /* only for tests */
  51 XBT_PUBLIC(void) __SIMIX_main(void);
  52
  53 /* User create and kill process, the function must accept the folling parameters:
  54  * const char *name: a name for the object. It is for user-level information and can be NULL
  55  * xbt_main_func_t code: is a function describing the behavior of the agent
  56  * void *data: data a pointer to any data one may want to attach to the new object.
  57  * smx_host_t host: the location where the new agent is executed
  58  * int argc, char **argv: parameters passed to code
  59  *
  60  * */
  61 typedef void *(*smx_creation_func_t) ( /*name */ const char *,
  62                                       /*code */ xbt_main_func_t,
  63                                       /*userdata */ void *,
  64                                       /*hostname */ char *,
  65                                       /* argc */ int,
  66                                       /* argv */ char **,
  67                                       /* props */ xbt_dict_t);
  68 XBT_PUBLIC(void) SIMIX_function_register_process_create(smx_creation_func_t
  69                                                         function);
  70 XBT_PUBLIC(void) SIMIX_function_register_process_kill(void_f_pvoid_t
  71                                                       function);
  72 XBT_PUBLIC(void) SIMIX_function_register_process_cleanup(void_f_pvoid_t
  73                                                          function);
  74
  75 /************************** Host handling ***********************************/
  76
  77 XBT_PUBLIC(void) SIMIX_host_set_data(smx_host_t host, void *data);
  78 XBT_PUBLIC(void *) SIMIX_host_get_data(smx_host_t host);
  79
  80 XBT_PUBLIC(const char *) SIMIX_host_get_name(smx_host_t host);
  81 XBT_PUBLIC(void) SIMIX_process_set_name(smx_process_t process, char *name);
  82 XBT_PUBLIC(smx_host_t) SIMIX_host_self(void);
  83 XBT_PUBLIC(double) SIMIX_host_get_speed(smx_host_t host);
  84 XBT_PUBLIC(double) SIMIX_host_get_available_speed(smx_host_t host);
  85
  86 XBT_PUBLIC(int) SIMIX_host_get_number(void);
  87 XBT_PUBLIC(smx_host_t *) SIMIX_host_get_table(void);
  88 XBT_PUBLIC(xbt_dict_t) SIMIX_host_get_dict(void);
  89
  90 XBT_PUBLIC(void) SIMIX_create_environment(const char *file);
  91 XBT_INLINE XBT_PUBLIC(smx_host_t) SIMIX_host_get_by_name(const char *name);
  92
  93 XBT_PUBLIC(xbt_dict_t) SIMIX_host_get_properties(smx_host_t host);
  94
  95 /* Two possible states, 1 - CPU ON and 0 CPU OFF */
  96 XBT_PUBLIC(int) SIMIX_host_get_state(smx_host_t host);
  97
  98 /************************** Process handling *********************************/
  99 XBT_PUBLIC(smx_process_t) SIMIX_process_create(const char *name,
 100                                                xbt_main_func_t code,
 101                                                void *data,
 102                                                const char *hostname,
 103                                                int argc, char **argv,
 104                                                xbt_dict_t properties);
 105
 106 XBT_PUBLIC(void) SIMIX_process_kill(smx_process_t process);
 107 XBT_PUBLIC(void) SIMIX_process_cleanup(void *arg);
 108 XBT_PUBLIC(void) SIMIX_process_killall(void);
 109 XBT_PUBLIC(void) SIMIX_process_change_host(smx_process_t process,
 110                                            char *source, char *dest);
 111
 112 //above layer
 113 XBT_PUBLIC(void *) SIMIX_process_get_data(smx_process_t process);
 114 XBT_PUBLIC(void) SIMIX_process_set_data(smx_process_t process, void *data);
 115
 116 XBT_INLINE XBT_PUBLIC(smx_host_t) SIMIX_process_get_host(smx_process_t
 117                                                          process);
 118 XBT_PUBLIC(const char *) SIMIX_process_get_name(smx_process_t process);
 119 XBT_INLINE XBT_PUBLIC(smx_process_t) SIMIX_process_self(void);
 120
 121 XBT_PUBLIC(void) SIMIX_process_yield(void);
 122 XBT_PUBLIC(void) SIMIX_process_suspend(smx_process_t process);
 123 XBT_PUBLIC(void) SIMIX_process_resume(smx_process_t process);
 124 XBT_PUBLIC(int) SIMIX_process_is_suspended(smx_process_t process);
 125 XBT_PUBLIC(int) SIMIX_process_is_blocked(smx_process_t process);
 126
 127 /*property handlers*/
 128 XBT_PUBLIC(xbt_dict_t) SIMIX_process_get_properties(smx_process_t host);
 129 XBT_PUBLIC(int) SIMIX_process_count(void);
 130
 131 /************************** Synchro handling **********************************/
 132
 133 /******Mutex******/
 134 XBT_PUBLIC(smx_mutex_t) SIMIX_mutex_init(void);
 135 XBT_PUBLIC(void) SIMIX_mutex_lock(smx_mutex_t mutex);
 136 XBT_PUBLIC(int) SIMIX_mutex_trylock(smx_mutex_t mutex);
 137 XBT_PUBLIC(void) SIMIX_mutex_unlock(smx_mutex_t mutex);
 138 XBT_PUBLIC(void) SIMIX_mutex_destroy(smx_mutex_t mutex);
 139
 140 /*****Conditional*****/
 141 XBT_PUBLIC(smx_cond_t) SIMIX_cond_init(void);
 142 XBT_PUBLIC(void) SIMIX_cond_signal(smx_cond_t cond);
 143 XBT_PUBLIC(void) SIMIX_cond_wait(smx_cond_t cond, smx_mutex_t mutex);
 144 XBT_PUBLIC(void) SIMIX_cond_wait_timeout(smx_cond_t cond,
 145                                          smx_mutex_t mutex,
 146                                          double max_duration);
 147 XBT_PUBLIC(void) SIMIX_cond_broadcast(smx_cond_t cond);
 148 XBT_PUBLIC(void) SIMIX_cond_destroy(smx_cond_t cond);
 149 XBT_PUBLIC(xbt_fifo_t) SIMIX_cond_get_actions(smx_cond_t cond);
 150 XBT_PUBLIC(void) SIMIX_cond_display_info(smx_cond_t cond);
 151
 152 /*****Semaphores*******/
 153
 154
 155 XBT_PUBLIC(smx_sem_t) SIMIX_sem_init(int capacity);
 156 XBT_PUBLIC(void) SIMIX_sem_destroy(smx_sem_t sem);
 157 XBT_PUBLIC(void) SIMIX_sem_release(smx_sem_t sem);
 158 XBT_PUBLIC(void) SIMIX_sem_release_forever(smx_sem_t sem);
 159 XBT_PUBLIC(int) SIMIX_sem_would_block(smx_sem_t sem);
 160 XBT_PUBLIC(void) SIMIX_sem_block_onto(smx_sem_t sem);
 161 XBT_PUBLIC(void) SIMIX_sem_acquire(smx_sem_t sem);
 162 XBT_PUBLIC(void) SIMIX_sem_acquire_timeout(smx_sem_t sem,
 163                                            double max_duration);
 164 XBT_PUBLIC(unsigned int) SIMIX_sem_acquire_any(xbt_dynar_t sems);
 165 XBT_PUBLIC(int) SIMIX_sem_get_capacity(smx_sem_t sem);
 166
 167
 168 /************************** Action handling ************************************/
 169 XBT_PUBLIC(smx_action_t) SIMIX_action_communicate(smx_host_t sender,
 170                                                   smx_host_t receiver,
 171                                                   const char *name,
 172                                                   double size,
 173                                                   double rate);
 174 XBT_PUBLIC(smx_action_t) SIMIX_action_execute(smx_host_t host,
 175                                               const char *name,
 176                                               double amount);
 177 XBT_PUBLIC(smx_action_t) SIMIX_action_sleep(smx_host_t host,
 178                                             double amount);
 179 XBT_PUBLIC(void) SIMIX_action_cancel(smx_action_t action);
 180 XBT_PUBLIC(void) SIMIX_action_set_priority(smx_action_t action,
 181                                            double priority);
 182 XBT_PUBLIC(void) SIMIX_action_resume(smx_action_t action);
 183 XBT_PUBLIC(void) SIMIX_action_suspend(smx_action_t action);
 184 XBT_PUBLIC(int) SIMIX_action_destroy(smx_action_t action);
 185 XBT_PUBLIC(void) SIMIX_action_use(smx_action_t action);
 186 XBT_PUBLIC(void) SIMIX_action_release(smx_action_t action);
 187
 188 XBT_PUBLIC(void) SIMIX_register_action_to_condition(smx_action_t action,
 189                                                     smx_cond_t cond);
 190 XBT_PUBLIC(void) SIMIX_unregister_action_to_condition(smx_action_t action,
 191                                                       smx_cond_t cond);
 192 XBT_PUBLIC(void) SIMIX_register_action_to_semaphore(smx_action_t action,
 193                                                     smx_sem_t sem);
 194 XBT_INLINE XBT_PUBLIC(void)
 195 SIMIX_unregister_action_to_semaphore(smx_action_t action, smx_sem_t sem);
 196
 197
 198 XBT_PUBLIC(double) SIMIX_action_get_remains(smx_action_t action);
 199 #ifdef HAVE_LATENCY_BOUND_TRACKING
 200 XBT_PUBLIC(int) SIMIX_action_is_latency_bounded(smx_action_t action);
 201 #endif
 202
 203 XBT_PUBLIC(e_surf_action_state_t) SIMIX_action_get_state(smx_action_t
 204                                                          action);
 205
 206 XBT_PUBLIC(smx_action_t) SIMIX_action_parallel_execute(char *name,
 207                                                        int host_nb,
 208                                                        smx_host_t *
 209                                                        host_list, double
 210                                                        *computation_amount, double
 211                                                        *communication_amount,
 212                                                        double amount,
 213                                                        double rate);
 214
 215 XBT_PUBLIC(char *) SIMIX_action_get_name(smx_action_t action);
 216 XBT_PUBLIC(void) SIMIX_action_set_name(smx_action_t action, char *name);
 217 XBT_PUBLIC(void) SIMIX_action_signal_all(smx_action_t action);
 218 XBT_PUBLIC(void) SIMIX_display_process_status(void);
 219 /************************** Comunication Handling *****************************/
 220
 221 /* Public */
 222 /*****Rendez-vous points*****/
 223 XBT_PUBLIC(smx_rdv_t) SIMIX_rdv_create(const char *name);
 224 XBT_PUBLIC(void) SIMIX_rdv_destroy(smx_rdv_t rvp);
 225 XBT_PUBLIC(int) SIMIX_rdv_get_count_waiting_comm(smx_rdv_t rdv,
 226                                                  smx_host_t host);
 227 XBT_PUBLIC(smx_comm_t) SIMIX_rdv_get_head(smx_rdv_t rdv);
 228 XBT_PUBLIC(smx_comm_t) SIMIX_rdv_get_request(smx_rdv_t rdv,
 229                                              smx_comm_type_t type);
 230 XBT_PUBLIC(void) SIMIX_rdv_set_data(smx_rdv_t rdv, void *data);
 231 XBT_PUBLIC(void *) SIMIX_rdv_get_data(smx_rdv_t rdv);
 232
 233 /*****Communication Requests*****/
 234 XBT_INLINE XBT_PUBLIC(void) SIMIX_communication_cancel(smx_comm_t comm);
 235 XBT_PUBLIC(void) SIMIX_communication_destroy(smx_comm_t comm);
 236 XBT_PUBLIC(double) SIMIX_communication_get_remains(smx_comm_t comm);
 237 #ifdef HAVE_LATENCY_BOUND_TRACKING
 238 XBT_PUBLIC(int) SIMIX_communication_is_latency_bounded(smx_comm_t comm);
 239 #endif
 240 XBT_PUBLIC(void *) SIMIX_communication_get_data(smx_comm_t comm);
 241
 242 XBT_PUBLIC(void *) SIMIX_communication_get_src_buf(smx_comm_t comm);
 243 XBT_PUBLIC(void *) SIMIX_communication_get_dst_buf(smx_comm_t comm);
 244 XBT_PUBLIC(size_t) SIMIX_communication_get_src_buf_size(smx_comm_t comm);
 245 XBT_PUBLIC(size_t) SIMIX_communication_get_dst_buf_size(smx_comm_t comm);
 246
 247 /*****Networking*****/
 248 XBT_PUBLIC(void) SIMIX_network_set_copy_data_callback(void (*callback)
 249                                                        (smx_comm_t,
 250                                                         size_t));
 251 XBT_PUBLIC(void) SIMIX_network_copy_pointer_callback(smx_comm_t comm,
 252                                                      size_t buff_size);
 253 XBT_PUBLIC(void) SIMIX_network_copy_buffer_callback(smx_comm_t comm,
 254                                                     size_t buff_size);
 255 XBT_PUBLIC(void) SIMIX_network_send(smx_rdv_t rdv, double task_size,
 256                                     double rate, double timeout,
 257                                     void *src_buff, size_t src_buff_size,
 258                                     smx_comm_t * comm, void *data);
 259 XBT_PUBLIC(void) SIMIX_network_recv(smx_rdv_t rdv, double timeout,
 260                                     void *dst_buff, size_t * dst_buff_size,
 261                                     smx_comm_t * comm);
 262 XBT_PUBLIC(smx_comm_t) SIMIX_network_isend(smx_rdv_t rdv, double task_size,
 263                                            double rate, void *src_buff,
 264                                            size_t src_buff_size,
 265                                            void *data);
 266 XBT_PUBLIC(smx_comm_t) SIMIX_network_irecv(smx_rdv_t rdv, void *dst_buff,
 267                                            size_t * dst_buff_size);
 268 XBT_PUBLIC(unsigned int) SIMIX_network_waitany(xbt_dynar_t comms);
 269 XBT_INLINE XBT_PUBLIC(void) SIMIX_network_wait(smx_comm_t comm,
 270                                                double timeout);
 271 XBT_PUBLIC(int) SIMIX_network_test(smx_comm_t comm);
 272
 273 SG_END_DECL()
 274 #endif                          /* _SIMIX_SIMIX_H */