Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Prepare optim for xbt_lib-get_or_null
[simgrid.git] / src / surf / surf_private.h
index 9f33fc0..09753e3 100644 (file)
 #include "surf/maxmin.h"
 #include "surf/trace_mgr.h"
 #include "xbt/log.h"
-#include "surf/surfxml_parse_private.h"
+#include "surf/surfxml_parse.h"
 #include "surf/random_mgr.h"
-#include "instr/private.h"
+#include "instr/instr_private.h"
+#include "surf/surfxml_parse_values.h"
 
 #define NO_MAX_DURATION -1.0
 
+typedef enum {
+  UM_FULL,
+  UM_LAZY,
+  UM_UNDEFINED
+} e_UM_t;
+
 /* 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_fullduplex;
+extern int sg_network_crosstraffic;
 #ifdef HAVE_GTNETS
-  extern double sg_gtnets_jitter;
-  extern int sg_gtnets_jitter_seed;
+extern double sg_gtnets_jitter;
+extern int sg_gtnets_jitter_seed;
 #endif
 
 
@@ -49,12 +57,15 @@ double generic_maxmin_share_resources(xbt_swag_t running_actions,
                                       void (*solve) (lmm_system_t));
 
 /* Generic functions common to all models */
-e_surf_action_state_t surf_action_state_get(surf_action_t action); /* cannot declare inline since we use a pointer to it */
-double surf_action_get_start_time(surf_action_t action); /* cannot declare inline since we use a pointer to it */
-double surf_action_get_finish_time(surf_action_t action); /* cannot declare inline since we use a pointer to it */
+void surf_action_init(void);
+void surf_action_exit(void);
+e_surf_action_state_t surf_action_state_get(surf_action_t action);      /* cannot declare inline since we use a pointer to it */
+double surf_action_get_start_time(surf_action_t action);        /* cannot declare inline since we use a pointer to it */
+double surf_action_get_finish_time(surf_action_t action);       /* cannot declare inline since we use a pointer to it */
 void surf_action_free(surf_action_t * action);
-void surf_action_state_set(surf_action_t action, e_surf_action_state_t state);
-void surf_action_data_set(surf_action_t action, void *data); /* cannot declare inline since we use a pointer to it */
+void surf_action_state_set(surf_action_t action,
+                           e_surf_action_state_t state);
+void surf_action_data_set(surf_action_t action, void *data);    /* cannot declare inline since we use a pointer to it */
 FILE *surf_fopen(const char *name, const char *mode);
 
 extern tmgr_history_t history;
@@ -67,7 +78,7 @@ void surf_config(const char *name, va_list pa);
 void net_action_recycle(surf_action_t action);
 double net_action_get_remains(surf_action_t action);
 #ifdef HAVE_LATENCY_BOUND_TRACKING
-int net_get_link_latency(surf_action_t action);
+int net_get_link_latency_limited(surf_action_t action);
 #endif
 void net_action_set_max_duration(surf_action_t action, double duration);
 /*
@@ -85,114 +96,104 @@ const char *__surf_get_initial_path(void);
 int __surf_is_absolute_file_path(const char *file_path);
 
 /*
- * One link routing list
+ * Link of lenght 1, alongside with its source and destination. This is mainly usefull in the bindings to gtnets and ns3
  */
-typedef struct s_onelink s_onelink_t, *onelink_t;
-struct s_onelink{
-       char *src;
-       char *dst;
-       void *link_ptr;
-};
-
+typedef struct s_onelink {
+  char *src;
+  char *dst;
+  void *link_ptr;
+} s_onelink_t, *onelink_t;
 
 /**
  * Routing logic
  */
+typedef struct s_as *AS_t;
 
-typedef enum {
-  SURF_NETWORK_ELEMENT_NULL = 0,   /* NULL */
-  SURF_NETWORK_ELEMENT_HOST,       /* host type */
-  SURF_NETWORK_ELEMENT_ROUTER,     /* router type */
-  SURF_NETWORK_ELEMENT_GATEWAY,    /* gateway type of the AS */
-  SURF_NETWORK_ELEMENT_AS,         /* AS type */
-  SURF_NETWORK_ELEMENT_AS_GATEWAY, /* gateway type for internals AS */
-  SURF_NETWORK_ELEMENT_LINK        /* link type */
-} e_surf_network_element_type_t;
-
-typedef struct s_model_type s_model_type_t, *model_type_t;
-typedef struct s_network_element s_network_element_t, *network_element_t;
-typedef struct s_route s_route_t, *route_t;
-typedef struct s_route_limits s_route_limits_t, *route_limits_t;
-typedef struct s_route_extended s_route_extended_t, *route_extended_t;
-typedef struct s_routing_component s_routing_component_t, *routing_component_t;
-//typedef struct s_routing_global s_routing_global_t, *routing_global_t;
-
-struct s_model_type {
+typedef struct s_model_type {
   const char *name;
   const char *desc;
-  void* (*create)();
-  void (*load)();
-  void (*unload)();
-  void (*end)();
-};
-
-struct s_network_element {
-  //int id;
-  e_surf_network_element_type_t type;
-};
+  AS_t (*create) ();
+  void (*end) (AS_t as);
+} s_routing_model_description_t, *routing_model_description_t;
 
-struct s_route {
+typedef struct s_route {
   xbt_dynar_t link_list;
-};
-
-struct s_route_limits {
-  char* src_gateway;
-  char* dst_gateway;
-};
-
-struct s_route_extended {
-  s_route_t generic_route;
-  char* src_gateway;
-  char* dst_gateway;
-};
+  char *src_gateway;
+  char *dst_gateway;
+} s_route_t, *route_t;
 
 /* This enum used in the routing structure helps knowing in which situation we are. */
 typedef enum {
-  SURF_ROUTING_NULL = 0,   /**< Indefined type                                   */ 
+  SURF_ROUTING_NULL = 0,   /**< Undefined type                                   */
   SURF_ROUTING_BASE,       /**< Base case: use simple link lists for routing     */
   SURF_ROUTING_RECURSIVE   /**< Recursive case: also return gateway informations */
 } e_surf_routing_hierarchy_t;
 
-struct s_routing_component {
-  model_type_t routing;
+typedef struct s_as {
+  xbt_dict_t to_index;                 /* char* -> network_element_t */
+  xbt_dict_t bypassRoutes;             /* store bypass routes */
+  routing_model_description_t model_desc;
   e_surf_routing_hierarchy_t hierarchy;
   char *name;
-  struct s_routing_component* routing_father;
+  struct s_as *routing_father;
   xbt_dict_t routing_sons;
-  route_extended_t (*get_route)(routing_component_t rc, const char* src, const char* dst);
-  xbt_dynar_t (*get_onelink_routes)(routing_component_t rc);
-  int (*is_router)(routing_component_t rc, const char *name);
-  route_extended_t (*get_bypass_route)(routing_component_t rc, const char* src, const char* dst);
-  void (*finalize)(routing_component_t rc);
-  void (*set_processing_unit)(routing_component_t rc, const char* name);
-  void (*set_autonomous_system)(routing_component_t rc, const char* name);
-  void (*set_route)(routing_component_t rc, const char* src, const char* dst, route_t route);
-  void (*set_ASroute)(routing_component_t rc, const char* src, const char* dst, route_extended_t route);
-  void (*set_bypassroute)(routing_component_t rc, const char* src, const char* dst, route_extended_t e_route);
-};
+
+  void (*get_route_and_latency) (AS_t as, const char *src, const char *dst, route_t into, double *latency);
+
+  xbt_dynar_t(*get_onelink_routes) (AS_t as);
+  route_t(*get_bypass_route) (AS_t as, const char *src, const char *dst);
+  void (*finalize) (AS_t as);
+
+
+  /* The parser calls the following functions to inform the routing models
+   * that a new element is added to the AS currently built.
+   *
+   * Of course, only the routing model of this AS is informed, not every ones */
+  void (*parse_PU) (AS_t as, const char *name); /* A host or a router, whatever */
+  void (*parse_AS) (AS_t as, const char *name);
+  void (*parse_route) (AS_t as, const char *src,
+                     const char *dst, route_t route);
+  void (*parse_ASroute) (AS_t as, const char *src,
+                       const char *dst, route_t route);
+  void (*parse_bypassroute) (AS_t as, const char *src,
+                           const char *dst, route_t e_route);
+} s_as_t;
+
+typedef struct s_network_element_info {
+  AS_t rc_component;
+  e_surf_network_element_type_t rc_type;
+  int id;
+  char *name;
+} s_network_element_info_t, *network_element_info_t;
+
+typedef int *network_element_t;
 
 struct s_routing_global {
-  routing_component_t root;
-  xbt_dict_t where_network_elements; /* char* -> s_routing_component* */
+  AS_t root;
   void *loopback;
   size_t size_of_link;
-  xbt_dynar_t (*get_route)(const char* src, const char* dst);
-  xbt_dynar_t (*get_onelink_routes)(void);
-  int (*is_router)(const char *name);
-  void (*finalize)(void);
   xbt_dynar_t last_route;
+  xbt_dynar_t(*get_onelink_routes) (void);
 };
 
-XBT_PUBLIC(void) routing_model_create(size_t size_of_link,void *loopback);
+XBT_PUBLIC(void) routing_model_create(size_t size_of_link, void *loopback);
+XBT_PUBLIC(void) routing_exit(void);
+XBT_PUBLIC(void) routing_register_callbacks(void);
+XBT_PUBLIC(void) generic_free_route(route_t route); // FIXME rename to routing_route_free
+ // FIXME: make previous function private to routing again?
+
+
+XBT_PUBLIC(void) routing_get_route_and_latency(const char *src, const char *dst,
+                              xbt_dynar_t * route, double *latency);
 
 /**
  * Resource protected methods
  */
-xbt_dict_t surf_resource_properties(const void *resource);
+static XBT_INLINE xbt_dict_t surf_resource_properties(const void *resource);
 
 XBT_PUBLIC(void) surfxml_bufferstack_push(int new);
 XBT_PUBLIC(void) surfxml_bufferstack_pop(int new);
 
 XBT_PUBLIC_DATA(int) surfxml_bufferstack_size;
 
-#endif /* _SURF_SURF_PRIVATE_H */
+#endif                          /* _SURF_SURF_PRIVATE_H */