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 "simix/context.h"
  16
  17 SG_BEGIN_DECL()
  18
  19 /********************************** Global ************************************/
  20 /* Initialization and exit */
  21 XBT_PUBLIC(void) SIMIX_global_init(int *argc, char **argv);
  22 XBT_PUBLIC(void) SIMIX_clean(void);
  23
  24
  25 XBT_PUBLIC(void) SIMIX_function_register_process_cleanup(void_pfn_smxprocess_t function);
  26 XBT_PUBLIC(void) SIMIX_function_register_process_create(smx_creation_func_t function);
  27 XBT_PUBLIC(void) SIMIX_function_register_process_kill(void_pfn_smxprocess_t function);
  28
  29 /* Simulation execution */
  30 XBT_PUBLIC(void) SIMIX_run(void);
  31
  32 /* Timer functions FIXME: should these be public? */
  33 XBT_PUBLIC(void) SIMIX_timer_set(double date, void *function, void *arg);
  34 XBT_PUBLIC(double) SIMIX_timer_next(void);
  35
  36 XBT_PUBLIC(void) SIMIX_display_process_status(void);
  37
  38 /******************************* Environment **********************************/
  39 XBT_PUBLIC(void) SIMIX_create_environment(const char *file);
  40
  41 /******************************** Deployment **********************************/
  42
  43 XBT_PUBLIC(void) SIMIX_function_register(const char *name, xbt_main_func_t code);
  44 XBT_PUBLIC(void) SIMIX_function_register_default(xbt_main_func_t code);
  45 XBT_PUBLIC(xbt_main_func_t) SIMIX_get_registered_function(const char *name);
  46 XBT_PUBLIC(void) SIMIX_launch_application(const char *file);
  47 XBT_PUBLIC(void) SIMIX_process_set_function(const char* process_host,
  48                                             const char *process_function,
  49                                             xbt_dynar_t arguments,
  50                                             double process_start_time,
  51                                             double process_kill_time);
  52
  53 /*********************************** Host *************************************/
  54 XBT_PUBLIC(xbt_dict_t) SIMIX_host_get_dict(void);
  55 XBT_PUBLIC(smx_host_t) SIMIX_host_get_by_name(const char *name);
  56 XBT_PUBLIC(smx_host_t) SIMIX_host_self(void);
  57 XBT_PUBLIC(const char*) SIMIX_host_self_get_name(void);
  58 XBT_PUBLIC(const char*) SIMIX_host_get_name(smx_host_t host); /* FIXME: make private: only the name of SIMIX_host_self() should be public without request */
  59 XBT_PUBLIC(void) SIMIX_host_self_set_data(void *data);
  60 XBT_PUBLIC(void*) SIMIX_host_self_get_data(void);
  61
  62 /********************************* Process ************************************/
  63 XBT_PUBLIC(int) SIMIX_process_count(void);
  64 XBT_INLINE XBT_PUBLIC(smx_process_t) SIMIX_process_self(void);
  65 XBT_PUBLIC(const char*) SIMIX_process_self_get_name(void);
  66 XBT_PUBLIC(void) SIMIX_process_self_set_data(void *data);
  67 XBT_PUBLIC(void*) SIMIX_process_self_get_data(void);
  68 XBT_PUBLIC(smx_context_t) SIMIX_process_get_context(smx_process_t);
  69 XBT_PUBLIC(void) SIMIX_process_set_context(smx_process_t p,smx_context_t c);
  70
  71 /****************************** Communication *********************************/
  72 XBT_PUBLIC(void) SIMIX_comm_set_copy_data_callback(void (*callback) (smx_action_t, size_t));
  73 XBT_PUBLIC(void) SIMIX_comm_copy_pointer_callback(smx_action_t comm, size_t buff_size);
  74 XBT_PUBLIC(void) SIMIX_comm_copy_buffer_callback(smx_action_t comm, size_t buff_size);
  75 XBT_PUBLIC(smx_action_t) SIMIX_comm_get_send_match(smx_rdv_t rdv, int (*match_fun)(void*, void*), void* data);
  76 XBT_PUBLIC(void) SIMIX_comm_finish(smx_action_t action);
  77
  78 /******************************************************************************/
  79 /*                        SIMIX Smurf Proxy Functions                         */
  80 /******************************************************************************/
  81 /* These functions issue request through the Smurf proxy.                     */
  82 /* They cannot be called from maestro's context, and they are thread safe.    */
  83 /******************************************************************************/
  84
  85 XBT_INLINE XBT_PUBLIC(double) SIMIX_get_clock(void);
  86
  87 /******************************* Host Requests ********************************/
  88 /* FIXME: use handlers and keep smx_host_t hidden from higher levels */
  89 XBT_PUBLIC(xbt_dict_t) SIMIX_req_host_get_dict(void);
  90 XBT_INLINE XBT_PUBLIC(smx_host_t) SIMIX_req_host_get_by_name(const char *name);
  91 XBT_PUBLIC(const char *) SIMIX_req_host_get_name(smx_host_t host);
  92 XBT_PUBLIC(xbt_dict_t) SIMIX_req_host_get_properties(smx_host_t host);
  93 XBT_PUBLIC(double) SIMIX_req_host_get_speed(smx_host_t host);
  94 XBT_PUBLIC(double) SIMIX_req_host_get_available_speed(smx_host_t host);
  95 /* Two possible states, 1 - CPU ON and 0 CPU OFF */
  96 XBT_PUBLIC(int) SIMIX_req_host_get_state(smx_host_t host);
  97 XBT_PUBLIC(void *) SIMIX_req_host_get_data(smx_host_t host);
  98
  99 XBT_PUBLIC(void) SIMIX_req_host_set_data(smx_host_t host, void *data);
 100
 101 XBT_PUBLIC(smx_action_t) SIMIX_req_host_execute(const char *name, smx_host_t host,
 102                                                 double computation_amount,
 103                                                 double priority);
 104 XBT_PUBLIC(smx_action_t) SIMIX_req_host_parallel_execute(const char *name,
 105                                                      int host_nb,
 106                                                      smx_host_t *host_list,
 107                                                      double *computation_amount,
 108                                                      double *communication_amount,
 109                                                      double amount,
 110                                                      double rate);
 111 XBT_PUBLIC(void) SIMIX_req_host_execution_destroy(smx_action_t execution);
 112 XBT_PUBLIC(void) SIMIX_req_host_execution_cancel(smx_action_t execution);
 113 XBT_PUBLIC(double) SIMIX_req_host_execution_get_remains(smx_action_t execution);
 114 XBT_PUBLIC(e_smx_state_t) SIMIX_req_host_execution_get_state(smx_action_t execution);
 115 XBT_PUBLIC(void) SIMIX_req_host_execution_set_priority(smx_action_t execution, double priority);
 116 XBT_PUBLIC(e_smx_state_t) SIMIX_req_host_execution_wait(smx_action_t execution);
 117
 118
 119 /**************************** Process Requests ********************************/
 120 /* Constructor and Destructor */
 121 XBT_PUBLIC(void) SIMIX_req_process_create(smx_process_t *process,
 122                                           const char *name,
 123                                           xbt_main_func_t code,
 124                                           void *data,
 125                                           const char *hostname,
 126                                           int argc, char **argv,
 127                                           xbt_dict_t properties);
 128
 129 XBT_PUBLIC(void) SIMIX_req_process_kill(smx_process_t process);
 130 XBT_PUBLIC(void) SIMIX_req_process_killall(void);
 131
 132 /* Process handling */
 133 XBT_PUBLIC(void) SIMIX_req_process_cleanup(smx_process_t process);
 134 XBT_PUBLIC(void) SIMIX_req_process_change_host(smx_process_t process,
 135                                            const char *source, const char *dest);
 136 XBT_PUBLIC(void) SIMIX_req_process_suspend(smx_process_t process);
 137 XBT_PUBLIC(void) SIMIX_req_process_resume(smx_process_t process);
 138
 139 /* Getters and Setters */
 140 XBT_PUBLIC(int) SIMIX_req_process_count(void);
 141 XBT_PUBLIC(void *) SIMIX_req_process_get_data(smx_process_t process);
 142 XBT_PUBLIC(void) SIMIX_req_process_set_data(smx_process_t process, void *data);
 143 XBT_INLINE XBT_PUBLIC(smx_host_t) SIMIX_req_process_get_host(smx_process_t process);
 144 XBT_PUBLIC(const char *) SIMIX_req_process_get_name(smx_process_t process);
 145 XBT_PUBLIC(int) SIMIX_req_process_is_suspended(smx_process_t process);
 146 XBT_PUBLIC(xbt_dict_t) SIMIX_req_process_get_properties(smx_process_t host);
 147
 148 /* Sleep control */
 149 XBT_PUBLIC(e_smx_state_t) SIMIX_req_process_sleep(double duration);
 150
 151 /************************** Comunication Requests *****************************/
 152 /***** Rendez-vous points *****/
 153 XBT_PUBLIC(smx_rdv_t) SIMIX_req_rdv_create(const char *name);
 154 XBT_PUBLIC(void) SIMIX_req_rdv_destroy(smx_rdv_t rvp);
 155 XBT_PUBLIC(smx_rdv_t) SIMIX_req_rdv_get_by_name(const char *name);
 156 XBT_PUBLIC(int) SIMIX_req_rdv_comm_count_by_host(smx_rdv_t rdv, smx_host_t host);
 157 XBT_PUBLIC(smx_action_t) SIMIX_req_rdv_get_head(smx_rdv_t rdv);
 158
 159 /***** Communication Requests *****/
 160
 161 XBT_PUBLIC(void) SIMIX_req_comm_send(smx_rdv_t rdv, double task_size,
 162                                      double rate, void *src_buff,
 163                                      size_t src_buff_size,
 164                                      int (*match_fun)(void *, void *),
 165                                      void *data, double timeout);
 166
 167 XBT_PUBLIC(smx_action_t) SIMIX_req_comm_isend(smx_rdv_t rdv, double task_size,
 168                                               double rate, void *src_buff,
 169                                               size_t src_buff_size,
 170                                               int (*match_fun)(void *, void *),
 171                                               void *data, int detached);
 172
 173 XBT_PUBLIC(void) SIMIX_req_comm_recv(smx_rdv_t rdv, void *dst_buff,
 174                                      size_t * dst_buff_size,
 175                                      int (*match_fun)(void *, void *),
 176                                      void *data, double timeout);
 177
 178 XBT_PUBLIC(smx_action_t) SIMIX_req_comm_irecv(smx_rdv_t rdv, void *dst_buff,
 179                                               size_t * dst_buff_size,
 180                                               int (*match_fun)(void *, void *),
 181                                               void *data);
 182
 183 XBT_PUBLIC(void) SIMIX_req_comm_destroy(smx_action_t comm);
 184
 185 XBT_INLINE XBT_PUBLIC(void) SIMIX_req_comm_cancel(smx_action_t comm);
 186
 187 /* FIXME: waitany is going to be a vararg function, and should take a timeout */
 188 XBT_PUBLIC(unsigned int) SIMIX_req_comm_waitany(xbt_dynar_t comms);
 189 XBT_PUBLIC(void) SIMIX_req_comm_wait(smx_action_t comm, double timeout);
 190 XBT_PUBLIC(int) SIMIX_req_comm_test(smx_action_t comm);
 191 XBT_PUBLIC(int) SIMIX_req_comm_testany(xbt_dynar_t comms);
 192
 193 /* Getters and setters */
 194 XBT_PUBLIC(double) SIMIX_req_comm_get_remains(smx_action_t comm);
 195 XBT_PUBLIC(e_smx_state_t) SIMIX_req_comm_get_state(smx_action_t comm);
 196 XBT_PUBLIC(void *) SIMIX_req_comm_get_src_data(smx_action_t comm);
 197 XBT_PUBLIC(void *) SIMIX_req_comm_get_dst_data(smx_action_t comm);
 198 XBT_PUBLIC(smx_process_t) SIMIX_req_comm_get_src_proc(smx_action_t comm);
 199 XBT_PUBLIC(smx_process_t) SIMIX_req_comm_get_dst_proc(smx_action_t comm);
 200 XBT_PUBLIC(void) SIMIX_req_comm_set_copy_data_callback(void (*callback)(smx_action_t,size_t));
 201 XBT_PUBLIC(void) SIMIX_req_comm_copy_pointer_callback(smx_action_t comm, size_t buff_size);
 202 XBT_PUBLIC(void) SIMIX_req_comm_copy_buffer_callback(smx_action_t comm, size_t buff_size);
 203
 204 #ifdef HAVE_LATENCY_BOUND_TRACKING
 205 XBT_PUBLIC(int) SIMIX_req_comm_is_latency_bounded(smx_action_t comm);
 206 #endif
 207
 208 #ifdef HAVE_TRACING
 209 /************************** Tracing handling **********************************/
 210 XBT_PUBLIC(void) SIMIX_req_set_category(smx_action_t action, const char *category);
 211 #endif
 212
 213 /************************** Synchro handling **********************************/
 214
 215 XBT_PUBLIC(smx_mutex_t) SIMIX_req_mutex_init(void);
 216 XBT_PUBLIC(void) SIMIX_req_mutex_destroy(smx_mutex_t mutex);
 217 XBT_PUBLIC(void) SIMIX_req_mutex_lock(smx_mutex_t mutex);
 218 XBT_PUBLIC(int) SIMIX_req_mutex_trylock(smx_mutex_t mutex);
 219 XBT_PUBLIC(void) SIMIX_req_mutex_unlock(smx_mutex_t mutex);
 220
 221 XBT_PUBLIC(smx_cond_t) SIMIX_req_cond_init(void);
 222 XBT_PUBLIC(void) SIMIX_req_cond_destroy(smx_cond_t cond);
 223 XBT_PUBLIC(void) SIMIX_req_cond_signal(smx_cond_t cond);
 224 XBT_PUBLIC(void) SIMIX_req_cond_wait(smx_cond_t cond, smx_mutex_t mutex);
 225 XBT_PUBLIC(void) SIMIX_req_cond_wait_timeout(smx_cond_t cond,
 226                                          smx_mutex_t mutex,
 227                                          double max_duration);
 228 XBT_PUBLIC(void) SIMIX_req_cond_broadcast(smx_cond_t cond);
 229
 230 XBT_PUBLIC(smx_sem_t) SIMIX_req_sem_init(int capacity);
 231 XBT_PUBLIC(void) SIMIX_req_sem_destroy(smx_sem_t sem);
 232 XBT_PUBLIC(void) SIMIX_req_sem_release(smx_sem_t sem);
 233 XBT_PUBLIC(void) SIMIX_req_sem_release_forever(smx_sem_t sem);
 234 XBT_PUBLIC(int) SIMIX_req_sem_would_block(smx_sem_t sem);
 235 XBT_PUBLIC(void) SIMIX_req_sem_block_onto(smx_sem_t sem);
 236 XBT_PUBLIC(void) SIMIX_req_sem_acquire(smx_sem_t sem);
 237 XBT_PUBLIC(void) SIMIX_req_sem_acquire_timeout(smx_sem_t sem,
 238                                            double max_duration);
 239 XBT_PUBLIC(unsigned int) SIMIX_req_sem_acquire_any(xbt_dynar_t sems);
 240 XBT_PUBLIC(int) SIMIX_req_sem_get_capacity(smx_sem_t sem);
 241
 242 const char *SIMIX_request_name(int kind);
 243
 244 SG_END_DECL()
 245 #endif                          /* _SIMIX_SIMIX_H */