1 /* Copyright (c) 2004-2013. 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 extern xbt_dict_t watched_hosts_lib;
22 extern const char *surf_action_state_names[6];
30 typedef struct surf_model_private {
31 int (*resource_used) (void *resource_id);
32 /* Share the resources to the actions and return in how much time
33 the next action may terminate */
34 double (*share_resources) (double now);
35 /* Update the actions' state */
36 void (*update_actions_state) (double now, double delta);
37 void (*update_resource_state) (void *id, tmgr_trace_event_t event_type,
38 double value, double time);
39 void (*finalize) (void);
41 lmm_system_t maxmin_system;
42 e_UM_t update_mechanism;
43 xbt_swag_t modified_set;
44 xbt_heap_t action_heap;
47 } s_surf_model_private_t;
49 double generic_maxmin_share_resources(xbt_swag_t running_actions,
52 void (*solve) (lmm_system_t));
53 double generic_share_resources_lazy(double now, surf_model_t model);
55 /* Generic functions common to all models */
56 void surf_action_init(void);
57 void surf_action_exit(void);
58 e_surf_action_state_t surf_action_state_get(surf_action_t action); /* cannot declare inline since we use a pointer to it */
59 double surf_action_get_start_time(surf_action_t action); /* cannot declare inline since we use a pointer to it */
60 double surf_action_get_finish_time(surf_action_t action); /* cannot declare inline since we use a pointer to it */
61 void surf_action_free(surf_action_t * action);
62 void surf_action_state_set(surf_action_t action,
63 e_surf_action_state_t state);
64 void surf_action_data_set(surf_action_t action, void *data); /* cannot declare inline since we use a pointer to it */
66 void surf_action_lmm_update_index_heap(void *action, int i); /* callback for heap management shared by cpu and net models */
67 void surf_action_lmm_heap_insert(xbt_heap_t heap, surf_action_lmm_t action,
68 double key, enum heap_action_type hat);
69 void surf_action_lmm_heap_remove(xbt_heap_t heap,surf_action_lmm_t action);
71 void surf_action_cancel(surf_action_t action);
72 int surf_action_unref(surf_action_t action);
73 void surf_action_suspend(surf_action_t action);
74 void surf_action_resume(surf_action_t action);
75 int surf_action_is_suspended(surf_action_t action);
76 void surf_action_set_max_duration(surf_action_t action, double duration);
77 void surf_action_set_priority(surf_action_t action, double priority);
79 void surf_action_set_category(surf_action_t action,
80 const char *category);
82 double surf_action_get_remains(surf_action_t action);
83 void update_resource_energy(surf_model_t model, surf_action_lmm_t action);
84 void generic_update_action_remaining_lazy( surf_action_lmm_t action, double now);
85 void generic_update_actions_state_lazy(double now, double delta, surf_model_t model);
86 void generic_update_actions_state_full(double now, double delta, surf_model_t model);
88 FILE *surf_fopen(const char *name, const char *mode);
90 extern tmgr_history_t history;
92 //void surf_config_init(int *argc, char **argv);
93 //void surf_config_finalize(void);
94 //void surf_config(const char *name, va_list pa);
96 void net_action_recycle(surf_action_t action);
97 #ifdef HAVE_LATENCY_BOUND_TRACKING
98 int net_get_link_latency_limited(surf_action_t action);
101 /* The __surf_is_absolute_file_path() returns 1 if
102 * file_path is a absolute file path, in the other
103 * case the function returns 0.
105 int __surf_is_absolute_file_path(const char *file_path);
107 typedef struct s_routing_edge {
109 e_surf_network_element_type_t rc_type;
115 * Link of lenght 1, alongside with its source and destination. This is mainly usefull in the bindings to gtnets and ns3
117 typedef struct s_onelink {
118 sg_routing_edge_t src;
119 sg_routing_edge_t dst;
121 } s_onelink_t, *onelink_t;
127 typedef struct s_model_type {
131 void (*end) (AS_t as);
132 } s_routing_model_description_t, *routing_model_description_t;
134 /* This enum used in the routing structure helps knowing in which situation we are. */
136 SURF_ROUTING_NULL = 0, /**< Undefined type */
137 SURF_ROUTING_BASE, /**< Base case: use simple link lists for routing */
138 SURF_ROUTING_RECURSIVE /**< Recursive case: also return gateway informations */
139 } e_surf_routing_hierarchy_t;
141 typedef struct s_as {
142 xbt_dynar_t index_network_elm;
143 xbt_dict_t bypassRoutes; /* store bypass routes */
144 routing_model_description_t model_desc;
145 e_surf_routing_hierarchy_t hierarchy;
147 struct s_as *routing_father;
148 xbt_dict_t routing_sons;
149 sg_routing_edge_t net_elem;
150 xbt_dynar_t link_up_down_list;
152 void (*get_route_and_latency) (AS_t as, sg_routing_edge_t src, sg_routing_edge_t dst, sg_platf_route_cbarg_t into, double *latency);
154 xbt_dynar_t(*get_onelink_routes) (AS_t as);
155 void (*get_graph) (xbt_graph_t graph, xbt_dict_t nodes, xbt_dict_t edges, AS_t rc);
156 sg_platf_route_cbarg_t(*get_bypass_route) (AS_t as, sg_routing_edge_t src, sg_routing_edge_t dst, double *lat);
157 void (*finalize) (AS_t as);
160 /* The parser calls the following functions to inform the routing models
161 * that a new element is added to the AS currently built.
163 * Of course, only the routing model of this AS is informed, not every ones */
164 int (*parse_PU) (AS_t as, sg_routing_edge_t elm); /* A host or a router, whatever */
165 int (*parse_AS) (AS_t as, sg_routing_edge_t elm);
166 void (*parse_route) (AS_t as, sg_platf_route_cbarg_t route);
167 void (*parse_ASroute) (AS_t as, sg_platf_route_cbarg_t route);
168 void (*parse_bypassroute) (AS_t as, sg_platf_route_cbarg_t e_route);
172 struct s_routing_platf {
175 xbt_dynar_t last_route;
176 xbt_dynar_t(*get_onelink_routes) (void);
179 XBT_PUBLIC(void) routing_model_create(void *loopback);
180 XBT_PUBLIC(void) routing_exit(void);
181 XBT_PUBLIC(void) storage_register_callbacks(void);
182 /* ***************************************** */
183 /* TUTORIAL: New TAG */
184 XBT_PUBLIC(void) gpu_register_callbacks(void);
185 /* ***************************************** */
187 XBT_PUBLIC(void) routing_register_callbacks(void);
188 XBT_PUBLIC(void) generic_free_route(sg_platf_route_cbarg_t route); // FIXME rename to routing_route_free
189 // FIXME: make previous function private to routing again?
192 XBT_PUBLIC(void) routing_get_route_and_latency(sg_routing_edge_t src, sg_routing_edge_t dst,
193 xbt_dynar_t * route, double *latency);
195 XBT_PUBLIC(void) generic_get_graph(xbt_graph_t graph, xbt_dict_t nodes, xbt_dict_t edges, AS_t rc);
197 * Resource protected methods
199 XBT_PUBLIC(void) surfxml_bufferstack_push(int new);
200 XBT_PUBLIC(void) surfxml_bufferstack_pop(int new);
202 XBT_PUBLIC_DATA(int) surfxml_bufferstack_size;
204 /********** Tracing **********/
205 /* from surf_instr.c */
206 void TRACE_surf_host_set_power(double date, const char *resource, double power);
207 void TRACE_surf_link_set_bandwidth(double date, const char *resource, double bandwidth);
210 #endif /* _SURF_SURF_PRIVATE_H */