Start the SimDag revolution: function factoring

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

diff --git a/include/simgrid/simdag.h b/include/simgrid/simdag.h
index 89ec19c..fe649ed 100644 (file)
--- a/include/simgrid/simdag.h
+++ b/include/simgrid/simdag.h
@@ -1,4 +1,4 @@
-/* Copyright (c) 2006-2010, 2012-2014. The SimGrid Team.
+/* Copyright (c) 2006-2010, 2012-2015. The SimGrid Team.
  * All rights reserved.                                                     */
 
 /* This program is free software; you can redistribute it and/or modify it
@@ -22,7 +22,7 @@ SG_BEGIN_DECL()
     resource with computing capabilities</em> and has a <em>name</em>.
 
     @see SD_workstation_management */
-typedef xbt_dictelm_t SD_workstation_t;
+typedef sg_host_t SD_workstation_t;
 
 /** @brief Workstation access mode
     @ingroup SD_datatypes_management
@@ -67,7 +67,7 @@ typedef struct SD_task *SD_task_t;
     @see SD_task_management */
 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 */
+  SD_SCHEDULABLE = 0x0001,   /**< @brief A task becomes SD_SCHEDULABLE as soon as its dependencies are satisfied */
   SD_SCHEDULED = 0x0002,     /**< @brief A task becomes SD_SCHEDULED when you call function
                                   SD_task_schedule. SD_simulate will execute it when it becomes SD_RUNNABLE. */
   SD_RUNNABLE = 0x0004,      /**< @brief A scheduled task becomes runnable is SD_simulate as soon as its dependencies are satisfied. */
@@ -98,11 +98,6 @@ typedef enum {
     @see SD_storage_management */
 typedef xbt_dictelm_t SD_storage_t;
 
-/************************** AS handling *************************************/
-XBT_PUBLIC(xbt_dict_t) SD_as_router_get_properties(const char *as);
-XBT_PUBLIC(const char*) SD_as_router_get_property_value(const char * as,
-                                                  const char *name);
-
 /************************** Link handling ***********************************/
 /** @defgroup SD_link_management Links
  *  @brief Functions for managing the network links
@@ -117,38 +112,7 @@ XBT_PUBLIC(const char*) SD_as_router_get_property_value(const char * as,
  *  @{
  */
 XBT_PUBLIC(const SD_link_t *) SD_link_get_list(void);
-XBT_PUBLIC(int) SD_link_get_number(void);
-/** @brief Returns the user data of a link */
-static inline void *SD_link_get_data(SD_link_t link) {
-  return sg_link_data(link);
-}
 
-/** @brief Sets the user data of a link
- *
- * The new data can be \c NULL. The old data should have been freed first
- * if it was not \c NULL.
- */
-static inline void SD_link_set_data(SD_link_t link, void *data) {
-       sg_link_data_set(link, data);
-}
-/** @Returns the name of a link  */
-static inline const char *SD_link_get_name(SD_link_t link) {
-  return sg_link_name(link);
-}
-/** @brief Returns the current bandwidth of a link (in bytes per second) */
-static inline double SD_link_get_current_bandwidth(SD_link_t link) {
-  return sg_link_bandwidth(link);
-}
-/** @brief Returns the current latency of a link (in seconds) */
-static inline double SD_link_get_current_latency(SD_link_t link){
-  return sg_link_latency(link);
-}
-/** @brief Returns the sharing policy of this workstation.
- *  @return true if the link is shared, and false if it's a fatpipe
- */
-static inline int SD_link_is_shared(SD_link_t link) {
-  return sg_link_is_shared(link);
-}
 /** @} */
 
 /************************** Workstation handling ****************************/
@@ -169,7 +133,7 @@ static inline int SD_link_is_shared(SD_link_t link) {
  */
 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(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);
@@ -200,9 +164,9 @@ XBT_PUBLIC(void) SD_workstation_set_access_mode(SD_workstation_t
 
 XBT_PUBLIC(double) SD_workstation_get_computation_time(SD_workstation_t workstation,
                                                        double flops_amount);
-XBT_PUBLIC(double) SD_route_get_current_latency(SD_workstation_t src,
+XBT_PUBLIC(double) SD_route_get_latency(SD_workstation_t src,
                                                 SD_workstation_t dst);
-XBT_PUBLIC(double) SD_route_get_current_bandwidth(SD_workstation_t src,
+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,
@@ -252,8 +216,8 @@ XBT_PUBLIC(double) SD_task_get_execution_time(SD_task_t task,
                                               const SD_workstation_t *
                                               workstation_list,
                                               const double *flops_amount,
-                                                                                         const double *bytes_amount);
-XBT_PUBLIC(int) SD_task_get_kind(SD_task_t task);
+                                              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,
@@ -328,7 +292,7 @@ XBT_PUBLIC(int) SD_task_dependency_exists(SD_task_t src, SD_task_t dst);
 /** @defgroup SD_simulation Simulation
  *  @brief Functions for creating the environment and launching the simulation
  *
- *  This section describes the functions for initialising SimDag, launching
+ *  This section describes the functions for initializing SimDag, launching
  *  the simulation and exiting SimDag.
  *
  *  @{
@@ -348,7 +312,8 @@ XBT_PUBLIC(void) uniq_transfer_task_name(SD_task_t task);
 
 /** @} */
 
+SG_END_DECL()
+
 #include "simgrid/instr.h"
 
-SG_END_DECL()
 #endif