X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/8d0eaea75f444b5ac20edfca6d4ce04cee7307e7..b4036710f1d7f435ac50328d290cb95b108d505e:/include/simdag/simdag.h diff --git a/include/simdag/simdag.h b/include/simdag/simdag.h index 609f689d1e..c250e0fefc 100644 --- a/include/simdag/simdag.h +++ b/include/simdag/simdag.h @@ -8,69 +8,133 @@ SG_BEGIN_DECL() /************************** Link handling ***********************************/ -/* private (called by SG_environment_create) -SG_link_t SG_link_create(void *data, const char *name, -double bandwidth, double latency);*/ -void* SG_link_get_data(SG_link_t link); -void SG_link_set_data(SG_link_t link, void *data); -const char* SG_link_get_name(SG_link_t link); -double SG_link_get_capacity(SG_link_t link); -double SG_link_get_current_bandwidth(SG_link_t link); -double SG_link_get_current_latency(SG_link_t link); -/* private (called by SG_clean) -void SG_link_destroy(SG_link_t link); -*/ +/** @defgroup SD_link_management Links + * @brief Functions for managing the network links + * + * This section describes the functions for managing the network links. + * + * A link is a network node represented as a name, a current + * bandwidth and a current latency. The links are created + * when you call the function SD_create_environment. + * + * @see SD_link_t + * @{ + */ +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 ****************************/ -/* private (called by SG_environment_create) -SG_workstation_t SG_workstation_create(void *data, const char *name, double power, - double available_power);*/ -SG_workstation_t SG_workstation_get_by_name(const char *name); -SG_workstation_t* SG_workstation_get_list(void); -int SG_workstation_get_number(void); -void SG_workstation_set_data(SG_workstation_t workstation, void *data); -void* SG_workstation_get_data(SG_workstation_t workstation); -const char* SG_workstation_get_name(SG_workstation_t workstation); -SG_link_t* SG_workstation_route_get_list(SG_workstation_t src, SG_workstation_t dst); -int SG_workstation_route_get_size(SG_workstation_t src, SG_workstation_t dst); -double SG_workstation_get_power(SG_workstation_t workstation); -double SG_workstation_get_available_power(SG_workstation_t workstation); -/* private (called by SG_clean) -void SG_workstation_destroy(SG_workstation_t workstation); -*/ +/** @defgroup SD_workstation_management Workstations + * @brief Functions for managing the workstations + * + * This section describes the functions for managing the workstations. + * + * A workstation is a place where a task can be executed. + * A workstation is represented as a physical + * resource with computing capabilities and has a name. + * + * The workstations are created when you call the function SD_create_environment. + * + * @see SD_workstation_t + * @{ + */ +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 ************************************/ -SG_task_t SG_task_create(const char *name, void *data, double amount); -int SG_task_schedule(SG_task_t task, int workstation_nb, - SG_workstation_t **workstation_list, double *computation_amount, - double *communication_amount, double rate); - -void* SG_task_get_data(SG_task_t task); -void SG_task_set_data(SG_task_t task, void *data); -const char* SG_task_get_name(SG_task_t task); -double SG_task_get_amount(SG_task_t task); -double SG_task_get_remaining_amount(SG_task_t task); -void SG_task_dependency_add(const char *name, void *data, SG_task_t src, SG_task_t dst); -void SG_task_dependency_remove(SG_task_t src, SG_task_t dst); -SG_task_state_t SG_task_get_state(SG_task_t task); -/* SG_task_state_t can be either SG_SCHEDULED, SG_RUNNING, SG_DONE, or SG_FAILED */ - -void SG_task_watch(SG_task_t task, SG_task_state_t state); -/* SG_simulate will stop as soon as the state of this task is the one given in argument. - Watch-point is then automatically removed */ - -void SG_task_unwatch(SG_task_t task, SG_task_state_t state); -void SG_task_unschedule(SG_task_t task); /* change state and rerun */ -void SG_task_destroy(SG_task_t task); +/** @defgroup SD_task_management Tasks + * @brief Functions for managing the tasks + * + * This section describes the functions for managing the tasks. + * + * A task is some working amount 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 \ref e_SD_task_state_t "state" indicating whether + * the task is scheduled, running, done, etc. + * + * @see SD_task_t, SD_task_dependency_management + * @{ + */ +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); +/** @} */ + + +/** @defgroup SD_task_dependency_management Tasks dependencies + * @brief Functions for managing the task dependencies + * + * This section describes the functions for managing the dependencies between the tasks. + * + * @see SD_task_management + * @{ + */ +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 *******************************************/ -void SG_init(int *argc, char **argv); -void SG_create_environment(const char *platform_file); -SG_task_t *SG_simulate(double how_long); /* returns a NULL-terminated array of SG_task_t whose state has changed */ -void SG_clean(); /* cleans everything */ +/** @defgroup SD_simulation Simulation + * @brief Functions for creating the environment and launching the simulation + * + * This section describes the functions for initialising SimDag, launching + * the simulation and exiting SimDag. + * + * @{ + */ +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()