Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
remove the create_resource entry point in resource model APIs
[simgrid.git] / src / include / surf / surf.h
index 2d4e5b4..6100dfa 100644 (file)
 SG_BEGIN_DECL()
 /* Actions and models are highly connected structures... */
 
+/* user-visible parameters */
+extern double sg_tcp_gamma;
+extern double sg_sender_gap;
+extern double sg_latency_factor;
+extern double sg_bandwidth_factor;
+extern double sg_weight_S_parameter;
+extern int sg_maxmin_selective_update;
+extern int sg_network_crosstraffic;
+#ifdef HAVE_GTNETS
+extern double sg_gtnets_jitter;
+extern int sg_gtnets_jitter_seed;
+#endif
+extern xbt_dynar_t surf_path;
+
+
 typedef enum {
   SURF_NETWORK_ELEMENT_NULL = 0,        /* NULL */
   SURF_NETWORK_ELEMENT_HOST,    /* host type */
@@ -34,6 +49,7 @@ XBT_PUBLIC(e_surf_network_element_type_t)
 
 /** @Brief Specify that we use that action */
 XBT_PUBLIC(void) surf_action_ref(surf_action_t action);
+
 /** @brief Creates a new action.
  *
  * @param size The size is the one of the subtype you want to create
@@ -78,16 +94,16 @@ typedef struct surf_action {
   double cost;                  /**< cost        */
   double priority;              /**< priority (1.0 by default) */
   double max_duration;          /**< max_duration (may fluctuate until
-                                  the task is completed) */
+           the task is completed) */
   double remains;               /**< How much of that cost remains to
-                                * be done in the currently running task */
+         * be done in the currently running task */
 #ifdef HAVE_LATENCY_BOUND_TRACKING
   int latency_limited;               /**< Set to 1 if is limited by latency, 0 otherwise */
 #endif
 
   double start;                 /**< start time  */
   double finish;                /**< finish time : this is modified during the run
-                                * and fluctuates until the task is completed */
+         * and fluctuates until the task is completed */
   void *data;                   /**< for your convenience */
   int refcount;
   surf_model_t model_type;
@@ -96,6 +112,7 @@ typedef struct surf_action {
 #endif
   surf_file_t file;        /**< surf_file_t for storage model */
   s_file_stat_t stat;        /**< surf_file_t for storage model */
+  xbt_dict_t ls_dict;
 } s_surf_action_t;
 
 typedef struct surf_action_lmm {
@@ -151,6 +168,16 @@ typedef struct surf_action_state {
 typedef struct s_routing_platf s_routing_platf_t, *routing_platf_t;
 XBT_PUBLIC_DATA(routing_platf_t) routing_platf;
 
+/*******************************************
+ *  TUTORIAL: New model
+ *  New model extension public
+ *  Public functions specific to a New model.
+ */
+typedef struct surf_new_model_extension_public {
+  surf_action_t(*fct) ();
+  void* (*create_resource) ();
+} s_surf_model_extension_new_model_t;
+/*******************************************/
 
 /** \ingroup SURF_models
  *  \brief Private data available on all models
@@ -170,13 +197,6 @@ typedef struct surf_cpu_model_extension_public {
   e_surf_resource_state_t(*get_state) (void *cpu);
   double (*get_speed) (void *cpu, double load);
   double (*get_available_speed) (void *cpu);
-  void* (*create_resource) (const char *name, double power_peak,
-                           double power_scale,
-                           tmgr_trace_t power_trace,
-                           int core,
-                           e_surf_resource_state_t state_initial,
-                           tmgr_trace_t state_trace,
-                           xbt_dict_t cpu_properties);
   void (*add_traces) (void);
 } s_surf_model_extension_cpu_t;
 
@@ -196,16 +216,6 @@ typedef struct surf_network_model_extension_public {
   double (*get_link_latency) (const void *link);
   int (*link_shared) (const void *link);
   void (*add_traces) (void);
-  void* (*create_resource) (const char *name,
-                           double bw_initial,
-                           tmgr_trace_t bw_trace,
-                           double lat_initial,
-                           tmgr_trace_t lat_trace,
-                           e_surf_resource_state_t
-                           state_initial,
-                           tmgr_trace_t state_trace,
-                           e_surf_link_sharing_policy_t policy,
-                           xbt_dict_t properties);
 } s_surf_model_extension_network_t;
 
 /* Storage model */
@@ -217,12 +227,13 @@ typedef struct surf_network_model_extension_public {
  */
 
 typedef struct surf_storage_model_extension_public {
-  surf_action_t(*open) (void *storage, const char* path, const char* mode);
+  surf_action_t(*open) (void *storage, const char* mount, const char* path, const char* mode);
   surf_action_t(*close) (void *storage, surf_file_t fp);
-  surf_action_t(*read) (void *storage, void* ptr, size_t size, size_t nmemb, surf_file_t stream);
+  surf_action_t(*read) (void *storage, void* ptr, double size, size_t nmemb, surf_file_t stream);
   surf_action_t(*write) (void *storage, const void* ptr, size_t size, size_t nmemb, surf_file_t stream);
   surf_action_t(*stat) (void *storage, surf_file_t stream);
-  void* (*create_resource) (const char* id, const char* model,const char* type_id);
+  surf_action_t(*unlink) (void *storage, surf_file_t stream);
+  surf_action_t(*ls) (void *storage, const char *path);
 } s_surf_model_extension_storage_t;
 
      /** \ingroup SURF_models
@@ -232,7 +243,7 @@ typedef struct surf_storage_model_extension_public {
       */
 typedef struct surf_workstation_model_extension_public {
   surf_action_t(*execute) (void *workstation, double size);                                /**< Execute a computation amount on a workstation
-                                                                                       and create the corresponding action */
+                                      and create the corresponding action */
   surf_action_t(*sleep) (void *workstation, double duration);                              /**< Make a workstation sleep during a given duration */
   e_surf_resource_state_t(*get_state) (void *workstation);                                      /**< Return the CPU state of a workstation */
   double (*get_speed) (void *workstation, double load);                                    /**< Return the speed of a workstation */
@@ -247,32 +258,19 @@ typedef struct surf_workstation_model_extension_public {
                                           void **workstation_list,
                                           double *computation_amount,
                                           double *communication_amount,
-                                          double amount, double rate);
+                                          double rate);
   double (*get_link_bandwidth) (const void *link);                                         /**< Return the current bandwidth of a network link */
   double (*get_link_latency) (const void *link);                                           /**< Return the current latency of a network link */
   surf_action_t(*open) (void *workstation, const char* storage, const char* path, const char* mode);
-  surf_action_t(*close) (void *workstation, const char* storage, surf_file_t fp);
-  surf_action_t(*read) (void *workstation, const char* storage, void* ptr, size_t size, size_t nmemb, surf_file_t stream);
-  surf_action_t(*write) (void *workstation, const char* storage, const void* ptr, size_t size, size_t nmemb, surf_file_t stream);
-  surf_action_t(*stat) (void *workstation, const char* storage, surf_file_t stream);
+  surf_action_t(*close) (void *workstation, surf_file_t fp);
+  surf_action_t(*read) (void *workstation, void* ptr, size_t size, size_t nmemb, surf_file_t stream);
+  surf_action_t(*write) (void *workstation, const void* ptr, size_t size, size_t nmemb, surf_file_t stream);
+  surf_action_t(*stat) (void *workstation, surf_file_t stream);
+  surf_action_t(*unlink) (void *workstation, surf_file_t stream);
+  surf_action_t(*ls) (void *workstation, const char* mount, const char *path);
+
   int (*link_shared) (const void *link);
    xbt_dict_t(*get_properties) (const void *resource);
-  void* (*link_create_resource) (const char *name,
-                                double bw_initial,
-                                tmgr_trace_t bw_trace,
-                                double lat_initial,
-                                tmgr_trace_t lat_trace,
-                                e_surf_resource_state_t
-                                state_initial,
-                                tmgr_trace_t state_trace,
-                                e_surf_link_sharing_policy_t
-                                policy, xbt_dict_t properties);
-  void* (*cpu_create_resource) (const char *name, double power_peak,
-                               double power_scale,
-                               tmgr_trace_t power_trace,
-                               e_surf_resource_state_t state_initial,
-                               tmgr_trace_t state_trace,
-                               xbt_dict_t cpu_properties);
   void (*add_traces) (void);
 
 } s_surf_model_extension_workstation_t;
@@ -298,7 +296,7 @@ typedef struct surf_model {
 
   double (*action_get_start_time) (surf_action_t action);     /**< Return the start time of an action */
   double (*action_get_finish_time) (surf_action_t action);     /**< Return the finish time of an action */
-  int (*action_unref) (surf_action_t action);     /**< Specify that we don't use that action anymore */
+  int (*action_unref) (surf_action_t action);     /**< Specify that we don't use that action anymore. Returns true if the action was destroyed and false if someone still has references on it. */
   void (*action_cancel) (surf_action_t action);     /**< Cancel a running action */
   void (*action_recycle) (surf_action_t action);     /**< Recycle an action */
   void (*action_data_set) (surf_action_t action, void *data);     /**< Set the user data of an action */
@@ -315,6 +313,8 @@ typedef struct surf_model {
   int (*get_latency_limited) (surf_action_t action);     /**< Return 1 if action is limited by latency, 0 otherwise */
 #endif
 
+  void (*gap_remove) (surf_action_lmm_t action);
+
   surf_model_private_t model_private;
 
   union extension {
@@ -322,6 +322,10 @@ typedef struct surf_model {
     s_surf_model_extension_network_t network;
     s_surf_model_extension_storage_t storage;
     s_surf_model_extension_workstation_t workstation;
+    /*******************************************/
+    /* TUTORIAL: New model                     */
+    s_surf_model_extension_new_model_t new_model;
+    /*******************************************/
   } extension;
 } s_surf_model_t;
 
@@ -329,10 +333,10 @@ surf_model_t surf_model_init(void);
 void surf_model_exit(surf_model_t model);
 
 static inline void *surf_cpu_resource_by_name(const char *name) {
-       return xbt_lib_get_or_null(host_lib, name, SURF_CPU_LEVEL);
+  return xbt_lib_get_or_null(host_lib, name, SURF_CPU_LEVEL);
 }
 static inline void *surf_workstation_resource_by_name(const char *name){
-       return xbt_lib_get_or_null(host_lib, name, SURF_WKS_LEVEL);
+  return xbt_lib_get_or_null(host_lib, name, SURF_WKS_LEVEL);
 }
 static inline void *surf_storage_resource_by_name(const char *name){
     return xbt_lib_get_or_null(storage_lib, name, SURF_STORAGE_LEVEL);
@@ -564,11 +568,6 @@ XBT_PUBLIC(void) surf_network_model_init_Vegas(void);
 XBT_PUBLIC_DATA(s_surf_model_description_t)
     surf_network_model_description[];
 
-
-
-
-
-
 /** \ingroup SURF_models
  *  \brief The storage model
  */
@@ -580,12 +579,6 @@ XBT_PUBLIC(void) surf_storage_model_init_default(void);
  */
 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_storage_model_description[];
 
-
-
-
-
-
-
 /** \ingroup SURF_models
  *  \brief The workstation model
  *
@@ -645,6 +638,13 @@ XBT_PUBLIC(void) surf_workstation_model_init_ptask_L07(void);
 XBT_PUBLIC_DATA(s_surf_model_description_t)
     surf_workstation_model_description[];
 
+/*******************************************
+ *  TUTORIAL: New model
+ */
+XBT_PUBLIC(void) surf_new_model_init_default(void);
+XBT_PUBLIC_DATA(s_surf_model_description_t) surf_new_model_description[];
+/*******************************************/
+
 /** \ingroup SURF_models
  *  \brief List of initialized models
  */
@@ -653,7 +653,6 @@ XBT_PUBLIC_DATA(xbt_dynar_t) model_list;
 /*******************************************/
 /*** SURF Globals **************************/
 /*******************************************/
-XBT_PUBLIC_DATA(xbt_cfg_t) _surf_cfg_set;
 
 /** \ingroup SURF_simulation
  *  \brief Initialize SURF
@@ -726,8 +725,20 @@ XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_latency;
 
 XBT_PUBLIC(double) get_cpu_power(const char *power);
 
+XBT_PUBLIC(xbt_dict_t) get_as_router_properties(const char* name);
+
 int surf_get_nthreads(void);
 void surf_set_nthreads(int nthreads);
 
+void surf_watched_hosts(void);
+
+/*
+ * Returns the initial path. On Windows the initial path is
+ * the current directory for the current process in the other
+ * case the function returns "./" that represents the current
+ * directory on Unix/Linux platforms.
+ */
+const char *__surf_get_initial_path(void);
+
 SG_END_DECL()
 #endif                          /* _SURF_SURF_H */