1 /* platf.h - Public interface to the SimGrid platforms */
3 /* Copyright (c) 2004, 2005, 2006, 2007, 2009, 2010, 2011. The SimGrid Team.
4 * All rights reserved. */
6 /* This program is free software; you can redistribute it and/or modify it
7 * under the terms of the license (GNU LGPL) which comes with this package. */
14 typedef void *sg_routing_link_t; /* The actual type is model-dependent so use void* instead*/
15 typedef struct s_routing_edge *sg_routing_edge_t;
17 XBT_PUBLIC(sg_routing_edge_t) sg_routing_edge_by_name_or_null(const char *name);
21 typedef struct tmgr_trace *tmgr_trace_t; /**< Opaque structure defining an availability trace */
23 /** opaque structure defining a event generator for avaibility based on a probability distribution */
24 typedef struct probabilist_event_generator *probabilist_event_generator_t;
26 XBT_PUBLIC(tmgr_trace_t) tmgr_trace_new_from_file(const char *filename);
27 XBT_PUBLIC(tmgr_trace_t) tmgr_trace_new_from_string(const char *id,
30 typedef struct RngStream_InfoState *RngStream;
31 XBT_PUBLIC(RngStream) tmgr_rng_stream_from_id(char* id);
32 XBT_PUBLIC(probabilist_event_generator_t) tmgr_event_generator_new_uniform(RngStream rng_stream,
35 XBT_PUBLIC(probabilist_event_generator_t) tmgr_event_generator_new_exponential(RngStream rng_stream,
37 XBT_PUBLIC(probabilist_event_generator_t) tmgr_event_generator_new_weibull(RngStream rng_stream,
41 /** Defines whether a given resource is working or not */
43 SURF_RESOURCE_ON = 1, /**< Up & ready */
44 SURF_RESOURCE_OFF = 0 /**< Down & broken */
45 } e_surf_resource_state_t;
48 SURF_LINK_FULLDUPLEX = 2,
51 } e_surf_link_sharing_policy_t;
54 * Platform creation functions. Instead of passing 123 arguments to the creation functions
55 * (one for each possible XML attribute), we pass structures containing them all. It removes the
56 * chances of switching arguments by error, and reduce the burden when we add a new attribute:
57 * old models can just continue to ignore it without having to update their headers.
59 * It shouldn't be too costly at runtime, provided that structures living on the stack are
60 * used, instead of malloced structures.
68 tmgr_trace_t power_trace;
69 e_surf_resource_state_t initial_state;
70 tmgr_trace_t state_trace;
72 xbt_dict_t properties;
73 } s_sg_platf_host_cbarg_t, *sg_platf_host_cbarg_t;
78 } s_sg_platf_router_cbarg_t, *sg_platf_router_cbarg_t;
83 tmgr_trace_t bandwidth_trace;
85 tmgr_trace_t latency_trace;
86 e_surf_resource_state_t state;
87 tmgr_trace_t state_trace;
88 e_surf_link_sharing_policy_t policy;
89 xbt_dict_t properties;
90 } s_sg_platf_link_cbarg_t, *sg_platf_link_cbarg_t;
92 typedef struct s_sg_platf_peer_cbarg *sg_platf_peer_cbarg_t;
93 typedef struct s_sg_platf_peer_cbarg {
100 tmgr_trace_t availability_trace;
101 tmgr_trace_t state_trace;
102 } s_sg_platf_peer_cbarg_t;
104 typedef struct s_sg_platf_linkctn_cbarg *sg_platf_linkctn_cbarg_t;
105 typedef struct s_sg_platf_linkctn_cbarg {
107 const char *direction;
108 } s_sg_platf_linkctn_cbarg_t;
110 typedef struct s_sg_platf_cluster_cbarg *sg_platf_cluster_cbarg_t;
111 typedef struct s_sg_platf_cluster_cbarg {
122 const char* router_id;
123 e_surf_link_sharing_policy_t sharing_policy;
124 e_surf_link_sharing_policy_t bb_sharing_policy;
125 const char* availability_trace; //don't convert to tmgr_trace_t since there is a trace per host and some rewriting is needed
126 const char* state_trace;
127 } s_sg_platf_cluster_cbarg_t;
132 } s_sg_platf_storage_cbarg_t, *sg_platf_storage_cbarg_t;
138 xbt_dict_t properties;
139 } s_sg_platf_storage_type_cbarg_t, *sg_platf_storage_type_cbarg_t;
144 } s_sg_platf_mstorage_cbarg_t, *sg_platf_mstorage_cbarg_t;
149 } s_sg_platf_mount_cbarg_t, *sg_platf_mount_cbarg_t;
152 XBT_PUBLIC(void) sg_platf_begin(void); // Start a new platform
153 XBT_PUBLIC(void) sg_platf_end(void); // Finish the creation of the platform
155 XBT_PUBLIC(void) sg_platf_new_AS_begin(const char *id, const char *mode); // Begin description of new AS
156 XBT_PUBLIC(void) sg_platf_new_AS_end(void); // That AS is fully described
158 XBT_PUBLIC(void) sg_platf_new_host (sg_platf_host_cbarg_t host); // Add an host to the currently described AS
159 XBT_PUBLIC(void) sg_platf_new_router (sg_platf_router_cbarg_t router); // Add a router to the currently described AS
160 XBT_PUBLIC(void) sg_platf_new_link (sg_platf_link_cbarg_t link); // Add a link to the currently described AS
161 XBT_PUBLIC(void) sg_platf_new_peer (sg_platf_peer_cbarg_t peer); // Add a peer to the currently described AS
162 XBT_PUBLIC(void) sg_platf_new_cluster(sg_platf_cluster_cbarg_t clust); // Add a cluster to the currently described AS
163 XBT_PUBLIC(void) sg_platf_new_storage(sg_platf_storage_cbarg_t storage); // Add a storage to the currently described AS
164 XBT_PUBLIC(void) sg_platf_new_storage(sg_platf_storage_cbarg_t storage); // Add a storage to the currently described AS
165 XBT_PUBLIC(void) sg_platf_new_mstorage(sg_platf_mstorage_cbarg_t mstorage);
166 XBT_PUBLIC(void) sg_platf_new_storage_type(sg_platf_storage_type_cbarg_t storage_type);
167 XBT_PUBLIC(void) sg_platf_new_mount(sg_platf_mount_cbarg_t mount);
169 #endif /* SG_PLATF_H */