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;
34 extern const char *surf_action_state_names[6];
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);
53 lmm_system_t maxmin_system;
54 e_UM_t update_mechanism;
55 xbt_swag_t modified_set;
56 xbt_heap_t action_heap;
59 } s_surf_model_private_t;
61 double generic_maxmin_share_resources(xbt_swag_t running_actions,
64 void (*solve) (lmm_system_t));
65 void generic_update_action_remaining_lazy( surf_action_t action, double now);
67 /* Generic functions common to all models */
68 void surf_action_init(void);
69 void surf_action_exit(void);
70 e_surf_action_state_t surf_action_state_get(surf_action_t action); /* cannot declare inline since we use a pointer to it */
71 double surf_action_get_start_time(surf_action_t action); /* cannot declare inline since we use a pointer to it */
72 double surf_action_get_finish_time(surf_action_t action); /* cannot declare inline since we use a pointer to it */
73 void surf_action_free(surf_action_t * action);
74 void surf_action_state_set(surf_action_t action,
75 e_surf_action_state_t state);
76 void surf_action_data_set(surf_action_t action, void *data); /* cannot declare inline since we use a pointer to it */
78 void surf_action_lmm_update_index_heap(void *action, int i); /* callback for heap management shared by cpu and net models */
79 void surf_action_lmm_heap_insert(xbt_heap_t heap, surf_action_lmm_t action,
80 double key, enum heap_action_type hat);
81 void surf_action_lmm_heap_remove(xbt_heap_t heap,surf_action_lmm_t action);
83 void surf_action_cancel(surf_action_t action);
84 int surf_action_unref(surf_action_t action);
85 void surf_action_suspend(surf_action_t action);
86 void surf_action_resume(surf_action_t action);
87 int surf_action_is_suspended(surf_action_t action);
88 void surf_action_set_max_duration(surf_action_t action, double duration);
89 void surf_action_set_priority(surf_action_t action, double priority);
91 void surf_action_set_category(surf_action_t action,
92 const char *category);
94 double surf_action_get_remains(surf_action_t action);
96 FILE *surf_fopen(const char *name, const char *mode);
98 extern tmgr_history_t history;
99 extern xbt_dynar_t surf_path;
101 void surf_config_init(int *argc, char **argv);
102 void surf_config_finalize(void);
103 void surf_config(const char *name, va_list pa);
105 void net_action_recycle(surf_action_t action);
106 double net_action_get_remains(surf_action_t action);
107 #ifdef HAVE_LATENCY_BOUND_TRACKING
108 int net_get_link_latency_limited(surf_action_t action);
112 * Returns the initial path. On Windows the initial path is
113 * the current directory for the current process in the other
114 * case the function returns "./" that represents the current
115 * directory on Unix/Linux platforms.
117 const char *__surf_get_initial_path(void);
119 /* The __surf_is_absolute_file_path() returns 1 if
120 * file_path is a absolute file path, in the other
121 * case the function returns 0.
123 int __surf_is_absolute_file_path(const char *file_path);
125 typedef struct s_as *AS_t;
126 typedef struct s_routing_edge {
128 e_surf_network_element_type_t rc_type;
131 } s_network_element_t;
134 * Link of lenght 1, alongside with its source and destination. This is mainly usefull in the bindings to gtnets and ns3
136 typedef struct s_onelink {
137 sg_routing_edge_t src;
138 sg_routing_edge_t dst;
140 } s_onelink_t, *onelink_t;
146 typedef struct s_model_type {
150 void (*end) (AS_t as);
151 } s_routing_model_description_t, *routing_model_description_t;
153 typedef struct s_route {
154 xbt_dynar_t link_list;
155 sg_routing_edge_t src_gateway;
156 sg_routing_edge_t dst_gateway;
157 } s_route_t, *route_t;
159 /* This enum used in the routing structure helps knowing in which situation we are. */
161 SURF_ROUTING_NULL = 0, /**< Undefined type */
162 SURF_ROUTING_BASE, /**< Base case: use simple link lists for routing */
163 SURF_ROUTING_RECURSIVE /**< Recursive case: also return gateway informations */
164 } e_surf_routing_hierarchy_t;
166 typedef struct s_as {
167 xbt_dynar_t index_network_elm;
168 xbt_dict_t bypassRoutes; /* store bypass routes */
169 routing_model_description_t model_desc;
170 e_surf_routing_hierarchy_t hierarchy;
172 struct s_as *routing_father;
173 xbt_dict_t routing_sons;
174 sg_routing_edge_t net_elem;
175 xbt_dynar_t link_up_down_list;
177 void (*get_route_and_latency) (AS_t as, sg_routing_edge_t src, sg_routing_edge_t dst, route_t into, double *latency);
179 xbt_dynar_t(*get_onelink_routes) (AS_t as);
180 route_t(*get_bypass_route) (AS_t as, sg_routing_edge_t src, sg_routing_edge_t dst, double *lat);
181 void (*finalize) (AS_t as);
184 /* The parser calls the following functions to inform the routing models
185 * that a new element is added to the AS currently built.
187 * Of course, only the routing model of this AS is informed, not every ones */
188 int (*parse_PU) (AS_t as, sg_routing_edge_t elm); /* A host or a router, whatever */
189 int (*parse_AS) (AS_t as, sg_routing_edge_t elm);
190 void (*parse_route) (AS_t as, const char *src,
191 const char *dst, route_t route);
192 void (*parse_ASroute) (AS_t as, const char *src,
193 const char *dst, route_t route);
194 void (*parse_bypassroute) (AS_t as, const char *src,
195 const char *dst, route_t e_route);
198 struct s_routing_platf {
201 xbt_dynar_t last_route;
202 xbt_dynar_t(*get_onelink_routes) (void);
205 XBT_PUBLIC(void) routing_model_create(void *loopback);
206 XBT_PUBLIC(void) routing_exit(void);
207 XBT_PUBLIC(void) storage_register_callbacks(void);
208 XBT_PUBLIC(void) routing_register_callbacks(void);
209 XBT_PUBLIC(void) generic_free_route(route_t route); // FIXME rename to routing_route_free
210 // FIXME: make previous function private to routing again?
213 XBT_PUBLIC(void) routing_get_route_and_latency(sg_routing_edge_t src, sg_routing_edge_t dst,
214 xbt_dynar_t * route, double *latency);
217 * Resource protected methods
219 static XBT_INLINE xbt_dict_t surf_resource_properties(const void *resource);
221 XBT_PUBLIC(void) surfxml_bufferstack_push(int new);
222 XBT_PUBLIC(void) surfxml_bufferstack_pop(int new);
224 XBT_PUBLIC_DATA(int) surfxml_bufferstack_size;
226 #endif /* _SURF_SURF_PRIVATE_H */