Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
what is that pimple, for god's sake??
[simgrid.git] / src / surf / surf_private.h
index ddd2ca4..bc442cb 100644 (file)
@@ -1,10 +1,8 @@
-/*     $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. */
-
 #ifndef _SURF_SURF_PRIVATE_H
 #define _SURF_SURF_PRIVATE_H
 
 #include "xbt/log.h"
 #include "surf/surfxml_parse_private.h"
 #include "surf/random_mgr.h"
+#include "instr/instr_private.h"
+#include "surf/surfxml_parse_values.h"
 
 #define NO_MAX_DURATION -1.0
+
+/* 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;
+#ifdef HAVE_GTNETS
+extern double sg_gtnets_jitter;
+extern int sg_gtnets_jitter_seed;
+#endif
 
-extern const char *surf_action_state_names[6];
 
-typedef enum {
-  SURF_LINK_SHARED = 1,
-  SURF_LINK_FATPIPE = 0
-} e_surf_link_sharing_policy_t;
+extern const char *surf_action_state_names[6];
 
 typedef struct surf_model_private {
   int (*resource_used) (void *resource_id);
@@ -44,13 +51,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);
-double surf_action_get_start_time(surf_action_t action);
-double surf_action_get_finish_time(surf_action_t action);
+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);
+                           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;
@@ -60,7 +69,12 @@ void surf_config_init(int *argc, char **argv);
 void surf_config_finalize(void);
 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_limited(surf_action_t action);
+#endif
+void net_action_set_max_duration(surf_action_t action, double duration);
 /*
  * Returns the initial path. On Windows the initial path is
  * the current directory for the current process in the other
@@ -78,37 +92,113 @@ int __surf_is_absolute_file_path(const char *file_path);
 /*
  * One link routing list
  */
-typedef struct {
-       int src_id;
-       int dst_id;
-       void *link_ptr;
-}s_onelink, *s_onelink_t;
-
+typedef struct s_onelink {
+  char *src;
+  char *dst;
+  void *link_ptr;
+} s_onelink_t, *onelink_t;
 
-/*
+/**
  * Routing logic
  */
-struct s_routing {
+typedef struct s_routing_component *routing_component_t;
+
+typedef struct s_model_type {
   const char *name;
-  xbt_dict_t host_id; /* char* -> int* */
-  xbt_dynar_t (*get_route)(int src, int dst);
-  xbt_dict_t (*get_onelink_routes)(void);
-  int (*is_router)(int id);
-  void (*finalize)(void);
-  int host_count;
-  int router_count;
+  const char *desc;
+  routing_component_t (*create) ();
+  void (*load) ();     /* Add parsing callbacks for the time of the creation of this AS
+                          FIXME: that feature is unused and could maybe be killed? */
+  void (*unload) ();   /* Remove the callbacks at the end of this AS's creation
+                          FIXME: that feature is unused and could maybe be killed? */
+  void (*end) ();
+} s_model_type_t, *model_type_t;
+
+typedef struct s_route {
+  xbt_dynar_t link_list;
+} s_route_t, *route_t;
+
+typedef struct s_name_route_extended {
+  s_route_t generic_route;
+  char *src_gateway;
+  char *dst_gateway;
+} s_name_route_extended_t, *name_route_extended_t;
+
+typedef struct s_route_extended {
+  s_route_t generic_route;
+  char *src_gateway;
+  char *dst_gateway;
+} s_route_extended_t, *route_extended_t;
+
+/* This enum used in the routing structure helps knowing in which situation we are. */
+typedef enum {
+  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;
+
+typedef struct s_routing_component {
+  xbt_dict_t to_index;                 /* char* -> network_element_t */
+  xbt_dict_t bypassRoutes;             /* store bypass routes */
+  model_type_t routing;
+  e_surf_routing_hierarchy_t hierarchy;
+  char *name;
+  struct s_routing_component *routing_father;
+  xbt_dict_t routing_sons;
+   route_extended_t(*get_route) (routing_component_t rc, const char *src,
+                                 const char *dst);
+   double(*get_latency) (routing_component_t rc, const char *src,
+                                 const char *dst, route_extended_t e_route);
+   xbt_dynar_t(*get_onelink_routes) (routing_component_t rc);
+   e_surf_network_element_type_t(*get_network_element_type) (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, name_route_extended_t route);
+  void (*set_ASroute) (routing_component_t rc, const char *src,
+                       const char *dst, name_route_extended_t route);
+  void (*set_bypassroute) (routing_component_t rc, const char *src,
+                           const char *dst, route_extended_t e_route);
+} s_routing_component_t;
+
+typedef struct s_network_element_info {
+  routing_component_t rc_component;
+  e_surf_network_element_type_t rc_type;
+} s_network_element_info_t, *network_element_info_t;
+
+typedef int *network_element_t;
+
+struct s_routing_global {
+  routing_component_t root;
+  void *loopback;
+  size_t size_of_link;
+  xbt_dynar_t(*get_route) (const char *src, const char *dst);
+  xbt_dynar_t(*get_route_or_null) (const char *src, const char *dst);
+  xbt_dynar_t(*get_route_no_cleanup) (const char *src, const char *dst);
+  xbt_dynar_t(*get_onelink_routes) (void);
+  double (*get_latency) (const char *src, const char *dst);
+  void (*get_route_latency)(const char *src, const char *dst,
+                            xbt_dynar_t *route, double *latency, int cleanup);
+  e_surf_network_element_type_t(*get_network_element_type) (const char *name);
+  void (*finalize) (void);
+  xbt_dynar_t last_route;
 };
-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_register_callbacks(void);
 
-/*
+/**
  * Resource protected methods
  */
-XBT_PUBLIC(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;
 
+XBT_PUBLIC_DATA(int) surfxml_bufferstack_size;
 
-#endif /* _SURF_SURF_PRIVATE_H */
+#endif                          /* _SURF_SURF_PRIVATE_H */