include/simdag/simdag.h

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