Finish SimDag documentation

[simgrid.git] / src / simdag / private.h

diff --git a/src/simdag/private.h b/src/simdag/private.h
index 4ac0f2f..06fe339 100644 (file)
--- a/src/simdag/private.h
+++ b/src/simdag/private.h
@@ -15,36 +15,31 @@ typedef struct SD_global {
   xbt_dict_t workstations; /* workstation list */
   int workstation_count; /* number of workstations */
   xbt_dict_t links; /* link list */
   xbt_dict_t workstations; /* workstation list */
   int workstation_count; /* number of workstations */
   xbt_dict_t links; /* link list */

-  xbt_dynar_t tasks; /* task list */
+  int watch_point_reached; /* has a task just reached a watch point? */

   
   /* task state sets */
   xbt_swag_t not_scheduled_task_set;
   xbt_swag_t scheduled_task_set;
   
   /* task state sets */
   xbt_swag_t not_scheduled_task_set;
   xbt_swag_t scheduled_task_set;

+  xbt_swag_t ready_task_set;

   xbt_swag_t running_task_set;
   xbt_swag_t done_task_set;
   xbt_swag_t failed_task_set;
   xbt_swag_t running_task_set;
   xbt_swag_t done_task_set;
   xbt_swag_t failed_task_set;

+

 } s_SD_global_t, *SD_global_t;
 
 extern SD_global_t sd_global;
 
 } s_SD_global_t, *SD_global_t;
 
 extern SD_global_t sd_global;
 

-/* Link private data */
-typedef struct SD_link_data {
+/* Link */
+typedef struct SD_link {

   void *surf_link; /* surf object */
   void *surf_link; /* surf object */

-} s_SD_link_data_t;
+  void *data; /* user data */
+} s_SD_link_t;

 
 

-/* Workstation private data */
-typedef struct SD_workstation_data {
+/* Workstation */
+typedef struct SD_workstation {

   void *surf_workstation; /* surf object */
   void *surf_workstation; /* surf object */

-} s_SD_workstation_data_t;
-
-/* Task dependencies */
-typedef struct SD_dependency {
-  char *name;
-  void *data;
-  SD_task_t src;
-  SD_task_t dst;
-  /* src must be finished before dst can start */
-} s_SD_dependency_t, *SD_dependency_t;
+  void *data; /* user data */
+} s_SD_workstation_t;

 
 /* Task */
 typedef struct SD_task {
 
 /* Task */
 typedef struct SD_task {


@@ -55,6 +50,8 @@ typedef struct SD_task {
   double amount;
   surf_action_t surf_action;
   unsigned short watch_points;
   double amount;
   surf_action_t surf_action;
   unsigned short watch_points;

+  int state_changed; /* used only by SD_simulate, to make sure we put
+                       the task only once in the returning array */

 
   /* dependencies */
   xbt_dynar_t tasks_before;
 
   /* dependencies */
   xbt_dynar_t tasks_before;


@@ -68,6 +65,15 @@ typedef struct SD_task {
   double rate;
 } s_SD_task_t;
 
   double rate;
 } s_SD_task_t;
 

+/* Task dependencies */
+typedef struct SD_dependency {
+  char *name;
+  void *data;
+  SD_task_t src;
+  SD_task_t dst;
+  /* src must be finished before dst can start */
+} s_SD_dependency_t, *SD_dependency_t;
+

 /* SimDag private functions */
 
 SD_link_t __SD_link_create(void *surf_link, void *data);
 /* SimDag private functions */
 
 SD_link_t __SD_link_create(void *surf_link, void *data);


@@ -76,6 +82,37 @@ void __SD_link_destroy(void *link);
 SD_workstation_t __SD_workstation_create(void *surf_workstation, void *data);
 void __SD_workstation_destroy(void *workstation);
 
 SD_workstation_t __SD_workstation_create(void *surf_workstation, void *data);
 void __SD_workstation_destroy(void *workstation);
 

+void __SD_task_set_state(SD_task_t task, e_SD_task_state_t new_state);

 surf_action_t __SD_task_run(SD_task_t task);
 surf_action_t __SD_task_run(SD_task_t task);

+void __SD_task_remove_dependencies(SD_task_t task);
+
+/* Functions to test if the task is in a given state.
+   These functions are faster than using SD_task_get_state() */
+
+/* Returns whether the given task is scheduled or ready. */
+static _XBT_INLINE int __SD_task_is_scheduled_or_ready(SD_task_t task) {
+  return task->state_set == sd_global->scheduled_task_set ||
+    task->state_set == sd_global->ready_task_set;
+}
+
+/* Returns whether the state of the given task is SD_NOT_SCHEDULED. */
+static _XBT_INLINE int __SD_task_is_not_scheduled(SD_task_t task) {
+  return task->state_set == sd_global->not_scheduled_task_set;
+}
+
+/* Returns whether the state of the given task is SD_SCHEDULED. */
+static _XBT_INLINE int __SD_task_is_scheduled(SD_task_t task) {
+  return task->state_set == sd_global->scheduled_task_set;
+}
+
+/* Returns whether the state of the given task is SD_READY. */
+static _XBT_INLINE int __SD_task_is_ready(SD_task_t task) {
+  return task->state_set == sd_global->ready_task_set;
+}
+
+/* Returns whether the state of the given task is SD_RUNNING. */
+static _XBT_INLINE int __SD_task_is_running(SD_task_t task) {
+  return task->state_set == sd_global->running_task_set;
+}

 
 #endif
 
 #endif