src/include/simix/simix.h

   1 /*      $Id: simix.h 5610 2008-06-12 09:38:58Z alegrand $        */
   2
   3 /* Copyright (c) 2007 Arnaud Legrand, Bruno Donnassolo.
   4    All rights reserved.                                          */
   5
   6 /* This program is free software; you can redistribute it and/or modify it
   7  * under the terms of the license (GNU LGPL) which comes with this package. */
   8
   9 #ifndef _SIMIX_SIMIX_H
  10 #define _SIMIX_SIMIX_H
  11
  12 #include "xbt/misc.h"
  13 #include "xbt/fifo.h"
  14 #include "xbt/dict.h"
  15 #include "xbt/function_types.h"
  16 #include "simix/datatypes.h"
  17 #include "surf/surf.h"
  18
  19 SG_BEGIN_DECL()
  20
  21
  22 /************************** Global ******************************************/
  23 XBT_PUBLIC(void) SIMIX_config(const char *name, va_list pa);
  24 XBT_PUBLIC(void) SIMIX_global_init(int *argc, char **argv);
  25 XBT_PUBLIC(void) SIMIX_clean(void);
  26 XBT_PUBLIC(void) SIMIX_function_register(const char *name, xbt_main_func_t code);
  27 XBT_PUBLIC(void) SIMIX_function_register_default(xbt_main_func_t code);
  28 XBT_PUBLIC(xbt_main_func_t) SIMIX_get_registered_function(const char *name);
  29
  30 XBT_PUBLIC(void) SIMIX_launch_application(const char *file);
  31
  32 XBT_PUBLIC(double) SIMIX_get_clock(void);
  33 XBT_PUBLIC(void) SIMIX_init(void);
  34 XBT_PUBLIC(double) SIMIX_solve(xbt_fifo_t actions_done, xbt_fifo_t actions_failed);
  35
  36 /* Timer functions */
  37 XBT_PUBLIC(void) SIMIX_timer_set (double date, void *function, void *arg);
  38 XBT_PUBLIC(int) SIMIX_timer_get(void **function, void **arg);
  39
  40 /* only for tests */
  41 XBT_PUBLIC(void) __SIMIX_main(void);
  42
  43 /* User create and kill process, the function must accept the folling parameters:
  44  * const char *name: a name for the object. It is for user-level information and can be NULL
  45  * xbt_main_func_t code: is a function describing the behavior of the agent
  46  * void *data: data a pointer to any data one may want to attach to the new object.
  47  * smx_host_t host: the location where the new agent is executed
  48  * int argc, char **argv: parameters passed to code
  49  *
  50  * */
  51 typedef void *(*smx_creation_func_t)(/*name*/     const char *,
  52                                      /*code*/     xbt_main_func_t,
  53                                      /*userdata*/ void *,
  54                                      /*hostname*/ char *,
  55                                      /* argc */   int,
  56                                      /* argv */   char **,
  57                                      /* props */ xbt_dict_t);
  58 XBT_PUBLIC(void) SIMIX_function_register_process_create(smx_creation_func_t function);
  59 XBT_PUBLIC(void) SIMIX_function_register_process_kill(void_f_pvoid_t function);
  60 XBT_PUBLIC(void) SIMIX_function_register_process_cleanup(void_f_pvoid_t function);
  61
  62 /************************** Host handling ***********************************/
  63
  64 XBT_PUBLIC(void) SIMIX_host_set_data(smx_host_t host, void *data);
  65 XBT_PUBLIC(void*) SIMIX_host_get_data(smx_host_t host);
  66
  67 XBT_PUBLIC(const char *) SIMIX_host_get_name(smx_host_t host);
  68 XBT_PUBLIC(void) SIMIX_process_set_name(smx_process_t process, char *name);
  69 XBT_PUBLIC(smx_host_t) SIMIX_host_self(void);
  70 XBT_PUBLIC(double) SIMIX_host_get_speed(smx_host_t host);
  71 XBT_PUBLIC(double) SIMIX_host_get_available_speed(smx_host_t host);
  72
  73 XBT_PUBLIC(int) SIMIX_host_get_number(void);
  74 XBT_PUBLIC(smx_host_t *) SIMIX_host_get_table(void);
  75 XBT_PUBLIC(xbt_dict_t) SIMIX_host_get_dict(void);
  76
  77 XBT_PUBLIC(void) SIMIX_create_environment(const char *file);
  78 XBT_PUBLIC(smx_host_t) SIMIX_host_get_by_name(const char *name);
  79
  80 XBT_PUBLIC(xbt_dict_t) SIMIX_host_get_properties(smx_host_t host);
  81
  82 /* Two possible states, 1 - CPU ON and 0 CPU OFF */
  83 XBT_PUBLIC(int) SIMIX_host_get_state(smx_host_t host);
  84
  85 /************************** Process handling *********************************/
  86 XBT_PUBLIC(smx_process_t) SIMIX_process_create(const char *name,
  87                                                xbt_main_func_t code, void *data,
  88                                                const char * hostname, int argc, char **argv, xbt_dict_t properties);
  89
  90 XBT_PUBLIC(void) SIMIX_jprocess_create(const char *name,
  91                                        smx_host_t host,
  92                                        void *data,
  93                                        void *jprocess, void *jenv,
  94                                        smx_process_t* res);
  95
  96 XBT_PUBLIC(void) SIMIX_process_kill(smx_process_t process);
  97 XBT_PUBLIC(void) SIMIX_process_cleanup(void *arg);
  98 XBT_PUBLIC(void) SIMIX_process_killall(void);
  99 XBT_PUBLIC(void) SIMIX_process_change_host(smx_process_t process, 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_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_PUBLIC(smx_process_t) SIMIX_process_self(void);
 108
 109 XBT_PUBLIC(void) SIMIX_process_suspend(smx_process_t process);
 110 XBT_PUBLIC(void) SIMIX_process_resume(smx_process_t process);
 111 XBT_PUBLIC(int) SIMIX_process_is_suspended(smx_process_t process);
 112
 113 /*property handlers*/
 114 XBT_PUBLIC(xbt_dict_t) SIMIX_process_get_properties(smx_process_t host);
 115
 116 /************************** Synchro handling **********************************/
 117
 118 /******Mutex******/
 119 XBT_PUBLIC(smx_mutex_t) SIMIX_mutex_init(void);
 120 XBT_PUBLIC(void) SIMIX_mutex_lock(smx_mutex_t mutex);
 121 XBT_PUBLIC(int) SIMIX_mutex_trylock(smx_mutex_t mutex);
 122 XBT_PUBLIC(void) SIMIX_mutex_unlock(smx_mutex_t mutex);
 123 XBT_PUBLIC(void) SIMIX_mutex_destroy(smx_mutex_t mutex);
 124
 125 /*****Conditional*****/
 126 XBT_PUBLIC(smx_cond_t) SIMIX_cond_init(void);
 127 XBT_PUBLIC(void) SIMIX_cond_signal(smx_cond_t cond);
 128 XBT_PUBLIC(void) SIMIX_cond_wait(smx_cond_t cond,smx_mutex_t mutex);
 129 XBT_PUBLIC(void) SIMIX_cond_wait_timeout(smx_cond_t cond,smx_mutex_t mutex, double max_duration);
 130 XBT_PUBLIC(void) SIMIX_cond_broadcast(smx_cond_t cond);
 131 XBT_PUBLIC(void) SIMIX_cond_destroy(smx_cond_t cond);
 132 XBT_PUBLIC(xbt_fifo_t) SIMIX_cond_get_actions(smx_cond_t cond);
 133 XBT_PUBLIC(void) SIMIX_cond_display_info(smx_cond_t cond);
 134
 135 /************************** Action handling ************************************/
 136 XBT_PUBLIC(smx_action_t) SIMIX_action_communicate(smx_host_t sender,smx_host_t receiver, const char *name,
 137                                                                                                                                                                                                         double size, double rate);
 138 XBT_PUBLIC(smx_action_t) SIMIX_action_execute(smx_host_t host, const char *name, double amount);
 139 XBT_PUBLIC(smx_action_t) SIMIX_action_sleep(smx_host_t host, double amount);
 140 XBT_PUBLIC(void) SIMIX_action_cancel(smx_action_t action);
 141 XBT_PUBLIC(void) SIMIX_action_set_priority(smx_action_t action, double priority);
 142 XBT_PUBLIC(void) SIMIX_action_destroy(smx_action_t action);
 143 XBT_PUBLIC(void) SIMIX_register_action_to_condition(smx_action_t action, smx_cond_t cond);
 144 XBT_PUBLIC(void) SIMIX_unregister_action_to_condition(smx_action_t action, smx_cond_t cond);
 145 XBT_PUBLIC(double) SIMIX_action_get_remains(smx_action_t action);
 146
 147 XBT_PUBLIC(e_surf_action_state_t) SIMIX_action_get_state(smx_action_t action);
 148
 149 XBT_PUBLIC(smx_action_t) SIMIX_action_parallel_execute(char * name,
 150                                                        int host_nb,
 151                                                        smx_host_t *host_list,
 152                                                        double *computation_amount,
 153                                                        double *communication_amount,
 154                                                        double amount,
 155                                                        double rate);
 156
 157 void SIMIX_display_process_status(void);
 158
 159
 160 SG_END_DECL()
 161
 162 #endif                          /* _SIMIX_SIMIX_H */