include/simdag/simdag.h

   1 #ifndef SIMDAG_SIMDAG_H
   2 #define SIMDAG_SIMDAG_H
   3
   4 #include "simdag/datatypes.h"
   5 #include "xbt/misc.h"
   6 #include "xbt/dynar.h"
   7 #include "xbt/dict.h"
   8
   9
  10 SG_BEGIN_DECL()
  11
  12 /************************** Link handling ***********************************/
  13 /** @defgroup SD_link_management Links
  14  *  @brief Functions for managing the network links
  15  *
  16  *  This section describes the functions for managing the network links.
  17  *
  18  *  A link is a network node represented as a <em>name</em>, a <em>current
  19  *  bandwidth</em> and a <em>current latency</em>. The links are created
  20  *  when you call the function SD_create_environment.
  21  *
  22  *  @see SD_link_t
  23  *  @{
  24  */
  25 XBT_PUBLIC(const SD_link_t *) SD_link_get_list(void);
  26 XBT_PUBLIC(int) SD_link_get_number(void);
  27 XBT_PUBLIC(void *) SD_link_get_data(SD_link_t link);
  28 XBT_PUBLIC(void) SD_link_set_data(SD_link_t link, void *data);
  29 XBT_PUBLIC(const char *) SD_link_get_name(SD_link_t link);
  30 XBT_PUBLIC(double) SD_link_get_current_bandwidth(SD_link_t link);
  31 XBT_PUBLIC(double) SD_link_get_current_latency(SD_link_t link);
  32 XBT_PUBLIC(e_SD_link_sharing_policy_t) SD_link_get_sharing_policy(SD_link_t
  33                                                                   link);
  34 /*property handling functions*/
  35 XBT_PUBLIC(xbt_dict_t) SD_link_get_properties(SD_link_t link);
  36 XBT_PUBLIC(const char *) SD_link_get_property_value(SD_link_t link,
  37                                                     const char *name);
  38 /** @} */
  39
  40 /************************** Workstation handling ****************************/
  41
  42 /** @defgroup SD_workstation_management Workstations
  43  *  @brief Functions for managing the workstations
  44  *
  45  *  This section describes the functions for managing the workstations.
  46  *
  47  *  A workstation is a place where a task can be executed.
  48  *  A workstation is represented as a <em>physical
  49  *  resource with computing capabilities</em> and has a <em>name</em>.
  50  *
  51  *  The workstations are created when you call the function SD_create_environment.
  52  *
  53  *  @see SD_workstation_t
  54  *  @{
  55  */
  56 XBT_PUBLIC(SD_workstation_t) SD_workstation_get_by_name(const char *name);
  57 XBT_PUBLIC(const SD_workstation_t *) SD_workstation_get_list(void);
  58 XBT_PUBLIC(int) SD_workstation_get_number(void);
  59 XBT_PUBLIC(void) SD_workstation_set_data(SD_workstation_t workstation,
  60                                          void *data);
  61 XBT_PUBLIC(void *) SD_workstation_get_data(SD_workstation_t workstation);
  62 XBT_PUBLIC(const char *) SD_workstation_get_name(SD_workstation_t
  63                                                  workstation);
  64 /*property handling functions*/
  65 XBT_PUBLIC(xbt_dict_t) SD_workstation_get_properties(SD_workstation_t
  66                                                      workstation);
  67 XBT_PUBLIC(const char *) SD_workstation_get_property_value(SD_workstation_t
  68                                                            workstation,
  69                                                            const char *name);
  70
  71 XBT_PUBLIC(const SD_link_t *) SD_route_get_list(SD_workstation_t src,
  72                                                 SD_workstation_t dst);
  73 XBT_PUBLIC(int) SD_route_get_size(SD_workstation_t src, SD_workstation_t dst);
  74 XBT_PUBLIC(double) SD_workstation_get_power(SD_workstation_t workstation);
  75 XBT_PUBLIC(double) SD_workstation_get_available_power(SD_workstation_t
  76                                                       workstation);
  77 XBT_PUBLIC(e_SD_workstation_access_mode_t)
  78   SD_workstation_get_access_mode(SD_workstation_t workstation);
  79 XBT_PUBLIC(void) SD_workstation_set_access_mode(SD_workstation_t workstation,
  80                                                 e_SD_workstation_access_mode_t
  81                                                 access_mode);
  82
  83 XBT_PUBLIC(double) SD_workstation_get_computation_time(SD_workstation_t
  84                                                        workstation,
  85                                                        double
  86                                                        computation_amount);
  87 XBT_PUBLIC(double) SD_route_get_current_latency(SD_workstation_t src,
  88                                                 SD_workstation_t dst);
  89 XBT_PUBLIC(double) SD_route_get_current_bandwidth(SD_workstation_t src,
  90                                                   SD_workstation_t dst);
  91 XBT_PUBLIC(double) SD_route_get_communication_time(SD_workstation_t src,
  92                                                    SD_workstation_t dst,
  93                                                    double
  94                                                    communication_amount);
  95
  96 /** @} */
  97
  98 /************************** Task handling ************************************/
  99
 100 /** @defgroup SD_task_management Tasks
 101  *  @brief Functions for managing the tasks
 102  *
 103  *  This section describes the functions for managing the tasks.
 104  *
 105  *  A task is some <em>working amount</em> that can be executed
 106  *  in parallel on several workstations. A task may depend on other
 107  *  tasks, this means that the task cannot start until the other tasks are done.
 108  *  Each task has a <em>\ref e_SD_task_state_t "state"</em> indicating whether
 109  *  the task is scheduled, running, done, etc.
 110  *
 111  *  @see SD_task_t, SD_task_dependency_management
 112  *  @{
 113  */
 114 XBT_PUBLIC(SD_task_t) SD_task_create(const char *name, void *data,
 115                                      double amount);
 116 XBT_PUBLIC(void *) SD_task_get_data(SD_task_t task);
 117 XBT_PUBLIC(void) SD_task_set_data(SD_task_t task, void *data);
 118 XBT_PUBLIC(e_SD_task_state_t) SD_task_get_state(SD_task_t task);
 119 XBT_PUBLIC(const char *) SD_task_get_name(SD_task_t task);
 120 XBT_PUBLIC(void) SD_task_watch(SD_task_t task, e_SD_task_state_t state);
 121 XBT_PUBLIC(void) SD_task_unwatch(SD_task_t task, e_SD_task_state_t state);
 122 XBT_PUBLIC(double) SD_task_get_amount(SD_task_t task);
 123 XBT_PUBLIC(double) SD_task_get_remaining_amount(SD_task_t task);
 124 XBT_PUBLIC(double) SD_task_get_execution_time(SD_task_t task,
 125                                               int workstation_nb,
 126                                               const SD_workstation_t *
 127                                               workstation_list, const double
 128                                               *computation_amount, const double
 129                                               *communication_amount,
 130                                               double rate);
 131 XBT_PUBLIC(void) SD_task_schedule(SD_task_t task, int workstation_nb,
 132                                   const SD_workstation_t * workstation_list,
 133                                   const double *computation_amount,
 134                                   const double *communication_amount,
 135                                   double rate);
 136 XBT_PUBLIC(void) SD_task_unschedule(SD_task_t task);
 137 XBT_PUBLIC(double) SD_task_get_start_time(SD_task_t task);
 138 XBT_PUBLIC(double) SD_task_get_finish_time(SD_task_t task);
 139 XBT_PUBLIC(void) SD_task_destroy(SD_task_t task);
 140 /** @} */
 141
 142
 143 /** @defgroup SD_task_dependency_management Tasks dependencies
 144  *  @brief Functions for managing the task dependencies
 145  *
 146  *  This section describes the functions for managing the dependencies between the tasks.
 147  *
 148  *  @see SD_task_management
 149  *  @{
 150  */
 151 XBT_PUBLIC(void) SD_task_dependency_add(const char *name, void *data,
 152                                         SD_task_t src, SD_task_t dst);
 153 XBT_PUBLIC(void) SD_task_dependency_remove(SD_task_t src, SD_task_t dst);
 154 XBT_PUBLIC(void *) SD_task_dependency_get_data(SD_task_t src, SD_task_t dst);
 155 XBT_PUBLIC(int) SD_task_dependency_exists(SD_task_t src, SD_task_t dst);
 156 /** @} */
 157
 158 /************************** Global *******************************************/
 159
 160 /** @defgroup SD_simulation Simulation
 161  *  @brief Functions for creating the environment and launching the simulation
 162  *
 163  *  This section describes the functions for initialising SimDag, launching
 164  *  the simulation and exiting SimDag.
 165  *
 166  *  @{
 167  */
 168 XBT_PUBLIC(void) SD_init(int *argc, char **argv);
 169 XBT_PUBLIC(void) SD_application_reinit(void);
 170 XBT_PUBLIC(void) SD_create_environment(const char *platform_file);
 171 XBT_PUBLIC(SD_task_t *) SD_simulate(double how_long);
 172 XBT_PUBLIC(double) SD_get_clock(void);
 173 XBT_PUBLIC(void) SD_exit(void);
 174 /** @} */
 175
 176 SG_END_DECL()
 177 #endif