include/simgrid/simdag.h

   1 /* Copyright (c) 2006-2010, 2012-2016. 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 "xbt/misc.h"
  11 #include "xbt/dynar.h"
  12 #include "xbt/dict.h"
  13 #include "simgrid/link.h"
  14
  15 SG_BEGIN_DECL()
  16
  17 /** @brief Link datatype
  18     @ingroup SD_datatypes_management
  19
  20     A link is a network node represented as a <em>name</em>, a <em>bandwidth</em> and a <em>latency</em>.
  21     A route is a list of links between two workstations.
  22
  23     @see SD_link_management */
  24 typedef Link *SD_link_t;
  25
  26 /** @brief Task datatype
  27     @ingroup SD_datatypes_management
  28
  29     A task is some <em>computing amount</em> that can be executed in parallel on several hosts.
  30     A task may depend on other tasks, which means that the task cannot start until the other tasks are done.
  31     Each task has a <em>\ref e_SD_task_state_t "state"</em> indicating whether the task is scheduled, running, done, ...
  32
  33     @see SD_task_management */
  34 typedef struct SD_task *SD_task_t;
  35
  36 /** @brief Task states
  37     @ingroup SD_datatypes_management
  38
  39     @see SD_task_management */
  40 typedef enum {
  41   SD_NOT_SCHEDULED = 0,      /**< @brief Initial state (not valid for SD_watch and SD_unwatch). */
  42   SD_SCHEDULABLE = 0x0001,   /**< @brief A task becomes SD_SCHEDULABLE as soon as its dependencies are satisfied */
  43   SD_SCHEDULED = 0x0002,     /**< @brief A task becomes SD_SCHEDULED when you call function
  44                                   SD_task_schedule. SD_simulate will execute it when it becomes SD_RUNNABLE. */
  45   SD_RUNNABLE = 0x0004,      /**< @brief A scheduled task becomes runnable is SD_simulate as soon as its dependencies are satisfied. */
  46   SD_RUNNING = 0x0008,       /**< @brief An SD_RUNNABLE task becomes SD_RUNNING when it is launched. */
  47   SD_DONE = 0x0010,          /**< @brief The task is successfully finished. */
  48   SD_FAILED = 0x0020         /**< @brief A problem occurred during the execution of the task. */
  49 } e_SD_task_state_t;
  50
  51 /** @brief Task kinds
  52     @ingroup SD_datatypes_management
  53
  54     @see SD_task_management */
  55 typedef enum {
  56   SD_TASK_NOT_TYPED = 0,      /**< @brief no specified type */
  57   SD_TASK_COMM_E2E = 1,       /**< @brief end to end communication */
  58   SD_TASK_COMP_SEQ = 2,        /**< @brief sequential computation */
  59   SD_TASK_COMP_PAR_AMDAHL = 3, /**< @brief parallel computation (Amdahl's law) */
  60   SD_TASK_COMM_PAR_MXN_1D_BLOCK = 4 /**< @brief MxN data redistribution (1D Block distribution) */
  61 } e_SD_task_kind_t;
  62
  63 /** @brief Storage datatype
  64     @ingroup SD_datatypes_management
  65
  66     @see SD_storage_management */
  67 typedef xbt_dictelm_t SD_storage_t;
  68
  69 /************************** Workstation handling ****************************/
  70 /** @defgroup sg_host_management Hosts
  71  *  @brief Functions for managing the Hosts
  72  *
  73  *  This section describes the functions for managing the hosts.
  74  *
  75  *  A host is a place where a task can be executed.
  76  *  A host is represented as a <em>physical resource with computing capabilities</em> and has a <em>name</em>.
  77  *
  78  *  The hosts are created when you call the function SD_create_environment.
  79  *
  80  *  @see sg_host_t
  81  *  @{
  82  */
  83 XBT_PUBLIC(SD_link_t *) SD_route_get_list(sg_host_t src, sg_host_t dst);
  84 XBT_PUBLIC(int) SD_route_get_size(sg_host_t src, sg_host_t dst);
  85
  86 XBT_PUBLIC(double) SD_route_get_latency(sg_host_t src, sg_host_t dst);
  87 XBT_PUBLIC(double) SD_route_get_bandwidth(sg_host_t src, sg_host_t dst);
  88
  89 XBT_PUBLIC(const char*) SD_storage_get_host(SD_storage_t storage);
  90 /** @} */
  91
  92 /************************** Task handling ************************************/
  93 /** @defgroup SD_task_management Tasks
  94  *  @brief Functions for managing the tasks
  95  *
  96  *  This section describes the functions for managing the tasks.
  97  *
  98  *  A task is some <em>working amount</em> that can be executed in parallel on several hosts.
  99  *  A task may depend on other tasks, which means that the task cannot start until the other tasks are done.
 100  *  Each task has a <em>\ref e_SD_task_state_t "state"</em> indicating whether the task is scheduled, running, done, ...
 101  *
 102  *  @see SD_task_t, SD_task_dependency_management
 103  *  @{
 104  */
 105 XBT_PUBLIC(SD_task_t) SD_task_create(const char *name, void *data, double amount);
 106 XBT_PUBLIC(void *) SD_task_get_data(SD_task_t task);
 107 XBT_PUBLIC(void) SD_task_set_data(SD_task_t task, void *data);
 108 XBT_PUBLIC(e_SD_task_state_t) SD_task_get_state(SD_task_t task);
 109 XBT_PUBLIC(const char *) SD_task_get_name(SD_task_t task);
 110 XBT_PUBLIC(void) SD_task_set_name(SD_task_t task, const char *name);
 111 XBT_PUBLIC(void) SD_task_set_rate(SD_task_t task, double rate);
 112
 113 XBT_PUBLIC(void) SD_task_watch(SD_task_t task, e_SD_task_state_t state);
 114 XBT_PUBLIC(void) SD_task_unwatch(SD_task_t task, e_SD_task_state_t state);
 115 XBT_PUBLIC(double) SD_task_get_amount(SD_task_t task);
 116 XBT_PUBLIC(void) SD_task_set_amount(SD_task_t task, double amount);
 117 XBT_PUBLIC(double) SD_task_get_alpha(SD_task_t task);
 118 XBT_PUBLIC(double) SD_task_get_remaining_amount(SD_task_t task);
 119 XBT_PUBLIC(double) SD_task_get_execution_time(SD_task_t task, int workstation_nb, const sg_host_t *workstation_list,
 120                                               const double *flops_amount, const double *bytes_amount);
 121 XBT_PUBLIC(e_SD_task_kind_t) SD_task_get_kind(SD_task_t task);
 122 XBT_PUBLIC(void) SD_task_schedule(SD_task_t task, int workstation_nb, const sg_host_t *workstation_list,
 123                                   const double *flops_amount, const double *bytes_amount, double rate);
 124 XBT_PUBLIC(void) SD_task_unschedule(SD_task_t task);
 125 XBT_PUBLIC(double) SD_task_get_start_time(SD_task_t task);
 126 XBT_PUBLIC(double) SD_task_get_finish_time(SD_task_t task);
 127 XBT_PUBLIC(xbt_dynar_t) SD_task_get_parents(SD_task_t task);
 128 XBT_PUBLIC(xbt_dynar_t) SD_task_get_children(SD_task_t task);
 129 XBT_PUBLIC(int) SD_task_get_workstation_count(SD_task_t task);
 130 XBT_PUBLIC(sg_host_t *) SD_task_get_workstation_list(SD_task_t task);
 131 XBT_PUBLIC(void) SD_task_destroy(SD_task_t task);
 132 XBT_PUBLIC(void) SD_task_dump(SD_task_t task);
 133 XBT_PUBLIC(void) SD_task_dotty(SD_task_t task, void *out_FILE);
 134
 135 XBT_PUBLIC(SD_task_t) SD_task_create_comp_seq(const char *name, void *data, double amount);
 136 XBT_PUBLIC(SD_task_t) SD_task_create_comp_par_amdahl(const char *name, void *data, double amount, double alpha);
 137 XBT_PUBLIC(SD_task_t) SD_task_create_comm_e2e(const char *name, void *data, double amount);
 138 XBT_PUBLIC(SD_task_t) SD_task_create_comm_par_mxn_1d_block(const char *name, void *data, double amount);
 139
 140 XBT_PUBLIC(void) SD_task_distribute_comp_amdahl(SD_task_t task, int ws_count);
 141 XBT_PUBLIC(void) SD_task_schedulev(SD_task_t task, int count, const sg_host_t * list);
 142 XBT_PUBLIC(void) SD_task_schedulel(SD_task_t task, int count, ...);
 143
 144
 145 /** @brief A constant to use in SD_task_schedule to mean that there is no cost.
 146  *
 147  *  For example, create a pure computation task (no comm) like this:
 148  *
 149  *  SD_task_schedule(task, my_host_count, my_host_list, my_flops_amount, SD_TASK_SCHED_NO_COST, my_rate);
 150  */
 151 #define SD_SCHED_NO_COST NULL
 152
 153 /** @} */
 154
 155 /** @defgroup SD_task_dependency_management Tasks dependencies
 156  *  @brief Functions for managing the task dependencies
 157  *
 158  *  This section describes the functions for managing the dependencies between the tasks.
 159  *
 160  *  @see SD_task_management
 161  *  @{
 162  */
 163 XBT_PUBLIC(void) SD_task_dependency_add(const char *name, void *data, SD_task_t src, SD_task_t dst);
 164 XBT_PUBLIC(void) SD_task_dependency_remove(SD_task_t src, SD_task_t dst);
 165 XBT_PUBLIC(const char *) SD_task_dependency_get_name(SD_task_t src, SD_task_t dst);
 166 XBT_PUBLIC(void *) SD_task_dependency_get_data(SD_task_t src, SD_task_t dst);
 167 XBT_PUBLIC(int) SD_task_dependency_exists(SD_task_t src, SD_task_t dst);
 168 /** @} */
 169
 170 /************************** Global *******************************************/
 171 /** @defgroup SD_simulation Simulation
 172  *  @brief Functions for creating the environment and launching the simulation
 173  *
 174  *  This section describes the functions for initializing SimDag, launching the simulation and exiting SimDag.
 175  *
 176  *  @{
 177  */
 178 XBT_PUBLIC(void) SD_init(int *argc, char **argv);
 179 XBT_PUBLIC(void) SD_config(const char *key, const char *value);
 180 XBT_PUBLIC(void) SD_create_environment(const char *platform_file);
 181 XBT_PUBLIC(xbt_dynar_t) SD_simulate(double how_long);
 182 XBT_PUBLIC(double) SD_get_clock(void);
 183 XBT_PUBLIC(void) SD_exit(void);
 184 XBT_PUBLIC(xbt_dynar_t) SD_daxload(const char *filename);
 185 XBT_PUBLIC(xbt_dynar_t) SD_dotload(const char *filename);
 186 XBT_PUBLIC(xbt_dynar_t) SD_dotload_with_sched(const char *filename);
 187 XBT_PUBLIC(xbt_dynar_t) SD_PTG_dotload(const char *filename);
 188
 189 /** @} */
 190
 191 /* Support some backward compatibility */
 192 #define SD_workstation_t sg_host_t
 193
 194 #define SD_link_get_name sg_link_name
 195 #define SD_link_get_current_latency sg_link_latency
 196 #define SD_link_get_current_bandwidth sg_link_bandwidth
 197
 198 #define SD_route_get_current_latency SD_route_get_latency
 199 #define SD_route_get_current_bandwidth SD_route_get_bandwidth
 200
 201 #define SD_workstation_get_list sg_host_list
 202 #define SD_workstation_get_number sg_host_count
 203
 204 #define SD_workstation_get_name sg_host_get_name
 205 #define SD_workstation_get_by_name sg_host_by_name
 206 #define SD_workstation_dump sg_host_dump
 207 #define SD_workstation_get_data sg_host_user
 208 #define SD_workstation_set_data sg_host_user_set
 209 #define SD_workstation_get_properties sg_host_get_properties
 210 #define SD_workstation_get_property_value sg_host_get_property_value
 211 #define SD_workstation_get_power sg_host_speed
 212 #define SD_workstation_get_available_power sg_host_get_available_speed
 213
 214 #define SD_workstation_get_mounted_storage_list sg_host_get_mounted_storage_list
 215 // Lost functions
 216 //SD_workstation_get_access_mode
 217 //SD_workstation_set_access_mode
 218 //SD_workstation_get_current_task
 219 //SD_route_get_communication_time => SG_route_get_latency() + amount / SD_route_get_bandwidth()
 220 //SD_workstation_get_computation_time => amount / sg_host_speed()
 221 //TRACE_sd_set_task_category
 222
 223 SG_END_DECL()
 224 #endif