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