Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
fix: small changes to make surf_routing.c compile
[simgrid.git] / src / include / surf / surf.h
index 08e83e1..58fe9f5 100644 (file)
@@ -1,6 +1,5 @@
-/*     $Id$     */
-
-/* Copyright (c) 2004 Arnaud Legrand. All rights reserved.                  */
+/* Copyright (c) 2004, 2005, 2006, 2007, 2008, 2009, 2010. The SimGrid Team.
+ * All rights reserved.                                                     */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
@@ -23,6 +22,11 @@ SG_BEGIN_DECL()
        SURF_RESOURCE_OFF = 0              /**< Down & broken     */
      } e_surf_resource_state_t;
 
+     typedef enum {
+       SURF_LINK_SHARED = 1,
+       SURF_LINK_FATPIPE = 0
+     } e_surf_link_sharing_policy_t;
+
 /** @Brief Specify that we use that action */
 XBT_PUBLIC(void) surf_action_ref(surf_action_t action);
 /** @brief Creates a new action.
@@ -35,8 +39,6 @@ XBT_PUBLIC(void) surf_action_ref(surf_action_t action);
 XBT_PUBLIC(void *) surf_action_new(size_t size, double cost,
                                    surf_model_t model, int failed);
 
-
-
 /** \brief Resource model description
  */
      typedef struct surf_model_description {
@@ -71,6 +73,10 @@ XBT_PUBLIC(void) model_help(const char* category, s_surf_model_description_t * t
                                   the task is completed) */
        double remains;          /**< How much of that cost remains to
                                 * 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 */
@@ -124,8 +130,9 @@ XBT_PUBLIC(void) model_help(const char* category, s_surf_model_description_t * t
 /***************************/
 /* Generic model object */
 /***************************/
-     typedef struct s_routing s_routing_t, *routing_t;
-XBT_PUBLIC_DATA(routing_t) used_routing;
+     typedef struct s_routing_global s_routing_global_t, *routing_global_t;
+XBT_PUBLIC_DATA(routing_global_t) global_routing;
+
 
 /** \brief Private data available on all models
  *  \ingroup SURF_models
@@ -155,6 +162,13 @@ XBT_PUBLIC_DATA(routing_t) used_routing;
        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)(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_cpu_t;
 
      /* Network model */
@@ -166,12 +180,23 @@ XBT_PUBLIC_DATA(routing_t) used_routing;
       */
      typedef struct surf_network_model_extension_public {
        surf_action_t(*communicate) (const char *src_name,
-                                    const char *dst_name, int src, int dst,
+                                    const char *dst_name,
                                     double size, double rate);
-       xbt_dynar_t(*get_route) (int src, int dst);
+       xbt_dynar_t(*get_route) (const char *src_name, const char *dst_name);
        double (*get_link_bandwidth) (const void *link);
        double (*get_link_latency) (const void *link);
        int (*link_shared) (const void *link);
+       void (*add_traces)(void);
+       void (*create_resource)(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;
 
      /** \brief Workstation model extension public
@@ -199,9 +224,30 @@ XBT_PUBLIC_DATA(routing_t) used_routing;
        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 */
        int (*link_shared) (const void *link);
-         xbt_dict_t(*get_properties) (const void *resource);
+       xbt_dict_t(*get_properties) (const void *resource);
+       void (*link_create_resource) (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) (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;
 
+
+
+
 /** \brief Model datatype
  *  \ingroup SURF_models
  *
@@ -230,15 +276,16 @@ XBT_PUBLIC_DATA(routing_t) used_routing;
        void (*set_max_duration) (surf_action_t action, double duration);/**< Set the max duration of an action*/
        void (*set_priority) (surf_action_t action, double priority);/**< Set the priority of an action */
        double (*get_remains) (surf_action_t action);/**< Get the remains of an action */
+#ifdef HAVE_LATENCY_BOUND_TRACKING
+       int (*get_latency_limited) (surf_action_t action);/**< Return 1 if action is limited by latency, 0 otherwise */
+#endif
 
        xbt_dict_t resource_set;
 
 
-
        surf_model_private_t model_private;
 
 
-
        union extension {
          s_surf_model_extension_timer_t timer;
          s_surf_model_extension_cpu_t cpu;
@@ -331,6 +378,11 @@ XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[];
 
 XBT_PUBLIC(void) create_workstations(void);
 
+/**\brief create new host bypass the parser
+ *
+ */
+
+
 /** \brief The network model
  *  \ingroup SURF_models
  *
@@ -341,6 +393,18 @@ XBT_PUBLIC(void) create_workstations(void);
  */
 XBT_PUBLIC_DATA(surf_model_t) surf_network_model;
 
+/** \brief Same as network model 'LagrangeVelho', only with different correction factors.
+ *  \ingroup SURF_models
+ *  \param filename XML platform file name
+ *
+ * This model is proposed by Pierre-Nicolas Clauss and Martin Quinson and Stéphane Génaud
+ * based on the model 'LV08' and different correction factors depending on the communication
+ * size (< 1KiB, < 64KiB, >= 64KiB).
+ *
+ *  \see surf_workstation_model_init_SMPI()
+ */
+XBT_PUBLIC(void) surf_network_model_init_SMPI(const char *filename);
+
 /** \brief Initializes the platform with the network model 'LagrangeVelho'
  *  \ingroup SURF_models
  *  \param filename XML platform file name
@@ -367,6 +431,8 @@ XBT_PUBLIC(void) surf_network_model_init_LegrandVelho(const char *filename);
  */
 XBT_PUBLIC(void) surf_network_model_init_Constant(const char *filename);
 
+XBT_PUBLIC(void) surf_network_model_init_Vivaldi(const char *filename);
+
 /** \brief Initializes the platform with the network model CM02
  *  \ingroup SURF_models
  *  \param filename XML platform file name
@@ -378,6 +444,11 @@ XBT_PUBLIC(void) surf_network_model_init_Constant(const char *filename);
  */
 XBT_PUBLIC(void) surf_network_model_init_CM02(const char *filename);
 
+/**
+ * brief initialize the the network model bypassing the XML parser
+ */
+XBT_PUBLIC(void) surf_network_model_init_bypass(const char* id,double initial_bw,double initial_lat);
+
 #ifdef HAVE_GTNETS
 /** \brief Initializes the platform with the network model GTNETS
  *  \ingroup SURF_models
@@ -593,16 +664,6 @@ XBT_PUBLIC(void) parse_platform_file(const char *file);
 /* Stores the sets */
 XBT_PUBLIC_DATA(xbt_dict_t) set_list;
 
-XBT_PUBLIC_DATA(void) manage_route(xbt_dict_t route_table,
-                                   const char *route_name, int action,
-                                   int isMultiRoute);
-XBT_PUBLIC_DATA(int) route_action;
-
-/* This is used by all models when creating the routing table while parsing */
-XBT_PUBLIC_DATA(xbt_dict_t) route_table;
-XBT_PUBLIC_DATA(xbt_dict_t) route_multi_table;
-
-
 /* For the trace and trace:connect tag (store their content till the end of the parsing) */
 XBT_PUBLIC_DATA(xbt_dict_t) traces_set_list;
 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_host_avail;
@@ -614,6 +675,102 @@ XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_latency;
 
 XBT_PUBLIC(double) get_cpu_power(const char *power);
 
+/*public interface to create resource bypassing the parser via cpu/network model
+ *
+ * see surfxml_parse.c
+ * */
+XBT_PUBLIC(void) surf_host_create_resource(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);
+
+/*public interface to create resource bypassing the parser via workstation_ptask_L07 model
+ *
+ * see surfxml_parse.c
+ * */
+XBT_PUBLIC(void) surf_wsL07_host_create_resource(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);
+/**
+ * create link resource
+ * see surfxml_parse.c
+ */
+XBT_PUBLIC(void) surf_link_create_resource(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);
+
+
+XBT_PUBLIC(void) surf_wsL07_link_create_resource(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);
+/**
+ * add route element (link_ctn) bypassing the parser
+ *
+ * see surfxml_parse.c
+ *
+ */
+XBT_PUBLIC(void) surf_add_route_element(char *link_ctn_id);
+
+/**
+ * set route src_id,dest_id, and create a route resource
+ *
+ * see surf_routing.c && surfxml_parse.c
+ */
+
+XBT_PUBLIC(void) surf_set_routes(void);
+
+
+/**
+ * add traces
+ * see surfxml_parse.c
+ */
+XBT_PUBLIC(void) surf_add_host_traces(void);
+XBT_PUBLIC(void) surf_add_link_traces(void);
+XBT_PUBLIC(void) surf_wsL07_add_traces(void);
+
+/*
+ * init AS from lua console
+ * see surf_routing.c
+ */
+XBT_PUBLIC(void) routing_AS_init(const char* id,const char *mode);
+XBT_PUBLIC(void) routing_AS_end(const char* id);
+// add host to network element list
+XBT_PUBLIC(void) routing_add_host(const char * host_id);
+//Set a new link on the actual list of link for a route or ASroute
+XBT_PUBLIC(void) routing_add_link(const char *link_id);
+//Set the endpoints for a route
+XBT_PUBLIC(void) routing_set_route(const char* src_id,const char* dst_id);
+//Store the route
+XBT_PUBLIC(void) routing_store_route(void);
+
+/*
+ * interface between surf and lua bindings
+ * see surfxml_parse.c
+ */
+XBT_PUBLIC(void) surf_AS_new(const char* id,const char *mode);
+XBT_PUBLIC(void) surf_AS_finalize(const char*id);
+XBT_PUBLIC(void) surf_route_add_host(const char*id);
+XBT_PUBLIC(void) surf_routing_add_route(const char* src_id,const char *dest_id,xbt_dynar_t links_id);
+
 #include "surf/surf_resource.h"
 #include "surf/surf_resource_lmm.h"