src/include/surf/surf.h

   1 /*      $Id$     */
   2
   3 /* Copyright (c) 2004 Arnaud Legrand. All rights reserved.                  */
   4
   5 /* This program is free software; you can redistribute it and/or modify it
   6  * under the terms of the license (GNU LGPL) which comes with this package. */
   7
   8 #ifndef _SURF_SURF_H
   9 #define _SURF_SURF_H
  10
  11 #include "xbt/swag.h"
  12 #include "xbt/dynar.h"
  13 #include "xbt/dict.h"
  14
  15 /* Actions and resources are higly connected structures... */
  16 typedef struct surf_action *surf_action_t;
  17 typedef struct surf_resource *surf_resource_t;
  18
  19 /*****************/
  20 /* Action object */
  21 /*****************/
  22 typedef enum {
  23   SURF_ACTION_READY = 0,        /* Ready        */
  24   SURF_ACTION_RUNNING,          /* Running      */
  25   SURF_ACTION_FAILED,           /* Task Failure */
  26   SURF_ACTION_DONE,             /* Completed    */
  27   SURF_ACTION_TO_FREE,          /* Action to free in next cleanup */
  28   SURF_ACTION_NOT_IN_THE_SYSTEM /* Not in the system anymore. Why did you ask ? */
  29 } e_surf_action_state_t;
  30
  31 typedef struct surf_action_state {
  32   xbt_swag_t ready_action_set;
  33   xbt_swag_t running_action_set;
  34   xbt_swag_t failed_action_set;
  35   xbt_swag_t done_action_set;
  36 } s_surf_action_state_t, *surf_action_state_t;
  37
  38 /* Never create s_surf_action_t by yourself !!!! */
  39 /* Use action_new from the corresponding resource */
  40 typedef struct surf_action {
  41   s_xbt_swag_hookup_t state_hookup;
  42   xbt_swag_t state_set;
  43   double cost;                  /* cost        */
  44   double max_duration;          /* max_duration (may fluctuate until
  45                                    the task is completed) */
  46   double remains;               /* How much of that cost remains to
  47                                  * be done in the currently running task */
  48   double start;                 /* start time  */
  49   double finish;                /* finish time : this is modified during the run
  50                                  * and fluctuates until the task is completed */
  51   void *data;                   /* for your convenience */
  52   int using;
  53   surf_resource_t resource_type;
  54 } s_surf_action_t;
  55
  56 /***************************/
  57 /* Generic resource object */
  58 /***************************/
  59
  60 typedef struct surf_resource_private *surf_resource_private_t;
  61 typedef struct surf_resource_public {
  62   s_surf_action_state_t states; /* Any living action on this resource */
  63   void *(*name_service) (const char *name);
  64   const char *(*get_resource_name) (void *resource_id);
  65
  66    e_surf_action_state_t(*action_get_state) (surf_action_t action);
  67   void (*action_use) (surf_action_t action);
  68   int  (*action_free) (surf_action_t action);
  69   void (*action_cancel) (surf_action_t action);
  70   void (*action_recycle) (surf_action_t action);
  71   void (*action_change_state) (surf_action_t action,
  72                                e_surf_action_state_t state);
  73   void (*action_set_data) (surf_action_t action, void *data);
  74   void (*suspend) (surf_action_t action);
  75   void (*resume) (surf_action_t action);
  76   int (*is_suspended) (surf_action_t action);
  77   void (*set_max_duration) (surf_action_t action, double duration);
  78   const char *name;
  79 } s_surf_resource_public_t, *surf_resource_public_t;
  80
  81 typedef struct surf_resource {
  82   surf_resource_private_t common_private;
  83   surf_resource_public_t common_public;
  84 } s_surf_resource_t;
  85
  86 /**************************************/
  87 /* Implementations of resource object */
  88 /**************************************/
  89 /* Timer resource */
  90 typedef struct surf_timer_resource_extension_private
  91 *surf_timer_resource_extension_private_t;
  92 typedef struct surf_timer_resource_extension_public {
  93   void (*set) (double date, void *function, void *arg);
  94   int (*get)  (void **function, void **arg);
  95 } s_surf_timer_resource_extension_public_t,
  96   *surf_timer_resource_extension_public_t;
  97
  98 typedef struct surf_timer_resource {
  99   surf_resource_private_t common_private;
 100   surf_resource_public_t common_public;
 101   surf_timer_resource_extension_public_t extension_public;
 102 } s_surf_timer_resource_t, *surf_timer_resource_t;
 103 extern surf_timer_resource_t surf_timer_resource;
 104 void surf_timer_resource_init(const char *filename);
 105
 106 /* Cpu resource */
 107 typedef enum {
 108   SURF_CPU_ON = 1,              /* Ready        */
 109   SURF_CPU_OFF = 0              /* Running      */
 110 } e_surf_cpu_state_t;
 111
 112 typedef struct surf_cpu_resource_extension_private
 113 *surf_cpu_resource_extension_private_t;
 114 typedef struct surf_cpu_resource_extension_public {
 115   surf_action_t(*execute) (void *cpu, double size);
 116   surf_action_t(*sleep) (void *cpu, double duration);
 117   e_surf_cpu_state_t(*get_state) (void *cpu);
 118 } s_surf_cpu_resource_extension_public_t,
 119     *surf_cpu_resource_extension_public_t;
 120
 121 typedef struct surf_cpu_resource {
 122   surf_resource_private_t common_private;
 123   surf_resource_public_t common_public;
 124   surf_cpu_resource_extension_public_t extension_public;
 125 } s_surf_cpu_resource_t, *surf_cpu_resource_t;
 126 extern surf_cpu_resource_t surf_cpu_resource;
 127 void surf_cpu_resource_init_Cas01(const char *filename);
 128
 129 /* Network resource */
 130 typedef struct surf_network_resource_extension_private
 131 *surf_network_resource_extension_private_t;
 132 typedef struct surf_network_resource_extension_public {
 133   surf_action_t(*communicate) (void *src, void *dst, double size,
 134                                double max_rate);
 135 } s_surf_network_resource_extension_public_t,
 136     *surf_network_resource_extension_public_t;
 137
 138 typedef struct surf_network_resource {
 139   surf_resource_private_t common_private;
 140   surf_resource_public_t common_public;
 141   surf_network_resource_extension_public_t extension_public;
 142 } s_surf_network_resource_t, *surf_network_resource_t;
 143
 144 extern surf_network_resource_t surf_network_resource;
 145 void surf_network_resource_init_CM02(const char *filename);
 146
 147 /* Workstation resource */
 148 typedef struct surf_workstation_resource_extension_private
 149 *surf_workstation_resource_extension_private_t;
 150 typedef struct surf_workstation_resource_extension_public {
 151   surf_action_t(*execute) (void *workstation, double size);
 152   surf_action_t(*sleep) (void *workstation, double duration);
 153   e_surf_cpu_state_t(*get_state) (void *workstation);
 154   surf_action_t(*communicate) (void *workstation_src,
 155                                void *workstation_dst, double size,
 156                                double max_rate);
 157   surf_action_t(*execute_parallel_task) (int workstation_nb,
 158                                          void **workstation_list,
 159                                          double *computation_amount,
 160                                          double *communication_amount,
 161                                          double amount,
 162                                          double rate);
 163 } s_surf_workstation_resource_extension_public_t,
 164     *surf_workstation_resource_extension_public_t;
 165
 166 typedef struct surf_workstation_resource {
 167   surf_resource_private_t common_private;
 168   surf_resource_public_t common_public;
 169   surf_workstation_resource_extension_public_t extension_public;
 170 } s_surf_workstation_resource_t, *surf_workstation_resource_t;
 171
 172 extern surf_workstation_resource_t surf_workstation_resource;
 173 void surf_workstation_resource_init_CLM03(const char *filename);
 174 void surf_workstation_resource_init_KCCFLN05(const char *filename);
 175 extern xbt_dict_t workstation_set;
 176
 177 /*******************************************/
 178 /*** SURF Globals **************************/
 179 /*******************************************/
 180
 181 void surf_init(int *argc, char **argv); /* initialize common structures */
 182
 183 extern xbt_dynar_t resource_list;       /* list of initialized resources */
 184
 185 double surf_solve(void);        /*  update all states and returns
 186                                    the time elapsed since last
 187                                    event */
 188 double surf_get_clock(void);
 189 void surf_finalize(void);       /* clean everything */
 190
 191 #endif                          /* _SURF_SURF_H */