src/include/simix/simix.h

   1 /*      $Id$     */
   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/function_types.h"
  15 #include "simix/datatypes.h"
  16 #include "surf/surf.h"
  17
  18 SG_BEGIN_DECL()
  19
  20
  21 /************************** Global ******************************************/
  22 XBT_PUBLIC(void) SIMIX_config(const char *name, va_list pa);
  23 XBT_PUBLIC(void) SIMIX_global_init(int *argc, char **argv);
  24 XBT_PUBLIC(void) SIMIX_clean(void);
  25 XBT_PUBLIC(void) SIMIX_function_register(const char *name, 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(double) SIMIX_solve(xbt_fifo_t actions_done, xbt_fifo_t actions_failed);
  32
  33 /* Timer functions */
  34 XBT_PUBLIC(void) SIMIX_timer_set (double date, void *function, void *arg);
  35 XBT_PUBLIC(int) SIMIX_timer_get(void **function, void **arg);
  36
  37 /* only for tests */
  38 XBT_PUBLIC(void) __SIMIX_main(void);
  39
  40 /* User create and kill process, the function must accept the folling parameters:
  41  * const char *name: a name for the object. It is for user-level information and can be NULL
  42  * xbt_main_func_t code: is a function describing the behavior of the agent
  43  * void *data: data a pointer to any data one may want to attach to the new object.
  44  * smx_host_t host: the location where the new agent is executed
  45  * int argc, char **argv: parameters passed to code
  46  *
  47  * */
  48 typedef void *(smx_creation_func_t)(/*name*/     const char *,
  49                                      /*code*/     xbt_main_func_t,
  50                                      /*userdata*/ void *,
  51                                      /*hostname*/ char *,
  52                                      /* argc */   int,
  53                                      /* argv */   char **);
  54 XBT_PUBLIC(void) SIMIX_function_register_process_create(smx_creation_func_t *function);
  55
  56 XBT_PUBLIC(void) SIMIX_function_register_process_kill(void_f_pvoid_t *function);
  57
  58 /************************** Host handling ***********************************/
  59
  60 XBT_PUBLIC(void) SIMIX_host_set_data(smx_host_t host, void *data);
  61 XBT_PUBLIC(void*) SIMIX_host_get_data(smx_host_t host);
  62
  63 XBT_PUBLIC(const char *) SIMIX_host_get_name(smx_host_t host);
  64 XBT_PUBLIC(smx_host_t) SIMIX_host_self(void);
  65 XBT_PUBLIC(double) SIMIX_host_get_speed(smx_host_t host);
  66 XBT_PUBLIC(double) SIMIX_host_get_available_speed(smx_host_t host);
  67
  68 XBT_PUBLIC(int) SIMIX_host_get_number(void);
  69 XBT_PUBLIC(smx_host_t *)SIMIX_host_get_table(void);
  70
  71 XBT_PUBLIC(void) SIMIX_create_environment(const char *file);
  72 XBT_PUBLIC(smx_host_t) SIMIX_host_get_by_name(const char *name);
  73
  74 /* Two possible states, 1 - CPU ON and 0 CPU OFF */
  75 XBT_PUBLIC(int) SIMIX_host_get_state(smx_host_t host);
  76
  77 /************************** Process handling *********************************/
  78 XBT_PUBLIC(smx_process_t) SIMIX_process_create(const char *name,
  79                                                xbt_main_func_t code, void *data,
  80                                                const char * hostname, int argc, char **argv,
  81                                                void * clean_process_function);
  82
  83 XBT_PUBLIC(void) SIMIX_jprocess_create(const char *name,
  84                                        smx_host_t host,
  85                                        void *data,
  86                                        void *jprocess, void *jenv,
  87                                        void * clean_process_function,
  88                                        smx_process_t* res);
  89
  90 XBT_PUBLIC(void) SIMIX_process_kill(smx_process_t process);
  91 XBT_PUBLIC(void) SIMIX_process_cleanup(void *arg);
  92 XBT_PUBLIC(void) SIMIX_process_killall(void);
  93
  94 //above layer
  95 XBT_PUBLIC(void*) SIMIX_process_get_data(smx_process_t process);
  96 XBT_PUBLIC(void) SIMIX_process_set_data(smx_process_t process, void *data);
  97
  98 XBT_PUBLIC(smx_host_t) SIMIX_process_get_host(smx_process_t process);
  99 XBT_PUBLIC(const char *)SIMIX_process_get_name(smx_process_t process);
 100 XBT_PUBLIC(smx_process_t) SIMIX_process_self(void);
 101
 102 XBT_PUBLIC(void) SIMIX_process_suspend(smx_process_t process);
 103 XBT_PUBLIC(void) SIMIX_process_resume(smx_process_t process);
 104 XBT_PUBLIC(int) SIMIX_process_is_suspended(smx_process_t process);
 105
 106
 107 /************************** Synchro handling **********************************/
 108
 109 /******Mutex******/
 110 XBT_PUBLIC(smx_mutex_t) SIMIX_mutex_init(void);
 111 XBT_PUBLIC(void) SIMIX_mutex_lock(smx_mutex_t mutex);
 112 XBT_PUBLIC(int) SIMIX_mutex_trylock(smx_mutex_t mutex);
 113 XBT_PUBLIC(void) SIMIX_mutex_unlock(smx_mutex_t mutex);
 114 XBT_PUBLIC(void) SIMIX_mutex_destroy(smx_mutex_t mutex);
 115
 116 /*****Conditional*****/
 117 XBT_PUBLIC(smx_cond_t) SIMIX_cond_init(void);
 118 XBT_PUBLIC(void) SIMIX_cond_signal(smx_cond_t cond);
 119 XBT_PUBLIC(void) SIMIX_cond_wait(smx_cond_t cond,smx_mutex_t mutex);
 120 XBT_PUBLIC(void) SIMIX_cond_wait_timeout(smx_cond_t cond,smx_mutex_t mutex, double max_duration);
 121 XBT_PUBLIC(void) SIMIX_cond_broadcast(smx_cond_t cond);
 122 XBT_PUBLIC(void) SIMIX_cond_destroy(smx_cond_t cond);
 123 XBT_PUBLIC(void) SIMIX_register_condition_to_action(smx_action_t action, smx_cond_t cond);
 124 XBT_PUBLIC(xbt_fifo_t) SIMIX_cond_get_actions(smx_cond_t cond);
 125
 126
 127 /************************** Action handling ************************************/
 128 XBT_PUBLIC(smx_action_t) SIMIX_action_communicate(smx_host_t sender,smx_host_t receiver, char *name,
 129                                                                                                                                                                                                         double size, double rate);
 130 XBT_PUBLIC(smx_action_t) SIMIX_action_execute(smx_host_t host,char *name, double amount);
 131 XBT_PUBLIC(smx_action_t) SIMIX_action_sleep(smx_host_t host, double amount);
 132 XBT_PUBLIC(void) SIMIX_action_cancel(smx_action_t action);
 133 XBT_PUBLIC(void) SIMIX_action_set_priority(smx_action_t action, double priority);
 134 XBT_PUBLIC(void) SIMIX_action_destroy(smx_action_t action);
 135 XBT_PUBLIC(void) SIMIX_register_action_to_condition(smx_action_t action, smx_cond_t cond);
 136 XBT_PUBLIC(double) SIMIX_action_get_remains(smx_action_t action);
 137
 138 XBT_PUBLIC(e_surf_action_state_t) SIMIX_action_get_state(smx_action_t action);
 139
 140 /*Not implemented yet */
 141 XBT_PUBLIC(smx_action_t) SIMIX_action_parallel_execute(char * name,
 142                                                        int workstation_nb,
 143                                                        void **workstation_list,
 144                                                        double *computation_amount,
 145                                                        double *communication_amount,
 146                                                        double amount,
 147                                                        double rate);
 148
 149 void SIMIX_display_process_status(void);
 150
 151 /* Helper functions for jMSG: manipulate the context data without breaking the module separation */
 152 void  SIMIX_process_set_jprocess(smx_process_t process, void *jp);
 153 void* SIMIX_process_get_jprocess(smx_process_t process);
 154 void  SIMIX_process_set_jmutex(smx_process_t process, void *jm);
 155 void* SIMIX_process_get_jmutex(smx_process_t process);
 156 void  SIMIX_process_set_jcond(smx_process_t process, void *jc);
 157 void* SIMIX_process_get_jcond(smx_process_t process);
 158 void  SIMIX_process_set_jenv(smx_process_t process, void *je);
 159 void* SIMIX_process_get_jenv(smx_process_t process);
 160
 161
 162 SG_END_DECL()
 163
 164 #endif                          /* _SIMIX_SIMIX_H */