Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
19082b71ceb09a39372c8723cd259462591d3a6a
[simgrid.git] / include / simgrid / forward.h
1 /* Copyright (c) 2004-2015. 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
7 #ifndef SG_PLATF_TYPES_H
8 #define SG_PLATF_TYPES_H
9
10 #include <xbt.h>
11
12 #ifdef __cplusplus
13
14 namespace simgrid {
15   namespace s4u {
16     class Host;
17   }
18   namespace surf {
19     class Resource;
20     class Cpu;
21     class NetCard;
22     class As;
23     class Link;
24   }
25   namespace trace_mgr {
26     class future_evt_set;
27   }
28 }
29
30 typedef simgrid::s4u::Host simgrid_Host;
31 typedef simgrid::surf::As surf_As;
32 typedef simgrid::surf::Cpu surf_Cpu;
33 typedef simgrid::surf::NetCard surf_NetCard;
34 typedef simgrid::surf::Link Link;
35 typedef simgrid::surf::Resource surf_Resource;
36
37 #else
38
39 typedef struct simgrid_Host simgrid_Host;
40 typedef struct surf_As surf_As;
41 typedef struct surf_Cpu surf_Cpu;
42 typedef struct surf_NetCard surf_NetCard;
43 typedef struct surf_Resource surf_Resource;
44 typedef struct Link Link;
45 #endif
46
47 typedef simgrid_Host* sg_host_t;
48 typedef surf_As *AS_t;
49 typedef surf_Cpu *surf_cpu_t;
50 typedef surf_NetCard *sg_netcard_t;
51 typedef surf_Resource *sg_resource_t;
52
53 // Types which are in fact dictelmt:
54 typedef xbt_dictelm_t sg_storage_t;
55
56 typedef struct tmgr_trace *tmgr_trace_t; /**< Opaque structure defining an availability trace */
57
58 typedef void *sg_routing_link_t; /* FIXME:The actual type is model-dependent so use void* instead*/
59
60 typedef enum {
61   SURF_LINK_FULLDUPLEX = 2,
62   SURF_LINK_SHARED = 1,
63   SURF_LINK_FATPIPE = 0
64 } e_surf_link_sharing_policy_t;
65
66 typedef enum {
67   SURF_TRACE_CONNECT_KIND_HOST_AVAIL = 4,
68   SURF_TRACE_CONNECT_KIND_POWER = 3,
69   SURF_TRACE_CONNECT_KIND_LINK_AVAIL = 2,
70   SURF_TRACE_CONNECT_KIND_BANDWIDTH = 1,
71   SURF_TRACE_CONNECT_KIND_LATENCY = 0
72 } e_surf_trace_connect_kind_t;
73
74 typedef enum {
75   SURF_PROCESS_ON_FAILURE_DIE = 1,
76   SURF_PROCESS_ON_FAILURE_RESTART = 0
77 } e_surf_process_on_failure_t;
78
79 typedef enum {
80   SURF_CLUSTER_FAT_TREE=2,
81   SURF_CLUSTER_FLAT = 1,
82   SURF_CLUSTER_TORUS = 0
83 } e_surf_cluster_topology_t;
84
85
86 /** @ingroup m_datatypes_management_details
87  * @brief Type for any simgrid size
88  */
89 typedef unsigned long long sg_size_t;
90
91 /** @ingroup m_datatypes_management_details
92  * @brief Type for any simgrid offset
93  */
94 typedef long long sg_offset_t;
95
96 /*
97  * Platform creation functions. Instead of passing 123 arguments to the creation functions
98  * (one for each possible XML attribute), we pass structures containing them all. It removes the
99  * chances of switching arguments by error, and reduce the burden when we add a new attribute:
100  * old models can just continue to ignore it without having to update their headers.
101  *
102  * It shouldn't be too costly at runtime, provided that structures living on the stack are
103  * used, instead of malloced structures.
104  */
105
106 typedef struct {
107   const char* id;
108   xbt_dynar_t speed_peak;
109   int pstate;
110   int core_amount;
111   double speed_scale;
112   tmgr_trace_t speed_trace;
113   int initiallyOn;
114   tmgr_trace_t state_trace;
115   const char* coord;
116   xbt_dict_t properties;
117 } s_sg_platf_host_cbarg_t, *sg_platf_host_cbarg_t;
118
119 #define SG_PLATF_HOST_INITIALIZER { \
120     NULL, 0, 1, 1, 1., NULL, 1/*ON*/, NULL, \
121     NULL, NULL \
122 }
123
124 typedef struct {
125   const char* id;
126   const char* link_up;
127   const char* link_down;
128 } s_sg_platf_host_link_cbarg_t, *sg_platf_host_link_cbarg_t;
129
130 #define SG_PLATF_HOST_LINK_INITIALIZER {NULL,NULL,NULL}
131
132 typedef struct {
133   const char* id;
134   const char* coord;
135 } s_sg_platf_router_cbarg_t, *sg_platf_router_cbarg_t;
136
137 #define SG_PLATF_ROUTER_INITIALIZER {NULL,NULL}
138
139 typedef struct {
140   const char* id;
141   double bandwidth;
142   tmgr_trace_t bandwidth_trace;
143   double latency;
144   tmgr_trace_t latency_trace;
145   int initiallyOn;
146   tmgr_trace_t state_trace;
147   e_surf_link_sharing_policy_t policy;
148   xbt_dict_t properties;
149 } s_sg_platf_link_cbarg_t, *sg_platf_link_cbarg_t;
150
151 #define SG_PLATF_LINK_INITIALIZER {\
152   NULL, 0., NULL, 0., NULL, 1/*ON*/, \
153   NULL, SURF_LINK_SHARED, NULL \
154 }
155
156 typedef struct s_sg_platf_peer_cbarg *sg_platf_peer_cbarg_t;
157 typedef struct s_sg_platf_peer_cbarg {
158   const char* id;
159   double speed;
160   double bw_in;
161   double bw_out;
162   double lat;
163   const char* coord;
164   tmgr_trace_t availability_trace;
165   tmgr_trace_t state_trace;
166 } s_sg_platf_peer_cbarg_t;
167
168 #define SG_PLATF_PEER_INITIALIZER {NULL,0.0,0.0,0.0,0.0,NULL,NULL,NULL}
169
170 typedef struct s_sg_platf_route_cbarg *sg_platf_route_cbarg_t;
171 typedef struct s_sg_platf_route_cbarg {
172   int symmetrical;
173   const char *src;
174   const char *dst;
175   sg_netcard_t gw_src;
176   sg_netcard_t gw_dst;
177   xbt_dynar_t link_list;
178 } s_sg_platf_route_cbarg_t;
179
180 #define SG_PLATF_ROUTE_INITIALIZER {1,NULL,NULL,NULL,NULL,NULL}
181
182 typedef struct s_sg_platf_cluster_cbarg *sg_platf_cluster_cbarg_t;
183 typedef struct s_sg_platf_cluster_cbarg {
184   const char* id;
185   const char* prefix;
186   const char* suffix;
187   const char* radical;
188   double speed;
189   int core_amount;
190   double bw;
191   double lat;
192   double bb_bw;
193   double bb_lat;
194   double loopback_bw;
195   double loopback_lat;
196   double limiter_link;
197   e_surf_cluster_topology_t topology;
198   const char* topo_parameters;
199   xbt_dict_t properties;
200   const char* router_id;
201   e_surf_link_sharing_policy_t sharing_policy;
202   e_surf_link_sharing_policy_t bb_sharing_policy;
203   const char* availability_trace; //don't convert to tmgr_trace_t since there is a trace per host and some rewriting is needed
204   const char* state_trace;
205 } s_sg_platf_cluster_cbarg_t;
206
207 #define SG_PLATF_CLUSTER_INITIALIZER {NULL,NULL,NULL,NULL,0.0,1 \
208   ,1.,1.,0.,0.,0.,0.,0. \
209   ,SURF_CLUSTER_FLAT,NULL,NULL,NULL, \
210   SURF_LINK_SHARED,SURF_LINK_SHARED,NULL \
211   ,NULL}
212
213 typedef struct s_sg_platf_cabinet_cbarg *sg_platf_cabinet_cbarg_t;
214 typedef struct s_sg_platf_cabinet_cbarg {
215   const char* id;
216   const char* prefix;
217   const char* suffix;
218   const char* radical;
219   double speed;
220   double bw;
221   double lat;
222 } s_sg_platf_cabinet_cbarg_t;
223
224 #define SG_PLATF_CABINET_INITIALIZER {NULL,NULL,NULL,NULL,0.0,0.0,0.0}
225
226 typedef struct {
227   const char* id;
228   const char* type_id;
229   const char* content;
230   const char* content_type;
231   xbt_dict_t properties;
232   const char* attach;
233 } s_sg_platf_storage_cbarg_t, *sg_platf_storage_cbarg_t;
234
235 #define SG_PLATF_STORAGE_INITIALIZER {NULL,NULL,NULL,NULL,NULL,NULL}
236
237 typedef struct {
238   const char* id;
239   const char* model;
240   const char* content;
241   const char* content_type;
242   xbt_dict_t properties;
243   xbt_dict_t model_properties;
244   sg_size_t size;
245 } s_sg_platf_storage_type_cbarg_t, *sg_platf_storage_type_cbarg_t;
246
247 #define SG_PLATF_STORAGE_TYPE_INITIALIZER {NULL,NULL,NULL,NULL,NULL,NULL,0}
248
249 typedef struct {
250   const char* type_id;
251   const char* name;
252 } s_sg_platf_mstorage_cbarg_t, *sg_platf_mstorage_cbarg_t;
253
254 #define SG_PLATF_MSTORAGE_INITIALIZER {NULL,NULL}
255
256 typedef struct {
257   const char* storageId;
258   const char* name;
259 } s_sg_platf_mount_cbarg_t, *sg_platf_mount_cbarg_t;
260
261 #define SG_PLATF_MOUNT_INITIALIZER {NULL,NULL}
262
263 typedef struct s_sg_platf_prop_cbarg *sg_platf_prop_cbarg_t;
264 typedef struct s_sg_platf_prop_cbarg {
265   const char *id;
266   const char *value;
267 } s_sg_platf_prop_cbarg_t;
268
269 #define SG_PLATF_PROP_INITIALIZER {NULL,NULL}
270
271 typedef struct s_sg_platf_trace_cbarg *sg_platf_trace_cbarg_t;
272 typedef struct s_sg_platf_trace_cbarg {
273   const char *id;
274   const char *file;
275   double periodicity;
276   const char *pc_data;
277 } s_sg_platf_trace_cbarg_t;
278
279 #define SG_PLATF_TRACE_INITIALIZER {NULL,NULL,0.0,NULL}
280
281 typedef struct s_sg_platf_trace_connect_cbarg *sg_platf_trace_connect_cbarg_t;
282 typedef struct s_sg_platf_trace_connect_cbarg {
283   e_surf_trace_connect_kind_t kind;
284   const char *trace;
285   const char *element;
286 } s_sg_platf_trace_connect_cbarg_t;
287
288 #define SG_PLATF_TRACE_CONNECT_INITIALIZER {SURF_TRACE_CONNECT_KIND_LATENCY,NULL,NULL}
289
290 typedef struct s_sg_platf_process_cbarg *sg_platf_process_cbarg_t;
291 typedef struct s_sg_platf_process_cbarg {
292   const char **argv;
293   int argc;
294   xbt_dict_t properties;
295   const char *host;
296   const char *function;
297   double start_time;
298   double kill_time;
299   e_surf_process_on_failure_t on_failure;
300 } s_sg_platf_process_cbarg_t;
301
302 #define SG_PLATF_PROCESS_INITIALIZER {NULL,0,NULL,NULL,NULL,-1.0,-1.0,SURF_PROCESS_ON_FAILURE_DIE}
303
304 typedef struct s_sg_platf_AS_cbarg *sg_platf_AS_cbarg_t;
305 typedef struct s_sg_platf_AS_cbarg {
306   const char *id;
307   int routing;
308 } s_sg_platf_AS_cbarg_t;
309
310 #define SG_PLATF_AS_INITIALIZER {NULL,0}
311
312 /** opaque structure defining a event generator for availability based on a probability distribution */
313 typedef struct probabilist_event_generator *probabilist_event_generator_t;
314
315 #endif