src/simdag/private.h

   1 /* Copyright (c) 2006-2014. 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_PRIVATE_H
   8 #define SIMDAG_PRIVATE_H
   9
  10 #include "xbt/dict.h"
  11 #include "xbt/dynar.h"
  12 #include "xbt/fifo.h"
  13 #include "simgrid/simdag.h"
  14 #include "surf/surf.h"
  15 #include "xbt/swag.h"
  16 #include "xbt/mallocator.h"
  17 #include <stdbool.h>
  18
  19 /* Global variables */
  20
  21 typedef struct SD_global {
  22   SD_workstation_t *workstation_list;   /* array of workstations, created only if
  23                                            necessary in SD_workstation_get_list */
  24   SD_link_t *link_list;         /* array of links, created only if
  25                                    necessary in SD_link_get_list */
  26   SD_link_t *recyclable_route;  /* array returned by SD_route_get_list
  27                                    and mallocated only once */
  28
  29   xbt_mallocator_t task_mallocator; /* to not remalloc new tasks */
  30
  31   int watch_point_reached;      /* has a task just reached a watch point? */
  32
  33   /* task state sets */
  34   xbt_swag_t not_scheduled_task_set;
  35   xbt_swag_t schedulable_task_set;
  36   xbt_swag_t scheduled_task_set;
  37   xbt_swag_t runnable_task_set;
  38   xbt_swag_t in_fifo_task_set;
  39   xbt_swag_t running_task_set;
  40   xbt_swag_t done_task_set;
  41   xbt_swag_t failed_task_set;
  42
  43   xbt_swag_t return_set;
  44   int task_number;
  45
  46 } s_SD_global_t, *SD_global_t;
  47
  48 extern SD_global_t sd_global;
  49
  50 /* Link */
  51 typedef struct SD_link {
  52   void *surf_link;              /* surf object */
  53   void *data;                   /* user data */
  54   e_SD_link_sharing_policy_t sharing_policy;
  55 } s_SD_link_t;
  56
  57 /* Workstation */
  58 typedef s_xbt_dictelm_t s_SD_workstation_t;
  59 typedef struct SD_workstation {
  60   void *data;                   /* user data */
  61   e_SD_workstation_access_mode_t access_mode;
  62
  63   xbt_fifo_t task_fifo;         /* only used in sequential mode */
  64   SD_task_t current_task;       /* only used in sequential mode */
  65 } s_SD_workstation_priv_t, *SD_workstation_priv_t;
  66
  67 static inline SD_workstation_priv_t SD_workstation_priv(SD_workstation_t host){
  68   return xbt_lib_get_level(host, SD_HOST_LEVEL);
  69 }
  70
  71 /* Storage */
  72 typedef s_xbt_dictelm_t s_SD_storage_t;
  73 typedef struct SD_storage {
  74   void *data;                   /* user data */
  75   const char *host;
  76 } s_SD_storage_priv_t, *SD_storage_priv_t;
  77
  78 static inline SD_storage_priv_t SD_storage_priv(SD_storage_t storage){
  79   return xbt_lib_get_level(storage, SD_STORAGE_LEVEL);
  80 }
  81
  82 /* Task */
  83 typedef struct SD_task {
  84   s_xbt_swag_hookup_t state_hookup;
  85   s_xbt_swag_hookup_t return_hookup;
  86   xbt_swag_t state_set;
  87   e_SD_task_state_t state;
  88   void *data;                   /* user data */
  89   char *name;
  90   int kind;
  91   double amount;
  92   double alpha;          /* used by typed parallel tasks */
  93   double remains;
  94   double start_time;
  95   double finish_time;
  96   surf_action_t surf_action;
  97   unsigned short watch_points;  /* bit field xor()ed with masks */
  98
  99   int fifo_checked;             /* used by SD_task_just_done to make sure we evaluate
 100                                    the task only once */
 101   int marked;                   /* used to check if the task DAG has some cycle*/
 102
 103   /* dependencies */
 104   xbt_dynar_t tasks_before;
 105   xbt_dynar_t tasks_after;
 106   int unsatisfied_dependencies;
 107   unsigned int is_not_ready;
 108
 109   /* scheduling parameters (only exist in state SD_SCHEDULED) */
 110   int workstation_nb;
 111   SD_workstation_t *workstation_list;   /* surf workstations */
 112   double *flops_amount;
 113   double *bytes_amount;
 114   double rate;
 115
 116   long long int counter;        /* task unique identifier for instrumentation */
 117   char *category;               /* sd task category for instrumentation */
 118 } s_SD_task_t;
 119
 120 /* Task dependencies */
 121 typedef struct SD_dependency {
 122   char *name;
 123   void *data;
 124   SD_task_t src;
 125   SD_task_t dst;
 126   /* src must be finished before dst can start */
 127 } s_SD_dependency_t, *SD_dependency_t;
 128
 129 /* SimDag private functions */
 130 XBT_PUBLIC(xbt_swag_t) SD_simulate_swag(double how_long); /* could be public, but you need to see the internals of the SD_task_t to use it */
 131
 132
 133 SD_link_t __SD_link_create(void *surf_link, void *data);
 134 #define __SD_link_destroy xbt_free_f
 135
 136 SD_workstation_t __SD_workstation_create(void *surf_workstation,
 137                                          void *data);
 138 void __SD_workstation_destroy(void *workstation);
 139 int __SD_workstation_is_busy(SD_workstation_t workstation);
 140
 141 void __SD_task_set_state(SD_task_t task, e_SD_task_state_t new_state);
 142 void __SD_task_really_run(SD_task_t task);
 143 int __SD_task_try_to_run(SD_task_t task);
 144 void __SD_task_just_done(SD_task_t task);
 145 bool acyclic_graph_detail(xbt_dynar_t dag);
 146
 147 /* Task mallocator functions */
 148 void* SD_task_new_f(void);
 149 void SD_task_recycle_f(void *t);
 150 void SD_task_free_f(void *t);
 151
 152 /* Functions to test if the task is in a given state. */
 153
 154 /* Returns whether the given task is scheduled or runnable. */
 155 static XBT_INLINE int __SD_task_is_scheduled_or_runnable(SD_task_t task)
 156 {
 157   return task->state_set == sd_global->scheduled_task_set ||
 158       task->state_set == sd_global->runnable_task_set;
 159 }
 160
 161 /* Returns whether the given task is scheduled or runnable. */
 162 static XBT_INLINE int __SD_task_is_schedulable_or_done(SD_task_t task)
 163 {
 164   return task->state_set == sd_global->schedulable_task_set ||
 165       task->state_set == sd_global->done_task_set;
 166 }
 167
 168 /* Returns whether the state of the given task is SD_NOT_SCHEDULED. */
 169 static XBT_INLINE int __SD_task_is_not_scheduled(SD_task_t task)
 170 {
 171   return task->state_set == sd_global->not_scheduled_task_set;
 172 }
 173
 174 /* Returns whether the state of the given task is SD_SCHEDULED. */
 175 static XBT_INLINE int __SD_task_is_schedulable(SD_task_t task)
 176 {
 177   return task->state_set == sd_global->schedulable_task_set;
 178 }
 179
 180 /* Returns whether the state of the given task is SD_SCHEDULED. */
 181 static XBT_INLINE int __SD_task_is_scheduled(SD_task_t task)
 182 {
 183   return task->state_set == sd_global->scheduled_task_set;
 184 }
 185
 186 /* Returns whether the state of the given task is SD_RUNNABLE. */
 187 static XBT_INLINE int __SD_task_is_runnable(SD_task_t task)
 188 {
 189   return task->state_set == sd_global->runnable_task_set;
 190 }
 191
 192 /* Returns whether the state of the given task is SD_IN_FIFO. */
 193 static XBT_INLINE int __SD_task_is_in_fifo(SD_task_t task)
 194 {
 195   return task->state_set == sd_global->in_fifo_task_set;
 196 }
 197
 198 /* Returns whether the state of the given task is SD_RUNNABLE or SD_IN_FIFO. */
 199 static XBT_INLINE int __SD_task_is_runnable_or_in_fifo(SD_task_t task)
 200 {
 201   return task->state_set == sd_global->runnable_task_set ||
 202       task->state_set == sd_global->in_fifo_task_set;
 203 }
 204
 205 /* Returns whether the state of the given task is SD_RUNNING. */
 206 static XBT_INLINE int __SD_task_is_running(SD_task_t task)
 207 {
 208   return task->state_set == sd_global->running_task_set;
 209 }
 210
 211 /********** Storage **********/
 212 SD_storage_t __SD_storage_create(void *surf_storage, void *data);
 213 void __SD_storage_destroy(void *storage);
 214
 215 /********** Tracing **********/
 216 /* declaration of instrumentation functions from sd_task_instr.c */
 217 void TRACE_sd_task_create(SD_task_t task);
 218 void TRACE_sd_task_execute_start(SD_task_t task);
 219 void TRACE_sd_task_execute_end(SD_task_t task);
 220 void TRACE_sd_task_destroy(SD_task_t task);
 221
 222
 223 #endif