src/surf/surf_private.h

   1 /* Copyright (c) 2004, 2005, 2006, 2007, 2008, 2009, 2010. The SimGrid Team.
   2  * All rights reserved.                                                     */
   3
   4 /* This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the license (GNU LGPL) which comes with this package. */
   6 #ifndef _SURF_SURF_PRIVATE_H
   7 #define _SURF_SURF_PRIVATE_H
   8
   9 #include "surf/surf.h"
  10 #include "surf/maxmin.h"
  11 #include "surf/trace_mgr.h"
  12 #include "xbt/log.h"
  13 #include "surf/surfxml_parse.h"
  14 #include "surf/random_mgr.h"
  15 #include "instr/instr_private.h"
  16 #include "surf/surfxml_parse_values.h"
  17
  18 #define NO_MAX_DURATION -1.0
  19
  20 /* user-visible parameters */
  21 extern double sg_tcp_gamma;
  22 extern double sg_sender_gap;
  23 extern double sg_latency_factor;
  24 extern double sg_bandwidth_factor;
  25 extern double sg_weight_S_parameter;
  26 extern int sg_maxmin_selective_update;
  27 extern int sg_network_fullduplex;
  28 #ifdef HAVE_GTNETS
  29 extern double sg_gtnets_jitter;
  30 extern int sg_gtnets_jitter_seed;
  31 #endif
  32
  33
  34 extern const char *surf_action_state_names[6];
  35
  36 typedef struct surf_model_private {
  37   int (*resource_used) (void *resource_id);
  38   /* Share the resources to the actions and return in how much time
  39      the next action may terminate */
  40   double (*share_resources) (double now);
  41   /* Update the actions' state */
  42   void (*update_actions_state) (double now, double delta);
  43   void (*update_resource_state) (void *id, tmgr_trace_event_t event_type,
  44                                  double value, double time);
  45   void (*finalize) (void);
  46 } s_surf_model_private_t;
  47
  48 double generic_maxmin_share_resources(xbt_swag_t running_actions,
  49                                       size_t offset,
  50                                       lmm_system_t sys,
  51                                       void (*solve) (lmm_system_t));
  52
  53 /* Generic functions common to all models */
  54 void surf_action_init(void);
  55 void surf_action_exit(void);
  56 e_surf_action_state_t surf_action_state_get(surf_action_t action);      /* cannot declare inline since we use a pointer to it */
  57 double surf_action_get_start_time(surf_action_t action);        /* cannot declare inline since we use a pointer to it */
  58 double surf_action_get_finish_time(surf_action_t action);       /* cannot declare inline since we use a pointer to it */
  59 void surf_action_free(surf_action_t * action);
  60 void surf_action_state_set(surf_action_t action,
  61                            e_surf_action_state_t state);
  62 void surf_action_data_set(surf_action_t action, void *data);    /* cannot declare inline since we use a pointer to it */
  63 FILE *surf_fopen(const char *name, const char *mode);
  64
  65 extern tmgr_history_t history;
  66 extern xbt_dynar_t surf_path;
  67
  68 void surf_config_init(int *argc, char **argv);
  69 void surf_config_finalize(void);
  70 void surf_config(const char *name, va_list pa);
  71
  72 void net_action_recycle(surf_action_t action);
  73 double net_action_get_remains(surf_action_t action);
  74 #ifdef HAVE_LATENCY_BOUND_TRACKING
  75 int net_get_link_latency_limited(surf_action_t action);
  76 #endif
  77 void net_action_set_max_duration(surf_action_t action, double duration);
  78 /*
  79  * Returns the initial path. On Windows the initial path is
  80  * the current directory for the current process in the other
  81  * case the function returns "./" that represents the current
  82  * directory on Unix/Linux platforms.
  83  */
  84 const char *__surf_get_initial_path(void);
  85
  86 /* The __surf_is_absolute_file_path() returns 1 if
  87  * file_path is a absolute file path, in the other
  88  * case the function returns 0.
  89  */
  90 int __surf_is_absolute_file_path(const char *file_path);
  91
  92 /*
  93  * Link of lenght 1, alongside with its source and destination. This is mainly usefull in the bindings to gtnets and ns3
  94  */
  95 typedef struct s_onelink {
  96   char *src;
  97   char *dst;
  98   void *link_ptr;
  99 } s_onelink_t, *onelink_t;
 100
 101 /**
 102  * Routing logic
 103  */
 104 typedef struct s_as *AS_t;
 105
 106 typedef struct s_model_type {
 107   const char *name;
 108   const char *desc;
 109   AS_t (*create) ();
 110   void (*end) (AS_t as);
 111 } s_routing_model_description_t, *routing_model_description_t;
 112
 113 typedef struct s_route {
 114   xbt_dynar_t link_list;
 115   char *src_gateway;
 116   char *dst_gateway;
 117 } s_route_t, *route_t;
 118
 119 /* This enum used in the routing structure helps knowing in which situation we are. */
 120 typedef enum {
 121   SURF_ROUTING_NULL = 0,   /**< Undefined type                                   */
 122   SURF_ROUTING_BASE,       /**< Base case: use simple link lists for routing     */
 123   SURF_ROUTING_RECURSIVE   /**< Recursive case: also return gateway informations */
 124 } e_surf_routing_hierarchy_t;
 125
 126 typedef struct s_as {
 127   xbt_dict_t to_index;                  /* char* -> network_element_t */
 128   xbt_dict_t bypassRoutes;              /* store bypass routes */
 129   routing_model_description_t model_desc;
 130   e_surf_routing_hierarchy_t hierarchy;
 131   char *name;
 132   struct s_as *routing_father;
 133   xbt_dict_t routing_sons;
 134
 135   void (*get_route_and_latency) (AS_t as, const char *src, const char *dst, route_t into, double *latency);
 136
 137   xbt_dynar_t(*get_onelink_routes) (AS_t as);
 138   route_t(*get_bypass_route) (AS_t as, const char *src, const char *dst);
 139   void (*finalize) (AS_t as);
 140
 141
 142   /* The parser calls the following functions to inform the routing models
 143    * that a new element is added to the AS currently built.
 144    *
 145    * Of course, only the routing model of this AS is informed, not every ones */
 146   void (*parse_PU) (AS_t as, const char *name); /* A host or a router, whatever */
 147   void (*parse_AS) (AS_t as, const char *name);
 148   void (*parse_route) (AS_t as, const char *src,
 149                      const char *dst, route_t route);
 150   void (*parse_ASroute) (AS_t as, const char *src,
 151                        const char *dst, route_t route);
 152   void (*parse_bypassroute) (AS_t as, const char *src,
 153                            const char *dst, route_t e_route);
 154 } s_as_t;
 155
 156 typedef struct s_network_element_info {
 157   AS_t rc_component;
 158   e_surf_network_element_type_t rc_type;
 159 } s_network_element_info_t, *network_element_info_t;
 160
 161 typedef int *network_element_t;
 162
 163 struct s_routing_global {
 164   AS_t root;
 165   void *loopback;
 166   size_t size_of_link;
 167   xbt_dynar_t last_route;
 168   xbt_dynar_t(*get_onelink_routes) (void);
 169 };
 170
 171 XBT_PUBLIC(void) routing_model_create(size_t size_of_link, void *loopback);
 172 XBT_PUBLIC(void) routing_exit(void);
 173 XBT_PUBLIC(void) routing_register_callbacks(void);
 174 XBT_PUBLIC(void) generic_free_route(route_t route); // FIXME rename to routing_route_free
 175  // FIXME: make previous function private to routing again?
 176
 177
 178 XBT_PUBLIC(void) routing_get_route_and_latency(const char *src, const char *dst,
 179                               xbt_dynar_t * route, double *latency);
 180
 181 /**
 182  * Resource protected methods
 183  */
 184 static XBT_INLINE xbt_dict_t surf_resource_properties(const void *resource);
 185
 186 XBT_PUBLIC(void) surfxml_bufferstack_push(int new);
 187 XBT_PUBLIC(void) surfxml_bufferstack_pop(int new);
 188
 189 XBT_PUBLIC_DATA(int) surfxml_bufferstack_size;
 190
 191 #endif                          /* _SURF_SURF_PRIVATE_H */