Change the way we specify the sizes of bandwidth tests to be able to send really...

[simgrid.git] / include / simdag / simdag.h

diff --git a/include/simdag/simdag.h b/include/simdag/simdag.h
index 9690a03..c250e0f 100644 (file)
--- a/include/simdag/simdag.h
+++ b/include/simdag/simdag.h
@@ -20,11 +20,13 @@ SG_BEGIN_DECL()
  *  @see SD_link_t
  *  @{
  */
-void*        SD_link_get_data(SD_link_t link);
-void         SD_link_set_data(SD_link_t link, void *data);
-const char*  SD_link_get_name(SD_link_t link);
-double       SD_link_get_current_bandwidth(SD_link_t link);
-double       SD_link_get_current_latency(SD_link_t link);
+XBT_PUBLIC const SD_link_t*   SD_link_get_list(void);
+XBT_PUBLIC int                SD_link_get_number(void);
+XBT_PUBLIC void*              SD_link_get_data(SD_link_t link);
+XBT_PUBLIC void               SD_link_set_data(SD_link_t link, void *data);
+XBT_PUBLIC const char*        SD_link_get_name(SD_link_t link);
+XBT_PUBLIC double             SD_link_get_current_bandwidth(SD_link_t link);
+XBT_PUBLIC double             SD_link_get_current_latency(SD_link_t link);
 /** @} */
 
 /************************** Workstation handling ****************************/
@@ -43,16 +45,26 @@ double       SD_link_get_current_latency(SD_link_t link);
  *  @see SD_workstation_t
  *  @{
  */
-SD_workstation_t   SD_workstation_get_by_name(const char *name);
-SD_workstation_t*  SD_workstation_get_list(void);
-int                SD_workstation_get_number(void);
-void               SD_workstation_set_data(SD_workstation_t workstation, void *data);
-void*              SD_workstation_get_data(SD_workstation_t workstation);
-const char*        SD_workstation_get_name(SD_workstation_t workstation);
-SD_link_t*         SD_workstation_route_get_list(SD_workstation_t src, SD_workstation_t dst);
-int                SD_workstation_route_get_size(SD_workstation_t src, SD_workstation_t dst);
-double             SD_workstation_get_power(SD_workstation_t workstation);
-double             SD_workstation_get_available_power(SD_workstation_t workstation);
+XBT_PUBLIC SD_workstation_t        SD_workstation_get_by_name(const char *name);
+XBT_PUBLIC const SD_workstation_t* SD_workstation_get_list(void);
+XBT_PUBLIC int                     SD_workstation_get_number(void);
+XBT_PUBLIC void                    SD_workstation_set_data(SD_workstation_t workstation, void *data);
+XBT_PUBLIC void*                   SD_workstation_get_data(SD_workstation_t workstation);
+XBT_PUBLIC const char*             SD_workstation_get_name(SD_workstation_t workstation);
+XBT_PUBLIC const SD_link_t*              SD_route_get_list(SD_workstation_t src, SD_workstation_t dst);
+XBT_PUBLIC int                     SD_route_get_size(SD_workstation_t src, SD_workstation_t dst);
+XBT_PUBLIC double                  SD_workstation_get_power(SD_workstation_t workstation);
+XBT_PUBLIC double                  SD_workstation_get_available_power(SD_workstation_t workstation);
+XBT_PUBLIC e_SD_workstation_access_mode_t SD_workstation_get_access_mode(SD_workstation_t workstation);
+XBT_PUBLIC void                    SD_workstation_set_access_mode(SD_workstation_t workstation,
+                                                      e_SD_workstation_access_mode_t access_mode);
+
+XBT_PUBLIC double    SD_workstation_get_computation_time(SD_workstation_t workstation, double computation_amount);
+XBT_PUBLIC double    SD_route_get_current_latency(SD_workstation_t src, SD_workstation_t dst);
+XBT_PUBLIC double    SD_route_get_current_bandwidth(SD_workstation_t src, SD_workstation_t dst);
+XBT_PUBLIC double    SD_route_get_communication_time(SD_workstation_t src, SD_workstation_t dst,
+                                                     double communication_amount);
+
 /** @} */
 
 /************************** Task handling ************************************/
@@ -62,7 +74,7 @@ double             SD_workstation_get_available_power(SD_workstation_t workstati
  * 
  *  This section describes the functions for managing the tasks.
  *  
- *  A task is some <em>computing amount</em> that can be executed
+ *  A task is some <em>working amount</em> that can be executed
  *  in parallel on several workstations. A task may depend on other
  *  tasks, this means that the task cannot start until the other tasks are done.
  *  Each task has a <em>\ref e_SD_task_state_t "state"</em> indicating whether
@@ -71,20 +83,26 @@ double             SD_workstation_get_available_power(SD_workstation_t workstati
  *  @see SD_task_t, SD_task_dependency_management
  *  @{
  */
-SD_task_t         SD_task_create(const char *name, void *data, double amount);
-void*             SD_task_get_data(SD_task_t task);
-void              SD_task_set_data(SD_task_t task, void *data);
-e_SD_task_state_t SD_task_get_state(SD_task_t task);
-const char*       SD_task_get_name(SD_task_t task);
-double            SD_task_get_amount(SD_task_t task);
-double            SD_task_get_remaining_amount(SD_task_t task);
-void              SD_task_watch(SD_task_t task, e_SD_task_state_t state);
-void              SD_task_unwatch(SD_task_t task, e_SD_task_state_t state);
-void              SD_task_schedule(SD_task_t task, int workstation_nb,
-                                  const SD_workstation_t *workstation_list, double *computation_amount,
-                                  double *communication_amount, double rate);
-void              SD_task_unschedule(SD_task_t task);
-void              SD_task_destroy(SD_task_t task);
+XBT_PUBLIC SD_task_t         SD_task_create(const char *name, void *data, double amount);
+XBT_PUBLIC void*             SD_task_get_data(SD_task_t task);
+XBT_PUBLIC void              SD_task_set_data(SD_task_t task, void *data);
+XBT_PUBLIC e_SD_task_state_t SD_task_get_state(SD_task_t task);
+XBT_PUBLIC const char*       SD_task_get_name(SD_task_t task);
+XBT_PUBLIC void              SD_task_watch(SD_task_t task, e_SD_task_state_t state);
+XBT_PUBLIC void              SD_task_unwatch(SD_task_t task, e_SD_task_state_t state);
+XBT_PUBLIC double            SD_task_get_amount(SD_task_t task);
+XBT_PUBLIC double            SD_task_get_remaining_amount(SD_task_t task);
+XBT_PUBLIC double            SD_task_get_execution_time(SD_task_t task, int workstation_nb,
+                                            const SD_workstation_t *workstation_list,
+                                            const double *computation_amount, const double *communication_amount,
+                                            double rate);
+XBT_PUBLIC void              SD_task_schedule(SD_task_t task, int workstation_nb,
+                                  const SD_workstation_t *workstation_list, const double *computation_amount,
+                                  const double *communication_amount, double rate);
+XBT_PUBLIC void              SD_task_unschedule(SD_task_t task);
+XBT_PUBLIC double            SD_task_get_start_time(SD_task_t task);
+XBT_PUBLIC double            SD_task_get_finish_time(SD_task_t task);
+XBT_PUBLIC void              SD_task_destroy(SD_task_t task);
 /** @} */
 
 
@@ -96,9 +114,9 @@ void              SD_task_destroy(SD_task_t task);
  *  @see SD_task_management
  *  @{
  */
-void              SD_task_dependency_add(const char *name, void *data, SD_task_t src, SD_task_t dst);
-void              SD_task_dependency_remove(SD_task_t src, SD_task_t dst);
-void*             SD_task_dependency_get_data(SD_task_t src, SD_task_t dst);
+XBT_PUBLIC void              SD_task_dependency_add(const char *name, void *data, SD_task_t src, SD_task_t dst);
+XBT_PUBLIC void              SD_task_dependency_remove(SD_task_t src, SD_task_t dst);
+XBT_PUBLIC void*             SD_task_dependency_get_data(SD_task_t src, SD_task_t dst);
 /** @} */
 
 /************************** Global *******************************************/
@@ -111,10 +129,11 @@ void*             SD_task_dependency_get_data(SD_task_t src, SD_task_t dst);
  *  
  *  @{
  */
-void              SD_init(int *argc, char **argv);
-void              SD_create_environment(const char *platform_file);
-SD_task_t*        SD_simulate(double how_long);
-void              SD_exit(void);
+XBT_PUBLIC void              SD_init(int *argc, char **argv);
+XBT_PUBLIC void              SD_create_environment(const char *platform_file);
+XBT_PUBLIC SD_task_t*        SD_simulate(double how_long);
+XBT_PUBLIC double            SD_get_clock(void);
+XBT_PUBLIC void              SD_exit(void);
 /** @} */
 
 SG_END_DECL()