include/simgrid/simdag.h

   1 /* Copyright (c) 2006-2020. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #ifndef SIMGRID_SIMDAG_H
   7 #define SIMGRID_SIMDAG_H
   8
   9 #include <simgrid/host.h>
  10 #include <simgrid/link.h>
  11 #include <simgrid/version.h>
  12 #include <xbt/log.h>
  13 #include <xbt/sysdep.h>
  14
  15 #ifdef __cplusplus
  16 #include <set>
  17 #endif
  18
  19 SG_BEGIN_DECL
  20
  21 /** @brief Link opaque datatype
  22     @ingroup SD_link_api
  23
  24     A link is a network node represented as a <em>name</em>, a <em>bandwidth</em> and a <em>latency</em>.
  25     A route is a list of links between two hosts.
  26  */
  27 typedef sg_link_t SD_link_t;
  28
  29 /** @brief Task opaque datatype
  30     @ingroup SD_task_api
  31
  32     A task is some <em>computing amount</em> that can be executed in parallel on several hosts.
  33     A task may depend on other tasks, which means that the task cannot start until the other tasks are done.
  34     Each task has a <em>@ref e_SD_task_state_t "state"</em> indicating whether the task is scheduled, running, done, ...
  35
  36     */
  37 typedef struct s_SD_task_t* SD_task_t;
  38 typedef const struct s_SD_task_t* const_SD_task_t;
  39
  40 /** @brief Task states
  41     @ingroup SD_task_api */
  42 typedef enum {
  43   SD_NOT_SCHEDULED = 0x0001,      /**< @brief Initial state (not valid for SD_watch and SD_unwatch). */
  44   SD_SCHEDULABLE = 0x0002,   /**< @brief A task becomes SD_SCHEDULABLE as soon as its dependencies are satisfied */
  45   SD_SCHEDULED = 0x0004,     /**< @brief A task becomes SD_SCHEDULED when you call function
  46                                   SD_task_schedule. SD_simulate will execute it when it becomes SD_RUNNABLE. */
  47   SD_RUNNABLE = 0x0008,      /**< @brief A scheduled task becomes runnable is SD_simulate as soon as its dependencies are satisfied. */
  48   SD_RUNNING = 0x0010,       /**< @brief An SD_RUNNABLE task becomes SD_RUNNING when it is launched. */
  49   SD_DONE = 0x0020,          /**< @brief The task is successfully finished. */
  50   SD_FAILED = 0x0040         /**< @brief A problem occurred during the execution of the task. */
  51 } e_SD_task_state_t;
  52
  53 /** @brief Task kinds
  54     @ingroup SD_task_api */
  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 /************************** Task handling ************************************/
  64 /** @defgroup SD_task_api Tasks
  65  *  @brief Functions for managing the tasks
  66  *
  67  *  This section describes the functions for managing the tasks.
  68  *
  69  *  A task is some <em>working amount</em> that can be executed in parallel on several hosts.
  70  *  A task may depend on other tasks, which means that the task cannot start until the other tasks are done.
  71  *  Each task has a <em>@ref e_SD_task_state_t "state"</em> indicating whether the task is scheduled, running, done, ...
  72  *
  73  *  @see SD_task_t, @see SD_task_dependency_api
  74  *  @{
  75  */
  76 XBT_PUBLIC SD_task_t SD_task_create(const char* name, void* data, double amount);
  77 XBT_PUBLIC void* SD_task_get_data(const_SD_task_t task);
  78 XBT_PUBLIC void SD_task_set_data(SD_task_t task, void* data);
  79 XBT_PUBLIC e_SD_task_state_t SD_task_get_state(const_SD_task_t task);
  80 XBT_PUBLIC const char* SD_task_get_name(const_SD_task_t task);
  81 XBT_PUBLIC void SD_task_set_name(SD_task_t task, const char* name);
  82 XBT_PUBLIC void SD_task_set_rate(SD_task_t task, double rate);
  83
  84 XBT_PUBLIC void SD_task_watch(SD_task_t task, e_SD_task_state_t state);
  85 XBT_PUBLIC void SD_task_unwatch(SD_task_t task, e_SD_task_state_t state);
  86 XBT_PUBLIC double SD_task_get_amount(const_SD_task_t task);
  87 XBT_PUBLIC void SD_task_set_amount(SD_task_t task, double amount);
  88 XBT_PUBLIC double SD_task_get_alpha(const_SD_task_t task);
  89 XBT_PUBLIC double SD_task_get_remaining_amount(const_SD_task_t task);
  90 XBT_PUBLIC double SD_task_get_execution_time(const_SD_task_t task, int host_count, const sg_host_t* host_list,
  91                                              const double* flops_amount, const double* bytes_amount);
  92 XBT_PUBLIC e_SD_task_kind_t SD_task_get_kind(const_SD_task_t task);
  93 XBT_PUBLIC void SD_task_schedule(SD_task_t task, int host_count, const sg_host_t* host_list, const double* flops_amount,
  94                                  const double* bytes_amount, double rate);
  95 XBT_PUBLIC void SD_task_unschedule(SD_task_t task);
  96 XBT_PUBLIC double SD_task_get_start_time(const_SD_task_t task);
  97 XBT_PUBLIC double SD_task_get_finish_time(const_SD_task_t task);
  98 XBT_PUBLIC xbt_dynar_t SD_task_get_parents(const_SD_task_t task);
  99 XBT_PUBLIC xbt_dynar_t SD_task_get_children(const_SD_task_t task);
 100 XBT_PUBLIC int SD_task_get_workstation_count(const_SD_task_t task);
 101 XBT_PUBLIC sg_host_t* SD_task_get_workstation_list(const_SD_task_t task);
 102 XBT_PUBLIC void SD_task_destroy(SD_task_t task);
 103 XBT_PUBLIC void SD_task_dump(const_SD_task_t task);
 104 XBT_PUBLIC void SD_task_dotty(const_SD_task_t task, void* out_FILE);
 105
 106 XBT_PUBLIC SD_task_t SD_task_create_comp_seq(const char* name, void* data, double amount);
 107 XBT_PUBLIC SD_task_t SD_task_create_comp_par_amdahl(const char* name, void* data, double amount, double alpha);
 108 XBT_PUBLIC SD_task_t SD_task_create_comm_e2e(const char* name, void* data, double amount);
 109 XBT_PUBLIC SD_task_t SD_task_create_comm_par_mxn_1d_block(const char* name, void* data, double amount);
 110
 111 XBT_PUBLIC void SD_task_distribute_comp_amdahl(SD_task_t task, int ws_count);
 112 XBT_PUBLIC void SD_task_build_MxN_1D_block_matrix(SD_task_t task, int src_nb, int dst_nb);
 113 XBT_PUBLIC void SD_task_schedulev(SD_task_t task, int count, const sg_host_t* list);
 114 XBT_PUBLIC void SD_task_schedulel(SD_task_t task, int count, ...);
 115
 116 /** @brief A constant to use in SD_task_schedule to mean that there is no cost.
 117  *
 118  *  For example, create a pure computation task (i.e., with no communication) like this:
 119  *
 120  *  SD_task_schedule(task, my_host_count, my_host_list, my_flops_amount, SD_SCHED_NO_COST, my_rate)
 121  */
 122 #define SD_SCHED_NO_COST NULL
 123
 124 /** @} */
 125
 126 /** @addtogroup SD_task_dependency_api
 127  *
 128  *  This section describes the functions for managing the dependencies between the tasks.
 129  *
 130  *  @see SD_task_api
 131  *  @{
 132  */
 133 XBT_PUBLIC void SD_task_dependency_add(SD_task_t src, SD_task_t dst);
 134 XBT_PUBLIC void SD_task_dependency_remove(SD_task_t src, SD_task_t dst);
 135 XBT_PUBLIC int SD_task_dependency_exists(const_SD_task_t src, SD_task_t dst);
 136 /** @} */
 137
 138 /************************** Global *******************************************/
 139 /** @addtogroup SD_simulation Simulation
 140  *
 141  *  This section describes the functions for initializing SimDag, launching the simulation and exiting SimDag.
 142  *
 143  *  @{
 144  */
 145
 146 #define SD_init(argc, argv)                                                                                            \
 147   do {                                                                                                                 \
 148     sg_version_check(SIMGRID_VERSION_MAJOR, SIMGRID_VERSION_MINOR, SIMGRID_VERSION_PATCH);                             \
 149     SD_init_nocheck((argc), (argv));                                                                                   \
 150   } while (0)
 151
 152 XBT_PUBLIC void SD_init_nocheck(int* argc, char** argv);
 153 XBT_PUBLIC void SD_config(const char* key, const char* value);
 154 XBT_PUBLIC void SD_create_environment(const char* platform_file);
 155 XBT_PUBLIC void SD_simulate(double how_long);
 156 XBT_PUBLIC void SD_simulate_with_update(double how_long, xbt_dynar_t changed_tasks_dynar);
 157 XBT_PUBLIC double SD_get_clock();
 158 XBT_PUBLIC void SD_exit();
 159 XBT_PUBLIC xbt_dynar_t SD_daxload(const char* filename);
 160 XBT_PUBLIC xbt_dynar_t SD_dotload(const char* filename);
 161 XBT_PUBLIC xbt_dynar_t SD_dotload_with_sched(const char* filename);
 162 XBT_PUBLIC xbt_dynar_t SD_PTG_dotload(const char* filename);
 163 /** @} */
 164
 165 /* Support some backward compatibility */
 166 #define SD_workstation_t sg_host_t
 167
 168 #define SD_link_get_name sg_link_get_name
 169 #define SD_link_get_current_latency sg_link_get_latency
 170 #define SD_link_get_current_bandwidth sg_link_get_bandwidth
 171
 172 #define SD_route_get_current_latency SD_route_get_latency
 173 #define SD_route_get_current_bandwidth SD_route_get_bandwidth
 174
 175 #define SD_workstation_get_list sg_host_list
 176 #define SD_workstation_get_number sg_host_count
 177
 178 #define SD_workstation_get_name sg_host_get_name
 179 #define SD_workstation_get_by_name sg_host_by_name
 180 #define SD_workstation_dump sg_host_dump
 181 #define SD_workstation_get_data sg_host_user
 182 #define SD_workstation_set_data sg_host_user_set
 183 #define SD_workstation_get_properties sg_host_get_properties
 184 #define SD_workstation_get_property_value sg_host_get_property_value
 185 #define SD_workstation_get_power sg_host_speed
 186 #define SD_workstation_get_available_power sg_host_get_available_speed
 187 #define SD_route_get_latency sg_host_route_latency
 188 #define SD_route_get_bandwidth sg_host_route_bandwidth
 189
 190 #define SD_workstation_get_mounted_storage_list sg_host_get_mounted_storage_list // XBT_ATTRIB_DEPRECATED_v330
 191 // Lost functions
 192 //SD_workstation_get_access_mode
 193 //SD_workstation_set_access_mode
 194 //SD_workstation_get_current_task
 195 //SD_route_get_communication_time => SG_route_get_latency() + amount / SD_route_get_bandwidth()
 196 //SD_workstation_get_computation_time => amount / sg_host_speed()
 197 //SD_route_get_size
 198 //SD_route_get_list
 199 //TRACE_sd_set_task_category
 200 SG_END_DECL
 201
 202 #ifdef __cplusplus
 203 namespace simgrid {
 204 namespace sd {
 205 XBT_PUBLIC std::set<SD_task_t>* simulate(double how_long);
 206 }
 207 }
 208 #endif
 209
 210 #endif