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