include/simdag/simdag.h

   1 /* Copyright (c) 2006-2010, 2012-2014. 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 SIMDAG_SIMDAG_H
   8 #define SIMDAG_SIMDAG_H
   9
  10 #include "simdag/datatypes.h"
  11 #include "xbt/misc.h"
  12 #include "xbt/dynar.h"
  13 #include "xbt/dict.h"
  14
  15
  16 SG_BEGIN_DECL()
  17
  18 /************************** AS handling *************************************/
  19 XBT_PUBLIC(xbt_dict_t) SD_as_router_get_properties(const char *as);
  20 XBT_PUBLIC(const char*) SD_as_router_get_property_value(const char * as,
  21                                                   const char *name);
  22
  23 /************************** Link handling ***********************************/
  24 /** @defgroup SD_link_management Links
  25  *  @brief Functions for managing the network links
  26  *
  27  *  This section describes the functions for managing the network links.
  28  *
  29  *  A link is a network node represented as a <em>name</em>, a <em>current
  30  *  bandwidth</em> and a <em>current latency</em>. The links are created
  31  *  when you call the function SD_create_environment.
  32  *
  33  *  @see SD_link_t
  34  *  @{
  35  */
  36 XBT_PUBLIC(const SD_link_t *) SD_link_get_list(void);
  37 XBT_PUBLIC(int) SD_link_get_number(void);
  38 XBT_PUBLIC(void *) SD_link_get_data(SD_link_t link);
  39 XBT_PUBLIC(void) SD_link_set_data(SD_link_t link, void *data);
  40 XBT_PUBLIC(const char *) SD_link_get_name(SD_link_t link);
  41 XBT_PUBLIC(double) SD_link_get_current_bandwidth(SD_link_t link);
  42 XBT_PUBLIC(double) SD_link_get_current_latency(SD_link_t link);
  43 XBT_PUBLIC(e_SD_link_sharing_policy_t) SD_link_get_sharing_policy(SD_link_t
  44                                                                   link);
  45 /** @} */
  46
  47 /************************** Workstation handling ****************************/
  48
  49 /** @defgroup SD_workstation_management Workstations
  50  *  @brief Functions for managing the workstations
  51  *
  52  *  This section describes the functions for managing the workstations.
  53  *
  54  *  A workstation is a place where a task can be executed.
  55  *  A workstation is represented as a <em>physical
  56  *  resource with computing capabilities</em> and has a <em>name</em>.
  57  *
  58  *  The workstations are created when you call the function SD_create_environment.
  59  *
  60  *  @see SD_workstation_t
  61  *  @{
  62  */
  63 XBT_PUBLIC(SD_workstation_t) SD_workstation_get_by_name(const char *name);
  64 XBT_PUBLIC(const SD_workstation_t *) SD_workstation_get_list(void);
  65 XBT_PUBLIC(int) SD_workstation_get_number(void);
  66 XBT_PUBLIC(void) SD_workstation_set_data(SD_workstation_t workstation,
  67                                          void *data);
  68 XBT_PUBLIC(void *) SD_workstation_get_data(SD_workstation_t workstation);
  69 XBT_PUBLIC(const char *) SD_workstation_get_name(SD_workstation_t
  70                                                  workstation);
  71 /*property handling functions*/
  72 XBT_PUBLIC(xbt_dict_t) SD_workstation_get_properties(SD_workstation_t
  73                                                      workstation);
  74 XBT_PUBLIC(const char *) SD_workstation_get_property_value(SD_workstation_t
  75                                                            workstation,
  76                                                            const char
  77                                                            *name);
  78 XBT_PUBLIC(void) SD_workstation_dump(SD_workstation_t ws);
  79 XBT_PUBLIC(const SD_link_t *) SD_route_get_list(SD_workstation_t src,
  80                                                 SD_workstation_t dst);
  81 XBT_PUBLIC(int) SD_route_get_size(SD_workstation_t src,
  82                                   SD_workstation_t dst);
  83 XBT_PUBLIC(double) SD_workstation_get_power(SD_workstation_t workstation);
  84 XBT_PUBLIC(double) SD_workstation_get_available_power(SD_workstation_t
  85                                                       workstation);
  86 XBT_PUBLIC(int) SD_workstation_get_cores(SD_workstation_t workstation);
  87 XBT_PUBLIC(e_SD_workstation_access_mode_t)
  88     SD_workstation_get_access_mode(SD_workstation_t workstation);
  89 XBT_PUBLIC(void) SD_workstation_set_access_mode(SD_workstation_t
  90                                                 workstation,
  91                                                 e_SD_workstation_access_mode_t
  92                                                 access_mode);
  93
  94 XBT_PUBLIC(double) SD_workstation_get_computation_time(SD_workstation_t
  95                                                        workstation,
  96                                                        double
  97                                                        computation_amount);
  98 XBT_PUBLIC(double) SD_route_get_current_latency(SD_workstation_t src,
  99                                                 SD_workstation_t dst);
 100 XBT_PUBLIC(double) SD_route_get_current_bandwidth(SD_workstation_t src,
 101                                                   SD_workstation_t dst);
 102 XBT_PUBLIC(double) SD_route_get_communication_time(SD_workstation_t src,
 103                                                    SD_workstation_t dst,
 104                                                    double
 105                                                    communication_amount);
 106
 107 XBT_PUBLIC(SD_task_t) SD_workstation_get_current_task(SD_workstation_t
 108                                                       workstation);
 109 XBT_PUBLIC(xbt_dict_t)
 110     SD_workstation_get_mounted_storage_list(SD_workstation_t workstation);
 111 XBT_PUBLIC(xbt_dynar_t)
 112     SD_workstation_get_attached_storage_list(SD_workstation_t workstation);
 113 XBT_PUBLIC(const char*) SD_storage_get_host(SD_storage_t storage);
 114 /** @} */
 115
 116 /************************** Task handling ************************************/
 117
 118 /** @defgroup SD_task_management Tasks
 119  *  @brief Functions for managing the tasks
 120  *
 121  *  This section describes the functions for managing the tasks.
 122  *
 123  *  A task is some <em>working amount</em> that can be executed
 124  *  in parallel on several workstations. A task may depend on other
 125  *  tasks, this means that the task cannot start until the other tasks are done.
 126  *  Each task has a <em>\ref e_SD_task_state_t "state"</em> indicating whether
 127  *  the task is scheduled, running, done, etc.
 128  *
 129  *  @see SD_task_t, SD_task_dependency_management
 130  *  @{
 131  */
 132 XBT_PUBLIC(SD_task_t) SD_task_create(const char *name, void *data,
 133                                      double amount);
 134 XBT_PUBLIC(void *) SD_task_get_data(SD_task_t task);
 135 XBT_PUBLIC(void) SD_task_set_data(SD_task_t task, void *data);
 136 XBT_PUBLIC(e_SD_task_state_t) SD_task_get_state(SD_task_t task);
 137 XBT_PUBLIC(const char *) SD_task_get_name(SD_task_t task);
 138 XBT_PUBLIC(void) SD_task_set_name(SD_task_t task, const char *name);
 139 XBT_PUBLIC(void) SD_task_set_rate(SD_task_t task, double rate);
 140
 141 XBT_PUBLIC(void) SD_task_watch(SD_task_t task, e_SD_task_state_t state);
 142 XBT_PUBLIC(void) SD_task_unwatch(SD_task_t task, e_SD_task_state_t state);
 143 XBT_PUBLIC(double) SD_task_get_amount(SD_task_t task);
 144 XBT_PUBLIC(void) SD_task_set_amount(SD_task_t task, double amount);
 145 XBT_PUBLIC(double) SD_task_get_alpha(SD_task_t task);
 146 XBT_PUBLIC(double) SD_task_get_remaining_amount(SD_task_t task);
 147 XBT_PUBLIC(double) SD_task_get_execution_time(SD_task_t task,
 148                                               int workstation_nb,
 149                                               const SD_workstation_t *
 150                                               workstation_list,
 151                                               const double
 152                                               *computation_amount, const double
 153                                               *communication_amount);
 154 XBT_PUBLIC(int) SD_task_get_kind(SD_task_t task);
 155 XBT_PUBLIC(void) SD_task_schedule(SD_task_t task, int workstation_nb,
 156                                   const SD_workstation_t *
 157                                   workstation_list,
 158                                   const double *computation_amount,
 159                                   const double *communication_amount,
 160                                   double rate);
 161 XBT_PUBLIC(void) SD_task_unschedule(SD_task_t task);
 162 XBT_PUBLIC(double) SD_task_get_start_time(SD_task_t task);
 163 XBT_PUBLIC(double) SD_task_get_finish_time(SD_task_t task);
 164 XBT_PUBLIC(xbt_dynar_t) SD_task_get_parents(SD_task_t task);
 165 XBT_PUBLIC(xbt_dynar_t) SD_task_get_children(SD_task_t task);
 166 XBT_PUBLIC(int) SD_task_get_workstation_count(SD_task_t task);
 167 XBT_PUBLIC(SD_workstation_t *) SD_task_get_workstation_list(SD_task_t
 168                                                             task);
 169 XBT_PUBLIC(void) SD_task_destroy(SD_task_t task);
 170 XBT_PUBLIC(void) SD_task_dump(SD_task_t task);
 171 XBT_PUBLIC(void) SD_task_dotty(SD_task_t task, void *out_FILE);
 172
 173 XBT_PUBLIC(SD_task_t) SD_task_create_comp_seq(const char *name, void *data,
 174                                               double amount);
 175 XBT_PUBLIC(SD_task_t) SD_task_create_comp_par_amdahl(const char *name,
 176                                                      void *data,
 177                                                      double amount,
 178                                                      double alpha);
 179 XBT_PUBLIC(SD_task_t) SD_task_create_comm_e2e(const char *name, void *data,
 180                                               double amount);
 181 XBT_PUBLIC(SD_task_t) SD_task_create_comm_par_mxn_1d_block(const char *name,
 182                                                            void *data,
 183                                                            double amount);
 184
 185 XBT_PUBLIC(void) SD_task_distribute_comp_amdahl(SD_task_t task, int ws_count);
 186 XBT_PUBLIC(void) SD_task_schedulev(SD_task_t task, int count,
 187                                    const SD_workstation_t * list);
 188 XBT_PUBLIC(void) SD_task_schedulel(SD_task_t task, int count, ...);
 189
 190
 191 /** @brief A constant to use in SD_task_schedule to mean that there is no cost.
 192  *
 193  *  For example, create a pure computation task (no comm) like this:
 194  *
 195  *  SD_task_schedule(task, my_workstation_nb,
 196  *                   my_workstation_list,
 197  *                   my_computation_amount,
 198  *                   SD_TASK_SCHED_NO_COST,
 199  *                   my_rate);
 200  */
 201 #define SD_SCHED_NO_COST NULL
 202
 203 /** @} */
 204
 205
 206 /** @defgroup SD_task_dependency_management Tasks dependencies
 207  *  @brief Functions for managing the task dependencies
 208  *
 209  *  This section describes the functions for managing the dependencies between the tasks.
 210  *
 211  *  @see SD_task_management
 212  *  @{
 213  */
 214 XBT_PUBLIC(void) SD_task_dependency_add(const char *name, void *data,
 215                                         SD_task_t src, SD_task_t dst);
 216 XBT_PUBLIC(void) SD_task_dependency_remove(SD_task_t src, SD_task_t dst);
 217 XBT_PUBLIC(const char *) SD_task_dependency_get_name(SD_task_t src,
 218                                                      SD_task_t dst);
 219 XBT_PUBLIC(void *) SD_task_dependency_get_data(SD_task_t src,
 220                                                SD_task_t dst);
 221 XBT_PUBLIC(int) SD_task_dependency_exists(SD_task_t src, SD_task_t dst);
 222 /** @} */
 223
 224 /************************** Global *******************************************/
 225
 226 /** @defgroup SD_simulation Simulation
 227  *  @brief Functions for creating the environment and launching the simulation
 228  *
 229  *  This section describes the functions for initialising SimDag, launching
 230  *  the simulation and exiting SimDag.
 231  *
 232  *  @{
 233  */
 234 XBT_PUBLIC(void) SD_init(int *argc, char **argv);
 235 XBT_PUBLIC(void) SD_config(const char *key, const char *value);
 236 XBT_PUBLIC(void) SD_application_reinit(void);
 237 XBT_PUBLIC(void) SD_create_environment(const char *platform_file);
 238 XBT_PUBLIC(xbt_dynar_t) SD_simulate(double how_long);
 239 XBT_PUBLIC(double) SD_get_clock(void);
 240 XBT_PUBLIC(void) SD_exit(void);
 241 XBT_PUBLIC(xbt_dynar_t) SD_daxload(const char *filename);
 242 XBT_PUBLIC(xbt_dynar_t) SD_dotload(const char *filename);
 243 XBT_PUBLIC(xbt_dynar_t) SD_PTG_dotload(const char *filename);
 244 XBT_PUBLIC(xbt_dynar_t) SD_dotload_with_sched(const char *filename);
 245 XBT_PUBLIC(void) uniq_transfer_task_name(SD_task_t task);
 246
 247 /** @} */
 248
 249 #include "instr/instr.h"
 250
 251 SG_END_DECL()
 252 #endif