X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/be6965a2b4eeef9c8225b33abd4acb08f2b561ef..a88a4036e14334a7a01fc40a7d547687ba6dee38:/include/simgrid/simdag.h
diff --git a/include/simgrid/simdag.h b/include/simgrid/simdag.h
index dbd011ff3d..77f9ea6eee 100644
--- a/include/simgrid/simdag.h
+++ b/include/simgrid/simdag.h
@@ -1,4 +1,4 @@
-/* Copyright (c) 2006-2010, 2012-2015. The SimGrid Team.
+/* Copyright (c) 2006-2010, 2012-2016. The SimGrid Team.
* All rights reserved. */
/* This program is free software; you can redistribute it and/or modify it
@@ -10,46 +10,33 @@
#include "xbt/misc.h"
#include "xbt/dynar.h"
#include "xbt/dict.h"
-
+#include "xbt/asserts.h"
+#include "xbt/log.h"
#include "simgrid/link.h"
+#include "simgrid/host.h"
SG_BEGIN_DECL()
-/** @brief Workstation datatype
- @ingroup SD_datatypes_management
-
- 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.
-
- @see SD_workstation_management */
-typedef sg_host_t SD_workstation_t;
-/** @brief Link datatype
- @ingroup SD_datatypes_management
+/** @brief Link opaque datatype
+ @ingroup SD_link_api
- A link is a network node represented as a name, a current
- bandwidth and a current latency. A route is a list of
- links between two workstations.
-
- @see SD_link_management */
+ A link is a network node represented as a name, a bandwidth and a latency.
+ A route is a list of links between two hosts.
+ */
typedef Link *SD_link_t;
-/** @brief Task datatype
- @ingroup SD_datatypes_management
+/** @brief Task opaque datatype
+ @ingroup SD_task_api
- A task is some computing 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.
+ A task is some computing amount that can be executed in parallel on several hosts.
+ A task may depend on other tasks, which 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, ...
- @see SD_task_management */
+ */
typedef struct SD_task *SD_task_t;
/** @brief Task states
- @ingroup SD_datatypes_management
-
- @see SD_task_management */
+ @ingroup SD_task_api */
typedef enum {
SD_NOT_SCHEDULED = 0, /**< @brief Initial state (not valid for SD_watch and SD_unwatch). */
SD_SCHEDULABLE = 0x0001, /**< @brief A task becomes SD_SCHEDULABLE as soon as its dependencies are satisfied */
@@ -62,9 +49,7 @@ typedef enum {
} e_SD_task_state_t;
/** @brief Task kinds
- @ingroup SD_datatypes_management
-
- @see SD_task_management */
+ @ingroup SD_task_api */
typedef enum {
SD_TASK_NOT_TYPED = 0, /**< @brief no specified type */
SD_TASK_COMM_E2E = 1, /**< @brief end to end communication */
@@ -73,91 +58,44 @@ typedef enum {
SD_TASK_COMM_PAR_MXN_1D_BLOCK = 4 /**< @brief MxN data redistribution (1D Block distribution) */
} e_SD_task_kind_t;
-
/** @brief Storage datatype
- @ingroup SD_datatypes_management
-
- TODO PV: comment it !
-
- @see SD_storage_management */
+ @ingroup SD_storage_api */
typedef xbt_dictelm_t SD_storage_t;
/************************** Workstation handling ****************************/
-
-/** @defgroup SD_workstation_management Workstations
- * @brief Functions for managing the workstations
- *
- * This section describes the functions for managing the workstations.
+/** @addtogroup SD_host_api
*
- * 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.
+ * A host is a place where a task can be executed.
+ * A host 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.
+ * The hosts are created from the description file when you call the function SD_create_environment.
*
- * @see SD_workstation_t
+ * @see sg_host_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_count(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);
-/*property handling functions*/
-XBT_PUBLIC(xbt_dict_t) SD_workstation_get_properties(SD_workstation_t
- workstation);
-XBT_PUBLIC(const char *) SD_workstation_get_property_value(SD_workstation_t
- workstation,
- const char
- *name);
-XBT_PUBLIC(void) SD_workstation_dump(SD_workstation_t ws);
-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_speed(SD_workstation_t workstation);
-XBT_PUBLIC(double) SD_workstation_get_available_speed(SD_workstation_t
- workstation);
-XBT_PUBLIC(int) SD_workstation_get_cores(SD_workstation_t workstation);
-
-XBT_PUBLIC(double) SD_workstation_get_computation_time(SD_workstation_t workstation,
- double flops_amount);
-XBT_PUBLIC(double) SD_route_get_latency(SD_workstation_t src,
- SD_workstation_t dst);
-XBT_PUBLIC(double) SD_route_get_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 bytes_amount);
-
-XBT_PUBLIC(xbt_dict_t)
- SD_workstation_get_mounted_storage_list(SD_workstation_t workstation);
-XBT_PUBLIC(xbt_dynar_t)
- SD_workstation_get_attached_storage_list(SD_workstation_t workstation);
+XBT_PUBLIC(SD_link_t *) SD_route_get_list(sg_host_t src, sg_host_t dst);
+XBT_PUBLIC(int) SD_route_get_size(sg_host_t src, sg_host_t dst);
+
+XBT_PUBLIC(double) SD_route_get_latency(sg_host_t src, sg_host_t dst);
+XBT_PUBLIC(double) SD_route_get_bandwidth(sg_host_t src, sg_host_t dst);
+
XBT_PUBLIC(const char*) SD_storage_get_host(SD_storage_t storage);
/** @} */
/************************** Task handling ************************************/
-
-/** @defgroup SD_task_management Tasks
+/** @defgroup SD_task_api 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.
+ * A task is some working amount that can be executed in parallel on several hosts.
+ * A task may depend on other tasks, which 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, ...
*
- * @see SD_task_t, SD_task_dependency_management
+ * @see SD_task_t, @see SD_task_dependency_api
* @{
*/
-XBT_PUBLIC(SD_task_t) SD_task_create(const char *name, void *data,
- double amount);
+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);
@@ -171,46 +109,29 @@ XBT_PUBLIC(double) SD_task_get_amount(SD_task_t task);
XBT_PUBLIC(void) SD_task_set_amount(SD_task_t task, double amount);
XBT_PUBLIC(double) SD_task_get_alpha(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 *flops_amount,
- const double *bytes_amount);
+XBT_PUBLIC(double) SD_task_get_execution_time(SD_task_t task, int workstation_nb, const sg_host_t *workstation_list,
+ const double *flops_amount, const double *bytes_amount);
XBT_PUBLIC(e_SD_task_kind_t) SD_task_get_kind(SD_task_t task);
-XBT_PUBLIC(void) SD_task_schedule(SD_task_t task, int workstation_nb,
- const SD_workstation_t *
- workstation_list,
- const double *flops_amount,
- const double *bytes_amount,
- double rate);
+XBT_PUBLIC(void) SD_task_schedule(SD_task_t task, int workstation_nb, const sg_host_t *workstation_list,
+ const double *flops_amount, const double *bytes_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(xbt_dynar_t) SD_task_get_parents(SD_task_t task);
XBT_PUBLIC(xbt_dynar_t) SD_task_get_children(SD_task_t task);
XBT_PUBLIC(int) SD_task_get_workstation_count(SD_task_t task);
-XBT_PUBLIC(SD_workstation_t *) SD_task_get_workstation_list(SD_task_t
- task);
+XBT_PUBLIC(sg_host_t *) SD_task_get_workstation_list(SD_task_t task);
XBT_PUBLIC(void) SD_task_destroy(SD_task_t task);
XBT_PUBLIC(void) SD_task_dump(SD_task_t task);
XBT_PUBLIC(void) SD_task_dotty(SD_task_t task, void *out_FILE);
-XBT_PUBLIC(SD_task_t) SD_task_create_comp_seq(const char *name, void *data,
- double amount);
-XBT_PUBLIC(SD_task_t) SD_task_create_comp_par_amdahl(const char *name,
- void *data,
- double amount,
- double alpha);
-XBT_PUBLIC(SD_task_t) SD_task_create_comm_e2e(const char *name, void *data,
- double amount);
-XBT_PUBLIC(SD_task_t) SD_task_create_comm_par_mxn_1d_block(const char *name,
- void *data,
- double amount);
+XBT_PUBLIC(SD_task_t) SD_task_create_comp_seq(const char *name, void *data, double amount);
+XBT_PUBLIC(SD_task_t) SD_task_create_comp_par_amdahl(const char *name, void *data, double amount, double alpha);
+XBT_PUBLIC(SD_task_t) SD_task_create_comm_e2e(const char *name, void *data, double amount);
+XBT_PUBLIC(SD_task_t) SD_task_create_comm_par_mxn_1d_block(const char *name, void *data, double amount);
XBT_PUBLIC(void) SD_task_distribute_comp_amdahl(SD_task_t task, int ws_count);
-XBT_PUBLIC(void) SD_task_schedulev(SD_task_t task, int count,
- const SD_workstation_t * list);
+XBT_PUBLIC(void) SD_task_schedulev(SD_task_t task, int count, const sg_host_t * list);
XBT_PUBLIC(void) SD_task_schedulel(SD_task_t task, int count, ...);
@@ -218,61 +139,77 @@ XBT_PUBLIC(void) SD_task_schedulel(SD_task_t task, int count, ...);
*
* For example, create a pure computation task (no comm) like this:
*
- * SD_task_schedule(task, my_workstation_nb,
- * my_workstation_list,
- * my_flops_amount,
- * SD_TASK_SCHED_NO_COST,
- * my_rate);
+ * SD_task_schedule(task, my_host_count, my_host_list, my_flops_amount, SD_TASK_SCHED_NO_COST, my_rate);
*/
#define SD_SCHED_NO_COST NULL
/** @} */
-
-/** @defgroup SD_task_dependency_management Tasks dependencies
- * @brief Functions for managing the task dependencies
- *
+/** @addtogroup SD_task_dependency_api
+ *
* This section describes the functions for managing the dependencies between the tasks.
*
- * @see SD_task_management
+ * @see SD_task_api
* @{
*/
-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_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(const char *) SD_task_dependency_get_name(SD_task_t src,
- SD_task_t dst);
-XBT_PUBLIC(void *) SD_task_dependency_get_data(SD_task_t src,
- SD_task_t dst);
+XBT_PUBLIC(const char *) SD_task_dependency_get_name(SD_task_t src, SD_task_t dst);
+XBT_PUBLIC(void *) SD_task_dependency_get_data(SD_task_t src, SD_task_t dst);
XBT_PUBLIC(int) SD_task_dependency_exists(SD_task_t src, SD_task_t dst);
/** @} */
/************************** Global *******************************************/
-
-/** @defgroup SD_simulation Simulation
- * @brief Functions for creating the environment and launching the simulation
+/** @addtogroup SD_simulation Simulation
*
- * This section describes the functions for initializing SimDag, launching
- * the simulation and exiting SimDag.
+ * This section describes the functions for initializing SimDag, launching the simulation and exiting SimDag.
*
* @{
*/
XBT_PUBLIC(void) SD_init(int *argc, char **argv);
XBT_PUBLIC(void) SD_config(const char *key, const char *value);
-XBT_PUBLIC(void) SD_application_reinit(void);
XBT_PUBLIC(void) SD_create_environment(const char *platform_file);
XBT_PUBLIC(xbt_dynar_t) SD_simulate(double how_long);
XBT_PUBLIC(double) SD_get_clock(void);
XBT_PUBLIC(void) SD_exit(void);
XBT_PUBLIC(xbt_dynar_t) SD_daxload(const char *filename);
XBT_PUBLIC(xbt_dynar_t) SD_dotload(const char *filename);
-XBT_PUBLIC(xbt_dynar_t) SD_PTG_dotload(const char *filename);
XBT_PUBLIC(xbt_dynar_t) SD_dotload_with_sched(const char *filename);
+XBT_PUBLIC(xbt_dynar_t) SD_PTG_dotload(const char *filename);
/** @} */
-SG_END_DECL()
-
-#include "simgrid/instr.h"
+/* Support some backward compatibility */
+#define SD_workstation_t sg_host_t
+
+#define SD_link_get_name sg_link_name
+#define SD_link_get_current_latency sg_link_latency
+#define SD_link_get_current_bandwidth sg_link_bandwidth
+
+#define SD_route_get_current_latency SD_route_get_latency
+#define SD_route_get_current_bandwidth SD_route_get_bandwidth
+
+#define SD_workstation_get_list sg_host_list
+#define SD_workstation_get_number sg_host_count
+
+#define SD_workstation_get_name sg_host_get_name
+#define SD_workstation_get_by_name sg_host_by_name
+#define SD_workstation_dump sg_host_dump
+#define SD_workstation_get_data sg_host_user
+#define SD_workstation_set_data sg_host_user_set
+#define SD_workstation_get_properties sg_host_get_properties
+#define SD_workstation_get_property_value sg_host_get_property_value
+#define SD_workstation_get_power sg_host_speed
+#define SD_workstation_get_available_power sg_host_get_available_speed
+
+#define SD_workstation_get_mounted_storage_list sg_host_get_mounted_storage_list
+// Lost functions
+//SD_workstation_get_access_mode
+//SD_workstation_set_access_mode
+//SD_workstation_get_current_task
+//SD_route_get_communication_time => SG_route_get_latency() + amount / SD_route_get_bandwidth()
+//SD_workstation_get_computation_time => amount / sg_host_speed()
+//TRACE_sd_set_task_category
+SG_END_DECL()
#endif