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_private.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  * One link routing list
  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_routing_component *routing_component_t;
 105
 106 typedef struct s_model_type {
 107   const char *name;
 108   const char *desc;
 109   routing_component_t (*create) ();
 110   void (*load) ();     /* Add parsing callbacks for the time of the creation of this AS
 111                           FIXME: that feature is unused and could maybe be killed? */
 112   void (*unload) ();   /* Remove the callbacks at the end of this AS's creation
 113                           FIXME: that feature is unused and could maybe be killed? */
 114   void (*end) ();
 115 } s_model_type_t, *model_type_t;
 116
 117 typedef struct s_route {
 118   xbt_dynar_t link_list;
 119 } s_route_t, *route_t;
 120
 121 typedef struct s_name_route_extended {
 122   s_route_t generic_route;
 123   char *src_gateway;
 124   char *dst_gateway;
 125 } s_name_route_extended_t, *name_route_extended_t;
 126
 127 typedef struct s_route_extended {
 128   s_route_t generic_route;
 129   char *src_gateway;
 130   char *dst_gateway;
 131 } s_route_extended_t, *route_extended_t;
 132
 133 /* This enum used in the routing structure helps knowing in which situation we are. */
 134 typedef enum {
 135   SURF_ROUTING_NULL = 0,   /**< Undefined type                                   */
 136   SURF_ROUTING_BASE,       /**< Base case: use simple link lists for routing     */
 137   SURF_ROUTING_RECURSIVE   /**< Recursive case: also return gateway informations */
 138 } e_surf_routing_hierarchy_t;
 139
 140 typedef struct s_routing_component *routing_component_t;
 141 typedef struct s_routing_component {
 142   xbt_dict_t to_index;                  /* char* -> network_element_t */
 143   xbt_dict_t bypassRoutes;              /* store bypass routes */
 144   model_type_t routing;
 145   e_surf_routing_hierarchy_t hierarchy;
 146   char *name;
 147   struct s_routing_component *routing_father;
 148   xbt_dict_t routing_sons;
 149    route_extended_t(*get_route) (routing_component_t rc, const char *src,
 150                                  const char *dst);
 151    double(*get_latency) (routing_component_t rc, const char *src,
 152                                  const char *dst, route_extended_t e_route);
 153    xbt_dynar_t(*get_onelink_routes) (routing_component_t rc);
 154    e_surf_network_element_type_t(*get_network_element_type) (const char
 155                                                              *name);
 156    route_extended_t(*get_bypass_route) (routing_component_t rc,
 157                                         const char *src, const char *dst);
 158   void (*finalize) (routing_component_t rc);
 159   void (*set_processing_unit) (routing_component_t rc, const char *name);
 160   void (*set_autonomous_system) (routing_component_t rc, const char *name);
 161   void (*set_route) (routing_component_t rc, const char *src,
 162                      const char *dst, name_route_extended_t route);
 163   void (*set_ASroute) (routing_component_t rc, const char *src,
 164                        const char *dst, name_route_extended_t route);
 165   void (*set_bypassroute) (routing_component_t rc, const char *src,
 166                            const char *dst, route_extended_t e_route);
 167 } s_routing_component_t;
 168
 169 typedef struct s_network_element_info {
 170   routing_component_t rc_component;
 171   e_surf_network_element_type_t rc_type;
 172 } s_network_element_info_t, *network_element_info_t;
 173
 174 typedef int *network_element_t;
 175
 176 struct s_routing_global {
 177   routing_component_t root;
 178   void *loopback;
 179   size_t size_of_link;
 180   xbt_dynar_t(*get_route) (const char *src, const char *dst);
 181   xbt_dynar_t(*get_route_or_null) (const char *src, const char *dst);
 182   xbt_dynar_t(*get_route_no_cleanup) (const char *src, const char *dst);
 183   xbt_dynar_t(*get_onelink_routes) (void);
 184   double (*get_latency) (const char *src, const char *dst);
 185   void (*get_route_latency)(const char *src, const char *dst,
 186                             xbt_dynar_t *route, double *latency, int cleanup);
 187   e_surf_network_element_type_t(*get_network_element_type) (const char *name);
 188   void (*finalize) (void);
 189   xbt_dynar_t last_route;
 190 };
 191
 192 XBT_PUBLIC(void) routing_model_create(size_t size_of_link, void *loopback, double_f_cpvoid_t get_link_latency_fun);
 193 XBT_PUBLIC(void) routing_register_callbacks(void);
 194
 195 /**
 196  * Resource protected methods
 197  */
 198 static XBT_INLINE xbt_dict_t surf_resource_properties(const void *resource);
 199
 200 XBT_PUBLIC(void) surfxml_bufferstack_push(int new);
 201 XBT_PUBLIC(void) surfxml_bufferstack_pop(int new);
 202
 203 XBT_PUBLIC_DATA(int) surfxml_bufferstack_size;
 204
 205 #endif                          /* _SURF_SURF_PRIVATE_H */