include/simdag/simdag.h

   1 #ifndef SIMDAG_SIMDAG_H
   2 #define SIMDAG_SIMDAG_H
   3
   4 #include "simdag/datatypes.h"
   5 #include "xbt/misc.h"
   6
   7 SG_BEGIN_DECL()
   8
   9 /************************** Link handling ***********************************/
  10
  11 /* private (called by SD_environment_create)
  12 SD_link_t    SD_link_create(void *data, const char *name,
  13 double bandwidth, double latency);*/
  14 void*        SD_link_get_data(SD_link_t link);
  15 void         SD_link_set_data(SD_link_t link, void *data);
  16 const char*  SD_link_get_name(SD_link_t link);
  17 double       SD_link_get_capacity(SD_link_t link);
  18 double       SD_link_get_current_bandwidth(SD_link_t link);
  19 double       SD_link_get_current_latency(SD_link_t link);
  20 /* private (called by SD_clean)
  21 void         SD_link_destroy(SD_link_t link);
  22 */
  23
  24 /************************** Workstation handling ****************************/
  25
  26 /** @defgroup SD_workstation_management Workstations
  27  *  @brief Functions for managing the workstations
  28  *
  29  *  This section describes the functions for managing the workstations.
  30  *
  31  *  A workstation is a place where a task can be executed.
  32  *  A workstation is represented as a <em>physical
  33  *  resource with computing capabilities</em> and has a <em>name</em>.
  34  *
  35  *  @see SD_workstation_t
  36  *
  37  *  @{
  38  */
  39 SD_workstation_t   SD_workstation_get_by_name(const char *name);
  40 SD_workstation_t*  SD_workstation_get_list(void);
  41 int                SD_workstation_get_number(void);
  42 void               SD_workstation_set_data(SD_workstation_t workstation, void *data);
  43 void*              SD_workstation_get_data(SD_workstation_t workstation);
  44 const char*        SD_workstation_get_name(SD_workstation_t workstation);
  45 SD_link_t*         SD_workstation_route_get_list(SD_workstation_t src, SD_workstation_t dst);
  46 int                SD_workstation_route_get_size(SD_workstation_t src, SD_workstation_t dst);
  47 double             SD_workstation_get_power(SD_workstation_t workstation);
  48 double             SD_workstation_get_available_power(SD_workstation_t workstation);
  49
  50 /** @} */
  51
  52 /************************** Task handling ************************************/
  53
  54 SD_task_t         SD_task_create(const char *name, void *data, double amount);
  55 void              SD_task_schedule(SD_task_t task, int workstation_nb,
  56                                    const SD_workstation_t *workstation_list, double *computation_amount,
  57                                    double *communication_amount, double rate);
  58 void              SD_task_reset(SD_task_t task);
  59 void*             SD_task_get_data(SD_task_t task);
  60 void              SD_task_set_data(SD_task_t task, void *data);
  61 const char*       SD_task_get_name(SD_task_t task);
  62 double            SD_task_get_amount(SD_task_t task);
  63 double            SD_task_get_remaining_amount(SD_task_t task);
  64 void              SD_task_dependency_add(const char *name, void *data, SD_task_t src, SD_task_t dst);
  65 void              SD_task_dependency_remove(SD_task_t src, SD_task_t dst);
  66 void*             SD_task_dependency_get_data(SD_task_t src, SD_task_t dst);
  67 e_SD_task_state_t SD_task_get_state(SD_task_t task);
  68 /* e_SD_task_state_t can be either SD_SCHEDULED, SD_RUNNING, SD_DONE, or SD_FAILED */
  69
  70 void              SD_task_watch(SD_task_t task, e_SD_task_state_t state);
  71 /* SD_simulate will stop as soon as the state of this task is the one given in argument.
  72    Watch-point is then automatically removed */
  73
  74 void              SD_task_unwatch(SD_task_t task, e_SD_task_state_t state);
  75 void              SD_task_unschedule(SD_task_t task); /* change state and rerun */
  76 void              SD_task_destroy(SD_task_t task);
  77
  78 /************************** Global *******************************************/
  79
  80 void              SD_init(int *argc, char **argv);
  81 void              SD_create_environment(const char *platform_file);
  82 SD_task_t*        SD_simulate(double how_long); /* returns a NULL-terminated array of SD_task_t whose state has changed */
  83 void              SD_exit(void); /* cleans everything */
  84
  85 SG_END_DECL()
  86
  87 #endif