1 /* Copyright (c) 2004, 2005, 2006, 2007, 2008, 2009, 2010. The SimGrid Team.
2 * All rights reserved. */
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
10 #include "surf/maxmin.h"
11 #include "surf/trace_mgr.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"
18 #define NO_MAX_DURATION -1.0
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_crosstraffic;
29 extern double sg_gtnets_jitter;
30 extern int sg_gtnets_jitter_seed;
33 extern xbt_dict_t watched_hosts_lib;
35 extern const char *surf_action_state_names[6];
43 typedef struct surf_model_private {
44 int (*resource_used) (void *resource_id);
45 /* Share the resources to the actions and return in how much time
46 the next action may terminate */
47 double (*share_resources) (double now);
48 /* Update the actions' state */
49 void (*update_actions_state) (double now, double delta);
50 void (*update_resource_state) (void *id, tmgr_trace_event_t event_type,
51 double value, double time);
52 void (*finalize) (void);
54 lmm_system_t maxmin_system;
55 e_UM_t update_mechanism;
56 xbt_swag_t modified_set;
57 xbt_heap_t action_heap;
60 } s_surf_model_private_t;
62 double generic_maxmin_share_resources(xbt_swag_t running_actions,
65 void (*solve) (lmm_system_t));
66 double generic_share_resources_lazy(double now, surf_model_t model);
68 /* Generic functions common to all models */
69 void surf_action_init(void);
70 void surf_action_exit(void);
71 e_surf_action_state_t surf_action_state_get(surf_action_t action); /* cannot declare inline since we use a pointer to it */
72 double surf_action_get_start_time(surf_action_t action); /* cannot declare inline since we use a pointer to it */
73 double surf_action_get_finish_time(surf_action_t action); /* cannot declare inline since we use a pointer to it */
74 void surf_action_free(surf_action_t * action);
75 void surf_action_state_set(surf_action_t action,
76 e_surf_action_state_t state);
77 void surf_action_data_set(surf_action_t action, void *data); /* cannot declare inline since we use a pointer to it */
79 void surf_action_lmm_update_index_heap(void *action, int i); /* callback for heap management shared by cpu and net models */
80 void surf_action_lmm_heap_insert(xbt_heap_t heap, surf_action_lmm_t action,
81 double key, enum heap_action_type hat);
82 void surf_action_lmm_heap_remove(xbt_heap_t heap,surf_action_lmm_t action);
84 void surf_action_cancel(surf_action_t action);
85 int surf_action_unref(surf_action_t action);
86 void surf_action_suspend(surf_action_t action);
87 void surf_action_resume(surf_action_t action);
88 int surf_action_is_suspended(surf_action_t action);
89 void surf_action_set_max_duration(surf_action_t action, double duration);
90 void surf_action_set_priority(surf_action_t action, double priority);
92 void surf_action_set_category(surf_action_t action,
93 const char *category);
95 double surf_action_get_remains(surf_action_t action);
96 void generic_update_action_remaining_lazy( surf_action_lmm_t action, double now);
97 void generic_update_actions_state_lazy(double now, double delta, surf_model_t model);
98 void generic_update_actions_state_full(double now, double delta, surf_model_t model);
100 FILE *surf_fopen(const char *name, const char *mode);
102 extern tmgr_history_t history;
103 extern xbt_dynar_t surf_path;
105 void surf_config_init(int *argc, char **argv);
106 void surf_config_finalize(void);
107 void surf_config(const char *name, va_list pa);
109 void net_action_recycle(surf_action_t action);
110 double net_action_get_remains(surf_action_t action);
111 #ifdef HAVE_LATENCY_BOUND_TRACKING
112 int net_get_link_latency_limited(surf_action_t action);
116 * Returns the initial path. On Windows the initial path is
117 * the current directory for the current process in the other
118 * case the function returns "./" that represents the current
119 * directory on Unix/Linux platforms.
121 const char *__surf_get_initial_path(void);
123 /* The __surf_is_absolute_file_path() returns 1 if
124 * file_path is a absolute file path, in the other
125 * case the function returns 0.
127 int __surf_is_absolute_file_path(const char *file_path);
129 typedef struct s_as *AS_t;
130 typedef struct s_routing_edge {
132 e_surf_network_element_type_t rc_type;
135 } s_network_element_t;
138 * Link of lenght 1, alongside with its source and destination. This is mainly usefull in the bindings to gtnets and ns3
140 typedef struct s_onelink {
141 sg_routing_edge_t src;
142 sg_routing_edge_t dst;
144 } s_onelink_t, *onelink_t;
150 typedef struct s_model_type {
154 void (*end) (AS_t as);
155 } s_routing_model_description_t, *routing_model_description_t;
157 typedef struct s_route {
158 xbt_dynar_t link_list;
159 sg_routing_edge_t src_gateway;
160 sg_routing_edge_t dst_gateway;
161 } s_route_t, *route_t;
163 /* This enum used in the routing structure helps knowing in which situation we are. */
165 SURF_ROUTING_NULL = 0, /**< Undefined type */
166 SURF_ROUTING_BASE, /**< Base case: use simple link lists for routing */
167 SURF_ROUTING_RECURSIVE /**< Recursive case: also return gateway informations */
168 } e_surf_routing_hierarchy_t;
170 typedef struct s_as {
171 xbt_dynar_t index_network_elm;
172 xbt_dict_t bypassRoutes; /* store bypass routes */
173 routing_model_description_t model_desc;
174 e_surf_routing_hierarchy_t hierarchy;
176 struct s_as *routing_father;
177 xbt_dict_t routing_sons;
178 sg_routing_edge_t net_elem;
179 xbt_dynar_t link_up_down_list;
181 void (*get_route_and_latency) (AS_t as, sg_routing_edge_t src, sg_routing_edge_t dst, route_t into, double *latency);
183 xbt_dynar_t(*get_onelink_routes) (AS_t as);
184 route_t(*get_bypass_route) (AS_t as, sg_routing_edge_t src, sg_routing_edge_t dst, double *lat);
185 void (*finalize) (AS_t as);
188 /* The parser calls the following functions to inform the routing models
189 * that a new element is added to the AS currently built.
191 * Of course, only the routing model of this AS is informed, not every ones */
192 int (*parse_PU) (AS_t as, sg_routing_edge_t elm); /* A host or a router, whatever */
193 int (*parse_AS) (AS_t as, sg_routing_edge_t elm);
194 void (*parse_route) (AS_t as, const char *src,
195 const char *dst, route_t route);
196 void (*parse_ASroute) (AS_t as, const char *src,
197 const char *dst, route_t route);
198 void (*parse_bypassroute) (AS_t as, const char *src,
199 const char *dst, route_t e_route);
202 struct s_routing_platf {
205 xbt_dynar_t last_route;
206 xbt_dynar_t(*get_onelink_routes) (void);
209 XBT_PUBLIC(void) routing_model_create(void *loopback);
210 XBT_PUBLIC(void) routing_exit(void);
211 XBT_PUBLIC(void) storage_register_callbacks(void);
212 XBT_PUBLIC(void) routing_register_callbacks(void);
213 XBT_PUBLIC(void) generic_free_route(route_t route); // FIXME rename to routing_route_free
214 // FIXME: make previous function private to routing again?
217 XBT_PUBLIC(void) routing_get_route_and_latency(sg_routing_edge_t src, sg_routing_edge_t dst,
218 xbt_dynar_t * route, double *latency);
221 * Resource protected methods
223 static XBT_INLINE xbt_dict_t surf_resource_properties(const void *resource);
225 XBT_PUBLIC(void) surfxml_bufferstack_push(int new);
226 XBT_PUBLIC(void) surfxml_bufferstack_pop(int new);
228 XBT_PUBLIC_DATA(int) surfxml_bufferstack_size;
230 #endif /* _SURF_SURF_PRIVATE_H */