Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
568ded5760c256b7c5efc684f2d580915e9ba787
[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.h"
14 #include "surf/random_mgr.h"
15 #include "instr/instr_private.h"
16 #include "surf/surfxml_parse_values.h"
17
18 #define NO_MAX_DURATION -1.0
19
20 extern xbt_dict_t watched_hosts_lib;
21
22 extern const char *surf_action_state_names[6];
23
24 typedef enum {
25   UM_FULL,
26   UM_LAZY,
27   UM_UNDEFINED
28 } e_UM_t;
29
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);
40
41   lmm_system_t maxmin_system;
42   e_UM_t update_mechanism;
43   xbt_swag_t modified_set;
44   xbt_heap_t action_heap;
45   int selective_update;
46
47 } s_surf_model_private_t;
48
49 double generic_maxmin_share_resources(xbt_swag_t running_actions,
50                                       size_t offset,
51                                       lmm_system_t sys,
52                                       void (*solve) (lmm_system_t));
53 double generic_share_resources_lazy(double now, surf_model_t model);
54
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 */
65
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);
70
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);
78 #ifdef HAVE_TRACING
79 void surf_action_set_category(surf_action_t action,
80                                     const char *category);
81 #endif
82 double surf_action_get_remains(surf_action_t action);
83 void generic_update_action_remaining_lazy( surf_action_lmm_t action, double now);
84 void generic_update_actions_state_lazy(double now, double delta, surf_model_t model);
85 void generic_update_actions_state_full(double now, double delta, surf_model_t model);
86
87 FILE *surf_fopen(const char *name, const char *mode);
88
89 extern tmgr_history_t history;
90
91 //void surf_config_init(int *argc, char **argv);
92 //void surf_config_finalize(void);
93 //void surf_config(const char *name, va_list pa);
94
95 void net_action_recycle(surf_action_t action);
96 double net_action_get_remains(surf_action_t action);
97 #ifdef HAVE_LATENCY_BOUND_TRACKING
98 int net_get_link_latency_limited(surf_action_t action);
99 #endif
100
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.
104  */
105 int __surf_is_absolute_file_path(const char *file_path);
106
107 typedef struct s_as *AS_t;
108 typedef struct s_routing_edge {
109   AS_t rc_component;
110   e_surf_network_element_type_t rc_type;
111   int id;
112   char *name;
113 } s_routing_edge_t;
114
115 /*
116  * Link of lenght 1, alongside with its source and destination. This is mainly usefull in the bindings to gtnets and ns3
117  */
118 typedef struct s_onelink {
119   sg_routing_edge_t src;
120   sg_routing_edge_t dst;
121   void *link_ptr;
122 } s_onelink_t, *onelink_t;
123
124 /**
125  * Routing logic
126  */
127
128 typedef struct s_model_type {
129   const char *name;
130   const char *desc;
131   AS_t (*create) ();
132   void (*end) (AS_t as);
133 } s_routing_model_description_t, *routing_model_description_t;
134
135 /* This enum used in the routing structure helps knowing in which situation we are. */
136 typedef enum {
137   SURF_ROUTING_NULL = 0,   /**< Undefined type                                   */
138   SURF_ROUTING_BASE,       /**< Base case: use simple link lists for routing     */
139   SURF_ROUTING_RECURSIVE   /**< Recursive case: also return gateway informations */
140 } e_surf_routing_hierarchy_t;
141
142 typedef struct s_as {
143   xbt_dynar_t index_network_elm;
144   xbt_dict_t bypassRoutes;    /* store bypass routes */
145   routing_model_description_t model_desc;
146   e_surf_routing_hierarchy_t hierarchy;
147   char *name;
148   struct s_as *routing_father;
149   xbt_dict_t routing_sons;
150   sg_routing_edge_t net_elem;
151   xbt_dynar_t link_up_down_list;
152
153   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
155   xbt_dynar_t(*get_onelink_routes) (AS_t as);
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);
158
159
160   /* The parser calls the following functions to inform the routing models
161    * that a new element is added to the AS currently built.
162    *
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);
169
170 } s_as_t;
171
172 struct s_routing_platf {
173   AS_t root;
174   void *loopback;
175   xbt_dynar_t last_route;
176   xbt_dynar_t(*get_onelink_routes) (void);
177 };
178
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 /* ***************************************** */
186
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?
190
191
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);
194
195 /**
196  * Resource protected methods
197  */
198 XBT_PUBLIC(void) surfxml_bufferstack_push(int new);
199 XBT_PUBLIC(void) surfxml_bufferstack_pop(int new);
200
201 XBT_PUBLIC_DATA(int) surfxml_bufferstack_size;
202
203 #endif                          /* _SURF_SURF_PRIVATE_H */