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/private.h"
  16
  17 #define NO_MAX_DURATION -1.0
  18
  19 /* user-visible parameters */
  20 extern double sg_tcp_gamma;
  21 extern double sg_latency_factor;
  22 extern double sg_bandwidth_factor;
  23 extern double sg_weight_S_parameter;
  24 extern int sg_maxmin_selective_update;
  25 extern int sg_network_fullduplex;
  26 #ifdef HAVE_GTNETS
  27   extern double sg_gtnets_jitter;
  28   extern int sg_gtnets_jitter_seed;
  29 #endif
  30
  31
  32 extern const char *surf_action_state_names[6];
  33
  34 typedef struct surf_model_private {
  35   int (*resource_used) (void *resource_id);
  36   /* Share the resources to the actions and return in how much time
  37      the next action may terminate */
  38   double (*share_resources) (double now);
  39   /* Update the actions' state */
  40   void (*update_actions_state) (double now, double delta);
  41   void (*update_resource_state) (void *id, tmgr_trace_event_t event_type,
  42                                  double value, double time);
  43   void (*finalize) (void);
  44 } s_surf_model_private_t;
  45
  46 double generic_maxmin_share_resources(xbt_swag_t running_actions,
  47                                       size_t offset,
  48                                       lmm_system_t sys,
  49                                       void (*solve) (lmm_system_t));
  50
  51 /* Generic functions common to all models */
  52 e_surf_action_state_t surf_action_state_get(surf_action_t action); /* cannot declare inline since we use a pointer to it */
  53 double surf_action_get_start_time(surf_action_t action); /* cannot declare inline since we use a pointer to it */
  54 double surf_action_get_finish_time(surf_action_t action); /* cannot declare inline since we use a pointer to it */
  55 void surf_action_free(surf_action_t * action);
  56 void surf_action_state_set(surf_action_t action, e_surf_action_state_t state);
  57 void surf_action_data_set(surf_action_t action, void *data); /* cannot declare inline since we use a pointer to it */
  58 FILE *surf_fopen(const char *name, const char *mode);
  59
  60 extern tmgr_history_t history;
  61 extern xbt_dynar_t surf_path;
  62
  63 void surf_config_init(int *argc, char **argv);
  64 void surf_config_finalize(void);
  65 void surf_config(const char *name, va_list pa);
  66
  67 void net_action_recycle(surf_action_t action);
  68 double net_action_get_remains(surf_action_t action);
  69 #ifdef HAVE_LATENCY_BOUND_TRACKING
  70 int net_get_link_latency(surf_action_t action);
  71 #endif
  72 void net_action_set_max_duration(surf_action_t action, double duration);
  73 /*
  74  * Returns the initial path. On Windows the initial path is
  75  * the current directory for the current process in the other
  76  * case the function returns "./" that represents the current
  77  * directory on Unix/Linux platforms.
  78  */
  79 const char *__surf_get_initial_path(void);
  80
  81 /* The __surf_is_absolute_file_path() returns 1 if
  82  * file_path is a absolute file path, in the other
  83  * case the function returns 0.
  84  */
  85 int __surf_is_absolute_file_path(const char *file_path);
  86
  87 /*
  88  * One link routing list
  89  */
  90 typedef struct s_onelink {
  91         char *src;
  92         char *dst;
  93         void *link_ptr;
  94 } s_onelink_t, *onelink_t;
  95
  96 /**
  97  * Routing logic
  98  */
  99
 100 typedef struct s_model_type {
 101           const char *name;
 102           const char *desc;
 103           void* (*create)();
 104           void (*load)();
 105           void (*unload)();
 106           void (*end)();
 107 } s_model_type_t, *model_type_t;
 108
 109 typedef struct s_route  {
 110   xbt_dynar_t link_list;
 111 } s_route_t, *route_t;
 112
 113 typedef struct s_route_limits {
 114           char* src_gateway;
 115           char* dst_gateway;
 116 } s_route_limits_t, *route_limits_t;
 117
 118 typedef struct s_route_extended {
 119           s_route_t generic_route;
 120           char* src_gateway;
 121           char* dst_gateway;
 122 } s_route_extended_t, *route_extended_t;
 123
 124 /* This enum used in the routing structure helps knowing in which situation we are. */
 125 typedef enum {
 126   SURF_ROUTING_NULL = 0,   /**< Indefined type                                   */
 127   SURF_ROUTING_BASE,       /**< Base case: use simple link lists for routing     */
 128   SURF_ROUTING_RECURSIVE   /**< Recursive case: also return gateway informations */
 129 } e_surf_routing_hierarchy_t;
 130
 131 typedef enum {
 132   SURF_NETWORK_ELEMENT_NULL = 0,   /* NULL */
 133   SURF_NETWORK_ELEMENT_HOST,       /* host type */
 134   SURF_NETWORK_ELEMENT_ROUTER,     /* router type */
 135   SURF_NETWORK_ELEMENT_AS,         /* AS type */
 136 } e_surf_network_element_type_t;
 137
 138 typedef struct s_routing_component *routing_component_t;
 139 typedef struct s_routing_component {
 140           model_type_t routing;
 141           e_surf_routing_hierarchy_t hierarchy;
 142           char *name;
 143           struct s_routing_component* routing_father;
 144           xbt_dict_t routing_sons;
 145           route_extended_t (*get_route)(routing_component_t rc, const char* src, const char* dst);
 146           xbt_dynar_t (*get_onelink_routes)(routing_component_t rc);
 147           e_surf_network_element_type_t (*get_network_element_type) (const char *name);
 148           route_extended_t (*get_bypass_route)(routing_component_t rc, const char* src, const char* dst);
 149           void (*finalize)(routing_component_t rc);
 150           void (*set_processing_unit)(routing_component_t rc, const char* name);
 151           void (*set_autonomous_system)(routing_component_t rc, const char* name);
 152           void (*set_route)(routing_component_t rc, const char* src, const char* dst, route_t route);
 153           void (*set_ASroute)(routing_component_t rc, const char* src, const char* dst, route_extended_t route);
 154           void (*set_bypassroute)(routing_component_t rc, const char* src, const char* dst, route_extended_t e_route);
 155 } s_routing_component_t;
 156
 157 typedef struct s_network_element_info {
 158         routing_component_t rc_component;
 159         e_surf_network_element_type_t rc_type;
 160 } s_network_element_info_t, *network_element_info_t;
 161
 162 typedef int *network_element_t;
 163
 164 struct s_routing_global {
 165   routing_component_t root;
 166   xbt_dict_t where_network_elements; /* char* -> network_element_info_t */
 167   void *loopback;
 168   size_t size_of_link;
 169   xbt_dynar_t (*get_route)(const char* src, const char* dst);
 170   xbt_dynar_t (*get_onelink_routes)(void);
 171   e_surf_network_element_type_t (*get_network_element_type)(const char *name);
 172   void (*finalize)(void);
 173   xbt_dynar_t last_route;
 174 };
 175
 176 XBT_PUBLIC(void) routing_model_create(size_t size_of_link,void *loopback);
 177
 178 /**
 179  * Resource protected methods
 180  */
 181 xbt_dict_t surf_resource_properties(const void *resource);
 182
 183 XBT_PUBLIC(void) surfxml_bufferstack_push(int new);
 184 XBT_PUBLIC(void) surfxml_bufferstack_pop(int new);
 185
 186 XBT_PUBLIC_DATA(int) surfxml_bufferstack_size;
 187
 188 #endif /* _SURF_SURF_PRIVATE_H */