Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
9f33fc0d523458f3f5a86927c68b3730161bcb74
[simgrid.git] / 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 s_onelink_t, *onelink_t;
91 struct s_onelink{
92         char *src;
93         char *dst;
94         void *link_ptr;
95 };
96
97
98 /**
99  * Routing logic
100  */
101
102 typedef enum {
103   SURF_NETWORK_ELEMENT_NULL = 0,   /* NULL */
104   SURF_NETWORK_ELEMENT_HOST,       /* host type */
105   SURF_NETWORK_ELEMENT_ROUTER,     /* router type */
106   SURF_NETWORK_ELEMENT_GATEWAY,    /* gateway type of the AS */
107   SURF_NETWORK_ELEMENT_AS,         /* AS type */
108   SURF_NETWORK_ELEMENT_AS_GATEWAY, /* gateway type for internals AS */
109   SURF_NETWORK_ELEMENT_LINK        /* link type */
110 } e_surf_network_element_type_t;
111
112 typedef struct s_model_type s_model_type_t, *model_type_t;
113 typedef struct s_network_element s_network_element_t, *network_element_t;
114 typedef struct s_route s_route_t, *route_t;
115 typedef struct s_route_limits s_route_limits_t, *route_limits_t;
116 typedef struct s_route_extended s_route_extended_t, *route_extended_t;
117 typedef struct s_routing_component s_routing_component_t, *routing_component_t;
118 //typedef struct s_routing_global s_routing_global_t, *routing_global_t;
119
120 struct s_model_type {
121   const char *name;
122   const char *desc;
123   void* (*create)();
124   void (*load)();
125   void (*unload)();
126   void (*end)();
127 };
128
129 struct s_network_element {
130   //int id;
131   e_surf_network_element_type_t type;
132 };
133
134 struct s_route {
135   xbt_dynar_t link_list;
136 };
137
138 struct s_route_limits {
139   char* src_gateway;
140   char* dst_gateway;
141 };
142
143 struct s_route_extended {
144   s_route_t generic_route;
145   char* src_gateway;
146   char* dst_gateway;
147 };
148
149 /* This enum used in the routing structure helps knowing in which situation we are. */
150 typedef enum {
151   SURF_ROUTING_NULL = 0,   /**< Indefined type                                   */ 
152   SURF_ROUTING_BASE,       /**< Base case: use simple link lists for routing     */
153   SURF_ROUTING_RECURSIVE   /**< Recursive case: also return gateway informations */
154 } e_surf_routing_hierarchy_t;
155
156 struct s_routing_component {
157   model_type_t routing;
158   e_surf_routing_hierarchy_t hierarchy;
159   char *name;
160   struct s_routing_component* routing_father;
161   xbt_dict_t routing_sons;
162   route_extended_t (*get_route)(routing_component_t rc, const char* src, const char* dst);
163   xbt_dynar_t (*get_onelink_routes)(routing_component_t rc);
164   int (*is_router)(routing_component_t rc, const char *name);
165   route_extended_t (*get_bypass_route)(routing_component_t rc, const char* src, const char* dst);
166   void (*finalize)(routing_component_t rc);
167   void (*set_processing_unit)(routing_component_t rc, const char* name);
168   void (*set_autonomous_system)(routing_component_t rc, const char* name);
169   void (*set_route)(routing_component_t rc, const char* src, const char* dst, route_t route);
170   void (*set_ASroute)(routing_component_t rc, const char* src, const char* dst, route_extended_t route);
171   void (*set_bypassroute)(routing_component_t rc, const char* src, const char* dst, route_extended_t e_route);
172 };
173
174 struct s_routing_global {
175   routing_component_t root;
176   xbt_dict_t where_network_elements; /* char* -> s_routing_component* */
177   void *loopback;
178   size_t size_of_link;
179   xbt_dynar_t (*get_route)(const char* src, const char* dst);
180   xbt_dynar_t (*get_onelink_routes)(void);
181   int (*is_router)(const char *name);
182   void (*finalize)(void);
183   xbt_dynar_t last_route;
184 };
185
186 XBT_PUBLIC(void) routing_model_create(size_t size_of_link,void *loopback);
187
188 /**
189  * Resource protected methods
190  */
191 xbt_dict_t surf_resource_properties(const void *resource);
192
193 XBT_PUBLIC(void) surfxml_bufferstack_push(int new);
194 XBT_PUBLIC(void) surfxml_bufferstack_pop(int new);
195
196 XBT_PUBLIC_DATA(int) surfxml_bufferstack_size;
197
198 #endif /* _SURF_SURF_PRIVATE_H */