1 /* platf.h - Public interface to the SimGrid platforms */
3 /* Copyright (c) 2004-2012. The SimGrid Team. All rights reserved. */
5 /* This program is free software; you can redistribute it and/or modify it
6 * under the terms of the license (GNU LGPL) which comes with this package. */
13 typedef void *sg_routing_link_t; /* The actual type is model-dependent so use void* instead*/
14 typedef struct s_routing_edge *sg_routing_edge_t;
16 XBT_PUBLIC(sg_routing_edge_t) sg_routing_edge_by_name_or_null(const char *name);
20 typedef struct tmgr_trace *tmgr_trace_t; /**< Opaque structure defining an availability trace */
22 /** opaque structure defining a event generator for availability based on a probability distribution */
23 typedef struct probabilist_event_generator *probabilist_event_generator_t;
25 XBT_PUBLIC(tmgr_trace_t) tmgr_trace_new_from_file(const char *filename);
26 XBT_PUBLIC(tmgr_trace_t) tmgr_trace_new_from_string(const char *id,
29 XBT_PUBLIC(tmgr_trace_t) tmgr_trace_new_from_generator(const char *id,
30 probabilist_event_generator_t generator1,
31 probabilist_event_generator_t generator2,
34 XBT_PUBLIC(probabilist_event_generator_t) tmgr_event_generator_new_uniform(const char* id,
37 XBT_PUBLIC(probabilist_event_generator_t) tmgr_event_generator_new_exponential(const char* id,
39 XBT_PUBLIC(probabilist_event_generator_t) tmgr_event_generator_new_weibull(const char* id,
43 /** Defines whether a given resource is working or not */
45 SURF_RESOURCE_ON = 1, /**< Up & ready */
46 SURF_RESOURCE_OFF = 0 /**< Down & broken */
47 } e_surf_resource_state_t;
50 SURF_LINK_FULLDUPLEX = 2,
53 } e_surf_link_sharing_policy_t;
56 SURF_LINK_DIRECTION_NONE = 2,
57 SURF_LINK_DIRECTION_UP = 1,
58 SURF_LINK_DIRECTION_DOWN = 0
59 } e_surf_link_ctn_direction_t;
62 * Platform creation functions. Instead of passing 123 arguments to the creation functions
63 * (one for each possible XML attribute), we pass structures containing them all. It removes the
64 * chances of switching arguments by error, and reduce the burden when we add a new attribute:
65 * old models can just continue to ignore it without having to update their headers.
67 * It shouldn't be too costly at runtime, provided that structures living on the stack are
68 * used, instead of malloced structures.
76 tmgr_trace_t power_trace;
77 e_surf_resource_state_t initial_state;
78 tmgr_trace_t state_trace;
80 xbt_dict_t properties;
81 } s_sg_platf_host_cbarg_t, *sg_platf_host_cbarg_t;
86 const char* link_down;
87 } s_sg_platf_host_link_cbarg_t, *sg_platf_host_link_cbarg_t;
93 } s_sg_platf_router_cbarg_t, *sg_platf_router_cbarg_t;
98 tmgr_trace_t bandwidth_trace;
100 tmgr_trace_t latency_trace;
101 e_surf_resource_state_t state;
102 tmgr_trace_t state_trace;
103 e_surf_link_sharing_policy_t policy;
104 xbt_dict_t properties;
105 } s_sg_platf_link_cbarg_t, *sg_platf_link_cbarg_t;
107 typedef struct s_sg_platf_peer_cbarg *sg_platf_peer_cbarg_t;
108 typedef struct s_sg_platf_peer_cbarg {
115 tmgr_trace_t availability_trace;
116 tmgr_trace_t state_trace;
117 } s_sg_platf_peer_cbarg_t;
119 typedef struct s_sg_platf_linkctn_cbarg *sg_platf_linkctn_cbarg_t;
120 typedef struct s_sg_platf_linkctn_cbarg {
122 e_surf_link_ctn_direction_t direction;
123 } s_sg_platf_linkctn_cbarg_t;
125 typedef struct s_sg_platf_cluster_cbarg *sg_platf_cluster_cbarg_t;
126 typedef struct s_sg_platf_cluster_cbarg {
137 const char* router_id;
138 e_surf_link_sharing_policy_t sharing_policy;
139 e_surf_link_sharing_policy_t bb_sharing_policy;
140 const char* availability_trace; //don't convert to tmgr_trace_t since there is a trace per host and some rewriting is needed
141 const char* state_trace;
142 } s_sg_platf_cluster_cbarg_t;
144 typedef struct s_sg_platf_cabinet_cbarg *sg_platf_cabinet_cbarg_t;
145 typedef struct s_sg_platf_cabinet_cbarg {
153 } s_sg_platf_cabinet_cbarg_t;
159 } s_sg_platf_storage_cbarg_t, *sg_platf_storage_cbarg_t;
165 xbt_dict_t properties;
166 unsigned long size; /* size in Gbytes */
167 } s_sg_platf_storage_type_cbarg_t, *sg_platf_storage_type_cbarg_t;
172 } s_sg_platf_mstorage_cbarg_t, *sg_platf_mstorage_cbarg_t;
177 } s_sg_platf_mount_cbarg_t, *sg_platf_mount_cbarg_t;
180 XBT_PUBLIC(void) sg_platf_begin(void); // Start a new platform
181 XBT_PUBLIC(void) sg_platf_end(void); // Finish the creation of the platform
183 XBT_PUBLIC(void) sg_platf_new_AS_begin(const char *id, int mode); // Begin description of new AS
184 XBT_PUBLIC(void) sg_platf_new_AS_end(void); // That AS is fully described
186 XBT_PUBLIC(void) sg_platf_new_host (sg_platf_host_cbarg_t host); // Add an host to the currently described AS
187 XBT_PUBLIC(void) sg_platf_new_host_link(sg_platf_host_link_cbarg_t h); // Add an host_link to the currently described AS
188 XBT_PUBLIC(void) sg_platf_new_router (sg_platf_router_cbarg_t router); // Add a router to the currently described AS
189 XBT_PUBLIC(void) sg_platf_new_link (sg_platf_link_cbarg_t link); // Add a link to the currently described AS
190 XBT_PUBLIC(void) sg_platf_new_linkctn (sg_platf_linkctn_cbarg_t linkctn); // Add a linkctn
191 XBT_PUBLIC(void) sg_platf_new_peer (sg_platf_peer_cbarg_t peer); // Add a peer to the currently described AS
192 XBT_PUBLIC(void) sg_platf_new_cluster(sg_platf_cluster_cbarg_t clust); // Add a cluster to the currently described AS
193 XBT_PUBLIC(void) sg_platf_new_cabinet(sg_platf_cabinet_cbarg_t cabinet); // Add a cabinet to the currently described AS
194 XBT_PUBLIC(void) sg_platf_new_storage(sg_platf_storage_cbarg_t storage); // Add a storage to the currently described AS
195 XBT_PUBLIC(void) sg_platf_new_storage(sg_platf_storage_cbarg_t storage); // Add a storage to the currently described AS
196 XBT_PUBLIC(void) sg_platf_new_mstorage(sg_platf_mstorage_cbarg_t mstorage);
197 XBT_PUBLIC(void) sg_platf_new_storage_type(sg_platf_storage_type_cbarg_t storage_type);
198 XBT_PUBLIC(void) sg_platf_new_mount(sg_platf_mount_cbarg_t mount);
200 #endif /* SG_PLATF_H */