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